xref: /dragonfly/sys/net/bpf.h (revision 0ca59c34)
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  */
43 
44 #ifndef _NET_BPF_H_
45 #define _NET_BPF_H_
46 
47 #ifndef _SYS_PARAM_H_
48 #include <sys/param.h>
49 #endif
50 #ifndef _SYS_TIME_H_
51 #include <sys/time.h>
52 #endif
53 #ifndef _SYS_IOCCOM_H_
54 #include <sys/ioccom.h>
55 #endif
56 
57 __BEGIN_DECLS
58 
59 #define BPF_MAX_CLONES	128
60 
61 /* BSD style release date */
62 #define	BPF_RELEASE 199606
63 
64 typedef	int32_t	  bpf_int32;
65 typedef	u_int32_t bpf_u_int32;
66 
67 /*
68  * Alignment macros.  BPF_WORDALIGN rounds up to the next
69  * even multiple of BPF_ALIGNMENT.
70  */
71 #define BPF_ALIGNMENT sizeof(long)
72 #define BPF_WORDALIGN(x) roundup2(x, BPF_ALIGNMENT)
73 
74 #define BPF_MAXINSNS 512
75 #define BPF_MAXBUFSIZE 0x80000
76 #define BPF_DEFAULTBUFSIZE 4096
77 #define BPF_MINBUFSIZE 32
78 
79 /*
80  *  Structure for BIOCSETF.
81  */
82 struct bpf_program {
83 	u_int bf_len;
84 	struct bpf_insn *bf_insns;
85 };
86 
87 /*
88  * Struct returned by BIOCGSTATS.
89  */
90 struct bpf_stat {
91 	u_int bs_recv;		/* number of packets received */
92 	u_int bs_drop;		/* number of packets dropped */
93 };
94 
95 /*
96  * Struct return by BIOCVERSION.  This represents the version number of
97  * the filter language described by the instruction encodings below.
98  * bpf understands a program iff kernel_major == filter_major &&
99  * kernel_minor >= filter_minor, that is, if the value returned by the
100  * running kernel has the same major number and a minor number equal
101  * equal to or less than the filter being downloaded.  Otherwise, the
102  * results are undefined, meaning an error may be returned or packets
103  * may be accepted haphazardly.
104  * It has nothing to do with the source code version.
105  */
106 struct bpf_version {
107 	u_short bv_major;
108 	u_short bv_minor;
109 };
110 /* Current version number of filter architecture. */
111 #define BPF_MAJOR_VERSION 1
112 #define BPF_MINOR_VERSION 1
113 
114 #define	BIOCGBLEN	_IOR('B',102, u_int)
115 #define	BIOCSBLEN	_IOWR('B',102, u_int)
116 #define	BIOCSETF	_IOW('B',103, struct bpf_program)
117 #define	BIOCFLUSH	_IO('B',104)
118 #define BIOCPROMISC	_IO('B',105)
119 #define	BIOCGDLT	_IOR('B',106, u_int)
120 #define BIOCGETIF	_IOR('B',107, struct ifreq)
121 #define BIOCSETIF	_IOW('B',108, struct ifreq)
122 #define BIOCSRTIMEOUT	_IOW('B',109, struct timeval)
123 #define BIOCGRTIMEOUT	_IOR('B',110, struct timeval)
124 #define BIOCGSTATS	_IOR('B',111, struct bpf_stat)
125 #define BIOCIMMEDIATE	_IOW('B',112, u_int)
126 #define BIOCVERSION	_IOR('B',113, struct bpf_version)
127 #define BIOCGRSIG	_IOR('B',114, u_int)
128 #define BIOCSRSIG	_IOW('B',115, u_int)
129 #define BIOCGHDRCMPLT	_IOR('B',116, u_int)
130 #define BIOCSHDRCMPLT	_IOW('B',117, u_int)
131 #define BIOCGSEESENT	_IOR('B',118, u_int)
132 #define BIOCSSEESENT	_IOW('B',119, u_int)
133 #define	BIOCSDLT	_IOW('B',120, u_int)
134 #define	BIOCGDLTLIST	_IOWR('B',121, struct bpf_dltlist)
135 #define	BIOCLOCK	_IO('B', 122)
136 #define	BIOCSETWF	_IOW('B',123, struct bpf_program)
137 
138 /*
139  * Structure prepended to each packet.
140  */
141 struct bpf_hdr {
142 	struct timeval	bh_tstamp;	/* time stamp */
143 	bpf_u_int32	bh_caplen;	/* length of captured portion */
144 	bpf_u_int32	bh_datalen;	/* original length of packet */
145 	u_short		bh_hdrlen;	/* length of bpf header (this struct
146 					   plus alignment padding) */
147 };
148 /*
149  * Because the structure above is not a multiple of 4 bytes, some compilers
150  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
151  * Only the kernel needs to know about it; applications use bh_hdrlen.
152  */
153 #ifdef _KERNEL
154 #define	SIZEOF_BPF_HDR	(sizeof(struct bpf_hdr) <= 20 ? 18 : \
155     sizeof(struct bpf_hdr))
156 #endif
157 
158 #ifndef _NET_DLT_H
159 #include <net/dlt.h>
160 #endif
161 
162 /*
163  * The instruction encodings.
164  */
165 /* instruction classes */
166 #define BPF_CLASS(code) ((code) & 0x07)
167 #define		BPF_LD		0x00
168 #define		BPF_LDX		0x01
169 #define		BPF_ST		0x02
170 #define		BPF_STX		0x03
171 #define		BPF_ALU		0x04
172 #define		BPF_JMP		0x05
173 #define		BPF_RET		0x06
174 #define		BPF_MISC	0x07
175 
176 /* ld/ldx fields */
177 #define BPF_SIZE(code)	((code) & 0x18)
178 #define		BPF_W		0x00
179 #define		BPF_H		0x08
180 #define		BPF_B		0x10
181 #define BPF_MODE(code)	((code) & 0xe0)
182 #define		BPF_IMM		0x00
183 #define		BPF_ABS		0x20
184 #define		BPF_IND		0x40
185 #define		BPF_MEM		0x60
186 #define		BPF_LEN		0x80
187 #define		BPF_MSH		0xa0
188 
189 /* alu/jmp fields */
190 #define BPF_OP(code)	((code) & 0xf0)
191 #define		BPF_ADD		0x00
192 #define		BPF_SUB		0x10
193 #define		BPF_MUL		0x20
194 #define		BPF_DIV		0x30
195 #define		BPF_OR		0x40
196 #define		BPF_AND		0x50
197 #define		BPF_LSH		0x60
198 #define		BPF_RSH		0x70
199 #define		BPF_NEG		0x80
200 #define		BPF_JA		0x00
201 #define		BPF_JEQ		0x10
202 #define		BPF_JGT		0x20
203 #define		BPF_JGE		0x30
204 #define		BPF_JSET	0x40
205 #define BPF_SRC(code)	((code) & 0x08)
206 #define		BPF_K		0x00
207 #define		BPF_X		0x08
208 
209 /* ret - BPF_K and BPF_X also apply */
210 #define BPF_RVAL(code)	((code) & 0x18)
211 #define		BPF_A		0x10
212 
213 /* misc */
214 #define BPF_MISCOP(code) ((code) & 0xf8)
215 #define		BPF_TAX		0x00
216 #define		BPF_TXA		0x80
217 
218 /*
219  * The instruction data structure.
220  */
221 struct bpf_insn {
222 	u_short		code;
223 	u_char		jt;
224 	u_char		jf;
225 	bpf_u_int32	k;
226 };
227 
228 /*
229  * Macros for insn array initializers.
230  */
231 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
232 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
233 
234 /*
235  * Structure to retrieve available DLTs for the interface.
236  */
237 struct bpf_dltlist {
238 	u_int	bfl_len;	/* number of bfd_list array */
239 	u_int	*bfl_list;	/* array of DLTs */
240 };
241 
242 #ifdef _KERNEL
243 
244 struct bpf_if;
245 struct ifnet;
246 struct mbuf;
247 
248 int	 bpf_validate(const struct bpf_insn *, int);
249 void	 bpf_tap(struct bpf_if *, u_char *, u_int);
250 void	 bpf_mtap(struct bpf_if *, struct mbuf *);
251 void	 bpf_mtap_family(struct bpf_if *, struct mbuf *m, __uint8_t family);
252 void	 bpf_mtap_hdr(struct bpf_if *, caddr_t, u_int, struct mbuf *, u_int);
253 void	 bpf_ptap(struct bpf_if *, struct mbuf *, const void *, u_int);
254 void	 bpfattach(struct ifnet *, u_int, u_int);
255 void	 bpfattach_dlt(struct ifnet *, u_int, u_int, struct bpf_if **);
256 void	 bpfdetach(struct ifnet *);
257 void	 bpf_gettoken(void);
258 void	 bpf_reltoken(void);
259 
260 u_int	 bpf_filter(const struct bpf_insn *, u_char *, u_int, u_int);
261 
262 #define	BPF_TAP(_ifp,_pkt,_pktlen) do {					\
263 	if ((_ifp)->if_bpf) {						\
264 		bpf_gettoken();						\
265 		if ((_ifp)->if_bpf)					\
266 			bpf_tap((_ifp)->if_bpf, (_pkt), (_pktlen));	\
267 		bpf_reltoken();						\
268 	}								\
269 } while (0)
270 
271 #define	BPF_MTAP(_ifp,_m) do {						\
272 	if ((_ifp)->if_bpf) {						\
273 		bpf_gettoken();						\
274 		if ((_ifp)->if_bpf)					\
275 			bpf_mtap((_ifp)->if_bpf, (_m));                 \
276 		bpf_reltoken();						\
277 	}								\
278 } while (0)
279 
280 #endif	/* _KERNEL */
281 
282 /*
283  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
284  */
285 #define BPF_MEMWORDS 16
286 
287 __END_DECLS
288 
289 #endif	/* !_NET_BPF_H_ */
290