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