source: lib/libtrace.h.in @ 66ffac4

develop
Last change on this file since 66ffac4 was 66ffac4, checked in by Jacob Van Walraven <jcv9@…>, 21 months ago

Add more meta functions, cleanup function names, DLLEXPORT all meta-api prototypes

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