]>
git.saurik.com Git - apple/xnu.git/blob - bsd/net/bpf.h
2 * Copyright (c) 2000-2008 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 * Copyright (c) 1990, 1991, 1993
30 * The Regents of the University of California. All rights reserved.
32 * This code is derived from the Stanford/CMU enet packet filter,
33 * (net/enet.c) distributed as part of 4.3BSD, and code contributed
34 * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
35 * Berkeley Laboratory.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
40 * 1. Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * 2. Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in the
44 * documentation and/or other materials provided with the distribution.
45 * 3. All advertising materials mentioning features or use of this software
46 * must display the following acknowledgement:
47 * This product includes software developed by the University of
48 * California, Berkeley and its contributors.
49 * 4. Neither the name of the University nor the names of its contributors
50 * may be used to endorse or promote products derived from this software
51 * without specific prior written permission.
53 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
65 * @(#)bpf.h 8.1 (Berkeley) 6/10/93
66 * @(#)bpf.h 1.34 (LBL) 6/16/96
68 * $FreeBSD: src/sys/net/bpf.h,v 1.21.2.3 2001/08/01 00:23:13 fenner Exp $
71 * NOTICE: This file was modified by SPARTA, Inc. in 2006 to introduce
72 * support for mandatory and extensible security protections. This notice
73 * is included in support of clause 2.2 (b) of the Apple Public License,
79 #include <sys/appleapiopts.h>
80 #include <sys/types.h>
82 #include <sys/cdefs.h>
85 #include <sys/kernel_types.h>
88 /* BSD style release date */
89 #define BPF_RELEASE 199606
91 typedef int32_t bpf_int32
;
92 typedef u_int32_t bpf_u_int32
;
95 * Alignment macros. BPF_WORDALIGN rounds up to the next
96 * even multiple of BPF_ALIGNMENT.
98 #define BPF_ALIGNMENT sizeof(int32_t)
99 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
101 #define BPF_MAXINSNS 512
102 #define BPF_MAXBUFSIZE 0x80000
103 #define BPF_MINBUFSIZE 32
106 * Structure for BIOCSETF.
110 struct bpf_insn
*bf_insns
;
113 #ifdef KERNEL_PRIVATE
114 /* LP64 version of bpf_program. all pointers
115 * grow when we're dealing with a 64-bit process.
116 * WARNING - keep in sync with bpf_program
118 struct bpf_program64
{
120 user64_addr_t bf_insns
__attribute__((aligned(8)));
123 struct bpf_program32
{
125 user32_addr_t bf_insns
;
127 #endif /* KERNEL_PRIVATE */
130 * Struct returned by BIOCGSTATS.
133 u_int bs_recv
; /* number of packets received */
134 u_int bs_drop
; /* number of packets dropped */
138 * Struct return by BIOCVERSION. This represents the version number of
139 * the filter language described by the instruction encodings below.
140 * bpf understands a program iff kernel_major == filter_major &&
141 * kernel_minor >= filter_minor, that is, if the value returned by the
142 * running kernel has the same major number and a minor number equal
143 * equal to or less than the filter being downloaded. Otherwise, the
144 * results are undefined, meaning an error may be returned or packets
145 * may be accepted haphazardly.
146 * It has nothing to do with the source code version.
152 #if defined(__LP64__)
153 #define __need_struct_timeval32
154 #include <sys/_structs.h>
155 #define BPF_TIMEVAL timeval32
157 #define BPF_TIMEVAL timeval
158 #endif /* __LP64__ */
159 /* Current version number of filter architecture. */
160 #define BPF_MAJOR_VERSION 1
161 #define BPF_MINOR_VERSION 1
163 #define BIOCGBLEN _IOR('B',102, u_int)
164 #define BIOCSBLEN _IOWR('B',102, u_int)
165 #define BIOCSETF _IOW('B',103, struct bpf_program)
166 #ifdef KERNEL_PRIVATE
167 #define BIOCSETF64 _IOW('B',103, struct bpf_program64)
168 #define BIOCSETF32 _IOW('B',103, struct bpf_program32)
169 #endif /* KERNEL_PRIVATE */
170 #define BIOCFLUSH _IO('B',104)
171 #define BIOCPROMISC _IO('B',105)
172 #define BIOCGDLT _IOR('B',106, u_int)
173 #define BIOCGETIF _IOR('B',107, struct ifreq)
174 #define BIOCSETIF _IOW('B',108, struct ifreq)
175 #define BIOCSRTIMEOUT _IOW('B',109, struct BPF_TIMEVAL)
176 #define BIOCGRTIMEOUT _IOR('B',110, struct BPF_TIMEVAL)
177 #define BIOCGSTATS _IOR('B',111, struct bpf_stat)
178 #define BIOCIMMEDIATE _IOW('B',112, u_int)
179 #define BIOCVERSION _IOR('B',113, struct bpf_version)
180 #define BIOCGRSIG _IOR('B',114, u_int)
181 #define BIOCSRSIG _IOW('B',115, u_int)
182 #define BIOCGHDRCMPLT _IOR('B',116, u_int)
183 #define BIOCSHDRCMPLT _IOW('B',117, u_int)
184 #define BIOCGSEESENT _IOR('B',118, u_int)
185 #define BIOCSSEESENT _IOW('B',119, u_int)
186 #define BIOCSDLT _IOW('B',120, u_int)
187 #define BIOCGDLTLIST _IOWR('B',121, struct bpf_dltlist)
190 * Structure prepended to each packet.
193 struct BPF_TIMEVAL bh_tstamp
; /* time stamp */
194 bpf_u_int32 bh_caplen
; /* length of captured portion */
195 bpf_u_int32 bh_datalen
; /* original length of packet */
196 u_short bh_hdrlen
; /* length of bpf header (this struct
197 plus alignment padding) */
200 * Because the structure above is not a multiple of 4 bytes, some compilers
201 * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
202 * Only the kernel needs to know about it; applications use bh_hdrlen.
205 #define SIZEOF_BPF_HDR (sizeof(struct bpf_hdr) <= 20 ? 18 : \
206 sizeof(struct bpf_hdr))
210 * Data-link level type codes.
212 #define DLT_NULL 0 /* no link-layer encapsulation */
213 #define DLT_EN10MB 1 /* Ethernet (10Mb) */
214 #define DLT_EN3MB 2 /* Experimental Ethernet (3Mb) */
215 #define DLT_AX25 3 /* Amateur Radio AX.25 */
216 #define DLT_PRONET 4 /* Proteon ProNET Token Ring */
217 #define DLT_CHAOS 5 /* Chaos */
218 #define DLT_IEEE802 6 /* IEEE 802 Networks */
219 #define DLT_ARCNET 7 /* ARCNET */
220 #define DLT_SLIP 8 /* Serial Line IP */
221 #define DLT_PPP 9 /* Point-to-point Protocol */
222 #define DLT_FDDI 10 /* FDDI */
223 #define DLT_ATM_RFC1483 11 /* LLC/SNAP encapsulated atm */
224 #define DLT_RAW 12 /* raw IP */
227 * These are values from BSD/OS's "bpf.h".
228 * These are not the same as the values from the traditional libpcap
229 * "bpf.h"; however, these values shouldn't be generated by any
230 * OS other than BSD/OS, so the correct values to use here are the
233 * Platforms that have already assigned these values to other
234 * DLT_ codes, however, should give these codes the values
235 * from that platform, so that programs that use these codes will
236 * continue to compile - even though they won't correctly read
237 * files of these types.
239 #define DLT_SLIP_BSDOS 15 /* BSD/OS Serial Line IP */
240 #define DLT_PPP_BSDOS 16 /* BSD/OS Point-to-point Protocol */
242 #define DLT_PFSYNC 18 /* Packet filter state syncing */
243 #define DLT_ATM_CLIP 19 /* Linux Classical-IP over ATM */
246 * This value is defined by NetBSD; other platforms should refrain from
247 * using it for other purposes, so that NetBSD savefiles with a link
248 * type of 50 can be read as this type on all platforms.
250 #define DLT_PPP_SERIAL 50 /* PPP over serial with HDLC encapsulation */
253 * This value was defined by libpcap 0.5; platforms that have defined
254 * it with a different value should define it here with that value -
255 * a link type of 104 in a save file will be mapped to DLT_C_HDLC,
256 * whatever value that happens to be, so programs will correctly
257 * handle files with that link type regardless of the value of
260 * The name DLT_C_HDLC was used by BSD/OS; we use that name for source
261 * compatibility with programs written for BSD/OS.
263 * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well,
264 * for source compatibility with programs written for libpcap 0.5.
266 #define DLT_C_HDLC 104 /* Cisco HDLC */
267 #define DLT_CHDLC DLT_C_HDLC
270 * Reserved for future use.
271 * Do not pick other numerical value for these unless you have also
272 * picked up the tcpdump.org top-of-CVS-tree version of "savefile.c",
273 * which will arrange that capture files for these DLT_ types have
274 * the same "network" value on all platforms, regardless of what
275 * value is chosen for their DLT_ type (thus allowing captures made
276 * on one platform to be read on other platforms, even if the two
277 * platforms don't use the same numerical values for all DLT_ types).
279 #define DLT_IEEE802_11 105 /* IEEE 802.11 wireless */
282 * Values between 106 and 107 are used in capture file headers as
283 * link-layer types corresponding to DLT_ types that might differ
284 * between platforms; don't use those values for new DLT_ new types.
288 * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except
289 * that the AF_ type in the link-layer header is in network byte order.
291 * OpenBSD defines it as 12, but that collides with DLT_RAW, so we
292 * define it as 108 here. If OpenBSD picks up this file, it should
293 * define DLT_LOOP as 12 in its version, as per the comment above -
294 * and should not use 108 for any purpose.
299 * Values between 109 and 112 are used in capture file headers as
300 * link-layer types corresponding to DLT_ types that might differ
301 * between platforms; don't use those values for new DLT_ new types.
305 * This is for Linux cooked sockets.
307 #define DLT_LINUX_SLL 113
310 * For use in capture-file headers as a link-layer type corresponding
311 * to OpenBSD PF (Packet Filter) log.
313 #define DLT_PFLOG 117
316 * BSD header for 802.11 plus a number of bits of link-layer information
317 * including radio information.
319 #ifndef DLT_IEEE802_11_RADIO
320 #define DLT_IEEE802_11_RADIO 127
324 * Apple IP-over-IEEE 1394, as per a request from Dieter Siegmund
325 * <dieter@apple.com>. The header that's presented is an Ethernet-like
328 * #define FIREWIRE_EUI64_LEN 8
329 * struct firewire_header {
330 * u_char firewire_dhost[FIREWIRE_EUI64_LEN];
331 * u_char firewire_shost[FIREWIRE_EUI64_LEN];
332 * u_short firewire_type;
335 * with "firewire_type" being an Ethernet type value, rather than,
336 * for example, raw GASP frames being handed up.
338 #define DLT_APPLE_IP_OVER_IEEE1394 138
341 * For future use with 802.11 captures - defined by AbsoluteValue
342 * Systems to store a number of bits of link-layer information
343 * including radio information:
345 * http://www.shaftnet.org/~pizza/software/capturefrm.txt
347 * but it might be used by some non-AVS drivers now or in the
350 #define DLT_IEEE802_11_RADIO_AVS 163 /* 802.11 plus AVS radio header */
354 * The instruction encodings.
356 /* instruction classes */
357 #define BPF_CLASS(code) ((code) & 0x07)
365 #define BPF_MISC 0x07
368 #define BPF_SIZE(code) ((code) & 0x18)
372 #define BPF_MODE(code) ((code) & 0xe0)
381 #define BPF_OP(code) ((code) & 0xf0)
395 #define BPF_JSET 0x40
396 #define BPF_SRC(code) ((code) & 0x08)
400 /* ret - BPF_K and BPF_X also apply */
401 #define BPF_RVAL(code) ((code) & 0x18)
405 #define BPF_MISCOP(code) ((code) & 0xf8)
410 * The instruction data structure.
420 * Macros for insn array initializers.
422 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
423 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
428 * Structure to retrieve available DLTs for the interface.
431 u_int32_t bfl_len
; /* number of bfd_list array */
433 u_int32_t
*bflu_list
; /* array of DLTs */
437 #define bfl_list bfl_u.bflu_list
441 #ifdef KERNEL_PRIVATE
442 /* Forward declerations */
446 extern int bpf_validate(const struct bpf_insn
*, int);
447 extern void bpfdetach(struct ifnet
*);
448 extern void bpfilterattach(int);
449 extern u_int
bpf_filter(const struct bpf_insn
*, u_char
*, u_int
, u_int
);
450 #endif /* KERNEL_PRIVATE */
453 #ifndef BPF_TAP_MODE_T
454 #define BPF_TAP_MODE_T
457 @abstract Constants defining interface families.
458 @constant BPF_MODE_DISABLED Disable bpf.
459 @constant BPF_MODE_INPUT Enable input only.
460 @constant BPF_MODE_OUTPUT Enable output only.
461 @constant BPF_MODE_INPUT_OUTPUT Enable input and output.
465 BPF_MODE_DISABLED
= 0,
468 BPF_MODE_INPUT_OUTPUT
= 3
471 @typedef bpf_tap_mode
472 @abstract Mode for tapping. BPF_MODE_DISABLED/BPF_MODE_INPUT_OUTPUT etc.
474 typedef u_int32_t bpf_tap_mode
;
475 #endif /* !BPF_TAP_MODE_T */
478 @typedef bpf_send_func
479 @discussion bpf_send_func is called when a bpf file descriptor is
480 used to send a raw packet on the interface. The mbuf and data
481 link type are specified. The callback is responsible for
482 releasing the mbuf whether or not it returns an error.
483 @param interface The interface the packet is being sent on.
484 @param dlt The data link type the bpf device is attached to.
485 @param packet The packet to be sent.
487 typedef errno_t (*bpf_send_func
)(ifnet_t interface
, u_int32_t data_link_type
,
491 @typedef bpf_tap_func
492 @discussion bpf_tap_func is called when the tap state of the
493 interface changes. This happens when a bpf device attaches to an
494 interface or detaches from an interface. The tap mode will join
495 together (bit or) the modes of all bpf devices using that
496 interface for that dlt. If you return an error from this
497 function, the bpf device attach attempt that triggered the tap
498 will fail. If this function was called bacuse the tap state was
499 decreasing (tap in or out is stopping), the error will be
501 @param interface The interface being tapped.
502 @param dlt The data link type being tapped.
503 @param direction The direction of the tap.
505 typedef errno_t (*bpf_tap_func
)(ifnet_t interface
, u_int32_t data_link_type
,
506 bpf_tap_mode direction
);
510 @discussion Registers an interface with BPF. This allows bpf devices
511 to attach to your interface to capture packets. Your interface
512 will be unregistered automatically when your interface is
514 @param interface The interface to register with BPF.
515 @param data_link_type The data link type of the interface. See the
516 DLT_* defines in bpf.h.
517 @param header_length The length, in bytes, of the data link header.
519 extern void bpfattach(ifnet_t interface
, u_int data_link_type
,
520 u_int header_length
);
524 @discussion Registers an interface with BPF. This allows bpf devices
525 to attach to your interface to capture and transmit packets.
526 Your interface will be unregistered automatically when your
527 interface is detached. You may register multiple times with
528 different data link types. An 802.11 interface would use this to
529 allow clients to pick whether they want just an ethernet style
530 frame or the 802.11 wireless headers as well. The first dlt you
531 register will be considered the default. Any bpf device attaches
532 that do not specify a data link type will use the default.
533 @param interface The interface to register with BPF.
534 @param data_link_type The data link type of the interface. See the
535 DLT_* defines in bpf.h.
536 @param header_length The length, in bytes, of the data link header.
538 extern errno_t
bpf_attach(ifnet_t interface
, u_int32_t data_link_type
,
539 u_int32_t header_length
, bpf_send_func send
, bpf_tap_func tap
);
543 @discussion Call this function when your interface receives a
544 packet. This function will check if any bpf devices need a
545 a copy of the packet.
546 @param interface The interface the packet was received on.
547 @param dlt The data link type of the packet.
548 @param packet The packet received.
549 @param header An optional pointer to a header that will be prepended.
550 @param headerlen If the header was specified, the length of the header.
552 extern void bpf_tap_in(ifnet_t interface
, u_int32_t dlt
, mbuf_t packet
,
553 void *header
, size_t header_len
);
556 @function bpf_tap_out
557 @discussion Call this function when your interface trasmits a
558 packet. This function will check if any bpf devices need a
559 a copy of the packet.
560 @param interface The interface the packet was or will be transmitted on.
561 @param dlt The data link type of the packet.
562 @param packet The packet received.
563 @param header An optional pointer to a header that will be prepended.
564 @param headerlen If the header was specified, the length of the header.
566 extern void bpf_tap_out(ifnet_t interface
, u_int32_t dlt
, mbuf_t packet
,
567 void *header
, size_t header_len
);
572 * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
574 #define BPF_MEMWORDS 16
576 #endif /* _NET_BPF_H_ */