source: lib/trace.c @ b6664e8

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