source: lib/trace.c @ 7b4b5ab

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

Remove unused header file

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