source: lib/libtrace.h.in @ 3fc3267

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivelibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since 3fc3267 was 3fc3267, checked in by Shane Alcock <salcock@…>, 7 years ago

Add protocol decoder functions for GRE and VXLAN

Many thanks to Perry Lorier for providing this patch.

Includes a test-case for VXLAN parsing.

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