source: lib/libtrace.h.in @ 29cafc0

cachetimestampsdevelopetsiliverc-4.0.3rc-4.0.4ringdecrementfixringperformance
Last change on this file since 29cafc0 was 29cafc0, checked in by Shane Alcock <salcock@…>, 3 years ago

Fix build error on OpenBSD with libtrace.h

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