xref: /dragonfly/sys/net/bpf.h (revision 1de703da)
1 /*
2  * Copyright (c) 1990, 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from the Stanford/CMU enet packet filter,
6  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
7  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
8  * Berkeley Laboratory.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *      @(#)bpf.h	8.1 (Berkeley) 6/10/93
39  *	@(#)bpf.h	1.34 (LBL)     6/16/96
40  *
41  * $FreeBSD: src/sys/net/bpf.h,v 1.21.2.4 2002/07/05 14:40:00 fenner Exp $
42  * $DragonFly: src/sys/net/bpf.h,v 1.2 2003/06/17 04:28:47 dillon Exp $
43  */
44 
45 #ifndef _NET_BPF_H_
46 #define _NET_BPF_H_
47 
48 /* BSD style release date */
49 #define	BPF_RELEASE 199606
50 
51 typedef	int32_t	  bpf_int32;
52 typedef	u_int32_t bpf_u_int32;
53 
54 /*
55  * Alignment macros.  BPF_WORDALIGN rounds up to the next
56  * even multiple of BPF_ALIGNMENT.
57  */
58 #define BPF_ALIGNMENT sizeof(long)
59 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
60 
61 #define BPF_MAXINSNS 512
62 #define BPF_MAXBUFSIZE 0x80000
63 #define BPF_MINBUFSIZE 32
64 
65 /*
66  *  Structure for BIOCSETF.
67  */
68 struct bpf_program {
69 	u_int bf_len;
70 	struct bpf_insn *bf_insns;
71 };
72 
73 /*
74  * Struct returned by BIOCGSTATS.
75  */
76 struct bpf_stat {
77 	u_int bs_recv;		/* number of packets received */
78 	u_int bs_drop;		/* number of packets dropped */
79 };
80 
81 /*
82  * Struct return by BIOCVERSION.  This represents the version number of
83  * the filter language described by the instruction encodings below.
84  * bpf understands a program iff kernel_major == filter_major &&
85  * kernel_minor >= filter_minor, that is, if the value returned by the
86  * running kernel has the same major number and a minor number equal
87  * equal to or less than the filter being downloaded.  Otherwise, the
88  * results are undefined, meaning an error may be returned or packets
89  * may be accepted haphazardly.
90  * It has nothing to do with the source code version.
91  */
92 struct bpf_version {
93 	u_short bv_major;
94 	u_short bv_minor;
95 };
96 /* Current version number of filter architecture. */
97 #define BPF_MAJOR_VERSION 1
98 #define BPF_MINOR_VERSION 1
99 
100 #define	BIOCGBLEN	_IOR('B',102, u_int)
101 #define	BIOCSBLEN	_IOWR('B',102, u_int)
102 #define	BIOCSETF	_IOW('B',103, struct bpf_program)
103 #define	BIOCFLUSH	_IO('B',104)
104 #define BIOCPROMISC	_IO('B',105)
105 #define	BIOCGDLT	_IOR('B',106, u_int)
106 #define BIOCGETIF	_IOR('B',107, struct ifreq)
107 #define BIOCSETIF	_IOW('B',108, struct ifreq)
108 #define BIOCSRTIMEOUT	_IOW('B',109, struct timeval)
109 #define BIOCGRTIMEOUT	_IOR('B',110, struct timeval)
110 #define BIOCGSTATS	_IOR('B',111, struct bpf_stat)
111 #define BIOCIMMEDIATE	_IOW('B',112, u_int)
112 #define BIOCVERSION	_IOR('B',113, struct bpf_version)
113 #define BIOCGRSIG	_IOR('B',114, u_int)
114 #define BIOCSRSIG	_IOW('B',115, u_int)
115 #define BIOCGHDRCMPLT	_IOR('B',116, u_int)
116 #define BIOCSHDRCMPLT	_IOW('B',117, u_int)
117 #define BIOCGSEESENT	_IOR('B',118, u_int)
118 #define BIOCSSEESENT	_IOW('B',119, u_int)
119 
120 /*
121  * Structure prepended to each packet.
122  */
123 struct bpf_hdr {
124 	struct timeval	bh_tstamp;	/* time stamp */
125 	bpf_u_int32	bh_caplen;	/* length of captured portion */
126 	bpf_u_int32	bh_datalen;	/* original length of packet */
127 	u_short		bh_hdrlen;	/* length of bpf header (this struct
128 					   plus alignment padding) */
129 };
130 /*
131  * Because the structure above is not a multiple of 4 bytes, some compilers
132  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
133  * Only the kernel needs to know about it; applications use bh_hdrlen.
134  */
135 #ifdef _KERNEL
136 #define	SIZEOF_BPF_HDR	(sizeof(struct bpf_hdr) <= 20 ? 18 : \
137     sizeof(struct bpf_hdr))
138 #endif
139 
140 /*
141  * Data-link level type codes.
142  */
143 #define DLT_NULL	0	/* no link-layer encapsulation */
144 #define DLT_EN10MB	1	/* Ethernet (10Mb) */
145 #define DLT_EN3MB	2	/* Experimental Ethernet (3Mb) */
146 #define DLT_AX25	3	/* Amateur Radio AX.25 */
147 #define DLT_PRONET	4	/* Proteon ProNET Token Ring */
148 #define DLT_CHAOS	5	/* Chaos */
149 #define DLT_IEEE802	6	/* IEEE 802 Networks */
150 #define DLT_ARCNET	7	/* ARCNET */
151 #define DLT_SLIP	8	/* Serial Line IP */
152 #define DLT_PPP		9	/* Point-to-point Protocol */
153 #define DLT_FDDI	10	/* FDDI */
154 #define DLT_ATM_RFC1483	11	/* LLC/SNAP encapsulated atm */
155 #define DLT_RAW		12	/* raw IP */
156 
157 /*
158  * These are values from BSD/OS's "bpf.h".
159  * These are not the same as the values from the traditional libpcap
160  * "bpf.h"; however, these values shouldn't be generated by any
161  * OS other than BSD/OS, so the correct values to use here are the
162  * BSD/OS values.
163  *
164  * Platforms that have already assigned these values to other
165  * DLT_ codes, however, should give these codes the values
166  * from that platform, so that programs that use these codes will
167  * continue to compile - even though they won't correctly read
168  * files of these types.
169  */
170 #define DLT_SLIP_BSDOS	15	/* BSD/OS Serial Line IP */
171 #define DLT_PPP_BSDOS	16	/* BSD/OS Point-to-point Protocol */
172 
173 #define DLT_ATM_CLIP	19	/* Linux Classical-IP over ATM */
174 
175 /*
176  * These values are defined by NetBSD; other platforms should refrain from
177  * using them for other purposes, so that NetBSD savefiles with link
178  * types of 50 or 51 can be read as this type on all platforms.
179  */
180 #define DLT_PPP_SERIAL	50	/* PPP over serial with HDLC encapsulation */
181 #define DLT_PPP_ETHER	51	/* PPP over Ethernet */
182 
183 /*
184  * This value was defined by libpcap 0.5; platforms that have defined
185  * it with a different value should define it here with that value -
186  * a link type of 104 in a save file will be mapped to DLT_C_HDLC,
187  * whatever value that happens to be, so programs will correctly
188  * handle files with that link type regardless of the value of
189  * DLT_C_HDLC.
190  *
191  * The name DLT_C_HDLC was used by BSD/OS; we use that name for source
192  * compatibility with programs written for BSD/OS.
193  *
194  * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well,
195  * for source compatibility with programs written for libpcap 0.5.
196  */
197 #define DLT_C_HDLC	104	/* Cisco HDLC */
198 #define DLT_CHDLC	DLT_C_HDLC
199 
200 #define DLT_IEEE802_11	105	/* IEEE 802.11 wireless */
201 
202 /*
203  * Values between 106 and 107 are used in capture file headers as
204  * link-layer types corresponding to DLT_ types that might differ
205  * between platforms; don't use those values for new DLT_ new types.
206  */
207 
208 /*
209  * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except
210  * that the AF_ type in the link-layer header is in network byte order.
211  *
212  * OpenBSD defines it as 12, but that collides with DLT_RAW, so we
213  * define it as 108 here.  If OpenBSD picks up this file, it should
214  * define DLT_LOOP as 12 in its version, as per the comment above -
215  * and should not use 108 as a DLT_ value.
216  */
217 #define DLT_LOOP	108
218 
219 /*
220  * Values between 109 and 112 are used in capture file headers as
221  * link-layer types corresponding to DLT_ types that might differ
222  * between platforms; don't use those values for new DLT_ new types.
223  */
224 
225 /*
226  * This is for Linux cooked sockets.
227  */
228 #define DLT_LINUX_SLL	113
229 
230 /*
231  * Apple LocalTalk hardware.
232  */
233 #define DLT_LTALK	114
234 
235 /*
236  * Acorn Econet.
237  */
238 #define DLT_ECONET	115
239 
240 /*
241  * Reserved for use with OpenBSD ipfilter.
242  */
243 #define DLT_IPFILTER	116
244 
245 /*
246  * Reserved for use in capture-file headers as a link-layer type
247  * corresponding to OpenBSD DLT_PFLOG; DLT_PFLOG is 17 in OpenBSD,
248  * but that's DLT_LANE8023 in SuSE 6.3, so we can't use 17 for it
249  * in capture-file headers.
250  */
251 #define DLT_PFLOG	117
252 
253 /*
254  * Registered for Cisco-internal use.
255  */
256 #define DLT_CISCO_IOS	118
257 
258 /*
259  * Reserved for 802.11 cards using the Prism II chips, with a link-layer
260  * header including Prism monitor mode information plus an 802.11
261  * header.
262  */
263 #define DLT_PRISM_HEADER	119
264 
265 /*
266  * Reserved for Aironet 802.11 cards, with an Aironet link-layer header
267  * (see Doug Ambrisko's FreeBSD patches).
268  */
269 #define DLT_AIRONET_HEADER	120
270 
271 /*
272  * The instruction encodings.
273  */
274 /* instruction classes */
275 #define BPF_CLASS(code) ((code) & 0x07)
276 #define		BPF_LD		0x00
277 #define		BPF_LDX		0x01
278 #define		BPF_ST		0x02
279 #define		BPF_STX		0x03
280 #define		BPF_ALU		0x04
281 #define		BPF_JMP		0x05
282 #define		BPF_RET		0x06
283 #define		BPF_MISC	0x07
284 
285 /* ld/ldx fields */
286 #define BPF_SIZE(code)	((code) & 0x18)
287 #define		BPF_W		0x00
288 #define		BPF_H		0x08
289 #define		BPF_B		0x10
290 #define BPF_MODE(code)	((code) & 0xe0)
291 #define		BPF_IMM 	0x00
292 #define		BPF_ABS		0x20
293 #define		BPF_IND		0x40
294 #define		BPF_MEM		0x60
295 #define		BPF_LEN		0x80
296 #define		BPF_MSH		0xa0
297 
298 /* alu/jmp fields */
299 #define BPF_OP(code)	((code) & 0xf0)
300 #define		BPF_ADD		0x00
301 #define		BPF_SUB		0x10
302 #define		BPF_MUL		0x20
303 #define		BPF_DIV		0x30
304 #define		BPF_OR		0x40
305 #define		BPF_AND		0x50
306 #define		BPF_LSH		0x60
307 #define		BPF_RSH		0x70
308 #define		BPF_NEG		0x80
309 #define		BPF_JA		0x00
310 #define		BPF_JEQ		0x10
311 #define		BPF_JGT		0x20
312 #define		BPF_JGE		0x30
313 #define		BPF_JSET	0x40
314 #define BPF_SRC(code)	((code) & 0x08)
315 #define		BPF_K		0x00
316 #define		BPF_X		0x08
317 
318 /* ret - BPF_K and BPF_X also apply */
319 #define BPF_RVAL(code)	((code) & 0x18)
320 #define		BPF_A		0x10
321 
322 /* misc */
323 #define BPF_MISCOP(code) ((code) & 0xf8)
324 #define		BPF_TAX		0x00
325 #define		BPF_TXA		0x80
326 
327 /*
328  * The instruction data structure.
329  */
330 struct bpf_insn {
331 	u_short		code;
332 	u_char		jt;
333 	u_char		jf;
334 	bpf_u_int32	k;
335 };
336 
337 /*
338  * Macros for insn array initializers.
339  */
340 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
341 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
342 
343 #ifdef _KERNEL
344 int	 bpf_validate __P((const struct bpf_insn *, int));
345 void	 bpf_tap __P((struct ifnet *, u_char *, u_int));
346 void	 bpf_mtap __P((struct ifnet *, struct mbuf *));
347 void	 bpfattach __P((struct ifnet *, u_int, u_int));
348 void	 bpfdetach __P((struct ifnet *));
349 
350 void	 bpfilterattach __P((int));
351 u_int	 bpf_filter __P((const struct bpf_insn *, u_char *, u_int, u_int));
352 #endif
353 
354 /*
355  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
356  */
357 #define BPF_MEMWORDS 16
358 
359 #endif
360