source: lib/trace.c @ 21c0d70

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivelibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since 21c0d70 was 92a2bf6, checked in by Shane Alcock <salcock@…>, 6 years ago

Make sure we destroy the message queue for each thread.

Otherwise, we will run out of fds when processing large numbers
of traces.

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