22da7d014d9d4d0660e73bc9cb0fdcea23d445a1
[dragonfly.git] / sys / net / netisr.h
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 $
35  * $DragonFly: src/sys/net/netisr.h,v 1.14 2004/04/10 09:35:34 hsu Exp $
36  */
37
38 #ifndef _NET_NETISR_H_
39 #define _NET_NETISR_H_
40
41 #include <sys/msgport.h>
42
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  */
58 #define NETISR_RESERVED0 0              /* cannot be used */
59 #define NETISR_POLL     1               /* polling callback */
60 #define NETISR_IP       2               /* same as AF_INET */
61 #define NETISR_NS       6               /* same as AF_NS */
62 #define NETISR_AARP     15              /* Appletalk ARP */
63 #define NETISR_ATALK2   16              /* Appletalk phase 2 */
64 #define NETISR_ATALK1   17              /* Appletalk phase 1 */
65 #define NETISR_ARP      18              /* same as AF_LINK */
66 #define NETISR_IPX      23              /* same as AF_IPX */
67 #define NETISR_USB      25              /* USB soft interrupt */
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
74 #define NETISR_MAX      32
75
76 TAILQ_HEAD(notifymsglist, netmsg_so_notify);
77
78 #ifdef _KERNEL
79
80 #include <sys/protosw.h>
81
82 struct netmsg;
83
84 typedef void (*netisr_fn_t)(struct netmsg *);
85 typedef boolean_t (*msg_predicate_fn_t)(struct netmsg *);
86
87 /*
88  * Base class.  All net messages must start with the same fields.
89  */
90 struct netmsg {
91     struct lwkt_msg     nm_lmsg;
92     netisr_fn_t         nm_handler;
93 };
94
95 struct netmsg_packet {
96     struct lwkt_msg     nm_lmsg;
97     netisr_fn_t         nm_handler;
98     struct mbuf         *nm_packet;
99 };
100
101 struct netmsg_pr_ctloutput {
102     struct lwkt_msg     nm_lmsg;
103     netisr_fn_t         nm_handler;
104     int                 (*nm_prfn) (struct socket *, struct sockopt *);
105     struct socket       *nm_so;
106     struct sockopt      *nm_sopt;
107 };
108
109 struct netmsg_pr_timeout {
110     struct lwkt_msg     nm_lmsg;
111     netisr_fn_t         nm_handler;
112     void                (*nm_prfn) (void);
113 };
114
115 struct netmsg_so_notify {
116     struct lwkt_msg                     nm_lmsg;
117     netisr_fn_t                         nm_handler;
118     msg_predicate_fn_t                  nm_predicate;
119     struct socket                       *nm_so;
120     int                                 nm_etype;  /* receive or send event */
121     TAILQ_ENTRY(netmsg_so_notify)       nm_list;
122 };
123
124 #define NM_REVENT       0x1             /* event on receive buffer */
125 #define NM_SEVENT       0x2             /* event on send buffer */
126
127 /*
128  * for dispatching pr_ functions,
129  * until they can be converted to message-passing
130  */
131 void netmsg_pr_dispatcher(struct netmsg *);
132
133 #define CMD_NETMSG_NEWPKT               (MSG_CMD_NETMSG | 0x0001)
134 #define CMD_NETMSG_POLL                 (MSG_CMD_NETMSG | 0x0002)
135
136 #define CMD_NETMSG_PRU_ABORT            (MSG_CMD_NETMSG | 0x0003)
137 #define CMD_NETMSG_PRU_ACCEPT           (MSG_CMD_NETMSG | 0x0004)
138 #define CMD_NETMSG_PRU_ATTACH           (MSG_CMD_NETMSG | 0x0005)
139 #define CMD_NETMSG_PRU_BIND             (MSG_CMD_NETMSG | 0x0006)
140 #define CMD_NETMSG_PRU_CONNECT          (MSG_CMD_NETMSG | 0x0007)
141 #define CMD_NETMSG_PRU_CONNECT2         (MSG_CMD_NETMSG | 0x0008)
142 #define CMD_NETMSG_PRU_CONTROL          (MSG_CMD_NETMSG | 0x0009)
143 #define CMD_NETMSG_PRU_DETACH           (MSG_CMD_NETMSG | 0x000a)
144 #define CMD_NETMSG_PRU_DISCONNECT       (MSG_CMD_NETMSG | 0x000b)
145 #define CMD_NETMSG_PRU_LISTEN           (MSG_CMD_NETMSG | 0x000c)
146 #define CMD_NETMSG_PRU_PEERADDR         (MSG_CMD_NETMSG | 0x000d)
147 #define CMD_NETMSG_PRU_RCVD             (MSG_CMD_NETMSG | 0x000e)
148 #define CMD_NETMSG_PRU_RCVOOB           (MSG_CMD_NETMSG | 0x000f)
149 #define CMD_NETMSG_PRU_SEND             (MSG_CMD_NETMSG | 0x0010)
150 #define CMD_NETMSG_PRU_SENSE            (MSG_CMD_NETMSG | 0x0011)
151 #define CMD_NETMSG_PRU_SHUTDOWN         (MSG_CMD_NETMSG | 0x0012)
152 #define CMD_NETMSG_PRU_SOCKADDR         (MSG_CMD_NETMSG | 0x0013)
153 #define CMD_NETMSG_PRU_SOSEND           (MSG_CMD_NETMSG | 0x0014)
154 #define CMD_NETMSG_PRU_SORECEIVE        (MSG_CMD_NETMSG | 0x0015)
155 #define CMD_NETMSG_PRU_SOPOLL           (MSG_CMD_NETMSG | 0x0016)
156
157 #define CMD_NETMSG_PR_CTLOUTPUT         (MSG_CMD_NETMSG | 0x0017)
158 #define CMD_NETMSG_PR_TIMEOUT           (MSG_CMD_NETMSG | 0x0018)
159
160 #define CMD_NETMSG_ONCPU                (MSG_CMD_NETMSG | 0x0019)
161 #define CMD_NETMSG_NOTIFY               (MSG_CMD_NETMSG | 0x0020)
162
163 void msg_notify_handler(struct netmsg *);
164
165 typedef lwkt_port_t (*lwkt_portfn_t)(struct mbuf *);
166
167 struct netisr {
168         lwkt_port       ni_port;                /* must be first */
169         lwkt_portfn_t   ni_mport;
170         netisr_fn_t     ni_handler;
171 };
172
173 extern lwkt_port netisr_afree_rport;
174
175 lwkt_port_t     cpu0_portfn(struct mbuf *m);
176 void            netisr_dispatch(int, struct mbuf *);
177 int             netisr_queue(int, struct mbuf *);
178 void            netisr_register(int, lwkt_portfn_t, netisr_fn_t);
179 int             netisr_unregister(int);
180 void            netmsg_service_loop(void *arg);
181 void            schednetisr(int);
182
183 #endif  /* KERNEL */
184
185 #endif  /* _NET_NETISR_H_ */