[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.38 2008/10/27 02:56:30 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

#endif

#ifdef _KERNEL

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)

/*
 * Temporary pktinfo structure passed directly from the driver to
 * ether_input_chain(), allows us to bypass numerous checks.
 */
struct pktinfo {
	int		pi_netisr;	/* netisr index, e.g. NETISR_IP */
	uint32_t	pi_flags;	/* PKTINFO_FLAG_ */
	int		pi_l3proto;	/* layer3 protocol number */
};

#define PKTINFO_FLAG_FRAG      0x1

/*
 * NETISR_xxx registrations
 */
struct netisr {
	netisr_fn_t	ni_handler;	/* packet handler function */
	netisr_hashck_t	ni_hashck;	/* hash check function */
	netisr_cpufn_t	ni_cpufn;	/* characterize pkt return cpu */
	struct netmsg_base ni_netmsg;	/* for sched_netisr() (no-data) */
};

#endif

#ifdef _KERNEL

#define NETMSG_SERVICE_ADAPTIVE	1
#define NETMSG_SERVICE_MPSAFE	2

extern lwkt_port netisr_adone_rport;
extern lwkt_port netisr_afree_rport;
extern lwkt_port netisr_afree_free_so_rport;
extern lwkt_port netisr_apanic_rport;
extern lwkt_port netisr_sync_port;

lwkt_port_t	cpu_portfn(int cpu);
lwkt_port_t	cur_netport(void);

void		netisr_register(int, netisr_fn_t, netisr_cpufn_t);
void		netisr_register_hashcheck(int, netisr_hashck_t);
void		netisr_register_rollup(netisr_ru_t ru_func);

void		netisr_characterize(int num, struct mbuf **mp, int hoff);
void		netisr_hashcheck(int num, struct mbuf *m,
		    const struct pktinfo *pi);
int		netisr_queue(int, struct mbuf *);

struct netisr_barrier *netisr_barrier_create(void);
void		netisr_barrier_set(struct netisr_barrier *);
void		netisr_barrier_rem(struct netisr_barrier *);

void		netmsg_service_port_init(lwkt_port_t);
void		netmsg_service_sync(void);
void		schednetisr(int);

#define curnetport	cur_netport()

#endif	/* _KERNEL */

#endif	/* _NET_NETISR_H_ */
Commit	Line	Data
984263bc	1	/*
66d6c637 JH	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
	34	/*
984263bc MD	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 $
e3873585	68	* $DragonFly: src/sys/net/netisr.h,v 1.38 2008/10/27 02:56:30 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	124
03d6a592 MD	125	#endif
	126
	127	#ifdef _KERNEL
	128
4599cf19 MD	129	void netmsg_so_notify(netmsg_t);
	130	void netmsg_so_notify_abort(netmsg_t);
	131	void netmsg_so_notify_doabort(lwkt_msg_t);
0ddb6032	132
03d6a592 MD	133	#endif
	134
	135	#if defined(_KERNEL) \|\| defined(_KERNEL_STRUCTURES)
	136
c3c96e44 MD	137	/*
	138	* Temporary pktinfo structure passed directly from the driver to
	139	* ether_input_chain(), allows us to bypass numerous checks.
	140	*/
f92bfd8c SZ	141	struct pktinfo {
	142	int pi_netisr; /* netisr index, e.g. NETISR_IP */
	143	uint32_t pi_flags; /* PKTINFO_FLAG_ */
	144	int pi_l3proto; /* layer3 protocol number */
f92bfd8c SZ	145	};
f92bfd8c SZ	146
c3c96e44	147	#define PKTINFO_FLAG_FRAG 0x1
8bde602d	148
c3c96e44 MD	149	/*
	150	* NETISR_xxx registrations
	151	*/
8bde602d	152	struct netisr {
c3c96e44	153	netisr_fn_t ni_handler; /* packet handler function */
e6f77b88	154	netisr_hashck_t ni_hashck; /* hash check function */
c3c96e44	155	netisr_cpufn_t ni_cpufn; /* characterize pkt return cpu */
002c1265	156	struct netmsg_base ni_netmsg; /* for sched_netisr() (no-data) */
8bde602d JH	157	};
8bde602d JH	158
03d6a592 MD	159	#endif
	160
	161	#ifdef _KERNEL
	162
92db3805 SZ	163	#define NETMSG_SERVICE_ADAPTIVE 1
	164	#define NETMSG_SERVICE_MPSAFE 2
	165
1630efc5	166	extern lwkt_port netisr_adone_rport;
3f48f9c5	167	extern lwkt_port netisr_afree_rport;
c3d495a1	168	extern lwkt_port netisr_afree_free_so_rport;
ecd27a4c	169	extern lwkt_port netisr_apanic_rport;
002c1265	170	extern lwkt_port netisr_sync_port;
3f48f9c5	171
ecdefdda	172	lwkt_port_t cpu_portfn(int cpu);
c244d613	173	lwkt_port_t cur_netport(void);
f92bfd8c	174
c3c96e44	175	void netisr_register(int, netisr_fn_t, netisr_cpufn_t);
e6f77b88	176	void netisr_register_hashcheck(int, netisr_hashck_t);
c3c96e44 MD	177	void netisr_register_rollup(netisr_ru_t ru_func);
	178
	179	void netisr_characterize(int num, struct mbuf **mp, int hoff);
e6f77b88 SZ	180	void netisr_hashcheck(int num, struct mbuf *m,
e6f77b88 SZ	181	const struct pktinfo *pi);
bf82f9b7	182	int netisr_queue(int, struct mbuf *);
f92bfd8c	183
a91f9815 SZ	184	struct netisr_barrier *netisr_barrier_create(void);
	185	void netisr_barrier_set(struct netisr_barrier *);
	186	void netisr_barrier_rem(struct netisr_barrier *);
	187
5c703385	188	void netmsg_service_port_init(lwkt_port_t);
5c703385	189	void netmsg_service_sync(void);
bf82f9b7	190	void schednetisr(int);
984263bc	191
c244d613 SZ	192	#define curnetport cur_netport()
c244d613 SZ	193
03d6a592	194	#endif /* _KERNEL */
984263bc	195
bf82f9b7	196	#endif /* _NET_NETISR_H_ */