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

/*-
 * Copyright (c) 1990 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 of Lawrence Berkeley Laboratory.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)bpf.h	7.1 (Berkeley) 5/7/91
 *
 * @(#) $Header: bpf.h,v 1.20 91/04/24 22:06:24 mccanne Locked $ (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

/*
 *  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 */
};

/*
 * 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(__GNUC__)
#define	BIOCGFLEN	_IOR(B,101, u_int)
#define	BIOCGBLEN	_IOR(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)
#else
#define	BIOCGFLEN	_IOR('B',101, u_int)
#define	BIOCGBLEN	_IOR('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)
#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_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.
 */
/* classes <2:0> */
#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
extern u_int bpf_filter();
extern void bpfattach();
extern void bpf_tap();
extern void bpf_mtap();
#endif

/*
 * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
 */
#define BPF_MEMWORDS 16
Commit	Line	Data
b688fc87 WJ	1	/*-
	2	* Copyright (c) 1990 The Regents of the University of California.
	3	* All rights reserved.
	4	*
	5	* This code is derived from the Stanford/CMU enet packet filter,
	6	* (net/enet.c) distributed as part of 4.3BSD, and code contributed
	7	* to Berkeley by Steven McCanne of Lawrence Berkeley Laboratory.
	8	*
	9	* Redistribution and use in source and binary forms, with or without
	10	* modification, are permitted provided that the following conditions
	11	* are met:
	12	* 1. Redistributions of source code must retain the above copyright
	13	* notice, this list of conditions and the following disclaimer.
	14	* 2. Redistributions in binary form must reproduce the above copyright
	15	* notice, this list of conditions and the following disclaimer in the
	16	* documentation and/or other materials provided with the distribution.
	17	* 3. All advertising materials mentioning features or use of this software
	18	* must display the following acknowledgement:
	19	* This product includes software developed by the University of
	20	* California, Berkeley and its contributors.
	21	* 4. Neither the name of the University nor the names of its contributors
	22	* may be used to endorse or promote products derived from this software
	23	* without specific prior written permission.
	24	*
	25	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	26	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	27	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	28	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	29	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	30	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	31	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	32	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	33	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	34	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	35	* SUCH DAMAGE.
	36	*
	37	* @(#)bpf.h 7.1 (Berkeley) 5/7/91
	38	*
	39	* @(#) $Header: bpf.h,v 1.20 91/04/24 22:06:24 mccanne Locked $ (LBL)
	40	*/
	41
	42	/*
	43	* Alignment macros. BPF_WORDALIGN rounds up to the next
	44	* even multiple of BPF_ALIGNMENT.
	45	*/
	46	#define BPF_ALIGNMENT sizeof(long)
	47	#define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
	48
	49	#define BPF_MAXINSNS 512
	50	#define BPF_MAXBUFSIZE 0x8000
	51
	52	/*
	53	* Structure for BIOCSETF.
	54	*/
	55	struct bpf_program {
	56	u_int bf_len;
	57	struct bpf_insn *bf_insns;
	58	};
	59
	60	/*
	61	* Struct returned by BIOCGSTATS.
	62	*/
	63	struct bpf_stat {
	64	u_int bs_recv; /* number of packets received */
65	u_int bs_drop; /* number of packets dropped */
66	};
67
68	/*
69	* BPF ioctls
70	*
71	* The first set is for compatibility with Sun's pcc style
72	* header files. If your using gcc, we assume that you
73	* have run fixincludes so the latter set should work.
74	*/
75	#if defined(sun) && !defined(__GNUC__)
76	#define BIOCGFLEN _IOR(B,101, u_int)
77	#define BIOCGBLEN _IOR(B,102, u_int)
78	#define BIOCSETF _IOW(B,103, struct bpf_program)
79	#define BIOCFLUSH _IO(B,104)
80	#define BIOCPROMISC _IO(B,105)
81	#define BIOCGDLT _IOR(B,106, u_int)
82	#define BIOCGETIF _IOR(B,107, struct ifreq)
83	#define BIOCSETIF _IOW(B,108, struct ifreq)
84	#define BIOCSRTIMEOUT _IOW(B,109, struct timeval)
85	#define BIOCGRTIMEOUT _IOR(B,110, struct timeval)
86	#define BIOCGSTATS _IOR(B,111, struct bpf_stat)
87	#define BIOCIMMEDIATE _IOW(B,112, u_int)
88	#else
89	#define BIOCGFLEN _IOR('B',101, u_int)
90	#define BIOCGBLEN _IOR('B',102, u_int)
91	#define BIOCSETF _IOW('B',103, struct bpf_program)
92	#define BIOCFLUSH _IO('B',104)
93	#define BIOCPROMISC _IO('B',105)
94	#define BIOCGDLT _IOR('B',106, u_int)
95	#define BIOCGETIF _IOR('B',107, struct ifreq)
96	#define BIOCSETIF _IOW('B',108, struct ifreq)
97	#define BIOCSRTIMEOUT _IOW('B',109, struct timeval)
98	#define BIOCGRTIMEOUT _IOR('B',110, struct timeval)
99	#define BIOCGSTATS _IOR('B',111, struct bpf_stat)
100	#define BIOCIMMEDIATE _IOW('B',112, u_int)
101	#endif
102
103	/*
104	* Structure prepended to each packet.
105	*/
106	struct bpf_hdr {
107	struct timeval bh_tstamp; /* time stamp */
108	u_long bh_caplen; /* length of captured portion */
109	u_long bh_datalen; /* original length of packet */
110	u_short bh_hdrlen; /* length of bpf header (this struct
111	plus alignment padding) */
112	};
113	/*
114	* Because the structure above is not a multiple of 4 bytes, some compilers
115	* will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
116	* Only the kernel needs to know about it; applications use bh_hdrlen.
117	*/
118	#ifdef KERNEL
119	#define SIZEOF_BPF_HDR 18
120	#endif
121
122	/*
123	* Data-link level type codes.
124	* Currently, only DLT_EN10MB and DLT_SLIP are supported.
125	*/
126	#define DLT_EN10MB 1 /* Ethernet (10Mb) */
127	#define DLT_EN3MB 2 /* Experimental Ethernet (3Mb) */
128	#define DLT_AX25 3 /* Amateur Radio AX.25 */
129	#define DLT_PRONET 4 /* Proteon ProNET Token Ring */
130	#define DLT_CHAOS 5 /* Chaos */
131	#define DLT_IEEE802 6 /* IEEE 802 Networks */
132	#define DLT_ARCNET 7 /* ARCNET */
133	#define DLT_SLIP 8 /* Serial Line IP */
134	#define DLT_PPP 9 /* Point-to-point Protocol */
135	#define DLT_FDDI 10 /* FDDI */
136
137	/*
138	* The instruction encondings.
139	*/
140	/* classes <2:0> */
141	#define BPF_CLASS(code) ((code) & 0x07)
142	#define BPF_LD 0x00
143	#define BPF_LDX 0x01
144	#define BPF_ST 0x02
145	#define BPF_STX 0x03
146	#define BPF_ALU 0x04
147	#define BPF_JMP 0x05
148	#define BPF_RET 0x06
149	#define BPF_MISC 0x07
150
151	/* ld/ldx fields */
152	#define BPF_SIZE(code) ((code) & 0x18)
153	#define BPF_W 0x00
154	#define BPF_H 0x08
155	#define BPF_B 0x10
156	#define BPF_MODE(code) ((code) & 0xe0)
157	#define BPF_IMM 0x00
158	#define BPF_ABS 0x20
159	#define BPF_IND 0x40
160	#define BPF_MEM 0x60
161	#define BPF_LEN 0x80
162	#define BPF_MSH 0xa0
163
164	/* alu/jmp fields */
165	#define BPF_OP(code) ((code) & 0xf0)
166	#define BPF_ADD 0x00
167	#define BPF_SUB 0x10
168	#define BPF_MUL 0x20
169	#define BPF_DIV 0x30
170	#define BPF_OR 0x40
171	#define BPF_AND 0x50
172	#define BPF_LSH 0x60
173	#define BPF_RSH 0x70
174	#define BPF_NEG 0x80
175	#define BPF_JA 0x00
176	#define BPF_JEQ 0x10
177	#define BPF_JGT 0x20
178	#define BPF_JGE 0x30
179	#define BPF_JSET 0x40
180	#define BPF_SRC(code) ((code) & 0x08)
181	#define BPF_K 0x00
182	#define BPF_X 0x08
183
184	/* ret - BPF_K and BPF_X also apply */
185	#define BPF_RVAL(code) ((code) & 0x18)
186	#define BPF_A 0x10
187
188	/* misc */
189	#define BPF_MISCOP(code) ((code) & 0xf8)
190	#define BPF_TAX 0x00
191	#define BPF_TXA 0x80
192
193	/*
194	* The instruction data structure.
195	*/
196	struct bpf_insn {
197	u_short code;
198	u_char jt;
199	u_char jf;
200	long k;
201	};
202
203	/*
204	* Macros for insn array initializers.
205	*/
206	#define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
207	#define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
208
209	#ifdef KERNEL
210	extern u_int bpf_filter();
211	extern void bpfattach();
212	extern void bpf_tap();
213	extern void bpf_mtap();
214	#endif
215
216	/*
217	* Number of scratch memory words (for BPF_LD\|BPF_MEM and BPF_ST).
218	*/
219	#define BPF_MEMWORDS 16