wiretap/wtap.h

   1 /* wtap.h
   2  *
   3  * $Id$
   4  *
   5  * Wiretap Library
   6  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21  */
  22
  23 #ifndef __WTAP_H__
  24 #define __WTAP_H__
  25
  26 #ifdef HAVE_SYS_TIME_H
  27 #include <sys/time.h>
  28 #endif
  29
  30 #include <glib.h>
  31 #include <time.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif /* __cplusplus */
  36
  37 /* Encapsulation types. Choose names that truly reflect
  38  * what is contained in the packet trace file.
  39  *
  40  * WTAP_ENCAP_PER_PACKET is a value passed to "wtap_dump_open()" or
  41  * "wtap_dump_fd_open()" to indicate that there is no single encapsulation
  42  * type for all packets in the file; this may cause those routines to
  43  * fail if the capture file format being written can't support that.
  44  * It's also returned by "wtap_file_encap()" for capture files that
  45  * don't have a single encapsulation type for all packets in the file.
  46  *
  47  * WTAP_ENCAP_UNKNOWN is returned by "wtap_pcap_encap_to_wtap_encap()"
  48  * if it's handed an unknown encapsulation.
  49  *
  50  * WTAP_ENCAP_FDDI_BITSWAPPED is for FDDI captures on systems where the
  51  * MAC addresses you get from the hardware are bit-swapped.  Ideally,
  52  * the driver would tell us that, but I know of none that do, so, for
  53  * now, we base it on the machine on which we're *reading* the
  54  * capture, rather than on the machine on which the capture was taken
  55  * (they're probably likely to be the same).  We assume that they're
  56  * bit-swapped on everything except for systems running Ultrix, Alpha
  57  * systems, and BSD/OS systems (that's what "tcpdump" does; I guess
  58  * Digital decided to bit-swap addresses in the hardware or in the
  59  * driver, and I guess BSDI bit-swapped them in the driver, given that
  60  * BSD/OS generally runs on Boring Old PC's).  If we create a wiretap
  61  * save file format, we'd use the WTAP_ENCAP values to flag the
  62  * encapsulation of a packet, so there we'd at least be able to base
  63  * it on the machine on which the capture was taken.
  64  *
  65  * WTAP_ENCAP_LINUX_ATM_CLIP is the encapsulation you get with the
  66  * ATM on Linux code from <http://linux-atm.sourceforge.net/>;
  67  * that code adds a DLT_ATM_CLIP DLT_ code of 19, and that
  68  * encapsulation isn't the same as the DLT_ATM_RFC1483 encapsulation
  69  * presumably used on some BSD systems, which we turn into
  70  * WTAP_ENCAP_ATM_RFC1483.
  71  *
  72  * WTAP_ENCAP_NULL corresponds to DLT_NULL from "libpcap".  This
  73  * corresponds to
  74  *
  75  *      1) PPP-over-HDLC encapsulation, at least with some versions
  76  *         of ISDN4BSD (but not the current ones, it appears, unless
  77  *         I've missed something);
  78  *
  79  *      2) a 4-byte header containing the AF_ address family, in
  80  *         the byte order of the machine that saved the capture,
  81  *         for the packet, as used on many BSD systems for the
  82  *         loopback device and some other devices, or a 4-byte header
  83  *         containing the AF_ address family in network byte order,
  84  *         as used on recent OpenBSD systems for the loopback device;
  85  *
  86  *      3) a 4-byte header containing 2 octets of 0 and an Ethernet
  87  *         type in the byte order from an Ethernet header, that being
  88  *         what older versions of "libpcap" on Linux turn the Ethernet
  89  *         header for loopback interfaces into (0.6.0 and later versions
  90  *         leave the Ethernet header alone and make it DLT_EN10MB). */
  91 #define WTAP_ENCAP_PER_PACKET                   -1
  92 #define WTAP_ENCAP_UNKNOWN                      0
  93 #define WTAP_ENCAP_ETHERNET                     1
  94 #define WTAP_ENCAP_TOKEN_RING                   2
  95 #define WTAP_ENCAP_SLIP                         3
  96 #define WTAP_ENCAP_PPP                          4
  97 #define WTAP_ENCAP_FDDI                         5
  98 #define WTAP_ENCAP_FDDI_BITSWAPPED              6
  99 #define WTAP_ENCAP_RAW_IP                       7
 100 #define WTAP_ENCAP_ARCNET                       8
 101 #define WTAP_ENCAP_ARCNET_LINUX                 9
 102 #define WTAP_ENCAP_ATM_RFC1483                  10
 103 #define WTAP_ENCAP_LINUX_ATM_CLIP               11
 104 #define WTAP_ENCAP_LAPB                         12
 105 #define WTAP_ENCAP_ATM_PDUS                     13
 106 #define WTAP_ENCAP_ATM_PDUS_UNTRUNCATED         14
 107 #define WTAP_ENCAP_NULL                         15
 108 #define WTAP_ENCAP_ASCEND                       16
 109 #define WTAP_ENCAP_ISDN                         17
 110 #define WTAP_ENCAP_IP_OVER_FC                   18
 111 #define WTAP_ENCAP_PPP_WITH_PHDR                19
 112 #define WTAP_ENCAP_IEEE_802_11                  20
 113 #define WTAP_ENCAP_PRISM_HEADER                 21
 114 #define WTAP_ENCAP_IEEE_802_11_WITH_RADIO       22
 115 #define WTAP_ENCAP_IEEE_802_11_WLAN_RADIOTAP    23
 116 #define WTAP_ENCAP_IEEE_802_11_WLAN_AVS         24
 117 #define WTAP_ENCAP_SLL                          25
 118 #define WTAP_ENCAP_FRELAY                       26
 119 #define WTAP_ENCAP_FRELAY_WITH_PHDR             27
 120 #define WTAP_ENCAP_CHDLC                        28
 121 #define WTAP_ENCAP_CISCO_IOS                    29
 122 #define WTAP_ENCAP_LOCALTALK                    30
 123 #define WTAP_ENCAP_OLD_PFLOG                    31
 124 #define WTAP_ENCAP_HHDLC                        32
 125 #define WTAP_ENCAP_DOCSIS                       33
 126 #define WTAP_ENCAP_COSINE                       34
 127 #define WTAP_ENCAP_WFLEET_HDLC                  35
 128 #define WTAP_ENCAP_SDLC                         36
 129 #define WTAP_ENCAP_TZSP                         37
 130 #define WTAP_ENCAP_ENC                          38
 131 #define WTAP_ENCAP_PFLOG                        39
 132 #define WTAP_ENCAP_CHDLC_WITH_PHDR              40
 133 #define WTAP_ENCAP_BLUETOOTH_H4                 41
 134 #define WTAP_ENCAP_MTP2                         42
 135 #define WTAP_ENCAP_MTP3                         43
 136 #define WTAP_ENCAP_IRDA                         44
 137 #define WTAP_ENCAP_USER0                        45
 138 #define WTAP_ENCAP_USER1                        46
 139 #define WTAP_ENCAP_USER2                        47
 140 #define WTAP_ENCAP_USER3                        48
 141 #define WTAP_ENCAP_USER4                        49
 142 #define WTAP_ENCAP_USER5                        50
 143 #define WTAP_ENCAP_USER6                        51
 144 #define WTAP_ENCAP_USER7                        52
 145 #define WTAP_ENCAP_USER8                        53
 146 #define WTAP_ENCAP_USER9                        54
 147 #define WTAP_ENCAP_USER10                       55
 148 #define WTAP_ENCAP_USER11                       56
 149 #define WTAP_ENCAP_USER12                       57
 150 #define WTAP_ENCAP_USER13                       58
 151 #define WTAP_ENCAP_USER14                       59
 152 #define WTAP_ENCAP_USER15                       60
 153 #define WTAP_ENCAP_SYMANTEC                     61
 154 #define WTAP_ENCAP_APPLE_IP_OVER_IEEE1394       62
 155 #define WTAP_ENCAP_BACNET_MS_TP                 63
 156 #define WTAP_ENCAP_NETTL_RAW_ICMP               64
 157 #define WTAP_ENCAP_NETTL_RAW_ICMPV6             65
 158 #define WTAP_ENCAP_GPRS_LLC                     66
 159 #define WTAP_ENCAP_JUNIPER_ATM1                 67
 160 #define WTAP_ENCAP_JUNIPER_ATM2                 68
 161 #define WTAP_ENCAP_REDBACK                      69
 162 #define WTAP_ENCAP_NETTL_RAW_IP                 70
 163 #define WTAP_ENCAP_NETTL_ETHERNET               71
 164 #define WTAP_ENCAP_NETTL_TOKEN_RING             72
 165 #define WTAP_ENCAP_NETTL_FDDI                   73
 166 #define WTAP_ENCAP_NETTL_UNKNOWN                74
 167 #define WTAP_ENCAP_MTP2_WITH_PHDR               75
 168 #define WTAP_ENCAP_JUNIPER_PPPOE                76
 169 #define WTAP_ENCAP_GCOM_TIE1                    77
 170 #define WTAP_ENCAP_GCOM_SERIAL                  78
 171 #define WTAP_ENCAP_NETTL_X25                    79
 172 #define WTAP_ENCAP_K12                          80
 173 #define WTAP_ENCAP_JUNIPER_MLPPP                81
 174 #define WTAP_ENCAP_JUNIPER_MLFR                 82
 175 #define WTAP_ENCAP_JUNIPER_ETHER                83
 176 #define WTAP_ENCAP_JUNIPER_PPP                  84
 177 #define WTAP_ENCAP_JUNIPER_FRELAY               85
 178 #define WTAP_ENCAP_JUNIPER_CHDLC                86
 179 #define WTAP_ENCAP_JUNIPER_GGSN                 87
 180 #define WTAP_ENCAP_LINUX_LAPD                   88
 181 #define WTAP_ENCAP_CATAPULT_DCT2000             89
 182 #define WTAP_ENCAP_BER                          90
 183 #define WTAP_ENCAP_JUNIPER_VP                   91
 184 #define WTAP_ENCAP_USB                          92
 185 #define WTAP_ENCAP_IEEE802_16_MAC_CPS           93
 186 #define WTAP_ENCAP_NETTL_RAW_TELNET             94
 187 #define WTAP_ENCAP_USB_LINUX                    95
 188 #define WTAP_ENCAP_MPEG                         96
 189 #define WTAP_ENCAP_PPI                          97
 190 #define WTAP_ENCAP_ERF                          98
 191 #define WTAP_ENCAP_BLUETOOTH_H4_WITH_PHDR       99
 192 #define WTAP_ENCAP_SITA                         100
 193 #define WTAP_ENCAP_SCCP                         101
 194 #define WTAP_ENCAP_BLUETOOTH_HCI                102 /*raw packets without a transport layer header e.g. H4*/
 195 #define WTAP_ENCAP_IPMB                         103
 196 #define WTAP_ENCAP_IEEE802_15_4                 104
 197 #define WTAP_ENCAP_X2E_XORAYA                   105
 198 #define WTAP_ENCAP_FLEXRAY                      106
 199 #define WTAP_ENCAP_LIN                          107
 200 #define WTAP_ENCAP_MOST                         108
 201 #define WTAP_ENCAP_CAN20B                       109
 202 #define WTAP_ENCAP_LAYER1_EVENT                 110
 203 #define WTAP_ENCAP_X2E_SERIAL                   111
 204 #define WTAP_ENCAP_I2C                          112
 205 #define WTAP_ENCAP_IEEE802_15_4_NONASK_PHY      113
 206 #define WTAP_ENCAP_TNEF                         114
 207 #define WTAP_ENCAP_USB_LINUX_MMAPPED            115
 208 #define WTAP_ENCAP_GSM_UM                       116
 209 #define WTAP_ENCAP_DPNSS                        117
 210 #define WTAP_ENCAP_PACKETLOGGER                 118
 211 #define WTAP_ENCAP_NSTRACE_1_0                  119
 212 #define WTAP_ENCAP_NSTRACE_2_0                  120
 213 #define WTAP_ENCAP_FIBRE_CHANNEL_FC2            121
 214 #define WTAP_ENCAP_FIBRE_CHANNEL_FC2_WITH_FRAME_DELIMS 122
 215 #define WTAP_ENCAP_JPEG_JFIF                    123
 216 #define WTAP_ENCAP_IPNET                        124
 217 #define WTAP_ENCAP_SOCKETCAN                    125
 218 #define WTAP_ENCAP_IEEE802_11_NETMON_RADIO      126
 219 #define WTAP_ENCAP_IEEE802_15_4_NOFCS           127
 220 #define WTAP_ENCAP_RAW_IPFIX                    128
 221
 222 #define WTAP_NUM_ENCAP_TYPES                    wtap_get_num_encap_types()
 223
 224 /* File types that can be read by wiretap.
 225    We support writing some many of these file types, too, so we
 226    distinguish between different versions of them. */
 227 #define WTAP_FILE_UNKNOWN                       0
 228 #define WTAP_FILE_WTAP                          1
 229 #define WTAP_FILE_PCAP                          2
 230 #define WTAP_FILE_PCAP_NSEC                     3
 231 #define WTAP_FILE_PCAP_AIX                      4
 232 #define WTAP_FILE_PCAP_SS991029                 5
 233 #define WTAP_FILE_PCAP_NOKIA                    6
 234 #define WTAP_FILE_PCAP_SS990417                 7
 235 #define WTAP_FILE_PCAP_SS990915                 8
 236 #define WTAP_FILE_5VIEWS                        9
 237 #define WTAP_FILE_IPTRACE_1_0                   10
 238 #define WTAP_FILE_IPTRACE_2_0                   11
 239 #define WTAP_FILE_BER                           12
 240 #define WTAP_FILE_HCIDUMP                       13
 241 #define WTAP_FILE_CATAPULT_DCT2000              14
 242 #define WTAP_FILE_NETXRAY_OLD                   15
 243 #define WTAP_FILE_NETXRAY_1_0                   16
 244 #define WTAP_FILE_COSINE                        17
 245 #define WTAP_FILE_CSIDS                         18
 246 #define WTAP_FILE_DBS_ETHERWATCH                19
 247 #define WTAP_FILE_ERF                           20
 248 #define WTAP_FILE_EYESDN                        21
 249 #define WTAP_FILE_NETTL                         22
 250 #define WTAP_FILE_ISERIES                       23
 251 #define WTAP_FILE_ISERIES_UNICODE               24
 252 #define WTAP_FILE_I4BTRACE                      25
 253 #define WTAP_FILE_ASCEND                        26
 254 #define WTAP_FILE_NETMON_1_x                    27
 255 #define WTAP_FILE_NETMON_2_x                    28
 256 #define WTAP_FILE_NGSNIFFER_UNCOMPRESSED        29
 257 #define WTAP_FILE_NGSNIFFER_COMPRESSED          30
 258 #define WTAP_FILE_NETXRAY_1_1                   31
 259 #define WTAP_FILE_NETXRAY_2_00x                 32
 260 #define WTAP_FILE_NETWORK_INSTRUMENTS_V9        33
 261 #define WTAP_FILE_LANALYZER                     34
 262 #define WTAP_FILE_PPPDUMP                       35
 263 #define WTAP_FILE_RADCOM                        36
 264 #define WTAP_FILE_SNOOP                         37
 265 #define WTAP_FILE_SHOMITI                       38
 266 #define WTAP_FILE_VMS                           39
 267 #define WTAP_FILE_K12                           40
 268 #define WTAP_FILE_TOSHIBA                       41
 269 #define WTAP_FILE_VISUAL_NETWORKS               42
 270 #define WTAP_FILE_ETHERPEEK_V56                 43
 271 #define WTAP_FILE_ETHERPEEK_V7                  44
 272 #define WTAP_FILE_AIROPEEK_V9                   45
 273 #define WTAP_FILE_MPEG                          46
 274 #define WTAP_FILE_K12TEXT                       47
 275 #define WTAP_FILE_NETSCREEN                     48
 276 #define WTAP_FILE_COMMVIEW                      49
 277 #define WTAP_FILE_PCAPNG                        50
 278 #define WTAP_FILE_BTSNOOP                       51
 279 #define WTAP_FILE_X2E_XORAYA                    52
 280 #define WTAP_FILE_TNEF                          53
 281 #define WTAP_FILE_DCT3TRACE                     54
 282 #define WTAP_FILE_PACKETLOGGER                  55
 283 #define WTAP_FILE_DAINTREE_SNA                  56
 284 #define WTAP_FILE_NETSCALER_1_0                 57
 285 #define WTAP_FILE_NETSCALER_2_0                 58
 286 #define WTAP_FILE_JPEG_JFIF                     59
 287 #define WTAP_FILE_IPFIX                         60
 288
 289 #define WTAP_NUM_FILE_TYPES                     wtap_get_num_file_types()
 290
 291 /* timestamp precision (currently only these values are supported) */
 292 #define WTAP_FILE_TSPREC_SEC            0
 293 #define WTAP_FILE_TSPREC_DSEC           1
 294 #define WTAP_FILE_TSPREC_CSEC           2
 295 #define WTAP_FILE_TSPREC_MSEC           3
 296 #define WTAP_FILE_TSPREC_USEC           6
 297 #define WTAP_FILE_TSPREC_NSEC           9
 298
 299 /*
 300  * Maximum packet size we'll support.
 301  * 65535 is the largest snapshot length that libpcap supports, so we
 302  * use that.
 303  */
 304 #define WTAP_MAX_PACKET_SIZE                    65535
 305
 306 /*
 307  * "Pseudo-headers" are used to supply to the clients of wiretap
 308  * per-packet information that's not part of the packet payload
 309  * proper.
 310  *
 311  * NOTE: do not use pseudo-header structures to hold information
 312  * used by the code to read a particular capture file type; to
 313  * keep that sort of state information, add a new structure for
 314  * that private information to "wtap-int.h", add a pointer to that
 315  * type of structure to the "capture" member of the "struct wtap"
 316  * structure, and allocate one of those structures and set that member
 317  * in the "open" routine for that capture file type if the open
 318  * succeeds.  See various other capture file type handlers for examples
 319  * of that.
 320  */
 321
 322
 323 struct nstr_phdr {
 324         gint64 rec_offset;
 325         gint32 rec_len;
 326         guint8 nicno_offset;
 327         guint8 nicno_len;
 328         guint8 dir_offset;
 329         guint8 dir_len;
 330         guint8 eth_offset;
 331         guint8 pcb_offset;
 332         guint8 l_pcb_offset;
 333         guint8 rec_type;
 334         guint8 vlantag_offset;
 335         guint8 coreid_offset;
 336 };
 337
 338 /* Packet "pseudo-header" information for Ethernet capture files. */
 339 struct eth_phdr {
 340         gint    fcs_len;        /* Number of bytes of FCS - -1 means "unknown" */
 341 };
 342
 343 /* Packet "pseudo-header" information for X.25 capture files. */
 344 #define FROM_DCE                        0x80
 345 struct x25_phdr {
 346         guint8  flags; /* ENCAP_LAPB, ENCAP_V120 : 1st bit means From DCE */
 347 };
 348
 349 /* Packet "pseudo-header" information for ISDN capture files. */
 350
 351 /* Direction */
 352 struct isdn_phdr {
 353         gboolean uton;
 354         guint8  channel;                /* 0 = D-channel; n = B-channel n */
 355 };
 356
 357 /* Packet "pseudo-header" for ATM capture files.
 358    Not all of this information is supplied by all capture types. */
 359
 360 /*
 361  * Status bits.
 362  */
 363 #define ATM_RAW_CELL    0x01    /* TRUE if the packet is a single cell */
 364 #define ATM_NO_HEC      0x02    /* TRUE if the cell has HEC stripped out */
 365 #define ATM_AAL2_NOPHDR 0x04    /* TRUE if the AAL2 PDU has no pseudo-header */
 366
 367 /*
 368  * AAL types.
 369  */
 370 #define AAL_UNKNOWN     0       /* AAL unknown */
 371 #define AAL_1           1       /* AAL1 */
 372 #define AAL_2           2       /* AAL2 */
 373 #define AAL_3_4         3       /* AAL3/4 */
 374 #define AAL_5           4       /* AAL5 */
 375 #define AAL_USER        5       /* User AAL */
 376 #define AAL_SIGNALLING  6       /* Signaling AAL */
 377 #define AAL_OAMCELL     7       /* OAM cell */
 378
 379 /*
 380  * Traffic types.
 381  */
 382 #define TRAF_UNKNOWN    0       /* Unknown */
 383 #define TRAF_LLCMX      1       /* LLC multiplexed (RFC 1483) */
 384 #define TRAF_VCMX       2       /* VC multiplexed (RFC 1483) */
 385 #define TRAF_LANE       3       /* LAN Emulation */
 386 #define TRAF_ILMI       4       /* ILMI */
 387 #define TRAF_FR         5       /* Frame Relay */
 388 #define TRAF_SPANS      6       /* FORE SPANS */
 389 #define TRAF_IPSILON    7       /* Ipsilon */
 390 #define TRAF_UMTS_FP    8       /* UMTS Frame Protocol */
 391
 392 /*
 393  * Traffic subtypes.
 394  */
 395 #define TRAF_ST_UNKNOWN         0       /* Unknown */
 396
 397 /*
 398  * For TRAF_VCMX:
 399  */
 400 #define TRAF_ST_VCMX_802_3_FCS  1       /* 802.3 with an FCS */
 401 #define TRAF_ST_VCMX_802_4_FCS  2       /* 802.4 with an FCS */
 402 #define TRAF_ST_VCMX_802_5_FCS  3       /* 802.5 with an FCS */
 403 #define TRAF_ST_VCMX_FDDI_FCS   4       /* FDDI with an FCS */
 404 #define TRAF_ST_VCMX_802_6_FCS  5       /* 802.6 with an FCS */
 405 #define TRAF_ST_VCMX_802_3      7       /* 802.3 without an FCS */
 406 #define TRAF_ST_VCMX_802_4      8       /* 802.4 without an FCS */
 407 #define TRAF_ST_VCMX_802_5      9       /* 802.5 without an FCS */
 408 #define TRAF_ST_VCMX_FDDI       10      /* FDDI without an FCS */
 409 #define TRAF_ST_VCMX_802_6      11      /* 802.6 without an FCS */
 410 #define TRAF_ST_VCMX_FRAGMENTS  12      /* Fragments */
 411 #define TRAF_ST_VCMX_BPDU       13      /* BPDU */
 412
 413 /*
 414  * For TRAF_LANE:
 415  */
 416 #define TRAF_ST_LANE_LE_CTRL    1       /* LANE: LE Ctrl */
 417 #define TRAF_ST_LANE_802_3      2       /* LANE: 802.3 */
 418 #define TRAF_ST_LANE_802_5      3       /* LANE: 802.5 */
 419 #define TRAF_ST_LANE_802_3_MC   4       /* LANE: 802.3 multicast */
 420 #define TRAF_ST_LANE_802_5_MC   5       /* LANE: 802.5 multicast */
 421
 422 /*
 423  * For TRAF_IPSILON:
 424  */
 425 #define TRAF_ST_IPSILON_FT0     1       /* Ipsilon: Flow Type 0 */
 426 #define TRAF_ST_IPSILON_FT1     2       /* Ipsilon: Flow Type 1 */
 427 #define TRAF_ST_IPSILON_FT2     3       /* Ipsilon: Flow Type 2 */
 428
 429 struct atm_phdr {
 430         guint32 flags;          /* status flags */
 431         guint8  aal;            /* AAL of the traffic */
 432         guint8  type;           /* traffic type */
 433         guint8  subtype;        /* traffic subtype */
 434         guint16 vpi;            /* virtual path identifier */
 435         guint16 vci;            /* virtual circuit identifier */
 436         guint8  aal2_cid;       /* channel id */
 437         guint16 channel;        /* link: 0 for DTE->DCE, 1 for DCE->DTE */
 438         guint16 cells;          /* number of cells */
 439         guint16 aal5t_u2u;      /* user-to-user indicator */
 440         guint16 aal5t_len;      /* length of the packet */
 441         guint32 aal5t_chksum;   /* checksum for AAL5 packet */
 442 };
 443
 444 /* Packet "pseudo-header" for the output from "wandsession", "wannext",
 445    "wandisplay", and similar commands on Lucent/Ascend access equipment. */
 446
 447 #define ASCEND_MAX_STR_LEN 64
 448
 449 #define ASCEND_PFX_WDS_X 1
 450 #define ASCEND_PFX_WDS_R 2
 451 #define ASCEND_PFX_WDD   3
 452 #define ASCEND_PFX_ISDN_X 4
 453 #define ASCEND_PFX_ISDN_R 5
 454 #define ASCEND_PFX_ETHER 6
 455
 456 struct ascend_phdr {
 457         guint16 type;                   /* ASCEND_PFX_*, as defined above */
 458         char    user[ASCEND_MAX_STR_LEN];   /* Username, from wandsession header */
 459         guint32 sess;                   /* Session number, from wandsession header */
 460         char    call_num[ASCEND_MAX_STR_LEN];   /* Called number, from WDD header */
 461         guint32 chunk;                  /* Chunk number, from WDD header */
 462         guint32 task;                   /* Task number */
 463 };
 464
 465 /* Also defined in epan/packet_info.h */
 466 #define P2P_DIR_UNKNOWN -1
 467 #define P2P_DIR_SENT    0
 468 #define P2P_DIR_RECV    1
 469
 470 /* Packet "pseudo-header" for point-to-point links with direction flags. */
 471 struct p2p_phdr {
 472         int     sent; /* TRUE=sent, FALSE=received, -1=unknown*/
 473 };
 474
 475 /*
 476  * Packet "pseudo-header" information for 802.11.
 477  * Radio information is only present for WTAP_ENCAP_IEEE_802_11_WITH_RADIO.
 478  *
 479  * Signal strength, etc. information:
 480  *
 481  * Raw signal strength can be measured in milliwatts.
 482  * It can also be represented as dBm, which is 10 times the log base 10
 483  * of the signal strength in mW.
 484  *
 485  * The Receive Signal Strength Indicator is an integer in the range 0 to 255.
 486  * The actual RSSI value for a given signal strength is dependent on the
 487  * vendor (and perhaps on the adapter).  The maximum possible RSSI value
 488  * is also dependent on the vendor and perhaps the adapter.
 489  *
 490  * The signal strength can be represented as a percentage, which is 100
 491  * times the ratio of the RSSI and the maximum RSSI.
 492  */
 493 struct ieee_802_11_phdr {
 494         gint    fcs_len;        /* Number of bytes of FCS - -1 means "unknown" */
 495         guint8  channel;        /* Channel number */
 496         guint8  data_rate;      /* in .5 Mb/s units */
 497         guint8  signal_level;   /* percentage */
 498 };
 499
 500 /* Packet "pseudo-header" for the output from CoSine L2 debug output. */
 501
 502 #define COSINE_MAX_IF_NAME_LEN  128
 503
 504 #define COSINE_ENCAP_TEST       1
 505 #define COSINE_ENCAP_PPoATM     2
 506 #define COSINE_ENCAP_PPoFR      3
 507 #define COSINE_ENCAP_ATM        4
 508 #define COSINE_ENCAP_FR         5
 509 #define COSINE_ENCAP_HDLC       6
 510 #define COSINE_ENCAP_PPP        7
 511 #define COSINE_ENCAP_ETH        8
 512 #define COSINE_ENCAP_UNKNOWN    99
 513
 514 #define COSINE_DIR_TX 1
 515 #define COSINE_DIR_RX 2
 516
 517 struct cosine_phdr {
 518         guint8 encap;           /* COSINE_ENCAP_* as defined above */
 519         guint8 direction;       /* COSINE_DIR_*, as defined above */
 520         char if_name[COSINE_MAX_IF_NAME_LEN];  /* Encap & Logical I/F name */
 521         guint16 pro;            /* Protocol */
 522         guint16 off;            /* Offset */
 523         guint16 pri;            /* Priority */
 524         guint16 rm;             /* Rate Marking */
 525         guint16 err;            /* Error Code */
 526 };
 527
 528 /* Packet "pseudo-header" for IrDA capture files. */
 529
 530 /*
 531  * Direction of the packet
 532  */
 533 #define IRDA_INCOMING       0x0000
 534 #define IRDA_OUTGOING       0x0004
 535
 536 /*
 537  * "Inline" log messages produced by IrCOMM2k on Windows
 538  */
 539 #define IRDA_LOG_MESSAGE    0x0100  /* log message */
 540 #define IRDA_MISSED_MSG     0x0101  /* missed log entry or frame */
 541
 542 /*
 543  * Differentiate between frames and log messages
 544  */
 545 #define IRDA_CLASS_FRAME    0x0000
 546 #define IRDA_CLASS_LOG      0x0100
 547 #define IRDA_CLASS_MASK     0xFF00
 548
 549 struct irda_phdr {
 550         guint16 pkttype;    /* packet type */
 551 };
 552
 553 /* Packet "pseudo-header" for nettl (HP-UX) capture files. */
 554
 555 struct nettl_phdr {
 556         guint16 subsys;
 557         guint32 devid;
 558         guint32 kind;
 559         gint32  pid;
 560         guint16 uid;
 561 };
 562
 563 /* Packet "pseudo-header" for MTP2 files. */
 564
 565 #define MTP2_ANNEX_A_NOT_USED      0
 566 #define MTP2_ANNEX_A_USED          1
 567 #define MTP2_ANNEX_A_USED_UNKNOWN  2
 568
 569 struct mtp2_phdr {
 570         guint8  sent;
 571         guint8  annex_a_used;
 572         guint16 link_number;
 573 };
 574
 575 /* Packet "pseudo-header" for K12 files. */
 576
 577 typedef union {
 578         struct {
 579                 guint16 vp;
 580                 guint16 vc;
 581                 guint16 cid;
 582         } atm;
 583
 584         guint32 ds0mask;
 585 } k12_input_info_t;
 586
 587 struct k12_phdr {
 588         guint32 input;
 589         const gchar* input_name;
 590         const gchar* stack_file;
 591         guint32 input_type;
 592         k12_input_info_t input_info;
 593         guchar* extra_info;
 594         guint32 extra_length;
 595         void* stuff;
 596 };
 597
 598 #define K12_PORT_DS0S      0x00010008
 599 #define K12_PORT_DS1       0x00100008
 600 #define K12_PORT_ATMPVC    0x01020000
 601
 602 struct lapd_phdr {
 603         guint16 pkttype;    /* packet type */
 604         guint8 we_network;
 605 };
 606
 607 struct wtap;
 608 struct catapult_dct2000_phdr
 609 {
 610         union
 611         {
 612                 struct isdn_phdr  isdn;
 613                 struct atm_phdr   atm;
 614                 struct p2p_phdr   p2p;
 615         } inner_pseudo_header;
 616         gint64 seek_off;
 617         struct wtap *wth;
 618 };
 619
 620 #define LIBPCAP_BT_PHDR_SENT    0
 621 #define LIBPCAP_BT_PHDR_RECV    1
 622
 623 /*
 624  * Header prepended by libpcap to each bluetooth hci h:4 frame.
 625  * Values in network byte order
 626  */
 627 struct libpcap_bt_phdr {
 628     guint32 direction;     /* Bit 0 hold the frame direction. */
 629 };
 630
 631 #define LIBPCAP_PPP_PHDR_RECV    0
 632 #define LIBPCAP_PPP_PHDR_SENT    1
 633
 634 /*
 635  * Header prepended by libpcap to each ppp frame.
 636  */
 637 struct libpcap_ppp_phdr {
 638     guint8 direction;
 639 };
 640
 641 /*
 642  * Endace Record Format pseudo header
 643  */
 644 struct erf_phdr {
 645   guint64 ts;             /* Time stamp */
 646   guint8 type;
 647   guint8 flags;
 648   guint16 rlen;
 649   guint16 lctr;
 650   guint16 wlen;
 651 };
 652
 653 struct erf_ehdr {
 654   guint64 ehdr;
 655 };
 656
 657 /*
 658  * ERF pseudo header with optional subheader
 659  * (Multichannel or Ethernet)
 660  */
 661 struct erf_mc_phdr {
 662   struct erf_phdr phdr;
 663   struct erf_ehdr ehdr_list[8];
 664   union
 665   {
 666     guint16 eth_hdr;
 667     guint32 mc_hdr;
 668   } subhdr;
 669 };
 670
 671 #define SITA_FRAME_DIR_TXED             (0x00)          /* values of sita_phdr.flags */
 672 #define SITA_FRAME_DIR_RXED             (0x01)
 673 #define SITA_FRAME_DIR                  (0x01)          /* mask */
 674 #define SITA_ERROR_NO_BUFFER            (0x80)
 675
 676 #define SITA_SIG_DSR                    (0x01)          /* values of sita_phdr.signals */
 677 #define SITA_SIG_DTR                    (0x02)
 678 #define SITA_SIG_CTS                    (0x04)
 679 #define SITA_SIG_RTS                    (0x08)
 680 #define SITA_SIG_DCD                    (0x10)
 681 #define SITA_SIG_UNDEF1                 (0x20)
 682 #define SITA_SIG_UNDEF2                 (0x40)
 683 #define SITA_SIG_UNDEF3                 (0x80)
 684
 685 #define SITA_ERROR_TX_UNDERRUN          (0x01)          /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_TXED) */
 686 #define SITA_ERROR_TX_CTS_LOST          (0x02)
 687 #define SITA_ERROR_TX_UART_ERROR        (0x04)
 688 #define SITA_ERROR_TX_RETX_LIMIT        (0x08)
 689 #define SITA_ERROR_TX_UNDEF1            (0x10)
 690 #define SITA_ERROR_TX_UNDEF2            (0x20)
 691 #define SITA_ERROR_TX_UNDEF3            (0x40)
 692 #define SITA_ERROR_TX_UNDEF4            (0x80)
 693
 694 #define SITA_ERROR_RX_FRAMING           (0x01)          /* values of sita_phdr.errors1 (if SITA_FRAME_DIR_RXED) */
 695 #define SITA_ERROR_RX_PARITY            (0x02)
 696 #define SITA_ERROR_RX_COLLISION         (0x04)
 697 #define SITA_ERROR_RX_FRAME_LONG        (0x08)
 698 #define SITA_ERROR_RX_FRAME_SHORT       (0x10)
 699 #define SITA_ERROR_RX_UNDEF1            (0x20)
 700 #define SITA_ERROR_RX_UNDEF2            (0x40)
 701 #define SITA_ERROR_RX_UNDEF3            (0x80)
 702
 703 #define SITA_ERROR_RX_NONOCTET_ALIGNED  (0x01)  /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_RXED) */
 704 #define SITA_ERROR_RX_ABORT             (0x02)
 705 #define SITA_ERROR_RX_CD_LOST           (0x04)
 706 #define SITA_ERROR_RX_DPLL              (0x08)
 707 #define SITA_ERROR_RX_OVERRUN           (0x10)
 708 #define SITA_ERROR_RX_FRAME_LEN_VIOL    (0x20)
 709 #define SITA_ERROR_RX_CRC               (0x40)
 710 #define SITA_ERROR_RX_BREAK             (0x80)
 711
 712 #define SITA_PROTO_UNUSED               (0x00)          /* values of sita_phdr.proto */
 713 #define SITA_PROTO_BOP_LAPB             (0x01)
 714 #define SITA_PROTO_ETHERNET             (0x02)
 715 #define SITA_PROTO_ASYNC_INTIO          (0x03)
 716 #define SITA_PROTO_ASYNC_BLKIO          (0x04)
 717 #define SITA_PROTO_ALC                  (0x05)
 718 #define SITA_PROTO_UTS                  (0x06)
 719 #define SITA_PROTO_PPP_HDLC             (0x07)
 720 #define SITA_PROTO_SDLC                 (0x08)
 721 #define SITA_PROTO_TOKENRING            (0x09)
 722 #define SITA_PROTO_I2C                  (0x10)
 723 #define SITA_PROTO_DPM_LINK             (0x11)
 724 #define SITA_PROTO_BOP_FRL              (0x12)
 725
 726 struct sita_phdr {
 727    guint8  flags;
 728    guint8  signals;
 729    guint8  errors1;
 730    guint8  errors2;
 731    guint8  proto;
 732 };
 733
 734 /*pseudo header for Bluetooth HCI*/
 735 struct bthci_phdr {
 736         gboolean sent;
 737         guint8 channel;
 738 };
 739
 740 #define BTHCI_CHANNEL_COMMAND 1
 741 #define BTHCI_CHANNEL_ACL     2
 742 #define BTHCI_CHANNEL_SCO     3
 743 #define BTHCI_CHANNEL_EVENT   4
 744
 745 /* pseudo header for WTAP_ENCAP_LAYER1_EVENT */
 746 struct l1event_phdr {
 747         gboolean uton;
 748 };
 749
 750 /* * I2C pseudo header */
 751 struct i2c_phdr {
 752         guint8 is_event;
 753         guint8 bus;
 754         guint32 flags;
 755 };
 756
 757 /* pseudo header for WTAP_ENCAP_GSM_UM */
 758 struct gsm_um_phdr {
 759         gboolean uplink;
 760         guint8 channel;
 761         /* The following are only populated for downlink */
 762         guint8 bsic;
 763         guint16 arfcn;
 764         guint32 tdma_frame;
 765         guint8 error;
 766         guint16 timeshift;
 767 };
 768
 769 #define GSM_UM_CHANNEL_UNKNOWN  0
 770 #define GSM_UM_CHANNEL_BCCH     1
 771 #define GSM_UM_CHANNEL_SDCCH    2
 772 #define GSM_UM_CHANNEL_SACCH    3
 773 #define GSM_UM_CHANNEL_FACCH    4
 774 #define GSM_UM_CHANNEL_CCCH     5
 775 #define GSM_UM_CHANNEL_RACH     6
 776 #define GSM_UM_CHANNEL_AGCH     7
 777 #define GSM_UM_CHANNEL_PCH      8
 778
 779 union wtap_pseudo_header {
 780         struct eth_phdr         eth;
 781         struct x25_phdr         x25;
 782         struct isdn_phdr        isdn;
 783         struct atm_phdr         atm;
 784         struct ascend_phdr      ascend;
 785         struct p2p_phdr         p2p;
 786         struct ieee_802_11_phdr ieee_802_11;
 787         struct cosine_phdr      cosine;
 788         struct irda_phdr        irda;
 789         struct nettl_phdr       nettl;
 790         struct mtp2_phdr        mtp2;
 791         struct k12_phdr         k12;
 792         struct lapd_phdr        lapd;
 793         struct catapult_dct2000_phdr dct2000;
 794         struct erf_mc_phdr      erf;
 795         struct sita_phdr        sita;
 796         struct bthci_phdr       bthci;
 797         struct l1event_phdr     l1event;
 798         struct i2c_phdr         i2c;
 799         struct gsm_um_phdr      gsm_um;
 800         struct nstr_phdr        nstr;
 801 };
 802
 803 struct wtap_nstime {
 804         time_t  secs;
 805         int     nsecs;
 806 };
 807
 808 struct wtap_pkthdr {
 809         struct wtap_nstime ts;
 810         guint32 caplen;
 811         guint32 len;
 812         int pkt_encap;
 813 };
 814
 815 struct Buffer;
 816 struct wtap_dumper;
 817
 818 typedef struct wtap wtap;
 819 typedef struct wtap_dumper wtap_dumper;
 820
 821 struct file_type_info {
 822     /* the file type name */
 823     /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
 824     const char *name;
 825
 826     /* the file type short name, used as a shortcut for the command line tools */
 827     /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
 828     const char *short_name;
 829
 830     /* the common file extensions for this type (seperated by semicolon) */
 831     /* should be *.* if no common extension is applicable */
 832     const char *file_extensions;
 833
 834     /* the default file extension, used to save this type */
 835     /* should be NULL if no default extension is known */
 836     const char *file_extension_default;
 837
 838     /* can this type be compressed with gzip? */
 839     gboolean can_compress;
 840
 841     /* can this type write this encapsulation format? */
 842     /* should be NULL is this file type don't have write support */
 843     int (*can_write_encap)(int);
 844
 845     /* the function to open the capture file for writing */
 846     /* should be NULL is this file type don't have write support */
 847     int (*dump_open)(wtap_dumper *, gboolean, int *);
 848 };
 849
 850
 851 typedef int (*wtap_open_routine_t)(struct wtap*, int *, char **);
 852
 853
 854 /*
 855  * On failure, "wtap_open_offline()" returns NULL, and puts into the
 856  * "int" pointed to by its second argument:
 857  *
 858  * a positive "errno" value if the capture file can't be opened;
 859  * a negative number, indicating the type of error, on other failures.
 860  */
 861 struct wtap* wtap_open_offline(const char *filename, int *err,
 862     gchar **err_info, gboolean do_random);
 863
 864 /*
 865  * If we were compiled with zlib and we're at EOF, unset EOF so that
 866  * wtap_read/gzread has a chance to succeed. This is necessary if
 867  * we're tailing a file.
 868  */
 869 void wtap_cleareof(wtap *wth);
 870
 871 /* Returns TRUE if read was successful. FALSE if failure. data_offset is
 872  * set to the offset in the file where the data for the read packet is
 873  * located. */
 874 gboolean wtap_read(wtap *wth, int *err, gchar **err_info,
 875     gint64 *data_offset);
 876
 877 gboolean wtap_seek_read (wtap *wth, gint64 seek_off,
 878         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
 879         int *err, gchar **err_info);
 880
 881 /*** get various information snippets about the current packet ***/
 882 struct wtap_pkthdr *wtap_phdr(wtap *wth);
 883 union wtap_pseudo_header *wtap_pseudoheader(wtap *wth);
 884 guint8 *wtap_buf_ptr(wtap *wth);
 885
 886 /*** get various information snippets about the current file ***/
 887
 888 /* Return an approximation of the amount of data we've read sequentially
 889  * from the file so far. */
 890 gint64 wtap_read_so_far(wtap *wth, int *err);
 891 gint64 wtap_file_size(wtap *wth, int *err);
 892 int wtap_snapshot_length(wtap *wth); /* per file */
 893 int wtap_file_type(wtap *wth);
 894 int wtap_file_encap(wtap *wth);
 895 int wtap_file_tsprecision(wtap *wth);
 896
 897 /*** close the current file ***/
 898 void wtap_sequential_close(wtap *wth);
 899 void wtap_close(wtap *wth);
 900
 901 /*** dump packets into a capture file ***/
 902 gboolean wtap_dump_can_open(int filetype);
 903 gboolean wtap_dump_can_write_encap(int filetype, int encap);
 904 gboolean wtap_dump_can_compress(int filetype);
 905 wtap_dumper* wtap_dump_open(const char *filename, int filetype, int encap,
 906         int snaplen, gboolean compressed, int *err);
 907 wtap_dumper* wtap_dump_fdopen(int fd, int filetype, int encap, int snaplen,
 908         gboolean compressed, int *err);
 909 gboolean wtap_dump(wtap_dumper *, const struct wtap_pkthdr *,
 910         const union wtap_pseudo_header *pseudo_header, const guchar *, int *err);
 911 void wtap_dump_flush(wtap_dumper *);
 912 gint64 wtap_get_bytes_dumped(wtap_dumper *);
 913 void wtap_set_bytes_dumped(wtap_dumper *wdh, gint64 bytes_dumped);
 914 gboolean wtap_dump_close(wtap_dumper *, int *);
 915
 916 /*** various string converter functions ***/
 917 const char *wtap_file_type_string(int filetype);
 918 const char *wtap_file_type_short_string(int filetype);
 919 int wtap_short_string_to_file_type(const char *short_name);
 920
 921 const char *wtap_file_extensions_string(int filetype);
 922 const char *wtap_file_extension_default_string(int filetype);
 923
 924 const char *wtap_encap_string(int encap);
 925 const char *wtap_encap_short_string(int encap);
 926 int wtap_short_string_to_encap(const char *short_name);
 927
 928 const char *wtap_strerror(int err);
 929
 930 /*** get available number of file types and encapsulations ***/
 931 int wtap_get_num_encap_types(void);
 932 int wtap_get_num_file_types(void);
 933
 934 /*** dynamically register new file types and encapsulations ***/
 935 void wtap_register_open_routine(wtap_open_routine_t, gboolean has_magic);
 936 int wtap_register_file_type(const struct file_type_info* fi);
 937 int wtap_register_encap_type(char* name, char* short_name);
 938
 939
 940 /*
 941  * Wiretap error codes.
 942  */
 943 #define WTAP_ERR_NOT_REGULAR_FILE               -1
 944         /* The file being opened for reading isn't a plain file (or pipe) */
 945 #define WTAP_ERR_RANDOM_OPEN_PIPE               -2
 946         /* The file is being opened for random access and it's a pipe */
 947 #define WTAP_ERR_FILE_UNKNOWN_FORMAT            -3
 948         /* The file being opened is not a capture file in a known format */
 949 #define WTAP_ERR_UNSUPPORTED                    -4
 950         /* Supported file type, but there's something in the file we
 951            can't support */
 952 #define WTAP_ERR_CANT_WRITE_TO_PIPE             -5
 953         /* Wiretap can't save to a pipe in the specified format */
 954 #define WTAP_ERR_CANT_OPEN                      -6
 955         /* The file couldn't be opened, reason unknown */
 956 #define WTAP_ERR_UNSUPPORTED_FILE_TYPE          -7
 957         /* Wiretap can't save files in the specified format */
 958 #define WTAP_ERR_UNSUPPORTED_ENCAP              -8
 959         /* Wiretap can't read or save files in the specified format with the
 960            specified encapsulation */
 961 #define WTAP_ERR_ENCAP_PER_PACKET_UNSUPPORTED   -9
 962         /* The specified format doesn't support per-packet encapsulations */
 963 #define WTAP_ERR_CANT_CLOSE                     -10
 964         /* The file couldn't be closed, reason unknown */
 965 #define WTAP_ERR_CANT_READ                      -11
 966         /* An attempt to read failed, reason unknown */
 967 #define WTAP_ERR_SHORT_READ                     -12
 968         /* An attempt to read read less data than it should have */
 969 #define WTAP_ERR_BAD_RECORD                     -13
 970         /* We read an invalid record */
 971 #define WTAP_ERR_SHORT_WRITE                    -14
 972         /* An attempt to write wrote less data than it should have */
 973 #define WTAP_ERR_UNC_TRUNCATED                  -15
 974         /* Sniffer compressed data was oddly truncated */
 975 #define WTAP_ERR_UNC_OVERFLOW                   -16
 976         /* Uncompressing Sniffer data would overflow buffer */
 977 #define WTAP_ERR_UNC_BAD_OFFSET                 -17
 978         /* LZ77 compressed data has bad offset to string */
 979 #define WTAP_ERR_RANDOM_OPEN_STDIN              -18
 980         /* We're trying to open the standard input for random access */
 981 #define WTAP_ERR_COMPRESSION_NOT_SUPPORTED -19
 982         /* The filetype doesn't support output compression */
 983 #define WTAP_ERR_CANT_SEEK                      -20
 984         /* An attempt to seek failed, reason unknown */
 985
 986 /* Errors from zlib; zlib error Z_xxx turns into Wiretap error
 987    WTAP_ERR_ZLIB + Z_xxx.
 988
 989    WTAP_ERR_ZLIB_MIN and WTAP_ERR_ZLIB_MAX bound the range of zlib
 990    errors; we leave room for 100 positive and 100 negative error
 991    codes. */
 992
 993 #define WTAP_ERR_ZLIB                           -200
 994 #define WTAP_ERR_ZLIB_MAX                       -100
 995 #define WTAP_ERR_ZLIB_MIN                       -300
 996
 997 #ifdef __cplusplus
 998 }
 999 #endif /* __cplusplus */
1000
1001 #endif /* __WTAP_H__ */