source: lib/trace.c @ 1ed3f1e

develop
Last change on this file since 1ed3f1e was 1ed3f1e, checked in by Jacob Van Walraven <jcv9@…>, 2 years ago

Prevent trace_construct_packet creating packets will invalid linktype

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