source: lib/trace.c @ b5cd711

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since b5cd711 was b5cd711, checked in by Shane Alcock <salcock@…>, 15 years ago

Changed all references to "fifo" to "tracefifo" with regards to function names and structures.
Fixes namespace conflicts with libfifo.

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