source: lib/trace.c @ 528eb6e

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