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