source: lib/trace.c @ 23d263a

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

Add config option TRACE_OPTION_DISCARD_META

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