source: lib/trace.c @ d3320d1

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