source: lib/libtrace.h.in @ b9af56e

develop
Last change on this file since b9af56e was b9af56e, checked in by Jacob van Walraven <jacobvw@…>, 21 months ago

Fix merge conflict

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