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

/*
 * Copyright (c) 2004 Jeffrey M. Hsu.  All rights reserved.
 * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
 * 
 * This code is derived from software contributed to The DragonFly Project
 * by Jeffrey M. Hsu.
 * 
 * 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. Neither the name of The DragonFly Project 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 COPYRIGHT HOLDERS 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
 * COPYRIGHT HOLDERS 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.
 */

/*
 * 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.35 2008/09/17 07:24:18 sephe Exp $
 */

#ifndef _NET_NETISR_H_
#define _NET_NETISR_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_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_MPLS	21		/* MPLS */
#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_BLUETOOTH 31

#define	NETISR_MAX	32

#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)

#ifndef _SYS_TYPES_H_
#include <sys/types.h>
#endif
#ifndef _SYS_QUEUE_H_
#include <sys/queue.h>
#endif
#ifndef _SYS_PROTOSW_H_
#include <sys/protosw.h>
#endif
#ifndef _SYS_MSGPORT_H_
#include <sys/msgport.h>
#endif
#ifndef _NET_NETMSG_H_
#include <net/netmsg.h>
#endif

TAILQ_HEAD(notifymsglist, netmsg_so_notify);

typedef __boolean_t (*msg_predicate_fn_t)(struct netmsg *);

/*
 * Base class.  All net messages must start with the same fields.
 */

struct netmsg_packet {
    struct netmsg	nm_netmsg;
    struct mbuf		*nm_packet;
};

struct netmsg_pr_timeout {
    struct netmsg	nm_netmsg;
    int			(*nm_prfn) (void);
};

struct netmsg_so_notify {
    struct netmsg			nm_netmsg;
    msg_predicate_fn_t			nm_predicate;
    struct socket			*nm_so;
    int					nm_fflags; /* flags e.g. FNONBLOCK */
    int					nm_etype;  /* receive or send event */
    TAILQ_ENTRY(netmsg_so_notify)	nm_list;
};

struct netmsg_so_notify_abort {
    struct netmsg			nm_netmsg;
    struct netmsg_so_notify 		*nm_notifymsg;
};

#define NM_REVENT	0x1		/* event on receive buffer */
#define NM_SEVENT	0x2		/* event on send buffer */

#endif

#ifdef _KERNEL

/*
 * for dispatching pr_ functions,
 * until they can be converted to message-passing
 */
void netmsg_pru_abort(netmsg_t);
void netmsg_pru_accept(netmsg_t);
void netmsg_pru_attach(netmsg_t);
void netmsg_pru_bind(netmsg_t);
void netmsg_pru_connect(netmsg_t);
void netmsg_pru_connect2(netmsg_t);
void netmsg_pru_control(netmsg_t);
void netmsg_pru_detach(netmsg_t);
void netmsg_pru_disconnect(netmsg_t);
void netmsg_pru_listen(netmsg_t);
void netmsg_pru_peeraddr(netmsg_t);
void netmsg_pru_rcvd(netmsg_t);
void netmsg_pru_rcvoob(netmsg_t);
void netmsg_pru_send(netmsg_t);
void netmsg_pru_sense(netmsg_t);
void netmsg_pru_shutdown(netmsg_t);
void netmsg_pru_sockaddr(netmsg_t);

void netmsg_pru_sopoll(netmsg_t);
void netmsg_pru_ctloutput(netmsg_t);

void netmsg_pr_timeout(netmsg_t);

void netmsg_so_notify(netmsg_t);
void netmsg_so_notify_abort(netmsg_t);
void netmsg_so_notify_doabort(lwkt_msg_t);

#endif

#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)

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;
	struct netmsg	ni_netmsg;	/* for sched_netisr() (no-data) */
};

#endif

#ifdef _KERNEL

extern lwkt_port netisr_adone_rport;
extern lwkt_port netisr_afree_rport;
extern lwkt_port netisr_apanic_rport;

lwkt_port_t	cpu0_portfn(struct mbuf **mptr);
lwkt_port_t	cpu_portfn(int cpu);
lwkt_port_t	netisr_find_port(int, struct mbuf **);
void		netisr_dispatch(int, struct mbuf *);
void		netisr_run(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_port_init(lwkt_port_t);
void		netmsg_service_loop(void *arg);
void		netmsg_service_loop_mpsafe(void *arg);
void		netmsg_service_sync(void);
void		schednetisr(int);

#endif	/* _KERNEL */

#endif	/* _NET_NETISR_H_ */
Commit	Line	Data
66d6c637 JH	1	/*
	2	* Copyright (c) 2004 Jeffrey M. Hsu. All rights reserved.
	3	* Copyright (c) 2004 The DragonFly Project. All rights reserved.
	4	*
	5	* This code is derived from software contributed to The DragonFly Project
	6	* by Jeffrey M. Hsu.
	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions
	10	* are met:
	11	* 1. Redistributions of source code must retain the above copyright
	12	* notice, this list of conditions and the following disclaimer.
	13	* 2. Redistributions in binary form must reproduce the above copyright
	14	* notice, this list of conditions and the following disclaimer in the
	15	* documentation and/or other materials provided with the distribution.
	16	* 3. Neither the name of The DragonFly Project nor the names of its
	17	* contributors may be used to endorse or promote products derived
	18	* from this software without specific, prior written permission.
	19	*
	20	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	21	* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	22	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
	23	* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
	24	* COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
	25	* INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
	26	* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	27	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
	28	* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	29	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
	30	* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	31	* SUCH DAMAGE.
	32	*/
	33
984263bc MD	34	/*
	35	* Copyright (c) 1980, 1986, 1989, 1993
	36	* The Regents of the University of California. All rights reserved.
	37	*
	38	* Redistribution and use in source and binary forms, with or without
	39	* modification, are permitted provided that the following conditions
	40	* are met:
	41	* 1. Redistributions of source code must retain the above copyright
	42	* notice, this list of conditions and the following disclaimer.
	43	* 2. Redistributions in binary form must reproduce the above copyright
	44	* notice, this list of conditions and the following disclaimer in the
	45	* documentation and/or other materials provided with the distribution.
	46	* 3. All advertising materials mentioning features or use of this software
	47	* must display the following acknowledgement:
	48	* This product includes software developed by the University of
	49	* California, Berkeley and its contributors.
	50	* 4. Neither the name of the University nor the names of its contributors
	51	* may be used to endorse or promote products derived from this software
	52	* without specific prior written permission.
	53	*
	54	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	55	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	56	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	57	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	58	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	59	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	60	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	61	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	62	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	63	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	64	* SUCH DAMAGE.
	65	*
	66	* @(#)netisr.h 8.1 (Berkeley) 6/10/93
	67	* $FreeBSD: src/sys/net/netisr.h,v 1.21.2.5 2002/02/09 23:02:39 luigi Exp $
b935f3c7	68	* $DragonFly: src/sys/net/netisr.h,v 1.35 2008/09/17 07:24:18 sephe Exp $
984263bc MD	69	*/
	70
	71	#ifndef _NET_NETISR_H_
	72	#define _NET_NETISR_H_
	73
	74	/*
	75	* The networking code runs off software interrupts.
	76	*
	77	* You can switch into the network by doing splnet() and return by splx().
	78	* The software interrupt level for the network is higher than the software
	79	* level for the clock (so you can enter the network in routines called
	80	* at timeout time).
	81	*/
	82
	83	/*
	84	* Each ``pup-level-1'' input queue has a bit in a ``netisr'' status
	85	* word which is used to de-multiplex a single software
	86	* interrupt used for scheduling the network code to calls
	87	* on the lowest level routine of each protocol.
	88	*/
35746821	89	#define NETISR_RESERVED0 0 /* cannot be used */
984263bc MD	90	#define NETISR_IP 2 /* same as AF_INET */
984263bc MD	91	#define NETISR_NS 6 /* same as AF_NS */
8bde602d JH	92	#define NETISR_AARP 15 /* Appletalk ARP */
	93	#define NETISR_ATALK2 16 /* Appletalk phase 2 */
	94	#define NETISR_ATALK1 17 /* Appletalk phase 1 */
984263bc	95	#define NETISR_ARP 18 /* same as AF_LINK */
9b42cabe	96	#define NETISR_MPLS 21 /* MPLS */
984263bc	97	#define NETISR_IPX 23 /* same as AF_IPX */
8bde602d	98	#define NETISR_USB 25 /* USB soft interrupt */
984263bc MD	99	#define NETISR_PPP 27 /* PPP soft interrupt */
	100	#define NETISR_IPV6 28 /* same as AF_INET6 */
	101	#define NETISR_NATM 29 /* same as AF_NATM */
	102	#define NETISR_NETGRAPH 30 /* same as AF_NETGRAPH */
0a9108eb	103	#define NETISR_BLUETOOTH 31
984263bc	104
8bde602d	105	#define NETISR_MAX 32
ef0fdad1	106
03d6a592	107	#if defined(_KERNEL) \|\| defined(_KERNEL_STRUCTURES)
984263bc	108
03d6a592 MD	109	#ifndef _SYS_TYPES_H_
	110	#include <sys/types.h>
	111	#endif
	112	#ifndef _SYS_QUEUE_H_
	113	#include <sys/queue.h>
	114	#endif
	115	#ifndef _SYS_PROTOSW_H_
9eeaa8a9	116	#include <sys/protosw.h>
03d6a592 MD	117	#endif
	118	#ifndef _SYS_MSGPORT_H_
	119	#include <sys/msgport.h>
	120	#endif
4599cf19 MD	121	#ifndef _NET_NETMSG_H_
	122	#include <net/netmsg.h>
	123	#endif
03d6a592 MD	124
03d6a592 MD	125	TAILQ_HEAD(notifymsglist, netmsg_so_notify);
9eeaa8a9	126
03d6a592	127	typedef __boolean_t (msg_predicate_fn_t)(struct netmsg );
9eeaa8a9 JH	128
	129	/*
	130	* Base class. All net messages must start with the same fields.
	131	*/
9eeaa8a9 JH	132
9eeaa8a9 JH	133	struct netmsg_packet {
4599cf19	134	struct netmsg nm_netmsg;
9eeaa8a9 JH	135	struct mbuf *nm_packet;
	136	};
	137
9eeaa8a9	138	struct netmsg_pr_timeout {
4599cf19	139	struct netmsg nm_netmsg;
b44419cb	140	int (*nm_prfn) (void);
9eeaa8a9 JH	141	};
9eeaa8a9 JH	142
c1d0003c	143	struct netmsg_so_notify {
4599cf19	144	struct netmsg nm_netmsg;
c1d0003c JH	145	msg_predicate_fn_t nm_predicate;
c1d0003c JH	146	struct socket *nm_so;
9ba76b73	147	int nm_fflags; /* flags e.g. FNONBLOCK */
c1d0003c JH	148	int nm_etype; /* receive or send event */
	149	TAILQ_ENTRY(netmsg_so_notify) nm_list;
	150	};
	151
4599cf19 MD	152	struct netmsg_so_notify_abort {
	153	struct netmsg nm_netmsg;
	154	struct netmsg_so_notify *nm_notifymsg;
	155	};
	156
c1d0003c JH	157	#define NM_REVENT 0x1 /* event on receive buffer */
	158	#define NM_SEVENT 0x2 /* event on send buffer */
	159
03d6a592 MD	160	#endif
	161
	162	#ifdef _KERNEL
	163
9eeaa8a9 JH	164	/*
	165	* for dispatching pr_ functions,
	166	* until they can be converted to message-passing
	167	*/
4599cf19 MD	168	void netmsg_pru_abort(netmsg_t);
	169	void netmsg_pru_accept(netmsg_t);
	170	void netmsg_pru_attach(netmsg_t);
	171	void netmsg_pru_bind(netmsg_t);
	172	void netmsg_pru_connect(netmsg_t);
	173	void netmsg_pru_connect2(netmsg_t);
	174	void netmsg_pru_control(netmsg_t);
	175	void netmsg_pru_detach(netmsg_t);
	176	void netmsg_pru_disconnect(netmsg_t);
	177	void netmsg_pru_listen(netmsg_t);
	178	void netmsg_pru_peeraddr(netmsg_t);
	179	void netmsg_pru_rcvd(netmsg_t);
	180	void netmsg_pru_rcvoob(netmsg_t);
	181	void netmsg_pru_send(netmsg_t);
	182	void netmsg_pru_sense(netmsg_t);
	183	void netmsg_pru_shutdown(netmsg_t);
	184	void netmsg_pru_sockaddr(netmsg_t);
	185
	186	void netmsg_pru_sopoll(netmsg_t);
e71a125f	187	void netmsg_pru_ctloutput(netmsg_t);
4599cf19	188
4599cf19 MD	189	void netmsg_pr_timeout(netmsg_t);
	190
	191	void netmsg_so_notify(netmsg_t);
	192	void netmsg_so_notify_abort(netmsg_t);
	193	void netmsg_so_notify_doabort(lwkt_msg_t);
0ddb6032	194
03d6a592 MD	195	#endif
	196
	197	#if defined(_KERNEL) \|\| defined(_KERNEL_STRUCTURES)
	198
b01ae44a	199	typedef lwkt_port_t (lwkt_portfn_t)(struct mbuf *);
8bde602d	200
8bde602d	201	struct netisr {
a29576fc	202	lwkt_port ni_port; /* must be first */
bf82f9b7	203	lwkt_portfn_t ni_mport;
8bde602d	204	netisr_fn_t ni_handler;
a29576fc	205	struct netmsg ni_netmsg; /* for sched_netisr() (no-data) */
8bde602d JH	206	};
8bde602d JH	207
03d6a592 MD	208	#endif
	209
	210	#ifdef _KERNEL
	211
1630efc5	212	extern lwkt_port netisr_adone_rport;
3f48f9c5	213	extern lwkt_port netisr_afree_rport;
ecd27a4c	214	extern lwkt_port netisr_apanic_rport;
3f48f9c5	215
b01ae44a	216	lwkt_port_t cpu0_portfn(struct mbuf **mptr);
ecdefdda	217	lwkt_port_t cpu_portfn(int cpu);
29bc1092	218	lwkt_port_t netisr_find_port(int, struct mbuf **);
bf82f9b7	219	void netisr_dispatch(int, struct mbuf *);
29bc1092	220	void netisr_run(int, struct mbuf *);
bf82f9b7 MD	221	int netisr_queue(int, struct mbuf *);
	222	void netisr_register(int, lwkt_portfn_t, netisr_fn_t);
	223	int netisr_unregister(int);
5c703385	224	void netmsg_service_port_init(lwkt_port_t);
bf82f9b7	225	void netmsg_service_loop(void *arg);
95f8b5ce	226	void netmsg_service_loop_mpsafe(void *arg);
5c703385	227	void netmsg_service_sync(void);
bf82f9b7	228	void schednetisr(int);
984263bc	229
03d6a592	230	#endif /* _KERNEL */
984263bc	231
bf82f9b7	232	#endif /* _NET_NETISR_H_ */