wiretap/wtap.h

   1 /* wtap.h
   2  *
   3  * $Id: wtap.h,v 1.151 2004/01/29 10:58:28 guy Exp $
   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
  37 /* Encapsulation types. Choose names that truly reflect
  38  * what is contained in the packet trace file.
  39  *
  40  * WTAP_ENCAP_PER_PACKET is a value passed to "wtap_dump_open()" or
  41  * "wtap_dump_fd_open()" to indicate that there is no single encapsulation
  42  * type for all packets in the file; this may cause those routines to
  43  * fail if the capture file format being written can't support that.
  44  * It's also returned by "wtap_file_encap()" for capture files that
  45  * don't have a single encapsulation type for all packets in the file.
  46  *
  47  * WTAP_ENCAP_UNKNOWN is returned by "wtap_pcap_encap_to_wtap_encap()"
  48  * if it's handed an unknown encapsulation.
  49  *
  50  * WTAP_ENCAP_FDDI_BITSWAPPED is for FDDI captures on systems where the
  51  * MAC addresses you get from the hardware are bit-swapped.  Ideally,
  52  * the driver would tell us that, but I know of none that do, so, for
  53  * now, we base it on the machine on which we're *reading* the
  54  * capture, rather than on the machine on which the capture was taken
  55  * (they're probably likely to be the same).  We assume that they're
  56  * bit-swapped on everything except for systems running Ultrix, Alpha
  57  * systems, and BSD/OS systems (that's what "tcpdump" does; I guess
  58  * Digital decided to bit-swap addresses in the hardware or in the
  59  * driver, and I guess BSDI bit-swapped them in the driver, given that
  60  * BSD/OS generally runs on Boring Old PC's).  If we create a wiretap
  61  * save file format, we'd use the WTAP_ENCAP values to flag the
  62  * encapsulation of a packet, so there we'd at least be able to base
  63  * it on the machine on which the capture was taken.
  64  *
  65  * WTAP_ENCAP_LINUX_ATM_CLIP is the encapsulation you get with the
  66  * ATM on Linux code from <http://linux-atm.sourceforge.net/>;
  67  * that code adds a DLT_ATM_CLIP DLT_ code of 19, and that
  68  * encapsulation isn't the same as the DLT_ATM_RFC1483 encapsulation
  69  * presumably used on some BSD systems, which we turn into
  70  * WTAP_ENCAP_ATM_RFC1483.
  71  *
  72  * WTAP_ENCAP_NULL corresponds to DLT_NULL from "libpcap".  This
  73  * corresponds to
  74  *
  75  *      1) PPP-over-HDLC encapsulation, at least with some versions
  76  *         of ISDN4BSD (but not the current ones, it appears, unless
  77  *         I've missed something);
  78  *
  79  *      2) a 4-byte header containing the AF_ address family, in
  80  *         the byte order of the machine that saved the capture,
  81  *         for the packet, as used on many BSD systems for the
  82  *         loopback device and some other devices, or a 4-byte header
  83  *         containing the AF_ address family in network byte order,
  84  *         as used on recent OpenBSD systems for the loopback device;
  85  *
  86  *      3) a 4-byte header containing 2 octets of 0 and an Ethernet
  87  *         type in the byte order from an Ethernet header, that being
  88  *         what older versions of "libpcap" on Linux turn the Ethernet
  89  *         header for loopback interfaces into (0.6.0 and later versions
  90  *         leave the Ethernet header alone and make it DLT_EN10MB). */
  91 #define WTAP_ENCAP_PER_PACKET                   -1
  92 #define WTAP_ENCAP_UNKNOWN                      0
  93 #define WTAP_ENCAP_ETHERNET                     1
  94 #define WTAP_ENCAP_TOKEN_RING                   2
  95 #define WTAP_ENCAP_SLIP                         3
  96 #define WTAP_ENCAP_PPP                          4
  97 #define WTAP_ENCAP_FDDI                         5
  98 #define WTAP_ENCAP_FDDI_BITSWAPPED              6
  99 #define WTAP_ENCAP_RAW_IP                       7
 100 #define WTAP_ENCAP_ARCNET                       8
 101 #define WTAP_ENCAP_ARCNET_LINUX                 9
 102 #define WTAP_ENCAP_ATM_RFC1483                  10
 103 #define WTAP_ENCAP_LINUX_ATM_CLIP               11
 104 #define WTAP_ENCAP_LAPB                         12
 105 #define WTAP_ENCAP_ATM_PDUS                     13
 106 #define WTAP_ENCAP_ATM_PDUS_UNTRUNCATED         14
 107 #define WTAP_ENCAP_NULL                         15
 108 #define WTAP_ENCAP_ASCEND                       16
 109 #define WTAP_ENCAP_ISDN                         17
 110 #define WTAP_ENCAP_IP_OVER_FC                   18
 111 #define WTAP_ENCAP_PPP_WITH_PHDR                19
 112 #define WTAP_ENCAP_IEEE_802_11                  20
 113 #define WTAP_ENCAP_PRISM_HEADER                 21
 114 #define WTAP_ENCAP_IEEE_802_11_WITH_RADIO       22
 115 #define WTAP_ENCAP_IEEE_802_11_WLAN_BSD         23
 116 #define WTAP_ENCAP_IEEE_802_11_WLAN_AVS         24
 117 #define WTAP_ENCAP_SLL                          25
 118 #define WTAP_ENCAP_FRELAY                       26
 119 #define WTAP_ENCAP_FRELAY_WITH_PHDR             27
 120 #define WTAP_ENCAP_CHDLC                        28
 121 #define WTAP_ENCAP_CISCO_IOS                    29
 122 #define WTAP_ENCAP_LOCALTALK                    30
 123 #define WTAP_ENCAP_OLD_PFLOG                    31
 124 #define WTAP_ENCAP_HHDLC                        32
 125 #define WTAP_ENCAP_DOCSIS                       33
 126 #define WTAP_ENCAP_COSINE                       34
 127 #define WTAP_ENCAP_WFLEET_HDLC                  35
 128 #define WTAP_ENCAP_SDLC                         36
 129 #define WTAP_ENCAP_TZSP                         37
 130 #define WTAP_ENCAP_ENC                          38
 131 #define WTAP_ENCAP_PFLOG                        39
 132 #define WTAP_ENCAP_CHDLC_WITH_PHDR              40
 133 #define WTAP_ENCAP_BLUETOOTH_H4                 41
 134 #define WTAP_ENCAP_MTP2                         42
 135 #define WTAP_ENCAP_MTP3                         43
 136 #define WTAP_ENCAP_IRDA                         44
 137 #define WTAP_ENCAP_USER0                        45
 138 #define WTAP_ENCAP_USER1                        46
 139 #define WTAP_ENCAP_USER2                        47
 140 #define WTAP_ENCAP_USER3                        48
 141 #define WTAP_ENCAP_USER4                        49
 142 #define WTAP_ENCAP_USER5                        50
 143 #define WTAP_ENCAP_USER6                        51
 144 #define WTAP_ENCAP_USER7                        52
 145 #define WTAP_ENCAP_USER8                        53
 146 #define WTAP_ENCAP_USER9                        54
 147 #define WTAP_ENCAP_USER10                       55
 148 #define WTAP_ENCAP_USER11                       56
 149 #define WTAP_ENCAP_USER12                       57
 150 #define WTAP_ENCAP_USER13                       58
 151 #define WTAP_ENCAP_USER14                       59
 152 #define WTAP_ENCAP_USER15                       60
 153
 154 /* last WTAP_ENCAP_ value + 1 */
 155 #define WTAP_NUM_ENCAP_TYPES                    61
 156
 157 /* File types that can be read by wiretap.
 158    We support writing some many of these file types, too, so we
 159    distinguish between different versions of them. */
 160 #define WTAP_FILE_UNKNOWN                       0
 161 #define WTAP_FILE_WTAP                          1
 162 #define WTAP_FILE_PCAP                          2
 163 #define WTAP_FILE_PCAP_SS990417                 3
 164 #define WTAP_FILE_PCAP_SS990915                 4
 165 #define WTAP_FILE_PCAP_SS991029                 5
 166 #define WTAP_FILE_PCAP_NOKIA                    6
 167 #define WTAP_FILE_PCAP_AIX                      7
 168 #define WTAP_FILE_LANALYZER                     8
 169 #define WTAP_FILE_NGSNIFFER_UNCOMPRESSED        9
 170 #define WTAP_FILE_NGSNIFFER_COMPRESSED          10
 171 #define WTAP_FILE_SNOOP                         11
 172 #define WTAP_FILE_SHOMITI                       12
 173 #define WTAP_FILE_IPTRACE_1_0                   13
 174 #define WTAP_FILE_IPTRACE_2_0                   14
 175 #define WTAP_FILE_NETMON_1_x                    15
 176 #define WTAP_FILE_NETMON_2_x                    16
 177 #define WTAP_FILE_NETXRAY_OLD                   17
 178 #define WTAP_FILE_NETXRAY_1_0                   18
 179 #define WTAP_FILE_NETXRAY_1_1                   19
 180 #define WTAP_FILE_NETXRAY_2_00x                 20
 181 #define WTAP_FILE_RADCOM                        21
 182 #define WTAP_FILE_ASCEND                        22
 183 #define WTAP_FILE_NETTL                         23
 184 #define WTAP_FILE_TOSHIBA                       24
 185 #define WTAP_FILE_I4BTRACE                      25
 186 #define WTAP_FILE_CSIDS                         26
 187 #define WTAP_FILE_PPPDUMP                       27
 188 #define WTAP_FILE_ETHERPEEK_V56                 28
 189 #define WTAP_FILE_ETHERPEEK_V7                  29
 190 #define WTAP_FILE_VMS                           30
 191 #define WTAP_FILE_DBS_ETHERWATCH                31
 192 #define WTAP_FILE_VISUAL_NETWORKS               32
 193 #define WTAP_FILE_COSINE                        33
 194 #define WTAP_FILE_5VIEWS                        34
 195 #define WTAP_FILE_ERF                           35
 196 #define WTAP_FILE_HCIDUMP                       36
 197 #define WTAP_FILE_NETWORK_INSTRUMENTS_V9        37
 198 #define WTAP_FILE_AIROPEEK_V9                   38
 199
 200 /* last WTAP_FILE_ value + 1 */
 201 #define WTAP_NUM_FILE_TYPES                     39
 202
 203 /*
 204  * Maximum packet size we'll support.
 205  * It must be at least 65535.
 206  */
 207 #define WTAP_MAX_PACKET_SIZE                    65535
 208
 209 /*
 210  * "Pseudo-headers" are used to supply to the clients of wiretap
 211  * per-packet information that's not part of the packet payload
 212  * proper.
 213  *
 214  * NOTE: do not use pseudo-header structures to hold information
 215  * used by the code to read a particular capture file type; to
 216  * keep that sort of state information, add a new structure for
 217  * that private information to "wtap-int.h", add a pointer to that
 218  * type of structure to the "capture" member of the "struct wtap"
 219  * structure, and allocate one of those structures and set that member
 220  * in the "open" routine for that capture file type if the open
 221  * succeeds.  See various other capture file type handlers for examples
 222  * of that.
 223  */
 224
 225 /* Packet "pseudo-header" information for Ethernet capture files. */
 226 struct eth_phdr {
 227         gint    fcs_len;        /* Number of bytes of FCS - -1 means "unknown" */
 228 };
 229
 230 /* Packet "pseudo-header" information for X.25 capture files. */
 231 #define FROM_DCE                        0x80
 232 struct x25_phdr {
 233         guint8  flags; /* ENCAP_LAPB, ENCAP_V120 : 1st bit means From DCE */
 234 };
 235
 236 /* Packet "pseudo-header" information for ISDN capture files. */
 237
 238 /* Direction */
 239 struct isdn_phdr {
 240         gboolean uton;
 241         guint8  channel;                /* 0 = D-channel; n = B-channel n */
 242 };
 243
 244 /* Packet "pseudo-header" for ATM capture files.
 245    Not all of this information is supplied by all capture types. */
 246
 247 /*
 248  * Status bits.
 249  */
 250 #define ATM_RAW_CELL    0x01    /* TRUE if the packet is a single cell */
 251
 252 /*
 253  * AAL types.
 254  */
 255 #define AAL_UNKNOWN     0       /* AAL unknown */
 256 #define AAL_1           1       /* AAL1 */
 257 #define AAL_2           2       /* AAL2 */
 258 #define AAL_3_4         3       /* AAL3/4 */
 259 #define AAL_5           4       /* AAL5 */
 260 #define AAL_USER        5       /* User AAL */
 261 #define AAL_SIGNALLING  6       /* Signaling AAL */
 262 #define AAL_OAMCELL     7       /* OAM cell */
 263
 264 /*
 265  * Traffic types.
 266  */
 267 #define TRAF_UNKNOWN    0       /* Unknown */
 268 #define TRAF_LLCMX      1       /* LLC multiplexed (RFC 1483) */
 269 #define TRAF_VCMX       2       /* VC multiplexed (RFC 1483) */
 270 #define TRAF_LANE       3       /* LAN Emulation */
 271 #define TRAF_ILMI       4       /* ILMI */
 272 #define TRAF_FR         5       /* Frame Relay */
 273 #define TRAF_SPANS      6       /* FORE SPANS */
 274 #define TRAF_IPSILON    7       /* Ipsilon */
 275
 276 /*
 277  * Traffic subtypes.
 278  */
 279 #define TRAF_ST_UNKNOWN         0       /* Unknown */
 280
 281 /*
 282  * For TRAF_VCMX:
 283  */
 284 #define TRAF_ST_VCMX_802_3_FCS  1       /* 802.3 with an FCS */
 285 #define TRAF_ST_VCMX_802_4_FCS  2       /* 802.4 with an FCS */
 286 #define TRAF_ST_VCMX_802_5_FCS  3       /* 802.5 with an FCS */
 287 #define TRAF_ST_VCMX_FDDI_FCS   4       /* FDDI with an FCS */
 288 #define TRAF_ST_VCMX_802_6_FCS  5       /* 802.6 with an FCS */
 289 #define TRAF_ST_VCMX_802_3      7       /* 802.3 without an FCS */
 290 #define TRAF_ST_VCMX_802_4      8       /* 802.4 without an FCS */
 291 #define TRAF_ST_VCMX_802_5      9       /* 802.5 without an FCS */
 292 #define TRAF_ST_VCMX_FDDI       10      /* FDDI without an FCS */
 293 #define TRAF_ST_VCMX_802_6      11      /* 802.6 without an FCS */
 294 #define TRAF_ST_VCMX_FRAGMENTS  12      /* Fragments */
 295 #define TRAF_ST_VCMX_BPDU       13      /* BPDU */
 296
 297 /*
 298  * For TRAF_LANE:
 299  */
 300 #define TRAF_ST_LANE_LE_CTRL    1       /* LANE: LE Ctrl */
 301 #define TRAF_ST_LANE_802_3      2       /* LANE: 802.3 */
 302 #define TRAF_ST_LANE_802_5      3       /* LANE: 802.5 */
 303 #define TRAF_ST_LANE_802_3_MC   4       /* LANE: 802.3 multicast */
 304 #define TRAF_ST_LANE_802_5_MC   5       /* LANE: 802.5 multicast */
 305
 306 /*
 307  * For TRAF_IPSILON:
 308  */
 309 #define TRAF_ST_IPSILON_FT0     1       /* Ipsilon: Flow Type 0 */
 310 #define TRAF_ST_IPSILON_FT1     2       /* Ipsilon: Flow Type 1 */
 311 #define TRAF_ST_IPSILON_FT2     3       /* Ipsilon: Flow Type 2 */
 312
 313 struct atm_phdr {
 314         guint32 flags;          /* status flags */
 315         guint8  aal;            /* AAL of the traffic */
 316         guint8  type;           /* traffic type */
 317         guint8  subtype;        /* traffic subtype */
 318         guint16 vpi;            /* virtual path identifier */
 319         guint16 vci;            /* virtual circuit identifier */
 320         guint16 channel;        /* link: 0 for DTE->DCE, 1 for DCE->DTE */
 321         guint16 cells;          /* number of cells */
 322         guint16 aal5t_u2u;      /* user-to-user indicator */
 323         guint16 aal5t_len;      /* length of the packet */
 324         guint32 aal5t_chksum;   /* checksum for AAL5 packet */
 325 };
 326
 327 /* Packet "pseudo-header" for the output from "wandsession", "wannext",
 328    "wandisplay", and similar commands on Lucent/Ascend access equipment. */
 329
 330 #define ASCEND_MAX_STR_LEN 64
 331
 332 #define ASCEND_PFX_WDS_X 1
 333 #define ASCEND_PFX_WDS_R 2
 334 #define ASCEND_PFX_WDD   3
 335
 336 struct ascend_phdr {
 337         guint16 type;                   /* ASCEND_PFX_*, as defined above */
 338         char    user[ASCEND_MAX_STR_LEN];   /* Username, from wandsession header */
 339         guint32 sess;                   /* Session number, from wandsession header */
 340         char    call_num[ASCEND_MAX_STR_LEN];   /* Called number, from WDD header */
 341         guint32 chunk;                  /* Chunk number, from WDD header */
 342         guint32 task;                   /* Task number */
 343 };
 344
 345 /* Packet "pseudo-header" for point-to-point links with direction flags. */
 346 struct p2p_phdr {
 347         gboolean        sent; /* TRUE=sent, FALSE=received */
 348 };
 349
 350 /* Packet "pseudo-header" information for 802.11
 351    Radio information is only present for WTAP_ENCAP_IEEE_802_11_WITH_RADIO. */
 352 struct ieee_802_11_phdr {
 353         gint    fcs_len;        /* Number of bytes of FCS - -1 means "unknown" */
 354         guint8  channel;        /* Channel number */
 355         guint8  data_rate;      /* in .5 Mb/s units */
 356         guint8  signal_level;   /* percentage */
 357 };
 358
 359 /* Packet "pseudo-header" for the output from CoSine L2 debug output. */
 360
 361 #define COSINE_MAX_IF_NAME_LEN  128
 362
 363 #define COSINE_ENCAP_TEST       1
 364 #define COSINE_ENCAP_PPoATM     2
 365 #define COSINE_ENCAP_PPoFR      3
 366 #define COSINE_ENCAP_ATM        4
 367 #define COSINE_ENCAP_FR         5
 368 #define COSINE_ENCAP_HDLC       6
 369 #define COSINE_ENCAP_PPP        7
 370 #define COSINE_ENCAP_ETH        8
 371 #define COSINE_ENCAP_UNKNOWN    99
 372
 373 #define COSINE_DIR_TX 1
 374 #define COSINE_DIR_RX 2
 375
 376 struct cosine_phdr {
 377         guint8 encap;           /* COSINE_ENCAP_* as defined above */
 378         guint8 direction;       /* COSINE_DIR_*, as defined above */
 379         char if_name[COSINE_MAX_IF_NAME_LEN];  /* Encap & Logical I/F name */
 380         guint16 pro;            /* Protocol */
 381         guint16 off;            /* Offset */
 382         guint16 pri;            /* Priority */
 383         guint16 rm;             /* Rate Marking */
 384         guint16 err;            /* Error Code */
 385 };
 386
 387 /* Packet "pseudo-header" for IrDA capture files. */
 388
 389 /*
 390  * Direction of the packet
 391  */
 392 #define IRDA_INCOMING       0x0000
 393 #define IRDA_OUTGOING       0x0004
 394
 395 /*
 396  * "Inline" log messages produced by IrCOMM2k on Windows
 397  */
 398 #define IRDA_LOG_MESSAGE    0x0100  /* log message */
 399 #define IRDA_MISSED_MSG     0x0101  /* missed log entry or frame */
 400
 401 /*
 402  * Differentiate between frames and log messages
 403  */
 404 #define IRDA_CLASS_FRAME    0x0000
 405 #define IRDA_CLASS_LOG      0x0100
 406 #define IRDA_CLASS_MASK     0xFF00
 407
 408 struct irda_phdr {
 409         guint16 pkttype;    /* packet type */
 410 };
 411
 412 union wtap_pseudo_header {
 413         struct eth_phdr         eth;
 414         struct x25_phdr         x25;
 415         struct isdn_phdr        isdn;
 416         struct atm_phdr         atm;
 417         struct ascend_phdr      ascend;
 418         struct p2p_phdr         p2p;
 419         struct ieee_802_11_phdr ieee_802_11;
 420         struct cosine_phdr      cosine;
 421         struct irda_phdr        irda;
 422 };
 423
 424 struct wtap_pkthdr {
 425         struct timeval ts;
 426         guint32 caplen;
 427         guint32 len;
 428         int pkt_encap;
 429 };
 430
 431 typedef void (*wtap_handler)(guchar*, const struct wtap_pkthdr*,
 432                 long, union wtap_pseudo_header *pseudo_header, const guchar *);
 433
 434 struct wtap;
 435 struct Buffer;
 436 struct wtap_dumper;
 437
 438 typedef struct wtap wtap;
 439 typedef struct wtap_dumper wtap_dumper;
 440
 441 /*
 442  * On failure, "wtap_open_offline()" returns NULL, and puts into the
 443  * "int" pointed to by its second argument:
 444  *
 445  * a positive "errno" value if the capture file can't be opened;
 446  *
 447  * a negative number, indicating the type of error, on other failures.
 448  */
 449 struct wtap* wtap_open_offline(const char *filename, int *err,
 450     gchar **err_info, gboolean do_random);
 451
 452 /* Returns TRUE if entire loop-reading was successful. If read failure
 453  * happened, FALSE is returned and err is set. */
 454 gboolean wtap_loop(wtap *wth, int, wtap_handler, guchar*, int *err,
 455     gchar **err_info);
 456
 457 /* Returns TRUE if read was successful. FALSE if failure. data_offset is
 458  * set the the offset in the file where the data for the read packet is
 459  * located. */
 460 gboolean wtap_read(wtap *wth, int *err, gchar **err_info,
 461     long *data_offset);
 462
 463 struct wtap_pkthdr *wtap_phdr(wtap *wth);
 464 union wtap_pseudo_header *wtap_pseudoheader(wtap *wth);
 465 guint8 *wtap_buf_ptr(wtap *wth);
 466
 467 int wtap_fd(wtap *wth);
 468 int wtap_snapshot_length(wtap *wth); /* per file */
 469 int wtap_file_type(wtap *wth);
 470 int wtap_file_encap(wtap *wth);
 471
 472 const char *wtap_file_type_string(int filetype);
 473 const char *wtap_file_type_short_string(int filetype);
 474 int wtap_short_string_to_file_type(const char *short_name);
 475
 476 const char *wtap_encap_string(int encap);
 477 const char *wtap_encap_short_string(int encap);
 478 int wtap_short_string_to_encap(const char *short_name);
 479
 480 const char *wtap_strerror(int err);
 481 void wtap_sequential_close(wtap *wth);
 482 void wtap_close(wtap *wth);
 483 gboolean wtap_seek_read (wtap *wth, long seek_off,
 484         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
 485         int *err, gchar **err_info);
 486
 487 gboolean wtap_dump_can_open(int filetype);
 488 gboolean wtap_dump_can_write_encap(int filetype, int encap);
 489 wtap_dumper* wtap_dump_open(const char *filename, int filetype, int encap,
 490         int snaplen, int *err);
 491 wtap_dumper* wtap_dump_fdopen(int fd, int filetype, int encap, int snaplen,
 492         int *err);
 493 gboolean wtap_dump(wtap_dumper *, const struct wtap_pkthdr *,
 494         const union wtap_pseudo_header *pseudo_header, const guchar *, int *err);
 495 FILE* wtap_dump_file(wtap_dumper *);
 496 gboolean wtap_dump_close(wtap_dumper *, int *);
 497 long wtap_get_bytes_dumped(wtap_dumper *);
 498 void wtap_set_bytes_dumped(wtap_dumper *wdh, long bytes_dumped);
 499
 500 /*
 501  * Wiretap error codes.
 502  */
 503 #define WTAP_ERR_NOT_REGULAR_FILE               -1
 504         /* The file being opened for reading isn't a plain file (or pipe) */
 505 #define WTAP_ERR_RANDOM_OPEN_PIPE               -2
 506         /* The file is being opened for random access and it's a pipe */
 507 #define WTAP_ERR_FILE_UNKNOWN_FORMAT            -3
 508         /* The file being opened is not a capture file in a known format */
 509 #define WTAP_ERR_UNSUPPORTED                    -4
 510         /* Supported file type, but there's something in the file we
 511            can't support */
 512 #define WTAP_ERR_CANT_WRITE_TO_PIPE             -5
 513         /* Wiretap can't save to a pipe in the specified format */
 514 #define WTAP_ERR_CANT_OPEN                      -6
 515         /* The file couldn't be opened, reason unknown */
 516 #define WTAP_ERR_UNSUPPORTED_FILE_TYPE          -7
 517         /* Wiretap can't save files in the specified format */
 518 #define WTAP_ERR_UNSUPPORTED_ENCAP              -8
 519         /* Wiretap can't read or save files in the specified format with the
 520            specified encapsulation */
 521 #define WTAP_ERR_ENCAP_PER_PACKET_UNSUPPORTED   -9
 522         /* The specified format doesn't support per-packet encapsulations */
 523 #define WTAP_ERR_CANT_CLOSE                     -10
 524         /* The file couldn't be closed, reason unknown */
 525 #define WTAP_ERR_CANT_READ                      -11
 526         /* An attempt to read failed, reason unknown */
 527 #define WTAP_ERR_SHORT_READ                     -12
 528         /* An attempt to read read less data than it should have */
 529 #define WTAP_ERR_BAD_RECORD                     -13
 530         /* We read an invalid record */
 531 #define WTAP_ERR_SHORT_WRITE                    -14
 532         /* An attempt to write wrote less data than it should have */
 533 #define WTAP_ERR_UNC_TRUNCATED                  -15
 534         /* Sniffer compressed data was oddly truncated */
 535 #define WTAP_ERR_UNC_OVERFLOW                   -16
 536         /* Uncompressing Sniffer data would overflow buffer */
 537 #define WTAP_ERR_UNC_BAD_OFFSET                 -17
 538         /* LZ77 compressed data has bad offset to string */
 539
 540 /* Errors from zlib; zlib error Z_xxx turns into Wiretap error
 541    WTAP_ERR_ZLIB + Z_xxx.
 542
 543    WTAP_ERR_ZLIB_MIN and WTAP_ERR_ZLIB_MAX bound the range of zlib
 544    errors; we leave room for 100 positive and 100 negative error
 545    codes. */
 546
 547 #define WTAP_ERR_ZLIB                           -200
 548 #define WTAP_ERR_ZLIB_MAX                       -100
 549 #define WTAP_ERR_ZLIB_MIN                       -300
 550
 551
 552 #endif /* __WTAP_H__ */