1/* 2 * Copyright (c) 2000-2007 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 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. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 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. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28/* 29 * Copyright (c) 1990, 1991, 1993 30 * The Regents of the University of California. All rights reserved. 31 * 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. 36 * 37 * Redistribution and use in source and binary forms, with or without 38 * modification, are permitted provided that the following conditions 39 * are met: 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. 52 * 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 63 * SUCH DAMAGE. 64 * 65 * @(#)bpf.h 8.1 (Berkeley) 6/10/93 66 * @(#)bpf.h 1.34 (LBL) 6/16/96 67 * 68 * $FreeBSD: src/sys/net/bpf.h,v 1.21.2.3 2001/08/01 00:23:13 fenner Exp $ 69 */ 70/* 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, 74 * Version 2.0. 75 */ 76 77#ifndef _NET_BPF_H_ 78#define _NET_BPF_H_ 79#include <sys/appleapiopts.h> 80#include <sys/types.h> 81#include <sys/time.h> 82#include <sys/cdefs.h> 83 84#ifdef KERNEL 85#include <sys/kernel_types.h> 86#endif 87 88/* BSD style release date */ 89#define BPF_RELEASE 199606 90 91typedef int32_t bpf_int32; 92typedef u_int32_t bpf_u_int32; 93 94/* 95 * Alignment macros. BPF_WORDALIGN rounds up to the next 96 * even multiple of BPF_ALIGNMENT. 97 */ 98#define BPF_ALIGNMENT sizeof(int32_t) 99#define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1)) 100 101#define BPF_MAXINSNS 512 102#define BPF_MAXBUFSIZE 0x80000 103#define BPF_MINBUFSIZE 32 104 105/* 106 * Structure for BIOCSETF. 107 */ 108struct bpf_program { 109 u_int bf_len; 110 struct bpf_insn *bf_insns; 111}; 112 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 117 */ 118struct bpf_program64 { 119 u_int bf_len; 120 user_addr_t bf_insns __attribute__((aligned(8))); 121}; 122 123#endif // KERNEL_PRIVATE 124 125/* 126 * Struct returned by BIOCGSTATS. 127 */ 128struct bpf_stat { 129 u_int bs_recv; /* number of packets received */ 130 u_int bs_drop; /* number of packets dropped */ 131}; 132 133/* 134 * Struct return by BIOCVERSION. This represents the version number of 135 * the filter language described by the instruction encodings below. 136 * bpf understands a program iff kernel_major == filter_major && 137 * kernel_minor >= filter_minor, that is, if the value returned by the 138 * running kernel has the same major number and a minor number equal 139 * equal to or less than the filter being downloaded. Otherwise, the 140 * results are undefined, meaning an error may be returned or packets 141 * may be accepted haphazardly. 142 * It has nothing to do with the source code version. 143 */ 144struct bpf_version { 145 u_short bv_major; 146 u_short bv_minor; 147}; 148#if defined(__LP64__) 149#define __need_struct_timeval32 150#include <sys/_structs.h> 151#define BPF_TIMEVAL timeval32 152#else 153#define BPF_TIMEVAL timeval 154#endif 155/* Current version number of filter architecture. */ 156#define BPF_MAJOR_VERSION 1 157#define BPF_MINOR_VERSION 1 158 159#define BIOCGBLEN _IOR('B',102, u_int) 160#define BIOCSBLEN _IOWR('B',102, u_int) 161#define BIOCSETF _IOW('B',103, struct bpf_program) 162#ifdef KERNEL_PRIVATE 163#define BIOCSETF64 _IOW('B',103, struct bpf_program64) 164#endif // KERNEL_PRIVATE 165#define BIOCFLUSH _IO('B',104) 166#define BIOCPROMISC _IO('B',105) 167#define BIOCGDLT _IOR('B',106, u_int) 168#define BIOCGETIF _IOR('B',107, struct ifreq) 169#define BIOCSETIF _IOW('B',108, struct ifreq) 170#define BIOCSRTIMEOUT _IOW('B',109, struct BPF_TIMEVAL) 171#define BIOCGRTIMEOUT _IOR('B',110, struct BPF_TIMEVAL) 172#define BIOCGSTATS _IOR('B',111, struct bpf_stat) 173#define BIOCIMMEDIATE _IOW('B',112, u_int) 174#define BIOCVERSION _IOR('B',113, struct bpf_version) 175#define BIOCGRSIG _IOR('B',114, u_int) 176#define BIOCSRSIG _IOW('B',115, u_int) 177#define BIOCGHDRCMPLT _IOR('B',116, u_int) 178#define BIOCSHDRCMPLT _IOW('B',117, u_int) 179#define BIOCGSEESENT _IOR('B',118, u_int) 180#define BIOCSSEESENT _IOW('B',119, u_int) 181#define BIOCSDLT _IOW('B',120, u_int) 182#define BIOCGDLTLIST _IOWR('B',121, struct bpf_dltlist) 183 184/* 185 * Structure prepended to each packet. 186 */ 187struct bpf_hdr { 188 struct BPF_TIMEVAL bh_tstamp; /* time stamp */ 189 bpf_u_int32 bh_caplen; /* length of captured portion */ 190 bpf_u_int32 bh_datalen; /* original length of packet */ 191 u_short bh_hdrlen; /* length of bpf header (this struct 192 plus alignment padding) */ 193}; 194/* 195 * Because the structure above is not a multiple of 4 bytes, some compilers 196 * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work. 197 * Only the kernel needs to know about it; applications use bh_hdrlen. 198 */ 199#ifdef KERNEL 200#define SIZEOF_BPF_HDR (sizeof(struct bpf_hdr) <= 20 ? 18 : \ 201 sizeof(struct bpf_hdr)) 202#endif 203 204/* 205 * Data-link level type codes. 206 */ 207#define DLT_NULL 0 /* no link-layer encapsulation */ 208#define DLT_EN10MB 1 /* Ethernet (10Mb) */ 209#define DLT_EN3MB 2 /* Experimental Ethernet (3Mb) */ 210#define DLT_AX25 3 /* Amateur Radio AX.25 */ 211#define DLT_PRONET 4 /* Proteon ProNET Token Ring */ 212#define DLT_CHAOS 5 /* Chaos */ 213#define DLT_IEEE802 6 /* IEEE 802 Networks */ 214#define DLT_ARCNET 7 /* ARCNET */ 215#define DLT_SLIP 8 /* Serial Line IP */ 216#define DLT_PPP 9 /* Point-to-point Protocol */ 217#define DLT_FDDI 10 /* FDDI */ 218#define DLT_ATM_RFC1483 11 /* LLC/SNAP encapsulated atm */ 219#define DLT_RAW 12 /* raw IP */ 220#define DLT_APPLE_IP_OVER_IEEE1394 138 221 222/* 223 * These are values from BSD/OS's "bpf.h". 224 * These are not the same as the values from the traditional libpcap 225 * "bpf.h"; however, these values shouldn't be generated by any 226 * OS other than BSD/OS, so the correct values to use here are the 227 * BSD/OS values. 228 * 229 * Platforms that have already assigned these values to other 230 * DLT_ codes, however, should give these codes the values 231 * from that platform, so that programs that use these codes will 232 * continue to compile - even though they won't correctly read 233 * files of these types. 234 */ 235#define DLT_SLIP_BSDOS 15 /* BSD/OS Serial Line IP */ 236#define DLT_PPP_BSDOS 16 /* BSD/OS Point-to-point Protocol */ 237 238#define DLT_ATM_CLIP 19 /* Linux Classical-IP over ATM */ 239 240/* 241 * This value is defined by NetBSD; other platforms should refrain from 242 * using it for other purposes, so that NetBSD savefiles with a link 243 * type of 50 can be read as this type on all platforms. 244 */ 245#define DLT_PPP_SERIAL 50 /* PPP over serial with HDLC encapsulation */ 246 247/* 248 * This value was defined by libpcap 0.5; platforms that have defined 249 * it with a different value should define it here with that value - 250 * a link type of 104 in a save file will be mapped to DLT_C_HDLC, 251 * whatever value that happens to be, so programs will correctly 252 * handle files with that link type regardless of the value of 253 * DLT_C_HDLC. 254 * 255 * The name DLT_C_HDLC was used by BSD/OS; we use that name for source 256 * compatibility with programs written for BSD/OS. 257 * 258 * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well, 259 * for source compatibility with programs written for libpcap 0.5. 260 */ 261#define DLT_C_HDLC 104 /* Cisco HDLC */ 262#define DLT_CHDLC DLT_C_HDLC 263 264/* 265 * Reserved for future use. 266 * Do not pick other numerical value for these unless you have also 267 * picked up the tcpdump.org top-of-CVS-tree version of "savefile.c", 268 * which will arrange that capture files for these DLT_ types have 269 * the same "network" value on all platforms, regardless of what 270 * value is chosen for their DLT_ type (thus allowing captures made 271 * on one platform to be read on other platforms, even if the two 272 * platforms don't use the same numerical values for all DLT_ types). 273 */ 274#define DLT_IEEE802_11 105 /* IEEE 802.11 wireless */ 275 276/* 277 * Values between 106 and 107 are used in capture file headers as 278 * link-layer types corresponding to DLT_ types that might differ 279 * between platforms; don't use those values for new DLT_ new types. 280 */ 281 282/* 283 * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except 284 * that the AF_ type in the link-layer header is in network byte order. 285 * 286 * OpenBSD defines it as 12, but that collides with DLT_RAW, so we 287 * define it as 108 here. If OpenBSD picks up this file, it should 288 * define DLT_LOOP as 12 in its version, as per the comment above - 289 * and should not use 108 for any purpose. 290 */ 291#define DLT_LOOP 108 292 293/* 294 * Values between 109 and 112 are used in capture file headers as 295 * link-layer types corresponding to DLT_ types that might differ 296 * between platforms; don't use those values for new DLT_ new types. 297 */ 298 299/* 300 * This is for Linux cooked sockets. 301 */ 302#define DLT_LINUX_SLL 113 303 304/* 305 * The instruction encodings. 306 */ 307/* instruction classes */ 308#define BPF_CLASS(code) ((code) & 0x07) 309#define BPF_LD 0x00 310#define BPF_LDX 0x01 311#define BPF_ST 0x02 312#define BPF_STX 0x03 313#define BPF_ALU 0x04 314#define BPF_JMP 0x05 315#define BPF_RET 0x06 316#define BPF_MISC 0x07 317 318/* ld/ldx fields */ 319#define BPF_SIZE(code) ((code) & 0x18) 320#define BPF_W 0x00 321#define BPF_H 0x08 322#define BPF_B 0x10 323#define BPF_MODE(code) ((code) & 0xe0) 324#define BPF_IMM 0x00 325#define BPF_ABS 0x20 326#define BPF_IND 0x40 327#define BPF_MEM 0x60 328#define BPF_LEN 0x80 329#define BPF_MSH 0xa0 330 331/* alu/jmp fields */ 332#define BPF_OP(code) ((code) & 0xf0) 333#define BPF_ADD 0x00 334#define BPF_SUB 0x10 335#define BPF_MUL 0x20 336#define BPF_DIV 0x30 337#define BPF_OR 0x40 338#define BPF_AND 0x50 339#define BPF_LSH 0x60 340#define BPF_RSH 0x70 341#define BPF_NEG 0x80 342#define BPF_JA 0x00 343#define BPF_JEQ 0x10 344#define BPF_JGT 0x20 345#define BPF_JGE 0x30 346#define BPF_JSET 0x40 347#define BPF_SRC(code) ((code) & 0x08) 348#define BPF_K 0x00 349#define BPF_X 0x08 350 351/* ret - BPF_K and BPF_X also apply */ 352#define BPF_RVAL(code) ((code) & 0x18) 353#define BPF_A 0x10 354 355/* misc */ 356#define BPF_MISCOP(code) ((code) & 0xf8) 357#define BPF_TAX 0x00 358#define BPF_TXA 0x80 359 360/* 361 * The instruction data structure. 362 */ 363struct bpf_insn { 364 u_short code; 365 u_char jt; 366 u_char jf; 367 bpf_u_int32 k; 368}; 369 370/* 371 * Macros for insn array initializers. 372 */ 373#define BPF_STMT(code, k) { (u_short)(code), 0, 0, k } 374#define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k } 375 376#pragma pack(4) 377 378/* 379 * Structure to retrieve available DLTs for the interface. 380 */ 381struct bpf_dltlist { 382 u_int32_t bfl_len; /* number of bfd_list array */ 383 union { 384 u_int32_t *bflu_list; /* array of DLTs */ 385 u_int64_t bflu_pad; 386 } bfl_u; 387}; 388#define bfl_list bfl_u.bflu_list 389 390#pragma pack() 391 392#ifdef KERNEL_PRIVATE 393/* Forward declerations */ 394struct ifnet; 395struct mbuf; 396 397int bpf_validate(const struct bpf_insn *, int); 398void bpfdetach(struct ifnet *); 399void bpfilterattach(int); 400u_int bpf_filter(const struct bpf_insn *, u_char *, u_int, u_int); 401 402#endif /* KERNEL_PRIVATE */ 403 404#ifdef KERNEL 405#ifndef BPF_TAP_MODE_T 406#define BPF_TAP_MODE_T 407/*! 408 @enum BPF tap mode 409 @abstract Constants defining interface families. 410 @constant BPF_MODE_DISABLED Disable bpf. 411 @constant BPF_MODE_INPUT Enable input only. 412 @constant BPF_MODE_OUTPUT Enable output only. 413 @constant BPF_MODE_INPUT_OUTPUT Enable input and output. 414*/ 415 416enum { 417 BPF_MODE_DISABLED = 0, 418 BPF_MODE_INPUT = 1, 419 BPF_MODE_OUTPUT = 2, 420 BPF_MODE_INPUT_OUTPUT = 3 421}; 422/*! 423 @typedef bpf_tap_mode 424 @abstract Mode for tapping. BPF_MODE_DISABLED/BPF_MODE_INPUT_OUTPUT etc. 425*/ 426typedef u_int32_t bpf_tap_mode; 427#endif /* !BPF_TAP_MODE_T */ 428 429/*! 430 @typedef bpf_send_func 431 @discussion bpf_send_func is called when a bpf file descriptor is 432 used to send a raw packet on the interface. The mbuf and data 433 link type are specified. The callback is responsible for 434 releasing the mbuf whether or not it returns an error. 435 @param interface The interface the packet is being sent on. 436 @param dlt The data link type the bpf device is attached to. 437 @param packet The packet to be sent. 438 */ 439typedef errno_t (*bpf_send_func)(ifnet_t interface, u_int32_t data_link_type, 440 mbuf_t packet); 441 442/*! 443 @typedef bpf_tap_func 444 @discussion bpf_tap_func is called when the tap state of the 445 interface changes. This happens when a bpf device attaches to an 446 interface or detaches from an interface. The tap mode will join 447 together (bit or) the modes of all bpf devices using that 448 interface for that dlt. If you return an error from this 449 function, the bpf device attach attempt that triggered the tap 450 will fail. If this function was called bacuse the tap state was 451 decreasing (tap in or out is stopping), the error will be 452 ignored. 453 @param interface The interface being tapped. 454 @param dlt The data link type being tapped. 455 @param direction The direction of the tap. 456 */ 457typedef errno_t (*bpf_tap_func)(ifnet_t interface, u_int32_t data_link_type, 458 bpf_tap_mode direction); 459 460/*! 461 @function bpfattach 462 @discussion Registers an interface with BPF. This allows bpf devices 463 to attach to your interface to capture packets. Your interface 464 will be unregistered automatically when your interface is 465 detached. 466 @param interface The interface to register with BPF. 467 @param data_link_type The data link type of the interface. See the 468 DLT_* defines in bpf.h. 469 @param header_length The length, in bytes, of the data link header. 470 */ 471void bpfattach(ifnet_t interface, u_int data_link_type, u_int header_length); 472 473/*! 474 @function bpf_attach 475 @discussion Registers an interface with BPF. This allows bpf devices 476 to attach to your interface to capture and transmit packets. 477 Your interface will be unregistered automatically when your 478 interface is detached. You may register multiple times with 479 different data link types. An 802.11 interface would use this to 480 allow clients to pick whether they want just an ethernet style 481 frame or the 802.11 wireless headers as well. The first dlt you 482 register will be considered the default. Any bpf device attaches 483 that do not specify a data link type will use the default. 484 @param interface The interface to register with BPF. 485 @param data_link_type The data link type of the interface. See the 486 DLT_* defines in bpf.h. 487 @param header_length The length, in bytes, of the data link header. 488 */ 489errno_t bpf_attach(ifnet_t interface, u_int32_t data_link_type, 490 u_int32_t header_length, bpf_send_func send, 491 bpf_tap_func tap); 492 493/*! 494 @function bpf_tap_in 495 @discussion Call this function when your interface receives a 496 packet. This function will check if any bpf devices need a 497 a copy of the packet. 498 @param interface The interface the packet was received on. 499 @param dlt The data link type of the packet. 500 @param packet The packet received. 501 @param header An optional pointer to a header that will be prepended. 502 @param headerlen If the header was specified, the length of the header. 503 */ 504void bpf_tap_in(ifnet_t interface, u_int32_t dlt, mbuf_t packet, 505 void* header, size_t header_len); 506 507/*! 508 @function bpf_tap_out 509 @discussion Call this function when your interface trasmits a 510 packet. This function will check if any bpf devices need a 511 a copy of the packet. 512 @param interface The interface the packet was or will be transmitted on. 513 @param dlt The data link type of the packet. 514 @param packet The packet received. 515 @param header An optional pointer to a header that will be prepended. 516 @param headerlen If the header was specified, the length of the header. 517 */ 518void bpf_tap_out(ifnet_t interface, u_int32_t dlt, mbuf_t packet, 519 void* header, size_t header_len); 520 521#endif /* KERNEL */ 522 523/* 524 * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST). 525 */ 526#define BPF_MEMWORDS 16 527 528#endif 529