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 *
33 * @(#) Header: /tcpdump/master/libpcap/pcap-int.h,v 1.94 2008-09-16 00:20:23 guy Exp (LBL)
34 */
35
36#ifndef pcap_int_h
37#define	pcap_int_h
38
39#include <pcap/pcap.h>
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45#ifdef HAVE_LIBDLPI
46#include <libdlpi.h>
47#endif
48
49#ifdef WIN32
50#include <Packet32.h>
51extern CRITICAL_SECTION g_PcapCompileCriticalSection;
52#endif /* WIN32 */
53
54#ifdef MSDOS
55#include <fcntl.h>
56#include <io.h>
57#endif
58
59#ifdef HAVE_SNF_API
60#include <snf.h>
61#endif
62
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
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
93#endif /* _MSC_VER */
94
95/*
96 * Savefile
97 */
98typedef enum {
99	NOT_SWAPPED,
100	SWAPPED,
101	MAYBE_SWAPPED
102} swapped_type_t;
103
104/*
105 * Used when reading a savefile.
106 */
107struct pcap_sf {
108	FILE *rfile;
109	int (*next_packet_op)(pcap_t *, struct pcap_pkthdr *, u_char **);
110	int swapped;
111	size_t hdrsize;
112	swapped_type_t lengths_swapped;
113	int version_major;
114	int version_minor;
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 */
119};
120
121/*
122 * Used when doing a live capture.
123 */
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 */
134	int	timeout;	/* timeout for buffering */
135	int	must_do_on_close; /* stuff we must do when we close */
136	struct pcap *next;	/* list of open pcaps that need stuff cleared on close */
137#ifdef linux
138	int	sock_packet;	/* using Linux 2.0 compatible interface */
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 */
142	u_int	packets_read;	/* count of packets read with recvfrom() */
143	bpf_u_int32 oldmode;	/* mode to restore when turning monitor mode off */
144	char	*mondevice;	/* mac80211 monitor device we created */
145	u_char	*mmapbuf;	/* memory-mapped region pointer */
146	size_t	mmapbuflen;	/* size of region */
147	u_int	tp_version;	/* version of tpacket_hdr for mmaped ring */
148	u_int	tp_hdrlen;	/* hdrlen of tpacket_hdr for mmaped ring */
149	u_char	*oneshot_buffer; /* buffer for copy of packet */
150	long	proc_dropped; /* packets reported dropped by /proc/net/dev */
151#endif /* linux */
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 */
157#else /* HAVE_DAG_STREAMS_API */
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 */
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
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/*
201 * Stuff to do when we close.
202 */
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 */
206
207struct pcap_opt {
208	int	buffer_size;
209	char	*source;
210	int	promisc;
211	int	rfmon;
212};
213
214/*
215 * 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
216 * Tru64 UNIX, and some versions of NetBSD pad FDDI packets to make everything
217 * line up on a nice boundary.
218 */
219#ifdef __NetBSD__
220#include <sys/param.h>	/* needed to declare __NetBSD_Version__ */
221#endif
222
223#if defined(ultrix) || defined(__osf__) || (defined(__NetBSD__) && __NetBSD_Version__ > 106000000)
224#define       PCAP_FDDIPAD 3
225#endif
226
227typedef int	(*activate_op_t)(pcap_t *);
228typedef int	(*can_set_rfmon_op_t)(pcap_t *);
229typedef int	(*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *);
230typedef int	(*inject_op_t)(pcap_t *, const void *, size_t);
231typedef int	(*setfilter_op_t)(pcap_t *, struct bpf_program *);
232typedef int	(*setdirection_op_t)(pcap_t *, pcap_direction_t);
233typedef int	(*set_datalink_op_t)(pcap_t *, int);
234typedef int	(*getnonblock_op_t)(pcap_t *, char *);
235typedef int	(*setnonblock_op_t)(pcap_t *, int, char *);
236typedef int	(*stats_op_t)(pcap_t *, struct pcap_stat *);
237#ifdef WIN32
238typedef int	(*setbuff_op_t)(pcap_t *, int);
239typedef int	(*setmode_op_t)(pcap_t *, int);
240typedef int	(*setmintocopy_op_t)(pcap_t *, int);
241#endif
242typedef void	(*cleanup_op_t)(pcap_t *);
243
244struct pcap {
245#ifdef WIN32
246	ADAPTER *adapter;
247	LPPACKET Packet;
248	int nonblock;
249#else
250	int fd;
251	int selectable_fd;
252	int send_fd;
253#endif /* WIN32 */
254
255#ifdef HAVE_LIBDLPI
256	dlpi_handle_t dlpi_hd;
257#endif
258	int snapshot;
259	int linktype;		/* Network linktype */
260	int linktype_ext;       /* Extended information stored in the linktype field of a file */
261	int tzoff;		/* timezone offset */
262	int offset;		/* offset for proper alignment */
263	int activated;		/* true if the capture is really started */
264	int oldstyle;		/* if we're opening with pcap_open_live() */
265
266	int break_loop;		/* flag set to force break from packet-reading loop */
267
268#ifdef PCAP_FDDIPAD
269	int fddipad;
270#endif
271
272#ifdef MSDOS
273        void (*wait_proc)(void); /*          call proc while waiting */
274#endif
275
276	struct pcap_sf sf;
277	struct pcap_md md;
278	struct pcap_opt opt;
279
280	/*
281	 * Read buffer.
282	 */
283	int bufsize;
284	u_char *buffer;
285	u_char *bp;
286	int cc;
287
288	/*
289	 * Place holder for pcap_next().
290	 */
291	u_char *pkt;
292
293	/* We're accepting only packets in this direction/these directions. */
294	pcap_direction_t direction;
295
296	/*
297	 * Methods.
298	 */
299	activate_op_t activate_op;
300	can_set_rfmon_op_t can_set_rfmon_op;
301	read_op_t read_op;
302	inject_op_t inject_op;
303	setfilter_op_t setfilter_op;
304	setdirection_op_t setdirection_op;
305	set_datalink_op_t set_datalink_op;
306	getnonblock_op_t getnonblock_op;
307	setnonblock_op_t setnonblock_op;
308	stats_op_t stats_op;
309
310	/*
311	 * Routine to use as callback for pcap_next()/pcap_next_ex().
312	 */
313	pcap_handler oneshot_callback;
314
315#ifdef WIN32
316	/*
317	 * These are, at least currently, specific to the Win32 NPF
318	 * driver.
319	 */
320	setbuff_op_t setbuff_op;
321	setmode_op_t setmode_op;
322	setmintocopy_op_t setmintocopy_op;
323#endif
324	cleanup_op_t cleanup_op;
325
326	/*
327	 * Placeholder for filter code if bpf not in kernel.
328	 */
329	struct bpf_program fcode;
330
331	char errbuf[PCAP_ERRBUF_SIZE + 1];
332	int dlt_count;
333	u_int *dlt_list;
334
335	struct pcap_pkthdr pcap_header;	/* This is needed for the pcap_next_ex() to work */
336};
337
338/*
339 * This is a timeval as stored in a savefile.
340 * It has to use the same types everywhere, independent of the actual
341 * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
342 * platforms and 64-bit tv_sec values on other platforms, and writing
343 * out native `struct timeval' values would mean files could only be
344 * read on systems with the same tv_sec size as the system on which
345 * the file was written.
346 */
347
348struct pcap_timeval {
349    bpf_int32 tv_sec;		/* seconds */
350    bpf_int32 tv_usec;		/* microseconds */
351};
352
353/*
354 * This is a `pcap_pkthdr' as actually stored in a savefile.
355 *
356 * Do not change the format of this structure, in any way (this includes
357 * changes that only affect the length of fields in this structure),
358 * and do not make the time stamp anything other than seconds and
359 * microseconds (e.g., seconds and nanoseconds).  Instead:
360 *
361 *	introduce a new structure for the new format;
362 *
363 *	send mail to "tcpdump-workers@lists.tcpdump.org", requesting
364 *	a new magic number for your new capture file format, and, when
365 *	you get the new magic number, put it in "savefile.c";
366 *
367 *	use that magic number for save files with the changed record
368 *	header;
369 *
370 *	make the code in "savefile.c" capable of reading files with
371 *	the old record header as well as files with the new record header
372 *	(using the magic number to determine the header format).
373 *
374 * Then supply the changes as a patch at
375 *
376 *	http://sourceforge.net/projects/libpcap/
377 *
378 * so that future versions of libpcap and programs that use it (such as
379 * tcpdump) will be able to read your new capture file format.
380 */
381
382struct pcap_sf_pkthdr {
383    struct pcap_timeval ts;	/* time stamp */
384    bpf_u_int32 caplen;		/* length of portion present */
385    bpf_u_int32 len;		/* length this packet (off wire) */
386};
387
388/*
389 * How a `pcap_pkthdr' is actually stored in savefiles written
390 * by some patched versions of libpcap (e.g. the ones in Red
391 * Hat Linux 6.1 and 6.2).
392 *
393 * Do not change the format of this structure, in any way (this includes
394 * changes that only affect the length of fields in this structure).
395 * Instead, introduce a new structure, as per the above.
396 */
397
398struct pcap_sf_patched_pkthdr {
399    struct pcap_timeval ts;	/* time stamp */
400    bpf_u_int32 caplen;		/* length of portion present */
401    bpf_u_int32 len;		/* length this packet (off wire) */
402    int		index;
403    unsigned short protocol;
404    unsigned char pkt_type;
405};
406
407/*
408 * User data structure for the one-shot callback used for pcap_next()
409 * and pcap_next_ex().
410 */
411struct oneshot_userdata {
412	struct pcap_pkthdr *hdr;
413	const u_char **pkt;
414	pcap_t *pd;
415};
416
417int	yylex(void);
418
419#ifndef min
420#define min(a, b) ((a) > (b) ? (b) : (a))
421#endif
422
423/* XXX should these be in pcap.h? */
424int	pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
425int	pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
426
427#ifndef HAVE_STRLCPY
428#define strlcpy(x, y, z) \
429	(strncpy((x), (y), (z)), \
430	 ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
431	 strlen((y)))
432#endif
433
434#include <stdarg.h>
435
436#if !defined(HAVE_SNPRINTF)
437#define snprintf pcap_snprintf
438extern int snprintf (char *, size_t, const char *, ...);
439#endif
440
441#if !defined(HAVE_VSNPRINTF)
442#define vsnprintf pcap_vsnprintf
443extern int vsnprintf (char *, size_t, const char *, va_list ap);
444#endif
445
446/*
447 * Routines that most pcap implementations can use for non-blocking mode.
448 */
449#if !defined(WIN32) && !defined(MSDOS)
450int	pcap_getnonblock_fd(pcap_t *, char *);
451int	pcap_setnonblock_fd(pcap_t *p, int, char *);
452#endif
453
454pcap_t	*pcap_create_common(const char *, char *);
455int	pcap_do_addexit(pcap_t *);
456void	pcap_add_to_pcaps_to_close(pcap_t *);
457void	pcap_remove_from_pcaps_to_close(pcap_t *);
458void	pcap_cleanup_live_common(pcap_t *);
459int	pcap_not_initialized(pcap_t *);
460int	pcap_check_activated(pcap_t *);
461
462/*
463 * Internal interfaces for "pcap_findalldevs()".
464 *
465 * "pcap_platform_finddevs()" is a platform-dependent routine to
466 * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
467 * "getifaddrs()", etc..
468 *
469 * "pcap_add_if()" adds an interface to the list of interfaces.
470 */
471int	pcap_platform_finddevs(pcap_if_t **, char *);
472int	add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *,
473	    size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
474	    struct sockaddr *, size_t, char *);
475int	pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *);
476struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
477int	add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
478	    const char *, char *);
479
480#ifdef WIN32
481char	*pcap_win32strerror(void);
482#endif
483
484int	install_bpf_program(pcap_t *, struct bpf_program *);
485
486int	pcap_strcasecmp(const char *, const char *);
487
488#ifdef __cplusplus
489}
490#endif
491
492#endif
493