source: lib/libtrace.h.in @ f0c639b

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since f0c639b was f0c639b, checked in by Scott Raynel <smr26@…>, 14 years ago
  • Remove trace_get_wireless_fcs as it is no longer part of the Radiotap standard.
  • Update trace_get_wire_length to account for the presence (or absence) of FCS bytes at the end of wireless frames. (only pcap and pcapfile for now)
  • Update radiotap libpacketdump decoder to no longer output non-standard FCS field.
  • Update test-wireless to ensure new length functions work correctly.
  • Property mode set to 100644
File size: 59.1 KB
Line 
1/*
2 * This file is part of libtrace
3 *
4 * Copyright (c) 2007 The University of Waikato, Hamilton, New Zealand.
5 * Authors: Daniel Lawson
6 *          Perry Lorier
7 *         
8 * All rights reserved.
9 *
10 * This code has been developed by the University of Waikato WAND
11 * research group. For further information please see http://www.wand.net.nz/
12 *
13 * libtrace is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * libtrace is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with libtrace; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 *
27 * $Id: libtrace.h 773 2006-05-01 12:58:09Z perry $
28 *
29 */
30
31#ifndef LIBTRACE_H
32#define LIBTRACE_H
33
34/** @file
35 *
36 * @brief Trace file processing library header
37 *
38 * @author Daniel Lawson
39 * @author Perry Lorier
40 *
41 * @version $Id: libtrace.h 773 2006-05-01 12:58:09Z perry $
42 *
43 * This library provides a per packet interface into a trace file, or a live
44 * captures.  It supports ERF, DAG cards, WAG cards, WAG's event format,
45 * pcap etc.
46 *
47 * @par Usage
48 * See the example/ directory in the source distribution for some simple examples
49 * @par Linking
50 * To use this library you need to link against libtrace by passing -ltrace
51 * to your linker. You may also need to link against a version of libpcap
52 * and of zlib which are compiled for largefile support (if you wish to access
53 * traces larger than 2 GB). This is left as an exercise for the reader. Debian
54 * Woody, at least, does not support large file offsets.
55 *
56 */
57
58#include <sys/types.h>
59#ifndef WIN32
60#include <sys/time.h>
61#endif
62
63#ifdef _MSC_VER
64    /* define the following from MSVC's internal types */
65    typedef             __int8  int8_t;
66    typedef             __int16 int16_t;
67    typedef             __int32 int32_t;
68    typedef             __int64 int64_t;
69    typedef unsigned    __int8  uint8_t;
70    typedef unsigned    __int16 uint16_t;
71    typedef unsigned    __int32 uint32_t;
72    typedef unsigned    __int64 uint64_t;
73    #ifdef BUILDING_DLL
74        #define DLLEXPORT __declspec(dllexport)
75    #else
76        #define DLLEXPORT __declspec(dllimport)
77    #endif
78    #define DLLLOCAL
79    /* Windows pads bitfields out to to the size of their parent type
80     * however gcc warns that this doesn't meet with the iso C specification
81     * so produces warnings for this behaviour.  sigh.
82     */
83    #define LT_BITFIELD8        uint8_t
84    #define LT_BITFIELD16       uint16_t
85    #define LT_BITFIELD32       uint32_t
86    #define LT_BITFIELD64       uint64_t
87#else
88#   include <stdint.h>
89    #ifdef HAVE_GCCVISIBILITYPATCH
90        #define DLLEXPORT __attribute__ (visibility("default"))
91        #define DLLLOCAL __attribute__ (visibility("hidden"))
92    #else
93        #define DLLEXPORT
94        #define DLLLOCAL
95    #endif
96    /* GCC warns if the bitfield type is not "unsigned int", however windows
97     * generates incorrect code for this (see above), so we define these
98     * macros.  How Hidious.  So much for C's portability.
99     */
100    #define LT_BITFIELD8        unsigned int
101    #define LT_BITFIELD16       unsigned int
102    #define LT_BITFIELD32       unsigned int
103    #define LT_BITFIELD64       unsigned int
104#endif
105
106#ifdef WIN32
107#   include <winsock2.h>
108#   include <ws2tcpip.h>
109    typedef short sa_family_t;
110    /* Make up for a lack of stdbool.h */
111#    define bool signed char
112#    define false 0
113#    define true 1
114#    if !defined(ssize_t)
115     /* XXX: Not 64-bit safe! */
116#    define ssize_t int
117#    endif   
118#else
119#    include <netinet/in.h>
120
121#ifndef __cplusplus
122#    include <stdbool.h>
123#endif
124
125#    include <sys/types.h>
126#    include <sys/socket.h>
127#endif
128
129/** API version as 2 byte hex digits, eg 0xXXYYZZ */
130#define LIBTRACE_API_VERSION \
131            ((@LIBTRACE_MAJOR@<<16)|(@LIBTRACE_MID@<<8)|(@LIBTRACE_MINOR@))
132
133#define LIBTRACE_SVN_REVISION 0
134#define DAG_DRIVER_V "@DAG_VERSION_NUM@"
135   
136#ifdef __cplusplus
137extern "C" {
138#endif
139
140/* Function does not depend on anything but its
141 * parameters, used to hint gcc's optimisations
142 */
143#if __GNUC__ >= 3
144#  define SIMPLE_FUNCTION __attribute__((pure))
145#  define UNUSED __attribute__((unused))
146#  define PACKED __attribute__((packed))
147#  define PRINTF(formatpos,argpos) __attribute__((format(printf,formatpos,argpos)))
148#else
149#  define SIMPLE_FUNCTION
150#  define UNUSED
151#  define PACKED
152#  define PRINTF(formatpos,argpos)
153#endif
154       
155/** Opaque structure holding information about an output trace */
156typedef struct libtrace_out_t libtrace_out_t;
157       
158/** Opaque structure holding information about a trace */
159typedef struct libtrace_t libtrace_t;
160       
161/** Opaque structure holding information about a bpf filter */
162typedef struct libtrace_filter_t libtrace_filter_t;
163
164/** If a packet has memory allocated
165 * If the packet has allocated it's own memory it's buffer_control should
166 * be TRACE_CTRL_PACKET, when the packet is destroyed it's memory will be
167 * free()'d.  If it's doing zerocopy out of memory owned by something else
168 * it should be TRACE_CTRL_EXTERNAL.
169 * @note the letters p and e are magic numbers used to detect if the packet
170 * wasn't created properly
171 */
172typedef enum {
173        TRACE_CTRL_PACKET='p',
174        TRACE_CTRL_EXTERNAL='e'
175} buf_control_t;
176/** The size of a packet's buffer when managed by libtrace */
177#define LIBTRACE_PACKET_BUFSIZE 65536
178
179/** libtrace error information */
180typedef struct trace_err_t{
181        int err_num;            /**< error code */
182        char problem[255];      /**< the format, uri etc that caused the error for reporting purposes */
183} libtrace_err_t;
184
185/** Enumeration of error codes */
186enum {
187        /** No Error has occured.... yet. */
188        TRACE_ERR_NOERROR       = 0,
189        /** The URI passed to trace_create() is unsupported, or badly formed */
190        TRACE_ERR_BAD_FORMAT    = -1,
191        /** The trace failed to initialise */
192        TRACE_ERR_INIT_FAILED   = -2,
193        /** Unknown config option */
194        TRACE_ERR_UNKNOWN_OPTION= -3,
195        /** This output uri cannot write packets of this type */
196        TRACE_ERR_NO_CONVERSION = -4,
197        /** This packet is corrupt, or unusable for the action required */
198        TRACE_ERR_BAD_PACKET    = -5,
199        /** Option known, but unsupported by this format */
200        TRACE_ERR_OPTION_UNAVAIL= -6,
201        /** This feature is unsupported */
202        TRACE_ERR_UNSUPPORTED   = -7
203};
204
205/** Enumeration of DLT types supported by libtrace
206 * These aren't actually DLTs, but LINKTYPE_'s, so becareful when modifying
207 * this.
208 */
209typedef enum {
210        TRACE_DLT_NULL = 0,
211        TRACE_DLT_EN10MB = 1,
212        TRACE_DLT_PPP = 9,
213        TRACE_DLT_ATM_RFC1483 = 11,
214        TRACE_DLT_RAW = 101,
215        TRACE_DLT_IEEE802_11 = 105,
216        TRACE_DLT_LINUX_SLL = 113,
217        TRACE_DLT_PFLOG = 117,
218        TRACE_DLT_IEEE802_11_RADIO = 127 /**< Radiotap */
219} libtrace_dlt_t ;
220
221/** Enumeration of link layer types supported by libtrace */
222typedef enum {
223    /* TRACE_TYPE_LEGACY = 0            Obsolete */
224       TRACE_TYPE_HDLC_POS = 1,
225       TRACE_TYPE_ETH = 2,              /**< 802.3 style Ethernet */
226       TRACE_TYPE_ATM = 3,              /**< ATM frame */
227       TRACE_TYPE_80211 = 4,            /**< 802.11 frames */
228       TRACE_TYPE_NONE = 5,             /**< Raw IP frames */
229       TRACE_TYPE_LINUX_SLL = 6,        /**< Linux "null" framing */
230       TRACE_TYPE_PFLOG = 7,            /**< FreeBSD's PFlug */
231    /* TRACE_TYPE_LEGACY_DEFAULT        Obsolete */
232       TRACE_TYPE_POS = 9,
233    /* TRACE_TYPE_LEGACY_ATM            Obsolete */
234    /* TRACE_TYPE_LEGACY_ETH            Obsolete */
235       TRACE_TYPE_80211_PRISM = 12,
236       TRACE_TYPE_AAL5 = 13,
237       TRACE_TYPE_DUCK = 14,         /**< Pseudo link layer for DUCK packets */
238       TRACE_TYPE_80211_RADIO = 15,  /**< Radiotap + 802.11 */
239       TRACE_TYPE_LLCSNAP = 16,      /**< Raw LLC/SNAP */
240       TRACE_TYPE_PPP = 17,          /**< PPP frames */
241       TRACE_TYPE_METADATA = 18         /**< WDCAP-style meta-data */
242       
243} libtrace_linktype_t;
244
245/** RT protocol base format identifiers
246 * This is used to say what kind of packet is being sent over the rt protocol
247 */
248enum base_format_t {
249        TRACE_FORMAT_ERF          =1,
250        TRACE_FORMAT_PCAP         =2,
251        TRACE_FORMAT_PCAPFILE     =3,
252        TRACE_FORMAT_WAG          =4,
253        TRACE_FORMAT_RT           =5,
254        TRACE_FORMAT_LEGACY_ATM   =6,
255        TRACE_FORMAT_LEGACY_POS   =7,
256        TRACE_FORMAT_LEGACY_ETH   =8,
257        TRACE_FORMAT_LINUX_NATIVE =9,
258        TRACE_FORMAT_DUCK         =10,
259        TRACE_FORMAT_BPF          =11
260};
261
262/* RT protocol packet types */
263typedef enum {
264        TRACE_RT_HELLO          =1, /**< Connection accepted */
265        TRACE_RT_START          =2, /**< Request for data transmission to begin
266                                    */
267        TRACE_RT_ACK            =3, /**< Data acknowledgement */
268        TRACE_RT_STATUS         =4, /**< Fifo status packet */
269        TRACE_RT_DUCK           =5, /**< Dag duck info packet */
270        TRACE_RT_END_DATA       =6, /**< Server is exiting message */
271        TRACE_RT_CLOSE          =7, /**< Client is exiting message */
272        TRACE_RT_DENY_CONN      =8, /**< Connection has been denied */
273        TRACE_RT_PAUSE          =9, /**< Request server to suspend sending data
274                                     */
275        TRACE_RT_PAUSE_ACK      =10,/**< Server is paused message */
276        TRACE_RT_OPTION         =11,/**< Option request */
277        TRACE_RT_KEYCHANGE      =12,/**< Anonymisation key has changed */
278        TRACE_RT_DUCK_2_4       =13,/**< Dag 2.4 Duck */
279        TRACE_RT_DUCK_2_5       =14,/**< Dag 2.5 Duck */
280        TRACE_RT_LOSTCONN       =15,/**< Lost connection to server */
281        TRACE_RT_SERVERSTART    =16,/**< Reliable server has been restarted */
282        TRACE_RT_CLIENTDROP     =17,/**< Reliable client was lost */
283        TRACE_RT_METADATA       =18,/**< Packet contains server meta-data */
284
285        TRACE_RT_DATA_SIMPLE    = 1000, /**< Trace types that know their link
286                                          * type
287                                          */
288        TRACE_RT_DATA_ERF       =TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_ERF,
289        TRACE_RT_DATA_WAG       =TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_WAG,
290        TRACE_RT_DATA_LEGACY_ATM=TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_LEGACY_ATM,
291        TRACE_RT_DATA_LEGACY_POS=TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_LEGACY_POS,
292        TRACE_RT_DATA_LEGACY_ETH=TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_LEGACY_ETH,
293        TRACE_RT_DATA_LINUX_NATIVE=TRACE_RT_DATA_SIMPLE+TRACE_FORMAT_LINUX_NATIVE,
294
295        TRACE_RT_DATA_DLT               = 2000, /**< Pcap doesn't store the
296                                                  * linktype per packet, and
297                                                  * thus we have to store it
298                                                  * in here.  sigh.
299                                                  */
300        TRACE_RT_DLT_NULL               =TRACE_RT_DATA_DLT+TRACE_DLT_NULL,
301        TRACE_RT_DLT_EN10MB             =TRACE_RT_DATA_DLT+TRACE_DLT_EN10MB,
302        TRACE_RT_DLT_IEEE802_11         =TRACE_RT_DATA_DLT+TRACE_DLT_IEEE802_11,
303        TRACE_RT_DLT_LINUX_SLL          =TRACE_RT_DATA_DLT+TRACE_DLT_LINUX_SLL,
304        TRACE_RT_DLT_PFLOG              =TRACE_RT_DATA_DLT+TRACE_DLT_PFLOG,
305        TRACE_RT_DLT_ATM_RFC1483        =TRACE_RT_DATA_DLT+TRACE_DLT_ATM_RFC1483,
306        TRACE_RT_LAST                   = (2<<31)
307} libtrace_rt_types_t;
308
309/** The libtrace packet structure, applications shouldn't be
310 * meddling around in here
311 */
312typedef struct libtrace_packet_t {
313        struct libtrace_t *trace;       /**< pointer to the trace */
314        void *header;                   /**< pointer to the framing header */
315        void *payload;                  /**< pointer to the link layer */
316        void *buffer;                   /**< allocated buffer */
317        libtrace_rt_types_t  type;      /**< rt protocol type for the packet */
318        buf_control_t buf_control;      /**< who owns the memory */
319} libtrace_packet_t;
320
321
322/** Trace directions
323 * Note that these are the directions used by convention, more directions
324 * are possible, not just these 3, and that they may not conform to this
325 * convention.
326 */
327typedef enum {
328        TRACE_DIR_OUTGOING = 0,         /**< Packets originating "outside" */
329        TRACE_DIR_INCOMING = 1,         /**< Packets originating "inside" */
330        TRACE_DIR_OTHER    = 2          /**< Packets with an unknown direction, or one that's unknown */
331} libtrace_direction_t;
332
333/** Enumeration of Radiotap fields */
334typedef enum {
335    TRACE_RADIOTAP_TSFT = 0, /**< Timer synchronisation function, in microseconds (uint64) */
336    TRACE_RADIOTAP_FLAGS = 1, /**< Wireless flags (uint8) */
337    TRACE_RADIOTAP_RATE = 2, /**< Bitrate in units of 500kbps (uint8) */
338    TRACE_RADIOTAP_CHANNEL = 3, /**< Frequency in MHz (uint16) and channel flags (uint16) */
339    TRACE_RADIOTAP_FHSS = 4, /**< FHSS hop set (uint8) and hopping pattern (uint8) */
340    TRACE_RADIOTAP_DBM_ANTSIGNAL = 5, /**< Signal power in dBm (int8) */
341    TRACE_RADIOTAP_DBM_ANTNOISE = 6, /**< Noise power in dBm (int8) */
342    TRACE_RADIOTAP_LOCK_QUALITY = 7, /**< Barker Code lock quality (uint16) */
343    TRACE_RADIOTAP_TX_ATTENUATION = 8, /**< TX attenuation as unitless distance from max power (uint16) */
344    TRACE_RADIOTAP_DB_TX_ATTENUATION = 9, /**< TX attenutation as dB from max power (uint16) */
345    TRACE_RADIOTAP_DBM_TX_POWER = 10, /**< TX Power in dBm (int8) */
346    TRACE_RADIOTAP_ANTENNA = 11, /**< Antenna frame was rx'd or tx'd on (uint8) */
347    TRACE_RADIOTAP_DB_ANTSIGNAL = 12, /**< Signal power in dB from a fixed reference (uint8) */
348    TRACE_RADIOTAP_DB_ANTNOISE = 13, /**< Noise power in dB from a fixed reference (uint8) */
349    TRACE_RADIOTAP_EXT = 31
350} libtrace_radiotap_field_t;
351
352
353/** @name Protocol structures
354 * These convenience structures are here as they are portable ways of dealing
355 * with various protocols.
356 * @{
357 */
358
359#ifdef WIN32
360#pragma pack(push)
361#pragma pack(1)
362#endif
363
364/** Generic IP header structure */
365typedef struct libtrace_ip
366{
367#if BYTE_ORDER == LITTLE_ENDIAN
368    LT_BITFIELD8 ip_hl:4;               /**< Header Length */
369    LT_BITFIELD8 ip_v:4;                /**< Version */
370#elif BYTE_ORDER == BIG_ENDIAN
371    LT_BITFIELD8 ip_v:4;                /**< Version */
372    LT_BITFIELD8 ip_hl:4;               /**< Header Length */
373#else
374#   error "Adjust your <bits/endian.h> defines"
375#endif
376    uint8_t  ip_tos;                    /**< Type of Service */
377    uint16_t ip_len;                    /**< Total Length */
378    int16_t  ip_id;                     /**< Identification */
379#if BYTE_ORDER == LITTLE_ENDIAN
380    LT_BITFIELD16 ip_off:12;            /**< Fragment Offset */
381    LT_BITFIELD16 ip_mf:1;              /**< More Fragments Flag */
382    LT_BITFIELD16 ip_df:1;              /**< Dont Fragment Flag */
383    LT_BITFIELD16 ip_rf:1;              /**< Reserved Fragment Flag */
384#elif BYTE_ORDER == BIG_ENDIAN
385    LT_BITFIELD16 ip_rf:1;              /**< Fragment Offset */
386    LT_BITFIELD16 ip_df:1;              /**< More Fragments Flag */
387    LT_BITFIELD16 ip_mf:1;              /**< Dont Fragment Flag */
388    LT_BITFIELD16 ip_off:12;            /**< Reserved Fragment Flag */
389#else
390#   error "Adjust your <bits/endian.h> defines"
391#endif
392    uint8_t  ip_ttl;                    /**< Time to Live */
393    uint8_t  ip_p;                      /**< Protocol */
394    uint16_t ip_sum;                    /**< Checksum */
395    struct in_addr ip_src;              /**< Source Address */
396    struct in_addr ip_dst;              /**< Destination Address */
397} PACKED libtrace_ip_t;
398
399/** IPv6 header extension structure */
400typedef struct libtrace_ip6_ext
401{
402        uint8_t nxt;
403        uint8_t len;
404} PACKED libtrace_ip6_ext_t;
405
406/** Generic IPv6 header structure */
407typedef struct libtrace_ip6
408{
409    uint32_t flow;
410    uint16_t plen;                      /**< Payload length */
411    uint8_t nxt;                        /**< Next header */
412    uint8_t hlim;                       /**< Hop limit */
413    struct in6_addr ip_src;             /**< source address */
414    struct in6_addr ip_dst;             /**< dest address */
415} PACKED libtrace_ip6_t;
416
417/** Generic TCP header structure */
418typedef struct libtrace_tcp
419  {
420    uint16_t source;            /**< Source Port */
421    uint16_t dest;              /**< Destination port */
422    uint32_t seq;               /**< Sequence number */
423    uint32_t ack_seq;           /**< Acknowledgement Number */
424#  if BYTE_ORDER == LITTLE_ENDIAN
425    LT_BITFIELD8 res1:4;        /**< Reserved bits */
426    LT_BITFIELD8 doff:4;        /**< Data Offset */     
427    LT_BITFIELD8 fin:1;         /**< FIN */
428    LT_BITFIELD8 syn:1;         /**< SYN flag */
429    LT_BITFIELD8 rst:1;         /**< RST flag */
430    LT_BITFIELD8 psh:1;         /**< PuSH flag */
431    LT_BITFIELD8 ack:1;         /**< ACK flag */
432    LT_BITFIELD8 urg:1;         /**< URG flag */
433    LT_BITFIELD8 res2:2;        /**< Reserved */
434#  elif BYTE_ORDER == BIG_ENDIAN
435    LT_BITFIELD8 doff:4;        /**< Data offset */
436    LT_BITFIELD8 res1:4;        /**< Reserved bits */
437    LT_BITFIELD8 res2:2;        /**< Reserved */
438    LT_BITFIELD8 urg:1;         /**< URG flag */
439    LT_BITFIELD8 ack:1;         /**< ACK flag */
440    LT_BITFIELD8 psh:1;         /**< PuSH flag */
441    LT_BITFIELD8 rst:1;         /**< RST flag */
442    LT_BITFIELD8 syn:1;         /**< SYN flag */
443    LT_BITFIELD8 fin:1;         /**< FIN flag */
444#  else
445#   error "Adjust your <bits/endian.h> defines"
446#  endif
447    uint16_t window;            /**< Window Size */
448    uint16_t check;             /**< Checksum */
449    uint16_t urg_ptr;           /**< Urgent Pointer */
450} PACKED libtrace_tcp_t;
451
452/** Generic UDP header structure */
453typedef struct libtrace_udp {
454  uint16_t      source;         /**< Source port */
455  uint16_t      dest;           /**< Destination port */
456  uint16_t      len;            /**< Length */
457  uint16_t      check;          /**< Checksum */
458} PACKED libtrace_udp_t;
459
460/** Generic ICMP header structure */
461typedef struct libtrace_icmp
462{
463  uint8_t type;         /**< Message Type */
464  uint8_t code;         /**< Type Sub-code */
465  uint16_t checksum;            /**< Checksum */
466  union
467  {
468    struct
469    {
470      uint16_t  id;
471      uint16_t  sequence;
472    } echo;                     /**< Echo Datagram */
473    uint32_t    gateway;        /**< Gateway Address */
474    struct
475    {
476      uint16_t  unused;
477      uint16_t  mtu;
478    } frag;                     /**< Path MTU Discovery */
479  } un;                         /**< Union for Payloads of Various ICMP Codes */
480} PACKED libtrace_icmp_t;
481
482/** Generic LLC/SNAP header structure */
483typedef struct libtrace_llcsnap
484{
485/* LLC */
486  uint8_t dsap;                 /**< Destination Service Access Point */
487  uint8_t ssap;                 /**< Source Service Access Point */
488  uint8_t control;
489/* SNAP */
490  LT_BITFIELD32 oui:24;         /**< Organisationally Unique Identifier (scope)*/
491  uint16_t type;                /**< Protocol within OUI */
492} PACKED libtrace_llcsnap_t;
493
494/** 802.3 frame */
495typedef struct libtrace_ether
496{
497  uint8_t ether_dhost[6];       /**< Destination Ether Addr */
498  uint8_t ether_shost[6];       /**< Source Ether Addr */
499  uint16_t ether_type;          /**< Packet Type ID Field (next-header) */
500} PACKED libtrace_ether_t;
501
502/** 802.1Q frame */
503typedef struct libtrace_8021q
504{
505  LT_BITFIELD16 vlan_pri:3;      /**< VLAN User Priority */
506  LT_BITFIELD16 vlan_cfi:1;      /**< VLAN Format Indicator,
507                                   * 0 for ethernet, 1 for token ring */
508  LT_BITFIELD16 vlan_id:12;      /**< VLAN Id */
509  uint16_t vlan_ether_type;      /**< VLAN Sub-packet Type ID Field
510                                   * (next-header)*/
511} PACKED libtrace_8021q_t;
512
513/** ATM User Network Interface (UNI) Cell. */
514typedef struct libtrace_atm_cell
515{
516  LT_BITFIELD32 gfc:4;          /**< Generic Flow Control */
517  LT_BITFIELD32 vpi:8;          /**< Virtual Path Identifier */
518  LT_BITFIELD32 vci:16;         /**< Virtual Channel Identifier */
519  LT_BITFIELD32 pt:3;           /**< Payload Type */
520  LT_BITFIELD32 clp:1;          /**< Cell Loss Priority */
521  LT_BITFIELD32 hec:8;          /**< Header Error Control */
522} PACKED libtrace_atm_cell_t;
523
524/** ATM Network Node/Network Interface (NNI) Cell. */
525typedef struct libtrace_atm_nni_cell
526{
527  LT_BITFIELD32 vpi:12;         /**< Virtual Path Identifier */
528  LT_BITFIELD32 vci:16;         /**< Virtual Channel Identifier */
529  LT_BITFIELD32 pt:3;           /**< Payload Type */
530  LT_BITFIELD32 clp:1;          /**< Cell Loss Priority */
531  LT_BITFIELD32 hec:8;          /**< Header Error Control */
532} PACKED libtrace_atm_nni_cell_t;
533
534/** Captured UNI cell.
535 *
536 * Endance don't capture the HEC, presumably to keep alignment.  This
537 * version of the \ref libtrace_atm_cell  is used when dealing with dag
538 * captures of uni cells.
539 *
540 */
541typedef struct libtrace_atm_capture_cell
542{
543  LT_BITFIELD32 gfc:4;          /**< Generic Flow Control */
544  LT_BITFIELD32 vpi:8;          /**< Virtual Path Identifier */
545  LT_BITFIELD32 vci:16;         /**< Virtual Channel Identifier */
546  LT_BITFIELD32 pt:3;           /**< Payload Type */
547  LT_BITFIELD32 clp:1;          /**< Cell Loss Priority */
548} PACKED libtrace_atm_capture_cell_t;
549
550/** Captured NNI cell.
551 *
552 * Endance don't capture the HEC, presumably to keep alignment.  This
553 * version of the \ref libtrace_atm_nni_cell  is used when dealing with dag
554 * captures of nni cells.
555 *
556 */
557typedef struct libtrace_atm_nni_capture_cell
558{
559  LT_BITFIELD32 vpi:12;         /**< Virtual Path Identifier */
560  LT_BITFIELD32 vci:16;         /**< Virtual Channel Identifier */
561  LT_BITFIELD32 pt:3;           /**< Payload Type */
562  LT_BITFIELD32 clp:1;          /**< Cell Loss Priority */
563  LT_BITFIELD32 hec:8;          /**< Header Error Control */
564} PACKED libtrace_atm_nni_capture_cell_t;
565
566/** PPP header */
567typedef struct libtrace_pps
568{
569 uint8_t addres;                /**< PPP Address (0xFF - All stations) */
570 uint8_t header;                /**< PPP Control (0x03 - Unnumbered info) */
571 uint16_t protocol;             /**< PPP Protocol (htons(0x0021) - IPv4 */
572} PACKED libtrace_ppp_t;
573
574/** 802.11 header */
575typedef struct libtrace_80211_t {
576#if BYTE_ORDER == LITTLE_ENDIAN
577        LT_BITFIELD32      protocol:2;
578        LT_BITFIELD32      type:2;
579        LT_BITFIELD32      subtype:4;
580#else
581        LT_BITFIELD32      subtype:4;
582        LT_BITFIELD32      type:2;
583        LT_BITFIELD32      protocol:2;
584#endif
585
586#if BYTE_ORDER == LITTLE_ENDIAN
587        LT_BITFIELD32      to_ds:1;     /**< Packet to Distribution Service */
588        LT_BITFIELD32      from_ds:1;   /**< Packet from Distribution Service */
589        LT_BITFIELD32      more_frag:1; /**< Packet has more fragments */
590        LT_BITFIELD32      retry:1;     /**< Packet is a retry */
591        LT_BITFIELD32      power:1;
592        LT_BITFIELD32      more_data:1;
593        LT_BITFIELD32      wep:1;
594        LT_BITFIELD32      order:1;
595#else
596        LT_BITFIELD32      order:1;
597        LT_BITFIELD32      wep:1;
598        LT_BITFIELD32      more_data:1;
599        LT_BITFIELD32      power:1;
600        LT_BITFIELD32      retry:1;     /**< Packet is a retry */
601        LT_BITFIELD32      more_frag:1; /**< Packet has more fragments */
602        LT_BITFIELD32      from_ds:1;   /**< Packet from Distribution Service */
603        LT_BITFIELD32      to_ds:1;     /**< Packet to Distribution Service */
604#endif
605        uint16_t     duration;
606        uint8_t      mac1[6];
607        uint8_t      mac2[6];
608        uint8_t      mac3[6];
609        uint16_t     SeqCtl;
610        uint8_t      mac4[6];
611} PACKED libtrace_80211_t;
612
613/** The Radiotap header pre-amble
614 *
615 * All Radiotap headers start with this pre-amble, followed by the fields
616 * specified in the it_present bitmask. If bit 31 of it_present is set, then
617 * another bitmask follows.
618 * @note All of the radiotap data fields are in little-endian byte-order.
619 */
620typedef struct libtrace_radiotap_t {
621    uint8_t     it_version; /**< Radiotap version */
622    uint8_t     it_pad; /**< Padding for natural alignment */
623    uint16_t    it_len; /**< Length in bytes of the entire Radiotap header */
624    uint32_t    it_present; /**< Which Radiotap fields are present */
625} PACKED libtrace_radiotap_t;
626
627
628#ifdef WIN32
629#pragma pack(pop)
630#endif
631
632
633/*@}*/
634
635/** Prints help information for libtrace
636 *
637 * Function prints out some basic help information regarding libtrace,
638 * and then prints out the help() function registered with each input module
639 */
640DLLEXPORT void trace_help(void);
641
642/** @name Trace management
643 * These members deal with creating, configuring, starting, pausing and
644 * cleaning up a trace object
645 *@{
646 */
647
648/** Create a trace file from a URI
649 *
650 * @param uri containing a valid libtrace URI
651 * @return an opaque pointer to a libtrace_t
652 *
653 * Valid URI's are:
654 *  - erf:/path/to/erf/file
655 *  - erf:-  (stdin)
656 *  - dag:/dev/dagcard                 
657 *  - pcapint:pcapinterface                (eg: pcap:eth0)
658 *  - pcap:/path/to/pcap/file
659 *  - pcap:-
660 *  - rt:hostname
661 *  - rt:hostname:port
662 *  - rtclient:hostname (deprecated)
663 *  - rtclient:hostname:port (deprecated)
664 *  - wag:/dev/wagcard
665 *  - wtf:-
666 *  - wtf:/path/to/wtf/file
667 *
668 *  If an error occured when attempting to open the trace file, an error
669 *  trace is returned and trace_get_error should be called to find out
670 *  if an error occured, and what that error was.  The trace is created in the
671 *  configuration state, you must call trace_start to start the capture.
672 */
673DLLEXPORT libtrace_t *trace_create(const char *uri);
674
675/** Creates a "dummy" trace file that has only the format type set.
676 *
677 * @return an opaque pointer to a (sparsely initialised) libtrace_t
678 *
679 * IMPORTANT: Do not attempt to call trace_read_packet or other such functions
680 * with the dummy trace. Its intended purpose is to act as a packet->trace for
681 * libtrace_packet_t's that are not associated with a libtrace_t structure.
682 */
683DLLEXPORT libtrace_t *trace_create_dead(const char *uri);
684
685/** Creates a trace output file from a URI.
686 *
687 * @param uri   the uri string describing the output format and destination
688 * @return an opaque pointer to a libtrace_output_t
689 *
690 * Valid URI's are:
691 *  - erf:/path/to/erf/file
692 *  - pcap:/path/to/pcap/file
693 *  - wtf:/path/to/wtf/file
694 *
695 *  If an error occured when attempting to open the output trace, NULL is returned
696 *  and trace_errno is set. Use trace_perror() to get more information
697 */
698DLLEXPORT libtrace_out_t *trace_create_output(const char *uri);
699
700/** Start the capture
701 * @param libtrace      The trace to start
702 * @return 0 on success, -1 on failure
703 *
704 * This does the actual work with starting the trace capture, and applying
705 * all the config options.  This may fail.
706 */
707DLLEXPORT int trace_start(libtrace_t *libtrace);
708
709/** Pause the capture
710 * @param libtrace      The trace to pause
711 * @return 0 on success, -1 on failure
712 *
713 * This stops a capture in progress and returns you to the configuration
714 * state.  Any packets that arrive after trace_pause() has been called
715 * will be discarded.  To resume capture, call trace_start().
716 */
717DLLEXPORT int trace_pause(libtrace_t *libtrace);
718
719/** Start an output trace
720 * @param libtrace      The trace to start
721 * @return 0 on success, -1 on failure
722 *
723 * This does the actual work with starting a trace for write.  This generally
724 * creates the file.
725 */
726DLLEXPORT int trace_start_output(libtrace_out_t *libtrace);
727
728/** Valid trace capture options */
729typedef enum {
730        TRACE_OPTION_SNAPLEN, /**< Number of bytes captured */
731        TRACE_OPTION_PROMISC, /**< Capture packets to other hosts */
732        TRACE_OPTION_FILTER,  /**< Apply this filter to all packets recieved */
733        TRACE_META_FREQ       /**< Frequency of meta-data information, e.g. DUCK packets */
734} trace_option_t;
735
736/** Sets an input config option
737 * @param libtrace      the trace object to apply the option to
738 * @param option        the option to set
739 * @param value         the value to set the option to
740 * @return -1 if option configuration failed, 0 otherwise
741 * This should be called after trace_create, and before trace_start
742 */
743DLLEXPORT int trace_config(libtrace_t *libtrace,
744                trace_option_t option,
745                void *value);
746
747typedef enum {
748        TRACE_OPTION_OUTPUT_FILEFLAGS, /**< File flags to open the trace file
749                                        * with.  eg O_APPEND
750                                        */
751        TRACE_OPTION_OUTPUT_COMPRESS   /**< Compression level, eg 6. */
752} trace_option_output_t;
753
754/** Sets an output config option
755 *
756 * @param libtrace      the output trace object to apply the option to
757 * @param option        the option to set
758 * @param value         the value to set the option to
759 * @return -1 if option configuration failed, 0 otherwise
760 * This should be called after trace_create_output, and before
761 * trace_start_output
762 */
763DLLEXPORT int trace_config_output(libtrace_out_t *libtrace,
764                trace_option_output_t option,
765                void *value
766                );
767
768/** Close a trace file, freeing up any resources it may have been using
769 *
770 */
771DLLEXPORT void trace_destroy(libtrace_t *trace);
772
773/** Close a trace file, freeing up any resources it may have been using
774 * @param trace         trace file to be destroyed
775 */
776DLLEXPORT void trace_destroy_dead(libtrace_t *trace);
777
778/** Close a trace output file, freeing up any resources it may have been using
779 * @param trace         the output trace file to be destroyed
780 */
781DLLEXPORT void trace_destroy_output(libtrace_out_t *trace);
782
783/** Check (and clear) the current error state of an input trace
784 * @param trace         the trace file to check the error state on
785 * @return Error report
786 * This reads and returns the current error state and sets the current error
787 * to "no error".
788 */
789DLLEXPORT libtrace_err_t trace_get_err(libtrace_t *trace);
790
791/** Return if there is an error
792 * @param trace         the trace file to check the error state on
793 * This does not clear the error status, and only returns true or false.
794 */
795DLLEXPORT bool trace_is_err(libtrace_t *trace);
796
797/** Output an error message to stderr and clear the error status.
798 * @param trace         the trace with the error to output
799 * @param msg           the message to prefix to the error
800 * This function does clear the error status.
801 */
802DLLEXPORT void trace_perror(libtrace_t *trace, const char *msg,...) PRINTF(2,3);
803
804/** Check (and clear) the current error state of an output trace
805 * @param trace         the output trace file to check the error state on
806 * @return Error report
807 * This reads and returns the current error state and sets the current error
808 * to "no error".
809 */
810DLLEXPORT libtrace_err_t trace_get_err_output(libtrace_out_t *trace);
811
812/** Return if there is an error
813 * @param trace         the trace file to check the error state on
814 * This does not clear the error status, and only returns true or false.
815 */
816DLLEXPORT bool trace_is_err_output(libtrace_out_t *trace);
817
818/** Output an error message to stderr and clear the error status.
819 * @param trace         the trace with the error to output
820 * @param msg           the message to prefix to the error
821 * This function does clear the error status.
822 */
823DLLEXPORT void trace_perror_output(libtrace_out_t *trace, const char *msg,...)
824        PRINTF(2,3);
825
826
827/*@}*/
828
829/** @name Reading/Writing packets
830 * These members deal with creating, reading and writing packets
831 *
832 * @{
833 */
834
835/** Create a new packet object
836 *
837 * @return a pointer to an initialised libtrace_packet_t object
838 */
839DLLEXPORT libtrace_packet_t *trace_create_packet(void);
840
841/** Copy a packet
842 * @param packet        the source packet to copy
843 * @return a new packet which has the same content as the source packet
844 * @note This always involves a copy, which can be slow.  Use of this
845 * function should be avoided where possible.
846 * @par The reason you would want to use this function is that a zerocopied
847 * packet from a device is using the devices memory which may be a limited
848 * resource.  Copying the packet will cause it to be copied into the systems
849 * memory.
850 */
851DLLEXPORT libtrace_packet_t *trace_copy_packet(const libtrace_packet_t *packet);
852
853/** Destroy a packet object
854 *
855 * sideeffect: sets packet to NULL
856 */
857DLLEXPORT void trace_destroy_packet(libtrace_packet_t *packet);
858
859
860/** Read one packet from the trace
861 *
862 * @param trace         the libtrace opaque pointer
863 * @param packet        the packet opaque pointer
864 * @return 0 on EOF, negative value on error, number of bytes read when
865 * successful.
866 *
867 * @note the number of bytes read is usually (but not always) the same as
868 * trace_get_framing_length()+trace_get_capture_length() depending on the
869 * trace format.
870 * @note the trace must have been started with trace_start before calling
871 * this function
872 */
873DLLEXPORT int trace_read_packet(libtrace_t *trace, libtrace_packet_t *packet);
874
875/** Event types
876 * see \ref libtrace_eventobj_t and \ref trace_event
877 */
878typedef enum {
879        TRACE_EVENT_IOWAIT,     /**< Need to block on fd */
880        TRACE_EVENT_SLEEP,      /**< Sleep for some time */
881        TRACE_EVENT_PACKET,     /**< packet has arrived */
882        TRACE_EVENT_TERMINATE   /**< End of trace */
883} libtrace_event_t;
884
885/** Structure returned by libtrace_event explaining what the current event is */
886typedef struct libtrace_eventobj_t {
887        libtrace_event_t type; /**< event type (iowait,sleep,packet) */
888        int fd;                /**< if IOWAIT, the fd to sleep on */
889        double seconds;        /**< if SLEEP, the amount of time to sleep for
890                                */
891        int size;              /**< if PACKET, the value returned from
892                                *  trace_read_packet
893                                */
894} libtrace_eventobj_t;
895
896/** Processes the next libtrace event
897 * @param trace the libtrace opaque pointer
898 * @param packet the libtrace_packet opaque pointer
899 * @return libtrace_event struct containing the type, and potential
900 *      fd or seconds to sleep on
901 *
902 * Type can be:
903 *  TRACE_EVENT_IOWAIT  Waiting on I/O on fd
904 *  TRACE_EVENT_SLEEP   Next event in seconds
905 *  TRACE_EVENT_PACKET  Packet arrived in buffer with size size
906 *  TRACE_EVENT_TERMINATE Trace terminated (perhaps with an error condition)
907 */
908DLLEXPORT libtrace_eventobj_t trace_event(libtrace_t *trace,
909                libtrace_packet_t *packet);
910
911
912/** Write one packet out to the output trace
913 *
914 * @param trace         the libtrace_out opaque pointer
915 * @param packet        the packet opaque pointer
916 * @return the number of bytes written out, if zero or negative then an error has occured.
917 */
918DLLEXPORT int trace_write_packet(libtrace_out_t *trace, libtrace_packet_t *packet);
919/*@}*/
920
921/** @name Protocol decodes
922 * These functions locate and return a pointer to various headers inside a
923 * packet
924 * @{
925 */
926
927/** get a pointer to the link layer
928 * @param packet        the packet opaque pointer
929 *
930 * @return a pointer to the link layer, or NULL if there is no link layer
931 *
932 * @note you should call trace_get_link_type to find out what type of link
933 * layer this is
934 */
935DLLEXPORT SIMPLE_FUNCTION
936void *trace_get_link(const libtrace_packet_t *packet);
937
938/** get a pointer to the IP header (if any)
939 * @param packet        the packet opaque pointer
940 *
941 * @return a pointer to the IP header, or NULL if there is no IP header
942 */
943DLLEXPORT SIMPLE_FUNCTION
944libtrace_ip_t *trace_get_ip(libtrace_packet_t *packet);
945
946/** get a pointer to the IPv6 header (if any)
947 * @param packet        the packet opaque pointer
948 *
949 * @return a pointer to the IPv6 header, or NULL if there is no IPv6 header
950 */
951DLLEXPORT SIMPLE_FUNCTION
952libtrace_ip6_t *trace_get_ip6(libtrace_packet_t *packet);
953
954/** Gets a pointer to the transport layer header (if any)
955 * @param packet        a pointer to a libtrace_packet structure
956 * @param[out] proto    transport layer protocol
957 *
958 * @return a pointer to the transport layer header, or NULL if there is no header
959 *
960 * @note proto may be NULL if proto is unneeded.
961 */
962DLLEXPORT void *trace_get_transport(libtrace_packet_t *packet, uint8_t *proto,
963                uint32_t *remaining);
964
965/** Gets a pointer to the payload given a pointer to the IP header
966 * @param ip            The IP Header
967 * @param[out] proto    An output variable of the IP protocol
968 * @param[in,out] remaining Updated with the number of bytes remaining
969 *
970 * @return a pointer to the transport layer header, or NULL if header isn't present.
971 *
972 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
973 * of bytes captured of the IP header and beyond.  It will be updated after this
974 * function to the number of bytes remaining after the IP header (and any IP options)
975 * have been removed.
976 *
977 * proto may be NULL if not needed.
978 *
979 * @note This is similar to trace_get_transport_from_ip in libtrace2
980 */
981DLLEXPORT void *trace_get_payload_from_ip(libtrace_ip_t *ip, uint8_t *proto,
982                uint32_t *remaining);
983
984/** Gets a pointer to the payload given a pointer to the IPv6 header
985 * @param ipptr         The IPv6 Header
986 * @param[out] proto    An output variable of the protocol of the next header
987 * @param[in,out] remaining Updated with the number of bytes remaining
988 *
989 * @return a pointer to the transport layer header, or NULL if the IPv6 header isn't complete.
990 *
991 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
992 * of bytes captured of the IP header and beyond.  It will be updated after this
993 * function to the number of bytes remaining after the IP header (and any IP options)
994 * have been removed.
995 *
996 * proto may be NULL if not needed.
997 *
998 */
999DLLEXPORT void *trace_get_payload_from_ip6(libtrace_ip6_t *ipptr,
1000                uint8_t *prot, uint32_t *remaining);
1001
1002/** Gets a pointer to the payload given a pointer to the link header
1003 * @param ip            The link pointer
1004 * @param[out] type     An output variable of the ethernet type
1005 * @param[in,out] remaining Updated with the number of bytes remaining
1006 *
1007 * @return a pointer to the transport layer header, or NULL if header isn't
1008 * present.
1009 *
1010 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
1011 * of bytes captured of the linklayer and beyond.  It will be updated after
1012 * this function to the number of bytes remaining after the IP header (and any
1013 * IP options) have been removed.
1014 *
1015 * type may be NULL if not needed.
1016 *
1017 */
1018DLLEXPORT void *trace_get_payload_from_link(void *linkptr,
1019                libtrace_linktype_t linktype,
1020                uint16_t *type, uint32_t *remaining);
1021
1022/** Skips over any 802.1q headers, if present.
1023 * @param ethernet      A pointer to the payload following an ethernet header -usually the result of calling trace_get_payload_from_link
1024 * @param[in,out] type  The ethernet type, replaced with the vlan ether type
1025 * @param[in,out] remaining Updated with the number of bytes remaining
1026 *
1027 * @return a pointer to the header beyond the vlan header, if present.
1028 * Otherwise, returns the ethernet payload that was passed in
1029 *
1030 * Remaining may be NULL. If Remaining is not NULL it must point to the number
1031 * of bytes captured past (but not including) the link layer. It will be
1032 * updated after this function to the number of bytes remaining after the
1033 * vlan header. If it is unchanged then no vlan header exists.
1034 *
1035 * Type must point to the value of the ethernet type. Libtrace will assert
1036 * fail if type is NULL.
1037 *
1038 */
1039DLLEXPORT void *trace_get_vlan_payload_from_ethernet_payload(
1040                void *ethernet_payload, uint16_t *type, uint32_t *remaining);
1041
1042/** Gets a pointer to the payload given a pointer to a tcp header
1043 * @param tcp           The tcp Header
1044 * @param[in,out] remaining Updated with the number of bytes remaining
1045 *
1046 * @return a pointer to the tcp payload, or NULL if the payload isn't present.
1047 *
1048 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
1049 * of bytes captured of the TCP header and beyond.  It will be updated after this
1050 * function to the number of bytes remaining after the TCP header (and any TCP options)
1051 * have been removed.
1052 *
1053 * @note This is similar to trace_get_transport_from_ip in libtrace2
1054 */
1055DLLEXPORT void *trace_get_payload_from_tcp(libtrace_tcp_t *tcp, uint32_t *remaining);
1056
1057/** Gets a pointer to the payload given a pointer to a udp header
1058 * @param udp           The udp Header
1059 * @param[in,out] remaining Updated with the number of bytes remaining
1060 *
1061 * @return a pointer to the udp payload, or NULL if the payload isn't present.
1062 *
1063 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
1064 * of bytes captured of the TCP header and beyond.  It will be updated after this
1065 * function to the number of bytes remaining after the TCP header (and any TCP options)
1066 * have been removed.
1067 *
1068 * @note This is similar trace_get_transport_from_ip in libtrace2
1069 */
1070DLLEXPORT void *trace_get_payload_from_udp(libtrace_udp_t *udp, uint32_t *remaining);
1071
1072/** Gets a pointer to the payload given a pointer to a icmp header
1073 * @param icmp          The icmp Header
1074 * @param[in,out] remaining Updated with the number of bytes remaining
1075 *
1076 * @return a pointer to the icmp payload, or NULL if the payload isn't present.
1077 *
1078 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
1079 * of bytes captured of the TCP header and beyond.  It will be updated after this
1080 * function to the number of bytes remaining after the TCP header (and any TCP options)
1081 * have been removed.
1082 *
1083 * @note This is similar to trace_get_payload_from_icmp in libtrace2
1084 */
1085DLLEXPORT void *trace_get_payload_from_icmp(libtrace_icmp_t *icmp, uint32_t *remaining);
1086
1087/** get a pointer to the TCP header (if any)
1088 * @param packet        the packet opaque pointer
1089 *
1090 * @return a pointer to the TCP header, or NULL if there is not a TCP packet
1091 */
1092DLLEXPORT SIMPLE_FUNCTION
1093libtrace_tcp_t *trace_get_tcp(libtrace_packet_t *packet);
1094
1095/** get a pointer to the TCP header (if any) given a pointer to the IP header
1096 * @param ip            The IP header
1097 * @param[in,out] remaining Updated with the number of bytes remaining
1098 *
1099 * @return a pointer to the TCP header, or NULL if this is not a TCP packet
1100 *
1101 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
1102 * of bytes captured of the TCP header and beyond.  It will be updated after this
1103 * function to the number of bytes remaining after the TCP header (and any TCP options)
1104 * have been removed.
1105 *
1106 * @note The last parameter has changed from libtrace2
1107 */
1108DLLEXPORT SIMPLE_FUNCTION
1109libtrace_tcp_t *trace_get_tcp_from_ip(libtrace_ip_t *ip, uint32_t *remaining);
1110
1111/** get a pointer to the UDP header (if any)
1112 * @param packet        the packet opaque pointer
1113 *
1114 * @return a pointer to the UDP header, or NULL if this is not a UDP packet
1115 */
1116DLLEXPORT SIMPLE_FUNCTION
1117libtrace_udp_t *trace_get_udp(libtrace_packet_t *packet);
1118
1119/** get a pointer to the UDP header (if any) given a pointer to the IP header
1120 * @param       ip      The IP header
1121 * @param[in,out] remaining Updated with the number of bytes remaining
1122 *
1123 * @return a pointer to the UDP header, or NULL if this is not an UDP packet
1124 *
1125 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
1126 * of bytes captured of the TCP header and beyond.  It will be updated after this
1127 * function to the number of bytes remaining after the TCP header (and any TCP options)
1128 * have been removed.
1129 *
1130 * @note Beware the change from libtrace2 from skipped to remaining
1131 */
1132DLLEXPORT SIMPLE_FUNCTION
1133libtrace_udp_t *trace_get_udp_from_ip(libtrace_ip_t *ip,uint32_t *remaining);
1134
1135/** get a pointer to the ICMP header (if any)
1136 * @param packet        the packet opaque pointer
1137 *
1138 * @return a pointer to the ICMP header, or NULL if this is not a ICMP packet
1139 */
1140DLLEXPORT SIMPLE_FUNCTION
1141libtrace_icmp_t *trace_get_icmp(libtrace_packet_t *packet);
1142
1143/** get a pointer to the ICMP header (if any) given a pointer to the IP header
1144 * @param ip            The IP header
1145 * @param[in,out] remaining Updated with the number of bytes remaining
1146 *
1147 * @return a pointer to the ICMP header, or NULL if this is not an ICMP packet
1148 *
1149 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
1150 * of bytes captured of the TCP header and beyond.  It will be updated after this
1151 * function to the number of bytes remaining after the TCP header (and any TCP options)
1152 * have been removed.
1153 *
1154 * @note Beware the change from libtrace2 from skipped to remaining
1155 */
1156DLLEXPORT SIMPLE_FUNCTION
1157libtrace_icmp_t *trace_get_icmp_from_ip(libtrace_ip_t *ip,uint32_t *remaining);
1158
1159/** Get the destination MAC address
1160 * @param packet        the packet opaque pointer
1161 * @return a pointer to the destination mac, (or NULL if there is no
1162 * destination MAC)
1163 */
1164DLLEXPORT SIMPLE_FUNCTION
1165uint8_t *trace_get_destination_mac(libtrace_packet_t *packet);
1166
1167/** Get the source MAC address
1168 * @param packet        the packet opaque pointer
1169 * @return a pointer to the source mac, (or NULL if there is no source MAC)
1170 */
1171DLLEXPORT SIMPLE_FUNCTION
1172uint8_t *trace_get_source_mac(libtrace_packet_t *packet);
1173
1174/** Get the source IP address
1175 * @param packet        the packet opaque pointer
1176 * @param addr          a pointer to a sockaddr to store the address in, or NULL to use
1177 *                      static storage.
1178 * @return NULL if there is no source address, or a sockaddr holding a v4 or v6 address
1179 */
1180DLLEXPORT SIMPLE_FUNCTION
1181struct sockaddr *trace_get_source_address(const libtrace_packet_t *packet,
1182                struct sockaddr *addr);
1183
1184/** Get the destination IP address
1185 * @param packet        the packet opaque pointer
1186 * @param addr          a pointer to a sockaddr to store the address in, or NULL to use
1187 *                      static storage.
1188 * @return NULL if there is no destination address, or a sockaddr holding a v4 or v6 address
1189 */
1190DLLEXPORT SIMPLE_FUNCTION
1191struct sockaddr *trace_get_destination_address(const libtrace_packet_t *packet,
1192                struct sockaddr *addr);
1193
1194/*@}*/
1195
1196/** parse an ip or tcp option
1197 * @param[in,out] ptr   the pointer to the current option
1198 * @param[in,out] len   the length of the remaining buffer
1199 * @param[out] type     the type of the option
1200 * @param[out] optlen   the length of the option
1201 * @param[out] data     the data of the option
1202 *
1203 * @return bool true if there is another option (and the fields are filled in)
1204 *               or false if this was the last option.
1205 *
1206 * This updates ptr to point to the next option after this one, and updates
1207 * len to be the number of bytes remaining in the options area.  Type is updated
1208 * to be the code of this option, and data points to the data of this option,
1209 * with optlen saying how many bytes there are.
1210 *
1211 * @note Beware of fragmented packets.
1212 */
1213DLLEXPORT int trace_get_next_option(unsigned char **ptr,int *len,
1214                        unsigned char *type,
1215                        unsigned char *optlen,
1216                        unsigned char **data);
1217
1218
1219/** @name Time
1220 * These functions deal with time that a packet arrived and return it
1221 * in various formats
1222 * @{
1223 */
1224/** Get the current time in DAG time format
1225 * @param packet        the packet opaque pointer
1226 *
1227 * @return a 64 bit timestamp in DAG ERF format (upper 32 bits are the seconds
1228 * past 1970-01-01, the lower 32bits are partial seconds)
1229 */
1230DLLEXPORT SIMPLE_FUNCTION
1231uint64_t trace_get_erf_timestamp(const libtrace_packet_t *packet);
1232
1233/** Get the current time in struct timeval
1234 * @param packet        the packet opaque pointer
1235 *
1236 * @return time that this packet was seen in a struct timeval
1237 */
1238DLLEXPORT SIMPLE_FUNCTION
1239struct timeval trace_get_timeval(const libtrace_packet_t *packet);
1240
1241/** Get the current time in floating point seconds
1242 * @param packet        the packet opaque pointer
1243 *
1244 * @return time that this packet was seen in 64bit floating point seconds
1245 */
1246DLLEXPORT SIMPLE_FUNCTION
1247double trace_get_seconds(const libtrace_packet_t *packet);
1248
1249/** Seek within a trace
1250 * @param trace         trace to seek
1251 * @param seconds       time to seek to
1252 * @return 0 on success.
1253 * Make the next packet read to be the first packet to occur at or after the
1254 * time searched for.  This must be called in the configuration state (ie,
1255 * before trace_start() or after trace_pause().
1256 * @note This function may be extremely slow.
1257 */
1258DLLEXPORT int trace_seek_seconds(libtrace_t *trace, double seconds);
1259
1260/** Seek within a trace
1261 * @param trace         trace to seek
1262 * @param tv            time to seek to
1263 * @return 0 on success.
1264 * Make the next packet read to be the first packet to occur at or after the
1265 * time searched for.  This must be called in the configuration state (ie,
1266 * before trace_start() or after trace_pause().
1267 * @note This function may be extremely slow.
1268 */
1269DLLEXPORT int trace_seek_timeval(libtrace_t *trace, struct timeval tv);
1270
1271/** Seek within a trace
1272 * @param trace         trace to seek
1273 * @param ts            erf timestamp
1274 * @return 0 on success.
1275 * Make the next packet read to be the first packet to occur at or after the
1276 * time searched for.  This must be called in the configuration state (ie,
1277 * before trace_start() or after trace_pause().
1278 * @note This function may be extremely slow.
1279 */
1280DLLEXPORT int trace_seek_erf_timestamp(libtrace_t *trace, uint64_t ts);
1281
1282/*@}*/
1283
1284/** @name Sizes
1285 * This section deals with finding or setting the various different lengths
1286 * a packet can have
1287 * @{
1288 */
1289/** Get the size of the packet in the trace
1290 * @param packet        the packet opaque pointer
1291 * @return the size of the packet in the trace
1292 * @note Due to this being a header capture, or anonymisation, this may not
1293 * be the same size as the original packet.  See get_wire_length() for the
1294 * original size of the packet.
1295 * @note This can (and often is) different for different packets in a trace!
1296 * @note This is sometimes called the "snaplen".
1297 * @note The return size refers to the network-level payload of the packet and
1298 * does not include any capture framing headers. For example, an Ethernet
1299 * packet with an empty TCP packet will return sizeof(ethernet_header) +
1300 * sizeof(ip_header) + sizeof(tcp_header).
1301 */
1302DLLEXPORT SIMPLE_FUNCTION
1303size_t trace_get_capture_length(const libtrace_packet_t *packet);
1304
1305/** Get the size of the packet as it was seen on the wire.
1306 * @param packet        the packet opaque pointer
1307 * @return the size of the packet as it was on the wire.
1308 * @note Due to the trace being a header capture, or anonymisation this may
1309 * not be the same as the Capture Len.
1310 * @note trace_getwire_length \em{includes} FCS.
1311 */
1312DLLEXPORT SIMPLE_FUNCTION
1313size_t trace_get_wire_length(const libtrace_packet_t *packet);
1314
1315/** Get the length of the capture framing headers.
1316 * @param packet        the packet opaque pointer
1317 * @return the size of the packet as it was on the wire.
1318 * @note this length corresponds to the difference between the size of a
1319 * captured packet in memory, and the captured length of the packet
1320 */
1321DLLEXPORT SIMPLE_FUNCTION
1322size_t trace_get_framing_length(const libtrace_packet_t *packet);
1323
1324/** Truncate ("snap") the packet at the suggested length
1325 * @param packet        the packet opaque pointer
1326 * @param size          the new length of the packet
1327 * @return the new capture length of the packet, or the original capture
1328 * length of the packet if unchanged
1329 */
1330DLLEXPORT size_t trace_set_capture_length(libtrace_packet_t *packet, size_t size);
1331
1332/*@}*/
1333
1334
1335/** Get the type of the link layer
1336 * @param packet        the packet opaque pointer
1337 * @return libtrace_linktype_t
1338 */
1339DLLEXPORT SIMPLE_FUNCTION
1340libtrace_linktype_t trace_get_link_type(const libtrace_packet_t *packet);
1341
1342/** Set the direction flag, if it has one
1343 * @param packet        the packet opaque pointer
1344 * @param direction     the new direction
1345 * @returns -1 on error, or the direction that was set.
1346 */
1347DLLEXPORT libtrace_direction_t trace_set_direction(libtrace_packet_t *packet, libtrace_direction_t direction);
1348
1349/** Get the direction flag, if it has one
1350 * @param packet        the packet opaque pointer
1351 * @return a value containing the direction flag, or -1 if this is not supported
1352 * The direction is defined as 0 for packets originating locally (ie, outbound)
1353 * and 1 for packets originating remotely (ie, inbound).
1354 * Other values are possible, which might be overloaded to mean special things
1355 * for a special trace.
1356 */
1357DLLEXPORT SIMPLE_FUNCTION
1358libtrace_direction_t trace_get_direction(const libtrace_packet_t *packet);
1359
1360/** @name BPF
1361 * This section deals with using Berkley Packet Filters
1362 * @{
1363 */
1364/** setup a BPF filter
1365 * @param filterstring a char * containing the bpf filter string
1366 * @return opaque pointer pointer to a libtrace_filter_t object
1367 * @note The filter is not actually compiled at this point, so no correctness
1368 * tests are performed here. trace_create_filter will always return ok, but
1369 * if the filter is poorly constructed an error will be generated when the
1370 * filter is actually used
1371 */
1372DLLEXPORT SIMPLE_FUNCTION
1373libtrace_filter_t *trace_create_filter(const char *filterstring);
1374
1375/** apply a BPF filter
1376 * @param filter        the filter opaque pointer
1377 * @param packet        the packet opaque pointer
1378 * @return >0 if the filter matches, 0 if it doesn't, -1 on error.
1379 * @note Due to the way BPF filters are built, the filter is not actually
1380 * compiled until the first time trace_create_filter is called. If your filter
1381 * is incorrect, it will generate an error message and assert, exiting the
1382 * program. This behaviour may change to more graceful handling of this error
1383 * in the future.
1384 */
1385DLLEXPORT int trace_apply_filter(libtrace_filter_t *filter,
1386                const libtrace_packet_t *packet);
1387
1388/** destory of BPF filter
1389 * @param filter        the filter opaque pointer
1390 * Deallocate all the resources associated with a BPF filter
1391 */
1392DLLEXPORT void trace_destroy_filter(libtrace_filter_t *filter);
1393/*@}*/
1394
1395/** @name Portability
1396 * This section has functions that causes annoyances to portability for one
1397 * reason or another.
1398 * @{
1399 */
1400
1401/** Convert an ethernet address to a string
1402 * @param addr  Ethernet address in network byte order
1403 * @param buf   Buffer to store the ascii representation, or NULL
1404 * @return buf, or if buf is NULL then a statically allocated buffer.
1405 *
1406 * This function is similar to the GNU ether_ntoa_r function, with a few
1407 * minor differences.  if NULL is passed as buf, then the function will
1408 * use an internal static buffer, if NULL isn't passed then the function
1409 * will use that buffer instead.
1410 *
1411 * @note the type of addr isn't struct ether_addr as it is with ether_ntoa_r,
1412 * however it is bit compatible so that a cast will work.
1413 */
1414DLLEXPORT char *trace_ether_ntoa(const uint8_t *addr, char *buf);
1415
1416/** Convert a string to an ethernet address
1417 * @param buf   Ethernet address in hex format delimited with :'s.
1418 * @param addr  buffer to store the binary representation, or NULL
1419 * @return addr, or if addr is NULL, then a statically allocated buffer.
1420 *
1421 * This function is similar to the GNU ether_aton_r function, with a few
1422 * minor differences.  if NULL is passed as addr, then the function will
1423 * use an internal static buffer, if NULL isn't passed then the function will
1424 * use that buffer instead.
1425 *
1426 * @note the type of addr isn't struct ether_addr as it is with ether_aton_r,
1427 * however it is bit compatible so that a cast will work.
1428 */
1429DLLEXPORT uint8_t *trace_ether_aton(const char *buf, uint8_t *addr);
1430
1431/*@}*/
1432
1433
1434/** Which port is the server port */
1435typedef enum {
1436        USE_DEST,       /**< Destination port is the server port */
1437        USE_SOURCE      /**< Source port is the server port */
1438} serverport_t;
1439
1440/** Get the source port
1441 * @param packet        the packet to read from
1442 * @return a port in \em HOST byte order, or equivalent to ports for this
1443 * protocol, or 0 if this protocol has no ports.
1444 */
1445DLLEXPORT SIMPLE_FUNCTION
1446uint16_t trace_get_source_port(const libtrace_packet_t *packet);
1447
1448/** Get the destination port
1449 * @param packet        the packet to read from
1450 * @return a port in \em HOST byte order, or equivilent to ports for this
1451 * protocol, or 0 if this protocol has no ports.
1452 */
1453DLLEXPORT SIMPLE_FUNCTION
1454uint16_t trace_get_destination_port(const libtrace_packet_t *packet);
1455
1456/** hint at the server port in specified protocol
1457 * @param protocol      the IP layer protocol, eg 6 (tcp), 17 (udp)
1458 * @param source        the source port from the packet
1459 * @param dest          the destination port from the packet
1460 * @return one of USE_SOURCE or USE_DEST depending on which one you should use
1461 * @note ports must be in \em HOST byte order!
1462 */
1463DLLEXPORT SIMPLE_FUNCTION
1464int8_t trace_get_server_port(uint8_t protocol, uint16_t source, uint16_t dest);
1465
1466/** Takes a uri and splits it into a format and uridata component.
1467 * @param uri           the uri to be parsed
1468 * @param format        destination location for the format component of the uri
1469 * @return 0 if an error occured, otherwise return the uridata component
1470 */
1471DLLEXPORT const char *trace_parse_uri(const char *uri, char **format);
1472
1473/** Gets the format type for a given packet.
1474 * @param packet        the packet opaque pointer
1475 * @return the format of the packet
1476 */
1477DLLEXPORT
1478enum base_format_t trace_get_format(struct libtrace_packet_t *packet);
1479
1480/** Construct a packet from a buffer.
1481 * @param packet[in,out]        Libtrace Packet object to update with the new
1482 *                              data.
1483 * @param linktype              The linktype of the packet.
1484 * @param[in] data              The packet data (including linklayer)
1485 * @param len                   Length of packet data
1486 */
1487DLLEXPORT
1488void trace_construct_packet(libtrace_packet_t *packet,
1489                libtrace_linktype_t linktype, const void *data, uint16_t len);
1490
1491/*@}*/
1492
1493/** @name Wireless trace support
1494 * Functions to access wireless information from packets that have wireless
1495 * monitoring headers such as Radiotap or Prism.
1496 *
1497 * The trace_get_wireless_* functions provide an abstract interface for
1498 * retrieving information from wireless traces. They take a pointer to the
1499 * wireless monitoring header (usually found with trace_get_link(packet)) and
1500 * the linktype of the header passed in.
1501 *
1502 * All of the trace_get_wireless_* functions return false if the requested
1503 * information was unavailable, or true if it was. The actual data is stored
1504 * in an output variable supplied by the caller. Values returned into the
1505 * output variable will always be returned in host byte order.
1506 * @{
1507 */
1508
1509
1510#ifndef ARPHRD_80211_RADIOTAP
1511/* libc doesn't define this yet, but it seems to be what everyone is using
1512 */
1513#define ARPHRD_80211_RADIOTAP 803
1514#endif
1515
1516/** Get the wireless Timer Syncronisation Function
1517 *
1518 * Gets the value of the timer syncronisation function for this frame, which
1519 * is a value in microseconds indicating the time that the first bit of the
1520 * MPDU was received by the MAC.
1521 *
1522 * @param link the wireless header
1523 * @param linktype the linktype of the wireless header passed in
1524 * @param[out] tsft the value of the timer syncronisation function.
1525 * @return true if the field was available, false if not.
1526 */
1527DLLEXPORT bool trace_get_wireless_tsft(void *linkptr,
1528        libtrace_linktype_t linktype, uint64_t *tsft);
1529
1530/** Get the wireless rate
1531 * @param link the wireless header
1532 * @param linktype the linktype of the wireless header passed in
1533 * @param[out] rate the data-rate of the frame in units of 500kbps
1534 * @return true if the field was available, false if not.
1535 */
1536DLLEXPORT bool trace_get_wireless_rate(void *linkptr,
1537        libtrace_linktype_t linktype, uint8_t *rate);
1538
1539/** Get the wireless channel frequency
1540 * @param link the wireless header
1541 * @param linktype the linktype of the wireless header passed in
1542 * @param[out] freq the frequency in MHz of the channel the frame was transmitted
1543 * or received on.
1544 * @return true if the field was available, false if not.
1545 */
1546DLLEXPORT bool trace_get_wireless_freq(void *linkptr,
1547        libtrace_linktype_t linktype, uint16_t *freq);
1548
1549/** Get the wireless signal strength in dBm
1550 * @param link the wireless header
1551 * @param linktype the linktype of the wireless header passed in
1552 * @param[out] strength the RF signal power at the antenna, in dB difference
1553 * from 1mW.
1554 * @return true if the field was available, false if not.
1555 */
1556DLLEXPORT bool trace_get_wireless_signal_strength_dbm(void *linkptr,
1557        libtrace_linktype_t linktype, int8_t *strength);
1558
1559/** Get the wireless noise strength in dBm
1560 * @param link the wireless header
1561 * @param linktype the linktype of the wireless header passed in
1562 * @param[out] strength the RF noise power at the antenna, in dB difference
1563 * from 1mW.
1564 * @return true if the field was available, false if not.
1565 */
1566DLLEXPORT bool trace_get_wireless_noise_strength_dbm(void *linkptr,
1567        libtrace_linktype_t linktype, int8_t *strength);
1568
1569/** Get the wireless signal strength in dB
1570 * @param link the wireless header
1571 * @param linktype the linktype of the wireless header passed in
1572 * @param[out] strength the RF signal power at the antenna,in dB difference
1573 * from a fixed reference.
1574 * @return true if the field was available, false if not.
1575 */
1576DLLEXPORT bool trace_get_wireless_signal_strength_db(void *linkptr,
1577        libtrace_linktype_t linktype, uint8_t *strength);
1578
1579/** Get the wireless noise strength in dB
1580 * @param link the wireless header
1581 * @param linktype the linktype of the wireless header passed in
1582 * @param[out] strength the RF noise power at the antenna, in dB difference
1583 * from a fixed reference.
1584 * @return true if the field was available, false if not.
1585 */
1586DLLEXPORT bool trace_get_wireless_noise_strength_db(void *linkptr,
1587        libtrace_linktype_t linktype, uint8_t *strength);
1588
1589/** Get the wireless transmit attenuation
1590 * @param link the wireless header
1591 * @param linktype the linktype of the wireless header passed in
1592 * @param[out] attenuation the transmit power as a unitless distance from maximum
1593 * power set at factory calibration. 0 indicates maximum transmission power.
1594 * @return true if the field was available, false if not.
1595 */
1596DLLEXPORT bool trace_get_wireless_tx_attenuation(void *linkptr,
1597        libtrace_linktype_t linktype, uint16_t *attenuation);
1598
1599/** Get the wireless transmit attenuation in dB
1600 * @param link the wireless header
1601 * @param linktype the linktype of the wireless header passed in
1602 * @param[out] attenuation the transmit power as dB difference from maximum power
1603 * set at factory calibration. 0 indicates maximum power.
1604 * @return true if the field was available, false if not.
1605 */
1606DLLEXPORT bool trace_get_wireless_tx_attenuation_db(void *linkptr,
1607        libtrace_linktype_t linktype, uint16_t *attenuation);
1608
1609/** Get the wireless transmit power in dBm @param link the wireless header
1610 * @param linktype the linktype of the wireless header passed in
1611 * @param[out] txpower the transmit power as dB from a 1mW reference. This is the absolute power level measured at the antenna port. 
1612 * @return true if the field was available, false if not.
1613 */
1614DLLEXPORT bool trace_get_wireless_tx_power_dbm(void *linkptr, libtrace_linktype_t
1615                linktype, int8_t *txpower);
1616
1617/** Get the wireless antenna
1618 * @param link the wireless header
1619 * @param linktype the linktype of the wireless header passed in
1620 * @param[out] antenna which antenna was used to transmit or receive the frame.
1621 * @return true if the field was available, false if not.
1622 */
1623DLLEXPORT bool trace_get_wireless_antenna(void *linkptr,
1624        libtrace_linktype_t linktype, uint8_t *antenna);
1625
1626/*@}*/
1627
1628#ifdef __cplusplus
1629} /* extern "C" */
1630#endif /* #ifdef __cplusplus */
1631#endif /* LIBTRACE_H_ */
Note: See TracBrowser for help on using the repository browser.