source: lib/trace.c @ 8370482

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

Fix bug when not using reporter combiner is destroyed without be initialised

  • Property mode set to 100644
File size: 65.6 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
110volatile int libtrace_halt = 0;
111/* Set once pstart is called used for backwards compatibility reasons */
112int libtrace_parallel = 0;
113
114/* strncpy is not assured to copy the final \0, so we
115 * will use our own one that does
116 */
117static void xstrncpy(char *dest, const char *src, size_t n)
118{
119        strncpy(dest,src,n);
120        dest[n]='\0';
121}
122 
123static char *xstrndup(const char *src,size_t n)
124{       
125        char *ret=(char*)malloc(n+1);
126        if (ret==NULL) {
127                fprintf(stderr,"Out of memory");
128                exit(EXIT_FAILURE);
129        }
130        xstrncpy(ret,src,n);
131        return ret;
132}
133
134
135/* call all the constructors if they haven't yet all been called */
136static void trace_init(void)
137{
138        if (!formats_list) {
139                duck_constructor();
140                erf_constructor();
141                tsh_constructor();
142                legacy_constructor();
143                atmhdr_constructor();
144                linuxring_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        /* No formats matched -- make sure we clean up the IO object we
208         * used to probe the file magic */
209        wandio_destroy(libtrace->io);
210        return;
211}
212
213/* Creates an input trace from a URI
214 *
215 * @params char * containing a valid libtrace URI
216 * @returns opaque pointer to a libtrace_t
217 *
218 * Some valid URI's are:
219 *  erf:/path/to/erf/file
220 *  erf:/path/to/erf/file.gz
221 *  erf:-                       (stdin)
222 *  dag:/dev/dagcard
223 *  pcapint:pcapinterface               (eg: pcapint:eth0)
224 *  pcapfile:/path/to/pcap/file
225 *  pcapfile:-
226 *  int:interface                       (eg: int:eth0) only on Linux
227 *  rt:hostname
228 *  rt:hostname:port
229 *
230 * If an error occured when attempting to open a trace, NULL is returned
231 * and an error is output to stdout.
232 */
233DLLEXPORT libtrace_t *trace_create(const char *uri) {
234        libtrace_t *libtrace = 
235                        (libtrace_t *)malloc(sizeof(libtrace_t));
236        char *scan = 0;
237        const char *uridata = 0;                 
238
239        trace_init();
240
241        assert(uri && "Passing NULL to trace_create makes me a very sad program");
242
243        if (!libtrace) {
244                /* Out of memory */
245                return NULL;
246        }
247       
248        libtrace->err.err_num = TRACE_ERR_NOERROR;
249        libtrace->format=NULL;
250       
251        libtrace->event.tdelta = 0.0;
252        libtrace->event.packet = NULL;
253        libtrace->event.psize = 0;
254        libtrace->event.trace_last_ts = 0.0;
255        libtrace->event.waiting = false;
256        libtrace->filter = NULL;
257        libtrace->snaplen = 0;
258        libtrace->started=false;
259        libtrace->uridata = NULL;
260        libtrace->io = NULL;
261        libtrace->filtered_packets = 0;
262        libtrace->accepted_packets = 0;
263       
264        /* Parallel inits */
265        ASSERT_RET(pthread_mutex_init(&libtrace->libtrace_lock, NULL), == 0);
266        ASSERT_RET(pthread_cond_init(&libtrace->perpkt_cond, NULL), == 0);
267        libtrace->state = STATE_NEW;
268        libtrace->perpkt_queue_full = false;
269        libtrace->global_blob = NULL;
270        libtrace->per_pkt = NULL;
271        libtrace->reporter = NULL;
272        libtrace->hasher = NULL;
273        libtrace_zero_ocache(&libtrace->packet_freelist);
274        libtrace_zero_thread(&libtrace->hasher_thread);
275        libtrace_zero_thread(&libtrace->reporter_thread);
276        libtrace_zero_thread(&libtrace->keepalive_thread);
277        libtrace->reporter_thread.type = THREAD_EMPTY;
278        libtrace->perpkt_thread_count = 0;
279        libtrace->perpkt_threads = NULL;
280        libtrace->tracetime = 0;
281        libtrace->first_packets.first = 0;
282        libtrace->first_packets.count = 0;
283        libtrace->first_packets.packets = NULL;
284        libtrace->stats = NULL;
285        libtrace->pread = NULL;
286        libtrace->sequence_number = 0;
287        ZERO_USER_CONFIG(libtrace->config);
288        memset(&libtrace->combiner, 0, sizeof(libtrace->combiner));
289
290        /* Parse the URI to determine what sort of trace we are dealing with */
291        if ((uridata = trace_parse_uri(uri, &scan)) == 0) {
292                /* Could not parse the URI nicely */
293                guess_format(libtrace,uri);
294                if (!libtrace->format) {
295                        trace_set_err(libtrace,TRACE_ERR_BAD_FORMAT,"Unable to guess format (%s)",uri);
296                        return libtrace;
297                }
298        }
299        else {
300                struct libtrace_format_t *tmp;
301
302                /* Find a format that matches the first part of the URI */
303                for (tmp=formats_list;tmp;tmp=tmp->next) {
304                        if (strlen(scan) == strlen(tmp->name) &&
305                                        strncasecmp(scan, tmp->name, strlen(scan)) == 0
306                                        ) {
307                                libtrace->format=tmp;
308                                break;
309                        }
310                }
311
312                if (libtrace->format == 0) {
313                        trace_set_err(libtrace, TRACE_ERR_BAD_FORMAT,
314                                        "Unknown format (%s)",scan);
315                        return libtrace;
316                }
317
318                libtrace->uridata = strdup(uridata);
319        }
320        /* libtrace->format now contains the type of uri
321         * libtrace->uridata contains the appropriate data for this
322         */
323       
324        /* Call the init_input function for the matching capture format */ 
325        if (libtrace->format->init_input) {
326                int err=libtrace->format->init_input(libtrace);
327                assert (err==-1 || err==0);
328                if (err==-1) {
329                        /* init_input should call trace_set_err to set
330                         * the error message
331                         */
332                        return libtrace;
333                }
334        } else {
335                trace_set_err(libtrace,TRACE_ERR_UNSUPPORTED,
336                                "Format does not support input (%s)",scan);
337                return libtrace;
338        }
339       
340        if (scan)
341                free(scan);
342        libtrace->err.err_num=TRACE_ERR_NOERROR;
343        libtrace->err.problem[0]='\0';
344        return libtrace;
345}
346
347/* Creates a "dummy" trace file that has only the format type set.
348 *
349 * @returns opaque pointer to a (sparsely initialised) libtrace_t
350 *
351 * IMPORTANT: Do not attempt to call trace_read_packet or other such functions
352 * with the dummy trace. Its intended purpose is to act as a packet->trace for
353 * libtrace_packet_t's that are not associated with a libtrace_t structure.
354 */
355DLLEXPORT libtrace_t * trace_create_dead (const char *uri) {
356        libtrace_t *libtrace = (libtrace_t *) malloc(sizeof(libtrace_t));
357        char *scan = (char *)calloc(sizeof(char),URI_PROTO_LINE);
358        char *uridata;
359        struct libtrace_format_t *tmp;
360
361        trace_init();
362       
363        libtrace->err.err_num = TRACE_ERR_NOERROR;
364
365        if((uridata = strchr(uri,':')) == NULL) {
366                xstrncpy(scan, uri, strlen(uri));
367        } else {
368                xstrncpy(scan,uri, (size_t)(uridata - uri));
369        }
370       
371        libtrace->err.err_num = TRACE_ERR_NOERROR;
372        libtrace->format=NULL;
373       
374        libtrace->event.tdelta = 0.0;
375        libtrace->event.packet = NULL;
376        libtrace->event.psize = 0;
377        libtrace->event.trace_last_ts = 0.0;
378        libtrace->filter = NULL;
379        libtrace->snaplen = 0;
380        libtrace->started=false;
381        libtrace->uridata = NULL;
382        libtrace->io = NULL;
383        libtrace->filtered_packets = 0;
384       
385        /* Parallel inits */
386        ASSERT_RET(pthread_mutex_init(&libtrace->libtrace_lock, NULL), == 0);
387        ASSERT_RET(pthread_cond_init(&libtrace->perpkt_cond, NULL), == 0);
388        libtrace->state = STATE_NEW; // TODO MAYBE DEAD
389        libtrace->perpkt_queue_full = false;
390        libtrace->global_blob = NULL;
391        libtrace->per_pkt = NULL;
392        libtrace->reporter = NULL;
393        libtrace->hasher = NULL;
394        libtrace_zero_ocache(&libtrace->packet_freelist);
395        libtrace_zero_thread(&libtrace->hasher_thread);
396        libtrace_zero_thread(&libtrace->reporter_thread);
397        libtrace_zero_thread(&libtrace->keepalive_thread);
398        libtrace->reporter_thread.type = THREAD_EMPTY;
399        libtrace->perpkt_thread_count = 0;
400        libtrace->perpkt_threads = NULL;
401        libtrace->tracetime = 0;
402        libtrace->stats = NULL;
403        libtrace->pread = NULL;
404        libtrace->sequence_number = 0;
405        ZERO_USER_CONFIG(libtrace->config);
406        memset(&libtrace->combiner, 0, sizeof(libtrace->combiner));
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 (option == TRACE_OPTION_HASHER)
566                return trace_set_hasher(libtrace,
567                                        (enum hasher_types) *((int *) value),
568                                        NULL, NULL);
569
570        /* If the capture format supports configuration, try using their
571         * native configuration first */
572        if (libtrace->format->config_input) {
573                ret=libtrace->format->config_input(libtrace,option,value);
574                if (ret==0)
575                        return 0;
576        }
577
578        /* If we get here, either the native configuration failed or the
579         * format did not support configuration. However, libtrace can
580         * deal with some options itself, so give that a go */
581        switch(option) {
582                case TRACE_OPTION_SNAPLEN:
583                        /* Clear the error if there was one */
584                        if (trace_is_err(libtrace)) {
585                                trace_get_err(libtrace);
586                        }
587                        if (*(int*)value<0 
588                                || *(int*)value>LIBTRACE_PACKET_BUFSIZE) {
589                                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,
590                                        "Invalid snap length");
591                        }
592                        libtrace->snaplen=*(int*)value;
593                        return 0;
594                case TRACE_OPTION_FILTER:
595                        /* Clear the error if there was one */
596                        if (trace_is_err(libtrace)) {
597                                trace_get_err(libtrace);
598                        }
599                        libtrace->filter=(libtrace_filter_t *)value;
600                        return 0;
601                case TRACE_OPTION_PROMISC:
602                        if (!trace_is_err(libtrace)) {
603                                trace_set_err(libtrace,TRACE_ERR_OPTION_UNAVAIL,
604                                                "Promisc mode is not supported by this format module");
605                        }
606                        return -1;
607                case TRACE_OPTION_META_FREQ:
608                        if (!trace_is_err(libtrace)) {
609                                trace_set_err(libtrace, 
610                                                TRACE_ERR_OPTION_UNAVAIL,
611                                                "This format does not support meta-data gathering");
612                        }
613                        return -1;
614                case TRACE_OPTION_EVENT_REALTIME:
615                        if (!trace_is_err(libtrace)) {
616                                trace_set_err(libtrace, 
617                                                TRACE_ERR_OPTION_UNAVAIL,
618                                                "This format does not support realtime events");
619                        }
620                        return -1;
621                case TRACE_OPTION_HASHER:
622                        /* Dealt with earlier */
623                        return -1;
624                       
625        }
626        if (!trace_is_err(libtrace)) {
627                trace_set_err(libtrace,TRACE_ERR_UNKNOWN_OPTION,
628                        "Unknown option %i", option);
629        }
630        return -1;
631}
632
633DLLEXPORT int trace_set_snaplen(libtrace_t *trace, int snaplen) {
634        return trace_config(trace, TRACE_OPTION_SNAPLEN, &snaplen);
635}
636
637DLLEXPORT int trace_set_promisc(libtrace_t *trace, bool promisc) {
638        int tmp = promisc;
639        return trace_config(trace, TRACE_OPTION_PROMISC, &tmp);
640}
641
642DLLEXPORT int trace_set_filter(libtrace_t *trace, libtrace_filter_t *filter) {
643        return trace_config(trace, TRACE_OPTION_FILTER, filter);
644}
645
646DLLEXPORT int trace_set_meta_freq(libtrace_t *trace, int freq) {
647        return trace_config(trace, TRACE_OPTION_META_FREQ, &freq);
648}
649
650DLLEXPORT int trace_set_event_realtime(libtrace_t *trace, bool realtime) {
651        int tmp = realtime;
652        return trace_config(trace, TRACE_OPTION_EVENT_REALTIME, &tmp);
653}
654
655DLLEXPORT int trace_config_output(libtrace_out_t *libtrace, 
656                trace_option_output_t option,
657                void *value) {
658       
659        /* Unlike the input options, libtrace does not natively support any of
660         * the output options - the format module must be able to deal with
661         * them. */
662        if (libtrace->format->config_output) {
663                return libtrace->format->config_output(libtrace, option, value);
664        }
665        return -1;
666}
667
668/* Close an input trace file, freeing up any resources it may have been using
669 *
670 */
671DLLEXPORT void trace_destroy(libtrace_t *libtrace) {
672        int i;
673        assert(libtrace);
674
675        ASSERT_RET(pthread_mutex_destroy(&libtrace->libtrace_lock), == 0);
676        ASSERT_RET(pthread_cond_destroy(&libtrace->perpkt_cond), == 0);
677
678        /* destroy any packets that are still around */
679        if (libtrace->state != STATE_NEW && libtrace->first_packets.packets) {
680                for (i = 0; i < libtrace->perpkt_thread_count; ++i) {
681                        if(libtrace->first_packets.packets[i].packet) {
682                                trace_destroy_packet(libtrace->first_packets.packets[i].packet);
683                        }
684                }
685                free(libtrace->first_packets.packets);
686                ASSERT_RET(pthread_spin_destroy(&libtrace->first_packets.lock), == 0);
687        }
688
689        if (libtrace->format) {
690                if (libtrace->started && libtrace->format->pause_input)
691                        libtrace->format->pause_input(libtrace);
692                if (libtrace->format->fin_input)
693                        libtrace->format->fin_input(libtrace);
694        }
695        /* Need to free things! */
696        if (libtrace->uridata)
697                free(libtrace->uridata);
698
699        if (libtrace->stats)
700                free(libtrace->stats);
701       
702        /* Empty any packet memory */
703        if (libtrace->state != STATE_NEW) {
704                // This has all of our packets
705                libtrace_ocache_destroy(&libtrace->packet_freelist);
706                if (libtrace->combiner.destroy && libtrace->reporter)
707                        libtrace->combiner.destroy(libtrace, &libtrace->combiner);
708                free(libtrace->perpkt_threads);
709                libtrace->perpkt_threads = NULL;
710                libtrace->perpkt_thread_count = 0;
711        }
712       
713        if (libtrace->event.packet) {
714                /* Don't use trace_destroy_packet here - there is almost
715                 * certainly going to be another libtrace_packet_t that is
716                 * pointing to the buffer for this packet, so we don't want
717                 * to free it. Rather, it will get freed when the user calls
718                 * trace_destroy_packet on the libtrace_packet_t that they
719                 * own.
720                 *
721                 * All we need to do then is free our packet structure itself.
722                 */
723                 free(libtrace->event.packet);
724        }
725        free(libtrace);
726}
727
728
729DLLEXPORT void trace_destroy_dead(libtrace_t *libtrace) {
730        assert(libtrace);
731
732        ASSERT_RET(pthread_mutex_destroy(&libtrace->libtrace_lock), == 0);
733        ASSERT_RET(pthread_cond_destroy(&libtrace->perpkt_cond), == 0);
734
735        /* Don't call pause_input or fin_input, because we should never have
736         * used this trace to do any reading anyway. Do make sure we free
737         * any format_data that has been created, though. */
738        if (libtrace->format_data)
739                free(libtrace->format_data);
740        free(libtrace);
741}
742/* Close an output trace file, freeing up any resources it may have been using
743 *
744 * @param libtrace      the output trace file to be destroyed
745 */
746DLLEXPORT void trace_destroy_output(libtrace_out_t *libtrace) 
747{
748        assert(libtrace);
749        if (libtrace->format && libtrace->format->fin_output)
750                libtrace->format->fin_output(libtrace);
751        if (libtrace->uridata)
752                free(libtrace->uridata);
753        free(libtrace);
754}
755
756DLLEXPORT libtrace_packet_t *trace_create_packet(void)
757{
758        libtrace_packet_t *packet =
759                (libtrace_packet_t*)calloc((size_t)1,sizeof(libtrace_packet_t));
760
761        packet->buf_control=TRACE_CTRL_PACKET;
762        trace_clear_cache(packet);
763        return packet;
764}
765
766DLLEXPORT libtrace_packet_t *trace_copy_packet(const libtrace_packet_t *packet) {
767        libtrace_packet_t *dest = 
768                (libtrace_packet_t *)malloc(sizeof(libtrace_packet_t));
769        if (!dest) {
770                printf("Out of memory constructing packet\n");
771                abort();
772        }
773        dest->trace=packet->trace;
774        dest->buffer=malloc(65536);
775        if (!dest->buffer) {
776                printf("Out of memory allocating buffer memory\n");
777                abort();
778        }
779        dest->header=dest->buffer;
780        dest->payload=(void*)
781                ((char*)dest->buffer+trace_get_framing_length(packet));
782        dest->type=packet->type;
783        dest->buf_control=TRACE_CTRL_PACKET;
784        dest->order = packet->order;
785        dest->hash = packet->hash;
786        dest->error = packet->error;
787        /* Reset the cache - better to recalculate than try to convert
788         * the values over to the new packet */
789        trace_clear_cache(dest);       
790        /* Ooooh nasty memcpys! This is why we want to avoid copying packets
791         * as much as possible */
792        memcpy(dest->header,packet->header,trace_get_framing_length(packet));
793        memcpy(dest->payload,packet->payload,trace_get_capture_length(packet));
794
795        return dest;
796}
797
798/** Destroy a packet object
799 */
800DLLEXPORT void trace_destroy_packet(libtrace_packet_t *packet) {
801        /* Free any resources possibly associated with the packet */
802        if (libtrace_parallel && packet->trace && packet->trace->format->fin_packet) {
803                packet->trace->format->fin_packet(packet);
804        }
805       
806        if (packet->buf_control == TRACE_CTRL_PACKET && packet->buffer) {
807                free(packet->buffer);
808        }
809        packet->buf_control=(buf_control_t)'\0'; 
810                                /* A "bad" value to force an assert
811                                 * if this packet is ever reused
812                                 */
813        free(packet);
814}
815
816/**
817 * Removes any possible data stored againt the trace and releases any data.
818 * This will not destroy a reusable good malloc'd buffer (TRACE_CTRL_PACKET)
819 * use trace_destroy_packet() for those diabolical purposes.
820 */
821void trace_fin_packet(libtrace_packet_t *packet) {
822        if (packet)
823        {
824                if (packet->trace && packet->trace->format->fin_packet) {
825                        packet->trace->format->fin_packet(packet);
826                }
827
828                // No matter what we remove the header and link pointers
829                packet->trace = NULL;
830                packet->header = NULL;
831                packet->payload = NULL;
832
833                if (packet->buf_control != TRACE_CTRL_PACKET)
834                {
835                        packet->buffer = NULL;
836                }
837
838                trace_clear_cache(packet);
839                packet->hash = 0;
840                packet->order = 0;
841        }
842}
843
844/* Read one packet from the trace into buffer. Note that this function will
845 * block until a packet is read (or EOF is reached).
846 *
847 * @param libtrace      the libtrace opaque pointer
848 * @param packet        the packet opaque pointer
849 * @returns 0 on EOF, negative value on error
850 *
851 */
852DLLEXPORT int trace_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
853
854        assert(libtrace && "You called trace_read_packet() with a NULL libtrace parameter!\n");
855        if (trace_is_err(libtrace))
856                return -1;
857        if (!libtrace->started) {
858                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,"You must call libtrace_start() before trace_read_packet()\n");
859                return -1;
860        }
861        if (!(packet->buf_control==TRACE_CTRL_PACKET || packet->buf_control==TRACE_CTRL_EXTERNAL)) {
862                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,"Packet passed to trace_read_packet() is invalid\n");
863                return -1;
864        }
865        assert(packet);
866
867        if (libtrace->format->read_packet) {
868                do {
869                        size_t ret;
870                        int filtret;
871                        /* Finalise the packet, freeing any resources the format module
872                         * may have allocated it and zeroing all data associated with it.
873                         */
874                        trace_fin_packet(packet);
875                        /* Store the trace we are reading from into the packet opaque
876                         * structure */
877                        packet->trace = libtrace;
878                        ret=libtrace->format->read_packet(libtrace,packet);
879                        if (ret==(size_t)-1 || ret==0) {
880                                return ret;
881                        }
882                        if (libtrace->filter) {
883                                /* If the filter doesn't match, read another
884                                 * packet
885                                 */
886                                filtret = trace_apply_filter(libtrace->filter, packet);
887                                if (filtret == -1) {
888                                        /* Error compiling filter, probably */
889                                        return ~0U;
890                                }
891                               
892                                if (filtret == 0) {
893                                        ++libtrace->filtered_packets;
894                                        continue;
895                                }
896                        }
897                        if (libtrace->snaplen>0) {
898                                /* Snap the packet */
899                                trace_set_capture_length(packet,
900                                                libtrace->snaplen);
901                        }
902                        trace_packet_set_order(packet, libtrace->sequence_number);
903                        ++libtrace->accepted_packets;
904                        ++libtrace->sequence_number;
905                        return ret;
906                } while(1);
907        }
908        trace_set_err(libtrace,TRACE_ERR_UNSUPPORTED,"This format does not support reading packets\n");
909        return ~0U;
910}
911
912/* Converts the provided buffer into a libtrace packet of the given type.
913 *
914 * Unlike trace_construct_packet, the buffer is expected to begin with the
915 * appropriate capture format header for the format type that the packet is
916 * being converted to. This also allows for a packet to be converted into
917 * just about capture format that is supported by libtrace, provided the
918 * format header is present in the buffer.
919 *
920 * This function is primarily used to convert packets received via the RT
921 * protocol back into their original capture format. The RT header encapsulates
922 * the original capture format header, so after removing it the packet must
923 * have it's header and payload pointers updated and the packet format and type
924 * changed, amongst other things.
925 *
926 * Intended only for internal use at this point - this function is not
927 * available through the external libtrace API.
928 */
929int trace_prepare_packet(libtrace_t *trace, libtrace_packet_t *packet,
930                void *buffer, libtrace_rt_types_t rt_type, uint32_t flags) {
931
932        assert(packet);
933        assert(trace);
934       
935        /* XXX Proper error handling?? */
936        if (buffer == NULL)
937                return -1;
938
939        if (!(packet->buf_control==TRACE_CTRL_PACKET || packet->buf_control==TRACE_CTRL_EXTERNAL)) {
940                trace_set_err(trace,TRACE_ERR_BAD_STATE,"Packet passed to trace_read_packet() is invalid\n");
941                return -1;
942        }
943       
944        packet->trace = trace;
945       
946        /* Clear packet cache */
947        trace_clear_cache(packet);
948
949        if (trace->format->prepare_packet) {
950                return trace->format->prepare_packet(trace, packet,
951                                buffer, rt_type, flags);
952        }
953        trace_set_err(trace, TRACE_ERR_UNSUPPORTED, 
954                        "This format does not support preparing packets\n");
955        return -1;
956
957}
958
959/* Writes a packet to the specified output trace
960 *
961 * @param libtrace      describes the output format, destination, etc.
962 * @param packet        the packet to be written out
963 * @returns the number of bytes written, -1 if write failed
964 */
965DLLEXPORT int trace_write_packet(libtrace_out_t *libtrace, libtrace_packet_t *packet) {
966        assert(libtrace);
967        assert(packet);
968        /* Verify the packet is valid */
969        if (!libtrace->started) {
970                trace_set_err_out(libtrace,TRACE_ERR_BAD_STATE,
971                        "Trace is not started before trace_write_packet");
972                return -1;
973        }
974
975        if (libtrace->format->write_packet) {
976                return libtrace->format->write_packet(libtrace, packet);
977        }
978        trace_set_err_out(libtrace,TRACE_ERR_UNSUPPORTED,
979                "This format does not support writing packets");
980        return -1;
981}
982
983/* Get a pointer to the first byte of the packet payload */
984DLLEXPORT void *trace_get_packet_buffer(const libtrace_packet_t *packet,
985                libtrace_linktype_t *linktype, uint32_t *remaining) {
986        int cap_len;
987        int wire_len;
988
989        assert(packet != NULL);
990        if (linktype) *linktype = trace_get_link_type(packet);
991        if (remaining) {
992                /* I think we should choose the minimum of the capture and
993                 * wire lengths to be the "remaining" value. If the packet has
994                 * been padded to increase the capture length, we don't want
995                 * to allow subsequent protocol decoders to consider the
996                 * padding as part of the packet.
997                 *
998                 * For example, in Auck 4 there is a trace where the IP header
999                 * length is incorrect (24 bytes) followed by a 20 byte TCP
1000                 * header. Total IP length is 40 bytes. As a result, the
1001                 * legacyatm padding gets treated as the "missing" bytes of
1002                 * the TCP header, which isn't the greatest. We're probably
1003                 * better off returning an incomplete TCP header in that case.
1004                 */
1005               
1006                cap_len = trace_get_capture_length(packet);
1007                wire_len = trace_get_wire_length(packet);
1008
1009                assert(cap_len >= 0);
1010
1011                /* There is the odd corrupt packet, e.g. in IPLS II, that have
1012                 * massively negative wire lens. We could assert fail here on
1013                 * them, but we could at least try the capture length instead.
1014                 *
1015                 * You may still run into problems if you try to write that
1016                 * packet, but at least reading should work OK.
1017                 */
1018                if (wire_len < 0)
1019                        *remaining = cap_len;
1020                else if (wire_len < cap_len)
1021                        *remaining = wire_len;
1022                else
1023                        *remaining = cap_len;
1024                /* *remaining = trace_get_capture_length(packet); */
1025        }
1026        return (void *) packet->payload;
1027}
1028
1029
1030/* Get a pointer to the first byte of the packet payload
1031 *
1032 * DEPRECATED - use trace_get_packet_buffer() instead */
1033DLLEXPORT void *trace_get_link(const libtrace_packet_t *packet) {
1034        return (void *)packet->payload;
1035}
1036
1037/* Get the current time in DAG time format
1038 * @param packet        a pointer to a libtrace_packet structure
1039 * @returns a 64 bit timestamp in DAG ERF format (upper 32 bits are the seconds
1040 * past 1970-01-01, the lower 32bits are partial seconds)
1041 */ 
1042DLLEXPORT uint64_t trace_get_erf_timestamp(const libtrace_packet_t *packet) {
1043        if (packet->trace->format->get_erf_timestamp) {
1044                /* timestamp -> timestamp */
1045                return packet->trace->format->get_erf_timestamp(packet);
1046        } else if (packet->trace->format->get_timespec) {
1047                /* timespec -> timestamp */
1048                struct timespec ts;
1049                ts = packet->trace->format->get_timespec(packet);
1050                return ((((uint64_t)ts.tv_sec) << 32) +
1051                                (((uint64_t)ts.tv_nsec << 32)/1000000000));
1052        } else if (packet->trace->format->get_timeval) {
1053                /* timeval -> timestamp */
1054                struct timeval tv;
1055                tv = packet->trace->format->get_timeval(packet);
1056                return ((((uint64_t)tv.tv_sec) << 32) +
1057                                (((uint64_t)tv.tv_usec << 32)/1000000));
1058        } else if (packet->trace->format->get_seconds) {
1059                /* seconds -> timestamp */
1060                double seconds = packet->trace->format->get_seconds(packet);
1061                return (((uint64_t)seconds)<<32)
1062                          + (uint64_t)((seconds-(uint64_t)seconds)*UINT_MAX);
1063        }
1064        else {
1065                return (uint64_t)0;
1066        }
1067                     
1068}
1069
1070/* Get the current time in struct timeval
1071 * @param packet        a pointer to a libtrace_packet structure
1072 *
1073 * @returns time that this packet was seen in a struct timeval
1074 * @author Daniel Lawson
1075 * @author Perry Lorier
1076 */ 
1077DLLEXPORT struct timeval trace_get_timeval(const libtrace_packet_t *packet) {
1078        struct timeval tv;
1079        uint64_t ts = 0;
1080        if (packet->trace->format->get_timeval) {
1081                /* timeval -> timeval */
1082                tv = packet->trace->format->get_timeval(packet);
1083        } else if (packet->trace->format->get_erf_timestamp) {
1084                /* timestamp -> timeval */
1085                ts = packet->trace->format->get_erf_timestamp(packet);
1086                tv.tv_sec = ts >> 32;
1087                tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
1088                if (tv.tv_usec >= 1000000) {
1089                        tv.tv_usec -= 1000000;
1090                        tv.tv_sec += 1;
1091                }
1092        } else if (packet->trace->format->get_timespec) {
1093                struct timespec ts = packet->trace->format->get_timespec(packet);
1094                tv.tv_sec = ts.tv_sec;
1095                tv.tv_usec = ts.tv_nsec/1000;
1096        } else if (packet->trace->format->get_seconds) {
1097                /* seconds -> timeval */
1098                double seconds = packet->trace->format->get_seconds(packet);
1099                tv.tv_sec = (uint32_t)seconds;
1100                tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
1101        }
1102        else {
1103                tv.tv_sec=-1;
1104                tv.tv_usec=-1;
1105        }
1106
1107    return tv;
1108}
1109
1110DLLEXPORT struct timespec trace_get_timespec(const libtrace_packet_t *packet) {
1111        struct timespec ts;
1112
1113        if (packet->trace->format->get_timespec) {
1114                return packet->trace->format->get_timespec(packet);
1115        } else if (packet->trace->format->get_erf_timestamp) {
1116                /* timestamp -> timeval */
1117                uint64_t erfts = packet->trace->format->get_erf_timestamp(packet);
1118                ts.tv_sec = erfts >> 32;
1119                ts.tv_nsec = ((erfts&0xFFFFFFFF)*1000000000)>>32;
1120                if (ts.tv_nsec >= 1000000000) {
1121                        ts.tv_nsec -= 1000000000;
1122                        ts.tv_sec += 1;
1123                }
1124                return ts;
1125        } else if (packet->trace->format->get_timeval) {
1126                /* timeval -> timespec */
1127                struct timeval tv = packet->trace->format->get_timeval(packet);
1128                ts.tv_sec = tv.tv_sec;
1129                ts.tv_nsec = tv.tv_usec*1000;
1130                return ts;
1131        } else if (packet->trace->format->get_seconds) {
1132                /* seconds -> timespec */
1133                double seconds = packet->trace->format->get_seconds(packet);
1134                ts.tv_sec = (uint32_t)seconds;
1135                ts.tv_nsec = (long)(((seconds - ts.tv_sec) * 1000000000)/UINT_MAX);
1136                return ts;
1137        }
1138        else {
1139                ts.tv_sec=-1;
1140                ts.tv_nsec=-1;
1141                return ts;
1142        }
1143}
1144
1145
1146/* Get the current time in floating point seconds
1147 * @param packet        a pointer to a libtrace_packet structure
1148 * @returns time that this packet was seen in 64bit floating point seconds
1149 */ 
1150DLLEXPORT double trace_get_seconds(const libtrace_packet_t *packet) {
1151        double seconds = 0.0;
1152
1153        if (packet->trace->format->get_seconds) {
1154                /* seconds->seconds */
1155                seconds = packet->trace->format->get_seconds(packet);
1156        } else if (packet->trace->format->get_erf_timestamp) {
1157                /* timestamp -> seconds */
1158                uint64_t ts = 0;
1159                ts = packet->trace->format->get_erf_timestamp(packet);
1160                seconds =  (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
1161        } else if (packet->trace->format->get_timespec) {
1162                /* timespec -> seconds */
1163                struct timespec ts;
1164                ts = packet->trace->format->get_timespec(packet);
1165                seconds = ts.tv_sec + ((ts.tv_nsec * 1.0) / 1000000000);
1166        } else if (packet->trace->format->get_timeval) {
1167                /* timeval -> seconds */
1168                struct timeval tv;
1169                tv = packet->trace->format->get_timeval(packet);
1170                seconds = tv.tv_sec + ((tv.tv_usec * 1.0) / 1000000);
1171        }
1172
1173        return seconds;
1174}
1175
1176DLLEXPORT size_t trace_get_capture_length(const libtrace_packet_t *packet) 
1177{
1178        /* Cache the capture length */
1179        if (packet->capture_length == -1) {
1180                if (!packet->trace->format->get_capture_length)
1181                        return ~0U;
1182                /* Cast away constness because this is "just" a cache */
1183                ((libtrace_packet_t*)packet)->capture_length = 
1184                        packet->trace->format->get_capture_length(packet);
1185        }
1186
1187        assert(packet->capture_length < LIBTRACE_PACKET_BUFSIZE);
1188
1189        return packet->capture_length;
1190}
1191       
1192/* Get the size of the packet as it was seen on the wire.
1193 * @param packet        a pointer to a libtrace_packet structure
1194 *
1195 * @returns the size of the packet as it was on the wire.
1196 * @note Due to the trace being a header capture, or anonymisation this may
1197 * not be the same as the Capture Len.
1198 */ 
1199DLLEXPORT size_t trace_get_wire_length(const libtrace_packet_t *packet){
1200       
1201        if (packet->wire_length == -1) {
1202                if (!packet->trace->format->get_wire_length) 
1203                        return ~0U;
1204                ((libtrace_packet_t *)packet)->wire_length = 
1205                        packet->trace->format->get_wire_length(packet);
1206        }
1207
1208        assert(packet->wire_length < LIBTRACE_PACKET_BUFSIZE);
1209        return packet->wire_length;
1210
1211}
1212
1213/* Get the length of the capture framing headers.
1214 * @param packet        the packet opaque pointer
1215 * @returns the size of the packet as it was on the wire.
1216 * @note this length corresponds to the difference between the size of a
1217 * captured packet in memory, and the captured length of the packet
1218 */ 
1219DLLEXPORT SIMPLE_FUNCTION
1220size_t trace_get_framing_length(const libtrace_packet_t *packet) {
1221        if (packet->trace->format->get_framing_length) {
1222                return packet->trace->format->get_framing_length(packet);
1223        }
1224        return ~0U;
1225}
1226
1227
1228/* Get the type of the link layer
1229 * @param packet        a pointer to a libtrace_packet structure
1230 * @returns libtrace_linktype_t
1231 */
1232DLLEXPORT libtrace_linktype_t trace_get_link_type(const libtrace_packet_t *packet ) {
1233
1234        if (packet->link_type == 0) {
1235                if (!packet->trace->format->get_link_type)
1236                        return TRACE_TYPE_UNKNOWN;
1237                ((libtrace_packet_t *)packet)->link_type =
1238                        packet->trace->format->get_link_type(packet);
1239        }
1240
1241        return packet->link_type;
1242}
1243
1244/* process a libtrace event
1245 * @param trace the libtrace opaque pointer
1246 * @param packet the libtrace_packet opaque pointer
1247 * @returns
1248 *  TRACE_EVENT_IOWAIT  Waiting on I/O on fd
1249 *  TRACE_EVENT_SLEEP   Next event in seconds
1250 *  TRACE_EVENT_PACKET  Packet arrived in buffer with size size
1251 *  TRACE_EVENT_TERMINATE Trace terminated (perhaps with an error condition)
1252 * FIXME currently keeps a copy of the packet inside the trace pointer,
1253 * which in turn is stored inside the new packet object...
1254 */
1255DLLEXPORT libtrace_eventobj_t trace_event(libtrace_t *trace, 
1256                libtrace_packet_t *packet) {
1257        libtrace_eventobj_t event = {TRACE_EVENT_IOWAIT,0,0.0,0};
1258
1259        if (!trace) {
1260                fprintf(stderr,"You called trace_event() with a NULL trace object!\n");
1261        }
1262        assert(trace);
1263        assert(packet);
1264
1265        /* Free the last packet */
1266        trace_fin_packet(packet);
1267       
1268        /* Store the trace we are reading from into the packet opaque
1269         * structure */
1270        packet->trace = trace;
1271
1272        if (packet->trace->format->trace_event) {
1273                /* Note: incrementing accepted, filtered etc. packet
1274                 * counters is handled by the format-specific
1275                 * function so don't increment them here.
1276                 */
1277                event=packet->trace->format->trace_event(trace,packet);
1278                }
1279        return event;
1280
1281}
1282
1283/** Setup a BPF filter based on pre-compiled byte-code.
1284 * @param bf_insns      A pointer to the start of the byte-code
1285 * @param bf_len        The number of BPF instructions
1286 * @returns             an opaque pointer to a libtrace_filter_t object
1287 * @note                The supplied byte-code is not checked for correctness.
1288 * @author              Scott Raynel
1289 */
1290DLLEXPORT libtrace_filter_t *
1291trace_create_filter_from_bytecode(void *bf_insns, unsigned int bf_len)
1292{
1293#ifndef HAVE_BPF_FILTER
1294        fprintf(stderr, "This version of libtrace does not have BPF support\n");
1295        return NULL;
1296#else
1297        struct libtrace_filter_t *filter = (struct libtrace_filter_t *)
1298                malloc(sizeof(struct libtrace_filter_t));
1299        filter->filter.bf_insns = (struct bpf_insn *)
1300                malloc(sizeof(struct bpf_insn) * bf_len);
1301       
1302        memcpy(filter->filter.bf_insns, bf_insns,
1303                        bf_len * sizeof(struct bpf_insn));
1304       
1305        filter->filter.bf_len = bf_len;
1306        filter->filterstring = NULL;
1307        filter->jitfilter = NULL;
1308        /* "flag" indicates that the filter member is valid */
1309        filter->flag = 1; 
1310       
1311        return filter;
1312#endif
1313}
1314
1315/* Create a BPF filter
1316 * @param filterstring a char * containing the bpf filter string
1317 * @returns opaque pointer pointer to a libtrace_filter_t object
1318 */
1319DLLEXPORT libtrace_filter_t *trace_create_filter(const char *filterstring) {
1320#ifdef HAVE_BPF_FILTER
1321        libtrace_filter_t *filter = (libtrace_filter_t*)
1322                                malloc(sizeof(libtrace_filter_t));
1323        filter->filterstring = strdup(filterstring);
1324        filter->jitfilter = NULL;
1325        filter->flag = 0;
1326        return filter;
1327#else
1328        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1329        return NULL;
1330#endif
1331}
1332
1333DLLEXPORT void trace_destroy_filter(libtrace_filter_t *filter)
1334{
1335#ifdef HAVE_BPF_FILTER
1336        free(filter->filterstring);
1337        if (filter->flag)
1338                pcap_freecode(&filter->filter);
1339#ifdef HAVE_LLVM
1340        if (filter->jitfilter) 
1341                destroy_program(filter->jitfilter);
1342#endif
1343        free(filter);
1344#else
1345
1346#endif
1347}
1348
1349/* Compile a bpf filter, now we know the link type for the trace that we're
1350 * applying it to.
1351 *
1352 * @internal
1353 *
1354 * @returns -1 on error, 0 on success
1355 */
1356static int trace_bpf_compile(libtrace_filter_t *filter,
1357                const libtrace_packet_t *packet,
1358                void *linkptr, 
1359                libtrace_linktype_t linktype    ) {
1360#ifdef HAVE_BPF_FILTER
1361        /* It just so happens that the underlying libs used by pthread arn't
1362         * thread safe, namely lex/flex thingys, so single threaded compile
1363         * multi threaded running should be safe.
1364         */
1365        static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
1366        assert(filter);
1367
1368        /* If this isn't a real packet, then fail */
1369        if (!linkptr) {
1370                trace_set_err(packet->trace,
1371                                TRACE_ERR_BAD_FILTER,"Packet has no payload");
1372                return -1;
1373        }
1374       
1375        if (filter->filterstring && ! filter->flag) {
1376                pcap_t *pcap = NULL;
1377                if (linktype==(libtrace_linktype_t)-1) {
1378                        trace_set_err(packet->trace,
1379                                        TRACE_ERR_BAD_FILTER,
1380                                        "Packet has an unknown linktype");
1381                        return -1;
1382                }
1383                if (libtrace_to_pcap_dlt(linktype) == TRACE_DLT_ERROR) {
1384                        trace_set_err(packet->trace,TRACE_ERR_BAD_FILTER,
1385                                        "Unknown pcap equivalent linktype");
1386                        return -1;
1387                }
1388                assert (pthread_mutex_lock(&mutex) == 0);
1389                /* Make sure not one bet us to this */
1390                if (filter->flag) {
1391                        assert (pthread_mutex_unlock(&mutex) == 0);
1392                        return 1;
1393                }
1394                pcap=(pcap_t *)pcap_open_dead(
1395                                (int)libtrace_to_pcap_dlt(linktype),
1396                                1500U);
1397                /* build filter */
1398                assert(pcap);
1399                if (pcap_compile( pcap, &filter->filter, filter->filterstring, 
1400                                        1, 0)) {
1401                        trace_set_err(packet->trace,TRACE_ERR_BAD_FILTER,
1402                                        "Unable to compile the filter \"%s\": %s", 
1403                                        filter->filterstring,
1404                                        pcap_geterr(pcap));
1405                        pcap_close(pcap);
1406                        assert (pthread_mutex_unlock(&mutex) == 0);
1407                        return -1;
1408                }
1409                pcap_close(pcap);
1410                filter->flag=1;
1411                assert (pthread_mutex_unlock(&mutex) == 0);
1412        }
1413        return 0;
1414#else
1415        assert(!"Internal bug: This should never be called when BPF not enabled");
1416        trace_set_err(packet->trace,TRACE_ERR_OPTION_UNAVAIL,
1417                                "Feature unavailable");
1418        return -1;
1419#endif
1420}
1421
1422DLLEXPORT int trace_apply_filter(libtrace_filter_t *filter,
1423                        const libtrace_packet_t *packet) {
1424#ifdef HAVE_BPF_FILTER
1425        void *linkptr = 0;
1426        uint32_t clen = 0;
1427        bool free_packet_needed = false;
1428        int ret;
1429        libtrace_linktype_t linktype;
1430        libtrace_packet_t *packet_copy = (libtrace_packet_t*)packet;
1431#ifdef HAVE_LLVM
1432        static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
1433#endif
1434
1435        assert(filter);
1436        assert(packet);
1437
1438        /* Match all non-data packets as we probably want them to pass
1439         * through to the caller */
1440        linktype = trace_get_link_type(packet);
1441
1442        if (linktype == TRACE_TYPE_NONDATA)
1443                return 1;       
1444
1445        if (libtrace_to_pcap_dlt(linktype)==TRACE_DLT_ERROR) {
1446               
1447                /* If we cannot get a suitable DLT for the packet, it may
1448                 * be because the packet is encapsulated in a link type that
1449                 * does not correspond to a DLT. Therefore, we should try
1450                 * popping off headers until we either can find a suitable
1451                 * link type or we can't do any more sensible decapsulation. */
1452               
1453                /* Copy the packet, as we don't want to trash the one we
1454                 * were passed in */
1455                packet_copy=trace_copy_packet(packet);
1456                free_packet_needed=true;
1457
1458                while (libtrace_to_pcap_dlt(linktype) == TRACE_DLT_ERROR) {
1459                        if (!demote_packet(packet_copy)) {
1460                                trace_set_err(packet->trace, 
1461                                                TRACE_ERR_NO_CONVERSION,
1462                                                "pcap does not support this format");
1463                                if (free_packet_needed) {
1464                                        trace_destroy_packet(packet_copy);
1465                                }
1466                                return -1;
1467                        }
1468                        linktype = trace_get_link_type(packet_copy);
1469                }
1470
1471        }
1472       
1473        linkptr = trace_get_packet_buffer(packet_copy,NULL,&clen);
1474        if (!linkptr) {
1475                if (free_packet_needed) {
1476                        trace_destroy_packet(packet_copy);
1477                }
1478                return 0;
1479        }
1480
1481        /* We need to compile the filter now, because before we didn't know
1482         * what the link type was
1483         */
1484        // Note internal mutex locking used here
1485        if (trace_bpf_compile(filter,packet_copy,linkptr,linktype)==-1) {
1486                if (free_packet_needed) {
1487                        trace_destroy_packet(packet_copy);
1488                }
1489                return -1;
1490        }
1491
1492        /* If we're jitting, we may need to JIT the BPF code now too */
1493#if HAVE_LLVM
1494        if (!filter->jitfilter) {
1495                ASSERT_RET(pthread_mutex_lock(&mutex), == 0);
1496                /* Again double check here like the bpf filter */
1497                if(!filter->jitfilter)
1498                /* Looking at compile_program source this appears to be thread safe
1499                 * however if this gets called twice we will leak this memory :(
1500                 * as such lock here anyways */
1501                        filter->jitfilter = compile_program(filter->filter.bf_insns, filter->filter.bf_len);
1502                ASSERT_RET(pthread_mutex_unlock(&mutex), == 0);
1503        }
1504#endif
1505
1506        assert(filter->flag);
1507        /* Now execute the filter */
1508#if HAVE_LLVM
1509        ret=filter->jitfilter->bpf_run((unsigned char *)linkptr, clen);
1510#else
1511        ret=bpf_filter(filter->filter.bf_insns,(u_char*)linkptr,(unsigned int)clen,(unsigned int)clen);
1512#endif
1513
1514        /* If we copied the packet earlier, make sure that we free it */
1515        if (free_packet_needed) {
1516                trace_destroy_packet(packet_copy);
1517        }
1518        return ret;
1519#else
1520        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1521        return 0;
1522#endif
1523}
1524
1525/* Set the direction flag, if it has one
1526 * @param packet the packet opaque pointer
1527 * @param direction the new direction (0,1,2,3)
1528 * @returns a signed value containing the direction flag, or -1 if this is not supported
1529 */
1530DLLEXPORT libtrace_direction_t trace_set_direction(libtrace_packet_t *packet, 
1531                libtrace_direction_t direction) 
1532{
1533        assert(packet);
1534        if (packet->trace->format->set_direction) {
1535                return packet->trace->format->set_direction(packet,direction);
1536        }
1537        return (libtrace_direction_t)~0U;
1538}
1539
1540/* Get the direction flag, if it has one
1541 * @param packet a pointer to a libtrace_packet structure
1542 * @returns a signed value containing the direction flag, or -1 if this is not supported
1543 * The direction is defined as 0 for packets originating locally (ie, outbound)
1544 * and 1 for packets originating remotely (ie, inbound).
1545 * Other values are possible, which might be overloaded to mean special things
1546 * for a special trace.
1547 */
1548DLLEXPORT libtrace_direction_t trace_get_direction(const libtrace_packet_t *packet) 
1549{
1550        assert(packet);
1551        if (packet->trace->format->get_direction) {
1552                return packet->trace->format->get_direction(packet);
1553        }
1554        return (libtrace_direction_t)~0U;
1555}
1556
1557#define ROOT_SERVER(x) ((x) < 512)
1558#define ROOT_CLIENT(x) ((512 <= (x)) && ((x) < 1024))
1559#define NONROOT_SERVER(x) ((x) >= 5000)
1560#define NONROOT_CLIENT(x) ((1024 <= (x)) && ((x) < 5000))
1561#define DYNAMIC(x) ((49152 < (x)) && ((x) < 65535))
1562#define SERVER(x) ROOT_SERVER(x) || NONROOT_SERVER(x)
1563#define CLIENT(x) ROOT_CLIENT(x) || NONROOT_CLIENT(x)
1564
1565/* Attempt to deduce the 'server' port
1566 * @param protocol the IP protocol (eg, 6 or 17 for TCP or UDP)
1567 * @param source the TCP or UDP source port
1568 * @param dest the TCP or UDP destination port
1569 * @returns a hint as to which port is the server port
1570 */
1571DLLEXPORT int8_t trace_get_server_port(UNUSED uint8_t protocol, 
1572                uint16_t source, uint16_t dest) 
1573{
1574        /*
1575         * * If the ports are equal, return DEST
1576         * * Check for well-known ports in the given protocol
1577         * * Root server ports: 0 - 511
1578         * * Root client ports: 512 - 1023
1579         * * non-root client ports: 1024 - 4999
1580         * * non-root server ports: 5000+
1581         * * Check for static ranges: 1024 - 49151
1582         * * Check for dynamic ranges: 49152 - 65535
1583         * * flip a coin.
1584         */
1585       
1586        /* equal */
1587        if (source == dest)
1588                return USE_DEST;
1589
1590        /* root server port, 0 - 511 */
1591        if (ROOT_SERVER(source) && ROOT_SERVER(dest)) {
1592                if (source < dest)
1593                        return USE_SOURCE;
1594                return USE_DEST;
1595        }
1596
1597        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1598                return USE_SOURCE;
1599        if (!ROOT_SERVER(source) && ROOT_SERVER(dest))
1600                return USE_DEST;
1601
1602        /* non-root server */
1603        if (NONROOT_SERVER(source) && NONROOT_SERVER(dest)) {
1604                if (source < dest)
1605                        return USE_SOURCE;
1606                return USE_DEST;
1607        }
1608        if (NONROOT_SERVER(source) && !NONROOT_SERVER(dest))
1609                return USE_SOURCE;
1610        if (!NONROOT_SERVER(source) && NONROOT_SERVER(dest))
1611                return USE_DEST;
1612
1613        /* root client */
1614        if (ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1615                if (source < dest)
1616                        return USE_SOURCE;
1617                return USE_DEST;
1618        }
1619        if (ROOT_CLIENT(source) && !ROOT_CLIENT(dest)) {
1620                /* prefer root-client over nonroot-client */
1621                if (NONROOT_CLIENT(dest))
1622                        return USE_SOURCE;
1623                return USE_DEST;
1624        }
1625        if (!ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1626                /* prefer root-client over nonroot-client */
1627                if (NONROOT_CLIENT(source))
1628                        return USE_DEST;
1629                return USE_SOURCE;
1630        }
1631       
1632        /* nonroot client */
1633        if (NONROOT_CLIENT(source) && NONROOT_CLIENT(dest)) {
1634                if (source < dest) 
1635                        return USE_SOURCE;
1636                return USE_DEST;
1637        }
1638        if (NONROOT_CLIENT(source) && !NONROOT_CLIENT(dest))
1639                return USE_DEST;
1640        if (!NONROOT_CLIENT(source) && NONROOT_CLIENT(dest))
1641                return USE_SOURCE;
1642
1643        /* dynamic range */
1644        if (DYNAMIC(source) && DYNAMIC(dest)) {
1645                if (source < dest)
1646                        return USE_SOURCE;
1647                return USE_DEST;
1648        }
1649        if (DYNAMIC(source) && !DYNAMIC(dest))
1650                return USE_DEST;
1651        if (!DYNAMIC(source) && DYNAMIC(dest))
1652                return USE_SOURCE;
1653        /*
1654        if (SERVER(source) && CLIENT(dest))
1655                return USE_SOURCE;
1656       
1657        if (SERVER(dest) && CLIENT(source))
1658                return USE_DEST;
1659        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1660                return USE_SOURCE;
1661        if (ROOT_SERVER(dest) && !ROOT_SERVER(source))
1662                return USE_DEST;
1663        */
1664        /* failing that test... */
1665        if (source < dest) {
1666                return USE_SOURCE;
1667        } 
1668        return USE_DEST;
1669       
1670}
1671
1672/* Truncate the packet at the suggested length
1673 * @param packet        the packet opaque pointer
1674 * @param size          the new length of the packet
1675 * @returns the new size of the packet
1676 * @note size and the return size refer to the network-level payload of the
1677 * packet, and do not include any capture headers. For example, to truncate a
1678 * packet after the IP header, set size to sizeof(ethernet_header) +
1679 * sizeof(ip_header)
1680 * @note If the original network-level payload is smaller than size, then the
1681 * original size is returned and the packet is left unchanged.
1682 */
1683DLLEXPORT size_t trace_set_capture_length(libtrace_packet_t *packet, size_t size) {
1684        assert(packet);
1685
1686        if (packet->trace->format->set_capture_length) {
1687                packet->capture_length = packet->trace->format->set_capture_length(packet,size);
1688                return packet->capture_length;
1689        }
1690
1691        return ~0U;
1692}
1693
1694/* Splits a URI into two components - the format component which is seen before
1695 * the ':', and the uridata which follows the ':'.
1696 *
1697 * Returns a pointer to the URI data, but updates the format parameter to
1698 * point to a copy of the format component.
1699 */
1700
1701DLLEXPORT const char * trace_parse_uri(const char *uri, char **format) {
1702        const char *uridata = 0;
1703       
1704        if((uridata = strchr(uri,':')) == NULL) {
1705                /* Badly formed URI - needs a : */
1706                return 0;
1707        }
1708
1709        if ((unsigned)(uridata - uri) > URI_PROTO_LINE) {
1710                /* Badly formed URI - uri type is too long */
1711                return 0;
1712        }
1713
1714        /* NOTE: this is allocated memory - it should be freed by the caller
1715         * once they are done with it */
1716        *format=xstrndup(uri, (size_t)(uridata - uri));
1717
1718        /* Push uridata past the delimiter */
1719        uridata++;
1720       
1721        return uridata;
1722}
1723
1724enum base_format_t trace_get_format(libtrace_packet_t *packet) 
1725{
1726        assert(packet);
1727
1728        return packet->trace->format->type;
1729}
1730       
1731DLLEXPORT libtrace_err_t trace_get_err(libtrace_t *trace)
1732{
1733        libtrace_err_t err = trace->err;
1734        trace->err.err_num = 0; /* "OK" */
1735        trace->err.problem[0]='\0';
1736        return err;
1737}
1738
1739DLLEXPORT bool trace_is_err(libtrace_t *trace)
1740{
1741        return trace->err.err_num != 0;
1742}
1743
1744/* Prints the input error status to standard error and clears the error state */
1745DLLEXPORT void trace_perror(libtrace_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                if (trace->uridata) {
1754                        fprintf(stderr,"%s(%s): %s\n",
1755                                        buf,trace->uridata,trace->err.problem);
1756                } else {
1757                        fprintf(stderr,"%s: %s\n", buf, trace->err.problem);
1758                }
1759        } else {
1760                if (trace->uridata) {
1761                        fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
1762                } else {
1763                        fprintf(stderr,"%s: No error\n", buf);
1764                }
1765        }
1766        trace->err.err_num = 0; /* "OK" */
1767        trace->err.problem[0]='\0';
1768}
1769
1770DLLEXPORT libtrace_err_t trace_get_err_output(libtrace_out_t *trace)
1771{
1772        libtrace_err_t err = trace->err;
1773        trace->err.err_num = TRACE_ERR_NOERROR; /* "OK" */
1774        trace->err.problem[0]='\0';
1775        return err;
1776}
1777
1778DLLEXPORT bool trace_is_err_output(libtrace_out_t *trace)
1779{
1780        return trace->err.err_num != 0;
1781}
1782
1783/* Prints the output error status to standard error and clears the error state
1784 */
1785DLLEXPORT void trace_perror_output(libtrace_out_t *trace,const char *msg,...)
1786{
1787        char buf[256];
1788        va_list va;
1789        va_start(va,msg);
1790        vsnprintf(buf,sizeof(buf),msg,va);
1791        va_end(va);
1792        if(trace->err.err_num) {
1793                fprintf(stderr,"%s(%s): %s\n",
1794                                buf,
1795                                trace->uridata?trace->uridata:"no uri",
1796                                trace->err.problem);
1797        } else {
1798                fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
1799        }
1800        trace->err.err_num = TRACE_ERR_NOERROR; /* "OK" */
1801        trace->err.problem[0]='\0';
1802}
1803
1804DLLEXPORT int trace_seek_erf_timestamp(libtrace_t *trace, uint64_t ts)
1805{
1806        if (trace->format->seek_erf) {
1807                return trace->format->seek_erf(trace,ts);
1808        }
1809        else {
1810                if (trace->format->seek_timeval) {
1811                        struct timeval tv;
1812#if __BYTE_ORDER == __BIG_ENDIAN
1813                        tv.tv_sec = ts & 0xFFFFFFFF;
1814                        tv.tv_usec = ((ts >> 32) * 1000000) & 0xFFFFFFFF;
1815#elif __BYTE_ORDER == __LITTLE_ENDIAN
1816                        tv.tv_sec = ts >> 32;
1817                        tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
1818#else
1819#error "What on earth are you running this on?"
1820#endif
1821                        if (tv.tv_usec >= 1000000) {
1822                                tv.tv_usec -= 1000000;
1823                                tv.tv_sec += 1;
1824                        }
1825                        return trace->format->seek_timeval(trace,tv);
1826                }
1827                if (trace->format->seek_seconds) {
1828                        double seconds = 
1829                                (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
1830                        return trace->format->seek_seconds(trace,seconds);
1831                }
1832                trace_set_err(trace,
1833                                TRACE_ERR_OPTION_UNAVAIL,
1834                                "Feature unimplemented");
1835                return -1;
1836        }
1837}
1838
1839DLLEXPORT int trace_seek_seconds(libtrace_t *trace, double seconds)
1840{
1841        if (trace->format->seek_seconds) {
1842                return trace->format->seek_seconds(trace,seconds);
1843        }
1844        else {
1845                if (trace->format->seek_timeval) {
1846                        struct timeval tv;
1847                        tv.tv_sec = (uint32_t)seconds;
1848                        tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
1849                        return trace->format->seek_timeval(trace,tv);
1850                }
1851                if (trace->format->seek_erf) {
1852                        uint64_t timestamp = 
1853                                ((uint64_t)((uint32_t)seconds) << 32) + \
1854                            (uint64_t)(( seconds - (uint32_t)seconds   ) * UINT_MAX);
1855                        return trace->format->seek_erf(trace,timestamp);
1856                }
1857                trace_set_err(trace,
1858                                TRACE_ERR_OPTION_UNAVAIL,
1859                                "Feature unimplemented");
1860                return -1;
1861        }
1862}
1863
1864DLLEXPORT int trace_seek_timeval(libtrace_t *trace, struct timeval tv)
1865{
1866        if (trace->format->seek_timeval) {
1867                return trace->format->seek_timeval(trace,tv);
1868        }
1869        else {
1870                if (trace->format->seek_erf) {
1871                        uint64_t timestamp = ((((uint64_t)tv.tv_sec) << 32) + \
1872                                (((uint64_t)tv.tv_usec * UINT_MAX)/1000000));
1873                        return trace->format->seek_erf(trace,timestamp);
1874                }
1875                if (trace->format->seek_seconds) {
1876                        double seconds = tv.tv_sec + ((tv.tv_usec * 1.0)/1000000);
1877                        return trace->format->seek_seconds(trace,seconds);
1878                }
1879                trace_set_err(trace,
1880                                TRACE_ERR_OPTION_UNAVAIL,
1881                                "Feature unimplemented");
1882                return -1;
1883        }
1884}
1885
1886/* Converts a binary ethernet MAC address into a printable string */
1887DLLEXPORT char *trace_ether_ntoa(const uint8_t *addr, char *buf)
1888{
1889        static char staticbuf[18]={0,};
1890        if (!buf)
1891                buf=staticbuf;
1892        snprintf(buf,(size_t)18,"%02x:%02x:%02x:%02x:%02x:%02x",
1893                        addr[0],addr[1],addr[2],
1894                        addr[3],addr[4],addr[5]);
1895        return buf;
1896}
1897
1898/* Converts a printable ethernet MAC address into a binary format */
1899DLLEXPORT uint8_t *trace_ether_aton(const char *buf, uint8_t *addr)
1900{
1901        uint8_t *buf2 = addr;
1902        unsigned int tmp[6];
1903        static uint8_t staticaddr[6];
1904        if (!buf2)
1905                buf2=staticaddr;
1906        sscanf(buf,"%x:%x:%x:%x:%x:%x",
1907                        &tmp[0],&tmp[1],&tmp[2],
1908                        &tmp[3],&tmp[4],&tmp[5]);
1909        buf2[0]=tmp[0]; buf2[1]=tmp[1]; buf2[2]=tmp[2];
1910        buf2[3]=tmp[3]; buf2[4]=tmp[4]; buf2[5]=tmp[5];
1911        return buf2;
1912}
1913
1914
1915/* Creates a libtrace packet from scratch using the contents of the provided
1916 * buffer as the packet payload.
1917 *
1918 * Unlike trace_prepare_packet(), the buffer should not contain any capture
1919 * format headers; instead this function will add the PCAP header to the
1920 * packet record. This also means only PCAP packets can be constructed using
1921 * this function.
1922 *
1923 */
1924DLLEXPORT
1925void trace_construct_packet(libtrace_packet_t *packet,
1926                libtrace_linktype_t linktype,
1927                const void *data,
1928                uint16_t len)
1929{
1930        size_t size;
1931        static libtrace_t *deadtrace=NULL;
1932        libtrace_pcapfile_pkt_hdr_t hdr;
1933#ifdef WIN32
1934        struct _timeb tstruct;
1935#else
1936        struct timeval tv;
1937#endif
1938
1939        /* We need a trace to attach the constructed packet to (and it needs
1940         * to be PCAP) */
1941        if (NULL == deadtrace) 
1942                deadtrace=trace_create_dead("pcapfile");
1943
1944        /* Fill in the new PCAP header */
1945#ifdef WIN32
1946        _ftime(&tstruct);
1947        hdr.ts_sec=tstruct.time;
1948        hdr.ts_usec=tstruct.millitm * 1000;
1949#else
1950        gettimeofday(&tv,NULL);
1951        hdr.ts_sec=tv.tv_sec;
1952        hdr.ts_usec=tv.tv_usec;
1953#endif
1954
1955        hdr.caplen=len;
1956        hdr.wirelen=len;
1957
1958        /* Now fill in the libtrace packet itself */
1959        packet->trace=deadtrace;
1960        size=len+sizeof(hdr);
1961        if (packet->buf_control==TRACE_CTRL_PACKET) {
1962                packet->buffer=realloc(packet->buffer,size);
1963        }
1964        else {
1965                packet->buffer=malloc(size);
1966        }
1967        packet->buf_control=TRACE_CTRL_PACKET;
1968        packet->header=packet->buffer;
1969        packet->payload=(void*)((char*)packet->buffer+sizeof(hdr));
1970       
1971        /* Ugh, memcpy - sadly necessary */
1972        memcpy(packet->header,&hdr,sizeof(hdr));
1973        memcpy(packet->payload,data,(size_t)len);
1974        packet->type=pcap_linktype_to_rt(libtrace_to_pcap_linktype(linktype));
1975
1976        trace_clear_cache(packet);
1977}
1978
1979
1980uint64_t trace_get_received_packets(libtrace_t *trace)
1981{
1982        assert(trace);
1983        uint64_t ret;
1984
1985        if (trace->format->get_received_packets) {
1986                if ((ret = trace->format->get_received_packets(trace)) != UINT64_MAX)
1987                        return ret;
1988        } else if (trace->format->get_statistics) {
1989                struct libtrace_stat_t stat;
1990                stat.magic = LIBTRACE_STAT_MAGIC;
1991                trace_get_statistics(trace, &stat);
1992                if (stat.received_valid)
1993                        return stat.received;
1994        }
1995
1996        // Read the cached value taken before the trace was paused/closed
1997        if(trace->stats && trace->stats->received_valid)
1998                return trace->stats->received;
1999        else
2000                return UINT64_MAX;
2001}
2002
2003uint64_t trace_get_filtered_packets(libtrace_t *trace)
2004{
2005        assert(trace);
2006        int i = 0;
2007        uint64_t lib_filtered = trace->filtered_packets;
2008        for (i = 0; i < trace->perpkt_thread_count; i++) {
2009                lib_filtered += trace->perpkt_threads[i].filtered_packets;
2010        }
2011        if (trace->format->get_filtered_packets) {
2012                uint64_t trace_filtered = trace->format->get_filtered_packets(trace);
2013                if (trace_filtered == UINT64_MAX)
2014                        return UINT64_MAX;
2015                else
2016                        return trace_filtered + lib_filtered;
2017        } else if (trace->format->get_statistics) {
2018                struct libtrace_stat_t stat;
2019                stat.magic = LIBTRACE_STAT_MAGIC;
2020                trace_get_statistics(trace, &stat);
2021                if (stat.filtered_valid)
2022                        return lib_filtered + stat.filtered;
2023                else
2024                        return UINT64_MAX;
2025        }
2026
2027        // Read the cached value taken before the trace was paused/closed
2028        if(trace->stats && trace->stats->filtered_valid)
2029                return trace->stats->filtered + lib_filtered;
2030        else
2031                return lib_filtered;
2032}
2033
2034uint64_t trace_get_dropped_packets(libtrace_t *trace)
2035{
2036        assert(trace);
2037        uint64_t ret;
2038
2039        if (trace->format->get_dropped_packets) {
2040                if ((ret = trace->format->get_dropped_packets(trace)) != UINT64_MAX)
2041                        return ret;
2042        } else if (trace->format->get_statistics) {
2043                struct libtrace_stat_t stat;
2044                stat.magic = LIBTRACE_STAT_MAGIC;
2045                trace_get_statistics(trace, &stat);
2046                if (stat.dropped_valid)
2047                        return stat.dropped;
2048        }
2049
2050        // Read the cached value taken before the trace was paused/closed
2051        if(trace->stats && trace->stats->dropped_valid)
2052                return trace->stats->dropped;
2053        else
2054                return UINT64_MAX;
2055}
2056
2057uint64_t trace_get_accepted_packets(libtrace_t *trace)
2058{
2059        assert(trace);
2060        int i = 0;
2061        uint64_t ret = 0;
2062        /* We always add to a thread's accepted count before dispatching the
2063         * packet to the user. However if the underlying trace is single
2064         * threaded it will also be increasing the global count. So if we
2065         * find perpkt ignore the global count.
2066         */
2067        for (i = 0; i < trace->perpkt_thread_count; i++) {
2068                ret += trace->perpkt_threads[i].accepted_packets;
2069        }
2070        return ret ? ret : trace->accepted_packets;
2071}
2072
2073libtrace_stat_t *trace_get_statistics(libtrace_t *trace, libtrace_stat_t *stat)
2074{
2075        uint64_t ret;
2076        int i;
2077        assert(trace);
2078        if (stat == NULL) {
2079                if (trace->stats == NULL)
2080                        trace->stats = trace_create_statistics();
2081                stat = trace->stats;
2082        }
2083        assert(stat->magic == LIBTRACE_STAT_MAGIC && "Please use"
2084               "trace_create_statistics() to allocate statistics");
2085
2086        /* If the trace has paused or finished get the cached results */
2087        if (trace->state == STATE_PAUSED ||
2088            trace->state == STATE_FINISHED ||
2089            trace->state == STATE_FINISHING ||
2090            trace->state == STATE_JOINED) {
2091                if (trace->stats && trace->stats != stat)
2092                        *stat = *trace->stats;
2093                return stat;
2094        }
2095
2096        stat->reserved1 = 0;
2097        stat->reserved2 = 0;
2098#define X(x) stat->x ##_valid = 0;
2099        LIBTRACE_STAT_FIELDS;
2100#undef X
2101        /* Both accepted and filtered are stored against in the library */
2102        ret = trace_get_accepted_packets(trace);
2103        if (ret != UINT64_MAX) {
2104                stat->accepted_valid = 1;
2105                stat->accepted = ret;
2106        }
2107
2108        stat->filtered_valid = 1;
2109        stat->filtered = trace->filtered_packets;
2110        for (i = 0; i < trace->perpkt_thread_count; i++) {
2111                stat->filtered += trace->perpkt_threads[i].filtered_packets;
2112        }
2113
2114        if (trace->format->get_statistics) {
2115                trace->format->get_statistics(trace, stat);
2116        } else {
2117                /* Fallback to the old way */
2118                ret = trace_get_received_packets(trace);
2119                if (ret != UINT64_MAX) {
2120                        stat->received_valid = 1;
2121                        stat->received = ret;
2122                }
2123                ret = trace_get_dropped_packets(trace);
2124                if (ret != UINT64_MAX) {
2125                        stat->dropped_valid = 1;
2126                        stat->dropped = ret;
2127                }
2128        }
2129        return stat;
2130}
2131
2132void trace_get_thread_statistics(libtrace_t *trace, libtrace_thread_t *t,
2133                                 libtrace_stat_t *stat)
2134{
2135        assert(trace && stat);
2136        assert(stat->magic == LIBTRACE_STAT_MAGIC && "Please use"
2137               "trace_create_statistics() to allocate statistics");
2138        stat->reserved1 = 0;
2139        stat->reserved2 = 0;
2140#define X(x) stat->x ##_valid= 0;
2141        LIBTRACE_STAT_FIELDS;
2142#undef X
2143        stat->accepted_valid = 1;
2144        stat->accepted = t->accepted_packets;
2145        stat->filtered_valid = 1;
2146        stat->filtered = t->filtered_packets;
2147        if (!trace_has_dedicated_hasher(trace) && trace->format->get_thread_statistics) {
2148                trace->format->get_thread_statistics(trace, t, stat);
2149        }
2150        return;
2151}
2152
2153libtrace_stat_t *trace_create_statistics(void) {
2154        libtrace_stat_t *ret;
2155        ret = malloc(sizeof(libtrace_stat_t));
2156        if (ret) {
2157                memset(ret, 0, sizeof(libtrace_stat_t));
2158                ret->magic = LIBTRACE_STAT_MAGIC;
2159        }
2160        return ret;
2161}
2162
2163void trace_subtract_statistics(const libtrace_stat_t *a, const libtrace_stat_t *b,
2164                         libtrace_stat_t *c) {
2165        assert(a->magic == LIBTRACE_STAT_MAGIC && "Please use"
2166               "trace_create_statistics() to allocate statistics");
2167        assert(b->magic == LIBTRACE_STAT_MAGIC && "Please use"
2168               "trace_create_statistics() to allocate statistics");
2169        assert(c->magic == LIBTRACE_STAT_MAGIC && "Please use"
2170               "trace_create_statistics() to allocate statistics");
2171
2172#define X(x) \
2173        if (a->x ##_valid && b->x ##_valid) { \
2174                c->x ##_valid = 1; \
2175                c->x = a->x - b->x; \
2176        } else {\
2177                c->x ##_valid = 0;\
2178        }
2179        LIBTRACE_STAT_FIELDS
2180#undef X
2181}
2182
2183void trace_add_statistics(const libtrace_stat_t *a, const libtrace_stat_t *b,
2184                         libtrace_stat_t *c) {
2185        assert(a->magic == LIBTRACE_STAT_MAGIC && "Please use"
2186               "trace_create_statistics() to allocate statistics");
2187        assert(b->magic == LIBTRACE_STAT_MAGIC && "Please use"
2188               "trace_create_statistics() to allocate statistics");
2189        assert(c->magic == LIBTRACE_STAT_MAGIC && "Please use"
2190               "trace_create_statistics() to allocate statistics");
2191
2192#define X(x) \
2193        if (a->x ##_valid&& b->x ##_valid) { \
2194                c->x ##_valid = 1; \
2195                c->x = a->x + b->x; \
2196        } else {\
2197                c->x ##_valid = 0;\
2198        }
2199        LIBTRACE_STAT_FIELDS
2200#undef X
2201}
2202
2203int trace_print_statistics(const libtrace_stat_t *s, FILE *f, const char *format) {
2204        assert(s->magic == LIBTRACE_STAT_MAGIC && "Please use"
2205               "trace_create_statistics() to allocate statistics");
2206        if (format == NULL)
2207                format = "%s: %"PRIu64"\n";
2208#define xstr(s) str(s)
2209#define str(s) #s
2210#define X(x) \
2211        if (s->x ##_valid) { \
2212                if (fprintf(f, format, xstr(x), s->x) < 0) \
2213                        return -1; \
2214        }
2215        LIBTRACE_STAT_FIELDS
2216#undef X
2217        return 0;
2218}
2219
2220
2221void trace_clear_cache(libtrace_packet_t *packet) {
2222
2223        packet->l2_header = NULL;
2224        packet->l3_header = NULL;
2225        packet->l4_header = NULL;
2226        packet->link_type = 0;
2227        packet->l3_ethertype = 0;
2228        packet->transport_proto = 0;
2229        packet->capture_length = -1;
2230        packet->wire_length = -1;
2231        packet->payload_length = -1;
2232        packet->l2_remaining = 0;
2233        packet->l3_remaining = 0;
2234        packet->l4_remaining = 0;
2235
2236}
2237
2238void trace_interrupt(void) {
2239        libtrace_halt = 1;
2240}
2241
2242void register_format(struct libtrace_format_t *f) {
2243        assert(f->next==NULL); /* Can't register a format twice */
2244        f->next=formats_list;
2245        formats_list=f;
2246
2247        /* Now, verify that the format has at least the minimum functionality.
2248         *
2249         * This #if can be changed to a 1 to output warnings about inconsistent
2250         * functions being provided by format modules.  This generally is very
2251         * noisy, as almost all modules don't implement one or more functions
2252         * for various reasons.  This is very useful when checking a new
2253         * format module is sane.
2254         */ 
2255#if 0
2256        if (f->init_input) {
2257#define REQUIRE(x) \
2258                if (!f->x) \
2259                        fprintf(stderr,"%s: Input format should provide " #x "\n",f->name)
2260                REQUIRE(read_packet);
2261                REQUIRE(start_input);
2262                REQUIRE(fin_input);
2263                REQUIRE(get_link_type);
2264                REQUIRE(get_capture_length);
2265                REQUIRE(get_wire_length);
2266                REQUIRE(get_framing_length);
2267                REQUIRE(trace_event);
2268                if (!f->get_erf_timestamp
2269                        && !f->get_seconds
2270                        && !f->get_timeval) {
2271                        fprintf(stderr,"%s: A trace format capable of input, should provide at least one of\n"
2272"get_erf_timestamp, get_seconds or trace_timeval\n",f->name);
2273                }
2274                if (f->trace_event!=trace_event_trace) {
2275                        /* Theres nothing that a trace file could optimise with
2276                         * config_input
2277                         */
2278                        REQUIRE(pause_input);
2279                        REQUIRE(config_input);
2280                        REQUIRE(get_fd);
2281                }
2282                else {
2283                        if (f->get_fd) {
2284                                fprintf(stderr,"%s: Unnecessary get_fd\n",
2285                                                f->name);
2286                        }
2287                }
2288#undef REQUIRE
2289        }
2290        else {
2291#define REQUIRE(x) \
2292                if (f->x) \
2293                        fprintf(stderr,"%s: Non Input format shouldn't need " #x "\n",f->name)
2294                REQUIRE(read_packet);
2295                REQUIRE(start_input);
2296                REQUIRE(pause_input);
2297                REQUIRE(fin_input);
2298                REQUIRE(get_link_type);
2299                REQUIRE(get_capture_length);
2300                REQUIRE(get_wire_length);
2301                REQUIRE(get_framing_length);
2302                REQUIRE(trace_event);
2303                REQUIRE(get_seconds);
2304                REQUIRE(get_timeval);
2305                REQUIRE(get_erf_timestamp);
2306#undef REQUIRE
2307        }
2308        if (f->init_output) {
2309#define REQUIRE(x) \
2310                if (!f->x) \
2311                        fprintf(stderr,"%s: Output format should provide " #x "\n",f->name)
2312                REQUIRE(write_packet);
2313                REQUIRE(start_output);
2314                REQUIRE(config_output);
2315                REQUIRE(fin_output);
2316#undef REQUIRE
2317        }
2318        else {
2319#define REQUIRE(x) \
2320                if (f->x) \
2321                        fprintf(stderr,"%s: Non Output format shouldn't need " #x "\n",f->name)
2322                REQUIRE(write_packet);
2323                REQUIRE(start_output);
2324                REQUIRE(config_output);
2325                REQUIRE(fin_output);
2326#undef REQUIRE
2327        }
2328#endif
2329}
2330
Note: See TracBrowser for help on using the repository browser.