source: lib/libtrace.h.in @ dc62550

develop
Last change on this file since dc62550 was dc62550, checked in by Jacob van Walraven <jacobvw@…>, 2 years ago

Print a more suitable error when the input URI (file) is not found

  • Property mode set to 100644
File size: 146.6 KB
Line 
1/*
2 * This file is part of libtrace
3 *
4 * Copyright (c) 2007-2015 The University of Waikato, Hamilton,
5 * New Zealand.
6 *
7 * Authors: Daniel Lawson
8 *          Perry Lorier
9 *          Shane Alcock
10 *          Richard Sanger
11 *
12 * All rights reserved.
13 *
14 * This code has been developed by the University of Waikato WAND
15 * research group. For further information please see http://www.wand.net.nz/
16 *
17 * libtrace is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or
20 * (at your option) any later version.
21 *
22 * libtrace is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25 * GNU General Public License for more details.
26 *
27 * You should have received a copy of the GNU General Public License
28 * along with libtrace; if not, write to the Free Software
29 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30 *
31 * $Id$
32 *
33 */
34
35#ifndef LIBTRACE_H
36#define LIBTRACE_H
37
38/** @file
39 *
40 * @brief Trace file processing library header
41 *
42 * @author Daniel Lawson
43 * @author Perry Lorier
44 * @author Shane Alcock
45 * @author Richard Sanger
46 *
47 * @version $Id$
48 *
49 * This library provides a per packet interface into a trace file, or a live
50 * captures.  It supports ERF, DAG cards, PCAP, Linux and BSD native sockets,
51 * legacy ERF formats etc.
52 *
53 * @par Usage
54 * See the example/ directory in the source distribution for some simple
55 * examples
56 *
57 * @par Linking
58 * To use this library you need to link against libtrace by passing -ltrace
59 * to your linker.
60 *
61 * See libtrace_parallel.h for a description of the parallel API that allows
62 * programmers to spread packet processing across multiple threads.
63 *
64 */
65
66#include <sys/types.h>
67#include <stddef.h>
68#include <stdio.h>
69/* Compile time assertion. Sourced from:
70 * http://www.pixelbeat.org/programming/gcc/static_assert.html */
71#define ct_assert(e) extern char (*ct_assert(void)) [sizeof(char[1 - 2*!(e)])]
72
73#ifndef WIN32
74#include <sys/time.h>
75#endif
76
77/* Deal with missing byte order macros */
78#include <sys/param.h>
79
80#if defined(BYTE_ORDER) && !defined(__BYTE_ORDER)
81#define __BYTE_ORDER    BYTE_ORDER
82#endif
83
84#if defined(BIG_ENDIAN) && !defined(__BIG_ENDIAN)
85#define __BIG_ENDIAN    BIG_ENDIAN
86#endif
87
88#if defined(LITTLE_ENDIAN) && !defined(__LITTLE_ENDIAN)
89#define __LITTLE_ENDIAN LITTLE_ENDIAN
90#endif
91
92#ifdef WIN32
93#   include <winsock2.h>
94#   include <ws2tcpip.h>
95    typedef short sa_family_t;
96    /* Make up for a lack of stdbool.h */
97#    define bool signed char
98#    define false 0
99#    define true 1
100#    if !defined(ssize_t)
101     /* XXX: Not 64-bit safe! */
102#    define ssize_t int
103#    endif   
104#else
105#    include <netinet/in.h>
106
107#ifndef __cplusplus
108#    include <stdbool.h>
109#endif
110
111#    include <sys/types.h>
112#    include <sys/socket.h>
113#endif
114
115/** API version as 2 byte hex digits, eg 0xXXYYZZ */
116#define LIBTRACE_API_VERSION \
117            ((@LIBTRACE_MAJOR@<<16)|(@LIBTRACE_MID@<<8)|(@LIBTRACE_MINOR@))
118
119/** This used to be replaced with the current SVN revision number when
120 * 'make dist' was invoked to create a distributable tarball. We don't use
121 * SVN anymore and there probably isn't any need to know the exact revision
122 * number either these days. */
123#define LIBTRACE_SVN_REVISION LIBTRACE_API_VERSION
124
125/** DAG driver version installed on the current system */
126#define DAG_DRIVER_V "@DAG_VERSION_NUM@"
127
128/**
129  * A version of assert that always runs the first argument even
130  * when not debugging, however only asserts the condition if debugging
131  * Intended for use mainly with pthread locks etc. which have error
132  * returns but *should* never actually fail.
133  */
134#ifdef NDEBUG
135#define ASSERT_RET(run, cond) run
136#else
137#define ASSERT_RET(run, cond) assert(run cond)
138//#define ASSERT_RET(run, cond) run
139#endif
140   
141#ifdef __cplusplus
142extern "C" {
143#endif
144
145#ifdef _MSC_VER
146    /* define the following from MSVC's internal types */
147    typedef             __int8  int8_t;
148    typedef             __int16 int16_t;
149    typedef             __int32 int32_t;
150    typedef             __int64 int64_t;
151    typedef unsigned    __int8  uint8_t;
152    typedef unsigned    __int16 uint16_t;
153    typedef unsigned    __int32 uint32_t;
154    typedef unsigned    __int64 uint64_t;
155   
156    /* Windows pads bitfields out to to the size of their parent type
157     * however gcc warns that this doesn't meet with the iso C specification
158     * so produces warnings for this behaviour.  sigh.
159     */
160    #define LT_BITFIELD8        uint8_t
161    #define LT_BITFIELD16       uint16_t
162    #define LT_BITFIELD32       uint32_t
163    #define LT_BITFIELD64       uint64_t
164#else
165    #ifdef HAVE_STDINT_H
166        #   include <stdint.h>
167    #endif
168    /* GCC warns if the bitfield type is not "unsigned int", however windows
169     * generates incorrect code for this (see above), so we define these
170     * macros.  How Hideous.  So much for C's portability.
171     */
172    #define LT_BITFIELD8        unsigned int
173    #define LT_BITFIELD16       unsigned int
174    #define LT_BITFIELD32       unsigned int
175    #define LT_BITFIELD64       unsigned int
176#endif
177
178/* Ensure these gcc optimisation attributes are defined consistently,
179 * without requiring users to need to have access to the config.h
180 * generated by running configure.
181 */
182
183#define LT_USE_PACKED @HAVE_ATTRIBUTE_PACKED@
184#define LT_USE_UNUSED @HAVE_ATTRIBUTE_UNUSED@
185#define LT_USE_DEPRECATED @HAVE_ATTRIBUTE_DEPRECATED@
186#define LT_USE_PURE @HAVE_ATTRIBUTE_PURE@
187#define LT_USE_PRINTF @HAVE_ATTRIBUTE_FORMAT@
188#define LT_USE_VISIBILITY @HAVE_VISIBILITY@
189
190#if LT_USE_PACKED
191#  define PACKED __attribute__((packed))
192#else
193#  define PACKED
194#endif
195
196#if LT_USE_UNUSED
197#  define UNUSED __attribute__((unused))
198#else
199#  define UNUSED
200#endif
201
202#if LT_USE_DEPRECATED
203#  define DEPRECATED __attribute__((deprecated))
204#else
205#  define DEPRECATED
206#endif
207
208#if LT_USE_PURE
209#  define SIMPLE_FUNCTION __attribute__((pure))
210#else
211#  define SIMPLE_FUNCTION
212#endif
213
214#if LT_USE_PRINTF
215#  define PRINTF(formatpos, argpos) __attribute__((format(printf,formatpos, argpos)))
216#else
217#  define PRINTF(formatpos, argpos)
218#endif
219
220#ifndef CACHE_LINE_SIZE
221#define CACHE_LINE_SIZE 64
222#endif
223#define ALIGN_STRUCT(x) __attribute__((aligned(x)))
224
225#ifdef _MSC_VER
226    #ifdef LT_BUILDING_DLL
227        #define DLLEXPORT __declspec(dllexport)
228    #else
229        #define DLLEXPORT __declspec(dllimport)
230    #endif
231    #define DLLLOCAL
232#else
233    #ifndef DLLEXPORT
234        #if LT_USE_VISIBILITY && LT_BUILDING_DLL
235            #define DLLEXPORT __attribute__ ((visibility("default")))
236            #define DLLLOCAL __attribute__ ((visibility("hidden")))
237        #else
238            #define DLLEXPORT
239            #define DLLLOCAL
240        #endif
241    #endif
242#endif
243
244
245/** Opaque structure holding information about an output trace */
246typedef struct libtrace_out_t libtrace_out_t;
247
248/** Opaque structure holding information about a trace */
249typedef struct libtrace_t libtrace_t;
250
251/** Opaque structure holding information about a bpf filter */
252typedef struct libtrace_filter_t libtrace_filter_t;
253
254/** Opaque structure holding information about libtrace thread */
255typedef struct libtrace_thread_t libtrace_thread_t;
256
257/** Opaque structure holding callback functions for libtrace threads */
258typedef struct callback_set libtrace_callback_set_t;
259
260/** If the packet has allocated its own memory the buffer_control should be
261 * set to TRACE_CTRL_PACKET, so that the memory will be freed when the packet
262 * is destroyed. If the packet has been zero-copied out of memory owned by
263 * something else, e.g. a DAG card, it should be TRACE_CTRL_EXTERNAL.
264 *
265 * @note The letters p and e are magic numbers used to detect if the packet
266 * wasn't created properly.
267 */
268typedef enum {
269        TRACE_CTRL_PACKET='p',  /**< Buffer memory is owned by the packet */
270        TRACE_CTRL_EXTERNAL='e' /**< Buffer memory is owned by an external source */
271} buf_control_t;
272
273/** The size of a packet's buffer when managed by libtrace */
274#define LIBTRACE_PACKET_BUFSIZE 65536
275
276/** Libtrace error information */
277typedef struct trace_err_t{
278        int err_num;            /**< error code */
279        char problem[1024];     /**< the format, uri etc that caused the error for reporting purposes */
280} libtrace_err_t;
281
282/** Enumeration of error codes */
283enum {
284        /** No Error has occurred.... yet. */
285        TRACE_ERR_NOERROR       = 0,
286        /** The URI passed to trace_create() is unsupported, or badly formed */
287        TRACE_ERR_BAD_FORMAT    = -1,
288        /** The trace failed to initialise */
289        TRACE_ERR_INIT_FAILED   = -2,
290        /** Unknown config option */
291        TRACE_ERR_UNKNOWN_OPTION= -3,
292        /** This output uri cannot write packets of this type */
293        TRACE_ERR_NO_CONVERSION = -4,
294        /** This packet is corrupt, or unusable for the action required */
295        TRACE_ERR_BAD_PACKET    = -5,
296        /** Option known, but unsupported by this format */
297        TRACE_ERR_OPTION_UNAVAIL= -6,
298        /** This feature is unsupported */
299        TRACE_ERR_UNSUPPORTED   = -7,
300        /** Illegal use of the API */
301        TRACE_ERR_BAD_STATE     = -8,
302        /** Failed to compile a BPF filter */
303        TRACE_ERR_BAD_FILTER    = -9,
304        /** RT communication breakdown */
305        TRACE_ERR_RT_FAILURE    = -10,
306        /** Compression format unsupported */
307        TRACE_ERR_UNSUPPORTED_COMPRESS  = -11,
308        /** Wandio has returned an error */
309        TRACE_ERR_WANDIO_FAILED = -12,
310        /** Input URI (file) not found */
311        TRACE_ERR_URI_NOT_FOUND = -13 
312};
313
314/** Enumeration of DLTs supported by libtrace
315 */
316typedef enum {
317        /* Special value used to indicate a failure to convert to libtrace
318         * DLT */
319        TRACE_DLT_ERROR = -1,
320
321        /** pcap documents this as having the Address Family value in host
322          * byte order as the framing.  Ugly? Yes.
323          */
324        TRACE_DLT_NULL = 0,
325        TRACE_DLT_EN10MB = 1,
326        TRACE_DLT_PPP = 9,
327        TRACE_DLT_ATM_RFC1483 = 11,
328
329        /** Ok, so OpenBSD has a different value for DLT_RAW as the rest of
330         * the planet, so detect this.  When reading to/from files we should
331         * be using TRACE_DLT_LINKTYPE_RAW instead. When talking about DLT's
332         * inside libtrace tho, we should be using /these/ DLT's.
333         */
334#ifdef __OpenBSD__
335        TRACE_DLT_OPENBSD_LOOP=12,
336        TRACE_DLT_RAW = 14,
337#else
338        TRACE_DLT_RAW = 12,
339        TRACE_DLT_OPENBSD_LOOP = 108,
340#endif
341        TRACE_DLT_PPP_SERIAL = 50,
342        TRACE_DLT_LINKTYPE_RAW = 101, /**< See TRACE_DLT_RAW for explanations of pain. */
343        TRACE_DLT_C_HDLC = 104,
344        TRACE_DLT_IEEE802_11 = 105,
345        TRACE_DLT_LINUX_SLL = 113,
346        TRACE_DLT_PFLOG = 117,
347        TRACE_DLT_IEEE802_11_RADIO = 127 /**< Radiotap */
348} libtrace_dlt_t ;
349
350/** Enumeration of link layer types supported by libtrace */
351typedef enum {
352       TRACE_TYPE_UNKNOWN = -1,         /**< Unable to determine link type */
353    /* TRACE_TYPE_LEGACY = 0            Obsolete */
354       TRACE_TYPE_HDLC_POS = 1,         /**< HDLC over POS */
355       TRACE_TYPE_ETH = 2,              /**< 802.3 style Ethernet */
356       TRACE_TYPE_ATM = 3,              /**< ATM frame */
357       TRACE_TYPE_80211 = 4,            /**< 802.11 frames */
358       TRACE_TYPE_NONE = 5,             /**< Raw IP frames */
359       TRACE_TYPE_LINUX_SLL = 6,        /**< Linux "null" framing */
360       TRACE_TYPE_PFLOG = 7,            /**< FreeBSD's PFlog */
361    /* TRACE_TYPE_LEGACY_DEFAULT        Obsolete */
362       TRACE_TYPE_POS = 9,              /**< Packet-over-SONET */
363    /* TRACE_TYPE_LEGACY_ATM            Obsolete */
364    /* TRACE_TYPE_LEGACY_ETH            Obsolete */
365       TRACE_TYPE_80211_PRISM = 12,     /**< 802.11 Prism frames */
366       TRACE_TYPE_AAL5 = 13,            /**< ATM Adaptation Layer 5 frames */
367       TRACE_TYPE_DUCK = 14,         /**< Pseudo link layer for DUCK packets */
368       TRACE_TYPE_80211_RADIO = 15,  /**< Radiotap + 802.11 */
369       TRACE_TYPE_LLCSNAP = 16,      /**< Raw LLC/SNAP */
370       TRACE_TYPE_PPP = 17,          /**< PPP frames */
371       TRACE_TYPE_METADATA = 18,        /**< WDCAP-style meta-data */
372       TRACE_TYPE_NONDATA = 19,         /**< Not a data packet */
373       TRACE_TYPE_OPENBSD_LOOP = 20,    /**< OpenBSD loopback */
374       TRACE_TYPE_ERF_META = 21, /**< ERF Provenance metadata record */
375       TRACE_TYPE_ETSILI = 22   /**< ETSI Lawful Intercept */
376} libtrace_linktype_t;
377
378/** RT protocol base format identifiers.
379 * This is used to describe the capture format of the packet is being sent
380 * using the RT protocol.
381 */
382enum base_format_t {
383        TRACE_FORMAT_ERF          =1,   /**< ERF (DAG capture format) */
384        TRACE_FORMAT_PCAP         =2,   /**< Live PCAP capture */
385        TRACE_FORMAT_PCAPFILE     =3,   /**< PCAP trace file */
386        TRACE_FORMAT_WAG          =4,   /**< WAG live capture (Obsolete) */
387        TRACE_FORMAT_RT           =5,   /**< RT network protocol */
388        TRACE_FORMAT_LEGACY_ATM   =6,   /**< Legacy ERF for ATM capture */
389        TRACE_FORMAT_LEGACY_POS   =7,   /**< Legacy ERF for POS capture */
390        TRACE_FORMAT_LEGACY_ETH   =8,   /**< Legacy ERF for ETH capture */
391        TRACE_FORMAT_LINUX_NATIVE =9,   /**< Linux native interface capture */
392        TRACE_FORMAT_DUCK         =10,  /**< DAG Clock information */
393        TRACE_FORMAT_BPF          =11,  /**< BSD native interface capture */
394        TRACE_FORMAT_TSH          =12,  /**< TSH trace format */
395        TRACE_FORMAT_ATMHDR       =13,  /**< Legacy ATM header capture */
396        TRACE_FORMAT_LEGACY_NZIX  =14,  /**< Legacy format used for NZIX traces */
397        TRACE_FORMAT_LINUX_RING   =15,  /**< Linux native interface capture PACKET_MMAP */
398        TRACE_FORMAT_RAWERF       =16,  /**< Special format for reading uncompressed ERF traces without checking for compression */
399        TRACE_FORMAT_DPDK     =17, /**< The Intel Data Plane Development Kit format */
400        TRACE_FORMAT_PCAPNG     =18,    /**< PCAP-NG trace file */
401        TRACE_FORMAT_NDAG       =19,    /**< DAG multicast over a network */
402        TRACE_FORMAT_DPDK_NDAG       =20,    /**< DAG multicast over a network, received via DPDK */
403        TRACE_FORMAT_ETSILIVE     =21,  /**< ETSI LI over a network */
404};
405
406/** RT protocol packet types */
407typedef enum {
408        TRACE_RT_HELLO          =1, /**< Connection accepted */
409        TRACE_RT_START          =2, /**< Request for data transmission to begin
410                                    */
411        TRACE_RT_ACK            =3, /**< Data acknowledgement */
412        TRACE_RT_STATUS         =4, /**< Fifo status packet */
413        TRACE_RT_DUCK           =5, /**< Dag duck info packet */
414        TRACE_RT_END_DATA       =6, /**< Server is exiting message */
415        TRACE_RT_CLOSE          =7, /**< Client is exiting message */
416        TRACE_RT_DENY_CONN      =8, /**< Connection has been denied */
417        TRACE_RT_PAUSE          =9, /**< Request server to suspend sending data
418                                     */
419        TRACE_RT_PAUSE_ACK      =10,/**< Server is paused message */
420        TRACE_RT_OPTION         =11,/**< Option request */
421        TRACE_RT_KEYCHANGE      =12,/**< Anonymisation key has changed */
422        TRACE_RT_DUCK_2_4       =13,/**< Dag 2.4 Duck */
423        TRACE_RT_DUCK_2_5       =14,/**< Dag 2.5 Duck */
424        TRACE_RT_LOSTCONN       =15,/**< Lost connection to server */
425        TRACE_RT_SERVERSTART    =16,/**< Reliable server has been restarted */
426        TRACE_RT_CLIENTDROP     =17,/**< Reliable client was lost */
427        TRACE_RT_METADATA       =18,/**< Packet contains server meta-data */
428        TRACE_RT_DUCK_5_0       =19,/**< Dag 5.0 Duck */
429        TRACE_RT_PCAPNG_META    =20,/**< Metadata for a PCAP NG input source */
430
431        /** Not actually used - all DATA types begin from this value */
432        TRACE_RT_DATA_SIMPLE    = 1000,
433       
434        /** RT is encapsulating an ERF capture record */
435        TRACE_RT_DATA_ERF       =TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_ERF,
436        /** RT is encapsulating a WAG capture record */
437        TRACE_RT_DATA_WAG       =TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_WAG,
438        /** RT is encapsulating a Legacy ATM capture record */
439        TRACE_RT_DATA_LEGACY_ATM=TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_LEGACY_ATM,
440        /** RT is encapsulating a Legacy POS capture record */
441        TRACE_RT_DATA_LEGACY_POS=TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_LEGACY_POS,
442        /** RT is encapsulating a Legacy ETH capture record */
443        TRACE_RT_DATA_LEGACY_ETH=TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_LEGACY_ETH,
444        /** RT is encapsulating a Linux native capture record */
445        TRACE_RT_DATA_LINUX_NATIVE=TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_LINUX_NATIVE,
446        /** RT is encapsulating a BSD native capture record */
447        //TRACE_RT_DATA_BPF       =TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_BPF,
448        /** RT is encapsulating a TSH capture record */
449        TRACE_RT_DATA_TSH       =TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_TSH,
450        /** RT is encapsulating an ATM header capture record */
451        TRACE_RT_DATA_ATMHDR = TRACE_RT_DATA_SIMPLE + TRACE_FORMAT_ATMHDR,
452        /** RT is encapsulating a Legacy NZIX capture record */
453        TRACE_RT_DATA_LEGACY_NZIX=TRACE_RT_DATA_SIMPLE + TRACE_FORMAT_LEGACY_NZIX,
454        /** RT is encapsulating a Linux native PACKET_MMAP capture record */
455        TRACE_RT_DATA_LINUX_RING=TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_LINUX_RING,
456    /** RT is encapsulating a Intel DPDK capture record */
457        TRACE_RT_DATA_DPDK=TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_DPDK,
458
459        TRACE_RT_DATA_ETSILI = TRACE_RT_DATA_SIMPLE + TRACE_FORMAT_ETSILIVE,
460
461        /** As PCAP does not store the linktype with the packet, we need to
462         * create a separate RT type for each supported DLT, starting from
463         * this value */
464        TRACE_RT_DATA_DLT               = 2000,
465        /** RT is encapsulating a PCAP capture record with a NULL linktype */
466        TRACE_RT_DLT_NULL               =TRACE_RT_DATA_DLT+TRACE_DLT_NULL,
467        /** RT is encapsulating a PCAP capture record with an Ethernet
468         * linktype */
469        TRACE_RT_DLT_EN10MB             =TRACE_RT_DATA_DLT+TRACE_DLT_EN10MB,
470        /** RT is encapsulating a PCAP capture record with an 802.11
471         * linktype */
472        TRACE_RT_DLT_IEEE802_11         =TRACE_RT_DATA_DLT+TRACE_DLT_IEEE802_11,
473        /** RT is encapsulating a PCAP capture record with a Linux SLL
474         * linktype */
475        TRACE_RT_DLT_LINUX_SLL          =TRACE_RT_DATA_DLT+TRACE_DLT_LINUX_SLL,
476        /** RT is encapsulating a PCAP capture record with a PFlog linktype */
477        TRACE_RT_DLT_PFLOG              =TRACE_RT_DATA_DLT+TRACE_DLT_PFLOG,
478        /** RT is encapsulating a PCAP capture record with an AAL5 linktype */
479        TRACE_RT_DLT_ATM_RFC1483        =TRACE_RT_DATA_DLT+TRACE_DLT_ATM_RFC1483,
480        /** Unused value marking the end of the valid range for PCAP RT
481         * encapsulation */
482        TRACE_RT_DATA_DLT_END           = 2999,
483        /** BPF does not store the linktype with the packet, so we need a
484         * separate RT type for each supported DLT. This value represents the
485         * starting point */
486        TRACE_RT_DATA_BPF               = 3000,
487
488        TRACE_RT_BPF_NULL               = TRACE_RT_DATA_BPF+TRACE_DLT_NULL,
489        TRACE_RT_BPF_EN10MB             = TRACE_RT_DATA_BPF+TRACE_DLT_EN10MB,
490        TRACE_RT_BPF_IEEE802_11         = TRACE_RT_DATA_BPF+TRACE_DLT_IEEE802_11,
491        TRACE_RT_BPF_PFLOG              =TRACE_RT_DATA_BPF+TRACE_DLT_PFLOG,
492        TRACE_RT_BPF_ATM_RFC1483        =TRACE_RT_DATA_BPF+TRACE_DLT_ATM_RFC1483,
493
494        TRACE_RT_DATA_BPF_END           = 3999,
495
496        TRACE_RT_DATA_PCAPNG            = 4000,
497        TRACE_RT_DATA_PCAPNG_END        = 4499,
498        /** Unused value marking the end of the valid range for all RT packet
499         * types */
500        TRACE_RT_LAST                   = 4500
501} libtrace_rt_types_t;
502
503/** IP Protocol values */
504typedef enum {
505        TRACE_IPPROTO_IP        = 0,    /**< IP pseudo protocol number */
506        TRACE_IPPROTO_ICMP      = 1,    /**< Internet Control Message protocol */
507        TRACE_IPPROTO_IGMP      = 2,    /**< Internet Group Management Protocol */
508        TRACE_IPPROTO_IPIP      = 4,    /**< IP encapsulated in IP */
509        TRACE_IPPROTO_TCP       = 6,    /**< Transmission Control Protocol */
510        TRACE_IPPROTO_UDP       = 17,   /**< User Datagram Protocol */
511        TRACE_IPPROTO_IPV6      = 41,   /**< IPv6 over IPv4 */
512        TRACE_IPPROTO_ROUTING   = 43,   /**< IPv6 Routing header */
513        TRACE_IPPROTO_FRAGMENT  = 44,   /**< IPv6 Fragmentation header */
514        TRACE_IPPROTO_RSVP      = 46,   /**< Resource Reservation Protocol */
515        TRACE_IPPROTO_GRE       = 47,   /**< General Routing Encapsulation */
516        TRACE_IPPROTO_ESP       = 50,   /**< Encapsulated Security Payload [RFC2406] */
517        TRACE_IPPROTO_AH        = 51,   /**< Authentication Header [RFC2402] */
518        TRACE_IPPROTO_ICMPV6    = 58,   /**< ICMPv6 */
519        TRACE_IPPROTO_NONE      = 59,   /**< IPv6 no next header */
520        TRACE_IPPROTO_DSTOPTS   = 60,   /**< IPv6 destination options */
521        TRACE_IPPROTO_OSPF      = 89,   /**< Open Shortest Path First routing protocol */
522        TRACE_IPPROTO_PIM       = 103,  /**< Protocol Independant Multicast */
523        TRACE_IPPROTO_SCTP      = 132   /**< Stream Control Transmission Protocol */
524} libtrace_ipproto_t;
525
526/** Ethertypes supported by Libtrace */
527typedef enum {
528        /* Numbers <=1500 are of course, LLC/SNAP */
529        TRACE_ETHERTYPE_LOOPBACK= 0x0060,       /**< Ethernet Loopback */
530        TRACE_ETHERTYPE_IP      = 0x0800,       /**< IPv4 */
531        TRACE_ETHERTYPE_ARP     = 0x0806,       /**< Address resolution protocol */
532        TRACE_ETHERTYPE_RARP    = 0x8035,       /**< Reverse ARP */
533        TRACE_ETHERTYPE_8021Q   = 0x8100,       /**< 802.1q VLAN Extended Header */
534        TRACE_ETHERTYPE_IPV6    = 0x86DD,       /**< IPv6 */
535        TRACE_ETHERTYPE_MPLS    = 0x8847,       /**< MPLS Unicast traffic */
536        TRACE_ETHERTYPE_MPLS_MC = 0x8848,       /**< MPLS Multicast traffic */
537        TRACE_ETHERTYPE_PPP_DISC= 0x8863,       /**< PPPoE Service Discovery */
538        TRACE_ETHERTYPE_PPP_SES = 0x8864        /**< PPPoE Session Messages */
539} libtrace_ethertype_t;
540
541/** The libtrace packet structure. Applications shouldn't be
542 * meddling around in here
543 */
544typedef struct libtrace_packet_t {
545        struct libtrace_t *trace;       /**< Pointer to the trace */
546        void *header;                   /**< Pointer to the framing header */
547        void *payload;                  /**< Pointer to the link layer */
548        void *buffer;                   /**< Allocated buffer */
549        libtrace_rt_types_t  type;      /**< RT protocol type for the packet */
550        buf_control_t buf_control;      /**< Describes memory ownership */
551        int capture_length;             /**< Cached capture length */
552        int wire_length;                /**< Cached wire length */
553        int payload_length;             /**< Cached payload length */
554        void *l2_header;                /**< Cached link header */
555        libtrace_linktype_t link_type;  /**< Cached link type */
556        uint32_t l2_remaining;          /**< Cached link remaining */
557        void *l3_header;                /**< Cached l3 header */
558        uint16_t l3_ethertype;          /**< Cached l3 ethertype */
559        uint32_t l3_remaining;          /**< Cached l3 remaining */
560        void *l4_header;                /**< Cached transport header */
561        uint8_t transport_proto;        /**< Cached transport protocol */
562        uint32_t l4_remaining;          /**< Cached transport remaining */
563        uint64_t order; /**< Notes the order of this packet in relation to the input */
564        uint64_t hash; /**< A hash of the packet as supplied by the user */
565        int error; /**< The error status of pread_packet */
566        uint64_t internalid;            /** Internal identifier for the pkt */
567        void *srcbucket;
568
569        pthread_mutex_t ref_lock;       /**< Lock for reference counter */
570        int refcount;                 /**< Reference counter */
571
572} libtrace_packet_t;
573
574#define IS_LIBTRACE_META_PACKET(packet) (packet->type < TRACE_RT_DATA_SIMPLE)
575
576
577/** Trace directions.
578 * Note that these are the directions used by convention. More directions
579 * are possible, not just these 3, and that they may not conform to this
580 * convention.
581 */
582typedef enum {
583        TRACE_DIR_OUTGOING = 0,         /**< Packets originating "inside" */
584        TRACE_DIR_INCOMING = 1,         /**< Packets originating "outside" */
585        TRACE_DIR_OTHER    = 2,         /**< Packets with an unknown direction, or one that's unknown */
586        TRACE_DIR_UNKNOWN = -1,         /**< No direction information available */
587} libtrace_direction_t;
588
589/** Enumeration of Radiotap fields */
590typedef enum {
591    TRACE_RADIOTAP_TSFT = 0, /**< Timer synchronisation function, in microseconds (uint64) */
592    TRACE_RADIOTAP_FLAGS = 1, /**< Wireless flags (uint8) */
593    TRACE_RADIOTAP_RATE = 2, /**< Bitrate in units of 500kbps (uint8) */
594    TRACE_RADIOTAP_CHANNEL = 3, /**< Frequency in MHz (uint16) and channel flags (uint16) */
595    TRACE_RADIOTAP_FHSS = 4, /**< FHSS hop set (uint8) and hopping pattern (uint8) */
596    TRACE_RADIOTAP_DBM_ANTSIGNAL = 5, /**< Signal power in dBm (int8) */
597    TRACE_RADIOTAP_DBM_ANTNOISE = 6, /**< Noise power in dBm (int8) */
598    TRACE_RADIOTAP_LOCK_QUALITY = 7, /**< Barker Code lock quality (uint16) */
599    TRACE_RADIOTAP_TX_ATTENUATION = 8, /**< TX attenuation as unitless distance from max power (uint16) */
600    TRACE_RADIOTAP_DB_TX_ATTENUATION = 9, /**< TX attenuation as dB from max power (uint16) */
601    TRACE_RADIOTAP_DBM_TX_POWER = 10, /**< TX Power in dBm (int8) */
602    TRACE_RADIOTAP_ANTENNA = 11, /**< Antenna frame was rx'd or tx'd on (uint8) */
603    TRACE_RADIOTAP_DB_ANTSIGNAL = 12, /**< Signal power in dB from a fixed reference (uint8) */
604    TRACE_RADIOTAP_DB_ANTNOISE = 13, /**< Noise power in dB from a fixed reference (uint8) */
605    TRACE_RADIOTAP_RX_FLAGS = 14, /** Properties of received frame (uint16) */
606    TRACE_RADIOTAP_TX_FLAGS = 15, /** Properties of transmitted frame (uint16) */
607    TRACE_RADIOTAP_RTS_RETRIES = 16, /** Number of rts retries frame used (uint8) */
608    TRACE_RADIOTAP_DATA_RETRIES = 17, /** Number of unicast retries a transmitted frame used (uint8) */
609    TRACE_RADIOTAP_EXT = 31
610} libtrace_radiotap_field_t;
611
612
613/** @name Protocol structures
614 * These convenience structures provide portable versions of the headers
615 * for a variety of protocols.
616 * @{
617 */
618
619#ifdef WIN32
620#pragma pack(push)
621#pragma pack(1)
622#endif
623
624/** Generic IP header structure */
625typedef struct libtrace_ip
626{
627#if __BYTE_ORDER == __LITTLE_ENDIAN
628    LT_BITFIELD8 ip_hl:4;               /**< Header Length */
629    LT_BITFIELD8 ip_v:4;                /**< Version */
630#elif __BYTE_ORDER == __BIG_ENDIAN
631    LT_BITFIELD8 ip_v:4;                /**< Version */
632    LT_BITFIELD8 ip_hl:4;               /**< Header Length */
633#else
634#   error "Adjust your <bits/endian.h> defines"
635#endif
636    uint8_t  ip_tos;                    /**< Type of Service */
637    uint16_t ip_len;                    /**< Total Length */
638    int16_t  ip_id;                     /**< Identification */
639    uint16_t ip_off;                    /**< IP Fragment offset (and flags) */
640    uint8_t  ip_ttl;                    /**< Time to Live */
641    uint8_t  ip_p;                      /**< Protocol */
642    uint16_t ip_sum;                    /**< Checksum */
643    struct in_addr ip_src;              /**< Source Address */
644    struct in_addr ip_dst;              /**< Destination Address */
645} PACKED libtrace_ip_t;
646
647/** IPv6 header extension structure */
648typedef struct libtrace_ip6_ext
649{
650        uint8_t nxt;    /**< Next header */
651        uint8_t len;    /**< Length of the current header */
652} PACKED libtrace_ip6_ext_t;
653
654/** IPv6 fragmentation header */
655typedef struct libtrace_ip6_frag
656{
657        uint8_t nxt;    /**< Next header */
658        uint8_t res;    /**< Reserved */
659        uint16_t frag_off;      /**< Fragment Offset (includes M flag) */
660        uint32_t ident; /** Fragment identification */
661} PACKED libtrace_ip6_frag_t;
662
663/** Generic IPv6 header structure
664 *
665 * @note The flow label field also includes the Version and Traffic Class
666 * fields, because we haven't figured out a nice way to deal with fields
667 * crossing byte boundaries on both Big and Little Endian machines */
668typedef struct libtrace_ip6
669{
670    uint32_t flow;                      /**< Flow label */
671    uint16_t plen;                      /**< Payload length */
672    uint8_t nxt;                        /**< Next header */
673    uint8_t hlim;                       /**< Hop limit */
674    struct in6_addr ip_src;             /**< Source address */
675    struct in6_addr ip_dst;             /**< Destination address */
676} PACKED libtrace_ip6_t;
677
678/** Generic TCP header structure */
679typedef struct libtrace_tcp
680  {
681    uint16_t source;            /**< Source Port */
682    uint16_t dest;              /**< Destination port */
683    uint32_t seq;               /**< Sequence number */
684    uint32_t ack_seq;           /**< Acknowledgement Number */
685#  if __BYTE_ORDER == __LITTLE_ENDIAN
686    LT_BITFIELD8 ecn_ns:1;      /**< ECN Nonce Sum */
687    LT_BITFIELD8 res1:3;        /**< Reserved bits */
688    LT_BITFIELD8 doff:4;        /**< Data Offset */
689    LT_BITFIELD8 fin:1;         /**< FIN */
690    LT_BITFIELD8 syn:1;         /**< SYN flag */
691    LT_BITFIELD8 rst:1;         /**< RST flag */
692    LT_BITFIELD8 psh:1;         /**< PuSH flag */
693    LT_BITFIELD8 ack:1;         /**< ACK flag */
694    LT_BITFIELD8 urg:1;         /**< URG flag */
695    LT_BITFIELD8 ece:1;         /**< ECN Echo */
696    LT_BITFIELD8 cwr:1;         /**< ECN CWR */
697#  elif __BYTE_ORDER == __BIG_ENDIAN
698    LT_BITFIELD8 doff:4;        /**< Data offset */
699    LT_BITFIELD8 res1:3;        /**< Reserved bits */
700    LT_BITFIELD8 ecn_ns:1;      /**< ECN Nonce Sum */
701    LT_BITFIELD8 cwr:1;         /**< ECN CWR */
702    LT_BITFIELD8 ece:1;         /**< ECN Echo */
703    LT_BITFIELD8 urg:1;         /**< URG flag */
704    LT_BITFIELD8 ack:1;         /**< ACK flag */
705    LT_BITFIELD8 psh:1;         /**< PuSH flag */
706    LT_BITFIELD8 rst:1;         /**< RST flag */
707    LT_BITFIELD8 syn:1;         /**< SYN flag */
708    LT_BITFIELD8 fin:1;         /**< FIN flag */
709#  else
710#   error "Adjust your <bits/endian.h> defines"
711#  endif
712    uint16_t window;            /**< Window Size */
713    uint16_t check;             /**< Checksum */
714    uint16_t urg_ptr;           /**< Urgent Pointer */
715} PACKED libtrace_tcp_t;
716
717/** Generic UDP header structure */
718typedef struct libtrace_udp {
719  uint16_t      source;         /**< Source port */
720  uint16_t      dest;           /**< Destination port */
721  uint16_t      len;            /**< Length */
722  uint16_t      check;          /**< Checksum */
723} PACKED libtrace_udp_t;
724
725/** Generic ICMP header structure */
726typedef struct libtrace_icmp
727{
728  uint8_t type;         /**< Message Type */
729  uint8_t code;         /**< Type Sub-code */
730  uint16_t checksum;            /**< Checksum */
731  union
732  {
733    struct
734    {
735      uint16_t  id;             /**< ID of the Echo request */
736      uint16_t  sequence;       /**< Sequence number of the Echo request */
737    } echo;                     /**< Echo Datagram */
738    uint32_t    gateway;        /**< Gateway Address */
739    struct
740    {
741      uint16_t  unused;         /**< Unused */
742      uint16_t  mtu;            /**< Next-hop MTU */
743    } frag;                     /**< Path MTU Discovery */
744  } un;                         /**< Union for Payloads of Various ICMP Codes */
745} PACKED libtrace_icmp_t;
746
747/** Generic ICMPv6 header structure */
748typedef struct libtrace_icmp6 {
749  uint8_t type;         /**< Message Type */
750  uint8_t code;         /**< Type Sub-code */
751  uint16_t checksum;    /**< Checksum */
752
753  union {
754    struct {
755        uint8_t length;   /**< Length of original datagram content in 64 bit words */
756        uint8_t unused;   /**< Unused */       
757        uint8_t unused1;  /**< Unused */
758    } extend;   /**< Extensions added in RFC 4884 for Time Exceeded and Destination Unreachable Messages */
759
760    uint32_t mtu;       /**< MTU from Packet Too Big Message */
761    uint32_t pointer;   /**< Pointer from Parameter Problem Message */
762    struct {
763        uint16_t id;    /**< Echo Identifier */
764        uint16_t sequence; /**< Echo Sequence Number */
765    } echo; /**< Data required for Echo Request and Reply messages */
766  } un;
767} PACKED libtrace_icmp6_t;
768
769/** Generic LLC/SNAP header structure */
770typedef struct libtrace_llcsnap
771{
772/* LLC */
773  uint8_t dsap;                 /**< Destination Service Access Point */
774  uint8_t ssap;                 /**< Source Service Access Point */
775  uint8_t control;              /**< Control field */
776/* SNAP */
777  LT_BITFIELD32 oui:24;         /**< Organisationally Unique Identifier (scope)*/
778  uint16_t type;                /**< Protocol within OUI */
779} PACKED libtrace_llcsnap_t;
780
781/** 802.3 frame */
782typedef struct libtrace_ether
783{
784  uint8_t ether_dhost[6];       /**< Destination Ether Addr */
785  uint8_t ether_shost[6];       /**< Source Ether Addr */
786  uint16_t ether_type;          /**< Packet Type ID Field (next-header) */
787} PACKED libtrace_ether_t;
788
789/** 802.1Q frame */
790typedef struct libtrace_8021q
791{
792  LT_BITFIELD16 vlan_pri:3;      /**< VLAN User Priority */
793  LT_BITFIELD16 vlan_cfi:1;      /**< VLAN Format Indicator,
794                                   * 0 for ethernet, 1 for token ring */
795  LT_BITFIELD16 vlan_id:12;      /**< VLAN Id */
796  uint16_t vlan_ether_type;      /**< VLAN Sub-packet Type ID Field
797                                   * (next-header)*/
798} PACKED libtrace_8021q_t;
799
800/** ATM User Network Interface (UNI) Cell. */
801typedef struct libtrace_atm_cell
802{
803  LT_BITFIELD32 gfc:4;          /**< Generic Flow Control */
804  LT_BITFIELD32 vpi:8;          /**< Virtual Path Identifier */
805  LT_BITFIELD32 vci:16;         /**< Virtual Channel Identifier */
806  LT_BITFIELD32 pt:3;           /**< Payload Type */
807  LT_BITFIELD32 clp:1;          /**< Cell Loss Priority */
808  LT_BITFIELD32 hec:8;          /**< Header Error Control */
809} PACKED libtrace_atm_cell_t;
810
811/** ATM Network Node/Network Interface (NNI) Cell. */
812typedef struct libtrace_atm_nni_cell
813{
814  LT_BITFIELD32 vpi:12;         /**< Virtual Path Identifier */
815  LT_BITFIELD32 vci:16;         /**< Virtual Channel Identifier */
816  LT_BITFIELD32 pt:3;           /**< Payload Type */
817  LT_BITFIELD32 clp:1;          /**< Cell Loss Priority */
818  LT_BITFIELD32 hec:8;          /**< Header Error Control */
819} PACKED libtrace_atm_nni_cell_t;
820
821/** Captured UNI cell.
822 *
823 * Endace don't capture the HEC, presumably to keep alignment.  This
824 * version of the \ref libtrace_atm_cell is used when dealing with DAG
825 * captures of uni cells.
826 *
827 */
828typedef struct libtrace_atm_capture_cell
829{
830  LT_BITFIELD32 gfc:4;          /**< Generic Flow Control */
831  LT_BITFIELD32 vpi:8;          /**< Virtual Path Identifier */
832  LT_BITFIELD32 vci:16;         /**< Virtual Channel Identifier */
833  LT_BITFIELD32 pt:3;           /**< Payload Type */
834  LT_BITFIELD32 clp:1;          /**< Cell Loss Priority */
835} PACKED libtrace_atm_capture_cell_t;
836
837/** Captured NNI cell.
838 *
839 * Endace don't capture the HEC, presumably to keep alignment.  This
840 * version of the \ref libtrace_atm_nni_cell is used when dealing with DAG
841 * captures of nni cells.
842 *
843 */
844typedef struct libtrace_atm_nni_capture_cell
845{
846  LT_BITFIELD32 vpi:12;         /**< Virtual Path Identifier */
847  LT_BITFIELD32 vci:16;         /**< Virtual Channel Identifier */
848  LT_BITFIELD32 pt:3;           /**< Payload Type */
849  LT_BITFIELD32 clp:1;          /**< Cell Loss Priority */
850  LT_BITFIELD32 hec:8;          /**< Header Error Control */
851} PACKED libtrace_atm_nni_capture_cell_t;
852
853/** PPP header */
854typedef struct libtrace_ppp
855{
856 /* I can't figure out where the hell these two variables come from. They're
857  * definitely not in RFC 1661 which defines PPP. Probably some weird thing
858  * relating to the lack of distinction between PPP, HDLC and CHDLC */
859       
860/* uint8_t address; */          /**< PPP Address (0xFF - All stations) */
861/* uint8_t header;  */          /**< PPP Control (0x03 - Unnumbered info) */
862 uint16_t protocol;             /**< PPP Protocol (htons(0x0021) - IPv4 */
863} PACKED libtrace_ppp_t;
864
865/** PPPoE header */
866typedef struct libtrace_pppoe
867{
868 LT_BITFIELD8 version:4;        /**< Protocol version number */
869 LT_BITFIELD8 type:4;           /**< PPPoE Type */
870 uint8_t code;                  /**< PPPoE Code */
871 uint16_t session_id;           /**< Session Identifier */
872 uint16_t length;               /**< Total Length of the PPP packet */
873} PACKED libtrace_pppoe_t;
874
875/** Libtrace local definition of GRE (Generalised Routing Protocol) header
876 * RFC2890
877 */
878typedef struct libtrace_gre_t
879{
880    uint16_t flags;         /**< Flags and version */
881    uint16_t ethertype;     /**< Payload ethertype */
882    uint16_t checksum;      /**< Optional checksum */
883    uint16_t reserved1;     /**< Optional reserved */
884    uint16_t key;           /**< Optional key (or Tenant Network ID) */
885    uint16_t seq;           /**< Optional sequence number */
886} PACKED libtrace_gre_t;
887
888#define LIBTRACE_GRE_FLAG_CHECKSUM 0x8000
889#define LIBTRACE_GRE_FLAG_KEY      0x2000
890#define LIBTRACE_GRE_FLAG_SEQ      0x1000
891#define LIBTRACE_GRE_FLAG_VERMASK  0x0007
892
893
894/* PPTP GRE (RFC2637) */
895#define LIBTRACE_GRE_FLAG_ACK      0x0080
896#define LIBTRACE_GRE_PPTP_VERSION  0x0001
897
898/** Libtrace local definition of VXLAN Header
899 * (draft-mahalingam-dutt-dcops-vxlan)
900 */
901typedef struct libtrace_vxlan_t
902{
903    uint8_t flags;          /**< Flags */
904    uint8_t reserved1[3];   /**< Reserved */
905    uint8_t vni[3];         /**< VXLAN Network Identifier (VNI) */
906    uint8_t reserved2;
907} PACKED libtrace_vxlan_t;
908
909/** 802.11 header */
910typedef struct libtrace_80211_t {
911#if __BYTE_ORDER == __LITTLE_ENDIAN
912        LT_BITFIELD32      protocol:2;  /**< Protocol Version */
913        LT_BITFIELD32      type:2;      /**< Frame Type */
914        LT_BITFIELD32      subtype:4;   /**< Frame Subtype */
915#else
916        LT_BITFIELD32      subtype:4;   /**< Frame Subtype */
917        LT_BITFIELD32      type:2;      /**< Frame Type */
918        LT_BITFIELD32      protocol:2;  /**< Protocol Version */
919#endif
920
921#if __BYTE_ORDER == __LITTLE_ENDIAN
922        LT_BITFIELD32      to_ds:1;     /**< Packet to Distribution Service */
923        LT_BITFIELD32      from_ds:1;   /**< Packet from Distribution Service */
924        LT_BITFIELD32      more_frag:1; /**< Packet has more fragments */
925        LT_BITFIELD32      retry:1;     /**< Packet is a retry */
926        LT_BITFIELD32      power:1;     /**< Power Management mode */
927        LT_BITFIELD32      more_data:1; /**< More data is buffered at station */
928        LT_BITFIELD32      wep:1;       /**< WEP encryption indicator */
929        LT_BITFIELD32      order:1;     /**< Strictly-Ordered class indicator */
930#else
931        LT_BITFIELD32      order:1;     /**< Strictly-Ordered class indicator */
932        LT_BITFIELD32      wep:1;       /**< WEP encryption indicator */
933        LT_BITFIELD32      more_data:1; /**< More data is buffered at station */
934        LT_BITFIELD32      power:1;     /**< Power Management mode */
935        LT_BITFIELD32      retry:1;     /**< Packet is a retry */
936        LT_BITFIELD32      more_frag:1; /**< Packet has more fragments */
937        LT_BITFIELD32      from_ds:1;   /**< Packet from Distribution Service */
938        LT_BITFIELD32      to_ds:1;     /**< Packet to Distribution Service */
939#endif
940       
941        uint16_t     duration;  /**< Duration value for NAV calculation */
942        uint8_t      mac1[6];   /**< MAC Address 1 */
943        uint8_t      mac2[6];   /**< MAC Address 2 */
944        uint8_t      mac3[6];   /**< MAC Address 3 */
945        uint16_t     SeqCtl;    /**< Sequence Control */       
946        uint8_t      mac4[6];   /**< MAC Address 4 */
947} PACKED libtrace_80211_t;
948
949/** The Radiotap header pre-amble
950 *
951 * All Radiotap headers start with this pre-amble, followed by the fields
952 * specified in the it_present bitmask. If bit 31 of it_present is set, then
953 * another bitmask follows.
954 * @note All of the radiotap data fields are in little-endian byte-order.
955 */
956typedef struct libtrace_radiotap_t {
957    uint8_t     it_version; /**< Radiotap version */
958    uint8_t     it_pad; /**< Padding for natural alignment */
959    uint16_t    it_len; /**< Length in bytes of the entire Radiotap header */
960    uint32_t    it_present; /**< Which Radiotap fields are present */
961} PACKED libtrace_radiotap_t;
962
963/** OSPF header */
964typedef struct libtrace_ospf_v2_t
965{
966        uint8_t ospf_v;         /**< OSPF Version, should be 2 */
967        uint8_t type;           /**< OSPF Packet Type */
968        uint16_t ospf_len;      /**< Packet length, including OSPF header */
969        struct in_addr router;  /**< Router ID of the packet source */
970        struct in_addr area;    /**< Area the packet belongs to */
971        uint16_t sum;           /**< Checksum */
972        uint16_t au_type;       /**< Authentication procedure */
973        uint16_t zero;          /**< Always zero */
974        uint8_t au_key_id;      /**< Authentication Key ID */
975        uint8_t au_data_len;    /**< Authentication Data Length */
976        uint32_t au_seq_num;    /**< Cryptographic Sequence Number */
977} PACKED libtrace_ospf_v2_t;
978
979/** Options Field present in some OSPFv2 packets */
980typedef struct libtrace_ospf_options_t {
981#if __BYTE_ORDER == __LITTLE_ENDIAN
982        LT_BITFIELD8 unused1:1;
983        LT_BITFIELD8 e_bit:1;
984        LT_BITFIELD8 mc_bit:1;
985        LT_BITFIELD8 np_bit:1;
986        LT_BITFIELD8 ea_bit:1;
987        LT_BITFIELD8 dc_bit:1;
988        LT_BITFIELD8 unused2:2;
989#elif __BYTE_ORDER == __BIG_ENDIAN
990        LT_BITFIELD8 unused2:2;
991        LT_BITFIELD8 dc_bit:1;
992        LT_BITFIELD8 ea_bit:1;
993        LT_BITFIELD8 np_bit:1;
994        LT_BITFIELD8 mc_bit:1;
995        LT_BITFIELD8 e_bit:1;
996        LT_BITFIELD8 unused1:1;
997#endif
998} PACKED libtrace_ospf_options_t;
999
1000/** LSA Header for OSPFv2 */
1001typedef struct libtrace_ospf_lsa_v2_t
1002{
1003        uint16_t age;           /**< Time in seconds since LSA originated */
1004        libtrace_ospf_options_t lsa_options;    /**< Options */
1005        uint8_t lsa_type;       /**< LSA type */
1006        struct in_addr ls_id;   /**< Link State ID */
1007        struct in_addr adv_router; /**< Router that originated this LSA */
1008        uint32_t seq;           /**< LS sequence number */
1009        uint16_t checksum;      /**< Checksum */
1010        uint16_t length;        /**< Length of the LSA including LSA header */
1011} PACKED libtrace_ospf_lsa_v2_t;
1012
1013/** OSPFv2 Hello Packet */
1014typedef struct libtrace_ospf_hello_v2_t
1015{
1016        struct in_addr mask;    /**< Network mask for this interface */
1017        uint16_t interval;      /**< Interval between Hello packets (secs) */
1018        libtrace_ospf_options_t hello_options;  /**< Options */
1019        uint8_t priority;       /**< Router Priority */
1020        uint32_t deadint;       /**< Interval before declaring a router down */
1021        struct in_addr designated;      /**< Designated router for the network */
1022        struct in_addr backup;  /**< Backup designated router */
1023
1024        /** Neighbors follow from here, but there can be anywhere from 1 to N
1025         * neighbors so I can't include that here */
1026} PACKED libtrace_ospf_hello_v2_t;
1027
1028/** OSPFv2 Database Description packet */
1029typedef struct libtrace_ospf_db_desc_v2_t
1030{
1031        uint16_t mtu;           /**< Interface MTU */
1032        libtrace_ospf_options_t db_desc_options;        /**< Options */
1033#if __BYTE_ORDER == __LITTLE_ENDIAN
1034        LT_BITFIELD8 db_desc_ms:1;      /**< If set, this router is the master */
1035        LT_BITFIELD8 db_desc_m:1;       /**< If set, more packets to follow */
1036        LT_BITFIELD8 db_desc_i:1;       /**< If set, this is the first packet in sequence */
1037        LT_BITFIELD8 zero:5;
1038#elif __BYTE_ORDER == __BIG_ENDIAN
1039        LT_BITFIELD8 zero:5;
1040        LT_BITFIELD8 db_desc_i:1;       /**< If set, this is the first packet in sequence */
1041        LT_BITFIELD8 db_desc_m:1;       /**< If set, more packets to follow */
1042        LT_BITFIELD8 db_desc_ms:1;      /**< If set, this router is the master */
1043#endif
1044        uint32_t seq;           /**< Sequence number for DD packets */
1045} PACKED libtrace_ospf_db_desc_v2_t;
1046
1047/** OSPF Link State Request Packet */
1048typedef struct libtrace_ospf_ls_req_t
1049{
1050        uint32_t ls_type;       /**< Link State Type */
1051        uint32_t ls_id;         /**< Link State Id */
1052        uint32_t advertising_router;    /**< Advertising Router */
1053} PACKED libtrace_ospf_ls_req_t;
1054
1055/** OSPF Link State Update Packet */
1056typedef struct libtrace_ospf_ls_update_t
1057{
1058        uint32_t ls_num_adv;    /**< Number of LSAs in this packet */
1059
1060        /* Followed by LSAs, use API functions to access these */
1061} PACKED libtrace_ospf_ls_update_t;
1062
1063/** OSPFv2 AS External LSA Body */
1064typedef struct libtrace_ospf_as_external_lsa_t
1065{
1066        struct in_addr netmask; /**< Netmask for the destination */
1067#if __BYTE_ORDER == __LITTLE_ENDIAN
1068        LT_BITFIELD8 tos:7;
1069        LT_BITFIELD8 e:1;       /**< If set, metric is Type 2. Else, Type 1 */
1070#elif __BYTE_ORDER == __BIG_ENDIAN
1071        LT_BITFIELD8 e:1;       /**< If set, metric is Type 2. Else, Type 1 */
1072        LT_BITFIELD8 tos:7;
1073#endif
1074        uint8_t metric_a;       /**< Byte 1 of the Metric field */
1075        uint8_t metric_b;       /**< Byte 2 of the Metric field */
1076        uint8_t metric_c;       /**< Byte 3 of the Metric field */
1077        struct in_addr forwarding;      /**< Forwarding address */
1078        uint32_t external_tag;          /**< External Route Tag */
1079} PACKED libtrace_ospf_as_external_lsa_v2_t;
1080
1081/** OSPFv2 Summary LSA Body */
1082typedef struct libtrace_ospf_summary_lsa
1083{
1084        struct in_addr netmask; /**< Netmask for the destination */
1085        uint8_t zero;           /**< Always zero */
1086        uint8_t metric_a;       /**< Byte 1 of the Metric field */
1087        uint8_t metric_b;       /**< Byte 2 of the Metric field */
1088        uint8_t metric_c;       /**< Byte 3 of the Metric field */
1089       
1090} PACKED libtrace_ospf_summary_lsa_v2_t;
1091
1092/** OSPFv2 Network LSA Body */
1093typedef struct libtrace_ospf_network_lsa_t
1094{
1095        struct in_addr netmask; /**< Netmask for the network */
1096        /* Followed by IDs of attached routers */
1097} PACKED libtrace_ospf_network_lsa_v2_t;
1098
1099/** OSPFv2 Router Link structure */
1100typedef struct libtrace_ospf_link_t
1101{
1102        struct in_addr link_id;         /**< Object that link connects to */
1103        struct in_addr link_data;       /**< Link Data field */
1104        uint8_t type;                   /**< Link Type */
1105        uint8_t num_tos;                /**< Number of TOS metrics */
1106        uint16_t tos_metric;            /**< Cost of router link */
1107} PACKED libtrace_ospf_link_v2_t;
1108
1109/** OSPFv2 Router LSA */
1110typedef struct libtrace_ospf_router_lsa_t
1111{
1112#if __BYTE_ORDER == __LITTLE_ENDIAN
1113        LT_BITFIELD8 b:1;       /**< Area Border Router Flag */
1114        LT_BITFIELD8 e:1;       /**< External Router Flag */
1115        LT_BITFIELD8 v:1;       /**< Virtual Endpoint Flag */
1116        LT_BITFIELD8 zero:5;
1117#elif __BYTE_ORDER == __BIG_ENDIAN
1118        LT_BITFIELD8 zero:5;
1119        LT_BITFIELD8 v:1;       /**< Virtual Endpoint Flag */
1120        LT_BITFIELD8 e:1;       /**< External Router Flag */
1121        LT_BITFIELD8 b:1;       /**< Area Border Router Flag */
1122#endif
1123        uint8_t zero2;          /**< Always zero */
1124        uint16_t num_links;     /**< Number of links in LSA */
1125} PACKED libtrace_ospf_router_lsa_v2_t;
1126
1127/** OSPF message types */
1128typedef enum {
1129        TRACE_OSPF_HELLO = 1,           /**< OSPF Hello */
1130        TRACE_OSPF_DATADESC = 2,        /**< OSPF Database Description */
1131        TRACE_OSPF_LSREQ = 3,           /**< OSPF Link State Request */
1132        TRACE_OSPF_LSUPDATE = 4,        /**< OSPF Link State Update */
1133        TRACE_OSPF_LSACK = 5            /**< OSPF Link State Acknowledgement */
1134} libtrace_ospf_types_t;
1135
1136/** OSPF link state acknowledgement types */
1137typedef enum {
1138        TRACE_OSPF_LS_ROUTER = 1,       /**< OSPF Router LSA */
1139        TRACE_OSPF_LS_NETWORK = 2,      /**< OSPF Network LSA */
1140        TRACE_OSPF_LS_SUMMARY = 3,      /**< OSPF Summary LSA */
1141        TRACE_OSPF_LS_ASBR_SUMMARY = 4, /**< OSPF Summary LSA (ASBR) */
1142        TRACE_OSPF_LS_EXTERNAL = 5      /**< OSPF AS External LSA */
1143} libtrace_ospf_ls_types_t;
1144
1145/** A local definition of an SLL header */
1146typedef struct libtrace_sll_header_t {
1147        uint16_t pkttype;               /**< Packet type */
1148        uint16_t hatype;                /**< Link-layer address type */
1149        uint16_t halen;                 /**< Link-layer address length */
1150        unsigned char addr[8];          /**< Link-layer address */
1151        uint16_t protocol;              /**< Protocol */
1152} libtrace_sll_header_t;
1153
1154
1155/* SLL packet types */
1156
1157/** Packet was addressed for the local host */
1158#define TRACE_SLL_HOST          0
1159/** Packet was addressed for a broadcast address */
1160#define TRACE_SLL_BROADCAST     1
1161/** Packet was addressed for a multicast address */
1162#define TRACE_SLL_MULTICAST     2
1163/** Packet was addressed for another host but was captured by a promiscuous
1164 * device */
1165#define TRACE_SLL_OTHERHOST     3
1166/** Packet originated from the local host */
1167#define TRACE_SLL_OUTGOING      4
1168
1169
1170#ifdef WIN32
1171#pragma pack(pop)
1172#endif
1173
1174
1175/*@}*/
1176
1177/** Prints help information for libtrace
1178 *
1179 * Function prints out some basic help information regarding libtrace,
1180 * and then prints out the help() function registered with each input module
1181 */
1182DLLEXPORT void trace_help(void);
1183
1184/** Causes a libtrace reader to stop blocking whilst waiting on new packets
1185 * and immediately return EOF.
1186 *
1187 * This function is useful if you are handling signals within your libtrace
1188 * program. If a live source is not receiving any packets (or they are being
1189 * filtered), a call to trace_read_packet will result in an infinite loop as
1190 * it will block until a packet is received. Normally, a SIGINT would cause the
1191 * program to end and thus break the loop, but if you are handling the signal
1192 * yourself then that signal will never reach libtrace.
1193 *
1194 * Instead this function sets a global variable within libtrace that will
1195 * cause a blocking live capture to break on the next internal timeout,
1196 * allowing control to be returned to the user and their own signal handling
1197 * to kick in.
1198 */
1199DLLEXPORT void trace_interrupt(void);
1200
1201/** @name Trace management
1202 * These members deal with creating, configuring, starting, pausing and
1203 * cleaning up a trace object
1204 *@{
1205 */
1206
1207/** Takes a uri and splits it into a format and uridata component.
1208 * @param uri           The uri to be parsed
1209 * @param [out] format  A pointer that will be updated to point to an allocated
1210 *                      string holding the format component of the URI
1211 * @return NULL if an error occurred, otherwise return a pointer to the uridata
1212 * component
1213 *
1214 * @note The format component is strdup'd by this function, so be sure to free
1215 * it when you are done with the split URI. Similarly, do not pass a pointer
1216 * to an allocated string into this function as the 'format' parameter, as
1217 * that memory will be leaked and replaced with the strdup'd format.
1218 */
1219DLLEXPORT const char *trace_parse_uri(const char *uri, char **format);
1220
1221/** Create an input trace from a URI
1222 *
1223 * @param uri A valid libtrace URI to be opened
1224 * @return An opaque pointer to a libtrace_t
1225 *
1226 * Some valid URI's are:
1227 *  - erf:/path/to/erf/file
1228 *  - erf:-  (stdin)
1229 *  - dag:/dev/dagcard
1230 *  - pcapint:pcapinterface                (eg: pcap:eth0)
1231 *  - pcap:/path/to/pcap/file
1232 *  - pcap:-
1233 *  - rt:hostname
1234 *  - rt:hostname:port
1235 *
1236 *  If an error occurred when attempting to open the trace file, a
1237 *  trace is still returned so trace_is_err() should be called to find out
1238 *  if an error occurred. The trace is created in the configuration state, you
1239 *  must call trace_start before attempting to read packets from the trace.
1240 */
1241DLLEXPORT libtrace_t *trace_create(const char *uri);
1242
1243/** Creates a "dummy" trace file that has only the format type set.
1244 *
1245 * @param uri A valid (but fake) URI indicating the format of the dummy trace that is to be created.
1246 * @return An opaque pointer to a (sparsely initialised) libtrace_t
1247 *
1248 * Only the format portion of the uri parameter matters - the 'file' being
1249 * opened does not have to exist.
1250 *
1251 * @note IMPORTANT: Do not attempt to call trace_read_packet or other such
1252 * functions with the dummy trace. Its intended purpose is to provide access
1253 * to the format functions where the original trace may no longer exist or is
1254 * not the correct format, e.g. reading ERF packets from an RT input.
1255 */
1256DLLEXPORT libtrace_t *trace_create_dead(const char *uri);
1257
1258/** Creates a trace output file from a URI.
1259 *
1260 * @param uri The uri string describing the output format and destination
1261 * @return An opaque pointer to a libtrace_output_t
1262 *
1263 * Valid URIs include:
1264 *  - erf:/path/to/erf/file
1265 *  - pcap:/path/to/pcap/file
1266 *
1267 *  If an error occurred when attempting to open the output trace, a trace is
1268 *  still returned but trace_errno will be set. Use trace_is_err_out() and
1269 *  trace_perror_output() to get more information.
1270 */
1271DLLEXPORT libtrace_out_t *trace_create_output(const char *uri);
1272
1273/** Start an input trace
1274 * @param libtrace      The trace to start
1275 * @return 0 on success, -1 on failure
1276 *
1277 * This does the actual work of starting the input trace and applying
1278 * all the config options.  This may fail, returning -1. The libtrace error
1279 * handling functions can be used to get more information about what
1280 * specifically went wrong.
1281 */
1282DLLEXPORT int trace_start(libtrace_t *libtrace);
1283
1284/** Pauses an input trace
1285 * @param libtrace      The trace to pause
1286 * @return 0 on success, -1 on failure
1287 *
1288 * This stops an input trace that is in progress and returns you to the
1289 * configuration state.  Any packets that arrive on a live capture after
1290 * trace_pause() has been called will be discarded.  To resume the trace, call
1291 * trace_start().
1292 */
1293DLLEXPORT int trace_pause(libtrace_t *libtrace);
1294
1295/** Start an output trace
1296 * @param libtrace      The trace to start
1297 * @return 0 on success, -1 on failure
1298 *
1299 * This does the actual work with starting a trace capable of writing packets. 
1300 * This generally creates the output file.
1301 */
1302DLLEXPORT int trace_start_output(libtrace_out_t *libtrace);
1303
1304/** Valid configuration options for input traces */
1305typedef enum {
1306        /** Maximum number of bytes to be captured for any given packet */
1307        TRACE_OPTION_SNAPLEN,   
1308
1309        /** If enabled, places a live capture interface into promiscuous mode */
1310        TRACE_OPTION_PROMISC,   
1311
1312        /** Apply this filter to all packets read from this trace */
1313        TRACE_OPTION_FILTER,   
1314
1315        /** Defines the frequency of meta-data reporting, e.g. DUCK packets */
1316        TRACE_OPTION_META_FREQ,
1317
1318        /** If enabled, the libtrace event API will ignore time gaps between
1319         * packets when reading from a trace file */
1320        TRACE_OPTION_EVENT_REALTIME,
1321
1322        /** The hasher function for a parallel libtrace. It is recommended to
1323         * access this option via trace_set_hasher(). */
1324        TRACE_OPTION_HASHER,
1325
1326        /** Speed up trace file replays (via trace_event()) by this factor */
1327        TRACE_OPTION_REPLAY_SPEEDUP,
1328} trace_option_t;
1329
1330/** Sets an input config option
1331 * @param libtrace      The trace object to apply the option to
1332 * @param option        The option to set
1333 * @param value         The value to set the option to
1334 * @return -1 if option configuration failed, 0 otherwise
1335 *
1336 * This should be called after trace_create(), and before trace_start()
1337 *
1338 * @note Please consider using the newer trace_set_X() functions to access
1339 * this function.
1340 */
1341DLLEXPORT int trace_config(libtrace_t *libtrace,
1342                trace_option_t option,
1343                void *value);
1344
1345/** Maximum number of bytes to be captured for any given packet
1346 *
1347 * @param libtrace The trace object to apply the option to
1348 * @param snaplen The snap length to set
1349 * @return -1 if option configuration failed, 0 otherwise
1350 */
1351DLLEXPORT int trace_set_snaplen(libtrace_t *trace, int snaplen);
1352
1353/** If enabled, places a live capture interface into promiscuous mode
1354 *
1355 * @param libtrace The trace object to apply the option to
1356 * @param promisc
1357 * @return -1 if option configuration failed, 0 otherwise
1358 */
1359DLLEXPORT int trace_set_promisc(libtrace_t *trace, bool promisc);
1360
1361/** Apply this filter to all packets read from this trace
1362 *
1363 * @param libtrace The trace object to apply the option to
1364 * @param filter The filter to apply
1365 * @return -1 if option configuration failed, 0 otherwise
1366 */
1367DLLEXPORT int trace_set_filter(libtrace_t *trace, libtrace_filter_t *filter);
1368
1369/** Defines the frequency of meta-data reporting, e.g. DUCK packets
1370 *
1371 * @param libtrace The trace object to apply the option to
1372 * @param freq The meta data frequency
1373 * @return -1 if option configuration failed, 0 otherwise
1374 */
1375DLLEXPORT int trace_set_meta_freq(libtrace_t *trace, int freq);
1376
1377/** If enabled, the libtrace event API will ignore time gaps between
1378 * packets when reading from a trace file.
1379 *
1380 * @param libtrace The trace object to apply the option to
1381 * @param realtime True ignores gaps
1382 * @return -1 if option configuration failed, 0 otherwise
1383 */
1384DLLEXPORT int trace_set_event_realtime(libtrace_t *trace, bool realtime);
1385
1386/** Valid compression types
1387 * Note, this must be kept in sync with WANDIO_COMPRESS_* numbers in wandio.h
1388 */
1389typedef enum {
1390        TRACE_OPTION_COMPRESSTYPE_NONE = 0, /**< No compression */
1391        TRACE_OPTION_COMPRESSTYPE_ZLIB = 1, /**< GZip Compression */
1392        TRACE_OPTION_COMPRESSTYPE_BZ2  = 2, /**< BZip2 Compression */
1393        TRACE_OPTION_COMPRESSTYPE_LZO  = 3,  /**< LZO Compression */
1394        TRACE_OPTION_COMPRESSTYPE_LZMA  = 4,  /**< LZO Compression */
1395        TRACE_OPTION_COMPRESSTYPE_LAST
1396} trace_option_compresstype_t;
1397
1398/** Valid configuration options for output traces */
1399typedef enum {
1400        /** File flags to use when opening an output file, e.g. O_APPEND */
1401        TRACE_OPTION_OUTPUT_FILEFLAGS,
1402        /** Compression level: 0 = no compression, 1 = faster compression,
1403         * 9 = better compression */
1404        TRACE_OPTION_OUTPUT_COMPRESS,
1405        /** Compression type, see trace_option_compresstype_t */
1406        TRACE_OPTION_OUTPUT_COMPRESSTYPE
1407} trace_option_output_t;
1408
1409/* To add a new stat field update this list, and the relevant places in
1410 * libtrace_stat_t structure.
1411 */
1412/** An X Macro set for libtrace stat fields */
1413#define LIBTRACE_STAT_FIELDS \
1414        X(accepted) \
1415        X(filtered) \
1416        X(received) \
1417        X(dropped) \
1418        X(captured) \
1419        X(missing) \
1420        X(errors)
1421
1422/**
1423 * Statistic counters are cumulative from the time the trace is started.
1424 * Trace pause will reset the counters, to zero.
1425 * Always check \a{field}_valid is set before attempting to read the stored
1426 * value.
1427 *
1428 * @note Always allocate this structure using trace_create_statistics().
1429 *       This allows us to extend the structure in the future.
1430 */
1431typedef struct libtrace_stat_t {
1432#define X(name) LT_BITFIELD64 name ##_valid : 1;
1433        LIBTRACE_STAT_FIELDS
1434#undef X
1435        /* We use the remaining space as magic to ensure the structure
1436         * was alloc'd by us. We can easily decrease the no. bits without
1437         * problems as long as we update any asserts as needed */
1438        LT_BITFIELD64 reserved1: 25; /**< Bits reserved for future fields */
1439        LT_BITFIELD64 reserved2: 24; /**< Bits reserved for future fields */
1440        LT_BITFIELD64 magic: 8; /**< A number stored against the format to
1441                                  ensure the struct was allocated correctly */
1442
1443        /* These must all be uint64_t's, match this order with the X macro */
1444        /** The number of packets that have been read from the input trace
1445         * using trace_read_packet(). In the parallel framework this may include
1446         * some packets waiting in a batch yet to be seen by the user's
1447         * application.
1448         *
1449         * This does not include filtered packets because these do not make it
1450         * to trace_read_packet().
1451         *
1452         * @note This field replaces trace_get_accepted_packets()
1453         */
1454        uint64_t accepted;
1455
1456        /** The number of packets that were captured, but discarded for not
1457         * matching a provided filter.
1458         *
1459         * @note This field replaces trace_get_filtered_packets()
1460         */
1461        uint64_t filtered;
1462
1463        /** The total number of good packets which have been received. Including
1464         * those which are dropped and filtered. This does not include errors.
1465         *
1466         * @note This may include a small number of buffered packets
1467         *       not yet included in accepted.
1468         *
1469         * @note This field replaces trace_get_received_packets()
1470         */
1471        uint64_t received;
1472
1473        /** The number of packets that have been dropped on an input trace
1474         * due to lack of buffer space on the capturing device. This does not
1475         * included errored packets which are dropped directly by the card.
1476         *
1477         * @note This field replaces trace_get_dropped_packets()
1478         */
1479        uint64_t dropped;
1480
1481        /** The number of received packets that have not been dropped. This
1482         * includes filtered packets.
1483         *
1484         * This is equivalent to received-dropped.
1485         *
1486         * @note This may include a small number of buffered packets
1487         *       not yet included in accepted.
1488         */
1489        uint64_t captured;
1490
1491        /** The number of packets (or aggregated records) that have been
1492         *  lost between the original capture device and the current input
1493         *  trace.
1494         *
1495         *  @note Only relevant for input formats that use a network to
1496         *  transfer live captured packets from one host to another (e.g.
1497         *  nDAG).
1498         */
1499        uint64_t missing;
1500
1501        /** The number of packets that have been discarded by the network card
1502         * because they are invalid. That includes FCS mismatches, incorrect
1503         * packet lengths etc.
1504         */
1505        uint64_t errors;
1506} libtrace_stat_t;
1507
1508ct_assert(offsetof(libtrace_stat_t, accepted) == 8);
1509
1510/** Sets an output config option
1511 *
1512 * @param libtrace      The output trace object to apply the option to
1513 * @param option        The option to set
1514 * @param value         The value to set the option to
1515 * @return -1 if option configuration failed, 0 otherwise
1516 * This should be called after trace_create_output, and before
1517 * trace_start_output
1518 */
1519DLLEXPORT int trace_config_output(libtrace_out_t *libtrace,
1520                trace_option_output_t option,
1521                void *value
1522                );
1523
1524/** Close an input trace, freeing up any resources it may have been using
1525 *
1526 * @param trace         The input trace to be destroyed
1527 *
1528 */
1529DLLEXPORT void trace_destroy(libtrace_t *trace);
1530
1531/** Close a dummy trace file, freeing up any resources it may have been using
1532 * @param trace         The dummy trace to be destroyed
1533 */
1534DLLEXPORT void trace_destroy_dead(libtrace_t *trace);
1535
1536/** Close an output trace, freeing up any resources it may have been using
1537 * @param trace         The output trace to be destroyed
1538 */
1539DLLEXPORT void trace_destroy_output(libtrace_out_t *trace);
1540
1541/** Flush an output trace, forcing any buffered packets to be written
1542 * @param libtrace      The output trace to be flushed
1543 */
1544DLLEXPORT int trace_flush_output(libtrace_out_t *libtrace);
1545
1546/** Check (and clear) the current error state of an input trace
1547 * @param trace         The input trace to check the error state on
1548 * @return The current error status and message
1549 *
1550 * This reads and returns the current error state and sets the current error
1551 * to "no error".
1552 */
1553DLLEXPORT libtrace_err_t trace_get_err(libtrace_t *trace);
1554
1555/** Indicate if there has been an error on an input trace
1556 * @param trace         The input trace to check the error state on
1557 * @return true if an error has occurred, false otherwise
1558 *
1559 * @note This does not clear the error status, and only returns true or false.
1560 */
1561DLLEXPORT bool trace_is_err(libtrace_t *trace);
1562
1563/** Outputs the error message for an input trace to stderr and clear the error
1564 * status.
1565 * @param trace         The input trace with the error to output
1566 * @param msg           The message to prepend to the error
1567 *
1568 * This function does clear the error status.
1569 */
1570DLLEXPORT void trace_perror(libtrace_t *trace, const char *msg,...) PRINTF(2,3);
1571
1572/** Checks (and clears) the current error state for an output trace
1573 * @param trace         The output trace to check the error state on
1574 * @return The current error status and message
1575 *
1576 * This reads and returns the current error state and sets the current error
1577 * to "no error".
1578 */
1579DLLEXPORT libtrace_err_t trace_get_err_output(libtrace_out_t *trace);
1580
1581/** Indicates if there is an error on an output trace
1582 * @param trace         The output trace to check the error state on
1583 * @return true if an error has occurred, false otherwise.
1584 *
1585 * This does not clear the error status, and only returns true or false.
1586 */
1587DLLEXPORT bool trace_is_err_output(libtrace_out_t *trace);
1588
1589/** Outputs the error message for an output trace to stderr and clear the error
1590 * status.
1591 * @param trace         The output trace with the error to output
1592 * @param msg           The message to prepend to the error
1593 * This function does clear the error status.
1594 */
1595DLLEXPORT void trace_perror_output(libtrace_out_t *trace, const char *msg,...)
1596        PRINTF(2,3);
1597
1598/** Returns the number of packets observed on an input trace.
1599 * Includes the number of packets counted as early as possible, before
1600 * filtering, and includes dropped packets.
1601 *
1602 * @param trace         The input trace to examine
1603 * @returns The number of packets seen at the capture point before filtering.
1604 *
1605 * If the number is not known, this function will return UINT64_MAX
1606 *
1607 * @deprecated This function is deprecated: Use trace_get_statistics(), this
1608 *             allows all statistic counters to be read in an atomic manner.
1609 */
1610DLLEXPORT DEPRECATED
1611uint64_t trace_get_received_packets(libtrace_t *trace);
1612
1613/** Returns the number of packets that were captured, but discarded for not
1614 * matching a provided filter.
1615 *
1616 * @param trace         The input trace to examine
1617 * @returns The number of packets that were successfully captured, but filtered
1618 *
1619 * If the number is not known, this function will return UINT64_MAX
1620 *
1621 * @deprecated This function is deprecated: Use trace_get_statistics(), this
1622 *             allows all statistic counters to be read in an atomic manner.
1623 */
1624DLLEXPORT DEPRECATED
1625uint64_t trace_get_filtered_packets(libtrace_t *trace);
1626
1627/** Returns the number of packets that have been dropped on an input trace due
1628 * to lack of buffer space on the capturing device.
1629 *
1630 * @param trace         The input trace to examine
1631 * @returns The number of packets captured, but dropped due to buffer overruns
1632 *
1633 * If the number is not known, this function will return UINT64_MAX
1634 *
1635 * @deprecated This function is deprecated: Use trace_get_statistics(), this
1636 *             allows all statistic counters to be read in an atomic manner.
1637 */
1638DLLEXPORT DEPRECATED
1639uint64_t trace_get_dropped_packets(libtrace_t *trace);
1640
1641/** Returns the number of packets that have been read from the input trace using
1642 * trace_read_packet().
1643 *
1644 * @param trace         The input trace to examine
1645 * @returns The number of packets that have been read by the libtrace user.
1646 *
1647 * If the number is not known, this function will return UINT64_MAX
1648 *
1649 * @deprecated This function is deprecated: Use trace_get_statistics(), this
1650 *             allows all statistic counters to be read in an atomic manner.
1651 */
1652DLLEXPORT DEPRECATED
1653uint64_t trace_get_accepted_packets(libtrace_t *trace);
1654
1655/**
1656 * Returns statistic counters for a trace, for a parallel trace this is a
1657 * combined total.
1658 * Where possible these are retrieved atomically, however this behaviour depends
1659 * on the underlying trace format.
1660 *
1661 * @param trace The input trace to examine.
1662 * @param stats Optional, Filled upon return with statistics about the trace,
1663 *              check the flags included to see if a given statistic is valid.
1664 *              If NULL a statistic structure owned by libtrace is returned, this
1665 *              should not be free'd and will become invalid if the trace is
1666 *              destroyed.
1667 *
1668 * @return A pointer to the statistics structure.
1669 * @note Use trace_create_stat() to create the stats object, this way future
1670 *       versions of libtrace can add to the structure without breaking existing
1671 *       code.
1672 */
1673DLLEXPORT
1674libtrace_stat_t *trace_get_statistics(libtrace_t *trace, libtrace_stat_t *stats);
1675
1676
1677/**
1678 * Returns statistic counters for a single thread of a trace.
1679 * Where possible these are retrieved atomically, however this behaviour depends
1680 * on the underlying trace format.
1681 *
1682 * @param trace The input trace to examine.
1683 * @param t An optional thread to received stats for or NULL to retrieve stats
1684 *          for the current thread
1685 * @param stats Filled upon return with statistics about the trace, check the
1686 *              flags included to see if a given statistic is valid.
1687 *
1688 * @note Use trace_create_stat() to create the stats object, this way future
1689 *       versions of libtrace can add to the structure without breaking existing
1690 *       code.
1691 */
1692DLLEXPORT
1693void trace_get_thread_statistics(libtrace_t *trace, libtrace_thread_t *t,
1694                                 libtrace_stat_t *stats);
1695
1696/**
1697 * Creates and returns a zeroed libtrace_stat_t structure.
1698 *
1699 * This allows us to add extra fields increasing the size of the structure
1700 * without breaking existing libtrace applications.
1701 *
1702 * This structure should be free'd using free().
1703 *
1704 * @return A valid pointer to a libtrace_stat_t struct otherwise NULL if
1705 *         memory was not available.
1706 */
1707DLLEXPORT libtrace_stat_t* trace_create_statistics(void);
1708
1709/**
1710 * Clear all fields of given statistic.
1711 * This api doesn't verify the magic field unlike other stat apis.
1712 *
1713 * @param s The statistic structure to clear
1714 */
1715DLLEXPORT
1716void trace_clear_statistics(libtrace_stat_t *s);
1717
1718/**
1719 * Performs the operation c=a-b accounting for valid fields.
1720 * c is allowed to be a or b.
1721 *
1722 * @param a The minuend
1723 * @param b The subtrahend
1724 * @param c The resulting difference
1725 */
1726DLLEXPORT
1727void trace_subtract_statistics(const libtrace_stat_t *a,
1728                               const libtrace_stat_t *b, libtrace_stat_t *c);
1729
1730/**
1731 * Performs operation c=a+b accounting for valid fields.
1732 * c is allowed to be a or b.
1733 *
1734 * @param a The first operand
1735 * @param b The second operand
1736 * @param c The result
1737 */
1738DLLEXPORT
1739void trace_add_statistics(const libtrace_stat_t *a,
1740                          const libtrace_stat_t *b, libtrace_stat_t *c);
1741
1742/**
1743 * Prints all valid stats to a file stream, (which could be stdout/err).
1744 * By default the format "name: value" is used.
1745 *
1746 * @param s The statistic structure to print
1747 * @param f The output file stream
1748 * @param format An optional format string such as the default ("%s: %"PRIu64"\n")
1749 *               This is passed to fprintf and called with two arguments
1750 *               first a char* (%s) and second a uint64_t (%PRIu64).
1751 *
1752 * @return -1 if an error occurs when writing to the file stream, check errno.
1753 *         Otherwise 0.
1754 */
1755DLLEXPORT
1756int trace_print_statistics(const libtrace_stat_t *s, FILE *f,
1757                           const char *format);
1758
1759
1760/*@}*/
1761
1762/** @name Reading / Writing packets
1763 * These members deal with creating, reading and writing packets
1764 *
1765 * @{
1766 */
1767
1768/** Create a new packet object
1769 *
1770 * @return A pointer to an initialised libtrace_packet_t object, or NULL if
1771 * libtrace is unable to allocate space for a new packet.
1772 */
1773DLLEXPORT libtrace_packet_t *trace_create_packet(void);
1774
1775/** Copy a packet object
1776 * @param packet        The source packet to copy
1777 * @return A new packet which has the same content as the source packet
1778 *
1779 * @note This always involves a copy, which can be slow.  Use of this
1780 * function should be avoided where possible.
1781 *
1782 * @par The reason you would want to use this function is that a zero-copied
1783 * packet from a device will be stored using memory owned by the device which
1784 * may be a limited resource. Copying the packet will ensure that the packet
1785 * is now stored in memory owned and managed by libtrace.
1786 */
1787DLLEXPORT libtrace_packet_t *trace_copy_packet(const libtrace_packet_t *packet);
1788
1789/** Destroy a packet object
1790 * @param packet        The packet to be destroyed
1791 *
1792 */
1793DLLEXPORT void trace_destroy_packet(libtrace_packet_t *packet);
1794
1795/** Read the next packet from an input trace
1796 *
1797 * @param trace         The libtrace opaque pointer for the input trace
1798 * @param packet        The packet opaque pointer
1799 * @return 0 on EOF, negative value on error, number of bytes read when successful.
1800 *
1801 * @note The number of bytes read is usually (but not always) the same as
1802 * trace_get_framing_length()+trace_get_capture_length() depending on the
1803 * trace format.
1804 *
1805 * @note The trace must have been started with trace_start before calling
1806 * this function
1807 *
1808 * @note When reading from a live capture, this function will block until a
1809 * packet is observed on the capture interface. The libtrace event API
1810 * (e.g. trace_event()) should be used if non-blocking operation is required.
1811 */
1812DLLEXPORT int trace_read_packet(libtrace_t *trace, libtrace_packet_t *packet);
1813
1814/** Converts the data provided in buffer into a valid libtrace packet
1815 *
1816 * @param trace         An input trace of the same format as the "packet"
1817 *                      contained in the buffer
1818 * @param packet        The libtrace packet to prepare
1819 * @param buffer        A buffer containing the packet data, including the
1820 *                      capture format header
1821 * @param rt_type       The RT type for the packet that is being prepared
1822 * @param flags         Used to specify options for the preparation function,
1823 *                      e.g. who owns the packet buffer
1824 *
1825 * @return -1 if an error occurs, 0 otherwise
1826 *
1827 * Packet preparation is a tricky concept - the idea is to take the data
1828 * pointed to by 'buffer' and treat it as a packet record of the same capture
1829 * format as that used by the input trace. The provided libtrace packet then
1830 * has its internal pointers and values set to describe the packet record in
1831 * the buffer.
1832 *
1833 * The primary use of this function is to allow the RT packet reader to
1834 * easily and safely convert packets from the RT format back into the format
1835 * that they were originally captured with., essentially removing the RT
1836 * encapsulation.
1837 *
1838 * This function is now available via the exported API, as it can have some
1839 * uses outside of internal libtrace contexts. However, we strongly advise
1840 * that you avoid using this function unless you really know what you are
1841 * doing.
1842 */
1843DLLEXPORT int trace_prepare_packet(libtrace_t *trace, libtrace_packet_t *packet,
1844                void *buffer, libtrace_rt_types_t rt_type, uint32_t flags);
1845
1846/** Flags for prepare_packet functions */
1847enum {
1848        /** The buffer memory has been allocated by libtrace and should be
1849         * freed when the packet is destroyed. */
1850        TRACE_PREP_OWN_BUFFER           =1,
1851
1852        /** The buffer memory is externally-owned and must not be freed by
1853         * libtrace when the packet is destroyed. */
1854        TRACE_PREP_DO_NOT_OWN_BUFFER    =0
1855};
1856
1857
1858/** Event types
1859 * see \ref libtrace_eventobj_t and \ref trace_event
1860 */
1861typedef enum {
1862        TRACE_EVENT_IOWAIT,     /**< Wait on the given file descriptor */
1863        TRACE_EVENT_SLEEP,      /**< Sleep for the given amount of time */
1864        TRACE_EVENT_PACKET,     /**< Packet has been read from input trace */
1865        TRACE_EVENT_TERMINATE   /**< End of input trace */
1866} libtrace_event_t;
1867
1868/** Structure returned by libtrace_event explaining what the current event is */
1869typedef struct libtrace_eventobj_t {
1870        libtrace_event_t type; /**< Event type (iowait,sleep,packet) */
1871       
1872        /** If the event is IOWAIT, the file descriptor to wait on */
1873        int fd;               
1874        /** If the event is SLEEP, the amount of time to sleep for in seconds */
1875        double seconds;       
1876        /** If the event is PACKET, the value returned by trace_read_packet() */
1877        int size;
1878} libtrace_eventobj_t;
1879
1880/** Processes the next libtrace event from an input trace.
1881 * @param trace The libtrace opaque pointer for the input trace
1882 * @param packet The libtrace_packet opaque pointer to use for reading packets
1883 * @return A libtrace_event struct containing the event type and details of the event.
1884 *
1885 * Type can be:
1886 *  TRACE_EVENT_IOWAIT  Waiting on I/O on a file descriptor
1887 *  TRACE_EVENT_SLEEP   Wait a specified amount of time for the next event
1888 *  TRACE_EVENT_PACKET  Packet was read from the trace
1889 *  TRACE_EVENT_TERMINATE Trace terminated (perhaps with an error condition)
1890 */
1891DLLEXPORT libtrace_eventobj_t trace_event(libtrace_t *trace,
1892                libtrace_packet_t *packet);
1893
1894
1895/** Write one packet out to the output trace
1896 *
1897 * @param trace         The libtrace_out opaque pointer for the output trace
1898 * @param packet        The packet opaque pointer of the packet to be written
1899 * @return The number of bytes written out, if zero or negative then an error has occured.
1900 */
1901DLLEXPORT int trace_write_packet(libtrace_out_t *trace, libtrace_packet_t *packet);
1902
1903/** Gets the capture format for a given packet.
1904 * @param packet        The packet to get the capture format for.
1905 * @return The capture format of the packet
1906 *
1907 * @note Due to ability to convert packets between formats relatively easily
1908 * in Libtrace, the format of the packet right now may not be the format that
1909 * the packet was originally captured with.
1910 */
1911DLLEXPORT
1912enum base_format_t trace_get_format(struct libtrace_packet_t *packet);
1913
1914/** Construct a libtrace packet from a buffer containing the packet payload.
1915 * @param[in,out] packet        Libtrace Packet object to update with the new
1916 *                              data.
1917 * @param linktype              The linktype of the packet data.
1918 * @param[in] data              The packet data (including linklayer).
1919 * @param len                   Length of packet data provided in the buffer.
1920 *
1921 * @note The constructed packet will be in the PCAP format.
1922 *
1923 * @note To be useful, the provided buffer must start with the layer 2 header
1924 * (or a metadata header, if desired).
1925 */
1926DLLEXPORT
1927void trace_construct_packet(libtrace_packet_t *packet,
1928                libtrace_linktype_t linktype, const void *data, uint16_t len);
1929
1930/*@}*/
1931
1932/** @name Protocol decodes
1933 * These functions locate and return a pointer to various headers inside a
1934 * packet
1935 *
1936 * A packet is divided up into several "layers.":
1937 *
1938 * @li Framing header -- This is the header provided by the capture format
1939 * itself rather than anything that was sent over the network. This provides
1940 * basic details about the packet record including capture lengths, wire
1941 * lengths, timestamps, direction information and any other metadata that is
1942 * part of the capture format. 
1943 *
1944 * @li Metadata header (optional) -- A header containing metadata about a
1945 * packet that was captured, but the metadata was not transmitted over the
1946 * wire.  Some examples include RadioTap and Linux_sll headers.  This can be
1947 * retrieved by trace_get_packet_meta(), or skipped using
1948 * trace_get_payload_from_meta(). There may be multiple "metadata" headers on
1949 * a packet.
1950 *
1951 * @li Layer 2/Link layer/Datalink header -- This can be retrieved by
1952 * trace_get_layer2(), or skipped using trace_get_payload_from_layer2().
1953 *
1954 * @li Layer 3/IP/IPv6 -- This can be retrieved by trace_get_layer3().  As a
1955 * convenience trace_get_ip()/trace_get_ip6() can be used to find an IPv4/IPv6
1956 * header.
1957 *
1958 * @li Layer 5/transport -- These are protocols carried in IPv4/IPv6 frames.
1959 * These can be retrieved using trace_get_transport().
1960 *
1961 * @{
1962 */
1963
1964
1965/** Gets a pointer to the first byte of the packet as it was captured and
1966 * returns its corresponding linktype and capture length.
1967 *
1968 * Use this function instead of the deprecated trace_get_link().
1969 *
1970 * @param packet The packet to get the buffer from
1971 * @param[out] linktype The linktype of the returned pointer
1972 * @param[out] remaining The capture length (the number of captured bytes from
1973 * the returned pointer)
1974 * @return A pointer to the first byte of the packet
1975 */
1976DLLEXPORT void *trace_get_packet_buffer(const libtrace_packet_t *packet,
1977                libtrace_linktype_t *linktype, uint32_t *remaining);
1978
1979/** Get a pointer to the link layer for a given packet
1980 * @param packet        The packet to get the link layer for
1981 *
1982 * @return A pointer to the link layer, or NULL if there is no link layer
1983 *
1984 * @deprecated This function is deprecated: Use trace_get_packet_buffer() or
1985 * one of the trace_get_layer*() functions instead.
1986 * @note You should call trace_get_link_type to find out what type of link
1987 * layer has been returned to you.
1988 */
1989DLLEXPORT SIMPLE_FUNCTION DEPRECATED
1990void *trace_get_link(const libtrace_packet_t *packet);
1991
1992/** Strips layer 2.5 headers from a given packet.
1993 * @param packet        The packet to strip headers from.
1994 *
1995 * @return The packet with the requested headers removed (if they were
1996 * present).
1997 *
1998 * This function is intended for removing those pesky layer 2.5 headers
1999 * that are not supported by other packet analysis applications, e.g. VLAN
2000 * and MPLS headers. If successful, the resulting packet will be a simple
2001 * Ethernet-IP-Transport packet that just about anything should be able to
2002 * parse without difficulty.
2003 *
2004 * If this function encounters a layer 2 or 2.5 header that it does not
2005 * support, stripping will cease and the packet returning will be stripped
2006 * up to but not including the unsupported header.
2007 *
2008 * New in libtrace 4.0.0
2009 *
2010 * @note This function only supports stripping headers from Ethernet packets
2011 * for now. Passing in packets of other link types will simply result in
2012 * the original packet being returned unmodified.
2013 *
2014 */
2015DLLEXPORT libtrace_packet_t *trace_strip_packet(libtrace_packet_t *packet);
2016
2017/** Get a pointer to the IPv4 header (if any) for a given packet
2018 * @param packet        The packet to get the IPv4 header for
2019 *
2020 * @return A pointer to the IPv4 header, or NULL if there is no IPv4 header
2021 *
2022 * If a partial IP header is present, i.e. the packet has been truncated before
2023 * the end of the IP header, this function will return NULL.
2024 *
2025 * You should consider using \ref trace_get_layer3 instead of this function.
2026 */
2027DLLEXPORT SIMPLE_FUNCTION
2028libtrace_ip_t *trace_get_ip(libtrace_packet_t *packet);
2029
2030/** get a pointer to the IPv6 header (if any)
2031 * @param packet        The packet to get the IPv6 header for
2032 *
2033 * @return A pointer to the IPv6 header, or NULL if there is no IPv6 header
2034 *
2035 * If a partial IPv6 header is present, i.e. the packet has been truncated
2036 * before the end of the IP header, this function will return NULL.
2037 *
2038 * You should consider using \ref trace_get_layer3 instead of this function.
2039 */
2040DLLEXPORT SIMPLE_FUNCTION
2041libtrace_ip6_t *trace_get_ip6(libtrace_packet_t *packet);
2042
2043/** Return a pointer to the first metadata header in a packet, if present.
2044 *
2045 * This function takes a pointer to a libtrace packet and if any metadata
2046 * headers exist, returns a pointer to the first one, along with its
2047 * corresponding linktype.
2048 *
2049 * If no metadata headers exist in the packet, NULL is returned.
2050 *
2051 * A metadata header is a header that was prepended by the capturing device,
2052 * such as a Linux SLL header, or a Radiotap wireless monitoring header.
2053 * Subsequent metadata headers may be accessed with the
2054 * trace_get_payload_from_meta(...) function.
2055 *
2056 * @param packet The libtrace packet
2057 * @param[out] linktype The linktype of the returned metadata header
2058 * @param[out] remaining The number of bytes captured after the returned
2059 * pointer.
2060 * @return A pointer to the first metadata header, or NULL if there are no
2061 * metadata headers present.
2062 *
2063 * remaining may be NULL, however linktype must be provided.
2064 */
2065DLLEXPORT void *trace_get_packet_meta(const libtrace_packet_t *packet,
2066                libtrace_linktype_t *linktype,
2067                uint32_t *remaining);
2068
2069/** Returns the payload of a metadata header.
2070 *
2071 * This function takes a pointer to the start of a metadata header (either
2072 * obtained via trace_get_packet_meta(...) or by a previous call to
2073 * trace_get_payload_from_meta(...)) along with its corresponding linktype and
2074 * returns the payload, i.e. the next header. It will also update the linktype
2075 * parameter to indicate the type of payload.
2076 * 
2077 * If the linktype indicates that the header passed in is not a metadata
2078 * header, the function returns NULL to indicate this. The linktype remains
2079 * unchanged in this case.
2080 *
2081 * This function allows the user to iterate through metadata headers which are
2082 * sometimes present before the actual packet as it was received on the wire.
2083 * Examples of metadata headers include the Linux SLL header and the Radiotap
2084 * wireless monitoring header.
2085 *
2086 * If the metadata header passed into this function is truncated, this
2087 * function will return NULL, and remaining will be set to 0.
2088 *
2089 * If there are 0 bytes of payload following the provided metadata header, the
2090 * function will return a pointer to where the header would otherwise be and
2091 * remaining will be 0.
2092 *
2093 * Therefore, be sure to check the value of remaining after calling this
2094 * function!
2095 *
2096 * @param[in] meta A pointer to a metadata header
2097 * @param[in,out] linktype The linktype of meta (updated to indicate the
2098 * linktype of the returned header if applicable).
2099 * @param[in,out] remaining The number of bytes after the meta pointer.
2100 * @return A pointer to the payload of the metadata header. If meta is not a
2101 * pointer to a metadata header, NULL is returned and linktype remains
2102 * unchanged.
2103 *
2104 * All parameters are mandatory.
2105 */
2106DLLEXPORT void *trace_get_payload_from_meta(const void *meta,
2107                libtrace_linktype_t *linktype,
2108                uint32_t *remaining);
2109
2110
2111/** Get a pointer to the layer 2 header. Generally this is the first byte of the
2112 * packet as it was seen on the wire.
2113 *
2114 * This function takes a libtrace packet and skips over any metadata headers if
2115 * present (such as Linux SLL or Radiotap) and returns a pointer to the first
2116 * byte of the packet that was actually received by the network interface.
2117 *
2118 * @param packet The libtrace packet to find the layer 2 header for
2119 * @param[out] linktype The linktype of the returned layer 2 header
2120 * @param[out] remaining The number of bytes left in the packet after the
2121 * returned pointer.
2122 * @return A pointer to the first byte of the packet as it was seen on the
2123 * wire. If no layer 2 header is present, this function will return NULL.
2124 *
2125 * remaining may be NULL, otherwise it will be filled in by the function.
2126 */
2127DLLEXPORT void *trace_get_layer2(const libtrace_packet_t *packet,
2128                libtrace_linktype_t *linktype,
2129                uint32_t *remaining);
2130
2131/** Gets a pointer to the next header following a layer 2 header
2132 *
2133 * @param l2                    The pointer to the current layer 2 header
2134 * @param linktype              The type of the layer 2 header
2135 * @param[out] ethertype        An optional output variable of the ethernet type of the new header
2136 * @param[in,out] remaining     Updated with the number of captured bytes
2137                                remaining
2138 *
2139 * @return A pointer to the header following the provided layer 2 header, or
2140 * NULL if no subsequent header is present.
2141 *
2142 * Remaining must point to the number of bytes captured from the layer 2 header
2143 * and beyond.  It will be decremented by the number of bytes skipped to find
2144 * the payload.
2145 *
2146 * If the layer 2 header is complete but there are zero bytes of payload after
2147 * the end of the header, a pointer to where the payload would be is returned
2148 * and remaining will be set to 0.  If the layer 2 header is incomplete
2149 * (truncated), then NULL is returned and remaining will be set to 0.
2150 * Therefore, it is very important to check the value of remaining after
2151 * calling this function.
2152 *
2153 */
2154DLLEXPORT void *trace_get_payload_from_layer2(void *l2,
2155                libtrace_linktype_t linktype,
2156                uint16_t *ethertype,
2157                uint32_t *remaining);
2158
2159
2160/** Get a pointer to the layer 3 (e.g. IP) header.
2161 * @param packet  The libtrace packet to find the layer 3 header for
2162 * @param[out] ethertype The ethertype of the layer 3 header
2163 * @param[out] remaining The amount of captured data remaining in the packet starting from the returned pointer, i.e. including the layer 3 header.
2164 *
2165 * @return A pointer to the layer 3 header. If no layer 3 header is present in
2166 * the packet, NULL is returned. If the layer 3 header is truncated, a valid
2167 * pointer will still be returned so be sure to check the value of remaining
2168 * before attempting to process the returned header.
2169 *
2170 * remaining may be NULL, otherwise it will be set to the number of captured
2171 * bytes after the pointer returned.
2172 */
2173DLLEXPORT
2174void *trace_get_layer3(const libtrace_packet_t *packet,
2175                uint16_t *ethertype, uint32_t *remaining);
2176
2177/** Calculates the expected IP checksum for a packet.
2178 * @param packet        The libtrace packet to calculate the checksum for
2179 * @param[out] csum     The checksum that is calculated by this function. This
2180 *                      may not be NULL.
2181 *
2182 * @return A pointer to the original checksum field within the IP
2183 * header. If the checksum field is not present in the packet, NULL is returned.
2184 *
2185 * @note The return value points to the checksum that exists within the current
2186 * packet. The value in csum is the value that the checksum should be, given
2187 * the current packet contents. 
2188 *
2189 * @note This function involves the use of a memcpy, so be careful about
2190 * calling it excessively if performance is a concern for you.
2191 *
2192 * New in libtrace 3.0.17
2193 */
2194DLLEXPORT uint16_t *trace_checksum_layer3(libtrace_packet_t *packet,
2195                uint16_t *csum);
2196
2197/** Calculates the expected checksum for the transport header in a packet.
2198 * @param packet        The libtrace packet to calculate the checksum for
2199 * @param[out] csum     The checksum that is calculated by this function. This
2200 *                      may not be NULL.
2201 *
2202 * @return A pointer to the original checksum field within the transport
2203 * header. If the checksum field is not present in the packet, NULL is returned.
2204 *
2205 * @note The return value points to the checksum that exists within the current
2206 * packet. The value in csum is the value that the checksum should be, given
2207 * the current packet contents. 
2208 *
2209 * @note This function involves the use of a memcpy, so be careful about
2210 * calling it excessively if performance is a concern for you.
2211 *
2212 * @note Because transport checksums are calculated across the entire payload,
2213 * truncated packets will result in NULL being returned.
2214 *
2215 * This function will determine the appropriate checksum for whatever transport
2216 * layer header is present in the provided packet. At this stage, this only
2217 * currently works for TCP, UDP and ICMP packets.
2218 *
2219 * Be wary of TCP checksum offloading if you are examining the checksum of
2220 * packets captured on the same host that generated them!
2221 *
2222 * New in libtrace 3.0.17
2223 */
2224DLLEXPORT uint16_t *trace_checksum_transport(libtrace_packet_t *packet,
2225                uint16_t *csum);
2226
2227/** Calculates the fragment offset in bytes for an IP packet
2228 * @param packet        The libtrace packet to calculate the offset for
2229 * @param[out] more     A boolean flag to indicate whether there are more
2230 *                      fragments after the current packet.
2231 * @return The fragment offset for the packet in bytes. If the packet is not
2232 * an IP packet or the fragment offset is not present in packet, the return
2233 * value will be 0.
2234 *
2235 * @note The value returned is in bytes, not 8-octet units as it is stored
2236 * in the fragment offset field in the headers. In other words, libtrace
2237 * automatically does the multiplication for you.
2238 *
2239 * The value passed in for 'more' does not matter; it will be overwritten
2240 * with the value of the More Fragments flag from the IP header.
2241 *
2242 * New in libtrace 3.0.20
2243 */
2244DLLEXPORT uint16_t trace_get_fragment_offset(const libtrace_packet_t *packet,
2245                uint8_t *more);
2246
2247/** Gets a pointer to the transport layer header (if any)
2248 * @param packet   The libtrace packet to find the transport header for
2249 * @param[out] proto    The protocol present at the transport layer.
2250 * @param[out] remaining The amount of captured data remaining in the packet
2251 * starting from the returned pointer, i.e. including the transport header.
2252 *
2253 * @return A pointer to the transport layer header. If no transport header is
2254 * present in the packet, NULL is returned. If the transport header is
2255 * truncated, a valid pointer will still be returned so be sure to check the
2256 * value of remaining before attempting to process the returned header.
2257 *
2258 * remaining may be NULL, otherwise it will be set to the number of captured
2259 * bytes after the returned pointer.
2260 *
2261 * @note proto may be NULL if proto is unneeded.
2262 */
2263DLLEXPORT void *trace_get_transport(const libtrace_packet_t *packet,
2264                uint8_t *proto, uint32_t *remaining);
2265
2266/** Gets a pointer to the payload following an IPv4 header
2267 * @param ip            The IPv4 Header
2268 * @param[out] proto    The protocol of the header following the IPv4 header
2269 * @param[in,out] remaining Updated with the number of captured bytes remaining
2270 *
2271 * @return A pointer to the transport layer header, or NULL if no subsequent
2272 * header is present.
2273 *
2274 * When calling this function, remaining must contain the number of captured
2275 * bytes remaining in the packet starting from the IPv4 header (including the
2276 * IPv4 header itself).
2277 *
2278 * remaining will be decremented by the size of the IPv4 header (including any
2279 * options). If the IPv4 header is complete but there are zero bytes of payload
2280 * after the IPv4 header, a pointer to where the payload would be is returned
2281 * and remaining will be set to 0.  If the IPv4 header is incomplete, NULL will
2282 * be returned and remaining will be set to 0. Therefore, it is very important
2283 * to check the value of remaining after calling this function.
2284 *
2285 * proto may be NULL, in which case it won't be updated.
2286 *
2287 * @note This is similar to trace_get_transport_from_ip in libtrace2
2288 */
2289DLLEXPORT void *trace_get_payload_from_ip(libtrace_ip_t *ip, uint8_t *proto,
2290                uint32_t *remaining);
2291
2292/** Gets a pointer to the payload following an IPv6 header
2293 * @param ipptr         The IPv6 Header
2294 * @param[out] proto    The protocol of the header following the IPv6 header
2295 * @param[in,out] remaining Updated with the number of captured bytes remaining
2296 *
2297 * @return A pointer to the transport layer header, or NULL if no subsequent
2298 * header is present.
2299 *
2300 * When calling this function, remaining must contain the number of captured
2301 * bytes remaining in the packet starting from the IPv6 header (including the
2302 * IPv6 header itself).
2303 *
2304 * remaining will be decremented by the size of the IPv6 header (including any
2305 * options). If the IPv6 header is complete but there are zero bytes of payload
2306 * after the IPv6 header, a pointer to where the payload would be is returned
2307 * and remaining will be set to 0.  If the IPv6 header is incomplete, NULL will
2308 * be returned and remaining will be set to 0. Therefore, it is very important
2309 * to check the value of remaining after calling this function.
2310 *
2311 * proto may be NULL, in which case it won't be updated.
2312 *
2313 */
2314DLLEXPORT void *trace_get_payload_from_ip6(libtrace_ip6_t *ipptr,
2315                uint8_t *proto, uint32_t *remaining);
2316
2317/** Gets a pointer to the payload following a link header
2318 * @param linkptr       A pointer to the link layer header
2319 * @param linktype      The linktype of the link header being examined
2320 * @param[out] type     An output variable for the ethernet type
2321 * @param[in,out] remaining Updated with the number of captured bytes remaining
2322 *
2323 * @return A pointer to the header following the link header, or NULL if no
2324 * subsequent header is present.
2325 *
2326 * When calling this function, remaining must contain the number of captured
2327 * bytes remaining in the packet starting from the link header (including the
2328 * link header itself). remaining will be updated to contain the number of
2329 * bytes remaining after the link header has been skipped.
2330 *
2331 * @deprecated This function is deprecated: you should be using
2332 * trace_get_payload_from_layer2() or trace_get_payload_from_meta() instead.
2333 *
2334 */
2335DLLEXPORT void *trace_get_payload_from_link(void *linkptr,
2336                libtrace_linktype_t linktype,
2337                uint16_t *type, uint32_t *remaining);
2338
2339/** Gets a pointer to the payload following an 802.1q (VLAN) header.
2340 * @param vlan      A pointer to the VLAN header
2341 * @param[out] type  The ethernet type, replaced with the VLAN ether type
2342 * @param[in,out] remaining Updated with the number of captured bytes remaining
2343 *
2344 * @return A pointer to the header beyond the VLAN header, if one is present.
2345 * Otherwise, returns NULL. 
2346 *
2347 * When calling this function, remaining must contain the number of captured
2348 * bytes remaining in the packet starting from the VLAN header (including the
2349 * VLAN header itself). remaining will be updated to contain the number of
2350 * bytes remaining after the VLAN header has been skipped.
2351 *
2352 * If the VLAN header is complete but there are zero bytes of payload after
2353 * the VLAN header, a pointer to where the payload would be is returned and
2354 * remaining will be set to 0.  If the VLAN header is incomplete, NULL will be
2355 * returned and remaining will be set to 0. Therefore, it is important to check
2356 * the value of remaining after calling this function.
2357 *
2358 * type will be set to the ethertype of the VLAN payload. This parameter is not
2359 * mandatory, but is highly recommended.
2360 *
2361 */
2362DLLEXPORT void *trace_get_payload_from_vlan(
2363                void *vlan, uint16_t *type, uint32_t *remaining);
2364
2365/** Gets a pointer to the payload following an MPLS header.
2366 * @param mpls      A pointer to the MPLS header
2367 * @param[out] type  The ethernet type, replaced by the ether type of the
2368 * returned header - 0x0000 if an Ethernet header is returned
2369 * @param[in,out] remaining Updated with the number of captured bytes remaining
2370 *
2371 * @return A pointer to the header beyond the MPLS label, if one is present.
2372 * Will return NULL if there is not enough bytes remaining to skip past the
2373 * MPLS label.
2374 *
2375 * When calling this function, remaining must contain the number of captured
2376 * bytes remaining in the packet starting from the MPLS header (including the
2377 * MPLS header itself). remaining will be updated to contain the number of
2378 * bytes remaining after the MPLS header has been skipped.
2379 *
2380 * If the MPLS header is complete but there are zero bytes of payload after
2381 * the MPLS header, a pointer to where the payload would be is returned and
2382 * remaining will be set to 0.  If the MPLS header is incomplete, NULL will be
2383 * returned and remaining will be set to 0. Therefore, it is important to check
2384 * the value of remaining after calling this function.
2385 *
2386 * type will be set to the ethertype of the MPLS payload. This parameter is
2387 * mandatory - it may not be NULL.
2388 *
2389 * @note This function will only remove one MPLS label at a time - the type
2390 * will be set to 0x8847 if there is another MPLS label following the one
2391 * skipped by this function.
2392 *
2393 */
2394DLLEXPORT void *trace_get_payload_from_mpls(
2395                void *mpls, uint16_t *type, uint32_t *remaining);
2396
2397/** Gets a pointer to the payload following a PPPoE header
2398 * @param pppoe      A pointer to the PPPoE header
2399 * @param[out] type  The ethernet type, replaced by the ether type of the
2400 * returned header - 0x0000 if an Ethernet header is returned
2401 * @param[in,out] remaining  Updated with the number of captured bytes remaining
2402 *
2403 * @return A pointer to the header beyond the PPPoE header. NOTE that this
2404 * function will also skip over the PPP header that will immediately follow
2405 * the PPPoE header. This function will return NULL if there are not enough
2406 * bytes remaining to skip past both the PPPoE and PPP headers.
2407 *
2408 * When calling this function, remaining must contain the number of captured
2409 * bytes remaining in the packet starting from the PPPoE header (including the
2410 * PPPoE header itself). remaining will be updated to contain the number of
2411 * bytes remaining after the PPPoE and PPP headers have been removed.
2412 *
2413 * If the PPPoE and PPP headers are complete but there are zero bytes of
2414 * payload after the PPP header, a pointer to where the payload would be is
2415 * returned and remaining will be set to 0.  If the PPPoE or PPP header is
2416 * incomplete, NULL will be returned and remaining will be set to 0. Therefore,
2417 * it is important to check the value of remaining after calling this function.
2418 *
2419 * type will be set to the ether type of the PPP payload. This parameter is
2420 * mandatory - it may not be NULL.
2421 *
2422 */
2423DLLEXPORT void *trace_get_payload_from_pppoe(
2424                void *pppoe, uint16_t *type, uint32_t *remaining);
2425
2426/** Gets a pointer to the payload following a TCP header
2427 * @param tcp           A pointer to the TCP header
2428 * @param[in,out] remaining Updated with the number of captured bytes remaining
2429 *
2430 * @return A pointer to the TCP payload, or NULL if the TCP header is truncated.
2431 *
2432 * When calling this function, remaining must contain the number of captured
2433 * bytes remaining in the packet starting from the TCP header (including the
2434 * TCP header itself). remaining will be updated to contain the number of
2435 * bytes remaining after the TCP header has been skipped.
2436 *
2437 * If the TCP header is complete but there are zero bytes of payload after
2438 * the TCP header, a pointer to where the payload would be is returned and
2439 * remaining will be set to 0.  If the TCP header is incomplete, NULL will be
2440 * returned and remaining will be set to 0. Therefore, it is important to check
2441 * the value of remaining after calling this function.
2442 *
2443 */
2444DLLEXPORT void *trace_get_payload_from_tcp(libtrace_tcp_t *tcp,
2445                uint32_t *remaining);
2446
2447/** Gets a pointer to the payload following a UDP header
2448 * @param udp           A pointer to the UDP header
2449 * @param[in,out] remaining Updated with the number of captured bytes remaining
2450 *
2451 * @return A pointer to the UDP payload, or NULL if the UDP header is truncated.
2452 *
2453 * When calling this function, remaining must contain the number of captured
2454 * bytes remaining in the packet starting from the UDP header (including the
2455 * UDP header itself). remaining will be updated to contain the number of
2456 * bytes remaining after the UDP header has been skipped.
2457 *
2458 * If the UDP header is complete but there are zero bytes of payload after
2459 * the UDP header, a pointer to where the payload would be is returned and
2460 * remaining will be set to 0.  If the UDP header is incomplete, NULL will be
2461 * returned and remaining will be set to 0. Therefore, it is important to check
2462 * the value of remaining after calling this function.
2463 *
2464 */
2465DLLEXPORT void *trace_get_payload_from_udp(libtrace_udp_t *udp, uint32_t *remaining);
2466
2467/** Gets a pointer to the payload following a ICMP header
2468 * @param icmp           A pointer to the ICMP header
2469 * @param[in,out] remaining Updated with the number of captured bytes remaining
2470 *
2471 * @return A pointer to the ICMP payload, or NULL if the ICMP header is
2472 * truncated.
2473 *
2474 * When calling this function, remaining must contain the number of captured
2475 * bytes remaining in the packet starting from the ICMP header (including the
2476 * ICMP header itself). remaining will be updated to contain the number of
2477 * bytes remaining after the ICMP header has been skipped.
2478 *
2479 * If the ICMP header is complete but there are zero bytes of payload after
2480 * the ICMP header, a pointer to where the payload would be is returned and
2481 * remaining will be set to 0.  If the ICMP header is incomplete, NULL will be
2482 * returned and remaining will be set to 0. Therefore, it is important to check
2483 * the value of remaining after calling this function.
2484 *
2485 * @note In the case of some ICMP messages, the payload may be the IP header
2486 * from the packet that triggered the ICMP message.
2487 *
2488 */
2489DLLEXPORT void *trace_get_payload_from_icmp(libtrace_icmp_t *icmp,
2490                uint32_t *remaining);
2491
2492/** Gets a pointer to the payload following a ICMPv6 header
2493 * @param icmp           A pointer to the ICMPv6 header
2494 * @param[in,out] remaining Updated with the number of captured bytes remaining
2495 *
2496 * @return A pointer to the ICMPv6 payload, or NULL if the ICMPv6 header is
2497 * truncated.
2498 *
2499 * When calling this function, remaining must contain the number of captured
2500 * bytes remaining in the packet starting from the ICMPv6 header (including the
2501 * ICMP header itself). remaining will be updated to contain the number of
2502 * bytes remaining after the ICMPv6 header has been skipped.
2503 *
2504 * If the ICMPv6 header is complete but there are zero bytes of payload after
2505 * the header, a pointer to where the payload would be is returned and
2506 * remaining will be set to 0.  If the ICMPv6 header is incomplete, NULL will be
2507 * returned and remaining will be set to 0. Therefore, it is important to check
2508 * the value of remaining after calling this function.
2509 *
2510 * @note In the case of some ICMPv6 messages, the payload may be the IP header
2511 * from the packet that triggered the ICMP message.
2512 *
2513 */
2514DLLEXPORT void *trace_get_payload_from_icmp6(libtrace_icmp6_t *icmp,
2515                uint32_t *remaining);
2516
2517/** Gets a pointer to the payload following a GRE header
2518 * @param         gre       A pointer to the beginning of the GRE header.
2519 * @param[in,out] remaining Updated with the number of captured bytes remaining.
2520 *
2521 * @return A pointer to the GRE payload, or NULL if the GRE header is truncated.
2522 *
2523 * When calling this function, remaining must contain the number of captured
2524 * bytes remaining in the packet starting from the GRE header (including the
2525 * GRE header itself). remaining will be updated to contain the number of
2526 * bytes remaining after the GRE header has been skipped.
2527 *
2528 * If the GRE header is complete but there are zero bytes of payload after
2529 * the header, a pointer to where the payload would be is returned and
2530 * remaining will be set to 0.  If the GRE header is incomplete, NULL will be
2531 * returned and remaining will be set to 0. Therefore, it is important to check
2532 * the value of remaining after calling this function.
2533 */
2534DLLEXPORT void *trace_get_payload_from_gre(libtrace_gre_t *gre,
2535                uint32_t *remaining);
2536
2537/** Gets a pointer to the payload following a VXLAN header
2538 * @param         udp       A pointer to the beginning of the UDP header.
2539 * @param[in,out] remaining Updated with the number of captured bytes remaining.
2540 *
2541 * @return A pointer to the beginning of the VXLAN header, or NULL if the UDP
2542 * header is truncated, or this is not a VXLAN packet.
2543 *
2544 */
2545DLLEXPORT libtrace_vxlan_t *trace_get_vxlan_from_udp(libtrace_udp_t *udp,
2546                uint32_t *remaining);
2547
2548/** Gets a pointer to the payload following a VXLAN header
2549 * @param         vxlan       A pointer to the beginning of the VXLAN header.
2550 * @param[in,out] remaining Updated with the number of captured bytes remaining.
2551 *
2552 * @return A pointer to the VXLAN payload, or NULL if the VXLAN header is
2553 * truncated.
2554 *
2555 * When calling this function, remaining must contain the number of captured
2556 * bytes remaining in the packet starting from the VXLAN header (including the
2557 * VXLAN header itself). remaining will be updated to contain the number of
2558 * bytes remaining after the VXLAN header has been skipped.
2559 *
2560 * If the VXLAN header is complete but there are zero bytes of payload after
2561 * the header, a pointer to where the payload would be is returned and
2562 * remaining will be set to 0.  If the VXLAN header is incomplete, NULL will be
2563 * returned and remaining will be set to 0. Therefore, it is important to check
2564 * the value of remaining after calling this function.
2565 */
2566DLLEXPORT void *trace_get_payload_from_vxlan(libtrace_vxlan_t *vxlan,
2567                uint32_t *remaining);
2568
2569/** Get a pointer to the TCP header (if present)
2570 * @param packet        The packet to get the TCP header from
2571 *
2572 * @return A pointer to the TCP header, or NULL if there is not a complete TCP
2573 * header present in the packet.
2574 *
2575 * This is a short-cut function enabling quick and easy access to the TCP
2576 * header if that is all you care about. However, we recommend the use of the
2577 * more generic trace_get_transport() function instead.
2578 *
2579 * @note Unlike trace_get_transport(), this function will return NULL if the
2580 * TCP header is incomplete or truncated.
2581 */
2582DLLEXPORT SIMPLE_FUNCTION
2583libtrace_tcp_t *trace_get_tcp(libtrace_packet_t *packet);
2584
2585/** Get a pointer to the TCP header following an IPv4 header (if present)
2586 * @param ip            The IP header to find the subsequent TCP header for
2587 * @param[in,out] remaining Updated with the number of captured bytes remaining
2588 *
2589 * @return A pointer to the TCP header, or NULL if no TCP header is present in
2590 * the packet.
2591 *
2592 * When calling this function, remaining must contain the number of captured
2593 * bytes remaining in the packet starting from the IP header (including the
2594 * IP header itself). remaining will be updated to contain the number of
2595 * bytes remaining after the IP header has been skipped.
2596 *
2597 * If the IP header is complete but there are zero bytes of payload after
2598 * the IP header, a pointer to where the payload would be is returned and
2599 * remaining will be set to 0.  If the IP header is incomplete, NULL will be
2600 * returned and remaining will be set to 0. Therefore, it is important to check
2601 * the value of remaining after calling this function.
2602 *
2603 * @note This function is rather redundant now that the layer 3 header is
2604 * cached. There should be no performance advantage for the user to call this
2605 * function over just calling trace_get_transport().
2606 *
2607 * @note The last parameter has changed from libtrace2
2608 */
2609DLLEXPORT SIMPLE_FUNCTION
2610libtrace_tcp_t *trace_get_tcp_from_ip(libtrace_ip_t *ip, uint32_t *remaining);
2611
2612/** Get a pointer to the UDP header (if present)
2613 * @param packet        The packet to get the UDP header from
2614 *
2615 * @return A pointer to the UDP header, or NULL if there is not a complete UDP
2616 * header present in the packet.
2617 *
2618 * This is a short-cut function enabling quick and easy access to the UDP
2619 * header if that is all you care about. However, we recommend the use of the
2620 * more generic trace_get_transport() function instead.
2621 *
2622 * @note Unlike trace_get_transport(), this function will return NULL if the
2623 * UDP header is incomplete or truncated.
2624 */
2625DLLEXPORT SIMPLE_FUNCTION
2626libtrace_udp_t *trace_get_udp(libtrace_packet_t *packet);
2627
2628/** Get a pointer to the UDP header following an IPv4 header (if present)
2629 * @param ip            The IP header to find the subsequent UDP header for
2630 * @param[in,out] remaining Updated with the number of captured bytes remaining
2631 *
2632 * @return A pointer to the UDP header, or NULL if no UDP header is present in
2633 * the packet.
2634 *
2635 * When calling this function, remaining must contain the number of captured
2636 * bytes remaining in the packet starting from the IP header (including the
2637 * IP header itself). remaining will be updated to contain the number of
2638 * bytes remaining after the IP header has been skipped.
2639 *
2640 * If the IP header is complete but there are zero bytes of payload after
2641 * the IP header, a pointer to where the payload would be is returned and
2642 * remaining will be set to 0.  If the IP header is incomplete, NULL will be
2643 * returned and remaining will be set to 0. Therefore, it is important to check
2644 * the value of remaining after calling this function.
2645 *
2646 * @note This function is rather redundant now that the layer 3 header is
2647 * cached. There should be no performance advantage for the user to call this
2648 * function over just calling trace_get_transport().
2649 *
2650 * @note The last parameter has changed from libtrace2
2651 */
2652DLLEXPORT SIMPLE_FUNCTION
2653libtrace_udp_t *trace_get_udp_from_ip(libtrace_ip_t *ip,uint32_t *remaining);
2654
2655/** Get a pointer to the ICMP header (if present)
2656 * @param packet        The packet to get the ICMP header from
2657 *
2658 * @return A pointer to the ICMP header, or NULL if there is not a complete
2659 * ICMP header present in the packet.
2660 *
2661 * This is a short-cut function enabling quick and easy access to the ICMP
2662 * header if that is all you care about. However, we recommend the use of the
2663 * more generic trace_get_transport() function instead.
2664 *
2665 * @note Unlike trace_get_transport(), this function will return NULL if the
2666 * ICMP header is incomplete or truncated.
2667 */
2668DLLEXPORT SIMPLE_FUNCTION
2669libtrace_icmp_t *trace_get_icmp(libtrace_packet_t *packet);
2670
2671/** Get a pointer to the ICMPv6 header (if present)
2672 * @param packet        The packet to get the ICMPv6 header from
2673 *
2674 * @return A pointer to the ICMPv6 header, or NULL if there is not a complete
2675 * ICMP header present in the packet.
2676 *
2677 * This is a short-cut function enabling quick and easy access to the ICMPv6
2678 * header if that is all you care about. However, we recommend the use of the
2679 * more generic trace_get_transport() function instead.
2680 *
2681 * @note Unlike trace_get_transport(), this function will return NULL if the
2682 * ICMPv6 header is incomplete or truncated.
2683 */
2684DLLEXPORT SIMPLE_FUNCTION
2685libtrace_icmp6_t *trace_get_icmp6(libtrace_packet_t *packet);
2686
2687/** Get a pointer to the ICMP header following an IPv4 header (if present)
2688 * @param ip            The IP header to find the subsequent ICMP header for
2689 * @param[in,out] remaining Updated with the number of captured bytes remaining
2690 *
2691 * @return A pointer to the ICMP header, or NULL if no UDP header is present in
2692 * the packet.
2693 *
2694 * When calling this function, remaining must contain the number of captured
2695 * bytes remaining in the packet starting from the IP header (including the
2696 * IP header itself). remaining will be updated to contain the number of
2697 * bytes remaining after the IP header has been skipped.
2698 *
2699 * If the IP header is complete but there are zero bytes of payload after
2700 * the IP header, a pointer to where the payload would be is returned and
2701 * remaining will be set to 0.  If the IP header is incomplete, NULL will be
2702 * returned and remaining will be set to 0. Therefore, it is important to check
2703 * the value of remaining after calling this function.
2704 *
2705 * @note This function is rather redundant now that the layer 3 header is
2706 * cached. There should be no performance advantage for the user to call this
2707 * function over just calling trace_get_transport().
2708 *
2709 * @note The last parameter has changed from libtrace2
2710 */
2711DLLEXPORT SIMPLE_FUNCTION
2712libtrace_icmp_t *trace_get_icmp_from_ip(libtrace_ip_t *ip,uint32_t *remaining);
2713
2714/** Get a pointer to the OSPF header (if present)
2715 * @param packet        The packet to get the OSPF header from
2716 * @param[out] version  The OSPF version number
2717 * @param[out] remaining        Updated with the number of captured bytes remaining
2718 * @return A pointer to the start of the OSPF header or NULL if there is no
2719 * complete OSPF header present in the packet
2720 *
2721 * This is a short-cut function enabling quick and easy access to the OSPF
2722 * header. If you only care about the OSPF header, this function may be useful
2723 * but we otherwise recommend the use of the more generic trace_get_transport()
2724 * function instead.
2725 *
2726 * Upon return, 'version' is updated to contain the OSPF version number for the
2727 * packet so that the returned pointer may be cast to the correct type.
2728 * The version parameter MUST contain a valid pointer; it MUST NOT be NULL.
2729 *
2730 * 'remaining' is also set to contain the number of captured bytes remaining
2731 * starting from the pointer returned by this function.
2732 *
2733 * @note Unlike trace_get_transport(), this function will return NULL if the
2734 * OSPF header is incomplete or truncated.
2735 */
2736DLLEXPORT SIMPLE_FUNCTION
2737void *trace_get_ospf_header(libtrace_packet_t *packet, uint8_t *version,
2738                uint32_t *remaining);
2739
2740/** Get a pointer to the contents of the OSPF packet *after* the OSPF header
2741 * @param header        The OSPF header to get the OSPF contents from
2742 * @param[out] ospf_type        The OSPF packet type
2743 * @param[in, out] remaining    Updated with the number of captured bytes remaining
2744 * @return A pointer to the first byte after the OSPF header.
2745 *
2746 * This function returns a void pointer that can be cast appropriately
2747 * based on the ospf_type. For example, if the ospf_type is TRACE_OSPF_HELLO
2748 * then the return pointer should be cast as a libtrace_ospf_hello_v2_t
2749 * structure.
2750 *
2751 * If the OSPF header is truncated, then NULL will be returned. If the OSPF
2752 * contents are missing or truncated, the pointer to the start of the content
2753 * will still be returned so be careful to check the value of remaining.
2754 *
2755 * 'remaining' MUST be set to the amount of bytes remaining in the captured
2756 * packet starting from the beginning of the OSPF header. It will be updated
2757 * to contain the number of bytes remaining from the start of the OSPF contents.
2758 *
2759 * @note This function only works for OSPF version 2 packets.
2760 * @note Use trace_get_first_ospf_lsa_v2_from_X() and trace_get_next_ospf_lsa_v2() to read the LSAs from Link State Update packets.
2761 * @note Use trace_get_first_ospf_lsa_v2_from_X() and trace_get_next_ospf_lsa_header_v2() to read the LSA headers from Link State Ack packets.
2762 *
2763 */
2764DLLEXPORT SIMPLE_FUNCTION
2765void *trace_get_ospf_contents_v2(libtrace_ospf_v2_t *header,
2766                uint8_t *ospf_type, uint32_t *remaining);
2767
2768/** Get a pointer to the start of the first LSA contained within an LS Update packet
2769 * @param ls_update     Pointer to the LS Update header
2770 * @param[in,out] remaining     Updated with the number of captured bytes remaining
2771 * @return A pointer to the first LSA in the packet.
2772 *
2773 * This function simply skips past the LS Update header to provide a suitable
2774 * pointer to pass into trace_get_next_ospf_lsa_v2.
2775 *
2776 * If the OSPF packet is truncated, then NULL will be returned.
2777 *
2778 * 'remaining' MUST be set to the amount of bytes remaining in the captured
2779 * packet starting from the beginning of the LS Update header. It will be
2780 * updated to contain the number of bytes remaining from the start of the
2781 * first LSA.
2782 *
2783 * @note This function only works for OSPF version 2 packets.
2784 * @note trace_get_next_ospf_lsa_v2() should be subsequently used to process the LSAs
2785 */
2786DLLEXPORT SIMPLE_FUNCTION
2787unsigned char *trace_get_first_ospf_lsa_from_update_v2(
2788                libtrace_ospf_ls_update_t *ls_update,
2789                uint32_t *remaining);
2790
2791/** Get a pointer to the start of the first LSA contained within an Database Description packet
2792 * @param db_desc       Pointer to the Database Description header
2793 * @param[in,out] remaining     Updated with the number of captured bytes remaining
2794 * @return A pointer to the first LSA in the packet.
2795 *
2796 * This function simply skips past the Database Description header to provide a
2797 * suitable pointer to pass into trace_get_next_ospf_lsa_header_v2.
2798 *
2799 * If the OSPF packet is truncated, then NULL will be returned.
2800 *
2801 * 'remaining' MUST be set to the amount of bytes remaining in the captured
2802 * packet starting from the beginning of the Database Description header. It
2803 * will be updated to contain the number of bytes remaining from the start of
2804 * the first LSA.
2805 *
2806 * @note This function only works for OSPF version 2 packets.
2807 * @note trace_get_next_ospf_lsa_header_v2() should be subsequently used to process the LSA headers
2808 */
2809DLLEXPORT SIMPLE_FUNCTION
2810unsigned char *trace_get_first_ospf_lsa_from_db_desc_v2(
2811                libtrace_ospf_db_desc_v2_t *db_desc,
2812                uint32_t *remaining);
2813
2814/** Get a pointer to the start of the first link contained within a Router LSA
2815 * @param lsa   Pointer to the Router LSA
2816 * @param[in,out] remaining     Updated with the number of captured bytes remaining
2817 * @return A pointer to the first link in the packet.
2818 *
2819 * This function simply skips past the Router LSA header to provide a
2820 * suitable pointer to pass into trace_get_next_ospf_link_v2.
2821 *
2822 * If the OSPF packet is truncated, then NULL will be returned.
2823 *
2824 * 'remaining' MUST be set to the amount of bytes remaining in the captured
2825 * packet starting from the beginning of the Router LSA (not including the LSA
2826 * header) header. It will be updated to contain the number of bytes remaining
2827 * from the start of the first Link.
2828 *
2829 * @note This function only works for OSPF version 2 packets.
2830 * @note trace_get_next_ospf_link_v2() should be subsequently used to process
2831 * the links
2832 */
2833DLLEXPORT SIMPLE_FUNCTION
2834unsigned char *trace_get_first_ospf_link_from_router_lsa_v2(
2835                libtrace_ospf_router_lsa_v2_t *lsa,
2836                uint32_t *remaining);
2837
2838/** Parses an OSPF Router LSA Link and finds the next Link (if there is one)
2839 * @param[in,out] current       Pointer to the next Link (updated by this function)
2840 * @param[out] link             Set to point to the Link located at the original value of current
2841 * @param[in,out] remaining     Updated with the number of captured bytes remaining
2842 * @param[out] link_len         Set to the size of the Link pointed to by 'link'
2843 * @return 0 if there are no more links after the current one, 1 otherwise.
2844 *
2845 * When called, 'current' MUST point to an OSPF Router LSA link. Ideally, this
2846 * would come from either a call to
2847 * trace_get_first_ospf_link_from_router_lsa_v2() or a previous call of this
2848 * function.
2849 *
2850 * 'link' will be set to the value of 'current', so that the caller may then
2851 * do any processing they wish on that particular link. 'current' is advanced
2852 * to point to the next link and 'link_len' is updated to report the size of
2853 * the original link.
2854 *
2855 * 'remaining' MUST be set to the amount of bytes remaining in the captured
2856 * packet starting from the beginning of the Link pointed to by 'current'.
2857 * It will be updated to contain the number of bytes remaining from the start
2858 * of the next link.
2859 *
2860 * If this function returns 0 but 'link' is NOT NULL, that link is still valid
2861 * but there are no more links after this one.
2862 * If this function returns 0 AND link is NULL, the link is obviously not
2863 * suitable for processing.
2864 *
2865 * @note This function only works for OSPF version 2 packets.
2866 */
2867DLLEXPORT SIMPLE_FUNCTION
2868int trace_get_next_ospf_link_v2(unsigned char **current,
2869                libtrace_ospf_link_v2_t **link,
2870                uint32_t *remaining,
2871                uint32_t *link_len);
2872
2873/** Parses an OSPF LSA and finds the next LSA (if there is one)
2874 * @param[in,out] current       Pointer to the next LSA (updated by this function)
2875 * @param[out] lsa_hdr          Set to point to the header of the LSA located at the original value of current
2876 * @param[out] lsa_body         Set to point to the body of the LSA located at the original value of current
2877 * @param[in,out] remaining     Updated with the number of captured bytes remaining
2878 * @param[out] lsa_type         Set to the type of the LSA located at the original value of current
2879 * @param[out] lsa_length       Set to the size of the LSA located at the original value of current
2880 * @return 1 if there are more LSAs after the current one, 0 if there are no more LSAs to come, and -1 if the current LSA is incomplete, truncated or invalid.
2881 *
2882 * When called, 'current' MUST point to an OSPF LSA. Ideally, this would come
2883 * from either a call to trace_get_first_ospf_lsa_from_update_v2() or a
2884 * previous call of this function.
2885 *
2886 * This function should only be used to access COMPLETE LSAs, i.e. LSAs that
2887 * have both a header and a body. In OSPFv2, only the LSAs contained within
2888 * LSA Update packets meet this requirement. trace_get_next_ospf_lsa_header_v2
2889 * should be used to read header-only LSAs, e.g. those present in LS Acks.
2890 *
2891 * 'lsa_hdr' will be set to the value of 'current', so that the caller may then
2892 * do any processing they wish on that particular LSA. 'lsa_body' will be set
2893 * to point to the first byte after the LSA header. 'current' is advanced
2894 * to point to the next LSA. 'lsa_length' is updated to contain the size of
2895 * the parsed LSA, while 'lsa_type' is set to indicate the LSA type.
2896 *
2897 * 'remaining' MUST be set to the amount of bytes remaining in the captured
2898 * packet starting from the beginning of the LSA pointed to by 'current'.
2899 * It will be updated to contain the number of bytes remaining from the start
2900 * of the next LSA.
2901 *
2902 * If this function returns 0 but 'lsa_hdr' is NOT NULL, that LSA is still
2903 * valid but there are no more LSAs after this one.
2904 * If this function returns 0 AND 'lsa_hdr' is NULL, the LSA is obviously not
2905 * suitable for processing.
2906 *
2907 * It is also recommended to check the value of 'lsa_body' before
2908 * de-referencing it. 'lsa_body' will be set to NULL if there is only an LSA
2909 * header present.
2910 *
2911 * @note This function only works for OSPF version 2 packets.
2912 *
2913 */
2914DLLEXPORT SIMPLE_FUNCTION
2915int trace_get_next_ospf_lsa_v2(unsigned char **current,
2916                libtrace_ospf_lsa_v2_t **lsa_hdr,
2917                unsigned char **lsa_body,
2918                uint32_t *remaining,
2919                uint8_t *lsa_type,
2920                uint16_t *lsa_length);
2921
2922/** Parses an OSPF LSA header and finds the next LSA (if there is one)
2923 * @param[in,out] current       Pointer to the next LSA (updated by this function)
2924 * @param[out] lsa_hdr          Set to point to the header of the LSA located at the original value of current
2925 * @param[in,out] remaining     Updated with the number of captured bytes remaining
2926 * @param[out] lsa_length       Set to the size of the LSA located at the original value of current
2927 * @return 1 if there are more LSAs after the current one, 0 if there are no more LSAs to come, and -1 if the current LSA is incomplete, truncated or invalid.
2928 *
2929 * When called, 'current' MUST point to an OSPF LSA. Ideally, this would come
2930 * from either a call to trace_get_first_ospf_lsa_from_db_desc_v2() or a
2931 * previous call of this function.
2932 *
2933 * This function should only be used to access LSA headers, i.e. LSAs that
2934 * have a header only. In OSPFv2, the LSAs contained within LSA Ack and
2935 * Database Description packets meet this requirement.
2936 * trace_get_next_ospf_lsa_v2 should be used to read full LSAs, e.g. those
2937 * present in LS Updates.
2938 *
2939 * 'lsa_hdr' will be set to the value of 'current', so that the caller may then
2940 * do any processing they wish on that particular LSA header. 'current' is
2941 * advanced to point to the next LSA header. 'lsa_length' is updated to contain
2942 * the size of the parsed LSA header.
2943 *
2944 * 'remaining' MUST be set to the amount of bytes remaining in the captured
2945 * packet starting from the beginning of the LSA pointed to by 'current'.
2946 * It will be updated to contain the number of bytes remaining from the start
2947 * of the next LSA.
2948 *
2949 * If this function returns 0 but 'lsa_hdr' is NOT NULL, that LSA is still
2950 * valid but there are no more LSAs after this one.
2951 * If this function returns 0 AND 'lsa_hdr' is NULL, the LSA is obviously not
2952 * suitable for processing.
2953 *
2954 * @note This function only works for OSPF version 2 packets.
2955 *
2956 */
2957DLLEXPORT SIMPLE_FUNCTION
2958int trace_get_next_ospf_lsa_header_v2(unsigned char **current,
2959                libtrace_ospf_lsa_v2_t **lsa_hdr,
2960                uint32_t *remaining,
2961                uint8_t *lsa_type,
2962                uint16_t *lsa_length);
2963
2964/** Extracts the metric field from an AS External LSA packet
2965 *
2966 * @param as_lsa        The AS External LSA
2967 * @returns The value of the metric field
2968 *
2969 * The metric field in the AS External LSA packet is a 24-bit value, which
2970 * is difficult to extract correctly. To avoid byte-ordering issues, use this
2971 * function which will extract the correct value for you.
2972 */
2973DLLEXPORT SIMPLE_FUNCTION
2974uint32_t trace_get_ospf_metric_from_as_external_lsa_v2(
2975                libtrace_ospf_as_external_lsa_v2_t *as_lsa);
2976
2977/** Extracts the metric field from a Summary LSA packet
2978 *
2979 * @param sum_lsa       The Summary LSA
2980 * @returns The value of the metric field
2981 *
2982 * The metric field in the Summary LSA packet is a 24-bit value, which
2983 * is difficult to extract correctly. To avoid byte-ordering issues, use this
2984 * function which will extract the correct value for you.
2985 */
2986DLLEXPORT SIMPLE_FUNCTION
2987uint32_t trace_get_ospf_metric_from_summary_lsa_v2(
2988                libtrace_ospf_summary_lsa_v2_t *sum_lsa);
2989
2990
2991/** Gets the destination MAC address for a given packet
2992 * @param packet        The packet to extract the destination MAC address from
2993 *
2994 * @return A pointer to the destination MAC address field in the layer 2
2995 * header, (or NULL if there is no destination MAC address or layer 2 header
2996 * available)
2997 *
2998 * @note This is a zero-copy function, so the memory that the returned pointer
2999 * points to is part of the packet itself.
3000 */
3001DLLEXPORT SIMPLE_FUNCTION
3002uint8_t *trace_get_destination_mac(libtrace_packet_t *packet);
3003
3004/** Gets the source MAC address for a given packet
3005 * @param packet        The packet to extract the source MAC address from
3006 *
3007 * @return A pointer to the source MAC address field in the layer 2
3008 * header, (or NULL if there is no source MAC address or layer 2 header
3009 * available)
3010 *
3011 * @note This is a zero-copy function, so the memory that the returned pointer
3012 * points to is part of the packet itself.
3013 */
3014DLLEXPORT SIMPLE_FUNCTION
3015uint8_t *trace_get_source_mac(libtrace_packet_t *packet);
3016
3017/** Get the source IP address for a given packet
3018 * @param packet        The packet to extract the source IP address from
3019 * @param addr          A pointer to a sockaddr structure to store the address
3020 *                      in. If NULL, static storage is used instead.
3021 * @return A pointer to a sockaddr holding a v4 or v6 IP address or on some
3022 * platforms a sockaddr holding a MAC address. Returns NULL if no source IP
3023 * address was available.
3024 *
3025 * @note The best way to use this function is to pass in a pointer to the
3026 * struct sockaddr_storage for the addr parameter. This will avoid problems
3027 * with trying to shoe-horn an IPv6 address into a sockaddr that only supports
3028 * IPv4.
3029 */
3030DLLEXPORT SIMPLE_FUNCTION
3031struct sockaddr *trace_get_source_address(const libtrace_packet_t *packet,
3032                struct sockaddr *addr);
3033
3034/** Get the source IP address for a packet and convert it into a string
3035 * @param packet        The packet to extract the source IP address from
3036 * @param space         A pointer to a character buffer to store the address
3037 *                      in. If NULL, static storage is used instead.
3038 * @param spacelen      The size of the buffer passed in via 'space'. Set this
3039 *                      to zero if you are going to pass in a NULL buffer.
3040 * @return A pointer to a character buffer containing the string representation
3041 * of the source IP address. For packets where there is no suitable IP address,
3042 * the source MAC will be returned instead. Returns NULL if no valid address
3043 * is available.
3044 *
3045 * @note Be wary of the possibility of the address being an IPv6 address - make
3046 * sure your buffer is large enough!
3047 *
3048 * New in libtrace 3.0.17.
3049 */
3050DLLEXPORT SIMPLE_FUNCTION
3051char *trace_get_source_address_string(const libtrace_packet_t *packet,
3052                char *space, int spacelen);
3053
3054/** Get the destination IP address for a given packet
3055 * @param packet        The packet to extract the destination IP address from
3056 * @param addr          A pointer to a sockaddr structure to store the address
3057 *                      in. If NULL, static storage is used instead.
3058 * @return A pointer to a sockaddr holding a v4 or v6 IP address or on some
3059 * platforms a sockaddr holding a MAC address. Returns NULL if no destination
3060 * IP address was available.
3061 *
3062 * @note The best way to use this function is to pass in a pointer to the
3063 * struct sockaddr_storage for the addr parameter. This will avoid problems
3064 * with trying to shoe-horn an IPv6 address into a sockaddr that only supports
3065 * IPv4.
3066 */
3067DLLEXPORT SIMPLE_FUNCTION
3068struct sockaddr *trace_get_destination_address(const libtrace_packet_t *packet,
3069                struct sockaddr *addr);
3070
3071/** Get the destination IP address for a packet and convert it into a string
3072 * @param packet        The packet to extract the destination IP address from
3073 * @param space         A pointer to a character buffer to store the address
3074 *                      in. If NULL, static storage is used instead.
3075 * @param spacelen      The size of the buffer passed in via 'space'. Set this
3076 *                      to zero if you are going to pass in a NULL buffer.
3077 * @return A pointer to a character buffer containing the string representation
3078 * of the destination IP address. For packets where there is no suitable IP
3079 * address, the destination MAC will be returned instead. Returns NULL if no
3080 * valid address is available.
3081 *
3082 * @note Be wary of the possibility of the address being an IPv6 address - make
3083 * sure your buffer is large enough!
3084 *
3085 * New in libtrace 3.0.17.
3086 */
3087DLLEXPORT SIMPLE_FUNCTION
3088char *trace_get_destination_address_string(const libtrace_packet_t *packet,
3089                char *space, int spacelen);
3090
3091/** Parses an IP or TCP option
3092 * @param[in,out] ptr   The pointer to the current option
3093 * @param[in,out] len   The total length of all the remaining options
3094 * @param[out] type     The type of the option
3095 * @param[out] optlen   The length of the option
3096 * @param[out] data     The data of the option
3097 *
3098 * @return bool true if there is another option (and the fields are filled in)
3099 *               or false if this was the last option.
3100 *
3101 * This updates ptr to point to the next option after this one, and updates
3102 * len to be the number of bytes remaining in the options area.  Type is updated
3103 * to be the code of this option, and data points to the data of this option,
3104 * with optlen saying how many bytes there are.
3105 *
3106 * @note Beware of fragmented packets.
3107 */
3108DLLEXPORT int trace_get_next_option(unsigned char **ptr,int *len,
3109                        unsigned char *type,
3110                        unsigned char *optlen,
3111                        unsigned char **data);
3112
3113/*@}*/
3114
3115/** @name Time
3116 * These functions deal with the timestamp describing when a packet was
3117 * captured and can convert it into various formats
3118 * @{
3119 */
3120
3121/** Get the packet timestamp in the DAG time format
3122 * @param packet        The packet to extract the timestamp from
3123 *
3124 * @return a 64 bit timestamp in DAG ERF format (upper 32 bits are the seconds
3125 * past 1970-01-01, the lower 32bits are partial seconds)
3126 */
3127DLLEXPORT SIMPLE_FUNCTION
3128uint64_t trace_get_erf_timestamp(const libtrace_packet_t *packet);
3129
3130/** Get the packet timestamp as a struct timeval
3131 * @param packet        The packet to extract the timestamp from
3132 *
3133 * @return The time that this packet was captured in a struct timeval
3134 */
3135DLLEXPORT SIMPLE_FUNCTION
3136struct timeval trace_get_timeval(const libtrace_packet_t *packet);
3137
3138/** Get the packet timestamp as a struct timespec
3139 * @param packet        The packet to extract the timestamp from
3140 *
3141 * @return The time that this packet was captured in a struct timespec
3142 */
3143DLLEXPORT SIMPLE_FUNCTION
3144struct timespec trace_get_timespec(const libtrace_packet_t *packet);
3145
3146/** Get the packet timestamp in floating point seconds
3147 * @param packet        The packet to extract the timestamp from
3148 *
3149 * @return time that this packet was seen in 64-bit floating point seconds from
3150 * the UNIX epoch (1970-01-01 00:00:00 UTC).
3151 */
3152DLLEXPORT SIMPLE_FUNCTION
3153double trace_get_seconds(const libtrace_packet_t *packet);
3154
3155/** Seek within an input trace to a time specified in floating point seconds
3156 * @param trace         The input trace to seek within
3157 * @param seconds       The time to seek to, in floating point seconds
3158 * @return 0 on success, -1 if the seek fails. Use trace_perror() to determine
3159 * the error that occurred.
3160 *
3161 * This will make the next packet read to be the first packet to occur at or
3162 * after the specified time.  This must be called in the configuration state
3163 * (i.e. before trace_start() or after trace_pause()).
3164 *
3165 * The time format accepted by this function is 64-bit floating point seconds
3166 * since the UNIX epoch (1970-01-01 00:00:00 UTC), i.e. the same format as
3167 * trace_get_seconds().
3168 *
3169 * @note This function may be extremely slow.
3170 */
3171DLLEXPORT int trace_seek_seconds(libtrace_t *trace, double seconds);
3172
3173/** Seek within an input trace to a time specified as a timeval
3174 * @param trace         The input trace to seek within
3175 * @param tv            The time to seek to, as a timeval
3176 *
3177 * @return 0 on success, -1 if the seek fails. Use trace_perror() to determine
3178 * the error that occurred.
3179 *
3180 * This will make the next packet read to be the first packet to occur at or
3181 * after the specified time.  This must be called in the configuration state
3182 * (i.e. before trace_start() or after trace_pause()).
3183 *
3184 * @note This function may be extremely slow.
3185 */
3186DLLEXPORT int trace_seek_timeval(libtrace_t *trace, struct timeval tv);
3187
3188/** Seek within an input trace to a time specified as an ERF timestamp
3189 * @param trace         The input trace to seek within
3190 * @param ts            The time to seek to, as an ERF timestamp
3191 *
3192 * @return 0 on success, -1 if the seek fails. Use trace_perror() to determine
3193 * the error that occurred.
3194 *
3195 * This will make the next packet read to be the first packet to occur at or
3196 * after the specified time.  This must be called in the configuration state
3197 * (i.e. before trace_start() or after trace_pause()).
3198 *
3199 * The time format accepted by this function is the ERF timestamp, which is a
3200 * 64-bit value where the upper 32 bits are seconds since the UNIX epoch and
3201 * the lower 32 bits are partial seconds.
3202 *
3203 * @note This function may be extremely slow.
3204 */
3205DLLEXPORT int trace_seek_erf_timestamp(libtrace_t *trace, uint64_t ts);
3206
3207/*@}*/
3208
3209/** @name Sizes
3210 * This section deals with finding or setting the various different lengths
3211 * that a packet can have, e.g. capture lengths, wire lengths, etc.
3212 * @{
3213 */
3214/** Get the current size of the packet (in bytes), taking into account any
3215 * truncation or snapping that may have previously been performed.
3216 *
3217 * @param packet        The packet to determine the capture length for
3218 * @return The size of the packet read from the input trace, i.e. what is
3219 * actually available to libtrace at the moment.
3220 *
3221 * @note Most traces are header captures, so this value may not be the same
3222 * as the size of the packet when it was captured. Use trace_get_wire_length()
3223 * to get the original size of the packet.
3224 
3225 * @note This can (and often is) different for different packets in a trace!
3226 
3227 * @note This is sometimes called the "snaplen".
3228 *
3229 * @note The return size refers to the network-level payload of the packet and
3230 * does not include any capture framing headers. For example, an Ethernet
3231 * packet with an empty TCP packet will return sizeof(ethernet_header) +
3232 * sizeof(ip_header) + sizeof(tcp_header), but not the capture format
3233 * (pcap/erf/etc) header.
3234 */
3235DLLEXPORT SIMPLE_FUNCTION
3236size_t trace_get_capture_length(const libtrace_packet_t *packet);
3237
3238/** Get the size of the packet as it was originally seen on the wire (in bytes).
3239 * @param packet        The packet to determine the wire length for
3240 * @return The size of the packet as it was on the wire.
3241 *
3242 * @note This value may not be the same as the capture length, due to
3243 * truncation.
3244 *
3245 * @note trace_get_wire_length \em includes  the Frame Check Sequence. This is
3246 * different behaviour compared to most PCAP-based tools.
3247 *
3248 * @note The return size refers to the network-level payload of the packet and
3249 * does not include any capture framing headers. For example, an Ethernet
3250 * packet with an empty TCP packet will return sizeof(ethernet_header) +
3251 * sizeof(ip_header) + sizeof(tcp_header), but not the capture format
3252 * (pcap/erf/etc) header.
3253 */
3254DLLEXPORT SIMPLE_FUNCTION
3255size_t trace_get_wire_length(const libtrace_packet_t *packet);
3256
3257/** Get the length of the capture framing headers (in bytes).
3258 * @param packet        The packet to determine the framing length for
3259 * @return The size of the capture format header encapsulating the packet.
3260 *
3261 * @note This length corresponds to the difference between the amount of
3262 * memory required to store a captured packet and the capture length reported
3263 * by trace_capture_length()
3264 */
3265DLLEXPORT SIMPLE_FUNCTION
3266size_t trace_get_framing_length(const libtrace_packet_t *packet);
3267
3268/** Get the length of the original payload content of the packet (in bytes).
3269 * @param packet        The packet to determine the payload length for
3270 * @return The size of the packet payload (without headers). Returns 0 if
3271 * unable to calculate payload length correctly.
3272 *
3273 * This function reports the amount of data that followed the transport header
3274 * when the packet was originally captured, i.e. prior to any snapping. Best
3275 * described as the wire length minus the packet headers.
3276 *
3277 * Currently only supports some protocols and will return 0 if an unsupported
3278 * protocol header is encountered, or if one of the headers is truncated.
3279 *
3280 * @note Supports IPv4, IPv6, TCP, UDP and ICMP.
3281 */
3282DLLEXPORT SIMPLE_FUNCTION
3283size_t trace_get_payload_length(const libtrace_packet_t *packet);
3284
3285/** Truncate ("snap") the packet to the suggested length
3286 * @param packet        The packet to truncate
3287 * @param size          The new length of the packet (in bytes)
3288 *
3289 * @return The new capture length of the packet or the original capture
3290 * length of the packet if unchanged.
3291 *
3292 * This function will modify the capture length of the given packet. The wire
3293 * length will not be changed, so you can always determine what the original
3294 * packet size was, prior to the truncation.
3295 *
3296 * @note You can only use this function to decrease the capture length. Any
3297 * attempt to increase capture length will have no effect.
3298 */
3299DLLEXPORT size_t trace_set_capture_length(libtrace_packet_t *packet, size_t size);
3300
3301/*@}*/
3302
3303
3304/** Gets the link layer type for a packet
3305 * @param packet        The packet to extract the link layer type for
3306 * @return A libtrace_linktype_t describing the link layer protocol being used
3307 * by this packet.
3308 */
3309DLLEXPORT SIMPLE_FUNCTION
3310libtrace_linktype_t trace_get_link_type(const libtrace_packet_t *packet);
3311
3312/** Set the direction flag for a packet, if the capture format supports
3313 * direction tagging.
3314 *
3315 * @param packet        The packet to set the direction for
3316 * @param direction     The new direction
3317 * @returns -1 on error, or the direction that was set.
3318 *
3319 * @note Few capture formats actually support direction tagging. Most notably,
3320 * we cannot set the direction on PCAP packets.
3321 */
3322DLLEXPORT libtrace_direction_t trace_set_direction(libtrace_packet_t *packet, libtrace_direction_t direction);
3323
3324/** Get the direction flag for a packet, if it has one.
3325 * @param packet  The packet to get the direction for
3326 *
3327 * @return A value representing the direction flag, or -1 if this is not
3328 * supported by the capture format.
3329 *
3330 * The direction is defined as 0 for packets originating locally (ie, outbound)
3331 * and 1 for packets originating remotely (ie, inbound). Other values are
3332 * possible, which might be overloaded to mean special things for certain
3333 * traces, e.g. in the Waikato traces, 2 is used to represent an "Unknown"
3334 * direction.
3335 *
3336 * For DAG/ERF traces, the direction is extracted from the "Interface" bits in
3337 * the ERF header, which can range from 0 - 3.
3338 */
3339DLLEXPORT SIMPLE_FUNCTION
3340libtrace_direction_t trace_get_direction(const libtrace_packet_t *packet);
3341
3342/** @name BPF
3343 * This section deals with using Berkley Packet Filters to filter input traces
3344 * @{
3345 */
3346/** Creates a BPF filter
3347 * @param filterstring The filter string describing the BPF filter to create
3348 * @return An opaque pointer to a libtrace_filter_t object
3349 *
3350 * @note The filter is not actually compiled at this point, so no correctness
3351 * tests are performed here. trace_create_filter() will always return ok, but
3352 * if the filter is poorly constructed an error will be generated when the
3353 * filter is actually used.
3354 */
3355DLLEXPORT SIMPLE_FUNCTION
3356libtrace_filter_t *trace_create_filter(const char *filterstring);
3357
3358/** Create a BPF filter based on pre-compiled byte-code.
3359 * @param bf_insns      A pointer to the start of the byte-code
3360 * @param bf_len        The number of BPF instructions 
3361 * @return              An opaque pointer to a libtrace_filter_t object
3362 * @note                The supplied byte-code is not checked for correctness.
3363 *                      Instead, incorrect byte-code will generate an error
3364 *                      once the filter is actually used.
3365 * @author              Scott Raynel
3366 */
3367DLLEXPORT libtrace_filter_t *
3368trace_create_filter_from_bytecode(void *bf_insns, unsigned int bf_len);
3369
3370/** Apply a BPF filter to a packet
3371 * @param filter        The filter to be applied       
3372 * @param packet        The packet to be matched against the filter
3373 * @return >0 if the filter matches, 0 if it doesn't, -1 on error.
3374 *
3375 * @note Due to the way BPF filters are built, the filter is not actually
3376 * compiled until the first time trace_create_filter is called. If your filter
3377 * is incorrect, it will generate an error message and assert, exiting the
3378 * program. This behaviour may change to a more graceful handling of this error
3379 * in the future.
3380 */
3381DLLEXPORT int trace_apply_filter(libtrace_filter_t *filter,
3382                const libtrace_packet_t *packet);
3383
3384/** Destroy a BPF filter
3385 * @param filter        The filter to be destroyed
3386 *
3387 * Deallocates all the resources associated with a BPF filter.
3388 */
3389DLLEXPORT void trace_destroy_filter(libtrace_filter_t *filter);
3390/*@}*/
3391
3392/** @name Portability
3393 * This section contains functions that deal with portability issues, e.g. byte
3394 * ordering.
3395 * @{
3396 */
3397
3398/** Converts an ethernet address to a printable string
3399 * @param addr  Ethernet address in network byte order
3400 * @param buf   Buffer to store the ascii representation, or NULL to indicate
3401 * that static storage should be used.
3402 * @return buf, or if buf is NULL then a statically allocated buffer.
3403 *
3404 * This function is similar to the GNU ether_ntoa_r function, with a few
3405 * minor differences.  If NULL is passed as buf, then the function will
3406 * use an internal static buffer. If NULL isn't passed then the function
3407 * will use that buffer instead.
3408 *
3409 * The address pointers returned by trace_get_source_mac() and
3410 * trace_get_destination_mac() can be passed directly into this function.
3411 *
3412 * @note The type of addr isn't struct ether_addr as it is with ether_ntoa_r,
3413 * however it is bit compatible so that a cast will work.
3414 */
3415DLLEXPORT char *trace_ether_ntoa(const uint8_t *addr, char *buf);
3416
3417/** Convert a string to an ethernet address
3418 * @param buf   A string containing an Ethernet address in hex format
3419 * delimited with :'s.
3420 * @param addr  Buffer to store the binary representation, or NULL to indicate
3421 * that static storage should be used.
3422 * @return addr, or if addr is NULL then a statically allocated buffer.
3423 *
3424 * This function is similar to the GNU ether_aton_r function, with a few
3425 * minor differences.  If NULL is passed as addr, then the function will
3426 * use an internal static buffer. If NULL isn't passed then the function will
3427 * use that buffer instead.
3428 *
3429 * The address returned by this function will be in network byte order.
3430 *
3431 * @note the type of addr isn't struct ether_addr as it is with ether_aton_r,
3432 * however it is bit compatible so that a cast will work.
3433 */
3434DLLEXPORT uint8_t *trace_ether_aton(const char *buf, uint8_t *addr);
3435
3436/*@}*/
3437
3438/** @name Ports
3439 * This section contains functions for dealing with port numbers at the
3440 * transport layer.
3441 *
3442 * @{
3443 */
3444
3445/** An indication of which port is the "server" port for a given port pair */
3446typedef enum {
3447        USE_DEST,       /**< Destination port is the server port */
3448        USE_SOURCE      /**< Source port is the server port */
3449} serverport_t;
3450
3451/** Gets the source port for a given packet
3452 * @param packet        The packet to get the source port from
3453 * @return The source port in HOST byte order or 0 if no suitable port number
3454 * can be extracted from the packet.
3455 *
3456 * This function will return 0 if the transport protocol is known not to
3457 * use port numbers, e.g. ICMP. 0 is also returned if no transport header is
3458 * present in the packet or the transport header has been truncated such that
3459 * the port fields are not readable.
3460 *
3461 * @note If the transport protocol is not known by libtrace, the first two
3462 * bytes of the transport header will be treated as the source port field.
3463 */
3464DLLEXPORT SIMPLE_FUNCTION
3465uint16_t trace_get_source_port(const libtrace_packet_t *packet);
3466
3467/** Gets the destination port for a given packet
3468 * @param packet        The packet to get the destination port from
3469 * @return The destination port in HOST byte order or 0 if no suitable port
3470 * number can be extracted from the packet.
3471 *
3472 * This function will return 0 if the transport protocol is known not to
3473 * use port numbers, e.g. ICMP. 0 is also returned if no transport header is
3474 * present in the packet or the transport header has been truncated such that
3475 * the port fields are not readable.
3476 *
3477 * @note If the transport protocol is not known by libtrace, the third and
3478 * fourth bytes of the transport header will be treated as the destination
3479 * port field.
3480 *
3481 */
3482DLLEXPORT SIMPLE_FUNCTION
3483uint16_t trace_get_destination_port(const libtrace_packet_t *packet);
3484
3485/** Hint at which of the two provided ports is the server port.
3486 *
3487 * @param protocol      The IP layer protocol, eg 6 (tcp), 17 (udp)
3488 * @param source        The source port from the packet
3489 * @param dest          The destination port from the packet
3490 *
3491 * @return one of USE_SOURCE or USE_DEST describing on which of the two ports
3492 * is most likely to be the server port.
3493 *
3494 * @note Ports must be provided in HOST byte order!
3495 *
3496 * This function is based almost entirely on heuristics and should not be
3497 * treated as a definitive means of identifying the server port. However, it
3498 * is deterministic, so it is very handy for identifying both halves of the
3499 * same flow.
3500 */
3501DLLEXPORT SIMPLE_FUNCTION
3502int8_t trace_get_server_port(uint8_t protocol, uint16_t source, uint16_t dest);
3503
3504/*@}*/
3505
3506/** @name Wireless trace support
3507 * Functions to access wireless information from packets that have wireless
3508 * monitoring headers such as Radiotap or Prism.
3509 *
3510 * The trace_get_wireless_* functions provide an abstract interface for
3511 * retrieving information from wireless traces. They take a pointer to the
3512 * wireless monitoring header (usually found with trace_get_packet_meta()) and
3513 * the linktype of the header passed in.
3514 *
3515 * All of the trace_get_wireless_* functions return false if the requested
3516 * information was unavailable, or true if it was. The actual data is stored
3517 * in an output variable supplied by the caller. Values returned into the
3518 * output variable will always be returned in host byte order.
3519 * @{
3520 */
3521
3522
3523#ifndef ARPHRD_80211_RADIOTAP
3524/** libc doesn't define this yet, so we have to do so ourselves */
3525#define ARPHRD_80211_RADIOTAP 803
3526#endif
3527
3528/** Get the wireless Timer Synchronisation Function
3529 *
3530 * Gets the value of the timer synchronisation function for this frame, which
3531 * is a value in microseconds indicating the time that the first bit of the
3532 * MPDU was received by the MAC.
3533 *
3534 * @param linkptr The wireless meta header
3535 * @param linktype The linktype of the wireless meta header passed in
3536 * @param[out] tsft The value of the timer synchronisation function.
3537 * @return true if the field was available, false if not.
3538 */
3539DLLEXPORT bool trace_get_wireless_tsft(void *linkptr,
3540        libtrace_linktype_t linktype, uint64_t *tsft);
3541
3542/** Get the wireless data rate
3543 *
3544 * @param linkptr The wireless meta header
3545 * @param linktype The linktype of the wireless meta header passed in
3546 * @param[out] rate The data-rate of the frame in units of 500kbps
3547 * @return true if the field was available, false if not.
3548 */
3549DLLEXPORT bool trace_get_wireless_rate(void *linkptr,
3550        libtrace_linktype_t linktype, uint8_t *rate);
3551
3552/** Get the wireless channel frequency
3553 * @param linkptr The wireless meta header
3554 * @param linktype The linktype of the wireless meta header passed in
3555 * @param[out] freq The frequency in MHz of the channel the frame was
3556 * transmitted or received on.
3557 * @return true if the field was available, false if not.
3558 */
3559DLLEXPORT bool trace_get_wireless_freq(void *linkptr,
3560        libtrace_linktype_t linktype, uint16_t *freq);
3561
3562/** Get the wireless signal strength in dBm
3563 * @param linkptr The wireless meta header
3564 * @param linktype The linktype of the wireless meta header passed in
3565 * @param[out] strength The RF signal power at the antenna, in dB difference
3566 * from 1mW.
3567 * @return true if the field was available, false if not.
3568 */
3569DLLEXPORT bool trace_get_wireless_signal_strength_dbm(void *linkptr,
3570        libtrace_linktype_t linktype, int8_t *strength);
3571
3572/** Get the wireless noise strength in dBm
3573 * @param linkptr The wireless meta header
3574 * @param linktype The linktype of the wireless meta header passed in
3575 * @param[out] strength The RF noise power at the antenna, in dB difference
3576 * from 1mW.
3577 * @return true if the field was available, false if not.
3578 */
3579DLLEXPORT bool trace_get_wireless_noise_strength_dbm(void *linkptr,
3580        libtrace_linktype_t linktype, int8_t *strength);
3581
3582/** Get the wireless signal strength in dB
3583 * @param linkptr The wireless meta header
3584 * @param linktype The linktype of the wireless meta header passed in
3585 * @param[out] strength The RF signal power at the antenna, in dB difference
3586 * from a fixed reference.
3587 * @return true if the field was available, false if not.
3588 */
3589DLLEXPORT bool trace_get_wireless_signal_strength_db(void *linkptr,
3590        libtrace_linktype_t linktype, uint8_t *strength);
3591
3592/** Get the wireless noise strength in dB
3593 * @param linkptr The wireless meta header
3594 * @param linktype The linktype of the wireless meta header passed in
3595 * @param[out] strength The RF noise power at the antenna, in dB difference
3596 * from a fixed reference.
3597 * @return true if the field was available, false if not.
3598 */
3599DLLEXPORT bool trace_get_wireless_noise_strength_db(void *linkptr,
3600        libtrace_linktype_t linktype, uint8_t *strength);
3601
3602/** Get the wireless transmit attenuation
3603 * @param linkptr The wireless meta header
3604 * @param linktype The linktype of the wireless meta header passed in
3605 * @param[out] attenuation The transmit power as a unitless distance from
3606 * maximum power set at factory calibration. 0 indicates maximum transmission
3607 * power.
3608 * @return true if the field was available, false if not.
3609 */
3610DLLEXPORT bool trace_get_wireless_tx_attenuation(void *linkptr,
3611        libtrace_linktype_t linktype, uint16_t *attenuation);
3612
3613/** Get the wireless transmit attenuation in dB
3614 * @param linkptr The wireless meta header
3615 * @param linktype The linktype of the wireless meta header passed in
3616 * @param[out] attenuation The transmit power as dB difference from maximum
3617 * power set at factory calibration. 0 indicates maximum power.
3618 * @return true if the field was available, false if not.
3619 */
3620DLLEXPORT bool trace_get_wireless_tx_attenuation_db(void *linkptr,
3621        libtrace_linktype_t linktype, uint16_t *attenuation);
3622
3623/** Get the wireless transmit power in dBm
3624 * @param linkptr The wireless meta header
3625 * @param linktype The linktype of the wireless meta header passed in
3626 * @param[out] txpower The transmit power as dB from a 1mW reference. This is
3627 * the absolute power level measured at the antenna port. 
3628 * @return true if the field was available, false if not.
3629 */
3630DLLEXPORT bool trace_get_wireless_tx_power_dbm(void *linkptr,
3631                libtrace_linktype_t linktype, int8_t *txpower);
3632
3633/** Get the wireless antenna
3634 * @param linkptr The wireless meta header
3635 * @param linktype The linktype of the wireless meta header passed in
3636 * @param[out] antenna The antenna that was used to transmit or receive the
3637 * frame.
3638 * @return true if the field was available, false if not.
3639 */
3640DLLEXPORT bool trace_get_wireless_antenna(void *linkptr,
3641        libtrace_linktype_t linktype, uint8_t *antenna);
3642
3643/*@}*/
3644
3645#ifdef __cplusplus
3646} /* extern "C" */
3647#endif /* #ifdef __cplusplus */
3648#endif /* LIBTRACE_H_ */
Note: See TracBrowser for help on using the repository browser.