source: lib/libtrace.h.in @ f440dc0

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