bpf.h revision 1.34 1 /* $NetBSD: bpf.h,v 1.34 2004/04/10 23:31:52 darrenr Exp $ */
2
3 /*
4 * Copyright (c) 1990, 1991, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
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.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
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.
23 *
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
34 * SUCH DAMAGE.
35 *
36 * @(#)bpf.h 8.2 (Berkeley) 1/9/95
37 * @(#) Header: bpf.h,v 1.36 97/06/12 14:29:53 leres Exp (LBL)
38 */
39
40 #ifndef _NET_BPF_H_
41 #define _NET_BPF_H_
42
43 #include <sys/time.h>
44
45 /* BSD style release date */
46 #define BPF_RELEASE 199606
47
48 typedef int bpf_int32;
49 typedef u_int bpf_u_int32;
50
51 /*
52 * Alignment macros. BPF_WORDALIGN rounds up to the next
53 * even multiple of BPF_ALIGNMENT.
54 */
55 #define BPF_ALIGNMENT sizeof(long)
56 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
57
58 #define BPF_MAXINSNS 512
59 #define BPF_DFLTBUFSIZE (1024*1024) /* default static upper limit */
60 #define BPF_MAXBUFSIZE (1024*1024*16) /* hard limit on sysctl'able value */
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 * The first set is for compatibility with Sun's pcc style
102 * header files. If your using gcc, we assume that you
103 * have run fixincludes so the latter set should work.
104 */
105 #define BIOCGBLEN _IOR('B',102, u_int)
106 #define BIOCSBLEN _IOWR('B',102, u_int)
107 #define BIOCSETF _IOW('B',103, struct bpf_program)
108 #define BIOCFLUSH _IO('B',104)
109 #define BIOCPROMISC _IO('B',105)
110 #define BIOCGDLT _IOR('B',106, u_int)
111 #define BIOCGETIF _IOR('B',107, struct ifreq)
112 #define BIOCSETIF _IOW('B',108, struct ifreq)
113 #define BIOCSRTIMEOUT _IOW('B',109, struct timeval)
114 #define BIOCGRTIMEOUT _IOR('B',110, struct timeval)
115 #define BIOCGSTATS _IOR('B',111, struct bpf_stat)
116 #define BIOCIMMEDIATE _IOW('B',112, u_int)
117 #define BIOCVERSION _IOR('B',113, struct bpf_version)
118 #define BIOCSTCPF _IOW('B',114, struct bpf_program)
119 #define BIOCSUDPF _IOW('B',115, struct bpf_program)
120 #define BIOCGHDRCMPLT _IOR('B',116, u_int)
121 #define BIOCSHDRCMPLT _IOW('B',117, u_int)
122 #define BIOCSDLT _IOW('B',118, u_int)
123 #define BIOCGDLTLIST _IOWR('B',119, struct bpf_dltlist)
124 #define BIOCGSEESENT _IOR('B',120, u_int)
125 #define BIOCSSEESENT _IOW('B',121, u_int)
126
127 /*
128 * Structure prepended to each packet.
129 */
130 struct bpf_hdr {
131 struct timeval bh_tstamp; /* time stamp */
132 u_int32_t bh_caplen; /* length of captured portion */
133 u_int32_t bh_datalen; /* original length of packet */
134 u_int16_t bh_hdrlen; /* length of bpf header (this struct
135 plus alignment padding) */
136 };
137 /*
138 * Because the structure above is not a multiple of 4 bytes, some compilers
139 * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
140 * Only the kernel needs to know about it; applications use bh_hdrlen.
141 * XXX To save a few bytes on 32-bit machines, we avoid end-of-struct
142 * XXX padding by using the size of the header data elements. This is
143 * XXX fail-safe: on new machines, we just use the 'safe' sizeof.
144 */
145 #ifdef _KERNEL
146 #if defined(__arm32__) || defined(__i386__) || defined(__m68k__) || \
147 defined(__mips__) || defined(__ns32k__) || defined(__vax__) || \
148 defined(__sh__) || (defined(__sparc__) && !defined(__sparc64__))
149 #define SIZEOF_BPF_HDR 18
150 #else
151 #define SIZEOF_BPF_HDR sizeof(struct bpf_hdr)
152 #endif
153 #endif
154
155 /* Pull in data-link level type codes. */
156 #include <net/dlt.h>
157
158 /*
159 * The instruction encondings.
160 */
161 /* instruction classes */
162 #define BPF_CLASS(code) ((code) & 0x07)
163 #define BPF_LD 0x00
164 #define BPF_LDX 0x01
165 #define BPF_ST 0x02
166 #define BPF_STX 0x03
167 #define BPF_ALU 0x04
168 #define BPF_JMP 0x05
169 #define BPF_RET 0x06
170 #define BPF_MISC 0x07
171
172 /* ld/ldx fields */
173 #define BPF_SIZE(code) ((code) & 0x18)
174 #define BPF_W 0x00
175 #define BPF_H 0x08
176 #define BPF_B 0x10
177 #define BPF_MODE(code) ((code) & 0xe0)
178 #define BPF_IMM 0x00
179 #define BPF_ABS 0x20
180 #define BPF_IND 0x40
181 #define BPF_MEM 0x60
182 #define BPF_LEN 0x80
183 #define BPF_MSH 0xa0
184
185 /* alu/jmp fields */
186 #define BPF_OP(code) ((code) & 0xf0)
187 #define BPF_ADD 0x00
188 #define BPF_SUB 0x10
189 #define BPF_MUL 0x20
190 #define BPF_DIV 0x30
191 #define BPF_OR 0x40
192 #define BPF_AND 0x50
193 #define BPF_LSH 0x60
194 #define BPF_RSH 0x70
195 #define BPF_NEG 0x80
196 #define BPF_JA 0x00
197 #define BPF_JEQ 0x10
198 #define BPF_JGT 0x20
199 #define BPF_JGE 0x30
200 #define BPF_JSET 0x40
201 #define BPF_SRC(code) ((code) & 0x08)
202 #define BPF_K 0x00
203 #define BPF_X 0x08
204
205 /* ret - BPF_K and BPF_X also apply */
206 #define BPF_RVAL(code) ((code) & 0x18)
207 #define BPF_A 0x10
208
209 /* misc */
210 #define BPF_MISCOP(code) ((code) & 0xf8)
211 #define BPF_TAX 0x00
212 #define BPF_TXA 0x80
213
214 /*
215 * The instruction data structure.
216 */
217 struct bpf_insn {
218 u_int16_t code;
219 u_char jt;
220 u_char jf;
221 int32_t k;
222 };
223
224 /*
225 * Macros for insn array initializers.
226 */
227 #define BPF_STMT(code, k) { (u_int16_t)(code), 0, 0, k }
228 #define BPF_JUMP(code, k, jt, jf) { (u_int16_t)(code), jt, jf, k }
229
230 /*
231 * Structure to retrieve available DLTs for the interface.
232 */
233 struct bpf_dltlist {
234 u_int bfl_len; /* number of bfd_list array */
235 u_int *bfl_list; /* array of DLTs */
236 };
237
238 #ifdef _KERNEL
239 int bpf_validate __P((struct bpf_insn *, int));
240 void bpf_tap __P((caddr_t, u_char *, u_int));
241 void bpf_mtap __P((caddr_t, struct mbuf *));
242 void bpfattach __P((struct ifnet *, u_int, u_int));
243 void bpfattach2 __P((struct ifnet *, u_int, u_int, caddr_t *));
244 void bpfdetach __P((struct ifnet *));
245 void bpf_change_type __P((struct ifnet *, u_int, u_int));
246 void bpfilterattach __P((int));
247 #endif
248
249 u_int bpf_filter __P((struct bpf_insn *, u_char *, u_int, u_int));
250
251 /*
252 * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
253 */
254 #define BPF_MEMWORDS 16
255
256 #endif /* _NET_BPF_H_ */
257