xref: /dragonfly/sys/net/bpf.h (revision 62f7f702)
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.12 2008/03/14 09:52:10 matthias Exp $
43  */
44 
45 #ifndef _NET_BPF_H_
46 #define _NET_BPF_H_
47 
48 #ifndef _SYS_TYPES_H_
49 #include <sys/types.h>
50 #endif
51 #ifndef _SYS_TIME_H_
52 #include <sys/time.h>
53 #endif
54 
55 /* BSD style release date */
56 #define	BPF_RELEASE 199606
57 
58 typedef	int32_t	  bpf_int32;
59 typedef	u_int32_t bpf_u_int32;
60 
61 /*
62  * Alignment macros.  BPF_WORDALIGN rounds up to the next
63  * even multiple of BPF_ALIGNMENT.
64  */
65 #define BPF_ALIGNMENT sizeof(long)
66 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
67 
68 #define BPF_MAXINSNS 512
69 #define BPF_MAXBUFSIZE 0x80000
70 #define BPF_DEFAULTBUFSIZE 4096
71 #define BPF_MINBUFSIZE 32
72 
73 /*
74  *  Structure for BIOCSETF.
75  */
76 struct bpf_program {
77 	u_int bf_len;
78 	struct bpf_insn *bf_insns;
79 };
80 
81 /*
82  * Struct returned by BIOCGSTATS.
83  */
84 struct bpf_stat {
85 	u_int bs_recv;		/* number of packets received */
86 	u_int bs_drop;		/* number of packets dropped */
87 };
88 
89 /*
90  * Struct return by BIOCVERSION.  This represents the version number of
91  * the filter language described by the instruction encodings below.
92  * bpf understands a program iff kernel_major == filter_major &&
93  * kernel_minor >= filter_minor, that is, if the value returned by the
94  * running kernel has the same major number and a minor number equal
95  * equal to or less than the filter being downloaded.  Otherwise, the
96  * results are undefined, meaning an error may be returned or packets
97  * may be accepted haphazardly.
98  * It has nothing to do with the source code version.
99  */
100 struct bpf_version {
101 	u_short bv_major;
102 	u_short bv_minor;
103 };
104 /* Current version number of filter architecture. */
105 #define BPF_MAJOR_VERSION 1
106 #define BPF_MINOR_VERSION 1
107 
108 #define	BIOCGBLEN	_IOR('B',102, u_int)
109 #define	BIOCSBLEN	_IOWR('B',102, u_int)
110 #define	BIOCSETF	_IOW('B',103, struct bpf_program)
111 #define	BIOCFLUSH	_IO('B',104)
112 #define BIOCPROMISC	_IO('B',105)
113 #define	BIOCGDLT	_IOR('B',106, u_int)
114 #define BIOCGETIF	_IOR('B',107, struct ifreq)
115 #define BIOCSETIF	_IOW('B',108, struct ifreq)
116 #define BIOCSRTIMEOUT	_IOW('B',109, struct timeval)
117 #define BIOCGRTIMEOUT	_IOR('B',110, struct timeval)
118 #define BIOCGSTATS	_IOR('B',111, struct bpf_stat)
119 #define BIOCIMMEDIATE	_IOW('B',112, u_int)
120 #define BIOCVERSION	_IOR('B',113, struct bpf_version)
121 #define BIOCGRSIG	_IOR('B',114, u_int)
122 #define BIOCSRSIG	_IOW('B',115, u_int)
123 #define BIOCGHDRCMPLT	_IOR('B',116, u_int)
124 #define BIOCSHDRCMPLT	_IOW('B',117, u_int)
125 #define BIOCGSEESENT	_IOR('B',118, u_int)
126 #define BIOCSSEESENT	_IOW('B',119, u_int)
127 #define	BIOCSDLT	_IOW('B',120, u_int)
128 #define	BIOCGDLTLIST	_IOWR('B',121, struct bpf_dltlist)
129 #define	BIOCLOCK	_IO('B', 122)
130 #define	BIOCSETWF	_IOW('B',123, struct bpf_program)
131 
132 /*
133  * Structure prepended to each packet.
134  */
135 struct bpf_hdr {
136 	struct timeval	bh_tstamp;	/* time stamp */
137 	bpf_u_int32	bh_caplen;	/* length of captured portion */
138 	bpf_u_int32	bh_datalen;	/* original length of packet */
139 	u_short		bh_hdrlen;	/* length of bpf header (this struct
140 					   plus alignment padding) */
141 };
142 /*
143  * Because the structure above is not a multiple of 4 bytes, some compilers
144  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
145  * Only the kernel needs to know about it; applications use bh_hdrlen.
146  */
147 #ifdef _KERNEL
148 #define	SIZEOF_BPF_HDR	(sizeof(struct bpf_hdr) <= 20 ? 18 : \
149     sizeof(struct bpf_hdr))
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_RAW		12	/* raw IP */
168 
169 /*
170  * These are values from BSD/OS's "bpf.h".
171  * These are not the same as the values from the traditional libpcap
172  * "bpf.h"; however, these values shouldn't be generated by any
173  * OS other than BSD/OS, so the correct values to use here are the
174  * BSD/OS values.
175  *
176  * Platforms that have already assigned these values to other
177  * DLT_ codes, however, should give these codes the values
178  * from that platform, so that programs that use these codes will
179  * continue to compile - even though they won't correctly read
180  * files of these types.
181  */
182 #define DLT_SLIP_BSDOS	15	/* BSD/OS Serial Line IP */
183 #define DLT_PPP_BSDOS	16	/* BSD/OS Point-to-point Protocol */
184 
185 #define DLT_ATM_CLIP	19	/* Linux Classical-IP over ATM */
186 
187 /*
188  * These values are defined by NetBSD; other platforms should refrain from
189  * using them for other purposes, so that NetBSD savefiles with link
190  * types of 50 or 51 can be read as this type on all platforms.
191  */
192 #define DLT_PPP_SERIAL	50	/* PPP over serial with HDLC encapsulation */
193 #define DLT_PPP_ETHER	51	/* PPP over Ethernet */
194 
195 /*
196  * This value was defined by libpcap 0.5; platforms that have defined
197  * it with a different value should define it here with that value -
198  * a link type of 104 in a save file will be mapped to DLT_C_HDLC,
199  * whatever value that happens to be, so programs will correctly
200  * handle files with that link type regardless of the value of
201  * DLT_C_HDLC.
202  *
203  * The name DLT_C_HDLC was used by BSD/OS; we use that name for source
204  * compatibility with programs written for BSD/OS.
205  *
206  * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well,
207  * for source compatibility with programs written for libpcap 0.5.
208  */
209 #define DLT_C_HDLC	104	/* Cisco HDLC */
210 #define DLT_CHDLC	DLT_C_HDLC
211 
212 #define DLT_IEEE802_11	105	/* IEEE 802.11 wireless */
213 
214 /*
215  * Values between 106 and 107 are used in capture file headers as
216  * link-layer types corresponding to DLT_ types that might differ
217  * between platforms; don't use those values for new DLT_ new types.
218  */
219 
220 /*
221  * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except
222  * that the AF_ type in the link-layer header is in network byte order.
223  *
224  * OpenBSD defines it as 12, but that collides with DLT_RAW, so we
225  * define it as 108 here.  If OpenBSD picks up this file, it should
226  * define DLT_LOOP as 12 in its version, as per the comment above -
227  * and should not use 108 as a DLT_ value.
228  */
229 #define DLT_LOOP	108
230 
231 /*
232  * Values between 109 and 112 are used in capture file headers as
233  * link-layer types corresponding to DLT_ types that might differ
234  * between platforms; don't use those values for new DLT_ new types.
235  */
236 
237 /*
238  * This is for Linux cooked sockets.
239  */
240 #define DLT_LINUX_SLL	113
241 
242 /*
243  * Apple LocalTalk hardware.
244  */
245 #define DLT_LTALK	114
246 
247 /*
248  * Acorn Econet.
249  */
250 #define DLT_ECONET	115
251 
252 /*
253  * Reserved for use with OpenBSD ipfilter.
254  */
255 #define DLT_IPFILTER	116
256 
257 /*
258  * Reserved for use in capture-file headers as a link-layer type
259  * corresponding to OpenBSD DLT_PFLOG; DLT_PFLOG is 17 in OpenBSD,
260  * but that's DLT_LANE8023 in SuSE 6.3, so we can't use 17 for it
261  * in capture-file headers.
262  */
263 #define DLT_PFLOG	117
264 
265 /*
266  * Registered for Cisco-internal use.
267  */
268 #define DLT_CISCO_IOS	118
269 
270 /*
271  * Reserved for 802.11 cards using the Prism II chips, with a link-layer
272  * header including Prism monitor mode information plus an 802.11
273  * header.
274  */
275 #define DLT_PRISM_HEADER	119
276 
277 /*
278  * Reserved for Aironet 802.11 cards, with an Aironet link-layer header
279  * (see Doug Ambrisko's FreeBSD patches).
280  */
281 #define DLT_AIRONET_HEADER	120
282 
283 /*
284  * Reserved for use by OpenBSD's pfsync device.
285  */
286 #define	DLT_PFSYNC	121
287 
288 /*
289  * The instruction encodings.
290  */
291 /* instruction classes */
292 #define BPF_CLASS(code) ((code) & 0x07)
293 #define		BPF_LD		0x00
294 #define		BPF_LDX		0x01
295 #define		BPF_ST		0x02
296 #define		BPF_STX		0x03
297 #define		BPF_ALU		0x04
298 #define		BPF_JMP		0x05
299 #define		BPF_RET		0x06
300 #define		BPF_MISC	0x07
301 
302 /* ld/ldx fields */
303 #define BPF_SIZE(code)	((code) & 0x18)
304 #define		BPF_W		0x00
305 #define		BPF_H		0x08
306 #define		BPF_B		0x10
307 #define BPF_MODE(code)	((code) & 0xe0)
308 #define		BPF_IMM		0x00
309 #define		BPF_ABS		0x20
310 #define		BPF_IND		0x40
311 #define		BPF_MEM		0x60
312 #define		BPF_LEN		0x80
313 #define		BPF_MSH		0xa0
314 
315 /* alu/jmp fields */
316 #define BPF_OP(code)	((code) & 0xf0)
317 #define		BPF_ADD		0x00
318 #define		BPF_SUB		0x10
319 #define		BPF_MUL		0x20
320 #define		BPF_DIV		0x30
321 #define		BPF_OR		0x40
322 #define		BPF_AND		0x50
323 #define		BPF_LSH		0x60
324 #define		BPF_RSH		0x70
325 #define		BPF_NEG		0x80
326 #define		BPF_JA		0x00
327 #define		BPF_JEQ		0x10
328 #define		BPF_JGT		0x20
329 #define		BPF_JGE		0x30
330 #define		BPF_JSET	0x40
331 #define BPF_SRC(code)	((code) & 0x08)
332 #define		BPF_K		0x00
333 #define		BPF_X		0x08
334 
335 /* ret - BPF_K and BPF_X also apply */
336 #define BPF_RVAL(code)	((code) & 0x18)
337 #define		BPF_A		0x10
338 
339 /* misc */
340 #define BPF_MISCOP(code) ((code) & 0xf8)
341 #define		BPF_TAX		0x00
342 #define		BPF_TXA		0x80
343 
344 /*
345  * The instruction data structure.
346  */
347 struct bpf_insn {
348 	u_short		code;
349 	u_char		jt;
350 	u_char		jf;
351 	bpf_u_int32	k;
352 };
353 
354 /*
355  * Macros for insn array initializers.
356  */
357 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
358 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
359 
360 /*
361  * Structure to retrieve available DLTs for the interface.
362  */
363 struct bpf_dltlist {
364 	u_int	bfl_len;	/* number of bfd_list array */
365 	u_int	*bfl_list;	/* array of DLTs */
366 };
367 
368 #ifdef _KERNEL
369 struct bpf_if;
370 struct ifnet;
371 struct mbuf;
372 
373 int	 bpf_validate(const struct bpf_insn *, int);
374 void	 bpf_tap(struct bpf_if *, u_char *, u_int);
375 void	 bpf_mtap(struct bpf_if *, struct mbuf *);
376 void	 bpf_mtap_family(struct bpf_if *, struct mbuf *m, __uint8_t family);
377 void	 bpf_ptap(struct bpf_if *, struct mbuf *, const void *, u_int);
378 void	 bpfattach(struct ifnet *, u_int, u_int);
379 void	 bpfattach_dlt(struct ifnet *, u_int, u_int, struct bpf_if **);
380 void	 bpfdetach(struct ifnet *);
381 
382 void	 bpfilterattach(int);
383 u_int	 bpf_filter(const struct bpf_insn *, u_char *, u_int, u_int);
384 
385 #define	BPF_TAP(_ifp,_pkt,_pktlen) do {				\
386 	if ((_ifp)->if_bpf)					\
387 		bpf_tap((_ifp)->if_bpf, (_pkt), (_pktlen));	\
388 } while (0)
389 #define	BPF_MTAP(_ifp,_m) do {					\
390 	if ((_ifp)->if_bpf)					\
391 		bpf_mtap((_ifp)->if_bpf, (_m));			\
392 } while (0)
393 #endif
394 
395 /*
396  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
397  */
398 #define BPF_MEMWORDS 16
399 
400 #endif
401