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
33 * $DragonFly: src/sys/kern/uipc_msg.c,v 1.26 2008/10/27 02:56:30 sephe Exp $
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/msgport.h>
40 #include <sys/protosw.h>
41 #include <sys/socket.h>
42 #include <sys/socketvar.h>
43 #include <sys/socketops.h>
44 #include <sys/thread.h>
45 #include <sys/thread2.h>
46 #include <sys/msgport2.h>
48 #include <net/netmsg2.h>
50 #include <net/netisr.h>
51 #include <net/netmsg.h>
54 * Abort a socket and free it. Called from soabort() only.
56 * The SS_ABORTING flag must already be set.
59 so_pru_abort(struct socket *so)
61 struct netmsg_pru_abort msg;
64 KKASSERT(so->so_state & SS_ABORTING);
65 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_ABORT);
66 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport,
68 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_abort;
70 (void)lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
74 * Abort a socket and free it, asynchronously. Called from
77 * The SS_ABORTING flag must already be set.
80 so_pru_aborta(struct socket *so)
82 struct netmsg_pru_abort *msg;
85 KKASSERT(so->so_state & SS_ABORTING);
86 msg = kmalloc(sizeof(*msg), M_LWKTMSG, M_WAITOK | M_ZERO);
87 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_ABORT);
88 netmsg_init(&msg->nm_netmsg, &netisr_afree_rport,
90 msg->nm_prufn = so->so_proto->pr_usrreqs->pru_abort;
92 lwkt_sendmsg(port, &msg->nm_netmsg.nm_lmsg);
96 * Abort a socket and free it. Called from soabort_oncpu() only.
97 * Caller must make sure that the current CPU is inpcb's owner CPU.
99 * The SS_ABORTING flag must already be set.
102 so_pru_abort_oncpu(struct socket *so)
104 so->so_proto->pr_usrreqs->pru_abort(so);
108 so_pru_accept(struct socket *so, struct sockaddr **nam)
110 /* Block (memory allocation) in process context. XXX JH */
111 return ((*so->so_proto->pr_usrreqs->pru_accept)(so, nam));
115 struct netmsg_pru_accept msg;
118 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_ACCEPT);
119 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
121 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_accept;
124 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
130 so_pru_attach(struct socket *so, int proto, struct pru_attach_info *ai)
133 struct netmsg_pru_attach msg;
136 port = so->so_proto->pr_mport(NULL, NULL, NULL, PRU_ATTACH);
137 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
139 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_attach;
141 msg.nm_proto = proto;
143 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
148 so_pru_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
151 struct netmsg_pru_bind msg;
154 /* Send mesg to thread for new address. */
155 port = so->so_proto->pr_mport(NULL, nam, NULL, PRU_BIND);
156 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
158 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_bind;
161 msg.nm_td = td; /* used only for prison_ip() XXX JH */
162 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
167 so_pru_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
170 struct netmsg_pru_connect msg;
173 port = so->so_proto->pr_mport(so, nam, NULL, PRU_CONNECT);
174 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
176 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_connect;
180 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
185 so_pru_connect2(struct socket *so1, struct socket *so2)
188 struct netmsg_pru_connect2 msg;
191 port = so1->so_proto->pr_mport(so1, NULL, NULL, PRU_CONNECT2);
192 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
193 netmsg_pru_connect2);
194 msg.nm_prufn = so1->so_proto->pr_usrreqs->pru_connect2;
197 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
202 so_pru_control(struct socket *so, u_long cmd, caddr_t data, struct ifnet *ifp)
204 return ((*so->so_proto->pr_usrreqs->pru_control)(so, cmd, data, ifp,
206 #ifdef gag /* does copyin and copyout deep inside stack XXX JH */
208 struct netmsg_pru_control msg;
211 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_CONTROL);
212 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
214 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_control;
220 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
226 so_pru_detach(struct socket *so)
229 struct netmsg_pru_detach msg;
232 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_DETACH);
233 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
235 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_detach;
237 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
242 so_pru_disconnect(struct socket *so)
245 struct netmsg_pru_disconnect msg;
248 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_DISCONNECT);
249 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
250 netmsg_pru_disconnect);
251 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_disconnect;
253 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
258 so_pru_listen(struct socket *so, struct thread *td)
261 struct netmsg_pru_listen msg;
264 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_LISTEN);
265 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
267 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_listen;
269 msg.nm_td = td; /* used only for prison_ip() XXX JH */
270 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
275 so_pru_peeraddr(struct socket *so, struct sockaddr **nam)
278 struct netmsg_pru_peeraddr msg;
281 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_PEERADDR);
282 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
283 netmsg_pru_peeraddr);
284 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_peeraddr;
287 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
292 so_pru_rcvd(struct socket *so, int flags)
295 struct netmsg_pru_rcvd msg;
298 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_RCVD);
299 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
301 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_rcvd;
303 msg.nm_flags = flags;
304 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
309 so_pru_rcvoob(struct socket *so, struct mbuf *m, int flags)
312 struct netmsg_pru_rcvoob msg;
315 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_RCVOOB);
316 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
318 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_rcvoob;
321 msg.nm_flags = flags;
322 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
327 so_pru_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *addr,
328 struct mbuf *control, struct thread *td)
331 struct netmsg_pru_send msg;
334 port = so->so_proto->pr_mport(so, addr, &m, PRU_SEND);
340 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
342 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_send;
344 msg.nm_flags = flags;
347 msg.nm_control = control;
349 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
357 so_pru_sense(struct socket *so, struct stat *sb)
360 struct netmsg_pru_sense msg;
363 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_SENSE);
364 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
366 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_sense;
369 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
374 so_pru_shutdown(struct socket *so)
377 struct netmsg_pru_shutdown msg;
380 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_SHUTDOWN);
381 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
382 netmsg_pru_shutdown);
383 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_shutdown;
385 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
390 so_pru_sockaddr(struct socket *so, struct sockaddr **nam)
393 struct netmsg_pru_sockaddr msg;
396 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_SOCKADDR);
397 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
398 netmsg_pru_sockaddr);
399 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_sockaddr;
402 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
407 so_pru_sopoll(struct socket *so, int events, struct ucred *cred)
410 struct netmsg_pru_sopoll msg;
413 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_SOPOLL);
414 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
416 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_sopoll;
418 msg.nm_events = events;
420 msg.nm_td = curthread;
421 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
426 so_pru_ctloutput(struct socket *so, struct sockopt *sopt)
428 struct netmsg_pru_ctloutput msg;
432 KKASSERT(!sopt->sopt_val || kva_p(sopt->sopt_val));
433 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_CTLOUTPUT);
434 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
435 netmsg_pru_ctloutput);
436 /* TBD: move pr_ctloutput to pr_usrreqs */
437 msg.nm_prufn = so->so_proto->pr_ctloutput;
440 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
445 * Protocol control input, typically via icmp.
447 * If the protocol pr_ctlport is not NULL we call it to figure out the
448 * protocol port. If NULL is returned we can just return, otherwise
449 * we issue a netmsg to call pr_ctlinput in the proper thread.
451 * This must be done synchronously as arg and/or extra may point to
455 so_pru_ctlinput(struct protosw *pr, int cmd, struct sockaddr *arg, void *extra)
457 struct netmsg_pru_ctlinput msg;
460 if (pr->pr_ctlport == NULL)
462 KKASSERT(pr->pr_ctlinput != NULL);
463 port = pr->pr_ctlport(cmd, arg, extra);
466 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
467 netmsg_pru_ctlinput);
468 msg.nm_prufn = pr->pr_ctlinput;
471 msg.nm_extra = extra;
472 lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
476 * If we convert all the protosw pr_ functions for all the protocols
477 * to take a message directly, this layer can go away. For the moment
478 * our dispatcher ignores the return value, but since we are handling
479 * the replymsg ourselves we return EASYNC by convention.
483 * Abort and destroy a socket.
486 netmsg_pru_abort(netmsg_t msg)
488 struct netmsg_pru_abort *nm = (void *)msg;
489 struct socket *so = nm->nm_so;
492 KKASSERT(so->so_state & SS_ABORTING);
493 so->so_state &= ~SS_ABORTING;
494 error = nm->nm_prufn(so);
497 lwkt_replymsg(&msg->nm_lmsg, error);
502 netmsg_pru_accept(netmsg_t msg)
504 struct netmsg_pru_accept *nm = (void *)msg;
506 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_nam));
511 netmsg_pru_attach(netmsg_t msg)
513 struct netmsg_pru_attach *nm = (void *)msg;
515 lwkt_replymsg(&msg->nm_lmsg,
516 nm->nm_prufn(nm->nm_so, nm->nm_proto, nm->nm_ai));
520 netmsg_pru_bind(netmsg_t msg)
522 struct netmsg_pru_bind *nm = (void *)msg;
524 lwkt_replymsg(&msg->nm_lmsg,
525 nm->nm_prufn(nm->nm_so, nm->nm_nam, nm->nm_td));
529 netmsg_pru_connect(netmsg_t msg)
531 struct netmsg_pru_connect *nm = (void *)msg;
533 lwkt_replymsg(&msg->nm_lmsg,
534 nm->nm_prufn(nm->nm_so, nm->nm_nam, nm->nm_td));
538 netmsg_pru_connect2(netmsg_t msg)
540 struct netmsg_pru_connect2 *nm = (void *)msg;
542 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so1, nm->nm_so2));
546 netmsg_pru_control(netmsg_t msg)
548 struct netmsg_pru_control *nm = (void *)msg;
551 error = nm->nm_prufn(nm->nm_so, nm->nm_cmd, nm->nm_data,
552 nm->nm_ifp, nm->nm_td);
553 lwkt_replymsg(&msg->nm_lmsg, error);
557 netmsg_pru_detach(netmsg_t msg)
559 struct netmsg_pru_detach *nm = (void *)msg;
561 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so));
565 netmsg_pru_disconnect(netmsg_t msg)
567 struct netmsg_pru_disconnect *nm = (void *)msg;
569 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so));
573 netmsg_pru_listen(netmsg_t msg)
575 struct netmsg_pru_listen *nm = (void *)msg;
577 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_td));
581 netmsg_pru_peeraddr(netmsg_t msg)
583 struct netmsg_pru_peeraddr *nm = (void *)msg;
585 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_nam));
589 netmsg_pru_rcvd(netmsg_t msg)
591 struct netmsg_pru_rcvd *nm = (void *)msg;
593 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_flags));
597 netmsg_pru_rcvoob(netmsg_t msg)
599 struct netmsg_pru_rcvoob *nm = (void *)msg;
601 lwkt_replymsg(&msg->nm_lmsg,
602 nm->nm_prufn(nm->nm_so, nm->nm_m, nm->nm_flags));
606 netmsg_pru_send(netmsg_t msg)
608 struct netmsg_pru_send *nm = (void *)msg;
611 error = nm->nm_prufn(nm->nm_so, nm->nm_flags, nm->nm_m,
612 nm->nm_addr, nm->nm_control, nm->nm_td);
613 lwkt_replymsg(&msg->nm_lmsg, error);
617 netmsg_pru_sense(netmsg_t msg)
619 struct netmsg_pru_sense *nm = (void *)msg;
621 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_stat));
625 netmsg_pru_shutdown(netmsg_t msg)
627 struct netmsg_pru_shutdown *nm = (void *)msg;
629 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so));
633 netmsg_pru_sockaddr(netmsg_t msg)
635 struct netmsg_pru_sockaddr *nm = (void *)msg;
637 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_nam));
641 netmsg_pru_sopoll(netmsg_t msg)
643 struct netmsg_pru_sopoll *nm = (void *)msg;
646 error = nm->nm_prufn(nm->nm_so, nm->nm_events, nm->nm_cred, nm->nm_td);
647 lwkt_replymsg(&msg->nm_lmsg, error);
651 netmsg_pru_ctloutput(netmsg_t msg)
653 struct netmsg_pru_ctloutput *nm = (void *)msg;
655 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_sopt));
659 netmsg_pru_ctlinput(netmsg_t msg)
661 struct netmsg_pru_ctlinput *nm = (void *)msg;
663 nm->nm_prufn(nm->nm_cmd, nm->nm_arg, nm->nm_extra);
664 lwkt_replymsg(&nm->nm_netmsg.nm_lmsg, 0);
668 netmsg_pr_timeout(netmsg_t msg)
670 struct netmsg_pr_timeout *nm = (void *)msg;
672 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prfn());
676 * Handle a predicate event request. This function is only called once
677 * when the predicate message queueing request is received.
680 netmsg_so_notify(netmsg_t netmsg)
682 struct netmsg_so_notify *msg = (void *)netmsg;
683 struct signalsockbuf *ssb;
685 ssb = (msg->nm_etype & NM_REVENT) ?
686 &msg->nm_so->so_rcv :
690 * Reply immediately if the event has occured, otherwise queue the
693 if (msg->nm_predicate(&msg->nm_netmsg)) {
694 lwkt_replymsg(&msg->nm_netmsg.nm_lmsg,
695 msg->nm_netmsg.nm_lmsg.ms_error);
697 TAILQ_INSERT_TAIL(&ssb->ssb_sel.si_mlist, msg, nm_list);
698 ssb->ssb_flags |= SSB_MEVENT;
703 * Called by doio when trying to abort a netmsg_so_notify message.
704 * Unlike the other functions this one is dispatched directly by
705 * the LWKT subsystem, so it takes a lwkt_msg_t as an argument.
707 * The original message, lmsg, is under the control of the caller and
708 * will not be destroyed until we return so we can safely reference it
709 * in our synchronous abort request.
711 * This part of the abort request occurs on the originating cpu which
712 * means we may race the message flags and the original message may
713 * not even have been processed by the target cpu yet.
716 netmsg_so_notify_doabort(lwkt_msg_t lmsg)
718 struct netmsg_so_notify_abort msg;
720 if ((lmsg->ms_flags & (MSGF_DONE | MSGF_REPLY)) == 0) {
721 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
722 netmsg_so_notify_abort);
723 msg.nm_notifymsg = (void *)lmsg;
724 lwkt_domsg(lmsg->ms_target_port, &msg.nm_netmsg.nm_lmsg, 0);
729 * Predicate requests can be aborted. This function is only called once
730 * and will interlock against processing/reply races (since such races
731 * occur on the same thread that controls the port where the abort is
734 * This part of the abort request occurs on the target cpu. The message
735 * flags must be tested again in case the test that we did on the
736 * originating cpu raced. Since messages are handled in sequence, the
737 * original message will have already been handled by the loop and either
738 * replied to or queued.
740 * We really only need to interlock with MSGF_REPLY (a bit that is set on
741 * our cpu when we reply). Note that MSGF_DONE is not set until the
742 * reply reaches the originating cpu. Test both bits anyway.
745 netmsg_so_notify_abort(netmsg_t netmsg)
747 struct netmsg_so_notify_abort *abrtmsg = (void *)netmsg;
748 struct netmsg_so_notify *msg = abrtmsg->nm_notifymsg;
749 struct signalsockbuf *ssb;
752 * The original notify message is not destroyed until after the
753 * abort request is returned, so we can check its state.
755 if ((msg->nm_netmsg.nm_lmsg.ms_flags & (MSGF_DONE | MSGF_REPLY)) == 0) {
756 ssb = (msg->nm_etype & NM_REVENT) ?
757 &msg->nm_so->so_rcv :
759 TAILQ_REMOVE(&ssb->ssb_sel.si_mlist, msg, nm_list);
760 lwkt_replymsg(&msg->nm_netmsg.nm_lmsg, EINTR);
764 * Reply to the abort message
766 lwkt_replymsg(&abrtmsg->nm_netmsg.nm_lmsg, 0);