source: lib/trace.c @ 977e0db

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

Add meta api for erf and pcapng meta packets

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