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