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 so_pru_accept(struct socket *so, struct sockaddr **nam)
98 /* Block (memory allocation) in process context. XXX JH */
99 return ((*so->so_proto->pr_usrreqs->pru_accept)(so, nam));
103 struct netmsg_pru_accept msg;
106 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_ACCEPT);
107 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
109 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_accept;
112 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
118 so_pru_attach(struct socket *so, int proto, struct pru_attach_info *ai)
121 struct netmsg_pru_attach msg;
124 port = so->so_proto->pr_mport(NULL, NULL, NULL, PRU_ATTACH);
125 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
127 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_attach;
129 msg.nm_proto = proto;
131 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
136 so_pru_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
139 struct netmsg_pru_bind msg;
142 /* Send mesg to thread for new address. */
143 port = so->so_proto->pr_mport(NULL, nam, NULL, PRU_BIND);
144 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
146 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_bind;
149 msg.nm_td = td; /* used only for prison_ip() XXX JH */
150 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
155 so_pru_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
158 struct netmsg_pru_connect msg;
161 port = so->so_proto->pr_mport(so, nam, NULL, PRU_CONNECT);
162 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
164 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_connect;
168 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
173 so_pru_connect2(struct socket *so1, struct socket *so2)
176 struct netmsg_pru_connect2 msg;
179 port = so1->so_proto->pr_mport(so1, NULL, NULL, PRU_CONNECT2);
180 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
181 netmsg_pru_connect2);
182 msg.nm_prufn = so1->so_proto->pr_usrreqs->pru_connect2;
185 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
190 so_pru_control(struct socket *so, u_long cmd, caddr_t data, struct ifnet *ifp)
192 return ((*so->so_proto->pr_usrreqs->pru_control)(so, cmd, data, ifp,
194 #ifdef gag /* does copyin and copyout deep inside stack XXX JH */
196 struct netmsg_pru_control msg;
199 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_CONTROL);
200 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
202 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_control;
208 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
214 so_pru_detach(struct socket *so)
217 struct netmsg_pru_detach msg;
220 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_DETACH);
221 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
223 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_detach;
225 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
230 so_pru_disconnect(struct socket *so)
233 struct netmsg_pru_disconnect msg;
236 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_DISCONNECT);
237 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
238 netmsg_pru_disconnect);
239 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_disconnect;
241 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
246 so_pru_listen(struct socket *so, struct thread *td)
249 struct netmsg_pru_listen msg;
252 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_LISTEN);
253 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
255 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_listen;
257 msg.nm_td = td; /* used only for prison_ip() XXX JH */
258 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
263 so_pru_peeraddr(struct socket *so, struct sockaddr **nam)
266 struct netmsg_pru_peeraddr msg;
269 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_PEERADDR);
270 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
271 netmsg_pru_peeraddr);
272 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_peeraddr;
275 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
280 so_pru_rcvd(struct socket *so, int flags)
283 struct netmsg_pru_rcvd msg;
286 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_RCVD);
287 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
289 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_rcvd;
291 msg.nm_flags = flags;
292 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
297 so_pru_rcvoob(struct socket *so, struct mbuf *m, int flags)
300 struct netmsg_pru_rcvoob msg;
303 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_RCVOOB);
304 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
306 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_rcvoob;
309 msg.nm_flags = flags;
310 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
315 so_pru_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *addr,
316 struct mbuf *control, struct thread *td)
319 struct netmsg_pru_send msg;
322 port = so->so_proto->pr_mport(so, addr, &m, PRU_SEND);
328 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
330 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_send;
332 msg.nm_flags = flags;
335 msg.nm_control = control;
337 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
342 so_pru_sense(struct socket *so, struct stat *sb)
345 struct netmsg_pru_sense msg;
348 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_SENSE);
349 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
351 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_sense;
354 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
359 so_pru_shutdown(struct socket *so)
362 struct netmsg_pru_shutdown msg;
365 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_SHUTDOWN);
366 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
367 netmsg_pru_shutdown);
368 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_shutdown;
370 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
375 so_pru_sockaddr(struct socket *so, struct sockaddr **nam)
378 struct netmsg_pru_sockaddr msg;
381 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_SOCKADDR);
382 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
383 netmsg_pru_sockaddr);
384 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_sockaddr;
387 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
392 so_pru_sopoll(struct socket *so, int events, struct ucred *cred)
395 struct netmsg_pru_sopoll msg;
398 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_SOPOLL);
399 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
401 msg.nm_prufn = so->so_proto->pr_usrreqs->pru_sopoll;
403 msg.nm_events = events;
405 msg.nm_td = curthread;
406 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
411 so_pru_ctloutput(struct socket *so, struct sockopt *sopt)
413 struct netmsg_pru_ctloutput msg;
417 KKASSERT(!sopt->sopt_val || kva_p(sopt->sopt_val));
418 port = so->so_proto->pr_mport(so, NULL, NULL, PRU_CTLOUTPUT);
419 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
420 netmsg_pru_ctloutput);
421 /* TBD: move pr_ctloutput to pr_usrreqs */
422 msg.nm_prufn = so->so_proto->pr_ctloutput;
425 error = lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
430 * Protocol control input, typically via icmp.
432 * If the protocol pr_ctlport is not NULL we call it to figure out the
433 * protocol port. If NULL is returned we can just return, otherwise
434 * we issue a netmsg to call pr_ctlinput in the proper thread.
436 * This must be done synchronously as arg and/or extra may point to
440 so_pru_ctlinput(struct protosw *pr, int cmd, struct sockaddr *arg, void *extra)
442 struct netmsg_pru_ctlinput msg;
445 if (pr->pr_ctlport == NULL)
447 KKASSERT(pr->pr_ctlinput != NULL);
448 port = pr->pr_ctlport(cmd, arg, extra);
451 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
452 netmsg_pru_ctlinput);
453 msg.nm_prufn = pr->pr_ctlinput;
456 msg.nm_extra = extra;
457 lwkt_domsg(port, &msg.nm_netmsg.nm_lmsg, 0);
461 * If we convert all the protosw pr_ functions for all the protocols
462 * to take a message directly, this layer can go away. For the moment
463 * our dispatcher ignores the return value, but since we are handling
464 * the replymsg ourselves we return EASYNC by convention.
468 * Abort and destroy a socket.
471 netmsg_pru_abort(netmsg_t msg)
473 struct netmsg_pru_abort *nm = (void *)msg;
474 struct socket *so = nm->nm_so;
477 KKASSERT(so->so_state & SS_ABORTING);
478 so->so_state &= ~SS_ABORTING;
479 error = nm->nm_prufn(so);
482 lwkt_replymsg(&msg->nm_lmsg, error);
487 netmsg_pru_accept(netmsg_t msg)
489 struct netmsg_pru_accept *nm = (void *)msg;
491 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_nam));
496 netmsg_pru_attach(netmsg_t msg)
498 struct netmsg_pru_attach *nm = (void *)msg;
500 lwkt_replymsg(&msg->nm_lmsg,
501 nm->nm_prufn(nm->nm_so, nm->nm_proto, nm->nm_ai));
505 netmsg_pru_bind(netmsg_t msg)
507 struct netmsg_pru_bind *nm = (void *)msg;
509 lwkt_replymsg(&msg->nm_lmsg,
510 nm->nm_prufn(nm->nm_so, nm->nm_nam, nm->nm_td));
514 netmsg_pru_connect(netmsg_t msg)
516 struct netmsg_pru_connect *nm = (void *)msg;
518 lwkt_replymsg(&msg->nm_lmsg,
519 nm->nm_prufn(nm->nm_so, nm->nm_nam, nm->nm_td));
523 netmsg_pru_connect2(netmsg_t msg)
525 struct netmsg_pru_connect2 *nm = (void *)msg;
527 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so1, nm->nm_so2));
531 netmsg_pru_control(netmsg_t msg)
533 struct netmsg_pru_control *nm = (void *)msg;
536 error = nm->nm_prufn(nm->nm_so, nm->nm_cmd, nm->nm_data,
537 nm->nm_ifp, nm->nm_td);
538 lwkt_replymsg(&msg->nm_lmsg, error);
542 netmsg_pru_detach(netmsg_t msg)
544 struct netmsg_pru_detach *nm = (void *)msg;
546 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so));
550 netmsg_pru_disconnect(netmsg_t msg)
552 struct netmsg_pru_disconnect *nm = (void *)msg;
554 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so));
558 netmsg_pru_listen(netmsg_t msg)
560 struct netmsg_pru_listen *nm = (void *)msg;
562 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_td));
566 netmsg_pru_peeraddr(netmsg_t msg)
568 struct netmsg_pru_peeraddr *nm = (void *)msg;
570 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_nam));
574 netmsg_pru_rcvd(netmsg_t msg)
576 struct netmsg_pru_rcvd *nm = (void *)msg;
578 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_flags));
582 netmsg_pru_rcvoob(netmsg_t msg)
584 struct netmsg_pru_rcvoob *nm = (void *)msg;
586 lwkt_replymsg(&msg->nm_lmsg,
587 nm->nm_prufn(nm->nm_so, nm->nm_m, nm->nm_flags));
591 netmsg_pru_send(netmsg_t msg)
593 struct netmsg_pru_send *nm = (void *)msg;
596 error = nm->nm_prufn(nm->nm_so, nm->nm_flags, nm->nm_m,
597 nm->nm_addr, nm->nm_control, nm->nm_td);
598 lwkt_replymsg(&msg->nm_lmsg, error);
602 netmsg_pru_sense(netmsg_t msg)
604 struct netmsg_pru_sense *nm = (void *)msg;
606 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_stat));
610 netmsg_pru_shutdown(netmsg_t msg)
612 struct netmsg_pru_shutdown *nm = (void *)msg;
614 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so));
618 netmsg_pru_sockaddr(netmsg_t msg)
620 struct netmsg_pru_sockaddr *nm = (void *)msg;
622 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_nam));
626 netmsg_pru_sopoll(netmsg_t msg)
628 struct netmsg_pru_sopoll *nm = (void *)msg;
631 error = nm->nm_prufn(nm->nm_so, nm->nm_events, nm->nm_cred, nm->nm_td);
632 lwkt_replymsg(&msg->nm_lmsg, error);
636 netmsg_pru_ctloutput(netmsg_t msg)
638 struct netmsg_pru_ctloutput *nm = (void *)msg;
640 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prufn(nm->nm_so, nm->nm_sopt));
644 netmsg_pru_ctlinput(netmsg_t msg)
646 struct netmsg_pru_ctlinput *nm = (void *)msg;
648 nm->nm_prufn(nm->nm_cmd, nm->nm_arg, nm->nm_extra);
649 lwkt_replymsg(&nm->nm_netmsg.nm_lmsg, 0);
653 netmsg_pr_timeout(netmsg_t msg)
655 struct netmsg_pr_timeout *nm = (void *)msg;
657 lwkt_replymsg(&msg->nm_lmsg, nm->nm_prfn());
661 * Handle a predicate event request. This function is only called once
662 * when the predicate message queueing request is received.
665 netmsg_so_notify(netmsg_t netmsg)
667 struct netmsg_so_notify *msg = (void *)netmsg;
668 struct signalsockbuf *ssb;
670 ssb = (msg->nm_etype & NM_REVENT) ?
671 &msg->nm_so->so_rcv :
675 * Reply immediately if the event has occured, otherwise queue the
678 if (msg->nm_predicate(&msg->nm_netmsg)) {
679 lwkt_replymsg(&msg->nm_netmsg.nm_lmsg,
680 msg->nm_netmsg.nm_lmsg.ms_error);
682 TAILQ_INSERT_TAIL(&ssb->ssb_sel.si_mlist, msg, nm_list);
683 ssb->ssb_flags |= SSB_MEVENT;
688 * Called by doio when trying to abort a netmsg_so_notify message.
689 * Unlike the other functions this one is dispatched directly by
690 * the LWKT subsystem, so it takes a lwkt_msg_t as an argument.
692 * The original message, lmsg, is under the control of the caller and
693 * will not be destroyed until we return so we can safely reference it
694 * in our synchronous abort request.
696 * This part of the abort request occurs on the originating cpu which
697 * means we may race the message flags and the original message may
698 * not even have been processed by the target cpu yet.
701 netmsg_so_notify_doabort(lwkt_msg_t lmsg)
703 struct netmsg_so_notify_abort msg;
705 if ((lmsg->ms_flags & (MSGF_DONE | MSGF_REPLY)) == 0) {
706 netmsg_init(&msg.nm_netmsg, &curthread->td_msgport, 0,
707 netmsg_so_notify_abort);
708 msg.nm_notifymsg = (void *)lmsg;
709 lwkt_domsg(lmsg->ms_target_port, &msg.nm_netmsg.nm_lmsg, 0);
714 * Predicate requests can be aborted. This function is only called once
715 * and will interlock against processing/reply races (since such races
716 * occur on the same thread that controls the port where the abort is
719 * This part of the abort request occurs on the target cpu. The message
720 * flags must be tested again in case the test that we did on the
721 * originating cpu raced. Since messages are handled in sequence, the
722 * original message will have already been handled by the loop and either
723 * replied to or queued.
725 * We really only need to interlock with MSGF_REPLY (a bit that is set on
726 * our cpu when we reply). Note that MSGF_DONE is not set until the
727 * reply reaches the originating cpu. Test both bits anyway.
730 netmsg_so_notify_abort(netmsg_t netmsg)
732 struct netmsg_so_notify_abort *abrtmsg = (void *)netmsg;
733 struct netmsg_so_notify *msg = abrtmsg->nm_notifymsg;
734 struct signalsockbuf *ssb;
737 * The original notify message is not destroyed until after the
738 * abort request is returned, so we can check its state.
740 if ((msg->nm_netmsg.nm_lmsg.ms_flags & (MSGF_DONE | MSGF_REPLY)) == 0) {
741 ssb = (msg->nm_etype & NM_REVENT) ?
742 &msg->nm_so->so_rcv :
744 TAILQ_REMOVE(&ssb->ssb_sel.si_mlist, msg, nm_list);
745 lwkt_replymsg(&msg->nm_netmsg.nm_lmsg, EINTR);
749 * Reply to the abort message
751 lwkt_replymsg(&abrtmsg->nm_netmsg.nm_lmsg, 0);