source: lib/trace.c @ 8753bb8

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