source: lib/libtrace.h.in @ e01a738

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since e01a738 was e01a738, checked in by Perry Lorier <perry@…>, 14 years ago

Add support for tsh: trace formats (as braindead as they are)

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