source: lib/libtrace.h.in @ 387d299

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

Remove duplicate macros in libpacketdump

Ensure OSPF libpacketdump module won't segfault or print garbage
if a truncated OSPF header is passed into it.

Renamed 'len' field in OSPF header to 'ospf_len' to avoid
potential conflict with variables named len in libpacketdump
code.

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