[dragonfly.git] / sys / net / netisr.h

/*
 * Copyright (c) 1980, 1986, 1989, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * 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.
 *
 *	@(#)netisr.h	8.1 (Berkeley) 6/10/93
 * $FreeBSD: src/sys/net/netisr.h,v 1.21.2.5 2002/02/09 23:02:39 luigi Exp $
 * $DragonFly: src/sys/net/netisr.h,v 1.12 2004/04/09 22:34:09 hsu Exp $
 */

#ifndef _NET_NETISR_H_
#define _NET_NETISR_H_

#include <sys/msgport.h>

/*
 * The networking code runs off software interrupts.
 *
 * You can switch into the network by doing splnet() and return by splx().
 * The software interrupt level for the network is higher than the software
 * level for the clock (so you can enter the network in routines called
 * at timeout time).
 */

/*
 * Each ``pup-level-1'' input queue has a bit in a ``netisr'' status
 * word which is used to de-multiplex a single software
 * interrupt used for scheduling the network code to calls
 * on the lowest level routine of each protocol.
 */
#define NETISR_RESERVED0 0		/* cannot be used */
#define	NETISR_POLL	1		/* polling callback */
#define	NETISR_IP	2		/* same as AF_INET */
#define	NETISR_NS	6		/* same as AF_NS */
#define	NETISR_AARP	15		/* Appletalk ARP */
#define	NETISR_ATALK2	16		/* Appletalk phase 2 */
#define	NETISR_ATALK1	17		/* Appletalk phase 1 */
#define	NETISR_ARP	18		/* same as AF_LINK */
#define	NETISR_IPX	23		/* same as AF_IPX */
#define	NETISR_USB	25		/* USB soft interrupt */
#define	NETISR_PPP	27		/* PPP soft interrupt */
#define	NETISR_IPV6	28		/* same as AF_INET6 */
#define	NETISR_NATM	29		/* same as AF_NATM */
#define	NETISR_NETGRAPH	30		/* same as AF_NETGRAPH */
#define	NETISR_POLLMORE	31		/* check if we need more polling */

#define	NETISR_MAX	32

#ifdef _KERNEL

#include <sys/protosw.h>

struct netmsg;

typedef void (*netisr_fn_t)(struct netmsg *);

/*
 * Base class.  All net messages must start with the same fields.
 */
struct netmsg {
    struct lwkt_msg	nm_lmsg;
    netisr_fn_t		nm_handler;
};

struct netmsg_packet {
    struct lwkt_msg	nm_lmsg;
    netisr_fn_t		nm_handler;
    struct mbuf		*nm_packet;
};

struct netmsg_pr_ctloutput {
    struct lwkt_msg	nm_lmsg;
    netisr_fn_t		nm_handler;
    int			(*nm_prfn) (struct socket *, struct sockopt *);
    struct socket	*nm_so;
    struct sockopt	*nm_sopt;
};

struct netmsg_pr_timeout {
    struct lwkt_msg	nm_lmsg;
    netisr_fn_t		nm_handler;
    void		(*nm_prfn) (void);
};

/*
 * for dispatching pr_ functions,
 * until they can be converted to message-passing
 */
void netmsg_pr_dispatcher(struct netmsg *);

#define CMD_NETMSG_NEWPKT		(MSG_CMD_NETMSG | 0x0001)
#define CMD_NETMSG_POLL			(MSG_CMD_NETMSG | 0x0002)

#define CMD_NETMSG_PRU_ABORT		(MSG_CMD_NETMSG | 0x0003)
#define CMD_NETMSG_PRU_ACCEPT		(MSG_CMD_NETMSG | 0x0004)
#define CMD_NETMSG_PRU_ATTACH		(MSG_CMD_NETMSG | 0x0005)
#define CMD_NETMSG_PRU_BIND		(MSG_CMD_NETMSG | 0x0006)
#define CMD_NETMSG_PRU_CONNECT		(MSG_CMD_NETMSG | 0x0007)
#define CMD_NETMSG_PRU_CONNECT2		(MSG_CMD_NETMSG | 0x0008)
#define CMD_NETMSG_PRU_CONTROL		(MSG_CMD_NETMSG | 0x0009)
#define CMD_NETMSG_PRU_DETACH		(MSG_CMD_NETMSG | 0x000a)
#define CMD_NETMSG_PRU_DISCONNECT	(MSG_CMD_NETMSG | 0x000b)
#define CMD_NETMSG_PRU_LISTEN		(MSG_CMD_NETMSG | 0x000c)
#define CMD_NETMSG_PRU_PEERADDR		(MSG_CMD_NETMSG | 0x000d)
#define CMD_NETMSG_PRU_RCVD		(MSG_CMD_NETMSG | 0x000e)
#define CMD_NETMSG_PRU_RCVOOB		(MSG_CMD_NETMSG | 0x000f)
#define CMD_NETMSG_PRU_SEND		(MSG_CMD_NETMSG | 0x0010)
#define CMD_NETMSG_PRU_SENSE		(MSG_CMD_NETMSG | 0x0011)
#define CMD_NETMSG_PRU_SHUTDOWN		(MSG_CMD_NETMSG | 0x0012)
#define CMD_NETMSG_PRU_SOCKADDR		(MSG_CMD_NETMSG | 0x0013)
#define CMD_NETMSG_PRU_SOSEND		(MSG_CMD_NETMSG | 0x0014)
#define CMD_NETMSG_PRU_SORECEIVE	(MSG_CMD_NETMSG | 0x0015)
#define CMD_NETMSG_PRU_SOPOLL		(MSG_CMD_NETMSG | 0x0016)

#define CMD_NETMSG_PR_CTLOUTPUT		(MSG_CMD_NETMSG | 0x0017)
#define CMD_NETMSG_PR_TIMEOUT		(MSG_CMD_NETMSG | 0x0018)

#define	CMD_NETMSG_ONCPU		(MSG_CMD_NETMSG | 0x0019)

typedef lwkt_port_t (*lwkt_portfn_t)(struct mbuf *);

struct netisr {
	lwkt_port	ni_port;		/* must be first */
	lwkt_portfn_t	ni_mport;
	netisr_fn_t	ni_handler;
};

extern lwkt_port netisr_afree_rport;

lwkt_port_t	cpu0_portfn(struct mbuf *m);
void		netisr_dispatch(int, struct mbuf *);
int		netisr_queue(int, struct mbuf *);
void		netisr_register(int, lwkt_portfn_t, netisr_fn_t);
int		netisr_unregister(int);
void		netmsg_service_loop(void *arg);
void		schednetisr(int);

#endif	/* KERNEL */

#endif	/* _NET_NETISR_H_ */
Commit	Line	Data
984263bc MD	1	/*
	2	* Copyright (c) 1980, 1986, 1989, 1993
	3	* The Regents of the University of California. All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	* 3. All advertising materials mentioning features or use of this software
	14	* must display the following acknowledgement:
	15	* This product includes software developed by the University of
	16	* California, Berkeley and its contributors.
	17	* 4. Neither the name of the University nor the names of its contributors
	18	* may be used to endorse or promote products derived from this software
	19	* without specific prior written permission.
	20	*
	21	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	22	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	23	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	24	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	25	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	26	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	27	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	28	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	29	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	30	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	31	* SUCH DAMAGE.
	32	*
	33	* @(#)netisr.h 8.1 (Berkeley) 6/10/93
	34	* $FreeBSD: src/sys/net/netisr.h,v 1.21.2.5 2002/02/09 23:02:39 luigi Exp $
a80cf23b	35	* $DragonFly: src/sys/net/netisr.h,v 1.12 2004/04/09 22:34:09 hsu Exp $
984263bc MD	36	*/
	37
	38	#ifndef _NET_NETISR_H_
	39	#define _NET_NETISR_H_
	40
bf82f9b7 MD	41	#include <sys/msgport.h>
bf82f9b7 MD	42
984263bc MD	43	/*
	44	* The networking code runs off software interrupts.
	45	*
	46	* You can switch into the network by doing splnet() and return by splx().
	47	* The software interrupt level for the network is higher than the software
	48	* level for the clock (so you can enter the network in routines called
	49	* at timeout time).
	50	*/
	51
	52	/*
	53	* Each ``pup-level-1'' input queue has a bit in a ``netisr'' status
	54	* word which is used to de-multiplex a single software
	55	* interrupt used for scheduling the network code to calls
	56	* on the lowest level routine of each protocol.
	57	*/
35746821 MD	58	#define NETISR_RESERVED0 0 /* cannot be used */
35746821 MD	59	#define NETISR_POLL 1 /* polling callback */
984263bc MD	60	#define NETISR_IP 2 /* same as AF_INET */
984263bc MD	61	#define NETISR_NS 6 /* same as AF_NS */
8bde602d JH	62	#define NETISR_AARP 15 /* Appletalk ARP */
	63	#define NETISR_ATALK2 16 /* Appletalk phase 2 */
	64	#define NETISR_ATALK1 17 /* Appletalk phase 1 */
984263bc MD	65	#define NETISR_ARP 18 /* same as AF_LINK */
984263bc MD	66	#define NETISR_IPX 23 /* same as AF_IPX */
8bde602d	67	#define NETISR_USB 25 /* USB soft interrupt */
984263bc MD	68	#define NETISR_PPP 27 /* PPP soft interrupt */
	69	#define NETISR_IPV6 28 /* same as AF_INET6 */
	70	#define NETISR_NATM 29 /* same as AF_NATM */
	71	#define NETISR_NETGRAPH 30 /* same as AF_NETGRAPH */
	72	#define NETISR_POLLMORE 31 /* check if we need more polling */
	73
8bde602d	74	#define NETISR_MAX 32
ef0fdad1	75
984263bc	76	#ifdef _KERNEL
984263bc	77
9eeaa8a9 JH	78	#include <sys/protosw.h>
	79
	80	struct netmsg;
	81
a80cf23b	82	typedef void (netisr_fn_t)(struct netmsg );
9eeaa8a9 JH	83
	84	/*
	85	* Base class. All net messages must start with the same fields.
	86	*/
	87	struct netmsg {
	88	struct lwkt_msg nm_lmsg;
	89	netisr_fn_t nm_handler;
	90	};
	91
	92	struct netmsg_packet {
	93	struct lwkt_msg nm_lmsg;
	94	netisr_fn_t nm_handler;
	95	struct mbuf *nm_packet;
	96	};
	97
	98	struct netmsg_pr_ctloutput {
	99	struct lwkt_msg nm_lmsg;
	100	netisr_fn_t nm_handler;
	101	int (nm_prfn) (struct socket , struct sockopt *);
	102	struct socket *nm_so;
	103	struct sockopt *nm_sopt;
	104	};
	105
	106	struct netmsg_pr_timeout {
	107	struct lwkt_msg nm_lmsg;
	108	netisr_fn_t nm_handler;
	109	void (*nm_prfn) (void);
	110	};
	111
	112	/*
	113	* for dispatching pr_ functions,
	114	* until they can be converted to message-passing
	115	*/
a80cf23b	116	void netmsg_pr_dispatcher(struct netmsg *);
9eeaa8a9 JH	117
	118	#define CMD_NETMSG_NEWPKT (MSG_CMD_NETMSG \| 0x0001)
	119	#define CMD_NETMSG_POLL (MSG_CMD_NETMSG \| 0x0002)
	120
	121	#define CMD_NETMSG_PRU_ABORT (MSG_CMD_NETMSG \| 0x0003)
	122	#define CMD_NETMSG_PRU_ACCEPT (MSG_CMD_NETMSG \| 0x0004)
	123	#define CMD_NETMSG_PRU_ATTACH (MSG_CMD_NETMSG \| 0x0005)
	124	#define CMD_NETMSG_PRU_BIND (MSG_CMD_NETMSG \| 0x0006)
	125	#define CMD_NETMSG_PRU_CONNECT (MSG_CMD_NETMSG \| 0x0007)
	126	#define CMD_NETMSG_PRU_CONNECT2 (MSG_CMD_NETMSG \| 0x0008)
	127	#define CMD_NETMSG_PRU_CONTROL (MSG_CMD_NETMSG \| 0x0009)
	128	#define CMD_NETMSG_PRU_DETACH (MSG_CMD_NETMSG \| 0x000a)
	129	#define CMD_NETMSG_PRU_DISCONNECT (MSG_CMD_NETMSG \| 0x000b)
	130	#define CMD_NETMSG_PRU_LISTEN (MSG_CMD_NETMSG \| 0x000c)
	131	#define CMD_NETMSG_PRU_PEERADDR (MSG_CMD_NETMSG \| 0x000d)
	132	#define CMD_NETMSG_PRU_RCVD (MSG_CMD_NETMSG \| 0x000e)
	133	#define CMD_NETMSG_PRU_RCVOOB (MSG_CMD_NETMSG \| 0x000f)
	134	#define CMD_NETMSG_PRU_SEND (MSG_CMD_NETMSG \| 0x0010)
	135	#define CMD_NETMSG_PRU_SENSE (MSG_CMD_NETMSG \| 0x0011)
	136	#define CMD_NETMSG_PRU_SHUTDOWN (MSG_CMD_NETMSG \| 0x0012)
	137	#define CMD_NETMSG_PRU_SOCKADDR (MSG_CMD_NETMSG \| 0x0013)
	138	#define CMD_NETMSG_PRU_SOSEND (MSG_CMD_NETMSG \| 0x0014)
	139	#define CMD_NETMSG_PRU_SORECEIVE (MSG_CMD_NETMSG \| 0x0015)
	140	#define CMD_NETMSG_PRU_SOPOLL (MSG_CMD_NETMSG \| 0x0016)
	141
	142	#define CMD_NETMSG_PR_CTLOUTPUT (MSG_CMD_NETMSG \| 0x0017)
	143	#define CMD_NETMSG_PR_TIMEOUT (MSG_CMD_NETMSG \| 0x0018)
ef0fdad1	144
0ddb6032 JH	145	#define CMD_NETMSG_ONCPU (MSG_CMD_NETMSG \| 0x0019)
0ddb6032 JH	146
bf82f9b7	147	typedef lwkt_port_t (lwkt_portfn_t)(struct mbuf );
8bde602d	148
8bde602d	149	struct netisr {
bf82f9b7 MD	150	lwkt_port ni_port; /* must be first */
bf82f9b7 MD	151	lwkt_portfn_t ni_mport;
8bde602d	152	netisr_fn_t ni_handler;
8bde602d JH	153	};
8bde602d JH	154
3f48f9c5 JH	155	extern lwkt_port netisr_afree_rport;
3f48f9c5 JH	156
bf82f9b7 MD	157	lwkt_port_t cpu0_portfn(struct mbuf *m);
	158	void netisr_dispatch(int, struct mbuf *);
	159	int netisr_queue(int, struct mbuf *);
	160	void netisr_register(int, lwkt_portfn_t, netisr_fn_t);
	161	int netisr_unregister(int);
	162	void netmsg_service_loop(void *arg);
	163	void schednetisr(int);
984263bc	164
9eeaa8a9	165	#endif /* KERNEL */
984263bc	166
bf82f9b7	167	#endif /* _NET_NETISR_H_ */