Based on patch from Denis Ovsienko via
[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 <time.h>
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif /* __cplusplus */
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_RADIOTAP    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 #define WTAP_ENCAP_SYMANTEC                     61
154 #define WTAP_ENCAP_APPLE_IP_OVER_IEEE1394       62
155 #define WTAP_ENCAP_BACNET_MS_TP                 63
156 #define WTAP_ENCAP_NETTL_RAW_ICMP               64
157 #define WTAP_ENCAP_NETTL_RAW_ICMPV6             65
158 #define WTAP_ENCAP_GPRS_LLC                     66
159 #define WTAP_ENCAP_JUNIPER_ATM1                 67
160 #define WTAP_ENCAP_JUNIPER_ATM2                 68
161 #define WTAP_ENCAP_REDBACK                      69
162 #define WTAP_ENCAP_NETTL_RAW_IP                 70
163 #define WTAP_ENCAP_NETTL_ETHERNET               71
164 #define WTAP_ENCAP_NETTL_TOKEN_RING             72
165 #define WTAP_ENCAP_NETTL_FDDI                   73
166 #define WTAP_ENCAP_NETTL_UNKNOWN                74
167 #define WTAP_ENCAP_MTP2_WITH_PHDR               75
168 #define WTAP_ENCAP_JUNIPER_PPPOE                76
169 #define WTAP_ENCAP_GCOM_TIE1                    77
170 #define WTAP_ENCAP_GCOM_SERIAL                  78
171 #define WTAP_ENCAP_NETTL_X25                    79
172 #define WTAP_ENCAP_K12                          80
173 #define WTAP_ENCAP_JUNIPER_MLPPP                81
174 #define WTAP_ENCAP_JUNIPER_MLFR                 82
175 #define WTAP_ENCAP_JUNIPER_ETHER                83
176 #define WTAP_ENCAP_JUNIPER_PPP                  84
177 #define WTAP_ENCAP_JUNIPER_FRELAY               85
178 #define WTAP_ENCAP_JUNIPER_CHDLC                86
179 #define WTAP_ENCAP_JUNIPER_GGSN                 87
180 #define WTAP_ENCAP_LINUX_LAPD                   88
181 #define WTAP_ENCAP_CATAPULT_DCT2000             89
182 #define WTAP_ENCAP_BER                          90
183 #define WTAP_ENCAP_JUNIPER_VP                   91
184 #define WTAP_ENCAP_USB                          92
185 #define WTAP_ENCAP_IEEE802_16_MAC_CPS           93
186 #define WTAP_ENCAP_NETTL_RAW_TELNET             94
187 #define WTAP_ENCAP_USB_LINUX                    95
188 #define WTAP_ENCAP_MPEG                         96
189 #define WTAP_ENCAP_PPI                          97
190 #define WTAP_ENCAP_ERF                          98
191 #define WTAP_ENCAP_BLUETOOTH_H4_WITH_PHDR       99
192 #define WTAP_ENCAP_SITA                         100
193 #define WTAP_ENCAP_SCCP                         101
194 #define WTAP_ENCAP_BLUETOOTH_HCI                102 /*raw packets without a transport layer header e.g. H4*/
195 #define WTAP_ENCAP_IPMB                         103
196 #define WTAP_ENCAP_IEEE802_15_4                 104
197 #define WTAP_ENCAP_X2E_XORAYA                   105
198 #define WTAP_ENCAP_FLEXRAY                      106
199 #define WTAP_ENCAP_LIN                          107
200 #define WTAP_ENCAP_MOST                         108
201 #define WTAP_ENCAP_CAN20B                       109
202 #define WTAP_ENCAP_LAYER1_EVENT                 110
203 #define WTAP_ENCAP_X2E_SERIAL                   111
204 #define WTAP_ENCAP_I2C                          112
205 #define WTAP_ENCAP_IEEE802_15_4_NONASK_PHY      113
206 #define WTAP_ENCAP_TNEF                         114
207 #define WTAP_ENCAP_USB_LINUX_MMAPPED            115
208 #define WTAP_ENCAP_GSM_UM                       116
209 #define WTAP_ENCAP_DPNSS                        117
210 #define WTAP_ENCAP_PACKETLOGGER                 118
211 #define WTAP_ENCAP_NSTRACE_1_0                  119
212 #define WTAP_ENCAP_NSTRACE_2_0                  120
213 #define WTAP_ENCAP_FIBRE_CHANNEL_FC2            121
214 #define WTAP_ENCAP_FIBRE_CHANNEL_FC2_WITH_FRAME_DELIMS 122
215 #define WTAP_ENCAP_JPEG_JFIF                    123     /* obsoleted by WTAP_ENCAP_MIME*/
216 #define WTAP_ENCAP_IPNET                        124
217 #define WTAP_ENCAP_SOCKETCAN                    125
218 #define WTAP_ENCAP_IEEE802_11_NETMON_RADIO      126
219 #define WTAP_ENCAP_IEEE802_15_4_NOFCS           127
220 #define WTAP_ENCAP_RAW_IPFIX                    128
221 #define WTAP_ENCAP_RAW_IP4                      129
222 #define WTAP_ENCAP_RAW_IP6                      130
223 #define WTAP_ENCAP_LAPD                         131
224 #define WTAP_ENCAP_DVBCI                        132
225 #define WTAP_ENCAP_MUX27010                     133
226 #define WTAP_ENCAP_MIME                         134
227
228 #define WTAP_NUM_ENCAP_TYPES                    wtap_get_num_encap_types()
229
230 /* File types that can be read by wiretap.
231    We support writing some many of these file types, too, so we
232    distinguish between different versions of them. */
233 #define WTAP_FILE_UNKNOWN                       0
234 #define WTAP_FILE_WTAP                          1
235 #define WTAP_FILE_PCAP                          2
236 #define WTAP_FILE_PCAP_NSEC                     3
237 #define WTAP_FILE_PCAP_AIX                      4
238 #define WTAP_FILE_PCAP_SS991029                 5
239 #define WTAP_FILE_PCAP_NOKIA                    6
240 #define WTAP_FILE_PCAP_SS990417                 7
241 #define WTAP_FILE_PCAP_SS990915                 8
242 #define WTAP_FILE_5VIEWS                        9
243 #define WTAP_FILE_IPTRACE_1_0                   10
244 #define WTAP_FILE_IPTRACE_2_0                   11
245 #define WTAP_FILE_BER                           12
246 #define WTAP_FILE_HCIDUMP                       13
247 #define WTAP_FILE_CATAPULT_DCT2000              14
248 #define WTAP_FILE_NETXRAY_OLD                   15
249 #define WTAP_FILE_NETXRAY_1_0                   16
250 #define WTAP_FILE_COSINE                        17
251 #define WTAP_FILE_CSIDS                         18
252 #define WTAP_FILE_DBS_ETHERWATCH                19
253 #define WTAP_FILE_ERF                           20
254 #define WTAP_FILE_EYESDN                        21
255 #define WTAP_FILE_NETTL                         22
256 #define WTAP_FILE_ISERIES                       23
257 #define WTAP_FILE_ISERIES_UNICODE               24
258 #define WTAP_FILE_I4BTRACE                      25
259 #define WTAP_FILE_ASCEND                        26
260 #define WTAP_FILE_NETMON_1_x                    27
261 #define WTAP_FILE_NETMON_2_x                    28
262 #define WTAP_FILE_NGSNIFFER_UNCOMPRESSED        29
263 #define WTAP_FILE_NGSNIFFER_COMPRESSED          30
264 #define WTAP_FILE_NETXRAY_1_1                   31
265 #define WTAP_FILE_NETXRAY_2_00x                 32
266 #define WTAP_FILE_NETWORK_INSTRUMENTS           33
267 #define WTAP_FILE_LANALYZER                     34
268 #define WTAP_FILE_PPPDUMP                       35
269 #define WTAP_FILE_RADCOM                        36
270 #define WTAP_FILE_SNOOP                         37
271 #define WTAP_FILE_SHOMITI                       38
272 #define WTAP_FILE_VMS                           39
273 #define WTAP_FILE_K12                           40
274 #define WTAP_FILE_TOSHIBA                       41
275 #define WTAP_FILE_VISUAL_NETWORKS               42
276 #define WTAP_FILE_ETHERPEEK_V56                 43
277 #define WTAP_FILE_ETHERPEEK_V7                  44
278 #define WTAP_FILE_AIROPEEK_V9                   45
279 #define WTAP_FILE_MPEG                          46
280 #define WTAP_FILE_K12TEXT                       47
281 #define WTAP_FILE_NETSCREEN                     48
282 #define WTAP_FILE_COMMVIEW                      49
283 #define WTAP_FILE_PCAPNG                        50
284 #define WTAP_FILE_BTSNOOP                       51
285 #define WTAP_FILE_X2E_XORAYA                    52
286 #define WTAP_FILE_TNEF                          53
287 #define WTAP_FILE_DCT3TRACE                     54
288 #define WTAP_FILE_PACKETLOGGER                  55
289 #define WTAP_FILE_DAINTREE_SNA                  56
290 #define WTAP_FILE_NETSCALER_1_0                 57
291 #define WTAP_FILE_NETSCALER_2_0                 58
292 #define WTAP_FILE_JPEG_JFIF                     59 /* obsoleted by WTAP_FILE_MIME */
293 #define WTAP_FILE_IPFIX                         60
294 #define WTAP_FILE_MIME                          61
295
296 #define WTAP_NUM_FILE_TYPES                     wtap_get_num_file_types()
297
298 /* timestamp precision (currently only these values are supported) */
299 #define WTAP_FILE_TSPREC_SEC            0
300 #define WTAP_FILE_TSPREC_DSEC           1
301 #define WTAP_FILE_TSPREC_CSEC           2
302 #define WTAP_FILE_TSPREC_MSEC           3
303 #define WTAP_FILE_TSPREC_USEC           6
304 #define WTAP_FILE_TSPREC_NSEC           9
305
306 /*
307  * Maximum packet size we'll support.
308  * 65535 is the largest snapshot length that libpcap supports, so we
309  * use that.
310  */
311 #define WTAP_MAX_PACKET_SIZE                    65535
312
313 /*
314  * "Pseudo-headers" are used to supply to the clients of wiretap
315  * per-packet information that's not part of the packet payload
316  * proper.
317  *
318  * NOTE: do not use pseudo-header structures to hold information
319  * used by the code to read a particular capture file type; to
320  * keep that sort of state information, add a new structure for
321  * that private information to "wtap-int.h", add a pointer to that
322  * type of structure to the "capture" member of the "struct wtap"
323  * structure, and allocate one of those structures and set that member
324  * in the "open" routine for that capture file type if the open
325  * succeeds.  See various other capture file type handlers for examples
326  * of that.
327  */
328
329
330 struct nstr_phdr {
331         gint64 rec_offset;
332         gint32 rec_len;
333         guint8 nicno_offset;
334         guint8 nicno_len;
335         guint8 dir_offset;
336         guint8 dir_len;
337         guint8 eth_offset;
338         guint8 pcb_offset;
339         guint8 l_pcb_offset;
340         guint8 rec_type;
341         guint8 vlantag_offset;
342         guint8 coreid_offset;
343 };
344
345 /* Packet "pseudo-header" information for Ethernet capture files. */
346 struct eth_phdr {
347         gint    fcs_len;        /* Number of bytes of FCS - -1 means "unknown" */
348 };
349
350 /* Packet "pseudo-header" information for X.25 capture files. */
351 #define FROM_DCE                        0x80
352 struct x25_phdr {
353         guint8  flags; /* ENCAP_LAPB, ENCAP_V120 : 1st bit means From DCE */
354 };
355
356 /* Packet "pseudo-header" information for ISDN capture files. */
357
358 /* Direction */
359 struct isdn_phdr {
360         gboolean uton;
361         guint8  channel;                /* 0 = D-channel; n = B-channel n */
362 };
363
364 /* Packet "pseudo-header" for ATM capture files.
365    Not all of this information is supplied by all capture types. */
366
367 /*
368  * Status bits.
369  */
370 #define ATM_RAW_CELL    0x01    /* TRUE if the packet is a single cell */
371 #define ATM_NO_HEC      0x02    /* TRUE if the cell has HEC stripped out */
372 #define ATM_AAL2_NOPHDR 0x04    /* TRUE if the AAL2 PDU has no pseudo-header */
373
374 /*
375  * AAL types.
376  */
377 #define AAL_UNKNOWN     0       /* AAL unknown */
378 #define AAL_1           1       /* AAL1 */
379 #define AAL_2           2       /* AAL2 */
380 #define AAL_3_4         3       /* AAL3/4 */
381 #define AAL_5           4       /* AAL5 */
382 #define AAL_USER        5       /* User AAL */
383 #define AAL_SIGNALLING  6       /* Signaling AAL */
384 #define AAL_OAMCELL     7       /* OAM cell */
385
386 /*
387  * Traffic types.
388  */
389 #define TRAF_UNKNOWN    0       /* Unknown */
390 #define TRAF_LLCMX      1       /* LLC multiplexed (RFC 1483) */
391 #define TRAF_VCMX       2       /* VC multiplexed (RFC 1483) */
392 #define TRAF_LANE       3       /* LAN Emulation */
393 #define TRAF_ILMI       4       /* ILMI */
394 #define TRAF_FR         5       /* Frame Relay */
395 #define TRAF_SPANS      6       /* FORE SPANS */
396 #define TRAF_IPSILON    7       /* Ipsilon */
397 #define TRAF_UMTS_FP    8       /* UMTS Frame Protocol */
398
399 /*
400  * Traffic subtypes.
401  */
402 #define TRAF_ST_UNKNOWN         0       /* Unknown */
403
404 /*
405  * For TRAF_VCMX:
406  */
407 #define TRAF_ST_VCMX_802_3_FCS  1       /* 802.3 with an FCS */
408 #define TRAF_ST_VCMX_802_4_FCS  2       /* 802.4 with an FCS */
409 #define TRAF_ST_VCMX_802_5_FCS  3       /* 802.5 with an FCS */
410 #define TRAF_ST_VCMX_FDDI_FCS   4       /* FDDI with an FCS */
411 #define TRAF_ST_VCMX_802_6_FCS  5       /* 802.6 with an FCS */
412 #define TRAF_ST_VCMX_802_3      7       /* 802.3 without an FCS */
413 #define TRAF_ST_VCMX_802_4      8       /* 802.4 without an FCS */
414 #define TRAF_ST_VCMX_802_5      9       /* 802.5 without an FCS */
415 #define TRAF_ST_VCMX_FDDI       10      /* FDDI without an FCS */
416 #define TRAF_ST_VCMX_802_6      11      /* 802.6 without an FCS */
417 #define TRAF_ST_VCMX_FRAGMENTS  12      /* Fragments */
418 #define TRAF_ST_VCMX_BPDU       13      /* BPDU */
419
420 /*
421  * For TRAF_LANE:
422  */
423 #define TRAF_ST_LANE_LE_CTRL    1       /* LANE: LE Ctrl */
424 #define TRAF_ST_LANE_802_3      2       /* LANE: 802.3 */
425 #define TRAF_ST_LANE_802_5      3       /* LANE: 802.5 */
426 #define TRAF_ST_LANE_802_3_MC   4       /* LANE: 802.3 multicast */
427 #define TRAF_ST_LANE_802_5_MC   5       /* LANE: 802.5 multicast */
428
429 /*
430  * For TRAF_IPSILON:
431  */
432 #define TRAF_ST_IPSILON_FT0     1       /* Ipsilon: Flow Type 0 */
433 #define TRAF_ST_IPSILON_FT1     2       /* Ipsilon: Flow Type 1 */
434 #define TRAF_ST_IPSILON_FT2     3       /* Ipsilon: Flow Type 2 */
435
436 struct atm_phdr {
437         guint32 flags;          /* status flags */
438         guint8  aal;            /* AAL of the traffic */
439         guint8  type;           /* traffic type */
440         guint8  subtype;        /* traffic subtype */
441         guint16 vpi;            /* virtual path identifier */
442         guint16 vci;            /* virtual circuit identifier */
443         guint8  aal2_cid;       /* channel id */
444         guint16 channel;        /* link: 0 for DTE->DCE, 1 for DCE->DTE */
445         guint16 cells;          /* number of cells */
446         guint16 aal5t_u2u;      /* user-to-user indicator */
447         guint16 aal5t_len;      /* length of the packet */
448         guint32 aal5t_chksum;   /* checksum for AAL5 packet */
449 };
450
451 /* Packet "pseudo-header" for the output from "wandsession", "wannext",
452    "wandisplay", and similar commands on Lucent/Ascend access equipment. */
453
454 #define ASCEND_MAX_STR_LEN 64
455
456 #define ASCEND_PFX_WDS_X 1
457 #define ASCEND_PFX_WDS_R 2
458 #define ASCEND_PFX_WDD   3
459 #define ASCEND_PFX_ISDN_X 4
460 #define ASCEND_PFX_ISDN_R 5
461 #define ASCEND_PFX_ETHER 6
462
463 struct ascend_phdr {
464         guint16 type;                   /* ASCEND_PFX_*, as defined above */
465         char    user[ASCEND_MAX_STR_LEN];   /* Username, from wandsession header */
466         guint32 sess;                   /* Session number, from wandsession header */
467         char    call_num[ASCEND_MAX_STR_LEN];   /* Called number, from WDD header */
468         guint32 chunk;                  /* Chunk number, from WDD header */
469         guint32 task;                   /* Task number */
470 };
471
472 /* Also defined in epan/packet_info.h */
473 #define P2P_DIR_UNKNOWN -1
474 #define P2P_DIR_SENT    0
475 #define P2P_DIR_RECV    1
476
477 /* Packet "pseudo-header" for point-to-point links with direction flags. */
478 struct p2p_phdr {
479         int     sent; /* TRUE=sent, FALSE=received, -1=unknown*/
480 };
481
482 /*
483  * Packet "pseudo-header" information for 802.11.
484  * Radio information is only present for WTAP_ENCAP_IEEE_802_11_WITH_RADIO.
485  *
486  * Signal strength, etc. information:
487  *
488  * Raw signal strength can be measured in milliwatts.
489  * It can also be represented as dBm, which is 10 times the log base 10
490  * of the signal strength in mW.
491  *
492  * The Receive Signal Strength Indicator is an integer in the range 0 to 255.
493  * The actual RSSI value for a given signal strength is dependent on the
494  * vendor (and perhaps on the adapter).  The maximum possible RSSI value
495  * is also dependent on the vendor and perhaps the adapter.
496  *
497  * The signal strength can be represented as a percentage, which is 100
498  * times the ratio of the RSSI and the maximum RSSI.
499  */
500 struct ieee_802_11_phdr {
501         gint    fcs_len;        /* Number of bytes of FCS - -1 means "unknown" */
502         guint8  channel;        /* Channel number */
503         guint8  data_rate;      /* in .5 Mb/s units */
504         guint8  signal_level;   /* percentage */
505 };
506
507 /* Packet "pseudo-header" for the output from CoSine L2 debug output. */
508
509 #define COSINE_MAX_IF_NAME_LEN  128
510
511 #define COSINE_ENCAP_TEST       1
512 #define COSINE_ENCAP_PPoATM     2
513 #define COSINE_ENCAP_PPoFR      3
514 #define COSINE_ENCAP_ATM        4
515 #define COSINE_ENCAP_FR         5
516 #define COSINE_ENCAP_HDLC       6
517 #define COSINE_ENCAP_PPP        7
518 #define COSINE_ENCAP_ETH        8
519 #define COSINE_ENCAP_UNKNOWN    99
520
521 #define COSINE_DIR_TX 1
522 #define COSINE_DIR_RX 2
523
524 struct cosine_phdr {
525         guint8 encap;           /* COSINE_ENCAP_* as defined above */
526         guint8 direction;       /* COSINE_DIR_*, as defined above */
527         char if_name[COSINE_MAX_IF_NAME_LEN];  /* Encap & Logical I/F name */
528         guint16 pro;            /* Protocol */
529         guint16 off;            /* Offset */
530         guint16 pri;            /* Priority */
531         guint16 rm;             /* Rate Marking */
532         guint16 err;            /* Error Code */
533 };
534
535 /* Packet "pseudo-header" for IrDA capture files. */
536
537 /*
538  * Direction of the packet
539  */
540 #define IRDA_INCOMING       0x0000
541 #define IRDA_OUTGOING       0x0004
542
543 /*
544  * "Inline" log messages produced by IrCOMM2k on Windows
545  */
546 #define IRDA_LOG_MESSAGE    0x0100  /* log message */
547 #define IRDA_MISSED_MSG     0x0101  /* missed log entry or frame */
548
549 /*
550  * Differentiate between frames and log messages
551  */
552 #define IRDA_CLASS_FRAME    0x0000
553 #define IRDA_CLASS_LOG      0x0100
554 #define IRDA_CLASS_MASK     0xFF00
555
556 struct irda_phdr {
557         guint16 pkttype;    /* packet type */
558 };
559
560 /* Packet "pseudo-header" for nettl (HP-UX) capture files. */
561
562 struct nettl_phdr {
563         guint16 subsys;
564         guint32 devid;
565         guint32 kind;
566         gint32  pid;
567         guint16 uid;
568 };
569
570 /* Packet "pseudo-header" for MTP2 files. */
571
572 #define MTP2_ANNEX_A_NOT_USED      0
573 #define MTP2_ANNEX_A_USED          1
574 #define MTP2_ANNEX_A_USED_UNKNOWN  2
575
576 struct mtp2_phdr {
577         guint8  sent;
578         guint8  annex_a_used;
579         guint16 link_number;
580 };
581
582 /* Packet "pseudo-header" for K12 files. */
583
584 typedef union {
585         struct {
586                 guint16 vp;
587                 guint16 vc;
588                 guint16 cid;
589         } atm;
590
591         guint32 ds0mask;
592 } k12_input_info_t;
593
594 struct k12_phdr {
595         guint32 input;
596         const gchar* input_name;
597         const gchar* stack_file;
598         guint32 input_type;
599         k12_input_info_t input_info;
600         guchar* extra_info;
601         guint32 extra_length;
602         void* stuff;
603 };
604
605 #define K12_PORT_DS0S      0x00010008
606 #define K12_PORT_DS1       0x00100008
607 #define K12_PORT_ATMPVC    0x01020000
608
609 struct lapd_phdr {
610         guint16 pkttype;    /* packet type */
611         guint8 we_network;
612 };
613
614 struct wtap;
615 struct catapult_dct2000_phdr
616 {
617         union
618         {
619                 struct isdn_phdr  isdn;
620                 struct atm_phdr   atm;
621                 struct p2p_phdr   p2p;
622         } inner_pseudo_header;
623         gint64 seek_off;
624         struct wtap *wth;
625 };
626
627 #define LIBPCAP_BT_PHDR_SENT    0
628 #define LIBPCAP_BT_PHDR_RECV    1
629
630 /*
631  * Header prepended by libpcap to each bluetooth hci h:4 frame.
632  * Values in network byte order
633  */
634 struct libpcap_bt_phdr {
635     guint32 direction;     /* Bit 0 hold the frame direction. */
636 };
637
638 #define LIBPCAP_PPP_PHDR_RECV    0
639 #define LIBPCAP_PPP_PHDR_SENT    1
640
641 /*
642  * Header prepended by libpcap to each ppp frame.
643  */
644 struct libpcap_ppp_phdr {
645     guint8 direction;
646 };
647
648 /*
649  * Endace Record Format pseudo header
650  */
651 struct erf_phdr {
652   guint64 ts;             /* Time stamp */
653   guint8 type;
654   guint8 flags;
655   guint16 rlen;
656   guint16 lctr;
657   guint16 wlen;
658 };
659
660 struct erf_ehdr {
661   guint64 ehdr;
662 };
663
664 /*
665  * ERF pseudo header with optional subheader
666  * (Multichannel or Ethernet)
667  */
668 struct erf_mc_phdr {
669   struct erf_phdr phdr;
670   struct erf_ehdr ehdr_list[8];
671   union
672   {
673     guint16 eth_hdr;
674     guint32 mc_hdr;
675   } subhdr;
676 };
677
678 #define SITA_FRAME_DIR_TXED             (0x00)          /* values of sita_phdr.flags */
679 #define SITA_FRAME_DIR_RXED             (0x01)
680 #define SITA_FRAME_DIR                  (0x01)          /* mask */
681 #define SITA_ERROR_NO_BUFFER            (0x80)
682
683 #define SITA_SIG_DSR                    (0x01)          /* values of sita_phdr.signals */
684 #define SITA_SIG_DTR                    (0x02)
685 #define SITA_SIG_CTS                    (0x04)
686 #define SITA_SIG_RTS                    (0x08)
687 #define SITA_SIG_DCD                    (0x10)
688 #define SITA_SIG_UNDEF1                 (0x20)
689 #define SITA_SIG_UNDEF2                 (0x40)
690 #define SITA_SIG_UNDEF3                 (0x80)
691
692 #define SITA_ERROR_TX_UNDERRUN          (0x01)          /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_TXED) */
693 #define SITA_ERROR_TX_CTS_LOST          (0x02)
694 #define SITA_ERROR_TX_UART_ERROR        (0x04)
695 #define SITA_ERROR_TX_RETX_LIMIT        (0x08)
696 #define SITA_ERROR_TX_UNDEF1            (0x10)
697 #define SITA_ERROR_TX_UNDEF2            (0x20)
698 #define SITA_ERROR_TX_UNDEF3            (0x40)
699 #define SITA_ERROR_TX_UNDEF4            (0x80)
700
701 #define SITA_ERROR_RX_FRAMING           (0x01)          /* values of sita_phdr.errors1 (if SITA_FRAME_DIR_RXED) */
702 #define SITA_ERROR_RX_PARITY            (0x02)
703 #define SITA_ERROR_RX_COLLISION         (0x04)
704 #define SITA_ERROR_RX_FRAME_LONG        (0x08)
705 #define SITA_ERROR_RX_FRAME_SHORT       (0x10)
706 #define SITA_ERROR_RX_UNDEF1            (0x20)
707 #define SITA_ERROR_RX_UNDEF2            (0x40)
708 #define SITA_ERROR_RX_UNDEF3            (0x80)
709
710 #define SITA_ERROR_RX_NONOCTET_ALIGNED  (0x01)  /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_RXED) */
711 #define SITA_ERROR_RX_ABORT             (0x02)
712 #define SITA_ERROR_RX_CD_LOST           (0x04)
713 #define SITA_ERROR_RX_DPLL              (0x08)
714 #define SITA_ERROR_RX_OVERRUN           (0x10)
715 #define SITA_ERROR_RX_FRAME_LEN_VIOL    (0x20)
716 #define SITA_ERROR_RX_CRC               (0x40)
717 #define SITA_ERROR_RX_BREAK             (0x80)
718
719 #define SITA_PROTO_UNUSED               (0x00)          /* values of sita_phdr.proto */
720 #define SITA_PROTO_BOP_LAPB             (0x01)
721 #define SITA_PROTO_ETHERNET             (0x02)
722 #define SITA_PROTO_ASYNC_INTIO          (0x03)
723 #define SITA_PROTO_ASYNC_BLKIO          (0x04)
724 #define SITA_PROTO_ALC                  (0x05)
725 #define SITA_PROTO_UTS                  (0x06)
726 #define SITA_PROTO_PPP_HDLC             (0x07)
727 #define SITA_PROTO_SDLC                 (0x08)
728 #define SITA_PROTO_TOKENRING            (0x09)
729 #define SITA_PROTO_I2C                  (0x10)
730 #define SITA_PROTO_DPM_LINK             (0x11)
731 #define SITA_PROTO_BOP_FRL              (0x12)
732
733 struct sita_phdr {
734    guint8  flags;
735    guint8  signals;
736    guint8  errors1;
737    guint8  errors2;
738    guint8  proto;
739 };
740
741 /*pseudo header for Bluetooth HCI*/
742 struct bthci_phdr {
743         gboolean sent;
744         guint8 channel;
745 };
746
747 #define BTHCI_CHANNEL_COMMAND 1
748 #define BTHCI_CHANNEL_ACL     2
749 #define BTHCI_CHANNEL_SCO     3
750 #define BTHCI_CHANNEL_EVENT   4
751
752 /* pseudo header for WTAP_ENCAP_LAYER1_EVENT */
753 struct l1event_phdr {
754         gboolean uton;
755 };
756
757 /* * I2C pseudo header */
758 struct i2c_phdr {
759         guint8 is_event;
760         guint8 bus;
761         guint32 flags;
762 };
763
764 /* pseudo header for WTAP_ENCAP_GSM_UM */
765 struct gsm_um_phdr {
766         gboolean uplink;
767         guint8 channel;
768         /* The following are only populated for downlink */
769         guint8 bsic;
770         guint16 arfcn;
771         guint32 tdma_frame;
772         guint8 error;
773         guint16 timeshift;
774 };
775
776 #define GSM_UM_CHANNEL_UNKNOWN  0
777 #define GSM_UM_CHANNEL_BCCH     1
778 #define GSM_UM_CHANNEL_SDCCH    2
779 #define GSM_UM_CHANNEL_SACCH    3
780 #define GSM_UM_CHANNEL_FACCH    4
781 #define GSM_UM_CHANNEL_CCCH     5
782 #define GSM_UM_CHANNEL_RACH     6
783 #define GSM_UM_CHANNEL_AGCH     7
784 #define GSM_UM_CHANNEL_PCH      8
785
786 union wtap_pseudo_header {
787         struct eth_phdr         eth;
788         struct x25_phdr         x25;
789         struct isdn_phdr        isdn;
790         struct atm_phdr         atm;
791         struct ascend_phdr      ascend;
792         struct p2p_phdr         p2p;
793         struct ieee_802_11_phdr ieee_802_11;
794         struct cosine_phdr      cosine;
795         struct irda_phdr        irda;
796         struct nettl_phdr       nettl;
797         struct mtp2_phdr        mtp2;
798         struct k12_phdr         k12;
799         struct lapd_phdr        lapd;
800         struct catapult_dct2000_phdr dct2000;
801         struct erf_mc_phdr      erf;
802         struct sita_phdr        sita;
803         struct bthci_phdr       bthci;
804         struct l1event_phdr     l1event;
805         struct i2c_phdr         i2c;
806         struct gsm_um_phdr      gsm_um;
807         struct nstr_phdr        nstr;
808 };
809
810 struct wtap_nstime {
811         time_t  secs;
812         int     nsecs;
813 };
814
815 struct wtap_pkthdr {
816         struct wtap_nstime ts;
817         guint32 caplen;
818         guint32 len;
819         int pkt_encap;
820 };
821
822 struct Buffer;
823 struct wtap_dumper;
824
825 typedef struct wtap wtap;
826 typedef struct wtap_dumper wtap_dumper;
827
828 typedef struct wtap_reader *FILE_T;
829
830 struct file_type_info {
831     /* the file type name */
832     /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
833     const char *name;
834
835     /* the file type short name, used as a shortcut for the command line tools */
836     /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
837     const char *short_name;
838
839     /* the common file extensions for this type (seperated by semicolon) */
840     /* should be *.* if no common extension is applicable */
841     const char *file_extensions;
842
843     /* the default file extension, used to save this type */
844     /* should be NULL if no default extension is known */
845     const char *file_extension_default;
846
847     /* when writing this file format, is seeking required? */
848     gboolean writing_must_seek;
849
850     /* does this type support name resolution records? */
851     /* should be FALSE is this file type doesn't support name resolution records */
852     gboolean has_name_resolution;
853
854     /* can this type write this encapsulation format? */
855     /* should be NULL is this file type doesn't have write support */
856     int (*can_write_encap)(int);
857
858     /* the function to open the capture file for writing */
859     /* should be NULL is this file type don't have write support */
860     int (*dump_open)(wtap_dumper *, int *);
861 };
862
863
864 typedef int (*wtap_open_routine_t)(struct wtap*, int *, char **);
865
866
867 /** On failure, "wtap_open_offline()" returns NULL, and puts into the
868  * "int" pointed to by its second argument:
869  *
870  * @param filename Name of the file to open
871  * @param err a positive "errno" value if the capture file can't be opened;
872  * a negative number, indicating the type of error, on other failures.
873  * @param err_info for some errors, a string giving more details of
874  * the error
875  * @param do_random TRUE if random access to the file will be done,
876  * FALSE if not
877  */
878 struct wtap* wtap_open_offline(const char *filename, int *err,
879     gchar **err_info, gboolean do_random);
880
881 /*
882  * If we were compiled with zlib and we're at EOF, unset EOF so that
883  * wtap_read/gzread has a chance to succeed. This is necessary if
884  * we're tailing a file.
885  */
886 void wtap_cleareof(wtap *wth);
887
888 /*
889  * Set callback functions to add new hostnames. Currently pcapng-only.
890  * MUST match add_ipv4_name and add_ipv6_name in addr_resolv.c.
891  */
892 typedef void (*wtap_new_ipv4_callback_t) (const guint addr, const gchar *name);
893 void wtap_set_cb_new_ipv4(wtap *wth, wtap_new_ipv4_callback_t add_new_ipv4);
894
895 typedef void (*wtap_new_ipv6_callback_t) (const void *addrp, const gchar *name);
896 void wtap_set_cb_new_ipv6(wtap *wth, wtap_new_ipv6_callback_t add_new_ipv6);
897
898 /* Returns TRUE if read was successful. FALSE if failure. data_offset is
899  * set to the offset in the file where the data for the read packet is
900  * located. */
901 gboolean wtap_read(wtap *wth, int *err, gchar **err_info,
902     gint64 *data_offset);
903
904 gboolean wtap_seek_read (wtap *wth, gint64 seek_off,
905         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
906         int *err, gchar **err_info);
907
908 /*** get various information snippets about the current packet ***/
909 struct wtap_pkthdr *wtap_phdr(wtap *wth);
910 union wtap_pseudo_header *wtap_pseudoheader(wtap *wth);
911 guint8 *wtap_buf_ptr(wtap *wth);
912
913 /*** get various information snippets about the current file ***/
914
915 /* Return an approximation of the amount of data we've read sequentially
916  * from the file so far. */
917 gint64 wtap_read_so_far(wtap *wth);
918 gint64 wtap_file_size(wtap *wth, int *err);
919 guint wtap_snapshot_length(wtap *wth); /* per file */
920 int wtap_file_type(wtap *wth);
921 int wtap_file_encap(wtap *wth);
922 int wtap_file_tsprecision(wtap *wth);
923
924 /*** close the current file ***/
925 void wtap_sequential_close(wtap *wth);
926 void wtap_close(wtap *wth);
927
928 /*** dump packets into a capture file ***/
929 gboolean wtap_dump_can_open(int filetype);
930 gboolean wtap_dump_can_write_encap(int filetype, int encap);
931 gboolean wtap_dump_can_compress(int filetype);
932 gboolean wtap_dump_has_name_resolution(int filetype);
933 wtap_dumper* wtap_dump_open(const char *filename, int filetype, int encap,
934         int snaplen, gboolean compressed, int *err);
935 wtap_dumper* wtap_dump_fdopen(int fd, int filetype, int encap, int snaplen,
936         gboolean compressed, int *err);
937 gboolean wtap_dump(wtap_dumper *, const struct wtap_pkthdr *,
938         const union wtap_pseudo_header *pseudo_header, const guchar *, int *err);
939 void wtap_dump_flush(wtap_dumper *);
940 gint64 wtap_get_bytes_dumped(wtap_dumper *);
941 void wtap_set_bytes_dumped(wtap_dumper *wdh, gint64 bytes_dumped);
942 struct addrinfo;
943 gboolean wtap_dump_set_addrinfo_list(wtap_dumper *wdh, struct addrinfo *addrinfo_list);
944 gboolean wtap_dump_close(wtap_dumper *, int *);
945
946 /*** various string converter functions ***/
947 const char *wtap_file_type_string(int filetype);
948 const char *wtap_file_type_short_string(int filetype);
949 int wtap_short_string_to_file_type(const char *short_name);
950
951 const char *wtap_file_extensions_string(int filetype);
952 const char *wtap_file_extension_default_string(int filetype);
953
954 const char *wtap_encap_string(int encap);
955 const char *wtap_encap_short_string(int encap);
956 int wtap_short_string_to_encap(const char *short_name);
957
958 const char *wtap_strerror(int err);
959
960 /*** get available number of file types and encapsulations ***/
961 int wtap_get_num_encap_types(void);
962 int wtap_get_num_file_types(void);
963
964 /*** dynamically register new file types and encapsulations ***/
965 void wtap_register_open_routine(wtap_open_routine_t, gboolean has_magic);
966 int wtap_register_file_type(const struct file_type_info* fi);
967 int wtap_register_encap_type(char* name, char* short_name);
968
969
970 /*
971  * Wiretap error codes.
972  */
973 #define WTAP_ERR_NOT_REGULAR_FILE               -1
974         /* The file being opened for reading isn't a plain file (or pipe) */
975 #define WTAP_ERR_RANDOM_OPEN_PIPE               -2
976         /* The file is being opened for random access and it's a pipe */
977 #define WTAP_ERR_FILE_UNKNOWN_FORMAT            -3
978         /* The file being opened is not a capture file in a known format */
979 #define WTAP_ERR_UNSUPPORTED                    -4
980         /* Supported file type, but there's something in the file we
981            can't support */
982 #define WTAP_ERR_CANT_WRITE_TO_PIPE             -5
983         /* Wiretap can't save to a pipe in the specified format */
984 #define WTAP_ERR_CANT_OPEN                      -6
985         /* The file couldn't be opened, reason unknown */
986 #define WTAP_ERR_UNSUPPORTED_FILE_TYPE          -7
987         /* Wiretap can't save files in the specified format */
988 #define WTAP_ERR_UNSUPPORTED_ENCAP              -8
989         /* Wiretap can't read or save files in the specified format with the
990            specified encapsulation */
991 #define WTAP_ERR_ENCAP_PER_PACKET_UNSUPPORTED   -9
992         /* The specified format doesn't support per-packet encapsulations */
993 #define WTAP_ERR_CANT_CLOSE                     -10
994         /* The file couldn't be closed, reason unknown */
995 #define WTAP_ERR_CANT_READ                      -11
996         /* An attempt to read failed, reason unknown */
997 #define WTAP_ERR_SHORT_READ                     -12
998         /* An attempt to read read less data than it should have */
999 #define WTAP_ERR_BAD_RECORD                     -13
1000         /* We read an invalid record */
1001 #define WTAP_ERR_SHORT_WRITE                    -14
1002         /* An attempt to write wrote less data than it should have */
1003 #define WTAP_ERR_UNC_TRUNCATED                  -15
1004         /* Sniffer compressed data was oddly truncated */
1005 #define WTAP_ERR_UNC_OVERFLOW                   -16
1006         /* Uncompressing Sniffer data would overflow buffer */
1007 #define WTAP_ERR_UNC_BAD_OFFSET                 -17
1008         /* LZ77 compressed data has bad offset to string */
1009 #define WTAP_ERR_RANDOM_OPEN_STDIN              -18
1010         /* We're trying to open the standard input for random access */
1011 #define WTAP_ERR_COMPRESSION_NOT_SUPPORTED      -19
1012         /* The filetype doesn't support output compression */
1013 #define WTAP_ERR_CANT_SEEK                      -20
1014         /* An attempt to seek failed, reason unknown */
1015 #define WTAP_ERR_DECOMPRESS                     -21
1016         /* Error decompressing */
1017 #define WTAP_ERR_INTERNAL                       -22
1018         /* "Shouldn't happen" internal errors */
1019
1020 #ifdef __cplusplus
1021 }
1022 #endif /* __cplusplus */
1023
1024 #endif /* __WTAP_H__ */