Merge branch 'vendor/LIBPCAP'
[dragonfly.git] / contrib / libpcap / pcap-int.h
CommitLineData
23fa89e6
PA
1/*
2 * Copyright (c) 1994, 1995, 1996
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the Computer Systems
16 * Engineering Group at Lawrence Berkeley Laboratory.
17 * 4. Neither the name of the University nor of the Laboratory may be used
18 * to endorse or promote products derived from this software without
19 * specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
a85e14b0 33 * @(#) $Header: /tcpdump/master/libpcap/pcap-int.h,v 1.94 2008-09-16 00:20:23 guy Exp $ (LBL)
23fa89e6
PA
34 */
35
36#ifndef pcap_int_h
de0d3203
PA
37#define pcap_int_h
38
39#include <pcap/pcap.h>
23fa89e6
PA
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
de0d3203
PA
45#ifdef HAVE_LIBDLPI
46#include <libdlpi.h>
47#endif
23fa89e6
PA
48
49#ifdef WIN32
50#include <Packet32.h>
a85e14b0 51extern CRITICAL_SECTION g_PcapCompileCriticalSection;
23fa89e6
PA
52#endif /* WIN32 */
53
54#ifdef MSDOS
55#include <fcntl.h>
56#include <io.h>
57#endif
58
a85e14b0
PA
59#ifdef HAVE_SNF_API
60#include <snf.h>
61#endif
62
de0d3203
PA
63#if (defined(_MSC_VER) && (_MSC_VER <= 1200)) /* we are compiling with Visual Studio 6, that doesn't support the LL suffix*/
64
65/*
66 * Swap byte ordering of unsigned long long timestamp on a big endian
67 * machine.
68 */
69#define SWAPLL(ull) ((ull & 0xff00000000000000) >> 56) | \
70 ((ull & 0x00ff000000000000) >> 40) | \
71 ((ull & 0x0000ff0000000000) >> 24) | \
72 ((ull & 0x000000ff00000000) >> 8) | \
73 ((ull & 0x00000000ff000000) << 8) | \
74 ((ull & 0x0000000000ff0000) << 24) | \
75 ((ull & 0x000000000000ff00) << 40) | \
76 ((ull & 0x00000000000000ff) << 56)
77
78#else /* A recent Visual studio compiler or not VC */
79
dfcad8d8
PA
80/*
81 * Swap byte ordering of unsigned long long timestamp on a big endian
82 * machine.
83 */
84#define SWAPLL(ull) ((ull & 0xff00000000000000LL) >> 56) | \
85 ((ull & 0x00ff000000000000LL) >> 40) | \
86 ((ull & 0x0000ff0000000000LL) >> 24) | \
87 ((ull & 0x000000ff00000000LL) >> 8) | \
88 ((ull & 0x00000000ff000000LL) << 8) | \
89 ((ull & 0x0000000000ff0000LL) << 24) | \
90 ((ull & 0x000000000000ff00LL) << 40) | \
91 ((ull & 0x00000000000000ffLL) << 56)
92
de0d3203
PA
93#endif /* _MSC_VER */
94
23fa89e6
PA
95/*
96 * Savefile
97 */
98typedef enum {
99 NOT_SWAPPED,
100 SWAPPED,
101 MAYBE_SWAPPED
102} swapped_type_t;
103
de0d3203
PA
104/*
105 * Used when reading a savefile.
106 */
23fa89e6
PA
107struct pcap_sf {
108 FILE *rfile;
a85e14b0 109 int (*next_packet_op)(pcap_t *, struct pcap_pkthdr *, u_char **);
23fa89e6 110 int swapped;
de0d3203 111 size_t hdrsize;
23fa89e6
PA
112 swapped_type_t lengths_swapped;
113 int version_major;
114 int version_minor;
a85e14b0
PA
115 bpf_u_int32 ifcount; /* number of interfaces seen in this capture */
116 u_int tsresol; /* time stamp resolution */
117 u_int tsscale; /* scaling factor for resolution -> microseconds */
118 u_int64_t tsoffset; /* time stamp offset */
23fa89e6
PA
119};
120
de0d3203
PA
121/*
122 * Used when doing a live capture.
123 */
23fa89e6
PA
124struct pcap_md {
125 struct pcap_stat stat;
126 /*XXX*/
127 int use_bpf; /* using kernel filter */
128 u_long TotPkts; /* can't oflow for 79 hrs on ether */
129 u_long TotAccepted; /* count accepted by filter */
130 u_long TotDrops; /* count of dropped packets */
131 long TotMissed; /* missed by i/f during this run */
132 long OrigMissed; /* missed by i/f before this run */
133 char *device; /* device name */
de0d3203 134 int timeout; /* timeout for buffering */
a85e14b0 135 int must_do_on_close; /* stuff we must do when we close */
de0d3203 136 struct pcap *next; /* list of open pcaps that need stuff cleared on close */
23fa89e6
PA
137#ifdef linux
138 int sock_packet; /* using Linux 2.0 compatible interface */
23fa89e6
PA
139 int cooked; /* using SOCK_DGRAM rather than SOCK_RAW */
140 int ifindex; /* interface index of device we're bound to */
141 int lo_ifindex; /* interface index of the loopback device */
23fa89e6 142 u_int packets_read; /* count of packets read with recvfrom() */
de0d3203 143 bpf_u_int32 oldmode; /* mode to restore when turning monitor mode off */
a85e14b0
PA
144 char *mondevice; /* mac80211 monitor device we created */
145 u_char *mmapbuf; /* memory-mapped region pointer */
146 size_t mmapbuflen; /* size of region */
de0d3203
PA
147 u_int tp_version; /* version of tpacket_hdr for mmaped ring */
148 u_int tp_hdrlen; /* hdrlen of tpacket_hdr for mmaped ring */
a85e14b0
PA
149 u_char *oneshot_buffer; /* buffer for copy of packet */
150 long proc_dropped; /* packets reported dropped by /proc/net/dev */
de0d3203 151#endif /* linux */
23fa89e6
PA
152
153#ifdef HAVE_DAG_API
154#ifdef HAVE_DAG_STREAMS_API
155 u_char *dag_mem_bottom; /* DAG card current memory bottom pointer */
156 u_char *dag_mem_top; /* DAG card current memory top pointer */
de0d3203 157#else /* HAVE_DAG_STREAMS_API */
23fa89e6
PA
158 void *dag_mem_base; /* DAG card memory base address */
159 u_int dag_mem_bottom; /* DAG card current memory bottom offset */
160 u_int dag_mem_top; /* DAG card current memory top offset */
161#endif /* HAVE_DAG_STREAMS_API */
162 int dag_fcs_bits; /* Number of checksum bits from link layer */
163 int dag_offset_flags; /* Flags to pass to dag_offset(). */
164 int dag_stream; /* DAG stream number */
165 int dag_timeout; /* timeout specified to pcap_open_live.
166 * Same as in linux above, introduce
167 * generally? */
168#endif /* HAVE_DAG_API */
a85e14b0
PA
169#ifdef HAVE_SNF_API
170 snf_handle_t snf_handle; /* opaque device handle */
171 snf_ring_t snf_ring; /* opaque device ring handle */
172 int snf_timeout;
173 int snf_boardnum;
174#endif /*HAVE_SNF_API*/
175
de0d3203
PA
176#ifdef HAVE_ZEROCOPY_BPF
177 /*
178 * Zero-copy read buffer -- for zero-copy BPF. 'buffer' above will
179 * alternative between these two actual mmap'd buffers as required.
180 * As there is a header on the front size of the mmap'd buffer, only
181 * some of the buffer is exposed to libpcap as a whole via bufsize;
182 * zbufsize is the true size. zbuffer tracks the current zbuf
183 * assocated with buffer so that it can be used to decide which the
184 * next buffer to read will be.
185 */
186 u_char *zbuf1, *zbuf2, *zbuffer;
187 u_int zbufsize;
188 u_int zerocopy;
189 u_int interrupted;
190 struct timespec firstsel;
191 /*
192 * If there's currently a buffer being actively processed, then it is
193 * referenced here; 'buffer' is also pointed at it, but offset by the
194 * size of the header.
195 */
196 struct bpf_zbuf_header *bzh;
197#endif /* HAVE_ZEROCOPY_BPF */
198};
199
200/*
a85e14b0 201 * Stuff to do when we close.
de0d3203 202 */
a85e14b0
PA
203#define MUST_CLEAR_PROMISC 0x00000001 /* clear promiscuous mode */
204#define MUST_CLEAR_RFMON 0x00000002 /* clear rfmon (monitor) mode */
205#define MUST_DELETE_MONIF 0x00000004 /* delete monitor-mode interface */
de0d3203
PA
206
207struct pcap_opt {
208 int buffer_size;
209 char *source;
210 int promisc;
211 int rfmon;
a85e14b0 212 int tstamp_type;
23fa89e6
PA
213};
214
215/*
216 * Ultrix, DEC OSF/1^H^H^H^H^H^H^H^H^HDigital UNIX^H^H^H^H^H^H^H^H^H^H^H^H
dfcad8d8
PA
217 * Tru64 UNIX, and some versions of NetBSD pad FDDI packets to make everything
218 * line up on a nice boundary.
23fa89e6 219 */
dfcad8d8
PA
220#ifdef __NetBSD__
221#include <sys/param.h> /* needed to declare __NetBSD_Version__ */
222#endif
223
23fa89e6
PA
224#if defined(ultrix) || defined(__osf__) || (defined(__NetBSD__) && __NetBSD_Version__ > 106000000)
225#define PCAP_FDDIPAD 3
226#endif
227
de0d3203
PA
228typedef int (*activate_op_t)(pcap_t *);
229typedef int (*can_set_rfmon_op_t)(pcap_t *);
230typedef int (*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *);
231typedef int (*inject_op_t)(pcap_t *, const void *, size_t);
232typedef int (*setfilter_op_t)(pcap_t *, struct bpf_program *);
233typedef int (*setdirection_op_t)(pcap_t *, pcap_direction_t);
234typedef int (*set_datalink_op_t)(pcap_t *, int);
235typedef int (*getnonblock_op_t)(pcap_t *, char *);
236typedef int (*setnonblock_op_t)(pcap_t *, int, char *);
237typedef int (*stats_op_t)(pcap_t *, struct pcap_stat *);
238#ifdef WIN32
239typedef int (*setbuff_op_t)(pcap_t *, int);
240typedef int (*setmode_op_t)(pcap_t *, int);
241typedef int (*setmintocopy_op_t)(pcap_t *, int);
242#endif
243typedef void (*cleanup_op_t)(pcap_t *);
244
23fa89e6
PA
245struct pcap {
246#ifdef WIN32
247 ADAPTER *adapter;
248 LPPACKET Packet;
23fa89e6
PA
249 int nonblock;
250#else
251 int fd;
252 int selectable_fd;
253 int send_fd;
254#endif /* WIN32 */
de0d3203
PA
255
256#ifdef HAVE_LIBDLPI
257 dlpi_handle_t dlpi_hd;
258#endif
23fa89e6 259 int snapshot;
de0d3203
PA
260 int linktype; /* Network linktype */
261 int linktype_ext; /* Extended information stored in the linktype field of a file */
23fa89e6
PA
262 int tzoff; /* timezone offset */
263 int offset; /* offset for proper alignment */
de0d3203
PA
264 int activated; /* true if the capture is really started */
265 int oldstyle; /* if we're opening with pcap_open_live() */
23fa89e6
PA
266
267 int break_loop; /* flag set to force break from packet-reading loop */
268
269#ifdef PCAP_FDDIPAD
270 int fddipad;
271#endif
272
273#ifdef MSDOS
23fa89e6
PA
274 void (*wait_proc)(void); /* call proc while waiting */
275#endif
276
277 struct pcap_sf sf;
278 struct pcap_md md;
de0d3203 279 struct pcap_opt opt;
23fa89e6
PA
280
281 /*
282 * Read buffer.
283 */
284 int bufsize;
285 u_char *buffer;
286 u_char *bp;
287 int cc;
288
289 /*
290 * Place holder for pcap_next().
291 */
292 u_char *pkt;
293
294 /* We're accepting only packets in this direction/these directions. */
295 pcap_direction_t direction;
296
297 /*
298 * Methods.
299 */
de0d3203
PA
300 activate_op_t activate_op;
301 can_set_rfmon_op_t can_set_rfmon_op;
302 read_op_t read_op;
303 inject_op_t inject_op;
304 setfilter_op_t setfilter_op;
305 setdirection_op_t setdirection_op;
306 set_datalink_op_t set_datalink_op;
307 getnonblock_op_t getnonblock_op;
308 setnonblock_op_t setnonblock_op;
309 stats_op_t stats_op;
310
a85e14b0
PA
311 /*
312 * Routine to use as callback for pcap_next()/pcap_next_ex().
313 */
314 pcap_handler oneshot_callback;
315
de0d3203
PA
316#ifdef WIN32
317 /*
318 * These are, at least currently, specific to the Win32 NPF
319 * driver.
320 */
321 setbuff_op_t setbuff_op;
322 setmode_op_t setmode_op;
323 setmintocopy_op_t setmintocopy_op;
324#endif
325 cleanup_op_t cleanup_op;
23fa89e6
PA
326
327 /*
328 * Placeholder for filter code if bpf not in kernel.
329 */
330 struct bpf_program fcode;
331
332 char errbuf[PCAP_ERRBUF_SIZE + 1];
333 int dlt_count;
334 u_int *dlt_list;
a85e14b0
PA
335 int tstamp_type_count;
336 u_int *tstamp_type_list;
23fa89e6
PA
337
338 struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */
339};
340
341/*
342 * This is a timeval as stored in a savefile.
343 * It has to use the same types everywhere, independent of the actual
344 * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
345 * platforms and 64-bit tv_sec values on other platforms, and writing
346 * out native `struct timeval' values would mean files could only be
347 * read on systems with the same tv_sec size as the system on which
348 * the file was written.
349 */
350
351struct pcap_timeval {
352 bpf_int32 tv_sec; /* seconds */
353 bpf_int32 tv_usec; /* microseconds */
354};
355
356/*
357 * This is a `pcap_pkthdr' as actually stored in a savefile.
358 *
359 * Do not change the format of this structure, in any way (this includes
360 * changes that only affect the length of fields in this structure),
361 * and do not make the time stamp anything other than seconds and
362 * microseconds (e.g., seconds and nanoseconds). Instead:
363 *
364 * introduce a new structure for the new format;
365 *
de0d3203
PA
366 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting
367 * a new magic number for your new capture file format, and, when
23fa89e6
PA
368 * you get the new magic number, put it in "savefile.c";
369 *
370 * use that magic number for save files with the changed record
371 * header;
372 *
373 * make the code in "savefile.c" capable of reading files with
374 * the old record header as well as files with the new record header
375 * (using the magic number to determine the header format).
376 *
de0d3203
PA
377 * Then supply the changes as a patch at
378 *
379 * http://sourceforge.net/projects/libpcap/
380 *
381 * so that future versions of libpcap and programs that use it (such as
382 * tcpdump) will be able to read your new capture file format.
23fa89e6
PA
383 */
384
385struct pcap_sf_pkthdr {
386 struct pcap_timeval ts; /* time stamp */
387 bpf_u_int32 caplen; /* length of portion present */
388 bpf_u_int32 len; /* length this packet (off wire) */
389};
390
391/*
392 * How a `pcap_pkthdr' is actually stored in savefiles written
393 * by some patched versions of libpcap (e.g. the ones in Red
394 * Hat Linux 6.1 and 6.2).
395 *
396 * Do not change the format of this structure, in any way (this includes
397 * changes that only affect the length of fields in this structure).
398 * Instead, introduce a new structure, as per the above.
399 */
400
401struct pcap_sf_patched_pkthdr {
402 struct pcap_timeval ts; /* time stamp */
403 bpf_u_int32 caplen; /* length of portion present */
404 bpf_u_int32 len; /* length this packet (off wire) */
405 int index;
406 unsigned short protocol;
407 unsigned char pkt_type;
408};
409
a85e14b0
PA
410/*
411 * User data structure for the one-shot callback used for pcap_next()
412 * and pcap_next_ex().
413 */
414struct oneshot_userdata {
415 struct pcap_pkthdr *hdr;
416 const u_char **pkt;
417 pcap_t *pd;
418};
419
23fa89e6
PA
420int yylex(void);
421
422#ifndef min
423#define min(a, b) ((a) > (b) ? (b) : (a))
424#endif
425
426/* XXX should these be in pcap.h? */
427int pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
428int pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
429
430#ifndef HAVE_STRLCPY
431#define strlcpy(x, y, z) \
432 (strncpy((x), (y), (z)), \
433 ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
434 strlen((y)))
435#endif
436
437#include <stdarg.h>
438
439#if !defined(HAVE_SNPRINTF)
440#define snprintf pcap_snprintf
441extern int snprintf (char *, size_t, const char *, ...);
442#endif
443
444#if !defined(HAVE_VSNPRINTF)
445#define vsnprintf pcap_vsnprintf
446extern int vsnprintf (char *, size_t, const char *, va_list ap);
447#endif
448
449/*
450 * Routines that most pcap implementations can use for non-blocking mode.
451 */
452#if !defined(WIN32) && !defined(MSDOS)
453int pcap_getnonblock_fd(pcap_t *, char *);
454int pcap_setnonblock_fd(pcap_t *p, int, char *);
455#endif
456
de0d3203
PA
457pcap_t *pcap_create_common(const char *, char *);
458int pcap_do_addexit(pcap_t *);
459void pcap_add_to_pcaps_to_close(pcap_t *);
460void pcap_remove_from_pcaps_to_close(pcap_t *);
461void pcap_cleanup_live_common(pcap_t *);
462int pcap_not_initialized(pcap_t *);
463int pcap_check_activated(pcap_t *);
23fa89e6
PA
464
465/*
466 * Internal interfaces for "pcap_findalldevs()".
467 *
468 * "pcap_platform_finddevs()" is a platform-dependent routine to
469 * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
470 * "getifaddrs()", etc..
471 *
472 * "pcap_add_if()" adds an interface to the list of interfaces.
473 */
474int pcap_platform_finddevs(pcap_if_t **, char *);
475int add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *,
476 size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
477 struct sockaddr *, size_t, char *);
478int pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *);
479struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
480int add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
481 const char *, char *);
482
483#ifdef WIN32
484char *pcap_win32strerror(void);
485#endif
486
487int install_bpf_program(pcap_t *, struct bpf_program *);
488
489int pcap_strcasecmp(const char *, const char *);
490
491#ifdef __cplusplus
492}
493#endif
494
495#endif