]> The Tcpdump Group git mirrors - libpcap/blob - bpf/net/bpf.h
Introduce a set of PCAP_ENCAP_ codes to specify packet encapsulations.
[libpcap] / bpf / net / bpf.h
1 /*-
2 * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
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 7.1 (Berkeley) 5/7/91
39 *
40 * @(#) $Header: /tcpdump/master/libpcap/bpf/net/Attic/bpf.h,v 1.39 2000-09-17 04:04:39 guy Exp $ (LBL)
41 */
42
43 #ifndef BPF_MAJOR_VERSION
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 #ifndef __NetBSD__
56 #define BPF_ALIGNMENT sizeof(bpf_int32)
57 #else
58 #define BPF_ALIGNMENT sizeof(long)
59 #endif
60 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
61
62 #define BPF_MAXINSNS 512
63 #define BPF_MAXBUFSIZE 0x8000
64 #define BPF_MINBUFSIZE 32
65
66 /*
67 * Structure for BIOCSETF.
68 */
69 struct bpf_program {
70 u_int bf_len;
71 struct bpf_insn *bf_insns;
72 };
73
74 /*
75 * Struct returned by BIOCGSTATS.
76 */
77 struct bpf_stat {
78 u_int bs_recv; /* number of packets received */
79 u_int bs_drop; /* number of packets dropped */
80 };
81
82 /*
83 * Struct return by BIOCVERSION. This represents the version number of
84 * the filter language described by the instruction encodings below.
85 * bpf understands a program iff kernel_major == filter_major &&
86 * kernel_minor >= filter_minor, that is, if the value returned by the
87 * running kernel has the same major number and a minor number equal
88 * equal to or less than the filter being downloaded. Otherwise, the
89 * results are undefined, meaning an error may be returned or packets
90 * may be accepted haphazardly.
91 * It has nothing to do with the source code version.
92 */
93 struct bpf_version {
94 u_short bv_major;
95 u_short bv_minor;
96 };
97 /* Current version number of filter architecture. */
98 #define BPF_MAJOR_VERSION 1
99 #define BPF_MINOR_VERSION 1
100
101 /*
102 * BPF ioctls
103 *
104 * The first set is for compatibility with Sun's pcc style
105 * header files. If your using gcc, we assume that you
106 * have run fixincludes so the latter set should work.
107 */
108 #if (defined(sun) || defined(ibm032)) && !defined(__GNUC__)
109 #define BIOCGBLEN _IOR(B,102, u_int)
110 #define BIOCSBLEN _IOWR(B,102, u_int)
111 #define BIOCSETF _IOW(B,103, struct bpf_program)
112 #define BIOCFLUSH _IO(B,104)
113 #define BIOCPROMISC _IO(B,105)
114 #define BIOCGDLT _IOR(B,106, u_int)
115 #define BIOCGETIF _IOR(B,107, struct ifreq)
116 #define BIOCSETIF _IOW(B,108, struct ifreq)
117 #define BIOCSRTIMEOUT _IOW(B,109, struct timeval)
118 #define BIOCGRTIMEOUT _IOR(B,110, struct timeval)
119 #define BIOCGSTATS _IOR(B,111, struct bpf_stat)
120 #define BIOCIMMEDIATE _IOW(B,112, u_int)
121 #define BIOCVERSION _IOR(B,113, struct bpf_version)
122 #define BIOCSTCPF _IOW(B,114, struct bpf_program)
123 #define BIOCSUDPF _IOW(B,115, struct bpf_program)
124 #else
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 BIOCSTCPF _IOW('B',114, struct bpf_program)
139 #define BIOCSUDPF _IOW('B',115, struct bpf_program)
140 #endif
141
142 /*
143 * Structure prepended to each packet.
144 */
145 struct bpf_hdr {
146 struct timeval bh_tstamp; /* time stamp */
147 bpf_u_int32 bh_caplen; /* length of captured portion */
148 bpf_u_int32 bh_datalen; /* original length of packet */
149 u_short bh_hdrlen; /* length of bpf header (this struct
150 plus alignment padding) */
151 };
152 /*
153 * Because the structure above is not a multiple of 4 bytes, some compilers
154 * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
155 * Only the kernel needs to know about it; applications use bh_hdrlen.
156 */
157 #if defined(KERNEL) || defined(_KERNEL)
158 #define SIZEOF_BPF_HDR 18
159 #endif
160
161 /*
162 * Data-link level type codes.
163 * These are the types that are the same on all platforms; on other
164 * platforms, a <net/bpf.h> should be supplied that defines the additional
165 * DLT_* codes appropriately for that platform (the BSDs, for example,
166 * should not just pick up this version of "bpf.h"; they should also define
167 * the additional DLT_* codes used by their kernels, as well as the values
168 * defined here).
169 */
170 #define DLT_NULL 0 /* no link-layer encapsulation */
171 #define DLT_EN10MB 1 /* Ethernet (10Mb) */
172 #define DLT_EN3MB 2 /* Experimental Ethernet (3Mb) */
173 #define DLT_AX25 3 /* Amateur Radio AX.25 */
174 #define DLT_PRONET 4 /* Proteon ProNET Token Ring */
175 #define DLT_CHAOS 5 /* Chaos */
176 #define DLT_IEEE802 6 /* IEEE 802 Networks */
177 #define DLT_ARCNET 7 /* ARCNET */
178 #define DLT_SLIP 8 /* Serial Line IP */
179 #define DLT_PPP 9 /* Point-to-point Protocol */
180 #define DLT_FDDI 10 /* FDDI */
181 #define DLT_ATM_CLIP 19 /* Linux Classical-IP over ATM */
182
183 /*
184 * These are the values that were traditionally defined in <net/bpf.h>,
185 * but that are not the same on all platforms; if they are not already
186 * defined (e.g., defined above because this is a BSD that defines them
187 * for use in its kernel), we define them to have the appropriate
188 * PCAP_ENCAP_* value from <pcap.h>, so that programs using those DLT_
189 * codes will continue to compile and will be able to read capture files
190 * from the current version of libpcap.
191 */
192 #ifndef DLT_ATM_RFC1483
193 #define DLT_ATM_RFC1483 100 /* LLC/SNAP encapsulated atm */
194 #endif
195 #ifndef DLT_RAW
196 #define DLT_RAW 101 /* raw IP */
197 #endif
198
199 /*
200 * NOTE: these two values were defined by LBL libpcap, but with values
201 * that didn't seem to correspond to the values that were used in BSD/OS;
202 * neither of them are, as far as I know, used in any kernel, so they
203 * should not be defined above. We therefore don't bother checking to
204 * see if they're already defined.
205 */
206 #define DLT_SLIP_BSDOS 102 /* BSD/OS Serial Line IP */
207 #define DLT_PPP_BSDOS 103 /* BSD/OS Point-to-point Protocol */
208
209 /*
210 * This value was defined by libpcap 0.5; we now use it as a DLT_* value
211 * solely for backwards compatibility - new programs should use
212 * PCAP_ENCAP_C_HDLC instead.
213 */
214 #define DLT_CHDLC 104 /* Cisco HDLC */
215
216 /*
217 * The instruction encondings.
218 */
219 /* instruction classes */
220 #define BPF_CLASS(code) ((code) & 0x07)
221 #define BPF_LD 0x00
222 #define BPF_LDX 0x01
223 #define BPF_ST 0x02
224 #define BPF_STX 0x03
225 #define BPF_ALU 0x04
226 #define BPF_JMP 0x05
227 #define BPF_RET 0x06
228 #define BPF_MISC 0x07
229
230 /* ld/ldx fields */
231 #define BPF_SIZE(code) ((code) & 0x18)
232 #define BPF_W 0x00
233 #define BPF_H 0x08
234 #define BPF_B 0x10
235 #define BPF_MODE(code) ((code) & 0xe0)
236 #define BPF_IMM 0x00
237 #define BPF_ABS 0x20
238 #define BPF_IND 0x40
239 #define BPF_MEM 0x60
240 #define BPF_LEN 0x80
241 #define BPF_MSH 0xa0
242
243 /* alu/jmp fields */
244 #define BPF_OP(code) ((code) & 0xf0)
245 #define BPF_ADD 0x00
246 #define BPF_SUB 0x10
247 #define BPF_MUL 0x20
248 #define BPF_DIV 0x30
249 #define BPF_OR 0x40
250 #define BPF_AND 0x50
251 #define BPF_LSH 0x60
252 #define BPF_RSH 0x70
253 #define BPF_NEG 0x80
254 #define BPF_JA 0x00
255 #define BPF_JEQ 0x10
256 #define BPF_JGT 0x20
257 #define BPF_JGE 0x30
258 #define BPF_JSET 0x40
259 #define BPF_SRC(code) ((code) & 0x08)
260 #define BPF_K 0x00
261 #define BPF_X 0x08
262
263 /* ret - BPF_K and BPF_X also apply */
264 #define BPF_RVAL(code) ((code) & 0x18)
265 #define BPF_A 0x10
266
267 /* misc */
268 #define BPF_MISCOP(code) ((code) & 0xf8)
269 #define BPF_TAX 0x00
270 #define BPF_TXA 0x80
271
272 /*
273 * The instruction data structure.
274 */
275 struct bpf_insn {
276 u_short code;
277 u_char jt;
278 u_char jf;
279 bpf_int32 k;
280 };
281
282 /*
283 * Macros for insn array initializers.
284 */
285 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
286 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
287
288 #if defined(BSD) && (defined(KERNEL) || defined(_KERNEL))
289 /*
290 * Systems based on non-BSD kernels don't have ifnet's (or they don't mean
291 * anything if it is in <net/if.h>) and won't work like this.
292 */
293 # if __STDC__
294 extern void bpf_tap(struct ifnet *, u_char *, u_int);
295 extern void bpf_mtap(struct ifnet *, struct mbuf *);
296 extern void bpfattach(struct ifnet *, u_int, u_int);
297 extern void bpfilterattach(int);
298 # else
299 extern void bpf_tap();
300 extern void bpf_mtap();
301 extern void bpfattach();
302 extern void bpfilterattach();
303 # endif /* __STDC__ */
304 #endif /* BSD && (_KERNEL || KERNEL) */
305 #if __STDC__
306 extern int bpf_validate(struct bpf_insn *, int);
307 extern u_int bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
308 #else
309 extern int bpf_validate();
310 extern u_int bpf_filter();
311 #endif
312
313 /*
314 * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
315 */
316 #define BPF_MEMWORDS 16
317
318 #endif