source: lib/trace.c @ 2193905

develop
Last change on this file since 2193905 was 2193905, checked in by Jacob Van Walraven <jcv9@…>, 2 years ago

Apply changes required for pull request #81

  • Property mode set to 100644
File size: 76.8 KB
Line 
1/*
2 *
3 * Copyright (c) 2007-2016 The University of Waikato, Hamilton, New Zealand.
4 * All rights reserved.
5 *
6 * This file is part of libtrace.
7 *
8 * This code has been developed by the University of Waikato WAND
9 * research group. For further information please see http://www.wand.net.nz/
10 *
11 * libtrace is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * libtrace is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 * GNU Lesser General Public License for more details.
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23 *
24 *
25 */
26
27#define _GNU_SOURCE
28#include "common.h"
29#include "config.h"
30#include <assert.h>
31#include <errno.h>
32#include <fcntl.h>
33#include <stdio.h>
34#include <stdlib.h>
35#include <string.h>
36#include <sys/stat.h>
37#include <sys/types.h>
38#ifndef WIN32
39#include <sys/socket.h>
40#endif
41#include <stdarg.h>
42#include <sys/param.h>
43
44#ifdef HAVE_LIMITS_H
45#  include <limits.h>
46#endif
47
48#ifdef HAVE_SYS_LIMITS_H
49#  include <sys/limits.h>
50#endif
51
52#ifdef HAVE_NET_IF_ARP_H
53#  include <net/if_arp.h>
54#endif
55
56#ifdef HAVE_NET_IF_H
57#  include <net/if.h>
58#endif
59
60#ifdef HAVE_NETINET_IN_H
61#  include <netinet/in.h>
62#endif
63
64#ifdef HAVE_NET_ETHERNET_H
65#  include <net/ethernet.h>
66#endif
67
68#ifdef HAVE_NETINET_IF_ETHER_H
69#  include <netinet/if_ether.h>
70#endif
71
72#include <time.h>
73#ifdef WIN32
74#include <sys/timeb.h>
75#endif
76
77#include "libtrace.h"
78#include "libtrace_int.h"
79
80#ifdef HAVE_PCAP_BPF_H
81#  include <pcap-bpf.h>
82#else
83#  ifdef HAVE_NET_BPF_H
84#    include <net/bpf.h>
85#  endif
86#endif
87
88
89#include "libtrace_int.h"
90#include "format_helper.h"
91#include "rt_protocol.h"
92
93#include <pthread.h>
94#include <signal.h>
95
96#define MAXOPTS 1024
97
98/* This file contains much of the implementation of the libtrace API itself. */
99
100static struct libtrace_format_t *formats_list = NULL;
101
102volatile int libtrace_halt = 0;
103/* Set once pstart is called used for backwards compatibility reasons */
104int libtrace_parallel = 0;
105
106/* strncpy is not assured to copy the final \0, so we
107 * will use our own one that does
108 */
109static inline void xstrncpy(char *dest, const char *src, size_t n,
110                size_t destlen)
111{
112        size_t slen = destlen - 1;
113        if (n < slen) {
114                slen = n;
115        }
116        strncpy(dest,src,slen);
117        dest[slen]='\0';
118}
119
120static char *xstrndup(const char *src,size_t n)
121{
122        char *ret=(char*)malloc(n+1);
123        if (ret==NULL) {
124                fprintf(stderr,"Out of memory\n");
125                exit(EXIT_FAILURE);
126        }
127        xstrncpy(ret,src,n,n+1);
128        return ret;
129}
130
131
132/* call all the constructors if they haven't yet all been called */
133__attribute__((constructor))
134static void trace_init(void)
135{
136        struct timeval tv;
137        gettimeofday(&tv, NULL);
138        srand(tv.tv_sec);
139
140        if (!formats_list) {
141                duck_constructor();
142                erf_constructor();
143                tsh_constructor();
144                legacy_constructor();
145                atmhdr_constructor();
146                linuxring_constructor();
147                linuxnative_constructor();
148#ifdef HAVE_LIBPCAP
149                pcap_constructor();
150#endif
151                bpf_constructor();
152                pcapfile_constructor();
153                pcapng_constructor();
154                rt_constructor();
155                ndag_constructor();
156#ifdef HAVE_WANDDER
157                etsilive_constructor();
158#endif
159#ifdef HAVE_DAG
160                dag_constructor();
161#endif
162#ifdef HAVE_DPDK
163                dpdk_constructor();
164                dpdkndag_constructor();
165#endif
166        }
167}
168
169/* Prints help information for libtrace
170 *
171 * Function prints out some basic help information regarding libtrace,
172 * and then prints out the help() function registered with each input module
173 */
174DLLEXPORT void trace_help(void) {
175        struct libtrace_format_t *tmp;
176        trace_init();
177        printf("libtrace %s\n\n",PACKAGE_VERSION);
178        printf("Following this are a list of the format modules supported in this build of libtrace\n\n");
179        for(tmp=formats_list;tmp;tmp=tmp->next) {
180                if (tmp->help)
181                        tmp->help();
182        }
183}
184
185#define URI_PROTO_LINE 16U
186
187/* Try to guess which format module is appropriate for a given trace file or
188 * device */
189static void guess_format(libtrace_t *libtrace, const char *filename)
190{
191        struct libtrace_format_t *tmp;
192
193        /* Try and guess based on filename */
194        for(tmp = formats_list; tmp; tmp=tmp->next) {
195                if (tmp->probe_filename && tmp->probe_filename(filename)) {
196                        libtrace->format = tmp;
197                        libtrace->uridata = strdup(filename);
198                        return;
199                }
200        }
201
202        libtrace->io = wandio_create(filename);
203        if (!libtrace->io) {
204                trace_set_err(libtrace,TRACE_ERR_URI_NOT_FOUND,"Unable to find URI (%s)", filename);
205                return;
206        }
207
208        /* Try and guess based on file magic */
209        for(tmp = formats_list; tmp; tmp=tmp->next) {
210                if (tmp->probe_magic && tmp->probe_magic(libtrace->io)) {
211                        libtrace->format = tmp;
212                        libtrace->uridata = strdup(filename);
213                        return;
214                }
215        }
216
217        /* No formats matched -- make sure we clean up the IO object we
218         * used to probe the file magic */
219        wandio_destroy(libtrace->io);
220        trace_set_err(libtrace,TRACE_ERR_BAD_FORMAT,"Unable to guess format (%s)", filename);
221        return;
222}
223
224/* Creates an input trace from a URI
225 *
226 * @params char * containing a valid libtrace URI
227 * @returns opaque pointer to a libtrace_t
228 *
229 * Some valid URI's are:
230 *  erf:/path/to/erf/file
231 *  erf:/path/to/erf/file.gz
232 *  erf:-                       (stdin)
233 *  dag:/dev/dagcard
234 *  pcapint:pcapinterface               (eg: pcapint:eth0)
235 *  pcapfile:/path/to/pcap/file
236 *  pcapfile:-
237 *  int:interface                       (eg: int:eth0) only on Linux
238 *  rt:hostname
239 *  rt:hostname:port
240 *
241 * If an error occured when attempting to open a trace, NULL is returned
242 * and an error is output to stdout.
243 */
244DLLEXPORT libtrace_t *trace_create(const char *uri) {
245        libtrace_t *libtrace =
246                        (libtrace_t *)malloc(sizeof(libtrace_t));
247        char *scan = 0;
248        const char *uridata = 0;
249
250        trace_init();
251
252        if (!libtrace) {
253                fprintf(stderr, "Unable to allocate memory in trace_create()\n");
254                return NULL;
255        }
256
257        if(!uri) {
258                trace_set_err(libtrace, TRACE_ERR_URI_NULL, "NULL uri passed to trace_create()");
259                return libtrace;
260        }
261
262        libtrace->err.err_num = TRACE_ERR_NOERROR;
263        libtrace->format=NULL;
264
265        libtrace->event.packet = NULL;
266        libtrace->event.psize = 0;
267        libtrace->event.first_ts = 0.0;
268        libtrace->event.first_now = 0.0;
269        libtrace->event.waiting = false;
270        libtrace->filter = NULL;
271        libtrace->snaplen = 0;
272        libtrace->replayspeedup = 1;
273        libtrace->started=false;
274        libtrace->startcount=0;
275        libtrace->uridata = NULL;
276        libtrace->io = NULL;
277        libtrace->filtered_packets = 0;
278        libtrace->accepted_packets = 0;
279        libtrace->last_packet = NULL;
280
281        /* Parallel inits */
282        ASSERT_RET(pthread_mutex_init(&libtrace->libtrace_lock, NULL), == 0);
283        ASSERT_RET(pthread_mutex_init(&libtrace->read_packet_lock, NULL), == 0);
284        ASSERT_RET(pthread_cond_init(&libtrace->perpkt_cond, NULL), == 0);
285        libtrace->state = STATE_NEW;
286        libtrace->perpkt_queue_full = false;
287        libtrace->global_blob = NULL;
288        libtrace->hasher = NULL;
289        libtrace->hasher_data = NULL;
290        libtrace->hasher_owner = HASH_OWNED_EXTERNAL;
291        libtrace_zero_ocache(&libtrace->packet_freelist);
292        libtrace_zero_thread(&libtrace->hasher_thread);
293        libtrace_zero_thread(&libtrace->reporter_thread);
294        libtrace_zero_thread(&libtrace->keepalive_thread);
295        libtrace->reporter_thread.type = THREAD_EMPTY;
296        libtrace->perpkt_thread_count = 0;
297        libtrace->perpkt_threads = NULL;
298        libtrace->tracetime = 0;
299        libtrace->first_packets.first = 0;
300        libtrace->first_packets.count = 0;
301        libtrace->first_packets.packets = NULL;
302        libtrace->stats = NULL;
303        libtrace->pread = NULL;
304        libtrace->sequence_number = 0;
305        ZERO_USER_CONFIG(libtrace->config);
306        memset(&libtrace->combiner, 0, sizeof(libtrace->combiner));
307        libtrace->perpkt_cbs = NULL;
308        libtrace->reporter_cbs = NULL;
309
310        /* Parse the URI to determine what sort of trace we are dealing with */
311        if ((uridata = trace_parse_uri(uri, &scan)) == 0) {
312                /* Could not parse the URI nicely */
313                guess_format(libtrace,uri);
314                if (trace_is_err(libtrace)) {
315                        return libtrace;
316                }
317        }
318        else {
319                struct libtrace_format_t *tmp;
320
321                /* Find a format that matches the first part of the URI */
322                for (tmp=formats_list;tmp;tmp=tmp->next) {
323                        if (strlen(scan) == strlen(tmp->name) &&
324                                        strncasecmp(scan, tmp->name, strlen(scan)) == 0
325                                        ) {
326                                libtrace->format=tmp;
327                                break;
328                        }
329                }
330
331                if (libtrace->format == 0) {
332                        trace_set_err(libtrace, TRACE_ERR_BAD_FORMAT,
333                                        "Unknown format (%s)",scan);
334                        return libtrace;
335                }
336
337                libtrace->uridata = strdup(uridata);
338        }
339        /* libtrace->format now contains the type of uri
340         * libtrace->uridata contains the appropriate data for this
341         */
342
343        /* Call the init_input function for the matching capture format */
344        if (libtrace->format->init_input) {
345                int err=libtrace->format->init_input(libtrace);
346                if (err==-1) {
347                        /* init_input should call trace_set_err to set the
348                         * error message
349                         */
350                        return libtrace;
351                }
352        } else {
353                trace_set_err(libtrace,TRACE_ERR_UNSUPPORTED,
354                                "Format does not support input (%s)",scan);
355                return libtrace;
356        }
357
358        if (scan)
359                free(scan);
360        libtrace->err.err_num=TRACE_ERR_NOERROR;
361        libtrace->err.problem[0]='\0';
362        return libtrace;
363}
364
365/* Creates a "dummy" trace file that has only the format type set.
366 *
367 * @returns opaque pointer to a (sparsely initialised) libtrace_t
368 *
369 * IMPORTANT: Do not attempt to call trace_read_packet or other such functions
370 * with the dummy trace. Its intended purpose is to act as a packet->trace for
371 * libtrace_packet_t's that are not associated with a libtrace_t structure.
372 */
373DLLEXPORT libtrace_t * trace_create_dead (const char *uri) {
374        libtrace_t *libtrace = (libtrace_t *) malloc(sizeof(libtrace_t));
375        char *scan = (char *)calloc(sizeof(char),URI_PROTO_LINE);
376        char *uridata;
377        struct libtrace_format_t *tmp;
378
379        trace_init();
380
381        libtrace->err.err_num = TRACE_ERR_NOERROR;
382
383        if((uridata = strchr(uri,':')) == NULL) {
384                xstrncpy(scan, uri, strlen(uri), URI_PROTO_LINE);
385        } else {
386                xstrncpy(scan,uri, (size_t)(uridata - uri), URI_PROTO_LINE);
387        }
388
389        libtrace->err.err_num = TRACE_ERR_NOERROR;
390        libtrace->format=NULL;
391
392        libtrace->event.packet = NULL;
393        libtrace->event.psize = 0;
394        libtrace->event.first_ts = 0;
395        libtrace->event.first_now = 0;
396        libtrace->filter = NULL;
397        libtrace->snaplen = 0;
398        libtrace->started=false;
399        libtrace->uridata = NULL;
400        libtrace->io = NULL;
401        libtrace->filtered_packets = 0;
402        libtrace->accepted_packets = 0;
403        libtrace->last_packet = NULL;
404
405        /* Parallel inits */
406        ASSERT_RET(pthread_mutex_init(&libtrace->libtrace_lock, NULL), == 0);
407        ASSERT_RET(pthread_mutex_init(&libtrace->read_packet_lock, NULL), == 0);
408        ASSERT_RET(pthread_cond_init(&libtrace->perpkt_cond, NULL), == 0);
409        libtrace->state = STATE_NEW; // TODO MAYBE DEAD
410        libtrace->perpkt_queue_full = false;
411        libtrace->global_blob = NULL;
412        libtrace->hasher = NULL;
413        libtrace_zero_ocache(&libtrace->packet_freelist);
414        libtrace_zero_thread(&libtrace->hasher_thread);
415        libtrace_zero_thread(&libtrace->reporter_thread);
416        libtrace_zero_thread(&libtrace->keepalive_thread);
417        libtrace->reporter_thread.type = THREAD_EMPTY;
418        libtrace->perpkt_thread_count = 0;
419        libtrace->perpkt_threads = NULL;
420        libtrace->tracetime = 0;
421        libtrace->stats = NULL;
422        libtrace->pread = NULL;
423        libtrace->sequence_number = 0;
424        ZERO_USER_CONFIG(libtrace->config);
425        memset(&libtrace->combiner, 0, sizeof(libtrace->combiner));
426        libtrace->perpkt_cbs = NULL;
427        libtrace->reporter_cbs = NULL;
428        for(tmp=formats_list;tmp;tmp=tmp->next) {
429                if (strlen(scan) == strlen(tmp->name) &&
430                                !strncasecmp(scan,
431                                        tmp->name,
432                                        strlen(scan))) {
433                                libtrace->format=tmp;
434                                break;
435                                }
436        }
437        if (libtrace->format == 0) {
438                trace_set_err(libtrace,TRACE_ERR_BAD_FORMAT,
439                                "Unknown format (%s)",scan);
440        }
441
442        libtrace->format_data = NULL;
443        free(scan);
444        return libtrace;
445
446}
447
448/* Creates an output trace from a URI.
449 *
450 * @param uri   the uri string describing the output format and destination
451 * @returns opaque pointer to a libtrace_output_t
452 *
453 *  If an error occured when attempting to open the output trace, NULL is
454 *  returned and trace_errno is set.
455 */
456
457DLLEXPORT libtrace_out_t *trace_create_output(const char *uri) {
458        libtrace_out_t *libtrace =
459                        (libtrace_out_t*)malloc(sizeof(libtrace_out_t));
460
461        char *scan = 0;
462        const char *uridata = 0;
463        struct libtrace_format_t *tmp;
464
465        trace_init();
466
467        libtrace->err.err_num = TRACE_ERR_NOERROR;
468        strcpy(libtrace->err.problem,"Error message set\n");
469        libtrace->format = NULL;
470        libtrace->uridata = NULL;
471
472        /* Parse the URI to determine what capture format we want to write */
473
474        if ((uridata = trace_parse_uri(uri, &scan)) == 0) {
475                trace_set_err_out(libtrace,TRACE_ERR_BAD_FORMAT,
476                                "Bad uri format (%s)",uri);
477                return libtrace;
478        }
479
480        /* Attempt to find the format in the list of supported formats */
481        for(tmp=formats_list;tmp;tmp=tmp->next) {
482                if (strlen(scan) == strlen(tmp->name) &&
483                                !strncasecmp(scan,
484                                        tmp->name,
485                                        strlen(scan))) {
486                                libtrace->format=tmp;
487                                break;
488                                }
489        }
490        free(scan);
491
492        if (libtrace->format == NULL) {
493                trace_set_err_out(libtrace,TRACE_ERR_BAD_FORMAT,
494                                "Unknown output format (%s)",scan);
495                return libtrace;
496        }
497        libtrace->uridata = strdup(uridata);
498
499        /* libtrace->format now contains the type of uri
500         * libtrace->uridata contains the appropriate data for this
501         */
502
503        if (libtrace->format->init_output) {
504                int err = libtrace->format->init_output(libtrace);
505                if (err == -1) {
506                        /* init_output should call trace_set_err to set the
507                         * error message
508                         */
509                        return libtrace;
510                }
511        } else {
512                trace_set_err_out(libtrace,TRACE_ERR_UNSUPPORTED,
513                                "Format does not support writing (%s)",scan);
514                return libtrace;
515        }
516
517
518        libtrace->started=false;
519        return libtrace;
520}
521
522/* Start an input trace
523 * @param libtrace      the input trace to start
524 * @returns 0 on success
525 *
526 * This does the work associated with actually starting up
527 * the trace.  it may fail.
528 */
529DLLEXPORT int trace_start(libtrace_t *libtrace)
530{
531        if(!libtrace) {
532                fprintf(stderr, "NULL trace passed to trace_start()\n");
533                return TRACE_ERR_NULL_TRACE;
534        }
535
536        if (trace_is_err(libtrace))
537                return -1;
538        if (libtrace->format->start_input) {
539                int ret=libtrace->format->start_input(libtrace);
540                if (ret < 0) {
541                        return ret;
542                }
543        }
544        libtrace->startcount ++;
545        libtrace->started=true;
546        return 0;
547}
548
549/* Start an output trace */
550DLLEXPORT int trace_start_output(libtrace_out_t *libtrace)
551{
552        if(!libtrace) {
553                fprintf(stderr, "NULL trace passed to trace_start_output()\n");
554                return TRACE_ERR_NULL_TRACE;
555        }
556        if (libtrace->format->start_output) {
557                int ret=libtrace->format->start_output(libtrace);
558                if (ret < 0) {
559                        return ret;
560                }
561        }
562
563        libtrace->started=true;
564        return 0;
565}
566
567DLLEXPORT int trace_pause(libtrace_t *libtrace)
568{
569        if(!libtrace) {
570                fprintf(stderr, "NULL trace passed to trace_pause()\n");
571                return TRACE_ERR_NULL_TRACE;
572        }
573        if (!libtrace->started) {
574                trace_set_err(libtrace,TRACE_ERR_BAD_STATE, "You must call trace_start() before calling trace_pause()");
575                return -1;
576        }
577
578        /* Finish the last packet we read - for backwards compatibility */
579        if (!libtrace_parallel && libtrace->last_packet)
580                trace_fin_packet(libtrace->last_packet);
581        if(libtrace->last_packet != NULL) {
582                trace_set_err(libtrace, TRACE_ERR_PAUSE_FIN, "Unable to remove all data stored against trace in trace_pause()");
583                return -1;
584        }
585
586        if (libtrace->format->pause_input)
587                libtrace->format->pause_input(libtrace);
588
589        libtrace->started=false;
590        return 0;
591}
592
593DLLEXPORT int trace_config(libtrace_t *libtrace,
594                trace_option_t option,
595                void *value)
596{
597        int ret;
598
599        if (trace_is_err(libtrace)) {
600                return -1;
601        }
602
603        if (option == TRACE_OPTION_HASHER)
604                return trace_set_hasher(libtrace,
605                                        (enum hasher_types) *((int *) value),
606                                        NULL, NULL);
607
608        /* If the capture format supports configuration, try using their
609         * native configuration first */
610        if (libtrace->format->config_input) {
611                ret=libtrace->format->config_input(libtrace,option,value);
612                if (ret==0)
613                        return 0;
614        }
615
616        /* If we get here, either the native configuration failed or the
617         * format did not support configuration. However, libtrace can
618         * deal with some options itself, so give that a go */
619        switch(option) {
620                case TRACE_OPTION_REPLAY_SPEEDUP:
621                        /* Clear the error if there was one */
622                        if (trace_is_err(libtrace)) {
623                                trace_get_err(libtrace);
624                        }
625                        if (*(int*)value<1
626                                || *(int*)value>LIBTRACE_MAX_REPLAY_SPEEDUP) {
627                                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,
628                                        "Invalid replay speed");
629                        }
630                        libtrace->replayspeedup=*(int*)value;
631                        return 0;
632
633                case TRACE_OPTION_SNAPLEN:
634                        /* Clear the error if there was one */
635                        if (trace_is_err(libtrace)) {
636                                trace_get_err(libtrace);
637                        }
638                        if (*(int*)value<0
639                                || *(int*)value>LIBTRACE_PACKET_BUFSIZE) {
640                                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,
641                                        "Invalid snap length");
642                        }
643                        libtrace->snaplen=*(int*)value;
644                        return 0;
645                case TRACE_OPTION_FILTER:
646                        /* Clear the error if there was one */
647                        if (trace_is_err(libtrace)) {
648                                trace_get_err(libtrace);
649                        }
650                        libtrace->filter=(libtrace_filter_t *)value;
651                        return 0;
652                case TRACE_OPTION_PROMISC:
653                        if (!trace_is_err(libtrace)) {
654                                trace_set_err(libtrace,TRACE_ERR_OPTION_UNAVAIL,
655                                                "Promisc mode is not supported by this format module");
656                        }
657                        return -1;
658                case TRACE_OPTION_META_FREQ:
659                        if (!trace_is_err(libtrace)) {
660                                trace_set_err(libtrace,
661                                                TRACE_ERR_OPTION_UNAVAIL,
662                                                "This format does not support meta-data gathering");
663                        }
664                        return -1;
665                case TRACE_OPTION_EVENT_REALTIME:
666                        if (!trace_is_err(libtrace)) {
667                                trace_set_err(libtrace,
668                                                TRACE_ERR_OPTION_UNAVAIL,
669                                                "This format does not support realtime events");
670                        }
671                        return -1;
672                case TRACE_OPTION_HASHER:
673                        /* Dealt with earlier */
674                        return -1;
675
676        }
677        if (!trace_is_err(libtrace)) {
678                trace_set_err(libtrace,TRACE_ERR_UNKNOWN_OPTION,
679                        "Unknown option %i", option);
680        }
681        return -1;
682}
683
684DLLEXPORT int trace_set_snaplen(libtrace_t *trace, int snaplen) {
685        return trace_config(trace, TRACE_OPTION_SNAPLEN, &snaplen);
686}
687
688DLLEXPORT int trace_set_promisc(libtrace_t *trace, bool promisc) {
689        int tmp = promisc;
690        return trace_config(trace, TRACE_OPTION_PROMISC, &tmp);
691}
692
693DLLEXPORT int trace_set_filter(libtrace_t *trace, libtrace_filter_t *filter) {
694        return trace_config(trace, TRACE_OPTION_FILTER, filter);
695}
696
697DLLEXPORT int trace_set_meta_freq(libtrace_t *trace, int freq) {
698        return trace_config(trace, TRACE_OPTION_META_FREQ, &freq);
699}
700
701DLLEXPORT int trace_set_event_realtime(libtrace_t *trace, bool realtime) {
702        int tmp = realtime;
703        return trace_config(trace, TRACE_OPTION_EVENT_REALTIME, &tmp);
704}
705
706DLLEXPORT int trace_config_output(libtrace_out_t *libtrace, 
707                trace_option_output_t option,
708                void *value) {
709
710        /* Unlike the input options, libtrace does not natively support any of
711         * the output options - the format module must be able to deal with
712         * them. */
713        if (libtrace->format->config_output) {
714                return libtrace->format->config_output(libtrace, option, value);
715        }
716        return -1;
717}
718
719/* Close an input trace file, freeing up any resources it may have been using
720 *
721 */
722DLLEXPORT void trace_destroy(libtrace_t *libtrace) {
723        int i;
724
725        if(!libtrace) {
726                fprintf(stderr, "NULL trace passed to trace_destroy()\n");
727                return;
728        }
729
730        ASSERT_RET(pthread_mutex_destroy(&libtrace->libtrace_lock), == 0);
731        ASSERT_RET(pthread_mutex_destroy(&libtrace->read_packet_lock), == 0);
732        ASSERT_RET(pthread_cond_destroy(&libtrace->perpkt_cond), == 0);
733
734        /* destroy any packets that are still around */
735        if (libtrace->state != STATE_NEW && libtrace->first_packets.packets) {
736                for (i = 0; i < libtrace->perpkt_thread_count; ++i) {
737                        if(libtrace->first_packets.packets[i].packet) {
738                                trace_destroy_packet(libtrace->first_packets.packets[i].packet);
739                        }
740                }
741                free(libtrace->first_packets.packets);
742                ASSERT_RET(pthread_spin_destroy(&libtrace->first_packets.lock), == 0);
743        }
744
745        /* Finish any the last packet we read - for backwards compatibility */
746        if (!libtrace_parallel && libtrace->last_packet) {
747                trace_fin_packet(libtrace->last_packet);
748        }
749        if (libtrace->last_packet != NULL) {
750                trace_set_err(libtrace, TRACE_ERR_PAUSE_FIN, "Unable to remove all data stored against trace in trace_destroy()");
751                return;
752        }
753
754        if (libtrace->format) {
755                if (libtrace->started && libtrace->format->pause_input)
756                        libtrace->format->pause_input(libtrace);
757                if (libtrace->format->fin_input)
758                        libtrace->format->fin_input(libtrace);
759        }
760        /* Need to free things! */
761        if (libtrace->uridata)
762                free(libtrace->uridata);
763
764        if (libtrace->stats)
765                free(libtrace->stats);
766
767        /* Empty any packet memory */
768        if (libtrace->state != STATE_NEW) {
769                // This has all of our packets
770                libtrace_ocache_destroy(&libtrace->packet_freelist);
771                for (i = 0; i < libtrace->perpkt_thread_count; ++i) {
772                        libtrace_message_queue_destroy(&libtrace->perpkt_threads[i].messages);
773                }
774                if (libtrace->hasher_thread.type == THREAD_HASHER)
775                        libtrace_message_queue_destroy(&libtrace->hasher_thread.messages);
776                if (libtrace->keepalive_thread.type == THREAD_KEEPALIVE)
777                        libtrace_message_queue_destroy(&libtrace->keepalive_thread.messages);
778                if (libtrace->reporter_thread.type == THREAD_REPORTER)
779                        libtrace_message_queue_destroy(&libtrace->reporter_thread.messages);
780
781
782                if (libtrace->combiner.destroy && libtrace->reporter_cbs)
783                        libtrace->combiner.destroy(libtrace, &libtrace->combiner);
784                free(libtrace->perpkt_threads);
785                libtrace->perpkt_threads = NULL;
786                libtrace->perpkt_thread_count = 0;
787
788        }
789
790        if (libtrace->hasher_owner == HASH_OWNED_LIBTRACE) {
791                if (libtrace->hasher_data) {
792                        free(libtrace->hasher_data);
793                }
794        }
795
796
797        if (libtrace->perpkt_cbs)
798                trace_destroy_callback_set(libtrace->perpkt_cbs);
799        if (libtrace->reporter_cbs)
800                trace_destroy_callback_set(libtrace->reporter_cbs);
801
802        if (libtrace->event.packet) {
803                /* Don't use trace_destroy_packet here - there is almost
804                 * certainly going to be another libtrace_packet_t that is
805                 * pointing to the buffer for this packet, so we don't want
806                 * to free it. Rather, it will get freed when the user calls
807                 * trace_destroy_packet on the libtrace_packet_t that they
808                 * own.
809                 *
810                 * All we need to do then is free our packet structure itself.
811                 */
812                 free(libtrace->event.packet);
813        }
814
815        free(libtrace);
816}
817
818
819DLLEXPORT void trace_destroy_dead(libtrace_t *libtrace) {
820        if(!libtrace) {
821                fprintf(stderr, "NULL trace passed to trace_destroy_dead()\n");
822                return;
823        }
824
825        ASSERT_RET(pthread_mutex_destroy(&libtrace->libtrace_lock), == 0);
826        ASSERT_RET(pthread_mutex_destroy(&libtrace->read_packet_lock), == 0);
827        ASSERT_RET(pthread_cond_destroy(&libtrace->perpkt_cond), == 0);
828
829        /* Don't call pause_input or fin_input, because we should never have
830         * used this trace to do any reading anyway. Do make sure we free
831         * any format_data that has been created, though. */
832        if (libtrace->format_data)
833                free(libtrace->format_data);
834        free(libtrace);
835}
836/* Close an output trace file, freeing up any resources it may have been using
837 *
838 * @param libtrace      the output trace file to be destroyed
839 */
840DLLEXPORT void trace_destroy_output(libtrace_out_t *libtrace) {
841        if(!libtrace) {
842                fprintf(stderr, "NULL trace passed to trace_destroy_output()\n");
843                return;
844        }
845        if (libtrace->format && libtrace->format->fin_output)
846                libtrace->format->fin_output(libtrace);
847        if (libtrace->uridata)
848                free(libtrace->uridata);
849        free(libtrace);
850}
851
852DLLEXPORT int trace_flush_output(libtrace_out_t *libtrace) {
853        if (!libtrace) {
854                fprintf(stderr, "NULL trace passed to trace_flush_output()\n");
855                return TRACE_ERR_NULL_TRACE;
856        }
857        if (libtrace->format && libtrace->format->flush_output) {
858                return libtrace->format->flush_output(libtrace);
859        }
860
861        return 0;
862}
863
864DLLEXPORT libtrace_packet_t *trace_create_packet(void)
865{
866        libtrace_packet_t *packet =
867                (libtrace_packet_t*)calloc((size_t)1,sizeof(libtrace_packet_t));
868
869        if (packet == NULL)
870                return NULL;
871
872        packet->buf_control=TRACE_CTRL_PACKET;
873        packet->which_trace_start = 0;
874        pthread_mutex_init(&(packet->ref_lock), NULL);
875        trace_clear_cache(packet);
876        return packet;
877}
878
879DLLEXPORT libtrace_packet_t *trace_copy_packet(const libtrace_packet_t *packet) {
880        libtrace_packet_t *dest;
881
882        if (packet->which_trace_start != packet->trace->startcount) {
883                return NULL;
884        }
885
886        dest = (libtrace_packet_t *)calloc((size_t)1, sizeof(libtrace_packet_t));
887        if (!dest) {
888                printf("Out of memory constructing packet\n");
889                abort();
890        }
891        dest->trace=packet->trace;
892        dest->buffer=malloc(65536);
893        if (!dest->buffer) {
894                printf("Out of memory allocating buffer memory\n");
895                abort();
896        }
897        dest->header=dest->buffer;
898        dest->payload=(void*)
899                ((char*)dest->buffer+trace_get_framing_length(packet));
900        dest->type=packet->type;
901        dest->buf_control=TRACE_CTRL_PACKET;
902        dest->order = packet->order;
903        dest->hash = packet->hash;
904        dest->error = packet->error;
905        dest->which_trace_start = packet->which_trace_start;
906        /* Reset the cache - better to recalculate than try to convert
907         * the values over to the new packet */
908        trace_clear_cache(dest);
909        /* Ooooh nasty memcpys! This is why we want to avoid copying packets
910         * as much as possible */
911        memcpy(dest->header,packet->header,trace_get_framing_length(packet));
912        memcpy(dest->payload,packet->payload,trace_get_capture_length(packet));
913
914        return dest;
915}
916
917/** Destroy a packet object
918 */
919DLLEXPORT void trace_destroy_packet(libtrace_packet_t *packet) {
920        /* Free any resources possibly associated with the packet */
921        if (libtrace_parallel && packet->trace && packet->trace->format->fin_packet) {
922                packet->trace->format->fin_packet(packet);
923        }
924        if (!libtrace_parallel && packet->trace &&
925             packet->trace->last_packet == packet) {
926                packet->trace->last_packet = NULL;
927        }
928
929        if (packet->buf_control == TRACE_CTRL_PACKET && packet->buffer) {
930                free(packet->buffer);
931        }
932        pthread_mutex_destroy(&(packet->ref_lock));
933        packet->buf_control=(buf_control_t)'\0';
934                                /* A "bad" value to force an assert
935                                 * if this packet is ever reused
936                                 */
937        free(packet);
938}
939
940/**
941 * Removes any possible data stored againt the trace and releases any data.
942 * This will not destroy a reusable good malloc'd buffer (TRACE_CTRL_PACKET)
943 * use trace_destroy_packet() for those diabolical purposes.
944 */
945void trace_fin_packet(libtrace_packet_t *packet) {
946        if (packet)
947        {
948                if (packet->trace && packet->trace->format->fin_packet) {
949                        packet->trace->format->fin_packet(packet);
950                }
951
952                if (packet->srcbucket && packet->internalid != 0) {
953                        libtrace_bucket_t *b = (libtrace_bucket_t *)packet->srcbucket;
954                        libtrace_release_bucket_id(b, packet->internalid);
955                }
956
957                if (packet->trace) {
958                        if (!libtrace_parallel && packet->trace->last_packet == packet)
959                                packet->trace->last_packet = NULL;
960                }
961
962                // No matter what we remove the header and link pointers
963                packet->trace = NULL;
964                packet->header = NULL;
965                packet->payload = NULL;
966
967                if (packet->buf_control != TRACE_CTRL_PACKET)
968                {
969                        packet->buffer = NULL;
970                }
971
972                trace_clear_cache(packet);
973                packet->hash = 0;
974                packet->order = 0;
975                packet->srcbucket = NULL;
976        }
977}
978
979/* Read one packet from the trace into buffer. Note that this function will
980 * block until a packet is read (or EOF is reached).
981 *
982 * @param libtrace      the libtrace opaque pointer
983 * @param packet        the packet opaque pointer
984 * @returns 0 on EOF, negative value on error
985 *
986 */
987DLLEXPORT int trace_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
988
989        if (!libtrace) {
990                fprintf(stderr, "NULL trace passed to trace_read_packet()\n");
991                return TRACE_ERR_NULL_TRACE;
992        }
993
994        if (trace_is_err(libtrace))
995                return -1;
996
997        if (!libtrace->started) {
998                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,"You must call libtrace_start() before trace_read_packet()");
999                return -1;
1000        }
1001
1002        if (!packet) {
1003                trace_set_err(libtrace, TRACE_ERR_NULL_PACKET, "NULL packet passed into trace_read_packet()");
1004                return -1;
1005        }
1006
1007        if (!(packet->buf_control==TRACE_CTRL_PACKET
1008                    || packet->buf_control==TRACE_CTRL_EXTERNAL)) {
1009                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,"Packet passed to trace_read_packet() is invalid");
1010                return -1;
1011        }
1012
1013        if (libtrace->format->read_packet) {
1014                /* Finalise the packet, freeing any resources the format module
1015                 * may have allocated it and zeroing all data associated with it.
1016                 */
1017                if (packet->trace == libtrace) {
1018                        trace_fin_packet(packet);
1019                }
1020                do {
1021                        size_t ret;
1022                        int filtret;
1023                        if ((ret=is_halted(libtrace)) != (size_t)-1)
1024                                return ret;
1025                        /* Store the trace we are reading from into the packet opaque
1026                         * structure */
1027                        packet->trace = libtrace;
1028                        packet->which_trace_start = libtrace->startcount;
1029                        ret=libtrace->format->read_packet(libtrace,packet);
1030                        if (ret==(size_t)READ_MESSAGE ||
1031                            ret==(size_t)-1 || ret==0) {
1032                                packet->trace = NULL;
1033                                return ret;
1034                        }
1035                        if (libtrace->filter) {
1036                                /* If the filter doesn't match, read another
1037                                 * packet
1038                                 */
1039                                filtret = trace_apply_filter(libtrace->filter, packet);
1040                                if (filtret == -1) {
1041                                        /* Error compiling filter, probably */
1042                                        return ~0U;
1043                                }
1044
1045                                if (filtret == 0) {
1046                                        ++libtrace->filtered_packets;
1047                                        trace_fin_packet(packet);
1048                                        continue;
1049                                }
1050                        }
1051                        if (libtrace->snaplen>0) {
1052                                /* Snap the packet */
1053                                trace_set_capture_length(packet,
1054                                                libtrace->snaplen);
1055                        }
1056                        if (!IS_LIBTRACE_META_PACKET(packet)) {
1057                                ++libtrace->accepted_packets;
1058                        }
1059                        if (packet->order == 0) {
1060                                trace_packet_set_order(packet, libtrace->sequence_number);
1061                        }
1062                        ++libtrace->sequence_number;
1063                        if (!libtrace_parallel && packet->trace == libtrace)
1064                                libtrace->last_packet = packet;
1065
1066                        return ret;
1067                } while(1);
1068        }
1069        trace_set_err(libtrace,TRACE_ERR_UNSUPPORTED,"This format does not support reading packets\n");
1070        return ~0U;
1071}
1072
1073/* Converts the provided buffer into a libtrace packet of the given type.
1074 *
1075 * Unlike trace_construct_packet, the buffer is expected to begin with the
1076 * appropriate capture format header for the format type that the packet is
1077 * being converted to. This also allows for a packet to be converted into
1078 * just about capture format that is supported by libtrace, provided the
1079 * format header is present in the buffer.
1080 *
1081 * This function is primarily used to convert packets received via the RT
1082 * protocol back into their original capture format. The RT header encapsulates
1083 * the original capture format header, so after removing it the packet must
1084 * have it's header and payload pointers updated and the packet format and type
1085 * changed, amongst other things.
1086 *
1087 * Intended only for internal use at this point - this function is not
1088 * available through the external libtrace API.
1089 */
1090int trace_prepare_packet(libtrace_t *trace, libtrace_packet_t *packet,
1091                void *buffer, libtrace_rt_types_t rt_type, uint32_t flags) {
1092
1093        if (!trace) {
1094                fprintf(stderr, "NULL trace passed into trace_prepare_packet()\n");
1095                return TRACE_ERR_NULL_TRACE;
1096        }
1097
1098        if (!packet) {
1099                trace_set_err(trace, TRACE_ERR_NULL_TRACE, "NULL packet passed into trace_prepare_packet()");
1100                return -1;
1101        }
1102
1103        if (!buffer) {
1104                trace_set_err(trace, TRACE_ERR_NULL_BUFFER, "NULL buffer passed into trace_prepare_packet()");
1105                return -1;
1106        }
1107
1108        if (!(packet->buf_control==TRACE_CTRL_PACKET || packet->buf_control==TRACE_CTRL_EXTERNAL)) {
1109                trace_set_err(trace,TRACE_ERR_BAD_STATE,"Packet passed to trace_read_packet() is invalid");
1110                return -1;
1111        }
1112
1113        packet->trace = trace;
1114        if (!libtrace_parallel)
1115                trace->last_packet = packet;
1116        /* Clear packet cache */
1117        trace_clear_cache(packet);
1118
1119        if (trace->format->prepare_packet) {
1120                return trace->format->prepare_packet(trace, packet,
1121                                buffer, rt_type, flags);
1122        }
1123        trace_set_err(trace, TRACE_ERR_UNSUPPORTED,
1124                        "This format does not support preparing packets");
1125        return -1;
1126
1127}
1128
1129/* Writes a packet to the specified output trace
1130 *
1131 * @param libtrace      describes the output format, destination, etc.
1132 * @param packet        the packet to be written out
1133 * @returns the number of bytes written, -1 if write failed
1134 */
1135DLLEXPORT int trace_write_packet(libtrace_out_t *libtrace, libtrace_packet_t *packet) {
1136
1137        if (!libtrace) {
1138                fprintf(stderr, "NULL trace passed into trace_write_packet()\n");
1139                return TRACE_ERR_NULL_TRACE;
1140        }
1141        if (!packet) {
1142                trace_set_err_out(libtrace, TRACE_ERR_NULL_PACKET, "NULL trace passed into trace_write_packet()");
1143                return -1;
1144        }
1145        /* Verify the packet is valid */
1146        if (!libtrace->started) {
1147                trace_set_err_out(libtrace,TRACE_ERR_BAD_STATE,
1148                        "You must call trace_start_output() before calling trace_write_packet()");
1149                return -1;
1150        }
1151
1152        /* Don't try to convert meta-packets across formats */
1153        if (strcmp(libtrace->format->name, packet->trace->format->name) != 0 &&
1154                        IS_LIBTRACE_META_PACKET(packet)) {
1155                return 0;
1156        }
1157
1158        if (libtrace->format->write_packet) {
1159                return libtrace->format->write_packet(libtrace, packet);
1160        }
1161        trace_set_err_out(libtrace,TRACE_ERR_UNSUPPORTED,
1162                "This format does not support writing packets");
1163        return -1;
1164}
1165
1166/* Get a pointer to the first byte of the packet payload */
1167DLLEXPORT void *trace_get_packet_buffer(const libtrace_packet_t *packet,
1168                libtrace_linktype_t *linktype, uint32_t *remaining) {
1169        int cap_len;
1170        int wire_len;
1171        libtrace_linktype_t ltype;
1172
1173        if (!packet) {
1174                fprintf(stderr, "NULL packet passed into trace_get_packet_buffer()\n");
1175                return NULL;
1176        }
1177        ltype = trace_get_link_type(packet);
1178
1179        if (linktype) {
1180                *linktype = ltype;
1181        }
1182
1183        if (ltype == TRACE_TYPE_CONTENT_INVALID) {
1184                if (remaining) {
1185                        *remaining = 0;
1186                }
1187                return NULL;
1188        }
1189
1190        if (remaining) {
1191                /* I think we should choose the minimum of the capture and
1192                 * wire lengths to be the "remaining" value. If the packet has
1193                 * been padded to increase the capture length, we don't want
1194                 * to allow subsequent protocol decoders to consider the
1195                 * padding as part of the packet.
1196                 *
1197                 * For example, in Auck 4 there is a trace where the IP header
1198                 * length is incorrect (24 bytes) followed by a 20 byte TCP
1199                 * header. Total IP length is 40 bytes. As a result, the
1200                 * legacyatm padding gets treated as the "missing" bytes of
1201                 * the TCP header, which isn't the greatest. We're probably
1202                 * better off returning an incomplete TCP header in that case.
1203                 */
1204
1205                cap_len = trace_get_capture_length(packet);
1206                wire_len = trace_get_wire_length(packet);
1207
1208                if (!(cap_len >= 0)) {
1209                        fprintf(stderr, "Was expecting capture length of atleast 0 in trace_get_packet_buffer()\n");
1210                        return NULL;
1211                }
1212
1213                /* There is the odd corrupt packet, e.g. in IPLS II, that have
1214                 * massively negative wire lens. We could assert fail here on
1215                 * them, but we could at least try the capture length instead.
1216                 *
1217                 * You may still run into problems if you try to write that
1218                 * packet, but at least reading should work OK.
1219                 */
1220                if (wire_len < 0)
1221                        *remaining = cap_len;
1222                else if (wire_len < cap_len)
1223                        *remaining = wire_len;
1224                else
1225                        *remaining = cap_len;
1226                /* *remaining = trace_get_capture_length(packet); */
1227        }
1228        return (void *) packet->payload;
1229}
1230
1231
1232/* Get a pointer to the first byte of the packet payload
1233 *
1234 * DEPRECATED - use trace_get_packet_buffer() instead */
1235DLLEXPORT void *trace_get_link(const libtrace_packet_t *packet) {
1236        return (void *)packet->payload;
1237}
1238
1239/* Get the current time in DAG time format
1240 * @param packet        a pointer to a libtrace_packet structure
1241 * @returns a 64 bit timestamp in DAG ERF format (upper 32 bits are the seconds
1242 * past 1970-01-01, the lower 32bits are partial seconds)
1243 */
1244DLLEXPORT uint64_t trace_get_erf_timestamp(const libtrace_packet_t *packet) {
1245        if (packet->which_trace_start != packet->trace->startcount) {
1246                return (uint64_t)0;
1247        }
1248
1249        if (packet->trace->format->get_erf_timestamp) {
1250                /* timestamp -> timestamp */
1251                return packet->trace->format->get_erf_timestamp(packet);
1252        } else if (packet->trace->format->get_timespec) {
1253                /* timespec -> timestamp */
1254                struct timespec ts;
1255                ts = packet->trace->format->get_timespec(packet);
1256                return ((((uint64_t)ts.tv_sec) << 32) +
1257                                (((uint64_t)ts.tv_nsec << 32)/1000000000));
1258        } else if (packet->trace->format->get_timeval) {
1259                /* timeval -> timestamp */
1260                struct timeval tv;
1261                tv = packet->trace->format->get_timeval(packet);
1262                return ((((uint64_t)tv.tv_sec) << 32) +
1263                                (((uint64_t)tv.tv_usec << 32)/1000000));
1264        } else if (packet->trace->format->get_seconds) {
1265                /* seconds -> timestamp */
1266                double seconds = packet->trace->format->get_seconds(packet);
1267                return (((uint64_t)seconds)<<32)
1268                          + (uint64_t)((seconds-(uint64_t)seconds)*UINT_MAX);
1269        }
1270        else {
1271                return (uint64_t)0;
1272        }
1273}
1274
1275/* Get the current time in struct timeval
1276 * @param packet        a pointer to a libtrace_packet structure
1277 *
1278 * @returns time that this packet was seen in a struct timeval
1279 * @author Daniel Lawson
1280 * @author Perry Lorier
1281 */
1282DLLEXPORT struct timeval trace_get_timeval(const libtrace_packet_t *packet) {
1283        struct timeval tv;
1284        uint64_t ts = 0;
1285
1286        if (packet->which_trace_start != packet->trace->startcount) {
1287                tv.tv_sec=-1;
1288                tv.tv_usec=-1;
1289        } else if (packet->trace->format->get_timeval) {
1290                /* timeval -> timeval */
1291                tv = packet->trace->format->get_timeval(packet);
1292        } else if (packet->trace->format->get_erf_timestamp) {
1293                /* timestamp -> timeval */
1294                ts = packet->trace->format->get_erf_timestamp(packet);
1295                tv.tv_sec = ts >> 32;
1296                tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
1297                if (tv.tv_usec >= 1000000) {
1298                        tv.tv_usec -= 1000000;
1299                        tv.tv_sec += 1;
1300                }
1301        } else if (packet->trace->format->get_timespec) {
1302                struct timespec ts = packet->trace->format->get_timespec(packet);
1303                tv.tv_sec = ts.tv_sec;
1304                tv.tv_usec = ts.tv_nsec/1000;
1305        } else if (packet->trace->format->get_seconds) {
1306                /* seconds -> timeval */
1307                double seconds = packet->trace->format->get_seconds(packet);
1308                tv.tv_sec = (uint32_t)seconds;
1309                tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
1310        }
1311        else {
1312                tv.tv_sec=-1;
1313                tv.tv_usec=-1;
1314        }
1315
1316    return tv;
1317}
1318
1319DLLEXPORT struct timespec trace_get_timespec(const libtrace_packet_t *packet) {
1320        struct timespec ts;
1321
1322        if (packet->which_trace_start != packet->trace->startcount) {
1323                ts.tv_sec=-1;
1324                ts.tv_nsec=-1;
1325        } else if (packet->trace->format->get_timespec) {
1326                return packet->trace->format->get_timespec(packet);
1327        } else if (packet->trace->format->get_erf_timestamp) {
1328                /* timestamp -> timeval */
1329                uint64_t erfts = packet->trace->format->get_erf_timestamp(packet);
1330                ts.tv_sec = erfts >> 32;
1331                ts.tv_nsec = ((erfts&0xFFFFFFFF)*1000000000)>>32;
1332                if (ts.tv_nsec >= 1000000000) {
1333                        ts.tv_nsec -= 1000000000;
1334                        ts.tv_sec += 1;
1335                }
1336        } else if (packet->trace->format->get_timeval) {
1337                /* timeval -> timespec */
1338                struct timeval tv = packet->trace->format->get_timeval(packet);
1339                ts.tv_sec = tv.tv_sec;
1340                ts.tv_nsec = tv.tv_usec*1000;
1341        } else if (packet->trace->format->get_seconds) {
1342                /* seconds -> timespec */
1343                double seconds = packet->trace->format->get_seconds(packet);
1344                ts.tv_sec = (uint32_t)seconds;
1345                ts.tv_nsec = (long)(((seconds - ts.tv_sec) * 1000000000)/UINT_MAX);
1346        }
1347        else {
1348                ts.tv_sec=-1;
1349                ts.tv_nsec=-1;
1350        }
1351        return ts;
1352}
1353
1354
1355/* Get the current time in floating point seconds
1356 * @param packet        a pointer to a libtrace_packet structure
1357 * @returns time that this packet was seen in 64bit floating point seconds
1358 */
1359DLLEXPORT double trace_get_seconds(const libtrace_packet_t *packet) {
1360        double seconds = 0.0;
1361
1362        if (packet->which_trace_start != packet->trace->startcount) {
1363                return 0.0;
1364        }
1365
1366        if (packet->trace->format->get_seconds) {
1367                /* seconds->seconds */
1368                seconds = packet->trace->format->get_seconds(packet);
1369        } else if (packet->trace->format->get_erf_timestamp) {
1370                /* timestamp -> seconds */
1371                uint64_t ts = 0;
1372                ts = packet->trace->format->get_erf_timestamp(packet);
1373                seconds =  (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
1374        } else if (packet->trace->format->get_timespec) {
1375                /* timespec -> seconds */
1376                struct timespec ts;
1377                ts = packet->trace->format->get_timespec(packet);
1378                seconds = ts.tv_sec + ((ts.tv_nsec * 1.0) / 1000000000);
1379        } else if (packet->trace->format->get_timeval) {
1380                /* timeval -> seconds */
1381                struct timeval tv;
1382                tv = packet->trace->format->get_timeval(packet);
1383                seconds = tv.tv_sec + ((tv.tv_usec * 1.0) / 1000000);
1384        }
1385
1386        return seconds;
1387}
1388
1389DLLEXPORT size_t trace_get_capture_length(const libtrace_packet_t *packet)
1390{
1391        /* Cache the capture length */
1392        if (packet->which_trace_start != packet->trace->startcount) {
1393                return ~0U;
1394        }
1395        if (packet->capture_length == -1) {
1396                if (!packet->trace->format->get_capture_length)
1397                        return ~0U;
1398                /* Cast away constness because this is "just" a cache */
1399                ((libtrace_packet_t*)packet)->capture_length =
1400                        packet->trace->format->get_capture_length(packet);
1401        }
1402
1403        if (!(packet->capture_length < LIBTRACE_PACKET_BUFSIZE)) {
1404                fprintf(stderr, "Capture length is greater than the buffer size in trace_get_capture_length()\n");
1405                return 0;
1406                /* should we be returning ~OU here? */
1407        }
1408
1409        return packet->capture_length;
1410}
1411
1412/* Get the size of the packet as it was seen on the wire.
1413 * @param packet        a pointer to a libtrace_packet structure
1414 *
1415 * @returns the size of the packet as it was on the wire.
1416 * @note Due to the trace being a header capture, or anonymisation this may
1417 * not be the same as the Capture Len.
1418 */
1419DLLEXPORT size_t trace_get_wire_length(const libtrace_packet_t *packet){
1420
1421        if (packet->which_trace_start != packet->trace->startcount) {
1422                return ~0U;
1423        }
1424
1425        if (packet->wire_length == -1) {
1426                if (!packet->trace->format->get_wire_length)
1427                        return ~0U;
1428                ((libtrace_packet_t *)packet)->wire_length =
1429                        packet->trace->format->get_wire_length(packet);
1430        }
1431
1432        if (!(packet->wire_length < LIBTRACE_PACKET_BUFSIZE)) {
1433                fprintf(stderr, "Wire length is greater than the buffer size in trace_get_wire_length()\n");
1434                return 0;
1435                /* should we be returning ~OU here? */
1436        }
1437        return packet->wire_length;
1438
1439}
1440
1441/* Get the length of the capture framing headers.
1442 * @param packet        the packet opaque pointer
1443 * @returns the size of the packet as it was on the wire.
1444 * @note this length corresponds to the difference between the size of a
1445 * captured packet in memory, and the captured length of the packet
1446 */
1447DLLEXPORT SIMPLE_FUNCTION
1448size_t trace_get_framing_length(const libtrace_packet_t *packet) {
1449        if (packet->which_trace_start != packet->trace->startcount) {
1450                return ~0U;
1451        }
1452
1453        if (packet->framing_length >= 0) {
1454                return packet->framing_length;
1455        }
1456
1457        if (packet->trace->format->get_framing_length) {
1458                ((libtrace_packet_t *)packet)->framing_length =
1459                       packet->trace->format->get_framing_length(packet);
1460                return packet->framing_length;
1461        }
1462        return ~0U;
1463}
1464
1465
1466/* Get the type of the link layer
1467 * @param packet        a pointer to a libtrace_packet structure
1468 * @returns libtrace_linktype_t
1469 */
1470DLLEXPORT libtrace_linktype_t trace_get_link_type(const libtrace_packet_t *packet ) {
1471
1472        if (packet->which_trace_start != packet->trace->startcount) {
1473                return TRACE_TYPE_CONTENT_INVALID;
1474        }
1475
1476        if (packet->link_type == 0) {
1477                if (!packet->trace->format->get_link_type)
1478                        return TRACE_TYPE_UNKNOWN;
1479                ((libtrace_packet_t *)packet)->link_type =
1480                        packet->trace->format->get_link_type(packet);
1481        }
1482
1483        return packet->link_type;
1484}
1485
1486/* process a libtrace event
1487 * @param trace the libtrace opaque pointer
1488 * @param packet the libtrace_packet opaque pointer
1489 * @returns
1490 *  TRACE_EVENT_IOWAIT  Waiting on I/O on fd
1491 *  TRACE_EVENT_SLEEP   Next event in seconds
1492 *  TRACE_EVENT_PACKET  Packet arrived in buffer with size size
1493 *  TRACE_EVENT_TERMINATE Trace terminated (perhaps with an error condition)
1494 * FIXME currently keeps a copy of the packet inside the trace pointer,
1495 * which in turn is stored inside the new packet object...
1496 */
1497DLLEXPORT libtrace_eventobj_t trace_event(libtrace_t *trace,
1498                libtrace_packet_t *packet) {
1499        libtrace_eventobj_t event = {TRACE_EVENT_IOWAIT,0,0.0,0};
1500
1501        if (!trace) {
1502                fprintf(stderr, "NULL trace passed into trace_event()");
1503                /* Return default event on error? */
1504                return event;
1505        }
1506        if (!packet) {
1507                trace_set_err(trace, TRACE_ERR_NULL_PACKET, "NULL packet passed into trace_event()");
1508                /* Return default event on error? */
1509                return event;
1510        }
1511
1512        /* Free the last packet */
1513        trace_fin_packet(packet);
1514        /* Store the trace we are reading from into the packet opaque
1515         * structure */
1516        packet->trace = trace;
1517
1518        if (packet->trace->format->trace_event) {
1519                /* Note: incrementing accepted, filtered etc. packet
1520                 * counters is handled by the format-specific
1521                 * function so don't increment them here.
1522                 */
1523                event=packet->trace->format->trace_event(trace,packet);
1524                }
1525        return event;
1526
1527}
1528
1529/** Setup a BPF filter based on pre-compiled byte-code.
1530 * @param bf_insns      A pointer to the start of the byte-code
1531 * @param bf_len        The number of BPF instructions
1532 * @returns             an opaque pointer to a libtrace_filter_t object
1533 * @note                The supplied byte-code is not checked for correctness.
1534 * @author              Scott Raynel
1535 */
1536DLLEXPORT libtrace_filter_t *
1537trace_create_filter_from_bytecode(void *bf_insns, unsigned int bf_len)
1538{
1539#ifndef HAVE_BPF
1540        fprintf(stderr, "This version of libtrace does not have BPF support\n");
1541        return NULL;
1542#else
1543        struct libtrace_filter_t *filter = (struct libtrace_filter_t *)
1544                malloc(sizeof(struct libtrace_filter_t));
1545        filter->filter.bf_insns = (struct bpf_insn *)
1546                malloc(sizeof(struct bpf_insn) * bf_len);
1547
1548        memcpy(filter->filter.bf_insns, bf_insns,
1549                        bf_len * sizeof(struct bpf_insn));
1550
1551        filter->filter.bf_len = bf_len;
1552        filter->filterstring = NULL;
1553        filter->jitfilter = NULL;
1554        /* "flag" indicates that the filter member is valid */
1555        filter->flag = 1;
1556
1557        return filter;
1558#endif
1559}
1560
1561/* Create a BPF filter
1562 * @param filterstring a char * containing the bpf filter string
1563 * @returns opaque pointer pointer to a libtrace_filter_t object
1564 */
1565DLLEXPORT libtrace_filter_t *trace_create_filter(const char *filterstring) {
1566#ifdef HAVE_BPF
1567        libtrace_filter_t *filter = (libtrace_filter_t*)
1568                                malloc(sizeof(libtrace_filter_t));
1569        filter->filterstring = strdup(filterstring);
1570        filter->jitfilter = NULL;
1571        filter->flag = 0;
1572        return filter;
1573#else
1574        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1575        return NULL;
1576#endif
1577}
1578
1579DLLEXPORT void trace_destroy_filter(libtrace_filter_t *filter)
1580{
1581#ifdef HAVE_BPF
1582        free(filter->filterstring);
1583        if (filter->flag)
1584                pcap_freecode(&filter->filter);
1585#ifdef HAVE_LLVM
1586        if (filter->jitfilter)
1587                destroy_program(filter->jitfilter);
1588#endif
1589        free(filter);
1590#else
1591
1592#endif
1593}
1594
1595/* Compile a bpf filter, now we know the link type for the trace that we're
1596 * applying it to.
1597 *
1598 * @internal
1599 *
1600 * @returns -1 on error, 0 on success
1601 */
1602static int trace_bpf_compile(libtrace_filter_t *filter,
1603                const libtrace_packet_t *packet,
1604                void *linkptr,
1605                libtrace_linktype_t linktype    ) {
1606#ifdef HAVE_BPF
1607        /* It just so happens that the underlying libs used by pthread arn't
1608         * thread safe, namely lex/flex thingys, so single threaded compile
1609         * multi threaded running should be safe.
1610         */
1611        static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
1612
1613        if (!packet) {
1614                fprintf(stderr, "NULL packet passed into trace_bpf_compile()");
1615                return TRACE_ERR_NULL_PACKET;
1616        }
1617
1618        if (!filter) {
1619                trace_set_err(packet->trace,
1620                                TRACE_ERR_NULL_FILTER, "Filter is NULL trace_bpf_compile()");
1621                return -1;
1622        }
1623
1624        /* If this isn't a real packet, then fail */
1625        if (!linkptr) {
1626                trace_set_err(packet->trace,
1627                                TRACE_ERR_BAD_FILTER,"Packet has no payload");
1628                return -1;
1629        }
1630
1631        if (filter->filterstring && ! filter->flag) {
1632                pcap_t *pcap = NULL;
1633                if (linktype==(libtrace_linktype_t)-1) {
1634                        trace_set_err(packet->trace,
1635                                        TRACE_ERR_BAD_FILTER,
1636                                        "Packet has an unknown linktype");
1637                        return -1;
1638                }
1639                if (libtrace_to_pcap_dlt(linktype) == TRACE_DLT_ERROR) {
1640                        trace_set_err(packet->trace,TRACE_ERR_BAD_FILTER,
1641                                        "Unknown pcap equivalent linktype");
1642                        return -1;
1643                }
1644                pthread_mutex_lock(&mutex);
1645                /* Make sure not one bet us to this */
1646                if (filter->flag) {
1647                        pthread_mutex_unlock(&mutex);
1648                        return -1;
1649                }
1650                pcap=(pcap_t *)pcap_open_dead(
1651                                (int)libtrace_to_pcap_dlt(linktype),
1652                                1500U);
1653                /* build filter */
1654                if (!pcap) {
1655                        trace_set_err(packet->trace, TRACE_ERR_BAD_FILTER,
1656                                                "Unable to open pcap_t for compiling filters trace_bpf_compile()");
1657                        return -1;
1658                }
1659                if (pcap_compile( pcap, &filter->filter, filter->filterstring,
1660                                        1, 0)) {
1661                        trace_set_err(packet->trace,TRACE_ERR_BAD_FILTER,
1662                                        "Unable to compile the filter \"%s\": %s",
1663                                        filter->filterstring,
1664                                        pcap_geterr(pcap));
1665                        pcap_close(pcap);
1666                        pthread_mutex_unlock(&mutex);
1667                        return -1;
1668                }
1669                pcap_close(pcap);
1670                filter->flag=1;
1671                pthread_mutex_unlock(&mutex);
1672        }
1673        return 0;
1674#else
1675        trace_set_err(packet->trace,TRACE_ERR_OPTION_UNAVAIL,
1676                                "Feature unavailable");
1677        return -1;
1678#endif
1679}
1680
1681DLLEXPORT int trace_apply_filter(libtrace_filter_t *filter,
1682                        const libtrace_packet_t *packet) {
1683#ifdef HAVE_BPF
1684        void *linkptr = 0;
1685        uint32_t clen = 0;
1686        bool free_packet_needed = false;
1687        int ret;
1688        libtrace_linktype_t linktype;
1689        libtrace_packet_t *packet_copy = (libtrace_packet_t*)packet;
1690#ifdef HAVE_LLVM
1691        static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
1692#endif
1693
1694        if (!packet) {
1695                fprintf(stderr, "NULL packet passed into trace_apply_filter()\n");
1696                return TRACE_ERR_NULL_PACKET;
1697        }
1698        if (!filter) {
1699                trace_set_err(packet->trace, TRACE_ERR_NULL_FILTER,
1700                        "NULL filter passed into trace_apply_filter()");
1701                return -1;
1702        }
1703
1704        /* Match all non-data packets as we probably want them to pass
1705         * through to the caller */
1706        linktype = trace_get_link_type(packet);
1707
1708        if (linktype == TRACE_TYPE_NONDATA || linktype == TRACE_TYPE_ERF_META)
1709                return 1;
1710
1711        if (libtrace_to_pcap_dlt(linktype)==TRACE_DLT_ERROR) {
1712
1713                /* If we cannot get a suitable DLT for the packet, it may
1714                 * be because the packet is encapsulated in a link type that
1715                 * does not correspond to a DLT. Therefore, we should try
1716                 * popping off headers until we either can find a suitable
1717                 * link type or we can't do any more sensible decapsulation. */
1718
1719                /* Copy the packet, as we don't want to trash the one we
1720                 * were passed in */
1721                packet_copy=trace_copy_packet(packet);
1722                free_packet_needed=true;
1723
1724                while (libtrace_to_pcap_dlt(linktype) == TRACE_DLT_ERROR) {
1725                        if (!demote_packet(packet_copy)) {
1726                                trace_set_err(packet->trace,
1727                                                TRACE_ERR_NO_CONVERSION,
1728                                                "pcap does not support this linktype so cannot apply BPF filters");
1729                                if (free_packet_needed) {
1730                                        trace_destroy_packet(packet_copy);
1731                                }
1732                                return -1;
1733                        }
1734                        linktype = trace_get_link_type(packet_copy);
1735                }
1736
1737        }
1738
1739        linkptr = trace_get_packet_buffer(packet_copy,NULL,&clen);
1740        if (!linkptr) {
1741                if (free_packet_needed) {
1742                        trace_destroy_packet(packet_copy);
1743                }
1744                return 0;
1745        }
1746
1747        /* We need to compile the filter now, because before we didn't know
1748         * what the link type was
1749         */
1750        // Note internal mutex locking used here
1751        if (trace_bpf_compile(filter,packet_copy,linkptr,linktype)==-1) {
1752                if (free_packet_needed) {
1753                        trace_destroy_packet(packet_copy);
1754                }
1755                return -1;
1756        }
1757
1758        /* If we're jitting, we may need to JIT the BPF code now too */
1759#if HAVE_LLVM
1760        if (!filter->jitfilter) {
1761                ASSERT_RET(pthread_mutex_lock(&mutex), == 0);
1762                /* Again double check here like the bpf filter */
1763                if(!filter->jitfilter)
1764                /* Looking at compile_program source this appears to be thread safe
1765                 * however if this gets called twice we will leak this memory :(
1766                 * as such lock here anyways */
1767                        filter->jitfilter = compile_program(filter->filter.bf_insns, filter->filter.bf_len);
1768                ASSERT_RET(pthread_mutex_unlock(&mutex), == 0);
1769        }
1770#endif
1771
1772        if (!filter->flag) {
1773                trace_set_err(packet->trace, TRACE_ERR_BAD_FILTER,
1774                        "Bad filter passed into trace_apply_filter()");
1775                return -1;
1776        }
1777        /* Now execute the filter */
1778#if HAVE_LLVM
1779        ret=filter->jitfilter->bpf_run((unsigned char *)linkptr, clen);
1780#else
1781        ret=bpf_filter(filter->filter.bf_insns,(u_char*)linkptr,(unsigned int)clen,(unsigned int)clen);
1782#endif
1783
1784        /* If we copied the packet earlier, make sure that we free it */
1785        if (free_packet_needed) {
1786                trace_destroy_packet(packet_copy);
1787        }
1788        return ret;
1789#else
1790        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1791        return 0;
1792#endif
1793}
1794
1795/* Set the direction flag, if it has one
1796 * @param packet the packet opaque pointer
1797 * @param direction the new direction (0,1,2,3)
1798 * @returns a signed value containing the direction flag, or -1 if this is not supported
1799 */
1800DLLEXPORT libtrace_direction_t trace_set_direction(libtrace_packet_t *packet,
1801                libtrace_direction_t direction)
1802{
1803        if (!packet) {
1804                fprintf(stderr, "NULL packet passed into trace_set_direction()\n");
1805                return (libtrace_direction_t)~0U;
1806        }
1807        if (packet->trace->format->set_direction) {
1808                return packet->trace->format->set_direction(packet,direction);
1809        }
1810        return (libtrace_direction_t)~0U;
1811}
1812
1813/* Get the direction flag, if it has one
1814 * @param packet a pointer to a libtrace_packet structure
1815 * @returns a signed value containing the direction flag, or -1 if this is not supported
1816 * The direction is defined as 0 for packets originating locally (ie, outbound)
1817 * and 1 for packets originating remotely (ie, inbound).
1818 * Other values are possible, which might be overloaded to mean special things
1819 * for a special trace.
1820 */
1821DLLEXPORT libtrace_direction_t trace_get_direction(const libtrace_packet_t *packet)
1822{
1823        if (!packet) {
1824                fprintf(stderr, "NULL packet passed into trace_set_direction()\n");
1825                return (libtrace_direction_t)~0U;
1826        }
1827        if (packet->which_trace_start != packet->trace->startcount) {
1828                return (libtrace_direction_t)~0U;
1829        }
1830        if (packet->trace->format->get_direction) {
1831                return packet->trace->format->get_direction(packet);
1832        }
1833        return (libtrace_direction_t)~0U;
1834}
1835
1836#define ROOT_SERVER(x) ((x) < 512)
1837#define ROOT_CLIENT(x) ((512 <= (x)) && ((x) < 1024))
1838#define NONROOT_SERVER(x) ((x) >= 5000)
1839#define NONROOT_CLIENT(x) ((1024 <= (x)) && ((x) < 5000))
1840#define DYNAMIC(x) ((49152 < (x)) && ((x) < 65535))
1841#define SERVER(x) ROOT_SERVER(x) || NONROOT_SERVER(x)
1842#define CLIENT(x) ROOT_CLIENT(x) || NONROOT_CLIENT(x)
1843
1844/* Attempt to deduce the 'server' port
1845 * @param protocol the IP protocol (eg, 6 or 17 for TCP or UDP)
1846 * @param source the TCP or UDP source port
1847 * @param dest the TCP or UDP destination port
1848 * @returns a hint as to which port is the server port
1849 */
1850DLLEXPORT int8_t trace_get_server_port(UNUSED uint8_t protocol,
1851                uint16_t source, uint16_t dest)
1852{
1853        /*
1854         * * If the ports are equal, return DEST
1855         * * Check for well-known ports in the given protocol
1856         * * Root server ports: 0 - 511
1857         * * Root client ports: 512 - 1023
1858         * * non-root client ports: 1024 - 4999
1859         * * non-root server ports: 5000+
1860         * * Check for static ranges: 1024 - 49151
1861         * * Check for dynamic ranges: 49152 - 65535
1862         * * flip a coin.
1863         */
1864
1865        /* equal */
1866        if (source == dest)
1867                return USE_DEST;
1868
1869        /* root server port, 0 - 511 */
1870        if (ROOT_SERVER(source) && ROOT_SERVER(dest)) {
1871                if (source < dest)
1872                        return USE_SOURCE;
1873                return USE_DEST;
1874        }
1875
1876        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1877                return USE_SOURCE;
1878        if (!ROOT_SERVER(source) && ROOT_SERVER(dest))
1879                return USE_DEST;
1880
1881        /* non-root server */
1882        if (NONROOT_SERVER(source) && NONROOT_SERVER(dest)) {
1883                if (source < dest)
1884                        return USE_SOURCE;
1885                return USE_DEST;
1886        }
1887        if (NONROOT_SERVER(source) && !NONROOT_SERVER(dest))
1888                return USE_SOURCE;
1889        if (!NONROOT_SERVER(source) && NONROOT_SERVER(dest))
1890                return USE_DEST;
1891
1892        /* root client */
1893        if (ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1894                if (source < dest)
1895                        return USE_SOURCE;
1896                return USE_DEST;
1897        }
1898        if (ROOT_CLIENT(source) && !ROOT_CLIENT(dest)) {
1899                /* prefer root-client over nonroot-client */
1900                if (NONROOT_CLIENT(dest))
1901                        return USE_SOURCE;
1902                return USE_DEST;
1903        }
1904        if (!ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1905                /* prefer root-client over nonroot-client */
1906                if (NONROOT_CLIENT(source))
1907                        return USE_DEST;
1908                return USE_SOURCE;
1909        }
1910
1911        /* nonroot client */
1912        if (NONROOT_CLIENT(source) && NONROOT_CLIENT(dest)) {
1913                if (source < dest)
1914                        return USE_SOURCE;
1915                return USE_DEST;
1916        }
1917        if (NONROOT_CLIENT(source) && !NONROOT_CLIENT(dest))
1918                return USE_DEST;
1919        if (!NONROOT_CLIENT(source) && NONROOT_CLIENT(dest))
1920                return USE_SOURCE;
1921
1922        /* dynamic range */
1923        if (DYNAMIC(source) && DYNAMIC(dest)) {
1924                if (source < dest)
1925                        return USE_SOURCE;
1926                return USE_DEST;
1927        }
1928        if (DYNAMIC(source) && !DYNAMIC(dest))
1929                return USE_DEST;
1930        if (!DYNAMIC(source) && DYNAMIC(dest))
1931                return USE_SOURCE;
1932        /*
1933        if (SERVER(source) && CLIENT(dest))
1934                return USE_SOURCE;
1935
1936        if (SERVER(dest) && CLIENT(source))
1937                return USE_DEST;
1938        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1939                return USE_SOURCE;
1940        if (ROOT_SERVER(dest) && !ROOT_SERVER(source))
1941                return USE_DEST;
1942        */
1943        /* failing that test... */
1944        if (source < dest) {
1945                return USE_SOURCE;
1946        }
1947        return USE_DEST;
1948
1949}
1950
1951/* Truncate the packet at the suggested length
1952 * @param packet        the packet opaque pointer
1953 * @param size          the new length of the packet
1954 * @returns the new size of the packet
1955 * @note size and the return size refer to the network-level payload of the
1956 * packet, and do not include any capture headers. For example, to truncate a
1957 * packet after the IP header, set size to sizeof(ethernet_header) +
1958 * sizeof(ip_header)
1959 * @note If the original network-level payload is smaller than size, then the
1960 * original size is returned and the packet is left unchanged.
1961 */
1962DLLEXPORT size_t trace_set_capture_length(libtrace_packet_t *packet, size_t size) {
1963        if (!packet) {
1964                fprintf(stderr, "NULL packet passed into trace_set_capture_length()\n");
1965                return ~0U;
1966        }
1967
1968        if (packet->trace->format->set_capture_length) {
1969                packet->capture_length = packet->trace->format->set_capture_length(packet,size);
1970                return packet->capture_length;
1971        }
1972
1973        return ~0U;
1974}
1975
1976/* Splits a URI into two components - the format component which is seen before
1977 * the ':', and the uridata which follows the ':'.
1978 *
1979 * Returns a pointer to the URI data, but updates the format parameter to
1980 * point to a copy of the format component.
1981 */
1982
1983DLLEXPORT const char * trace_parse_uri(const char *uri, char **format) {
1984        const char *uridata = 0;
1985
1986        if((uridata = strchr(uri,':')) == NULL) {
1987                /* Badly formed URI - needs a : */
1988                return 0;
1989        }
1990
1991        if ((unsigned)(uridata - uri) > URI_PROTO_LINE) {
1992                /* Badly formed URI - uri type is too long */
1993                return 0;
1994        }
1995
1996        /* NOTE: this is allocated memory - it should be freed by the caller
1997         * once they are done with it */
1998        *format=xstrndup(uri, (size_t)(uridata - uri));
1999
2000        /* Push uridata past the delimiter */
2001        uridata++;
2002
2003        return uridata;
2004}
2005
2006enum base_format_t trace_get_format(libtrace_packet_t *packet) {
2007        if (!packet) {
2008                fprintf(stderr, "NULL packet passed into trace_get_format()\n");
2009                return TRACE_FORMAT_UNKNOWN;
2010        }
2011
2012        return packet->trace->format->type;
2013}
2014
2015DLLEXPORT libtrace_err_t trace_get_err(libtrace_t *trace)
2016{
2017        libtrace_err_t err = trace->err;
2018        trace->err.err_num = 0; /* "OK" */
2019        trace->err.problem[0]='\0';
2020        return err;
2021}
2022
2023DLLEXPORT bool trace_is_err(libtrace_t *trace)
2024{
2025        return trace->err.err_num != 0;
2026}
2027
2028/* Prints the input error status to standard error and clears the error state */
2029DLLEXPORT void trace_perror(libtrace_t *trace,const char *msg,...)
2030{
2031        char buf[256];
2032        va_list va;
2033        va_start(va,msg);
2034        vsnprintf(buf,sizeof(buf),msg,va);
2035        va_end(va);
2036        if(trace->err.err_num) {
2037                if (trace->uridata) {
2038                        fprintf(stderr,"%s(%s): %s\n",
2039                                        buf,trace->uridata,trace->err.problem);
2040                } else {
2041                        fprintf(stderr,"%s: %s\n", buf, trace->err.problem);
2042                }
2043        } else {
2044                if (trace->uridata) {
2045                        fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
2046                } else {
2047                        fprintf(stderr,"%s: No error\n", buf);
2048                }
2049        }
2050        trace->err.err_num = 0; /* "OK" */
2051        trace->err.problem[0]='\0';
2052}
2053
2054DLLEXPORT libtrace_err_t trace_get_err_output(libtrace_out_t *trace)
2055{
2056        libtrace_err_t err = trace->err;
2057        trace->err.err_num = TRACE_ERR_NOERROR; /* "OK" */
2058        trace->err.problem[0]='\0';
2059        return err;
2060}
2061
2062DLLEXPORT bool trace_is_err_output(libtrace_out_t *trace)
2063{
2064        return trace->err.err_num != 0;
2065}
2066
2067/* Prints the output error status to standard error and clears the error state
2068 */
2069DLLEXPORT void trace_perror_output(libtrace_out_t *trace,const char *msg,...)
2070{
2071        char buf[256];
2072        va_list va;
2073        va_start(va,msg);
2074        vsnprintf(buf,sizeof(buf),msg,va);
2075        va_end(va);
2076        if(trace->err.err_num) {
2077                fprintf(stderr,"%s(%s): %s\n",
2078                                buf,
2079                                trace->uridata?trace->uridata:"no uri",
2080                                trace->err.problem);
2081        } else {
2082                fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
2083        }
2084        trace->err.err_num = TRACE_ERR_NOERROR; /* "OK" */
2085        trace->err.problem[0]='\0';
2086}
2087
2088DLLEXPORT int trace_seek_erf_timestamp(libtrace_t *trace, uint64_t ts)
2089{
2090        if (trace->format->seek_erf) {
2091                return trace->format->seek_erf(trace,ts);
2092        }
2093        else {
2094                if (trace->format->seek_timeval) {
2095                        struct timeval tv;
2096#if __BYTE_ORDER == __BIG_ENDIAN
2097                        tv.tv_sec = ts & 0xFFFFFFFF;
2098                        tv.tv_usec = ((ts >> 32) * 1000000) & 0xFFFFFFFF;
2099#elif __BYTE_ORDER == __LITTLE_ENDIAN
2100                        tv.tv_sec = ts >> 32;
2101                        tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
2102#else
2103#error "What on earth are you running this on?"
2104#endif
2105                        if (tv.tv_usec >= 1000000) {
2106                                tv.tv_usec -= 1000000;
2107                                tv.tv_sec += 1;
2108                        }
2109                        return trace->format->seek_timeval(trace,tv);
2110                }
2111                if (trace->format->seek_seconds) {
2112                        double seconds =
2113                                (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
2114                        return trace->format->seek_seconds(trace,seconds);
2115                }
2116                trace_set_err(trace,
2117                                TRACE_ERR_OPTION_UNAVAIL,
2118                                "Feature unimplemented");
2119                return -1;
2120        }
2121}
2122
2123DLLEXPORT int trace_seek_seconds(libtrace_t *trace, double seconds)
2124{
2125        if (trace->format->seek_seconds) {
2126                return trace->format->seek_seconds(trace,seconds);
2127        }
2128        else {
2129                if (trace->format->seek_timeval) {
2130                        struct timeval tv;
2131                        tv.tv_sec = (uint32_t)seconds;
2132                        tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
2133                        return trace->format->seek_timeval(trace,tv);
2134                }
2135                if (trace->format->seek_erf) {
2136                        uint64_t timestamp =
2137                                ((uint64_t)((uint32_t)seconds) << 32) + \
2138                            (uint64_t)(( seconds - (uint32_t)seconds   ) * UINT_MAX);
2139                        return trace->format->seek_erf(trace,timestamp);
2140                }
2141                trace_set_err(trace,
2142                                TRACE_ERR_OPTION_UNAVAIL,
2143                                "Feature unimplemented");
2144                return -1;
2145        }
2146}
2147
2148DLLEXPORT int trace_seek_timeval(libtrace_t *trace, struct timeval tv)
2149{
2150        if (trace->format->seek_timeval) {
2151                return trace->format->seek_timeval(trace,tv);
2152        }
2153        else {
2154                if (trace->format->seek_erf) {
2155                        uint64_t timestamp = ((((uint64_t)tv.tv_sec) << 32) + \
2156                                (((uint64_t)tv.tv_usec * UINT_MAX)/1000000));
2157                        return trace->format->seek_erf(trace,timestamp);
2158                }
2159                if (trace->format->seek_seconds) {
2160                        double seconds = tv.tv_sec + ((tv.tv_usec * 1.0)/1000000);
2161                        return trace->format->seek_seconds(trace,seconds);
2162                }
2163                trace_set_err(trace,
2164                                TRACE_ERR_OPTION_UNAVAIL,
2165                                "Feature unimplemented");
2166                return -1;
2167        }
2168}
2169
2170/* Converts a binary ethernet MAC address into a printable string */
2171DLLEXPORT char *trace_ether_ntoa(const uint8_t *addr, char *buf)
2172{
2173        static char staticbuf[18]={0,};
2174        if (!buf)
2175                buf=staticbuf;
2176        snprintf(buf,(size_t)18,"%02x:%02x:%02x:%02x:%02x:%02x",
2177                        addr[0],addr[1],addr[2],
2178                        addr[3],addr[4],addr[5]);
2179        return buf;
2180}
2181
2182/* Converts a printable ethernet MAC address into a binary format */
2183DLLEXPORT uint8_t *trace_ether_aton(const char *buf, uint8_t *addr)
2184{
2185        uint8_t *buf2 = addr;
2186        unsigned int tmp[6];
2187        static uint8_t staticaddr[6];
2188        if (!buf2)
2189                buf2=staticaddr;
2190        sscanf(buf,"%x:%x:%x:%x:%x:%x",
2191                        &tmp[0],&tmp[1],&tmp[2],
2192                        &tmp[3],&tmp[4],&tmp[5]);
2193        buf2[0]=tmp[0]; buf2[1]=tmp[1]; buf2[2]=tmp[2];
2194        buf2[3]=tmp[3]; buf2[4]=tmp[4]; buf2[5]=tmp[5];
2195        return buf2;
2196}
2197
2198
2199/* Creates a libtrace packet from scratch using the contents of the provided
2200 * buffer as the packet payload.
2201 *
2202 * Unlike trace_prepare_packet(), the buffer should not contain any capture
2203 * format headers; instead this function will add the PCAP header to the
2204 * packet record. This also means only PCAP packets can be constructed using
2205 * this function.
2206 *
2207 */
2208DLLEXPORT
2209void trace_construct_packet(libtrace_packet_t *packet,
2210                libtrace_linktype_t linktype,
2211                const void *data,
2212                uint16_t len) {
2213
2214        if (!packet) {
2215                fprintf(stderr, "NULL packet passed into trace_contruct_packet()\n");
2216                return;
2217        }
2218        /* Check a valid linktype was supplied */
2219        if (linktype == TRACE_TYPE_UNKNOWN || linktype == TRACE_TYPE_CONTENT_INVALID) {
2220                fprintf(stderr, "Unknown or invalid linktype passed into trace_construct_packet()\n");
2221                return;
2222        }
2223
2224        size_t size;
2225        static libtrace_t *deadtrace=NULL;
2226        libtrace_pcapfile_pkt_hdr_t hdr;
2227#ifdef WIN32
2228        struct _timeb tstruct;
2229#else
2230        struct timeval tv;
2231#endif
2232
2233        /* We need a trace to attach the constructed packet to (and it needs
2234         * to be PCAP) */
2235        if (NULL == deadtrace)
2236                deadtrace=trace_create_dead("pcapfile");
2237
2238        /* Fill in the new PCAP header */
2239#ifdef WIN32
2240        _ftime(&tstruct);
2241        hdr.ts_sec=tstruct.time;
2242        hdr.ts_usec=tstruct.millitm * 1000;
2243#else
2244        gettimeofday(&tv,NULL);
2245        hdr.ts_sec=tv.tv_sec;
2246        hdr.ts_usec=tv.tv_usec;
2247#endif
2248
2249        hdr.caplen=len;
2250        hdr.wirelen=len;
2251
2252        /* Now fill in the libtrace packet itself */
2253        if (!deadtrace) {
2254                fprintf(stderr, "Unable to create dummy trace for use within trace_construct_packet()\n");
2255                return;
2256        }
2257        packet->trace=deadtrace;
2258        size=len+sizeof(hdr);
2259        if (size < LIBTRACE_PACKET_BUFSIZE)
2260            size = LIBTRACE_PACKET_BUFSIZE;
2261        if (packet->buf_control==TRACE_CTRL_PACKET) {
2262            packet->buffer = realloc(packet->buffer, size);
2263        }
2264        else {
2265                packet->buffer = malloc(size);
2266        }
2267        packet->buf_control=TRACE_CTRL_PACKET;
2268        packet->header=packet->buffer;
2269        packet->payload=(void*)((char*)packet->buffer+sizeof(hdr));
2270
2271        /* Ugh, memmove - sadly necessary, also beware that we might be
2272         * moving data around within this packet, so ordering is important.
2273         */
2274        memmove(packet->payload, data, (size_t)len);
2275        memmove(packet->header, &hdr, sizeof(hdr));
2276        packet->type=pcap_linktype_to_rt(libtrace_to_pcap_linktype(linktype));
2277
2278        trace_clear_cache(packet);
2279}
2280
2281
2282uint64_t trace_get_received_packets(libtrace_t *trace)
2283{
2284        uint64_t ret;
2285
2286        if (!trace) {
2287                fprintf(stderr, "NULL trace passed to trace_get_received_packets()\n");
2288                /* When the number of received packets is not known we return UINT64_MAX */
2289                return UINT64_MAX;
2290        }
2291
2292        if (trace->format->get_received_packets) {
2293                if ((ret = trace->format->get_received_packets(trace)) != UINT64_MAX)
2294                        return ret;
2295        } else if (trace->format->get_statistics) {
2296                struct libtrace_stat_t stat;
2297                stat.magic = LIBTRACE_STAT_MAGIC;
2298                trace_get_statistics(trace, &stat);
2299                if (stat.received_valid)
2300                        return stat.received;
2301        }
2302
2303        // Read the cached value taken before the trace was paused/closed
2304        if(trace->stats && trace->stats->received_valid)
2305                return trace->stats->received;
2306        else
2307                return UINT64_MAX;
2308}
2309
2310uint64_t trace_get_filtered_packets(libtrace_t *trace)
2311{
2312        if (!trace) {
2313                fprintf(stderr, "NULL trace passed to trace_get_filtered_packets()\n");
2314                return UINT64_MAX;
2315        }
2316        int i = 0;
2317        uint64_t lib_filtered = trace->filtered_packets;
2318        for (i = 0; i < trace->perpkt_thread_count; i++) {
2319                lib_filtered += trace->perpkt_threads[i].filtered_packets;
2320        }
2321        if (trace->format->get_filtered_packets) {
2322                uint64_t trace_filtered = trace->format->get_filtered_packets(trace);
2323                if (trace_filtered == UINT64_MAX)
2324                        return UINT64_MAX;
2325                else
2326                        return trace_filtered + lib_filtered;
2327        } else if (trace->format->get_statistics) {
2328                struct libtrace_stat_t stat;
2329                stat.magic = LIBTRACE_STAT_MAGIC;
2330                trace_get_statistics(trace, &stat);
2331                if (stat.filtered_valid)
2332                        return lib_filtered + stat.filtered;
2333                else
2334                        return UINT64_MAX;
2335        }
2336
2337        // Read the cached value taken before the trace was paused/closed
2338        if(trace->stats && trace->stats->filtered_valid)
2339                return trace->stats->filtered + lib_filtered;
2340        else
2341                return lib_filtered;
2342}
2343
2344uint64_t trace_get_dropped_packets(libtrace_t *trace)
2345{
2346        if (!trace) {
2347                fprintf(stderr, "NULL trace passed into trace_get_dropped_packets()\n");
2348                return UINT64_MAX;
2349        }
2350        uint64_t ret;
2351
2352        if (trace->format->get_dropped_packets) {
2353                if ((ret = trace->format->get_dropped_packets(trace)) != UINT64_MAX)
2354                        return ret;
2355        } else if (trace->format->get_statistics) {
2356                struct libtrace_stat_t stat;
2357                stat.magic = LIBTRACE_STAT_MAGIC;
2358                trace_get_statistics(trace, &stat);
2359                if (stat.dropped_valid)
2360                        return stat.dropped;
2361        }
2362
2363        // Read the cached value taken before the trace was paused/closed
2364        if(trace->stats && trace->stats->dropped_valid)
2365                return trace->stats->dropped;
2366        else
2367                return UINT64_MAX;
2368}
2369
2370uint64_t trace_get_accepted_packets(libtrace_t *trace)
2371{
2372        if (!trace) {
2373                fprintf(stderr, "NULL trace passed into trace_get_accepted_packets()\n");
2374                return UINT64_MAX;
2375        }
2376        int i = 0;
2377        uint64_t ret = 0;
2378        /* We always add to a thread's accepted count before dispatching the
2379         * packet to the user. However if the underlying trace is single
2380         * threaded it will also be increasing the global count. So if we
2381         * find perpkt ignore the global count.
2382         */
2383        for (i = 0; i < trace->perpkt_thread_count; i++) {
2384                ret += trace->perpkt_threads[i].accepted_packets;
2385        }
2386        return ret ? ret : trace->accepted_packets;
2387}
2388
2389libtrace_stat_t *trace_get_statistics(libtrace_t *trace, libtrace_stat_t *stat)
2390{
2391        uint64_t ret = 0;
2392        int i;
2393        if (!trace) {
2394                fprintf(stderr, "NULL trace passed into trace_get_statistics()\n");
2395                return NULL;
2396        }
2397        if (stat == NULL) {
2398                if (trace->stats == NULL)
2399                        trace->stats = trace_create_statistics();
2400                stat = trace->stats;
2401        }
2402        if (stat->magic != LIBTRACE_STAT_MAGIC) {
2403                trace_set_err(trace, TRACE_ERR_STAT, "Use trace_create_statistics() to allocate "
2404                        "statistics prior to calling trace_get_statistics()");
2405                return NULL;
2406        }
2407
2408        /* If the trace has paused or finished get the cached results */
2409        if (trace->state == STATE_PAUSED ||
2410            trace->state == STATE_FINISHED ||
2411            trace->state == STATE_FINISHING ||
2412            trace->state == STATE_JOINED) {
2413                if (trace->stats && trace->stats != stat)
2414                        *stat = *trace->stats;
2415                return stat;
2416        }
2417
2418        stat->reserved1 = 0;
2419        stat->reserved2 = 0;
2420#define X(x) stat->x ##_valid = 0;
2421        LIBTRACE_STAT_FIELDS;
2422#undef X
2423        /* Both accepted and filtered are stored against in the library */
2424
2425        /* We always add to a thread's accepted count before dispatching the
2426         * packet to the user. However if the underlying trace is single
2427         * threaded it will also be increasing the global count. So if we
2428         * find perpkt ignore the global count.
2429         */
2430        for (i = 0; i < trace->perpkt_thread_count; i++) {
2431                ret += trace->perpkt_threads[i].accepted_packets;
2432        }
2433
2434        stat->accepted_valid = 1;
2435        stat->accepted = ret ? ret : trace->accepted_packets;
2436
2437        stat->filtered_valid = 1;
2438        stat->filtered = trace->filtered_packets;
2439        for (i = 0; i < trace->perpkt_thread_count; i++) {
2440                stat->filtered += trace->perpkt_threads[i].filtered_packets;
2441        }
2442
2443        if (trace->format->get_statistics) {
2444                trace->format->get_statistics(trace, stat);
2445        }
2446        return stat;
2447}
2448
2449void trace_get_thread_statistics(libtrace_t *trace, libtrace_thread_t *t,
2450                                 libtrace_stat_t *stat)
2451{
2452        if (!trace) {
2453                fprintf(stderr, "NULL trace passed into trace_get_thread_statistics()\n");
2454                return;
2455        }
2456        if (!stat) {
2457                trace_set_err(trace, TRACE_ERR_STAT, "NULL statistics structure passed into "
2458                        "trace_get_thread_statistics()");
2459                return;
2460        }
2461        if (stat->magic != LIBTRACE_STAT_MAGIC) {
2462                trace_set_err(trace, TRACE_ERR_STAT, "Use trace_create_statistics() to "
2463                        "allocate statistics prior to calling trace_get_thread_statistics()");
2464                return;
2465        }
2466        stat->reserved1 = 0;
2467        stat->reserved2 = 0;
2468#define X(x) stat->x ##_valid= 0;
2469        LIBTRACE_STAT_FIELDS;
2470#undef X
2471        stat->accepted_valid = 1;
2472        stat->accepted = t->accepted_packets;
2473        stat->filtered_valid = 1;
2474        stat->filtered = t->filtered_packets;
2475        if (!trace_has_dedicated_hasher(trace) && trace->format->get_thread_statistics) {
2476                trace->format->get_thread_statistics(trace, t, stat);
2477        }
2478}
2479
2480libtrace_stat_t *trace_create_statistics(void) {
2481        libtrace_stat_t *ret;
2482        ret = malloc(sizeof(libtrace_stat_t));
2483        if (ret) {
2484                memset(ret, 0, sizeof(libtrace_stat_t));
2485                ret->magic = LIBTRACE_STAT_MAGIC;
2486        }
2487        return ret;
2488}
2489
2490void trace_clear_statistics(libtrace_stat_t *s) {
2491        memset(s, 0, sizeof(libtrace_stat_t));
2492        s->magic = LIBTRACE_STAT_MAGIC;
2493}
2494
2495void trace_subtract_statistics(const libtrace_stat_t *a, const libtrace_stat_t *b,
2496                         libtrace_stat_t *c) {
2497
2498        if (a->magic != LIBTRACE_STAT_MAGIC
2499                || b->magic != LIBTRACE_STAT_MAGIC
2500                || c->magic != LIBTRACE_STAT_MAGIC) {
2501                fprintf(stderr, "Use trace_create_statistics() to allocate statistics prior to "
2502                        "calling trace_subtract_statistics()\n");
2503                return;
2504        }
2505
2506#define X(x) \
2507        if (a->x ##_valid && b->x ##_valid) { \
2508                c->x ##_valid = 1; \
2509                c->x = a->x - b->x; \
2510        } else {\
2511                c->x ##_valid = 0;\
2512        }
2513        LIBTRACE_STAT_FIELDS
2514#undef X
2515}
2516
2517void trace_add_statistics(const libtrace_stat_t *a, const libtrace_stat_t *b,
2518                         libtrace_stat_t *c) {
2519        if (a->magic != LIBTRACE_STAT_MAGIC
2520                || b->magic != LIBTRACE_STAT_MAGIC
2521                || c->magic != LIBTRACE_STAT_MAGIC) {
2522                fprintf(stderr, "Use trace_create_statistics() to allocate statistics prior to "
2523                        "calling trace_add_statistics()\n");
2524                return;
2525        }
2526
2527#define X(x) \
2528        if (a->x ##_valid&& b->x ##_valid) { \
2529                c->x ##_valid = 1; \
2530                c->x = a->x + b->x; \
2531        } else {\
2532                c->x ##_valid = 0;\
2533        }
2534        LIBTRACE_STAT_FIELDS
2535#undef X
2536}
2537
2538int trace_print_statistics(const libtrace_stat_t *s, FILE *f, const char *format) {
2539        if (s->magic != LIBTRACE_STAT_MAGIC) {
2540                fprintf(stderr, "Use trace_create_statistics() to allocate statistics prior to "
2541                        "calling trace_print_statistics\n");
2542                return TRACE_ERR_STAT;
2543        }
2544        if (format == NULL)
2545                format = "%s: %"PRIu64"\n";
2546#define xstr(s) str(s)
2547#define str(s) #s
2548#define X(x) \
2549        if (s->x ##_valid) { \
2550                if (fprintf(f, format, xstr(x), s->x) < 0) \
2551                        return -1; \
2552        }
2553        LIBTRACE_STAT_FIELDS
2554#undef X
2555        return 0;
2556}
2557
2558
2559void trace_clear_cache(libtrace_packet_t *packet) {
2560
2561        packet->l2_header = NULL;
2562        packet->l3_header = NULL;
2563        packet->l4_header = NULL;
2564        packet->link_type = 0;
2565        packet->l3_ethertype = 0;
2566        packet->transport_proto = 0;
2567        packet->capture_length = -1;
2568        packet->wire_length = -1;
2569        packet->framing_length = -1;
2570        packet->payload_length = -1;
2571        packet->l2_remaining = 0;
2572        packet->l3_remaining = 0;
2573        packet->l4_remaining = 0;
2574        packet->refcount = 0;
2575}
2576
2577void trace_interrupt(void) {
2578        libtrace_halt = 1;
2579}
2580
2581void register_format(struct libtrace_format_t *f) {
2582        if (f->next != NULL) {
2583                fprintf(stderr, "You cannot register a format twice in register_format()");
2584                return;
2585        }
2586        f->next=formats_list;
2587        formats_list=f;
2588
2589        /* Now, verify that the format has at least the minimum functionality.
2590         *
2591         * This #if can be changed to a 1 to output warnings about inconsistent
2592         * functions being provided by format modules.  This generally is very
2593         * noisy, as almost all modules don't implement one or more functions
2594         * for various reasons.  This is very useful when checking a new
2595         * format module is sane.
2596         */
2597#if 0
2598        if (f->init_input) {
2599#define REQUIRE(x) \
2600                if (!f->x) \
2601                        fprintf(stderr,"%s: Input format should provide " #x "\n",f->name)
2602                REQUIRE(read_packet);
2603                REQUIRE(start_input);
2604                REQUIRE(fin_input);
2605                REQUIRE(get_link_type);
2606                REQUIRE(get_capture_length);
2607                REQUIRE(get_wire_length);
2608                REQUIRE(get_framing_length);
2609                REQUIRE(trace_event);
2610                if (!f->get_erf_timestamp
2611                        && !f->get_seconds
2612                        && !f->get_timeval) {
2613                        fprintf(stderr,"%s: A trace format capable of input, should provide at least one of\n"
2614"get_erf_timestamp, get_seconds or trace_timeval\n",f->name);
2615                }
2616                if (f->trace_event!=trace_event_trace) {
2617                        /* Theres nothing that a trace file could optimise with
2618                         * config_input
2619                         */
2620                        REQUIRE(pause_input);
2621                        REQUIRE(config_input);
2622                        REQUIRE(get_fd);
2623                }
2624                else {
2625                        if (f->get_fd) {
2626                                fprintf(stderr,"%s: Unnecessary get_fd\n",
2627                                                f->name);
2628                        }
2629                }
2630#undef REQUIRE
2631        }
2632        else {
2633#define REQUIRE(x) \
2634                if (f->x) \
2635                        fprintf(stderr,"%s: Non Input format shouldn't need " #x "\n",f->name)
2636                REQUIRE(read_packet);
2637                REQUIRE(start_input);
2638                REQUIRE(pause_input);
2639                REQUIRE(fin_input);
2640                REQUIRE(get_link_type);
2641                REQUIRE(get_capture_length);
2642                REQUIRE(get_wire_length);
2643                REQUIRE(get_framing_length);
2644                REQUIRE(trace_event);
2645                REQUIRE(get_seconds);
2646                REQUIRE(get_timeval);
2647                REQUIRE(get_erf_timestamp);
2648#undef REQUIRE
2649        }
2650        if (f->init_output) {
2651#define REQUIRE(x) \
2652                if (!f->x) \
2653                        fprintf(stderr,"%s: Output format should provide " #x "\n",f->name)
2654                REQUIRE(write_packet);
2655                REQUIRE(start_output);
2656                REQUIRE(config_output);
2657                REQUIRE(fin_output);
2658#undef REQUIRE
2659        }
2660        else {
2661#define REQUIRE(x) \
2662                if (f->x) \
2663                        fprintf(stderr,"%s: Non Output format shouldn't need " #x "\n",f->name)
2664                REQUIRE(write_packet);
2665                REQUIRE(start_output);
2666                REQUIRE(config_output);
2667                REQUIRE(fin_output);
2668#undef REQUIRE
2669        }
2670#endif
2671}
2672
Note: See TracBrowser for help on using the repository browser.