source: lib/trace.c @ fba4ca0

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since fba4ca0 was fba4ca0, checked in by Daniel Lawson <dlawson@…>, 15 years ago

documentation cleanups, moved libtrace_packet_t definition into libtrace_int.h

  • Property mode set to 100644
File size: 36.2 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
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#include <sys/socket.h>
63#include <sys/un.h>
64#include <sys/mman.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 <err.h>
118
119#define MAXOPTS 1024
120
121#if HAVE_BPF
122/* A type encapsulating a bpf filter
123 * This type covers the compiled bpf filter, as well as the original filter
124 * string
125 *
126 */
127struct libtrace_filter_t {
128        struct bpf_insn *filter;
129        char * filterstring;
130};
131#endif
132
133
134
135struct libtrace_format_t **format_list = 0;
136int format_size = 0;
137int nformats = 0;
138
139void register_format(struct libtrace_format_t *f) {
140//      fprintf(stderr,"Registering input format %s\n",f->name);
141        if (format_list == 0) {
142                format_size = 10;
143                format_list = malloc(sizeof(struct libtrace_format_t *) * format_size);
144        } else if (format_size == nformats) {
145                format_size = format_size + 10;
146                format_list = realloc(format_list,
147                                sizeof(struct libtrace_format_t *) * format_size);
148        }
149        format_list[nformats] = f;
150        nformats++;
151}
152
153/* Prints help information for libtrace
154 *
155 * Function prints out some basic help information regarding libtrace,
156 * and then prints out the help() function registered with each input module
157 */
158void trace_help() {
159        int i = 0;
160        printf("libtrace %s\n",PACKAGE_VERSION);
161        for (i = 0; i < nformats; i++) {
162                if (format_list[i]->help) {
163                        format_list[i]->help();
164                }
165        }
166}
167
168/* Prints error information
169 *
170 * Prints out a descriptive error message for the currently set trace_err value
171 */
172void trace_perror(char *caller) {
173        switch (trace_err.err_num) {
174                case E_BAD_FORMAT:
175                        fprintf(stderr, "%s: No support for format (%s)\n", caller, trace_err.problem);
176                        break;
177                case E_NO_INIT:
178                        fprintf(stderr, "%s: Format (%s) does not have an init_trace function defined\n", caller, trace_err.problem);
179                        break;
180                case E_NO_INIT_OUT:
181                        fprintf(stderr, "%s: Format (%s) does not have an init_output function defined\n", caller, trace_err.problem);
182                        break;
183                case E_URI_LONG:
184                        fprintf(stderr, "%s: uri is too long\n", caller);
185                        break;
186                case E_URI_NOCOLON:
187                        fprintf(stderr, "%s: A uri must contain at least one colon e.g. format:destination\n", caller);
188                        break;
189                case E_INIT_FAILED:
190                        fprintf(stderr, "%s: libtrace failed to initialise (%s)\n",caller,trace_err.problem);
191                       
192                default:
193                        fprintf(stderr, "Unknown errcode %d\n",trace_err.err_num);
194                        break; 
195        }
196        trace_err.err_num = E_NOERROR;
197}
198
199#define RP_BUFSIZE 65536
200#define URI_PROTO_LINE 16
201
202/* Gets the name of the output format for a given output trace.
203 *
204 * @params libtrace     the output trace to get the name of the format for
205 * @returns callee-owned null-terminated char* containing the output format
206 *
207 */
208char *trace_get_output_format(struct libtrace_out_t *libtrace) {
209        char * format = libtrace->format->name;
210
211        return format;
212}
213
214/* Create a trace file from a URI
215 *
216 * @params char * containing a valid libtrace URI
217 * @returns opaque pointer to a libtrace_t
218 *
219 * Valid URI's are:
220 *  erf:/path/to/erf/file
221 *  erf:/path/to/erf/file.gz
222 *  erf:/path/to/rtclient/socket
223 *  erf:-                       (stdin)
224 *  dag:/dev/dagcard
225 *  pcapint:pcapinterface               (eg: pcapint:eth0)
226 *  pcap:/path/to/pcap/file
227 *  pcap:-
228 *  rtclient:hostname
229 *  rtclient:hostname:port
230 *  wag:-
231 *  wag:/path/to/wag/file
232 *  wag:/path/to/wag/file.gz
233 *  wag:/path/to/wag/socket
234 *
235 * If an error occured when attempting to open a trace, NULL is returned
236 * and an error is output to stdout.
237 */
238struct libtrace_t *trace_create(char *uri) {
239        struct libtrace_t *libtrace = malloc(sizeof(struct libtrace_t));
240        char *scan = 0;
241        char *uridata = 0;                 
242        int i = 0;
243        struct stat buf;
244       
245        trace_err.err_num = E_NOERROR;
246       
247        //scan = calloc(sizeof(char),URI_PROTO_LINE);   
248        // parse the URI to determine what sort of event we are dealing with
249       
250        if ((uridata = trace_parse_uri(uri, &scan)) == 0) {
251                return 0;
252        }
253       
254        libtrace->event.tdelta = 0.0;
255
256        libtrace->format = 0;
257        for (i = 0; i < nformats; i++) {
258                if (strlen(scan) == strlen(format_list[i]->name) &&
259                                !strncasecmp(scan,
260                                        format_list[i]->name,
261                                        strlen(scan))) {
262                                libtrace->format=format_list[i];
263                                break;
264                                }
265        }
266        if (libtrace->format == 0) {
267                trace_err.err_num = E_BAD_FORMAT;
268                trace_err.problem = scan;
269                return 0;
270        }
271
272        libtrace->uridata = strdup(uridata);
273
274        // libtrace->format now contains the type of uri
275        // libtrace->uridata contains the appropriate data for this
276       
277        if (libtrace->format->init_input) {
278                if (!libtrace->format->init_input( libtrace)) {
279                        trace_err.err_num = E_INIT_FAILED;
280                        trace_err.problem = scan;
281                        return 0;
282                }
283        } else {
284                trace_err.err_num = E_NO_INIT;
285                trace_err.problem = scan;
286                return 0;
287        }
288       
289
290        libtrace->fifo = create_tracefifo(1048576);
291        assert( libtrace->fifo);
292
293        return libtrace;
294}
295
296/* Creates a "dummy" trace file that has only the format type set.
297 *
298 * @returns opaque pointer to a (sparsely initialised) libtrace_t
299 *
300 * IMPORTANT: Do not attempt to call trace_read_packet or other such functions with
301 * the dummy trace. Its intended purpose is to act as a packet->trace for libtrace_packet_t's
302 * that are not associated with a libtrace_t structure.
303 */
304struct libtrace_t * trace_create_dead (char *uri) {
305        struct libtrace_t *libtrace = malloc(sizeof(struct libtrace_t));
306        char *scan = calloc(sizeof(char),URI_PROTO_LINE);
307        char *uridata;
308        int i;
309       
310        trace_err.err_num = E_NOERROR;
311
312        if((uridata = strchr(uri,':')) == NULL) {
313                strncpy(scan, uri, strlen(uri));
314        } else {
315                strncpy(scan,uri, (uridata - uri));
316        }
317       
318        libtrace->format = 0;   
319       
320        for (i = 0; i < nformats; i++) {
321                if (strlen(scan) == strlen(format_list[i]->name) &&
322                                !strncasecmp(scan,
323                                        format_list[i]->name,
324                                        strlen(scan))) {
325                                libtrace->format=format_list[i];
326                                break;
327                                }
328        }
329        if (libtrace->format == 0) {
330                trace_err.err_num = E_BAD_FORMAT;
331                trace_err.problem = scan;
332                return 0;
333        }
334
335        return libtrace;
336
337}
338
339/** Creates a trace output file from a URI.
340 *
341 * @param uri   the uri string describing the output format and destination
342 * @returns opaque pointer to a libtrace_output_t
343 * @author Shane Alcock
344 *
345 * Valid URI's are:
346 *  - gzerf:/path/to/erf/file.gz
347 *  - gzerf:/path/to/erf/file
348 *  - rtserver:hostname
349 *  - rtserver:hostname:port
350 *
351 *  If an error occured when attempting to open the output trace, NULL is returned
352 *  and trace_errno is set. Use trace_perror() to get more information
353 */
354       
355struct libtrace_out_t *trace_output_create(char *uri) {
356        struct libtrace_out_t *libtrace = malloc(sizeof(struct libtrace_out_t));
357       
358        char *scan = 0;
359        char *uridata = 0;
360        int i;
361
362        trace_err.err_num = E_NOERROR;
363        // parse the URI to determine what sort of event we are dealing with
364
365        if ((uridata = trace_parse_uri(uri, &scan)) == 0) {
366                return 0;
367        }
368       
369       
370        libtrace->format = 0;
371        for (i = 0; i < nformats; i++) {
372                if (strlen(scan) == strlen(format_list[i]->name) &&
373                                !strncasecmp(scan,
374                                        format_list[i]->name,
375                                        strlen(scan))) {
376                                libtrace->format=format_list[i];
377                                break;
378                                }
379        }
380        if (libtrace->format == 0) {
381                trace_err.err_num = E_BAD_FORMAT;
382                trace_err.problem = scan;       
383                return 0;
384        }
385        libtrace->uridata = strdup(uridata);
386
387
388        // libtrace->format now contains the type of uri
389        // libtrace->uridata contains the appropriate data for this
390
391        if (libtrace->format->init_output) {
392                if(!libtrace->format->init_output( libtrace)) {
393                        return 0;
394                }
395        } else {
396                trace_err.err_num = E_NO_INIT_OUT;
397                trace_err.problem = scan;
398                return 0;
399        }
400
401
402        libtrace->fifo = create_tracefifo(1048576);
403        assert( libtrace->fifo);
404
405        return libtrace;
406}
407
408/* Parses an output options string and calls the appropriate function to deal with output options.
409 *
410 * @param libtrace      the output trace object to apply the options to
411 * @param options       the options string
412 * @returns -1 if option configuration failed, 0 otherwise
413 *
414 * @author Shane Alcock
415 */
416int trace_output_config(struct libtrace_out_t *libtrace, char *options) {
417        char *opt_string = 0;
418        char *opt_argv[MAXOPTS];
419        int opt_argc = 0;
420       
421        assert(libtrace);
422       
423        if (!options) {
424                return 0;
425        }
426       
427        asprintf(&opt_string, "%s %s", libtrace->format->name, options);
428        parse_cmd(opt_string, &opt_argc, opt_argv, MAXOPTS);
429       
430        if (libtrace->format->config_output)
431                return libtrace->format->config_output(libtrace, opt_argc, opt_argv);
432
433}
434
435/* Close a trace file, freeing up any resources it may have been using
436 *
437 */
438void trace_destroy(struct libtrace_t *libtrace) {
439        assert(libtrace);
440        libtrace->format->fin_input(libtrace);
441        // need to free things!
442        free(libtrace->uridata);
443        destroy_tracefifo(libtrace->fifo);
444        free(libtrace);
445}
446
447
448void trace_destroy_dead(struct libtrace_t *libtrace) {
449        assert(libtrace);
450        free(libtrace);
451}
452/* Close an output trace file, freeing up any resources it may have been using
453 *
454 * @param libtrace      the output trace file to be destroyed
455 *
456 * @author Shane Alcock
457 * */
458void trace_output_destroy(struct libtrace_out_t *libtrace) {
459        assert(libtrace);
460        libtrace->format->fin_output(libtrace);
461        free(libtrace->uridata);
462        destroy_tracefifo(libtrace->fifo);
463        free(libtrace);
464}
465
466/* Read one packet from the trace into buffer
467 *
468 * @param libtrace      the libtrace opaque pointer
469 * @param packet        the packet opaque pointer
470 * @returns 0 on EOF, negative value on error
471 *
472 */
473int trace_read_packet(struct libtrace_t *libtrace, struct libtrace_packet_t *packet) {
474
475        if (!libtrace) {
476                fprintf(stderr,"You called trace_read_packet() with a NULL libtrace parameter!\n");
477        }
478        assert(libtrace);
479        assert(packet);
480     
481        /* Store the trace we are reading from into the packet opaque
482         * structure */
483        packet->trace = libtrace;
484
485        if (libtrace->format->read_packet) {
486                return libtrace->format->read_packet(libtrace,packet);
487        }
488}
489
490/* Writes a packet to the specified output
491 *
492 * @param libtrace      describes the output format, destination, etc.
493 * @param packet        the packet to be written out
494 * @returns the number of bytes written, -1 if write failed
495 *
496 * @author Shane Alcock
497 * */
498int trace_write_packet(struct libtrace_out_t *libtrace, struct libtrace_packet_t *packet) {
499        assert(libtrace);
500        assert(packet); 
501
502        if (libtrace->format->write_packet) {
503                return libtrace->format->write_packet(libtrace, packet);
504        }
505
506}
507
508/* get a pointer to the link layer
509 * @param packet        a pointer to a libtrace_packet structure
510 *
511 * @returns a pointer to the link layer, or NULL if there is no link layer
512 *
513 * @note you should call trace_get_link_type() to find out what type of link layer this is
514 */
515void *trace_get_link(const struct libtrace_packet_t *packet) {
516        const void *ethptr = 0;
517       
518        if (packet->trace->format->get_link) {
519                ethptr = packet->trace->format->get_link(packet);
520        }
521        return (void *)ethptr;
522}
523
524/* get a pointer to the IP header (if any)
525 * @param packet        a pointer to a libtrace_packet structure
526 *
527 * @returns a pointer to the IP header, or NULL if there is not an IP packet
528 */
529struct libtrace_ip *trace_get_ip(const struct libtrace_packet_t *packet) {
530        struct libtrace_ip *ipptr = 0;
531
532        switch(trace_get_link_type(packet)) {
533                case TRACE_TYPE_80211:
534                        { 
535                               
536                                struct ieee_802_11_header *wifi = trace_get_link(packet);       
537                                if (!wifi) {
538                                        ipptr = NULL;
539                                        break;
540                                }
541
542                                // Data packet?
543                                if (wifi->type != 2) {
544                                        ipptr = NULL;
545                                }
546                                else {
547                                        struct ieee_802_11_payload *eth = (void*)wifi->data;
548                                        ipptr = NULL;
549
550                                        if (eth->type == 0x0008) {
551                                                ipptr=(void*)eth->data;
552                                        } else if (eth->type = 0x0081) {
553                                                // VLAN
554                                                if ((*(uint16_t *)(eth + 16)) == 0x0008) {
555                                                        ipptr = (void*)eth->data + 4;
556                                                }
557                                        }
558                                }
559                        }
560                        break;
561                case TRACE_TYPE_ETH:
562                        {
563                                struct libtrace_ether *eth = 
564                                        trace_get_link(packet);
565                                if (!eth) {
566                                        ipptr = NULL;
567                                        break;
568                                }
569                                ipptr = NULL;
570                               
571                                if (eth->ether_type==0x0008) {
572                                        ipptr = ((void *)eth) + 14;
573                                } else if (eth->ether_type == 0x0081) {
574                                        struct libtrace_8021q *vlanhdr = 
575                                                (struct libtrace_8021q *)eth;
576                                        if (vlanhdr->vlan_ether_type == 0x0008) {
577                                                ipptr = ((void *)eth) + 18;
578                                        }
579                                }
580                                break;
581                        }
582                case TRACE_TYPE_NONE:
583                        ipptr = trace_get_link(packet);
584                        break;
585                case TRACE_TYPE_LINUX_SLL:
586                        {
587                                struct trace_sll_header_t *sll;
588
589                                sll = trace_get_link(packet);
590                                if (!sll) {
591                                        ipptr = NULL;
592                                        break;
593                                }
594                                if (ntohs(sll->protocol)!=0x0800) {
595                                        ipptr = NULL;
596                                }
597                                else {
598                                        ipptr = ((void*)sll)+sizeof(*sll);
599                                }
600                        }
601                        break;
602                case TRACE_TYPE_PFLOG:
603                        {
604                                struct trace_pflog_header_t *pflog;
605                                pflog = trace_get_link(packet);
606                                if (!pflog) {
607                                        ipptr = NULL;
608                                        break;
609                                }
610                                if (pflog->af != AF_INET) {
611                                        ipptr = NULL;
612                                } else {
613                                        ipptr = ((void*)pflog)+sizeof(*pflog);
614                                }
615                        }
616                        break;
617                case TRACE_TYPE_ATM:
618                        {
619                                struct atm_rec *atm = 
620                                        trace_get_link(packet);
621                                // TODO: Find out what ATM does, and return
622                                //       NULL for non IP data
623                                //       Presumably it uses the normal stuff
624                                if (!atm) {
625                                        ipptr = NULL;
626                                        break;
627                                }
628                                ipptr =  (void*)&atm->pload;
629                                break;
630                        }
631                default:
632                        fprintf(stderr,"Don't understand link layer type %i in trace_get_ip()\n",
633                                trace_get_link_type(packet));
634                        ipptr=NULL;
635                        break;
636        }
637
638        return ipptr;
639}
640
641#define SW_IP_OFFMASK 0xff1f
642
643/* get a pointer to the TCP header (if any)
644 * @param packet        a pointer to a libtrace_packet structure
645 *
646 * @returns a pointer to the TCP header, or NULL if there is not a TCP packet
647 */
648struct libtrace_tcp *trace_get_tcp(const struct libtrace_packet_t *packet) {
649        struct libtrace_tcp *tcpptr = 0;
650        struct libtrace_ip *ipptr = 0;
651
652        if(!(ipptr = trace_get_ip(packet))) {
653                return 0;
654        }
655        if ((ipptr->ip_p == 6) && ((ipptr->ip_off & SW_IP_OFFMASK) == 0))  {
656                tcpptr = (struct libtrace_tcp *)((ptrdiff_t)ipptr + (ipptr->ip_hl * 4));
657        }
658        return tcpptr;
659}
660
661/* get a pointer to the TCP header (if any) given a pointer to the IP header
662 * @param ip            The IP header
663 * @param[out] skipped  An output variable of the number of bytes skipped
664 *
665 * @returns a pointer to the TCP header, or NULL if this is not a TCP packet
666 *
667 * Skipped can be NULL, in which case it will be ignored by the program.
668 */
669struct libtrace_tcp *get_tcp_from_ip(const struct libtrace_ip *ip, int *skipped)
670{
671#define SW_IP_OFFMASK 0xff1f
672        struct libtrace_tcp *tcpptr = 0;
673
674        if ((ip->ip_p == 6) && ((ip->ip_off & SW_IP_OFFMASK) == 0))  {
675                tcpptr = (struct libtrace_tcp *)((ptrdiff_t)ip+ (ip->ip_hl * 4));
676        }
677
678        if (skipped)
679                *skipped=(ip->ip_hl*4);
680
681        return tcpptr;
682}
683
684/* get a pointer to the UDP header (if any)
685 * @param packet        a pointer to a libtrace_packet structure
686 *
687 * @returns a pointer to the UDP header, or NULL if this is not a UDP packet
688 */
689struct libtrace_udp *trace_get_udp(const struct libtrace_packet_t *packet) {
690        struct libtrace_udp *udpptr = 0;
691        struct libtrace_ip *ipptr = 0;
692       
693        if(!(ipptr = trace_get_ip(packet))) {
694                return 0;
695        }
696        if ((ipptr->ip_p == 17) && ((ipptr->ip_off & SW_IP_OFFMASK) == 0)) {
697                udpptr = (struct libtrace_udp *)((ptrdiff_t)ipptr + (ipptr->ip_hl * 4));
698        }
699
700        return udpptr;
701}
702
703/* get a pointer to the UDP header (if any) given a pointer to the IP header
704 * @param ip            The IP header
705 * @param[out] skipped  An output variable of the number of bytes skipped
706 *
707 * @returns a pointer to the UDP header, or NULL if this is not a UDP packet
708 *
709 * Skipped can be NULL, in which case it will be ignored by the program.
710 */
711struct libtrace_udp *get_udp_from_ip(const struct libtrace_ip *ip, int *skipped)
712{
713        struct libtrace_udp *udpptr = 0;
714
715        if ((ip->ip_p == 6) && ((ip->ip_off & SW_IP_OFFMASK) == 0))  {
716                udpptr = (struct libtrace_udp *)((ptrdiff_t)ip+ (ip->ip_hl * 4));
717        }
718
719        if (skipped)
720                *skipped=(ip->ip_hl*4);
721
722        return udpptr;
723}
724
725
726/* get a pointer to the ICMP header (if any)
727 * @param packet        a pointer to a libtrace_packet structure
728 *
729 * @returns a pointer to the ICMP header, or NULL if this is not a ICMP packet
730 */
731struct libtrace_icmp *trace_get_icmp(const struct libtrace_packet_t *packet) {
732        struct libtrace_icmp *icmpptr = 0;
733        struct libtrace_ip *ipptr = 0;
734       
735        if(!(ipptr = trace_get_ip(packet))) {
736                return 0;
737        }
738        if ((ipptr->ip_p == 1)&& ((ipptr->ip_off & SW_IP_OFFMASK) == 0 )){
739                icmpptr = (struct libtrace_icmp *)((ptrdiff_t)ipptr + (ipptr->ip_hl * 4));
740        }
741        return icmpptr;
742}
743
744/* get a pointer to the ICMP header (if any) given a pointer to the IP header
745 * @param ip            The IP header
746 * @param[out] skipped  An output variable of the number of bytes skipped
747 *
748 * @returns a pointer to the ICMP header, or NULL if this is not a ICMP packet
749 *
750 * Skipped can be NULL, in which case it will be ignored by the program.
751 */
752struct libtrace_icmp *get_icmp_from_ip(struct libtrace_ip *ip, int *skipped)
753{
754        struct libtrace_icmp *icmpptr = 0;
755
756        if ((ip->ip_p == 6) && ((ip->ip_off & SW_IP_OFFMASK) == 0))  {
757                icmpptr = (struct libtrace_icmp *)((ptrdiff_t)ip+ (ip->ip_hl * 4));
758        }
759
760        if (skipped)
761                *skipped=(ip->ip_hl*4);
762
763        return icmpptr;
764}
765/* parse an ip or tcp option
766 * @param[in,out] ptr   the pointer to the current option
767 * @param[in,out] len   the length of the remaining buffer
768 * @param[out] type     the type of the option
769 * @param[out] optlen   the length of the option
770 * @param[out] data     the data of the option
771 *
772 * @returns bool true if there is another option (and the fields are filled in)
773 *               or false if this was the last option.
774 *
775 * This updates ptr to point to the next option after this one, and updates
776 * len to be the number of bytes remaining in the options area.  Type is updated
777 * to be the code of this option, and data points to the data of this option,
778 * with optlen saying how many bytes there are.
779 *
780 * @note Beware of fragmented packets.
781 * @author Perry Lorier
782 */
783int trace_get_next_option(unsigned char **ptr,int *len,
784                        unsigned char *type,
785                        unsigned char *optlen,
786                        unsigned char **data)
787{
788        if (*len<=0)
789                return 0;
790        *type=**ptr;
791        switch(*type) {
792                case 0: /* End of options */
793                        return 0;
794                case 1: /* Pad */
795                        (*ptr)++;
796                        (*len)--;
797                        return 1;
798                default:
799                        *optlen = *(*ptr+1);
800                        if (*optlen<2)
801                                return 0; // I have no idea wtf is going on
802                                          // with these packets
803                        (*len)-=*optlen;
804                        (*data)=(*ptr+2);
805                        (*ptr)+=*optlen;
806                        if (*len<0)
807                                return 0;
808                        return 1;
809        }
810        assert(0);
811}
812
813
814/* Get the current time in DAG time format
815 * @param packet        a pointer to a libtrace_packet structure
816 * @returns a 64 bit timestamp in DAG ERF format (upper 32 bits are the seconds
817 * past 1970-01-01, the lower 32bits are partial seconds)
818 * @author Daniel Lawson
819 */ 
820uint64_t trace_get_erf_timestamp(const struct libtrace_packet_t *packet) {
821        uint64_t timestamp = 0;
822        double seconds = 0.0;
823        struct timeval ts;
824
825        if (packet->trace->format->get_erf_timestamp) {
826                // timestamp -> timestamp
827                timestamp = packet->trace->format->get_erf_timestamp(packet);
828        } else if (packet->trace->format->get_timeval) {
829                // timeval -> timestamp
830                ts = packet->trace->format->get_timeval(packet);
831                timestamp = ((((uint64_t)ts.tv_sec) << 32) + \
832                                (((uint64_t)ts.tv_usec * UINT_MAX)/1000000));
833        } else if (packet->trace->format->get_seconds) {
834                // seconds -> timestamp
835                seconds = packet->trace->format->get_seconds(packet);
836                timestamp = ((uint64_t)((uint32_t)seconds) << 32) + \
837                            (( seconds - (uint32_t)seconds   ) * UINT_MAX);
838        }
839        return timestamp;
840}
841
842/* Get the current time in struct timeval
843 * @param packet        a pointer to a libtrace_packet structure
844 *
845 * @returns time that this packet was seen in a struct timeval
846 * @author Daniel Lawson
847 * @author Perry Lorier
848 */ 
849struct timeval trace_get_timeval(const struct libtrace_packet_t *packet) {
850        struct timeval tv;
851        uint64_t ts = 0;
852        double seconds = 0.0;
853        if (packet->trace->format->get_timeval) {
854                // timeval -> timeval
855                tv = packet->trace->format->get_timeval(packet);
856        } else if (packet->trace->format->get_erf_timestamp) {
857                // timestamp -> timeval
858                ts = packet->trace->format->get_erf_timestamp(packet);
859#if __BYTE_ORDER == __BIG_ENDIAN
860                tv.tv_sec = ts & 0xFFFFFFFF;
861#elif __BYTE_ORDER == __LITTLE_ENDIAN
862                tv.tv_sec = ts >> 32;
863#else
864#error "What on earth are you running this on?"
865#endif
866                ts = (1000000 * (ts & 0xffffffffULL));
867                ts += (ts & 0x80000000ULL) << 1;
868                tv.tv_usec = ts >> 32;
869                if (tv.tv_usec >= 1000000) {
870                        tv.tv_usec -= 1000000;
871                        tv.tv_sec += 1;
872                }
873        } else if (packet->trace->format->get_seconds) {
874                // seconds -> timeval
875                seconds = packet->trace->format->get_seconds(packet);
876                tv.tv_sec = (uint32_t)seconds;
877                tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
878        }
879
880        return tv;
881}
882
883/* Get the current time in floating point seconds
884 * @param packet        a pointer to a libtrace_packet structure
885 * @returns time that this packet was seen in 64bit floating point seconds
886 * @author Perry Lorier
887 */ 
888double trace_get_seconds(const struct libtrace_packet_t *packet) {
889        double seconds;
890        uint64_t ts;
891        struct timeval tv;
892       
893        if (packet->trace->format->get_seconds) {
894                // seconds->seconds
895                seconds = packet->trace->format->get_seconds(packet);
896        } else if (packet->trace->format->get_erf_timestamp) {
897                // timestamp -> seconds
898                ts = packet->trace->format->get_erf_timestamp(packet);
899                seconds =  (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
900        } else if (packet->trace->format->get_timeval) {
901                // timeval -> seconds
902                tv = packet->trace->format->get_timeval(packet);
903                seconds = tv.tv_sec + ((tv.tv_usec * UINT_MAX * 1.0)/1000000);
904        }
905
906        return seconds;
907}
908
909/* Get the size of the packet in the trace
910 * @param packet the packet opaque pointer
911 * @returns the size of the packet in the trace
912 * @author Perry Lorier
913 * @note Due to this being a header capture, or anonymisation, this may not
914 * be the same size as the original packet.  See trace_get_wire_length() for the
915 * original size of the packet.
916 * @note This can (and often is) different for different packets in a trace!
917 * @par
918 *  This is sometimes called the "snaplen".
919 */ 
920int trace_get_capture_length(const struct libtrace_packet_t *packet) {
921
922        if (packet->trace->format->get_capture_length) {
923                return packet->trace->format->get_capture_length(packet);
924        }
925        return -1;
926}
927       
928/* Get the size of the packet as it was seen on the wire.
929 * @param packet        a pointer to a libtrace_packet structure
930 *
931 * @returns the size of the packet as it was on the wire.
932 * @author Perry Lorier
933 * @author Daniel Lawson
934 * @note Due to the trace being a header capture, or anonymisation this may
935 * not be the same as the Capture Len.
936 */ 
937int trace_get_wire_length(const struct libtrace_packet_t *packet){
938        if (packet->trace->format->get_wire_length) {
939                return packet->trace->format->get_wire_length(packet);
940        }
941        return -1;
942
943}
944
945/* Get the type of the link layer
946 * @param packet        a pointer to a libtrace_packet structure
947 * @returns libtrace_linktype_t
948 * @author Perry Lorier
949 * @author Daniel Lawson
950 */
951libtrace_linktype_t trace_get_link_type(const struct libtrace_packet_t *packet ) {
952        if (packet->trace->format->get_link_type) {
953                return packet->trace->format->get_link_type(packet);
954        }
955        return -1;
956}
957
958/* Get the source MAC addres
959 * @param packet        a pointer to a libtrace_packet structure
960 * @returns a pointer to the source mac, (or NULL if there is no source MAC)
961 * @author Perry Lorier
962 */
963uint8_t *trace_get_source_mac(const struct libtrace_packet_t *packet) {
964        void *link = trace_get_link(packet);
965        struct ieee_802_11_header *wifi = link;
966        struct libtrace_ether *ethptr = link;
967        if (!link)
968                return NULL;
969        switch (trace_get_link_type(packet)) {
970                case TRACE_TYPE_80211:
971                        return (uint8_t*)&wifi->mac2;
972                case TRACE_TYPE_ETH:
973                        return (uint8_t*)&ethptr->ether_shost;
974                default:
975                        fprintf(stderr,"Not implemented\n");
976                        assert(0);
977        }
978}
979
980/* Get the destination MAC addres
981 * @param packet a libtrace_packet pointer
982 * @returns a pointer to the destination mac, (or NULL if there is no
983 * destination MAC)
984 * @author Perry Lorier
985 */
986uint8_t *trace_get_destination_mac(const struct libtrace_packet_t *packet) {
987        void *link = trace_get_link(packet);
988        struct ieee_802_11_header *wifi = link;
989        struct libtrace_ether *ethptr = link;
990        if (!link)
991                return NULL;
992        switch (trace_get_link_type(packet)) {
993                case TRACE_TYPE_80211:
994                        return (uint8_t*)&wifi->mac1;
995                case TRACE_TYPE_ETH:
996                        return (uint8_t*)&ethptr->ether_dhost;
997                default:
998                        fprintf(stderr,"Not implemented\n");
999                        assert(0);
1000        }
1001}
1002
1003
1004/* process a libtrace event
1005 * @param trace the libtrace opaque pointer
1006 * @param packet the libtrace_packet opaque pointer
1007 * @returns
1008 *  TRACE_EVENT_IOWAIT  Waiting on I/O on fd
1009 *  TRACE_EVENT_SLEEP   Next event in seconds
1010 *  TRACE_EVENT_PACKET  Packet arrived in buffer with size size
1011 *  TRACE_EVENT_TERMINATE Trace terminated (perhaps with an error condition)
1012 * FIXME currently keeps a copy of the packet inside the trace pointer,
1013 * which in turn is stored inside the new packet object...
1014 * @author Perry Lorier
1015 */
1016struct libtrace_eventobj_t trace_event(struct libtrace_t *trace, 
1017                struct libtrace_packet_t *packet) {
1018        struct libtrace_eventobj_t event;
1019
1020        if (!trace) {
1021                fprintf(stderr,"You called trace_event() with a NULL trace object!\n");
1022        }
1023        assert(trace);
1024        assert(packet);
1025
1026        /* Store the trace we are reading from into the packet opaque
1027         * structure */
1028        packet->trace = trace;
1029
1030        if (packet->trace->format->trace_event) {
1031                return packet->trace->format->trace_event(trace,packet);
1032        } else {
1033                return event;
1034        }
1035
1036}
1037
1038/* setup a BPF filter
1039 * @param filterstring a char * containing the bpf filter string
1040 * @returns opaque pointer pointer to a libtrace_filter_t object
1041 * @author Daniel Lawson
1042 */
1043struct libtrace_filter_t *trace_bpf_setfilter(const char *filterstring) {
1044#if HAVE_BPF
1045        struct libtrace_filter_t *filter = malloc(sizeof(struct libtrace_filter_t));
1046        filter->filterstring = strdup(filterstring);
1047        filter->filter = 0;
1048        return filter;
1049#else
1050        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1051        return 0;
1052#endif
1053}
1054
1055/* apply a BPF filter
1056 * @param filter the filter opaque pointer
1057 * @param packet the packet opaque pointer
1058 * @returns 0 if the filter fails, 1 if it succeeds
1059 * @author Daniel Lawson
1060 */
1061int trace_bpf_filter(struct libtrace_filter_t *filter,
1062                        const struct libtrace_packet_t *packet) {
1063#if HAVE_BPF
1064        void *linkptr = 0;
1065        int clen = 0;
1066        assert(filter);
1067        assert(packet);
1068        linkptr = trace_get_link(packet);
1069        if (!linkptr) {
1070                return 0;
1071        }
1072       
1073        clen = trace_get_capture_length(packet);
1074       
1075
1076        if (filter->filterstring && ! filter->filter) {
1077                pcap_t *pcap;
1078                struct bpf_program bpfprog;
1079
1080                switch (trace_get_link_type(packet)) {
1081                        case TRACE_TYPE_ETH:
1082                                pcap = (pcap_t *)pcap_open_dead(DLT_EN10MB, 1500);
1083                                break;
1084#ifdef DLT_LINUX_SLL
1085                        case TRACE_TYPE_LINUX_SLL:
1086                                pcap = (pcap_t *)pcap_open_dead(DLT_LINUX_SLL, 1500);
1087                                break;
1088#endif
1089#ifdef DLT_PFLOG
1090                        case TRACE_TYPE_PFLOG:
1091                                pcap = (pcap_t *)pcap_open_dead(DLT_PFLOG, 1500);
1092                                break;
1093#endif
1094                        default:
1095                                printf("only works for ETH and LINUX_SLL (ppp) at the moment\n");
1096                                assert(0);
1097                }               
1098
1099                // build filter
1100                if (pcap_compile( pcap, &bpfprog, filter->filterstring, 1, 0)) {
1101                        printf("bpf compilation error: %s: %s\n", 
1102                                pcap_geterr(pcap),filter->filterstring);
1103                        assert(0);
1104                }
1105                pcap_close(pcap);
1106                filter->filter = bpfprog.bf_insns;     
1107        }
1108
1109        assert(filter->filter);
1110        return bpf_filter(filter->filter, linkptr, clen, clen);
1111#else
1112        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1113        return 0;
1114#endif
1115}
1116
1117/* Set the direction flag, if it has one
1118 * @param packet the packet opaque pointer
1119 * @param direction the new direction (0,1,2,3)
1120 * @returns a signed value containing the direction flag, or -1 if this is not supported
1121 * @author Daniel Lawson
1122 */
1123int8_t trace_set_direction(struct libtrace_packet_t *packet, int8_t direction) {
1124        assert(packet);
1125        if (packet->trace->format->set_direction) {
1126                return packet->trace->format->set_direction(packet,direction);
1127        }
1128        return -1;
1129}
1130
1131/* Get the direction flag, if it has one
1132 * @param packet a pointer to a libtrace_packet structure
1133 * @returns a signed value containing the direction flag, or -1 if this is not supported
1134 * The direction is defined as 0 for packets originating locally (ie, outbound)
1135 * and 1 for packets originating remotely (ie, inbound).
1136 * Other values are possible, which might be overloaded to mean special things
1137 * for a special trace.
1138 * @author Daniel Lawson
1139 */
1140int8_t trace_get_direction(const struct libtrace_packet_t *packet) {
1141        assert(packet);
1142        if (packet->trace->format->get_direction) {
1143                return packet->trace->format->get_direction(packet);
1144        }
1145        return -1;
1146}
1147
1148struct ports_t {
1149        uint16_t src;
1150        uint16_t dst;
1151};
1152
1153/* Return the client port
1154 */
1155uint16_t trace_get_source_port(const struct libtrace_packet_t *packet)
1156{
1157        struct libtrace_ip *ip = trace_get_ip(packet);
1158        struct ports_t *port;
1159        if (6 != ip->ip_p
1160          && 17 != ip->ip_p)
1161                return 0;
1162        if (0 != (ip->ip_off & SW_IP_OFFMASK))
1163                return 0;
1164
1165        port = (struct ports_t *)((ptrdiff_t)ip + (ip->ip_hl * 4));
1166
1167        return ntohs(port->src);
1168}
1169
1170/* Same as get_source_port except use the destination port */
1171uint16_t trace_get_destination_port(const struct libtrace_packet_t *packet)
1172{
1173        struct libtrace_ip *ip = trace_get_ip(packet);
1174        struct ports_t *port;
1175
1176        if (6 != ip->ip_p
1177          && 17 != ip->ip_p)
1178                return 0;
1179
1180        if (0 != (ip->ip_off & SW_IP_OFFMASK))
1181                return 0;
1182
1183        port = (struct ports_t *)((ptrdiff_t)ip + (ip->ip_hl * 4));
1184
1185        return ntohs(port->dst);
1186}
1187
1188#define ROOT_SERVER(x) ((x) < 512)
1189#define ROOT_CLIENT(x) ((512 <= (x)) && ((x) < 1024))
1190#define NONROOT_SERVER(x) ((x) >= 5000)
1191#define NONROOT_CLIENT(x) ((1024 <= (x)) && ((x) < 5000))
1192#define DYNAMIC(x) ((49152 < (x)) && ((x) < 65535))
1193#define SERVER(x) ROOT_SERVER(x) || NONROOT_SERVER(x)
1194#define CLIENT(x) ROOT_CLIENT(x) || NONROOT_CLIENT(x)
1195
1196/* Attempt to deduce the 'server' port
1197 * @param protocol the IP protocol (eg, 6 or 17 for TCP or UDP)
1198 * @param source the TCP or UDP source port
1199 * @param dest the TCP or UDP destination port
1200 * @returns a hint as to which port is the server port
1201 * @author Daniel Lawson
1202 */
1203int8_t trace_get_server_port(uint8_t protocol, uint16_t source, uint16_t dest) {
1204        /*
1205         * * If the ports are equal, return DEST
1206         * * Check for well-known ports in the given protocol
1207         * * Root server ports: 0 - 511
1208         * * Root client ports: 512 - 1023
1209         * * non-root client ports: 1024 - 4999
1210         * * non-root server ports: 5000+
1211         * * Check for static ranges: 1024 - 49151
1212         * * Check for dynamic ranges: 49152 - 65535
1213         * * flip a coin.
1214         */
1215
1216        uint16_t server, client;
1217
1218        /* equal */
1219        if (source == client)
1220                return USE_DEST;
1221
1222        /* root server port, 0 - 511 */
1223        if (ROOT_SERVER(source) && ROOT_SERVER(dest)) {
1224                if (source < dest)
1225                        return USE_SOURCE;
1226                return USE_DEST;
1227        }
1228
1229        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1230                return USE_SOURCE;
1231        if (!ROOT_SERVER(source) && ROOT_SERVER(dest))
1232                return USE_DEST;
1233
1234        /* non-root server */
1235        if (NONROOT_SERVER(source) && NONROOT_SERVER(dest)) {
1236                if (source < dest)
1237                        return USE_SOURCE;
1238                return USE_DEST;
1239        }
1240        if (NONROOT_SERVER(source) && !NONROOT_SERVER(dest))
1241                return USE_SOURCE;
1242        if (!NONROOT_SERVER(source) && NONROOT_SERVER(dest))
1243                return USE_DEST;
1244
1245        /* root client */
1246        if (ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1247                if (source < dest)
1248                        return USE_SOURCE;
1249                return USE_DEST;
1250        }
1251        if (ROOT_CLIENT(source) && !ROOT_CLIENT(dest)) {
1252                /* prefer root-client over nonroot-client */
1253                if (NONROOT_CLIENT(dest))
1254                        return USE_SOURCE;
1255                return USE_DEST;
1256        }
1257        if (!ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1258                /* prefer root-client over nonroot-client */
1259                if (NONROOT_CLIENT(source))
1260                        return USE_DEST;
1261                return USE_SOURCE;
1262        }
1263       
1264        /* nonroot client */
1265        if (NONROOT_CLIENT(source) && NONROOT_CLIENT(dest)) {
1266                if (source < dest) 
1267                        return USE_SOURCE;
1268                return USE_DEST;
1269        }
1270        if (NONROOT_CLIENT(source) && !NONROOT_CLIENT(dest))
1271                return USE_DEST;
1272        if (!NONROOT_CLIENT(source) && NONROOT_CLIENT(dest))
1273                return USE_SOURCE;
1274
1275        /* dynamic range */
1276        if (DYNAMIC(source) && DYNAMIC(dest))
1277                if (source < dest)
1278                        return USE_SOURCE;
1279                return USE_DEST;
1280        if (DYNAMIC(source) && !DYNAMIC(dest))
1281                return USE_DEST;
1282        if (!DYNAMIC(source) && DYNAMIC(dest))
1283                return USE_SOURCE;
1284        /*
1285        if (SERVER(source) && CLIENT(dest))
1286                return USE_SOURCE;
1287       
1288        if (SERVER(dest) && CLIENT(source))
1289                return USE_DEST;
1290        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1291                return USE_SOURCE;
1292        if (ROOT_SERVER(dest) && !ROOT_SERVER(source))
1293                return USE_DEST;
1294        */
1295        // failing that test...
1296        if (source < dest) {
1297                return USE_SOURCE;
1298        } 
1299        return USE_DEST;
1300       
1301}
1302
1303/* Truncate the packet at the suggested length
1304 * @param packet        the packet opaque pointer
1305 * @param size          the new length of the packet
1306 * @returns the new length of the packet, or the original length of the
1307 * packet if unchanged
1308 * NOTE: len refers to the network-level payload of the packet, and not
1309 * any capture headers included as well. For example, to truncate a packet
1310 * after the IP header, set scan to sizeof(ethernet_header) + sizeof(ip_header)
1311 * @author Daniel Lawson
1312 */
1313size_t trace_set_capture_length(struct libtrace_packet_t *packet, size_t size) {
1314        assert(packet);
1315
1316        if (size > packet->size) {
1317                // can't make a packet larger
1318                return packet->size;
1319        }
1320        if (packet->trace->format->truncate_packet) {
1321                return packet->trace->format->truncate_packet(packet,size);
1322        }
1323        return -1;
1324}
1325
1326char * trace_parse_uri(char *uri, char **format) {
1327        char *uridata = 0;
1328       
1329        *format = calloc(sizeof(char), URI_PROTO_LINE);
1330       
1331        if((uridata = strchr(uri,':')) == NULL) {
1332                // badly formed URI - needs a :
1333                trace_err.err_num = E_URI_NOCOLON;
1334                return 0;
1335        }
1336
1337        if ((uridata - uri) > URI_PROTO_LINE) {
1338                // badly formed URI - uri type is too long
1339                trace_err.err_num = E_URI_LONG;
1340                return 0;
1341        }
1342
1343        strncpy(*format ,uri, (uridata - uri));
1344        // push uridata past the delimiter
1345        uridata++;
1346        return uridata;
1347}
1348       
Note: See TracBrowser for help on using the repository browser.