source: lib/trace.c @ 89cc0cc

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

More assertion cleanups

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