[apple/xnu.git] / bsd / net / bpfdesc.h

/*
 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * 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.
 *
 * 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.
 *
 *      @(#)bpfdesc.h	8.1 (Berkeley) 6/10/93
 *
 * $FreeBSD: src/sys/net/bpfdesc.h,v 1.14.2.1 2000/03/19 05:55:36 rwatson Exp $
 */

#ifndef _NET_BPFDESC_H_
#define _NET_BPFDESC_H_
#include <sys/appleapiopts.h>
#ifdef KERNEL_PRIVATE
/*
 * The items in this header file should be wrapped in #ifdef KERNEL.
 */

#include <sys/select.h>
#include <kern/thread_call.h>

/*
 * Descriptor associated with each open bpf file.
 */
struct bpf_d {
	struct bpf_d	*bd_next;	/* Linked list of descriptors */
	/*
	 * Buffer slots: two mbuf clusters buffer the incoming packets.
	 *   The model has three slots.  Sbuf is always occupied.
	 *   sbuf (store) - Receive interrupt puts packets here.
	 *   hbuf (hold) - When sbuf is full, put cluster here and
	 *                 wakeup read (replace sbuf with fbuf).
	 *   fbuf (free) - When read is done, put cluster here.
	 * On receiving, if sbuf is full and fbuf is 0, packet is dropped.
	 */
	caddr_t		bd_sbuf;	/* store slot */
	caddr_t		bd_hbuf;	/* hold slot */
	caddr_t		bd_fbuf;	/* free slot */
	int 		bd_slen;	/* current length of store buffer */
	int 		bd_hlen;	/* current length of hold buffer */

	int		bd_bufsize;	/* absolute length of buffers */

	struct bpf_if  *bd_bif;		/* interface descriptor */
	u_int32_t		bd_rtout;	/* Read timeout in 'ticks' */
	struct bpf_insn *bd_filter; 	/* filter code */
	u_int32_t		bd_rcount;	/* number of packets received */
	u_int32_t		bd_dcount;	/* number of packets dropped */

	u_char		bd_promisc;	/* true if listening promiscuously */
	u_char		bd_state;	/* idle, waiting, or timed out */
	u_char		bd_immediate;	/* true to return on packet arrival */
	int		bd_async;	/* non-zero if packet reception should generate signal */
	int		bd_sig;		/* signal to send upon packet reception */
#ifdef __APPLE__
	pid_t		bd_sigio;
#else
	struct sigio *	bd_sigio;	/* information for async I/O */
#endif

#if BSD < 199103
	u_char		bd_selcoll;	/* true if selects collide */
	int		bd_timedout;
	struct proc *	bd_selproc;	/* process that last selected us */
#else
	u_char		bd_pad;		/* explicit alignment */
	struct selinfo	bd_sel;		/* bsd select info */
#endif
	int		bd_hdrcmplt;	/* false to fill in src lladdr automatically */
	int		bd_seesent;	/* true if bpf should see sent packets */
	int		bd_oflags;	/* device open flags */
	thread_call_t bd_thread_call; /* for BPF timeouts with select */
#if CONFIG_MACF_NET
	struct label *	bd_label;	/* MAC label for descriptor */
#endif
};

/* Values for bd_state */
#define BPF_IDLE		0    /* no select in progress or kqueue pending */
#define BPF_WAITING		1    /* waiting for read timeout in select/kqueue */
#define BPF_TIMED_OUT 	2	 /* read timeout has expired in select/kqueue */
#define BPF_DRAINING	3	 /* waiting for timeout routine to finish during close */

/* Test whether a BPF is ready for read(). */
#define bpf_ready(bd)	((bd)->bd_hlen != 0 ||		\
			 (((bd)->bd_immediate || (bd)->bd_state == BPF_TIMED_OUT) && \
			  (bd)->bd_slen != 0))


/*
 * Descriptor associated with each attached hardware interface.
 */
struct bpf_if {
	struct bpf_if *bif_next;	/* list of all interfaces */
	struct bpf_d *bif_dlist;	/* descriptor list */
	u_int bif_dlt;			/* link layer type */
	u_int bif_hdrlen;		/* length of header (with padding) */
	struct ifnet *bif_ifp;		/* corresponding interface */
	bpf_send_func	bif_send;
	bpf_tap_func	bif_tap;
};

#endif /* KERNEL_PRIVATE */
#endif
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2007 Apple Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* Copyright (c) 1990, 1991, 1993
	30	* The Regents of the University of California. All rights reserved.
	31	*
	32	* This code is derived from the Stanford/CMU enet packet filter,
	33	* (net/enet.c) distributed as part of 4.3BSD, and code contributed
	34	* to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
	35	* Berkeley Laboratory.
	36	*
	37	* Redistribution and use in source and binary forms, with or without
	38	* modification, are permitted provided that the following conditions
	39	* are met:
	40	* 1. Redistributions of source code must retain the above copyright
	41	* notice, this list of conditions and the following disclaimer.
	42	* 2. Redistributions in binary form must reproduce the above copyright
	43	* notice, this list of conditions and the following disclaimer in the
	44	* documentation and/or other materials provided with the distribution.
	45	* 3. All advertising materials mentioning features or use of this software
	46	* must display the following acknowledgement:
	47	* This product includes software developed by the University of
	48	* California, Berkeley and its contributors.
	49	* 4. Neither the name of the University nor the names of its contributors
	50	* may be used to endorse or promote products derived from this software
	51	* without specific prior written permission.
	52	*
	53	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	54	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	55	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	56	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	57	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	58	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	59	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	60	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	61	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	62	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	63	* SUCH DAMAGE.
	64	*
	65	* @(#)bpfdesc.h 8.1 (Berkeley) 6/10/93
	66	*
9bccf70c	67	* $FreeBSD: src/sys/net/bpfdesc.h,v 1.14.2.1 2000/03/19 05:55:36 rwatson Exp $
1c79356b A	68	*/
	69
	70	#ifndef _NET_BPFDESC_H_
	71	#define _NET_BPFDESC_H_
9bccf70c	72	#include <sys/appleapiopts.h>
91447636	73	#ifdef KERNEL_PRIVATE
9bccf70c A	74	/*
	75	* The items in this header file should be wrapped in #ifdef KERNEL.
	76	*/
1c79356b A	77
1c79356b A	78	#include <sys/select.h>
6d2010ae	79	#include <kern/thread_call.h>
1c79356b A	80
	81	/*
	82	* Descriptor associated with each open bpf file.
	83	*/
	84	struct bpf_d {
	85	struct bpf_d bd_next; / Linked list of descriptors */
	86	/*
	87	* Buffer slots: two mbuf clusters buffer the incoming packets.
	88	* The model has three slots. Sbuf is always occupied.
	89	* sbuf (store) - Receive interrupt puts packets here.
	90	* hbuf (hold) - When sbuf is full, put cluster here and
	91	* wakeup read (replace sbuf with fbuf).
	92	* fbuf (free) - When read is done, put cluster here.
	93	* On receiving, if sbuf is full and fbuf is 0, packet is dropped.
	94	*/
	95	caddr_t bd_sbuf; /* store slot */
	96	caddr_t bd_hbuf; /* hold slot */
	97	caddr_t bd_fbuf; /* free slot */
	98	int bd_slen; /* current length of store buffer */
	99	int bd_hlen; /* current length of hold buffer */
	100
	101	int bd_bufsize; /* absolute length of buffers */
	102
6d2010ae	103	struct bpf_if bd_bif; / interface descriptor */
b0d623f7	104	u_int32_t bd_rtout; /* Read timeout in 'ticks' */
1c79356b	105	struct bpf_insn bd_filter; / filter code */
b0d623f7 A	106	u_int32_t bd_rcount; /* number of packets received */
b0d623f7 A	107	u_int32_t bd_dcount; /* number of packets dropped */
1c79356b A	108
	109	u_char bd_promisc; /* true if listening promiscuously */
	110	u_char bd_state; /* idle, waiting, or timed out */
	111	u_char bd_immediate; /* true to return on packet arrival */
	112	int bd_async; /* non-zero if packet reception should generate signal */
	113	int bd_sig; /* signal to send upon packet reception */
9bccf70c	114	#ifdef __APPLE__
1c79356b	115	pid_t bd_sigio;
9bccf70c A	116	#else
9bccf70c A	117	struct sigio * bd_sigio; /* information for async I/O */
1c79356b A	118	#endif
	119
	120	#if BSD < 199103
	121	u_char bd_selcoll; /* true if selects collide */
	122	int bd_timedout;
	123	struct proc * bd_selproc; /* process that last selected us */
	124	#else
	125	u_char bd_pad; /* explicit alignment */
	126	struct selinfo bd_sel; /* bsd select info */
	127	#endif
9bccf70c A	128	int bd_hdrcmplt; /* false to fill in src lladdr automatically */
9bccf70c A	129	int bd_seesent; /* true if bpf should see sent packets */
b0d623f7	130	int bd_oflags; /* device open flags */
6d2010ae	131	thread_call_t bd_thread_call; /* for BPF timeouts with select */
2d21ac55 A	132	#if CONFIG_MACF_NET
	133	struct label * bd_label; /* MAC label for descriptor */
	134	#endif
1c79356b A	135	};
1c79356b A	136
6d2010ae A	137	/* Values for bd_state */
	138	#define BPF_IDLE 0 /* no select in progress or kqueue pending */
	139	#define BPF_WAITING 1 /* waiting for read timeout in select/kqueue */
	140	#define BPF_TIMED_OUT 2 /* read timeout has expired in select/kqueue */
	141	#define BPF_DRAINING 3 /* waiting for timeout routine to finish during close */
	142
	143	/* Test whether a BPF is ready for read(). */
	144	#define bpf_ready(bd) ((bd)->bd_hlen != 0 \|\| \
	145	(((bd)->bd_immediate \|\| (bd)->bd_state == BPF_TIMED_OUT) && \
	146	(bd)->bd_slen != 0))
	147
	148
1c79356b A	149	/*
	150	* Descriptor associated with each attached hardware interface.
	151	*/
	152	struct bpf_if {
	153	struct bpf_if bif_next; / list of all interfaces */
	154	struct bpf_d bif_dlist; / descriptor list */
	155	u_int bif_dlt; /* link layer type */
	156	u_int bif_hdrlen; /* length of header (with padding) */
	157	struct ifnet bif_ifp; / corresponding interface */
2d21ac55 A	158	bpf_send_func bif_send;
2d21ac55 A	159	bpf_tap_func bif_tap;
1c79356b A	160	};
1c79356b A	161
91447636	162	#endif /* KERNEL_PRIVATE */
1c79356b	163	#endif