source: lib/trace.c @ c99b1e5

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

Fixes bug where memory was free()d despite having never been allocated.
This occurred when using the original (non-parallel) framework.

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