xref: /freebsd/contrib/libpcap/pcap-int.h (revision a3e8fd0b7f663db7eafff527d5c3ca3bcfa8a537)
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.33 2001/08/24 07:46:52 guy Exp $ (LBL)
34  *
35  * $FreeBSD$
36  */
37 
38 #ifndef pcap_int_h
39 #define pcap_int_h
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 #include <pcap.h>
46 
47 /*
48  * Savefile
49  */
50 struct pcap_sf {
51 	FILE *rfile;
52 	int swapped;
53 	int hdrsize;
54 	int version_major;
55 	int version_minor;
56 	u_char *base;
57 };
58 
59 struct pcap_md {
60 	struct pcap_stat stat;
61 	/*XXX*/
62 	int use_bpf;		/* using kernel filter */
63 	u_long	TotPkts;	/* can't oflow for 79 hrs on ether */
64 	u_long	TotAccepted;	/* count accepted by filter */
65 	u_long	TotDrops;	/* count of dropped packets */
66 	long	TotMissed;	/* missed by i/f during this run */
67 	long	OrigMissed;	/* missed by i/f before this run */
68 #ifdef linux
69 	int	sock_packet;	/* using Linux 2.0 compatible interface */
70 	int	timeout;	/* timeout specified to pcap_open_live */
71 	int	clear_promisc;	/* must clear promiscuous mode when we close */
72 	int	cooked;		/* using SOCK_DGRAM rather than SOCK_RAW */
73 	int	lo_ifindex;	/* interface index of the loopback device */
74 	char 	*device;	/* device name */
75 	struct pcap *next;	/* list of open promiscuous sock_packet pcaps */
76 #endif
77 };
78 
79 struct pcap {
80 	int fd;
81 	int snapshot;
82 	int linktype;
83 	int tzoff;		/* timezone offset */
84 	int offset;		/* offset for proper alignment */
85 
86 	struct pcap_sf sf;
87 	struct pcap_md md;
88 
89 	/*
90 	 * Read buffer.
91 	 */
92 	int bufsize;
93 	u_char *buffer;
94 	u_char *bp;
95 	int cc;
96 
97 	/*
98 	 * Place holder for pcap_next().
99 	 */
100 	u_char *pkt;
101 
102 
103 	/*
104 	 * Placeholder for filter code if bpf not in kernel.
105 	 */
106 	struct bpf_program fcode;
107 
108 	char errbuf[PCAP_ERRBUF_SIZE];
109 };
110 
111 /*
112  * This is a timeval as stored in disk in a dumpfile.
113  * It has to use the same types everywhere, independent of the actual
114  * `struct timeval'
115  */
116 
117 struct pcap_timeval {
118     bpf_int32 tv_sec;		/* seconds */
119     bpf_int32 tv_usec;		/* microseconds */
120 };
121 
122 /*
123  * How a `pcap_pkthdr' is actually stored in the dumpfile.
124  *
125  * Do not change the format of this structure, in any way (this includes
126  * changes that only affect the length of fields in this structure),
127  * and do not make the time stamp anything other than seconds and
128  * microseconds (e.g., seconds and nanoseconds).  Instead:
129  *
130  *	introduce a new structure for the new format;
131  *
132  *	send mail to "tcpdump-workers@tcpdump.org", requesting a new
133  *	magic number for your new capture file format, and, when
134  *	you get the new magic number, put it in "savefile.c";
135  *
136  *	use that magic number for save files with the changed record
137  *	header;
138  *
139  *	make the code in "savefile.c" capable of reading files with
140  *	the old record header as well as files with the new record header
141  *	(using the magic number to determine the header format).
142  *
143  * Then supply the changes to "patches@tcpdump.org", so that future
144  * versions of libpcap and programs that use it (such as tcpdump) will
145  * be able to read your new capture file format.
146  */
147 
148 struct pcap_sf_pkthdr {
149     struct pcap_timeval ts;	/* time stamp */
150     bpf_u_int32 caplen;		/* length of portion present */
151     bpf_u_int32 len;		/* length this packet (off wire) */
152 };
153 
154 /*
155  * How a `pcap_pkthdr' is actually stored in dumpfiles written
156  * by some patched versions of libpcap (e.g. the ones in Red
157  * Hat Linux 6.1 and 6.2).
158  *
159  * Do not change the format of this structure, in any way (this includes
160  * changes that only affect the length of fields in this structure).
161  * Instead, introduce a new structure, as per the above.
162  */
163 
164 struct pcap_sf_patched_pkthdr {
165     struct pcap_timeval ts;	/* time stamp */
166     bpf_u_int32 caplen;		/* length of portion present */
167     bpf_u_int32 len;		/* length this packet (off wire) */
168     int		index;
169     unsigned short protocol;
170     unsigned char pkt_type;
171 };
172 
173 int	yylex(void);
174 
175 #ifndef min
176 #define min(a, b) ((a) > (b) ? (b) : (a))
177 #endif
178 
179 /* XXX should these be in pcap.h? */
180 int	pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
181 int	pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
182 
183 /*
184  * 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
185  * Tru64 UNIX, and NetBSD pad to make everything line up on a nice boundary.
186  */
187 #if defined(ultrix) || defined(__osf__) || defined(__NetBSD__)
188 #define       PCAP_FDDIPAD 3
189 #endif
190 
191 #ifndef HAVE_STRLCPY
192 #define strlcpy(x, y, z) \
193 	(strncpy((x), (y), (z)), \
194 	 ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
195 	 strlen((y)))
196 #endif
197 
198 #ifdef linux
199 void	pcap_close_linux(pcap_t *);
200 #endif
201 
202 /* XXX */
203 extern	int pcap_fddipad;
204 
205 int	install_bpf_program(pcap_t *, struct bpf_program *);
206 
207 #ifdef __cplusplus
208 }
209 #endif
210 
211 #endif
212