]>
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 timeval) 
 176 #ifdef KERNEL_PRIVATE 
 177 #define BIOCSRTIMEOUT64 _IOW('B',109, struct user64_timeval) 
 178 #define BIOCSRTIMEOUT32 _IOW('B',109, struct user32_timeval) 
 179 #endif /* KERNEL_PRIVATE */ 
 180 #define BIOCGRTIMEOUT   _IOR('B',110, struct timeval) 
 181 #ifdef KERNEL_PRIVATE 
 182 #define BIOCGRTIMEOUT64 _IOR('B',110, struct user64_timeval) 
 183 #define BIOCGRTIMEOUT32 _IOR('B',110, struct user32_timeval) 
 184 #endif /* KERNEL_PRIVATE */ 
 185 #define BIOCGSTATS      _IOR('B',111, struct bpf_stat) 
 186 #define BIOCIMMEDIATE   _IOW('B',112, u_int) 
 187 #define BIOCVERSION     _IOR('B',113, struct bpf_version) 
 188 #define BIOCGRSIG       _IOR('B',114, u_int) 
 189 #define BIOCSRSIG       _IOW('B',115, u_int) 
 190 #define BIOCGHDRCMPLT   _IOR('B',116, u_int) 
 191 #define BIOCSHDRCMPLT   _IOW('B',117, u_int) 
 192 #define BIOCGSEESENT    _IOR('B',118, u_int) 
 193 #define BIOCSSEESENT    _IOW('B',119, u_int) 
 194 #define BIOCSDLT        _IOW('B',120, u_int) 
 195 #define BIOCGDLTLIST    _IOWR('B',121, struct bpf_dltlist) 
 198  * Structure prepended to each packet. 
 201         struct BPF_TIMEVAL bh_tstamp
;   /* time stamp */ 
 202         bpf_u_int32     bh_caplen
;      /* length of captured portion */ 
 203         bpf_u_int32     bh_datalen
;     /* original length of packet */ 
 204         u_short         bh_hdrlen
;      /* length of bpf header (this struct 
 205                                            plus alignment padding) */ 
 208  * Because the structure above is not a multiple of 4 bytes, some compilers 
 209  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work. 
 210  * Only the kernel needs to know about it; applications use bh_hdrlen. 
 213 #define SIZEOF_BPF_HDR  (sizeof(struct bpf_hdr) <= 20 ? 18 : \ 
 214     sizeof(struct bpf_hdr)) 
 218  * Data-link level type codes. 
 220 #define DLT_NULL        0       /* no link-layer encapsulation */ 
 221 #define DLT_EN10MB      1       /* Ethernet (10Mb) */ 
 222 #define DLT_EN3MB       2       /* Experimental Ethernet (3Mb) */ 
 223 #define DLT_AX25        3       /* Amateur Radio AX.25 */ 
 224 #define DLT_PRONET      4       /* Proteon ProNET Token Ring */ 
 225 #define DLT_CHAOS       5       /* Chaos */ 
 226 #define DLT_IEEE802     6       /* IEEE 802 Networks */ 
 227 #define DLT_ARCNET      7       /* ARCNET */ 
 228 #define DLT_SLIP        8       /* Serial Line IP */ 
 229 #define DLT_PPP         9       /* Point-to-point Protocol */ 
 230 #define DLT_FDDI        10      /* FDDI */ 
 231 #define DLT_ATM_RFC1483 11      /* LLC/SNAP encapsulated atm */ 
 232 #define DLT_RAW         12      /* raw IP */ 
 235  * These are values from BSD/OS's "bpf.h". 
 236  * These are not the same as the values from the traditional libpcap 
 237  * "bpf.h"; however, these values shouldn't be generated by any 
 238  * OS other than BSD/OS, so the correct values to use here are the 
 241  * Platforms that have already assigned these values to other 
 242  * DLT_ codes, however, should give these codes the values 
 243  * from that platform, so that programs that use these codes will 
 244  * continue to compile - even though they won't correctly read 
 245  * files of these types. 
 247 #define DLT_SLIP_BSDOS  15      /* BSD/OS Serial Line IP */ 
 248 #define DLT_PPP_BSDOS   16      /* BSD/OS Point-to-point Protocol */ 
 250 #define DLT_PFSYNC      18      /* Packet filter state syncing */ 
 251 #define DLT_ATM_CLIP    19      /* Linux Classical-IP over ATM */ 
 254  * This value is defined by NetBSD; other platforms should refrain from 
 255  * using it for other purposes, so that NetBSD savefiles with a link 
 256  * type of 50 can be read as this type on all platforms. 
 258 #define DLT_PPP_SERIAL  50      /* PPP over serial with HDLC encapsulation */ 
 261  * This value was defined by libpcap 0.5; platforms that have defined 
 262  * it with a different value should define it here with that value - 
 263  * a link type of 104 in a save file will be mapped to DLT_C_HDLC, 
 264  * whatever value that happens to be, so programs will correctly 
 265  * handle files with that link type regardless of the value of 
 268  * The name DLT_C_HDLC was used by BSD/OS; we use that name for source 
 269  * compatibility with programs written for BSD/OS. 
 271  * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well, 
 272  * for source compatibility with programs written for libpcap 0.5. 
 274 #define DLT_C_HDLC      104     /* Cisco HDLC */ 
 275 #define DLT_CHDLC       DLT_C_HDLC 
 278  * Reserved for future use. 
 279  * Do not pick other numerical value for these unless you have also 
 280  * picked up the tcpdump.org top-of-CVS-tree version of "savefile.c", 
 281  * which will arrange that capture files for these DLT_ types have 
 282  * the same "network" value on all platforms, regardless of what 
 283  * value is chosen for their DLT_ type (thus allowing captures made 
 284  * on one platform to be read on other platforms, even if the two 
 285  * platforms don't use the same numerical values for all DLT_ types). 
 287 #define DLT_IEEE802_11  105     /* IEEE 802.11 wireless */ 
 290  * Values between 106 and 107 are used in capture file headers as 
 291  * link-layer types corresponding to DLT_ types that might differ 
 292  * between platforms; don't use those values for new DLT_ new types. 
 296  * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except 
 297  * that the AF_ type in the link-layer header is in network byte order. 
 299  * OpenBSD defines it as 12, but that collides with DLT_RAW, so we 
 300  * define it as 108 here.  If OpenBSD picks up this file, it should 
 301  * define DLT_LOOP as 12 in its version, as per the comment above - 
 302  * and should not use 108 for any purpose. 
 307  * Values between 109 and 112 are used in capture file headers as 
 308  * link-layer types corresponding to DLT_ types that might differ 
 309  * between platforms; don't use those values for new DLT_ new types. 
 313  * This is for Linux cooked sockets. 
 315 #define DLT_LINUX_SLL   113 
 318  * For use in capture-file headers as a link-layer type corresponding 
 319  * to OpenBSD PF (Packet Filter) log. 
 321 #define DLT_PFLOG       117 
 324  * BSD header for 802.11 plus a number of bits of link-layer information 
 325  * including radio information. 
 327 #ifndef DLT_IEEE802_11_RADIO 
 328 #define DLT_IEEE802_11_RADIO    127 
 332  * Apple IP-over-IEEE 1394, as per a request from Dieter Siegmund 
 333  * <dieter@apple.com>.  The header that's presented is an Ethernet-like 
 336  *      #define FIREWIRE_EUI64_LEN      8 
 337  *      struct firewire_header { 
 338  *              u_char  firewire_dhost[FIREWIRE_EUI64_LEN]; 
 339  *              u_char  firewire_shost[FIREWIRE_EUI64_LEN]; 
 340  *              u_short firewire_type; 
 343  * with "firewire_type" being an Ethernet type value, rather than, 
 344  * for example, raw GASP frames being handed up. 
 346 #define DLT_APPLE_IP_OVER_IEEE1394      138 
 349  * For future use with 802.11 captures - defined by AbsoluteValue 
 350  * Systems to store a number of bits of link-layer information 
 351  * including radio information: 
 353  *      http://www.shaftnet.org/~pizza/software/capturefrm.txt 
 355  * but it might be used by some non-AVS drivers now or in the 
 358 #define DLT_IEEE802_11_RADIO_AVS 163    /* 802.11 plus AVS radio header */ 
 362  * The instruction encodings. 
 364 /* instruction classes */ 
 365 #define BPF_CLASS(code) ((code) & 0x07) 
 373 #define         BPF_MISC        0x07 
 376 #define BPF_SIZE(code)  ((code) & 0x18) 
 380 #define BPF_MODE(code)  ((code) & 0xe0) 
 389 #define BPF_OP(code)    ((code) & 0xf0) 
 403 #define         BPF_JSET        0x40 
 404 #define BPF_SRC(code)   ((code) & 0x08) 
 408 /* ret - BPF_K and BPF_X also apply */ 
 409 #define BPF_RVAL(code)  ((code) & 0x18) 
 413 #define BPF_MISCOP(code) ((code) & 0xf8) 
 418  * The instruction data structure. 
 428  * Macros for insn array initializers. 
 430 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k } 
 431 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k } 
 436  * Structure to retrieve available DLTs for the interface. 
 439         u_int32_t               bfl_len
;        /* number of bfd_list array */ 
 441                 u_int32_t       
*bflu_list
;     /* array of DLTs */ 
 445 #define bfl_list bfl_u.bflu_list 
 449 #ifdef KERNEL_PRIVATE 
 450 /* Forward declerations */ 
 454 extern int      bpf_validate(const struct bpf_insn 
*, int); 
 455 extern void     bpfdetach(struct ifnet 
*); 
 456 extern void     bpfilterattach(int); 
 457 extern u_int    
bpf_filter(const struct bpf_insn 
*, u_char 
*, u_int
, u_int
); 
 458 #endif /* KERNEL_PRIVATE */ 
 461 #ifndef BPF_TAP_MODE_T 
 462 #define BPF_TAP_MODE_T 
 465         @abstract Constants defining interface families. 
 466         @constant BPF_MODE_DISABLED Disable bpf. 
 467         @constant BPF_MODE_INPUT Enable input only. 
 468         @constant BPF_MODE_OUTPUT Enable output only. 
 469         @constant BPF_MODE_INPUT_OUTPUT Enable input and output. 
 473         BPF_MODE_DISABLED       
= 0, 
 476         BPF_MODE_INPUT_OUTPUT   
= 3 
 479         @typedef bpf_tap_mode 
 480         @abstract Mode for tapping. BPF_MODE_DISABLED/BPF_MODE_INPUT_OUTPUT etc. 
 482 typedef u_int32_t bpf_tap_mode
; 
 483 #endif /* !BPF_TAP_MODE_T */ 
 486         @typedef bpf_send_func 
 487         @discussion bpf_send_func is called when a bpf file descriptor is 
 488                 used to send a raw packet on the interface. The mbuf and data 
 489                 link type are specified. The callback is responsible for 
 490                 releasing the mbuf whether or not it returns an error. 
 491         @param interface The interface the packet is being sent on. 
 492         @param dlt The data link type the bpf device is attached to. 
 493         @param packet The packet to be sent. 
 495 typedef errno_t (*bpf_send_func
)(ifnet_t interface
, u_int32_t data_link_type
, 
 499         @typedef bpf_tap_func 
 500         @discussion bpf_tap_func is called when the tap state of the 
 501                 interface changes. This happens when a bpf device attaches to an 
 502                 interface or detaches from an interface. The tap mode will join 
 503                 together (bit or) the modes of all bpf devices using that 
 504                 interface for that dlt. If you return an error from this 
 505                 function, the bpf device attach attempt that triggered the tap 
 506                 will fail. If this function was called bacuse the tap state was 
 507                 decreasing (tap in or out is stopping), the error will be 
 509         @param interface The interface being tapped. 
 510         @param dlt The data link type being tapped. 
 511         @param direction The direction of the tap. 
 513 typedef errno_t (*bpf_tap_func
)(ifnet_t interface
, u_int32_t data_link_type
, 
 514                                                                 bpf_tap_mode direction
); 
 518         @discussion Registers an interface with BPF. This allows bpf devices 
 519                 to attach to your interface to capture packets. Your interface 
 520                 will be unregistered automatically when your interface is 
 522         @param interface The interface to register with BPF. 
 523         @param data_link_type The data link type of the interface. See the 
 524                 DLT_* defines in bpf.h. 
 525         @param header_length The length, in bytes, of the data link header. 
 527 extern void  bpfattach(ifnet_t interface
, u_int data_link_type
, 
 528     u_int header_length
); 
 532         @discussion Registers an interface with BPF. This allows bpf devices 
 533                 to attach to your interface to capture and transmit packets. 
 534                 Your interface will be unregistered automatically when your 
 535                 interface is detached. You may register multiple times with 
 536                 different data link types. An 802.11 interface would use this to 
 537                 allow clients to pick whether they want just an ethernet style 
 538                 frame or the 802.11 wireless headers as well. The first dlt you 
 539                 register will be considered the default. Any bpf device attaches 
 540                 that do not specify a data link type will use the default. 
 541         @param interface The interface to register with BPF. 
 542         @param data_link_type The data link type of the interface. See the 
 543                 DLT_* defines in bpf.h. 
 544         @param header_length The length, in bytes, of the data link header. 
 546 extern errno_t  
bpf_attach(ifnet_t interface
, u_int32_t data_link_type
, 
 547     u_int32_t header_length
, bpf_send_func send
, bpf_tap_func tap
); 
 551         @discussion Call this function when your interface receives a 
 552                 packet. This function will check if any bpf devices need a 
 553                 a copy of the packet. 
 554         @param interface The interface the packet was received on. 
 555         @param dlt The data link type of the packet. 
 556         @param packet The packet received. 
 557         @param header An optional pointer to a header that will be prepended. 
 558         @param headerlen If the header was specified, the length of the header. 
 560 extern void bpf_tap_in(ifnet_t interface
, u_int32_t dlt
, mbuf_t packet
, 
 561     void *header
, size_t header_len
); 
 564         @function bpf_tap_out 
 565         @discussion Call this function when your interface trasmits a 
 566                 packet. This function will check if any bpf devices need a 
 567                 a copy of the packet. 
 568         @param interface The interface the packet was or will be transmitted on. 
 569         @param dlt The data link type of the packet. 
 570         @param packet The packet received. 
 571         @param header An optional pointer to a header that will be prepended. 
 572         @param headerlen If the header was specified, the length of the header. 
 574 extern void bpf_tap_out(ifnet_t interface
, u_int32_t dlt
, mbuf_t packet
, 
 575     void *header
, size_t header_len
); 
 580  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST). 
 582 #define BPF_MEMWORDS 16 
 584 #endif /* _NET_BPF_H_ */