source: lib/libtrace.h.in @ db919d5

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

Resolve merge conflict

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