[unix-history] / usr / src / sys / net / bpf.h

/*
 * Copyright (c) 1990, 1991, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from the Stanford/CMU enet packet filter,
 * (net/enet.c) distributed as part of 4.3BSD, and code contributed
 * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
 * Berkeley Laboratory.
 *
 * %sccs.include.redist.c%
 *
 *      @(#)bpf.h	8.1 (Berkeley) %G%
 *
 * @(#) $Header: bpf.h,v 1.24 91/10/27 21:22:32 mccanne Exp $ (LBL)
 */

/*
 * Alignment macros.  BPF_WORDALIGN rounds up to the next 
 * even multiple of BPF_ALIGNMENT. 
 */
#define BPF_ALIGNMENT sizeof(long)
#define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))

#define BPF_MAXINSNS 512
#define BPF_MAXBUFSIZE 0x8000
#define BPF_MINBUFSIZE 32

/*
 *  Structure for BIOCSETF.
 */
struct bpf_program {
	u_int bf_len;
	struct bpf_insn *bf_insns;
};
 
/*
 * Struct returned by BIOCGSTATS.
 */
struct bpf_stat {
	u_int bs_recv;		/* number of packets received */
	u_int bs_drop;		/* number of packets dropped */
};

/*
 * Struct return by BIOCVERSION.  This represents the version number of 
 * the filter language described by the instruction encodings below.
 * bpf understands a program iff kernel_major == filter_major &&
 * kernel_minor >= filter_minor, that is, if the value returned by the
 * running kernel has the same major number and a minor number equal
 * equal to or less than the filter being downloaded.  Otherwise, the
 * results are undefined, meaning an error may be returned or packets
 * may be accepted haphazardly.
 * It has nothing to do with the source code version.
 */
struct bpf_version {
	u_short bv_major;
	u_short bv_minor;
};
/* Current version number. */
#define BPF_MAJOR_VERSION 1
#define BPF_MINOR_VERSION 1

/*
 * BPF ioctls
 *
 * The first set is for compatibility with Sun's pcc style
 * header files.  If your using gcc, we assume that you
 * have run fixincludes so the latter set should work.
 */
#if (defined(sun) || defined(ibm032)) && !defined(__GNUC__)
#define	BIOCGBLEN	_IOR(B,102, u_int)
#define	BIOCSBLEN	_IOWR(B,102, u_int)
#define	BIOCSETF	_IOW(B,103, struct bpf_program)
#define	BIOCFLUSH	_IO(B,104)
#define BIOCPROMISC	_IO(B,105)
#define	BIOCGDLT	_IOR(B,106, u_int)
#define BIOCGETIF	_IOR(B,107, struct ifreq)
#define BIOCSETIF	_IOW(B,108, struct ifreq)
#define BIOCSRTIMEOUT	_IOW(B,109, struct timeval)
#define BIOCGRTIMEOUT	_IOR(B,110, struct timeval)
#define BIOCGSTATS	_IOR(B,111, struct bpf_stat)
#define BIOCIMMEDIATE	_IOW(B,112, u_int)
#define BIOCVERSION	_IOR(B,113, struct bpf_version)
#else
#define	BIOCGBLEN	_IOR('B',102, u_int)
#define	BIOCSBLEN	_IOWR('B',102, u_int)
#define	BIOCSETF	_IOW('B',103, struct bpf_program)
#define	BIOCFLUSH	_IO('B',104)
#define BIOCPROMISC	_IO('B',105)
#define	BIOCGDLT	_IOR('B',106, u_int)
#define BIOCGETIF	_IOR('B',107, struct ifreq)
#define BIOCSETIF	_IOW('B',108, struct ifreq)
#define BIOCSRTIMEOUT	_IOW('B',109, struct timeval)
#define BIOCGRTIMEOUT	_IOR('B',110, struct timeval)
#define BIOCGSTATS	_IOR('B',111, struct bpf_stat)
#define BIOCIMMEDIATE	_IOW('B',112, u_int)
#define BIOCVERSION	_IOR('B',113, struct bpf_version)
#endif

/*
 * Structure prepended to each packet.
 */
struct bpf_hdr {
	struct timeval	bh_tstamp;	/* time stamp */
	u_long		bh_caplen;	/* length of captured portion */
	u_long		bh_datalen;	/* original length of packet */
	u_short		bh_hdrlen;	/* length of bpf header (this struct
					   plus alignment padding) */
};
/*
 * Because the structure above is not a multiple of 4 bytes, some compilers
 * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
 * Only the kernel needs to know about it; applications use bh_hdrlen.
 */
#ifdef KERNEL
#define SIZEOF_BPF_HDR 18
#endif

/*
 * Data-link level type codes.
 * Currently, only DLT_EN10MB and DLT_SLIP are supported.
 */
#define DLT_NULL	0	/* no link-layer encapsulation */
#define DLT_EN10MB	1	/* Ethernet (10Mb) */
#define DLT_EN3MB	2	/* Experimental Ethernet (3Mb) */
#define DLT_AX25	3	/* Amateur Radio AX.25 */
#define DLT_PRONET	4	/* Proteon ProNET Token Ring */
#define DLT_CHAOS	5	/* Chaos */
#define DLT_IEEE802	6	/* IEEE 802 Networks */
#define DLT_ARCNET	7	/* ARCNET */
#define DLT_SLIP	8	/* Serial Line IP */
#define DLT_PPP		9	/* Point-to-point Protocol */
#define DLT_FDDI	10	/* FDDI */

/*
 * The instruction encondings.
 */
/* instruction classes */
#define BPF_CLASS(code) ((code) & 0x07)
#define		BPF_LD		0x00
#define		BPF_LDX		0x01
#define		BPF_ST		0x02
#define		BPF_STX		0x03
#define		BPF_ALU		0x04
#define		BPF_JMP		0x05
#define		BPF_RET		0x06
#define		BPF_MISC	0x07

/* ld/ldx fields */
#define BPF_SIZE(code)	((code) & 0x18)
#define		BPF_W		0x00
#define		BPF_H		0x08
#define		BPF_B		0x10
#define BPF_MODE(code)	((code) & 0xe0)
#define		BPF_IMM 	0x00
#define		BPF_ABS		0x20
#define		BPF_IND		0x40
#define		BPF_MEM		0x60
#define		BPF_LEN		0x80
#define		BPF_MSH		0xa0

/* alu/jmp fields */
#define BPF_OP(code)	((code) & 0xf0)
#define		BPF_ADD		0x00
#define		BPF_SUB		0x10
#define		BPF_MUL		0x20
#define		BPF_DIV		0x30
#define		BPF_OR		0x40
#define		BPF_AND		0x50
#define		BPF_LSH		0x60
#define		BPF_RSH		0x70
#define		BPF_NEG		0x80
#define		BPF_JA		0x00
#define		BPF_JEQ		0x10
#define		BPF_JGT		0x20
#define		BPF_JGE		0x30
#define		BPF_JSET	0x40
#define BPF_SRC(code)	((code) & 0x08)
#define		BPF_K		0x00
#define		BPF_X		0x08

/* ret - BPF_K and BPF_X also apply */
#define BPF_RVAL(code)	((code) & 0x18)
#define		BPF_A		0x10

/* misc */
#define BPF_MISCOP(code) ((code) & 0xf8)
#define		BPF_TAX		0x00
#define		BPF_TXA		0x80

/*
 * The instruction data structure.
 */
struct bpf_insn {
	u_short	code;
	u_char 	jt;
	u_char 	jf;
	long	k;
};

/*
 * Macros for insn array initializers.
 */
#define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
#define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }

#ifdef KERNEL
int	 bpf_validate __P((struct bpf_insn *, int));
int	 bpfopen __P((dev_t, int));
int	 bpfclose __P((dev_t, int));
int	 bpfread __P((dev_t, struct uio *));
int	 bpfwrite __P((dev_t, struct uio *));
int	 bpfioctl __P((dev_t, int, caddr_t, int));
int	 bpf_select __P((dev_t, int, struct proc *));
void	 bpf_tap __P((caddr_t, u_char *, u_int));
void	 bpf_mtap __P((caddr_t, struct mbuf *));
void	 bpfattach __P((caddr_t *, struct ifnet *, u_int, u_int));
void	 bpfilterattach __P((int));
u_int	 bpf_filter __P((struct bpf_insn *, u_char *, u_int, u_int));
#endif

/*
 * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
 */
#define BPF_MEMWORDS 16
Commit	Line	Data
81c7b6ec	1	/*
86090d31 KB	2	* Copyright (c) 1990, 1991, 1993
86090d31 KB	3	* The Regents of the University of California. All rights reserved.
11569edc	4	*
6cfe221b KB	5	* This code is derived from the Stanford/CMU enet packet filter,
6cfe221b KB	6	* (net/enet.c) distributed as part of 4.3BSD, and code contributed
81c7b6ec	7	* to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
d9f44bf8	8	* Berkeley Laboratory.
11569edc	9	*
81c7b6ec	10	* %sccs.include.redist.c%
6cfe221b	11	*
86090d31	12	* @(#)bpf.h 8.1 (Berkeley) %G%
d9f44bf8 SM	13	*
d9f44bf8 SM	14	* @(#) $Header: bpf.h,v 1.24 91/10/27 21:22:32 mccanne Exp $ (LBL)
11569edc SM	15	*/
	16
	17	/*
	18	* Alignment macros. BPF_WORDALIGN rounds up to the next
	19	* even multiple of BPF_ALIGNMENT.
	20	*/
	21	#define BPF_ALIGNMENT sizeof(long)
	22	#define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
	23
f8e186b1 SM	24	#define BPF_MAXINSNS 512
f8e186b1 SM	25	#define BPF_MAXBUFSIZE 0x8000
635b572c	26	#define BPF_MINBUFSIZE 32
f8e186b1	27
11569edc SM	28	/*
	29	* Structure for BIOCSETF.
	30	*/
	31	struct bpf_program {
	32	u_int bf_len;
	33	struct bpf_insn *bf_insns;
	34	};
	35
	36	/*
	37	* Struct returned by BIOCGSTATS.
	38	*/
	39	struct bpf_stat {
	40	u_int bs_recv; /* number of packets received */
	41	u_int bs_drop; /* number of packets dropped */
	42	};
	43
635b572c SM	44	/*
	45	* Struct return by BIOCVERSION. This represents the version number of
	46	* the filter language described by the instruction encodings below.
	47	* bpf understands a program iff kernel_major == filter_major &&
	48	* kernel_minor >= filter_minor, that is, if the value returned by the
	49	* running kernel has the same major number and a minor number equal
	50	* equal to or less than the filter being downloaded. Otherwise, the
	51	* results are undefined, meaning an error may be returned or packets
	52	* may be accepted haphazardly.
	53	* It has nothing to do with the source code version.
	54	*/
	55	struct bpf_version {
	56	u_short bv_major;
	57	u_short bv_minor;
	58	};
	59	/* Current version number. */
	60	#define BPF_MAJOR_VERSION 1
	61	#define BPF_MINOR_VERSION 1
	62
11569edc SM	63	/*
	64	* BPF ioctls
	65	*
	66	* The first set is for compatibility with Sun's pcc style
	67	* header files. If your using gcc, we assume that you
	68	* have run fixincludes so the latter set should work.
	69	*/
d9f44bf8	70	#if (defined(sun) \|\| defined(ibm032)) && !defined(__GNUC__)
11569edc	71	#define BIOCGBLEN _IOR(B,102, u_int)
d9f44bf8	72	#define BIOCSBLEN _IOWR(B,102, u_int)
11569edc SM	73	#define BIOCSETF _IOW(B,103, struct bpf_program)
	74	#define BIOCFLUSH _IO(B,104)
	75	#define BIOCPROMISC _IO(B,105)
732c04ca	76	#define BIOCGDLT _IOR(B,106, u_int)
11569edc SM	77	#define BIOCGETIF _IOR(B,107, struct ifreq)
	78	#define BIOCSETIF _IOW(B,108, struct ifreq)
	79	#define BIOCSRTIMEOUT _IOW(B,109, struct timeval)
	80	#define BIOCGRTIMEOUT _IOR(B,110, struct timeval)
	81	#define BIOCGSTATS _IOR(B,111, struct bpf_stat)
	82	#define BIOCIMMEDIATE _IOW(B,112, u_int)
635b572c	83	#define BIOCVERSION _IOR(B,113, struct bpf_version)
11569edc	84	#else
11569edc	85	#define BIOCGBLEN _IOR('B',102, u_int)
d9f44bf8	86	#define BIOCSBLEN _IOWR('B',102, u_int)
11569edc SM	87	#define BIOCSETF _IOW('B',103, struct bpf_program)
	88	#define BIOCFLUSH _IO('B',104)
	89	#define BIOCPROMISC _IO('B',105)
732c04ca	90	#define BIOCGDLT _IOR('B',106, u_int)
11569edc SM	91	#define BIOCGETIF _IOR('B',107, struct ifreq)
	92	#define BIOCSETIF _IOW('B',108, struct ifreq)
	93	#define BIOCSRTIMEOUT _IOW('B',109, struct timeval)
	94	#define BIOCGRTIMEOUT _IOR('B',110, struct timeval)
	95	#define BIOCGSTATS _IOR('B',111, struct bpf_stat)
	96	#define BIOCIMMEDIATE _IOW('B',112, u_int)
635b572c	97	#define BIOCVERSION _IOR('B',113, struct bpf_version)
11569edc SM	98	#endif
11569edc SM	99
11569edc SM	100	/*
	101	* Structure prepended to each packet.
	102	*/
	103	struct bpf_hdr {
	104	struct timeval bh_tstamp; /* time stamp */
	105	u_long bh_caplen; /* length of captured portion */
	106	u_long bh_datalen; /* original length of packet */
	107	u_short bh_hdrlen; /* length of bpf header (this struct
	108	plus alignment padding) */
	109	};
	110	/*
	111	* Because the structure above is not a multiple of 4 bytes, some compilers
	112	* will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
	113	* Only the kernel needs to know about it; applications use bh_hdrlen.
	114	*/
	115	#ifdef KERNEL
	116	#define SIZEOF_BPF_HDR 18
	117	#endif
	118
	119	/*
	120	* Data-link level type codes.
732c04ca	121	* Currently, only DLT_EN10MB and DLT_SLIP are supported.
11569edc	122	*/
d9f44bf8	123	#define DLT_NULL 0 /* no link-layer encapsulation */
11569edc SM	124	#define DLT_EN10MB 1 /* Ethernet (10Mb) */
	125	#define DLT_EN3MB 2 /* Experimental Ethernet (3Mb) */
	126	#define DLT_AX25 3 /* Amateur Radio AX.25 */
	127	#define DLT_PRONET 4 /* Proteon ProNET Token Ring */
	128	#define DLT_CHAOS 5 /* Chaos */
	129	#define DLT_IEEE802 6 /* IEEE 802 Networks */
	130	#define DLT_ARCNET 7 /* ARCNET */
	131	#define DLT_SLIP 8 /* Serial Line IP */
	132	#define DLT_PPP 9 /* Point-to-point Protocol */
	133	#define DLT_FDDI 10 /* FDDI */
	134
	135	/*
e6ce130c	136	* The instruction encondings.
11569edc	137	*/
635b572c	138	/* instruction classes */
e6ce130c SM	139	#define BPF_CLASS(code) ((code) & 0x07)
	140	#define BPF_LD 0x00
	141	#define BPF_LDX 0x01
	142	#define BPF_ST 0x02
	143	#define BPF_STX 0x03
	144	#define BPF_ALU 0x04
	145	#define BPF_JMP 0x05
	146	#define BPF_RET 0x06
	147	#define BPF_MISC 0x07
	148
	149	/* ld/ldx fields */
	150	#define BPF_SIZE(code) ((code) & 0x18)
	151	#define BPF_W 0x00
	152	#define BPF_H 0x08
	153	#define BPF_B 0x10
	154	#define BPF_MODE(code) ((code) & 0xe0)
	155	#define BPF_IMM 0x00
	156	#define BPF_ABS 0x20
	157	#define BPF_IND 0x40
	158	#define BPF_MEM 0x60
	159	#define BPF_LEN 0x80
	160	#define BPF_MSH 0xa0
	161
	162	/* alu/jmp fields */
	163	#define BPF_OP(code) ((code) & 0xf0)
	164	#define BPF_ADD 0x00
	165	#define BPF_SUB 0x10
	166	#define BPF_MUL 0x20
	167	#define BPF_DIV 0x30
	168	#define BPF_OR 0x40
	169	#define BPF_AND 0x50
	170	#define BPF_LSH 0x60
	171	#define BPF_RSH 0x70
	172	#define BPF_NEG 0x80
	173	#define BPF_JA 0x00
	174	#define BPF_JEQ 0x10
	175	#define BPF_JGT 0x20
	176	#define BPF_JGE 0x30
	177	#define BPF_JSET 0x40
	178	#define BPF_SRC(code) ((code) & 0x08)
	179	#define BPF_K 0x00
	180	#define BPF_X 0x08
	181
	182	/* ret - BPF_K and BPF_X also apply */
	183	#define BPF_RVAL(code) ((code) & 0x18)
	184	#define BPF_A 0x10
11569edc	185
e6ce130c SM	186	/* misc */
	187	#define BPF_MISCOP(code) ((code) & 0xf8)
	188	#define BPF_TAX 0x00
	189	#define BPF_TXA 0x80
11569edc SM	190
	191	/*
	192	* The instruction data structure.
	193	*/
	194	struct bpf_insn {
	195	u_short code;
	196	u_char jt;
	197	u_char jf;
	198	long k;
	199	};
	200
	201	/*
e6ce130c	202	* Macros for insn array initializers.
11569edc	203	*/
e6ce130c SM	204	#define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
e6ce130c SM	205	#define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
11569edc SM	206
11569edc SM	207	#ifdef KERNEL
c4420f77 KB	208	int bpf_validate __P((struct bpf_insn *, int));
	209	int bpfopen __P((dev_t, int));
	210	int bpfclose __P((dev_t, int));
	211	int bpfread __P((dev_t, struct uio *));
	212	int bpfwrite __P((dev_t, struct uio *));
	213	int bpfioctl __P((dev_t, int, caddr_t, int));
	214	int bpf_select __P((dev_t, int, struct proc *));
	215	void bpf_tap __P((caddr_t, u_char *, u_int));
	216	void bpf_mtap __P((caddr_t, struct mbuf *));
	217	void bpfattach __P((caddr_t , struct ifnet , u_int, u_int));
	218	void bpfilterattach __P((int));
	219	u_int bpf_filter __P((struct bpf_insn , u_char , u_int, u_int));
11569edc SM	220	#endif
	221
	222	/*
e6ce130c	223	* Number of scratch memory words (for BPF_LD\|BPF_MEM and BPF_ST).
11569edc SM	224	*/
11569edc SM	225	#define BPF_MEMWORDS 16
d9f44bf8	226