xref: /freebsd/sys/net/bpf.h (revision d2387d42b8da231a5b95cbc313825fb2aadf26f6)
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$
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 /*
54  * Alignment macros.  BPF_WORDALIGN rounds up to the next
55  * even multiple of BPF_ALIGNMENT.
56  */
57 #define BPF_ALIGNMENT sizeof(long)
58 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
59 
60 #define BPF_MAXINSNS 512
61 #define BPF_MAXBUFSIZE 0x80000
62 #define BPF_MINBUFSIZE 32
63 
64 /*
65  *  Structure for BIOCSETF.
66  */
67 struct bpf_program {
68 	u_int bf_len;
69 	struct bpf_insn *bf_insns;
70 };
71 
72 /*
73  * Struct returned by BIOCGSTATS.
74  */
75 struct bpf_stat {
76 	u_int bs_recv;		/* number of packets received */
77 	u_int bs_drop;		/* number of packets dropped */
78 };
79 
80 /*
81  * Struct return by BIOCVERSION.  This represents the version number of
82  * the filter language described by the instruction encodings below.
83  * bpf understands a program iff kernel_major == filter_major &&
84  * kernel_minor >= filter_minor, that is, if the value returned by the
85  * running kernel has the same major number and a minor number equal
86  * equal to or less than the filter being downloaded.  Otherwise, the
87  * results are undefined, meaning an error may be returned or packets
88  * may be accepted haphazardly.
89  * It has nothing to do with the source code version.
90  */
91 struct bpf_version {
92 	u_short bv_major;
93 	u_short bv_minor;
94 };
95 /* Current version number of filter architecture. */
96 #define BPF_MAJOR_VERSION 1
97 #define BPF_MINOR_VERSION 1
98 
99 #define	BIOCGBLEN	_IOR('B',102, u_int)
100 #define	BIOCSBLEN	_IOWR('B',102, u_int)
101 #define	BIOCSETF	_IOW('B',103, struct bpf_program)
102 #define	BIOCFLUSH	_IO('B',104)
103 #define BIOCPROMISC	_IO('B',105)
104 #define	BIOCGDLT	_IOR('B',106, u_int)
105 #define BIOCGETIF	_IOR('B',107, struct ifreq)
106 #define BIOCSETIF	_IOW('B',108, struct ifreq)
107 #define BIOCSRTIMEOUT	_IOW('B',109, struct timeval)
108 #define BIOCGRTIMEOUT	_IOR('B',110, struct timeval)
109 #define BIOCGSTATS	_IOR('B',111, struct bpf_stat)
110 #define BIOCIMMEDIATE	_IOW('B',112, u_int)
111 #define BIOCVERSION	_IOR('B',113, struct bpf_version)
112 #define BIOCGRSIG	_IOR('B',114, u_int)
113 #define BIOCSRSIG	_IOW('B',115, u_int)
114 #define BIOCGHDRCMPLT	_IOR('B',116, u_int)
115 #define BIOCSHDRCMPLT	_IOW('B',117, u_int)
116 #define BIOCGSEESENT	_IOR('B',118, u_int)
117 #define BIOCSSEESENT	_IOW('B',119, u_int)
118 #define	BIOCSDLT	_IOW('B',120, u_int)
119 #define	BIOCGDLTLIST	_IOWR('B',121, struct bpf_dltlist)
120 
121 /*
122  * Structure prepended to each packet.
123  */
124 struct bpf_hdr {
125 	struct timeval	bh_tstamp;	/* time stamp */
126 	bpf_u_int32	bh_caplen;	/* length of captured portion */
127 	bpf_u_int32	bh_datalen;	/* original length of packet */
128 	u_short		bh_hdrlen;	/* length of bpf header (this struct
129 					   plus alignment padding) */
130 };
131 /*
132  * Because the structure above is not a multiple of 4 bytes, some compilers
133  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
134  * Only the kernel needs to know about it; applications use bh_hdrlen.
135  */
136 #ifdef _KERNEL
137 #define	SIZEOF_BPF_HDR	(sizeof(struct bpf_hdr) <= 20 ? 18 : \
138     sizeof(struct bpf_hdr))
139 #endif
140 
141 /*
142  * Data-link level type codes.
143  */
144 #define DLT_NULL	0	/* no link-layer encapsulation */
145 #define DLT_EN10MB	1	/* Ethernet (10Mb) */
146 #define DLT_EN3MB	2	/* Experimental Ethernet (3Mb) */
147 #define DLT_AX25	3	/* Amateur Radio AX.25 */
148 #define DLT_PRONET	4	/* Proteon ProNET Token Ring */
149 #define DLT_CHAOS	5	/* Chaos */
150 #define DLT_IEEE802	6	/* IEEE 802 Networks */
151 #define DLT_ARCNET	7	/* ARCNET */
152 #define DLT_SLIP	8	/* Serial Line IP */
153 #define DLT_PPP		9	/* Point-to-point Protocol */
154 #define DLT_FDDI	10	/* FDDI */
155 #define DLT_ATM_RFC1483	11	/* LLC/SNAP encapsulated atm */
156 #define DLT_RAW		12	/* raw IP */
157 
158 /*
159  * These are values from BSD/OS's "bpf.h".
160  * These are not the same as the values from the traditional libpcap
161  * "bpf.h"; however, these values shouldn't be generated by any
162  * OS other than BSD/OS, so the correct values to use here are the
163  * BSD/OS values.
164  *
165  * Platforms that have already assigned these values to other
166  * DLT_ codes, however, should give these codes the values
167  * from that platform, so that programs that use these codes will
168  * continue to compile - even though they won't correctly read
169  * files of these types.
170  */
171 #define DLT_SLIP_BSDOS	15	/* BSD/OS Serial Line IP */
172 #define DLT_PPP_BSDOS	16	/* BSD/OS Point-to-point Protocol */
173 
174 #define DLT_ATM_CLIP	19	/* Linux Classical-IP over ATM */
175 
176 /*
177  * These values are defined by NetBSD; other platforms should refrain from
178  * using them for other purposes, so that NetBSD savefiles with link
179  * types of 50 or 51 can be read as this type on all platforms.
180  */
181 #define DLT_PPP_SERIAL	50	/* PPP over serial with HDLC encapsulation */
182 #define DLT_PPP_ETHER	51	/* PPP over Ethernet */
183 
184 /*
185  * Reserved for the Symantec Enterprise Firewall.
186  */
187 #define DLT_SYMANTEC_FIREWALL	99
188 
189 
190 /*
191  * This value was defined by libpcap 0.5; platforms that have defined
192  * it with a different value should define it here with that value -
193  * a link type of 104 in a save file will be mapped to DLT_C_HDLC,
194  * whatever value that happens to be, so programs will correctly
195  * handle files with that link type regardless of the value of
196  * DLT_C_HDLC.
197  *
198  * The name DLT_C_HDLC was used by BSD/OS; we use that name for source
199  * compatibility with programs written for BSD/OS.
200  *
201  * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well,
202  * for source compatibility with programs written for libpcap 0.5.
203  */
204 #define DLT_C_HDLC	104	/* Cisco HDLC */
205 #define DLT_CHDLC	DLT_C_HDLC
206 
207 #define DLT_IEEE802_11	105	/* IEEE 802.11 wireless */
208 
209 /*
210  * Values between 106 and 107 are used in capture file headers as
211  * link-layer types corresponding to DLT_ types that might differ
212  * between platforms; don't use those values for new DLT_ new types.
213  */
214 
215 /*
216  * Frame Relay; BSD/OS has a DLT_FR with a value of 11, but that collides
217  * with other values.
218  * DLT_FR and DLT_FRELAY packets start with the Q.922 Frame Relay header
219  * (DLCI, etc.).
220  */
221 #define DLT_FRELAY	107
222 
223 /*
224  * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except
225  * that the AF_ type in the link-layer header is in network byte order.
226  *
227  * OpenBSD defines it as 12, but that collides with DLT_RAW, so we
228  * define it as 108 here.  If OpenBSD picks up this file, it should
229  * define DLT_LOOP as 12 in its version, as per the comment above -
230  * and should not use 108 as a DLT_ value.
231  */
232 #define DLT_LOOP	108
233 
234 /*
235  * Values between 109 and 112 are used in capture file headers as
236  * link-layer types corresponding to DLT_ types that might differ
237  * between platforms; don't use those values for new DLT_ new types.
238  */
239 
240 /*
241  * Encapsulated packets for IPsec; DLT_ENC is 13 in OpenBSD, but that's
242  * DLT_SLIP_BSDOS in NetBSD, so we don't use 13 for it in OSes other
243  * than OpenBSD.
244  */
245 #define DLT_ENC	109
246 
247 /*
248  * This is for Linux cooked sockets.
249  */
250 #define DLT_LINUX_SLL	113
251 
252 /*
253  * Apple LocalTalk hardware.
254  */
255 #define DLT_LTALK	114
256 
257 /*
258  * Acorn Econet.
259  */
260 #define DLT_ECONET	115
261 
262 /*
263  * Reserved for use with OpenBSD ipfilter.
264  */
265 #define DLT_IPFILTER	116
266 
267 /*
268  * Reserved for use in capture-file headers as a link-layer type
269  * corresponding to OpenBSD DLT_PFLOG; DLT_PFLOG is 17 in OpenBSD,
270  * but that's DLT_LANE8023 in SuSE 6.3, so we can't use 17 for it
271  * in capture-file headers.
272  */
273 #define DLT_PFLOG	117
274 
275 /*
276  * Registered for Cisco-internal use.
277  */
278 #define DLT_CISCO_IOS	118
279 
280 /*
281  * Reserved for 802.11 cards using the Prism II chips, with a link-layer
282  * header including Prism monitor mode information plus an 802.11
283  * header.
284  */
285 #define DLT_PRISM_HEADER	119
286 
287 /*
288  * Reserved for Aironet 802.11 cards, with an Aironet link-layer header
289  * (see Doug Ambrisko's FreeBSD patches).
290  */
291 #define DLT_AIRONET_HEADER	120
292 
293 /*
294  * Reserved for use by OpenBSD's pfsync device.
295  */
296 #define DLT_PFSYNC	121
297 
298 /*
299  * Reserved for Siemens HiPath HDLC. XXX
300  */
301 #define DLT_HHDLC	121
302 
303 /*
304  * Reserved for RFC 2625 IP-over-Fibre Channel.
305  */
306 #define DLT_IP_OVER_FC	122
307 
308 /*
309  * Reserved for Full Frontal ATM on Solaris.
310  */
311 #define DLT_SUNATM	123
312 
313 /*
314  * Reserved as per request from Kent Dahlgren <kent@praesum.com>
315  * for private use.
316  */
317 #define DLT_RIO		124	/* RapidIO */
318 #define DLT_PCI_EXP	125	/* PCI Express */
319 #define DLT_AURORA	126	/* Xilinx Aurora link layer */
320 
321 /*
322  * BSD header for 802.11 plus a number of bits of link-layer information
323  * including radio information.
324  */
325 #ifndef DLT_IEEE802_11_RADIO
326 #define DLT_IEEE802_11_RADIO	127
327 #endif
328 
329 /*
330  * Reserved for TZSP encapsulation.
331  */
332 #define DLT_TZSP		128	/* Tazmen Sniffer Protocol */
333 
334 /*
335  * Reserved for Linux ARCNET.
336  */
337 #define DLT_ARCNET_LINUX	129
338 
339 /*
340  * Juniper-private data link types.
341  */
342 #define DLT_JUNIPER_MLPPP	130
343 #define DLT_JUNIPER_MLFR	131
344 #define DLT_JUNIPER_ES		132
345 #define DLT_JUNIPER_GGSN	133
346 #define DLT_JUNIPER_MFR		134
347 #define DLT_JUNIPER_ATM2	135
348 #define DLT_JUNIPER_SERVICES	136
349 #define DLT_JUNIPER_ATM1	137
350 
351 /*
352  * Reserved for Apple IP-over-IEEE-1394.
353  */
354 #define DLT_APPLE_IP_OVER_IEEE1394	138
355 
356 /*
357  * Reserved for DOCSIS.
358  */
359 #define DLT_DOCSIS	143
360 
361 /*
362  * Reserved for Linux IrDA.
363  */
364 #define DLT_LINUX_IRDA	144
365 
366 /*
367  * Reserved for IBM SP switch and IBM Next Federation switch.
368  */
369 #define DLT_IBM_SP	145
370 #define DLT_IBM_SN	146
371 
372 /*
373  * Reserved for AbsoluteValue Systems 802.11 capture.
374  */
375 #define DLT_IEEE802_11_RADIO_AVS	163
376 
377 /*
378  * Reserved for Juniper-private DLT.
379  */
380 #define DLT_JUNIPER_MONITOR	164
381 
382 /*
383  * The instruction encodings.
384  */
385 /* instruction classes */
386 #define BPF_CLASS(code) ((code) & 0x07)
387 #define		BPF_LD		0x00
388 #define		BPF_LDX		0x01
389 #define		BPF_ST		0x02
390 #define		BPF_STX		0x03
391 #define		BPF_ALU		0x04
392 #define		BPF_JMP		0x05
393 #define		BPF_RET		0x06
394 #define		BPF_MISC	0x07
395 
396 /* ld/ldx fields */
397 #define BPF_SIZE(code)	((code) & 0x18)
398 #define		BPF_W		0x00
399 #define		BPF_H		0x08
400 #define		BPF_B		0x10
401 #define BPF_MODE(code)	((code) & 0xe0)
402 #define		BPF_IMM 	0x00
403 #define		BPF_ABS		0x20
404 #define		BPF_IND		0x40
405 #define		BPF_MEM		0x60
406 #define		BPF_LEN		0x80
407 #define		BPF_MSH		0xa0
408 
409 /* alu/jmp fields */
410 #define BPF_OP(code)	((code) & 0xf0)
411 #define		BPF_ADD		0x00
412 #define		BPF_SUB		0x10
413 #define		BPF_MUL		0x20
414 #define		BPF_DIV		0x30
415 #define		BPF_OR		0x40
416 #define		BPF_AND		0x50
417 #define		BPF_LSH		0x60
418 #define		BPF_RSH		0x70
419 #define		BPF_NEG		0x80
420 #define		BPF_JA		0x00
421 #define		BPF_JEQ		0x10
422 #define		BPF_JGT		0x20
423 #define		BPF_JGE		0x30
424 #define		BPF_JSET	0x40
425 #define BPF_SRC(code)	((code) & 0x08)
426 #define		BPF_K		0x00
427 #define		BPF_X		0x08
428 
429 /* ret - BPF_K and BPF_X also apply */
430 #define BPF_RVAL(code)	((code) & 0x18)
431 #define		BPF_A		0x10
432 
433 /* misc */
434 #define BPF_MISCOP(code) ((code) & 0xf8)
435 #define		BPF_TAX		0x00
436 #define		BPF_TXA		0x80
437 
438 /*
439  * The instruction data structure.
440  */
441 struct bpf_insn {
442 	u_short		code;
443 	u_char		jt;
444 	u_char		jf;
445 	bpf_u_int32	k;
446 };
447 
448 /*
449  * Macros for insn array initializers.
450  */
451 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
452 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
453 
454 /*
455  * Structure to retrieve available DLTs for the interface.
456  */
457 struct bpf_dltlist {
458 	u_int	bfl_len;	/* number of bfd_list array */
459 	u_int	*bfl_list;	/* array of DLTs */
460 };
461 
462 #ifdef _KERNEL
463 struct bpf_if;
464 int	 bpf_validate(const struct bpf_insn *, int);
465 void	 bpf_tap(struct bpf_if *, u_char *, u_int);
466 void	 bpf_mtap(struct bpf_if *, struct mbuf *);
467 void	 bpf_mtap2(struct bpf_if *, void *, u_int, struct mbuf *);
468 void	 bpfattach(struct ifnet *, u_int, u_int);
469 void	 bpfattach2(struct ifnet *, u_int, u_int, struct bpf_if **);
470 void	 bpfdetach(struct ifnet *);
471 
472 void	 bpfilterattach(int);
473 u_int	 bpf_filter(const struct bpf_insn *, u_char *, u_int, u_int);
474 
475 #define	BPF_TAP(_ifp,_pkt,_pktlen) do {				\
476 	if ((_ifp)->if_bpf)					\
477 		bpf_tap((_ifp)->if_bpf, (_pkt), (_pktlen));	\
478 } while (0)
479 #define	BPF_MTAP(_ifp,_m) do {					\
480 	if ((_ifp)->if_bpf) {					\
481 		M_ASSERTVALID(_m);				\
482 		bpf_mtap((_ifp)->if_bpf, (_m));			\
483 	}							\
484 } while (0)
485 #define	BPF_MTAP2(_ifp,_data,_dlen,_m) do {			\
486 	if ((_ifp)->if_bpf) {					\
487 		M_ASSERTVALID(_m);				\
488 		bpf_mtap2((_ifp)->if_bpf,(_data),(_dlen),(_m));	\
489 	}							\
490 } while (0)
491 #endif
492 
493 /*
494  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
495  */
496 #define BPF_MEMWORDS 16
497 
498 #endif /* _NET_BPF_H_ */
499