b60ce5c1910865db96cf3b331fef6f5f6d6bf34e
[dragonfly.git] / sys / net / netisr.h
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
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 $
68  * $DragonFly: src/sys/net/netisr.h,v 1.38 2008/10/27 02:56:30 sephe Exp $
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  */
89 #define NETISR_RESERVED0 0              /* cannot be used */
90 #define NETISR_IP       2               /* same as AF_INET */
91 #define NETISR_NS       6               /* same as AF_NS */
92 #define NETISR_AARP     15              /* Appletalk ARP */
93 #define NETISR_ATALK2   16              /* Appletalk phase 2 */
94 #define NETISR_ATALK1   17              /* Appletalk phase 1 */
95 #define NETISR_ARP      18              /* same as AF_LINK */
96 #define NETISR_MPLS     21              /* MPLS */
97 #define NETISR_IPX      23              /* same as AF_IPX */
98 #define NETISR_USB      25              /* USB soft interrupt */
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 */
103 #define NETISR_BLUETOOTH 31
104
105 #define NETISR_MAX      32
106
107 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
108
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_
116 #include <sys/protosw.h>
117 #endif
118 #ifndef _SYS_MSGPORT_H_
119 #include <sys/msgport.h>
120 #endif
121 #ifndef _NET_NETMSG_H_
122 #include <net/netmsg.h>
123 #endif
124
125 #endif
126
127 #ifdef _KERNEL
128
129 void netmsg_so_notify(netmsg_t);
130 void netmsg_so_notify_abort(netmsg_t);
131 void netmsg_so_notify_doabort(lwkt_msg_t);
132
133 #endif
134
135 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
136
137 /*
138  * Temporary pktinfo structure passed directly from the driver to
139  * ether_input_chain(), allows us to bypass numerous checks.
140  */
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 */
145 };
146
147 #define PKTINFO_FLAG_FRAG      0x1
148
149 /*
150  * NETISR_xxx registrations
151  */
152 struct netisr {
153         netisr_fn_t     ni_handler;     /* packet handler function */
154         netisr_ru_t     ni_rufunc;      /* rollup function */
155         netisr_cpufn_t  ni_cpufn;       /* characterize pkt return cpu */
156         struct netmsg_base ni_netmsg;   /* for sched_netisr() (no-data) */
157 };
158
159 #endif
160
161 #ifdef _KERNEL
162
163 #define NETMSG_SERVICE_ADAPTIVE 1
164 #define NETMSG_SERVICE_MPSAFE   2
165
166 extern lwkt_port netisr_adone_rport;
167 extern lwkt_port netisr_afree_rport;
168 extern lwkt_port netisr_afree_free_so_rport;
169 extern lwkt_port netisr_apanic_rport;
170 extern lwkt_port netisr_sync_port;
171
172 lwkt_port_t     cpu_portfn(int cpu);
173 lwkt_port_t     cur_netport(void);
174
175 void            netisr_register(int, netisr_fn_t, netisr_cpufn_t);
176 void            netisr_register_rollup(netisr_ru_t ru_func);
177
178 void            netisr_characterize(int num, struct mbuf **mp, int hoff);
179 int             netisr_queue(int, struct mbuf *);
180
181 struct netisr_barrier *netisr_barrier_create(void);
182 void            netisr_barrier_set(struct netisr_barrier *);
183 void            netisr_barrier_rem(struct netisr_barrier *);
184
185 void            netmsg_service_port_init(lwkt_port_t);
186 void            netmsg_service_sync(void);
187 void            schednetisr(int);
188
189 #define curnetport      cur_netport()
190
191 #endif  /* _KERNEL */
192
193 #endif  /* _NET_NETISR_H_ */