6 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
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.
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.
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.
26 #ifdef HAVE_SYS_TIME_H
36 #endif /* __cplusplus */
38 /* Encapsulation types. Choose names that truly reflect
39 * what is contained in the packet trace file.
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.
48 * WTAP_ENCAP_UNKNOWN is returned by "wtap_pcap_encap_to_wtap_encap()"
49 * if it's handed an unknown encapsulation.
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.
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.
73 * WTAP_ENCAP_NULL corresponds to DLT_NULL from "libpcap". This
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);
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;
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
208 #define WTAP_NUM_ENCAP_TYPES wtap_get_num_encap_types()
210 /* File types that can be read by wiretap.
211 We support writing some many of these file types, too, so we
212 distinguish between different versions of them. */
213 #define WTAP_FILE_UNKNOWN 0
214 #define WTAP_FILE_WTAP 1
215 #define WTAP_FILE_PCAP 2
216 #define WTAP_FILE_PCAP_NSEC 3
217 #define WTAP_FILE_PCAP_AIX 4
218 #define WTAP_FILE_PCAP_SS991029 5
219 #define WTAP_FILE_PCAP_NOKIA 6
220 #define WTAP_FILE_PCAP_SS990417 7
221 #define WTAP_FILE_PCAP_SS990915 8
222 #define WTAP_FILE_5VIEWS 9
223 #define WTAP_FILE_IPTRACE_1_0 10
224 #define WTAP_FILE_IPTRACE_2_0 11
225 #define WTAP_FILE_BER 12
226 #define WTAP_FILE_HCIDUMP 13
227 #define WTAP_FILE_CATAPULT_DCT2000 14
228 #define WTAP_FILE_NETXRAY_OLD 15
229 #define WTAP_FILE_NETXRAY_1_0 16
230 #define WTAP_FILE_COSINE 17
231 #define WTAP_FILE_CSIDS 18
232 #define WTAP_FILE_DBS_ETHERWATCH 19
233 #define WTAP_FILE_ERF 20
234 #define WTAP_FILE_EYESDN 21
235 #define WTAP_FILE_NETTL 22
236 #define WTAP_FILE_ISERIES 23
237 #define WTAP_FILE_ISERIES_UNICODE 24
238 #define WTAP_FILE_I4BTRACE 25
239 #define WTAP_FILE_ASCEND 26
240 #define WTAP_FILE_NETMON_1_x 27
241 #define WTAP_FILE_NETMON_2_x 28
242 #define WTAP_FILE_NGSNIFFER_UNCOMPRESSED 29
243 #define WTAP_FILE_NGSNIFFER_COMPRESSED 30
244 #define WTAP_FILE_NETXRAY_1_1 31
245 #define WTAP_FILE_NETXRAY_2_00x 32
246 #define WTAP_FILE_NETWORK_INSTRUMENTS_V9 33
247 #define WTAP_FILE_LANALYZER 34
248 #define WTAP_FILE_PPPDUMP 35
249 #define WTAP_FILE_RADCOM 36
250 #define WTAP_FILE_SNOOP 37
251 #define WTAP_FILE_SHOMITI 38
252 #define WTAP_FILE_VMS 39
253 #define WTAP_FILE_K12 40
254 #define WTAP_FILE_TOSHIBA 41
255 #define WTAP_FILE_VISUAL_NETWORKS 42
256 #define WTAP_FILE_ETHERPEEK_V56 43
257 #define WTAP_FILE_ETHERPEEK_V7 44
258 #define WTAP_FILE_AIROPEEK_V9 45
259 #define WTAP_FILE_MPEG 46
260 #define WTAP_FILE_K12TEXT 47
261 #define WTAP_FILE_NETSCREEN 48
262 #define WTAP_FILE_COMMVIEW 49
263 #define WTAP_FILE_PCAPNG 50
264 #define WTAP_FILE_BTSNOOP 51
265 #define WTAP_FILE_X2E_XORAYA 52
267 #define WTAP_NUM_FILE_TYPES wtap_get_num_file_types()
269 /* timestamp precision (currently only these values are supported) */
270 #define WTAP_FILE_TSPREC_SEC 0
271 #define WTAP_FILE_TSPREC_DSEC 1
272 #define WTAP_FILE_TSPREC_CSEC 2
273 #define WTAP_FILE_TSPREC_MSEC 3
274 #define WTAP_FILE_TSPREC_USEC 6
275 #define WTAP_FILE_TSPREC_NSEC 9
278 * Maximum packet size we'll support.
279 * It must be at least 65535.
281 #define WTAP_MAX_PACKET_SIZE 65535
284 * "Pseudo-headers" are used to supply to the clients of wiretap
285 * per-packet information that's not part of the packet payload
288 * NOTE: do not use pseudo-header structures to hold information
289 * used by the code to read a particular capture file type; to
290 * keep that sort of state information, add a new structure for
291 * that private information to "wtap-int.h", add a pointer to that
292 * type of structure to the "capture" member of the "struct wtap"
293 * structure, and allocate one of those structures and set that member
294 * in the "open" routine for that capture file type if the open
295 * succeeds. See various other capture file type handlers for examples
299 /* Packet "pseudo-header" information for Ethernet capture files. */
301 gint fcs_len; /* Number of bytes of FCS - -1 means "unknown" */
304 /* Packet "pseudo-header" information for X.25 capture files. */
305 #define FROM_DCE 0x80
307 guint8 flags; /* ENCAP_LAPB, ENCAP_V120 : 1st bit means From DCE */
310 /* Packet "pseudo-header" information for ISDN capture files. */
315 guint8 channel; /* 0 = D-channel; n = B-channel n */
318 /* Packet "pseudo-header" for ATM capture files.
319 Not all of this information is supplied by all capture types. */
324 #define ATM_RAW_CELL 0x01 /* TRUE if the packet is a single cell */
329 #define AAL_UNKNOWN 0 /* AAL unknown */
330 #define AAL_1 1 /* AAL1 */
331 #define AAL_2 2 /* AAL2 */
332 #define AAL_3_4 3 /* AAL3/4 */
333 #define AAL_5 4 /* AAL5 */
334 #define AAL_USER 5 /* User AAL */
335 #define AAL_SIGNALLING 6 /* Signaling AAL */
336 #define AAL_OAMCELL 7 /* OAM cell */
341 #define TRAF_UNKNOWN 0 /* Unknown */
342 #define TRAF_LLCMX 1 /* LLC multiplexed (RFC 1483) */
343 #define TRAF_VCMX 2 /* VC multiplexed (RFC 1483) */
344 #define TRAF_LANE 3 /* LAN Emulation */
345 #define TRAF_ILMI 4 /* ILMI */
346 #define TRAF_FR 5 /* Frame Relay */
347 #define TRAF_SPANS 6 /* FORE SPANS */
348 #define TRAF_IPSILON 7 /* Ipsilon */
349 #define TRAF_UMTS_FP 8 /* UMTS Frame Protocol */
354 #define TRAF_ST_UNKNOWN 0 /* Unknown */
359 #define TRAF_ST_VCMX_802_3_FCS 1 /* 802.3 with an FCS */
360 #define TRAF_ST_VCMX_802_4_FCS 2 /* 802.4 with an FCS */
361 #define TRAF_ST_VCMX_802_5_FCS 3 /* 802.5 with an FCS */
362 #define TRAF_ST_VCMX_FDDI_FCS 4 /* FDDI with an FCS */
363 #define TRAF_ST_VCMX_802_6_FCS 5 /* 802.6 with an FCS */
364 #define TRAF_ST_VCMX_802_3 7 /* 802.3 without an FCS */
365 #define TRAF_ST_VCMX_802_4 8 /* 802.4 without an FCS */
366 #define TRAF_ST_VCMX_802_5 9 /* 802.5 without an FCS */
367 #define TRAF_ST_VCMX_FDDI 10 /* FDDI without an FCS */
368 #define TRAF_ST_VCMX_802_6 11 /* 802.6 without an FCS */
369 #define TRAF_ST_VCMX_FRAGMENTS 12 /* Fragments */
370 #define TRAF_ST_VCMX_BPDU 13 /* BPDU */
375 #define TRAF_ST_LANE_LE_CTRL 1 /* LANE: LE Ctrl */
376 #define TRAF_ST_LANE_802_3 2 /* LANE: 802.3 */
377 #define TRAF_ST_LANE_802_5 3 /* LANE: 802.5 */
378 #define TRAF_ST_LANE_802_3_MC 4 /* LANE: 802.3 multicast */
379 #define TRAF_ST_LANE_802_5_MC 5 /* LANE: 802.5 multicast */
384 #define TRAF_ST_IPSILON_FT0 1 /* Ipsilon: Flow Type 0 */
385 #define TRAF_ST_IPSILON_FT1 2 /* Ipsilon: Flow Type 1 */
386 #define TRAF_ST_IPSILON_FT2 3 /* Ipsilon: Flow Type 2 */
389 guint32 flags; /* status flags */
390 guint8 aal; /* AAL of the traffic */
391 guint8 type; /* traffic type */
392 guint8 subtype; /* traffic subtype */
393 guint16 vpi; /* virtual path identifier */
394 guint16 vci; /* virtual circuit identifier */
395 guint8 aal2_cid; /* channel id */
396 guint16 channel; /* link: 0 for DTE->DCE, 1 for DCE->DTE */
397 guint16 cells; /* number of cells */
398 guint16 aal5t_u2u; /* user-to-user indicator */
399 guint16 aal5t_len; /* length of the packet */
400 guint32 aal5t_chksum; /* checksum for AAL5 packet */
403 /* Packet "pseudo-header" for the output from "wandsession", "wannext",
404 "wandisplay", and similar commands on Lucent/Ascend access equipment. */
406 #define ASCEND_MAX_STR_LEN 64
408 #define ASCEND_PFX_WDS_X 1
409 #define ASCEND_PFX_WDS_R 2
410 #define ASCEND_PFX_WDD 3
411 #define ASCEND_PFX_ISDN_X 4
412 #define ASCEND_PFX_ISDN_R 5
413 #define ASCEND_PFX_ETHER 6
416 guint16 type; /* ASCEND_PFX_*, as defined above */
417 char user[ASCEND_MAX_STR_LEN]; /* Username, from wandsession header */
418 guint32 sess; /* Session number, from wandsession header */
419 char call_num[ASCEND_MAX_STR_LEN]; /* Called number, from WDD header */
420 guint32 chunk; /* Chunk number, from WDD header */
421 guint32 task; /* Task number */
424 /* Packet "pseudo-header" for point-to-point links with direction flags. */
426 gboolean sent; /* TRUE=sent, FALSE=received */
430 * Packet "pseudo-header" information for 802.11.
431 * Radio information is only present for WTAP_ENCAP_IEEE_802_11_WITH_RADIO.
433 * Signal strength, etc. information:
435 * Raw signal strength can be measured in milliwatts.
436 * It can also be represented as dBm, which is 10 times the log base 10
437 * of the signal strength in mW.
439 * The Receive Signal Strength Indicator is an integer in the range 0 to 255.
440 * The actual RSSI value for a given signal strength is dependent on the
441 * vendor (and perhaps on the adapter). The maximum possible RSSI value
442 * is also dependent on the vendor and perhaps the adapter.
444 * The signal strength can be represented as a percentage, which is 100
445 * times the ratio of the RSSI and the maximum RSSI.
447 struct ieee_802_11_phdr {
448 gint fcs_len; /* Number of bytes of FCS - -1 means "unknown" */
449 guint8 channel; /* Channel number */
450 guint8 data_rate; /* in .5 Mb/s units */
451 guint8 signal_level; /* percentage */
454 /* Packet "pseudo-header" for the output from CoSine L2 debug output. */
456 #define COSINE_MAX_IF_NAME_LEN 128
458 #define COSINE_ENCAP_TEST 1
459 #define COSINE_ENCAP_PPoATM 2
460 #define COSINE_ENCAP_PPoFR 3
461 #define COSINE_ENCAP_ATM 4
462 #define COSINE_ENCAP_FR 5
463 #define COSINE_ENCAP_HDLC 6
464 #define COSINE_ENCAP_PPP 7
465 #define COSINE_ENCAP_ETH 8
466 #define COSINE_ENCAP_UNKNOWN 99
468 #define COSINE_DIR_TX 1
469 #define COSINE_DIR_RX 2
472 guint8 encap; /* COSINE_ENCAP_* as defined above */
473 guint8 direction; /* COSINE_DIR_*, as defined above */
474 char if_name[COSINE_MAX_IF_NAME_LEN]; /* Encap & Logical I/F name */
475 guint16 pro; /* Protocol */
476 guint16 off; /* Offset */
477 guint16 pri; /* Priority */
478 guint16 rm; /* Rate Marking */
479 guint16 err; /* Error Code */
482 /* Packet "pseudo-header" for IrDA capture files. */
485 * Direction of the packet
487 #define IRDA_INCOMING 0x0000
488 #define IRDA_OUTGOING 0x0004
491 * "Inline" log messages produced by IrCOMM2k on Windows
493 #define IRDA_LOG_MESSAGE 0x0100 /* log message */
494 #define IRDA_MISSED_MSG 0x0101 /* missed log entry or frame */
497 * Differentiate between frames and log messages
499 #define IRDA_CLASS_FRAME 0x0000
500 #define IRDA_CLASS_LOG 0x0100
501 #define IRDA_CLASS_MASK 0xFF00
504 guint16 pkttype; /* packet type */
507 /* Packet "pseudo-header" for nettl (HP-UX) capture files. */
517 /* Packet "pseudo-header" for MTP2 files. */
519 #define MTP2_ANNEX_A_NOT_USED 0
520 #define MTP2_ANNEX_A_USED 1
521 #define MTP2_ANNEX_A_USED_UNKNOWN 2
529 /* Packet "pseudo-header" for K12 files. */
543 const gchar* input_name;
544 const gchar* stack_file;
546 k12_input_info_t input_info;
548 guint32 extra_length;
552 #define K12_PORT_DS0S 0x00010008
553 #define K12_PORT_DS1 0x00100008
554 #define K12_PORT_ATMPVC 0x01020000
557 guint16 pkttype; /* packet type */
562 struct catapult_dct2000_phdr
566 struct isdn_phdr isdn;
569 } inner_pseudo_header;
575 * possible event type
577 #define URB_SUBMIT 'S'
578 #define URB_COMPLETE 'C'
579 #define URB_ERROR 'E'
582 * possible transfer mode
584 #define URB_ISOCHRONOUS 0x0
585 #define URB_INTERRUPT 0x1
586 #define URB_CONTROL 0x2
589 #define URB_TRANSFER_IN 0x80 /* to host */
592 * USB setup header as defined in USB specification
593 * See usb_20.pdf, Chapter 9.3 'USB Device Requests' for details.
595 struct usb_device_setup_hdr {
604 * Header prepended by Linux kernel to each USB event.
605 * Followed by a struct usb_device_setup_hdr, although that header is valid
606 * only if setup_flag is 0.
607 * (Setup flag is '-', 'D', 'Z', or 0. Data flag is '<', '>', 'Z', or 0.)
608 * See linux/Documentation/usb/usbmon.txt and libpcap/pcap/usb.h for details.
610 * We present this as a pseudo-header; the values are in host byte order.
612 struct linux_usb_phdr {
613 guint64 id; /* urb id, to link submission and completion events */
614 guint8 event_type; /* Submit ('S'), Completed ('C'), Error ('E') */
615 guint8 transfer_type; /* ISO (0), Intr, Control, Bulk (3) */
616 guint8 endpoint_number; /* Endpoint number (0-15) and transfer direction */
617 guint8 device_address; /* 0-127 */
619 gint8 setup_flag; /* 0, if the urb setup header is present */
620 gint8 data_flag; /* 0, if urb data is present */
624 guint32 urb_len; /* whole len of urb this event refers to */
625 guint32 data_len; /* amount of urb data really present in this event */
629 * Header prepended by libpcap to each bluetooth hci h:4 frame.
630 * Values in network byte order
632 struct libpcap_bt_phdr {
633 guint32 direction; /* Bit 0 hold the frame direction. */
637 * Endace Record Format pseudo header
640 guint64 ts; /* Time stamp */
653 * ERF pseudo header with optional subheader
654 * (Multichannel or Ethernet)
657 struct erf_phdr phdr;
658 struct erf_ehdr ehdr_list[8];
666 #define SITA_FRAME_DIR_TXED (0x00) /* values of sita_phdr.flags */
667 #define SITA_FRAME_DIR_RXED (0x01)
668 #define SITA_FRAME_DIR (0x01) /* mask */
669 #define SITA_ERROR_NO_BUFFER (0x80)
671 #define SITA_SIG_DSR (0x01) /* values of sita_phdr.signals */
672 #define SITA_SIG_DTR (0x02)
673 #define SITA_SIG_CTS (0x04)
674 #define SITA_SIG_RTS (0x08)
675 #define SITA_SIG_DCD (0x10)
676 #define SITA_SIG_UNDEF1 (0x20)
677 #define SITA_SIG_UNDEF2 (0x40)
678 #define SITA_SIG_UNDEF3 (0x80)
680 #define SITA_ERROR_TX_UNDERRUN (0x01) /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_TXED) */
681 #define SITA_ERROR_TX_CTS_LOST (0x02)
682 #define SITA_ERROR_TX_UART_ERROR (0x04)
683 #define SITA_ERROR_TX_RETX_LIMIT (0x08)
684 #define SITA_ERROR_TX_UNDEF1 (0x10)
685 #define SITA_ERROR_TX_UNDEF2 (0x20)
686 #define SITA_ERROR_TX_UNDEF3 (0x40)
687 #define SITA_ERROR_TX_UNDEF4 (0x80)
689 #define SITA_ERROR_RX_FRAMING (0x01) /* values of sita_phdr.errors1 (if SITA_FRAME_DIR_RXED) */
690 #define SITA_ERROR_RX_PARITY (0x02)
691 #define SITA_ERROR_RX_COLLISION (0x04)
692 #define SITA_ERROR_RX_FRAME_LONG (0x08)
693 #define SITA_ERROR_RX_FRAME_SHORT (0x10)
694 #define SITA_ERROR_RX_UNDEF1 (0x20)
695 #define SITA_ERROR_RX_UNDEF2 (0x40)
696 #define SITA_ERROR_RX_UNDEF3 (0x80)
698 #define SITA_ERROR_RX_NONOCTET_ALIGNED (0x01) /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_RXED) */
699 #define SITA_ERROR_RX_ABORT (0x02)
700 #define SITA_ERROR_RX_CD_LOST (0x04)
701 #define SITA_ERROR_RX_DPLL (0x08)
702 #define SITA_ERROR_RX_OVERRUN (0x10)
703 #define SITA_ERROR_RX_FRAME_LEN_VIOL (0x20)
704 #define SITA_ERROR_RX_CRC (0x40)
705 #define SITA_ERROR_RX_BREAK (0x80)
707 #define SITA_PROTO_UNUSED (0x00) /* values of sita_phdr.proto */
708 #define SITA_PROTO_BOP_LAPB (0x01)
709 #define SITA_PROTO_ETHERNET (0x02)
710 #define SITA_PROTO_ASYNC_INTIO (0x03)
711 #define SITA_PROTO_ASYNC_BLKIO (0x04)
712 #define SITA_PROTO_ALC (0x05)
713 #define SITA_PROTO_UTS (0x06)
714 #define SITA_PROTO_PPP_HDLC (0x07)
715 #define SITA_PROTO_SDLC (0x08)
716 #define SITA_PROTO_TOKENRING (0x09)
717 #define SITA_PROTO_I2C (0x10)
718 #define SITA_PROTO_DPM_LINK (0x11)
719 #define SITA_PROTO_BOP_FRL (0x12)
729 /*pseudo header for Bluetooth HCI*/
735 #define BTHCI_CHANNEL_COMMAND 1
736 #define BTHCI_CHANNEL_ACL 2
737 #define BTHCI_CHANNEL_SCO 3
738 #define BTHCI_CHANNEL_EVENT 4
740 /* pseudo header for WTAP_ENCAP_LAYER1_EVENT */
741 struct l1event_phdr {
745 /* * I2C pseudo header */
752 union wtap_pseudo_header {
755 struct isdn_phdr isdn;
757 struct ascend_phdr ascend;
759 struct ieee_802_11_phdr ieee_802_11;
760 struct cosine_phdr cosine;
761 struct irda_phdr irda;
762 struct nettl_phdr nettl;
763 struct mtp2_phdr mtp2;
765 struct lapd_phdr lapd;
766 struct catapult_dct2000_phdr dct2000;
767 struct linux_usb_phdr linux_usb;
768 struct erf_mc_phdr erf;
769 struct sita_phdr sita;
770 struct bthci_phdr bthci;
771 struct l1event_phdr l1event;
781 struct wtap_nstime ts;
791 typedef struct wtap wtap;
792 typedef struct wtap_dumper wtap_dumper;
794 struct file_type_info {
795 /* the file type name */
796 /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
799 /* the file type short name, used as a shortcut for the command line tools */
800 /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
801 const char *short_name;
803 /* the common file extensions for this type (seperated by semicolon) */
804 /* should be *.* if no common extension is applicable */
805 const char *file_extensions;
807 /* the default file extension, used to save this type */
808 /* should be NULL if no default extension is known */
809 const char *file_extension_default;
811 /* can this type be compressed with gzip? */
812 gboolean can_compress;
814 /* can this type write this encapsulation format? */
815 /* should be NULL is this file type don't have write support */
816 int (*can_write_encap)(int);
818 /* the function to open the capture file for writing */
819 /* should be NULL is this file type don't have write support */
820 int (*dump_open)(wtap_dumper *, gboolean, int *);
824 typedef int (*wtap_open_routine_t)(struct wtap*, int *, char **);
828 * On failure, "wtap_open_offline()" returns NULL, and puts into the
829 * "int" pointed to by its second argument:
831 * a positive "errno" value if the capture file can't be opened;
832 * a negative number, indicating the type of error, on other failures.
834 struct wtap* wtap_open_offline(const char *filename, int *err,
835 gchar **err_info, gboolean do_random);
837 /* Returns TRUE if read was successful. FALSE if failure. data_offset is
838 * set to the offset in the file where the data for the read packet is
840 gboolean wtap_read(wtap *wth, int *err, gchar **err_info,
841 gint64 *data_offset);
843 gboolean wtap_seek_read (wtap *wth, gint64 seek_off,
844 union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
845 int *err, gchar **err_info);
847 /*** get various information snippets about the current packet ***/
848 struct wtap_pkthdr *wtap_phdr(wtap *wth);
849 union wtap_pseudo_header *wtap_pseudoheader(wtap *wth);
850 guint8 *wtap_buf_ptr(wtap *wth);
852 /*** get various information snippets about the current file ***/
854 /* Return an approximation of the amount of data we've read sequentially
855 * from the file so far. */
856 gint64 wtap_read_so_far(wtap *wth, int *err);
857 gint64 wtap_file_size(wtap *wth, int *err);
858 int wtap_snapshot_length(wtap *wth); /* per file */
859 int wtap_file_type(wtap *wth);
860 int wtap_file_encap(wtap *wth);
861 int wtap_file_tsprecision(wtap *wth);
863 /*** close the current file ***/
864 void wtap_sequential_close(wtap *wth);
865 void wtap_close(wtap *wth);
867 /*** dump packets into a capture file ***/
868 gboolean wtap_dump_can_open(int filetype);
869 gboolean wtap_dump_can_write_encap(int filetype, int encap);
870 gboolean wtap_dump_can_compress(int filetype);
871 wtap_dumper* wtap_dump_open(const char *filename, int filetype, int encap,
872 int snaplen, gboolean compressed, int *err);
873 wtap_dumper* wtap_dump_fdopen(int fd, int filetype, int encap, int snaplen,
874 gboolean compressed, int *err);
875 gboolean wtap_dump(wtap_dumper *, const struct wtap_pkthdr *,
876 const union wtap_pseudo_header *pseudo_header, const guchar *, int *err);
877 void wtap_dump_flush(wtap_dumper *);
878 gint64 wtap_get_bytes_dumped(wtap_dumper *);
879 void wtap_set_bytes_dumped(wtap_dumper *wdh, gint64 bytes_dumped);
880 gboolean wtap_dump_close(wtap_dumper *, int *);
882 /*** various string converter functions ***/
883 const char *wtap_file_type_string(int filetype);
884 const char *wtap_file_type_short_string(int filetype);
885 int wtap_short_string_to_file_type(const char *short_name);
887 const char *wtap_file_extensions_string(int filetype);
888 const char *wtap_file_extension_default_string(int filetype);
890 const char *wtap_encap_string(int encap);
891 const char *wtap_encap_short_string(int encap);
892 int wtap_short_string_to_encap(const char *short_name);
894 const char *wtap_strerror(int err);
896 /*** get available number of file types and encapsulations ***/
897 int wtap_get_num_encap_types(void);
898 int wtap_get_num_file_types(void);
900 /*** dynamically register new file types and encapsulations ***/
901 void wtap_register_open_routine(wtap_open_routine_t, gboolean has_magic);
902 int wtap_register_file_type(const struct file_type_info* fi);
903 int wtap_register_encap_type(char* name, char* short_name);
907 * Wiretap error codes.
909 #define WTAP_ERR_NOT_REGULAR_FILE -1
910 /* The file being opened for reading isn't a plain file (or pipe) */
911 #define WTAP_ERR_RANDOM_OPEN_PIPE -2
912 /* The file is being opened for random access and it's a pipe */
913 #define WTAP_ERR_FILE_UNKNOWN_FORMAT -3
914 /* The file being opened is not a capture file in a known format */
915 #define WTAP_ERR_UNSUPPORTED -4
916 /* Supported file type, but there's something in the file we
918 #define WTAP_ERR_CANT_WRITE_TO_PIPE -5
919 /* Wiretap can't save to a pipe in the specified format */
920 #define WTAP_ERR_CANT_OPEN -6
921 /* The file couldn't be opened, reason unknown */
922 #define WTAP_ERR_UNSUPPORTED_FILE_TYPE -7
923 /* Wiretap can't save files in the specified format */
924 #define WTAP_ERR_UNSUPPORTED_ENCAP -8
925 /* Wiretap can't read or save files in the specified format with the
926 specified encapsulation */
927 #define WTAP_ERR_ENCAP_PER_PACKET_UNSUPPORTED -9
928 /* The specified format doesn't support per-packet encapsulations */
929 #define WTAP_ERR_CANT_CLOSE -10
930 /* The file couldn't be closed, reason unknown */
931 #define WTAP_ERR_CANT_READ -11
932 /* An attempt to read failed, reason unknown */
933 #define WTAP_ERR_SHORT_READ -12
934 /* An attempt to read read less data than it should have */
935 #define WTAP_ERR_BAD_RECORD -13
936 /* We read an invalid record */
937 #define WTAP_ERR_SHORT_WRITE -14
938 /* An attempt to write wrote less data than it should have */
939 #define WTAP_ERR_UNC_TRUNCATED -15
940 /* Sniffer compressed data was oddly truncated */
941 #define WTAP_ERR_UNC_OVERFLOW -16
942 /* Uncompressing Sniffer data would overflow buffer */
943 #define WTAP_ERR_UNC_BAD_OFFSET -17
944 /* LZ77 compressed data has bad offset to string */
945 #define WTAP_ERR_RANDOM_OPEN_STDIN -18
946 /* We're trying to open the standard input for random access */
947 #define WTAP_ERR_COMPRESSION_NOT_SUPPORTED -19
948 /* The filetype doesn't support output compression */
950 /* Errors from zlib; zlib error Z_xxx turns into Wiretap error
951 WTAP_ERR_ZLIB + Z_xxx.
953 WTAP_ERR_ZLIB_MIN and WTAP_ERR_ZLIB_MAX bound the range of zlib
954 errors; we leave room for 100 positive and 100 negative error
957 #define WTAP_ERR_ZLIB -200
958 #define WTAP_ERR_ZLIB_MAX -100
959 #define WTAP_ERR_ZLIB_MIN -300
963 #endif /* __cplusplus */
965 #endif /* __WTAP_H__ */