bsd/net/bpf.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1990, 1991, 1993
  24  *      The Regents of the University of California.  All rights reserved.
  25  *
  26  * This code is derived from the Stanford/CMU enet packet filter,
  27  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
  28  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
  29  * Berkeley Laboratory.
  30  *
  31  * Redistribution and use in source and binary forms, with or without
  32  * modification, are permitted provided that the following conditions
  33  * are met:
  34  * 1. Redistributions of source code must retain the above copyright
  35  *    notice, this list of conditions and the following disclaimer.
  36  * 2. Redistributions in binary form must reproduce the above copyright
  37  *    notice, this list of conditions and the following disclaimer in the
  38  *    documentation and/or other materials provided with the distribution.
  39  * 3. All advertising materials mentioning features or use of this software
  40  *    must display the following acknowledgement:
  41  *      This product includes software developed by the University of
  42  *      California, Berkeley and its contributors.
  43  * 4. Neither the name of the University nor the names of its contributors
  44  *    may be used to endorse or promote products derived from this software
  45  *    without specific prior written permission.
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  48  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  50  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  51  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  52  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  53  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  54  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  55  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  56  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  57  * SUCH DAMAGE.
  58  *
  59  *      @(#)bpf.h       8.1 (Berkeley) 6/10/93
  60  *      @(#)bpf.h       1.34 (LBL)     6/16/96
  61  *
  62  * $FreeBSD: src/sys/net/bpf.h,v 1.21.2.3 2001/08/01 00:23:13 fenner Exp $
  63  */
  64
  65 #ifndef _NET_BPF_H_
  66 #define _NET_BPF_H_
  67 #include <sys/appleapiopts.h>
  68 #include <sys/types.h>
  69 #include <sys/time.h>
  70 #include <sys/cdefs.h>
  71
  72 #ifdef KERNEL
  73 #include <sys/kernel_types.h>
  74 #endif
  75
  76 /* BSD style release date */
  77 #define BPF_RELEASE 199606
  78
  79 typedef int32_t   bpf_int32;
  80 typedef u_int32_t bpf_u_int32;
  81
  82 /*
  83  * Alignment macros.  BPF_WORDALIGN rounds up to the next
  84  * even multiple of BPF_ALIGNMENT.
  85  */
  86 #define BPF_ALIGNMENT sizeof(long)
  87 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
  88
  89 #define BPF_MAXINSNS 512
  90 #define BPF_MAXBUFSIZE 0x80000
  91 #define BPF_MINBUFSIZE 32
  92
  93 /*
  94  *  Structure for BIOCSETF.
  95  */
  96 struct bpf_program {
  97         u_int bf_len;
  98         struct bpf_insn *bf_insns;
  99 };
 100
 101 #ifdef KERNEL
 102 /* LP64 version of bpf_program.  all pointers
 103  * grow when we're dealing with a 64-bit process.
 104  * WARNING - keep in sync with bpf_program
 105  */
 106 #if __DARWIN_ALIGN_NATURAL
 107 #pragma options align=natural
 108 #endif
 109
 110 struct user_bpf_program {
 111         u_int           bf_len;
 112         user_addr_t     bf_insns;
 113 };
 114
 115 #if __DARWIN_ALIGN_NATURAL
 116 #pragma options align=reset
 117 #endif
 118
 119 #endif // KERNEL
 120
 121 /*
 122  * Struct returned by BIOCGSTATS.
 123  */
 124 struct bpf_stat {
 125         u_int bs_recv;          /* number of packets received */
 126         u_int bs_drop;          /* number of packets dropped */
 127 };
 128
 129 /*
 130  * Struct return by BIOCVERSION.  This represents the version number of
 131  * the filter language described by the instruction encodings below.
 132  * bpf understands a program iff kernel_major == filter_major &&
 133  * kernel_minor >= filter_minor, that is, if the value returned by the
 134  * running kernel has the same major number and a minor number equal
 135  * equal to or less than the filter being downloaded.  Otherwise, the
 136  * results are undefined, meaning an error may be returned or packets
 137  * may be accepted haphazardly.
 138  * It has nothing to do with the source code version.
 139  */
 140 struct bpf_version {
 141         u_short bv_major;
 142         u_short bv_minor;
 143 };
 144 /* Current version number of filter architecture. */
 145 #define BPF_MAJOR_VERSION 1
 146 #define BPF_MINOR_VERSION 1
 147
 148 #define BIOCGBLEN       _IOR('B',102, u_int)
 149 #define BIOCSBLEN       _IOWR('B',102, u_int)
 150 #define BIOCSETF        _IOW('B',103, struct bpf_program)
 151 #define BIOCFLUSH       _IO('B',104)
 152 #define BIOCPROMISC     _IO('B',105)
 153 #define BIOCGDLT        _IOR('B',106, u_int)
 154 #define BIOCGETIF       _IOR('B',107, struct ifreq)
 155 #define BIOCSETIF       _IOW('B',108, struct ifreq)
 156 #define BIOCSRTIMEOUT   _IOW('B',109, struct timeval)
 157 #define BIOCGRTIMEOUT   _IOR('B',110, struct timeval)
 158 #define BIOCGSTATS      _IOR('B',111, struct bpf_stat)
 159 #define BIOCIMMEDIATE   _IOW('B',112, u_int)
 160 #define BIOCVERSION     _IOR('B',113, struct bpf_version)
 161 #define BIOCGRSIG       _IOR('B',114, u_int)
 162 #define BIOCSRSIG       _IOW('B',115, u_int)
 163 #define BIOCGHDRCMPLT   _IOR('B',116, u_int)
 164 #define BIOCSHDRCMPLT   _IOW('B',117, u_int)
 165 #define BIOCGSEESENT    _IOR('B',118, u_int)
 166 #define BIOCSSEESENT    _IOW('B',119, u_int)
 167
 168 /*
 169  * Structure prepended to each packet.
 170  */
 171 struct bpf_hdr {
 172         struct timeval  bh_tstamp;      /* time stamp */
 173         bpf_u_int32     bh_caplen;      /* length of captured portion */
 174         bpf_u_int32     bh_datalen;     /* original length of packet */
 175         u_short         bh_hdrlen;      /* length of bpf header (this struct
 176                                            plus alignment padding) */
 177 };
 178 /*
 179  * Because the structure above is not a multiple of 4 bytes, some compilers
 180  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
 181  * Only the kernel needs to know about it; applications use bh_hdrlen.
 182  */
 183 #ifdef KERNEL
 184 #define SIZEOF_BPF_HDR  (sizeof(struct bpf_hdr) <= 20 ? 18 : \
 185     sizeof(struct bpf_hdr))
 186 #endif
 187
 188 /*
 189  * Data-link level type codes.
 190  */
 191 #define DLT_NULL        0       /* no link-layer encapsulation */
 192 #define DLT_EN10MB      1       /* Ethernet (10Mb) */
 193 #define DLT_EN3MB       2       /* Experimental Ethernet (3Mb) */
 194 #define DLT_AX25        3       /* Amateur Radio AX.25 */
 195 #define DLT_PRONET      4       /* Proteon ProNET Token Ring */
 196 #define DLT_CHAOS       5       /* Chaos */
 197 #define DLT_IEEE802     6       /* IEEE 802 Networks */
 198 #define DLT_ARCNET      7       /* ARCNET */
 199 #define DLT_SLIP        8       /* Serial Line IP */
 200 #define DLT_PPP         9       /* Point-to-point Protocol */
 201 #define DLT_FDDI        10      /* FDDI */
 202 #define DLT_ATM_RFC1483 11      /* LLC/SNAP encapsulated atm */
 203 #define DLT_RAW         12      /* raw IP */
 204 #define DLT_APPLE_IP_OVER_IEEE1394      138
 205
 206 /*
 207  * These are values from BSD/OS's "bpf.h".
 208  * These are not the same as the values from the traditional libpcap
 209  * "bpf.h"; however, these values shouldn't be generated by any
 210  * OS other than BSD/OS, so the correct values to use here are the
 211  * BSD/OS values.
 212  *
 213  * Platforms that have already assigned these values to other
 214  * DLT_ codes, however, should give these codes the values
 215  * from that platform, so that programs that use these codes will
 216  * continue to compile - even though they won't correctly read
 217  * files of these types.
 218  */
 219 #define DLT_SLIP_BSDOS  15      /* BSD/OS Serial Line IP */
 220 #define DLT_PPP_BSDOS   16      /* BSD/OS Point-to-point Protocol */
 221
 222 #define DLT_ATM_CLIP    19      /* Linux Classical-IP over ATM */
 223
 224 /*
 225  * This value is defined by NetBSD; other platforms should refrain from
 226  * using it for other purposes, so that NetBSD savefiles with a link
 227  * type of 50 can be read as this type on all platforms.
 228  */
 229 #define DLT_PPP_SERIAL  50      /* PPP over serial with HDLC encapsulation */
 230
 231 /*
 232  * This value was defined by libpcap 0.5; platforms that have defined
 233  * it with a different value should define it here with that value -
 234  * a link type of 104 in a save file will be mapped to DLT_C_HDLC,
 235  * whatever value that happens to be, so programs will correctly
 236  * handle files with that link type regardless of the value of
 237  * DLT_C_HDLC.
 238  *
 239  * The name DLT_C_HDLC was used by BSD/OS; we use that name for source
 240  * compatibility with programs written for BSD/OS.
 241  *
 242  * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well,
 243  * for source compatibility with programs written for libpcap 0.5.
 244  */
 245 #define DLT_C_HDLC      104     /* Cisco HDLC */
 246 #define DLT_CHDLC       DLT_C_HDLC
 247
 248 /*
 249  * Reserved for future use.
 250  * Do not pick other numerical value for these unless you have also
 251  * picked up the tcpdump.org top-of-CVS-tree version of "savefile.c",
 252  * which will arrange that capture files for these DLT_ types have
 253  * the same "network" value on all platforms, regardless of what
 254  * value is chosen for their DLT_ type (thus allowing captures made
 255  * on one platform to be read on other platforms, even if the two
 256  * platforms don't use the same numerical values for all DLT_ types).
 257  */
 258 #define DLT_IEEE802_11  105     /* IEEE 802.11 wireless */
 259
 260 /*
 261  * Values between 106 and 107 are used in capture file headers as
 262  * link-layer types corresponding to DLT_ types that might differ
 263  * between platforms; don't use those values for new DLT_ new types.
 264  */
 265
 266 /*
 267  * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except
 268  * that the AF_ type in the link-layer header is in network byte order.
 269  *
 270  * OpenBSD defines it as 12, but that collides with DLT_RAW, so we
 271  * define it as 108 here.  If OpenBSD picks up this file, it should
 272  * define DLT_LOOP as 12 in its version, as per the comment above -
 273  * and should not use 108 for any purpose.
 274  */
 275 #define DLT_LOOP        108
 276
 277 /*
 278  * Values between 109 and 112 are used in capture file headers as
 279  * link-layer types corresponding to DLT_ types that might differ
 280  * between platforms; don't use those values for new DLT_ new types.
 281  */
 282
 283 /*
 284  * This is for Linux cooked sockets.
 285  */
 286 #define DLT_LINUX_SLL   113
 287
 288 /*
 289  * The instruction encodings.
 290  */
 291 /* instruction classes */
 292 #define BPF_CLASS(code) ((code) & 0x07)
 293 #define         BPF_LD          0x00
 294 #define         BPF_LDX         0x01
 295 #define         BPF_ST          0x02
 296 #define         BPF_STX         0x03
 297 #define         BPF_ALU         0x04
 298 #define         BPF_JMP         0x05
 299 #define         BPF_RET         0x06
 300 #define         BPF_MISC        0x07
 301
 302 /* ld/ldx fields */
 303 #define BPF_SIZE(code)  ((code) & 0x18)
 304 #define         BPF_W           0x00
 305 #define         BPF_H           0x08
 306 #define         BPF_B           0x10
 307 #define BPF_MODE(code)  ((code) & 0xe0)
 308 #define         BPF_IMM         0x00
 309 #define         BPF_ABS         0x20
 310 #define         BPF_IND         0x40
 311 #define         BPF_MEM         0x60
 312 #define         BPF_LEN         0x80
 313 #define         BPF_MSH         0xa0
 314
 315 /* alu/jmp fields */
 316 #define BPF_OP(code)    ((code) & 0xf0)
 317 #define         BPF_ADD         0x00
 318 #define         BPF_SUB         0x10
 319 #define         BPF_MUL         0x20
 320 #define         BPF_DIV         0x30
 321 #define         BPF_OR          0x40
 322 #define         BPF_AND         0x50
 323 #define         BPF_LSH         0x60
 324 #define         BPF_RSH         0x70
 325 #define         BPF_NEG         0x80
 326 #define         BPF_JA          0x00
 327 #define         BPF_JEQ         0x10
 328 #define         BPF_JGT         0x20
 329 #define         BPF_JGE         0x30
 330 #define         BPF_JSET        0x40
 331 #define BPF_SRC(code)   ((code) & 0x08)
 332 #define         BPF_K           0x00
 333 #define         BPF_X           0x08
 334
 335 /* ret - BPF_K and BPF_X also apply */
 336 #define BPF_RVAL(code)  ((code) & 0x18)
 337 #define         BPF_A           0x10
 338
 339 /* misc */
 340 #define BPF_MISCOP(code) ((code) & 0xf8)
 341 #define         BPF_TAX         0x00
 342 #define         BPF_TXA         0x80
 343
 344 /*
 345  * The instruction data structure.
 346  */
 347 struct bpf_insn {
 348         u_short         code;
 349         u_char          jt;
 350         u_char          jf;
 351         bpf_u_int32     k;
 352 };
 353
 354 /*
 355  * Macros for insn array initializers.
 356  */
 357 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
 358 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
 359
 360 #ifdef KERNEL_PRIVATE
 361 /* Forward declerations */
 362 struct ifnet;
 363 struct mbuf;
 364
 365 int      bpf_validate(const struct bpf_insn *, int);
 366 void     bpf_tap(struct ifnet *, u_char *, u_int);
 367 void     bpf_mtap(struct ifnet *, struct mbuf *);
 368
 369 void     bpfdetach(struct ifnet *);
 370
 371 void     bpfilterattach(int);
 372 u_int    bpf_filter(const struct bpf_insn *, u_char *, u_int, u_int);
 373
 374 #ifdef __APPLE__
 375 #define BPF_TAP(x, y, z) bpf_tap(x,y,z)
 376 #define BPF_MTAP(x, y) bpf_mtap(x, y)
 377 #endif /* __APPLE__ */
 378
 379 #endif /* KERNEL_PRIVATE */
 380
 381 #ifdef KERNEL
 382 /*!
 383         @function bpfattach
 384         @discussion Registers an interface with BPF. This allows bpf devices
 385                 to attach to your interface to capture packets. Your interface
 386                 will be unregistered automatically when your interface is
 387                 detached.
 388         @param interface The interface to register with BPF.
 389         @param data_link_type The data link type of the interface. See the
 390                 DLT_* defines in bpf.h.
 391         @param header_length The length, in bytes, of the data link header.
 392  */
 393 void     bpfattach(ifnet_t interface, u_int data_link_type, u_int header_length);
 394 #endif /* KERNEL */
 395
 396 /*
 397  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
 398  */
 399 #define BPF_MEMWORDS 16
 400
 401 #endif