xref: /dflybsd-src/sys/net/netmsg.h (revision dae741e33c840b92a8a53bf9f01157ede145e256)
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_cpufn_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: netmsg_packet is embedded in mbufs.
68  */
69 TAILQ_HEAD(notifymsglist, netmsg_so_notify);
70 
71 struct netmsg_packet {
72 	struct netmsg_base	base;
73 	struct mbuf		*nm_packet;
74 	int			nm_nxt;
75 };
76 
77 struct netmsg_pr_timeout {
78 	struct netmsg_base	base;
79 };
80 
81 struct netmsg_so_notify;
82 typedef __boolean_t (*msg_predicate_fn_t)(struct netmsg_so_notify *);
83 
84 struct netmsg_so_notify {
85 	struct netmsg_base	base;
86 	msg_predicate_fn_t	nm_predicate;
87 	int			nm_fflags; /* flags e.g. FNONBLOCK */
88 	int			nm_etype;  /* receive or send event */
89 	TAILQ_ENTRY(netmsg_so_notify) nm_list;
90 };
91 
92 struct netmsg_so_notify_abort {
93 	struct netmsg_base	base;
94 	struct netmsg_so_notify	*nm_notifymsg;
95 };
96 
97 #define NM_REVENT	0x1		/* event on receive buffer */
98 #define NM_SEVENT	0x2		/* event on send buffer */
99 
100 /*
101  * User protocol requests messages.
102  */
103 struct netmsg_pru_abort {
104 	struct netmsg_base	base;
105 };
106 
107 struct netmsg_pru_accept {
108 	struct netmsg_base	base;
109 	struct sockaddr		**nm_nam;
110 };
111 
112 struct netmsg_pru_attach {
113 	struct netmsg_base	base;
114 	int			nm_proto;
115 	struct pru_attach_info	*nm_ai;
116 };
117 
118 struct netmsg_pru_bind {
119 	struct netmsg_base	base;
120 	struct sockaddr		*nm_nam;
121 	struct thread		*nm_td;
122 };
123 
124 struct netmsg_pru_connect {
125 	struct netmsg_base	base;
126 	struct sockaddr		*nm_nam;
127 	struct thread		*nm_td;
128 	struct mbuf		*nm_m;		/* connect with send */
129 	int			nm_flags;	/* connect with send */
130 	int			nm_reconnect;	/* message control */
131 };
132 
133 #define NMSG_RECONNECT_RECONNECT	0x0001	/* thread port change */
134 #define NMSG_RECONNECT_NAMALLOC		0x0002	/* nm_nam allocated */
135 #define NMSG_RECONNECT_PUSH		0x0004	/* call tcp_output */
136 #define NMSG_RECONNECT_FALLBACK		0x0008	/* fallback to ipv4 */
137 
138 struct netmsg_pru_connect2 {
139 	struct netmsg_base	base;
140 	struct socket		*nm_so1;
141 	struct socket		*nm_so2;
142 };
143 
144 struct netmsg_pru_control {
145 	struct netmsg_base	base;
146 	u_long			nm_cmd;
147 	caddr_t			nm_data;
148 	struct ifnet		*nm_ifp;
149 	struct thread		*nm_td;
150 };
151 
152 struct netmsg_pru_detach {
153 	struct netmsg_base	base;
154 };
155 
156 struct netmsg_pru_disconnect {
157 	struct netmsg_base	base;
158 };
159 
160 struct netmsg_pru_listen {
161 	struct netmsg_base	base;
162 	struct thread		*nm_td;
163 };
164 
165 struct netmsg_pru_peeraddr {
166 	struct netmsg_base	base;
167 	struct sockaddr		**nm_nam;
168 };
169 
170 struct netmsg_pru_rcvd {
171 	struct netmsg_base	base;
172 	int			nm_flags;
173 };
174 
175 struct netmsg_pru_rcvoob {
176 	struct netmsg_base	base;
177 	struct mbuf		*nm_m;
178 	int			nm_flags;
179 };
180 
181 struct netmsg_pru_send {
182 	struct netmsg_base	base;
183 	int			nm_flags;	/* PRUS_xxx */
184 	struct mbuf		*nm_m;
185 	struct sockaddr		*nm_addr;
186 	struct mbuf		*nm_control;
187 	struct thread		*nm_td;
188 };
189 
190 #define PRUS_OOB		0x1
191 #define PRUS_EOF		0x2
192 #define PRUS_MORETOCOME		0x4
193 #define PRUS_NAMALLOC		0x8
194 #define PRUS_NOREPLY		0x10
195 
196 struct netmsg_pru_sense {
197 	struct netmsg_base	base;
198 	struct stat		*nm_stat;
199 };
200 
201 struct netmsg_pru_shutdown {
202 	struct netmsg_base	base;
203 };
204 
205 struct netmsg_pru_sockaddr {
206 	struct netmsg_base	base;
207 	struct sockaddr		**nm_nam;
208 };
209 
210 struct netmsg_pru_sosend {
211 	struct netmsg_base	base;
212 	struct sockaddr		*nm_addr;
213 	struct uio		*nm_uio;
214 	struct mbuf		*nm_top;
215 	struct mbuf		*nm_control;
216 	int			nm_flags;
217 	struct thread		*nm_td;
218 };
219 
220 struct netmsg_pru_soreceive {
221 	struct netmsg_base	base;
222 	struct sockaddr		*nm_addr;
223 	struct sockaddr		**nm_paddr;
224 	struct uio		*nm_uio;
225 	struct sockbuf		*nm_sio;
226 	struct mbuf		**nm_controlp;
227 	int			*nm_flagsp;
228 };
229 
230 struct netmsg_pr_ctloutput {
231 	struct netmsg_base	base;
232 	struct sockopt		*nm_sopt;
233 };
234 
235 struct netmsg_pru_ctlinput {
236 	struct netmsg_base	base;
237 	int			nm_cmd;
238 	struct sockaddr		*nm_arg;
239 	void			*nm_extra;
240 };
241 
242 /*
243  * Union of all possible netmsgs.  Note that when a netmsg is sent the
244  * actual allocated storage is likely only the size of the particular
245  * class of message, and not sizeof(union netmsg).
246  */
247 union netmsg {
248 	struct lwkt_msg			lmsg;		/* base embedded */
249 	struct netmsg_base		base;		/* base embedded */
250 
251 	struct netmsg_packet		packet;		/* mbuf embedded */
252 	struct netmsg_pr_timeout	timeout;
253 	struct netmsg_so_notify		notify;
254 	struct netmsg_so_notify_abort	notify_abort;
255 
256 	struct netmsg_pr_ctloutput	ctloutput;
257 
258 	struct netmsg_pru_abort		abort;
259 	struct netmsg_pru_accept	accept;		/* synchronous */
260 	struct netmsg_pru_attach	attach;
261 	struct netmsg_pru_bind		bind;
262 	struct netmsg_pru_connect	connect;
263 	struct netmsg_pru_connect2	connect2;
264 	struct netmsg_pru_control	control;	/* synchronous */
265 	struct netmsg_pru_detach	detach;
266 	struct netmsg_pru_disconnect	disconnect;
267 	struct netmsg_pru_listen	listen;
268 	struct netmsg_pru_peeraddr	peeraddr;
269 	struct netmsg_pru_rcvd		rcvd;
270 	struct netmsg_pru_rcvoob	rcvoob;
271 	struct netmsg_pru_send		send;
272 	struct netmsg_pru_sense		sense;
273 	struct netmsg_pru_shutdown	shutdown;
274 	struct netmsg_pru_sockaddr	sockaddr;
275 	struct netmsg_pru_sosend	sosend;		/* synchronous */
276 	struct netmsg_pru_soreceive	soreceive;	/* synchronous */
277 	struct netmsg_pru_ctlinput	ctlinput;
278 };
279 
280 #endif	/* _KERNEL || _KERNEL_STRUCTURES */
281 
282 #endif	/* !_NET_NETMSG_H_ */
283