4 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 #ifdef HAVE_SYS_TIME_H
30 #include <wsutil/buffer.h>
31 #include <wsutil/nstime.h>
32 #include "ws_symbol_export.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_IEEE_802_11_PRISM 21
115 #define WTAP_ENCAP_IEEE_802_11_WITH_RADIO 22
116 #define WTAP_ENCAP_IEEE_802_11_RADIOTAP 23
117 #define WTAP_ENCAP_IEEE_802_11_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_ENCAP_GCOM_TIE1 77
171 #define WTAP_ENCAP_GCOM_SERIAL 78
172 #define WTAP_ENCAP_NETTL_X25 79
173 #define WTAP_ENCAP_K12 80
174 #define WTAP_ENCAP_JUNIPER_MLPPP 81
175 #define WTAP_ENCAP_JUNIPER_MLFR 82
176 #define WTAP_ENCAP_JUNIPER_ETHER 83
177 #define WTAP_ENCAP_JUNIPER_PPP 84
178 #define WTAP_ENCAP_JUNIPER_FRELAY 85
179 #define WTAP_ENCAP_JUNIPER_CHDLC 86
180 #define WTAP_ENCAP_JUNIPER_GGSN 87
181 #define WTAP_ENCAP_LINUX_LAPD 88
182 #define WTAP_ENCAP_CATAPULT_DCT2000 89
183 #define WTAP_ENCAP_BER 90
184 #define WTAP_ENCAP_JUNIPER_VP 91
185 #define WTAP_ENCAP_USB 92
186 #define WTAP_ENCAP_IEEE802_16_MAC_CPS 93
187 #define WTAP_ENCAP_NETTL_RAW_TELNET 94
188 #define WTAP_ENCAP_USB_LINUX 95
189 #define WTAP_ENCAP_MPEG 96
190 #define WTAP_ENCAP_PPI 97
191 #define WTAP_ENCAP_ERF 98
192 #define WTAP_ENCAP_BLUETOOTH_H4_WITH_PHDR 99
193 #define WTAP_ENCAP_SITA 100
194 #define WTAP_ENCAP_SCCP 101
195 #define WTAP_ENCAP_BLUETOOTH_HCI 102 /*raw packets without a transport layer header e.g. H4*/
196 #define WTAP_ENCAP_IPMB 103
197 #define WTAP_ENCAP_IEEE802_15_4 104
198 #define WTAP_ENCAP_X2E_XORAYA 105
199 #define WTAP_ENCAP_FLEXRAY 106
200 #define WTAP_ENCAP_LIN 107
201 #define WTAP_ENCAP_MOST 108
202 #define WTAP_ENCAP_CAN20B 109
203 #define WTAP_ENCAP_LAYER1_EVENT 110
204 #define WTAP_ENCAP_X2E_SERIAL 111
205 #define WTAP_ENCAP_I2C 112
206 #define WTAP_ENCAP_IEEE802_15_4_NONASK_PHY 113
207 #define WTAP_ENCAP_TNEF 114
208 #define WTAP_ENCAP_USB_LINUX_MMAPPED 115
209 #define WTAP_ENCAP_GSM_UM 116
210 #define WTAP_ENCAP_DPNSS 117
211 #define WTAP_ENCAP_PACKETLOGGER 118
212 #define WTAP_ENCAP_NSTRACE_1_0 119
213 #define WTAP_ENCAP_NSTRACE_2_0 120
214 #define WTAP_ENCAP_FIBRE_CHANNEL_FC2 121
215 #define WTAP_ENCAP_FIBRE_CHANNEL_FC2_WITH_FRAME_DELIMS 122
216 #define WTAP_ENCAP_JPEG_JFIF 123 /* obsoleted by WTAP_ENCAP_MIME*/
217 #define WTAP_ENCAP_IPNET 124
218 #define WTAP_ENCAP_SOCKETCAN 125
219 #define WTAP_ENCAP_IEEE_802_11_NETMON 126
220 #define WTAP_ENCAP_IEEE802_15_4_NOFCS 127
221 #define WTAP_ENCAP_RAW_IPFIX 128
222 #define WTAP_ENCAP_RAW_IP4 129
223 #define WTAP_ENCAP_RAW_IP6 130
224 #define WTAP_ENCAP_LAPD 131
225 #define WTAP_ENCAP_DVBCI 132
226 #define WTAP_ENCAP_MUX27010 133
227 #define WTAP_ENCAP_MIME 134
228 #define WTAP_ENCAP_NETANALYZER 135
229 #define WTAP_ENCAP_NETANALYZER_TRANSPARENT 136
230 #define WTAP_ENCAP_IP_OVER_IB 137
231 #define WTAP_ENCAP_MPEG_2_TS 138
232 #define WTAP_ENCAP_PPP_ETHER 139
233 #define WTAP_ENCAP_NFC_LLCP 140
234 #define WTAP_ENCAP_NFLOG 141
235 #define WTAP_ENCAP_V5_EF 142
236 #define WTAP_ENCAP_BACNET_MS_TP_WITH_PHDR 143
237 #define WTAP_ENCAP_IXVERIWAVE 144
238 #define WTAP_ENCAP_IEEE_802_11_AIROPEEK 145
239 #define WTAP_ENCAP_SDH 146
240 #define WTAP_ENCAP_DBUS 147
241 #define WTAP_ENCAP_AX25_KISS 148
242 #define WTAP_ENCAP_AX25 149
243 #define WTAP_ENCAP_SCTP 150
244 #define WTAP_ENCAP_INFINIBAND 151
245 #define WTAP_ENCAP_JUNIPER_SVCS 152
246 #define WTAP_ENCAP_USBPCAP 153
247 #define WTAP_ENCAP_RTAC_SERIAL 154
248 #define WTAP_ENCAP_BLUETOOTH_LE_LL 155
249 #define WTAP_ENCAP_WIRESHARK_UPPER_PDU 156
250 #define WTAP_ENCAP_STANAG_4607 157
251 #define WTAP_ENCAP_STANAG_5066_D_PDU 158
252 #define WTAP_ENCAP_NETLINK 159
253 #define WTAP_ENCAP_BLUETOOTH_LINUX_MONITOR 160
254 #define WTAP_ENCAP_BLUETOOTH_BREDR_BB 161
255 #define WTAP_ENCAP_BLUETOOTH_LE_LL_WITH_PHDR 162
256 #define WTAP_ENCAP_NSTRACE_3_0 163
257 #define WTAP_ENCAP_LOGCAT 164
258 #define WTAP_ENCAP_LOGCAT_BRIEF 165
259 #define WTAP_ENCAP_LOGCAT_PROCESS 166
260 #define WTAP_ENCAP_LOGCAT_TAG 167
261 #define WTAP_ENCAP_LOGCAT_THREAD 168
262 #define WTAP_ENCAP_LOGCAT_TIME 169
263 #define WTAP_ENCAP_LOGCAT_THREADTIME 170
264 #define WTAP_ENCAP_LOGCAT_LONG 171
265 #define WTAP_ENCAP_PKTAP 172
266 #define WTAP_ENCAP_EPON 173
267 #define WTAP_ENCAP_IPMI_TRACE 174
268 /* After adding new item here, please also add new item to encap_table_base array */
270 #define WTAP_NUM_ENCAP_TYPES wtap_get_num_encap_types()
272 /* File types/subtypes that can be read by wiretap.
273 We support writing many of these file types, too, so we
274 distinguish between different subtypes of them, as
275 different subtypes need to be written in a different
277 #define WTAP_FILE_TYPE_SUBTYPE_UNKNOWN 0
278 #define WTAP_FILE_TYPE_SUBTYPE_PCAP 1
279 #define WTAP_FILE_TYPE_SUBTYPE_PCAPNG 2
280 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_NSEC 3
281 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_AIX 4
282 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_SS991029 5
283 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_NOKIA 6
284 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_SS990417 7
285 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_SS990915 8
286 #define WTAP_FILE_TYPE_SUBTYPE_5VIEWS 9
287 #define WTAP_FILE_TYPE_SUBTYPE_IPTRACE_1_0 10
288 #define WTAP_FILE_TYPE_SUBTYPE_IPTRACE_2_0 11
289 #define WTAP_FILE_TYPE_SUBTYPE_BER 12
290 #define WTAP_FILE_TYPE_SUBTYPE_HCIDUMP 13
291 #define WTAP_FILE_TYPE_SUBTYPE_CATAPULT_DCT2000 14
292 #define WTAP_FILE_TYPE_SUBTYPE_NETXRAY_OLD 15
293 #define WTAP_FILE_TYPE_SUBTYPE_NETXRAY_1_0 16
294 #define WTAP_FILE_TYPE_SUBTYPE_COSINE 17
295 #define WTAP_FILE_TYPE_SUBTYPE_CSIDS 18
296 #define WTAP_FILE_TYPE_SUBTYPE_DBS_ETHERWATCH 19
297 #define WTAP_FILE_TYPE_SUBTYPE_ERF 20
298 #define WTAP_FILE_TYPE_SUBTYPE_EYESDN 21
299 #define WTAP_FILE_TYPE_SUBTYPE_NETTL 22
300 #define WTAP_FILE_TYPE_SUBTYPE_ISERIES 23
301 #define WTAP_FILE_TYPE_SUBTYPE_ISERIES_UNICODE 24
302 #define WTAP_FILE_TYPE_SUBTYPE_I4BTRACE 25
303 #define WTAP_FILE_TYPE_SUBTYPE_ASCEND 26
304 #define WTAP_FILE_TYPE_SUBTYPE_NETMON_1_x 27
305 #define WTAP_FILE_TYPE_SUBTYPE_NETMON_2_x 28
306 #define WTAP_FILE_TYPE_SUBTYPE_NGSNIFFER_UNCOMPRESSED 29
307 #define WTAP_FILE_TYPE_SUBTYPE_NGSNIFFER_COMPRESSED 30
308 #define WTAP_FILE_TYPE_SUBTYPE_NETXRAY_1_1 31
309 #define WTAP_FILE_TYPE_SUBTYPE_NETXRAY_2_00x 32
310 #define WTAP_FILE_TYPE_SUBTYPE_NETWORK_INSTRUMENTS 33
311 #define WTAP_FILE_TYPE_SUBTYPE_LANALYZER 34
312 #define WTAP_FILE_TYPE_SUBTYPE_PPPDUMP 35
313 #define WTAP_FILE_TYPE_SUBTYPE_RADCOM 36
314 #define WTAP_FILE_TYPE_SUBTYPE_SNOOP 37
315 #define WTAP_FILE_TYPE_SUBTYPE_SHOMITI 38
316 #define WTAP_FILE_TYPE_SUBTYPE_VMS 39
317 #define WTAP_FILE_TYPE_SUBTYPE_K12 40
318 #define WTAP_FILE_TYPE_SUBTYPE_TOSHIBA 41
319 #define WTAP_FILE_TYPE_SUBTYPE_VISUAL_NETWORKS 42
320 #define WTAP_FILE_TYPE_SUBTYPE_PEEKCLASSIC_V56 43
321 #define WTAP_FILE_TYPE_SUBTYPE_PEEKCLASSIC_V7 44
322 #define WTAP_FILE_TYPE_SUBTYPE_PEEKTAGGED 45
323 #define WTAP_FILE_TYPE_SUBTYPE_MPEG 46
324 #define WTAP_FILE_TYPE_SUBTYPE_K12TEXT 47
325 #define WTAP_FILE_TYPE_SUBTYPE_NETSCREEN 48
326 #define WTAP_FILE_TYPE_SUBTYPE_COMMVIEW 49
327 #define WTAP_FILE_TYPE_SUBTYPE_BTSNOOP 50
328 #define WTAP_FILE_TYPE_SUBTYPE_TNEF 51
329 #define WTAP_FILE_TYPE_SUBTYPE_DCT3TRACE 52
330 #define WTAP_FILE_TYPE_SUBTYPE_PACKETLOGGER 53
331 #define WTAP_FILE_TYPE_SUBTYPE_DAINTREE_SNA 54
332 #define WTAP_FILE_TYPE_SUBTYPE_NETSCALER_1_0 55
333 #define WTAP_FILE_TYPE_SUBTYPE_NETSCALER_2_0 56
334 #define WTAP_FILE_TYPE_SUBTYPE_JPEG_JFIF 57 /* obsoleted by WTAP_FILE_TYPE_SUBTYPE_MIME */
335 #define WTAP_FILE_TYPE_SUBTYPE_IPFIX 58
336 #define WTAP_FILE_TYPE_SUBTYPE_MIME 59
337 #define WTAP_FILE_TYPE_SUBTYPE_AETHRA 60
338 #define WTAP_FILE_TYPE_SUBTYPE_MPEG_2_TS 61
339 #define WTAP_FILE_TYPE_SUBTYPE_VWR_80211 62
340 #define WTAP_FILE_TYPE_SUBTYPE_VWR_ETH 63
341 #define WTAP_FILE_TYPE_SUBTYPE_CAMINS 64
342 #define WTAP_FILE_TYPE_SUBTYPE_STANAG_4607 65
343 #define WTAP_FILE_TYPE_SUBTYPE_NETSCALER_3_0 66
344 #define WTAP_FILE_TYPE_SUBTYPE_LOGCAT 67
345 #define WTAP_FILE_TYPE_SUBTYPE_LOGCAT_BRIEF 68
346 #define WTAP_FILE_TYPE_SUBTYPE_LOGCAT_PROCESS 69
347 #define WTAP_FILE_TYPE_SUBTYPE_LOGCAT_TAG 70
348 #define WTAP_FILE_TYPE_SUBTYPE_LOGCAT_THREAD 71
349 #define WTAP_FILE_TYPE_SUBTYPE_LOGCAT_TIME 72
350 #define WTAP_FILE_TYPE_SUBTYPE_LOGCAT_THREADTIME 73
351 #define WTAP_FILE_TYPE_SUBTYPE_LOGCAT_LONG 74
352 #define WTAP_FILE_TYPE_SUBTYPE_COLASOFT_CAPSA 75
353 #define WTAP_FILE_TYPE_SUBTYPE_COLASOFT_PACKET_BUILDER 76
355 #define WTAP_NUM_FILE_TYPES_SUBTYPES wtap_get_num_file_types_subtypes()
357 /* timestamp precision (currently only these values are supported) */
358 #define WTAP_TSPREC_UNKNOWN -2
359 #define WTAP_TSPREC_PER_PACKET -1 /* as a per-file value, means per-packet */
360 #define WTAP_TSPREC_SEC 0
361 #define WTAP_TSPREC_DSEC 1
362 #define WTAP_TSPREC_CSEC 2
363 #define WTAP_TSPREC_MSEC 3
364 #define WTAP_TSPREC_USEC 6
365 #define WTAP_TSPREC_NSEC 9
368 * Maximum packet size we'll support.
369 * 262144 is the largest snapshot length that libpcap supports, so we
372 #define WTAP_MAX_PACKET_SIZE 262144
375 * "Pseudo-headers" are used to supply to the clients of wiretap
376 * per-packet information that's not part of the packet payload
379 * NOTE: do not use pseudo-header structures to hold information
380 * used by the code to read a particular capture file type; to
381 * keep that sort of state information, add a new structure for
382 * that private information to "wtap-int.h", add a pointer to that
383 * type of structure to the "capture" member of the "struct wtap"
384 * structure, and allocate one of those structures and set that member
385 * in the "open" routine for that capture file type if the open
386 * succeeds. See various other capture file type handlers for examples
402 guint8 vlantag_offset;
403 guint8 coreid_offset;
404 guint8 srcnodeid_offset;
405 guint8 destnodeid_offset;
406 guint8 clflags_offset;
407 guint8 src_vmname_len_offset;
408 guint8 dst_vmname_len_offset;
409 guint8 ns_activity_offset;
413 /* Packet "pseudo-header" information for Ethernet capture files. */
415 gint fcs_len; /* Number of bytes of FCS - -1 means "unknown" */
418 /* Packet "pseudo-header" information for X.25 capture files. */
419 #define FROM_DCE 0x80
421 guint8 flags; /* ENCAP_LAPB, ENCAP_V120 : 1st bit means From DCE */
424 /* Packet "pseudo-header" information for ISDN capture files. */
429 guint8 channel; /* 0 = D-channel; n = B-channel n */
432 /* Packet "pseudo-header" for ATM capture files.
433 Not all of this information is supplied by all capture types.
434 These originally came from the Network General (DOS-based)
435 ATM Sniffer file format, but we've added some additional
441 #define ATM_RAW_CELL 0x01 /* TRUE if the packet is a single cell */
442 #define ATM_NO_HEC 0x02 /* TRUE if the cell has HEC stripped out */
443 #define ATM_AAL2_NOPHDR 0x04 /* TRUE if the AAL2 PDU has no pseudo-header */
444 #define ATM_REASSEMBLY_ERROR 0x08 /* TRUE if this is an incompletely-reassembled PDU */
449 #define AAL_UNKNOWN 0 /* AAL unknown */
450 #define AAL_1 1 /* AAL1 */
451 #define AAL_2 2 /* AAL2 */
452 #define AAL_3_4 3 /* AAL3/4 */
453 #define AAL_5 4 /* AAL5 */
454 #define AAL_USER 5 /* User AAL */
455 #define AAL_SIGNALLING 6 /* Signaling AAL */
456 #define AAL_OAMCELL 7 /* OAM cell */
461 #define TRAF_UNKNOWN 0 /* Unknown */
462 #define TRAF_LLCMX 1 /* LLC multiplexed (RFC 1483) */
463 #define TRAF_VCMX 2 /* VC multiplexed (RFC 1483) */
464 #define TRAF_LANE 3 /* LAN Emulation */
465 #define TRAF_ILMI 4 /* ILMI */
466 #define TRAF_FR 5 /* Frame Relay */
467 #define TRAF_SPANS 6 /* FORE SPANS */
468 #define TRAF_IPSILON 7 /* Ipsilon */
469 #define TRAF_UMTS_FP 8 /* UMTS Frame Protocol */
470 #define TRAF_GPRS_NS 9 /* GPRS Network Services */
471 #define TRAF_SSCOP 10 /* SSCOP */
476 #define TRAF_ST_UNKNOWN 0 /* Unknown */
481 #define TRAF_ST_VCMX_802_3_FCS 1 /* 802.3 with an FCS */
482 #define TRAF_ST_VCMX_802_4_FCS 2 /* 802.4 with an FCS */
483 #define TRAF_ST_VCMX_802_5_FCS 3 /* 802.5 with an FCS */
484 #define TRAF_ST_VCMX_FDDI_FCS 4 /* FDDI with an FCS */
485 #define TRAF_ST_VCMX_802_6_FCS 5 /* 802.6 with an FCS */
486 #define TRAF_ST_VCMX_802_3 7 /* 802.3 without an FCS */
487 #define TRAF_ST_VCMX_802_4 8 /* 802.4 without an FCS */
488 #define TRAF_ST_VCMX_802_5 9 /* 802.5 without an FCS */
489 #define TRAF_ST_VCMX_FDDI 10 /* FDDI without an FCS */
490 #define TRAF_ST_VCMX_802_6 11 /* 802.6 without an FCS */
491 #define TRAF_ST_VCMX_FRAGMENTS 12 /* Fragments */
492 #define TRAF_ST_VCMX_BPDU 13 /* BPDU */
497 #define TRAF_ST_LANE_LE_CTRL 1 /* LANE: LE Ctrl */
498 #define TRAF_ST_LANE_802_3 2 /* LANE: 802.3 */
499 #define TRAF_ST_LANE_802_5 3 /* LANE: 802.5 */
500 #define TRAF_ST_LANE_802_3_MC 4 /* LANE: 802.3 multicast */
501 #define TRAF_ST_LANE_802_5_MC 5 /* LANE: 802.5 multicast */
506 #define TRAF_ST_IPSILON_FT0 1 /* Ipsilon: Flow Type 0 */
507 #define TRAF_ST_IPSILON_FT1 2 /* Ipsilon: Flow Type 1 */
508 #define TRAF_ST_IPSILON_FT2 3 /* Ipsilon: Flow Type 2 */
511 guint32 flags; /* status flags */
512 guint8 aal; /* AAL of the traffic */
513 guint8 type; /* traffic type */
514 guint8 subtype; /* traffic subtype */
515 guint16 vpi; /* virtual path identifier */
516 guint16 vci; /* virtual circuit identifier */
517 guint8 aal2_cid; /* channel id */
518 guint16 channel; /* link: 0 for DTE->DCE, 1 for DCE->DTE */
519 guint16 cells; /* number of cells */
520 guint16 aal5t_u2u; /* user-to-user indicator */
521 guint16 aal5t_len; /* length of the packet */
522 guint32 aal5t_chksum; /* checksum for AAL5 packet */
525 /* Packet "pseudo-header" for Nokia output */
528 guint8 stuff[4]; /* mysterious stuff */
531 /* Packet "pseudo-header" for the output from "wandsession", "wannext",
532 "wandisplay", and similar commands on Lucent/Ascend access equipment. */
534 #define ASCEND_MAX_STR_LEN 64
536 #define ASCEND_PFX_WDS_X 1
537 #define ASCEND_PFX_WDS_R 2
538 #define ASCEND_PFX_WDD 3
539 #define ASCEND_PFX_ISDN_X 4
540 #define ASCEND_PFX_ISDN_R 5
541 #define ASCEND_PFX_ETHER 6
544 guint16 type; /* ASCEND_PFX_*, as defined above */
545 char user[ASCEND_MAX_STR_LEN]; /* Username, from wandsession header */
546 guint32 sess; /* Session number, from wandsession header */
547 char call_num[ASCEND_MAX_STR_LEN]; /* Called number, from WDD header */
548 guint32 chunk; /* Chunk number, from WDD header */
549 guint32 task; /* Task number */
552 /* Also defined in epan/packet_info.h */
553 #define P2P_DIR_UNKNOWN -1
554 #define P2P_DIR_SENT 0
555 #define P2P_DIR_RECV 1
557 /* Packet "pseudo-header" for point-to-point links with direction flags. */
559 int sent; /* TRUE=sent, FALSE=received, -1=unknown*/
563 * Packet "pseudo-header" information for 802.11.
564 * Radio information is only present in this form for
565 * WTAP_ENCAP_IEEE_802_11_WITH_RADIO. This is used for file formats in
566 * which the radio information isn't provided as a pseudo-header in the
569 * Signal strength, etc. information:
571 * Raw signal strength can be measured in milliwatts.
572 * It can also be represented as dBm, which is 10 times the log base 10
573 * of the signal strength in mW.
575 * The Receive Signal Strength Indicator is an integer in the range 0 to 255.
576 * The actual RSSI value for a given signal strength is dependent on the
577 * vendor (and perhaps on the adapter). The maximum possible RSSI value
578 * is also dependent on the vendor and perhaps the adapter.
580 * The signal strength can be represented as a percentage, which is 100
581 * times the ratio of the RSSI and the maximum RSSI.
583 struct ieee_802_11_phdr {
584 guint32 presence_flags; /* flags indicating presence of certain fields */
585 gint fcs_len; /* Number of bytes of FCS - -1 means "unknown" */
586 gboolean decrypted; /* TRUE if frame is decrypted even if "protected" bit is set */
587 guint16 channel; /* Channel number */
588 guint16 data_rate; /* Data rate, in .5 Mb/s units */
589 guint16 mcs; /* MCS index */
590 guint32 frequency; /* Channel center frequency */
591 guint8 signal_percent; /* Signal level, as a percentage */
592 guint8 noise_percent; /* Noise level, as a percentage */
593 gint8 signal_dbm; /* Signal level, in dBm */
594 gint8 noise_dbm; /* Noise level, in dBm */
595 guint64 tsf_timestamp;
598 #define PHDR_802_11_HAS_CHANNEL 0x00000001 /* channel */
599 #define PHDR_802_11_HAS_DATA_RATE 0x00000002 /* data_rate */
600 #define PHDR_802_11_HAS_MCS 0x00000004 /* mcs_index */
601 #define PHDR_802_11_HAS_FREQUENCY 0x00000008 /* frequency */
602 #define PHDR_802_11_HAS_SIGNAL_PERCENT 0x00000010 /* signal_percent */
603 #define PHDR_802_11_HAS_NOISE_PERCENT 0x00000020 /* noise_percent */
604 #define PHDR_802_11_HAS_SIGNAL_DBM 0x00000040 /* signal_dbm */
605 #define PHDR_802_11_HAS_NOISE_DBM 0x00000080 /* noise_dbm */
606 #define PHDR_802_11_HAS_TSF_TIMESTAMP 0x00000100 /* tsf_timestamp */
608 /* Packet "pseudo-header" for the output from CoSine L2 debug output. */
610 #define COSINE_MAX_IF_NAME_LEN 128
612 #define COSINE_ENCAP_TEST 1
613 #define COSINE_ENCAP_PPoATM 2
614 #define COSINE_ENCAP_PPoFR 3
615 #define COSINE_ENCAP_ATM 4
616 #define COSINE_ENCAP_FR 5
617 #define COSINE_ENCAP_HDLC 6
618 #define COSINE_ENCAP_PPP 7
619 #define COSINE_ENCAP_ETH 8
620 #define COSINE_ENCAP_UNKNOWN 99
622 #define COSINE_DIR_TX 1
623 #define COSINE_DIR_RX 2
626 guint8 encap; /* COSINE_ENCAP_* as defined above */
627 guint8 direction; /* COSINE_DIR_*, as defined above */
628 char if_name[COSINE_MAX_IF_NAME_LEN]; /* Encap & Logical I/F name */
629 guint16 pro; /* Protocol */
630 guint16 off; /* Offset */
631 guint16 pri; /* Priority */
632 guint16 rm; /* Rate Marking */
633 guint16 err; /* Error Code */
636 /* Packet "pseudo-header" for IrDA capture files. */
639 * Direction of the packet
641 #define IRDA_INCOMING 0x0000
642 #define IRDA_OUTGOING 0x0004
645 * "Inline" log messages produced by IrCOMM2k on Windows
647 #define IRDA_LOG_MESSAGE 0x0100 /* log message */
648 #define IRDA_MISSED_MSG 0x0101 /* missed log entry or frame */
651 * Differentiate between frames and log messages
653 #define IRDA_CLASS_FRAME 0x0000
654 #define IRDA_CLASS_LOG 0x0100
655 #define IRDA_CLASS_MASK 0xFF00
658 guint16 pkttype; /* packet type */
661 /* Packet "pseudo-header" for nettl (HP-UX) capture files. */
671 /* Packet "pseudo-header" for MTP2 files. */
673 #define MTP2_ANNEX_A_NOT_USED 0
674 #define MTP2_ANNEX_A_USED 1
675 #define MTP2_ANNEX_A_USED_UNKNOWN 2
683 /* Packet "pseudo-header" for K12 files. */
697 const gchar *input_name;
698 const gchar *stack_file;
700 k12_input_info_t input_info;
702 guint32 extra_length;
706 #define K12_PORT_DS0S 0x00010008
707 #define K12_PORT_DS1 0x00100008
708 #define K12_PORT_ATMPVC 0x01020000
711 guint16 pkttype; /* packet type */
716 struct catapult_dct2000_phdr
720 struct isdn_phdr isdn;
723 } inner_pseudo_header;
728 #define LIBPCAP_BT_PHDR_SENT 0
729 #define LIBPCAP_BT_PHDR_RECV 1
732 * Header prepended by libpcap to each bluetooth hci h4 frame.
733 * Values in network byte order
735 struct libpcap_bt_phdr {
736 guint32 direction; /* Bit 0 hold the frame direction. */
740 * Header prepended by libpcap to each bluetooth monitor frame
741 * Values in network byte order
743 struct libpcap_bt_monitor_phdr {
748 #define LIBPCAP_PPP_PHDR_RECV 0
749 #define LIBPCAP_PPP_PHDR_SENT 1
752 * Header prepended by libpcap to each ppp frame.
754 struct libpcap_ppp_phdr {
759 * Endace Record Format pseudo header
762 guint64 ts; /* Time stamp */
775 * ERF pseudo header with optional subheader
776 * (Multichannel or Ethernet)
779 #define MAX_ERF_EHDR 8
782 struct erf_phdr phdr;
783 struct erf_ehdr ehdr_list[MAX_ERF_EHDR];
791 #define LLCP_PHDR_FLAG_SENT 0
797 #define SITA_FRAME_DIR_TXED (0x00) /* values of sita_phdr.flags */
798 #define SITA_FRAME_DIR_RXED (0x01)
799 #define SITA_FRAME_DIR (0x01) /* mask */
800 #define SITA_ERROR_NO_BUFFER (0x80)
802 #define SITA_SIG_DSR (0x01) /* values of sita_phdr.signals */
803 #define SITA_SIG_DTR (0x02)
804 #define SITA_SIG_CTS (0x04)
805 #define SITA_SIG_RTS (0x08)
806 #define SITA_SIG_DCD (0x10)
807 #define SITA_SIG_UNDEF1 (0x20)
808 #define SITA_SIG_UNDEF2 (0x40)
809 #define SITA_SIG_UNDEF3 (0x80)
811 #define SITA_ERROR_TX_UNDERRUN (0x01) /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_TXED) */
812 #define SITA_ERROR_TX_CTS_LOST (0x02)
813 #define SITA_ERROR_TX_UART_ERROR (0x04)
814 #define SITA_ERROR_TX_RETX_LIMIT (0x08)
815 #define SITA_ERROR_TX_UNDEF1 (0x10)
816 #define SITA_ERROR_TX_UNDEF2 (0x20)
817 #define SITA_ERROR_TX_UNDEF3 (0x40)
818 #define SITA_ERROR_TX_UNDEF4 (0x80)
820 #define SITA_ERROR_RX_FRAMING (0x01) /* values of sita_phdr.errors1 (if SITA_FRAME_DIR_RXED) */
821 #define SITA_ERROR_RX_PARITY (0x02)
822 #define SITA_ERROR_RX_COLLISION (0x04)
823 #define SITA_ERROR_RX_FRAME_LONG (0x08)
824 #define SITA_ERROR_RX_FRAME_SHORT (0x10)
825 #define SITA_ERROR_RX_UNDEF1 (0x20)
826 #define SITA_ERROR_RX_UNDEF2 (0x40)
827 #define SITA_ERROR_RX_UNDEF3 (0x80)
829 #define SITA_ERROR_RX_NONOCTET_ALIGNED (0x01) /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_RXED) */
830 #define SITA_ERROR_RX_ABORT (0x02)
831 #define SITA_ERROR_RX_CD_LOST (0x04)
832 #define SITA_ERROR_RX_DPLL (0x08)
833 #define SITA_ERROR_RX_OVERRUN (0x10)
834 #define SITA_ERROR_RX_FRAME_LEN_VIOL (0x20)
835 #define SITA_ERROR_RX_CRC (0x40)
836 #define SITA_ERROR_RX_BREAK (0x80)
838 #define SITA_PROTO_UNUSED (0x00) /* values of sita_phdr.proto */
839 #define SITA_PROTO_BOP_LAPB (0x01)
840 #define SITA_PROTO_ETHERNET (0x02)
841 #define SITA_PROTO_ASYNC_INTIO (0x03)
842 #define SITA_PROTO_ASYNC_BLKIO (0x04)
843 #define SITA_PROTO_ALC (0x05)
844 #define SITA_PROTO_UTS (0x06)
845 #define SITA_PROTO_PPP_HDLC (0x07)
846 #define SITA_PROTO_SDLC (0x08)
847 #define SITA_PROTO_TOKENRING (0x09)
848 #define SITA_PROTO_I2C (0x10)
849 #define SITA_PROTO_DPM_LINK (0x11)
850 #define SITA_PROTO_BOP_FRL (0x12)
860 /*pseudo header for Bluetooth HCI*/
866 #define BTHCI_CHANNEL_COMMAND 1
867 #define BTHCI_CHANNEL_ACL 2
868 #define BTHCI_CHANNEL_SCO 3
869 #define BTHCI_CHANNEL_EVENT 4
871 /* pseudo header for WTAP_ENCAP_BLUETOOTH_LINUX_MONITOR */
877 /* pseudo header for WTAP_ENCAP_LAYER1_EVENT */
878 struct l1event_phdr {
882 /* * I2C pseudo header */
889 /* pseudo header for WTAP_ENCAP_GSM_UM */
893 /* The following are only populated for downlink */
901 #define GSM_UM_CHANNEL_UNKNOWN 0
902 #define GSM_UM_CHANNEL_BCCH 1
903 #define GSM_UM_CHANNEL_SDCCH 2
904 #define GSM_UM_CHANNEL_SACCH 3
905 #define GSM_UM_CHANNEL_FACCH 4
906 #define GSM_UM_CHANNEL_CCCH 5
907 #define GSM_UM_CHANNEL_RACH 6
908 #define GSM_UM_CHANNEL_AGCH 7
909 #define GSM_UM_CHANNEL_PCH 8
911 /* pseudo header for WTAP_ENCAP_LOGCAT */
916 /* Pseudo-header for file-type-specific records */
917 struct ft_specific_record_phdr {
918 guint record_type; /* the type of record this is */
921 union wtap_pseudo_header {
924 struct isdn_phdr isdn;
926 struct ascend_phdr ascend;
928 struct ieee_802_11_phdr ieee_802_11;
929 struct cosine_phdr cosine;
930 struct irda_phdr irda;
931 struct nettl_phdr nettl;
932 struct mtp2_phdr mtp2;
934 struct lapd_phdr lapd;
935 struct catapult_dct2000_phdr dct2000;
936 struct erf_mc_phdr erf;
937 struct sita_phdr sita;
938 struct bthci_phdr bthci;
939 struct btmon_phdr btmon;
940 struct l1event_phdr l1event;
942 struct gsm_um_phdr gsm_um;
943 struct nstr_phdr nstr;
944 struct nokia_phdr nokia;
945 struct llcp_phdr llcp;
946 struct logcat_phdr logcat;
947 struct ft_specific_record_phdr ftsrec;
951 * Record type values.
953 * This list will expand over time, so don't assume everything will
954 * forever be one of the types listed below.
956 * For file-type-specific records, the "ftsrec" field of the pseudo-header
957 * contains a file-type-specific subtype value, such as a block type for
960 * An "event" is an indication that something happened during the capture
961 * process, such as a status transition of some sort on the network.
962 * These should, ideally, have a time stamp and, if they're relevant to
963 * a particular interface on a multi-interface capture, should also have
964 * an interface ID. The data for the event is file-type-specific and
965 * subtype-specific. These should be dissected and displayed just as
968 * A "report" supplies information not corresponding to an event;
969 * for example, a pcap-ng Interface Statistics Block would be a report,
970 * as it doesn't correspond to something happening on the network.
971 * They may have a time stamp, and should be dissected and displayed
972 * just as packets are.
974 * We distingiush between "events" and "reports" so that, for example,
975 * the packet display can show the delta between a packet and an event
976 * but not show the delta between a packet and a report, as the time
977 * stamp of a report may not correspond to anything interesting on
978 * the network but the time stamp of an event would.
980 * XXX - are there any file-type-specific records that *shouldn't* be
981 * dissected and displayed? If so, they should be parsed and the
982 * information in them stored somewhere, and used somewhere, whether
983 * it's just used when saving the file in its native format or also
984 * used to parse *other* file-type-specific records.
986 #define REC_TYPE_PACKET 0 /**< packet */
987 #define REC_TYPE_FT_SPECIFIC_EVENT 1 /**< file-type-specific event */
988 #define REC_TYPE_FT_SPECIFIC_REPORT 2 /**< file-type-specific report */
991 guint rec_type; /* what type of record is this? */
992 guint32 presence_flags; /* what stuff do we have? */
994 guint32 caplen; /* data length in the file */
995 guint32 len; /* data length on the wire */
996 int pkt_encap; /* WTAP_ENCAP_ value for this packet */
997 int pkt_tsprec; /* WTAP_TSPREC_ value for this packet */
998 /* pcapng variables */
999 guint32 interface_id; /* identifier of the interface. */
1001 gchar *opt_comment; /* NULL if not available */
1002 guint64 drop_count; /* number of packets lost (by the interface and the
1003 operating system) between this packet and the preceding one. */
1004 guint32 pack_flags; /* XXX - 0 for now (any value for "we don't have it"?) */
1006 union wtap_pseudo_header pseudo_header;
1010 * Bits in presence_flags, indicating which of the fields we have.
1012 * For the time stamp, we may need some more flags to indicate
1013 * whether the time stamp is an absolute date-and-time stamp, an
1014 * absolute time-only stamp (which can make relative time
1015 * calculations tricky, as you could in theory have two time
1016 * stamps separated by an unknown number of days), or a time stamp
1017 * relative to some unspecified time in the past (see mpeg.c).
1019 * There is no presence flag for len - there has to be *some* length
1020 * value for the packet. (The "captured length" can be missing if
1021 * the file format doesn't report a captured length distinct from
1022 * the on-the-network length because the application(s) producing those
1023 * files don't support slicing packets.)
1025 * There could be a presence flag for the packet encapsulation - if it's
1026 * absent, use the file encapsulation - but it's not clear that's useful;
1027 * we currently do that in the module for the file format.
1029 #define WTAP_HAS_TS 0x00000001 /**< time stamp */
1030 #define WTAP_HAS_CAP_LEN 0x00000002 /**< captured length separate from on-the-network length */
1031 #define WTAP_HAS_INTERFACE_ID 0x00000004 /**< interface ID */
1032 #define WTAP_HAS_COMMENTS 0x00000008 /**< comments */
1033 #define WTAP_HAS_DROP_COUNT 0x00000010 /**< drop count */
1034 #define WTAP_HAS_PACK_FLAGS 0x00000020 /**< packet flags */
1037 * Holds the option strings from pcapng:s Section Header block(SHB).
1039 typedef struct wtapng_section_s {
1041 guint64 section_length; /**< 64-bit value specifying the length in bytes of the
1042 * following section.
1043 * Section Length equal -1 (0xFFFFFFFFFFFFFFFF) means
1044 * that the size of the section is not specified
1047 gchar *opt_comment; /**< NULL if not available */
1048 gchar *shb_hardware; /**< NULL if not available
1049 * UTF-8 string containing the description of the
1050 * hardware used to create this section.
1052 gchar *shb_os; /**< NULL if not available, UTF-8 string containing the
1053 * name of the operating system used to create this section.
1055 gchar *shb_user_appl; /**< NULL if not available, UTF-8 string containing the
1056 * name of the application used to create this section.
1061 /** struct holding the information to build IDB:s
1062 * the interface_data array holds an array of wtapng_if_descr_t
1063 * one per interface.
1065 typedef struct wtapng_iface_descriptions_s {
1066 GArray *interface_data;
1067 } wtapng_iface_descriptions_t;
1069 /* Interface Description
1073 * if_name 2 A UTF-8 string containing the name of the device used to capture data.
1074 * "eth0" / "\Device\NPF_{AD1CE675-96D0-47C5-ADD0-2504B9126B68}" / ...
1076 * if_description 3 A UTF-8 string containing the description of the device used
1077 * to capture data. "Broadcom NetXtreme" / "First Ethernet Interface" / ...
1079 * if_IPv4addr 4 Interface network address and netmask. This option can be
1080 * repeated multiple times within the same Interface Description Block
1081 * when multiple IPv4 addresses are assigned to the interface. 192 168 1 1 255 255 255 0
1083 * if_IPv6addr 5 Interface network address and prefix length (stored in the last byte).
1084 * This option can be repeated multiple times within the same Interface
1085 * Description Block when multiple IPv6 addresses are assigned to the interface.
1086 * 2001:0db8:85a3:08d3:1319:8a2e:0370:7344/64 is written (in hex) as
1087 * "20 01 0d b8 85 a3 08 d3 13 19 8a 2e 03 70 73 44 40"
1089 * if_MACaddr 6 Interface Hardware MAC address (48 bits). 00 01 02 03 04 05
1091 * if_EUIaddr 7 Interface Hardware EUI address (64 bits), if available. TODO: give a good example
1093 * if_speed 8 Interface speed (in bps). 100000000 for 100Mbps
1095 * if_tsresol 9 Resolution of timestamps. If the Most Significant Bit is equal to zero,
1096 * the remaining bits indicates the resolution of the timestamp as as a
1097 * negative power of 10 (e.g. 6 means microsecond resolution, timestamps
1098 * are the number of microseconds since 1/1/1970). If the Most Significant Bit
1099 * is equal to one, the remaining bits indicates the resolution has a
1100 * negative power of 2 (e.g. 10 means 1/1024 of second).
1101 * If this option is not present, a resolution of 10^-6 is assumed
1102 * (i.e. timestamps have the same resolution of the standard 'libpcap' timestamps). 6
1104 * if_tzone 10 Time zone for GMT support (TODO: specify better). TODO: give a good example
1106 * if_filter 11 The filter (e.g. "capture only TCP traffic") used to capture traffic.
1107 * The first byte of the Option Data keeps a code of the filter used
1108 * (e.g. if this is a libpcap string, or BPF bytecode, and more).
1109 * More details about this format will be presented in Appendix XXX (TODO).
1110 * (TODO: better use different options for different fields?
1111 * e.g. if_filter_pcap, if_filter_bpf, ...) 00 "tcp port 23 and host 10.0.0.5"
1113 * if_os 12 A UTF-8 string containing the name of the operating system of the
1114 * machine in which this interface is installed.
1115 * This can be different from the same information that can be
1116 * contained by the Section Header Block
1117 * (Section 3.1 (Section Header Block (mandatory))) because
1118 * the capture can have been done on a remote machine.
1119 * "Windows XP SP2" / "openSUSE 10.2" / ...
1121 * if_fcslen 13 An integer value that specified the length of the
1122 * Frame Check Sequence (in bits) for this interface.
1123 * For link layers whose FCS length can change during time,
1124 * the Packet Block Flags Word can be used (see Appendix A (Packet Block Flags Word)). 4
1126 * if_tsoffset 14 A 64 bits integer value that specifies an offset (in seconds)
1127 * that must be added to the timestamp of each packet to obtain
1128 * the absolute timestamp of a packet. If the option is missing,
1129 * the timestamps stored in the packet must be considered absolute
1130 * timestamps. The time zone of the offset can be specified with the
1131 * option if_tzone. TODO: won't a if_tsoffset_low for fractional
1132 * second offsets be useful for highly syncronized capture systems? 1234
1135 * Interface description data
1137 typedef struct wtapng_if_descr_s {
1138 int wtap_encap; /**< link_type translated to wtap_encap */
1139 guint64 time_units_per_second;
1140 int tsprecision; /**< WTAP_TSPREC_ value for this interface */
1147 gchar *opt_comment; /**< NULL if not available */
1148 gchar *if_name; /**< NULL if not available
1150 * A UTF-8 string containing the name of the
1151 * device used to capture data.
1153 gchar *if_description; /**< NULL if not available
1155 * A UTF-8 string containing the description
1156 * of the device used to capture data.
1159 /* XXX: if_IPv4addr opt 4 Interface network address and netmask. */
1160 /* XXX: if_IPv6addr opt 5 Interface network address and prefix length (stored in the last byte).*/
1161 /* XXX: if_MACaddr opt 6 Interface Hardware MAC address (48 bits). */
1162 /* XXX: if_EUIaddr opt 7 Interface Hardware EUI address (64 bits) */
1164 guint64 if_speed; /**< 0xFFFFFFFF if unknown
1166 * Interface speed (in bps). 100000000 for 100Mbps
1168 guint8 if_tsresol; /**< default is 6 for microsecond resolution
1170 * Resolution of timestamps.
1171 * If the Most Significant Bit is equal to zero,
1172 * the remaining bits indicates the resolution of the
1173 * timestamp as as a negative power of 10
1176 /* XXX: if_tzone 10 Time zone for GMT support (TODO: specify better). */
1178 gchar *if_filter_str; /**< NULL if not available
1179 * opt 11 libpcap string.
1181 guint16 bpf_filter_len; /** Opt 11 variant II BPF filter len 0 if not used*/
1182 gchar *if_filter_bpf_bytes; /** Opt 11 BPF filter or NULL */
1183 gchar *if_os; /**< NULL if not available
1184 * 12 A UTF-8 string containing the name of the
1185 * operating system of the machine in which this
1186 * interface is installed.
1188 gint8 if_fcslen; /**< -1 if unknown or changes between packets,
1190 * An integer value that specified the length of
1191 * the Frame Check Sequence (in bits) for this interface. */
1192 /* XXX: guint64 if_tsoffset; opt 14 A 64 bits integer value that specifies an offset (in seconds)...*/
1193 guint8 num_stat_entries;
1194 GArray *interface_statistics; /**< An array holding the interface statistics from
1195 * pcapng ISB:s or equivalent(?)*/
1196 } wtapng_if_descr_t;
1200 * Interface Statistics. pcap-ng Interface Statistics Block (ISB).
1202 typedef struct wtapng_if_stats_s {
1204 guint32 interface_id;
1208 gchar *opt_comment; /**< NULL if not available */
1209 guint64 isb_starttime;
1210 guint64 isb_endtime;
1213 guint64 isb_filteraccept;
1215 guint64 isb_usrdeliv;
1216 } wtapng_if_stats_t;
1219 /** A struct with lists of resolved addresses.
1220 * Used when writing name resoultion blocks (NRB)
1222 typedef struct addrinfo_lists {
1223 GList *ipv4_addr_list; /**< A list of resolved hashipv4_t*/
1224 GList *ipv6_addr_list; /**< A list of resolved hashipv6_t*/
1229 typedef struct wtap wtap;
1230 typedef struct wtap_dumper wtap_dumper;
1232 typedef struct wtap_reader *FILE_T;
1234 /* Similar to the wtap_open_routine_info for open routines, the following
1235 * wtap_wslua_file_info struct is used by wslua code for Lua-based file writers.
1237 * This concept is necessary because when wslua goes to invoke the
1238 * registered dump/write_open routine callback in Lua, it needs the ref number representing
1239 * the hooked function inside Lua. This will be stored in the thing pointed to
1240 * by the void* data here. This 'data' pointer will be copied into the
1241 * wtap_dumper struct's 'void* data' member when calling the dump_open function,
1242 * which is how wslua finally retrieves it. Unlike wtap_dumper's 'priv' member, its
1243 * 'data' member is not free'd in wtap_dump_close().
1245 typedef struct wtap_wslua_file_info {
1246 int (*wslua_can_write_encap)(int, void*); /* a can_write_encap func for wslua uses */
1247 void* wslua_data; /* holds the wslua data */
1248 } wtap_wslua_file_info_t;
1251 * For registering extensions used for capture file formats.
1253 * These items are used in dialogs for opening files, so that
1254 * the user can ask to see all capture files (as identified
1255 * by file extension) or particular types of capture files.
1257 * Each file type has a description and a list of extensions the file
1258 * might have. Some file types aren't real file types, they're
1259 * just generic types, such as "text file" or "XML file", that can
1260 * be used for, among other things, captures we can read, or for
1261 * extensions such as ".cap" that were unimaginatively chosen by
1262 * several different sniffers for their file formats.
1264 struct file_extension_info {
1265 /* the file type name */
1268 /* a semicolon-separated list of file extensions used for this type */
1269 const char *extensions;
1273 * For registering file types that we can open.
1275 * Each file type has an open routine and an optional list of extensions
1276 * the file might have.
1278 * The open routine should return:
1280 * WTAP_OPEN_ERROR on an I/O error;
1282 * WTAP_OPEN_MINE if the file it's reading is one of the types
1285 * WTAP_OPEN_NOT_MINE if the file it's reading isn't one of the
1288 * If the routine handles this type of file, it should set the "file_type"
1289 * field in the "struct wtap" to the type of the file.
1291 * Note that the routine does not have to free the private data pointer on
1292 * error. The caller takes care of that by calling wtap_close on error.
1293 * (See https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=8518)
1295 * However, the caller does have to free the private data pointer when
1296 * returning WTAP_OPEN_NOT_MINE, since the next file type will be called
1297 * and will likely just overwrite the pointer.
1300 WTAP_OPEN_NOT_MINE = 0,
1302 WTAP_OPEN_ERROR = -1
1303 } wtap_open_return_val;
1305 typedef wtap_open_return_val (*wtap_open_routine_t)(struct wtap*, int *,
1309 * Some file formats have defined magic numbers at fixed offsets from
1310 * the beginning of the file; those routines should return 1 if and
1311 * only if the file has the magic number at that offset. (pcap-ng
1312 * is a bit of a special case, as it has both the Section Header Block
1313 * type field and its byte-order magic field; it checks for both.)
1314 * Those file formats do not require a file name extension in order
1315 * to recognize them or to avoid recognizing other file types as that
1316 * type, and have no extensions specified for them.
1318 * Other file formats don't have defined magic numbers at fixed offsets,
1319 * so a heuristic is required. If that file format has any file name
1320 * extensions used for it, a list of those extensions should be
1321 * specified, so that, if the name of the file being opened has an
1322 * extension, the file formats that use that extension are tried before
1323 * the ones that don't, to handle the case where a file of one type
1324 * might be recognized by the heuristics for a different file type.
1328 OPEN_INFO_MAGIC = 0,
1329 OPEN_INFO_HEURISTIC = 1
1332 WS_DLL_PUBLIC void init_open_routines(void);
1336 wtap_open_type type;
1337 wtap_open_routine_t open_routine;
1338 const char *extensions;
1339 gchar **extensions_set; /* populated using extensions member during initialization */
1340 void* wslua_data; /* should be NULL for C-code file readers */
1342 WS_DLL_PUBLIC struct open_info *open_routines;
1345 * Types of comments.
1347 #define WTAP_COMMENT_PER_SECTION 0x00000001 /* per-file/per-file-section */
1348 #define WTAP_COMMENT_PER_INTERFACE 0x00000002 /* per-interface */
1349 #define WTAP_COMMENT_PER_PACKET 0x00000004 /* per-packet */
1351 struct file_type_subtype_info {
1352 /* the file type name */
1353 /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
1356 /* the file type short name, used as a shortcut for the command line tools */
1357 /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
1358 const char *short_name;
1360 /* the default file extension, used to save this type */
1361 /* should be NULL if no default extension is known */
1362 const char *default_file_extension;
1364 /* a semicolon-separated list of additional file extensions */
1365 /* used for this type */
1366 /* should be NULL if no extensions, or no extensions other */
1367 /* than the default extension, are known */
1368 const char *additional_file_extensions;
1370 /* when writing this file format, is seeking required? */
1371 gboolean writing_must_seek;
1373 /* does this type support name resolution records? */
1374 /* should be FALSE is this file type doesn't support name resolution records */
1375 gboolean has_name_resolution;
1377 /* what types of comment does this file support? */
1378 guint32 supported_comment_types;
1380 /* can this type write this encapsulation format? */
1381 /* should be NULL is this file type doesn't have write support */
1382 int (*can_write_encap)(int);
1384 /* the function to open the capture file for writing */
1385 /* should be NULL is this file type don't have write support */
1386 int (*dump_open)(wtap_dumper *, int *);
1388 /* if can_write_encap returned WTAP_ERR_CHECK_WSLUA, then this is used instead */
1389 /* this should be NULL for everyone except Lua-based file writers */
1390 wtap_wslua_file_info_t *wslua_info;
1393 #define WTAP_TYPE_AUTO 0
1395 /** On failure, "wtap_open_offline()" returns NULL, and puts into the
1396 * "int" pointed to by its second argument:
1398 * @param filename Name of the file to open
1399 * @param type WTAP_TYPE_AUTO for automatic recognize file format or explicit choose format type
1400 * @param err a positive "errno" value if the capture file can't be opened;
1401 * a negative number, indicating the type of error, on other failures.
1402 * @param err_info for some errors, a string giving more details of
1404 * @param do_random TRUE if random access to the file will be done,
1408 struct wtap* wtap_open_offline(const char *filename, unsigned int type, int *err,
1409 gchar **err_info, gboolean do_random);
1412 * If we were compiled with zlib and we're at EOF, unset EOF so that
1413 * wtap_read/gzread has a chance to succeed. This is necessary if
1414 * we're tailing a file.
1417 void wtap_cleareof(wtap *wth);
1420 * Set callback functions to add new hostnames. Currently pcapng-only.
1421 * MUST match add_ipv4_name and add_ipv6_name in addr_resolv.c.
1423 typedef void (*wtap_new_ipv4_callback_t) (const guint addr, const gchar *name);
1425 void wtap_set_cb_new_ipv4(wtap *wth, wtap_new_ipv4_callback_t add_new_ipv4);
1427 typedef void (*wtap_new_ipv6_callback_t) (const void *addrp, const gchar *name);
1429 void wtap_set_cb_new_ipv6(wtap *wth, wtap_new_ipv6_callback_t add_new_ipv6);
1431 /** Returns TRUE if read was successful. FALSE if failure. data_offset is
1432 * set to the offset in the file where the data for the read packet is
1435 gboolean wtap_read(wtap *wth, int *err, gchar **err_info,
1436 gint64 *data_offset);
1439 gboolean wtap_seek_read (wtap *wth, gint64 seek_off,
1440 struct wtap_pkthdr *phdr, Buffer *buf, int *err, gchar **err_info);
1442 /*** get various information snippets about the current packet ***/
1444 struct wtap_pkthdr *wtap_phdr(wtap *wth);
1446 guint8 *wtap_buf_ptr(wtap *wth);
1448 /*** get various information snippets about the current file ***/
1450 /** Return an approximation of the amount of data we've read sequentially
1451 * from the file so far. */
1453 gint64 wtap_read_so_far(wtap *wth);
1455 gint64 wtap_file_size(wtap *wth, int *err);
1457 gboolean wtap_iscompressed(wtap *wth);
1459 guint wtap_snapshot_length(wtap *wth); /* per file */
1461 int wtap_file_type_subtype(wtap *wth);
1463 int wtap_file_encap(wtap *wth);
1465 int wtap_file_tsprec(wtap *wth);
1467 wtapng_section_t* wtap_file_get_shb_info(wtap *wth);
1469 wtapng_iface_descriptions_t *wtap_file_get_idb_info(wtap *wth);
1471 void wtap_write_shb_comment(wtap *wth, gchar *comment);
1473 /*** close the file descriptors for the current file ***/
1475 void wtap_fdclose(wtap *wth);
1477 /*** reopen the random file descriptor for the current file ***/
1479 gboolean wtap_fdreopen(wtap *wth, const char *filename, int *err);
1481 /*** close the current file ***/
1483 void wtap_sequential_close(wtap *wth);
1485 void wtap_close(wtap *wth);
1487 /*** dump packets into a capture file ***/
1489 gboolean wtap_dump_can_open(int filetype);
1492 * Given a GArray of WTAP_ENCAP_ types, return the per-file encapsulation
1493 * type that would be needed to write out a file with those types.
1496 int wtap_dump_file_encap_type(const GArray *file_encaps);
1499 * Return TRUE if we can write this capture file format out in
1500 * compressed form, FALSE if not.
1503 gboolean wtap_dump_can_compress(int filetype);
1506 * Return TRUE if this capture file format supports storing name
1507 * resolution information in it, FALSE if not.
1510 gboolean wtap_dump_has_name_resolution(int filetype);
1513 * Return TRUE if this capture file format supports all the comment
1514 * types specified, FALSE if not.
1517 gboolean wtap_dump_supports_comment_types(int filetype, guint32 comment_types);
1520 wtap_dumper* wtap_dump_open(const char *filename, int filetype, int encap,
1521 int snaplen, gboolean compressed, int *err);
1524 wtap_dumper* wtap_dump_open_ng(const char *filename, int filetype, int encap,
1525 int snaplen, gboolean compressed, wtapng_section_t *shb_hdr, wtapng_iface_descriptions_t *idb_inf, int *err);
1528 wtap_dumper* wtap_dump_fdopen(int fd, int filetype, int encap, int snaplen,
1529 gboolean compressed, int *err);
1532 wtap_dumper* wtap_dump_fdopen_ng(int fd, int filetype, int encap, int snaplen,
1533 gboolean compressed, wtapng_section_t *shb_hdr, wtapng_iface_descriptions_t *idb_inf, int *err);
1537 gboolean wtap_dump(wtap_dumper *, const struct wtap_pkthdr *, const guint8 *, int *err);
1539 void wtap_dump_flush(wtap_dumper *);
1541 gint64 wtap_get_bytes_dumped(wtap_dumper *);
1543 void wtap_set_bytes_dumped(wtap_dumper *wdh, gint64 bytes_dumped);
1546 gboolean wtap_dump_set_addrinfo_list(wtap_dumper *wdh, addrinfo_lists_t *addrinfo_lists);
1548 gboolean wtap_dump_close(wtap_dumper *, int *);
1551 * Return TRUE if we can write a file out with the given GArray of file
1552 * encapsulations and the given bitmask of comment types.
1555 gboolean wtap_dump_can_write(const GArray *file_encaps, guint32 required_comment_types);
1558 * Get a GArray of WTAP_FILE_TYPE_SUBTYPE_ values for file types/subtypes
1559 * that can be used to save a file of a given type with a given GArray of
1560 * WTAP_ENCAP_ types and the given bitmask of comment types.
1563 GArray *wtap_get_savable_file_types_subtypes(int file_type,
1564 const GArray *file_encaps, guint32 required_comment_types);
1566 /*** various string converter functions ***/
1568 const char *wtap_file_type_subtype_string(int file_type_subtype);
1570 const char *wtap_file_type_subtype_short_string(int file_type_subtype);
1572 int wtap_short_string_to_file_type_subtype(const char *short_name);
1574 /*** various file extension functions ***/
1576 GSList *wtap_get_all_file_extensions_list(void);
1578 const char *wtap_default_file_extension(int filetype);
1580 GSList *wtap_get_file_extensions_list(int filetype, gboolean include_compressed);
1582 void wtap_free_extensions_list(GSList *extensions);
1585 const char *wtap_encap_string(int encap);
1587 const char *wtap_encap_short_string(int encap);
1589 int wtap_short_string_to_encap(const char *short_name);
1592 const char *wtap_strerror(int err);
1594 /*** get available number of file types and encapsulations ***/
1596 int wtap_get_num_file_type_extensions(void);
1598 int wtap_get_num_encap_types(void);
1600 int wtap_get_num_file_types_subtypes(void);
1602 /*** get information for file type extension ***/
1604 const char *wtap_get_file_extension_type_name(int extension_type);
1606 GSList *wtap_get_file_extension_type_extensions(guint extension_type);
1608 /*** dynamically register new file types and encapsulations ***/
1610 void wtap_register_plugin_types(void);
1612 void register_all_wiretap_modules(void);
1614 void wtap_register_file_type_extension(const struct file_extension_info *ei);
1617 void wtap_register_open_info(struct open_info *oi, const gboolean first_routine);
1619 gboolean wtap_has_open_info(const gchar *name);
1621 void wtap_deregister_open_info(const gchar *name);
1624 unsigned int open_info_name_to_type(const char *name);
1626 int wtap_register_file_type_subtypes(const struct file_type_subtype_info* fi, const int subtype);
1628 void wtap_deregister_file_type_subtype(const int file_type_subtype);
1631 int wtap_register_encap_type(const char* name, const char* short_name);
1635 * Wiretap error codes.
1637 #define WTAP_ERR_NOT_REGULAR_FILE -1
1638 /** The file being opened for reading isn't a plain file (or pipe) */
1640 #define WTAP_ERR_RANDOM_OPEN_PIPE -2
1641 /** The file is being opened for random access and it's a pipe */
1643 #define WTAP_ERR_FILE_UNKNOWN_FORMAT -3
1644 /** The file being opened is not a capture file in a known format */
1646 #define WTAP_ERR_UNSUPPORTED -4
1647 /** Supported file type, but there's something in the file we
1650 #define WTAP_ERR_CANT_WRITE_TO_PIPE -5
1651 /** Wiretap can't save to a pipe in the specified format */
1653 #define WTAP_ERR_CANT_OPEN -6
1654 /** The file couldn't be opened, reason unknown */
1656 #define WTAP_ERR_UNSUPPORTED_FILE_TYPE -7
1657 /** Wiretap can't save files in the specified format */
1659 #define WTAP_ERR_UNSUPPORTED_ENCAP -8
1660 /** Wiretap can't read or save files in the specified format with the
1661 specified encapsulation */
1663 #define WTAP_ERR_ENCAP_PER_PACKET_UNSUPPORTED -9
1664 /** The specified format doesn't support per-packet encapsulations */
1666 #define WTAP_ERR_CANT_WRITE -10
1667 /** An attempt to read failed, reason unknown */
1669 #define WTAP_ERR_CANT_CLOSE -11
1670 /** The file couldn't be closed, reason unknown */
1672 #define WTAP_ERR_SHORT_READ -12
1673 /** An attempt to read read less data than it should have */
1675 #define WTAP_ERR_BAD_FILE -13
1676 /** The file appears to be damaged or corrupted or otherwise bogus */
1678 #define WTAP_ERR_SHORT_WRITE -14
1679 /** An attempt to write wrote less data than it should have */
1681 #define WTAP_ERR_UNC_OVERFLOW -15
1682 /** Uncompressing Sniffer data would overflow buffer */
1684 #define WTAP_ERR_RANDOM_OPEN_STDIN -16
1685 /** We're trying to open the standard input for random access */
1687 #define WTAP_ERR_COMPRESSION_NOT_SUPPORTED -17
1688 /* The filetype doesn't support output compression */
1690 #define WTAP_ERR_CANT_SEEK -18
1691 /** An attempt to seek failed, reason unknown */
1693 #define WTAP_ERR_CANT_SEEK_COMPRESSED -19
1694 /** An attempt to seek on a compressed stream */
1696 #define WTAP_ERR_DECOMPRESS -20
1697 /** Error decompressing */
1699 #define WTAP_ERR_INTERNAL -21
1700 /** "Shouldn't happen" internal errors */
1702 #define WTAP_ERR_PACKET_TOO_LARGE -22
1703 /** Packet being written is larger than we support; do not use when
1704 reading, use WTAP_ERR_BAD_FILE instead */
1706 #define WTAP_ERR_CHECK_WSLUA -23
1707 /** Not really an error: the file type being checked is from a Lua
1708 plugin, so that the code will call wslua_can_write_encap() instead if it gets this */
1710 #define WTAP_ERR_REC_TYPE_UNSUPPORTED -24
1711 /** Specified record type can't be written to that file type */
1715 #endif /* __cplusplus */
1717 #endif /* __WTAP_H__ */
1720 * Editor modelines - http://www.wireshark.org/tools/modelines.html
1725 * indent-tabs-mode: nil
1728 * vi: set shiftwidth=4 tabstop=8 expandtab:
1729 * :indentSize=4:tabSize=8:noTabs=true: