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
35 #endif /* __cplusplus */
37 /* Encapsulation types. Choose names that truly reflect
38 * what is contained in the packet trace file.
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.
47 * WTAP_ENCAP_UNKNOWN is returned by "wtap_pcap_encap_to_wtap_encap()"
48 * if it's handed an unknown encapsulation.
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.
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.
72 * WTAP_ENCAP_NULL corresponds to DLT_NULL from "libpcap". This
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);
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;
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 #define WTAP_ENCAP_NETANALYZER 135
228 #define WTAP_ENCAP_NETANALYZER_TRANSPARENT 136
229 #define WTAP_ENCAP_IP_OVER_IB 137
231 #define WTAP_NUM_ENCAP_TYPES wtap_get_num_encap_types()
233 /* File types that can be read by wiretap.
234 We support writing some many of these file types, too, so we
235 distinguish between different versions of them. */
236 #define WTAP_FILE_UNKNOWN 0
237 #define WTAP_FILE_WTAP 1
238 #define WTAP_FILE_PCAP 2
239 #define WTAP_FILE_PCAP_NSEC 3
240 #define WTAP_FILE_PCAP_AIX 4
241 #define WTAP_FILE_PCAP_SS991029 5
242 #define WTAP_FILE_PCAP_NOKIA 6
243 #define WTAP_FILE_PCAP_SS990417 7
244 #define WTAP_FILE_PCAP_SS990915 8
245 #define WTAP_FILE_5VIEWS 9
246 #define WTAP_FILE_IPTRACE_1_0 10
247 #define WTAP_FILE_IPTRACE_2_0 11
248 #define WTAP_FILE_BER 12
249 #define WTAP_FILE_HCIDUMP 13
250 #define WTAP_FILE_CATAPULT_DCT2000 14
251 #define WTAP_FILE_NETXRAY_OLD 15
252 #define WTAP_FILE_NETXRAY_1_0 16
253 #define WTAP_FILE_COSINE 17
254 #define WTAP_FILE_CSIDS 18
255 #define WTAP_FILE_DBS_ETHERWATCH 19
256 #define WTAP_FILE_ERF 20
257 #define WTAP_FILE_EYESDN 21
258 #define WTAP_FILE_NETTL 22
259 #define WTAP_FILE_ISERIES 23
260 #define WTAP_FILE_ISERIES_UNICODE 24
261 #define WTAP_FILE_I4BTRACE 25
262 #define WTAP_FILE_ASCEND 26
263 #define WTAP_FILE_NETMON_1_x 27
264 #define WTAP_FILE_NETMON_2_x 28
265 #define WTAP_FILE_NGSNIFFER_UNCOMPRESSED 29
266 #define WTAP_FILE_NGSNIFFER_COMPRESSED 30
267 #define WTAP_FILE_NETXRAY_1_1 31
268 #define WTAP_FILE_NETXRAY_2_00x 32
269 #define WTAP_FILE_NETWORK_INSTRUMENTS 33
270 #define WTAP_FILE_LANALYZER 34
271 #define WTAP_FILE_PPPDUMP 35
272 #define WTAP_FILE_RADCOM 36
273 #define WTAP_FILE_SNOOP 37
274 #define WTAP_FILE_SHOMITI 38
275 #define WTAP_FILE_VMS 39
276 #define WTAP_FILE_K12 40
277 #define WTAP_FILE_TOSHIBA 41
278 #define WTAP_FILE_VISUAL_NETWORKS 42
279 #define WTAP_FILE_ETHERPEEK_V56 43
280 #define WTAP_FILE_ETHERPEEK_V7 44
281 #define WTAP_FILE_AIROPEEK_V9 45
282 #define WTAP_FILE_MPEG 46
283 #define WTAP_FILE_K12TEXT 47
284 #define WTAP_FILE_NETSCREEN 48
285 #define WTAP_FILE_COMMVIEW 49
286 #define WTAP_FILE_PCAPNG 50
287 #define WTAP_FILE_BTSNOOP 51
288 #define WTAP_FILE_X2E_XORAYA 52
289 #define WTAP_FILE_TNEF 53
290 #define WTAP_FILE_DCT3TRACE 54
291 #define WTAP_FILE_PACKETLOGGER 55
292 #define WTAP_FILE_DAINTREE_SNA 56
293 #define WTAP_FILE_NETSCALER_1_0 57
294 #define WTAP_FILE_NETSCALER_2_0 58
295 #define WTAP_FILE_JPEG_JFIF 59 /* obsoleted by WTAP_FILE_MIME */
296 #define WTAP_FILE_IPFIX 60
297 #define WTAP_FILE_MIME 61
298 #define WTAP_FILE_AETHRA 62
300 #define WTAP_NUM_FILE_TYPES wtap_get_num_file_types()
302 /* timestamp precision (currently only these values are supported) */
303 #define WTAP_FILE_TSPREC_SEC 0
304 #define WTAP_FILE_TSPREC_DSEC 1
305 #define WTAP_FILE_TSPREC_CSEC 2
306 #define WTAP_FILE_TSPREC_MSEC 3
307 #define WTAP_FILE_TSPREC_USEC 6
308 #define WTAP_FILE_TSPREC_NSEC 9
311 * Maximum packet size we'll support.
312 * 65535 is the largest snapshot length that libpcap supports, so we
315 #define WTAP_MAX_PACKET_SIZE 65535
318 * "Pseudo-headers" are used to supply to the clients of wiretap
319 * per-packet information that's not part of the packet payload
322 * NOTE: do not use pseudo-header structures to hold information
323 * used by the code to read a particular capture file type; to
324 * keep that sort of state information, add a new structure for
325 * that private information to "wtap-int.h", add a pointer to that
326 * type of structure to the "capture" member of the "struct wtap"
327 * structure, and allocate one of those structures and set that member
328 * in the "open" routine for that capture file type if the open
329 * succeeds. See various other capture file type handlers for examples
345 guint8 vlantag_offset;
346 guint8 coreid_offset;
349 /* Packet "pseudo-header" information for Ethernet capture files. */
351 gint fcs_len; /* Number of bytes of FCS - -1 means "unknown" */
354 /* Packet "pseudo-header" information for X.25 capture files. */
355 #define FROM_DCE 0x80
357 guint8 flags; /* ENCAP_LAPB, ENCAP_V120 : 1st bit means From DCE */
360 /* Packet "pseudo-header" information for ISDN capture files. */
365 guint8 channel; /* 0 = D-channel; n = B-channel n */
368 /* Packet "pseudo-header" for ATM capture files.
369 Not all of this information is supplied by all capture types. */
374 #define ATM_RAW_CELL 0x01 /* TRUE if the packet is a single cell */
375 #define ATM_NO_HEC 0x02 /* TRUE if the cell has HEC stripped out */
376 #define ATM_AAL2_NOPHDR 0x04 /* TRUE if the AAL2 PDU has no pseudo-header */
381 #define AAL_UNKNOWN 0 /* AAL unknown */
382 #define AAL_1 1 /* AAL1 */
383 #define AAL_2 2 /* AAL2 */
384 #define AAL_3_4 3 /* AAL3/4 */
385 #define AAL_5 4 /* AAL5 */
386 #define AAL_USER 5 /* User AAL */
387 #define AAL_SIGNALLING 6 /* Signaling AAL */
388 #define AAL_OAMCELL 7 /* OAM cell */
393 #define TRAF_UNKNOWN 0 /* Unknown */
394 #define TRAF_LLCMX 1 /* LLC multiplexed (RFC 1483) */
395 #define TRAF_VCMX 2 /* VC multiplexed (RFC 1483) */
396 #define TRAF_LANE 3 /* LAN Emulation */
397 #define TRAF_ILMI 4 /* ILMI */
398 #define TRAF_FR 5 /* Frame Relay */
399 #define TRAF_SPANS 6 /* FORE SPANS */
400 #define TRAF_IPSILON 7 /* Ipsilon */
401 #define TRAF_UMTS_FP 8 /* UMTS Frame Protocol */
402 #define TRAF_GPRS_NS 9 /* GPRS Network Services */
407 #define TRAF_ST_UNKNOWN 0 /* Unknown */
412 #define TRAF_ST_VCMX_802_3_FCS 1 /* 802.3 with an FCS */
413 #define TRAF_ST_VCMX_802_4_FCS 2 /* 802.4 with an FCS */
414 #define TRAF_ST_VCMX_802_5_FCS 3 /* 802.5 with an FCS */
415 #define TRAF_ST_VCMX_FDDI_FCS 4 /* FDDI with an FCS */
416 #define TRAF_ST_VCMX_802_6_FCS 5 /* 802.6 with an FCS */
417 #define TRAF_ST_VCMX_802_3 7 /* 802.3 without an FCS */
418 #define TRAF_ST_VCMX_802_4 8 /* 802.4 without an FCS */
419 #define TRAF_ST_VCMX_802_5 9 /* 802.5 without an FCS */
420 #define TRAF_ST_VCMX_FDDI 10 /* FDDI without an FCS */
421 #define TRAF_ST_VCMX_802_6 11 /* 802.6 without an FCS */
422 #define TRAF_ST_VCMX_FRAGMENTS 12 /* Fragments */
423 #define TRAF_ST_VCMX_BPDU 13 /* BPDU */
428 #define TRAF_ST_LANE_LE_CTRL 1 /* LANE: LE Ctrl */
429 #define TRAF_ST_LANE_802_3 2 /* LANE: 802.3 */
430 #define TRAF_ST_LANE_802_5 3 /* LANE: 802.5 */
431 #define TRAF_ST_LANE_802_3_MC 4 /* LANE: 802.3 multicast */
432 #define TRAF_ST_LANE_802_5_MC 5 /* LANE: 802.5 multicast */
437 #define TRAF_ST_IPSILON_FT0 1 /* Ipsilon: Flow Type 0 */
438 #define TRAF_ST_IPSILON_FT1 2 /* Ipsilon: Flow Type 1 */
439 #define TRAF_ST_IPSILON_FT2 3 /* Ipsilon: Flow Type 2 */
442 guint32 flags; /* status flags */
443 guint8 aal; /* AAL of the traffic */
444 guint8 type; /* traffic type */
445 guint8 subtype; /* traffic subtype */
446 guint16 vpi; /* virtual path identifier */
447 guint16 vci; /* virtual circuit identifier */
448 guint8 aal2_cid; /* channel id */
449 guint16 channel; /* link: 0 for DTE->DCE, 1 for DCE->DTE */
450 guint16 cells; /* number of cells */
451 guint16 aal5t_u2u; /* user-to-user indicator */
452 guint16 aal5t_len; /* length of the packet */
453 guint32 aal5t_chksum; /* checksum for AAL5 packet */
456 /* Packet "pseudo-header" for the output from "wandsession", "wannext",
457 "wandisplay", and similar commands on Lucent/Ascend access equipment. */
459 #define ASCEND_MAX_STR_LEN 64
461 #define ASCEND_PFX_WDS_X 1
462 #define ASCEND_PFX_WDS_R 2
463 #define ASCEND_PFX_WDD 3
464 #define ASCEND_PFX_ISDN_X 4
465 #define ASCEND_PFX_ISDN_R 5
466 #define ASCEND_PFX_ETHER 6
469 guint16 type; /* ASCEND_PFX_*, as defined above */
470 char user[ASCEND_MAX_STR_LEN]; /* Username, from wandsession header */
471 guint32 sess; /* Session number, from wandsession header */
472 char call_num[ASCEND_MAX_STR_LEN]; /* Called number, from WDD header */
473 guint32 chunk; /* Chunk number, from WDD header */
474 guint32 task; /* Task number */
477 /* Also defined in epan/packet_info.h */
478 #define P2P_DIR_UNKNOWN -1
479 #define P2P_DIR_SENT 0
480 #define P2P_DIR_RECV 1
482 /* Packet "pseudo-header" for point-to-point links with direction flags. */
484 int sent; /* TRUE=sent, FALSE=received, -1=unknown*/
488 * Packet "pseudo-header" information for 802.11.
489 * Radio information is only present for WTAP_ENCAP_IEEE_802_11_WITH_RADIO.
491 * Signal strength, etc. information:
493 * Raw signal strength can be measured in milliwatts.
494 * It can also be represented as dBm, which is 10 times the log base 10
495 * of the signal strength in mW.
497 * The Receive Signal Strength Indicator is an integer in the range 0 to 255.
498 * The actual RSSI value for a given signal strength is dependent on the
499 * vendor (and perhaps on the adapter). The maximum possible RSSI value
500 * is also dependent on the vendor and perhaps the adapter.
502 * The signal strength can be represented as a percentage, which is 100
503 * times the ratio of the RSSI and the maximum RSSI.
505 struct ieee_802_11_phdr {
506 gint fcs_len; /* Number of bytes of FCS - -1 means "unknown" */
507 guint8 channel; /* Channel number */
508 guint8 data_rate; /* in .5 Mb/s units */
509 guint8 signal_level; /* percentage */
512 /* Packet "pseudo-header" for the output from CoSine L2 debug output. */
514 #define COSINE_MAX_IF_NAME_LEN 128
516 #define COSINE_ENCAP_TEST 1
517 #define COSINE_ENCAP_PPoATM 2
518 #define COSINE_ENCAP_PPoFR 3
519 #define COSINE_ENCAP_ATM 4
520 #define COSINE_ENCAP_FR 5
521 #define COSINE_ENCAP_HDLC 6
522 #define COSINE_ENCAP_PPP 7
523 #define COSINE_ENCAP_ETH 8
524 #define COSINE_ENCAP_UNKNOWN 99
526 #define COSINE_DIR_TX 1
527 #define COSINE_DIR_RX 2
530 guint8 encap; /* COSINE_ENCAP_* as defined above */
531 guint8 direction; /* COSINE_DIR_*, as defined above */
532 char if_name[COSINE_MAX_IF_NAME_LEN]; /* Encap & Logical I/F name */
533 guint16 pro; /* Protocol */
534 guint16 off; /* Offset */
535 guint16 pri; /* Priority */
536 guint16 rm; /* Rate Marking */
537 guint16 err; /* Error Code */
540 /* Packet "pseudo-header" for IrDA capture files. */
543 * Direction of the packet
545 #define IRDA_INCOMING 0x0000
546 #define IRDA_OUTGOING 0x0004
549 * "Inline" log messages produced by IrCOMM2k on Windows
551 #define IRDA_LOG_MESSAGE 0x0100 /* log message */
552 #define IRDA_MISSED_MSG 0x0101 /* missed log entry or frame */
555 * Differentiate between frames and log messages
557 #define IRDA_CLASS_FRAME 0x0000
558 #define IRDA_CLASS_LOG 0x0100
559 #define IRDA_CLASS_MASK 0xFF00
562 guint16 pkttype; /* packet type */
565 /* Packet "pseudo-header" for nettl (HP-UX) capture files. */
575 /* Packet "pseudo-header" for MTP2 files. */
577 #define MTP2_ANNEX_A_NOT_USED 0
578 #define MTP2_ANNEX_A_USED 1
579 #define MTP2_ANNEX_A_USED_UNKNOWN 2
587 /* Packet "pseudo-header" for K12 files. */
601 const gchar* input_name;
602 const gchar* stack_file;
604 k12_input_info_t input_info;
606 guint32 extra_length;
610 #define K12_PORT_DS0S 0x00010008
611 #define K12_PORT_DS1 0x00100008
612 #define K12_PORT_ATMPVC 0x01020000
615 guint16 pkttype; /* packet type */
620 struct catapult_dct2000_phdr
624 struct isdn_phdr isdn;
627 } inner_pseudo_header;
632 #define LIBPCAP_BT_PHDR_SENT 0
633 #define LIBPCAP_BT_PHDR_RECV 1
636 * Header prepended by libpcap to each bluetooth hci h:4 frame.
637 * Values in network byte order
639 struct libpcap_bt_phdr {
640 guint32 direction; /* Bit 0 hold the frame direction. */
643 #define LIBPCAP_PPP_PHDR_RECV 0
644 #define LIBPCAP_PPP_PHDR_SENT 1
647 * Header prepended by libpcap to each ppp frame.
649 struct libpcap_ppp_phdr {
654 * Endace Record Format pseudo header
657 guint64 ts; /* Time stamp */
670 * ERF pseudo header with optional subheader
671 * (Multichannel or Ethernet)
674 #define MAX_ERF_EHDR 8
677 struct erf_phdr phdr;
678 struct erf_ehdr ehdr_list[MAX_ERF_EHDR];
686 #define SITA_FRAME_DIR_TXED (0x00) /* values of sita_phdr.flags */
687 #define SITA_FRAME_DIR_RXED (0x01)
688 #define SITA_FRAME_DIR (0x01) /* mask */
689 #define SITA_ERROR_NO_BUFFER (0x80)
691 #define SITA_SIG_DSR (0x01) /* values of sita_phdr.signals */
692 #define SITA_SIG_DTR (0x02)
693 #define SITA_SIG_CTS (0x04)
694 #define SITA_SIG_RTS (0x08)
695 #define SITA_SIG_DCD (0x10)
696 #define SITA_SIG_UNDEF1 (0x20)
697 #define SITA_SIG_UNDEF2 (0x40)
698 #define SITA_SIG_UNDEF3 (0x80)
700 #define SITA_ERROR_TX_UNDERRUN (0x01) /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_TXED) */
701 #define SITA_ERROR_TX_CTS_LOST (0x02)
702 #define SITA_ERROR_TX_UART_ERROR (0x04)
703 #define SITA_ERROR_TX_RETX_LIMIT (0x08)
704 #define SITA_ERROR_TX_UNDEF1 (0x10)
705 #define SITA_ERROR_TX_UNDEF2 (0x20)
706 #define SITA_ERROR_TX_UNDEF3 (0x40)
707 #define SITA_ERROR_TX_UNDEF4 (0x80)
709 #define SITA_ERROR_RX_FRAMING (0x01) /* values of sita_phdr.errors1 (if SITA_FRAME_DIR_RXED) */
710 #define SITA_ERROR_RX_PARITY (0x02)
711 #define SITA_ERROR_RX_COLLISION (0x04)
712 #define SITA_ERROR_RX_FRAME_LONG (0x08)
713 #define SITA_ERROR_RX_FRAME_SHORT (0x10)
714 #define SITA_ERROR_RX_UNDEF1 (0x20)
715 #define SITA_ERROR_RX_UNDEF2 (0x40)
716 #define SITA_ERROR_RX_UNDEF3 (0x80)
718 #define SITA_ERROR_RX_NONOCTET_ALIGNED (0x01) /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_RXED) */
719 #define SITA_ERROR_RX_ABORT (0x02)
720 #define SITA_ERROR_RX_CD_LOST (0x04)
721 #define SITA_ERROR_RX_DPLL (0x08)
722 #define SITA_ERROR_RX_OVERRUN (0x10)
723 #define SITA_ERROR_RX_FRAME_LEN_VIOL (0x20)
724 #define SITA_ERROR_RX_CRC (0x40)
725 #define SITA_ERROR_RX_BREAK (0x80)
727 #define SITA_PROTO_UNUSED (0x00) /* values of sita_phdr.proto */
728 #define SITA_PROTO_BOP_LAPB (0x01)
729 #define SITA_PROTO_ETHERNET (0x02)
730 #define SITA_PROTO_ASYNC_INTIO (0x03)
731 #define SITA_PROTO_ASYNC_BLKIO (0x04)
732 #define SITA_PROTO_ALC (0x05)
733 #define SITA_PROTO_UTS (0x06)
734 #define SITA_PROTO_PPP_HDLC (0x07)
735 #define SITA_PROTO_SDLC (0x08)
736 #define SITA_PROTO_TOKENRING (0x09)
737 #define SITA_PROTO_I2C (0x10)
738 #define SITA_PROTO_DPM_LINK (0x11)
739 #define SITA_PROTO_BOP_FRL (0x12)
749 /*pseudo header for Bluetooth HCI*/
755 #define BTHCI_CHANNEL_COMMAND 1
756 #define BTHCI_CHANNEL_ACL 2
757 #define BTHCI_CHANNEL_SCO 3
758 #define BTHCI_CHANNEL_EVENT 4
760 /* pseudo header for WTAP_ENCAP_LAYER1_EVENT */
761 struct l1event_phdr {
765 /* * I2C pseudo header */
772 /* pseudo header for WTAP_ENCAP_GSM_UM */
776 /* The following are only populated for downlink */
784 #define GSM_UM_CHANNEL_UNKNOWN 0
785 #define GSM_UM_CHANNEL_BCCH 1
786 #define GSM_UM_CHANNEL_SDCCH 2
787 #define GSM_UM_CHANNEL_SACCH 3
788 #define GSM_UM_CHANNEL_FACCH 4
789 #define GSM_UM_CHANNEL_CCCH 5
790 #define GSM_UM_CHANNEL_RACH 6
791 #define GSM_UM_CHANNEL_AGCH 7
792 #define GSM_UM_CHANNEL_PCH 8
794 union wtap_pseudo_header {
797 struct isdn_phdr isdn;
799 struct ascend_phdr ascend;
801 struct ieee_802_11_phdr ieee_802_11;
802 struct cosine_phdr cosine;
803 struct irda_phdr irda;
804 struct nettl_phdr nettl;
805 struct mtp2_phdr mtp2;
807 struct lapd_phdr lapd;
808 struct catapult_dct2000_phdr dct2000;
809 struct erf_mc_phdr erf;
810 struct sita_phdr sita;
811 struct bthci_phdr bthci;
812 struct l1event_phdr l1event;
814 struct gsm_um_phdr gsm_um;
815 struct nstr_phdr nstr;
824 struct wtap_nstime ts;
833 typedef struct wtap wtap;
834 typedef struct wtap_dumper wtap_dumper;
836 typedef struct wtap_reader *FILE_T;
838 struct file_type_info {
839 /* the file type name */
840 /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
843 /* the file type short name, used as a shortcut for the command line tools */
844 /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
845 const char *short_name;
847 /* the common file extensions for this type (seperated by semicolon) */
848 /* should be *.* if no common extension is applicable */
849 const char *file_extensions;
851 /* the default file extension, used to save this type */
852 /* should be NULL if no default extension is known */
853 const char *file_extension_default;
855 /* when writing this file format, is seeking required? */
856 gboolean writing_must_seek;
858 /* does this type support name resolution records? */
859 /* should be FALSE is this file type doesn't support name resolution records */
860 gboolean has_name_resolution;
862 /* can this type write this encapsulation format? */
863 /* should be NULL is this file type doesn't have write support */
864 int (*can_write_encap)(int);
866 /* the function to open the capture file for writing */
867 /* should be NULL is this file type don't have write support */
868 int (*dump_open)(wtap_dumper *, int *);
872 typedef int (*wtap_open_routine_t)(struct wtap*, int *, char **);
875 /** On failure, "wtap_open_offline()" returns NULL, and puts into the
876 * "int" pointed to by its second argument:
878 * @param filename Name of the file to open
879 * @param err a positive "errno" value if the capture file can't be opened;
880 * a negative number, indicating the type of error, on other failures.
881 * @param err_info for some errors, a string giving more details of
883 * @param do_random TRUE if random access to the file will be done,
886 struct wtap* wtap_open_offline(const char *filename, int *err,
887 gchar **err_info, gboolean do_random);
890 * If we were compiled with zlib and we're at EOF, unset EOF so that
891 * wtap_read/gzread has a chance to succeed. This is necessary if
892 * we're tailing a file.
894 void wtap_cleareof(wtap *wth);
897 * Set callback functions to add new hostnames. Currently pcapng-only.
898 * MUST match add_ipv4_name and add_ipv6_name in addr_resolv.c.
900 typedef void (*wtap_new_ipv4_callback_t) (const guint addr, const gchar *name);
901 void wtap_set_cb_new_ipv4(wtap *wth, wtap_new_ipv4_callback_t add_new_ipv4);
903 typedef void (*wtap_new_ipv6_callback_t) (const void *addrp, const gchar *name);
904 void wtap_set_cb_new_ipv6(wtap *wth, wtap_new_ipv6_callback_t add_new_ipv6);
906 /* Returns TRUE if read was successful. FALSE if failure. data_offset is
907 * set to the offset in the file where the data for the read packet is
909 gboolean wtap_read(wtap *wth, int *err, gchar **err_info,
910 gint64 *data_offset);
912 gboolean wtap_seek_read (wtap *wth, gint64 seek_off,
913 union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
914 int *err, gchar **err_info);
916 /*** get various information snippets about the current packet ***/
917 struct wtap_pkthdr *wtap_phdr(wtap *wth);
918 union wtap_pseudo_header *wtap_pseudoheader(wtap *wth);
919 guint8 *wtap_buf_ptr(wtap *wth);
921 /*** get various information snippets about the current file ***/
923 /* Return an approximation of the amount of data we've read sequentially
924 * from the file so far. */
925 gint64 wtap_read_so_far(wtap *wth);
926 gint64 wtap_file_size(wtap *wth, int *err);
927 guint wtap_snapshot_length(wtap *wth); /* per file */
928 int wtap_file_type(wtap *wth);
929 int wtap_file_encap(wtap *wth);
930 int wtap_file_tsprecision(wtap *wth);
932 /*** close the current file ***/
933 void wtap_sequential_close(wtap *wth);
934 void wtap_close(wtap *wth);
936 /*** dump packets into a capture file ***/
937 gboolean wtap_dump_can_open(int filetype);
938 gboolean wtap_dump_can_write_encap(int filetype, int encap);
939 gboolean wtap_dump_can_compress(int filetype);
940 gboolean wtap_dump_has_name_resolution(int filetype);
941 wtap_dumper* wtap_dump_open(const char *filename, int filetype, int encap,
942 int snaplen, gboolean compressed, int *err);
943 wtap_dumper* wtap_dump_fdopen(int fd, int filetype, int encap, int snaplen,
944 gboolean compressed, int *err);
945 gboolean wtap_dump(wtap_dumper *, const struct wtap_pkthdr *,
946 const union wtap_pseudo_header *pseudo_header, const guint8 *, int *err);
947 void wtap_dump_flush(wtap_dumper *);
948 gint64 wtap_get_bytes_dumped(wtap_dumper *);
949 void wtap_set_bytes_dumped(wtap_dumper *wdh, gint64 bytes_dumped);
951 gboolean wtap_dump_set_addrinfo_list(wtap_dumper *wdh, struct addrinfo *addrinfo_list);
952 gboolean wtap_dump_close(wtap_dumper *, int *);
954 /*** various string converter functions ***/
955 const char *wtap_file_type_string(int filetype);
956 const char *wtap_file_type_short_string(int filetype);
957 int wtap_short_string_to_file_type(const char *short_name);
959 const char *wtap_file_extensions_string(int filetype);
960 const char *wtap_file_extension_default_string(int filetype);
962 const char *wtap_encap_string(int encap);
963 const char *wtap_encap_short_string(int encap);
964 int wtap_short_string_to_encap(const char *short_name);
966 const char *wtap_strerror(int err);
968 /*** get available number of file types and encapsulations ***/
969 int wtap_get_num_encap_types(void);
970 int wtap_get_num_file_types(void);
972 /*** dynamically register new file types and encapsulations ***/
973 void wtap_register_open_routine(wtap_open_routine_t, gboolean has_magic);
974 int wtap_register_file_type(const struct file_type_info* fi);
975 int wtap_register_encap_type(char* name, char* short_name);
979 * Wiretap error codes.
981 #define WTAP_ERR_NOT_REGULAR_FILE -1
982 /* The file being opened for reading isn't a plain file (or pipe) */
983 #define WTAP_ERR_RANDOM_OPEN_PIPE -2
984 /* The file is being opened for random access and it's a pipe */
985 #define WTAP_ERR_FILE_UNKNOWN_FORMAT -3
986 /* The file being opened is not a capture file in a known format */
987 #define WTAP_ERR_UNSUPPORTED -4
988 /* Supported file type, but there's something in the file we
990 #define WTAP_ERR_CANT_WRITE_TO_PIPE -5
991 /* Wiretap can't save to a pipe in the specified format */
992 #define WTAP_ERR_CANT_OPEN -6
993 /* The file couldn't be opened, reason unknown */
994 #define WTAP_ERR_UNSUPPORTED_FILE_TYPE -7
995 /* Wiretap can't save files in the specified format */
996 #define WTAP_ERR_UNSUPPORTED_ENCAP -8
997 /* Wiretap can't read or save files in the specified format with the
998 specified encapsulation */
999 #define WTAP_ERR_ENCAP_PER_PACKET_UNSUPPORTED -9
1000 /* The specified format doesn't support per-packet encapsulations */
1001 #define WTAP_ERR_CANT_CLOSE -10
1002 /* The file couldn't be closed, reason unknown */
1003 #define WTAP_ERR_CANT_READ -11
1004 /* An attempt to read failed, reason unknown */
1005 #define WTAP_ERR_SHORT_READ -12
1006 /* An attempt to read read less data than it should have */
1007 #define WTAP_ERR_BAD_FILE -13
1008 /* The file appears to be damaged or corrupted or otherwise bogus */
1009 #define WTAP_ERR_SHORT_WRITE -14
1010 /* An attempt to write wrote less data than it should have */
1011 #define WTAP_ERR_UNC_TRUNCATED -15
1012 /* Sniffer compressed data was oddly truncated */
1013 #define WTAP_ERR_UNC_OVERFLOW -16
1014 /* Uncompressing Sniffer data would overflow buffer */
1015 #define WTAP_ERR_UNC_BAD_OFFSET -17
1016 /* LZ77 compressed data has bad offset to string */
1017 #define WTAP_ERR_RANDOM_OPEN_STDIN -18
1018 /* We're trying to open the standard input for random access */
1019 #define WTAP_ERR_COMPRESSION_NOT_SUPPORTED -19
1020 /* The filetype doesn't support output compression */
1021 #define WTAP_ERR_CANT_SEEK -20
1022 /* An attempt to seek failed, reason unknown */
1023 #define WTAP_ERR_DECOMPRESS -21
1024 /* Error decompressing */
1025 #define WTAP_ERR_INTERNAL -22
1026 /* "Shouldn't happen" internal errors */
1030 #endif /* __cplusplus */
1032 #endif /* __WTAP_H__ */