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