source: lib/trace.c @ dfbdd796

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