2 * Copyright (c) 2003, 2004 Jeffrey M. Hsu. All rights reserved.
3 * Copyright (c) 2003, 2004 The DragonFly Project. All rights reserved.
5 * This code is derived from software contributed to The DragonFly Project
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/msgport.h>
38 #include <sys/protosw.h>
39 #include <sys/socket.h>
40 #include <sys/socketvar.h>
41 #include <sys/socketops.h>
42 #include <sys/thread.h>
43 #include <sys/thread2.h>
44 #include <sys/msgport2.h>
45 #include <sys/spinlock2.h>
49 #include <net/netmsg2.h>
50 #include <sys/socketvar2.h>
52 #include <net/netisr.h>
53 #include <net/netmsg.h>
56 * Abort a socket and free it. Called from soabort() only. soabort()
57 * got a ref on the socket which we must free on reply.
60 so_pru_abort(struct socket *so)
62 struct netmsg_pru_abort msg;
64 netmsg_init(&msg.base, so, &curthread->td_msgport,
65 0, so->so_proto->pr_usrreqs->pru_abort);
66 (void)lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
67 sofree(msg.base.nm_so);
71 * Abort a socket and free it, asynchronously. Called from
72 * soaborta() only. soaborta() got a ref on the socket which we must
76 so_pru_aborta(struct socket *so)
78 struct netmsg_pru_abort *msg;
80 msg = kmalloc(sizeof(*msg), M_LWKTMSG, M_WAITOK | M_ZERO);
81 netmsg_init(&msg->base, so, &netisr_afree_free_so_rport,
82 0, so->so_proto->pr_usrreqs->pru_abort);
83 lwkt_sendmsg(so->so_port, &msg->base.lmsg);
87 * Abort a socket and free it. Called from soabort_oncpu() only.
88 * Caller must make sure that the current CPU is inpcb's owner CPU.
91 so_pru_abort_oncpu(struct socket *so)
93 struct netmsg_pru_abort msg;
94 netisr_fn_t func = so->so_proto->pr_usrreqs->pru_abort;
96 netmsg_init(&msg.base, so, &netisr_adone_rport, 0, func);
97 msg.base.lmsg.ms_flags &= ~(MSGF_REPLY | MSGF_DONE);
98 msg.base.lmsg.ms_flags |= MSGF_SYNC;
100 KKASSERT(msg.base.lmsg.ms_flags & MSGF_DONE);
101 sofree(msg.base.nm_so);
105 so_pru_accept(struct socket *so, struct sockaddr **nam)
107 struct netmsg_pru_accept msg;
109 netmsg_init(&msg.base, so, &curthread->td_msgport,
110 0, so->so_proto->pr_usrreqs->pru_accept);
113 return lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
117 so_pru_attach(struct socket *so, int proto, struct pru_attach_info *ai)
119 struct netmsg_pru_attach msg;
122 netmsg_init(&msg.base, so, &curthread->td_msgport,
123 0, so->so_proto->pr_usrreqs->pru_attach);
124 msg.nm_proto = proto;
126 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
131 so_pru_attach_direct(struct socket *so, int proto, struct pru_attach_info *ai)
133 struct netmsg_pru_attach msg;
134 netisr_fn_t func = so->so_proto->pr_usrreqs->pru_attach;
136 netmsg_init(&msg.base, so, &netisr_adone_rport, 0, func);
137 msg.base.lmsg.ms_flags &= ~(MSGF_REPLY | MSGF_DONE);
138 msg.base.lmsg.ms_flags |= MSGF_SYNC;
139 msg.nm_proto = proto;
141 func((netmsg_t)&msg);
142 KKASSERT(msg.base.lmsg.ms_flags & MSGF_DONE);
143 return(msg.base.lmsg.ms_error);
147 * NOTE: If the target port changes the bind operation will deal with it.
150 so_pru_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
152 struct netmsg_pru_bind msg;
155 netmsg_init(&msg.base, so, &curthread->td_msgport,
156 0, so->so_proto->pr_usrreqs->pru_bind);
158 msg.nm_td = td; /* used only for prison_ip() */
159 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
164 so_pru_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
166 struct netmsg_pru_connect msg;
169 netmsg_init(&msg.base, so, &curthread->td_msgport,
170 0, so->so_proto->pr_usrreqs->pru_connect);
175 msg.nm_reconnect = 0;
176 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
181 so_pru_connect2(struct socket *so1, struct socket *so2)
183 struct netmsg_pru_connect2 msg;
186 netmsg_init(&msg.base, so1, &curthread->td_msgport,
187 0, so1->so_proto->pr_usrreqs->pru_connect2);
190 error = lwkt_domsg(so1->so_port, &msg.base.lmsg, 0);
195 * WARNING! Synchronous call from user context. Control function may do
199 so_pru_control_direct(struct socket *so, u_long cmd, caddr_t data,
202 struct netmsg_pru_control msg;
203 netisr_fn_t func = so->so_proto->pr_usrreqs->pru_control;
205 netmsg_init(&msg.base, so, &netisr_adone_rport, 0, func);
206 msg.base.lmsg.ms_flags &= ~(MSGF_REPLY | MSGF_DONE);
207 msg.base.lmsg.ms_flags |= MSGF_SYNC;
211 msg.nm_td = curthread;
212 func((netmsg_t)&msg);
213 KKASSERT(msg.base.lmsg.ms_flags & MSGF_DONE);
214 return(msg.base.lmsg.ms_error);
218 so_pru_detach(struct socket *so)
220 struct netmsg_pru_detach msg;
223 netmsg_init(&msg.base, so, &curthread->td_msgport,
224 0, so->so_proto->pr_usrreqs->pru_detach);
225 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
230 so_pru_detach_direct(struct socket *so)
232 struct netmsg_pru_detach msg;
233 netisr_fn_t func = so->so_proto->pr_usrreqs->pru_detach;
235 netmsg_init(&msg.base, so, &netisr_adone_rport, 0, func);
236 msg.base.lmsg.ms_flags &= ~(MSGF_REPLY | MSGF_DONE);
237 msg.base.lmsg.ms_flags |= MSGF_SYNC;
238 func((netmsg_t)&msg);
239 KKASSERT(msg.base.lmsg.ms_flags & MSGF_DONE);
243 so_pru_disconnect(struct socket *so)
245 struct netmsg_pru_disconnect msg;
248 netmsg_init(&msg.base, so, &curthread->td_msgport,
249 0, so->so_proto->pr_usrreqs->pru_disconnect);
250 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
255 so_pru_disconnect_direct(struct socket *so)
257 struct netmsg_pru_disconnect msg;
258 netisr_fn_t func = so->so_proto->pr_usrreqs->pru_disconnect;
260 netmsg_init(&msg.base, so, &netisr_adone_rport, 0, func);
261 msg.base.lmsg.ms_flags &= ~(MSGF_REPLY | MSGF_DONE);
262 msg.base.lmsg.ms_flags |= MSGF_SYNC;
263 func((netmsg_t)&msg);
264 KKASSERT(msg.base.lmsg.ms_flags & MSGF_DONE);
268 so_pru_listen(struct socket *so, struct thread *td)
270 struct netmsg_pru_listen msg;
273 netmsg_init(&msg.base, so, &curthread->td_msgport,
274 0, so->so_proto->pr_usrreqs->pru_listen);
275 msg.nm_td = td; /* used only for prison_ip() XXX JH */
276 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
281 so_pru_peeraddr(struct socket *so, struct sockaddr **nam)
283 struct netmsg_pru_peeraddr msg;
286 netmsg_init(&msg.base, so, &curthread->td_msgport,
287 0, so->so_proto->pr_usrreqs->pru_peeraddr);
289 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
294 so_pru_rcvd(struct socket *so, int flags)
296 struct netmsg_pru_rcvd msg;
299 netmsg_init(&msg.base, so, &curthread->td_msgport,
300 0, so->so_proto->pr_usrreqs->pru_rcvd);
301 msg.nm_flags = flags;
302 msg.nm_pru_flags = 0;
303 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
308 so_pru_rcvd_async(struct socket *so)
310 lwkt_msg_t lmsg = &so->so_rcvd_msg.base.lmsg;
312 KASSERT(so->so_proto->pr_flags & PR_ASYNC_RCVD,
313 ("async pru_rcvd is not supported"));
316 * WARNING! Spinlock is a bit dodgy, use hacked up sendmsg
317 * to avoid deadlocking.
319 spin_lock(&so->so_rcvd_spin);
320 if ((so->so_rcvd_msg.nm_pru_flags & PRUR_DEAD) == 0) {
321 if (lmsg->ms_flags & MSGF_DONE) {
323 lwkt_sendmsg_stage1(so->so_port, lmsg);
324 spin_unlock(&so->so_rcvd_spin);
325 lwkt_sendmsg_stage2(so->so_port, lmsg);
327 spin_unlock(&so->so_rcvd_spin);
330 spin_unlock(&so->so_rcvd_spin);
335 so_pru_rcvoob(struct socket *so, struct mbuf *m, int flags)
337 struct netmsg_pru_rcvoob msg;
340 netmsg_init(&msg.base, so, &curthread->td_msgport,
341 0, so->so_proto->pr_usrreqs->pru_rcvoob);
343 msg.nm_flags = flags;
344 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
349 * NOTE: If the target port changes the implied connect will deal with it.
352 so_pru_send(struct socket *so, int flags, struct mbuf *m,
353 struct sockaddr *addr, struct mbuf *control, struct thread *td)
355 struct netmsg_pru_send msg;
358 netmsg_init(&msg.base, so, &curthread->td_msgport,
359 0, so->so_proto->pr_usrreqs->pru_send);
360 msg.nm_flags = flags;
363 msg.nm_control = control;
365 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
370 so_pru_sync(struct socket *so)
372 struct netmsg_base msg;
374 netmsg_init(&msg, so, &curthread->td_msgport, 0,
375 netmsg_sync_handler);
376 lwkt_domsg(so->so_port, &msg.lmsg, 0);
380 so_pru_send_async(struct socket *so, int flags, struct mbuf *m,
381 struct sockaddr *addr0, struct mbuf *control, struct thread *td)
383 struct netmsg_pru_send *msg;
384 struct sockaddr *addr = NULL;
386 KASSERT(so->so_proto->pr_flags & PR_ASYNC_SEND,
387 ("async pru_send is not supported"));
389 flags |= PRUS_NOREPLY;
391 addr = kmalloc(addr0->sa_len, M_SONAME, M_WAITOK);
392 memcpy(addr, addr0, addr0->sa_len);
393 flags |= PRUS_FREEADDR;
396 msg = &m->m_hdr.mh_sndmsg;
397 netmsg_init(&msg->base, so, &netisr_apanic_rport,
398 0, so->so_proto->pr_usrreqs->pru_send);
399 msg->nm_flags = flags;
402 msg->nm_control = control;
404 lwkt_sendmsg(so->so_port, &msg->base.lmsg);
408 so_pru_sense(struct socket *so, struct stat *sb)
410 struct netmsg_pru_sense msg;
413 netmsg_init(&msg.base, so, &curthread->td_msgport,
414 0, so->so_proto->pr_usrreqs->pru_sense);
416 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
421 so_pru_shutdown(struct socket *so)
423 struct netmsg_pru_shutdown msg;
426 netmsg_init(&msg.base, so, &curthread->td_msgport,
427 0, so->so_proto->pr_usrreqs->pru_shutdown);
428 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
433 so_pru_sockaddr(struct socket *so, struct sockaddr **nam)
435 struct netmsg_pru_sockaddr msg;
438 netmsg_init(&msg.base, so, &curthread->td_msgport,
439 0, so->so_proto->pr_usrreqs->pru_sockaddr);
441 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
446 so_pr_ctloutput(struct socket *so, struct sockopt *sopt)
448 struct netmsg_pr_ctloutput msg;
451 KKASSERT(!sopt->sopt_val || kva_p(sopt->sopt_val));
452 netmsg_init(&msg.base, so, &curthread->td_msgport,
453 0, so->so_proto->pr_ctloutput);
455 error = lwkt_domsg(so->so_port, &msg.base.lmsg, 0);
460 * Protocol control input, typically via icmp.
462 * If the protocol pr_ctlport is not NULL we call it to figure out the
463 * protocol port. If NULL is returned we can just return, otherwise
464 * we issue a netmsg to call pr_ctlinput in the proper thread.
466 * This must be done synchronously as arg and/or extra may point to
470 so_pru_ctlinput(struct protosw *pr, int cmd, struct sockaddr *arg, void *extra)
472 struct netmsg_pru_ctlinput msg;
475 if (pr->pr_ctlport == NULL)
477 KKASSERT(pr->pr_ctlinput != NULL);
478 port = pr->pr_ctlport(cmd, arg, extra);
481 netmsg_init(&msg.base, NULL, &curthread->td_msgport,
485 msg.nm_extra = extra;
486 lwkt_domsg(port, &msg.base.lmsg, 0);
490 * If we convert all the protosw pr_ functions for all the protocols
491 * to take a message directly, this layer can go away. For the moment
492 * our dispatcher ignores the return value, but since we are handling
493 * the replymsg ourselves we return EASYNC by convention.
497 * Handle a predicate event request. This function is only called once
498 * when the predicate message queueing request is received.
501 netmsg_so_notify(netmsg_t msg)
503 struct lwkt_token *tok;
504 struct signalsockbuf *ssb;
506 ssb = (msg->notify.nm_etype & NM_REVENT) ?
507 &msg->base.nm_so->so_rcv :
508 &msg->base.nm_so->so_snd;
511 * Reply immediately if the event has occured, otherwise queue the
514 * NOTE: Socket can change if this is an accept predicate so cache
517 tok = lwkt_token_pool_lookup(msg->base.nm_so);
519 if (msg->notify.nm_predicate(&msg->notify)) {
521 lwkt_replymsg(&msg->base.lmsg,
522 msg->base.lmsg.ms_error);
524 TAILQ_INSERT_TAIL(&ssb->ssb_kq.ki_mlist, &msg->notify, nm_list);
525 atomic_set_int(&ssb->ssb_flags, SSB_MEVENT);
531 * Called by doio when trying to abort a netmsg_so_notify message.
532 * Unlike the other functions this one is dispatched directly by
533 * the LWKT subsystem, so it takes a lwkt_msg_t as an argument.
535 * The original message, lmsg, is under the control of the caller and
536 * will not be destroyed until we return so we can safely reference it
537 * in our synchronous abort request.
539 * This part of the abort request occurs on the originating cpu which
540 * means we may race the message flags and the original message may
541 * not even have been processed by the target cpu yet.
544 netmsg_so_notify_doabort(lwkt_msg_t lmsg)
546 struct netmsg_so_notify_abort msg;
548 if ((lmsg->ms_flags & (MSGF_DONE | MSGF_REPLY)) == 0) {
549 netmsg_init(&msg.base, NULL, &curthread->td_msgport,
550 0, netmsg_so_notify_abort);
551 msg.nm_notifymsg = (void *)lmsg;
552 lwkt_domsg(lmsg->ms_target_port, &msg.base.lmsg, 0);
557 * Predicate requests can be aborted. This function is only called once
558 * and will interlock against processing/reply races (since such races
559 * occur on the same thread that controls the port where the abort is
562 * This part of the abort request occurs on the target cpu. The message
563 * flags must be tested again in case the test that we did on the
564 * originating cpu raced. Since messages are handled in sequence, the
565 * original message will have already been handled by the loop and either
566 * replied to or queued.
568 * We really only need to interlock with MSGF_REPLY (a bit that is set on
569 * our cpu when we reply). Note that MSGF_DONE is not set until the
570 * reply reaches the originating cpu. Test both bits anyway.
573 netmsg_so_notify_abort(netmsg_t msg)
575 struct netmsg_so_notify_abort *abrtmsg = &msg->notify_abort;
576 struct netmsg_so_notify *nmsg = abrtmsg->nm_notifymsg;
577 struct signalsockbuf *ssb;
580 * The original notify message is not destroyed until after the
581 * abort request is returned, so we can check its state.
583 lwkt_getpooltoken(nmsg->base.nm_so);
584 if ((nmsg->base.lmsg.ms_flags & (MSGF_DONE | MSGF_REPLY)) == 0) {
585 ssb = (nmsg->nm_etype & NM_REVENT) ?
586 &nmsg->base.nm_so->so_rcv :
587 &nmsg->base.nm_so->so_snd;
588 TAILQ_REMOVE(&ssb->ssb_kq.ki_mlist, nmsg, nm_list);
589 lwkt_relpooltoken(nmsg->base.nm_so);
590 lwkt_replymsg(&nmsg->base.lmsg, EINTR);
592 lwkt_relpooltoken(nmsg->base.nm_so);
596 * Reply to the abort message
598 lwkt_replymsg(&abrtmsg->base.lmsg, 0);
602 so_async_rcvd_reply(struct socket *so)
605 * Spinlock safe, reply runs to degenerate lwkt_null_replyport()
607 spin_lock(&so->so_rcvd_spin);
608 lwkt_replymsg(&so->so_rcvd_msg.base.lmsg, 0);
609 spin_unlock(&so->so_rcvd_spin);
614 so_async_rcvd_drop(struct socket *so)
616 lwkt_msg_t lmsg = &so->so_rcvd_msg.base.lmsg;
620 * Spinlock safe, reply runs to degenerate lwkt_spin_dropmsg()
622 spin_lock(&so->so_rcvd_spin);
623 if (lwkt_dropmsg(lmsg) == 0)
625 so->so_rcvd_msg.nm_pru_flags |= PRUR_DEAD;
626 spin_unlock(&so->so_rcvd_spin);
627 if ((lmsg->ms_flags & MSGF_DONE) == 0) {
628 kprintf("Warning: tcp: so_async_rcvd_drop() raced message\n");
629 tsleep(so, 0, "soadrop", 1);