xref: /freebsd/contrib/libpcap/pcap-int.h (revision 4f29da19bd44f0e99f021510460a81bf754c21d2)
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.2 2005/05/03 18:54:36 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  * Savefile
57  */
58 typedef enum {
59 	NOT_SWAPPED,
60 	SWAPPED,
61 	MAYBE_SWAPPED
62 } swapped_type_t;
63 
64 struct pcap_sf {
65 	FILE *rfile;
66 	int swapped;
67 	int hdrsize;
68 	swapped_type_t lengths_swapped;
69 	int version_major;
70 	int version_minor;
71 	u_char *base;
72 };
73 
74 struct pcap_md {
75 	struct pcap_stat stat;
76 	/*XXX*/
77 	int use_bpf;		/* using kernel filter */
78 	u_long	TotPkts;	/* can't oflow for 79 hrs on ether */
79 	u_long	TotAccepted;	/* count accepted by filter */
80 	u_long	TotDrops;	/* count of dropped packets */
81 	long	TotMissed;	/* missed by i/f during this run */
82 	long	OrigMissed;	/* missed by i/f before this run */
83 	char	*device;	/* device name */
84 #ifdef linux
85 	int	sock_packet;	/* using Linux 2.0 compatible interface */
86 	int	timeout;	/* timeout specified to pcap_open_live */
87 	int	clear_promisc;	/* must clear promiscuous mode when we close */
88 	int	cooked;		/* using SOCK_DGRAM rather than SOCK_RAW */
89 	int	ifindex;	/* interface index of device we're bound to */
90 	int	lo_ifindex;	/* interface index of the loopback device */
91 	struct pcap *next;	/* list of open promiscuous sock_packet pcaps */
92 #endif
93 
94 #ifdef HAVE_DAG_API
95 	void	*dag_mem_base;	/* DAG card memory base address */
96 	u_int	dag_mem_bottom;	/* DAG card current memory bottom pointer */
97 	u_int	dag_mem_top;	/* DAG card current memory top pointer */
98 	int	dag_fcs_bits;	/* Number of checksum bits from link layer */
99 	int	dag_offset_flags; /* Flags to pass to dag_offset(). */
100 #endif
101 };
102 
103 /*
104  * 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
105  * Tru64 UNIX, and NetBSD pad to make everything line up on a nice boundary.
106  */
107 #if defined(ultrix) || defined(__osf__) || (defined(__NetBSD__) && __NetBSD_Version__ > 106000000)
108 #define       PCAP_FDDIPAD 3
109 #endif
110 
111 struct pcap {
112 #ifdef WIN32
113 	ADAPTER *adapter;
114 	LPPACKET Packet;
115 	int timeout;
116 	int nonblock;
117 #else
118 	int fd;
119 	int selectable_fd;
120 	int send_fd;
121 #endif /* WIN32 */
122 	int snapshot;
123 	int linktype;
124 	int tzoff;		/* timezone offset */
125 	int offset;		/* offset for proper alignment */
126 
127 	int break_loop;		/* flag set to force break from packet-reading loop */
128 
129 #ifdef PCAP_FDDIPAD
130 	int fddipad;
131 #endif
132 
133 #ifdef MSDOS
134         int inter_packet_wait;   /* offline: wait between packets */
135         void (*wait_proc)(void); /*          call proc while waiting */
136 #endif
137 
138 	struct pcap_sf sf;
139 	struct pcap_md md;
140 
141 	/*
142 	 * Read buffer.
143 	 */
144 	int bufsize;
145 	u_char *buffer;
146 	u_char *bp;
147 	int cc;
148 
149 	/*
150 	 * Place holder for pcap_next().
151 	 */
152 	u_char *pkt;
153 
154 	/* We're accepting only packets in this direction/these directions. */
155 	direction_t direction;
156 
157 	/*
158 	 * Methods.
159 	 */
160 	int	(*read_op)(pcap_t *, int cnt, pcap_handler, u_char *);
161 	int	(*inject_op)(pcap_t *, const void *, size_t);
162 	int	(*setfilter_op)(pcap_t *, struct bpf_program *);
163 	int	(*setdirection_op)(pcap_t *, direction_t);
164 	int	(*set_datalink_op)(pcap_t *, int);
165 	int	(*getnonblock_op)(pcap_t *, char *);
166 	int	(*setnonblock_op)(pcap_t *, int, char *);
167 	int	(*stats_op)(pcap_t *, struct pcap_stat *);
168 	void	(*close_op)(pcap_t *);
169 
170 	/*
171 	 * Placeholder for filter code if bpf not in kernel.
172 	 */
173 	struct bpf_program fcode;
174 
175 	char errbuf[PCAP_ERRBUF_SIZE + 1];
176 	int dlt_count;
177 	u_int *dlt_list;
178 
179 	struct pcap_pkthdr pcap_header;	/* This is needed for the pcap_next_ex() to work */
180 };
181 
182 /*
183  * This is a timeval as stored in disk in a dumpfile.
184  * It has to use the same types everywhere, independent of the actual
185  * `struct timeval'
186  */
187 
188 struct pcap_timeval {
189     bpf_int32 tv_sec;		/* seconds */
190     bpf_int32 tv_usec;		/* microseconds */
191 };
192 
193 /*
194  * How a `pcap_pkthdr' is actually stored in the dumpfile.
195  *
196  * Do not change the format of this structure, in any way (this includes
197  * changes that only affect the length of fields in this structure),
198  * and do not make the time stamp anything other than seconds and
199  * microseconds (e.g., seconds and nanoseconds).  Instead:
200  *
201  *	introduce a new structure for the new format;
202  *
203  *	send mail to "tcpdump-workers@tcpdump.org", requesting a new
204  *	magic number for your new capture file format, and, when
205  *	you get the new magic number, put it in "savefile.c";
206  *
207  *	use that magic number for save files with the changed record
208  *	header;
209  *
210  *	make the code in "savefile.c" capable of reading files with
211  *	the old record header as well as files with the new record header
212  *	(using the magic number to determine the header format).
213  *
214  * Then supply the changes to "patches@tcpdump.org", so that future
215  * versions of libpcap and programs that use it (such as tcpdump) will
216  * be able to read your new capture file format.
217  */
218 
219 struct pcap_sf_pkthdr {
220     struct pcap_timeval ts;	/* time stamp */
221     bpf_u_int32 caplen;		/* length of portion present */
222     bpf_u_int32 len;		/* length this packet (off wire) */
223 };
224 
225 /*
226  * How a `pcap_pkthdr' is actually stored in dumpfiles written
227  * by some patched versions of libpcap (e.g. the ones in Red
228  * Hat Linux 6.1 and 6.2).
229  *
230  * Do not change the format of this structure, in any way (this includes
231  * changes that only affect the length of fields in this structure).
232  * Instead, introduce a new structure, as per the above.
233  */
234 
235 struct pcap_sf_patched_pkthdr {
236     struct pcap_timeval ts;	/* time stamp */
237     bpf_u_int32 caplen;		/* length of portion present */
238     bpf_u_int32 len;		/* length this packet (off wire) */
239     int		index;
240     unsigned short protocol;
241     unsigned char pkt_type;
242 };
243 
244 int	yylex(void);
245 
246 #ifndef min
247 #define min(a, b) ((a) > (b) ? (b) : (a))
248 #endif
249 
250 /* XXX should these be in pcap.h? */
251 int	pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
252 int	pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
253 
254 #ifndef HAVE_STRLCPY
255 #define strlcpy(x, y, z) \
256 	(strncpy((x), (y), (z)), \
257 	 ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
258 	 strlen((y)))
259 #endif
260 
261 #include <stdarg.h>
262 
263 /*
264  * Routines that most pcap implementations can use for non-blocking mode.
265  */
266 #if !defined(WIN32) && !defined(MSDOS)
267 int	pcap_getnonblock_fd(pcap_t *, char *);
268 int	pcap_setnonblock_fd(pcap_t *p, int, char *);
269 #endif
270 
271 void	pcap_close_common(pcap_t *);
272 
273 /*
274  * Internal interfaces for "pcap_findalldevs()".
275  *
276  * "pcap_platform_finddevs()" is a platform-dependent routine to
277  * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
278  * "getifaddrs()", etc..
279  *
280  * "pcap_add_if()" adds an interface to the list of interfaces.
281  */
282 int	pcap_platform_finddevs(pcap_if_t **, char *);
283 int	add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *,
284 	    size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
285 	    struct sockaddr *, size_t, char *);
286 int	pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *);
287 struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
288 int	add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
289 	    const char *, char *);
290 
291 #ifdef WIN32
292 char	*pcap_win32strerror(void);
293 #endif
294 
295 int	install_bpf_program(pcap_t *, struct bpf_program *);
296 
297 int	pcap_strcasecmp(const char *, const char *);
298 
299 #ifdef __cplusplus
300 }
301 #endif
302 
303 #endif
304