source: lib/trace.c @ 4007dbb

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

Updates the new interface to be more complete

This should work around any issues with systems without thread support.
This still remains compatible with existing code.
Examples/tools/tests still need to be updated to make use of the new interface.
And tests also need to be updated.
Adds debug memory stats as an option to configure.

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