source: lib/trace.c @ 9231fe5

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

Minor cleanups in format_rt
Shuffled protocols.c around for better vlan support
Cleaned up IPv6 support to be more generic (less duplicated code)
added trace_get_{source,destination}_address

  • Property mode set to 100644
File size: 37.1 KB
Line 
1/*
2 * This file is part of libtrace
3 *
4 * Copyright (c) 2004 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 <netdb.h>
48#include <stdio.h>
49#include <stdlib.h>
50#include <string.h>
51#include <sys/stat.h>
52#include <sys/types.h>
53#include <stdarg.h>
54
55#ifdef HAVE_LIMITS_H
56#  include <limits.h>
57#endif
58
59#ifdef HAVE_SYS_LIMITS_H
60#  include <sys/limits.h>
61#endif
62
63#include <sys/socket.h>
64#include <sys/un.h>
65#include <sys/mman.h>
66#include <unistd.h>
67
68#ifdef HAVE_NET_IF_ARP_H
69#  include <net/if_arp.h>
70#endif
71
72#ifdef HAVE_NET_IF_H
73#  include <net/if.h>
74#endif
75
76#ifdef HAVE_NETINET_IN_H
77#  include <netinet/in.h>
78#endif
79
80#ifdef HAVE_NET_ETHERNET_H
81#  include <net/ethernet.h>
82#endif
83
84#ifdef HAVE_NETINET_IF_ETHER_H
85#  include <netinet/if_ether.h>
86#endif
87
88#include <time.h>
89#include <sys/ioctl.h>
90
91#ifdef HAVE_INTTYPES_H
92#  include <inttypes.h>
93#else
94#  error "Can't find inttypes.h - this needs to be fixed"
95#endif
96
97#ifdef HAVE_STDDEF_H
98#  include <stddef.h>
99#else
100# error "Can't find stddef.h - do you define ptrdiff_t elsewhere?"
101#endif
102
103#include "libtrace.h"
104#include "fifo.h"
105#include "libtrace_int.h"
106#include "parse_cmd.h"
107
108#if HAVE_PCAP_BPF_H
109#  include <pcap-bpf.h>
110#else
111#  ifdef HAVE_NET_BPF_H
112#    include <net/bpf.h>
113#  endif
114#endif
115
116#include "libtrace_int.h"
117#include "format_helper.h"
118#include "rt_protocol.h"
119#include <err.h>
120
121#define MAXOPTS 1024
122
123
124static struct libtrace_format_t *formats_list = 0;
125
126/* strncpy is not assured to copy the final \0, so we
127 * will use our own one that does
128 */
129static void xstrncpy(char *dest, const char *src, size_t n)
130{
131        strncpy(dest,src,n);
132        dest[n]='\0';
133}
134 
135static char *xstrndup(const char *src,size_t n)
136{       
137        char *ret=malloc(n+1);
138        xstrncpy(ret,src,n);
139        return ret;
140}
141
142void register_format(struct libtrace_format_t *f) {
143        assert(f->next==NULL);
144        f->next=formats_list;
145        formats_list=f;
146        /* Now, verify things */
147#if 0
148        if (format_list[nformats]->init_input) {
149#define REQUIRE(x) \
150                if (!format_list[nformats]->x) \
151                        fprintf(stderr,"%s: Input format should provide " #x "\n",format_list[nformats]->name)
152                REQUIRE(read_packet);
153                REQUIRE(start_input);
154                REQUIRE(config_input);
155                REQUIRE(pause_input);
156                REQUIRE(fin_input);
157                REQUIRE(get_link_type);
158                REQUIRE(get_capture_length);
159                REQUIRE(get_wire_length);
160                REQUIRE(get_framing_length);
161                REQUIRE(trace_event);
162                if (!format_list[nformats]->get_erf_timestamp
163                        && !format_list[nformats]->get_seconds
164                        && !format_list[nformats]->get_timeval) {
165                        fprintf(stderr,"%s: A trace format capable of input, should provide at least one of\n"
166"get_erf_timestamp, get_seconds or trace_timeval\n",format_list[nformats]->name);
167                }
168                if (format_list[nformats]->trace_event==trace_event_device) {
169                        REQUIRE(get_fd);
170                }
171                else {
172                        if (format_list[nformats]->get_fd) {
173                                fprintf(stderr,"%s: Unnecessary get_fd\n",
174                                                format_list[nformats]->name);
175                        }
176                }
177#undef REQUIRE
178        }
179        else {
180#define REQUIRE(x) \
181                if (format_list[nformats]->x) \
182                        fprintf(stderr,"%s: Non Input format shouldn't need " #x "\n",format_list[nformats]->name)
183                REQUIRE(read_packet);
184                REQUIRE(start_input);
185                REQUIRE(pause_input);
186                REQUIRE(fin_input);
187                REQUIRE(get_link_type);
188                REQUIRE(get_capture_length);
189                REQUIRE(get_wire_length);
190                REQUIRE(get_framing_length);
191                REQUIRE(trace_event);
192                REQUIRE(get_seconds);
193                REQUIRE(get_timeval);
194                REQUIRE(get_erf_timestamp);
195#undef REQUIRE
196        }
197        if (format_list[nformats]->init_output) {
198#define REQUIRE(x) \
199                if (!format_list[nformats]->x) \
200                        fprintf(stderr,"%s: Output format should provide " #x "\n",format_list[nformats]->name)
201                REQUIRE(write_packet);
202                REQUIRE(start_output);
203                REQUIRE(config_output);
204                REQUIRE(fin_output);
205#undef REQUIRE
206        }
207        else {
208#define REQUIRE(x) \
209                if (format_list[nformats]->x) \
210                        fprintf(stderr,"%s: Non Output format shouldn't need " #x "\n",format_list[nformats]->name)
211                REQUIRE(write_packet);
212                REQUIRE(start_output);
213                REQUIRE(config_output);
214                REQUIRE(fin_output);
215#undef REQUIRE
216        }
217#endif
218}
219
220/* Prints help information for libtrace
221 *
222 * Function prints out some basic help information regarding libtrace,
223 * and then prints out the help() function registered with each input module
224 */
225void trace_help() {
226        struct libtrace_format_t *tmp;
227        printf("libtrace %s\n",PACKAGE_VERSION);
228        for(tmp=formats_list;tmp;tmp=tmp->next) {
229                if (tmp->help)
230                        tmp->help();
231        }
232}
233
234#define RP_BUFSIZE 65536
235#define URI_PROTO_LINE 16
236
237/* Gets the name of the output format for a given output trace.
238 *
239 * @params libtrace     the output trace to get the name of the format for
240 * @returns callee-owned null-terminated char* containing the output format
241 *
242 */
243SIMPLE_FUNCTION
244char *trace_get_output_format(const struct libtrace_out_t *libtrace) {
245        char * format = libtrace->format->name;
246
247        return format;
248}
249
250/* Create a trace file from a URI
251 *
252 * @params char * containing a valid libtrace URI
253 * @returns opaque pointer to a libtrace_t
254 *
255 * Valid URI's are:
256 *  erf:/path/to/erf/file
257 *  erf:/path/to/erf/file.gz
258 *  erf:/path/to/rtclient/socket
259 *  erf:-                       (stdin)
260 *  dag:/dev/dagcard
261 *  pcapint:pcapinterface               (eg: pcapint:eth0)
262 *  pcap:/path/to/pcap/file
263 *  pcap:-
264 *  rtclient:hostname
265 *  rtclient:hostname:port
266 *  wag:-
267 *  wag:/path/to/wag/file
268 *  wag:/path/to/wag/file.gz
269 *  wag:/path/to/wag/socket
270 *
271 * If an error occured when attempting to open a trace, NULL is returned
272 * and an error is output to stdout.
273 */
274struct libtrace_t *trace_create(const char *uri) {
275        struct libtrace_t *libtrace = malloc(sizeof(struct libtrace_t));
276        char *scan = 0;
277        const char *uridata = 0;                 
278        struct libtrace_format_t *tmp;
279       
280        libtrace->err.err_num = TRACE_ERR_NOERROR;
281        libtrace->format=NULL;
282       
283        /* parse the URI to determine what sort of event we are dealing with */
284        if ((uridata = trace_parse_uri(uri, &scan)) == 0) {
285                trace_set_err(libtrace,TRACE_ERR_BAD_FORMAT,"Bad uri format (%s)",uri);
286                return libtrace;
287        }
288       
289        libtrace->event.tdelta = 0.0;
290        libtrace->filter = NULL;
291        libtrace->snaplen = 0;
292        libtrace->started=false;
293
294        for (tmp=formats_list;tmp;tmp=tmp->next) {
295                if (strlen(scan) == strlen(tmp->name) &&
296                                strncasecmp(scan, tmp->name, strlen(scan)) == 0
297                                ) {
298                        libtrace->format=tmp;
299                        break;
300                }
301        }
302        if (libtrace->format == 0) {
303                trace_set_err(libtrace, TRACE_ERR_BAD_FORMAT,
304                                "Unknown format (%s)",scan);
305                return libtrace;
306        }
307
308        libtrace->uridata = strdup(uridata);
309        /* libtrace->format now contains the type of uri
310         * libtrace->uridata contains the appropriate data for this
311         */
312       
313        if (libtrace->format->init_input) {
314                int err=libtrace->format->init_input(libtrace);
315                assert (err==-1 || err==0);
316                if (err==-1) {
317                        /* init_input should call trace_set_err to set
318                         * the error message
319                         */
320                        return libtrace;
321                }
322        } else {
323                trace_set_err(libtrace,TRACE_ERR_NO_INIT,
324                                "Format does not support input (%s)",scan);
325                return libtrace;
326        }
327       
328
329        libtrace->fifo = create_tracefifo(1048576);
330        if (!libtrace->fifo) {
331                trace_set_err(libtrace,ENOMEM,"Could not allocate memory for fifo");
332                free(scan);
333                return libtrace;
334        }
335        assert(libtrace->fifo);
336        free(scan);
337        trace_set_err(libtrace,0,"");
338        return libtrace;
339}
340
341/* Creates a "dummy" trace file that has only the format type set.
342 *
343 * @returns opaque pointer to a (sparsely initialised) libtrace_t
344 *
345 * IMPORTANT: Do not attempt to call trace_read_packet or other such functions
346 * with the dummy trace. Its intended purpose is to act as a packet->trace for
347 * libtrace_packet_t's that are not associated with a libtrace_t structure.
348 */
349struct libtrace_t * trace_create_dead (const char *uri) {
350        struct libtrace_t *libtrace = malloc(sizeof(struct libtrace_t));
351        char *scan = calloc(sizeof(char),URI_PROTO_LINE);
352        char *uridata;
353        struct libtrace_format_t *tmp;
354       
355        libtrace->err.err_num = TRACE_ERR_NOERROR;
356
357        if((uridata = strchr(uri,':')) == NULL) {
358                xstrncpy(scan, uri, strlen(uri));
359        } else {
360                xstrncpy(scan,uri, (uridata - uri));
361        }
362       
363        libtrace->format = 0;   
364       
365        for(tmp=formats_list;tmp;tmp=tmp->next) {
366                if (strlen(scan) == strlen(tmp->name) &&
367                                !strncasecmp(scan,
368                                        tmp->name,
369                                        strlen(scan))) {
370                                libtrace->format=tmp;
371                                break;
372                                }
373        }
374        if (libtrace->format == 0) {
375                trace_set_err(libtrace,TRACE_ERR_BAD_FORMAT,
376                                "Unknown format (%s)",scan);
377                return 0;
378        }
379
380        libtrace->format_data = NULL;
381        free(scan);
382        return libtrace;
383
384}
385
386/* Creates a trace output file from a URI.
387 *
388 * @param uri   the uri string describing the output format and destination
389 * @returns opaque pointer to a libtrace_output_t
390 *
391 *  If an error occured when attempting to open the output trace, NULL is
392 *  returned and trace_errno is set.
393 */
394       
395libtrace_out_t *trace_create_output(const char *uri) {
396        libtrace_out_t *libtrace = malloc(sizeof(struct libtrace_out_t));
397       
398        char *scan = 0;
399        const char *uridata = 0;
400        struct libtrace_format_t *tmp;
401
402        libtrace->err.err_num = TRACE_ERR_NOERROR;
403        strcat(libtrace->err.problem,"Error message set\n");
404       
405        /* parse the URI to determine what sort of event we are dealing with */
406
407        if ((uridata = trace_parse_uri(uri, &scan)) == 0) {
408                trace_set_err_out(libtrace,TRACE_ERR_BAD_FORMAT,
409                                "Bad uri format (%s)",uri);
410                return libtrace;
411        }
412       
413        libtrace->format = NULL;
414        for(tmp=formats_list;tmp;tmp=tmp->next) {
415                if (strlen(scan) == strlen(tmp->name) &&
416                                !strncasecmp(scan,
417                                        tmp->name,
418                                        strlen(scan))) {
419                                libtrace->format=tmp;
420                                break;
421                                }
422        }
423        if (libtrace->format == NULL) {
424                trace_set_err_out(libtrace,TRACE_ERR_BAD_FORMAT,
425                                "Unknown output format (%s)",scan);
426                return libtrace;
427        }
428        libtrace->uridata = strdup(uridata);
429
430
431        /* libtrace->format now contains the type of uri
432         * libtrace->uridata contains the appropriate data for this
433         */
434
435        if (libtrace->format->init_output) {
436                /* 0 on success, -1 on failure */
437                switch(libtrace->format->init_output(libtrace)) {
438                        case -1: /* failure */
439                                free(libtrace);
440                                return libtrace;
441                        case 0: /* success */
442                                break;
443                        default:
444                                assert(!"init_output() should return -1 for failure, or 0 for success");
445                }
446        } else {
447                trace_set_err_out(libtrace,TRACE_ERR_NO_INIT_OUT,
448                                "Format does not support writing (%s)",scan);
449                return libtrace;
450        }
451
452
453        free(scan);
454        libtrace->started=false;
455        return libtrace;
456}
457
458/* Start a trace
459 * @param libtrace      the input trace to start
460 * @returns 0 on success
461 *
462 * This does the work associated with actually starting up
463 * the trace.  it may fail.
464 */
465int trace_start(struct libtrace_t *libtrace)
466{
467        assert(libtrace);
468        if (libtrace->format->start_input) {
469                int ret=libtrace->format->start_input(libtrace);
470                if (ret < 0) {
471                        return ret;
472                }
473        }
474
475        libtrace->started=true;
476        return 0;
477}
478
479int trace_start_output(libtrace_out_t *libtrace) 
480{
481        assert(libtrace);
482        if (libtrace->format->start_output) {
483                int ret=libtrace->format->start_output(libtrace);
484                if (ret < 0) {
485                        return ret;
486                }
487        }
488
489        libtrace->started=true;
490        return 0;
491}
492
493int trace_pause(libtrace_t *libtrace)
494{
495        assert(libtrace);
496        assert(libtrace->started && "BUG: Called trace_pause without calling trace_start first");
497        if (libtrace->format->pause_input)
498                libtrace->format->pause_input(libtrace);
499        libtrace->started=false;
500        return 0;
501}
502
503int trace_config(libtrace_t *libtrace,
504                trace_option_t option,
505                void *value)
506{
507        int ret;
508        if (libtrace->format->config_input) {
509                ret=libtrace->format->config_input(libtrace,option,value);
510                if (ret==0)
511                        return 0;
512        }
513        switch(option) {
514                case TRACE_OPTION_SNAPLEN:
515                        libtrace->snaplen=*(int*)value;
516                        break;
517                case TRACE_OPTION_FILTER:
518                        libtrace->filter=value;
519                        break;
520                case TRACE_OPTION_PROMISC:
521                        trace_set_err(libtrace,TRACE_ERR_OPTION_UNAVAIL,
522                                "Promisc mode is not supported by this format module");
523                        return -1;
524                default:
525                        trace_set_err(libtrace,TRACE_ERR_UNKNOWN_OPTION,
526                                "Unknown option %i", option);
527                        return -1;
528        }
529        return 0;
530}
531
532/* Parses an output options string and calls the appropriate function to deal with output options.
533 *
534 * @param libtrace      the output trace object to apply the options to
535 * @param options       the options string
536 * @returns -1 if option configuration failed, 0 otherwise
537 *
538 * @author Shane Alcock
539 */
540int trace_config_output(struct libtrace_out_t *libtrace, 
541                trace_option_output_t option,
542                void *value) {
543        if (libtrace->format->config_output) {
544                return libtrace->format->config_output(libtrace, option, value);
545        }
546        return -1;
547}
548
549/* Close a trace file, freeing up any resources it may have been using
550 *
551 */
552void trace_destroy(struct libtrace_t *libtrace) {
553        assert(libtrace);
554        if (libtrace->started && libtrace->format->pause_input)
555                libtrace->format->pause_input(libtrace);
556        libtrace->format->fin_input(libtrace);
557        /* need to free things! */
558        free(libtrace->uridata);
559        destroy_tracefifo(libtrace->fifo);
560        free(libtrace);
561}
562
563
564void trace_destroy_dead(struct libtrace_t *libtrace) {
565        assert(libtrace);
566        free(libtrace);
567}
568/* Close an output trace file, freeing up any resources it may have been using
569 *
570 * @param libtrace      the output trace file to be destroyed
571 *
572 * @author Shane Alcock
573 * */
574void trace_destroy_output(struct libtrace_out_t *libtrace) {
575        assert(libtrace);
576        libtrace->format->fin_output(libtrace);
577        free(libtrace->uridata);
578        free(libtrace);
579}
580
581libtrace_packet_t *trace_create_packet() {
582        libtrace_packet_t *packet = calloc(1,sizeof(libtrace_packet_t));
583        packet->buf_control=TRACE_CTRL_PACKET;
584        return packet;
585}
586
587libtrace_packet_t *trace_copy_packet(const libtrace_packet_t *packet) {
588        libtrace_packet_t *dest = malloc(sizeof(libtrace_packet_t));
589        dest->trace=packet->trace;
590        dest->buffer=malloc(
591                        trace_get_framing_length(packet)
592                        +trace_get_capture_length(packet));
593        dest->header=dest->buffer;
594        dest->payload=(void*)
595                ((char*)dest->buffer+trace_get_framing_length(packet));
596        dest->size=packet->size;
597        dest->type=packet->type;
598        dest->buf_control=TRACE_CTRL_PACKET;
599        memcpy(dest->header,packet->header,trace_get_framing_length(packet));
600        memcpy(dest->payload,packet->payload,trace_get_capture_length(packet));
601
602        return dest;
603}
604
605/** Destroy a packet object
606 *
607 * sideeffect: sets packet to NULL
608 */
609void trace_destroy_packet(struct libtrace_packet_t **packet) {
610        if ((*packet)->buf_control == TRACE_CTRL_PACKET) {
611                free((*packet)->buffer);
612        }
613        free((*packet));
614        *packet = NULL;
615}       
616
617/* Read one packet from the trace into buffer
618 *
619 * @param libtrace      the libtrace opaque pointer
620 * @param packet        the packet opaque pointer
621 * @returns 0 on EOF, negative value on error
622 *
623 */
624int trace_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
625
626        assert(libtrace && "You called trace_read_packet() with a NULL libtrace parameter!\n");
627        assert(libtrace->started && "BUG: You must call libtrace_start() before trace_read_packet()\n");
628        assert(packet);
629        assert((packet->buf_control==TRACE_CTRL_PACKET || packet->buf_control==TRACE_CTRL_EXTERNAL)&&
630                "BUG: You must allocate a packet using packet_create()");
631     
632        /* Store the trace we are reading from into the packet opaque
633         * structure */
634        packet->trace = libtrace;
635
636
637        if (libtrace->format->read_packet) {
638                do {
639                        packet->size=libtrace->format->read_packet(libtrace,packet);
640                        if (packet->size==(size_t)-1 || packet->size==0)
641                                return packet->size;
642                        if (libtrace->filter) {
643                                /* If the filter doesn't match, read another
644                                 * packet
645                                 */
646                                if (!trace_bpf_filter(libtrace->filter,packet)){
647                                        continue;
648                                }
649                        }
650                        if (libtrace->snaplen>0) {
651                                /* Snap the packet */
652                                trace_set_capture_length(packet,
653                                                libtrace->snaplen);
654                        }
655
656                        return packet->size;
657                } while(1);
658        }
659        packet->size=-1;
660        return -1;
661}
662
663/* Writes a packet to the specified output
664 *
665 * @param libtrace      describes the output format, destination, etc.
666 * @param packet        the packet to be written out
667 * @returns the number of bytes written, -1 if write failed
668 *
669 * @author Shane Alcock
670 * */
671int trace_write_packet(struct libtrace_out_t *libtrace, const struct libtrace_packet_t *packet) {
672        assert(libtrace);
673        assert(packet); 
674        /* Verify the packet is valid */
675        assert(packet->size<65536);
676        assert(packet->size>0);
677        assert(libtrace->started);
678
679        if (libtrace->format->write_packet) {
680                return libtrace->format->write_packet(libtrace, packet);
681        }
682        return -1;
683}
684
685void *trace_get_link(const struct libtrace_packet_t *packet) {
686        return (void *)packet->payload;
687}
688
689/*
690typedef struct legacy_framing {
691        uint64_t        ts;
692        uint32_t        crc;
693        uint32_t        header;
694        uint32_t        data[12]; // pad to 64 bytes
695} legacy_framing_t;
696*/
697
698
699
700
701/* parse an ip or tcp option
702 * @param[in,out] ptr   the pointer to the current option
703 * @param[in,out] len   the length of the remaining buffer
704 * @param[out] type     the type of the option
705 * @param[out] optlen   the length of the option
706 * @param[out] data     the data of the option
707 *
708 * @returns bool true if there is another option (and the fields are filled in)
709 *               or false if this was the last option.
710 *
711 * This updates ptr to point to the next option after this one, and updates
712 * len to be the number of bytes remaining in the options area.  Type is updated
713 * to be the code of this option, and data points to the data of this option,
714 * with optlen saying how many bytes there are.
715 *
716 * @note Beware of fragmented packets.
717 * @author Perry Lorier
718 */
719int trace_get_next_option(unsigned char **ptr,int *len,
720                        unsigned char *type,
721                        unsigned char *optlen,
722                        unsigned char **data)
723{
724        if (*len<=0)
725                return 0;
726        *type=**ptr;
727        switch(*type) {
728                case 0: /* End of options */
729                        return 0;
730                case 1: /* Pad */
731                        (*ptr)++;
732                        (*len)--;
733                        return 1;
734                default:
735                        *optlen = *(*ptr+1);
736                        if (*optlen<2)
737                                return 0; /* I have no idea wtf is going on
738                                           * with these packets
739                                           */
740                        (*len)-=*optlen;
741                        (*data)=(*ptr+2);
742                        (*ptr)+=*optlen;
743                        if (*len<0)
744                                return 0;
745                        return 1;
746        }
747        assert(0);
748}
749
750
751/* Get the current time in DAG time format
752 * @param packet        a pointer to a libtrace_packet structure
753 * @returns a 64 bit timestamp in DAG ERF format (upper 32 bits are the seconds
754 * past 1970-01-01, the lower 32bits are partial seconds)
755 * @author Daniel Lawson
756 */ 
757uint64_t trace_get_erf_timestamp(const libtrace_packet_t *packet) {
758        uint64_t timestamp = 0;
759        double seconds = 0.0;
760        struct timeval ts;
761
762        assert(packet->size>0 && packet->size<65536);
763
764        if (packet->trace->format->get_erf_timestamp) {
765                /* timestamp -> timestamp */
766                timestamp = packet->trace->format->get_erf_timestamp(packet);
767        } else if (packet->trace->format->get_timeval) {
768                /* timeval -> timestamp */
769                ts = packet->trace->format->get_timeval(packet);
770                timestamp = ((((uint64_t)ts.tv_sec) << 32) + \
771                                (((uint64_t)ts.tv_usec * UINT_MAX)/1000000));
772        } else if (packet->trace->format->get_seconds) {
773                /* seconds -> timestamp */
774                seconds = packet->trace->format->get_seconds(packet);
775                timestamp = ((uint64_t)((uint32_t)seconds) << 32) + \
776                            (( seconds - (uint32_t)seconds   ) * UINT_MAX);
777        }
778        return timestamp;
779}
780
781/* Get the current time in struct timeval
782 * @param packet        a pointer to a libtrace_packet structure
783 *
784 * @returns time that this packet was seen in a struct timeval
785 * @author Daniel Lawson
786 * @author Perry Lorier
787 */ 
788struct timeval trace_get_timeval(const libtrace_packet_t *packet) {
789        struct timeval tv;
790        uint64_t ts = 0;
791        double seconds = 0.0;
792        assert(packet->size>0 && packet->size<65536);
793        if (packet->trace->format->get_timeval) {
794                /* timeval -> timeval */
795                tv = packet->trace->format->get_timeval(packet);
796        } else if (packet->trace->format->get_erf_timestamp) {
797                /* timestamp -> timeval */
798                ts = packet->trace->format->get_erf_timestamp(packet);
799#if __BYTE_ORDER == __BIG_ENDIAN
800                tv.tv_sec = ts & 0xFFFFFFFF;
801#elif __BYTE_ORDER == __LITTLE_ENDIAN
802                tv.tv_sec = ts >> 32;
803#else
804#error "What on earth are you running this on?"
805#endif
806                tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
807                if (tv.tv_usec >= 1000000) {
808                        tv.tv_usec -= 1000000;
809                        tv.tv_sec += 1;
810                }
811        } else if (packet->trace->format->get_seconds) {
812                /* seconds -> timeval */
813                seconds = packet->trace->format->get_seconds(packet);
814                tv.tv_sec = (uint32_t)seconds;
815                tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
816        }
817
818        return tv;
819}
820
821/* Get the current time in floating point seconds
822 * @param packet        a pointer to a libtrace_packet structure
823 * @returns time that this packet was seen in 64bit floating point seconds
824 * @author Perry Lorier
825 */ 
826double trace_get_seconds(const struct libtrace_packet_t *packet) {
827        double seconds = 0.0;
828        uint64_t ts = 0;
829        struct timeval tv;
830
831        assert(packet->size>0 && packet->size<65536);
832       
833        if (packet->trace->format->get_seconds) {
834                /* seconds->seconds */
835                seconds = packet->trace->format->get_seconds(packet);
836        } else if (packet->trace->format->get_erf_timestamp) {
837                /* timestamp -> seconds */
838                ts = packet->trace->format->get_erf_timestamp(packet);
839                seconds =  (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
840        } else if (packet->trace->format->get_timeval) {
841                /* timeval -> seconds */
842                tv = packet->trace->format->get_timeval(packet);
843                seconds = tv.tv_sec + ((tv.tv_usec * 1.0) / 1000000);
844        }
845
846        return seconds;
847}
848
849size_t trace_get_capture_length(const libtrace_packet_t *packet) {
850
851        assert(packet->size<65536);
852
853        if (packet->trace->format->get_capture_length) {
854                return packet->trace->format->get_capture_length(packet);
855        }
856        return -1;
857}
858       
859/* Get the size of the packet as it was seen on the wire.
860 * @param packet        a pointer to a libtrace_packet structure
861 *
862 * @returns the size of the packet as it was on the wire.
863 * @author Perry Lorier
864 * @author Daniel Lawson
865 * @note Due to the trace being a header capture, or anonymisation this may
866 * not be the same as the Capture Len.
867 */ 
868size_t trace_get_wire_length(const libtrace_packet_t *packet){
869        assert(packet->size>0 && packet->size<65536);
870
871        if (packet->trace->format->get_wire_length) {
872                return packet->trace->format->get_wire_length(packet);
873        }
874        return -1;
875
876}
877
878/* Get the length of the capture framing headers.
879 * @param packet        the packet opaque pointer
880 * @returns the size of the packet as it was on the wire.
881 * @author Perry Lorier
882 * @author Daniel Lawson
883 * @note this length corresponds to the difference between the size of a
884 * captured packet in memory, and the captured length of the packet
885 */ 
886SIMPLE_FUNCTION
887size_t trace_get_framing_length(const libtrace_packet_t *packet) {
888        if (packet->trace->format->get_framing_length) {
889                return packet->trace->format->get_framing_length(packet);
890        }
891        return -1;
892}
893
894
895/* Get the type of the link layer
896 * @param packet        a pointer to a libtrace_packet structure
897 * @returns libtrace_linktype_t
898 * @author Perry Lorier
899 * @author Daniel Lawson
900 */
901libtrace_linktype_t trace_get_link_type(const libtrace_packet_t *packet ) {
902        if (packet->trace->format->get_link_type) {
903                return packet->trace->format->get_link_type(packet);
904        }
905        return -1;
906}
907
908/* process a libtrace event
909 * @param trace the libtrace opaque pointer
910 * @param packet the libtrace_packet opaque pointer
911 * @returns
912 *  TRACE_EVENT_IOWAIT  Waiting on I/O on fd
913 *  TRACE_EVENT_SLEEP   Next event in seconds
914 *  TRACE_EVENT_PACKET  Packet arrived in buffer with size size
915 *  TRACE_EVENT_TERMINATE Trace terminated (perhaps with an error condition)
916 * FIXME currently keeps a copy of the packet inside the trace pointer,
917 * which in turn is stored inside the new packet object...
918 * @author Perry Lorier
919 */
920struct libtrace_eventobj_t trace_event(struct libtrace_t *trace, 
921                struct libtrace_packet_t *packet) {
922        struct libtrace_eventobj_t event = {0,0,0.0,0};
923
924        if (!trace) {
925                fprintf(stderr,"You called trace_event() with a NULL trace object!\n");
926        }
927        assert(trace);
928        assert(packet);
929
930        /* Store the trace we are reading from into the packet opaque
931         * structure */
932        packet->trace = trace;
933
934        if (packet->trace->format->trace_event) {
935                return packet->trace->format->trace_event(trace,packet);
936        } else {
937                return event;
938        }
939
940}
941
942/* setup a BPF filter
943 * @param filterstring a char * containing the bpf filter string
944 * @returns opaque pointer pointer to a libtrace_filter_t object
945 * @author Daniel Lawson
946 */
947struct libtrace_filter_t *trace_bpf_setfilter(const char *filterstring) {
948#if HAVE_BPF
949        struct libtrace_filter_t *filter = malloc(sizeof(struct libtrace_filter_t));
950        filter->filterstring = strdup(filterstring);
951        filter->flag = 0;
952        return filter;
953#else
954        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
955        return 0;
956#endif
957}
958
959/* compile a bpf filter, now we know what trace it's on
960 * @internal
961 *
962 * @returns -1 on error, 0 on success
963 */
964int trace_bpf_compile(libtrace_filter_t *filter,
965                const libtrace_packet_t *packet ) {
966#if HAVE_BPF
967        void *linkptr = 0;
968        assert(filter);
969
970        /* If this isn't a real packet, then fail */
971        linkptr = trace_get_link(packet);
972        if (!linkptr) {
973                trace_set_err(packet->trace,
974                                TRACE_ERR_BAD_PACKET,"Packet has no payload");
975                return -1;
976        }
977       
978        if (filter->filterstring && ! filter->flag) {
979                pcap_t *pcap;
980                libtrace_linktype_t linktype=trace_get_link_type(packet);
981                if (linktype==(libtrace_linktype_t)-1) {
982                        trace_set_err(packet->trace,TRACE_ERR_BAD_PACKET,
983                                        "Packet has an unknown linktype");
984                        return -1;
985                }
986                if (libtrace_to_pcap_dlt(linktype) == -1) {
987                        trace_set_err(packet->trace,TRACE_ERR_BAD_PACKET,
988                                        "Unknown pcap equivilent linktype");
989                        return -1;
990                }
991                pcap=(pcap_t *)pcap_open_dead(
992                                libtrace_to_pcap_dlt(linktype),
993                                1500);
994                /* build filter */
995                if (pcap_compile( pcap, &filter->filter, filter->filterstring, 
996                                        1, 0)) {
997                        pcap_close(pcap);
998                        trace_set_err(packet->trace,TRACE_ERR_BAD_PACKET,
999                                        "Packet has no payload");
1000                        return -1;
1001                }
1002                pcap_close(pcap);
1003                filter->flag=1;
1004        }
1005        return 0;
1006#else
1007        assert(!"This should never be called when BPF not enabled");
1008#endif
1009}
1010
1011int trace_bpf_filter(struct libtrace_filter_t *filter,
1012                        const struct libtrace_packet_t *packet) {
1013#if HAVE_BPF
1014        void *linkptr = 0;
1015        int clen = 0;
1016        assert(filter);
1017        assert(packet);
1018        linkptr = trace_get_link(packet);
1019        if (!linkptr) {
1020                return 0;
1021        }
1022
1023        /* We need to compile it now, because before we didn't know what the
1024         * link type was
1025         */
1026        if (trace_bpf_compile(filter,packet)==-1)
1027                return -1;
1028       
1029        clen = trace_get_capture_length(packet);
1030
1031        assert(filter->flag);
1032        return bpf_filter(filter->filter.bf_insns, linkptr, clen, clen);
1033#else
1034        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1035        return 0;
1036#endif
1037}
1038
1039/* Set the direction flag, if it has one
1040 * @param packet the packet opaque pointer
1041 * @param direction the new direction (0,1,2,3)
1042 * @returns a signed value containing the direction flag, or -1 if this is not supported
1043 * @author Daniel Lawson
1044 */
1045int8_t trace_set_direction(struct libtrace_packet_t *packet, int8_t direction) {
1046        assert(packet);
1047        assert(packet->size>0 && packet->size<65536);
1048        if (packet->trace->format->set_direction) {
1049                return packet->trace->format->set_direction(packet,direction);
1050        }
1051        return -1;
1052}
1053
1054/* Get the direction flag, if it has one
1055 * @param packet a pointer to a libtrace_packet structure
1056 * @returns a signed value containing the direction flag, or -1 if this is not supported
1057 * The direction is defined as 0 for packets originating locally (ie, outbound)
1058 * and 1 for packets originating remotely (ie, inbound).
1059 * Other values are possible, which might be overloaded to mean special things
1060 * for a special trace.
1061 * @author Daniel Lawson
1062 */
1063int8_t trace_get_direction(const struct libtrace_packet_t *packet) {
1064        assert(packet);
1065        assert(packet->size>0 && packet->size<65536);
1066        if (packet->trace->format->get_direction) {
1067                return packet->trace->format->get_direction(packet);
1068        }
1069        return -1;
1070}
1071
1072#define ROOT_SERVER(x) ((x) < 512)
1073#define ROOT_CLIENT(x) ((512 <= (x)) && ((x) < 1024))
1074#define NONROOT_SERVER(x) ((x) >= 5000)
1075#define NONROOT_CLIENT(x) ((1024 <= (x)) && ((x) < 5000))
1076#define DYNAMIC(x) ((49152 < (x)) && ((x) < 65535))
1077#define SERVER(x) ROOT_SERVER(x) || NONROOT_SERVER(x)
1078#define CLIENT(x) ROOT_CLIENT(x) || NONROOT_CLIENT(x)
1079
1080/* Attempt to deduce the 'server' port
1081 * @param protocol the IP protocol (eg, 6 or 17 for TCP or UDP)
1082 * @param source the TCP or UDP source port
1083 * @param dest the TCP or UDP destination port
1084 * @returns a hint as to which port is the server port
1085 * @author Daniel Lawson
1086 */
1087int8_t trace_get_server_port(uint8_t protocol __attribute__((unused)), uint16_t source, uint16_t dest) {
1088        /*
1089         * * If the ports are equal, return DEST
1090         * * Check for well-known ports in the given protocol
1091         * * Root server ports: 0 - 511
1092         * * Root client ports: 512 - 1023
1093         * * non-root client ports: 1024 - 4999
1094         * * non-root server ports: 5000+
1095         * * Check for static ranges: 1024 - 49151
1096         * * Check for dynamic ranges: 49152 - 65535
1097         * * flip a coin.
1098         */
1099       
1100        /* equal */
1101        if (source == dest)
1102                return USE_DEST;
1103
1104        /* root server port, 0 - 511 */
1105        if (ROOT_SERVER(source) && ROOT_SERVER(dest)) {
1106                if (source < dest)
1107                        return USE_SOURCE;
1108                return USE_DEST;
1109        }
1110
1111        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1112                return USE_SOURCE;
1113        if (!ROOT_SERVER(source) && ROOT_SERVER(dest))
1114                return USE_DEST;
1115
1116        /* non-root server */
1117        if (NONROOT_SERVER(source) && NONROOT_SERVER(dest)) {
1118                if (source < dest)
1119                        return USE_SOURCE;
1120                return USE_DEST;
1121        }
1122        if (NONROOT_SERVER(source) && !NONROOT_SERVER(dest))
1123                return USE_SOURCE;
1124        if (!NONROOT_SERVER(source) && NONROOT_SERVER(dest))
1125                return USE_DEST;
1126
1127        /* root client */
1128        if (ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1129                if (source < dest)
1130                        return USE_SOURCE;
1131                return USE_DEST;
1132        }
1133        if (ROOT_CLIENT(source) && !ROOT_CLIENT(dest)) {
1134                /* prefer root-client over nonroot-client */
1135                if (NONROOT_CLIENT(dest))
1136                        return USE_SOURCE;
1137                return USE_DEST;
1138        }
1139        if (!ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1140                /* prefer root-client over nonroot-client */
1141                if (NONROOT_CLIENT(source))
1142                        return USE_DEST;
1143                return USE_SOURCE;
1144        }
1145       
1146        /* nonroot client */
1147        if (NONROOT_CLIENT(source) && NONROOT_CLIENT(dest)) {
1148                if (source < dest) 
1149                        return USE_SOURCE;
1150                return USE_DEST;
1151        }
1152        if (NONROOT_CLIENT(source) && !NONROOT_CLIENT(dest))
1153                return USE_DEST;
1154        if (!NONROOT_CLIENT(source) && NONROOT_CLIENT(dest))
1155                return USE_SOURCE;
1156
1157        /* dynamic range */
1158        if (DYNAMIC(source) && DYNAMIC(dest))
1159                if (source < dest)
1160                        return USE_SOURCE;
1161                return USE_DEST;
1162        if (DYNAMIC(source) && !DYNAMIC(dest))
1163                return USE_DEST;
1164        if (!DYNAMIC(source) && DYNAMIC(dest))
1165                return USE_SOURCE;
1166        /*
1167        if (SERVER(source) && CLIENT(dest))
1168                return USE_SOURCE;
1169       
1170        if (SERVER(dest) && CLIENT(source))
1171                return USE_DEST;
1172        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1173                return USE_SOURCE;
1174        if (ROOT_SERVER(dest) && !ROOT_SERVER(source))
1175                return USE_DEST;
1176        */
1177        /* failing that test... */
1178        if (source < dest) {
1179                return USE_SOURCE;
1180        } 
1181        return USE_DEST;
1182       
1183}
1184
1185/* Truncate the packet at the suggested length
1186 * @param packet        the packet opaque pointer
1187 * @param size          the new length of the packet
1188 * @returns the new size of the packet
1189 * @note size and the return size refer to the network-level payload of the
1190 * packet, and do not include any capture headers. For example, to truncate a
1191 * packet after the IP header, set size to sizeof(ethernet_header) +
1192 * sizeof(ip_header)
1193 * @note If the original network-level payload is smaller than size, then the
1194 * original size is returned and the packet is left unchanged.
1195 * @author Daniel Lawson
1196 */
1197size_t trace_set_capture_length(struct libtrace_packet_t *packet, size_t size) {
1198        assert(packet);
1199        assert(packet->size>0 && packet->size<65536);
1200
1201        if (packet->trace->format->set_capture_length) {
1202                int caplen=packet->trace->format->set_capture_length(packet,size);
1203                if (caplen!=-1) {
1204                        packet->size=trace_get_framing_length(packet)+caplen;
1205                }
1206                return caplen;
1207        }
1208
1209        return -1;
1210}
1211
1212const char * trace_parse_uri(const char *uri, char **format) {
1213        const char *uridata = 0;
1214       
1215        if((uridata = strchr(uri,':')) == NULL) {
1216                /* badly formed URI - needs a : */
1217                return 0;
1218        }
1219
1220        if ((uridata - uri) > URI_PROTO_LINE) {
1221                /* badly formed URI - uri type is too long */
1222                return 0;
1223        }
1224
1225        *format=xstrndup(uri, (uridata - uri));
1226
1227        /* push uridata past the delimiter */
1228        uridata++;
1229       
1230        return uridata;
1231}
1232
1233enum base_format_t trace_get_format(struct libtrace_packet_t *packet) 
1234{
1235        assert(packet);
1236
1237        return packet->trace->format->type;
1238}
1239       
1240libtrace_err_t trace_get_err(libtrace_t *trace)
1241{
1242        libtrace_err_t err = trace->err;
1243        trace->err.err_num = 0; /* "OK" */
1244        trace->err.problem[0]='\0';
1245        return err;
1246}
1247
1248bool trace_is_err(libtrace_t *trace)
1249{
1250        return trace->err.err_num != 0;
1251}
1252
1253void trace_perror(libtrace_t *trace,const char *msg,...)
1254{
1255        char buf[256];
1256        va_list va;
1257        va_start(va,msg);
1258        vsnprintf(buf,sizeof(buf),msg,va);
1259        va_end(va);
1260        if(trace->err.err_num) {
1261                fprintf(stderr,"%s(%s): %s\n",
1262                                buf,trace->uridata,trace->err.problem);
1263        } else {
1264                fprintf(stderr,"%s(%s): No error\n",
1265                                buf,trace->uridata);
1266        }
1267}
1268
1269libtrace_err_t trace_get_err_output(libtrace_out_t *trace)
1270{
1271        libtrace_err_t err = trace->err;
1272        trace->err.err_num = 0; /* "OK" */
1273        trace->err.problem[0]='\0';
1274        return err;
1275}
1276
1277bool trace_is_err_output(libtrace_out_t *trace)
1278{
1279        return trace->err.err_num != 0;
1280}
1281
1282void trace_perror_output(libtrace_out_t *trace,const char *msg,...)
1283{
1284        char buf[256];
1285        va_list va;
1286        va_start(va,msg);
1287        vsnprintf(buf,sizeof(buf),msg,va);
1288        va_end(va);
1289        if(trace->err.err_num) {
1290                fprintf(stderr,"%s(%s): %s\n",
1291                                buf,trace->uridata,trace->err.problem);
1292        } else {
1293                fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
1294        }
1295}
1296
1297int trace_seek_erf_timestamp(libtrace_t *trace, uint64_t ts)
1298{
1299        if (trace->format->seek_erf) {
1300                return trace->format->seek_erf(trace,ts);
1301        }
1302        else {
1303                if (trace->format->seek_timeval) {
1304                        struct timeval tv;
1305#if __BYTE_ORDER == __BIG_ENDIAN
1306                        tv.tv_sec = ts & 0xFFFFFFFF;
1307#elif __BYTE_ORDER == __LITTLE_ENDIAN
1308                        tv.tv_sec = ts >> 32;
1309#else
1310#error "What on earth are you running this on?"
1311#endif
1312                        tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
1313                        if (tv.tv_usec >= 1000000) {
1314                                tv.tv_usec -= 1000000;
1315                                tv.tv_sec += 1;
1316                        }
1317                        return trace->format->seek_timeval(trace,tv);
1318                }
1319                if (trace->format->seek_seconds) {
1320                        double seconds = 
1321                                (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
1322                        return trace->format->seek_seconds(trace,seconds);
1323                }
1324                trace_set_err(trace,
1325                                TRACE_ERR_OPTION_UNAVAIL,
1326                                "Feature unimplemented");
1327                return -1;
1328        }
1329}
1330
1331int trace_seek_seconds(libtrace_t *trace, double seconds)
1332{
1333        if (trace->format->seek_seconds) {
1334                return trace->format->seek_seconds(trace,seconds);
1335        }
1336        else {
1337                if (trace->format->seek_timeval) {
1338                        struct timeval tv;
1339                        tv.tv_sec = (uint32_t)seconds;
1340                        tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
1341                        return trace->format->seek_timeval(trace,tv);
1342                }
1343                if (trace->format->seek_erf) {
1344                        uint64_t timestamp = 
1345                                ((uint64_t)((uint32_t)seconds) << 32) + \
1346                            (( seconds - (uint32_t)seconds   ) * UINT_MAX);
1347                        return trace->format->seek_erf(trace,timestamp);
1348                }
1349                trace_set_err(trace,
1350                                TRACE_ERR_OPTION_UNAVAIL,
1351                                "Feature unimplemented");
1352                return -1;
1353        }
1354}
1355
1356int trace_seek_timeval(libtrace_t *trace, struct timeval tv)
1357{
1358        if (trace->format->seek_timeval) {
1359                return trace->format->seek_timeval(trace,tv);
1360        }
1361        else {
1362                if (trace->format->seek_erf) {
1363                        uint64_t timestamp = ((((uint64_t)tv.tv_sec) << 32) + \
1364                                (((uint64_t)tv.tv_usec * UINT_MAX)/1000000));
1365                        return trace->format->seek_erf(trace,timestamp);
1366                }
1367                if (trace->format->seek_seconds) {
1368                        double seconds = tv.tv_sec + ((tv.tv_usec * 1.0)/1000000);
1369                        return trace->format->seek_seconds(trace,seconds);
1370                }
1371                trace_set_err(trace,
1372                                TRACE_ERR_OPTION_UNAVAIL,
1373                                "Feature unimplemented");
1374                return -1;
1375        }
1376}
1377
1378char *trace_ether_ntoa(const uint8_t *addr, char *buf)
1379{
1380        char *buf2 = buf;
1381        static char staticbuf[17]={0,};
1382        if (!buf2)
1383                buf2=staticbuf;
1384        sprintf(buf2,"%02x:%02x:%02x:%02x:%02x:%02x",
1385                        addr[0],addr[1],addr[2],
1386                        addr[3],addr[4],addr[5]);
1387        return buf2;
1388}
1389
1390uint8_t *trace_ether_aton(const char *buf, uint8_t *addr)
1391{
1392        uint8_t *buf2 = addr;
1393        unsigned int tmp[6];
1394        static uint8_t staticaddr[6];
1395        if (!buf2)
1396                buf2=staticaddr;
1397        sscanf(buf,"%x:%x:%x:%x:%x:%x",
1398                        &tmp[0],&tmp[1],&tmp[2],
1399                        &tmp[3],&tmp[4],&tmp[5]);
1400        buf2[0]=tmp[0]; buf2[1]=tmp[1]; buf2[2]=tmp[2];
1401        buf2[3]=tmp[3]; buf2[4]=tmp[4]; buf2[5]=tmp[5];
1402        return buf2;
1403}
1404
Note: See TracBrowser for help on using the repository browser.