source: lib/trace.c @ 23e1258

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since 23e1258 was 23e1258, checked in by Perry Lorier <perry@…>, 11 years ago

Fix bug with autodetection of dag cards

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