source: lib/trace.c @ 10553bf

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

Actually, don't free hasher_data

We can't guarantee that the data was actually malloc'd, so we'll
have to trust the user to free it themselves.

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