source: lib/trace.c @ 0c222cc

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

Catch common bug and report it to the user

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