2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1990, 1991, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from the Stanford/CMU enet packet filter,
8 * (net/enet.c) distributed as part of 4.3BSD, and code contributed
9 * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
10 * Berkeley Laboratory.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * @(#)bpf.h 8.1 (Berkeley) 6/10/93
37 * @(#)bpf.h 1.34 (LBL) 6/16/96
45 #include <sys/_eventhandler.h>
49 /* BSD style release date */
50 #define BPF_RELEASE 199606
52 typedef int32_t bpf_int32;
53 typedef u_int32_t bpf_u_int32;
54 typedef int64_t bpf_int64;
55 typedef u_int64_t bpf_u_int64;
59 * Alignment macros. BPF_WORDALIGN rounds up to the next multiple of
62 #define BPF_ALIGNMENT sizeof(long)
63 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
65 #define BPF_MAXINSNS 512
66 #define BPF_MAXBUFSIZE 0x80000
67 #define BPF_MINBUFSIZE 32
70 * Structure for BIOCSETF.
74 struct bpf_insn *bf_insns;
78 * Struct returned by BIOCGSTATS.
81 u_int bs_recv; /* number of packets received */
82 u_int bs_drop; /* number of packets dropped */
86 * Struct return by BIOCVERSION. This represents the version number of
87 * the filter language described by the instruction encodings below.
88 * bpf understands a program iff kernel_major == filter_major &&
89 * kernel_minor >= filter_minor, that is, if the value returned by the
90 * running kernel has the same major number and a minor number equal
91 * equal to or less than the filter being downloaded. Otherwise, the
92 * results are undefined, meaning an error may be returned or packets
93 * may be accepted haphazardly.
94 * It has nothing to do with the source code version.
100 /* Current version number of filter architecture. */
101 #define BPF_MAJOR_VERSION 1
102 #define BPF_MINOR_VERSION 1
105 * Historically, BPF has supported a single buffering model, first using mbuf
106 * clusters in kernel, and later using malloc(9) buffers in kernel. We now
107 * support multiple buffering modes, which may be queried and set using
108 * BIOCGETBUFMODE and BIOCSETBUFMODE. So as to avoid handling the complexity
109 * of changing modes while sniffing packets, the mode becomes fixed once an
110 * interface has been attached to the BPF descriptor.
112 #define BPF_BUFMODE_BUFFER 1 /* Kernel buffers with read(). */
113 #define BPF_BUFMODE_ZBUF 2 /* Zero-copy buffers. */
116 * Struct used by BIOCSETZBUF, BIOCROTZBUF: describes up to two zero-copy
117 * buffer as used by BPF.
120 void *bz_bufa; /* Location of 'a' zero-copy buffer. */
121 void *bz_bufb; /* Location of 'b' zero-copy buffer. */
122 size_t bz_buflen; /* Size of zero-copy buffers. */
125 #define BIOCGBLEN _IOR('B', 102, u_int)
126 #define BIOCSBLEN _IOWR('B', 102, u_int)
127 #define BIOCSETF _IOW('B', 103, struct bpf_program)
128 #define BIOCFLUSH _IO('B', 104)
129 #define BIOCPROMISC _IO('B', 105)
130 #define BIOCGDLT _IOR('B', 106, u_int)
131 #define BIOCGETIF _IOR('B', 107, struct ifreq)
132 #define BIOCSETIF _IOW('B', 108, struct ifreq)
133 #define BIOCSRTIMEOUT _IOW('B', 109, struct timeval)
134 #define BIOCGRTIMEOUT _IOR('B', 110, struct timeval)
135 #define BIOCGSTATS _IOR('B', 111, struct bpf_stat)
136 #define BIOCIMMEDIATE _IOW('B', 112, u_int)
137 #define BIOCVERSION _IOR('B', 113, struct bpf_version)
138 #define BIOCGRSIG _IOR('B', 114, u_int)
139 #define BIOCSRSIG _IOW('B', 115, u_int)
140 #define BIOCGHDRCMPLT _IOR('B', 116, u_int)
141 #define BIOCSHDRCMPLT _IOW('B', 117, u_int)
142 #define BIOCGDIRECTION _IOR('B', 118, u_int)
143 #define BIOCSDIRECTION _IOW('B', 119, u_int)
144 #define BIOCSDLT _IOW('B', 120, u_int)
145 #define BIOCGDLTLIST _IOWR('B', 121, struct bpf_dltlist)
146 #define BIOCLOCK _IO('B', 122)
147 #define BIOCSETWF _IOW('B', 123, struct bpf_program)
148 #define BIOCFEEDBACK _IOW('B', 124, u_int)
149 #define BIOCGETBUFMODE _IOR('B', 125, u_int)
150 #define BIOCSETBUFMODE _IOW('B', 126, u_int)
151 #define BIOCGETZMAX _IOR('B', 127, size_t)
152 #define BIOCROTZBUF _IOR('B', 128, struct bpf_zbuf)
153 #define BIOCSETZBUF _IOW('B', 129, struct bpf_zbuf)
154 #define BIOCSETFNR _IOW('B', 130, struct bpf_program)
155 #define BIOCGTSTAMP _IOR('B', 131, u_int)
156 #define BIOCSTSTAMP _IOW('B', 132, u_int)
157 #define BIOCSETVLANPCP _IOW('B', 133, u_int)
160 #define BIOCGSEESENT BIOCGDIRECTION
161 #define BIOCSSEESENT BIOCSDIRECTION
163 /* Packet directions */
165 BPF_D_IN, /* See incoming packets */
166 BPF_D_INOUT, /* See incoming and outgoing packets */
167 BPF_D_OUT /* See outgoing packets */
170 /* Time stamping functions */
171 #define BPF_T_MICROTIME 0x0000
172 #define BPF_T_NANOTIME 0x0001
173 #define BPF_T_BINTIME 0x0002
174 #define BPF_T_NONE 0x0003
175 #define BPF_T_FORMAT_MASK 0x0003
176 #define BPF_T_NORMAL 0x0000
177 #define BPF_T_FAST 0x0100
178 #define BPF_T_MONOTONIC 0x0200
179 #define BPF_T_MONOTONIC_FAST (BPF_T_FAST | BPF_T_MONOTONIC)
180 #define BPF_T_FLAG_MASK 0x0300
181 #define BPF_T_FORMAT(t) ((t) & BPF_T_FORMAT_MASK)
182 #define BPF_T_FLAG(t) ((t) & BPF_T_FLAG_MASK)
183 #define BPF_T_VALID(t) \
184 ((t) == BPF_T_NONE || (BPF_T_FORMAT(t) != BPF_T_NONE && \
185 ((t) & ~(BPF_T_FORMAT_MASK | BPF_T_FLAG_MASK)) == 0))
187 #define BPF_T_MICROTIME_FAST (BPF_T_MICROTIME | BPF_T_FAST)
188 #define BPF_T_NANOTIME_FAST (BPF_T_NANOTIME | BPF_T_FAST)
189 #define BPF_T_BINTIME_FAST (BPF_T_BINTIME | BPF_T_FAST)
190 #define BPF_T_MICROTIME_MONOTONIC (BPF_T_MICROTIME | BPF_T_MONOTONIC)
191 #define BPF_T_NANOTIME_MONOTONIC (BPF_T_NANOTIME | BPF_T_MONOTONIC)
192 #define BPF_T_BINTIME_MONOTONIC (BPF_T_BINTIME | BPF_T_MONOTONIC)
193 #define BPF_T_MICROTIME_MONOTONIC_FAST (BPF_T_MICROTIME | BPF_T_MONOTONIC_FAST)
194 #define BPF_T_NANOTIME_MONOTONIC_FAST (BPF_T_NANOTIME | BPF_T_MONOTONIC_FAST)
195 #define BPF_T_BINTIME_MONOTONIC_FAST (BPF_T_BINTIME | BPF_T_MONOTONIC_FAST)
198 * Structure prepended to each packet.
201 bpf_int64 bt_sec; /* seconds */
202 bpf_u_int64 bt_frac; /* fraction */
205 struct bpf_ts bh_tstamp; /* time stamp */
206 bpf_u_int32 bh_caplen; /* length of captured portion */
207 bpf_u_int32 bh_datalen; /* original length of packet */
208 u_short bh_hdrlen; /* length of bpf header (this struct
209 plus alignment padding) */
213 struct timeval bh_tstamp; /* time stamp */
214 bpf_u_int32 bh_caplen; /* length of captured portion */
215 bpf_u_int32 bh_datalen; /* original length of packet */
216 u_short bh_hdrlen; /* length of bpf header (this struct
217 plus alignment padding) */
220 #define MTAG_BPF 0x627066
221 #define MTAG_BPF_TIMESTAMP 0
225 * When using zero-copy BPF buffers, a shared memory header is present
226 * allowing the kernel BPF implementation and user process to synchronize
227 * without using system calls. This structure defines that header. When
228 * accessing these fields, appropriate atomic operation and memory barriers
229 * are required in order not to see stale or out-of-order data; see bpf(4)
230 * for reference code to access these fields from userspace.
232 * The layout of this structure is critical, and must not be changed; if must
233 * fit in a single page on all architectures.
235 struct bpf_zbuf_header {
236 volatile u_int bzh_kernel_gen; /* Kernel generation number. */
237 volatile u_int bzh_kernel_len; /* Length of data in the buffer. */
238 volatile u_int bzh_user_gen; /* User generation number. */
243 * The instruction encodings.
245 * Please inform tcpdump-workers@lists.tcpdump.org if you use any
246 * of the reserved values, so that we can note that they're used
247 * (and perhaps implement it in the reference BPF implementation
248 * and encourage its implementation elsewhere).
252 * The upper 8 bits of the opcode aren't used. BSD/OS used 0x8000.
255 /* instruction classes */
256 #define BPF_CLASS(code) ((code) & 0x07)
264 #define BPF_MISC 0x07
267 #define BPF_SIZE(code) ((code) & 0x18)
271 /* 0x18 reserved; used by BSD/OS */
272 #define BPF_MODE(code) ((code) & 0xe0)
279 /* 0xc0 reserved; used by BSD/OS */
280 /* 0xe0 reserved; used by BSD/OS */
283 #define BPF_OP(code) ((code) & 0xf0)
305 #define BPF_JSET 0x40
306 /* 0x50 reserved; used on BSD/OS */
317 #define BPF_SRC(code) ((code) & 0x08)
321 /* ret - BPF_K and BPF_X also apply */
322 #define BPF_RVAL(code) ((code) & 0x18)
327 #define BPF_MISCOP(code) ((code) & 0xf8)
332 /* #define BPF_COP 0x20 NetBSD "coprocessor" extensions */
336 /* #define BPF_COPX 0x40 NetBSD "coprocessor" extensions */
337 /* also used on BSD/OS */
353 /* 0xc0 reserved; used on BSD/OS */
363 * The instruction data structure.
373 * Macros for insn array initializers.
375 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
376 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
379 * Structure to retrieve available DLTs for the interface.
382 u_int bfl_len; /* number of bfd_list array */
383 u_int *bfl_list; /* array of DLTs */
387 #ifdef MALLOC_DECLARE
388 MALLOC_DECLARE(M_BPF);
391 SYSCTL_DECL(_net_bpf);
395 * Rotate the packet buffers in descriptor d. Move the store buffer into the
396 * hold slot, and the free buffer into the store slot. Zero the length of the
397 * new store buffer. Descriptor lock should be held. One must be careful to
398 * not rotate the buffers twice, i.e. if fbuf != NULL.
400 #define ROTATE_BUFFERS(d) do { \
401 (d)->bd_hbuf = (d)->bd_sbuf; \
402 (d)->bd_hlen = (d)->bd_slen; \
403 (d)->bd_sbuf = (d)->bd_fbuf; \
405 (d)->bd_fbuf = NULL; \
410 * Descriptor associated with each attached hardware interface.
411 * Part of this structure is exposed to external callers to speed up
412 * bpf_peers_present() calls.
415 CK_LIST_HEAD(bpfd_list, bpf_d);
418 CK_LIST_ENTRY(bpf_if) bif_next; /* list of all interfaces */
419 struct bpfd_list bif_dlist; /* descriptor list */
422 void bpf_bufheld(struct bpf_d *d);
423 int bpf_validate(const struct bpf_insn *, int);
424 void bpf_tap(struct bpf_if *, u_char *, u_int);
425 void bpf_tap_if(struct ifnet *, u_char *, u_int);
426 void bpf_mtap(struct bpf_if *, struct mbuf *);
427 void bpf_mtap_if(struct ifnet *, struct mbuf *);
428 void bpf_mtap2(struct bpf_if *, void *, u_int, struct mbuf *);
429 void bpf_mtap2_if(struct ifnet *, void *, u_int, struct mbuf *);
430 void bpfattach(struct ifnet *, u_int, u_int);
431 void bpfattach2(struct ifnet *, u_int, u_int, struct bpf_if **);
432 void bpfdetach(struct ifnet *);
434 int bpf_get_bp_params(struct bpf_if *, u_int *, u_int *);
437 void bpfilterattach(int);
438 u_int bpf_filter(const struct bpf_insn *, u_char *, u_int, u_int);
441 bpf_peers_present(struct bpf_if *bpf)
443 struct bpf_if_ext *ext;
445 ext = (struct bpf_if_ext *)bpf;
446 if (!CK_LIST_EMPTY(&ext->bif_dlist))
451 #define BPF_TAP(_ifp,_pkt,_pktlen) \
452 bpf_tap_if((_ifp), (_pkt), (_pktlen))
453 #define BPF_MTAP(_ifp,_m) \
454 bpf_mtap_if((_ifp), (_m))
455 #define BPF_MTAP2(_ifp,_data,_dlen,_m) \
456 bpf_mtap2_if((_ifp), (_data), (_dlen), (_m))
460 * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
462 #define BPF_MEMWORDS 16
464 /* BPF attach/detach events */
465 typedef void (*bpf_track_fn)(void *, struct ifnet *, int /* dlt */,
466 int /* 1 =>'s attach */);
467 EVENTHANDLER_DECLARE(bpf_track, bpf_track_fn);
469 #endif /* _NET_BPF_H_ */