source: lib/trace.c @ a984307

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivendag_formatrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since a984307 was a984307, checked in by Shane Alcock <salcock@…>, 5 years ago

Merge remote-tracking branch 'origin/develop' into libtrace4

Conflicts:

INSTALL
README
lib/format_dpdk.c
lib/trace.c
tools/tracesplit/tracesplit.c

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