xref: /openbsd/sys/net/bpf.h (revision d485f761)
1 /*	$OpenBSD: bpf.h,v 1.17 2001/10/02 18:04:35 deraadt Exp $	*/
2 /*	$NetBSD: bpf.h,v 1.15 1996/12/13 07:57:33 mikel Exp $	*/
3 
4 /*
5  * Copyright (c) 1990, 1991, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from the Stanford/CMU enet packet filter,
9  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
10  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
11  * Berkeley Laboratory.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. All advertising materials mentioning features or use of this software
22  *    must display the following acknowledgement:
23  *	This product includes software developed by the University of
24  *	California, Berkeley and its contributors.
25  * 4. Neither the name of the University nor the names of its contributors
26  *    may be used to endorse or promote products derived from this software
27  *    without specific prior written permission.
28  *
29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39  * SUCH DAMAGE.
40  *
41  *	@(#)bpf.h	8.1 (Berkeley) 6/10/93
42  */
43 
44 #ifndef _NET_BPF_H_
45 #define _NET_BPF_H_
46 
47 /* BSD style release date */
48 #define BPF_RELEASE 199606
49 
50 typedef	int32_t	bpf_int32;
51 typedef u_int32_t	bpf_u_int32;
52 /*
53  * Alignment macros.  BPF_WORDALIGN rounds up to the next even multiple of
54  * BPF_ALIGNMENT (which is at least as much as what a timeval needs).
55  */
56 #define BPF_ALIGNMENT sizeof(long)
57 #define BPF_WORDALIGN(x) (((x) + (BPF_ALIGNMENT - 1)) & ~(BPF_ALIGNMENT - 1))
58 
59 #define BPF_MAXINSNS 512
60 #define BPF_MAXBUFSIZE 0x80000
61 #define BPF_MINBUFSIZE 32
62 
63 /*
64  *  Structure for BIOCSETF.
65  */
66 struct bpf_program {
67 	u_int bf_len;
68 	struct bpf_insn *bf_insns;
69 };
70 
71 /*
72  * Struct returned by BIOCGSTATS.
73  */
74 struct bpf_stat {
75 	u_int bs_recv;		/* number of packets received */
76 	u_int bs_drop;		/* number of packets dropped */
77 };
78 
79 /*
80  * Struct return by BIOCVERSION.  This represents the version number of
81  * the filter language described by the instruction encodings below.
82  * bpf understands a program iff kernel_major == filter_major &&
83  * kernel_minor >= filter_minor, that is, if the value returned by the
84  * running kernel has the same major number and a minor number equal
85  * equal to or less than the filter being downloaded.  Otherwise, the
86  * results are undefined, meaning an error may be returned or packets
87  * may be accepted haphazardly.
88  * It has nothing to do with the source code version.
89  */
90 struct bpf_version {
91 	u_short bv_major;
92 	u_short bv_minor;
93 };
94 /* Current version number of filter architecture. */
95 #define BPF_MAJOR_VERSION 1
96 #define BPF_MINOR_VERSION 1
97 
98 /*
99  * BPF ioctls
100  */
101 #define	BIOCGBLEN	_IOR('B',102, u_int)
102 #define	BIOCSBLEN	_IOWR('B',102, u_int)
103 #define	BIOCSETF	_IOW('B',103, struct bpf_program)
104 #define	BIOCFLUSH	_IO('B',104)
105 #define BIOCPROMISC	_IO('B',105)
106 #define	BIOCGDLT	_IOR('B',106, u_int)
107 #define BIOCGETIF	_IOR('B',107, struct ifreq)
108 #define BIOCSETIF	_IOW('B',108, struct ifreq)
109 #define BIOCSRTIMEOUT	_IOW('B',109, struct timeval)
110 #define BIOCGRTIMEOUT	_IOR('B',110, struct timeval)
111 #define BIOCGSTATS	_IOR('B',111, struct bpf_stat)
112 #define BIOCIMMEDIATE	_IOW('B',112, u_int)
113 #define BIOCVERSION	_IOR('B',113, struct bpf_version)
114 #define BIOCSRSIG	_IOW('B',114, u_int)
115 #define BIOCGRSIG	_IOR('B',115, u_int)
116 #define BIOCGHDRCMPLT	_IOR('B',116, u_int)
117 #define BIOCSHDRCMPLT	_IOW('B',117, u_int)
118 
119 struct bpf_timeval {
120 	u_int32_t	tv_sec;
121 	u_int32_t	tv_usec;
122 };
123 
124 /*
125  * Structure prepended to each packet.
126  */
127 struct bpf_hdr {
128 	struct bpf_timeval bh_tstamp;	/* time stamp */
129 	u_int32_t	bh_caplen;	/* length of captured portion */
130 	u_int32_t	bh_datalen;	/* original length of packet */
131 	u_int16_t	bh_hdrlen;	/* length of bpf header (this struct
132 					   plus alignment padding) */
133 };
134 /*
135  * Because the structure above is not a multiple of 4 bytes, some compilers
136  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
137  * Only the kernel needs to know about it; applications use bh_hdrlen.
138  * XXX To save a few bytes on 32-bit machines, we avoid end-of-struct
139  * XXX padding by using the size of the header data elements.  This is
140  * XXX fail-safe: on new machines, we just use the 'safe' sizeof.
141  */
142 #ifdef _KERNEL
143 #if defined(__arm32__) || defined(__i386__) || defined(__m68k__) || \
144     defined(__mips__) || defined(__ns32k__) || defined(__sparc__) || \
145     defined(__vax__)
146 #define SIZEOF_BPF_HDR 18
147 #else
148 #define SIZEOF_BPF_HDR sizeof(struct bpf_hdr)
149 #endif
150 #endif
151 
152 /*
153  * Data-link level type codes.
154  */
155 #define DLT_NULL	0	/* no link-layer encapsulation */
156 #define DLT_EN10MB	1	/* Ethernet (10Mb) */
157 #define DLT_EN3MB	2	/* Experimental Ethernet (3Mb) */
158 #define DLT_AX25	3	/* Amateur Radio AX.25 */
159 #define DLT_PRONET	4	/* Proteon ProNET Token Ring */
160 #define DLT_CHAOS	5	/* Chaos */
161 #define DLT_IEEE802	6	/* IEEE 802 Networks */
162 #define DLT_ARCNET	7	/* ARCNET */
163 #define DLT_SLIP	8	/* Serial Line IP */
164 #define DLT_PPP		9	/* Point-to-point Protocol */
165 #define DLT_FDDI	10	/* FDDI */
166 #define DLT_ATM_RFC1483	11	/* LLC/SNAP encapsulated atm */
167 #define DLT_LOOP	12	/* loopback type (af header) */
168 #define DLT_ENC		13	/* IPSEC enc type (af header, spi, flags) */
169 #define DLT_RAW		14	/* raw IP */
170 #define DLT_SLIP_BSDOS	15	/* BSD/OS Serial Line IP */
171 #define DLT_PPP_BSDOS	16	/* BSD/OS Point-to-point Protocol */
172 #define DLT_PFLOG	17	/* Packet filter logging */
173 
174 /*
175  * The instruction encodings.
176  */
177 /* instruction classes */
178 #define BPF_CLASS(code) ((code) & 0x07)
179 #define		BPF_LD		0x00
180 #define		BPF_LDX		0x01
181 #define		BPF_ST		0x02
182 #define		BPF_STX		0x03
183 #define		BPF_ALU		0x04
184 #define		BPF_JMP		0x05
185 #define		BPF_RET		0x06
186 #define		BPF_MISC	0x07
187 
188 /* ld/ldx fields */
189 #define BPF_SIZE(code)	((code) & 0x18)
190 #define		BPF_W		0x00
191 #define		BPF_H		0x08
192 #define		BPF_B		0x10
193 #define BPF_MODE(code)	((code) & 0xe0)
194 #define		BPF_IMM 	0x00
195 #define		BPF_ABS		0x20
196 #define		BPF_IND		0x40
197 #define		BPF_MEM		0x60
198 #define		BPF_LEN		0x80
199 #define		BPF_MSH		0xa0
200 
201 /* alu/jmp fields */
202 #define BPF_OP(code)	((code) & 0xf0)
203 #define		BPF_ADD		0x00
204 #define		BPF_SUB		0x10
205 #define		BPF_MUL		0x20
206 #define		BPF_DIV		0x30
207 #define		BPF_OR		0x40
208 #define		BPF_AND		0x50
209 #define		BPF_LSH		0x60
210 #define		BPF_RSH		0x70
211 #define		BPF_NEG		0x80
212 #define		BPF_JA		0x00
213 #define		BPF_JEQ		0x10
214 #define		BPF_JGT		0x20
215 #define		BPF_JGE		0x30
216 #define		BPF_JSET	0x40
217 #define BPF_SRC(code)	((code) & 0x08)
218 #define		BPF_K		0x00
219 #define		BPF_X		0x08
220 
221 /* ret - BPF_K and BPF_X also apply */
222 #define BPF_RVAL(code)	((code) & 0x18)
223 #define		BPF_A		0x10
224 
225 /* misc */
226 #define BPF_MISCOP(code) ((code) & 0xf8)
227 #define		BPF_TAX		0x00
228 #define		BPF_TXA		0x80
229 
230 /*
231  * The instruction data structure.
232  */
233 struct bpf_insn {
234 	u_int16_t code;
235 	u_char 	  jt;
236 	u_char 	  jf;
237 	int32_t	  k;
238 };
239 
240 /*
241  * Macros for insn array initializers.
242  */
243 #define BPF_STMT(code, k) { (u_int16_t)(code), 0, 0, k }
244 #define BPF_JUMP(code, k, jt, jf) { (u_int16_t)(code), jt, jf, k }
245 
246 #ifdef _KERNEL
247 int	 bpf_validate __P((struct bpf_insn *, int));
248 void	 bpf_tap __P((caddr_t, u_char *, u_int));
249 void	 bpf_mtap __P((caddr_t, struct mbuf *));
250 void	 bpfattach __P((caddr_t *, struct ifnet *, u_int, u_int));
251 void	 bpfdetach __P((struct ifnet *));
252 void	 bpfilterattach __P((int));
253 u_int	 bpf_filter __P((struct bpf_insn *, u_char *, u_int, u_int));
254 #endif /* _KERNEL */
255 
256 /*
257  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
258  */
259 #define BPF_MEMWORDS 16
260 
261 extern int ticks;	/* from kern/kern_clock.c; incremented each */
262 			/* clock tick. */
263 
264 #endif /* _NET_BPF_H_ */
265