source: lib/trace.c @ 9c86dee

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

trace_create_dead not initialising startcount

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