source: lib/libtrace.h.in @ 692bf9c

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

Add support to retrieve outermost vlan tag, outermost mpls label, and all layer2 headers

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