source: lib/trace.c @ 1935565

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since 1935565 was 1935565, checked in by Shane Alcock <salcock@…>, 9 years ago
  • Fixed double free bug when using trace_event to read from a trace file. Previously, if you tried to clean up properly after finishing with trace_event, you would get a double free bug because the packet buffer was being freed twice: once during trace_destroy() (because of the internal packet stored by trace_event) and again during trace_destroy_packet().
  • Removed some of the unused code from trace_event_trace in format_helper.c
  • Make sure we only free packet->buffer during trace_destroy_packet if it is not NULL
  • Property mode set to 100644
File size: 53.5 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
504        if (trace_is_err(libtrace)) {
505                return -1;
506        }
507       
508        /* If the capture format supports configuration, try using their
509         * native configuration first */
510        if (libtrace->format->config_input) {
511                ret=libtrace->format->config_input(libtrace,option,value);
512                if (ret==0)
513                        return 0;
514        }
515
516        /* If we get here, either the native configuration failed or the
517         * format did not support configuration. However, libtrace can
518         * deal with some options itself, so give that a go */
519        switch(option) {
520                case TRACE_OPTION_SNAPLEN:
521                        /* Clear the error if there was one */
522                        if (trace_is_err(libtrace)) {
523                                trace_get_err(libtrace);
524                        }
525                        if (*(int*)value<0 
526                                || *(int*)value>LIBTRACE_PACKET_BUFSIZE) {
527                                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,
528                                        "Invalid snap length");
529                        }
530                        libtrace->snaplen=*(int*)value;
531                        return 0;
532                case TRACE_OPTION_FILTER:
533                        /* Clear the error if there was one */
534                        if (trace_is_err(libtrace)) {
535                                trace_get_err(libtrace);
536                        }
537                        libtrace->filter=(libtrace_filter_t *)value;
538                        return 0;
539                case TRACE_OPTION_PROMISC:
540                        if (!trace_is_err(libtrace)) {
541                                trace_set_err(libtrace,TRACE_ERR_OPTION_UNAVAIL,
542                                                "Promisc mode is not supported by this format module");
543                        }
544                        return -1;
545                case TRACE_OPTION_META_FREQ:
546                        if (!trace_is_err(libtrace)) {
547                                trace_set_err(libtrace, 
548                                                TRACE_ERR_OPTION_UNAVAIL,
549                                                "This format does not support meta-data gathering");
550                        }
551                        return -1;
552                case TRACE_OPTION_EVENT_REALTIME:
553                        if (!trace_is_err(libtrace)) {
554                                trace_set_err(libtrace, 
555                                                TRACE_ERR_OPTION_UNAVAIL,
556                                                "This format does not support realtime events");
557                        }
558                        return -1;
559                       
560        }
561        if (!trace_is_err(libtrace)) {
562                trace_set_err(libtrace,TRACE_ERR_UNKNOWN_OPTION,
563                        "Unknown option %i", option);
564        }
565        return -1;
566}
567
568DLLEXPORT int trace_config_output(libtrace_out_t *libtrace, 
569                trace_option_output_t option,
570                void *value) {
571       
572        /* Unlike the input options, libtrace does not natively support any of
573         * the output options - the format module must be able to deal with
574         * them. */
575        if (libtrace->format->config_output) {
576                return libtrace->format->config_output(libtrace, option, value);
577        }
578        return -1;
579}
580
581/* Close an input trace file, freeing up any resources it may have been using
582 *
583 */
584DLLEXPORT void trace_destroy(libtrace_t *libtrace) {
585        assert(libtrace);
586        if (libtrace->format) {
587                if (libtrace->started && libtrace->format->pause_input)
588                        libtrace->format->pause_input(libtrace);
589                libtrace->format->fin_input(libtrace);
590        }
591        /* Need to free things! */
592        if (libtrace->uridata)
593                free(libtrace->uridata);
594        if (libtrace->event.packet) {
595                /* Don't use trace_destroy_packet here - there is almost
596                 * certainly going to be another libtrace_packet_t that is
597                 * pointing to the buffer for this packet, so we don't want
598                 * to free it. Rather, it will get freed when the user calls
599                 * trace_destroy_packet on the libtrace_packet_t that they
600                 * own.
601                 *
602                 * All we need to do then is free our packet structure itself.
603                 */
604                 free(libtrace->event.packet);
605        }
606        free(libtrace);
607}
608
609
610DLLEXPORT void trace_destroy_dead(libtrace_t *libtrace) {
611        assert(libtrace);
612
613        /* Don't call pause_input or fin_input, because we should never have
614         * used this trace to do any reading anyway. Do make sure we free
615         * any format_data that has been created, though. */
616        if (libtrace->format_data)
617                free(libtrace->format_data);
618        free(libtrace);
619}
620/* Close an output trace file, freeing up any resources it may have been using
621 *
622 * @param libtrace      the output trace file to be destroyed
623 */
624DLLEXPORT void trace_destroy_output(libtrace_out_t *libtrace) 
625{
626        assert(libtrace);
627        if (libtrace->format && libtrace->format->fin_output)
628                libtrace->format->fin_output(libtrace);
629        if (libtrace->uridata)
630                free(libtrace->uridata);
631        free(libtrace);
632}
633
634DLLEXPORT libtrace_packet_t *trace_create_packet(void) 
635{
636        libtrace_packet_t *packet = 
637                (libtrace_packet_t*)calloc((size_t)1,sizeof(libtrace_packet_t));
638
639        packet->buf_control=TRACE_CTRL_PACKET;
640        trace_clear_cache(packet);
641        return packet;
642}
643
644DLLEXPORT libtrace_packet_t *trace_copy_packet(const libtrace_packet_t *packet) {
645        libtrace_packet_t *dest = 
646                (libtrace_packet_t *)malloc(sizeof(libtrace_packet_t));
647        if (!dest) {
648                printf("Out of memory constructing packet\n");
649                abort();
650        }
651        dest->trace=packet->trace;
652        dest->buffer=malloc(65536);
653        if (!dest->buffer) {
654                printf("Out of memory allocating buffer memory\n");
655                abort();
656        }
657        dest->header=dest->buffer;
658        dest->payload=(void*)
659                ((char*)dest->buffer+trace_get_framing_length(packet));
660        dest->type=packet->type;
661        dest->buf_control=TRACE_CTRL_PACKET;
662        /* Reset the cache - better to recalculate than try to convert
663         * the values over to the new packet */
664        trace_clear_cache(dest);       
665        /* Ooooh nasty memcpys! This is why we want to avoid copying packets
666         * as much as possible */
667        memcpy(dest->header,packet->header,trace_get_framing_length(packet));
668        memcpy(dest->payload,packet->payload,trace_get_capture_length(packet));
669
670        return dest;
671}
672
673/** Destroy a packet object
674 */
675DLLEXPORT void trace_destroy_packet(libtrace_packet_t *packet) {
676        if (packet->buf_control == TRACE_CTRL_PACKET && packet->buffer) {
677                free(packet->buffer);
678        }
679        packet->buf_control=(buf_control_t)'\0'; 
680                                /* A "bad" value to force an assert
681                                 * if this packet is ever reused
682                                 */
683        free(packet);
684}       
685
686/* Read one packet from the trace into buffer. Note that this function will
687 * block until a packet is read (or EOF is reached).
688 *
689 * @param libtrace      the libtrace opaque pointer
690 * @param packet        the packet opaque pointer
691 * @returns 0 on EOF, negative value on error
692 *
693 */
694DLLEXPORT int trace_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
695
696        assert(libtrace && "You called trace_read_packet() with a NULL libtrace parameter!\n");
697        if (trace_is_err(libtrace))
698                return -1;
699        if (!libtrace->started) {
700                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,"You must call libtrace_start() before trace_read_packet()\n");
701                return -1;
702        }
703        if (!(packet->buf_control==TRACE_CTRL_PACKET || packet->buf_control==TRACE_CTRL_EXTERNAL)) {
704                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,"Packet passed to trace_read_packet() is invalid\n");
705                return -1;
706        }
707        assert(packet);
708     
709        /* Store the trace we are reading from into the packet opaque
710         * structure */
711        packet->trace = libtrace;
712
713        /* Finalise the packet, freeing any resources the format module
714         * may have allocated it
715         */
716        if (libtrace->format->fin_packet) {
717                libtrace->format->fin_packet(packet);
718        }
719
720
721        if (libtrace->format->read_packet) {
722                do {
723                        size_t ret;
724                        /* Clear the packet cache */
725                        trace_clear_cache(packet);
726                        ret=libtrace->format->read_packet(libtrace,packet);
727                        if (ret==(size_t)-1 || ret==0) {
728                                return ret;
729                        }
730                        if (libtrace->filter) {
731                                /* If the filter doesn't match, read another
732                                 * packet
733                                 */
734                                if (!trace_apply_filter(libtrace->filter,packet)){
735                                        ++libtrace->filtered_packets;
736                                        continue;
737                                }
738                        }
739                        if (libtrace->snaplen>0) {
740                                /* Snap the packet */
741                                trace_set_capture_length(packet,
742                                                libtrace->snaplen);
743                        }
744                        ++libtrace->accepted_packets;
745                        return ret;
746                } while(1);
747        }
748        trace_set_err(libtrace,TRACE_ERR_UNSUPPORTED,"This format does not support reading packets\n");
749        return ~0U;
750}
751
752/* Converts the provided buffer into a libtrace packet of the given type.
753 *
754 * Unlike trace_construct_packet, the buffer is expected to begin with the
755 * appropriate capture format header for the format type that the packet is
756 * being converted to. This also allows for a packet to be converted into
757 * just about capture format that is supported by libtrace, provided the
758 * format header is present in the buffer.
759 *
760 * This function is primarily used to convert packets received via the RT
761 * protocol back into their original capture format. The RT header encapsulates
762 * the original capture format header, so after removing it the packet must
763 * have it's header and payload pointers updated and the packet format and type
764 * changed, amongst other things.
765 *
766 * Intended only for internal use at this point - this function is not
767 * available through the external libtrace API.
768 */
769int trace_prepare_packet(libtrace_t *trace, libtrace_packet_t *packet,
770                void *buffer, libtrace_rt_types_t rt_type, uint32_t flags) {
771
772        assert(packet);
773        assert(trace);
774       
775        /* XXX Proper error handling?? */
776        if (buffer == NULL)
777                return -1;
778
779        if (!(packet->buf_control==TRACE_CTRL_PACKET || packet->buf_control==TRACE_CTRL_EXTERNAL)) {
780                trace_set_err(trace,TRACE_ERR_BAD_STATE,"Packet passed to trace_read_packet() is invalid\n");
781                return -1;
782        }
783       
784        packet->trace = trace;
785       
786        /* Clear packet cache */
787        trace_clear_cache(packet);
788
789        if (trace->format->prepare_packet) {
790                return trace->format->prepare_packet(trace, packet,
791                                buffer, rt_type, flags);
792        }
793        trace_set_err(trace, TRACE_ERR_UNSUPPORTED, 
794                        "This format does not support preparing packets\n");
795        return -1;
796
797}
798
799/* Writes a packet to the specified output trace
800 *
801 * @param libtrace      describes the output format, destination, etc.
802 * @param packet        the packet to be written out
803 * @returns the number of bytes written, -1 if write failed
804 */
805DLLEXPORT int trace_write_packet(libtrace_out_t *libtrace, libtrace_packet_t *packet) {
806        assert(libtrace);
807        assert(packet); 
808        /* Verify the packet is valid */
809        if (!libtrace->started) {
810                trace_set_err_out(libtrace,TRACE_ERR_BAD_STATE,
811                        "Trace is not started before trace_write_packet");
812                return -1;
813        }
814
815        if (libtrace->format->write_packet) {
816                return libtrace->format->write_packet(libtrace, packet);
817        }
818        trace_set_err_out(libtrace,TRACE_ERR_UNSUPPORTED,
819                "This format does not support writing packets");
820        return -1;
821}
822
823/* Get a pointer to the first byte of the packet payload */
824DLLEXPORT void *trace_get_packet_buffer(const libtrace_packet_t *packet,
825                libtrace_linktype_t *linktype, uint32_t *remaining) {
826        int cap_len;
827        int wire_len;
828
829        assert(packet != NULL);
830        if (linktype) *linktype = trace_get_link_type(packet);
831        if (remaining) {
832                /* I think we should choose the minimum of the capture and
833                 * wire lengths to be the "remaining" value. If the packet has
834                 * been padded to increase the capture length, we don't want
835                 * to allow subsequent protocol decoders to consider the
836                 * padding as part of the packet.
837                 *
838                 * For example, in Auck 4 there is a trace where the IP header
839                 * length is incorrect (24 bytes) followed by a 20 byte TCP
840                 * header. Total IP length is 40 bytes. As a result, the
841                 * legacyatm padding gets treated as the "missing" bytes of
842                 * the TCP header, which isn't the greatest. We're probably
843                 * better off returning an incomplete TCP header in that case.
844                 */
845               
846                cap_len = trace_get_capture_length(packet);
847                wire_len = trace_get_wire_length(packet);
848
849                assert(cap_len >= 0);
850
851                /* There is the odd corrupt packet, e.g. in IPLS II, that have
852                 * massively negative wire lens. We could assert fail here on
853                 * them, but we could at least try the capture length instead.
854                 *
855                 * You may still run into problems if you try to write that
856                 * packet, but at least reading should work OK.
857                 */
858                if (wire_len < 0)
859                        *remaining = cap_len;
860                else if (wire_len < cap_len)
861                        *remaining = wire_len;
862                else
863                        *remaining = cap_len;
864                /* *remaining = trace_get_capture_length(packet); */
865        }
866        return (void *) packet->payload;
867}
868
869
870/* Get a pointer to the first byte of the packet payload
871 *
872 * DEPRECATED - use trace_get_packet_buffer() instead */
873DLLEXPORT void *trace_get_link(const libtrace_packet_t *packet) {
874        return (void *)packet->payload;
875}
876
877/* Get the current time in DAG time format
878 * @param packet        a pointer to a libtrace_packet structure
879 * @returns a 64 bit timestamp in DAG ERF format (upper 32 bits are the seconds
880 * past 1970-01-01, the lower 32bits are partial seconds)
881 */ 
882DLLEXPORT uint64_t trace_get_erf_timestamp(const libtrace_packet_t *packet) {
883        if (packet->trace->format->get_erf_timestamp) {
884                /* timestamp -> timestamp */
885                return packet->trace->format->get_erf_timestamp(packet);
886        } else if (packet->trace->format->get_timespec) {
887                /* timespec -> timestamp */
888                struct timespec ts;
889                ts = packet->trace->format->get_timespec(packet);
890                return ((((uint64_t)ts.tv_sec) << 32) +
891                                (((uint64_t)ts.tv_nsec << 32)/1000000000));
892        } else if (packet->trace->format->get_timeval) {
893                /* timeval -> timestamp */
894                struct timeval tv;
895                tv = packet->trace->format->get_timeval(packet);
896                return ((((uint64_t)tv.tv_sec) << 32) +
897                                (((uint64_t)tv.tv_usec << 32)/1000000));
898        } else if (packet->trace->format->get_seconds) {
899                /* seconds -> timestamp */
900                double seconds = packet->trace->format->get_seconds(packet);
901                return (((uint64_t)seconds)<<32)
902                          + (uint64_t)((seconds-(uint64_t)seconds)*UINT_MAX);
903        }
904        else {
905                return (uint64_t)0;
906        }
907                     
908}
909
910/* Get the current time in struct timeval
911 * @param packet        a pointer to a libtrace_packet structure
912 *
913 * @returns time that this packet was seen in a struct timeval
914 * @author Daniel Lawson
915 * @author Perry Lorier
916 */ 
917DLLEXPORT struct timeval trace_get_timeval(const libtrace_packet_t *packet) {
918        struct timeval tv;
919        uint64_t ts = 0;
920        if (packet->trace->format->get_timeval) {
921                /* timeval -> timeval */
922                tv = packet->trace->format->get_timeval(packet);
923        } else if (packet->trace->format->get_erf_timestamp) {
924                /* timestamp -> timeval */
925                ts = packet->trace->format->get_erf_timestamp(packet);
926#if __BYTE_ORDER == __BIG_ENDIAN
927                tv.tv_sec = ts & 0xFFFFFFFF;
928#elif __BYTE_ORDER == __LITTLE_ENDIAN
929                tv.tv_sec = ts >> 32;
930#else
931#error "What on earth are you running this on?"
932#endif
933                tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
934                if (tv.tv_usec >= 1000000) {
935                        tv.tv_usec -= 1000000;
936                        tv.tv_sec += 1;
937                }
938        } else if (packet->trace->format->get_timespec) {
939                struct timespec ts = packet->trace->format->get_timespec(packet);
940                tv.tv_sec = ts.tv_sec;
941                tv.tv_usec = ts.tv_nsec/1000;
942        } else if (packet->trace->format->get_seconds) {
943                /* seconds -> timeval */
944                double seconds = packet->trace->format->get_seconds(packet);
945                tv.tv_sec = (uint32_t)seconds;
946                tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
947        }
948        else {
949                tv.tv_sec=-1;
950                tv.tv_usec=-1;
951        }
952
953        return tv;
954}
955
956DLLEXPORT struct timespec trace_get_timespec(const libtrace_packet_t *packet) {
957        struct timespec ts;
958
959        if (packet->trace->format->get_timespec) {
960                return packet->trace->format->get_timespec(packet);
961        } else if (packet->trace->format->get_erf_timestamp) {
962                /* timestamp -> timeval */
963                uint64_t erfts = packet->trace->format->get_erf_timestamp(packet);
964#if __BYTE_ORDER == __BIG_ENDIAN
965                ts.tv_sec = erfts & 0xFFFFFFFF;
966#elif __BYTE_ORDER == __LITTLE_ENDIAN
967                ts.tv_sec = erfts >> 32;
968#else
969#error "What on earth are you running this on?"
970#endif
971                ts.tv_nsec = ((erfts&0xFFFFFFFF)*1000000000)>>32;
972                if (ts.tv_nsec >= 1000000000) {
973                        ts.tv_nsec -= 1000000000;
974                        ts.tv_sec += 1;
975                }
976                return ts;
977        } else if (packet->trace->format->get_timeval) {
978                /* timeval -> timespec */
979                struct timeval tv = packet->trace->format->get_timeval(packet);
980                ts.tv_sec = tv.tv_sec;
981                ts.tv_nsec = tv.tv_usec*1000;
982                return ts;
983        } else if (packet->trace->format->get_seconds) {
984                /* seconds -> timespec */
985                double seconds = packet->trace->format->get_seconds(packet);
986                ts.tv_sec = (uint32_t)seconds;
987                ts.tv_nsec = (long)(((seconds - ts.tv_sec) * 1000000000)/UINT_MAX);
988                return ts;
989        }
990        else {
991                ts.tv_sec=-1;
992                ts.tv_nsec=-1;
993                return ts;
994        }
995}
996
997
998/* Get the current time in floating point seconds
999 * @param packet        a pointer to a libtrace_packet structure
1000 * @returns time that this packet was seen in 64bit floating point seconds
1001 */ 
1002DLLEXPORT double trace_get_seconds(const libtrace_packet_t *packet) {
1003        double seconds = 0.0;
1004
1005        if (packet->trace->format->get_seconds) {
1006                /* seconds->seconds */
1007                seconds = packet->trace->format->get_seconds(packet);
1008        } else if (packet->trace->format->get_erf_timestamp) {
1009                /* timestamp -> seconds */
1010                uint64_t ts = 0;
1011                ts = packet->trace->format->get_erf_timestamp(packet);
1012                seconds =  (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
1013        } else if (packet->trace->format->get_timespec) {
1014                /* timespec -> seconds */
1015                struct timespec ts;
1016                ts = packet->trace->format->get_timespec(packet);
1017                seconds = ts.tv_sec + ((ts.tv_nsec * 1.0) / 1000000000);
1018        } else if (packet->trace->format->get_timeval) {
1019                /* timeval -> seconds */
1020                struct timeval tv;
1021                tv = packet->trace->format->get_timeval(packet);
1022                seconds = tv.tv_sec + ((tv.tv_usec * 1.0) / 1000000);
1023        }
1024
1025        return seconds;
1026}
1027
1028DLLEXPORT size_t trace_get_capture_length(const libtrace_packet_t *packet) 
1029{
1030        /* Cache the capture length */
1031        if (packet->capture_length == -1) {
1032                if (!packet->trace->format->get_capture_length)
1033                        return ~0U;
1034                /* Cast away constness because this is "just" a cache */
1035                ((libtrace_packet_t*)packet)->capture_length = 
1036                        packet->trace->format->get_capture_length(packet);
1037        }
1038
1039        assert(packet->capture_length < LIBTRACE_PACKET_BUFSIZE);
1040
1041        return packet->capture_length;
1042}
1043       
1044/* Get the size of the packet as it was seen on the wire.
1045 * @param packet        a pointer to a libtrace_packet structure
1046 *
1047 * @returns the size of the packet as it was on the wire.
1048 * @note Due to the trace being a header capture, or anonymisation this may
1049 * not be the same as the Capture Len.
1050 */ 
1051DLLEXPORT size_t trace_get_wire_length(const libtrace_packet_t *packet){
1052       
1053        if (packet->wire_length == -1) {
1054                if (!packet->trace->format->get_wire_length) 
1055                        return ~0U;
1056                ((libtrace_packet_t *)packet)->wire_length = 
1057                        packet->trace->format->get_wire_length(packet);
1058        }
1059
1060        assert(packet->wire_length < LIBTRACE_PACKET_BUFSIZE);
1061        return packet->wire_length;
1062
1063}
1064
1065/* Get the length of the capture framing headers.
1066 * @param packet        the packet opaque pointer
1067 * @returns the size of the packet as it was on the wire.
1068 * @note this length corresponds to the difference between the size of a
1069 * captured packet in memory, and the captured length of the packet
1070 */ 
1071DLLEXPORT SIMPLE_FUNCTION
1072size_t trace_get_framing_length(const libtrace_packet_t *packet) {
1073        if (packet->trace->format->get_framing_length) {
1074                return packet->trace->format->get_framing_length(packet);
1075        }
1076        return ~0U;
1077}
1078
1079
1080/* Get the type of the link layer
1081 * @param packet        a pointer to a libtrace_packet structure
1082 * @returns libtrace_linktype_t
1083 */
1084DLLEXPORT libtrace_linktype_t trace_get_link_type(const libtrace_packet_t *packet ) {
1085
1086        if (packet->link_type == 0) {
1087                if (!packet->trace->format->get_link_type)
1088                        return (libtrace_linktype_t)-1;
1089                ((libtrace_packet_t *)packet)->link_type =
1090                        packet->trace->format->get_link_type(packet);
1091        }
1092
1093        return packet->link_type;
1094}
1095
1096/* process a libtrace event
1097 * @param trace the libtrace opaque pointer
1098 * @param packet the libtrace_packet opaque pointer
1099 * @returns
1100 *  TRACE_EVENT_IOWAIT  Waiting on I/O on fd
1101 *  TRACE_EVENT_SLEEP   Next event in seconds
1102 *  TRACE_EVENT_PACKET  Packet arrived in buffer with size size
1103 *  TRACE_EVENT_TERMINATE Trace terminated (perhaps with an error condition)
1104 * FIXME currently keeps a copy of the packet inside the trace pointer,
1105 * which in turn is stored inside the new packet object...
1106 */
1107DLLEXPORT libtrace_eventobj_t trace_event(libtrace_t *trace, 
1108                libtrace_packet_t *packet) {
1109        libtrace_eventobj_t event = {TRACE_EVENT_IOWAIT,0,0.0,0};
1110
1111        if (!trace) {
1112                fprintf(stderr,"You called trace_event() with a NULL trace object!\n");
1113        }
1114        assert(trace);
1115        assert(packet);
1116
1117        /* Clear the packet cache */
1118        trace_clear_cache(packet);
1119       
1120        /* Store the trace we are reading from into the packet opaque
1121         * structure */
1122        packet->trace = trace;
1123
1124        if (packet->trace->format->trace_event) {
1125                event=packet->trace->format->trace_event(trace,packet);
1126                if (event.type == TRACE_EVENT_PACKET) {
1127                        ++trace->accepted_packets;
1128                }
1129        }
1130        return event;
1131
1132}
1133
1134/** Setup a BPF filter based on pre-compiled byte-code.
1135 * @param bf_insns      A pointer to the start of the byte-code
1136 * @param bf_len        The number of BPF instructions
1137 * @returns             an opaque pointer to a libtrace_filter_t object
1138 * @note                The supplied byte-code is not checked for correctness.
1139 * @author              Scott Raynel
1140 */
1141DLLEXPORT libtrace_filter_t *
1142trace_create_filter_from_bytecode(void *bf_insns, unsigned int bf_len)
1143{
1144#ifndef HAVE_BPF_FILTER
1145        fprintf(stderr, "This version of libtrace does not have BPF support\n");
1146        return NULL;
1147#else
1148        struct libtrace_filter_t *filter = (struct libtrace_filter_t *)
1149                malloc(sizeof(struct libtrace_filter_t));
1150        filter->filter.bf_insns = (struct bpf_insn *)
1151                malloc(sizeof(struct bpf_insn) * bf_len);
1152       
1153        memcpy(filter->filter.bf_insns, bf_insns,
1154                        bf_len * sizeof(struct bpf_insn));
1155       
1156        filter->filter.bf_len = bf_len;
1157        filter->filterstring = NULL;
1158        filter->jitfilter = NULL;
1159        /* "flag" indicates that the filter member is valid */
1160        filter->flag = 1; 
1161       
1162        return filter;
1163#endif
1164}
1165
1166/* Create a BPF filter
1167 * @param filterstring a char * containing the bpf filter string
1168 * @returns opaque pointer pointer to a libtrace_filter_t object
1169 */
1170DLLEXPORT libtrace_filter_t *trace_create_filter(const char *filterstring) {
1171#ifdef HAVE_BPF_FILTER
1172        libtrace_filter_t *filter = (libtrace_filter_t*)
1173                                malloc(sizeof(libtrace_filter_t));
1174        filter->filterstring = strdup(filterstring);
1175        filter->jitfilter = NULL;
1176        filter->flag = 0;
1177        return filter;
1178#else
1179        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1180        return NULL;
1181#endif
1182}
1183
1184DLLEXPORT void trace_destroy_filter(libtrace_filter_t *filter)
1185{
1186#ifdef HAVE_BPF_FILTER
1187        free(filter->filterstring);
1188        if (filter->flag)
1189                pcap_freecode(&filter->filter);
1190#ifdef HAVE_LLVM
1191        if (filter->jitfilter) 
1192                destroy_program(filter->jitfilter);
1193#endif
1194        free(filter);
1195#else
1196
1197#endif
1198}
1199
1200/* Compile a bpf filter, now we know the link type for the trace that we're
1201 * applying it to.
1202 *
1203 * @internal
1204 *
1205 * @returns -1 on error, 0 on success
1206 */
1207static int trace_bpf_compile(libtrace_filter_t *filter,
1208                const libtrace_packet_t *packet,
1209                void *linkptr, 
1210                libtrace_linktype_t linktype    ) {
1211#ifdef HAVE_BPF_FILTER
1212        assert(filter);
1213
1214        /* If this isn't a real packet, then fail */
1215        if (!linkptr) {
1216                trace_set_err(packet->trace,
1217                                TRACE_ERR_BAD_FILTER,"Packet has no payload");
1218                return -1;
1219        }
1220       
1221        if (filter->filterstring && ! filter->flag) {
1222                pcap_t *pcap = NULL;
1223                if (linktype==(libtrace_linktype_t)-1) {
1224                        trace_set_err(packet->trace,
1225                                        TRACE_ERR_BAD_FILTER,
1226                                        "Packet has an unknown linktype");
1227                        return -1;
1228                }
1229                if (libtrace_to_pcap_dlt(linktype) == ~1U) {
1230                        trace_set_err(packet->trace,TRACE_ERR_BAD_FILTER,
1231                                        "Unknown pcap equivalent linktype");
1232                        return -1;
1233                }
1234                pcap=(pcap_t *)pcap_open_dead(
1235                                (int)libtrace_to_pcap_dlt(linktype),
1236                                1500U);
1237                /* build filter */
1238                assert(pcap);
1239                if (pcap_compile( pcap, &filter->filter, filter->filterstring, 
1240                                        1, 0)) {
1241                        trace_set_err(packet->trace,TRACE_ERR_BAD_FILTER,
1242                                        "Unable to compile the filter \"%s\": %s", 
1243                                        filter->filterstring,
1244                                        pcap_geterr(pcap));
1245                        pcap_close(pcap);
1246                        return -1;
1247                }
1248                pcap_close(pcap);
1249                filter->flag=1;
1250        }
1251        return 0;
1252#else
1253        assert(!"Internal bug: This should never be called when BPF not enabled");
1254        trace_set_err(packet->trace,TRACE_ERR_OPTION_UNAVAIL,
1255                                "Feature unavailable");
1256        return -1;
1257#endif
1258}
1259
1260DLLEXPORT int trace_apply_filter(libtrace_filter_t *filter,
1261                        const libtrace_packet_t *packet) {
1262#ifdef HAVE_BPF_FILTER
1263        void *linkptr = 0;
1264        uint32_t clen = 0;
1265        bool free_packet_needed = false;
1266        int ret;
1267        libtrace_linktype_t linktype;
1268        libtrace_packet_t *packet_copy = (libtrace_packet_t*)packet;
1269
1270        assert(filter);
1271        assert(packet);
1272
1273        /* Match all non-data packets as we probably want them to pass
1274         * through to the caller */
1275        linktype = trace_get_link_type(packet);
1276
1277        if (linktype == TRACE_TYPE_NONDATA)
1278                return 1;       
1279
1280        if (libtrace_to_pcap_dlt(linktype)==~0U) {
1281               
1282                /* If we cannot get a suitable DLT for the packet, it may
1283                 * be because the packet is encapsulated in a link type that
1284                 * does not correspond to a DLT. Therefore, we should try
1285                 * popping off headers until we either can find a suitable
1286                 * link type or we can't do any more sensible decapsulation. */
1287               
1288                /* Copy the packet, as we don't want to trash the one we
1289                 * were passed in */
1290                packet_copy=trace_copy_packet(packet);
1291                free_packet_needed=true;
1292
1293                while (libtrace_to_pcap_dlt(linktype) == ~0U) {
1294                        if (!demote_packet(packet_copy)) {
1295                                trace_set_err(packet->trace, 
1296                                                TRACE_ERR_NO_CONVERSION,
1297                                                "pcap does not support this format");
1298                                if (free_packet_needed) {
1299                                        trace_destroy_packet(packet_copy);
1300                                }
1301                                return -1;
1302                        }
1303                        linktype = trace_get_link_type(packet_copy);
1304                }
1305
1306        }
1307       
1308        linkptr = trace_get_packet_buffer(packet_copy,NULL,&clen);
1309        if (!linkptr) {
1310                if (free_packet_needed) {
1311                        trace_destroy_packet(packet_copy);
1312                }
1313                return 0;
1314        }
1315
1316        /* We need to compile the filter now, because before we didn't know
1317         * what the link type was
1318         */
1319        if (trace_bpf_compile(filter,packet_copy,linkptr,linktype)==-1) {
1320                if (free_packet_needed) {
1321                        trace_destroy_packet(packet_copy);
1322                }
1323                return -1;
1324        }
1325
1326        /* If we're jitting, we may need to JIT the BPF code now too */
1327#if HAVE_LLVM
1328        if (!filter->jitfilter) {
1329                filter->jitfilter = compile_program(filter->filter.bf_insns, filter->filter.bf_len);
1330        }
1331#endif
1332
1333        assert(filter->flag);
1334        /* Now execute the filter */
1335#if HAVE_LLVM
1336        ret=filter->jitfilter->bpf_run((unsigned char *)linkptr, clen);
1337#else
1338        ret=bpf_filter(filter->filter.bf_insns,(u_char*)linkptr,(unsigned int)clen,(unsigned int)clen);
1339#endif
1340
1341        /* If we copied the packet earlier, make sure that we free it */
1342        if (free_packet_needed) {
1343                trace_destroy_packet(packet_copy);
1344        }
1345        return ret;
1346#else
1347        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1348        return 0;
1349#endif
1350}
1351
1352/* Set the direction flag, if it has one
1353 * @param packet the packet opaque pointer
1354 * @param direction the new direction (0,1,2,3)
1355 * @returns a signed value containing the direction flag, or -1 if this is not supported
1356 */
1357DLLEXPORT libtrace_direction_t trace_set_direction(libtrace_packet_t *packet, 
1358                libtrace_direction_t direction) 
1359{
1360        assert(packet);
1361        if (packet->trace->format->set_direction) {
1362                return packet->trace->format->set_direction(packet,direction);
1363        }
1364        return (libtrace_direction_t)~0U;
1365}
1366
1367/* Get the direction flag, if it has one
1368 * @param packet a pointer to a libtrace_packet structure
1369 * @returns a signed value containing the direction flag, or -1 if this is not supported
1370 * The direction is defined as 0 for packets originating locally (ie, outbound)
1371 * and 1 for packets originating remotely (ie, inbound).
1372 * Other values are possible, which might be overloaded to mean special things
1373 * for a special trace.
1374 */
1375DLLEXPORT libtrace_direction_t trace_get_direction(const libtrace_packet_t *packet) 
1376{
1377        assert(packet);
1378        if (packet->trace->format->get_direction) {
1379                return packet->trace->format->get_direction(packet);
1380        }
1381        return (libtrace_direction_t)~0U;
1382}
1383
1384#define ROOT_SERVER(x) ((x) < 512)
1385#define ROOT_CLIENT(x) ((512 <= (x)) && ((x) < 1024))
1386#define NONROOT_SERVER(x) ((x) >= 5000)
1387#define NONROOT_CLIENT(x) ((1024 <= (x)) && ((x) < 5000))
1388#define DYNAMIC(x) ((49152 < (x)) && ((x) < 65535))
1389#define SERVER(x) ROOT_SERVER(x) || NONROOT_SERVER(x)
1390#define CLIENT(x) ROOT_CLIENT(x) || NONROOT_CLIENT(x)
1391
1392/* Attempt to deduce the 'server' port
1393 * @param protocol the IP protocol (eg, 6 or 17 for TCP or UDP)
1394 * @param source the TCP or UDP source port
1395 * @param dest the TCP or UDP destination port
1396 * @returns a hint as to which port is the server port
1397 */
1398DLLEXPORT int8_t trace_get_server_port(UNUSED uint8_t protocol, 
1399                uint16_t source, uint16_t dest) 
1400{
1401        /*
1402         * * If the ports are equal, return DEST
1403         * * Check for well-known ports in the given protocol
1404         * * Root server ports: 0 - 511
1405         * * Root client ports: 512 - 1023
1406         * * non-root client ports: 1024 - 4999
1407         * * non-root server ports: 5000+
1408         * * Check for static ranges: 1024 - 49151
1409         * * Check for dynamic ranges: 49152 - 65535
1410         * * flip a coin.
1411         */
1412       
1413        /* equal */
1414        if (source == dest)
1415                return USE_DEST;
1416
1417        /* root server port, 0 - 511 */
1418        if (ROOT_SERVER(source) && ROOT_SERVER(dest)) {
1419                if (source < dest)
1420                        return USE_SOURCE;
1421                return USE_DEST;
1422        }
1423
1424        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1425                return USE_SOURCE;
1426        if (!ROOT_SERVER(source) && ROOT_SERVER(dest))
1427                return USE_DEST;
1428
1429        /* non-root server */
1430        if (NONROOT_SERVER(source) && NONROOT_SERVER(dest)) {
1431                if (source < dest)
1432                        return USE_SOURCE;
1433                return USE_DEST;
1434        }
1435        if (NONROOT_SERVER(source) && !NONROOT_SERVER(dest))
1436                return USE_SOURCE;
1437        if (!NONROOT_SERVER(source) && NONROOT_SERVER(dest))
1438                return USE_DEST;
1439
1440        /* root client */
1441        if (ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1442                if (source < dest)
1443                        return USE_SOURCE;
1444                return USE_DEST;
1445        }
1446        if (ROOT_CLIENT(source) && !ROOT_CLIENT(dest)) {
1447                /* prefer root-client over nonroot-client */
1448                if (NONROOT_CLIENT(dest))
1449                        return USE_SOURCE;
1450                return USE_DEST;
1451        }
1452        if (!ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1453                /* prefer root-client over nonroot-client */
1454                if (NONROOT_CLIENT(source))
1455                        return USE_DEST;
1456                return USE_SOURCE;
1457        }
1458       
1459        /* nonroot client */
1460        if (NONROOT_CLIENT(source) && NONROOT_CLIENT(dest)) {
1461                if (source < dest) 
1462                        return USE_SOURCE;
1463                return USE_DEST;
1464        }
1465        if (NONROOT_CLIENT(source) && !NONROOT_CLIENT(dest))
1466                return USE_DEST;
1467        if (!NONROOT_CLIENT(source) && NONROOT_CLIENT(dest))
1468                return USE_SOURCE;
1469
1470        /* dynamic range */
1471        if (DYNAMIC(source) && DYNAMIC(dest)) {
1472                if (source < dest)
1473                        return USE_SOURCE;
1474                return USE_DEST;
1475        }
1476        if (DYNAMIC(source) && !DYNAMIC(dest))
1477                return USE_DEST;
1478        if (!DYNAMIC(source) && DYNAMIC(dest))
1479                return USE_SOURCE;
1480        /*
1481        if (SERVER(source) && CLIENT(dest))
1482                return USE_SOURCE;
1483       
1484        if (SERVER(dest) && CLIENT(source))
1485                return USE_DEST;
1486        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1487                return USE_SOURCE;
1488        if (ROOT_SERVER(dest) && !ROOT_SERVER(source))
1489                return USE_DEST;
1490        */
1491        /* failing that test... */
1492        if (source < dest) {
1493                return USE_SOURCE;
1494        } 
1495        return USE_DEST;
1496       
1497}
1498
1499/* Truncate the packet at the suggested length
1500 * @param packet        the packet opaque pointer
1501 * @param size          the new length of the packet
1502 * @returns the new size of the packet
1503 * @note size and the return size refer to the network-level payload of the
1504 * packet, and do not include any capture headers. For example, to truncate a
1505 * packet after the IP header, set size to sizeof(ethernet_header) +
1506 * sizeof(ip_header)
1507 * @note If the original network-level payload is smaller than size, then the
1508 * original size is returned and the packet is left unchanged.
1509 */
1510DLLEXPORT size_t trace_set_capture_length(libtrace_packet_t *packet, size_t size) {
1511        assert(packet);
1512
1513        if (packet->trace->format->set_capture_length) {
1514                packet->capture_length = packet->trace->format->set_capture_length(packet,size);
1515                return packet->capture_length;
1516        }
1517
1518        return ~0U;
1519}
1520
1521/* Splits a URI into two components - the format component which is seen before
1522 * the ':', and the uridata which follows the ':'.
1523 *
1524 * Returns a pointer to the URI data, but updates the format parameter to
1525 * point to a copy of the format component.
1526 */
1527
1528DLLEXPORT const char * trace_parse_uri(const char *uri, char **format) {
1529        const char *uridata = 0;
1530       
1531        if((uridata = strchr(uri,':')) == NULL) {
1532                /* Badly formed URI - needs a : */
1533                return 0;
1534        }
1535
1536        if ((unsigned)(uridata - uri) > URI_PROTO_LINE) {
1537                /* Badly formed URI - uri type is too long */
1538                return 0;
1539        }
1540
1541        /* NOTE: this is allocated memory - it should be freed by the caller
1542         * once they are done with it */
1543        *format=xstrndup(uri, (size_t)(uridata - uri));
1544
1545        /* Push uridata past the delimiter */
1546        uridata++;
1547       
1548        return uridata;
1549}
1550
1551enum base_format_t trace_get_format(libtrace_packet_t *packet) 
1552{
1553        assert(packet);
1554
1555        return packet->trace->format->type;
1556}
1557       
1558DLLEXPORT libtrace_err_t trace_get_err(libtrace_t *trace)
1559{
1560        libtrace_err_t err = trace->err;
1561        trace->err.err_num = 0; /* "OK" */
1562        trace->err.problem[0]='\0';
1563        return err;
1564}
1565
1566DLLEXPORT bool trace_is_err(libtrace_t *trace)
1567{
1568        return trace->err.err_num != 0;
1569}
1570
1571/* Prints the input error status to standard error and clears the error state */
1572DLLEXPORT void trace_perror(libtrace_t *trace,const char *msg,...)
1573{
1574        char buf[256];
1575        va_list va;
1576        va_start(va,msg);
1577        vsnprintf(buf,sizeof(buf),msg,va);
1578        va_end(va);
1579        if(trace->err.err_num) {
1580                if (trace->uridata) {
1581                        fprintf(stderr,"%s(%s): %s\n",
1582                                        buf,trace->uridata,trace->err.problem);
1583                } else {
1584                        fprintf(stderr,"%s: %s\n", buf, trace->err.problem);
1585                }
1586        } else {
1587                if (trace->uridata) {
1588                        fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
1589                } else {
1590                        fprintf(stderr,"%s: No error\n", buf);
1591                }
1592        }
1593        trace->err.err_num = 0; /* "OK" */
1594        trace->err.problem[0]='\0';
1595}
1596
1597DLLEXPORT libtrace_err_t trace_get_err_output(libtrace_out_t *trace)
1598{
1599        libtrace_err_t err = trace->err;
1600        trace->err.err_num = TRACE_ERR_NOERROR; /* "OK" */
1601        trace->err.problem[0]='\0';
1602        return err;
1603}
1604
1605DLLEXPORT bool trace_is_err_output(libtrace_out_t *trace)
1606{
1607        return trace->err.err_num != 0;
1608}
1609
1610/* Prints the output error status to standard error and clears the error state
1611 */
1612DLLEXPORT void trace_perror_output(libtrace_out_t *trace,const char *msg,...)
1613{
1614        char buf[256];
1615        va_list va;
1616        va_start(va,msg);
1617        vsnprintf(buf,sizeof(buf),msg,va);
1618        va_end(va);
1619        if(trace->err.err_num) {
1620                fprintf(stderr,"%s(%s): %s\n",
1621                                buf,
1622                                trace->uridata?trace->uridata:"no uri",
1623                                trace->err.problem);
1624        } else {
1625                fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
1626        }
1627        trace->err.err_num = TRACE_ERR_NOERROR; /* "OK" */
1628        trace->err.problem[0]='\0';
1629}
1630
1631DLLEXPORT int trace_seek_erf_timestamp(libtrace_t *trace, uint64_t ts)
1632{
1633        if (trace->format->seek_erf) {
1634                return trace->format->seek_erf(trace,ts);
1635        }
1636        else {
1637                if (trace->format->seek_timeval) {
1638                        struct timeval tv;
1639#if __BYTE_ORDER == __BIG_ENDIAN
1640                        tv.tv_sec = ts & 0xFFFFFFFF;
1641#elif __BYTE_ORDER == __LITTLE_ENDIAN
1642                        tv.tv_sec = ts >> 32;
1643#else
1644#error "What on earth are you running this on?"
1645#endif
1646                        tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
1647                        if (tv.tv_usec >= 1000000) {
1648                                tv.tv_usec -= 1000000;
1649                                tv.tv_sec += 1;
1650                        }
1651                        return trace->format->seek_timeval(trace,tv);
1652                }
1653                if (trace->format->seek_seconds) {
1654                        double seconds = 
1655                                (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
1656                        return trace->format->seek_seconds(trace,seconds);
1657                }
1658                trace_set_err(trace,
1659                                TRACE_ERR_OPTION_UNAVAIL,
1660                                "Feature unimplemented");
1661                return -1;
1662        }
1663}
1664
1665DLLEXPORT int trace_seek_seconds(libtrace_t *trace, double seconds)
1666{
1667        if (trace->format->seek_seconds) {
1668                return trace->format->seek_seconds(trace,seconds);
1669        }
1670        else {
1671                if (trace->format->seek_timeval) {
1672                        struct timeval tv;
1673                        tv.tv_sec = (uint32_t)seconds;
1674                        tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
1675                        return trace->format->seek_timeval(trace,tv);
1676                }
1677                if (trace->format->seek_erf) {
1678                        uint64_t timestamp = 
1679                                ((uint64_t)((uint32_t)seconds) << 32) + \
1680                            (uint64_t)(( seconds - (uint32_t)seconds   ) * UINT_MAX);
1681                        return trace->format->seek_erf(trace,timestamp);
1682                }
1683                trace_set_err(trace,
1684                                TRACE_ERR_OPTION_UNAVAIL,
1685                                "Feature unimplemented");
1686                return -1;
1687        }
1688}
1689
1690DLLEXPORT int trace_seek_timeval(libtrace_t *trace, struct timeval tv)
1691{
1692        if (trace->format->seek_timeval) {
1693                return trace->format->seek_timeval(trace,tv);
1694        }
1695        else {
1696                if (trace->format->seek_erf) {
1697                        uint64_t timestamp = ((((uint64_t)tv.tv_sec) << 32) + \
1698                                (((uint64_t)tv.tv_usec * UINT_MAX)/1000000));
1699                        return trace->format->seek_erf(trace,timestamp);
1700                }
1701                if (trace->format->seek_seconds) {
1702                        double seconds = tv.tv_sec + ((tv.tv_usec * 1.0)/1000000);
1703                        return trace->format->seek_seconds(trace,seconds);
1704                }
1705                trace_set_err(trace,
1706                                TRACE_ERR_OPTION_UNAVAIL,
1707                                "Feature unimplemented");
1708                return -1;
1709        }
1710}
1711
1712/* Converts a binary ethernet MAC address into a printable string */
1713DLLEXPORT char *trace_ether_ntoa(const uint8_t *addr, char *buf)
1714{
1715        static char staticbuf[18]={0,};
1716        if (!buf)
1717                buf=staticbuf;
1718        snprintf(buf,(size_t)18,"%02x:%02x:%02x:%02x:%02x:%02x",
1719                        addr[0],addr[1],addr[2],
1720                        addr[3],addr[4],addr[5]);
1721        return buf;
1722}
1723
1724/* Converts a printable ethernet MAC address into a binary format */
1725DLLEXPORT uint8_t *trace_ether_aton(const char *buf, uint8_t *addr)
1726{
1727        uint8_t *buf2 = addr;
1728        unsigned int tmp[6];
1729        static uint8_t staticaddr[6];
1730        if (!buf2)
1731                buf2=staticaddr;
1732        sscanf(buf,"%x:%x:%x:%x:%x:%x",
1733                        &tmp[0],&tmp[1],&tmp[2],
1734                        &tmp[3],&tmp[4],&tmp[5]);
1735        buf2[0]=tmp[0]; buf2[1]=tmp[1]; buf2[2]=tmp[2];
1736        buf2[3]=tmp[3]; buf2[4]=tmp[4]; buf2[5]=tmp[5];
1737        return buf2;
1738}
1739
1740
1741/* Creates a libtrace packet from scratch using the contents of the provided
1742 * buffer as the packet payload.
1743 *
1744 * Unlike trace_prepare_packet(), the buffer should not contain any capture
1745 * format headers; instead this function will add the PCAP header to the
1746 * packet record. This also means only PCAP packets can be constructed using
1747 * this function.
1748 *
1749 */
1750DLLEXPORT
1751void trace_construct_packet(libtrace_packet_t *packet,
1752                libtrace_linktype_t linktype,
1753                const void *data,
1754                uint16_t len)
1755{
1756        size_t size;
1757        static libtrace_t *deadtrace=NULL;
1758        libtrace_pcapfile_pkt_hdr_t hdr;
1759#ifdef WIN32
1760        struct _timeb tstruct;
1761#else
1762        struct timeval tv;
1763#endif
1764
1765        /* We need a trace to attach the constructed packet to (and it needs
1766         * to be PCAP) */
1767        if (NULL == deadtrace) 
1768                deadtrace=trace_create_dead("pcapfile");
1769
1770        /* Fill in the new PCAP header */
1771#ifdef WIN32
1772        _ftime(&tstruct);
1773        hdr.ts_sec=tstruct.time;
1774        hdr.ts_usec=tstruct.millitm * 1000;
1775#else
1776        gettimeofday(&tv,NULL);
1777        hdr.ts_sec=tv.tv_sec;
1778        hdr.ts_usec=tv.tv_usec;
1779#endif
1780
1781        hdr.caplen=len;
1782        hdr.wirelen=len;
1783
1784        /* Now fill in the libtrace packet itself */
1785        packet->trace=deadtrace;
1786        size=len+sizeof(hdr);
1787        if (packet->buf_control==TRACE_CTRL_PACKET) {
1788                packet->buffer=realloc(packet->buffer,size);
1789        }
1790        else {
1791                packet->buffer=malloc(size);
1792        }
1793        packet->buf_control=TRACE_CTRL_PACKET;
1794        packet->header=packet->buffer;
1795        packet->payload=(void*)((char*)packet->buffer+sizeof(hdr));
1796       
1797        /* Ugh, memcpy - sadly necessary */
1798        memcpy(packet->header,&hdr,sizeof(hdr));
1799        memcpy(packet->payload,data,(size_t)len);
1800        packet->type=pcap_linktype_to_rt(libtrace_to_pcap_linktype(linktype));
1801
1802        trace_clear_cache(packet);
1803}
1804
1805
1806uint64_t trace_get_received_packets(libtrace_t *trace)
1807{
1808        assert(trace);
1809        if (trace->format->get_received_packets) {
1810                return trace->format->get_received_packets(trace);
1811        }
1812        return (uint64_t)-1;
1813}
1814
1815uint64_t trace_get_filtered_packets(libtrace_t *trace)
1816{
1817        assert(trace);
1818        if (trace->format->get_filtered_packets) {
1819                return trace->format->get_filtered_packets(trace)+
1820                        trace->filtered_packets;
1821        }
1822        if (trace->format->get_received_packets
1823                && trace->format->get_dropped_packets) {
1824                return 
1825                        ((trace_get_received_packets(trace)
1826                        -trace_get_accepted_packets(trace))
1827                        -trace_get_dropped_packets(trace))
1828                        +trace->filtered_packets;
1829        }
1830        return trace->filtered_packets;
1831}
1832
1833uint64_t trace_get_dropped_packets(libtrace_t *trace)
1834{
1835        assert(trace);
1836        if (trace->format->get_dropped_packets) {
1837                return trace->format->get_dropped_packets(trace);
1838        }
1839        return (uint64_t)-1;
1840}
1841
1842uint64_t trace_get_accepted_packets(libtrace_t *trace)
1843{
1844        assert(trace);
1845        return trace->accepted_packets;
1846}
1847
1848void trace_clear_cache(libtrace_packet_t *packet) {
1849
1850        packet->l2_header = NULL;
1851        packet->l3_header = NULL;
1852        packet->l4_header = NULL;
1853        packet->link_type = 0;
1854        packet->l3_ethertype = 0;
1855        packet->transport_proto = 0;
1856        packet->capture_length = -1;
1857        packet->wire_length = -1;
1858        packet->payload_length = -1;
1859        packet->l2_remaining = 0;
1860        packet->l3_remaining = 0;
1861        packet->l4_remaining = 0;
1862
1863}
1864
1865void trace_interrupt(void) {
1866        libtrace_halt = 1;
1867}
1868
1869void register_format(struct libtrace_format_t *f) {
1870        assert(f->next==NULL); /* Can't register a format twice */
1871        f->next=formats_list;
1872        formats_list=f;
1873
1874        /* Now, verify that the format has at least the minimum functionality.
1875         *
1876         * This #if can be changed to a 1 to output warnings about inconsistent
1877         * functions being provided by format modules.  This generally is very
1878         * noisy, as almost all modules don't implement one or more functions
1879         * for various reasons.  This is very useful when checking a new
1880         * format module is sane.
1881         */ 
1882#if 0
1883        if (f->init_input) {
1884#define REQUIRE(x) \
1885                if (!f->x) \
1886                        fprintf(stderr,"%s: Input format should provide " #x "\n",f->name)
1887                REQUIRE(read_packet);
1888                REQUIRE(start_input);
1889                REQUIRE(fin_input);
1890                REQUIRE(get_link_type);
1891                REQUIRE(get_capture_length);
1892                REQUIRE(get_wire_length);
1893                REQUIRE(get_framing_length);
1894                REQUIRE(trace_event);
1895                if (!f->get_erf_timestamp
1896                        && !f->get_seconds
1897                        && !f->get_timeval) {
1898                        fprintf(stderr,"%s: A trace format capable of input, should provide at least one of\n"
1899"get_erf_timestamp, get_seconds or trace_timeval\n",f->name);
1900                }
1901                if (f->trace_event!=trace_event_trace) {
1902                        /* Theres nothing that a trace file could optimise with
1903                         * config_input
1904                         */
1905                        REQUIRE(pause_input);
1906                        REQUIRE(config_input);
1907                        REQUIRE(get_fd);
1908                }
1909                else {
1910                        if (f->get_fd) {
1911                                fprintf(stderr,"%s: Unnecessary get_fd\n",
1912                                                f->name);
1913                        }
1914                }
1915#undef REQUIRE
1916        }
1917        else {
1918#define REQUIRE(x) \
1919                if (f->x) \
1920                        fprintf(stderr,"%s: Non Input format shouldn't need " #x "\n",f->name)
1921                REQUIRE(read_packet);
1922                REQUIRE(start_input);
1923                REQUIRE(pause_input);
1924                REQUIRE(fin_input);
1925                REQUIRE(get_link_type);
1926                REQUIRE(get_capture_length);
1927                REQUIRE(get_wire_length);
1928                REQUIRE(get_framing_length);
1929                REQUIRE(trace_event);
1930                REQUIRE(get_seconds);
1931                REQUIRE(get_timeval);
1932                REQUIRE(get_erf_timestamp);
1933#undef REQUIRE
1934        }
1935        if (f->init_output) {
1936#define REQUIRE(x) \
1937                if (!f->x) \
1938                        fprintf(stderr,"%s: Output format should provide " #x "\n",f->name)
1939                REQUIRE(write_packet);
1940                REQUIRE(start_output);
1941                REQUIRE(config_output);
1942                REQUIRE(fin_output);
1943#undef REQUIRE
1944        }
1945        else {
1946#define REQUIRE(x) \
1947                if (f->x) \
1948                        fprintf(stderr,"%s: Non Output format shouldn't need " #x "\n",f->name)
1949                REQUIRE(write_packet);
1950                REQUIRE(start_output);
1951                REQUIRE(config_output);
1952                REQUIRE(fin_output);
1953#undef REQUIRE
1954        }
1955#endif
1956}
1957
Note: See TracBrowser for help on using the repository browser.