source: lib/trace.c @ a49a9eb

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

Add an object cache with thread local caches
All packets used by a trace are put through this.
Adds bulk read/write operations to the ringbuffer (used by the object cache)
Replace semaphores with condition variables to support these bulk operations.
Internally use bulk read operations from a single threaded formats to reduce lock overhead.
Replaces the asserts around pthread_* functions with a version that will still run the command if NDEBUG

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