source: lib/trace.c @ 1919caf

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

Fix received counter always displaying 0 rather than unknown.
Fix saving counters for the single threaded fast path.

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