xref: /minix3/external/bsd/libpcap/dist/pcap-int.h (revision d56f51ea7d8b9045e5c8e2028422523d3f9a5840)
1*d56f51eaSDavid van Moolenbroek /*	$NetBSD: pcap-int.h,v 1.3 2015/03/31 21:39:42 christos Exp $	*/
2*d56f51eaSDavid van Moolenbroek 
3*d56f51eaSDavid van Moolenbroek /*
4*d56f51eaSDavid van Moolenbroek  * Copyright (c) 1994, 1995, 1996
5*d56f51eaSDavid van Moolenbroek  *	The Regents of the University of California.  All rights reserved.
6*d56f51eaSDavid van Moolenbroek  *
7*d56f51eaSDavid van Moolenbroek  * Redistribution and use in source and binary forms, with or without
8*d56f51eaSDavid van Moolenbroek  * modification, are permitted provided that the following conditions
9*d56f51eaSDavid van Moolenbroek  * are met:
10*d56f51eaSDavid van Moolenbroek  * 1. Redistributions of source code must retain the above copyright
11*d56f51eaSDavid van Moolenbroek  *    notice, this list of conditions and the following disclaimer.
12*d56f51eaSDavid van Moolenbroek  * 2. Redistributions in binary form must reproduce the above copyright
13*d56f51eaSDavid van Moolenbroek  *    notice, this list of conditions and the following disclaimer in the
14*d56f51eaSDavid van Moolenbroek  *    documentation and/or other materials provided with the distribution.
15*d56f51eaSDavid van Moolenbroek  * 3. All advertising materials mentioning features or use of this software
16*d56f51eaSDavid van Moolenbroek  *    must display the following acknowledgement:
17*d56f51eaSDavid van Moolenbroek  *	This product includes software developed by the Computer Systems
18*d56f51eaSDavid van Moolenbroek  *	Engineering Group at Lawrence Berkeley Laboratory.
19*d56f51eaSDavid van Moolenbroek  * 4. Neither the name of the University nor of the Laboratory may be used
20*d56f51eaSDavid van Moolenbroek  *    to endorse or promote products derived from this software without
21*d56f51eaSDavid van Moolenbroek  *    specific prior written permission.
22*d56f51eaSDavid van Moolenbroek  *
23*d56f51eaSDavid van Moolenbroek  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24*d56f51eaSDavid van Moolenbroek  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25*d56f51eaSDavid van Moolenbroek  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26*d56f51eaSDavid van Moolenbroek  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27*d56f51eaSDavid van Moolenbroek  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28*d56f51eaSDavid van Moolenbroek  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29*d56f51eaSDavid van Moolenbroek  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30*d56f51eaSDavid van Moolenbroek  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31*d56f51eaSDavid van Moolenbroek  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32*d56f51eaSDavid van Moolenbroek  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33*d56f51eaSDavid van Moolenbroek  * SUCH DAMAGE.
34*d56f51eaSDavid van Moolenbroek  */
35*d56f51eaSDavid van Moolenbroek 
36*d56f51eaSDavid van Moolenbroek #ifndef pcap_int_h
37*d56f51eaSDavid van Moolenbroek #define	pcap_int_h
38*d56f51eaSDavid van Moolenbroek 
39*d56f51eaSDavid van Moolenbroek #include <pcap/pcap.h>
40*d56f51eaSDavid van Moolenbroek 
41*d56f51eaSDavid van Moolenbroek #ifdef __cplusplus
42*d56f51eaSDavid van Moolenbroek extern "C" {
43*d56f51eaSDavid van Moolenbroek #endif
44*d56f51eaSDavid van Moolenbroek 
45*d56f51eaSDavid van Moolenbroek #ifdef WIN32
46*d56f51eaSDavid van Moolenbroek #include <Packet32.h>
47*d56f51eaSDavid van Moolenbroek extern CRITICAL_SECTION g_PcapCompileCriticalSection;
48*d56f51eaSDavid van Moolenbroek #endif /* WIN32 */
49*d56f51eaSDavid van Moolenbroek 
50*d56f51eaSDavid van Moolenbroek #ifdef MSDOS
51*d56f51eaSDavid van Moolenbroek #include <fcntl.h>
52*d56f51eaSDavid van Moolenbroek #include <io.h>
53*d56f51eaSDavid van Moolenbroek #endif
54*d56f51eaSDavid van Moolenbroek 
55*d56f51eaSDavid van Moolenbroek #if (defined(_MSC_VER) && (_MSC_VER <= 1200)) /* we are compiling with Visual Studio 6, that doesn't support the LL suffix*/
56*d56f51eaSDavid van Moolenbroek 
57*d56f51eaSDavid van Moolenbroek /*
58*d56f51eaSDavid van Moolenbroek  * Swap byte ordering of unsigned long long timestamp on a big endian
59*d56f51eaSDavid van Moolenbroek  * machine.
60*d56f51eaSDavid van Moolenbroek  */
61*d56f51eaSDavid van Moolenbroek #define SWAPLL(ull)  ((ull & 0xff00000000000000) >> 56) | \
62*d56f51eaSDavid van Moolenbroek                       ((ull & 0x00ff000000000000) >> 40) | \
63*d56f51eaSDavid van Moolenbroek                       ((ull & 0x0000ff0000000000) >> 24) | \
64*d56f51eaSDavid van Moolenbroek                       ((ull & 0x000000ff00000000) >> 8)  | \
65*d56f51eaSDavid van Moolenbroek                       ((ull & 0x00000000ff000000) << 8)  | \
66*d56f51eaSDavid van Moolenbroek                       ((ull & 0x0000000000ff0000) << 24) | \
67*d56f51eaSDavid van Moolenbroek                       ((ull & 0x000000000000ff00) << 40) | \
68*d56f51eaSDavid van Moolenbroek                       ((ull & 0x00000000000000ff) << 56)
69*d56f51eaSDavid van Moolenbroek 
70*d56f51eaSDavid van Moolenbroek #else /* A recent Visual studio compiler or not VC */
71*d56f51eaSDavid van Moolenbroek 
72*d56f51eaSDavid van Moolenbroek /*
73*d56f51eaSDavid van Moolenbroek  * Swap byte ordering of unsigned long long timestamp on a big endian
74*d56f51eaSDavid van Moolenbroek  * machine.
75*d56f51eaSDavid van Moolenbroek  */
76*d56f51eaSDavid van Moolenbroek #define SWAPLL(ull)  ((ull & 0xff00000000000000LL) >> 56) | \
77*d56f51eaSDavid van Moolenbroek                       ((ull & 0x00ff000000000000LL) >> 40) | \
78*d56f51eaSDavid van Moolenbroek                       ((ull & 0x0000ff0000000000LL) >> 24) | \
79*d56f51eaSDavid van Moolenbroek                       ((ull & 0x000000ff00000000LL) >> 8)  | \
80*d56f51eaSDavid van Moolenbroek                       ((ull & 0x00000000ff000000LL) << 8)  | \
81*d56f51eaSDavid van Moolenbroek                       ((ull & 0x0000000000ff0000LL) << 24) | \
82*d56f51eaSDavid van Moolenbroek                       ((ull & 0x000000000000ff00LL) << 40) | \
83*d56f51eaSDavid van Moolenbroek                       ((ull & 0x00000000000000ffLL) << 56)
84*d56f51eaSDavid van Moolenbroek 
85*d56f51eaSDavid van Moolenbroek #endif /* _MSC_VER */
86*d56f51eaSDavid van Moolenbroek 
87*d56f51eaSDavid van Moolenbroek /*
88*d56f51eaSDavid van Moolenbroek  * Maximum snapshot length.
89*d56f51eaSDavid van Moolenbroek  *
90*d56f51eaSDavid van Moolenbroek  * Somewhat arbitrary, but chosen to be:
91*d56f51eaSDavid van Moolenbroek  *
92*d56f51eaSDavid van Moolenbroek  *    1) big enough for maximum-size Linux loopback packets (65549)
93*d56f51eaSDavid van Moolenbroek  *       and some USB packets captured with USBPcap:
94*d56f51eaSDavid van Moolenbroek  *
95*d56f51eaSDavid van Moolenbroek  *           http://desowin.org/usbpcap/
96*d56f51eaSDavid van Moolenbroek  *
97*d56f51eaSDavid van Moolenbroek  *       (> 131072, < 262144)
98*d56f51eaSDavid van Moolenbroek  *
99*d56f51eaSDavid van Moolenbroek  * and
100*d56f51eaSDavid van Moolenbroek  *
101*d56f51eaSDavid van Moolenbroek  *    2) small enough not to cause attempts to allocate huge amounts of
102*d56f51eaSDavid van Moolenbroek  *       memory; some applications might use the snapshot length in a
103*d56f51eaSDavid van Moolenbroek  *       savefile header to control the size of the buffer they allocate,
104*d56f51eaSDavid van Moolenbroek  *       so a size of, say, 2^31-1 might not work well.
105*d56f51eaSDavid van Moolenbroek  *
106*d56f51eaSDavid van Moolenbroek  * We don't enforce this in pcap_set_snaplen(), but we use it internally.
107*d56f51eaSDavid van Moolenbroek  */
108*d56f51eaSDavid van Moolenbroek #define MAXIMUM_SNAPLEN		262144
109*d56f51eaSDavid van Moolenbroek 
110*d56f51eaSDavid van Moolenbroek struct pcap_opt {
111*d56f51eaSDavid van Moolenbroek 	char	*source;
112*d56f51eaSDavid van Moolenbroek 	int	timeout;	/* timeout for buffering */
113*d56f51eaSDavid van Moolenbroek 	int	buffer_size;
114*d56f51eaSDavid van Moolenbroek 	int	promisc;
115*d56f51eaSDavid van Moolenbroek 	int	rfmon;		/* monitor mode */
116*d56f51eaSDavid van Moolenbroek 	int	immediate;	/* immediate mode - deliver packets as soon as they arrive */
117*d56f51eaSDavid van Moolenbroek 	int	tstamp_type;
118*d56f51eaSDavid van Moolenbroek 	int	tstamp_precision;
119*d56f51eaSDavid van Moolenbroek };
120*d56f51eaSDavid van Moolenbroek 
121*d56f51eaSDavid van Moolenbroek typedef int	(*activate_op_t)(pcap_t *);
122*d56f51eaSDavid van Moolenbroek typedef int	(*can_set_rfmon_op_t)(pcap_t *);
123*d56f51eaSDavid van Moolenbroek typedef int	(*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *);
124*d56f51eaSDavid van Moolenbroek typedef int	(*inject_op_t)(pcap_t *, const void *, size_t);
125*d56f51eaSDavid van Moolenbroek typedef int	(*setfilter_op_t)(pcap_t *, struct bpf_program *);
126*d56f51eaSDavid van Moolenbroek typedef int	(*setdirection_op_t)(pcap_t *, pcap_direction_t);
127*d56f51eaSDavid van Moolenbroek typedef int	(*set_datalink_op_t)(pcap_t *, int);
128*d56f51eaSDavid van Moolenbroek typedef int	(*getnonblock_op_t)(pcap_t *, char *);
129*d56f51eaSDavid van Moolenbroek typedef int	(*setnonblock_op_t)(pcap_t *, int, char *);
130*d56f51eaSDavid van Moolenbroek typedef int	(*stats_op_t)(pcap_t *, struct pcap_stat *);
131*d56f51eaSDavid van Moolenbroek #ifdef WIN32
132*d56f51eaSDavid van Moolenbroek typedef int	(*setbuff_op_t)(pcap_t *, int);
133*d56f51eaSDavid van Moolenbroek typedef int	(*setmode_op_t)(pcap_t *, int);
134*d56f51eaSDavid van Moolenbroek typedef int	(*setmintocopy_op_t)(pcap_t *, int);
135*d56f51eaSDavid van Moolenbroek typedef Adapter *(*getadapter_op_t)(pcap_t *);
136*d56f51eaSDavid van Moolenbroek #endif
137*d56f51eaSDavid van Moolenbroek typedef void	(*cleanup_op_t)(pcap_t *);
138*d56f51eaSDavid van Moolenbroek 
139*d56f51eaSDavid van Moolenbroek /*
140*d56f51eaSDavid van Moolenbroek  * We put all the stuff used in the read code path at the beginning,
141*d56f51eaSDavid van Moolenbroek  * to try to keep it together in the same cache line or lines.
142*d56f51eaSDavid van Moolenbroek  */
143*d56f51eaSDavid van Moolenbroek struct pcap {
144*d56f51eaSDavid van Moolenbroek 	/*
145*d56f51eaSDavid van Moolenbroek 	 * Method to call to read packets on a live capture.
146*d56f51eaSDavid van Moolenbroek 	 */
147*d56f51eaSDavid van Moolenbroek 	read_op_t read_op;
148*d56f51eaSDavid van Moolenbroek 
149*d56f51eaSDavid van Moolenbroek 	/*
150*d56f51eaSDavid van Moolenbroek 	 * Method to call to read to read packets from a savefile.
151*d56f51eaSDavid van Moolenbroek 	 */
152*d56f51eaSDavid van Moolenbroek 	int (*next_packet_op)(pcap_t *, struct pcap_pkthdr *, u_char **);
153*d56f51eaSDavid van Moolenbroek 
154*d56f51eaSDavid van Moolenbroek #ifdef WIN32
155*d56f51eaSDavid van Moolenbroek 	ADAPTER *adapter;
156*d56f51eaSDavid van Moolenbroek 	LPPACKET Packet;
157*d56f51eaSDavid van Moolenbroek 	int nonblock;
158*d56f51eaSDavid van Moolenbroek #else
159*d56f51eaSDavid van Moolenbroek 	int fd;
160*d56f51eaSDavid van Moolenbroek 	int selectable_fd;
161*d56f51eaSDavid van Moolenbroek #endif /* WIN32 */
162*d56f51eaSDavid van Moolenbroek 
163*d56f51eaSDavid van Moolenbroek 	/*
164*d56f51eaSDavid van Moolenbroek 	 * Read buffer.
165*d56f51eaSDavid van Moolenbroek 	 */
166*d56f51eaSDavid van Moolenbroek 	int bufsize;
167*d56f51eaSDavid van Moolenbroek 	u_char *buffer;
168*d56f51eaSDavid van Moolenbroek 	u_char *bp;
169*d56f51eaSDavid van Moolenbroek 	int cc;
170*d56f51eaSDavid van Moolenbroek 
171*d56f51eaSDavid van Moolenbroek 	int break_loop;		/* flag set to force break from packet-reading loop */
172*d56f51eaSDavid van Moolenbroek 
173*d56f51eaSDavid van Moolenbroek 	void *priv;		/* private data for methods */
174*d56f51eaSDavid van Moolenbroek 
175*d56f51eaSDavid van Moolenbroek 	int swapped;
176*d56f51eaSDavid van Moolenbroek 	FILE *rfile;		/* null if live capture, non-null if savefile */
177*d56f51eaSDavid van Moolenbroek 	int fddipad;
178*d56f51eaSDavid van Moolenbroek 	struct pcap *next;	/* list of open pcaps that need stuff cleared on close */
179*d56f51eaSDavid van Moolenbroek 
180*d56f51eaSDavid van Moolenbroek 	/*
181*d56f51eaSDavid van Moolenbroek 	 * File version number; meaningful only for a savefile, but we
182*d56f51eaSDavid van Moolenbroek 	 * keep it here so that apps that (mistakenly) ask for the
183*d56f51eaSDavid van Moolenbroek 	 * version numbers will get the same zero values that they
184*d56f51eaSDavid van Moolenbroek 	 * always did.
185*d56f51eaSDavid van Moolenbroek 	 */
186*d56f51eaSDavid van Moolenbroek 	int version_major;
187*d56f51eaSDavid van Moolenbroek 	int version_minor;
188*d56f51eaSDavid van Moolenbroek 
189*d56f51eaSDavid van Moolenbroek 	int snapshot;
190*d56f51eaSDavid van Moolenbroek 	int linktype;		/* Network linktype */
191*d56f51eaSDavid van Moolenbroek 	int linktype_ext;       /* Extended information stored in the linktype field of a file */
192*d56f51eaSDavid van Moolenbroek 	int tzoff;		/* timezone offset */
193*d56f51eaSDavid van Moolenbroek 	int offset;		/* offset for proper alignment */
194*d56f51eaSDavid van Moolenbroek 	int activated;		/* true if the capture is really started */
195*d56f51eaSDavid van Moolenbroek 	int oldstyle;		/* if we're opening with pcap_open_live() */
196*d56f51eaSDavid van Moolenbroek 
197*d56f51eaSDavid van Moolenbroek 	struct pcap_opt opt;
198*d56f51eaSDavid van Moolenbroek 
199*d56f51eaSDavid van Moolenbroek 	/*
200*d56f51eaSDavid van Moolenbroek 	 * Place holder for pcap_next().
201*d56f51eaSDavid van Moolenbroek 	 */
202*d56f51eaSDavid van Moolenbroek 	u_char *pkt;
203*d56f51eaSDavid van Moolenbroek 
204*d56f51eaSDavid van Moolenbroek 	/* We're accepting only packets in this direction/these directions. */
205*d56f51eaSDavid van Moolenbroek 	pcap_direction_t direction;
206*d56f51eaSDavid van Moolenbroek 
207*d56f51eaSDavid van Moolenbroek 	/*
208*d56f51eaSDavid van Moolenbroek 	 * Flags to affect BPF code generation.
209*d56f51eaSDavid van Moolenbroek 	 */
210*d56f51eaSDavid van Moolenbroek 	int bpf_codegen_flags;
211*d56f51eaSDavid van Moolenbroek 
212*d56f51eaSDavid van Moolenbroek 	/*
213*d56f51eaSDavid van Moolenbroek 	 * Placeholder for filter code if bpf not in kernel.
214*d56f51eaSDavid van Moolenbroek 	 */
215*d56f51eaSDavid van Moolenbroek 	struct bpf_program fcode;
216*d56f51eaSDavid van Moolenbroek 
217*d56f51eaSDavid van Moolenbroek 	char errbuf[PCAP_ERRBUF_SIZE + 1];
218*d56f51eaSDavid van Moolenbroek 	int dlt_count;
219*d56f51eaSDavid van Moolenbroek 	u_int *dlt_list;
220*d56f51eaSDavid van Moolenbroek 	int tstamp_type_count;
221*d56f51eaSDavid van Moolenbroek 	u_int *tstamp_type_list;
222*d56f51eaSDavid van Moolenbroek 	int tstamp_precision_count;
223*d56f51eaSDavid van Moolenbroek 	u_int *tstamp_precision_list;
224*d56f51eaSDavid van Moolenbroek 
225*d56f51eaSDavid van Moolenbroek 	struct pcap_pkthdr pcap_header;	/* This is needed for the pcap_next_ex() to work */
226*d56f51eaSDavid van Moolenbroek 
227*d56f51eaSDavid van Moolenbroek 	/*
228*d56f51eaSDavid van Moolenbroek 	 * More methods.
229*d56f51eaSDavid van Moolenbroek 	 */
230*d56f51eaSDavid van Moolenbroek 	activate_op_t activate_op;
231*d56f51eaSDavid van Moolenbroek 	can_set_rfmon_op_t can_set_rfmon_op;
232*d56f51eaSDavid van Moolenbroek 	inject_op_t inject_op;
233*d56f51eaSDavid van Moolenbroek 	setfilter_op_t setfilter_op;
234*d56f51eaSDavid van Moolenbroek 	setdirection_op_t setdirection_op;
235*d56f51eaSDavid van Moolenbroek 	set_datalink_op_t set_datalink_op;
236*d56f51eaSDavid van Moolenbroek 	getnonblock_op_t getnonblock_op;
237*d56f51eaSDavid van Moolenbroek 	setnonblock_op_t setnonblock_op;
238*d56f51eaSDavid van Moolenbroek 	stats_op_t stats_op;
239*d56f51eaSDavid van Moolenbroek 
240*d56f51eaSDavid van Moolenbroek 	/*
241*d56f51eaSDavid van Moolenbroek 	 * Routine to use as callback for pcap_next()/pcap_next_ex().
242*d56f51eaSDavid van Moolenbroek 	 */
243*d56f51eaSDavid van Moolenbroek 	pcap_handler oneshot_callback;
244*d56f51eaSDavid van Moolenbroek 
245*d56f51eaSDavid van Moolenbroek #ifdef WIN32
246*d56f51eaSDavid van Moolenbroek 	/*
247*d56f51eaSDavid van Moolenbroek 	 * These are, at least currently, specific to the Win32 NPF
248*d56f51eaSDavid van Moolenbroek 	 * driver.
249*d56f51eaSDavid van Moolenbroek 	 */
250*d56f51eaSDavid van Moolenbroek 	setbuff_op_t setbuff_op;
251*d56f51eaSDavid van Moolenbroek 	setmode_op_t setmode_op;
252*d56f51eaSDavid van Moolenbroek 	setmintocopy_op_t setmintocopy_op;
253*d56f51eaSDavid van Moolenbroek 	getadapter_op_t getadapter_op;
254*d56f51eaSDavid van Moolenbroek #endif
255*d56f51eaSDavid van Moolenbroek 	cleanup_op_t cleanup_op;
256*d56f51eaSDavid van Moolenbroek };
257*d56f51eaSDavid van Moolenbroek 
258*d56f51eaSDavid van Moolenbroek /*
259*d56f51eaSDavid van Moolenbroek  * BPF code generation flags.
260*d56f51eaSDavid van Moolenbroek  */
261*d56f51eaSDavid van Moolenbroek #define BPF_SPECIAL_VLAN_HANDLING	0x00000001	/* special VLAN handling for Linux */
262*d56f51eaSDavid van Moolenbroek 
263*d56f51eaSDavid van Moolenbroek /*
264*d56f51eaSDavid van Moolenbroek  * This is a timeval as stored in a savefile.
265*d56f51eaSDavid van Moolenbroek  * It has to use the same types everywhere, independent of the actual
266*d56f51eaSDavid van Moolenbroek  * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
267*d56f51eaSDavid van Moolenbroek  * platforms and 64-bit tv_sec values on other platforms, and writing
268*d56f51eaSDavid van Moolenbroek  * out native `struct timeval' values would mean files could only be
269*d56f51eaSDavid van Moolenbroek  * read on systems with the same tv_sec size as the system on which
270*d56f51eaSDavid van Moolenbroek  * the file was written.
271*d56f51eaSDavid van Moolenbroek  */
272*d56f51eaSDavid van Moolenbroek 
273*d56f51eaSDavid van Moolenbroek struct pcap_timeval {
274*d56f51eaSDavid van Moolenbroek     bpf_int32 tv_sec;		/* seconds */
275*d56f51eaSDavid van Moolenbroek     bpf_int32 tv_usec;		/* microseconds */
276*d56f51eaSDavid van Moolenbroek };
277*d56f51eaSDavid van Moolenbroek 
278*d56f51eaSDavid van Moolenbroek /*
279*d56f51eaSDavid van Moolenbroek  * This is a `pcap_pkthdr' as actually stored in a savefile.
280*d56f51eaSDavid van Moolenbroek  *
281*d56f51eaSDavid van Moolenbroek  * Do not change the format of this structure, in any way (this includes
282*d56f51eaSDavid van Moolenbroek  * changes that only affect the length of fields in this structure),
283*d56f51eaSDavid van Moolenbroek  * and do not make the time stamp anything other than seconds and
284*d56f51eaSDavid van Moolenbroek  * microseconds (e.g., seconds and nanoseconds).  Instead:
285*d56f51eaSDavid van Moolenbroek  *
286*d56f51eaSDavid van Moolenbroek  *	introduce a new structure for the new format;
287*d56f51eaSDavid van Moolenbroek  *
288*d56f51eaSDavid van Moolenbroek  *	send mail to "tcpdump-workers@lists.tcpdump.org", requesting
289*d56f51eaSDavid van Moolenbroek  *	a new magic number for your new capture file format, and, when
290*d56f51eaSDavid van Moolenbroek  *	you get the new magic number, put it in "savefile.c";
291*d56f51eaSDavid van Moolenbroek  *
292*d56f51eaSDavid van Moolenbroek  *	use that magic number for save files with the changed record
293*d56f51eaSDavid van Moolenbroek  *	header;
294*d56f51eaSDavid van Moolenbroek  *
295*d56f51eaSDavid van Moolenbroek  *	make the code in "savefile.c" capable of reading files with
296*d56f51eaSDavid van Moolenbroek  *	the old record header as well as files with the new record header
297*d56f51eaSDavid van Moolenbroek  *	(using the magic number to determine the header format).
298*d56f51eaSDavid van Moolenbroek  *
299*d56f51eaSDavid van Moolenbroek  * Then supply the changes by forking the branch at
300*d56f51eaSDavid van Moolenbroek  *
301*d56f51eaSDavid van Moolenbroek  *	https://github.com/the-tcpdump-group/libpcap/issues
302*d56f51eaSDavid van Moolenbroek  *
303*d56f51eaSDavid van Moolenbroek  * and issuing a pull request, so that future versions of libpcap and
304*d56f51eaSDavid van Moolenbroek  * programs that use it (such as tcpdump) will be able to read your new
305*d56f51eaSDavid van Moolenbroek  * capture file format.
306*d56f51eaSDavid van Moolenbroek  */
307*d56f51eaSDavid van Moolenbroek 
308*d56f51eaSDavid van Moolenbroek struct pcap_sf_pkthdr {
309*d56f51eaSDavid van Moolenbroek     struct pcap_timeval ts;	/* time stamp */
310*d56f51eaSDavid van Moolenbroek     bpf_u_int32 caplen;		/* length of portion present */
311*d56f51eaSDavid van Moolenbroek     bpf_u_int32 len;		/* length this packet (off wire) */
312*d56f51eaSDavid van Moolenbroek };
313*d56f51eaSDavid van Moolenbroek 
314*d56f51eaSDavid van Moolenbroek /*
315*d56f51eaSDavid van Moolenbroek  * How a `pcap_pkthdr' is actually stored in savefiles written
316*d56f51eaSDavid van Moolenbroek  * by some patched versions of libpcap (e.g. the ones in Red
317*d56f51eaSDavid van Moolenbroek  * Hat Linux 6.1 and 6.2).
318*d56f51eaSDavid van Moolenbroek  *
319*d56f51eaSDavid van Moolenbroek  * Do not change the format of this structure, in any way (this includes
320*d56f51eaSDavid van Moolenbroek  * changes that only affect the length of fields in this structure).
321*d56f51eaSDavid van Moolenbroek  * Instead, introduce a new structure, as per the above.
322*d56f51eaSDavid van Moolenbroek  */
323*d56f51eaSDavid van Moolenbroek 
324*d56f51eaSDavid van Moolenbroek struct pcap_sf_patched_pkthdr {
325*d56f51eaSDavid van Moolenbroek     struct pcap_timeval ts;	/* time stamp */
326*d56f51eaSDavid van Moolenbroek     bpf_u_int32 caplen;		/* length of portion present */
327*d56f51eaSDavid van Moolenbroek     bpf_u_int32 len;		/* length this packet (off wire) */
328*d56f51eaSDavid van Moolenbroek     int		index;
329*d56f51eaSDavid van Moolenbroek     unsigned short protocol;
330*d56f51eaSDavid van Moolenbroek     unsigned char pkt_type;
331*d56f51eaSDavid van Moolenbroek };
332*d56f51eaSDavid van Moolenbroek 
333*d56f51eaSDavid van Moolenbroek /*
334*d56f51eaSDavid van Moolenbroek  * User data structure for the one-shot callback used for pcap_next()
335*d56f51eaSDavid van Moolenbroek  * and pcap_next_ex().
336*d56f51eaSDavid van Moolenbroek  */
337*d56f51eaSDavid van Moolenbroek struct oneshot_userdata {
338*d56f51eaSDavid van Moolenbroek 	struct pcap_pkthdr *hdr;
339*d56f51eaSDavid van Moolenbroek 	const u_char **pkt;
340*d56f51eaSDavid van Moolenbroek 	pcap_t *pd;
341*d56f51eaSDavid van Moolenbroek };
342*d56f51eaSDavid van Moolenbroek 
343*d56f51eaSDavid van Moolenbroek int	yylex(void);
344*d56f51eaSDavid van Moolenbroek 
345*d56f51eaSDavid van Moolenbroek #ifndef min
346*d56f51eaSDavid van Moolenbroek #define min(a, b) ((a) > (b) ? (b) : (a))
347*d56f51eaSDavid van Moolenbroek #endif
348*d56f51eaSDavid van Moolenbroek 
349*d56f51eaSDavid van Moolenbroek /* XXX should these be in pcap.h? */
350*d56f51eaSDavid van Moolenbroek int	pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
351*d56f51eaSDavid van Moolenbroek int	pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
352*d56f51eaSDavid van Moolenbroek 
353*d56f51eaSDavid van Moolenbroek #ifndef HAVE_STRLCPY
354*d56f51eaSDavid van Moolenbroek #define strlcpy(x, y, z) \
355*d56f51eaSDavid van Moolenbroek 	(strncpy((x), (y), (z)), \
356*d56f51eaSDavid van Moolenbroek 	 ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
357*d56f51eaSDavid van Moolenbroek 	 strlen((y)))
358*d56f51eaSDavid van Moolenbroek #endif
359*d56f51eaSDavid van Moolenbroek 
360*d56f51eaSDavid van Moolenbroek #include <stdarg.h>
361*d56f51eaSDavid van Moolenbroek 
362*d56f51eaSDavid van Moolenbroek #if !defined(HAVE_SNPRINTF)
363*d56f51eaSDavid van Moolenbroek #define snprintf pcap_snprintf
364*d56f51eaSDavid van Moolenbroek extern int snprintf (char *, size_t, const char *, ...);
365*d56f51eaSDavid van Moolenbroek #endif
366*d56f51eaSDavid van Moolenbroek 
367*d56f51eaSDavid van Moolenbroek #if !defined(HAVE_VSNPRINTF)
368*d56f51eaSDavid van Moolenbroek #define vsnprintf pcap_vsnprintf
369*d56f51eaSDavid van Moolenbroek extern int vsnprintf (char *, size_t, const char *, va_list ap);
370*d56f51eaSDavid van Moolenbroek #endif
371*d56f51eaSDavid van Moolenbroek 
372*d56f51eaSDavid van Moolenbroek /*
373*d56f51eaSDavid van Moolenbroek  * Does the packet count argument to a module's read routine say
374*d56f51eaSDavid van Moolenbroek  * "supply packets until you run out of packets"?
375*d56f51eaSDavid van Moolenbroek  */
376*d56f51eaSDavid van Moolenbroek #define PACKET_COUNT_IS_UNLIMITED(count)	((count) <= 0)
377*d56f51eaSDavid van Moolenbroek 
378*d56f51eaSDavid van Moolenbroek /*
379*d56f51eaSDavid van Moolenbroek  * Routines that most pcap implementations can use for non-blocking mode.
380*d56f51eaSDavid van Moolenbroek  */
381*d56f51eaSDavid van Moolenbroek #if !defined(WIN32) && !defined(MSDOS)
382*d56f51eaSDavid van Moolenbroek int	pcap_getnonblock_fd(pcap_t *, char *);
383*d56f51eaSDavid van Moolenbroek int	pcap_setnonblock_fd(pcap_t *p, int, char *);
384*d56f51eaSDavid van Moolenbroek #endif
385*d56f51eaSDavid van Moolenbroek 
386*d56f51eaSDavid van Moolenbroek /*
387*d56f51eaSDavid van Moolenbroek  * Internal interfaces for "pcap_create()".
388*d56f51eaSDavid van Moolenbroek  *
389*d56f51eaSDavid van Moolenbroek  * "pcap_create_interface()" is the routine to do a pcap_create on
390*d56f51eaSDavid van Moolenbroek  * a regular network interface.  There are multiple implementations
391*d56f51eaSDavid van Moolenbroek  * of this, one for each platform type (Linux, BPF, DLPI, etc.),
392*d56f51eaSDavid van Moolenbroek  * with the one used chosen by the configure script.
393*d56f51eaSDavid van Moolenbroek  *
394*d56f51eaSDavid van Moolenbroek  * "pcap_create_common()" allocates and fills in a pcap_t, for use
395*d56f51eaSDavid van Moolenbroek  * by pcap_create routines.
396*d56f51eaSDavid van Moolenbroek  */
397*d56f51eaSDavid van Moolenbroek pcap_t	*pcap_create_interface(const char *, char *);
398*d56f51eaSDavid van Moolenbroek pcap_t	*pcap_create_common(const char *, char *, size_t);
399*d56f51eaSDavid van Moolenbroek int	pcap_do_addexit(pcap_t *);
400*d56f51eaSDavid van Moolenbroek void	pcap_add_to_pcaps_to_close(pcap_t *);
401*d56f51eaSDavid van Moolenbroek void	pcap_remove_from_pcaps_to_close(pcap_t *);
402*d56f51eaSDavid van Moolenbroek void	pcap_cleanup_live_common(pcap_t *);
403*d56f51eaSDavid van Moolenbroek int	pcap_not_initialized(pcap_t *);
404*d56f51eaSDavid van Moolenbroek int	pcap_check_activated(pcap_t *);
405*d56f51eaSDavid van Moolenbroek 
406*d56f51eaSDavid van Moolenbroek /*
407*d56f51eaSDavid van Moolenbroek  * Internal interfaces for "pcap_findalldevs()".
408*d56f51eaSDavid van Moolenbroek  *
409*d56f51eaSDavid van Moolenbroek  * "pcap_findalldevs_interfaces()" finds interfaces using the
410*d56f51eaSDavid van Moolenbroek  * "standard" mechanisms (SIOCGIFCONF, "getifaddrs()", etc.).
411*d56f51eaSDavid van Moolenbroek  *
412*d56f51eaSDavid van Moolenbroek  * "pcap_platform_finddevs()" is a platform-dependent routine to
413*d56f51eaSDavid van Moolenbroek  * add devices not found by the "standard" mechanisms.
414*d56f51eaSDavid van Moolenbroek  *
415*d56f51eaSDavid van Moolenbroek  * "pcap_add_if()" adds an interface to the list of interfaces, for
416*d56f51eaSDavid van Moolenbroek  * use by various "find interfaces" routines.
417*d56f51eaSDavid van Moolenbroek  */
418*d56f51eaSDavid van Moolenbroek int	pcap_findalldevs_interfaces(pcap_if_t **, char *);
419*d56f51eaSDavid van Moolenbroek int	pcap_platform_finddevs(pcap_if_t **, char *);
420*d56f51eaSDavid van Moolenbroek int	add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *,
421*d56f51eaSDavid van Moolenbroek 	    size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
422*d56f51eaSDavid van Moolenbroek 	    struct sockaddr *, size_t, char *);
423*d56f51eaSDavid van Moolenbroek int	add_addr_to_dev(pcap_if_t *, struct sockaddr *, size_t,
424*d56f51eaSDavid van Moolenbroek 	    struct sockaddr *, size_t, struct sockaddr *, size_t,
425*d56f51eaSDavid van Moolenbroek 	    struct sockaddr *dstaddr, size_t, char *errbuf);
426*d56f51eaSDavid van Moolenbroek int	pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *);
427*d56f51eaSDavid van Moolenbroek struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
428*d56f51eaSDavid van Moolenbroek int	add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
429*d56f51eaSDavid van Moolenbroek 	    const char *, char *);
430*d56f51eaSDavid van Moolenbroek 
431*d56f51eaSDavid van Moolenbroek /*
432*d56f51eaSDavid van Moolenbroek  * Internal interfaces for "pcap_open_offline()".
433*d56f51eaSDavid van Moolenbroek  *
434*d56f51eaSDavid van Moolenbroek  * "pcap_open_offline_common()" allocates and fills in a pcap_t, for use
435*d56f51eaSDavid van Moolenbroek  * by pcap_open_offline routines.
436*d56f51eaSDavid van Moolenbroek  *
437*d56f51eaSDavid van Moolenbroek  * "sf_cleanup()" closes the file handle associated with a pcap_t, if
438*d56f51eaSDavid van Moolenbroek  * appropriate, and frees all data common to all modules for handling
439*d56f51eaSDavid van Moolenbroek  * savefile types.
440*d56f51eaSDavid van Moolenbroek  */
441*d56f51eaSDavid van Moolenbroek pcap_t	*pcap_open_offline_common(char *ebuf, size_t size);
442*d56f51eaSDavid van Moolenbroek void	sf_cleanup(pcap_t *p);
443*d56f51eaSDavid van Moolenbroek 
444*d56f51eaSDavid van Moolenbroek /*
445*d56f51eaSDavid van Moolenbroek  * Internal interfaces for both "pcap_create()" and routines that
446*d56f51eaSDavid van Moolenbroek  * open savefiles.
447*d56f51eaSDavid van Moolenbroek  *
448*d56f51eaSDavid van Moolenbroek  * "pcap_oneshot()" is the standard one-shot callback for "pcap_next()"
449*d56f51eaSDavid van Moolenbroek  * and "pcap_next_ex()".
450*d56f51eaSDavid van Moolenbroek  */
451*d56f51eaSDavid van Moolenbroek void	pcap_oneshot(u_char *, const struct pcap_pkthdr *, const u_char *);
452*d56f51eaSDavid van Moolenbroek 
453*d56f51eaSDavid van Moolenbroek #ifdef WIN32
454*d56f51eaSDavid van Moolenbroek char	*pcap_win32strerror(void);
455*d56f51eaSDavid van Moolenbroek #endif
456*d56f51eaSDavid van Moolenbroek 
457*d56f51eaSDavid van Moolenbroek int	install_bpf_program(pcap_t *, struct bpf_program *);
458*d56f51eaSDavid van Moolenbroek 
459*d56f51eaSDavid van Moolenbroek int	pcap_strcasecmp(const char *, const char *);
460*d56f51eaSDavid van Moolenbroek 
461*d56f51eaSDavid van Moolenbroek #ifdef __cplusplus
462*d56f51eaSDavid van Moolenbroek }
463*d56f51eaSDavid van Moolenbroek #endif
464*d56f51eaSDavid van Moolenbroek 
465*d56f51eaSDavid van Moolenbroek #endif
466