xref: /freebsd/contrib/libpcap/pcap-int.h (revision 39beb93c3f8bdbf72a61fda42300b5ebed7390c8)
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  * $FreeBSD$
34  * @(#) $Header: /tcpdump/master/libpcap/pcap-int.h,v 1.68.2.11 2007/06/22 06:43:58 guy Exp $ (LBL)
35  */
36 
37 #ifndef pcap_int_h
38 #define pcap_int_h
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 #include <pcap.h>
45 
46 #ifdef WIN32
47 #include <Packet32.h>
48 #endif /* WIN32 */
49 
50 #ifdef MSDOS
51 #include <fcntl.h>
52 #include <io.h>
53 #endif
54 
55 /*
56  * Swap byte ordering of unsigned long long timestamp on a big endian
57  * machine.
58  */
59 #define SWAPLL(ull)  ((ull & 0xff00000000000000LL) >> 56) | \
60                       ((ull & 0x00ff000000000000LL) >> 40) | \
61                       ((ull & 0x0000ff0000000000LL) >> 24) | \
62                       ((ull & 0x000000ff00000000LL) >> 8)  | \
63                       ((ull & 0x00000000ff000000LL) << 8)  | \
64                       ((ull & 0x0000000000ff0000LL) << 24) | \
65                       ((ull & 0x000000000000ff00LL) << 40) | \
66                       ((ull & 0x00000000000000ffLL) << 56)
67 
68 /*
69  * Savefile
70  */
71 typedef enum {
72 	NOT_SWAPPED,
73 	SWAPPED,
74 	MAYBE_SWAPPED
75 } swapped_type_t;
76 
77 struct pcap_sf {
78 	FILE *rfile;
79 	int swapped;
80 	int hdrsize;
81 	swapped_type_t lengths_swapped;
82 	int version_major;
83 	int version_minor;
84 	u_char *base;
85 };
86 
87 struct pcap_md {
88 	struct pcap_stat stat;
89 	/*XXX*/
90 	int use_bpf;		/* using kernel filter */
91 	u_long	TotPkts;	/* can't oflow for 79 hrs on ether */
92 	u_long	TotAccepted;	/* count accepted by filter */
93 	u_long	TotDrops;	/* count of dropped packets */
94 	long	TotMissed;	/* missed by i/f during this run */
95 	long	OrigMissed;	/* missed by i/f before this run */
96 	char	*device;	/* device name */
97 #ifdef linux
98 	int	sock_packet;	/* using Linux 2.0 compatible interface */
99 	int	timeout;	/* timeout specified to pcap_open_live */
100 	int	clear_promisc;	/* must clear promiscuous mode when we close */
101 	int	cooked;		/* using SOCK_DGRAM rather than SOCK_RAW */
102 	int	ifindex;	/* interface index of device we're bound to */
103 	int	lo_ifindex;	/* interface index of the loopback device */
104 	struct pcap *next;	/* list of open promiscuous sock_packet pcaps */
105 	u_int	packets_read;	/* count of packets read with recvfrom() */
106 #endif
107 
108 #ifdef HAVE_DAG_API
109 #ifdef HAVE_DAG_STREAMS_API
110 	u_char	*dag_mem_bottom;	/* DAG card current memory bottom pointer */
111 	u_char	*dag_mem_top;	/* DAG card current memory top pointer */
112 #else
113 	void	*dag_mem_base;	/* DAG card memory base address */
114 	u_int	dag_mem_bottom;	/* DAG card current memory bottom offset */
115 	u_int	dag_mem_top;	/* DAG card current memory top offset */
116 #endif /* HAVE_DAG_STREAMS_API */
117 	int	dag_fcs_bits;	/* Number of checksum bits from link layer */
118 	int	dag_offset_flags; /* Flags to pass to dag_offset(). */
119 	int	dag_stream;	/* DAG stream number */
120 	int	dag_timeout;	/* timeout specified to pcap_open_live.
121 				 * Same as in linux above, introduce
122 				 * generally? */
123 #endif /* HAVE_DAG_API */
124 };
125 
126 /*
127  * 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
128  * Tru64 UNIX, and some versions of NetBSD pad FDDI packets to make everything
129  * line up on a nice boundary.
130  */
131 #ifdef __NetBSD__
132 #include <sys/param.h>	/* needed to declare __NetBSD_Version__ */
133 #endif
134 
135 #if defined(ultrix) || defined(__osf__) || (defined(__NetBSD__) && __NetBSD_Version__ > 106000000)
136 #define       PCAP_FDDIPAD 3
137 #endif
138 
139 struct pcap {
140 #ifdef WIN32
141 	ADAPTER *adapter;
142 	LPPACKET Packet;
143 	int timeout;
144 	int nonblock;
145 #else
146 	int fd;
147 	int selectable_fd;
148 	int send_fd;
149 #endif /* WIN32 */
150 	int snapshot;
151 	int linktype;
152 	int tzoff;		/* timezone offset */
153 	int offset;		/* offset for proper alignment */
154 
155 	int break_loop;		/* flag set to force break from packet-reading loop */
156 
157 #ifdef PCAP_FDDIPAD
158 	int fddipad;
159 #endif
160 
161 #ifdef MSDOS
162         int inter_packet_wait;   /* offline: wait between packets */
163         void (*wait_proc)(void); /*          call proc while waiting */
164 #endif
165 
166 	struct pcap_sf sf;
167 	struct pcap_md md;
168 
169 	/*
170 	 * Read buffer -- for file descriptor read buffer model.
171 	 */
172 	int bufsize;
173 	u_char *buffer;
174 	u_char *bp;
175 	int cc;
176 	int to_ms;
177 
178 	/*
179 	 * Zero-copy read buffer -- for zero-copy BPF.  'buffer' above will
180 	 * alternative between these two actual mmap'd buffers as required.
181 	 * As there is a header on the front size of the mmap'd buffer, only
182 	 * some of the buffer is exposed to libpcap as a whole via bufsize;
183 	 * zbufsize is the true size.  zbuffer tracks the current zbuf
184 	 * assocated with buffer so that it can be used to decide which the
185 	 * next buffer to read will be.
186 	 */
187 	u_char *zbuf1, *zbuf2, *zbuffer;
188 	u_int zbufsize;
189 	u_int timeout;
190 	u_int zerocopy;
191 	u_int interrupted;
192 	struct timespec firstsel;
193 
194 	/*
195 	 * If there's currently a buffer being actively processed, then it is
196 	 * referenced here; 'buffer' is also pointed at it, but offset by the
197 	 * size of the header.
198 	 */
199 	struct bpf_zbuf_header *bzh;
200 
201 	/*
202 	 * Place holder for pcap_next().
203 	 */
204 	u_char *pkt;
205 
206 	/* We're accepting only packets in this direction/these directions. */
207 	pcap_direction_t direction;
208 
209 	/*
210 	 * Methods.
211 	 */
212 	int	(*read_op)(pcap_t *, int cnt, pcap_handler, u_char *);
213 	int	(*inject_op)(pcap_t *, const void *, size_t);
214 	int	(*setfilter_op)(pcap_t *, struct bpf_program *);
215 	int	(*setdirection_op)(pcap_t *, pcap_direction_t);
216 	int	(*set_datalink_op)(pcap_t *, int);
217 	int	(*getnonblock_op)(pcap_t *, char *);
218 	int	(*setnonblock_op)(pcap_t *, int, char *);
219 	int	(*stats_op)(pcap_t *, struct pcap_stat *);
220 	void	(*close_op)(pcap_t *);
221 
222 	/*
223 	 * Placeholder for filter code if bpf not in kernel.
224 	 */
225 	struct bpf_program fcode;
226 
227 	char errbuf[PCAP_ERRBUF_SIZE + 1];
228 	int dlt_count;
229 	u_int *dlt_list;
230 
231 	struct pcap_pkthdr pcap_header;	/* This is needed for the pcap_next_ex() to work */
232 };
233 
234 /*
235  * This is a timeval as stored in a savefile.
236  * It has to use the same types everywhere, independent of the actual
237  * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
238  * platforms and 64-bit tv_sec values on other platforms, and writing
239  * out native `struct timeval' values would mean files could only be
240  * read on systems with the same tv_sec size as the system on which
241  * the file was written.
242  */
243 
244 struct pcap_timeval {
245     bpf_int32 tv_sec;		/* seconds */
246     bpf_int32 tv_usec;		/* microseconds */
247 };
248 
249 /*
250  * This is a `pcap_pkthdr' as actually stored in a savefile.
251  *
252  * Do not change the format of this structure, in any way (this includes
253  * changes that only affect the length of fields in this structure),
254  * and do not make the time stamp anything other than seconds and
255  * microseconds (e.g., seconds and nanoseconds).  Instead:
256  *
257  *	introduce a new structure for the new format;
258  *
259  *	send mail to "tcpdump-workers@tcpdump.org", requesting a new
260  *	magic number for your new capture file format, and, when
261  *	you get the new magic number, put it in "savefile.c";
262  *
263  *	use that magic number for save files with the changed record
264  *	header;
265  *
266  *	make the code in "savefile.c" capable of reading files with
267  *	the old record header as well as files with the new record header
268  *	(using the magic number to determine the header format).
269  *
270  * Then supply the changes to "patches@tcpdump.org", so that future
271  * versions of libpcap and programs that use it (such as tcpdump) will
272  * be able to read your new capture file format.
273  */
274 
275 struct pcap_sf_pkthdr {
276     struct pcap_timeval ts;	/* time stamp */
277     bpf_u_int32 caplen;		/* length of portion present */
278     bpf_u_int32 len;		/* length this packet (off wire) */
279 };
280 
281 /*
282  * How a `pcap_pkthdr' is actually stored in savefiles written
283  * by some patched versions of libpcap (e.g. the ones in Red
284  * Hat Linux 6.1 and 6.2).
285  *
286  * Do not change the format of this structure, in any way (this includes
287  * changes that only affect the length of fields in this structure).
288  * Instead, introduce a new structure, as per the above.
289  */
290 
291 struct pcap_sf_patched_pkthdr {
292     struct pcap_timeval ts;	/* time stamp */
293     bpf_u_int32 caplen;		/* length of portion present */
294     bpf_u_int32 len;		/* length this packet (off wire) */
295     int		index;
296     unsigned short protocol;
297     unsigned char pkt_type;
298 };
299 
300 int	yylex(void);
301 
302 #ifndef min
303 #define min(a, b) ((a) > (b) ? (b) : (a))
304 #endif
305 
306 /* XXX should these be in pcap.h? */
307 int	pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
308 int	pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
309 
310 #ifndef HAVE_STRLCPY
311 #define strlcpy(x, y, z) \
312 	(strncpy((x), (y), (z)), \
313 	 ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
314 	 strlen((y)))
315 #endif
316 
317 #include <stdarg.h>
318 
319 /*
320  * Routines that most pcap implementations can use for non-blocking mode.
321  */
322 #if !defined(WIN32) && !defined(MSDOS)
323 int	pcap_getnonblock_fd(pcap_t *, char *);
324 int	pcap_setnonblock_fd(pcap_t *p, int, char *);
325 #endif
326 
327 void	pcap_close_common(pcap_t *);
328 
329 /*
330  * Internal interfaces for "pcap_findalldevs()".
331  *
332  * "pcap_platform_finddevs()" is a platform-dependent routine to
333  * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
334  * "getifaddrs()", etc..
335  *
336  * "pcap_add_if()" adds an interface to the list of interfaces.
337  */
338 int	pcap_platform_finddevs(pcap_if_t **, char *);
339 int	add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *,
340 	    size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
341 	    struct sockaddr *, size_t, char *);
342 int	pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *);
343 struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
344 int	add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
345 	    const char *, char *);
346 
347 #ifdef WIN32
348 char	*pcap_win32strerror(void);
349 #endif
350 
351 int	install_bpf_program(pcap_t *, struct bpf_program *);
352 
353 int	pcap_strcasecmp(const char *, const char *);
354 
355 #ifdef __cplusplus
356 }
357 #endif
358 
359 #endif
360