usr/src/uts/common/io/bpf/net/bpf.h

   1 /*      $NetBSD: bpf.h,v 1.50 2009/01/13 19:10:52 christos Exp $        */
   2
   3 /*
   4  * Copyright (c) 1990, 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from the Stanford/CMU enet packet filter,
   8  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
   9  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
  10  * Berkeley Laboratory.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)bpf.h       8.2 (Berkeley) 1/9/95
  37  * @(#) Header: bpf.h,v 1.36 97/06/12 14:29:53 leres Exp  (LBL)
  38  */
  39 /*
  40  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  41  * Use is subject to license terms.
  42  */
  43
  44 #ifndef _NET_BPF_H_
  45 #define _NET_BPF_H_
  46
  47 #include <sys/time.h>
  48 #include <sys/types32.h>
  49 #include <sys/ioccom.h>
  50
  51 /* BSD style release date */
  52 #define BPF_RELEASE 199606
  53
  54 typedef int bpf_int32;
  55 typedef uint_t bpf_uint_t32;
  56 typedef uint_t bpf_u_int32;
  57
  58 /*
  59  * Alignment macros.  BPF_WORDALIGN rounds up to the next
  60  * even multiple of BPF_ALIGNMENT.
  61  */
  62 #define BPF_ALIGNMENT sizeof (uint32_t)
  63 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
  64
  65 #define BPF_MAXINSNS 512
  66 #define BPF_DFLTBUFSIZE (1024*1024)     /* default static upper limit */
  67 #define BPF_MAXBUFSIZE (1024*1024*16)   /* hard limit on sysctl'able value */
  68 #define BPF_MINBUFSIZE 32
  69
  70 /*
  71  *  Structure for BIOCSETF.
  72  */
  73 struct bpf_program {
  74         uint_t bf_len;
  75         struct bpf_insn *bf_insns;
  76 };
  77 struct bpf_program32 {
  78         uint_t bf_len;
  79         caddr32_t bf_insns;
  80 };
  81
  82 /*
  83  * Struct returned by BIOCGSTATS and net.bpf.stats sysctl.
  84  */
  85 struct bpf_stat {
  86         uint64_t bs_recv;       /* number of packets received */
  87         uint64_t bs_drop;       /* number of packets dropped */
  88         uint64_t bs_capt;       /* number of packets captured */
  89         uint64_t bs_padding[13];
  90 };
  91
  92 /*
  93  * Struct returned by BIOCGSTATSOLD.
  94  */
  95 struct bpf_stat_old {
  96         uint_t bs_recv;         /* number of packets received */
  97         uint_t bs_drop;         /* number of packets dropped */
  98 };
  99
 100 /*
 101  * Struct return by BIOCVERSION.  This represents the version number of
 102  * the filter language described by the instruction encodings below.
 103  * bpf understands a program iff kernel_major == filter_major &&
 104  * kernel_minor >= filter_minor, that is, if the value returned by the
 105  * running kernel has the same major number and a minor number equal
 106  * equal to or less than the filter being downloaded.  Otherwise, the
 107  * results are undefined, meaning an error may be returned or packets
 108  * may be accepted haphazardly.
 109  * It has nothing to do with the source code version.
 110  */
 111 struct bpf_version {
 112         ushort_t bv_major;
 113         ushort_t bv_minor;
 114 };
 115 /* Current version number of filter architecture. */
 116 #define BPF_MAJOR_VERSION 1
 117 #define BPF_MINOR_VERSION 1
 118
 119 /*
 120  * BPF ioctls
 121  *
 122  * The first set is for compatibility with Sun's pcc style
 123  * header files.  If your using gcc, we assume that you
 124  * have run fixincludes so the latter set should work.
 125  */
 126 #define BIOCGBLEN        _IOR('B', 102, uint_t)
 127 #define BIOCSBLEN       _IOWR('B', 102, uint_t)
 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, uint_t)
 132 #define BIOCGETIF        _IOR('B', 107, struct ifreq)
 133 #define BIOCGETLIF       _IOR('B', 107, struct lifreq)
 134 #define BIOCSETIF        _IOW('B', 108, struct ifreq)
 135 #define BIOCSETLIF       _IOW('B', 108, struct lifreq)
 136 #define BIOCGSTATS       _IOR('B', 111, struct bpf_stat)
 137 #define BIOCGSTATSOLD    _IOR('B', 111, struct bpf_stat_old)
 138 #define BIOCIMMEDIATE    _IOW('B', 112, uint_t)
 139 #define BIOCVERSION      _IOR('B', 113, struct bpf_version)
 140 #define BIOCSTCPF        _IOW('B', 114, struct bpf_program)
 141 #define BIOCSUDPF        _IOW('B', 115, struct bpf_program)
 142 #define BIOCGHDRCMPLT    _IOR('B', 116, uint_t)
 143 #define BIOCSHDRCMPLT    _IOW('B', 117, uint_t)
 144 #define BIOCSDLT         _IOW('B', 118, uint_t)
 145 #define BIOCGDLTLIST    _IOWR('B', 119, struct bpf_dltlist)
 146 #define BIOCGSEESENT     _IOR('B', 120, uint_t)
 147 #define BIOCSSEESENT     _IOW('B', 121, uint_t)
 148 #define BIOCSRTIMEOUT    _IOW('B', 122, struct timeval)
 149 #define BIOCGRTIMEOUT    _IOR('B', 123, struct timeval)
 150 /*
 151  */
 152 #define BIOCSETF32       _IOW('B', 103, struct bpf_program32)
 153 #define BIOCGDLTLIST32  _IOWR('B', 119, struct bpf_dltlist32)
 154 #define BIOCSRTIMEOUT32  _IOW('B', 122, struct timeval32)
 155 #define BIOCGRTIMEOUT32  _IOR('B', 123, struct timeval32)
 156
 157 /*
 158  * Structure prepended to each packet. This is "wire" format, so we
 159  * cannot change it unfortunately to 64 bit times on 32 bit systems [yet].
 160  */
 161 struct bpf_timeval {
 162         int32_t tv_sec;
 163         int32_t tv_usec;
 164 };
 165
 166 struct bpf_hdr {
 167         struct bpf_timeval bh_tstamp;   /* time stamp */
 168         uint32_t        bh_caplen;      /* length of captured portion */
 169         uint32_t        bh_datalen;     /* original length of packet */
 170         uint16_t        bh_hdrlen;      /* length of bpf header (this struct */
 171                                         /*  plus alignment padding) */
 172 };
 173 /*
 174  * Because the structure above is not a multiple of 4 bytes, some compilers
 175  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
 176  * Only the kernel needs to know about it; applications use bh_hdrlen.
 177  * XXX To save a few bytes on 32-bit machines, we avoid end-of-struct
 178  * XXX padding by using the size of the header data elements.  This is
 179  * XXX fail-safe: on new machines, we just use the 'safe' sizeof.
 180  */
 181 #ifdef _KERNEL
 182 #if defined(__arm32__) || defined(__i386__) || defined(__m68k__) || \
 183     defined(__mips__) || defined(__ns32k__) || defined(__vax__) || \
 184     defined(__sh__) || (defined(__sparc__) && !defined(__sparc64__))
 185 #define SIZEOF_BPF_HDR 18
 186 #else
 187 #define SIZEOF_BPF_HDR sizeof (struct bpf_hdr)
 188 #endif
 189 #endif
 190
 191 /* Pull in data-link level type codes. */
 192 #include <net/dlt.h>
 193
 194 /*
 195  * The instruction encodings.
 196  */
 197 /* instruction classes */
 198 #define BPF_CLASS(code) ((code) & 0x07)
 199 #define         BPF_LD          0x00
 200 #define         BPF_LDX         0x01
 201 #define         BPF_ST          0x02
 202 #define         BPF_STX         0x03
 203 #define         BPF_ALU         0x04
 204 #define         BPF_JMP         0x05
 205 #define         BPF_RET         0x06
 206 #define         BPF_MISC        0x07
 207
 208 /* ld/ldx fields */
 209 #define BPF_SIZE(code)  ((code) & 0x18)
 210 #define         BPF_W           0x00
 211 #define         BPF_H           0x08
 212 #define         BPF_B           0x10
 213 #define BPF_MODE(code)  ((code) & 0xe0)
 214 #define         BPF_IMM         0x00
 215 #define         BPF_ABS         0x20
 216 #define         BPF_IND         0x40
 217 #define         BPF_MEM         0x60
 218 #define         BPF_LEN         0x80
 219 #define         BPF_MSH         0xa0
 220
 221 /* alu/jmp fields */
 222 #define BPF_OP(code)    ((code) & 0xf0)
 223 #define         BPF_ADD         0x00
 224 #define         BPF_SUB         0x10
 225 #define         BPF_MUL         0x20
 226 #define         BPF_DIV         0x30
 227 #define         BPF_OR          0x40
 228 #define         BPF_AND         0x50
 229 #define         BPF_LSH         0x60
 230 #define         BPF_RSH         0x70
 231 #define         BPF_NEG         0x80
 232 #define         BPF_JA          0x00
 233 #define         BPF_JEQ         0x10
 234 #define         BPF_JGT         0x20
 235 #define         BPF_JGE         0x30
 236 #define         BPF_JSET        0x40
 237 #define BPF_SRC(code)   ((code) & 0x08)
 238 #define         BPF_K           0x00
 239 #define         BPF_X           0x08
 240
 241 /* ret - BPF_K and BPF_X also apply */
 242 #define BPF_RVAL(code)  ((code) & 0x18)
 243 #define         BPF_A           0x10
 244
 245 /* misc */
 246 #define BPF_MISCOP(code) ((code) & 0xf8)
 247 #define         BPF_TAX         0x00
 248 #define         BPF_TXA         0x80
 249
 250 /*
 251  * The instruction data structure.
 252  */
 253 struct bpf_insn {
 254         uint16_t  code;
 255         uint8_t   jt;
 256         uint8_t   jf;
 257         uint32_t  k;
 258 };
 259
 260 /*
 261  * Macros for insn array initializers.
 262  */
 263 #define BPF_STMT(code, k) { (uint16_t)(code), 0, 0, k }
 264 #define BPF_JUMP(code, k, jt, jf) { (uint16_t)(code), jt, jf, k }
 265
 266 /*
 267  * Structure to retrieve available DLTs for the interface.
 268  */
 269 struct bpf_dltlist {
 270         uint_t  bfl_len;        /* number of bfd_list array */
 271         uint_t  *bfl_list;      /* array of DLTs */
 272 };
 273 struct bpf_dltlist32 {
 274         uint_t  bfl_len;
 275         caddr32_t bfl_list;
 276 };
 277
 278 #ifdef _KERNEL
 279 #include <sys/mac.h>
 280 #include <sys/dls_impl.h>
 281
 282 typedef void (*bpf_itap_fn_t)(void *, mblk_t *, boolean_t, uint_t);
 283
 284 extern void     bpfattach(uintptr_t, int, zoneid_t, int);
 285 extern void     bpfdetach(uintptr_t);
 286 extern uint_t   bpf_filter(struct bpf_insn *, uchar_t *, uint_t, uint_t);
 287 extern void     bpf_itap(void *, mblk_t *, boolean_t, uint_t);
 288 extern void     bpf_mtap(void *, mac_resource_handle_t, mblk_t *, boolean_t);
 289 extern int      bpf_validate(struct bpf_insn *, int);
 290
 291 #endif /* _KERNEL */
 292
 293 /*
 294  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
 295  */
 296 #define BPF_MEMWORDS 16
 297
 298 #endif /* !_NET_BPF_H_ */