source: lib/trace.c @ 9a3a846

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

Fix bug with commit 2fa43f

Missed a case in destroy packet

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