source: lib/trace.c @ ac65c9f

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

Fix bug in reporter dectecting per-packet threads finished too early finished, if stopped using trace_pstop.

Fix typo

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