source: lib/trace.c @ d994324

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivelibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since d994324 was d994324, checked in by Richard Sanger <rsangerarj@…>, 7 years ago

Remove anything to do with the combiner from set configuration and removes any options/storage related to these such as the next expected packet.

Instead this is done using trace_set_combiner now, and the for the built-in combiners.h header. This is a lot more flexible and allows the users to specify there own combiner, and any number of options for it.

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