Home | History | Annotate | Line # | Download | only in net
bpf.h revision 1.30
      1 /*	$NetBSD: bpf.h,v 1.30 2002/08/28 09:34:58 onoe 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. All advertising materials mentioning features or use of this software
     21  *    must display the following acknowledgement:
     22  *	This product includes software developed by the University of
     23  *	California, Berkeley and its contributors.
     24  * 4. Neither the name of the University nor the names of its contributors
     25  *    may be used to endorse or promote products derived from this software
     26  *    without specific prior written permission.
     27  *
     28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     38  * SUCH DAMAGE.
     39  *
     40  *	@(#)bpf.h	8.2 (Berkeley) 1/9/95
     41  * @(#) Header: bpf.h,v 1.36 97/06/12 14:29:53 leres Exp  (LBL)
     42  */
     43 
     44 #ifndef _NET_BPF_H_
     45 #define _NET_BPF_H_
     46 
     47 #include <sys/time.h>
     48 
     49 /* BSD style release date */
     50 #define BPF_RELEASE 199606
     51 
     52 typedef	int bpf_int32;
     53 typedef	u_int bpf_u_int32;
     54 
     55 /*
     56  * Alignment macros.  BPF_WORDALIGN rounds up to the next
     57  * even multiple of BPF_ALIGNMENT.
     58  */
     59 #define BPF_ALIGNMENT sizeof(long)
     60 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
     61 
     62 #define BPF_MAXINSNS 512
     63 #define BPF_MAXBUFSIZE 0x8000
     64 #define BPF_MINBUFSIZE 32
     65 
     66 /*
     67  *  Structure for BIOCSETF.
     68  */
     69 struct bpf_program {
     70 	u_int bf_len;
     71 	struct bpf_insn *bf_insns;
     72 };
     73 
     74 /*
     75  * Struct returned by BIOCGSTATS.
     76  */
     77 struct bpf_stat {
     78 	u_int bs_recv;		/* number of packets received */
     79 	u_int bs_drop;		/* number of packets dropped */
     80 };
     81 
     82 /*
     83  * Struct return by BIOCVERSION.  This represents the version number of
     84  * the filter language described by the instruction encodings below.
     85  * bpf understands a program iff kernel_major == filter_major &&
     86  * kernel_minor >= filter_minor, that is, if the value returned by the
     87  * running kernel has the same major number and a minor number equal
     88  * equal to or less than the filter being downloaded.  Otherwise, the
     89  * results are undefined, meaning an error may be returned or packets
     90  * may be accepted haphazardly.
     91  * It has nothing to do with the source code version.
     92  */
     93 struct bpf_version {
     94 	u_short bv_major;
     95 	u_short bv_minor;
     96 };
     97 /* Current version number of filter architecture. */
     98 #define BPF_MAJOR_VERSION 1
     99 #define BPF_MINOR_VERSION 1
    100 
    101 /*
    102  * BPF ioctls
    103  *
    104  * The first set is for compatibility with Sun's pcc style
    105  * header files.  If your using gcc, we assume that you
    106  * have run fixincludes so the latter set should work.
    107  */
    108 #if (defined(sun) || defined(ibm032)) && !defined(__GNUC__)
    109 #define	BIOCGBLEN	_IOR(B,102, u_int)
    110 #define	BIOCSBLEN	_IOWR(B,102, u_int)
    111 #define	BIOCSETF	_IOW(B,103, struct bpf_program)
    112 #define	BIOCFLUSH	_IO(B,104)
    113 #define BIOCPROMISC	_IO(B,105)
    114 #define	BIOCGDLT	_IOR(B,106, u_int)
    115 #define BIOCGETIF	_IOR(B,107, struct ifreq)
    116 #define BIOCSETIF	_IOW(B,108, struct ifreq)
    117 #define BIOCSRTIMEOUT	_IOW(B,109, struct timeval)
    118 #define BIOCGRTIMEOUT	_IOR(B,110, struct timeval)
    119 #define BIOCGSTATS	_IOR(B,111, struct bpf_stat)
    120 #define BIOCIMMEDIATE	_IOW(B,112, u_int)
    121 #define BIOCVERSION	_IOR(B,113, struct bpf_version)
    122 #define BIOCSTCPF	_IOW(B,114, struct bpf_program)
    123 #define BIOCSUDPF	_IOW(B,115, struct bpf_program)
    124 #define	BIOCGHDRCMPLT	_IOR(B,116, u_int)
    125 #define	BIOCSHDRCMPLT	_IOW(B,117, u_int)
    126 #define	BIOCSDLT	_IOW(B,118, u_int)
    127 #define	BIOCGDLTLIST	_IOWR(B,119, struct bpf_dltlist)
    128 #else
    129 #define	BIOCGBLEN	_IOR('B',102, u_int)
    130 #define	BIOCSBLEN	_IOWR('B',102, u_int)
    131 #define	BIOCSETF	_IOW('B',103, struct bpf_program)
    132 #define	BIOCFLUSH	_IO('B',104)
    133 #define BIOCPROMISC	_IO('B',105)
    134 #define	BIOCGDLT	_IOR('B',106, u_int)
    135 #define BIOCGETIF	_IOR('B',107, struct ifreq)
    136 #define BIOCSETIF	_IOW('B',108, struct ifreq)
    137 #define BIOCSRTIMEOUT	_IOW('B',109, struct timeval)
    138 #define BIOCGRTIMEOUT	_IOR('B',110, struct timeval)
    139 #define BIOCGSTATS	_IOR('B',111, struct bpf_stat)
    140 #define BIOCIMMEDIATE	_IOW('B',112, u_int)
    141 #define BIOCVERSION	_IOR('B',113, struct bpf_version)
    142 #define BIOCSTCPF	_IOW('B',114, struct bpf_program)
    143 #define BIOCSUDPF	_IOW('B',115, struct bpf_program)
    144 #define	BIOCGHDRCMPLT	_IOR('B',116, u_int)
    145 #define	BIOCSHDRCMPLT	_IOW('B',117, u_int)
    146 #define	BIOCSDLT	_IOW('B',118, u_int)
    147 #define	BIOCGDLTLIST	_IOWR('B',119, struct bpf_dltlist)
    148 #endif
    149 
    150 /*
    151  * Structure prepended to each packet.
    152  */
    153 struct bpf_hdr {
    154 	struct timeval	bh_tstamp;	/* time stamp */
    155 	u_int32_t	bh_caplen;	/* length of captured portion */
    156 	u_int32_t	bh_datalen;	/* original length of packet */
    157 	u_int16_t	bh_hdrlen;	/* length of bpf header (this struct
    158 					   plus alignment padding) */
    159 };
    160 /*
    161  * Because the structure above is not a multiple of 4 bytes, some compilers
    162  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
    163  * Only the kernel needs to know about it; applications use bh_hdrlen.
    164  * XXX To save a few bytes on 32-bit machines, we avoid end-of-struct
    165  * XXX padding by using the size of the header data elements.  This is
    166  * XXX fail-safe: on new machines, we just use the 'safe' sizeof.
    167  */
    168 #ifdef _KERNEL
    169 #if defined(__arm32__) || defined(__i386__) || defined(__m68k__) || \
    170     defined(__mips__) || defined(__ns32k__) || defined(__vax__) || \
    171     defined(__sh__) || (defined(__sparc__) && !defined(__sparc64__))
    172 #define SIZEOF_BPF_HDR 18
    173 #else
    174 #define SIZEOF_BPF_HDR sizeof(struct bpf_hdr)
    175 #endif
    176 #endif
    177 
    178 /* Pull in data-link level type codes. */
    179 #include <net/dlt.h>
    180 
    181 /*
    182  * The instruction encondings.
    183  */
    184 /* instruction classes */
    185 #define BPF_CLASS(code) ((code) & 0x07)
    186 #define		BPF_LD		0x00
    187 #define		BPF_LDX		0x01
    188 #define		BPF_ST		0x02
    189 #define		BPF_STX		0x03
    190 #define		BPF_ALU		0x04
    191 #define		BPF_JMP		0x05
    192 #define		BPF_RET		0x06
    193 #define		BPF_MISC	0x07
    194 
    195 /* ld/ldx fields */
    196 #define BPF_SIZE(code)	((code) & 0x18)
    197 #define		BPF_W		0x00
    198 #define		BPF_H		0x08
    199 #define		BPF_B		0x10
    200 #define BPF_MODE(code)	((code) & 0xe0)
    201 #define		BPF_IMM 	0x00
    202 #define		BPF_ABS		0x20
    203 #define		BPF_IND		0x40
    204 #define		BPF_MEM		0x60
    205 #define		BPF_LEN		0x80
    206 #define		BPF_MSH		0xa0
    207 
    208 /* alu/jmp fields */
    209 #define BPF_OP(code)	((code) & 0xf0)
    210 #define		BPF_ADD		0x00
    211 #define		BPF_SUB		0x10
    212 #define		BPF_MUL		0x20
    213 #define		BPF_DIV		0x30
    214 #define		BPF_OR		0x40
    215 #define		BPF_AND		0x50
    216 #define		BPF_LSH		0x60
    217 #define		BPF_RSH		0x70
    218 #define		BPF_NEG		0x80
    219 #define		BPF_JA		0x00
    220 #define		BPF_JEQ		0x10
    221 #define		BPF_JGT		0x20
    222 #define		BPF_JGE		0x30
    223 #define		BPF_JSET	0x40
    224 #define BPF_SRC(code)	((code) & 0x08)
    225 #define		BPF_K		0x00
    226 #define		BPF_X		0x08
    227 
    228 /* ret - BPF_K and BPF_X also apply */
    229 #define BPF_RVAL(code)	((code) & 0x18)
    230 #define		BPF_A		0x10
    231 
    232 /* misc */
    233 #define BPF_MISCOP(code) ((code) & 0xf8)
    234 #define		BPF_TAX		0x00
    235 #define		BPF_TXA		0x80
    236 
    237 /*
    238  * The instruction data structure.
    239  */
    240 struct bpf_insn {
    241 	u_int16_t code;
    242 	u_char 	  jt;
    243 	u_char 	  jf;
    244 	int32_t	  k;
    245 };
    246 
    247 /*
    248  * Macros for insn array initializers.
    249  */
    250 #define BPF_STMT(code, k) { (u_int16_t)(code), 0, 0, k }
    251 #define BPF_JUMP(code, k, jt, jf) { (u_int16_t)(code), jt, jf, k }
    252 
    253 /*
    254  * Structure to retrieve available DLTs for the interface.
    255  */
    256 struct bpf_dltlist {
    257 	u_int	bfl_len;	/* number of bfd_list array */
    258 	u_int	*bfl_list;	/* array of DLTs */
    259 };
    260 
    261 #ifdef _KERNEL
    262 int	 bpf_validate __P((struct bpf_insn *, int));
    263 void	 bpf_tap __P((caddr_t, u_char *, u_int));
    264 void	 bpf_mtap __P((caddr_t, struct mbuf *));
    265 void	 bpfattach __P((struct ifnet *, u_int, u_int));
    266 void	 bpfattach2 __P((struct ifnet *, u_int, u_int, caddr_t *));
    267 void	 bpfdetach __P((struct ifnet *));
    268 void	 bpf_change_type __P((struct ifnet *, u_int, u_int));
    269 void	 bpfilterattach __P((int));
    270 #endif
    271 
    272 u_int	 bpf_filter __P((struct bpf_insn *, u_char *, u_int, u_int));
    273 
    274 /*
    275  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
    276  */
    277 #define BPF_MEMWORDS 16
    278 
    279 #endif /* _NET_BPF_H_ */
    280