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