bsd/net/bpf.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, 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 #ifndef _NET_BPF_H_
  72 #define _NET_BPF_H_
  73 #include <sys/appleapiopts.h>
  74 #include <sys/types.h>
  75 #include <sys/time.h>
  76 #include <sys/cdefs.h>
  77
  78 #ifdef KERNEL
  79 #include <sys/kernel_types.h>
  80 #endif
  81
  82 /* BSD style release date */
  83 #define BPF_RELEASE 199606
  84
  85 typedef int32_t   bpf_int32;
  86 typedef u_int32_t bpf_u_int32;
  87
  88 /*
  89  * Alignment macros.  BPF_WORDALIGN rounds up to the next
  90  * even multiple of BPF_ALIGNMENT.
  91  */
  92 #define BPF_ALIGNMENT sizeof(long)
  93 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
  94
  95 #define BPF_MAXINSNS 512
  96 #define BPF_MAXBUFSIZE 0x80000
  97 #define BPF_MINBUFSIZE 32
  98
  99 /*
 100  *  Structure for BIOCSETF.
 101  */
 102 struct bpf_program {
 103         u_int bf_len;
 104         struct bpf_insn *bf_insns;
 105 };
 106
 107 #ifdef KERNEL
 108 /* LP64 version of bpf_program.  all pointers
 109  * grow when we're dealing with a 64-bit process.
 110  * WARNING - keep in sync with bpf_program
 111  */
 112 struct user_bpf_program {
 113         u_int           bf_len;
 114         user_addr_t     bf_insns __attribute__((aligned(8)));
 115 };
 116
 117 #endif // KERNEL
 118
 119 /*
 120  * Struct returned by BIOCGSTATS.
 121  */
 122 struct bpf_stat {
 123         u_int bs_recv;          /* number of packets received */
 124         u_int bs_drop;          /* number of packets dropped */
 125 };
 126
 127 /*
 128  * Struct return by BIOCVERSION.  This represents the version number of
 129  * the filter language described by the instruction encodings below.
 130  * bpf understands a program iff kernel_major == filter_major &&
 131  * kernel_minor >= filter_minor, that is, if the value returned by the
 132  * running kernel has the same major number and a minor number equal
 133  * equal to or less than the filter being downloaded.  Otherwise, the
 134  * results are undefined, meaning an error may be returned or packets
 135  * may be accepted haphazardly.
 136  * It has nothing to do with the source code version.
 137  */
 138 struct bpf_version {
 139         u_short bv_major;
 140         u_short bv_minor;
 141 };
 142 /* Current version number of filter architecture. */
 143 #define BPF_MAJOR_VERSION 1
 144 #define BPF_MINOR_VERSION 1
 145
 146 #define BIOCGBLEN       _IOR('B',102, u_int)
 147 #define BIOCSBLEN       _IOWR('B',102, u_int)
 148 #define BIOCSETF        _IOW('B',103, struct bpf_program)
 149 #define BIOCFLUSH       _IO('B',104)
 150 #define BIOCPROMISC     _IO('B',105)
 151 #define BIOCGDLT        _IOR('B',106, u_int)
 152 #define BIOCGETIF       _IOR('B',107, struct ifreq)
 153 #define BIOCSETIF       _IOW('B',108, struct ifreq)
 154 #define BIOCSRTIMEOUT   _IOW('B',109, struct timeval)
 155 #define BIOCGRTIMEOUT   _IOR('B',110, struct timeval)
 156 #define BIOCGSTATS      _IOR('B',111, struct bpf_stat)
 157 #define BIOCIMMEDIATE   _IOW('B',112, u_int)
 158 #define BIOCVERSION     _IOR('B',113, struct bpf_version)
 159 #define BIOCGRSIG       _IOR('B',114, u_int)
 160 #define BIOCSRSIG       _IOW('B',115, u_int)
 161 #define BIOCGHDRCMPLT   _IOR('B',116, u_int)
 162 #define BIOCSHDRCMPLT   _IOW('B',117, u_int)
 163 #define BIOCGSEESENT    _IOR('B',118, u_int)
 164 #define BIOCSSEESENT    _IOW('B',119, u_int)
 165
 166 /*
 167  * Structure prepended to each packet.
 168  */
 169 struct bpf_hdr {
 170         struct timeval  bh_tstamp;      /* time stamp */
 171         bpf_u_int32     bh_caplen;      /* length of captured portion */
 172         bpf_u_int32     bh_datalen;     /* original length of packet */
 173         u_short         bh_hdrlen;      /* length of bpf header (this struct
 174                                            plus alignment padding) */
 175 };
 176 /*
 177  * Because the structure above is not a multiple of 4 bytes, some compilers
 178  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
 179  * Only the kernel needs to know about it; applications use bh_hdrlen.
 180  */
 181 #ifdef KERNEL
 182 #define SIZEOF_BPF_HDR  (sizeof(struct bpf_hdr) <= 20 ? 18 : \
 183     sizeof(struct bpf_hdr))
 184 #endif
 185
 186 /*
 187  * Data-link level type codes.
 188  */
 189 #define DLT_NULL        0       /* no link-layer encapsulation */
 190 #define DLT_EN10MB      1       /* Ethernet (10Mb) */
 191 #define DLT_EN3MB       2       /* Experimental Ethernet (3Mb) */
 192 #define DLT_AX25        3       /* Amateur Radio AX.25 */
 193 #define DLT_PRONET      4       /* Proteon ProNET Token Ring */
 194 #define DLT_CHAOS       5       /* Chaos */
 195 #define DLT_IEEE802     6       /* IEEE 802 Networks */
 196 #define DLT_ARCNET      7       /* ARCNET */
 197 #define DLT_SLIP        8       /* Serial Line IP */
 198 #define DLT_PPP         9       /* Point-to-point Protocol */
 199 #define DLT_FDDI        10      /* FDDI */
 200 #define DLT_ATM_RFC1483 11      /* LLC/SNAP encapsulated atm */
 201 #define DLT_RAW         12      /* raw IP */
 202 #define DLT_APPLE_IP_OVER_IEEE1394      138
 203
 204 /*
 205  * These are values from BSD/OS's "bpf.h".
 206  * These are not the same as the values from the traditional libpcap
 207  * "bpf.h"; however, these values shouldn't be generated by any
 208  * OS other than BSD/OS, so the correct values to use here are the
 209  * BSD/OS values.
 210  *
 211  * Platforms that have already assigned these values to other
 212  * DLT_ codes, however, should give these codes the values
 213  * from that platform, so that programs that use these codes will
 214  * continue to compile - even though they won't correctly read
 215  * files of these types.
 216  */
 217 #define DLT_SLIP_BSDOS  15      /* BSD/OS Serial Line IP */
 218 #define DLT_PPP_BSDOS   16      /* BSD/OS Point-to-point Protocol */
 219
 220 #define DLT_ATM_CLIP    19      /* Linux Classical-IP over ATM */
 221
 222 /*
 223  * This value is defined by NetBSD; other platforms should refrain from
 224  * using it for other purposes, so that NetBSD savefiles with a link
 225  * type of 50 can be read as this type on all platforms.
 226  */
 227 #define DLT_PPP_SERIAL  50      /* PPP over serial with HDLC encapsulation */
 228
 229 /*
 230  * This value was defined by libpcap 0.5; platforms that have defined
 231  * it with a different value should define it here with that value -
 232  * a link type of 104 in a save file will be mapped to DLT_C_HDLC,
 233  * whatever value that happens to be, so programs will correctly
 234  * handle files with that link type regardless of the value of
 235  * DLT_C_HDLC.
 236  *
 237  * The name DLT_C_HDLC was used by BSD/OS; we use that name for source
 238  * compatibility with programs written for BSD/OS.
 239  *
 240  * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well,
 241  * for source compatibility with programs written for libpcap 0.5.
 242  */
 243 #define DLT_C_HDLC      104     /* Cisco HDLC */
 244 #define DLT_CHDLC       DLT_C_HDLC
 245
 246 /*
 247  * Reserved for future use.
 248  * Do not pick other numerical value for these unless you have also
 249  * picked up the tcpdump.org top-of-CVS-tree version of "savefile.c",
 250  * which will arrange that capture files for these DLT_ types have
 251  * the same "network" value on all platforms, regardless of what
 252  * value is chosen for their DLT_ type (thus allowing captures made
 253  * on one platform to be read on other platforms, even if the two
 254  * platforms don't use the same numerical values for all DLT_ types).
 255  */
 256 #define DLT_IEEE802_11  105     /* IEEE 802.11 wireless */
 257
 258 /*
 259  * Values between 106 and 107 are used in capture file headers as
 260  * link-layer types corresponding to DLT_ types that might differ
 261  * between platforms; don't use those values for new DLT_ new types.
 262  */
 263
 264 /*
 265  * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except
 266  * that the AF_ type in the link-layer header is in network byte order.
 267  *
 268  * OpenBSD defines it as 12, but that collides with DLT_RAW, so we
 269  * define it as 108 here.  If OpenBSD picks up this file, it should
 270  * define DLT_LOOP as 12 in its version, as per the comment above -
 271  * and should not use 108 for any purpose.
 272  */
 273 #define DLT_LOOP        108
 274
 275 /*
 276  * Values between 109 and 112 are used in capture file headers as
 277  * link-layer types corresponding to DLT_ types that might differ
 278  * between platforms; don't use those values for new DLT_ new types.
 279  */
 280
 281 /*
 282  * This is for Linux cooked sockets.
 283  */
 284 #define DLT_LINUX_SLL   113
 285
 286 /*
 287  * The instruction encodings.
 288  */
 289 /* instruction classes */
 290 #define BPF_CLASS(code) ((code) & 0x07)
 291 #define         BPF_LD          0x00
 292 #define         BPF_LDX         0x01
 293 #define         BPF_ST          0x02
 294 #define         BPF_STX         0x03
 295 #define         BPF_ALU         0x04
 296 #define         BPF_JMP         0x05
 297 #define         BPF_RET         0x06
 298 #define         BPF_MISC        0x07
 299
 300 /* ld/ldx fields */
 301 #define BPF_SIZE(code)  ((code) & 0x18)
 302 #define         BPF_W           0x00
 303 #define         BPF_H           0x08
 304 #define         BPF_B           0x10
 305 #define BPF_MODE(code)  ((code) & 0xe0)
 306 #define         BPF_IMM         0x00
 307 #define         BPF_ABS         0x20
 308 #define         BPF_IND         0x40
 309 #define         BPF_MEM         0x60
 310 #define         BPF_LEN         0x80
 311 #define         BPF_MSH         0xa0
 312
 313 /* alu/jmp fields */
 314 #define BPF_OP(code)    ((code) & 0xf0)
 315 #define         BPF_ADD         0x00
 316 #define         BPF_SUB         0x10
 317 #define         BPF_MUL         0x20
 318 #define         BPF_DIV         0x30
 319 #define         BPF_OR          0x40
 320 #define         BPF_AND         0x50
 321 #define         BPF_LSH         0x60
 322 #define         BPF_RSH         0x70
 323 #define         BPF_NEG         0x80
 324 #define         BPF_JA          0x00
 325 #define         BPF_JEQ         0x10
 326 #define         BPF_JGT         0x20
 327 #define         BPF_JGE         0x30
 328 #define         BPF_JSET        0x40
 329 #define BPF_SRC(code)   ((code) & 0x08)
 330 #define         BPF_K           0x00
 331 #define         BPF_X           0x08
 332
 333 /* ret - BPF_K and BPF_X also apply */
 334 #define BPF_RVAL(code)  ((code) & 0x18)
 335 #define         BPF_A           0x10
 336
 337 /* misc */
 338 #define BPF_MISCOP(code) ((code) & 0xf8)
 339 #define         BPF_TAX         0x00
 340 #define         BPF_TXA         0x80
 341
 342 /*
 343  * The instruction data structure.
 344  */
 345 struct bpf_insn {
 346         u_short         code;
 347         u_char          jt;
 348         u_char          jf;
 349         bpf_u_int32     k;
 350 };
 351
 352 /*
 353  * Macros for insn array initializers.
 354  */
 355 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
 356 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
 357
 358 #ifdef KERNEL_PRIVATE
 359 /* Forward declerations */
 360 struct ifnet;
 361 struct mbuf;
 362
 363 int      bpf_validate(const struct bpf_insn *, int);
 364 void     bpf_tap(struct ifnet *, u_char *, u_int);
 365 void     bpf_mtap(struct ifnet *, struct mbuf *);
 366
 367 void     bpfdetach(struct ifnet *);
 368
 369 void     bpfilterattach(int);
 370 u_int    bpf_filter(const struct bpf_insn *, u_char *, u_int, u_int);
 371
 372 #ifdef __APPLE__
 373 #define BPF_TAP(x, y, z) bpf_tap(x,y,z)
 374 #define BPF_MTAP(x, y) bpf_mtap(x, y)
 375 #endif /* __APPLE__ */
 376
 377 #endif /* KERNEL_PRIVATE */
 378
 379 #ifdef KERNEL
 380 /*!
 381         @function bpfattach
 382         @discussion Registers an interface with BPF. This allows bpf devices
 383                 to attach to your interface to capture packets. Your interface
 384                 will be unregistered automatically when your interface is
 385                 detached.
 386         @param interface The interface to register with BPF.
 387         @param data_link_type The data link type of the interface. See the
 388                 DLT_* defines in bpf.h.
 389         @param header_length The length, in bytes, of the data link header.
 390  */
 391 void     bpfattach(ifnet_t interface, u_int data_link_type, u_int header_length);
 392 #endif /* KERNEL */
 393
 394 /*
 395  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
 396  */
 397 #define BPF_MEMWORDS 16
 398
 399 #endif