Add initial pcapng name resolution record support. Wireshark has read
[obnox/wireshark/wip.git] / wiretap / wtap-int.h
1 /* wtap-int.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  */
22
23 #ifndef __WTAP_INT_H__
24 #define __WTAP_INT_H__
25
26 #ifdef HAVE_SYS_TIME_H
27 #include <sys/time.h>
28 #endif
29
30 #include <glib.h>
31 #include <stdio.h>
32 #include <time.h>
33
34 #ifdef HAVE_WINSOCK2_H
35 #include <winsock2.h>
36 #endif
37
38 #ifdef HAVE_LIBZ
39 #include <zlib.h>
40 #define FILE_T  gzFile
41 #else /* No zLib */
42 #define FILE_T  FILE *
43 #endif /* HAVE_LIBZ */
44
45 #include "wtap.h"
46
47 typedef gboolean (*subtype_read_func)(struct wtap*, int*, char**, gint64*);
48 typedef gboolean (*subtype_seek_read_func)(struct wtap*, gint64, union wtap_pseudo_header*,
49                                         guint8*, int, int *, char **);
50 struct wtap {
51         FILE_T                  fh;
52         int                     fd;           /* File descriptor for cap file */
53         FILE_T                  random_fh;    /* Secondary FILE_T for random access */
54         int                     file_type;
55         int                     snapshot_length;
56         struct Buffer           *frame_buffer;
57         struct wtap_pkthdr      phdr;
58         union wtap_pseudo_header pseudo_header;
59
60         gint64                  data_offset;
61
62         void                    *priv;
63
64         subtype_read_func       subtype_read;
65         subtype_seek_read_func  subtype_seek_read;
66         void                    (*subtype_sequential_close)(struct wtap*);
67         void                    (*subtype_close)(struct wtap*);
68         int                     file_encap;     /* per-file, for those
69                                                    file formats that have
70                                                    per-file encapsulation
71                                                    types */
72         int                     tsprecision;    /* timestamp precision of the lower 32bits
73                                                  * e.g. WTAP_FILE_TSPREC_USEC */
74         wtap_new_ipv4_callback_t add_new_ipv4;
75         wtap_new_ipv6_callback_t add_new_ipv6;
76 };
77
78 struct wtap_dumper;
79
80 typedef gboolean (*subtype_write_func)(struct wtap_dumper*,
81                 const struct wtap_pkthdr*, const union wtap_pseudo_header*,
82                 const guchar*, int*);
83 typedef gboolean (*subtype_close_func)(struct wtap_dumper*, int*);
84
85 struct wtap_dumper {
86         FILE*                   fh;
87         int                     file_type;
88         int                     snaplen;
89         int                     encap;
90         gboolean                compressed;
91         gint64                  bytes_dumped;
92
93         void                    *priv;
94
95         subtype_write_func      subtype_write;
96         subtype_close_func      subtype_close;
97
98         int                     tsprecision;    /* timestamp precision of the lower 32bits
99                                                          * e.g. WTAP_FILE_TSPREC_USEC */
100         struct addrinfo *addrinfo_list;
101 };
102
103 extern gboolean wtap_dump_file_write(wtap_dumper *wdh, const void *buf,
104     size_t bufsize, int *err);
105 extern gint64 wtap_dump_file_seek(wtap_dumper *wdh, gint64 offset, int whence, int *err);
106 extern gint64 wtap_dump_file_tell(wtap_dumper *wdh);
107
108
109 extern gint wtap_num_file_types;
110
111 /* Macros to byte-swap 64-bit, 32-bit and 16-bit quantities. */
112 #define BSWAP64(x) \
113         ((((x)&G_GINT64_CONSTANT(0xFF00000000000000U))>>56) |   \
114          (((x)&G_GINT64_CONSTANT(0x00FF000000000000U))>>40) |   \
115          (((x)&G_GINT64_CONSTANT(0x0000FF0000000000U))>>24) |   \
116          (((x)&G_GINT64_CONSTANT(0x000000FF00000000U))>>8) |    \
117          (((x)&G_GINT64_CONSTANT(0x00000000FF000000U))<<8) |    \
118          (((x)&G_GINT64_CONSTANT(0x0000000000FF0000U))<<24) |   \
119          (((x)&G_GINT64_CONSTANT(0x000000000000FF00U))<<40) |   \
120          (((x)&G_GINT64_CONSTANT(0x00000000000000FFU))<<56))
121 #define BSWAP32(x) \
122         ((((x)&0xFF000000)>>24) | \
123          (((x)&0x00FF0000)>>8) | \
124          (((x)&0x0000FF00)<<8) | \
125          (((x)&0x000000FF)<<24))
126 #define BSWAP16(x) \
127          ((((x)&0xFF00)>>8) | \
128           (((x)&0x00FF)<<8))
129
130 /* Macros to byte-swap possibly-unaligned 64-bit, 32-bit and 16-bit quantities;
131  * they take a pointer to the quantity, and byte-swap it in place.
132  */
133 #define PBSWAP64(p) \
134         {                       \
135         guint8 tmp;             \
136         tmp = (p)[7];           \
137         (p)[7] = (p)[0];        \
138         (p)[0] = tmp;           \
139         tmp = (p)[6];           \
140         (p)[6] = (p)[1];        \
141         (p)[1] = tmp;           \
142         tmp = (p)[5];           \
143         (p)[5] = (p)[2];        \
144         (p)[2] = tmp;           \
145         tmp = (p)[4];           \
146         (p)[4] = (p)[3];        \
147         (p)[3] = tmp;           \
148         }
149 #define PBSWAP32(p) \
150         {                       \
151         guint8 tmp;             \
152         tmp = (p)[3];           \
153         (p)[3] = (p)[0];        \
154         (p)[0] = tmp;           \
155         tmp = (p)[2];           \
156         (p)[2] = (p)[1];        \
157         (p)[1] = tmp;           \
158         }
159 #define PBSWAP16(p) \
160         {                       \
161         guint8 tmp;             \
162         tmp = (p)[1];           \
163         (p)[1] = (p)[0];        \
164         (p)[0] = tmp;           \
165         }
166
167 /* Turn host-byte-order values into little-endian values. */
168 #define htoles(s) GUINT16_TO_LE(s)
169 #define htolel(l) GUINT32_TO_LE(l)
170 #define htolell(ll) GUINT64_TO_LE(ll)
171
172 /* Pointer versions of ntohs and ntohl.  Given a pointer to a member of a
173  * byte array, returns the value of the two or four bytes at the pointer.
174  * The pletoh[sl] versions return the little-endian representation.
175  * We also provide pntohll and pletohll, which extract 64-bit integral
176  * quantities.
177  *
178  * These will work regardless of the byte alignment of the pointer.
179  */
180
181 #ifndef pntohs
182 #define pntohs(p)  ((guint16)                       \
183                     ((guint16)*((const guint8 *)(p)+0)<<8|  \
184                      (guint16)*((const guint8 *)(p)+1)<<0))
185 #endif
186
187 #ifndef pntoh24
188 #define pntoh24(p)  ((guint32)*((const guint8 *)(p)+0)<<16| \
189                      (guint32)*((const guint8 *)(p)+1)<<8|  \
190                      (guint32)*((const guint8 *)(p)+2)<<0)
191 #endif
192
193 #ifndef pntohl
194 #define pntohl(p)  ((guint32)*((const guint8 *)(p)+0)<<24|  \
195                     (guint32)*((const guint8 *)(p)+1)<<16|  \
196                     (guint32)*((const guint8 *)(p)+2)<<8|   \
197                     (guint32)*((const guint8 *)(p)+3)<<0)
198 #endif
199
200 #ifndef pntohll
201 #define pntohll(p)  ((guint64)*((const guint8 *)(p)+0)<<56|  \
202                      (guint64)*((const guint8 *)(p)+1)<<48|  \
203                      (guint64)*((const guint8 *)(p)+2)<<40|  \
204                      (guint64)*((const guint8 *)(p)+3)<<32|  \
205                      (guint64)*((const guint8 *)(p)+4)<<24|  \
206                      (guint64)*((const guint8 *)(p)+5)<<16|  \
207                      (guint64)*((const guint8 *)(p)+6)<<8|   \
208                      (guint64)*((const guint8 *)(p)+7)<<0)
209 #endif
210
211
212 #ifndef pletohs
213 #define pletohs(p) ((guint16)                       \
214                     ((guint16)*((const guint8 *)(p)+1)<<8|  \
215                      (guint16)*((const guint8 *)(p)+0)<<0))
216 #endif
217
218 #ifndef pletoh24
219 #define pletoh24(p) ((guint32)*((const guint8 *)(p)+2)<<16|  \
220                      (guint32)*((const guint8 *)(p)+1)<<8|  \
221                      (guint32)*((const guint8 *)(p)+0)<<0)
222 #endif
223
224
225 #ifndef pletohl
226 #define pletohl(p) ((guint32)*((const guint8 *)(p)+3)<<24|  \
227                     (guint32)*((const guint8 *)(p)+2)<<16|  \
228                     (guint32)*((const guint8 *)(p)+1)<<8|   \
229                     (guint32)*((const guint8 *)(p)+0)<<0)
230 #endif
231
232
233 #ifndef pletohll
234 #define pletohll(p) ((guint64)*((const guint8 *)(p)+7)<<56|  \
235                      (guint64)*((const guint8 *)(p)+6)<<48|  \
236                      (guint64)*((const guint8 *)(p)+5)<<40|  \
237                      (guint64)*((const guint8 *)(p)+4)<<32|  \
238                      (guint64)*((const guint8 *)(p)+3)<<24|  \
239                      (guint64)*((const guint8 *)(p)+2)<<16|  \
240                      (guint64)*((const guint8 *)(p)+1)<<8|   \
241                      (guint64)*((const guint8 *)(p)+0)<<0)
242 #endif
243
244 /* Pointer routines to put items out in a particular byte order.
245  * These will work regardless of the byte alignment of the pointer.
246  */
247
248 #ifndef phtons
249 #define phtons(p, v) \
250         {                               \
251         (p)[0] = (guint8)((v) >> 8);    \
252         (p)[1] = (guint8)((v) >> 0);    \
253         }
254 #endif
255
256 #ifndef phton24
257 #define phton24(p, v) \
258         {                               \
259         (p)[0] = (guint8)((v) >> 16);   \
260         (p)[1] = (guint8)((v) >> 8);    \
261         (p)[2] = (guint8)((v) >> 0);    \
262         }
263 #endif
264
265 #ifndef phtonl
266 #define phtonl(p, v) \
267         {                               \
268         (p)[0] = (guint8)((v) >> 24);   \
269         (p)[1] = (guint8)((v) >> 16);   \
270         (p)[2] = (guint8)((v) >> 8);    \
271         (p)[3] = (guint8)((v) >> 0);    \
272         }
273 #endif
274
275 #ifndef phtonll
276 #define phtonll(p, v) \
277         {                               \
278         (p)[0] = (guint8)((v) >> 56);   \
279         (p)[1] = (guint8)((v) >> 48);   \
280         (p)[2] = (guint8)((v) >> 40);   \
281         (p)[3] = (guint8)((v) >> 32);   \
282         (p)[4] = (guint8)((v) >> 24);   \
283         (p)[5] = (guint8)((v) >> 16);   \
284         (p)[6] = (guint8)((v) >> 8);    \
285         (p)[7] = (guint8)((v) >> 0);    \
286         }
287 #endif
288
289 #ifndef pletonll
290 #define pletonll(p, v) \
291         {                               \
292         (p)[0] = (guint8)((v) >> 0);    \
293         (p)[1] = (guint8)((v) >> 8);    \
294         (p)[2] = (guint8)((v) >> 16);   \
295         (p)[3] = (guint8)((v) >> 24);   \
296         (p)[4] = (guint8)((v) >> 32);   \
297         (p)[5] = (guint8)((v) >> 40);   \
298         (p)[6] = (guint8)((v) >> 48);   \
299         (p)[7] = (guint8)((v) >> 56);   \
300         }
301 #endif
302
303 #define wtap_file_read_unknown_bytes(target, num_bytes, fh, err) \
304         G_STMT_START \
305         { \
306                 int _bytes_read; \
307                 _bytes_read = file_read((target), 1, (num_bytes), (fh)); \
308                 if (_bytes_read != (int) (num_bytes)) { \
309                         *(err) = file_error((fh)); \
310                         return FALSE; \
311                 } \
312         } \
313         G_STMT_END
314
315 #define wtap_file_read_expected_bytes(target, num_bytes, fh, err) \
316         G_STMT_START \
317         { \
318                 int _bytes_read; \
319                 _bytes_read = file_read((target), 1, (num_bytes), (fh)); \
320                 if (_bytes_read != (int) (num_bytes)) { \
321                         *(err) = file_error((fh)); \
322                         if (*(err) == 0 && _bytes_read > 0) { \
323                                 *(err) = WTAP_ERR_SHORT_READ; \
324                         } \
325                         return FALSE; \
326                 } \
327         } \
328         G_STMT_END
329
330 /* glib doesn't have g_ptr_array_len of all things!*/
331 #ifndef g_ptr_array_len
332 #define g_ptr_array_len(a)      ((a)->len)
333 #endif
334
335 #endif /* __WTAP_INT_H__ */
336
337 /*
338  * Editor modelines
339  *
340  * Local Variables:
341  * c-basic-offset: 8
342  * tab-width: 8
343  * indent-tabs-mode: t
344  * End:
345  *
346  * ex: set shiftwidth=8 tabstop=8 noexpandtab
347  * :indentSize=8:tabSize=8:noTabs=false:
348  */