source: lib/trace.c @ c0506ea

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