source: lib/trace.c @ 979a84f4

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since 979a84f4 was 979a84f4, checked in by Shane Alcock <salcock@…>, 10 years ago
  • We now cache the wire length as well
  • If we're going to cache the link type, we should probably use it whenever we call trace_get_link_type()!
  • Property mode set to 100644
File size: 53.1 KB
Line 
1/*
2 * This file is part of libtrace
3 *
4 * Copyright (c) 2007,2008,2009,2010 The University of Waikato, Hamilton,
5 * New Zealand.
6 *
7 * Authors: Daniel Lawson
8 *          Perry Lorier
9 *          Shane Alcock
10 *         
11 * All rights reserved.
12 *
13 * This code has been developed by the University of Waikato WAND
14 * research group. For further information please see http://www.wand.net.nz/
15 *
16 * libtrace is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
20 *
21 * libtrace is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with libtrace; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
29 *
30 * $Id$
31 *
32 */
33
34
35#define _GNU_SOURCE
36#include "common.h"
37#include "config.h"
38#include <assert.h>
39#include <errno.h>
40#include <fcntl.h>
41#include <stdio.h>
42#include <stdlib.h>
43#include <string.h>
44#include <sys/stat.h>
45#include <sys/types.h>
46#ifndef WIN32
47#include <sys/socket.h>
48#endif
49#include <stdarg.h>
50
51#ifdef HAVE_LIMITS_H
52#  include <limits.h>
53#endif
54
55#ifdef HAVE_SYS_LIMITS_H
56#  include <sys/limits.h>
57#endif
58
59#ifdef HAVE_NET_IF_ARP_H
60#  include <net/if_arp.h>
61#endif
62
63#ifdef HAVE_NET_IF_H
64#  include <net/if.h>
65#endif
66
67#ifdef HAVE_NETINET_IN_H
68#  include <netinet/in.h>
69#endif
70
71#ifdef HAVE_NET_ETHERNET_H
72#  include <net/ethernet.h>
73#endif
74
75#ifdef HAVE_NETINET_IF_ETHER_H
76#  include <netinet/if_ether.h>
77#endif
78
79#include <time.h>
80#ifdef WIN32
81#include <sys/timeb.h>
82#endif
83
84#include "libtrace.h"
85#include "libtrace_int.h"
86
87#ifdef HAVE_PCAP_BPF_H
88#  include <pcap-bpf.h>
89#else
90#  ifdef HAVE_NET_BPF_H
91#    include <net/bpf.h>
92#  endif
93#endif
94
95
96#include "libtrace_int.h"
97#include "format_helper.h"
98#include "rt_protocol.h"
99
100#define MAXOPTS 1024
101
102/* This file contains much of the implementation of the libtrace API itself. */
103
104static struct libtrace_format_t *formats_list = NULL;
105
106int libtrace_halt = 0;
107
108/* strncpy is not assured to copy the final \0, so we
109 * will use our own one that does
110 */
111static void xstrncpy(char *dest, const char *src, size_t n)
112{
113        strncpy(dest,src,n);
114        dest[n]='\0';
115}
116 
117static char *xstrndup(const char *src,size_t n)
118{       
119        char *ret=(char*)malloc(n+1);
120        if (ret==NULL) {
121                fprintf(stderr,"Out of memory");
122                exit(EXIT_FAILURE);
123        }
124        xstrncpy(ret,src,n);
125        return ret;
126}
127
128
129/* call all the constructors if they haven't yet all been called */
130static void trace_init(void)
131{
132        if (!formats_list) {
133                duck_constructor();
134                erf_constructor();
135                tsh_constructor();
136                legacy_constructor();
137                atmhdr_constructor();
138#ifdef HAVE_NETPACKET_PACKET_H
139                linuxnative_constructor();
140#endif
141#ifdef HAVE_LIBPCAP
142                pcap_constructor();
143#endif
144#if HAVE_DECL_BIOCSETIF
145                bpf_constructor();
146#endif
147                pcapfile_constructor();
148                rt_constructor();
149#ifdef HAVE_DAG
150                dag_constructor();
151#endif
152        }
153}
154
155/* Prints help information for libtrace
156 *
157 * Function prints out some basic help information regarding libtrace,
158 * and then prints out the help() function registered with each input module
159 */
160DLLEXPORT void trace_help(void) {
161        struct libtrace_format_t *tmp;
162        trace_init();
163        printf("libtrace %s\n\n",PACKAGE_VERSION);
164        printf("Following this are a list of the format modules supported in this build of libtrace\n\n");
165        for(tmp=formats_list;tmp;tmp=tmp->next) {
166                if (tmp->help)
167                        tmp->help();
168        }
169}
170
171#define URI_PROTO_LINE 16U
172
173/* Try to guess which format module is appropriate for a given trace file or
174 * device */
175static void guess_format(libtrace_t *libtrace, const char *filename)
176{
177        struct libtrace_format_t *tmp;
178       
179        /* Try and guess based on filename */
180        for(tmp = formats_list; tmp; tmp=tmp->next) {
181                if (tmp->probe_filename && tmp->probe_filename(filename)) {
182                        libtrace->format = tmp;
183                        libtrace->uridata = strdup(filename);
184                        return;
185                }
186        }
187
188        libtrace->io = wandio_create(filename);
189        if (!libtrace->io)
190                return;
191
192        /* Try and guess based on file magic */
193        for(tmp = formats_list; tmp; tmp=tmp->next) {
194                if (tmp->probe_magic && tmp->probe_magic(libtrace->io)) {
195                        libtrace->format = tmp;
196                        libtrace->uridata = strdup(filename);
197                        return;
198                }
199        }
200       
201        /* Oh well */
202        return;
203}
204
205/* Creates an input trace from a URI
206 *
207 * @params char * containing a valid libtrace URI
208 * @returns opaque pointer to a libtrace_t
209 *
210 * Some valid URI's are:
211 *  erf:/path/to/erf/file
212 *  erf:/path/to/erf/file.gz
213 *  erf:-                       (stdin)
214 *  dag:/dev/dagcard
215 *  pcapint:pcapinterface               (eg: pcapint:eth0)
216 *  pcapfile:/path/to/pcap/file
217 *  pcapfile:-
218 *  int:interface                       (eg: int:eth0) only on Linux
219 *  rt:hostname
220 *  rt:hostname:port
221 *
222 * If an error occured when attempting to open a trace, NULL is returned
223 * and an error is output to stdout.
224 */
225DLLEXPORT libtrace_t *trace_create(const char *uri) {
226        libtrace_t *libtrace = 
227                        (libtrace_t *)malloc(sizeof(libtrace_t));
228        char *scan = 0;
229        const char *uridata = 0;                 
230
231        trace_init();
232
233        assert(uri && "Passing NULL to trace_create makes me a very sad program");
234
235        if (!libtrace) {
236                /* Out of memory */
237                return NULL;
238        }
239       
240        libtrace->err.err_num = TRACE_ERR_NOERROR;
241        libtrace->format=NULL;
242       
243        libtrace->event.tdelta = 0.0;
244        libtrace->event.packet = NULL;
245        libtrace->event.psize = 0;
246        libtrace->event.trace_last_ts = 0.0;
247        libtrace->event.waiting = false;
248        libtrace->filter = NULL;
249        libtrace->snaplen = 0;
250        libtrace->started=false;
251        libtrace->uridata = NULL;
252        libtrace->io = NULL;
253        libtrace->filtered_packets = 0;
254        libtrace->accepted_packets = 0;
255
256        /* Parse the URI to determine what sort of trace we are dealing with */
257        if ((uridata = trace_parse_uri(uri, &scan)) == 0) {
258                /* Could not parse the URI nicely */
259                guess_format(libtrace,uri);
260                if (!libtrace->format) {
261                        trace_set_err(libtrace,TRACE_ERR_BAD_FORMAT,"Unable to guess format (%s)",uri);
262                        return libtrace;
263                }
264        }
265        else {
266                struct libtrace_format_t *tmp;
267
268                /* Find a format that matches the first part of the URI */
269                for (tmp=formats_list;tmp;tmp=tmp->next) {
270                        if (strlen(scan) == strlen(tmp->name) &&
271                                        strncasecmp(scan, tmp->name, strlen(scan)) == 0
272                                        ) {
273                                libtrace->format=tmp;
274                                break;
275                        }
276                }
277
278                if (libtrace->format == 0) {
279                        trace_set_err(libtrace, TRACE_ERR_BAD_FORMAT,
280                                        "Unknown format (%s)",scan);
281                        return libtrace;
282                }
283
284                libtrace->uridata = strdup(uridata);
285        }
286        /* libtrace->format now contains the type of uri
287         * libtrace->uridata contains the appropriate data for this
288         */
289       
290        /* Call the init_input function for the matching capture format */ 
291        if (libtrace->format->init_input) {
292                int err=libtrace->format->init_input(libtrace);
293                assert (err==-1 || err==0);
294                if (err==-1) {
295                        /* init_input should call trace_set_err to set
296                         * the error message
297                         */
298                        return libtrace;
299                }
300        } else {
301                trace_set_err(libtrace,TRACE_ERR_UNSUPPORTED,
302                                "Format does not support input (%s)",scan);
303                return libtrace;
304        }
305       
306        if (scan)
307                free(scan);
308        libtrace->err.err_num=TRACE_ERR_NOERROR;
309        libtrace->err.problem[0]='\0';
310        return libtrace;
311}
312
313/* Creates a "dummy" trace file that has only the format type set.
314 *
315 * @returns opaque pointer to a (sparsely initialised) libtrace_t
316 *
317 * IMPORTANT: Do not attempt to call trace_read_packet or other such functions
318 * with the dummy trace. Its intended purpose is to act as a packet->trace for
319 * libtrace_packet_t's that are not associated with a libtrace_t structure.
320 */
321DLLEXPORT libtrace_t * trace_create_dead (const char *uri) {
322        libtrace_t *libtrace = (libtrace_t *) malloc(sizeof(libtrace_t));
323        char *scan = (char *)calloc(sizeof(char),URI_PROTO_LINE);
324        char *uridata;
325        struct libtrace_format_t *tmp;
326
327        trace_init();
328       
329        libtrace->err.err_num = TRACE_ERR_NOERROR;
330
331        if((uridata = strchr(uri,':')) == NULL) {
332                xstrncpy(scan, uri, strlen(uri));
333        } else {
334                xstrncpy(scan,uri, (size_t)(uridata - uri));
335        }
336       
337        libtrace->err.err_num = TRACE_ERR_NOERROR;
338        libtrace->format=NULL;
339       
340        libtrace->event.tdelta = 0.0;
341        libtrace->event.packet = NULL;
342        libtrace->event.psize = 0;
343        libtrace->event.trace_last_ts = 0.0;
344        libtrace->filter = NULL;
345        libtrace->snaplen = 0;
346        libtrace->started=false;
347        libtrace->uridata = NULL;
348        libtrace->io = NULL;
349        libtrace->filtered_packets = 0;
350       
351        for(tmp=formats_list;tmp;tmp=tmp->next) {
352                if (strlen(scan) == strlen(tmp->name) &&
353                                !strncasecmp(scan,
354                                        tmp->name,
355                                        strlen(scan))) {
356                                libtrace->format=tmp;
357                                break;
358                                }
359        }
360        if (libtrace->format == 0) {
361                trace_set_err(libtrace,TRACE_ERR_BAD_FORMAT,
362                                "Unknown format (%s)",scan);
363        }
364
365        libtrace->format_data = NULL;
366        free(scan);
367        return libtrace;
368
369}
370
371/* Creates an output trace from a URI.
372 *
373 * @param uri   the uri string describing the output format and destination
374 * @returns opaque pointer to a libtrace_output_t
375 *
376 *  If an error occured when attempting to open the output trace, NULL is
377 *  returned and trace_errno is set.
378 */
379       
380DLLEXPORT libtrace_out_t *trace_create_output(const char *uri) {
381        libtrace_out_t *libtrace = 
382                        (libtrace_out_t*)malloc(sizeof(libtrace_out_t));
383       
384        char *scan = 0;
385        const char *uridata = 0;
386        struct libtrace_format_t *tmp;
387
388        trace_init();
389
390        libtrace->err.err_num = TRACE_ERR_NOERROR;
391        strcpy(libtrace->err.problem,"Error message set\n");
392        libtrace->format = NULL;
393        libtrace->uridata = NULL;
394       
395        /* Parse the URI to determine what capture format we want to write */
396
397        if ((uridata = trace_parse_uri(uri, &scan)) == 0) {
398                trace_set_err_out(libtrace,TRACE_ERR_BAD_FORMAT,
399                                "Bad uri format (%s)",uri);
400                return libtrace;
401        }
402       
403        /* Attempt to find the format in the list of supported formats */
404        for(tmp=formats_list;tmp;tmp=tmp->next) {
405                if (strlen(scan) == strlen(tmp->name) &&
406                                !strncasecmp(scan,
407                                        tmp->name,
408                                        strlen(scan))) {
409                                libtrace->format=tmp;
410                                break;
411                                }
412        }
413        free(scan);
414
415        if (libtrace->format == NULL) {
416                trace_set_err_out(libtrace,TRACE_ERR_BAD_FORMAT,
417                                "Unknown output format (%s)",scan);
418                return libtrace;
419        }
420        libtrace->uridata = strdup(uridata);
421
422        /* libtrace->format now contains the type of uri
423         * libtrace->uridata contains the appropriate data for this
424         */
425
426        if (libtrace->format->init_output) {
427                /* 0 on success, -1 on failure */
428                switch(libtrace->format->init_output(libtrace)) {
429                        case -1: /* failure */
430                                return libtrace;
431                        case 0: /* success */
432                                break;
433                        default:
434                                assert(!"Internal error: init_output() should return -1 for failure, or 0 for success");
435                }
436        } else {
437                trace_set_err_out(libtrace,TRACE_ERR_UNSUPPORTED,
438                                "Format does not support writing (%s)",scan);
439                return libtrace;
440        }
441
442
443        libtrace->started=false;
444        return libtrace;
445}
446
447/* Start an input trace
448 * @param libtrace      the input trace to start
449 * @returns 0 on success
450 *
451 * This does the work associated with actually starting up
452 * the trace.  it may fail.
453 */
454DLLEXPORT int trace_start(libtrace_t *libtrace)
455{
456        assert(libtrace);
457        if (trace_is_err(libtrace))
458                return -1;
459        if (libtrace->format->start_input) {
460                int ret=libtrace->format->start_input(libtrace);
461                if (ret < 0) {
462                        return ret;
463                }
464        }
465
466        libtrace->started=true;
467        return 0;
468}
469
470/* Start an output trace */
471DLLEXPORT int trace_start_output(libtrace_out_t *libtrace) 
472{
473        assert(libtrace);
474        if (libtrace->format->start_output) {
475                int ret=libtrace->format->start_output(libtrace);
476                if (ret < 0) {
477                        return ret;
478                }
479        }
480
481        libtrace->started=true;
482        return 0;
483}
484
485DLLEXPORT int trace_pause(libtrace_t *libtrace)
486{
487        assert(libtrace);
488        if (!libtrace->started) {
489                trace_set_err(libtrace,TRACE_ERR_BAD_STATE, "You must call trace_start() before calling trace_pause()");
490                return -1;
491        }
492        if (libtrace->format->pause_input)
493                libtrace->format->pause_input(libtrace);
494        libtrace->started=false;
495        return 0;
496}
497
498DLLEXPORT int trace_config(libtrace_t *libtrace,
499                trace_option_t option,
500                void *value)
501{
502        int ret;
503        libtrace_err_t err;
504
505        if (trace_is_err(libtrace)) {
506                return -1;
507        }
508       
509        /* If the capture format supports configuration, try using their
510         * native configuration first */
511        if (libtrace->format->config_input) {
512                ret=libtrace->format->config_input(libtrace,option,value);
513                if (ret==0)
514                        return 0;
515        }
516
517        /* If we get here, either the native configuration failed or the
518         * format did not support configuration. However, libtrace can
519         * deal with some options itself, so give that a go */
520        switch(option) {
521                case TRACE_OPTION_SNAPLEN:
522                        /* Clear the error if there was one */
523                        if (trace_is_err(libtrace)) {
524                                err = trace_get_err(libtrace);
525                        }
526                        if (*(int*)value<0 
527                                || *(int*)value>LIBTRACE_PACKET_BUFSIZE) {
528                                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,
529                                        "Invalid snap length");
530                        }
531                        libtrace->snaplen=*(int*)value;
532                        return 0;
533                case TRACE_OPTION_FILTER:
534                        /* Clear the error if there was one */
535                        if (trace_is_err(libtrace)) {
536                                err = trace_get_err(libtrace);
537                        }
538                        libtrace->filter=(libtrace_filter_t *)value;
539                        return 0;
540                case TRACE_OPTION_PROMISC:
541                        if (!trace_is_err(libtrace)) {
542                                trace_set_err(libtrace,TRACE_ERR_OPTION_UNAVAIL,
543                                                "Promisc mode is not supported by this format module");
544                        }
545                        return -1;
546                case TRACE_OPTION_META_FREQ:
547                        if (!trace_is_err(libtrace)) {
548                                trace_set_err(libtrace, 
549                                                TRACE_ERR_OPTION_UNAVAIL,
550                                                "This format does not support meta-data gathering");
551                        }
552                        return -1;
553                case TRACE_OPTION_EVENT_REALTIME:
554                        if (!trace_is_err(libtrace)) {
555                                trace_set_err(libtrace, 
556                                                TRACE_ERR_OPTION_UNAVAIL,
557                                                "This format does not support realtime events");
558                        }
559                        return -1;
560                       
561        }
562        if (!trace_is_err(libtrace)) {
563                trace_set_err(libtrace,TRACE_ERR_UNKNOWN_OPTION,
564                        "Unknown option %i", option);
565        }
566        return -1;
567}
568
569DLLEXPORT int trace_config_output(libtrace_out_t *libtrace, 
570                trace_option_output_t option,
571                void *value) {
572       
573        /* Unlike the input options, libtrace does not natively support any of
574         * the output options - the format module must be able to deal with
575         * them. */
576        if (libtrace->format->config_output) {
577                return libtrace->format->config_output(libtrace, option, value);
578        }
579        return -1;
580}
581
582/* Close an input trace file, freeing up any resources it may have been using
583 *
584 */
585DLLEXPORT void trace_destroy(libtrace_t *libtrace) {
586        assert(libtrace);
587        if (libtrace->format) {
588                if (libtrace->started && libtrace->format->pause_input)
589                        libtrace->format->pause_input(libtrace);
590                libtrace->format->fin_input(libtrace);
591        }
592        /* Need to free things! */
593        if (libtrace->uridata)
594                free(libtrace->uridata);
595        if (libtrace->event.packet)
596                trace_destroy_packet(libtrace->event.packet);
597        free(libtrace);
598}
599
600
601DLLEXPORT void trace_destroy_dead(libtrace_t *libtrace) {
602        assert(libtrace);
603
604        /* Don't call pause_input or fin_input, because we should never have
605         * used this trace to do any reading anyway. Do make sure we free
606         * any format_data that has been created, though. */
607        if (libtrace->format_data)
608                free(libtrace->format_data);
609        free(libtrace);
610}
611/* Close an output trace file, freeing up any resources it may have been using
612 *
613 * @param libtrace      the output trace file to be destroyed
614 */
615DLLEXPORT void trace_destroy_output(libtrace_out_t *libtrace) 
616{
617        assert(libtrace);
618        if (libtrace->format && libtrace->format->fin_output)
619                libtrace->format->fin_output(libtrace);
620        if (libtrace->uridata)
621                free(libtrace->uridata);
622        free(libtrace);
623}
624
625DLLEXPORT libtrace_packet_t *trace_create_packet(void) 
626{
627        libtrace_packet_t *packet = 
628                (libtrace_packet_t*)calloc((size_t)1,sizeof(libtrace_packet_t));
629
630        packet->buf_control=TRACE_CTRL_PACKET;
631        trace_clear_cache(packet);
632        return packet;
633}
634
635DLLEXPORT libtrace_packet_t *trace_copy_packet(const libtrace_packet_t *packet) {
636        libtrace_packet_t *dest = 
637                (libtrace_packet_t *)malloc(sizeof(libtrace_packet_t));
638        if (!dest) {
639                printf("Out of memory constructing packet\n");
640                abort();
641        }
642        dest->trace=packet->trace;
643        dest->buffer=malloc(65536);
644        if (!dest->buffer) {
645                printf("Out of memory allocating buffer memory\n");
646                abort();
647        }
648        dest->header=dest->buffer;
649        dest->payload=(void*)
650                ((char*)dest->buffer+trace_get_framing_length(packet));
651        dest->type=packet->type;
652        dest->buf_control=TRACE_CTRL_PACKET;
653        /* Reset the cache - better to recalculate than try to convert
654         * the values over to the new packet */
655        trace_clear_cache(dest);       
656        /* Ooooh nasty memcpys! This is why we want to avoid copying packets
657         * as much as possible */
658        memcpy(dest->header,packet->header,trace_get_framing_length(packet));
659        memcpy(dest->payload,packet->payload,trace_get_capture_length(packet));
660
661        return dest;
662}
663
664/** Destroy a packet object
665 */
666DLLEXPORT void trace_destroy_packet(libtrace_packet_t *packet) {
667        if (packet->buf_control == TRACE_CTRL_PACKET) {
668                free(packet->buffer);
669        }
670        packet->buf_control=(buf_control_t)'\0'; 
671                                /* A "bad" value to force an assert
672                                 * if this packet is ever reused
673                                 */
674        free(packet);
675}       
676
677/* Read one packet from the trace into buffer. Note that this function will
678 * block until a packet is read (or EOF is reached).
679 *
680 * @param libtrace      the libtrace opaque pointer
681 * @param packet        the packet opaque pointer
682 * @returns 0 on EOF, negative value on error
683 *
684 */
685DLLEXPORT int trace_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
686
687        assert(libtrace && "You called trace_read_packet() with a NULL libtrace parameter!\n");
688        if (trace_is_err(libtrace))
689                return -1;
690        if (!libtrace->started) {
691                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,"You must call libtrace_start() before trace_read_packet()\n");
692                return -1;
693        }
694        if (!(packet->buf_control==TRACE_CTRL_PACKET || packet->buf_control==TRACE_CTRL_EXTERNAL)) {
695                trace_set_err(libtrace,TRACE_ERR_BAD_STATE,"Packet passed to trace_read_packet() is invalid\n");
696                return -1;
697        }
698        assert(packet);
699     
700        /* Store the trace we are reading from into the packet opaque
701         * structure */
702        packet->trace = libtrace;
703
704        /* Finalise the packet, freeing any resources the format module
705         * may have allocated it
706         */
707        if (libtrace->format->fin_packet) {
708                libtrace->format->fin_packet(packet);
709        }
710
711
712        if (libtrace->format->read_packet) {
713                do {
714                        size_t ret;
715                        /* Clear the packet cache */
716                        trace_clear_cache(packet);
717                        ret=libtrace->format->read_packet(libtrace,packet);
718                        if (ret==(size_t)-1 || ret==0) {
719                                return ret;
720                        }
721                        if (libtrace->filter) {
722                                /* If the filter doesn't match, read another
723                                 * packet
724                                 */
725                                if (!trace_apply_filter(libtrace->filter,packet)){
726                                        ++libtrace->filtered_packets;
727                                        continue;
728                                }
729                        }
730                        if (libtrace->snaplen>0) {
731                                /* Snap the packet */
732                                trace_set_capture_length(packet,
733                                                libtrace->snaplen);
734                        }
735                        ++libtrace->accepted_packets;
736                        return ret;
737                } while(1);
738        }
739        trace_set_err(libtrace,TRACE_ERR_UNSUPPORTED,"This format does not support reading packets\n");
740        return ~0U;
741}
742
743/* Converts the provided buffer into a libtrace packet of the given type.
744 *
745 * Unlike trace_construct_packet, the buffer is expected to begin with the
746 * appropriate capture format header for the format type that the packet is
747 * being converted to. This also allows for a packet to be converted into
748 * just about capture format that is supported by libtrace, provided the
749 * format header is present in the buffer.
750 *
751 * This function is primarily used to convert packets received via the RT
752 * protocol back into their original capture format. The RT header encapsulates
753 * the original capture format header, so after removing it the packet must
754 * have it's header and payload pointers updated and the packet format and type
755 * changed, amongst other things.
756 *
757 * Intended only for internal use at this point - this function is not
758 * available through the external libtrace API.
759 */
760int trace_prepare_packet(libtrace_t *trace, libtrace_packet_t *packet,
761                void *buffer, libtrace_rt_types_t rt_type, uint32_t flags) {
762
763        assert(packet);
764        assert(trace);
765       
766        /* XXX Proper error handling?? */
767        if (buffer == NULL)
768                return -1;
769
770        if (!(packet->buf_control==TRACE_CTRL_PACKET || packet->buf_control==TRACE_CTRL_EXTERNAL)) {
771                trace_set_err(trace,TRACE_ERR_BAD_STATE,"Packet passed to trace_read_packet() is invalid\n");
772                return -1;
773        }
774       
775        packet->trace = trace;
776       
777        /* Clear packet cache */
778        trace_clear_cache(packet);
779
780        if (trace->format->prepare_packet) {
781                return trace->format->prepare_packet(trace, packet,
782                                buffer, rt_type, flags);
783        }
784        trace_set_err(trace, TRACE_ERR_UNSUPPORTED, 
785                        "This format does not support preparing packets\n");
786        return -1;
787
788}
789
790/* Writes a packet to the specified output trace
791 *
792 * @param libtrace      describes the output format, destination, etc.
793 * @param packet        the packet to be written out
794 * @returns the number of bytes written, -1 if write failed
795 */
796DLLEXPORT int trace_write_packet(libtrace_out_t *libtrace, libtrace_packet_t *packet) {
797        assert(libtrace);
798        assert(packet); 
799        /* Verify the packet is valid */
800        if (!libtrace->started) {
801                trace_set_err_out(libtrace,TRACE_ERR_BAD_STATE,
802                        "Trace is not started before trace_write_packet");
803                return -1;
804        }
805
806        if (libtrace->format->write_packet) {
807                return libtrace->format->write_packet(libtrace, packet);
808        }
809        trace_set_err_out(libtrace,TRACE_ERR_UNSUPPORTED,
810                "This format does not support writing packets");
811        return -1;
812}
813
814/* Get a pointer to the first byte of the packet payload */
815DLLEXPORT void *trace_get_packet_buffer(const libtrace_packet_t *packet,
816                libtrace_linktype_t *linktype, uint32_t *remaining) {
817        int cap_len;
818        int wire_len;
819
820        assert(packet != NULL);
821        if (linktype) *linktype = trace_get_link_type(packet);
822        if (remaining) {
823                /* I think we should choose the minimum of the capture and
824                 * wire lengths to be the "remaining" value. If the packet has
825                 * been padded to increase the capture length, we don't want
826                 * to allow subsequent protocol decoders to consider the
827                 * padding as part of the packet.
828                 *
829                 * For example, in Auck 4 there is a trace where the IP header
830                 * length is incorrect (24 bytes) followed by a 20 byte TCP
831                 * header. Total IP length is 40 bytes. As a result, the
832                 * legacyatm padding gets treated as the "missing" bytes of
833                 * the TCP header, which isn't the greatest. We're probably
834                 * better off returning an incomplete TCP header in that case.
835                 */
836               
837                cap_len = trace_get_capture_length(packet);
838                wire_len = trace_get_wire_length(packet);
839
840                assert(cap_len >= 0);
841
842                /* There is the odd corrupt packet, e.g. in IPLS II, that have
843                 * massively negative wire lens. We could assert fail here on
844                 * them, but we could at least try the capture length instead.
845                 *
846                 * You may still run into problems if you try to write that
847                 * packet, but at least reading should work OK.
848                 */
849                if (wire_len < 0)
850                        *remaining = cap_len;
851                else if (wire_len < cap_len)
852                        *remaining = wire_len;
853                else
854                        *remaining = cap_len;
855                /* *remaining = trace_get_capture_length(packet); */
856        }
857        return (void *) packet->payload;
858}
859
860
861/* Get a pointer to the first byte of the packet payload
862 *
863 * DEPRECATED - use trace_get_packet_buffer() instead */
864DLLEXPORT void *trace_get_link(const libtrace_packet_t *packet) {
865        return (void *)packet->payload;
866}
867
868/* Get the current time in DAG time format
869 * @param packet        a pointer to a libtrace_packet structure
870 * @returns a 64 bit timestamp in DAG ERF format (upper 32 bits are the seconds
871 * past 1970-01-01, the lower 32bits are partial seconds)
872 */ 
873DLLEXPORT uint64_t trace_get_erf_timestamp(const libtrace_packet_t *packet) {
874        if (packet->trace->format->get_erf_timestamp) {
875                /* timestamp -> timestamp */
876                return packet->trace->format->get_erf_timestamp(packet);
877        } else if (packet->trace->format->get_timespec) {
878                /* timespec -> timestamp */
879                struct timespec ts;
880                ts = packet->trace->format->get_timespec(packet);
881                return ((((uint64_t)ts.tv_sec) << 32) +
882                                (((uint64_t)ts.tv_nsec << 32)/1000000000));
883        } else if (packet->trace->format->get_timeval) {
884                /* timeval -> timestamp */
885                struct timeval tv;
886                tv = packet->trace->format->get_timeval(packet);
887                return ((((uint64_t)tv.tv_sec) << 32) +
888                                (((uint64_t)tv.tv_usec << 32)/1000000));
889        } else if (packet->trace->format->get_seconds) {
890                /* seconds -> timestamp */
891                double seconds = packet->trace->format->get_seconds(packet);
892                return (((uint64_t)seconds)<<32)
893                          + (uint64_t)((seconds-(uint64_t)seconds)*UINT_MAX);
894        }
895        else {
896                return (uint64_t)0;
897        }
898                     
899}
900
901/* Get the current time in struct timeval
902 * @param packet        a pointer to a libtrace_packet structure
903 *
904 * @returns time that this packet was seen in a struct timeval
905 * @author Daniel Lawson
906 * @author Perry Lorier
907 */ 
908DLLEXPORT struct timeval trace_get_timeval(const libtrace_packet_t *packet) {
909        struct timeval tv;
910        uint64_t ts = 0;
911        if (packet->trace->format->get_timeval) {
912                /* timeval -> timeval */
913                tv = packet->trace->format->get_timeval(packet);
914        } else if (packet->trace->format->get_erf_timestamp) {
915                /* timestamp -> timeval */
916                ts = packet->trace->format->get_erf_timestamp(packet);
917#if __BYTE_ORDER == __BIG_ENDIAN
918                tv.tv_sec = ts & 0xFFFFFFFF;
919#elif __BYTE_ORDER == __LITTLE_ENDIAN
920                tv.tv_sec = ts >> 32;
921#else
922#error "What on earth are you running this on?"
923#endif
924                tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
925                if (tv.tv_usec >= 1000000) {
926                        tv.tv_usec -= 1000000;
927                        tv.tv_sec += 1;
928                }
929        } else if (packet->trace->format->get_timespec) {
930                struct timespec ts = packet->trace->format->get_timespec(packet);
931                tv.tv_sec = ts.tv_sec;
932                tv.tv_usec = ts.tv_nsec/1000;
933        } else if (packet->trace->format->get_seconds) {
934                /* seconds -> timeval */
935                double seconds = packet->trace->format->get_seconds(packet);
936                tv.tv_sec = (uint32_t)seconds;
937                tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
938        }
939        else {
940                tv.tv_sec=-1;
941                tv.tv_usec=-1;
942        }
943
944        return tv;
945}
946
947DLLEXPORT struct timespec trace_get_timespec(const libtrace_packet_t *packet) {
948        struct timespec ts;
949
950        if (packet->trace->format->get_timespec) {
951                return packet->trace->format->get_timespec(packet);
952        } else if (packet->trace->format->get_erf_timestamp) {
953                /* timestamp -> timeval */
954                uint64_t erfts = packet->trace->format->get_erf_timestamp(packet);
955#if __BYTE_ORDER == __BIG_ENDIAN
956                ts.tv_sec = erfts & 0xFFFFFFFF;
957#elif __BYTE_ORDER == __LITTLE_ENDIAN
958                ts.tv_sec = erfts >> 32;
959#else
960#error "What on earth are you running this on?"
961#endif
962                ts.tv_nsec = ((erfts&0xFFFFFFFF)*1000000000)>>32;
963                if (ts.tv_nsec >= 1000000000) {
964                        ts.tv_nsec -= 1000000000;
965                        ts.tv_sec += 1;
966                }
967                return ts;
968        } else if (packet->trace->format->get_timeval) {
969                /* timeval -> timespec */
970                struct timeval tv = packet->trace->format->get_timeval(packet);
971                ts.tv_sec = tv.tv_sec;
972                ts.tv_nsec = tv.tv_usec*1000;
973                return ts;
974        } else if (packet->trace->format->get_seconds) {
975                /* seconds -> timespec */
976                double seconds = packet->trace->format->get_seconds(packet);
977                ts.tv_sec = (uint32_t)seconds;
978                ts.tv_nsec = (long)(((seconds - ts.tv_sec) * 1000000000)/UINT_MAX);
979                return ts;
980        }
981        else {
982                ts.tv_sec=-1;
983                ts.tv_nsec=-1;
984                return ts;
985        }
986}
987
988
989/* Get the current time in floating point seconds
990 * @param packet        a pointer to a libtrace_packet structure
991 * @returns time that this packet was seen in 64bit floating point seconds
992 */ 
993DLLEXPORT double trace_get_seconds(const libtrace_packet_t *packet) {
994        double seconds = 0.0;
995
996        if (packet->trace->format->get_seconds) {
997                /* seconds->seconds */
998                seconds = packet->trace->format->get_seconds(packet);
999        } else if (packet->trace->format->get_erf_timestamp) {
1000                /* timestamp -> seconds */
1001                uint64_t ts = 0;
1002                ts = packet->trace->format->get_erf_timestamp(packet);
1003                seconds =  (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
1004        } else if (packet->trace->format->get_timespec) {
1005                /* timespec -> seconds */
1006                struct timespec ts;
1007                ts = packet->trace->format->get_timespec(packet);
1008                seconds = ts.tv_sec + ((ts.tv_nsec * 1.0) / 1000000000);
1009        } else if (packet->trace->format->get_timeval) {
1010                /* timeval -> seconds */
1011                struct timeval tv;
1012                tv = packet->trace->format->get_timeval(packet);
1013                seconds = tv.tv_sec + ((tv.tv_usec * 1.0) / 1000000);
1014        }
1015
1016        return seconds;
1017}
1018
1019DLLEXPORT size_t trace_get_capture_length(const libtrace_packet_t *packet) 
1020{
1021        /* Cache the capture length */
1022        if (packet->capture_length == -1) {
1023                if (!packet->trace->format->get_capture_length)
1024                        return ~0U;
1025                /* Cast away constness because this is "just" a cache */
1026                ((libtrace_packet_t*)packet)->capture_length = 
1027                        packet->trace->format->get_capture_length(packet);
1028        }
1029
1030        assert(packet->capture_length < LIBTRACE_PACKET_BUFSIZE);
1031
1032        return packet->capture_length;
1033}
1034       
1035/* Get the size of the packet as it was seen on the wire.
1036 * @param packet        a pointer to a libtrace_packet structure
1037 *
1038 * @returns the size of the packet as it was on the wire.
1039 * @note Due to the trace being a header capture, or anonymisation this may
1040 * not be the same as the Capture Len.
1041 */ 
1042DLLEXPORT size_t trace_get_wire_length(const libtrace_packet_t *packet){
1043       
1044        if (packet->wire_length == -1) {
1045                if (!packet->trace->format->get_wire_length) 
1046                        return ~0U;
1047                ((libtrace_packet_t *)packet)->wire_length = 
1048                        packet->trace->format->get_wire_length(packet);
1049        }
1050
1051        assert(packet->wire_length < LIBTRACE_PACKET_BUFSIZE);
1052        return packet->wire_length;
1053
1054}
1055
1056/* Get the length of the capture framing headers.
1057 * @param packet        the packet opaque pointer
1058 * @returns the size of the packet as it was on the wire.
1059 * @note this length corresponds to the difference between the size of a
1060 * captured packet in memory, and the captured length of the packet
1061 */ 
1062DLLEXPORT SIMPLE_FUNCTION
1063size_t trace_get_framing_length(const libtrace_packet_t *packet) {
1064        if (packet->trace->format->get_framing_length) {
1065                return packet->trace->format->get_framing_length(packet);
1066        }
1067        return ~0U;
1068}
1069
1070
1071/* Get the type of the link layer
1072 * @param packet        a pointer to a libtrace_packet structure
1073 * @returns libtrace_linktype_t
1074 */
1075DLLEXPORT libtrace_linktype_t trace_get_link_type(const libtrace_packet_t *packet ) {
1076
1077        if (packet->link_type == 0) {
1078                if (!packet->trace->format->get_link_type)
1079                        return (libtrace_linktype_t)-1;
1080                ((libtrace_packet_t *)packet)->link_type =
1081                        packet->trace->format->get_link_type(packet);
1082        }
1083
1084        return packet->link_type;
1085}
1086
1087/* process a libtrace event
1088 * @param trace the libtrace opaque pointer
1089 * @param packet the libtrace_packet opaque pointer
1090 * @returns
1091 *  TRACE_EVENT_IOWAIT  Waiting on I/O on fd
1092 *  TRACE_EVENT_SLEEP   Next event in seconds
1093 *  TRACE_EVENT_PACKET  Packet arrived in buffer with size size
1094 *  TRACE_EVENT_TERMINATE Trace terminated (perhaps with an error condition)
1095 * FIXME currently keeps a copy of the packet inside the trace pointer,
1096 * which in turn is stored inside the new packet object...
1097 */
1098DLLEXPORT libtrace_eventobj_t trace_event(libtrace_t *trace, 
1099                libtrace_packet_t *packet) {
1100        libtrace_eventobj_t event = {TRACE_EVENT_IOWAIT,0,0.0,0};
1101
1102        if (!trace) {
1103                fprintf(stderr,"You called trace_event() with a NULL trace object!\n");
1104        }
1105        assert(trace);
1106        assert(packet);
1107
1108        /* Clear the packet cache */
1109        trace_clear_cache(packet);
1110       
1111        /* Store the trace we are reading from into the packet opaque
1112         * structure */
1113        packet->trace = trace;
1114
1115        if (packet->trace->format->trace_event) {
1116                event=packet->trace->format->trace_event(trace,packet);
1117                if (event.type == TRACE_EVENT_PACKET) {
1118                        ++trace->accepted_packets;
1119                }
1120        }
1121        return event;
1122
1123}
1124
1125/** Setup a BPF filter based on pre-compiled byte-code.
1126 * @param bf_insns      A pointer to the start of the byte-code
1127 * @param bf_len        The number of BPF instructions
1128 * @returns             an opaque pointer to a libtrace_filter_t object
1129 * @note                The supplied byte-code is not checked for correctness.
1130 * @author              Scott Raynel
1131 */
1132DLLEXPORT libtrace_filter_t *
1133trace_create_filter_from_bytecode(void *bf_insns, unsigned int bf_len)
1134{
1135#ifndef HAVE_BPF_FILTER
1136        fprintf(stderr, "This version of libtrace does not have BPF support\n");
1137        return NULL;
1138#else
1139        struct libtrace_filter_t *filter = (struct libtrace_filter_t *)
1140                malloc(sizeof(struct libtrace_filter_t));
1141        filter->filter.bf_insns = (struct bpf_insn *)
1142                malloc(sizeof(struct bpf_insn) * bf_len);
1143       
1144        memcpy(filter->filter.bf_insns, bf_insns,
1145                        bf_len * sizeof(struct bpf_insn));
1146       
1147        filter->filter.bf_len = bf_len;
1148        filter->filterstring = NULL;
1149        filter->jitfilter = NULL;
1150        /* "flag" indicates that the filter member is valid */
1151        filter->flag = 1; 
1152       
1153        return filter;
1154#endif
1155}
1156
1157/* Create a BPF filter
1158 * @param filterstring a char * containing the bpf filter string
1159 * @returns opaque pointer pointer to a libtrace_filter_t object
1160 */
1161DLLEXPORT libtrace_filter_t *trace_create_filter(const char *filterstring) {
1162#ifdef HAVE_BPF_FILTER
1163        libtrace_filter_t *filter = (libtrace_filter_t*)
1164                                malloc(sizeof(libtrace_filter_t));
1165        filter->filterstring = strdup(filterstring);
1166        filter->jitfilter = NULL;
1167        filter->flag = 0;
1168        return filter;
1169#else
1170        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1171        return NULL;
1172#endif
1173}
1174
1175DLLEXPORT void trace_destroy_filter(libtrace_filter_t *filter)
1176{
1177#ifdef HAVE_BPF_FILTER
1178        free(filter->filterstring);
1179        if (filter->flag)
1180                pcap_freecode(&filter->filter);
1181#ifdef HAVE_LLVM
1182        if (filter->jitfilter) 
1183                destroy_program(filter->jitfilter);
1184#endif
1185        free(filter);
1186#else
1187
1188#endif
1189}
1190
1191/* Compile a bpf filter, now we know the link type for the trace that we're
1192 * applying it to.
1193 *
1194 * @internal
1195 *
1196 * @returns -1 on error, 0 on success
1197 */
1198static int trace_bpf_compile(libtrace_filter_t *filter,
1199                const libtrace_packet_t *packet,
1200                void *linkptr, 
1201                libtrace_linktype_t linktype    ) {
1202#ifdef HAVE_BPF_FILTER
1203        assert(filter);
1204
1205        /* If this isn't a real packet, then fail */
1206        if (!linkptr) {
1207                trace_set_err(packet->trace,
1208                                TRACE_ERR_BAD_PACKET,"Packet has no payload");
1209                return -1;
1210        }
1211       
1212        if (filter->filterstring && ! filter->flag) {
1213                pcap_t *pcap = NULL;
1214                if (linktype==(libtrace_linktype_t)-1) {
1215                        trace_set_err(packet->trace,
1216                                        TRACE_ERR_BAD_PACKET,
1217                                        "Packet has an unknown linktype");
1218                        return -1;
1219                }
1220                if (libtrace_to_pcap_dlt(linktype) == ~1U) {
1221                        trace_set_err(packet->trace,TRACE_ERR_BAD_PACKET,
1222                                        "Unknown pcap equivalent linktype");
1223                        return -1;
1224                }
1225                pcap=(pcap_t *)pcap_open_dead(
1226                                (int)libtrace_to_pcap_dlt(linktype),
1227                                1500U);
1228                /* build filter */
1229                assert(pcap);
1230                if (pcap_compile( pcap, &filter->filter, filter->filterstring, 
1231                                        1, 0)) {
1232                        trace_set_err(packet->trace,TRACE_ERR_BAD_PACKET,
1233                                        "Unable to compile the filter \"%s\": %s", 
1234                                        filter->filterstring,
1235                                        pcap_geterr(pcap));
1236                        pcap_close(pcap);
1237                        return -1;
1238                }
1239                pcap_close(pcap);
1240                filter->flag=1;
1241        }
1242        return 0;
1243#else
1244        assert(!"Internal bug: This should never be called when BPF not enabled");
1245        trace_set_err(packet->trace,TRACE_ERR_OPTION_UNAVAIL,
1246                                "Feature unavailable");
1247        return -1;
1248#endif
1249}
1250
1251DLLEXPORT int trace_apply_filter(libtrace_filter_t *filter,
1252                        const libtrace_packet_t *packet) {
1253#ifdef HAVE_BPF_FILTER
1254        void *linkptr = 0;
1255        uint32_t clen = 0;
1256        bool free_packet_needed = false;
1257        int ret;
1258        libtrace_linktype_t linktype;
1259        libtrace_packet_t *packet_copy = (libtrace_packet_t*)packet;
1260
1261        assert(filter);
1262        assert(packet);
1263
1264        /* Match all non-data packets as we probably want them to pass
1265         * through to the caller */
1266        linktype = trace_get_link_type(packet);
1267
1268        if (linktype == TRACE_TYPE_NONDATA)
1269                return 1;       
1270
1271        if (libtrace_to_pcap_dlt(linktype)==~0U) {
1272               
1273                /* If we cannot get a suitable DLT for the packet, it may
1274                 * be because the packet is encapsulated in a link type that
1275                 * does not correspond to a DLT. Therefore, we should try
1276                 * popping off headers until we either can find a suitable
1277                 * link type or we can't do any more sensible decapsulation. */
1278               
1279                /* Copy the packet, as we don't want to trash the one we
1280                 * were passed in */
1281                packet_copy=trace_copy_packet(packet);
1282                free_packet_needed=true;
1283
1284                while (libtrace_to_pcap_dlt(linktype) == ~0U) {
1285                        if (!demote_packet(packet_copy)) {
1286                                trace_set_err(packet->trace, 
1287                                                TRACE_ERR_NO_CONVERSION,
1288                                                "pcap does not support this format");
1289                                if (free_packet_needed) {
1290                                        trace_destroy_packet(packet_copy);
1291                                }
1292                                return -1;
1293                        }
1294                        linktype = trace_get_link_type(packet_copy);
1295                }
1296
1297        }
1298       
1299        linkptr = trace_get_packet_buffer(packet_copy,NULL,&clen);
1300        if (!linkptr) {
1301                if (free_packet_needed) {
1302                        trace_destroy_packet(packet_copy);
1303                }
1304                return 0;
1305        }
1306
1307        /* We need to compile the filter now, because before we didn't know
1308         * what the link type was
1309         */
1310        if (trace_bpf_compile(filter,packet_copy,linkptr,linktype)==-1) {
1311                if (free_packet_needed) {
1312                        trace_destroy_packet(packet_copy);
1313                }
1314                return -1;
1315        }
1316
1317        /* If we're jitting, we may need to JIT the BPF code now too */
1318#if HAVE_LLVM
1319        if (!filter->jitfilter) {
1320                filter->jitfilter = compile_program(filter->filter.bf_insns, filter->filter.bf_len);
1321        }
1322#endif
1323
1324        assert(filter->flag);
1325        /* Now execute the filter */
1326#if HAVE_LLVM
1327        ret=filter->jitfilter->bpf_run((unsigned char *)linkptr, clen);
1328#else
1329        ret=bpf_filter(filter->filter.bf_insns,(u_char*)linkptr,(unsigned int)clen,(unsigned int)clen);
1330#endif
1331
1332        /* If we copied the packet earlier, make sure that we free it */
1333        if (free_packet_needed) {
1334                trace_destroy_packet(packet_copy);
1335        }
1336        return ret;
1337#else
1338        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1339        return 0;
1340#endif
1341}
1342
1343/* Set the direction flag, if it has one
1344 * @param packet the packet opaque pointer
1345 * @param direction the new direction (0,1,2,3)
1346 * @returns a signed value containing the direction flag, or -1 if this is not supported
1347 */
1348DLLEXPORT libtrace_direction_t trace_set_direction(libtrace_packet_t *packet, 
1349                libtrace_direction_t direction) 
1350{
1351        assert(packet);
1352        if (packet->trace->format->set_direction) {
1353                return packet->trace->format->set_direction(packet,direction);
1354        }
1355        return (libtrace_direction_t)~0U;
1356}
1357
1358/* Get the direction flag, if it has one
1359 * @param packet a pointer to a libtrace_packet structure
1360 * @returns a signed value containing the direction flag, or -1 if this is not supported
1361 * The direction is defined as 0 for packets originating locally (ie, outbound)
1362 * and 1 for packets originating remotely (ie, inbound).
1363 * Other values are possible, which might be overloaded to mean special things
1364 * for a special trace.
1365 */
1366DLLEXPORT libtrace_direction_t trace_get_direction(const libtrace_packet_t *packet) 
1367{
1368        assert(packet);
1369        if (packet->trace->format->get_direction) {
1370                return packet->trace->format->get_direction(packet);
1371        }
1372        return (libtrace_direction_t)~0U;
1373}
1374
1375#define ROOT_SERVER(x) ((x) < 512)
1376#define ROOT_CLIENT(x) ((512 <= (x)) && ((x) < 1024))
1377#define NONROOT_SERVER(x) ((x) >= 5000)
1378#define NONROOT_CLIENT(x) ((1024 <= (x)) && ((x) < 5000))
1379#define DYNAMIC(x) ((49152 < (x)) && ((x) < 65535))
1380#define SERVER(x) ROOT_SERVER(x) || NONROOT_SERVER(x)
1381#define CLIENT(x) ROOT_CLIENT(x) || NONROOT_CLIENT(x)
1382
1383/* Attempt to deduce the 'server' port
1384 * @param protocol the IP protocol (eg, 6 or 17 for TCP or UDP)
1385 * @param source the TCP or UDP source port
1386 * @param dest the TCP or UDP destination port
1387 * @returns a hint as to which port is the server port
1388 */
1389DLLEXPORT int8_t trace_get_server_port(UNUSED uint8_t protocol, 
1390                uint16_t source, uint16_t dest) 
1391{
1392        /*
1393         * * If the ports are equal, return DEST
1394         * * Check for well-known ports in the given protocol
1395         * * Root server ports: 0 - 511
1396         * * Root client ports: 512 - 1023
1397         * * non-root client ports: 1024 - 4999
1398         * * non-root server ports: 5000+
1399         * * Check for static ranges: 1024 - 49151
1400         * * Check for dynamic ranges: 49152 - 65535
1401         * * flip a coin.
1402         */
1403       
1404        /* equal */
1405        if (source == dest)
1406                return USE_DEST;
1407
1408        /* root server port, 0 - 511 */
1409        if (ROOT_SERVER(source) && ROOT_SERVER(dest)) {
1410                if (source < dest)
1411                        return USE_SOURCE;
1412                return USE_DEST;
1413        }
1414
1415        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1416                return USE_SOURCE;
1417        if (!ROOT_SERVER(source) && ROOT_SERVER(dest))
1418                return USE_DEST;
1419
1420        /* non-root server */
1421        if (NONROOT_SERVER(source) && NONROOT_SERVER(dest)) {
1422                if (source < dest)
1423                        return USE_SOURCE;
1424                return USE_DEST;
1425        }
1426        if (NONROOT_SERVER(source) && !NONROOT_SERVER(dest))
1427                return USE_SOURCE;
1428        if (!NONROOT_SERVER(source) && NONROOT_SERVER(dest))
1429                return USE_DEST;
1430
1431        /* root client */
1432        if (ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1433                if (source < dest)
1434                        return USE_SOURCE;
1435                return USE_DEST;
1436        }
1437        if (ROOT_CLIENT(source) && !ROOT_CLIENT(dest)) {
1438                /* prefer root-client over nonroot-client */
1439                if (NONROOT_CLIENT(dest))
1440                        return USE_SOURCE;
1441                return USE_DEST;
1442        }
1443        if (!ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1444                /* prefer root-client over nonroot-client */
1445                if (NONROOT_CLIENT(source))
1446                        return USE_DEST;
1447                return USE_SOURCE;
1448        }
1449       
1450        /* nonroot client */
1451        if (NONROOT_CLIENT(source) && NONROOT_CLIENT(dest)) {
1452                if (source < dest) 
1453                        return USE_SOURCE;
1454                return USE_DEST;
1455        }
1456        if (NONROOT_CLIENT(source) && !NONROOT_CLIENT(dest))
1457                return USE_DEST;
1458        if (!NONROOT_CLIENT(source) && NONROOT_CLIENT(dest))
1459                return USE_SOURCE;
1460
1461        /* dynamic range */
1462        if (DYNAMIC(source) && DYNAMIC(dest)) {
1463                if (source < dest)
1464                        return USE_SOURCE;
1465                return USE_DEST;
1466        }
1467        if (DYNAMIC(source) && !DYNAMIC(dest))
1468                return USE_DEST;
1469        if (!DYNAMIC(source) && DYNAMIC(dest))
1470                return USE_SOURCE;
1471        /*
1472        if (SERVER(source) && CLIENT(dest))
1473                return USE_SOURCE;
1474       
1475        if (SERVER(dest) && CLIENT(source))
1476                return USE_DEST;
1477        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1478                return USE_SOURCE;
1479        if (ROOT_SERVER(dest) && !ROOT_SERVER(source))
1480                return USE_DEST;
1481        */
1482        /* failing that test... */
1483        if (source < dest) {
1484                return USE_SOURCE;
1485        } 
1486        return USE_DEST;
1487       
1488}
1489
1490/* Truncate the packet at the suggested length
1491 * @param packet        the packet opaque pointer
1492 * @param size          the new length of the packet
1493 * @returns the new size of the packet
1494 * @note size and the return size refer to the network-level payload of the
1495 * packet, and do not include any capture headers. For example, to truncate a
1496 * packet after the IP header, set size to sizeof(ethernet_header) +
1497 * sizeof(ip_header)
1498 * @note If the original network-level payload is smaller than size, then the
1499 * original size is returned and the packet is left unchanged.
1500 */
1501DLLEXPORT size_t trace_set_capture_length(libtrace_packet_t *packet, size_t size) {
1502        assert(packet);
1503
1504        if (packet->trace->format->set_capture_length) {
1505                return packet->trace->format->set_capture_length(packet,size);
1506        }
1507
1508        return ~0U;
1509}
1510
1511/* Splits a URI into two components - the format component which is seen before
1512 * the ':', and the uridata which follows the ':'.
1513 *
1514 * Returns a pointer to the URI data, but updates the format parameter to
1515 * point to a copy of the format component.
1516 */
1517
1518DLLEXPORT const char * trace_parse_uri(const char *uri, char **format) {
1519        const char *uridata = 0;
1520       
1521        if((uridata = strchr(uri,':')) == NULL) {
1522                /* Badly formed URI - needs a : */
1523                return 0;
1524        }
1525
1526        if ((unsigned)(uridata - uri) > URI_PROTO_LINE) {
1527                /* Badly formed URI - uri type is too long */
1528                return 0;
1529        }
1530
1531        /* NOTE: this is allocated memory - it should be freed by the caller
1532         * once they are done with it */
1533        *format=xstrndup(uri, (size_t)(uridata - uri));
1534
1535        /* Push uridata past the delimiter */
1536        uridata++;
1537       
1538        return uridata;
1539}
1540
1541enum base_format_t trace_get_format(libtrace_packet_t *packet) 
1542{
1543        assert(packet);
1544
1545        return packet->trace->format->type;
1546}
1547       
1548DLLEXPORT libtrace_err_t trace_get_err(libtrace_t *trace)
1549{
1550        libtrace_err_t err = trace->err;
1551        trace->err.err_num = 0; /* "OK" */
1552        trace->err.problem[0]='\0';
1553        return err;
1554}
1555
1556DLLEXPORT bool trace_is_err(libtrace_t *trace)
1557{
1558        return trace->err.err_num != 0;
1559}
1560
1561/* Prints the input error status to standard error and clears the error state */
1562DLLEXPORT void trace_perror(libtrace_t *trace,const char *msg,...)
1563{
1564        char buf[256];
1565        va_list va;
1566        va_start(va,msg);
1567        vsnprintf(buf,sizeof(buf),msg,va);
1568        va_end(va);
1569        if(trace->err.err_num) {
1570                if (trace->uridata) {
1571                        fprintf(stderr,"%s(%s): %s\n",
1572                                        buf,trace->uridata,trace->err.problem);
1573                } else {
1574                        fprintf(stderr,"%s: %s\n", buf, trace->err.problem);
1575                }
1576        } else {
1577                if (trace->uridata) {
1578                        fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
1579                } else {
1580                        fprintf(stderr,"%s: No error\n", buf);
1581                }
1582        }
1583        trace->err.err_num = 0; /* "OK" */
1584        trace->err.problem[0]='\0';
1585}
1586
1587DLLEXPORT libtrace_err_t trace_get_err_output(libtrace_out_t *trace)
1588{
1589        libtrace_err_t err = trace->err;
1590        trace->err.err_num = TRACE_ERR_NOERROR; /* "OK" */
1591        trace->err.problem[0]='\0';
1592        return err;
1593}
1594
1595DLLEXPORT bool trace_is_err_output(libtrace_out_t *trace)
1596{
1597        return trace->err.err_num != 0;
1598}
1599
1600/* Prints the output error status to standard error and clears the error state
1601 */
1602DLLEXPORT void trace_perror_output(libtrace_out_t *trace,const char *msg,...)
1603{
1604        char buf[256];
1605        va_list va;
1606        va_start(va,msg);
1607        vsnprintf(buf,sizeof(buf),msg,va);
1608        va_end(va);
1609        if(trace->err.err_num) {
1610                fprintf(stderr,"%s(%s): %s\n",
1611                                buf,
1612                                trace->uridata?trace->uridata:"no uri",
1613                                trace->err.problem);
1614        } else {
1615                fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
1616        }
1617        trace->err.err_num = TRACE_ERR_NOERROR; /* "OK" */
1618        trace->err.problem[0]='\0';
1619}
1620
1621DLLEXPORT int trace_seek_erf_timestamp(libtrace_t *trace, uint64_t ts)
1622{
1623        if (trace->format->seek_erf) {
1624                return trace->format->seek_erf(trace,ts);
1625        }
1626        else {
1627                if (trace->format->seek_timeval) {
1628                        struct timeval tv;
1629#if __BYTE_ORDER == __BIG_ENDIAN
1630                        tv.tv_sec = ts & 0xFFFFFFFF;
1631#elif __BYTE_ORDER == __LITTLE_ENDIAN
1632                        tv.tv_sec = ts >> 32;
1633#else
1634#error "What on earth are you running this on?"
1635#endif
1636                        tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
1637                        if (tv.tv_usec >= 1000000) {
1638                                tv.tv_usec -= 1000000;
1639                                tv.tv_sec += 1;
1640                        }
1641                        return trace->format->seek_timeval(trace,tv);
1642                }
1643                if (trace->format->seek_seconds) {
1644                        double seconds = 
1645                                (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
1646                        return trace->format->seek_seconds(trace,seconds);
1647                }
1648                trace_set_err(trace,
1649                                TRACE_ERR_OPTION_UNAVAIL,
1650                                "Feature unimplemented");
1651                return -1;
1652        }
1653}
1654
1655DLLEXPORT int trace_seek_seconds(libtrace_t *trace, double seconds)
1656{
1657        if (trace->format->seek_seconds) {
1658                return trace->format->seek_seconds(trace,seconds);
1659        }
1660        else {
1661                if (trace->format->seek_timeval) {
1662                        struct timeval tv;
1663                        tv.tv_sec = (uint32_t)seconds;
1664                        tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
1665                        return trace->format->seek_timeval(trace,tv);
1666                }
1667                if (trace->format->seek_erf) {
1668                        uint64_t timestamp = 
1669                                ((uint64_t)((uint32_t)seconds) << 32) + \
1670                            (uint64_t)(( seconds - (uint32_t)seconds   ) * UINT_MAX);
1671                        return trace->format->seek_erf(trace,timestamp);
1672                }
1673                trace_set_err(trace,
1674                                TRACE_ERR_OPTION_UNAVAIL,
1675                                "Feature unimplemented");
1676                return -1;
1677        }
1678}
1679
1680DLLEXPORT int trace_seek_timeval(libtrace_t *trace, struct timeval tv)
1681{
1682        if (trace->format->seek_timeval) {
1683                return trace->format->seek_timeval(trace,tv);
1684        }
1685        else {
1686                if (trace->format->seek_erf) {
1687                        uint64_t timestamp = ((((uint64_t)tv.tv_sec) << 32) + \
1688                                (((uint64_t)tv.tv_usec * UINT_MAX)/1000000));
1689                        return trace->format->seek_erf(trace,timestamp);
1690                }
1691                if (trace->format->seek_seconds) {
1692                        double seconds = tv.tv_sec + ((tv.tv_usec * 1.0)/1000000);
1693                        return trace->format->seek_seconds(trace,seconds);
1694                }
1695                trace_set_err(trace,
1696                                TRACE_ERR_OPTION_UNAVAIL,
1697                                "Feature unimplemented");
1698                return -1;
1699        }
1700}
1701
1702/* Converts a binary ethernet MAC address into a printable string */
1703DLLEXPORT char *trace_ether_ntoa(const uint8_t *addr, char *buf)
1704{
1705        static char staticbuf[18]={0,};
1706        if (!buf)
1707                buf=staticbuf;
1708        snprintf(buf,(size_t)18,"%02x:%02x:%02x:%02x:%02x:%02x",
1709                        addr[0],addr[1],addr[2],
1710                        addr[3],addr[4],addr[5]);
1711        return buf;
1712}
1713
1714/* Converts a printable ethernet MAC address into a binary format */
1715DLLEXPORT uint8_t *trace_ether_aton(const char *buf, uint8_t *addr)
1716{
1717        uint8_t *buf2 = addr;
1718        unsigned int tmp[6];
1719        static uint8_t staticaddr[6];
1720        if (!buf2)
1721                buf2=staticaddr;
1722        sscanf(buf,"%x:%x:%x:%x:%x:%x",
1723                        &tmp[0],&tmp[1],&tmp[2],
1724                        &tmp[3],&tmp[4],&tmp[5]);
1725        buf2[0]=tmp[0]; buf2[1]=tmp[1]; buf2[2]=tmp[2];
1726        buf2[3]=tmp[3]; buf2[4]=tmp[4]; buf2[5]=tmp[5];
1727        return buf2;
1728}
1729
1730
1731/* Creates a libtrace packet from scratch using the contents of the provided
1732 * buffer as the packet payload.
1733 *
1734 * Unlike trace_prepare_packet(), the buffer should not contain any capture
1735 * format headers; instead this function will add the PCAP header to the
1736 * packet record. This also means only PCAP packets can be constructed using
1737 * this function.
1738 *
1739 */
1740DLLEXPORT
1741void trace_construct_packet(libtrace_packet_t *packet,
1742                libtrace_linktype_t linktype,
1743                const void *data,
1744                uint16_t len)
1745{
1746        size_t size;
1747        static libtrace_t *deadtrace=NULL;
1748        libtrace_pcapfile_pkt_hdr_t hdr;
1749#ifdef WIN32
1750        struct _timeb tstruct;
1751#else
1752        struct timeval tv;
1753#endif
1754
1755        /* We need a trace to attach the constructed packet to (and it needs
1756         * to be PCAP) */
1757        if (NULL == deadtrace) 
1758                deadtrace=trace_create_dead("pcapfile");
1759
1760        /* Fill in the new PCAP header */
1761#ifdef WIN32
1762        _ftime(&tstruct);
1763        hdr.ts_sec=tstruct.time;
1764        hdr.ts_usec=tstruct.millitm * 1000;
1765#else
1766        gettimeofday(&tv,NULL);
1767        hdr.ts_sec=tv.tv_sec;
1768        hdr.ts_usec=tv.tv_usec;
1769#endif
1770
1771        hdr.caplen=len;
1772        hdr.wirelen=len;
1773
1774        /* Now fill in the libtrace packet itself */
1775        packet->trace=deadtrace;
1776        size=len+sizeof(hdr);
1777        if (packet->buf_control==TRACE_CTRL_PACKET) {
1778                packet->buffer=realloc(packet->buffer,size);
1779        }
1780        else {
1781                packet->buffer=malloc(size);
1782        }
1783        packet->buf_control=TRACE_CTRL_PACKET;
1784        packet->header=packet->buffer;
1785        packet->payload=(void*)((char*)packet->buffer+sizeof(hdr));
1786       
1787        /* Ugh, memcpy - sadly necessary */
1788        memcpy(packet->header,&hdr,sizeof(hdr));
1789        memcpy(packet->payload,data,(size_t)len);
1790        packet->type=pcap_linktype_to_rt(libtrace_to_pcap_linktype(linktype));
1791
1792        trace_clear_cache(packet);
1793}
1794
1795
1796uint64_t trace_get_received_packets(libtrace_t *trace)
1797{
1798        assert(trace);
1799        if (trace->format->get_received_packets) {
1800                return trace->format->get_received_packets(trace);
1801        }
1802        return (uint64_t)-1;
1803}
1804
1805uint64_t trace_get_filtered_packets(libtrace_t *trace)
1806{
1807        assert(trace);
1808        if (trace->format->get_filtered_packets) {
1809                return trace->format->get_filtered_packets(trace)+
1810                        trace->filtered_packets;
1811        }
1812        if (trace->format->get_received_packets
1813                && trace->format->get_dropped_packets) {
1814                return 
1815                        ((trace_get_received_packets(trace)
1816                        -trace_get_accepted_packets(trace))
1817                        -trace_get_dropped_packets(trace))
1818                        +trace->filtered_packets;
1819        }
1820        return trace->filtered_packets;
1821}
1822
1823uint64_t trace_get_dropped_packets(libtrace_t *trace)
1824{
1825        assert(trace);
1826        if (trace->format->get_dropped_packets) {
1827                return trace->format->get_dropped_packets(trace);
1828        }
1829        return (uint64_t)-1;
1830}
1831
1832uint64_t trace_get_accepted_packets(libtrace_t *trace)
1833{
1834        assert(trace);
1835        return trace->accepted_packets;
1836}
1837
1838void trace_clear_cache(libtrace_packet_t *packet) {
1839
1840        packet->l2_header = NULL;
1841        packet->l3_header = NULL;
1842        packet->l4_header = NULL;
1843        packet->link_type = 0;
1844        packet->l3_ethertype = 0;
1845        packet->transport_proto = 0;
1846        packet->capture_length = -1;
1847        packet->wire_length = -1;
1848        packet->payload_length = -1;
1849        packet->l2_remaining = 0;
1850        packet->l3_remaining = 0;
1851        packet->l4_remaining = 0;
1852
1853}
1854
1855void trace_interrupt(void) {
1856        libtrace_halt = 1;
1857}
1858
1859void register_format(struct libtrace_format_t *f) {
1860        assert(f->next==NULL); /* Can't register a format twice */
1861        f->next=formats_list;
1862        formats_list=f;
1863
1864        /* Now, verify that the format has at least the minimum functionality.
1865         *
1866         * This #if can be changed to a 1 to output warnings about inconsistent
1867         * functions being provided by format modules.  This generally is very
1868         * noisy, as almost all modules don't implement one or more functions
1869         * for various reasons.  This is very useful when checking a new
1870         * format module is sane.
1871         */ 
1872#if 0
1873        if (f->init_input) {
1874#define REQUIRE(x) \
1875                if (!f->x) \
1876                        fprintf(stderr,"%s: Input format should provide " #x "\n",f->name)
1877                REQUIRE(read_packet);
1878                REQUIRE(start_input);
1879                REQUIRE(fin_input);
1880                REQUIRE(get_link_type);
1881                REQUIRE(get_capture_length);
1882                REQUIRE(get_wire_length);
1883                REQUIRE(get_framing_length);
1884                REQUIRE(trace_event);
1885                if (!f->get_erf_timestamp
1886                        && !f->get_seconds
1887                        && !f->get_timeval) {
1888                        fprintf(stderr,"%s: A trace format capable of input, should provide at least one of\n"
1889"get_erf_timestamp, get_seconds or trace_timeval\n",f->name);
1890                }
1891                if (f->trace_event!=trace_event_trace) {
1892                        /* Theres nothing that a trace file could optimise with
1893                         * config_input
1894                         */
1895                        REQUIRE(pause_input);
1896                        REQUIRE(config_input);
1897                        REQUIRE(get_fd);
1898                }
1899                else {
1900                        if (f->get_fd) {
1901                                fprintf(stderr,"%s: Unnecessary get_fd\n",
1902                                                f->name);
1903                        }
1904                }
1905#undef REQUIRE
1906        }
1907        else {
1908#define REQUIRE(x) \
1909                if (f->x) \
1910                        fprintf(stderr,"%s: Non Input format shouldn't need " #x "\n",f->name)
1911                REQUIRE(read_packet);
1912                REQUIRE(start_input);
1913                REQUIRE(pause_input);
1914                REQUIRE(fin_input);
1915                REQUIRE(get_link_type);
1916                REQUIRE(get_capture_length);
1917                REQUIRE(get_wire_length);
1918                REQUIRE(get_framing_length);
1919                REQUIRE(trace_event);
1920                REQUIRE(get_seconds);
1921                REQUIRE(get_timeval);
1922                REQUIRE(get_erf_timestamp);
1923#undef REQUIRE
1924        }
1925        if (f->init_output) {
1926#define REQUIRE(x) \
1927                if (!f->x) \
1928                        fprintf(stderr,"%s: Output format should provide " #x "\n",f->name)
1929                REQUIRE(write_packet);
1930                REQUIRE(start_output);
1931                REQUIRE(config_output);
1932                REQUIRE(fin_output);
1933#undef REQUIRE
1934        }
1935        else {
1936#define REQUIRE(x) \
1937                if (f->x) \
1938                        fprintf(stderr,"%s: Non Output format shouldn't need " #x "\n",f->name)
1939                REQUIRE(write_packet);
1940                REQUIRE(start_output);
1941                REQUIRE(config_output);
1942                REQUIRE(fin_output);
1943#undef REQUIRE
1944        }
1945#endif
1946}
1947
Note: See TracBrowser for help on using the repository browser.