xref: /dragonfly/sys/net/netmsg.h (revision 030b3383)
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 #define MSGF_IGNSOPORT		MSGF_USER0	/* don't check so_port */
63 #define MSGF_PROTO1		MSGF_USER1	/* protocol specific */
64 
65 typedef struct netmsg_base *netmsg_base_t;
66 
67 /*
68  * NETISR messages
69  *
70  * NOTE:
71  * - netmsg_packet is embedded in mbufs.
72  * - netmsg_pru_send is embedded in mbufs.
73  * - netmsg_inarp is embedded in mbufs.
74  * - netmsg_ctlinput is embedded in mbufs.
75  */
76 TAILQ_HEAD(notifymsglist, netmsg_so_notify);
77 
78 struct netmsg_packet {
79 	struct netmsg_base	base;
80 	struct mbuf		*nm_packet;
81 	int			nm_nxt;
82 };
83 
84 struct netmsg_inarp {
85 	struct netmsg_base	base;
86 	struct mbuf		*m;
87 	in_addr_t		saddr;
88 	in_addr_t		taddr;
89 	in_addr_t		myaddr;
90 };
91 
92 struct netmsg_ctlinput {
93 	struct netmsg_base	base;
94 	struct mbuf		*m;
95 	int			cmd;
96 	int			hlen;
97 	int			proto;
98 };
99 
100 struct netmsg_pr_timeout {
101 	struct netmsg_base	base;
102 };
103 
104 struct netmsg_so_notify;
105 typedef __boolean_t (*msg_predicate_fn_t)(struct netmsg_so_notify *);
106 
107 struct netmsg_so_notify {
108 	struct netmsg_base	base;
109 	msg_predicate_fn_t	nm_predicate;
110 	int			nm_fflags; /* flags e.g. FNONBLOCK */
111 	int			nm_etype;  /* receive or send event */
112 	TAILQ_ENTRY(netmsg_so_notify) nm_list;
113 };
114 
115 struct netmsg_so_notify_abort {
116 	struct netmsg_base	base;
117 	struct netmsg_so_notify	*nm_notifymsg;
118 };
119 
120 #define NM_REVENT	0x1		/* event on receive buffer */
121 #define NM_SEVENT	0x2		/* event on send buffer */
122 
123 /*
124  * User protocol requests messages.
125  */
126 struct netmsg_pru_abort {
127 	struct netmsg_base	base;
128 };
129 
130 struct netmsg_pru_accept {
131 	struct netmsg_base	base;
132 	struct sockaddr		**nm_nam;
133 };
134 
135 struct netmsg_pru_attach {
136 	struct netmsg_base	base;
137 	int			nm_proto;
138 	struct pru_attach_info	*nm_ai;
139 };
140 
141 struct netmsg_pru_bind {
142 	struct netmsg_base	base;
143 	struct sockaddr		*nm_nam;
144 	struct thread		*nm_td;
145 	int			nm_flags;	/* PRUB_ */
146 };
147 
148 #define PRUB_RELINK		0x0001
149 
150 struct netmsg_pru_connect {
151 	struct netmsg_base	base;
152 	struct sockaddr		*nm_nam;
153 	struct thread		*nm_td;
154 	struct mbuf		*nm_m;		/* connect with send */
155 	int			nm_sndflags;	/* connect with send, PRUS_ */
156 	int			nm_flags;	/* message control */
157 };
158 
159 #define PRUC_RECONNECT		0x0001		/* thread port change */
160 #define PRUC_PUSH		0x0004		/* call tcp_output */
161 #define PRUC_ASYNC		0x0010
162 #define PRUC_HELDTD		0x0020
163 #define PRUC_HASLADDR		0x0040
164 
165 struct netmsg_pru_connect2 {
166 	struct netmsg_base	base;
167 	struct socket		*nm_so1;
168 	struct socket		*nm_so2;
169 };
170 
171 struct netmsg_pru_control {
172 	struct netmsg_base	base;
173 	u_long			nm_cmd;
174 	caddr_t			nm_data;
175 	struct ifnet		*nm_ifp;
176 	struct thread		*nm_td;
177 };
178 
179 struct netmsg_pru_detach {
180 	struct netmsg_base	base;
181 };
182 
183 struct netmsg_pru_disconnect {
184 	struct netmsg_base	base;
185 };
186 
187 struct netmsg_pru_listen {
188 	struct netmsg_base	base;
189 	struct thread		*nm_td;
190 	int			nm_flags;	/* PRUL_xxx */
191 };
192 
193 #define PRUL_RELINK		0x1
194 
195 struct netmsg_pru_peeraddr {
196 	struct netmsg_base	base;
197 	struct sockaddr		**nm_nam;
198 };
199 
200 struct netmsg_pru_rcvd {
201 	struct netmsg_base	base;
202 	int			nm_flags;
203 	int			nm_pru_flags;	/* PRUR_xxx */
204 };
205 
206 #define PRUR_ASYNC		0x1
207 #define PRUR_DEAD		0x2
208 
209 struct netmsg_pru_rcvoob {
210 	struct netmsg_base	base;
211 	struct mbuf		*nm_m;
212 	int			nm_flags;
213 };
214 
215 struct netmsg_pru_send {
216 	struct netmsg_base	base;
217 	int			nm_flags;	/* PRUS_xxx */
218 	int			nm_priv;	/* proto priv. */
219 	struct mbuf		*nm_m;
220 	struct sockaddr		*nm_addr;
221 	struct mbuf		*nm_control;
222 	struct thread		*nm_td;
223 };
224 
225 #define PRUS_OOB		0x1
226 #define PRUS_EOF		0x2
227 #define PRUS_MORETOCOME		0x4
228 #define PRUS_NAMALLOC		0x8
229 #define PRUS_NOREPLY		0x10
230 #define PRUS_DONTROUTE		0x20
231 #define PRUS_FREEADDR		0x40
232 #define PRUS_HELDTD		0x80
233 
234 struct netmsg_pru_sense {
235 	struct netmsg_base	base;
236 	struct stat		*nm_stat;
237 };
238 
239 struct netmsg_pru_shutdown {
240 	struct netmsg_base	base;
241 };
242 
243 struct netmsg_pru_sockaddr {
244 	struct netmsg_base	base;
245 	struct sockaddr		**nm_nam;
246 };
247 
248 struct netmsg_pru_sosend {
249 	struct netmsg_base	base;
250 	struct sockaddr		*nm_addr;
251 	struct uio		*nm_uio;
252 	struct mbuf		*nm_top;
253 	struct mbuf		*nm_control;
254 	int			nm_flags;
255 	struct thread		*nm_td;
256 };
257 
258 struct netmsg_pru_soreceive {
259 	struct netmsg_base	base;
260 	struct sockaddr		*nm_addr;
261 	struct sockaddr		**nm_paddr;
262 	struct uio		*nm_uio;
263 	struct sockbuf		*nm_sio;
264 	struct mbuf		**nm_controlp;
265 	int			*nm_flagsp;
266 };
267 
268 struct netmsg_pr_ctloutput {
269 	struct netmsg_base	base;
270 	struct sockopt		*nm_sopt;
271 };
272 
273 struct netmsg_pr_ctlinput {
274 	struct netmsg_base	base;
275 	int			nm_cmd;
276 	int			nm_direct;
277 	struct sockaddr		*nm_arg;
278 	void			*nm_extra;
279 };
280 
281 /*
282  * Union of all possible netmsgs.  Note that when a netmsg is sent the
283  * actual allocated storage is likely only the size of the particular
284  * class of message, and not sizeof(union netmsg).
285  */
286 union netmsg {
287 	struct lwkt_msg			lmsg;		/* base embedded */
288 	struct netmsg_base		base;		/* base embedded */
289 
290 	struct netmsg_packet		packet;		/* mbuf embedded */
291 	struct netmsg_pr_timeout	timeout;
292 	struct netmsg_so_notify		notify;
293 	struct netmsg_so_notify_abort	notify_abort;
294 
295 	struct netmsg_pr_ctloutput	ctloutput;
296 	struct netmsg_pr_ctlinput	ctlinput;
297 
298 	struct netmsg_pru_abort		abort;
299 	struct netmsg_pru_accept	accept;		/* synchronous */
300 	struct netmsg_pru_attach	attach;
301 	struct netmsg_pru_bind		bind;
302 	struct netmsg_pru_connect	connect;
303 	struct netmsg_pru_connect2	connect2;
304 	struct netmsg_pru_control	control;	/* synchronous */
305 	struct netmsg_pru_detach	detach;
306 	struct netmsg_pru_disconnect	disconnect;
307 	struct netmsg_pru_listen	listen;
308 	struct netmsg_pru_peeraddr	peeraddr;
309 	struct netmsg_pru_rcvd		rcvd;
310 	struct netmsg_pru_rcvoob	rcvoob;
311 	struct netmsg_pru_send		send;
312 	struct netmsg_pru_sense		sense;
313 	struct netmsg_pru_shutdown	shutdown;
314 	struct netmsg_pru_sockaddr	sockaddr;
315 	struct netmsg_pru_sosend	sosend;		/* synchronous */
316 	struct netmsg_pru_soreceive	soreceive;	/* synchronous */
317 };
318 
319 #endif	/* _KERNEL || _KERNEL_STRUCTURES */
320 
321 #endif	/* !_NET_NETMSG_H_ */
322