source: lib/libtrace.h.in @ 33b735c

develop
Last change on this file since 33b735c was 33b735c, checked in by Jacob Van Walraven <jcv9@…>, 4 years ago

More assertion cleanup

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