source: lib/trace.c @ f625817

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

Reworked callback API and removed old per_msg and reporter functions

Updated tracertstats to use the new callback API.

Extended the callback approach to the reporter thread as well as the per
packet threads.

Added libtrace_callback_set_t structure, which is used to register the
user callback functions.

Added callback functionality for MESSAGE_RESULT (needed now that reporter
threads also do callbacks) and MESSAGE_USER (for user-defined messages). The
MESSAGE_USER callback is essentially the same as the old per_msg function
style.

Updated combiners to use send_message to pass results to the reporter thread.
send_message itself is now no longer static, so that combiners can use it.

Disabled building of tracestats_parallel as it was using the older version
of the callback API. Will update in a future commit.

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