xref: /dragonfly/sys/net/netmsg.h (revision 25a2db75)
1 /*
2  * Copyright (c) 2003 Jeffrey Hsu
3  * 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 Jeffrey M. Hsu.
16  * 4. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  * $DragonFly: src/sys/net/netmsg.h,v 1.10 2008/10/27 02:56:30 sephe Exp $
31  */
32 
33 #ifndef _NET_NETMSG_H_
34 #define _NET_NETMSG_H_
35 
36 #ifndef _SYS_THREAD_H_
37 #include <sys/thread.h>
38 #endif
39 #ifndef _SYS_PROTOSW_H_
40 #include <sys/protosw.h>
41 #endif
42 
43 struct pktinfo;
44 
45 typedef void (*netisr_fn_t)(netmsg_t);
46 typedef void (*netisr_ru_t)(void);
47 typedef void (*netisr_hashfn_t)(struct mbuf **, int);
48 typedef void (*netisr_hashck_t)(struct mbuf *, const struct pktinfo *);
49 
50 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
51 
52 /*
53  * The base netmsg prefixes all netmsgs and includes an embedded LWKT
54  * message.
55  */
56 struct netmsg_base {
57 	struct lwkt_msg		lmsg;
58 	netisr_fn_t		nm_dispatch;
59 	struct socket		*nm_so;
60 };
61 
62 typedef struct netmsg_base *netmsg_base_t;
63 
64 /*
65  * NETISR messages
66  *
67  * NOTE:
68  * - netmsg_packet is embedded in mbufs.
69  * - netmsg_pru_send is embedded in mbufs.
70  * - netmsg_inarp is embedded in mbufs.
71  */
72 TAILQ_HEAD(notifymsglist, netmsg_so_notify);
73 
74 struct netmsg_packet {
75 	struct netmsg_base	base;
76 	struct mbuf		*nm_packet;
77 	int			nm_nxt;
78 };
79 
80 struct netmsg_inarp {
81 	struct netmsg_base	base;
82 	struct mbuf		*m;
83 	in_addr_t		saddr;
84 	in_addr_t		taddr;
85 	in_addr_t		myaddr;
86 };
87 
88 struct netmsg_pr_timeout {
89 	struct netmsg_base	base;
90 };
91 
92 struct netmsg_so_notify;
93 typedef __boolean_t (*msg_predicate_fn_t)(struct netmsg_so_notify *);
94 
95 struct netmsg_so_notify {
96 	struct netmsg_base	base;
97 	msg_predicate_fn_t	nm_predicate;
98 	int			nm_fflags; /* flags e.g. FNONBLOCK */
99 	int			nm_etype;  /* receive or send event */
100 	TAILQ_ENTRY(netmsg_so_notify) nm_list;
101 };
102 
103 struct netmsg_so_notify_abort {
104 	struct netmsg_base	base;
105 	struct netmsg_so_notify	*nm_notifymsg;
106 };
107 
108 #define NM_REVENT	0x1		/* event on receive buffer */
109 #define NM_SEVENT	0x2		/* event on send buffer */
110 
111 /*
112  * User protocol requests messages.
113  */
114 struct netmsg_pru_abort {
115 	struct netmsg_base	base;
116 };
117 
118 struct netmsg_pru_accept {
119 	struct netmsg_base	base;
120 	struct sockaddr		**nm_nam;
121 };
122 
123 struct netmsg_pru_attach {
124 	struct netmsg_base	base;
125 	int			nm_proto;
126 	struct pru_attach_info	*nm_ai;
127 };
128 
129 struct netmsg_pru_bind {
130 	struct netmsg_base	base;
131 	struct sockaddr		*nm_nam;
132 	struct thread		*nm_td;
133 };
134 
135 struct netmsg_pru_connect {
136 	struct netmsg_base	base;
137 	struct sockaddr		*nm_nam;
138 	struct thread		*nm_td;
139 	struct mbuf		*nm_m;		/* connect with send */
140 	int			nm_flags;	/* connect with send */
141 	int			nm_reconnect;	/* message control */
142 };
143 
144 #define NMSG_RECONNECT_RECONNECT	0x0001	/* thread port change */
145 #define NMSG_RECONNECT_NAMALLOC		0x0002	/* nm_nam allocated */
146 #define NMSG_RECONNECT_PUSH		0x0004	/* call tcp_output */
147 #define NMSG_RECONNECT_FALLBACK		0x0008	/* fallback to ipv4 */
148 
149 struct netmsg_pru_connect2 {
150 	struct netmsg_base	base;
151 	struct socket		*nm_so1;
152 	struct socket		*nm_so2;
153 };
154 
155 struct netmsg_pru_control {
156 	struct netmsg_base	base;
157 	u_long			nm_cmd;
158 	caddr_t			nm_data;
159 	struct ifnet		*nm_ifp;
160 	struct thread		*nm_td;
161 };
162 
163 struct netmsg_pru_detach {
164 	struct netmsg_base	base;
165 };
166 
167 struct netmsg_pru_disconnect {
168 	struct netmsg_base	base;
169 };
170 
171 struct netmsg_pru_listen {
172 	struct netmsg_base	base;
173 	struct thread		*nm_td;
174 };
175 
176 struct netmsg_pru_peeraddr {
177 	struct netmsg_base	base;
178 	struct sockaddr		**nm_nam;
179 };
180 
181 struct netmsg_pru_rcvd {
182 	struct netmsg_base	base;
183 	int			nm_flags;
184 	int			nm_pru_flags;	/* PRUR_xxx */
185 };
186 
187 #define PRUR_ASYNC		0x1
188 #define PRUR_DEAD		0x2
189 
190 struct netmsg_pru_rcvoob {
191 	struct netmsg_base	base;
192 	struct mbuf		*nm_m;
193 	int			nm_flags;
194 };
195 
196 struct netmsg_pru_send {
197 	struct netmsg_base	base;
198 	int			nm_flags;	/* PRUS_xxx */
199 	struct mbuf		*nm_m;
200 	struct sockaddr		*nm_addr;
201 	struct mbuf		*nm_control;
202 	struct thread		*nm_td;
203 };
204 
205 #define PRUS_OOB		0x1
206 #define PRUS_EOF		0x2
207 #define PRUS_MORETOCOME		0x4
208 #define PRUS_NAMALLOC		0x8
209 #define PRUS_NOREPLY		0x10
210 #define PRUS_DONTROUTE		0x20
211 #define PRUS_FREEADDR		0x40
212 
213 struct netmsg_pru_sense {
214 	struct netmsg_base	base;
215 	struct stat		*nm_stat;
216 };
217 
218 struct netmsg_pru_shutdown {
219 	struct netmsg_base	base;
220 };
221 
222 struct netmsg_pru_sockaddr {
223 	struct netmsg_base	base;
224 	struct sockaddr		**nm_nam;
225 };
226 
227 struct netmsg_pru_sosend {
228 	struct netmsg_base	base;
229 	struct sockaddr		*nm_addr;
230 	struct uio		*nm_uio;
231 	struct mbuf		*nm_top;
232 	struct mbuf		*nm_control;
233 	int			nm_flags;
234 	struct thread		*nm_td;
235 };
236 
237 struct netmsg_pru_soreceive {
238 	struct netmsg_base	base;
239 	struct sockaddr		*nm_addr;
240 	struct sockaddr		**nm_paddr;
241 	struct uio		*nm_uio;
242 	struct sockbuf		*nm_sio;
243 	struct mbuf		**nm_controlp;
244 	int			*nm_flagsp;
245 };
246 
247 struct netmsg_pr_ctloutput {
248 	struct netmsg_base	base;
249 	struct sockopt		*nm_sopt;
250 };
251 
252 struct netmsg_pru_ctlinput {
253 	struct netmsg_base	base;
254 	int			nm_cmd;
255 	struct sockaddr		*nm_arg;
256 	void			*nm_extra;
257 };
258 
259 /*
260  * Union of all possible netmsgs.  Note that when a netmsg is sent the
261  * actual allocated storage is likely only the size of the particular
262  * class of message, and not sizeof(union netmsg).
263  */
264 union netmsg {
265 	struct lwkt_msg			lmsg;		/* base embedded */
266 	struct netmsg_base		base;		/* base embedded */
267 
268 	struct netmsg_packet		packet;		/* mbuf embedded */
269 	struct netmsg_pr_timeout	timeout;
270 	struct netmsg_so_notify		notify;
271 	struct netmsg_so_notify_abort	notify_abort;
272 
273 	struct netmsg_pr_ctloutput	ctloutput;
274 
275 	struct netmsg_pru_abort		abort;
276 	struct netmsg_pru_accept	accept;		/* synchronous */
277 	struct netmsg_pru_attach	attach;
278 	struct netmsg_pru_bind		bind;
279 	struct netmsg_pru_connect	connect;
280 	struct netmsg_pru_connect2	connect2;
281 	struct netmsg_pru_control	control;	/* synchronous */
282 	struct netmsg_pru_detach	detach;
283 	struct netmsg_pru_disconnect	disconnect;
284 	struct netmsg_pru_listen	listen;
285 	struct netmsg_pru_peeraddr	peeraddr;
286 	struct netmsg_pru_rcvd		rcvd;
287 	struct netmsg_pru_rcvoob	rcvoob;
288 	struct netmsg_pru_send		send;
289 	struct netmsg_pru_sense		sense;
290 	struct netmsg_pru_shutdown	shutdown;
291 	struct netmsg_pru_sockaddr	sockaddr;
292 	struct netmsg_pru_sosend	sosend;		/* synchronous */
293 	struct netmsg_pru_soreceive	soreceive;	/* synchronous */
294 	struct netmsg_pru_ctlinput	ctlinput;
295 };
296 
297 #endif	/* _KERNEL || _KERNEL_STRUCTURES */
298 
299 #endif	/* !_NET_NETMSG_H_ */
300