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