source: lib/trace.c @ f6e8d46

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since f6e8d46 was f6e8d46, checked in by Perry Lorier <perry@…>, 11 years ago

Fix wrong error message for realtime events

  • Property mode set to 100644
File size: 50.5 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        assert(packet != NULL);
820        if (linktype) *linktype = trace_get_link_type(packet);
821        if (remaining) *remaining = trace_get_capture_length(packet);
822        return (void *) packet->payload;
823}
824
825
826/* Get a pointer to the first byte of the packet payload
827 *
828 * DEPRECATED - use trace_get_packet_buffer() instead */
829DLLEXPORT void *trace_get_link(const libtrace_packet_t *packet) {
830        return (void *)packet->payload;
831}
832
833/* Get the current time in DAG time format
834 * @param packet        a pointer to a libtrace_packet structure
835 * @returns a 64 bit timestamp in DAG ERF format (upper 32 bits are the seconds
836 * past 1970-01-01, the lower 32bits are partial seconds)
837 */ 
838DLLEXPORT uint64_t trace_get_erf_timestamp(const libtrace_packet_t *packet) {
839        if (packet->trace->format->get_erf_timestamp) {
840                /* timestamp -> timestamp */
841                return packet->trace->format->get_erf_timestamp(packet);
842        } else if (packet->trace->format->get_timespec) {
843                /* timespec -> timestamp */
844                struct timespec ts;
845                ts = packet->trace->format->get_timespec(packet);
846                return ((((uint64_t)ts.tv_sec) << 32) +
847                                (((uint64_t)ts.tv_nsec << 32)/1000000000));
848        } else if (packet->trace->format->get_timeval) {
849                /* timeval -> timestamp */
850                struct timeval tv;
851                tv = packet->trace->format->get_timeval(packet);
852                return ((((uint64_t)tv.tv_sec) << 32) +
853                                (((uint64_t)tv.tv_usec << 32)/1000000));
854        } else if (packet->trace->format->get_seconds) {
855                /* seconds -> timestamp */
856                double seconds = packet->trace->format->get_seconds(packet);
857                return (((uint64_t)seconds)<<32)
858                          + (uint64_t)((seconds-(uint64_t)seconds)*UINT_MAX);
859        }
860        else {
861                return (uint64_t)0;
862        }
863                     
864}
865
866/* Get the current time in struct timeval
867 * @param packet        a pointer to a libtrace_packet structure
868 *
869 * @returns time that this packet was seen in a struct timeval
870 * @author Daniel Lawson
871 * @author Perry Lorier
872 */ 
873DLLEXPORT struct timeval trace_get_timeval(const libtrace_packet_t *packet) {
874        struct timeval tv;
875        uint64_t ts = 0;
876        if (packet->trace->format->get_timeval) {
877                /* timeval -> timeval */
878                tv = packet->trace->format->get_timeval(packet);
879        } else if (packet->trace->format->get_erf_timestamp) {
880                /* timestamp -> timeval */
881                ts = packet->trace->format->get_erf_timestamp(packet);
882#if __BYTE_ORDER == __BIG_ENDIAN
883                tv.tv_sec = ts & 0xFFFFFFFF;
884#elif __BYTE_ORDER == __LITTLE_ENDIAN
885                tv.tv_sec = ts >> 32;
886#else
887#error "What on earth are you running this on?"
888#endif
889                tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
890                if (tv.tv_usec >= 1000000) {
891                        tv.tv_usec -= 1000000;
892                        tv.tv_sec += 1;
893                }
894        } else if (packet->trace->format->get_timespec) {
895                struct timespec ts = packet->trace->format->get_timespec(packet);
896                tv.tv_sec = ts.tv_sec;
897                tv.tv_usec = ts.tv_nsec/1000;
898        } else if (packet->trace->format->get_seconds) {
899                /* seconds -> timeval */
900                double seconds = packet->trace->format->get_seconds(packet);
901                tv.tv_sec = (uint32_t)seconds;
902                tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
903        }
904        else {
905                tv.tv_sec=-1;
906                tv.tv_usec=-1;
907        }
908
909        return tv;
910}
911
912DLLEXPORT struct timespec trace_get_timespec(const libtrace_packet_t *packet) {
913        struct timespec ts;
914
915        if (packet->trace->format->get_timespec) {
916                return packet->trace->format->get_timespec(packet);
917        } else if (packet->trace->format->get_erf_timestamp) {
918                /* timestamp -> timeval */
919                uint64_t erfts = packet->trace->format->get_erf_timestamp(packet);
920#if __BYTE_ORDER == __BIG_ENDIAN
921                ts.tv_sec = erfts & 0xFFFFFFFF;
922#elif __BYTE_ORDER == __LITTLE_ENDIAN
923                ts.tv_sec = erfts >> 32;
924#else
925#error "What on earth are you running this on?"
926#endif
927                ts.tv_nsec = ((erfts&0xFFFFFFFF)*1000000000)>>32;
928                if (ts.tv_nsec >= 1000000000) {
929                        ts.tv_nsec -= 1000000000;
930                        ts.tv_sec += 1;
931                }
932                return ts;
933        } else if (packet->trace->format->get_timeval) {
934                /* timeval -> timespec */
935                struct timeval tv = packet->trace->format->get_timeval(packet);
936                ts.tv_sec = tv.tv_sec;
937                ts.tv_nsec = tv.tv_usec*1000;
938                return ts;
939        } else if (packet->trace->format->get_seconds) {
940                /* seconds -> timespec */
941                double seconds = packet->trace->format->get_seconds(packet);
942                ts.tv_sec = (uint32_t)seconds;
943                ts.tv_nsec = (long)(((seconds - ts.tv_sec) * 1000000000)/UINT_MAX);
944                return ts;
945        }
946        else {
947                ts.tv_sec=-1;
948                ts.tv_nsec=-1;
949                return ts;
950        }
951}
952
953
954/* Get the current time in floating point seconds
955 * @param packet        a pointer to a libtrace_packet structure
956 * @returns time that this packet was seen in 64bit floating point seconds
957 */ 
958DLLEXPORT double trace_get_seconds(const libtrace_packet_t *packet) {
959        double seconds = 0.0;
960
961        if (packet->trace->format->get_seconds) {
962                /* seconds->seconds */
963                seconds = packet->trace->format->get_seconds(packet);
964        } else if (packet->trace->format->get_erf_timestamp) {
965                /* timestamp -> seconds */
966                uint64_t ts = 0;
967                ts = packet->trace->format->get_erf_timestamp(packet);
968                seconds =  (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
969        } else if (packet->trace->format->get_timespec) {
970                /* timespec -> seconds */
971                struct timespec ts;
972                ts = packet->trace->format->get_timespec(packet);
973                seconds = ts.tv_sec + ((ts.tv_nsec * 1.0) / 1000000000);
974        } else if (packet->trace->format->get_timeval) {
975                /* timeval -> seconds */
976                struct timeval tv;
977                tv = packet->trace->format->get_timeval(packet);
978                seconds = tv.tv_sec + ((tv.tv_usec * 1.0) / 1000000);
979        }
980
981        return seconds;
982}
983
984DLLEXPORT size_t trace_get_capture_length(const libtrace_packet_t *packet) 
985{
986        /* Cache the capture length */
987        if (packet->capture_length == -1) {
988                if (!packet->trace->format->get_capture_length)
989                        return ~0U;
990                /* Cast away constness because this is "just" a cache */
991                ((libtrace_packet_t*)packet)->capture_length = 
992                        packet->trace->format->get_capture_length(packet);
993        }
994
995        assert(packet->capture_length < LIBTRACE_PACKET_BUFSIZE);
996
997        return packet->capture_length;
998}
999       
1000/* Get the size of the packet as it was seen on the wire.
1001 * @param packet        a pointer to a libtrace_packet structure
1002 *
1003 * @returns the size of the packet as it was on the wire.
1004 * @note Due to the trace being a header capture, or anonymisation this may
1005 * not be the same as the Capture Len.
1006 */ 
1007DLLEXPORT size_t trace_get_wire_length(const libtrace_packet_t *packet){
1008        if (packet->trace->format->get_wire_length) {
1009                return packet->trace->format->get_wire_length(packet);
1010        }
1011        return ~0U;
1012
1013}
1014
1015/* Get the length of the capture framing headers.
1016 * @param packet        the packet opaque pointer
1017 * @returns the size of the packet as it was on the wire.
1018 * @note this length corresponds to the difference between the size of a
1019 * captured packet in memory, and the captured length of the packet
1020 */ 
1021DLLEXPORT SIMPLE_FUNCTION
1022size_t trace_get_framing_length(const libtrace_packet_t *packet) {
1023        if (packet->trace->format->get_framing_length) {
1024                return packet->trace->format->get_framing_length(packet);
1025        }
1026        return ~0U;
1027}
1028
1029
1030/* Get the type of the link layer
1031 * @param packet        a pointer to a libtrace_packet structure
1032 * @returns libtrace_linktype_t
1033 */
1034DLLEXPORT libtrace_linktype_t trace_get_link_type(const libtrace_packet_t *packet ) {
1035        if (packet->trace->format->get_link_type) {
1036                return packet->trace->format->get_link_type(packet);
1037        }
1038        return (libtrace_linktype_t)-1;
1039}
1040
1041/* process a libtrace event
1042 * @param trace the libtrace opaque pointer
1043 * @param packet the libtrace_packet opaque pointer
1044 * @returns
1045 *  TRACE_EVENT_IOWAIT  Waiting on I/O on fd
1046 *  TRACE_EVENT_SLEEP   Next event in seconds
1047 *  TRACE_EVENT_PACKET  Packet arrived in buffer with size size
1048 *  TRACE_EVENT_TERMINATE Trace terminated (perhaps with an error condition)
1049 * FIXME currently keeps a copy of the packet inside the trace pointer,
1050 * which in turn is stored inside the new packet object...
1051 */
1052DLLEXPORT libtrace_eventobj_t trace_event(libtrace_t *trace, 
1053                libtrace_packet_t *packet) {
1054        libtrace_eventobj_t event = {TRACE_EVENT_IOWAIT,0,0.0,0};
1055
1056        if (!trace) {
1057                fprintf(stderr,"You called trace_event() with a NULL trace object!\n");
1058        }
1059        assert(trace);
1060        assert(packet);
1061
1062        /* Clear the packet cache */
1063        packet->capture_length = -1;
1064        packet->l3_header = NULL;
1065        packet->l3_ethertype = 0;
1066       
1067        /* Store the trace we are reading from into the packet opaque
1068         * structure */
1069        packet->trace = trace;
1070
1071        if (packet->trace->format->trace_event) {
1072                event=packet->trace->format->trace_event(trace,packet);
1073                if (event.type == TRACE_EVENT_PACKET) {
1074                        ++trace->accepted_packets;
1075                }
1076        }
1077        return event;
1078
1079}
1080
1081/** Setup a BPF filter based on pre-compiled byte-code.
1082 * @param bf_insns      A pointer to the start of the byte-code
1083 * @param bf_len        The number of BPF instructions
1084 * @returns             an opaque pointer to a libtrace_filter_t object
1085 * @note                The supplied byte-code is not checked for correctness.
1086 * @author              Scott Raynel
1087 */
1088DLLEXPORT libtrace_filter_t *
1089trace_create_filter_from_bytecode(void *bf_insns, unsigned int bf_len)
1090{
1091#ifndef HAVE_BPF_FILTER
1092        fprintf(stderr, "This version of libtrace does not have BPF support\n");
1093        return NULL;
1094#else
1095        struct libtrace_filter_t *filter = (struct libtrace_filter_t *)
1096                malloc(sizeof(struct libtrace_filter_t));
1097        filter->filter.bf_insns = (struct bpf_insn *)
1098                malloc(sizeof(struct bpf_insn) * bf_len);
1099       
1100        memcpy(filter->filter.bf_insns, bf_insns,
1101                        bf_len * sizeof(struct bpf_insn));
1102       
1103        filter->filter.bf_len = bf_len;
1104        filter->filterstring = NULL;
1105        /* "flag" indicates that the filter member is valid */
1106        filter->flag = 1; 
1107       
1108        return filter;
1109#endif
1110}
1111
1112/* Create a BPF filter
1113 * @param filterstring a char * containing the bpf filter string
1114 * @returns opaque pointer pointer to a libtrace_filter_t object
1115 */
1116DLLEXPORT libtrace_filter_t *trace_create_filter(const char *filterstring) {
1117#ifdef HAVE_BPF_FILTER
1118        libtrace_filter_t *filter = (libtrace_filter_t*)
1119                                malloc(sizeof(libtrace_filter_t));
1120        filter->filterstring = strdup(filterstring);
1121        filter->flag = 0;
1122        return filter;
1123#else
1124        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1125        return NULL;
1126#endif
1127}
1128
1129DLLEXPORT void trace_destroy_filter(libtrace_filter_t *filter)
1130{
1131#ifdef HAVE_BPF_FILTER
1132        free(filter->filterstring);
1133        if (filter->flag)
1134                pcap_freecode(&filter->filter);
1135        free(filter);
1136#else
1137
1138#endif
1139}
1140
1141/* Compile a bpf filter, now we know the link type for the trace that we're
1142 * applying it to.
1143 *
1144 * @internal
1145 *
1146 * @returns -1 on error, 0 on success
1147 */
1148static int trace_bpf_compile(libtrace_filter_t *filter,
1149                const libtrace_packet_t *packet ) {
1150#ifdef HAVE_BPF_FILTER
1151        void *linkptr = 0;
1152        libtrace_linktype_t linktype;
1153        assert(filter);
1154
1155        /* If this isn't a real packet, then fail */
1156        linkptr = trace_get_packet_buffer(packet,&linktype,NULL);
1157        if (!linkptr) {
1158                trace_set_err(packet->trace,
1159                                TRACE_ERR_BAD_PACKET,"Packet has no payload");
1160                return -1;
1161        }
1162       
1163        if (filter->filterstring && ! filter->flag) {
1164                pcap_t *pcap = NULL;
1165                if (linktype==(libtrace_linktype_t)-1) {
1166                        trace_set_err(packet->trace,
1167                                        TRACE_ERR_BAD_PACKET,
1168                                        "Packet has an unknown linktype");
1169                        return -1;
1170                }
1171                if (libtrace_to_pcap_dlt(linktype) == ~1U) {
1172                        trace_set_err(packet->trace,TRACE_ERR_BAD_PACKET,
1173                                        "Unknown pcap equivalent linktype");
1174                        return -1;
1175                }
1176                pcap=(pcap_t *)pcap_open_dead(
1177                                (int)libtrace_to_pcap_dlt(linktype),
1178                                1500U);
1179                /* build filter */
1180                assert(pcap);
1181                if (pcap_compile( pcap, &filter->filter, filter->filterstring, 
1182                                        1, 0)) {
1183                        trace_set_err(packet->trace,TRACE_ERR_BAD_PACKET,
1184                                        "Unable to compile the filter \"%s\": %s", 
1185                                        filter->filterstring,
1186                                        pcap_geterr(pcap));
1187                        pcap_close(pcap);
1188                        return -1;
1189                }
1190                pcap_close(pcap);
1191                filter->flag=1;
1192        }
1193        return 0;
1194#else
1195        assert(!"Internal bug: This should never be called when BPF not enabled");
1196        trace_set_err(packet->trace,TRACE_ERR_OPTION_UNAVAIL,
1197                                "Feature unavailable");
1198        return -1;
1199#endif
1200}
1201
1202DLLEXPORT int trace_apply_filter(libtrace_filter_t *filter,
1203                        const libtrace_packet_t *packet) {
1204#ifdef HAVE_BPF_FILTER
1205        void *linkptr = 0;
1206        uint32_t clen = 0;
1207        bool free_packet_needed = false;
1208        int ret;
1209        libtrace_packet_t *packet_copy = (libtrace_packet_t*)packet;
1210
1211        assert(filter);
1212        assert(packet);
1213
1214        if (libtrace_to_pcap_dlt(trace_get_link_type(packet))==~0U) {
1215               
1216                /* If we cannot get a suitable DLT for the packet, it may
1217                 * be because the packet is encapsulated in a link type that
1218                 * does not correspond to a DLT. Therefore, we should try
1219                 * popping off headers until we either can find a suitable
1220                 * link type or we can't do any more sensible decapsulation. */
1221               
1222                /* Copy the packet, as we don't want to trash the one we
1223                 * were passed in */
1224                packet_copy=trace_copy_packet(packet);
1225                free_packet_needed=true;
1226
1227                while (libtrace_to_pcap_dlt(trace_get_link_type(packet_copy))==
1228                                ~0U) {
1229                        if (!demote_packet(packet_copy)) {
1230                                trace_set_err(packet->trace, 
1231                                                TRACE_ERR_NO_CONVERSION,
1232                                                "pcap does not support this format");
1233                                if (free_packet_needed) {
1234                                        trace_destroy_packet(packet_copy);
1235                                }
1236                                return -1;
1237                        }
1238                }
1239        }
1240       
1241        linkptr = trace_get_packet_buffer(packet_copy,NULL,&clen);
1242        if (!linkptr) {
1243                if (free_packet_needed) {
1244                        trace_destroy_packet(packet_copy);
1245                }
1246                return 0;
1247        }
1248
1249        /* We need to compile the filter now, because before we didn't know
1250         * what the link type was
1251         */
1252        if (trace_bpf_compile(filter,packet_copy)==-1) {
1253                if (free_packet_needed) {
1254                        trace_destroy_packet(packet_copy);
1255                }
1256                return -1;
1257        }
1258
1259        assert(filter->flag);
1260        ret=bpf_filter(filter->filter.bf_insns,(u_char*)linkptr,(unsigned int)clen,(unsigned int)clen);
1261
1262        /* If we copied the packet earlier, make sure that we free it */
1263        if (free_packet_needed) {
1264                trace_destroy_packet(packet_copy);
1265        }
1266        return ret;
1267#else
1268        fprintf(stderr,"This version of libtrace does not have bpf filter support\n");
1269        return 0;
1270#endif
1271}
1272
1273/* Set the direction flag, if it has one
1274 * @param packet the packet opaque pointer
1275 * @param direction the new direction (0,1,2,3)
1276 * @returns a signed value containing the direction flag, or -1 if this is not supported
1277 */
1278DLLEXPORT libtrace_direction_t trace_set_direction(libtrace_packet_t *packet, 
1279                libtrace_direction_t direction) 
1280{
1281        assert(packet);
1282        if (packet->trace->format->set_direction) {
1283                return packet->trace->format->set_direction(packet,direction);
1284        }
1285        return (libtrace_direction_t)~0U;
1286}
1287
1288/* Get the direction flag, if it has one
1289 * @param packet a pointer to a libtrace_packet structure
1290 * @returns a signed value containing the direction flag, or -1 if this is not supported
1291 * The direction is defined as 0 for packets originating locally (ie, outbound)
1292 * and 1 for packets originating remotely (ie, inbound).
1293 * Other values are possible, which might be overloaded to mean special things
1294 * for a special trace.
1295 */
1296DLLEXPORT libtrace_direction_t trace_get_direction(const libtrace_packet_t *packet) 
1297{
1298        assert(packet);
1299        if (packet->trace->format->get_direction) {
1300                return packet->trace->format->get_direction(packet);
1301        }
1302        return (libtrace_direction_t)~0U;
1303}
1304
1305#define ROOT_SERVER(x) ((x) < 512)
1306#define ROOT_CLIENT(x) ((512 <= (x)) && ((x) < 1024))
1307#define NONROOT_SERVER(x) ((x) >= 5000)
1308#define NONROOT_CLIENT(x) ((1024 <= (x)) && ((x) < 5000))
1309#define DYNAMIC(x) ((49152 < (x)) && ((x) < 65535))
1310#define SERVER(x) ROOT_SERVER(x) || NONROOT_SERVER(x)
1311#define CLIENT(x) ROOT_CLIENT(x) || NONROOT_CLIENT(x)
1312
1313/* Attempt to deduce the 'server' port
1314 * @param protocol the IP protocol (eg, 6 or 17 for TCP or UDP)
1315 * @param source the TCP or UDP source port
1316 * @param dest the TCP or UDP destination port
1317 * @returns a hint as to which port is the server port
1318 */
1319DLLEXPORT int8_t trace_get_server_port(UNUSED uint8_t protocol, 
1320                uint16_t source, uint16_t dest) 
1321{
1322        /*
1323         * * If the ports are equal, return DEST
1324         * * Check for well-known ports in the given protocol
1325         * * Root server ports: 0 - 511
1326         * * Root client ports: 512 - 1023
1327         * * non-root client ports: 1024 - 4999
1328         * * non-root server ports: 5000+
1329         * * Check for static ranges: 1024 - 49151
1330         * * Check for dynamic ranges: 49152 - 65535
1331         * * flip a coin.
1332         */
1333       
1334        /* equal */
1335        if (source == dest)
1336                return USE_DEST;
1337
1338        /* root server port, 0 - 511 */
1339        if (ROOT_SERVER(source) && ROOT_SERVER(dest)) {
1340                if (source < dest)
1341                        return USE_SOURCE;
1342                return USE_DEST;
1343        }
1344
1345        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1346                return USE_SOURCE;
1347        if (!ROOT_SERVER(source) && ROOT_SERVER(dest))
1348                return USE_DEST;
1349
1350        /* non-root server */
1351        if (NONROOT_SERVER(source) && NONROOT_SERVER(dest)) {
1352                if (source < dest)
1353                        return USE_SOURCE;
1354                return USE_DEST;
1355        }
1356        if (NONROOT_SERVER(source) && !NONROOT_SERVER(dest))
1357                return USE_SOURCE;
1358        if (!NONROOT_SERVER(source) && NONROOT_SERVER(dest))
1359                return USE_DEST;
1360
1361        /* root client */
1362        if (ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1363                if (source < dest)
1364                        return USE_SOURCE;
1365                return USE_DEST;
1366        }
1367        if (ROOT_CLIENT(source) && !ROOT_CLIENT(dest)) {
1368                /* prefer root-client over nonroot-client */
1369                if (NONROOT_CLIENT(dest))
1370                        return USE_SOURCE;
1371                return USE_DEST;
1372        }
1373        if (!ROOT_CLIENT(source) && ROOT_CLIENT(dest)) {
1374                /* prefer root-client over nonroot-client */
1375                if (NONROOT_CLIENT(source))
1376                        return USE_DEST;
1377                return USE_SOURCE;
1378        }
1379       
1380        /* nonroot client */
1381        if (NONROOT_CLIENT(source) && NONROOT_CLIENT(dest)) {
1382                if (source < dest) 
1383                        return USE_SOURCE;
1384                return USE_DEST;
1385        }
1386        if (NONROOT_CLIENT(source) && !NONROOT_CLIENT(dest))
1387                return USE_DEST;
1388        if (!NONROOT_CLIENT(source) && NONROOT_CLIENT(dest))
1389                return USE_SOURCE;
1390
1391        /* dynamic range */
1392        if (DYNAMIC(source) && DYNAMIC(dest)) {
1393                if (source < dest)
1394                        return USE_SOURCE;
1395                return USE_DEST;
1396        }
1397        if (DYNAMIC(source) && !DYNAMIC(dest))
1398                return USE_DEST;
1399        if (!DYNAMIC(source) && DYNAMIC(dest))
1400                return USE_SOURCE;
1401        /*
1402        if (SERVER(source) && CLIENT(dest))
1403                return USE_SOURCE;
1404       
1405        if (SERVER(dest) && CLIENT(source))
1406                return USE_DEST;
1407        if (ROOT_SERVER(source) && !ROOT_SERVER(dest))
1408                return USE_SOURCE;
1409        if (ROOT_SERVER(dest) && !ROOT_SERVER(source))
1410                return USE_DEST;
1411        */
1412        /* failing that test... */
1413        if (source < dest) {
1414                return USE_SOURCE;
1415        } 
1416        return USE_DEST;
1417       
1418}
1419
1420/* Truncate the packet at the suggested length
1421 * @param packet        the packet opaque pointer
1422 * @param size          the new length of the packet
1423 * @returns the new size of the packet
1424 * @note size and the return size refer to the network-level payload of the
1425 * packet, and do not include any capture headers. For example, to truncate a
1426 * packet after the IP header, set size to sizeof(ethernet_header) +
1427 * sizeof(ip_header)
1428 * @note If the original network-level payload is smaller than size, then the
1429 * original size is returned and the packet is left unchanged.
1430 */
1431DLLEXPORT size_t trace_set_capture_length(libtrace_packet_t *packet, size_t size) {
1432        assert(packet);
1433
1434        if (packet->trace->format->set_capture_length) {
1435                return packet->trace->format->set_capture_length(packet,size);
1436        }
1437
1438        return ~0U;
1439}
1440
1441/* Splits a URI into two components - the format component which is seen before
1442 * the ':', and the uridata which follows the ':'.
1443 *
1444 * Returns a pointer to the URI data, but updates the format parameter to
1445 * point to a copy of the format component.
1446 */
1447
1448DLLEXPORT const char * trace_parse_uri(const char *uri, char **format) {
1449        const char *uridata = 0;
1450       
1451        if((uridata = strchr(uri,':')) == NULL) {
1452                /* Badly formed URI - needs a : */
1453                return 0;
1454        }
1455
1456        if ((unsigned)(uridata - uri) > URI_PROTO_LINE) {
1457                /* Badly formed URI - uri type is too long */
1458                return 0;
1459        }
1460
1461        /* NOTE: this is allocated memory - it should be freed by the caller
1462         * once they are done with it */
1463        *format=xstrndup(uri, (size_t)(uridata - uri));
1464
1465        /* Push uridata past the delimiter */
1466        uridata++;
1467       
1468        return uridata;
1469}
1470
1471enum base_format_t trace_get_format(libtrace_packet_t *packet) 
1472{
1473        assert(packet);
1474
1475        return packet->trace->format->type;
1476}
1477       
1478DLLEXPORT libtrace_err_t trace_get_err(libtrace_t *trace)
1479{
1480        libtrace_err_t err = trace->err;
1481        trace->err.err_num = 0; /* "OK" */
1482        trace->err.problem[0]='\0';
1483        return err;
1484}
1485
1486DLLEXPORT bool trace_is_err(libtrace_t *trace)
1487{
1488        return trace->err.err_num != 0;
1489}
1490
1491/* Prints the input error status to standard error and clears the error state */
1492DLLEXPORT void trace_perror(libtrace_t *trace,const char *msg,...)
1493{
1494        char buf[256];
1495        va_list va;
1496        va_start(va,msg);
1497        vsnprintf(buf,sizeof(buf),msg,va);
1498        va_end(va);
1499        if(trace->err.err_num) {
1500                if (trace->uridata) {
1501                        fprintf(stderr,"%s(%s): %s\n",
1502                                        buf,trace->uridata,trace->err.problem);
1503                } else {
1504                        fprintf(stderr,"%s: %s\n", buf, trace->err.problem);
1505                }
1506        } else {
1507                if (trace->uridata) {
1508                        fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
1509                } else {
1510                        fprintf(stderr,"%s: No error\n", buf);
1511                }
1512        }
1513        trace->err.err_num = 0; /* "OK" */
1514        trace->err.problem[0]='\0';
1515}
1516
1517DLLEXPORT libtrace_err_t trace_get_err_output(libtrace_out_t *trace)
1518{
1519        libtrace_err_t err = trace->err;
1520        trace->err.err_num = TRACE_ERR_NOERROR; /* "OK" */
1521        trace->err.problem[0]='\0';
1522        return err;
1523}
1524
1525DLLEXPORT bool trace_is_err_output(libtrace_out_t *trace)
1526{
1527        return trace->err.err_num != 0;
1528}
1529
1530/* Prints the output error status to standard error and clears the error state
1531 */
1532DLLEXPORT void trace_perror_output(libtrace_out_t *trace,const char *msg,...)
1533{
1534        char buf[256];
1535        va_list va;
1536        va_start(va,msg);
1537        vsnprintf(buf,sizeof(buf),msg,va);
1538        va_end(va);
1539        if(trace->err.err_num) {
1540                fprintf(stderr,"%s(%s): %s\n",
1541                                buf,
1542                                trace->uridata?trace->uridata:"no uri",
1543                                trace->err.problem);
1544        } else {
1545                fprintf(stderr,"%s(%s): No error\n",buf,trace->uridata);
1546        }
1547        trace->err.err_num = TRACE_ERR_NOERROR; /* "OK" */
1548        trace->err.problem[0]='\0';
1549}
1550
1551DLLEXPORT int trace_seek_erf_timestamp(libtrace_t *trace, uint64_t ts)
1552{
1553        if (trace->format->seek_erf) {
1554                return trace->format->seek_erf(trace,ts);
1555        }
1556        else {
1557                if (trace->format->seek_timeval) {
1558                        struct timeval tv;
1559#if __BYTE_ORDER == __BIG_ENDIAN
1560                        tv.tv_sec = ts & 0xFFFFFFFF;
1561#elif __BYTE_ORDER == __LITTLE_ENDIAN
1562                        tv.tv_sec = ts >> 32;
1563#else
1564#error "What on earth are you running this on?"
1565#endif
1566                        tv.tv_usec = ((ts&0xFFFFFFFF)*1000000)>>32;
1567                        if (tv.tv_usec >= 1000000) {
1568                                tv.tv_usec -= 1000000;
1569                                tv.tv_sec += 1;
1570                        }
1571                        return trace->format->seek_timeval(trace,tv);
1572                }
1573                if (trace->format->seek_seconds) {
1574                        double seconds = 
1575                                (ts>>32) + ((ts & UINT_MAX)*1.0 / UINT_MAX);
1576                        return trace->format->seek_seconds(trace,seconds);
1577                }
1578                trace_set_err(trace,
1579                                TRACE_ERR_OPTION_UNAVAIL,
1580                                "Feature unimplemented");
1581                return -1;
1582        }
1583}
1584
1585DLLEXPORT int trace_seek_seconds(libtrace_t *trace, double seconds)
1586{
1587        if (trace->format->seek_seconds) {
1588                return trace->format->seek_seconds(trace,seconds);
1589        }
1590        else {
1591                if (trace->format->seek_timeval) {
1592                        struct timeval tv;
1593                        tv.tv_sec = (uint32_t)seconds;
1594                        tv.tv_usec = (uint32_t)(((seconds - tv.tv_sec) * 1000000)/UINT_MAX);
1595                        return trace->format->seek_timeval(trace,tv);
1596                }
1597                if (trace->format->seek_erf) {
1598                        uint64_t timestamp = 
1599                                ((uint64_t)((uint32_t)seconds) << 32) + \
1600                            (uint64_t)(( seconds - (uint32_t)seconds   ) * UINT_MAX);
1601                        return trace->format->seek_erf(trace,timestamp);
1602                }
1603                trace_set_err(trace,
1604                                TRACE_ERR_OPTION_UNAVAIL,
1605                                "Feature unimplemented");
1606                return -1;
1607        }
1608}
1609
1610DLLEXPORT int trace_seek_timeval(libtrace_t *trace, struct timeval tv)
1611{
1612        if (trace->format->seek_timeval) {
1613                return trace->format->seek_timeval(trace,tv);
1614        }
1615        else {
1616                if (trace->format->seek_erf) {
1617                        uint64_t timestamp = ((((uint64_t)tv.tv_sec) << 32) + \
1618                                (((uint64_t)tv.tv_usec * UINT_MAX)/1000000));
1619                        return trace->format->seek_erf(trace,timestamp);
1620                }
1621                if (trace->format->seek_seconds) {
1622                        double seconds = tv.tv_sec + ((tv.tv_usec * 1.0)/1000000);
1623                        return trace->format->seek_seconds(trace,seconds);
1624                }
1625                trace_set_err(trace,
1626                                TRACE_ERR_OPTION_UNAVAIL,
1627                                "Feature unimplemented");
1628                return -1;
1629        }
1630}
1631
1632/* Converts a binary ethernet MAC address into a printable string */
1633DLLEXPORT char *trace_ether_ntoa(const uint8_t *addr, char *buf)
1634{
1635        static char staticbuf[18]={0,};
1636        if (!buf)
1637                buf=staticbuf;
1638        snprintf(buf,(size_t)18,"%02x:%02x:%02x:%02x:%02x:%02x",
1639                        addr[0],addr[1],addr[2],
1640                        addr[3],addr[4],addr[5]);
1641        return buf;
1642}
1643
1644/* Converts a printable ethernet MAC address into a binary format */
1645DLLEXPORT uint8_t *trace_ether_aton(const char *buf, uint8_t *addr)
1646{
1647        uint8_t *buf2 = addr;
1648        unsigned int tmp[6];
1649        static uint8_t staticaddr[6];
1650        if (!buf2)
1651                buf2=staticaddr;
1652        sscanf(buf,"%x:%x:%x:%x:%x:%x",
1653                        &tmp[0],&tmp[1],&tmp[2],
1654                        &tmp[3],&tmp[4],&tmp[5]);
1655        buf2[0]=tmp[0]; buf2[1]=tmp[1]; buf2[2]=tmp[2];
1656        buf2[3]=tmp[3]; buf2[4]=tmp[4]; buf2[5]=tmp[5];
1657        return buf2;
1658}
1659
1660
1661/* Creates a libtrace packet from scratch using the contents of the provided
1662 * buffer as the packet payload.
1663 *
1664 * Unlike trace_prepare_packet(), the buffer should not contain any capture
1665 * format headers; instead this function will add the PCAP header to the
1666 * packet record. This also means only PCAP packets can be constructed using
1667 * this function.
1668 *
1669 */
1670DLLEXPORT
1671void trace_construct_packet(libtrace_packet_t *packet,
1672                libtrace_linktype_t linktype,
1673                const void *data,
1674                uint16_t len)
1675{
1676        size_t size;
1677        static libtrace_t *deadtrace=NULL;
1678        libtrace_pcapfile_pkt_hdr_t hdr;
1679#ifdef WIN32
1680        struct _timeb tstruct;
1681#else
1682        struct timeval tv;
1683#endif
1684
1685        /* We need a trace to attach the constructed packet to (and it needs
1686         * to be PCAP) */
1687        if (NULL == deadtrace) 
1688                deadtrace=trace_create_dead("pcapfile");
1689
1690        /* Fill in the new PCAP header */
1691#ifdef WIN32
1692        _ftime(&tstruct);
1693        hdr.ts_sec=tstruct.time;
1694        hdr.ts_usec=tstruct.millitm * 1000;
1695#else
1696        gettimeofday(&tv,NULL);
1697        hdr.ts_sec=tv.tv_sec;
1698        hdr.ts_usec=tv.tv_usec;
1699#endif
1700
1701        hdr.caplen=len;
1702        hdr.wirelen=len;
1703
1704        /* Now fill in the libtrace packet itself */
1705        packet->trace=deadtrace;
1706        size=len+sizeof(hdr);
1707        if (packet->buf_control==TRACE_CTRL_PACKET) {
1708                packet->buffer=realloc(packet->buffer,size);
1709        }
1710        else {
1711                packet->buffer=malloc(size);
1712        }
1713        packet->buf_control=TRACE_CTRL_PACKET;
1714        packet->header=packet->buffer;
1715        packet->payload=(void*)((char*)packet->buffer+sizeof(hdr));
1716       
1717        /* Ugh, memcpy - sadly necessary */
1718        memcpy(packet->header,&hdr,sizeof(hdr));
1719        memcpy(packet->payload,data,(size_t)len);
1720        packet->type=pcap_linktype_to_rt(libtrace_to_pcap_linktype(linktype));
1721}
1722
1723
1724uint64_t trace_get_received_packets(libtrace_t *trace)
1725{
1726        assert(trace);
1727        if (trace->format->get_received_packets) {
1728                return trace->format->get_received_packets(trace);
1729        }
1730        return (uint64_t)-1;
1731}
1732
1733uint64_t trace_get_filtered_packets(libtrace_t *trace)
1734{
1735        assert(trace);
1736        if (trace->format->get_filtered_packets) {
1737                return trace->format->get_filtered_packets(trace)+
1738                        trace->filtered_packets;
1739        }
1740        if (trace->format->get_received_packets
1741                && trace->format->get_dropped_packets) {
1742                return 
1743                        ((trace_get_received_packets(trace)
1744                        -trace_get_accepted_packets(trace))
1745                        -trace_get_dropped_packets(trace))
1746                        +trace->filtered_packets;
1747        }
1748        return trace->filtered_packets;
1749}
1750
1751uint64_t trace_get_dropped_packets(libtrace_t *trace)
1752{
1753        assert(trace);
1754        if (trace->format->get_dropped_packets) {
1755                return trace->format->get_dropped_packets(trace);
1756        }
1757        return (uint64_t)-1;
1758}
1759
1760uint64_t trace_get_accepted_packets(libtrace_t *trace)
1761{
1762        assert(trace);
1763        return trace->accepted_packets;
1764}
1765
1766void register_format(struct libtrace_format_t *f) {
1767        assert(f->next==NULL); /* Can't register a format twice */
1768        f->next=formats_list;
1769        formats_list=f;
1770
1771        /* Now, verify that the format has at least the minimum functionality.
1772         *
1773         * This #if can be changed to a 1 to output warnings about inconsistent
1774         * functions being provided by format modules.  This generally is very
1775         * noisy, as almost all modules don't implement one or more functions
1776         * for various reasons.  This is very useful when checking a new
1777         * format module is sane.
1778         */ 
1779#if 0
1780        if (f->init_input) {
1781#define REQUIRE(x) \
1782                if (!f->x) \
1783                        fprintf(stderr,"%s: Input format should provide " #x "\n",f->name)
1784                REQUIRE(read_packet);
1785                REQUIRE(start_input);
1786                REQUIRE(fin_input);
1787                REQUIRE(get_link_type);
1788                REQUIRE(get_capture_length);
1789                REQUIRE(get_wire_length);
1790                REQUIRE(get_framing_length);
1791                REQUIRE(trace_event);
1792                if (!f->get_erf_timestamp
1793                        && !f->get_seconds
1794                        && !f->get_timeval) {
1795                        fprintf(stderr,"%s: A trace format capable of input, should provide at least one of\n"
1796"get_erf_timestamp, get_seconds or trace_timeval\n",f->name);
1797                }
1798                if (f->trace_event!=trace_event_trace) {
1799                        /* Theres nothing that a trace file could optimise with
1800                         * config_input
1801                         */
1802                        REQUIRE(pause_input);
1803                        REQUIRE(config_input);
1804                        REQUIRE(get_fd);
1805                }
1806                else {
1807                        if (f->get_fd) {
1808                                fprintf(stderr,"%s: Unnecessary get_fd\n",
1809                                                f->name);
1810                        }
1811                }
1812#undef REQUIRE
1813        }
1814        else {
1815#define REQUIRE(x) \
1816                if (f->x) \
1817                        fprintf(stderr,"%s: Non Input format shouldn't need " #x "\n",f->name)
1818                REQUIRE(read_packet);
1819                REQUIRE(start_input);
1820                REQUIRE(pause_input);
1821                REQUIRE(fin_input);
1822                REQUIRE(get_link_type);
1823                REQUIRE(get_capture_length);
1824                REQUIRE(get_wire_length);
1825                REQUIRE(get_framing_length);
1826                REQUIRE(trace_event);
1827                REQUIRE(get_seconds);
1828                REQUIRE(get_timeval);
1829                REQUIRE(get_erf_timestamp);
1830#undef REQUIRE
1831        }
1832        if (f->init_output) {
1833#define REQUIRE(x) \
1834                if (!f->x) \
1835                        fprintf(stderr,"%s: Output format should provide " #x "\n",f->name)
1836                REQUIRE(write_packet);
1837                REQUIRE(start_output);
1838                REQUIRE(config_output);
1839                REQUIRE(fin_output);
1840#undef REQUIRE
1841        }
1842        else {
1843#define REQUIRE(x) \
1844                if (f->x) \
1845                        fprintf(stderr,"%s: Non Output format shouldn't need " #x "\n",f->name)
1846                REQUIRE(write_packet);
1847                REQUIRE(start_output);
1848                REQUIRE(config_output);
1849                REQUIRE(fin_output);
1850#undef REQUIRE
1851        }
1852#endif
1853}
1854
Note: See TracBrowser for help on using the repository browser.