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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /* 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
 187 /* last WTAP_ENCAP_ value + 1 */
 188 #define WTAP_NUM_ENCAP_TYPES                    93
 189
 190 /* File types that can be read by wiretap.
 191    We support writing some many of these file types, too, so we
 192    distinguish between different versions of them. */
 193 #define WTAP_FILE_UNKNOWN                       0
 194 #define WTAP_FILE_WTAP                          1
 195 #define WTAP_FILE_PCAP                          2
 196 #define WTAP_FILE_PCAP_NSEC                     3
 197 #define WTAP_FILE_PCAP_AIX                      4
 198 #define WTAP_FILE_PCAP_SS991029                 5
 199 #define WTAP_FILE_PCAP_NOKIA                    6
 200 #define WTAP_FILE_PCAP_SS990417                 7
 201 #define WTAP_FILE_PCAP_SS990915                 8
 202 #define WTAP_FILE_5VIEWS                        9
 203 #define WTAP_FILE_IPTRACE_1_0                   10
 204 #define WTAP_FILE_IPTRACE_2_0                   11
 205 #define WTAP_FILE_BER                           12
 206 #define WTAP_FILE_HCIDUMP                       13
 207 #define WTAP_FILE_CATAPULT_DCT2000              14
 208 #define WTAP_FILE_NETXRAY_OLD                   15
 209 #define WTAP_FILE_NETXRAY_1_0                   16
 210 #define WTAP_FILE_COSINE                        17
 211 #define WTAP_FILE_CSIDS                         18
 212 #define WTAP_FILE_DBS_ETHERWATCH                19
 213 #define WTAP_FILE_ERF                           20
 214 #define WTAP_FILE_EYESDN                        21
 215 #define WTAP_FILE_NETTL                         22
 216 #define WTAP_FILE_ISERIES                       23
 217 #define WTAP_FILE_ISERIES_UNICODE               24
 218 #define WTAP_FILE_I4BTRACE                      25
 219 #define WTAP_FILE_ASCEND                        26
 220 #define WTAP_FILE_NETMON_1_x                    27
 221 #define WTAP_FILE_NETMON_2_x                    28
 222 #define WTAP_FILE_NGSNIFFER_UNCOMPRESSED        29
 223 #define WTAP_FILE_NGSNIFFER_COMPRESSED          30
 224 #define WTAP_FILE_NETXRAY_1_1                   31
 225 #define WTAP_FILE_NETXRAY_2_00x                 32
 226 #define WTAP_FILE_NETWORK_INSTRUMENTS_V9        33
 227 #define WTAP_FILE_LANALYZER                     34
 228 #define WTAP_FILE_PPPDUMP                       35
 229 #define WTAP_FILE_RADCOM                        36
 230 #define WTAP_FILE_SNOOP                         37
 231 #define WTAP_FILE_SHOMITI                       38
 232 #define WTAP_FILE_VMS                           39
 233 #define WTAP_FILE_K12                           40
 234 #define WTAP_FILE_TOSHIBA                       41
 235 #define WTAP_FILE_VISUAL_NETWORKS               42
 236 #define WTAP_FILE_ETHERPEEK_V56                 43
 237 #define WTAP_FILE_ETHERPEEK_V7                  44
 238 #define WTAP_FILE_AIROPEEK_V9                   45
 239
 240 #define WTAP_NUM_FILE_TYPES                     46
 241
 242 /* timestamp precision (currently only these values are supported) */
 243 #define WTAP_FILE_TSPREC_SEC            0
 244 #define WTAP_FILE_TSPREC_DSEC           1
 245 #define WTAP_FILE_TSPREC_CSEC           2
 246 #define WTAP_FILE_TSPREC_MSEC           3
 247 #define WTAP_FILE_TSPREC_USEC           6
 248 #define WTAP_FILE_TSPREC_NSEC           9
 249
 250 /*
 251  * Maximum packet size we'll support.
 252  * It must be at least 65535.
 253  */
 254 #define WTAP_MAX_PACKET_SIZE                    65535
 255
 256 /*
 257  * "Pseudo-headers" are used to supply to the clients of wiretap
 258  * per-packet information that's not part of the packet payload
 259  * proper.
 260  *
 261  * NOTE: do not use pseudo-header structures to hold information
 262  * used by the code to read a particular capture file type; to
 263  * keep that sort of state information, add a new structure for
 264  * that private information to "wtap-int.h", add a pointer to that
 265  * type of structure to the "capture" member of the "struct wtap"
 266  * structure, and allocate one of those structures and set that member
 267  * in the "open" routine for that capture file type if the open
 268  * succeeds.  See various other capture file type handlers for examples
 269  * of that.
 270  */
 271
 272 /* Packet "pseudo-header" information for Ethernet capture files. */
 273 struct eth_phdr {
 274         gint    fcs_len;        /* Number of bytes of FCS - -1 means "unknown" */
 275 };
 276
 277 /* Packet "pseudo-header" information for X.25 capture files. */
 278 #define FROM_DCE                        0x80
 279 struct x25_phdr {
 280         guint8  flags; /* ENCAP_LAPB, ENCAP_V120 : 1st bit means From DCE */
 281 };
 282
 283 /* Packet "pseudo-header" information for ISDN capture files. */
 284
 285 /* Direction */
 286 struct isdn_phdr {
 287         gboolean uton;
 288         guint8  channel;                /* 0 = D-channel; n = B-channel n */
 289 };
 290
 291 /* Packet "pseudo-header" for ATM capture files.
 292    Not all of this information is supplied by all capture types. */
 293
 294 /*
 295  * Status bits.
 296  */
 297 #define ATM_RAW_CELL    0x01    /* TRUE if the packet is a single cell */
 298
 299 /*
 300  * AAL types.
 301  */
 302 #define AAL_UNKNOWN     0       /* AAL unknown */
 303 #define AAL_1           1       /* AAL1 */
 304 #define AAL_2           2       /* AAL2 */
 305 #define AAL_3_4         3       /* AAL3/4 */
 306 #define AAL_5           4       /* AAL5 */
 307 #define AAL_USER        5       /* User AAL */
 308 #define AAL_SIGNALLING  6       /* Signaling AAL */
 309 #define AAL_OAMCELL     7       /* OAM cell */
 310
 311 /*
 312  * Traffic types.
 313  */
 314 #define TRAF_UNKNOWN    0       /* Unknown */
 315 #define TRAF_LLCMX      1       /* LLC multiplexed (RFC 1483) */
 316 #define TRAF_VCMX       2       /* VC multiplexed (RFC 1483) */
 317 #define TRAF_LANE       3       /* LAN Emulation */
 318 #define TRAF_ILMI       4       /* ILMI */
 319 #define TRAF_FR         5       /* Frame Relay */
 320 #define TRAF_SPANS      6       /* FORE SPANS */
 321 #define TRAF_IPSILON    7       /* Ipsilon */
 322 #define TRAF_UMTS_FP    8       /* UMTS Frame Protocol */
 323
 324 /*
 325  * Traffic subtypes.
 326  */
 327 #define TRAF_ST_UNKNOWN         0       /* Unknown */
 328
 329 /*
 330  * For TRAF_VCMX:
 331  */
 332 #define TRAF_ST_VCMX_802_3_FCS  1       /* 802.3 with an FCS */
 333 #define TRAF_ST_VCMX_802_4_FCS  2       /* 802.4 with an FCS */
 334 #define TRAF_ST_VCMX_802_5_FCS  3       /* 802.5 with an FCS */
 335 #define TRAF_ST_VCMX_FDDI_FCS   4       /* FDDI with an FCS */
 336 #define TRAF_ST_VCMX_802_6_FCS  5       /* 802.6 with an FCS */
 337 #define TRAF_ST_VCMX_802_3      7       /* 802.3 without an FCS */
 338 #define TRAF_ST_VCMX_802_4      8       /* 802.4 without an FCS */
 339 #define TRAF_ST_VCMX_802_5      9       /* 802.5 without an FCS */
 340 #define TRAF_ST_VCMX_FDDI       10      /* FDDI without an FCS */
 341 #define TRAF_ST_VCMX_802_6      11      /* 802.6 without an FCS */
 342 #define TRAF_ST_VCMX_FRAGMENTS  12      /* Fragments */
 343 #define TRAF_ST_VCMX_BPDU       13      /* BPDU */
 344
 345 /*
 346  * For TRAF_LANE:
 347  */
 348 #define TRAF_ST_LANE_LE_CTRL    1       /* LANE: LE Ctrl */
 349 #define TRAF_ST_LANE_802_3      2       /* LANE: 802.3 */
 350 #define TRAF_ST_LANE_802_5      3       /* LANE: 802.5 */
 351 #define TRAF_ST_LANE_802_3_MC   4       /* LANE: 802.3 multicast */
 352 #define TRAF_ST_LANE_802_5_MC   5       /* LANE: 802.5 multicast */
 353
 354 /*
 355  * For TRAF_IPSILON:
 356  */
 357 #define TRAF_ST_IPSILON_FT0     1       /* Ipsilon: Flow Type 0 */
 358 #define TRAF_ST_IPSILON_FT1     2       /* Ipsilon: Flow Type 1 */
 359 #define TRAF_ST_IPSILON_FT2     3       /* Ipsilon: Flow Type 2 */
 360
 361 struct atm_phdr {
 362         guint32 flags;          /* status flags */
 363         guint8  aal;            /* AAL of the traffic */
 364         guint8  type;           /* traffic type */
 365         guint8  subtype;        /* traffic subtype */
 366         guint16 vpi;            /* virtual path identifier */
 367         guint16 vci;            /* virtual circuit identifier */
 368         guint8  aal2_cid;       /* channel id */
 369         guint16 channel;        /* link: 0 for DTE->DCE, 1 for DCE->DTE */
 370         guint16 cells;          /* number of cells */
 371         guint16 aal5t_u2u;      /* user-to-user indicator */
 372         guint16 aal5t_len;      /* length of the packet */
 373         guint32 aal5t_chksum;   /* checksum for AAL5 packet */
 374 };
 375
 376 /* Packet "pseudo-header" for the output from "wandsession", "wannext",
 377    "wandisplay", and similar commands on Lucent/Ascend access equipment. */
 378
 379 #define ASCEND_MAX_STR_LEN 64
 380
 381 #define ASCEND_PFX_WDS_X 1
 382 #define ASCEND_PFX_WDS_R 2
 383 #define ASCEND_PFX_WDD   3
 384 #define ASCEND_PFX_ISDN_X 4
 385 #define ASCEND_PFX_ISDN_R 5
 386 #define ASCEND_PFX_ETHER 6
 387
 388 struct ascend_phdr {
 389         guint16 type;                   /* ASCEND_PFX_*, as defined above */
 390         char    user[ASCEND_MAX_STR_LEN];   /* Username, from wandsession header */
 391         guint32 sess;                   /* Session number, from wandsession header */
 392         char    call_num[ASCEND_MAX_STR_LEN];   /* Called number, from WDD header */
 393         guint32 chunk;                  /* Chunk number, from WDD header */
 394         guint32 task;                   /* Task number */
 395 };
 396
 397 /* Packet "pseudo-header" for point-to-point links with direction flags. */
 398 struct p2p_phdr {
 399         gboolean        sent; /* TRUE=sent, FALSE=received */
 400 };
 401
 402 /* Packet "pseudo-header" information for 802.11
 403    Radio information is only present for WTAP_ENCAP_IEEE_802_11_WITH_RADIO. */
 404 struct ieee_802_11_phdr {
 405         gint    fcs_len;        /* Number of bytes of FCS - -1 means "unknown" */
 406         guint8  channel;        /* Channel number */
 407         guint8  data_rate;      /* in .5 Mb/s units */
 408         guint8  signal_level;   /* percentage */
 409 };
 410
 411 /* Packet "pseudo-header" for the output from CoSine L2 debug output. */
 412
 413 #define COSINE_MAX_IF_NAME_LEN  128
 414
 415 #define COSINE_ENCAP_TEST       1
 416 #define COSINE_ENCAP_PPoATM     2
 417 #define COSINE_ENCAP_PPoFR      3
 418 #define COSINE_ENCAP_ATM        4
 419 #define COSINE_ENCAP_FR         5
 420 #define COSINE_ENCAP_HDLC       6
 421 #define COSINE_ENCAP_PPP        7
 422 #define COSINE_ENCAP_ETH        8
 423 #define COSINE_ENCAP_UNKNOWN    99
 424
 425 #define COSINE_DIR_TX 1
 426 #define COSINE_DIR_RX 2
 427
 428 struct cosine_phdr {
 429         guint8 encap;           /* COSINE_ENCAP_* as defined above */
 430         guint8 direction;       /* COSINE_DIR_*, as defined above */
 431         char if_name[COSINE_MAX_IF_NAME_LEN];  /* Encap & Logical I/F name */
 432         guint16 pro;            /* Protocol */
 433         guint16 off;            /* Offset */
 434         guint16 pri;            /* Priority */
 435         guint16 rm;             /* Rate Marking */
 436         guint16 err;            /* Error Code */
 437 };
 438
 439 /* Packet "pseudo-header" for IrDA capture files. */
 440
 441 /*
 442  * Direction of the packet
 443  */
 444 #define IRDA_INCOMING       0x0000
 445 #define IRDA_OUTGOING       0x0004
 446
 447 /*
 448  * "Inline" log messages produced by IrCOMM2k on Windows
 449  */
 450 #define IRDA_LOG_MESSAGE    0x0100  /* log message */
 451 #define IRDA_MISSED_MSG     0x0101  /* missed log entry or frame */
 452
 453 /*
 454  * Differentiate between frames and log messages
 455  */
 456 #define IRDA_CLASS_FRAME    0x0000
 457 #define IRDA_CLASS_LOG      0x0100
 458 #define IRDA_CLASS_MASK     0xFF00
 459
 460 struct irda_phdr {
 461         guint16 pkttype;    /* packet type */
 462 };
 463
 464 /* Packet "pseudo-header" for nettl (HP-UX) capture files. */
 465
 466 struct nettl_phdr {
 467         guint16 subsys;
 468         guint32 devid;
 469         guint32 kind;
 470         gint32  pid;
 471         guint16 uid;
 472 };
 473
 474 /* Packet "pseudo-header" for MTP2 files. */
 475
 476 struct mtp2_phdr {
 477         guint8  sent;
 478         guint8  annex_a_used;
 479         guint16 link_number;
 480 };
 481
 482 /* Packet "pseudo-header" for K12 files. */
 483
 484 typedef union {
 485         struct {
 486                 guint16 vp;
 487                 guint16 vc;
 488         guint16 cid;
 489         } atm;
 490
 491         guint32 ds0mask;
 492 } k12_input_info_t;
 493
 494 struct k12_phdr {
 495         guint32 input;
 496         const gchar* input_name;
 497         const gchar* stack_file;
 498         guint32 input_type;
 499         k12_input_info_t input_info;
 500         void* stuff;
 501 };
 502
 503 #define K12_PORT_DS0S      0x00010008
 504 #define K12_PORT_DS1       0x00100008
 505 #define K12_PORT_ATMPVC    0x01020000
 506
 507 struct wtap;
 508 struct catapult_dct2000_phdr
 509 {
 510         union
 511         {
 512                 struct isdn_phdr  isdn;
 513                 struct atm_phdr   atm;
 514                 struct p2p_phdr   p2p;
 515         } inner_pseudo_header;
 516         gint64 seek_off;
 517         struct wtap *wth;
 518 };
 519
 520 struct lapd_phdr {
 521         guint16 pkttype;    /* packet type */
 522         guint8 we_network;
 523 };
 524
 525 union wtap_pseudo_header {
 526         struct eth_phdr         eth;
 527         struct x25_phdr         x25;
 528         struct isdn_phdr        isdn;
 529         struct atm_phdr         atm;
 530         struct ascend_phdr      ascend;
 531         struct p2p_phdr         p2p;
 532         struct ieee_802_11_phdr ieee_802_11;
 533         struct cosine_phdr      cosine;
 534         struct irda_phdr        irda;
 535         struct nettl_phdr       nettl;
 536         struct mtp2_phdr        mtp2;
 537         struct k12_phdr         k12;
 538         struct lapd_phdr        lapd;
 539         struct catapult_dct2000_phdr dct2000;
 540 };
 541
 542 struct wtap_nstime {
 543         time_t  secs;
 544         int     nsecs;
 545 };
 546
 547
 548 struct wtap_pkthdr {
 549         struct wtap_nstime ts;
 550         guint32 caplen;
 551         guint32 len;
 552         int pkt_encap;
 553 };
 554
 555 struct wtap;
 556 struct Buffer;
 557 struct wtap_dumper;
 558
 559 typedef struct wtap wtap;
 560 typedef struct wtap_dumper wtap_dumper;
 561
 562 /*
 563  * On failure, "wtap_open_offline()" returns NULL, and puts into the
 564  * "int" pointed to by its second argument:
 565  *
 566  * a positive "errno" value if the capture file can't be opened;
 567  *
 568  * a negative number, indicating the type of error, on other failures.
 569  */
 570 struct wtap* wtap_open_offline(const char *filename, int *err,
 571     gchar **err_info, gboolean do_random);
 572
 573 /* Returns TRUE if read was successful. FALSE if failure. data_offset is
 574  * set the the offset in the file where the data for the read packet is
 575  * located. */
 576 gboolean wtap_read(wtap *wth, int *err, gchar **err_info,
 577     gint64 *data_offset);
 578
 579 /*
 580  * Return an approximation of the amount of data we've read sequentially
 581  * from the file so far.
 582  */
 583 gint64 wtap_read_so_far(wtap *wth, int *err);
 584
 585 struct wtap_pkthdr *wtap_phdr(wtap *wth);
 586 union wtap_pseudo_header *wtap_pseudoheader(wtap *wth);
 587 guint8 *wtap_buf_ptr(wtap *wth);
 588
 589 gint64 wtap_file_size(wtap *wth, int *err);
 590 int wtap_snapshot_length(wtap *wth); /* per file */
 591 int wtap_file_type(wtap *wth);
 592 int wtap_file_encap(wtap *wth);
 593 int wtap_file_tsprecision(wtap *wth);
 594
 595 const char *wtap_file_type_string(int filetype);
 596 const char *wtap_file_type_short_string(int filetype);
 597 int wtap_short_string_to_file_type(const char *short_name);
 598
 599 const char *wtap_file_extensions_string(int filetype);
 600 const char *wtap_file_extension_default_string(int filetype);
 601
 602 const char *wtap_encap_string(int encap);
 603 const char *wtap_encap_short_string(int encap);
 604 int wtap_short_string_to_encap(const char *short_name);
 605
 606 const char *wtap_strerror(int err);
 607 void wtap_sequential_close(wtap *wth);
 608 void wtap_close(wtap *wth);
 609 gboolean wtap_seek_read (wtap *wth, gint64 seek_off,
 610         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
 611         int *err, gchar **err_info);
 612
 613 gboolean wtap_dump_can_open(int filetype);
 614 gboolean wtap_dump_can_write_encap(int filetype, int encap);
 615 gboolean wtap_dump_can_compress(int filetype);
 616 wtap_dumper* wtap_dump_open(const char *filename, int filetype, int encap,
 617         int snaplen, gboolean compressed, int *err);
 618 wtap_dumper* wtap_dump_fdopen(int fd, int filetype, int encap, int snaplen,
 619         gboolean compressed, int *err);
 620 gboolean wtap_dump(wtap_dumper *, const struct wtap_pkthdr *,
 621         const union wtap_pseudo_header *pseudo_header, const guchar *, int *err);
 622 void wtap_dump_flush(wtap_dumper *);
 623 gboolean wtap_dump_close(wtap_dumper *, int *);
 624 gint64 wtap_get_bytes_dumped(wtap_dumper *);
 625 void wtap_set_bytes_dumped(wtap_dumper *wdh, gint64 bytes_dumped);
 626
 627 /*
 628  * Wiretap error codes.
 629  */
 630 #define WTAP_ERR_NOT_REGULAR_FILE               -1
 631         /* The file being opened for reading isn't a plain file (or pipe) */
 632 #define WTAP_ERR_RANDOM_OPEN_PIPE               -2
 633         /* The file is being opened for random access and it's a pipe */
 634 #define WTAP_ERR_FILE_UNKNOWN_FORMAT            -3
 635         /* The file being opened is not a capture file in a known format */
 636 #define WTAP_ERR_UNSUPPORTED                    -4
 637         /* Supported file type, but there's something in the file we
 638            can't support */
 639 #define WTAP_ERR_CANT_WRITE_TO_PIPE             -5
 640         /* Wiretap can't save to a pipe in the specified format */
 641 #define WTAP_ERR_CANT_OPEN                      -6
 642         /* The file couldn't be opened, reason unknown */
 643 #define WTAP_ERR_UNSUPPORTED_FILE_TYPE          -7
 644         /* Wiretap can't save files in the specified format */
 645 #define WTAP_ERR_UNSUPPORTED_ENCAP              -8
 646         /* Wiretap can't read or save files in the specified format with the
 647            specified encapsulation */
 648 #define WTAP_ERR_ENCAP_PER_PACKET_UNSUPPORTED   -9
 649         /* The specified format doesn't support per-packet encapsulations */
 650 #define WTAP_ERR_CANT_CLOSE                     -10
 651         /* The file couldn't be closed, reason unknown */
 652 #define WTAP_ERR_CANT_READ                      -11
 653         /* An attempt to read failed, reason unknown */
 654 #define WTAP_ERR_SHORT_READ                     -12
 655         /* An attempt to read read less data than it should have */
 656 #define WTAP_ERR_BAD_RECORD                     -13
 657         /* We read an invalid record */
 658 #define WTAP_ERR_SHORT_WRITE                    -14
 659         /* An attempt to write wrote less data than it should have */
 660 #define WTAP_ERR_UNC_TRUNCATED                  -15
 661         /* Sniffer compressed data was oddly truncated */
 662 #define WTAP_ERR_UNC_OVERFLOW                   -16
 663         /* Uncompressing Sniffer data would overflow buffer */
 664 #define WTAP_ERR_UNC_BAD_OFFSET                 -17
 665         /* LZ77 compressed data has bad offset to string */
 666 #define WTAP_ERR_RANDOM_OPEN_STDIN              -18
 667         /* We're trying to open the standard input for random access */
 668 #define WTAP_ERR_COMPRESSION_NOT_SUPPORTED -19
 669         /* The filetype doesn't support output compression */
 670
 671 /* Errors from zlib; zlib error Z_xxx turns into Wiretap error
 672    WTAP_ERR_ZLIB + Z_xxx.
 673
 674    WTAP_ERR_ZLIB_MIN and WTAP_ERR_ZLIB_MAX bound the range of zlib
 675    errors; we leave room for 100 positive and 100 negative error
 676    codes. */
 677
 678 #define WTAP_ERR_ZLIB                           -200
 679 #define WTAP_ERR_ZLIB_MAX                       -100
 680 #define WTAP_ERR_ZLIB_MIN                       -300
 681
 682
 683 #endif /* __WTAP_H__ */