source: lib/libtrace.h.in @ 4e9be84

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

Remove old unused meta-api result structure

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