source: lib/trace.c @ e7132d6

develop
Last change on this file since e7132d6 was e7132d6, checked in by Jacob Van Walraven <jcv9@…>, 22 months ago

improvements to meta-api

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