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