bsd/net/bpf.h

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