The "file types" we have are actually combinations of types and
[metze/wireshark/wip.git] / wiretap / wtap.h
1 /* wtap.h
2  *
3  * $Id$
4  *
5  * Wiretap Library
6  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21  */
22
23 #ifndef __WTAP_H__
24 #define __WTAP_H__
25
26 #ifdef HAVE_SYS_TIME_H
27 #include <sys/time.h>
28 #endif
29
30 #include <glib.h>
31 #include <time.h>
32 #include <wiretap/buffer.h>
33 #include "ws_symbol_export.h"
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif /* __cplusplus */
38
39 /* Encapsulation types. Choose names that truly reflect
40  * what is contained in the packet trace file.
41  *
42  * WTAP_ENCAP_PER_PACKET is a value passed to "wtap_dump_open()" or
43  * "wtap_dump_fd_open()" to indicate that there is no single encapsulation
44  * type for all packets in the file; this may cause those routines to
45  * fail if the capture file format being written can't support that.
46  * It's also returned by "wtap_file_encap()" for capture files that
47  * don't have a single encapsulation type for all packets in the file.
48  *
49  * WTAP_ENCAP_UNKNOWN is returned by "wtap_pcap_encap_to_wtap_encap()"
50  * if it's handed an unknown encapsulation.
51  *
52  * WTAP_ENCAP_FDDI_BITSWAPPED is for FDDI captures on systems where the
53  * MAC addresses you get from the hardware are bit-swapped.  Ideally,
54  * the driver would tell us that, but I know of none that do, so, for
55  * now, we base it on the machine on which we're *reading* the
56  * capture, rather than on the machine on which the capture was taken
57  * (they're probably likely to be the same).  We assume that they're
58  * bit-swapped on everything except for systems running Ultrix, Alpha
59  * systems, and BSD/OS systems (that's what "tcpdump" does; I guess
60  * Digital decided to bit-swap addresses in the hardware or in the
61  * driver, and I guess BSDI bit-swapped them in the driver, given that
62  * BSD/OS generally runs on Boring Old PC's).  If we create a wiretap
63  * save file format, we'd use the WTAP_ENCAP values to flag the
64  * encapsulation of a packet, so there we'd at least be able to base
65  * it on the machine on which the capture was taken.
66  *
67  * WTAP_ENCAP_LINUX_ATM_CLIP is the encapsulation you get with the
68  * ATM on Linux code from <http://linux-atm.sourceforge.net/>;
69  * that code adds a DLT_ATM_CLIP DLT_ code of 19, and that
70  * encapsulation isn't the same as the DLT_ATM_RFC1483 encapsulation
71  * presumably used on some BSD systems, which we turn into
72  * WTAP_ENCAP_ATM_RFC1483.
73  *
74  * WTAP_ENCAP_NULL corresponds to DLT_NULL from "libpcap".  This
75  * corresponds to
76  *
77  *  1) PPP-over-HDLC encapsulation, at least with some versions
78  *     of ISDN4BSD (but not the current ones, it appears, unless
79  *     I've missed something);
80  *
81  *  2) a 4-byte header containing the AF_ address family, in
82  *     the byte order of the machine that saved the capture,
83  *     for the packet, as used on many BSD systems for the
84  *     loopback device and some other devices, or a 4-byte header
85  *     containing the AF_ address family in network byte order,
86  *     as used on recent OpenBSD systems for the loopback device;
87  *
88  *  3) a 4-byte header containing 2 octets of 0 and an Ethernet
89  *     type in the byte order from an Ethernet header, that being
90  *     what older versions of "libpcap" on Linux turn the Ethernet
91  *     header for loopback interfaces into (0.6.0 and later versions
92  *     leave the Ethernet header alone and make it DLT_EN10MB). */
93 #define WTAP_ENCAP_PER_PACKET                   -1
94 #define WTAP_ENCAP_UNKNOWN                        0
95 #define WTAP_ENCAP_ETHERNET                       1
96 #define WTAP_ENCAP_TOKEN_RING                     2
97 #define WTAP_ENCAP_SLIP                           3
98 #define WTAP_ENCAP_PPP                            4
99 #define WTAP_ENCAP_FDDI                           5
100 #define WTAP_ENCAP_FDDI_BITSWAPPED                6
101 #define WTAP_ENCAP_RAW_IP                         7
102 #define WTAP_ENCAP_ARCNET                         8
103 #define WTAP_ENCAP_ARCNET_LINUX                   9
104 #define WTAP_ENCAP_ATM_RFC1483                   10
105 #define WTAP_ENCAP_LINUX_ATM_CLIP                11
106 #define WTAP_ENCAP_LAPB                          12
107 #define WTAP_ENCAP_ATM_PDUS                      13
108 #define WTAP_ENCAP_ATM_PDUS_UNTRUNCATED          14
109 #define WTAP_ENCAP_NULL                          15
110 #define WTAP_ENCAP_ASCEND                        16
111 #define WTAP_ENCAP_ISDN                          17
112 #define WTAP_ENCAP_IP_OVER_FC                    18
113 #define WTAP_ENCAP_PPP_WITH_PHDR                 19
114 #define WTAP_ENCAP_IEEE_802_11                   20
115 #define WTAP_ENCAP_IEEE_802_11_PRISM             21
116 #define WTAP_ENCAP_IEEE_802_11_WITH_RADIO        22
117 #define WTAP_ENCAP_IEEE_802_11_RADIOTAP          23
118 #define WTAP_ENCAP_IEEE_802_11_AVS               24
119 #define WTAP_ENCAP_SLL                           25
120 #define WTAP_ENCAP_FRELAY                        26
121 #define WTAP_ENCAP_FRELAY_WITH_PHDR              27
122 #define WTAP_ENCAP_CHDLC                         28
123 #define WTAP_ENCAP_CISCO_IOS                     29
124 #define WTAP_ENCAP_LOCALTALK                     30
125 #define WTAP_ENCAP_OLD_PFLOG                     31
126 #define WTAP_ENCAP_HHDLC                         32
127 #define WTAP_ENCAP_DOCSIS                        33
128 #define WTAP_ENCAP_COSINE                        34
129 #define WTAP_ENCAP_WFLEET_HDLC                   35
130 #define WTAP_ENCAP_SDLC                          36
131 #define WTAP_ENCAP_TZSP                          37
132 #define WTAP_ENCAP_ENC                           38
133 #define WTAP_ENCAP_PFLOG                         39
134 #define WTAP_ENCAP_CHDLC_WITH_PHDR               40
135 #define WTAP_ENCAP_BLUETOOTH_H4                  41
136 #define WTAP_ENCAP_MTP2                          42
137 #define WTAP_ENCAP_MTP3                          43
138 #define WTAP_ENCAP_IRDA                          44
139 #define WTAP_ENCAP_USER0                         45
140 #define WTAP_ENCAP_USER1                         46
141 #define WTAP_ENCAP_USER2                         47
142 #define WTAP_ENCAP_USER3                         48
143 #define WTAP_ENCAP_USER4                         49
144 #define WTAP_ENCAP_USER5                         50
145 #define WTAP_ENCAP_USER6                         51
146 #define WTAP_ENCAP_USER7                         52
147 #define WTAP_ENCAP_USER8                         53
148 #define WTAP_ENCAP_USER9                         54
149 #define WTAP_ENCAP_USER10                        55
150 #define WTAP_ENCAP_USER11                        56
151 #define WTAP_ENCAP_USER12                        57
152 #define WTAP_ENCAP_USER13                        58
153 #define WTAP_ENCAP_USER14                        59
154 #define WTAP_ENCAP_USER15                        60
155 #define WTAP_ENCAP_SYMANTEC                      61
156 #define WTAP_ENCAP_APPLE_IP_OVER_IEEE1394        62
157 #define WTAP_ENCAP_BACNET_MS_TP                  63
158 #define WTAP_ENCAP_NETTL_RAW_ICMP                64
159 #define WTAP_ENCAP_NETTL_RAW_ICMPV6              65
160 #define WTAP_ENCAP_GPRS_LLC                      66
161 #define WTAP_ENCAP_JUNIPER_ATM1                  67
162 #define WTAP_ENCAP_JUNIPER_ATM2                  68
163 #define WTAP_ENCAP_REDBACK                       69
164 #define WTAP_ENCAP_NETTL_RAW_IP                  70
165 #define WTAP_ENCAP_NETTL_ETHERNET                71
166 #define WTAP_ENCAP_NETTL_TOKEN_RING              72
167 #define WTAP_ENCAP_NETTL_FDDI                    73
168 #define WTAP_ENCAP_NETTL_UNKNOWN                 74
169 #define WTAP_ENCAP_MTP2_WITH_PHDR                75
170 #define WTAP_ENCAP_JUNIPER_PPPOE                 76
171 #define WTAP_ENCAP_GCOM_TIE1                     77
172 #define WTAP_ENCAP_GCOM_SERIAL                   78
173 #define WTAP_ENCAP_NETTL_X25                     79
174 #define WTAP_ENCAP_K12                           80
175 #define WTAP_ENCAP_JUNIPER_MLPPP                 81
176 #define WTAP_ENCAP_JUNIPER_MLFR                  82
177 #define WTAP_ENCAP_JUNIPER_ETHER                 83
178 #define WTAP_ENCAP_JUNIPER_PPP                   84
179 #define WTAP_ENCAP_JUNIPER_FRELAY                85
180 #define WTAP_ENCAP_JUNIPER_CHDLC                 86
181 #define WTAP_ENCAP_JUNIPER_GGSN                  87
182 #define WTAP_ENCAP_LINUX_LAPD                    88
183 #define WTAP_ENCAP_CATAPULT_DCT2000              89
184 #define WTAP_ENCAP_BER                           90
185 #define WTAP_ENCAP_JUNIPER_VP                    91
186 #define WTAP_ENCAP_USB                           92
187 #define WTAP_ENCAP_IEEE802_16_MAC_CPS            93
188 #define WTAP_ENCAP_NETTL_RAW_TELNET              94
189 #define WTAP_ENCAP_USB_LINUX                     95
190 #define WTAP_ENCAP_MPEG                          96
191 #define WTAP_ENCAP_PPI                           97
192 #define WTAP_ENCAP_ERF                           98
193 #define WTAP_ENCAP_BLUETOOTH_H4_WITH_PHDR        99
194 #define WTAP_ENCAP_SITA                         100
195 #define WTAP_ENCAP_SCCP                         101
196 #define WTAP_ENCAP_BLUETOOTH_HCI                102 /*raw packets without a transport layer header e.g. H4*/
197 #define WTAP_ENCAP_IPMB                         103
198 #define WTAP_ENCAP_IEEE802_15_4                 104
199 #define WTAP_ENCAP_X2E_XORAYA                   105
200 #define WTAP_ENCAP_FLEXRAY                      106
201 #define WTAP_ENCAP_LIN                          107
202 #define WTAP_ENCAP_MOST                         108
203 #define WTAP_ENCAP_CAN20B                       109
204 #define WTAP_ENCAP_LAYER1_EVENT                 110
205 #define WTAP_ENCAP_X2E_SERIAL                   111
206 #define WTAP_ENCAP_I2C                          112
207 #define WTAP_ENCAP_IEEE802_15_4_NONASK_PHY      113
208 #define WTAP_ENCAP_TNEF                         114
209 #define WTAP_ENCAP_USB_LINUX_MMAPPED            115
210 #define WTAP_ENCAP_GSM_UM                       116
211 #define WTAP_ENCAP_DPNSS                        117
212 #define WTAP_ENCAP_PACKETLOGGER                 118
213 #define WTAP_ENCAP_NSTRACE_1_0                  119
214 #define WTAP_ENCAP_NSTRACE_2_0                  120
215 #define WTAP_ENCAP_FIBRE_CHANNEL_FC2            121
216 #define WTAP_ENCAP_FIBRE_CHANNEL_FC2_WITH_FRAME_DELIMS 122
217 #define WTAP_ENCAP_JPEG_JFIF                    123 /* obsoleted by WTAP_ENCAP_MIME*/
218 #define WTAP_ENCAP_IPNET                        124
219 #define WTAP_ENCAP_SOCKETCAN                    125
220 #define WTAP_ENCAP_IEEE_802_11_NETMON           126
221 #define WTAP_ENCAP_IEEE802_15_4_NOFCS           127
222 #define WTAP_ENCAP_RAW_IPFIX                    128
223 #define WTAP_ENCAP_RAW_IP4                      129
224 #define WTAP_ENCAP_RAW_IP6                      130
225 #define WTAP_ENCAP_LAPD                         131
226 #define WTAP_ENCAP_DVBCI                        132
227 #define WTAP_ENCAP_MUX27010                     133
228 #define WTAP_ENCAP_MIME                         134
229 #define WTAP_ENCAP_NETANALYZER                  135
230 #define WTAP_ENCAP_NETANALYZER_TRANSPARENT      136
231 #define WTAP_ENCAP_IP_OVER_IB                   137
232 #define WTAP_ENCAP_MPEG_2_TS                    138
233 #define WTAP_ENCAP_PPP_ETHER                    139
234 #define WTAP_ENCAP_NFC_LLCP                     140
235 #define WTAP_ENCAP_NFLOG                        141
236 #define WTAP_ENCAP_V5_EF                        142
237 #define WTAP_ENCAP_BACNET_MS_TP_WITH_PHDR       143
238 #define WTAP_ENCAP_IXVERIWAVE                   144
239 #define WTAP_ENCAP_IEEE_802_11_AIROPEEK         145
240 #define WTAP_ENCAP_SDH                          146
241 #define WTAP_ENCAP_DBUS                         147
242 #define WTAP_ENCAP_AX25_KISS                    148
243 #define WTAP_ENCAP_AX25                         149
244 #define WTAP_ENCAP_SCTP                         150
245 #define WTAP_ENCAP_INFINIBAND                   151
246 #define WTAP_ENCAP_JUNIPER_SVCS                 152
247 #define WTAP_ENCAP_USBPCAP                      153
248 #define WTAP_ENCAP_RTAC_SERIAL                  154
249 #define WTAP_ENCAP_BLUETOOTH_LE_LL              155
250 #define WTAP_ENCAP_WIRESHARK_UPPER_PDU          156
251 #define WTAP_ENCAP_STANAG_4607                  157
252
253 #define WTAP_NUM_ENCAP_TYPES                    wtap_get_num_encap_types()
254
255 /* File types/subtypes that can be read by wiretap.
256    We support writing many of these file types, too, so we
257    distinguish between different subtypes of them, as
258    different subtypes need to be written in a different
259    fashion. */
260 #define WTAP_FILE_TYPE_SUBTYPE_UNKNOWN                        0
261 #define WTAP_FILE_TYPE_SUBTYPE_PCAP                           1
262 #define WTAP_FILE_TYPE_SUBTYPE_PCAPNG                         2
263 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_NSEC                      3
264 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_AIX                       4
265 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_SS991029                  5
266 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_NOKIA                     6
267 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_SS990417                  7
268 #define WTAP_FILE_TYPE_SUBTYPE_PCAP_SS990915                  8
269 #define WTAP_FILE_TYPE_SUBTYPE_5VIEWS                         9
270 #define WTAP_FILE_TYPE_SUBTYPE_IPTRACE_1_0                   10
271 #define WTAP_FILE_TYPE_SUBTYPE_IPTRACE_2_0                   11
272 #define WTAP_FILE_TYPE_SUBTYPE_BER                           12
273 #define WTAP_FILE_TYPE_SUBTYPE_HCIDUMP                       13
274 #define WTAP_FILE_TYPE_SUBTYPE_CATAPULT_DCT2000              14
275 #define WTAP_FILE_TYPE_SUBTYPE_NETXRAY_OLD                   15
276 #define WTAP_FILE_TYPE_SUBTYPE_NETXRAY_1_0                   16
277 #define WTAP_FILE_TYPE_SUBTYPE_COSINE                        17
278 #define WTAP_FILE_TYPE_SUBTYPE_CSIDS                         18
279 #define WTAP_FILE_TYPE_SUBTYPE_DBS_ETHERWATCH                19
280 #define WTAP_FILE_TYPE_SUBTYPE_ERF                           20
281 #define WTAP_FILE_TYPE_SUBTYPE_EYESDN                        21
282 #define WTAP_FILE_TYPE_SUBTYPE_NETTL                         22
283 #define WTAP_FILE_TYPE_SUBTYPE_ISERIES                       23
284 #define WTAP_FILE_TYPE_SUBTYPE_ISERIES_UNICODE               24
285 #define WTAP_FILE_TYPE_SUBTYPE_I4BTRACE                      25
286 #define WTAP_FILE_TYPE_SUBTYPE_ASCEND                        26
287 #define WTAP_FILE_TYPE_SUBTYPE_NETMON_1_x                    27
288 #define WTAP_FILE_TYPE_SUBTYPE_NETMON_2_x                    28
289 #define WTAP_FILE_TYPE_SUBTYPE_NGSNIFFER_UNCOMPRESSED        29
290 #define WTAP_FILE_TYPE_SUBTYPE_NGSNIFFER_COMPRESSED          30
291 #define WTAP_FILE_TYPE_SUBTYPE_NETXRAY_1_1                   31
292 #define WTAP_FILE_TYPE_SUBTYPE_NETXRAY_2_00x                 32
293 #define WTAP_FILE_TYPE_SUBTYPE_NETWORK_INSTRUMENTS           33
294 #define WTAP_FILE_TYPE_SUBTYPE_LANALYZER                     34
295 #define WTAP_FILE_TYPE_SUBTYPE_PPPDUMP                       35
296 #define WTAP_FILE_TYPE_SUBTYPE_RADCOM                        36
297 #define WTAP_FILE_TYPE_SUBTYPE_SNOOP                         37
298 #define WTAP_FILE_TYPE_SUBTYPE_SHOMITI                       38
299 #define WTAP_FILE_TYPE_SUBTYPE_VMS                           39
300 #define WTAP_FILE_TYPE_SUBTYPE_K12                           40
301 #define WTAP_FILE_TYPE_SUBTYPE_TOSHIBA                       41
302 #define WTAP_FILE_TYPE_SUBTYPE_VISUAL_NETWORKS               42
303 #define WTAP_FILE_TYPE_SUBTYPE_PEEKCLASSIC_V56               43
304 #define WTAP_FILE_TYPE_SUBTYPE_PEEKCLASSIC_V7                44
305 #define WTAP_FILE_TYPE_SUBTYPE_PEEKTAGGED                    45
306 #define WTAP_FILE_TYPE_SUBTYPE_MPEG                          46
307 #define WTAP_FILE_TYPE_SUBTYPE_K12TEXT                       47
308 #define WTAP_FILE_TYPE_SUBTYPE_NETSCREEN                     48
309 #define WTAP_FILE_TYPE_SUBTYPE_COMMVIEW                      49
310 #define WTAP_FILE_TYPE_SUBTYPE_BTSNOOP                       50
311 #define WTAP_FILE_TYPE_SUBTYPE_TNEF                          51
312 #define WTAP_FILE_TYPE_SUBTYPE_DCT3TRACE                     52
313 #define WTAP_FILE_TYPE_SUBTYPE_PACKETLOGGER                  53
314 #define WTAP_FILE_TYPE_SUBTYPE_DAINTREE_SNA                  54
315 #define WTAP_FILE_TYPE_SUBTYPE_NETSCALER_1_0                 55
316 #define WTAP_FILE_TYPE_SUBTYPE_NETSCALER_2_0                 56
317 #define WTAP_FILE_TYPE_SUBTYPE_JPEG_JFIF                     57 /* obsoleted by WTAP_FILE_TYPE_SUBTYPE_MIME */
318 #define WTAP_FILE_TYPE_SUBTYPE_IPFIX                         58
319 #define WTAP_FILE_TYPE_SUBTYPE_MIME                          59
320 #define WTAP_FILE_TYPE_SUBTYPE_AETHRA                        60
321 #define WTAP_FILE_TYPE_SUBTYPE_MPEG_2_TS                     61
322 #define WTAP_FILE_TYPE_SUBTYPE_VWR_80211                     62
323 #define WTAP_FILE_TYPE_SUBTYPE_VWR_ETH                       63
324 #define WTAP_FILE_TYPE_SUBTYPE_CAMINS                        64
325 #define WTAP_FILE_TYPE_SUBTYPE_STANAG_4607                   65
326
327 #define WTAP_NUM_FILE_TYPES_SUBTYPES  wtap_get_num_file_types_subtypes()
328
329 /* timestamp precision (currently only these values are supported) */
330 #define WTAP_FILE_TSPREC_SEC        0
331 #define WTAP_FILE_TSPREC_DSEC       1
332 #define WTAP_FILE_TSPREC_CSEC       2
333 #define WTAP_FILE_TSPREC_MSEC       3
334 #define WTAP_FILE_TSPREC_USEC       6
335 #define WTAP_FILE_TSPREC_NSEC       9
336
337 /*
338  * Maximum packet size we'll support.
339  * 65535 is the largest snapshot length that libpcap supports, so we
340  * use that.
341  */
342 #define WTAP_MAX_PACKET_SIZE    65535
343
344 /*
345  * "Pseudo-headers" are used to supply to the clients of wiretap
346  * per-packet information that's not part of the packet payload
347  * proper.
348  *
349  * NOTE: do not use pseudo-header structures to hold information
350  * used by the code to read a particular capture file type; to
351  * keep that sort of state information, add a new structure for
352  * that private information to "wtap-int.h", add a pointer to that
353  * type of structure to the "capture" member of the "struct wtap"
354  * structure, and allocate one of those structures and set that member
355  * in the "open" routine for that capture file type if the open
356  * succeeds.  See various other capture file type handlers for examples
357  * of that.
358  */
359
360
361 struct nstr_phdr {
362     gint64 rec_offset;
363     gint32 rec_len;
364     guint8 nicno_offset;
365     guint8 nicno_len;
366     guint8 dir_offset;
367     guint8 dir_len;
368     guint8 eth_offset;
369     guint8 pcb_offset;
370     guint8 l_pcb_offset;
371     guint8 rec_type;
372     guint8 vlantag_offset;
373     guint8 coreid_offset;
374     guint8 srcnodeid_offset;
375     guint8 destnodeid_offset;
376     guint8 clflags_offset;
377     guint8 src_vmname_len_offset;
378     guint8 dst_vmname_len_offset;
379     guint8 ns_activity_offset;
380     guint8 data_offset;
381 };
382
383 /* Packet "pseudo-header" information for Ethernet capture files. */
384 struct eth_phdr {
385     gint   fcs_len;  /* Number of bytes of FCS - -1 means "unknown" */
386 };
387
388 /* Packet "pseudo-header" information for X.25 capture files. */
389 #define FROM_DCE 0x80
390 struct x25_phdr {
391     guint8  flags;   /* ENCAP_LAPB, ENCAP_V120 : 1st bit means From DCE */
392 };
393
394 /* Packet "pseudo-header" information for ISDN capture files. */
395
396 /* Direction */
397 struct isdn_phdr {
398     gboolean uton;
399     guint8   channel;   /* 0 = D-channel; n = B-channel n */
400 };
401
402 /* Packet "pseudo-header" for ATM capture files.
403    Not all of this information is supplied by all capture types. */
404
405 /*
406  * Status bits.
407  */
408 #define ATM_RAW_CELL    0x01    /* TRUE if the packet is a single cell */
409 #define ATM_NO_HEC      0x02    /* TRUE if the cell has HEC stripped out */
410 #define ATM_AAL2_NOPHDR 0x04    /* TRUE if the AAL2 PDU has no pseudo-header */
411
412 /*
413  * AAL types.
414  */
415 #define AAL_UNKNOWN     0  /* AAL unknown */
416 #define AAL_1           1  /* AAL1 */
417 #define AAL_2           2  /* AAL2 */
418 #define AAL_3_4         3  /* AAL3/4 */
419 #define AAL_5           4  /* AAL5 */
420 #define AAL_USER        5  /* User AAL */
421 #define AAL_SIGNALLING  6  /* Signaling AAL */
422 #define AAL_OAMCELL     7  /* OAM cell */
423
424 /*
425  * Traffic types.
426  */
427 #define TRAF_UNKNOWN    0  /* Unknown */
428 #define TRAF_LLCMX      1  /* LLC multiplexed (RFC 1483) */
429 #define TRAF_VCMX       2  /* VC multiplexed (RFC 1483) */
430 #define TRAF_LANE       3  /* LAN Emulation */
431 #define TRAF_ILMI       4  /* ILMI */
432 #define TRAF_FR         5  /* Frame Relay */
433 #define TRAF_SPANS      6  /* FORE SPANS */
434 #define TRAF_IPSILON    7  /* Ipsilon */
435 #define TRAF_UMTS_FP    8  /* UMTS Frame Protocol */
436 #define TRAF_GPRS_NS    9  /* GPRS Network Services */
437 #define TRAF_SSCOP     10  /* SSCOP */
438
439 /*
440  * Traffic subtypes.
441  */
442 #define TRAF_ST_UNKNOWN     0   /* Unknown */
443
444 /*
445  * For TRAF_VCMX:
446  */
447 #define TRAF_ST_VCMX_802_3_FCS   1  /* 802.3 with an FCS */
448 #define TRAF_ST_VCMX_802_4_FCS   2  /* 802.4 with an FCS */
449 #define TRAF_ST_VCMX_802_5_FCS   3  /* 802.5 with an FCS */
450 #define TRAF_ST_VCMX_FDDI_FCS    4  /* FDDI with an FCS */
451 #define TRAF_ST_VCMX_802_6_FCS   5  /* 802.6 with an FCS */
452 #define TRAF_ST_VCMX_802_3       7  /* 802.3 without an FCS */
453 #define TRAF_ST_VCMX_802_4       8  /* 802.4 without an FCS */
454 #define TRAF_ST_VCMX_802_5       9  /* 802.5 without an FCS */
455 #define TRAF_ST_VCMX_FDDI       10  /* FDDI without an FCS */
456 #define TRAF_ST_VCMX_802_6      11  /* 802.6 without an FCS */
457 #define TRAF_ST_VCMX_FRAGMENTS  12  /* Fragments */
458 #define TRAF_ST_VCMX_BPDU       13  /* BPDU */
459
460 /*
461  * For TRAF_LANE:
462  */
463 #define TRAF_ST_LANE_LE_CTRL     1  /* LANE: LE Ctrl */
464 #define TRAF_ST_LANE_802_3       2  /* LANE: 802.3 */
465 #define TRAF_ST_LANE_802_5       3  /* LANE: 802.5 */
466 #define TRAF_ST_LANE_802_3_MC    4  /* LANE: 802.3 multicast */
467 #define TRAF_ST_LANE_802_5_MC    5  /* LANE: 802.5 multicast */
468
469 /*
470  * For TRAF_IPSILON:
471  */
472 #define TRAF_ST_IPSILON_FT0      1  /* Ipsilon: Flow Type 0 */
473 #define TRAF_ST_IPSILON_FT1      2  /* Ipsilon: Flow Type 1 */
474 #define TRAF_ST_IPSILON_FT2      3  /* Ipsilon: Flow Type 2 */
475
476 struct atm_phdr {
477     guint32 flags;      /* status flags */
478     guint8  aal;        /* AAL of the traffic */
479     guint8  type;       /* traffic type */
480     guint8  subtype;    /* traffic subtype */
481     guint16 vpi;        /* virtual path identifier */
482     guint16 vci;        /* virtual circuit identifier */
483     guint8  aal2_cid;   /* channel id */
484     guint16 channel;    /* link: 0 for DTE->DCE, 1 for DCE->DTE */
485     guint16 cells;      /* number of cells */
486     guint16 aal5t_u2u;  /* user-to-user indicator */
487     guint16 aal5t_len;  /* length of the packet */
488     guint32 aal5t_chksum;   /* checksum for AAL5 packet */
489 };
490
491 /* Packet "pseudo-header" for Nokia output */
492 struct nokia_phdr {
493     struct eth_phdr eth;
494     guint8 stuff[4];    /* mysterious stuff */
495 };
496
497 /* Packet "pseudo-header" for the output from "wandsession", "wannext",
498    "wandisplay", and similar commands on Lucent/Ascend access equipment. */
499
500 #define ASCEND_MAX_STR_LEN 64
501
502 #define ASCEND_PFX_WDS_X    1
503 #define ASCEND_PFX_WDS_R    2
504 #define ASCEND_PFX_WDD      3
505 #define ASCEND_PFX_ISDN_X   4
506 #define ASCEND_PFX_ISDN_R   5
507 #define ASCEND_PFX_ETHER    6
508
509 struct ascend_phdr {
510     guint16 type;                         /* ASCEND_PFX_*, as defined above */
511     char    user[ASCEND_MAX_STR_LEN];     /* Username, from wandsession header */
512     guint32 sess;                         /* Session number, from wandsession header */
513     char    call_num[ASCEND_MAX_STR_LEN]; /* Called number, from WDD header */
514     guint32 chunk;                        /* Chunk number, from WDD header */
515     guint32 task;                         /* Task number */
516 };
517
518 /* Also defined in epan/packet_info.h */
519 #define P2P_DIR_UNKNOWN -1
520 #define P2P_DIR_SENT     0
521 #define P2P_DIR_RECV     1
522
523 /* Packet "pseudo-header" for point-to-point links with direction flags. */
524 struct p2p_phdr {
525     int sent; /* TRUE=sent, FALSE=received, -1=unknown*/
526 };
527
528 /*
529  * Packet "pseudo-header" information for 802.11.
530  * Radio information is only present for WTAP_ENCAP_IEEE_802_11_WITH_RADIO.
531  *
532  * Signal strength, etc. information:
533  *
534  * Raw signal strength can be measured in milliwatts.
535  * It can also be represented as dBm, which is 10 times the log base 10
536  * of the signal strength in mW.
537  *
538  * The Receive Signal Strength Indicator is an integer in the range 0 to 255.
539  * The actual RSSI value for a given signal strength is dependent on the
540  * vendor (and perhaps on the adapter).  The maximum possible RSSI value
541  * is also dependent on the vendor and perhaps the adapter.
542  *
543  * The signal strength can be represented as a percentage, which is 100
544  * times the ratio of the RSSI and the maximum RSSI.
545  */
546 struct ieee_802_11_phdr {
547     gint     fcs_len;       /* Number of bytes of FCS - -1 means "unknown" */
548     gboolean decrypted;     /* TRUE if frame is decrypted even if "protected" bit is set */
549     guint8   channel;       /* Channel number */
550     guint16  data_rate;     /* in .5 Mb/s units */
551     guint8   signal_level;  /* percentage */
552 };
553
554 /* Packet "pseudo-header" for the output from CoSine L2 debug output. */
555
556 #define COSINE_MAX_IF_NAME_LEN  128
557
558 #define COSINE_ENCAP_TEST      1
559 #define COSINE_ENCAP_PPoATM    2
560 #define COSINE_ENCAP_PPoFR     3
561 #define COSINE_ENCAP_ATM       4
562 #define COSINE_ENCAP_FR        5
563 #define COSINE_ENCAP_HDLC      6
564 #define COSINE_ENCAP_PPP       7
565 #define COSINE_ENCAP_ETH       8
566 #define COSINE_ENCAP_UNKNOWN  99
567
568 #define COSINE_DIR_TX 1
569 #define COSINE_DIR_RX 2
570
571 struct cosine_phdr {
572     guint8  encap;      /* COSINE_ENCAP_* as defined above */
573     guint8  direction;  /* COSINE_DIR_*, as defined above */
574     char    if_name[COSINE_MAX_IF_NAME_LEN];  /* Encap & Logical I/F name */
575     guint16 pro;        /* Protocol */
576     guint16 off;        /* Offset */
577     guint16 pri;        /* Priority */
578     guint16 rm;         /* Rate Marking */
579     guint16 err;        /* Error Code */
580 };
581
582 /* Packet "pseudo-header" for IrDA capture files. */
583
584 /*
585  * Direction of the packet
586  */
587 #define IRDA_INCOMING       0x0000
588 #define IRDA_OUTGOING       0x0004
589
590 /*
591  * "Inline" log messages produced by IrCOMM2k on Windows
592  */
593 #define IRDA_LOG_MESSAGE    0x0100  /* log message */
594 #define IRDA_MISSED_MSG     0x0101  /* missed log entry or frame */
595
596 /*
597  * Differentiate between frames and log messages
598  */
599 #define IRDA_CLASS_FRAME    0x0000
600 #define IRDA_CLASS_LOG      0x0100
601 #define IRDA_CLASS_MASK     0xFF00
602
603 struct irda_phdr {
604     guint16 pkttype;    /* packet type */
605 };
606
607 /* Packet "pseudo-header" for nettl (HP-UX) capture files. */
608
609 struct nettl_phdr {
610     guint16 subsys;
611     guint32 devid;
612     guint32 kind;
613     gint32  pid;
614     guint16 uid;
615 };
616
617 /* Packet "pseudo-header" for MTP2 files. */
618
619 #define MTP2_ANNEX_A_NOT_USED      0
620 #define MTP2_ANNEX_A_USED          1
621 #define MTP2_ANNEX_A_USED_UNKNOWN  2
622
623 struct mtp2_phdr {
624     guint8  sent;
625     guint8  annex_a_used;
626     guint16 link_number;
627 };
628
629 /* Packet "pseudo-header" for K12 files. */
630
631 typedef union {
632     struct {
633         guint16 vp;
634         guint16 vc;
635         guint16 cid;
636     } atm;
637
638     guint32 ds0mask;
639 } k12_input_info_t;
640
641 struct k12_phdr {
642     guint32           input;
643     const gchar      *input_name;
644     const gchar      *stack_file;
645     guint32           input_type;
646     k12_input_info_t  input_info;
647     guint8           *extra_info;
648     guint32           extra_length;
649     void*             stuff;
650 };
651
652 #define K12_PORT_DS0S      0x00010008
653 #define K12_PORT_DS1       0x00100008
654 #define K12_PORT_ATMPVC    0x01020000
655
656 struct lapd_phdr {
657     guint16 pkttype;    /* packet type */
658     guint8 we_network;
659 };
660
661 struct wtap;
662 struct catapult_dct2000_phdr
663 {
664     union
665     {
666         struct isdn_phdr isdn;
667         struct atm_phdr  atm;
668         struct p2p_phdr  p2p;
669     } inner_pseudo_header;
670     gint64       seek_off;
671     struct wtap *wth;
672 };
673
674 #define LIBPCAP_BT_PHDR_SENT    0
675 #define LIBPCAP_BT_PHDR_RECV    1
676
677 /*
678  * Header prepended by libpcap to each bluetooth hci h:4 frame.
679  * Values in network byte order
680  */
681 struct libpcap_bt_phdr {
682     guint32 direction;     /* Bit 0 hold the frame direction. */
683 };
684
685 #define LIBPCAP_PPP_PHDR_RECV    0
686 #define LIBPCAP_PPP_PHDR_SENT    1
687
688 /*
689  * Header prepended by libpcap to each ppp frame.
690  */
691 struct libpcap_ppp_phdr {
692     guint8 direction;
693 };
694
695 /*
696  * Endace Record Format pseudo header
697  */
698 struct erf_phdr {
699     guint64 ts;     /* Time stamp */
700     guint8  type;
701     guint8  flags;
702     guint16 rlen;
703     guint16 lctr;
704     guint16 wlen;
705 };
706
707 struct erf_ehdr {
708   guint64 ehdr;
709 };
710
711 /*
712  * ERF pseudo header with optional subheader
713  * (Multichannel or Ethernet)
714  */
715
716 #define MAX_ERF_EHDR 8
717
718 struct erf_mc_phdr {
719     struct erf_phdr phdr;
720     struct erf_ehdr ehdr_list[MAX_ERF_EHDR];
721     union
722     {
723         guint16 eth_hdr;
724         guint32 mc_hdr;
725     } subhdr;
726 };
727
728 #define LLCP_PHDR_FLAG_SENT 0
729 struct llcp_phdr {
730     guint8 adapter;
731     guint8 flags;
732 };
733
734 #define SITA_FRAME_DIR_TXED            (0x00)  /* values of sita_phdr.flags */
735 #define SITA_FRAME_DIR_RXED            (0x01)
736 #define SITA_FRAME_DIR                 (0x01)  /* mask */
737 #define SITA_ERROR_NO_BUFFER           (0x80)
738
739 #define SITA_SIG_DSR                   (0x01)  /* values of sita_phdr.signals */
740 #define SITA_SIG_DTR                   (0x02)
741 #define SITA_SIG_CTS                   (0x04)
742 #define SITA_SIG_RTS                   (0x08)
743 #define SITA_SIG_DCD                   (0x10)
744 #define SITA_SIG_UNDEF1                (0x20)
745 #define SITA_SIG_UNDEF2                (0x40)
746 #define SITA_SIG_UNDEF3                (0x80)
747
748 #define SITA_ERROR_TX_UNDERRUN         (0x01)  /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_TXED) */
749 #define SITA_ERROR_TX_CTS_LOST         (0x02)
750 #define SITA_ERROR_TX_UART_ERROR       (0x04)
751 #define SITA_ERROR_TX_RETX_LIMIT       (0x08)
752 #define SITA_ERROR_TX_UNDEF1           (0x10)
753 #define SITA_ERROR_TX_UNDEF2           (0x20)
754 #define SITA_ERROR_TX_UNDEF3           (0x40)
755 #define SITA_ERROR_TX_UNDEF4           (0x80)
756
757 #define SITA_ERROR_RX_FRAMING          (0x01)  /* values of sita_phdr.errors1 (if SITA_FRAME_DIR_RXED) */
758 #define SITA_ERROR_RX_PARITY           (0x02)
759 #define SITA_ERROR_RX_COLLISION        (0x04)
760 #define SITA_ERROR_RX_FRAME_LONG       (0x08)
761 #define SITA_ERROR_RX_FRAME_SHORT      (0x10)
762 #define SITA_ERROR_RX_UNDEF1           (0x20)
763 #define SITA_ERROR_RX_UNDEF2           (0x40)
764 #define SITA_ERROR_RX_UNDEF3           (0x80)
765
766 #define SITA_ERROR_RX_NONOCTET_ALIGNED (0x01)  /* values of sita_phdr.errors2 (if SITA_FRAME_DIR_RXED) */
767 #define SITA_ERROR_RX_ABORT            (0x02)
768 #define SITA_ERROR_RX_CD_LOST          (0x04)
769 #define SITA_ERROR_RX_DPLL             (0x08)
770 #define SITA_ERROR_RX_OVERRUN          (0x10)
771 #define SITA_ERROR_RX_FRAME_LEN_VIOL   (0x20)
772 #define SITA_ERROR_RX_CRC              (0x40)
773 #define SITA_ERROR_RX_BREAK            (0x80)
774
775 #define SITA_PROTO_UNUSED              (0x00)  /* values of sita_phdr.proto */
776 #define SITA_PROTO_BOP_LAPB            (0x01)
777 #define SITA_PROTO_ETHERNET            (0x02)
778 #define SITA_PROTO_ASYNC_INTIO         (0x03)
779 #define SITA_PROTO_ASYNC_BLKIO         (0x04)
780 #define SITA_PROTO_ALC                 (0x05)
781 #define SITA_PROTO_UTS                 (0x06)
782 #define SITA_PROTO_PPP_HDLC            (0x07)
783 #define SITA_PROTO_SDLC                (0x08)
784 #define SITA_PROTO_TOKENRING           (0x09)
785 #define SITA_PROTO_I2C                 (0x10)
786 #define SITA_PROTO_DPM_LINK            (0x11)
787 #define SITA_PROTO_BOP_FRL             (0x12)
788
789 struct sita_phdr {
790     guint8  sita_flags;
791     guint8  sita_signals;
792     guint8  sita_errors1;
793     guint8  sita_errors2;
794     guint8  sita_proto;
795 };
796
797 /*pseudo header for Bluetooth HCI*/
798 struct bthci_phdr {
799     gboolean sent;
800     guint8   channel;
801 };
802
803 #define BTHCI_CHANNEL_COMMAND  1
804 #define BTHCI_CHANNEL_ACL      2
805 #define BTHCI_CHANNEL_SCO      3
806 #define BTHCI_CHANNEL_EVENT    4
807
808 /* pseudo header for WTAP_ENCAP_LAYER1_EVENT */
809 struct l1event_phdr {
810     gboolean uton;
811 };
812
813 /* * I2C pseudo header */
814 struct i2c_phdr {
815     guint8  is_event;
816     guint8  bus;
817     guint32 flags;
818 };
819
820 /* pseudo header for WTAP_ENCAP_GSM_UM */
821 struct gsm_um_phdr {
822     gboolean uplink;
823     guint8   channel;
824     /* The following are only populated for downlink */
825     guint8   bsic;
826     guint16  arfcn;
827     guint32  tdma_frame;
828     guint8   error;
829     guint16  timeshift;
830 };
831
832 #define GSM_UM_CHANNEL_UNKNOWN  0
833 #define GSM_UM_CHANNEL_BCCH     1
834 #define GSM_UM_CHANNEL_SDCCH    2
835 #define GSM_UM_CHANNEL_SACCH    3
836 #define GSM_UM_CHANNEL_FACCH    4
837 #define GSM_UM_CHANNEL_CCCH     5
838 #define GSM_UM_CHANNEL_RACH     6
839 #define GSM_UM_CHANNEL_AGCH     7
840 #define GSM_UM_CHANNEL_PCH      8
841
842 union wtap_pseudo_header {
843     struct eth_phdr     eth;
844     struct x25_phdr     x25;
845     struct isdn_phdr    isdn;
846     struct atm_phdr     atm;
847     struct ascend_phdr  ascend;
848     struct p2p_phdr     p2p;
849     struct ieee_802_11_phdr ieee_802_11;
850     struct cosine_phdr  cosine;
851     struct irda_phdr    irda;
852     struct nettl_phdr   nettl;
853     struct mtp2_phdr    mtp2;
854     struct k12_phdr     k12;
855     struct lapd_phdr    lapd;
856     struct catapult_dct2000_phdr dct2000;
857     struct erf_mc_phdr  erf;
858     struct sita_phdr    sita;
859     struct bthci_phdr   bthci;
860     struct l1event_phdr l1event;
861     struct i2c_phdr     i2c;
862     struct gsm_um_phdr  gsm_um;
863     struct nstr_phdr    nstr;
864     struct nokia_phdr   nokia;
865     struct llcp_phdr    llcp;
866 };
867
868 struct wtap_nstime {
869     time_t secs;
870     int    nsecs;
871 };
872
873 struct wtap_pkthdr {
874     guint32             presence_flags; /* what stuff do we have? */
875     struct wtap_nstime  ts;
876     guint32             caplen;         /* data length in the file */
877     guint32             len;            /* data length on the wire */
878     int                 pkt_encap;
879                                         /* pcapng variables */
880     guint32             interface_id;   /* identifier of the interface. */
881                                         /* options */
882     gchar              *opt_comment;    /* NULL if not available */
883     guint64             drop_count;     /* number of packets lost (by the interface and the
884                                            operating system) between this packet and the preceding one. */
885     guint32             pack_flags;     /* XXX - 0 for now (any value for "we don't have it"?) */
886
887     union wtap_pseudo_header  pseudo_header;
888 };
889
890 /*
891  * Bits in presence_flags, indicating which of the fields we have.
892  *
893  * For the time stamp, we may need some more flags to indicate
894  * whether the time stamp is an absolute date-and-time stamp, an
895  * absolute time-only stamp (which can make relative time
896  * calculations tricky, as you could in theory have two time
897  * stamps separated by an unknown number of days), or a time stamp
898  * relative to some unspecified time in the past (see mpeg.c).
899  *
900  * There is no presence flag for len - there has to be *some* length
901  * value for the packet.  (The "captured length" can be missing if
902  * the file format doesn't report a captured length distinct from
903  * the on-the-network length because the application(s) producing those
904  * files don't support slicing packets.)
905  *
906  * There could be a presence flag for the packet encapsulation - if it's
907  * absent, use the file encapsulation - but it's not clear that's useful;
908  * we currently do that in the module for the file format.
909  */
910 #define WTAP_HAS_TS            0x00000001  /**< time stamp */
911 #define WTAP_HAS_CAP_LEN       0x00000002  /**< captured length separate from on-the-network length */
912 #define WTAP_HAS_INTERFACE_ID  0x00000004  /**< interface ID */
913 #define WTAP_HAS_COMMENTS      0x00000008  /**< comments */
914 #define WTAP_HAS_DROP_COUNT    0x00000010  /**< drop count */
915 #define WTAP_HAS_PACK_FLAGS    0x00000020  /**< packet flags */
916
917 /**
918  * Holds the option strings from pcapng:s Section Header block(SHB).
919  */
920 typedef struct wtapng_section_s {
921     /* mandatory */
922     guint64             section_length; /**< 64-bit value specifying the length in bytes of the
923                                          *     following section.
924                                          *     Section Length equal -1 (0xFFFFFFFFFFFFFFFF) means
925                                          *     that the size of the section is not specified
926                                          */
927     /* options */
928     gchar               *opt_comment;   /**< NULL if not available */
929     gchar               *shb_hardware;  /**< NULL if not available
930                                          *     UTF-8 string containing the description of the
931                                          *     hardware used to create this section.
932                                          */
933     gchar               *shb_os;        /**< NULL if not available, UTF-8 string containing the
934                                          *     name of the operating system used to create this section.
935                                          */
936     const gchar         *shb_user_appl; /**< NULL if not available, UTF-8 string containing the
937                                          *     name of the application used to create this section.
938                                          */
939 } wtapng_section_t;
940
941
942 /** struct holding the information to build IDB:s
943  *  the interface_data array holds an array of wtapng_if_descr_t
944  *  one per interface.
945  */
946 typedef struct wtapng_iface_descriptions_s {
947     guint number_of_interfaces;
948     GArray *interface_data;
949 } wtapng_iface_descriptions_t;
950
951 /* Interface Description
952  *
953  * Options:
954  *
955  * if_name        2  A UTF-8 string containing the name of the device used to capture data.
956  *                     "eth0" / "\Device\NPF_{AD1CE675-96D0-47C5-ADD0-2504B9126B68}" / ...
957  *
958  * if_description 3  A UTF-8 string containing the description of the device used
959  *                     to capture data. "Broadcom NetXtreme" / "First Ethernet Interface" / ...
960  *
961  * if_IPv4addr    4  Interface network address and netmask. This option can be
962  *                     repeated multiple times within the same Interface Description Block
963  *                     when multiple IPv4 addresses are assigned to the interface. 192 168 1 1 255 255 255 0
964  *
965  * if_IPv6addr    5  Interface network address and prefix length (stored in the last byte).
966  *                     This option can be repeated multiple times within the same Interface
967  *                     Description Block when multiple IPv6 addresses are assigned to the interface.
968  *                     2001:0db8:85a3:08d3:1319:8a2e:0370:7344/64 is written (in hex) as
969  *                     "20 01 0d b8 85 a3 08 d3 13 19 8a 2e 03 70 73 44 40"
970  *
971  * if_MACaddr     6  Interface Hardware MAC address (48 bits). 00 01 02 03 04 05
972  *
973  * if_EUIaddr     7  Interface Hardware EUI address (64 bits), if available. TODO: give a good example
974  *
975  * if_speed       8  Interface speed (in bps). 100000000 for 100Mbps
976  *
977  * if_tsresol     9  Resolution of timestamps. If the Most Significant Bit is equal to zero,
978  *                     the remaining bits indicates the resolution of the timestamp as as a
979  *                     negative power of 10 (e.g. 6 means microsecond resolution, timestamps
980  *                     are the number of microseconds since 1/1/1970). If the Most Significant Bit
981  *                     is equal to one, the remaining bits indicates the resolution has a
982  *                     negative power of 2 (e.g. 10 means 1/1024 of second).
983  *                     If this option is not present, a resolution of 10^-6 is assumed
984  *                     (i.e. timestamps have the same resolution of the standard 'libpcap' timestamps). 6
985  *
986  * if_tzone      10  Time zone for GMT support (TODO: specify better). TODO: give a good example
987  *
988  * if_filter     11  The filter (e.g. "capture only TCP traffic") used to capture traffic.
989  *                     The first byte of the Option Data keeps a code of the filter used
990  *                     (e.g. if this is a libpcap string, or BPF bytecode, and more).
991  *                     More details about this format will be presented in Appendix XXX (TODO).
992  *                     (TODO: better use different options for different fields?
993  *                     e.g. if_filter_pcap, if_filter_bpf, ...) 00 "tcp port 23 and host 10.0.0.5"
994  *
995  * if_os         12  A UTF-8 string containing the name of the operating system of the
996  *                     machine in which this interface is installed.
997  *                     This can be different from the same information that can be
998  *                     contained by the Section Header Block
999  *                     (Section 3.1 (Section Header Block (mandatory))) because
1000  *                     the capture can have been done on a remote machine.
1001  *                     "Windows XP SP2" / "openSUSE 10.2" / ...
1002  *
1003  * if_fcslen     13  An integer value that specified the length of the
1004  *                     Frame Check Sequence (in bits) for this interface.
1005  *                     For link layers whose FCS length can change during time,
1006  *                     the Packet Block Flags Word can be used (see Appendix A (Packet Block Flags Word)). 4
1007  *
1008  * if_tsoffset   14  A 64 bits integer value that specifies an offset (in seconds)
1009  *                     that must be added to the timestamp of each packet to obtain
1010  *                     the absolute timestamp of a packet. If the option is missing,
1011  *                     the timestamps stored in the packet must be considered absolute
1012  *                     timestamps. The time zone of the offset can be specified with the
1013  *                     option if_tzone. TODO: won't a if_tsoffset_low for fractional
1014  *                     second offsets be useful for highly syncronized capture systems? 1234
1015  */
1016 /**
1017  * Interface description data
1018  */
1019 typedef struct wtapng_if_descr_s {
1020     int                    wtap_encap;            /**< link_type translated to wtap_encap */
1021     guint64                time_units_per_second;
1022
1023     /* mandatory */
1024     guint16                link_type;
1025     guint32                snap_len;
1026
1027     /* options */
1028     gchar                 *opt_comment;           /**< NULL if not available */
1029     gchar                 *if_name;               /**< NULL if not available
1030                                                    *  opt 2
1031                                                    *     A UTF-8 string containing the name of the
1032                                                    *     device used to capture data.
1033                                                    */
1034     gchar                 *if_description;        /**< NULL if not available
1035                                                    *  opt 3
1036                                                    *     A UTF-8 string containing the description
1037                                                    *     of the device used to capture data.
1038                                                    */
1039
1040     /* XXX: if_IPv4addr opt 4  Interface network address and netmask.                                */
1041     /* XXX: if_IPv6addr opt 5  Interface network address and prefix length (stored in the last byte).*/
1042     /* XXX: if_MACaddr  opt 6  Interface Hardware MAC address (48 bits).                             */
1043     /* XXX: if_EUIaddr  opt 7  Interface Hardware EUI address (64 bits)                              */
1044
1045     guint64                if_speed;              /**< 0xFFFFFFFF if unknown
1046                                                    *  opt 8
1047                                                    *     Interface speed (in bps). 100000000 for 100Mbps
1048                                                    */
1049     guint8                 if_tsresol;            /**< default is 6 for microsecond resolution
1050                                                    *  opt 9
1051                                                    *     Resolution of timestamps.
1052                                                    *     If the Most Significant Bit is equal to zero,
1053                                                    *     the remaining bits indicates the resolution of the
1054                                                    *     timestamp as as a negative power of 10
1055                                                    */
1056
1057     /* XXX: if_tzone      10  Time zone for GMT support (TODO: specify better). */
1058
1059     gchar                 *if_filter_str;         /**< NULL if not available
1060                                                    *  opt 11  libpcap string.
1061                                                    */
1062     guint16                bpf_filter_len;        /** Opt 11 variant II BPF filter len 0 if not used*/
1063     gchar                 *if_filter_bpf_bytes;   /** Opt 11 BPF filter or NULL */
1064     gchar                 *if_os;                 /**< NULL if not available
1065                                                    *     12  A UTF-8 string containing the name of the
1066                                                    *     operating system of the machine in which this
1067                                                    *     interface is installed.
1068                                                    */
1069     gint8                  if_fcslen;             /**< -1 if unknown or changes between packets,
1070                                                    *  opt 13
1071                                                    *     An integer value that specified the length of
1072                                                    *     the Frame Check Sequence (in bits) for this interface. */
1073     /* XXX: guint64    if_tsoffset; opt 14  A 64 bits integer value that specifies an offset (in seconds)...*/
1074     guint8                 num_stat_entries;
1075     GArray                *interface_statistics;  /**< An array holding the interface statistics from
1076                                                    *     pcapng ISB:s or equivalent(?)*/
1077 } wtapng_if_descr_t;
1078
1079
1080 /**
1081  * Interface Statistics. pcap-ng Interface Statistics Block (ISB).
1082  */
1083 typedef struct wtapng_if_stats_s {
1084     /* mandatory */
1085     guint32  interface_id;
1086     guint32  ts_high;
1087     guint32  ts_low;
1088     /* options */
1089     gchar   *opt_comment;       /**< NULL if not available */
1090     guint64  isb_starttime;
1091     guint64  isb_endtime;
1092     guint64  isb_ifrecv;
1093     guint64  isb_ifdrop;
1094     guint64  isb_filteraccept;
1095     guint64  isb_osdrop;
1096     guint64  isb_usrdeliv;
1097 } wtapng_if_stats_t;
1098
1099
1100 /** A struct with lists of resolved addresses.
1101  *  Used when writing name resoultion blocks (NRB)
1102  */
1103 typedef struct addrinfo_lists {
1104     GList      *ipv4_addr_list; /**< A list of resolved hashipv4_t*/
1105     GList      *ipv6_addr_list; /**< A list of resolved hashipv6_t*/
1106 } addrinfo_lists_t;
1107
1108 struct wtap_dumper;
1109
1110 typedef struct wtap wtap;
1111 typedef struct wtap_dumper wtap_dumper;
1112
1113 typedef struct wtap_reader *FILE_T;
1114
1115 /*
1116  * For registering extensions used for capture file formats.
1117  *
1118  * These items are used in dialogs for opening files, so that
1119  * the user can ask to see all capture files (as identified
1120  * by file extension) or particular types of capture files.
1121  *
1122  * Each file type has a description and a list of extensions the file
1123  * might have.  Some file types aren't real file types, they're
1124  * just generic types, such as "text file" or "XML file", that can
1125  * be used for, among other things, captures we can read, or for
1126  * extensions such as ".cap" that were unimaginatively chosen by
1127  * several different sniffers for their file formats.
1128  */
1129 struct file_extension_info {
1130     /* the file type name */
1131     const char *name;
1132
1133     /* a semicolon-separated list of file extensions used for this type */
1134     const char *extensions;
1135 };
1136
1137 typedef int (*wtap_open_routine_t)(struct wtap*, int *, char **);
1138
1139 /*
1140  * Types of comments.
1141  */
1142 #define WTAP_COMMENT_PER_SECTION        0x00000001      /* per-file/per-file-section */
1143 #define WTAP_COMMENT_PER_INTERFACE      0x00000002      /* per-interface */
1144 #define WTAP_COMMENT_PER_PACKET         0x00000004      /* per-packet */
1145
1146 struct file_type_subtype_info {
1147     /* the file type name */
1148     /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
1149     const char *name;
1150
1151     /* the file type short name, used as a shortcut for the command line tools */
1152     /* should be NULL for all "pseudo" types that are only internally used and not read/writeable */
1153     const char *short_name;
1154
1155     /* the default file extension, used to save this type */
1156     /* should be NULL if no default extension is known */
1157     const char *default_file_extension;
1158
1159     /* a semicolon-separated list of additional file extensions */
1160     /* used for this type */
1161     /* should be NULL if no extensions, or no extensions other */
1162     /* than the default extension, are known */
1163     const char *additional_file_extensions;
1164
1165     /* when writing this file format, is seeking required? */
1166     gboolean writing_must_seek;
1167
1168     /* does this type support name resolution records? */
1169     /* should be FALSE is this file type doesn't support name resolution records */
1170     gboolean has_name_resolution;
1171
1172     /* what types of comment does this file support? */
1173     guint32 supported_comment_types;
1174
1175     /* can this type write this encapsulation format? */
1176     /* should be NULL is this file type doesn't have write support */
1177     int (*can_write_encap)(int);
1178
1179     /* the function to open the capture file for writing */
1180     /* should be NULL is this file type don't have write support */
1181     int (*dump_open)(wtap_dumper *, int *);
1182 };
1183
1184
1185 /** On failure, "wtap_open_offline()" returns NULL, and puts into the
1186  * "int" pointed to by its second argument:
1187  *
1188  * @param filename Name of the file to open
1189  * @param err a positive "errno" value if the capture file can't be opened;
1190  * a negative number, indicating the type of error, on other failures.
1191  * @param err_info for some errors, a string giving more details of
1192  * the error
1193  * @param do_random TRUE if random access to the file will be done,
1194  * FALSE if not
1195  */
1196 WS_DLL_PUBLIC
1197 struct wtap* wtap_open_offline(const char *filename, int *err,
1198     gchar **err_info, gboolean do_random);
1199
1200 /**
1201  * If we were compiled with zlib and we're at EOF, unset EOF so that
1202  * wtap_read/gzread has a chance to succeed. This is necessary if
1203  * we're tailing a file.
1204  */
1205 WS_DLL_PUBLIC
1206 void wtap_cleareof(wtap *wth);
1207
1208 /**
1209  * Set callback functions to add new hostnames. Currently pcapng-only.
1210  * MUST match add_ipv4_name and add_ipv6_name in addr_resolv.c.
1211  */
1212 typedef void (*wtap_new_ipv4_callback_t) (const guint addr, const gchar *name);
1213 WS_DLL_PUBLIC
1214 void wtap_set_cb_new_ipv4(wtap *wth, wtap_new_ipv4_callback_t add_new_ipv4);
1215
1216 typedef void (*wtap_new_ipv6_callback_t) (const void *addrp, const gchar *name);
1217 WS_DLL_PUBLIC
1218 void wtap_set_cb_new_ipv6(wtap *wth, wtap_new_ipv6_callback_t add_new_ipv6);
1219
1220 /** Returns TRUE if read was successful. FALSE if failure. data_offset is
1221  * set to the offset in the file where the data for the read packet is
1222  * located. */
1223 WS_DLL_PUBLIC
1224 gboolean wtap_read(wtap *wth, int *err, gchar **err_info,
1225     gint64 *data_offset);
1226
1227 WS_DLL_PUBLIC
1228 gboolean wtap_seek_read (wtap *wth, gint64 seek_off,
1229         struct wtap_pkthdr *phdr, Buffer *buf, int len,
1230         int *err, gchar **err_info);
1231
1232 /*** get various information snippets about the current packet ***/
1233 WS_DLL_PUBLIC
1234 struct wtap_pkthdr *wtap_phdr(wtap *wth);
1235 WS_DLL_PUBLIC
1236 guint8 *wtap_buf_ptr(wtap *wth);
1237
1238 /*** get various information snippets about the current file ***/
1239
1240 /** Return an approximation of the amount of data we've read sequentially
1241  * from the file so far. */
1242 WS_DLL_PUBLIC
1243 gint64 wtap_read_so_far(wtap *wth);
1244 WS_DLL_PUBLIC
1245 gint64 wtap_file_size(wtap *wth, int *err);
1246 WS_DLL_PUBLIC
1247 gboolean wtap_iscompressed(wtap *wth);
1248 WS_DLL_PUBLIC
1249 guint wtap_snapshot_length(wtap *wth); /* per file */
1250 WS_DLL_PUBLIC
1251 int wtap_file_type_subtype(wtap *wth);
1252 WS_DLL_PUBLIC
1253 int wtap_file_encap(wtap *wth);
1254 WS_DLL_PUBLIC
1255 int wtap_file_tsprecision(wtap *wth);
1256 WS_DLL_PUBLIC
1257 wtapng_section_t* wtap_file_get_shb_info(wtap *wth);
1258 WS_DLL_PUBLIC
1259 wtapng_iface_descriptions_t *wtap_file_get_idb_info(wtap *wth);
1260 WS_DLL_PUBLIC
1261 void wtap_write_shb_comment(wtap *wth, gchar *comment);
1262
1263 /*** close the file descriptors for the current file ***/
1264 WS_DLL_PUBLIC
1265 void wtap_fdclose(wtap *wth);
1266
1267 /*** reopen the random file descriptor for the current file ***/
1268 WS_DLL_PUBLIC
1269 gboolean wtap_fdreopen(wtap *wth, const char *filename, int *err);
1270
1271 /*** close the current file ***/
1272 WS_DLL_PUBLIC
1273 void wtap_sequential_close(wtap *wth);
1274 WS_DLL_PUBLIC
1275 void wtap_close(wtap *wth);
1276
1277 /*** dump packets into a capture file ***/
1278 WS_DLL_PUBLIC
1279 gboolean wtap_dump_can_open(int filetype);
1280
1281 /**
1282  * Given a GArray of WTAP_ENCAP_ types, return the per-file encapsulation
1283  * type that would be needed to write out a file with those types.
1284  */
1285 WS_DLL_PUBLIC
1286 int wtap_dump_file_encap_type(const GArray *file_encaps);
1287
1288 /**
1289  * Return TRUE if we can write this capture file format out in
1290  * compressed form, FALSE if not.
1291  */
1292 WS_DLL_PUBLIC
1293 gboolean wtap_dump_can_compress(int filetype);
1294
1295 /**
1296  * Return TRUE if this capture file format supports storing name
1297  * resolution information in it, FALSE if not.
1298  */
1299 WS_DLL_PUBLIC
1300 gboolean wtap_dump_has_name_resolution(int filetype);
1301
1302 /**
1303  * Return TRUE if this capture file format supports all the comment
1304  * types specified, FALSE if not.
1305  */
1306 WS_DLL_PUBLIC
1307 gboolean wtap_dump_supports_comment_types(int filetype, guint32 comment_types);
1308
1309 WS_DLL_PUBLIC
1310 wtap_dumper* wtap_dump_open(const char *filename, int filetype, int encap,
1311     int snaplen, gboolean compressed, int *err);
1312
1313 WS_DLL_PUBLIC
1314 wtap_dumper* wtap_dump_open_ng(const char *filename, int filetype, int encap,
1315     int snaplen, gboolean compressed, wtapng_section_t *shb_hdr, wtapng_iface_descriptions_t *idb_inf, int *err);
1316
1317 WS_DLL_PUBLIC
1318 wtap_dumper* wtap_dump_fdopen(int fd, int filetype, int encap, int snaplen,
1319     gboolean compressed, int *err);
1320
1321 WS_DLL_PUBLIC
1322 wtap_dumper* wtap_dump_fdopen_ng(int fd, int filetype, int encap, int snaplen,
1323                 gboolean compressed, wtapng_section_t *shb_hdr, wtapng_iface_descriptions_t *idb_inf, int *err);
1324
1325
1326 WS_DLL_PUBLIC
1327 gboolean wtap_dump(wtap_dumper *, const struct wtap_pkthdr *, const guint8 *, int *err);
1328 WS_DLL_PUBLIC
1329 void wtap_dump_flush(wtap_dumper *);
1330 WS_DLL_PUBLIC
1331 gint64 wtap_get_bytes_dumped(wtap_dumper *);
1332 WS_DLL_PUBLIC
1333 void wtap_set_bytes_dumped(wtap_dumper *wdh, gint64 bytes_dumped);
1334 struct addrinfo;
1335 WS_DLL_PUBLIC
1336 gboolean wtap_dump_set_addrinfo_list(wtap_dumper *wdh, addrinfo_lists_t *addrinfo_lists);
1337 WS_DLL_PUBLIC
1338 gboolean wtap_dump_close(wtap_dumper *, int *);
1339
1340 /**
1341  * Return TRUE if we can write a file out with the given GArray of file
1342  * encapsulations and the given bitmask of comment types.
1343  */
1344 WS_DLL_PUBLIC
1345 gboolean wtap_dump_can_write(const GArray *file_encaps, guint32 required_comment_types);
1346
1347 /**
1348  * Get a GArray of WTAP_FILE_TYPE_SUBTYPE_ values for file types/subtypes
1349  * that can be used to save a file of a given type with a given GArray of
1350  * WTAP_ENCAP_ types and the given bitmask of comment types.
1351  */
1352 WS_DLL_PUBLIC
1353 GArray *wtap_get_savable_file_types_subtypes(int file_type,
1354     const GArray *file_encaps, guint32 required_comment_types);
1355
1356 /*** various string converter functions ***/
1357 WS_DLL_PUBLIC
1358 const char *wtap_file_type_subtype_string(int file_type_subtype);
1359 WS_DLL_PUBLIC
1360 const char *wtap_file_type_subtype_short_string(int file_type_subtype);
1361 WS_DLL_PUBLIC
1362 int wtap_short_string_to_file_type_subtype(const char *short_name);
1363
1364 /*** various file extension functions ***/
1365 WS_DLL_PUBLIC
1366 GSList *wtap_get_all_file_extensions_list(void);
1367 WS_DLL_PUBLIC
1368 const char *wtap_default_file_extension(int filetype);
1369 WS_DLL_PUBLIC
1370 GSList *wtap_get_file_extensions_list(int filetype, gboolean include_compressed);
1371 WS_DLL_PUBLIC
1372 void wtap_free_extensions_list(GSList *extensions);
1373
1374 WS_DLL_PUBLIC
1375 const char *wtap_encap_string(int encap);
1376 WS_DLL_PUBLIC
1377 const char *wtap_encap_short_string(int encap);
1378 WS_DLL_PUBLIC
1379 int wtap_short_string_to_encap(const char *short_name);
1380
1381 WS_DLL_PUBLIC
1382 const char *wtap_strerror(int err);
1383
1384 /*** get available number of file types and encapsulations ***/
1385 WS_DLL_PUBLIC
1386 int wtap_get_num_file_type_extensions(void);
1387 WS_DLL_PUBLIC
1388 int wtap_get_num_encap_types(void);
1389 WS_DLL_PUBLIC
1390 int wtap_get_num_file_types_subtypes(void);
1391
1392 /*** get information for file type extension ***/
1393 WS_DLL_PUBLIC
1394 const char *wtap_get_file_extension_type_name(int extension_type);
1395 WS_DLL_PUBLIC
1396 GSList *wtap_get_file_extension_type_extensions(guint extension_type);
1397
1398 /*** dynamically register new file types and encapsulations ***/
1399 WS_DLL_PUBLIC
1400 void wtap_register_file_type_extension(const struct file_extension_info *ei);
1401 WS_DLL_PUBLIC
1402 void wtap_register_open_routine(wtap_open_routine_t, gboolean has_magic);
1403 WS_DLL_PUBLIC
1404 int wtap_register_file_type(const struct file_type_subtype_info* fi);
1405 WS_DLL_PUBLIC
1406 int wtap_register_encap_type(const char* name, const char* short_name);
1407
1408
1409 /**
1410  * Wiretap error codes.
1411  */
1412 #define WTAP_ERR_NOT_REGULAR_FILE              -1
1413     /** The file being opened for reading isn't a plain file (or pipe) */
1414
1415 #define WTAP_ERR_RANDOM_OPEN_PIPE              -2
1416     /** The file is being opened for random access and it's a pipe */
1417
1418 #define WTAP_ERR_FILE_UNKNOWN_FORMAT           -3
1419     /** The file being opened is not a capture file in a known format */
1420
1421 #define WTAP_ERR_UNSUPPORTED                   -4
1422     /** Supported file type, but there's something in the file we
1423        can't support */
1424
1425 #define WTAP_ERR_CANT_WRITE_TO_PIPE            -5
1426     /** Wiretap can't save to a pipe in the specified format */
1427
1428 #define WTAP_ERR_CANT_OPEN                     -6
1429     /** The file couldn't be opened, reason unknown */
1430
1431 #define WTAP_ERR_UNSUPPORTED_FILE_TYPE         -7
1432     /** Wiretap can't save files in the specified format */
1433
1434 #define WTAP_ERR_UNSUPPORTED_ENCAP             -8
1435     /** Wiretap can't read or save files in the specified format with the
1436        specified encapsulation */
1437
1438 #define WTAP_ERR_ENCAP_PER_PACKET_UNSUPPORTED  -9
1439     /** The specified format doesn't support per-packet encapsulations */
1440
1441 #define WTAP_ERR_CANT_CLOSE                   -10
1442     /** The file couldn't be closed, reason unknown */
1443
1444 #define WTAP_ERR_CANT_READ                    -11
1445     /** An attempt to read failed, reason unknown */
1446
1447 #define WTAP_ERR_SHORT_READ                   -12
1448     /** An attempt to read read less data than it should have */
1449
1450 #define WTAP_ERR_BAD_FILE                     -13
1451     /** The file appears to be damaged or corrupted or otherwise bogus */
1452
1453 #define WTAP_ERR_SHORT_WRITE                  -14
1454     /** An attempt to write wrote less data than it should have */
1455
1456 #define WTAP_ERR_UNC_TRUNCATED                -15
1457     /** Sniffer compressed data was oddly truncated */
1458
1459 #define WTAP_ERR_UNC_OVERFLOW                 -16
1460     /** Uncompressing Sniffer data would overflow buffer */
1461
1462 #define WTAP_ERR_UNC_BAD_OFFSET               -17
1463     /** LZ77 compressed data has bad offset to string */
1464
1465 #define WTAP_ERR_RANDOM_OPEN_STDIN            -18
1466     /** We're trying to open the standard input for random access */
1467
1468 #define WTAP_ERR_COMPRESSION_NOT_SUPPORTED    -19
1469     /* The filetype doesn't support output compression */
1470
1471 #define WTAP_ERR_CANT_SEEK                    -20
1472     /** An attempt to seek failed, reason unknown */
1473
1474 #define WTAP_ERR_CANT_SEEK_COMPRESSED         -21
1475     /** An attempt to seek on a compressed stream */
1476
1477 #define WTAP_ERR_DECOMPRESS                   -22
1478     /** Error decompressing */
1479
1480 #define WTAP_ERR_INTERNAL                     -23
1481     /** "Shouldn't happen" internal errors */
1482
1483 #ifdef __cplusplus
1484 }
1485 #endif /* __cplusplus */
1486
1487 #endif /* __WTAP_H__ */
1488
1489 /*
1490  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
1491  *
1492  * Local variables:
1493  * c-basic-offset: 4
1494  * tab-width: 8
1495  * indent-tabs-mode: nil
1496  * End:
1497  *
1498  * vi: set shiftwidth=4 tabstop=8 expandtab:
1499  * :indentSize=4:tabSize=8:noTabs=true:
1500  */