source: lib/trace.c @ ee6e802

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

Updated copyright blurb on all source files

In some cases, this meant adding copyright blurbs to files that
had never had them before.

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