libnet  latest
A Portable Framework for Low-Level Network Packet Construction
bpf.h
1 /*
2 It's not clear what purpose including this file with libnet serves. Is it just
3 for the DLT_ values? On systems with bpf, it should be present in the system
4 headers! Also, it's definitions have conflicted with the system's on AIX.
5 */
6 /*-
7  * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
8  * The Regents of the University of California. All rights reserved.
9  *
10  * This code is derived from the Stanford/CMU enet packet filter,
11  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
12  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
13  * Berkeley Laboratory.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  * notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in the
22  * documentation and/or other materials provided with the distribution.
23  * 3. All advertising materials mentioning features or use of this software
24  * must display the following acknowledgement:
25  * This product includes software developed by the University of
26  * California, Berkeley and its contributors.
27  * 4. Neither the name of the University nor the names of its contributors
28  * may be used to endorse or promote products derived from this software
29  * without specific prior written permission.
30  *
31  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
32  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
33  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34  * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
35  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
39  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
40  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41  * SUCH DAMAGE.
42  *
43  * @(#)bpf.h 7.1 (Berkeley) 5/7/91
44  *
45  * @(#) $Header: /usr/local/CVS/libnet/include/bpf.h,v 1.1.1.1 2003/06/26 21:55:10 route Exp $ (LBL)
46  */
47 
48 #ifndef BPF_MAJOR_VERSION
49 
50 /* BSD style release date */
51 #define BPF_RELEASE 199606
52 
53 typedef int bpf_int32;
54 typedef u_int bpf_u_int32;
55 
56 /*
57  * Alignment macros. BPF_WORDALIGN rounds up to the next
58  * even multiple of BPF_ALIGNMENT.
59  */
60 #define BPF_ALIGNMENT sizeof(bpf_int32)
61 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
62 
63 #define BPF_MAXINSNS 512
64 #define BPF_MAXBUFSIZE 0x8000
65 #define BPF_MINBUFSIZE 32
66 
67 /*
68  * Structure for BIOCSETF.
69  */
70 struct bpf_program {
71  u_int bf_len;
72  struct bpf_insn *bf_insns;
73 };
74 
75 /*
76  * Struct returned by BIOCGSTATS.
77  */
78 struct bpf_stat {
79  u_int bs_recv; /* number of packets received */
80  u_int bs_drop; /* number of packets dropped */
81 };
82 
83 /*
84  * Struct return by BIOCVERSION. This represents the version number of
85  * the filter language described by the instruction encodings below.
86  * bpf understands a program iff kernel_major == filter_major &&
87  * kernel_minor >= filter_minor, that is, if the value returned by the
88  * running kernel has the same major number and a minor number equal
89  * equal to or less than the filter being downloaded. Otherwise, the
90  * results are undefined, meaning an error may be returned or packets
91  * may be accepted haphazardly.
92  * It has nothing to do with the source code version.
93  */
94 struct bpf_version {
95  u_short bv_major;
96  u_short bv_minor;
97 };
98 /* Current version number of filter architecture. */
99 #define BPF_MAJOR_VERSION 1
100 #define BPF_MINOR_VERSION 1
101 
102 /*
103  * BPF ioctls
104  *
105  * The first set is for compatibility with Sun's pcc style
106  * header files. If your using gcc, we assume that you
107  * have run fixincludes so the latter set should work.
108  */
109 #if (defined(sun) || defined(ibm032)) && !defined(__GNUC__)
110 #define BIOCGBLEN _IOR(B,102, u_int)
111 #define BIOCSBLEN _IOWR(B,102, u_int)
112 #define BIOCSETF _IOW(B,103, struct bpf_program)
113 #define BIOCFLUSH _IO(B,104)
114 #define BIOCPROMISC _IO(B,105)
115 #define BIOCGDLT _IOR(B,106, u_int)
116 #define BIOCGETIF _IOR(B,107, struct ifreq)
117 #define BIOCSETIF _IOW(B,108, struct ifreq)
118 #define BIOCSRTIMEOUT _IOW(B,109, struct timeval)
119 #define BIOCGRTIMEOUT _IOR(B,110, struct timeval)
120 #define BIOCGSTATS _IOR(B,111, struct bpf_stat)
121 #define BIOCIMMEDIATE _IOW(B,112, u_int)
122 #define BIOCVERSION _IOR(B,113, struct bpf_version)
123 #define BIOCSTCPF _IOW(B,114, struct bpf_program)
124 #define BIOCSUDPF _IOW(B,115, struct bpf_program)
125 #else
126 #define BIOCGBLEN _IOR('B',102, u_int)
127 #define BIOCSBLEN _IOWR('B',102, u_int)
128 #define BIOCSETF _IOW('B',103, struct bpf_program)
129 #define BIOCFLUSH _IO('B',104)
130 #define BIOCPROMISC _IO('B',105)
131 #define BIOCGDLT _IOR('B',106, u_int)
132 #define BIOCGETIF _IOR('B',107, struct ifreq)
133 #define BIOCSETIF _IOW('B',108, struct ifreq)
134 #define BIOCSRTIMEOUT _IOW('B',109, struct timeval)
135 #define BIOCGRTIMEOUT _IOR('B',110, struct timeval)
136 #define BIOCGSTATS _IOR('B',111, struct bpf_stat)
137 #define BIOCIMMEDIATE _IOW('B',112, u_int)
138 #define BIOCVERSION _IOR('B',113, struct bpf_version)
139 #define BIOCSTCPF _IOW('B',114, struct bpf_program)
140 #define BIOCSUDPF _IOW('B',115, struct bpf_program)
141 #endif
142 
143 /*
144  * Structure prepended to each packet.
145  */
146 struct bpf_hdr {
147  struct timeval bh_tstamp; /* time stamp */
148  bpf_u_int32 bh_caplen; /* length of captured portion */
149  bpf_u_int32 bh_datalen; /* original length of packet */
150  u_short bh_hdrlen; /* length of bpf header (this struct
151  plus alignment padding) */
152 };
153 /*
154  * Because the structure above is not a multiple of 4 bytes, some compilers
155  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
156  * Only the kernel needs to know about it; applications use bh_hdrlen.
157  */
158 #ifdef KERNEL
159 #define SIZEOF_BPF_HDR 18
160 #endif
161 
162 /*
163  * Data-link level type codes.
164  */
165 #define DLT_NULL 0 /* no link-layer encapsulation */
166 #define DLT_EN10MB 1 /* Ethernet (10Mb) */
167 #define DLT_EN3MB 2 /* Experimental Ethernet (3Mb) */
168 #define DLT_AX25 3 /* Amateur Radio AX.25 */
169 #define DLT_PRONET 4 /* Proteon ProNET Token Ring */
170 #define DLT_CHAOS 5 /* Chaos */
171 #define DLT_IEEE802 6 /* IEEE 802 Networks */
172 #define DLT_ARCNET 7 /* ARCNET */
173 #define DLT_SLIP 8 /* Serial Line IP */
174 #define DLT_PPP 9 /* Point-to-point Protocol */
175 #define DLT_FDDI 10 /* FDDI */
176 #define DLT_ATM_RFC1483 11 /* LLC/SNAP encapsulated atm */
177 #define DLT_RAW 12 /* raw IP */
178 #define DLT_SLIP_BSDOS 13 /* BSD/OS Serial Line IP */
179 #define DLT_PPP_BSDOS 14 /* BSD/OS Point-to-point Protocol */
180 
181 /*
182  * The instruction encondings.
183  */
184 /* instruction classes */
185 #define BPF_CLASS(code) ((code) & 0x07)
186 #define BPF_LD 0x00
187 #define BPF_LDX 0x01
188 #define BPF_ST 0x02
189 #define BPF_STX 0x03
190 #define BPF_ALU 0x04
191 #define BPF_JMP 0x05
192 #define BPF_RET 0x06
193 #define BPF_MISC 0x07
194 
195 /* ld/ldx fields */
196 #define BPF_SIZE(code) ((code) & 0x18)
197 #define BPF_W 0x00
198 #define BPF_H 0x08
199 #define BPF_B 0x10
200 #define BPF_MODE(code) ((code) & 0xe0)
201 #define BPF_IMM 0x00
202 #define BPF_ABS 0x20
203 #define BPF_IND 0x40
204 #define BPF_MEM 0x60
205 #define BPF_LEN 0x80
206 #define BPF_MSH 0xa0
207 
208 /* alu/jmp fields */
209 #define BPF_OP(code) ((code) & 0xf0)
210 #define BPF_ADD 0x00
211 #define BPF_SUB 0x10
212 #define BPF_MUL 0x20
213 #define BPF_DIV 0x30
214 #define BPF_OR 0x40
215 #define BPF_AND 0x50
216 #define BPF_LSH 0x60
217 #define BPF_RSH 0x70
218 #define BPF_NEG 0x80
219 #define BPF_JA 0x00
220 #define BPF_JEQ 0x10
221 #define BPF_JGT 0x20
222 #define BPF_JGE 0x30
223 #define BPF_JSET 0x40
224 #define BPF_SRC(code) ((code) & 0x08)
225 #define BPF_K 0x00
226 #define BPF_X 0x08
227 
228 /* ret - BPF_K and BPF_X also apply */
229 #define BPF_RVAL(code) ((code) & 0x18)
230 #define BPF_A 0x10
231 
232 /* misc */
233 #define BPF_MISCOP(code) ((code) & 0xf8)
234 #define BPF_TAX 0x00
235 #define BPF_TXA 0x80
236 
237 /*
238  * The instruction data structure.
239  */
240 struct bpf_insn {
241  u_short code;
242  u_char jt;
243  u_char jf;
244  bpf_int32 k;
245 };
246 
247 /*
248  * Macros for insn array initializers.
249  */
250 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
251 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
252 
253 #ifdef KERNEL
254 extern u_int bpf_filter();
255 extern void bpfattach();
256 extern void bpf_tap();
257 extern void bpf_mtap();
258 #else
259 #if __STDC__
260 extern u_int bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
261 #endif
262 #endif
263 
264 /*
265  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
266  */
267 #define BPF_MEMWORDS 16
268 
269 #endif
A single BPF pseudo-instruction.
Definition: bpf.h:240
Structure that contains a couple of statistics values on the current capture.
Definition: bpf.h:78
A BPF pseudo-assembly program.
Definition: bpf.h:70
struct bpf_insn * bf_insns
A pointer to the first instruction of the program.
Definition: bpf.h:72
Packet header.
Definition: bpf.h:146
Definition: bpf.h:94