2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1990, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * @(#)sys_socket.c 8.1 (Berkeley) 6/10/93
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/systm.h>
40 #include <sys/domain.h>
42 #include <sys/filedesc.h>
43 #include <sys/kernel.h>
44 #include <sys/kthread.h>
45 #include <sys/malloc.h>
47 #include <sys/protosw.h>
48 #include <sys/sigio.h>
49 #include <sys/signal.h>
50 #include <sys/signalvar.h>
51 #include <sys/socket.h>
52 #include <sys/socketvar.h>
53 #include <sys/filio.h> /* XXX */
54 #include <sys/sockio.h>
56 #include <sys/sysctl.h>
57 #include <sys/sysproto.h>
58 #include <sys/taskqueue.h>
60 #include <sys/ucred.h>
62 #include <sys/unpcb.h>
66 #include <net/if_var.h>
67 #include <net/route.h>
70 #include <netinet/in.h>
71 #include <netinet/in_pcb.h>
73 #include <security/mac/mac_framework.h>
77 #include <vm/vm_extern.h>
78 #include <vm/vm_map.h>
80 static SYSCTL_NODE(_kern_ipc, OID_AUTO, aio, CTLFLAG_RD | CTLFLAG_MPSAFE, NULL,
83 static int empty_results;
84 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, empty_results, CTLFLAG_RD, &empty_results,
85 0, "socket operation returned EAGAIN");
87 static int empty_retries;
88 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, empty_retries, CTLFLAG_RD, &empty_retries,
89 0, "socket operation retries");
91 static fo_rdwr_t soo_read;
92 static fo_rdwr_t soo_write;
93 static fo_ioctl_t soo_ioctl;
94 static fo_poll_t soo_poll;
95 extern fo_kqfilter_t soo_kqfilter;
96 static fo_stat_t soo_stat;
97 static fo_close_t soo_close;
98 static fo_fill_kinfo_t soo_fill_kinfo;
99 static fo_aio_queue_t soo_aio_queue;
101 static void soo_aio_cancel(struct kaiocb *job);
103 struct fileops socketops = {
105 .fo_write = soo_write,
106 .fo_truncate = invfo_truncate,
107 .fo_ioctl = soo_ioctl,
109 .fo_kqfilter = soo_kqfilter,
111 .fo_close = soo_close,
112 .fo_chmod = invfo_chmod,
113 .fo_chown = invfo_chown,
114 .fo_sendfile = invfo_sendfile,
115 .fo_fill_kinfo = soo_fill_kinfo,
116 .fo_aio_queue = soo_aio_queue,
117 .fo_flags = DFLAG_PASSABLE
121 soo_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
122 int flags, struct thread *td)
124 struct socket *so = fp->f_data;
128 error = mac_socket_check_receive(active_cred, so);
132 error = soreceive(so, 0, uio, 0, 0, 0);
137 soo_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
138 int flags, struct thread *td)
140 struct socket *so = fp->f_data;
144 error = mac_socket_check_send(active_cred, so);
148 error = sosend(so, 0, uio, 0, 0, 0, uio->uio_td);
149 if (error == EPIPE && (so->so_options & SO_NOSIGPIPE) == 0) {
150 PROC_LOCK(uio->uio_td->td_proc);
151 tdsignal(uio->uio_td, SIGPIPE);
152 PROC_UNLOCK(uio->uio_td->td_proc);
158 soo_ioctl(struct file *fp, u_long cmd, void *data, struct ucred *active_cred,
161 struct socket *so = fp->f_data;
168 so->so_state |= SS_NBIO;
170 so->so_state &= ~SS_NBIO;
177 so->so_state |= SS_ASYNC;
178 if (SOLISTENING(so)) {
179 so->sol_sbrcv_flags |= SB_ASYNC;
180 so->sol_sbsnd_flags |= SB_ASYNC;
182 SOCKBUF_LOCK(&so->so_rcv);
183 so->so_rcv.sb_flags |= SB_ASYNC;
184 SOCKBUF_UNLOCK(&so->so_rcv);
185 SOCKBUF_LOCK(&so->so_snd);
186 so->so_snd.sb_flags |= SB_ASYNC;
187 SOCKBUF_UNLOCK(&so->so_snd);
192 so->so_state &= ~SS_ASYNC;
193 if (SOLISTENING(so)) {
194 so->sol_sbrcv_flags &= ~SB_ASYNC;
195 so->sol_sbsnd_flags &= ~SB_ASYNC;
197 SOCKBUF_LOCK(&so->so_rcv);
198 so->so_rcv.sb_flags &= ~SB_ASYNC;
199 SOCKBUF_UNLOCK(&so->so_rcv);
200 SOCKBUF_LOCK(&so->so_snd);
201 so->so_snd.sb_flags &= ~SB_ASYNC;
202 SOCKBUF_UNLOCK(&so->so_snd);
210 if (SOLISTENING(so)) {
213 *(int *)data = sbavail(&so->so_rcv);
219 if (SOLISTENING(so)) {
222 *(int *)data = sbavail(&so->so_snd);
228 if (SOLISTENING(so)) {
231 if ((so->so_snd.sb_hiwat < sbused(&so->so_snd)) ||
232 (so->so_snd.sb_mbmax < so->so_snd.sb_mbcnt)) {
235 *(int *)data = sbspace(&so->so_snd);
241 error = fsetown(*(int *)data, &so->so_sigio);
245 *(int *)data = fgetown(&so->so_sigio);
249 error = fsetown(-(*(int *)data), &so->so_sigio);
253 *(int *)data = -fgetown(&so->so_sigio);
258 if (SOLISTENING(so)) {
261 *(int *)data = (so->so_rcv.sb_state & SBS_RCVATMARK) != 0;
266 * Interface/routing/protocol specific ioctls: interface and
267 * routing ioctls should have a different entry since a
268 * socket is unnecessary.
270 if (IOCGROUP(cmd) == 'i')
271 error = ifioctl(so, cmd, data, td);
272 else if (IOCGROUP(cmd) == 'r') {
273 CURVNET_SET(so->so_vnet);
274 error = rtioctl_fib(cmd, data, so->so_fibnum);
277 CURVNET_SET(so->so_vnet);
278 error = ((*so->so_proto->pr_usrreqs->pru_control)
279 (so, cmd, data, 0, td));
288 soo_poll(struct file *fp, int events, struct ucred *active_cred,
291 struct socket *so = fp->f_data;
295 error = mac_socket_check_poll(active_cred, so);
299 return (sopoll(so, events, fp->f_cred, td));
303 soo_stat(struct file *fp, struct stat *ub, struct ucred *active_cred,
306 struct socket *so = fp->f_data;
309 bzero((caddr_t)ub, sizeof (*ub));
310 ub->st_mode = S_IFSOCK;
312 error = mac_socket_check_stat(active_cred, so);
317 if (!SOLISTENING(so)) {
321 * If SBS_CANTRCVMORE is set, but there's still data left
322 * in the receive buffer, the socket is still readable.
326 if ((sb->sb_state & SBS_CANTRCVMORE) == 0 || sbavail(sb))
327 ub->st_mode |= S_IRUSR | S_IRGRP | S_IROTH;
328 ub->st_size = sbavail(sb) - sb->sb_ctl;
333 if ((sb->sb_state & SBS_CANTSENDMORE) == 0)
334 ub->st_mode |= S_IWUSR | S_IWGRP | S_IWOTH;
337 ub->st_uid = so->so_cred->cr_uid;
338 ub->st_gid = so->so_cred->cr_gid;
339 error = so->so_proto->pr_usrreqs->pru_sense(so, ub);
345 * API socket close on file pointer. We call soclose() to close the socket
346 * (including initiating closing protocols). soclose() will sorele() the
347 * file reference but the actual socket will not go away until the socket's
351 soo_close(struct file *fp, struct thread *td)
357 fp->f_ops = &badfileops;
366 soo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
374 kif->kf_type = KF_TYPE_SOCKET;
376 CURVNET_SET(so->so_vnet);
377 kif->kf_un.kf_sock.kf_sock_domain0 =
378 so->so_proto->pr_domain->dom_family;
379 kif->kf_un.kf_sock.kf_sock_type0 = so->so_type;
380 kif->kf_un.kf_sock.kf_sock_protocol0 = so->so_proto->pr_protocol;
381 kif->kf_un.kf_sock.kf_sock_pcb = (uintptr_t)so->so_pcb;
382 switch (kif->kf_un.kf_sock.kf_sock_domain0) {
385 if (kif->kf_un.kf_sock.kf_sock_protocol0 == IPPROTO_TCP) {
386 if (so->so_pcb != NULL) {
387 inpcb = (struct inpcb *)(so->so_pcb);
388 kif->kf_un.kf_sock.kf_sock_inpcb =
389 (uintptr_t)inpcb->inp_ppcb;
390 kif->kf_un.kf_sock.kf_sock_sendq =
392 kif->kf_un.kf_sock.kf_sock_recvq =
398 if (so->so_pcb != NULL) {
399 unpcb = (struct unpcb *)(so->so_pcb);
400 if (unpcb->unp_conn) {
401 kif->kf_un.kf_sock.kf_sock_unpconn =
402 (uintptr_t)unpcb->unp_conn;
403 kif->kf_un.kf_sock.kf_sock_rcv_sb_state =
405 kif->kf_un.kf_sock.kf_sock_snd_sb_state =
407 kif->kf_un.kf_sock.kf_sock_sendq =
409 kif->kf_un.kf_sock.kf_sock_recvq =
415 error = so->so_proto->pr_usrreqs->pru_sockaddr(so, &sa);
417 sa->sa_len <= sizeof(kif->kf_un.kf_sock.kf_sa_local)) {
418 bcopy(sa, &kif->kf_un.kf_sock.kf_sa_local, sa->sa_len);
421 error = so->so_proto->pr_usrreqs->pru_peeraddr(so, &sa);
423 sa->sa_len <= sizeof(kif->kf_un.kf_sock.kf_sa_peer)) {
424 bcopy(sa, &kif->kf_un.kf_sock.kf_sa_peer, sa->sa_len);
427 strncpy(kif->kf_path, so->so_proto->pr_domain->dom_name,
428 sizeof(kif->kf_path));
434 * Use the 'backend3' field in AIO jobs to store the amount of data
435 * completed by the AIO job so far.
437 #define aio_done backend3
439 static STAILQ_HEAD(, task) soaio_jobs;
440 static struct mtx soaio_jobs_lock;
441 static struct task soaio_kproc_task;
442 static int soaio_starting, soaio_idle, soaio_queued;
443 static struct unrhdr *soaio_kproc_unr;
445 static int soaio_max_procs = MAX_AIO_PROCS;
446 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, max_procs, CTLFLAG_RW, &soaio_max_procs, 0,
447 "Maximum number of kernel processes to use for async socket IO");
449 static int soaio_num_procs;
450 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, num_procs, CTLFLAG_RD, &soaio_num_procs, 0,
451 "Number of active kernel processes for async socket IO");
453 static int soaio_target_procs = TARGET_AIO_PROCS;
454 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, target_procs, CTLFLAG_RD,
455 &soaio_target_procs, 0,
456 "Preferred number of ready kernel processes for async socket IO");
458 static int soaio_lifetime;
459 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, lifetime, CTLFLAG_RW, &soaio_lifetime, 0,
460 "Maximum lifetime for idle aiod");
463 soaio_kproc_loop(void *arg)
466 struct vmspace *myvm;
468 int error, id, pending;
473 * Grab an extra reference on the daemon's vmspace so that it
474 * doesn't get freed by jobs that switch to a different
478 myvm = vmspace_acquire_ref(p);
480 mtx_lock(&soaio_jobs_lock);
481 MPASS(soaio_starting > 0);
484 while (!STAILQ_EMPTY(&soaio_jobs)) {
485 task = STAILQ_FIRST(&soaio_jobs);
486 STAILQ_REMOVE_HEAD(&soaio_jobs, ta_link);
488 pending = task->ta_pending;
489 task->ta_pending = 0;
490 mtx_unlock(&soaio_jobs_lock);
492 task->ta_func(task->ta_context, pending);
494 mtx_lock(&soaio_jobs_lock);
496 MPASS(soaio_queued == 0);
498 if (p->p_vmspace != myvm) {
499 mtx_unlock(&soaio_jobs_lock);
500 vmspace_switch_aio(myvm);
501 mtx_lock(&soaio_jobs_lock);
506 error = mtx_sleep(&soaio_idle, &soaio_jobs_lock, 0, "-",
509 if (error == EWOULDBLOCK && STAILQ_EMPTY(&soaio_jobs) &&
510 soaio_num_procs > soaio_target_procs)
514 mtx_unlock(&soaio_jobs_lock);
515 free_unr(soaio_kproc_unr, id);
520 soaio_kproc_create(void *context, int pending)
525 mtx_lock(&soaio_jobs_lock);
527 if (soaio_num_procs < soaio_target_procs) {
529 } else if (soaio_num_procs >= soaio_max_procs) {
531 * Hit the limit on kernel processes, don't
532 * create another one.
535 } else if (soaio_queued <= soaio_idle + soaio_starting) {
537 * No more AIO jobs waiting for a process to be
543 mtx_unlock(&soaio_jobs_lock);
545 id = alloc_unr(soaio_kproc_unr);
546 error = kproc_create(soaio_kproc_loop, (void *)(intptr_t)id,
547 &p, 0, 0, "soaiod%d", id);
549 free_unr(soaio_kproc_unr, id);
550 mtx_lock(&soaio_jobs_lock);
555 mtx_lock(&soaio_jobs_lock);
558 mtx_unlock(&soaio_jobs_lock);
562 soaio_enqueue(struct task *task)
565 mtx_lock(&soaio_jobs_lock);
566 MPASS(task->ta_pending == 0);
568 STAILQ_INSERT_TAIL(&soaio_jobs, task, ta_link);
570 if (soaio_queued <= soaio_idle)
571 wakeup_one(&soaio_idle);
572 else if (soaio_num_procs < soaio_max_procs)
573 taskqueue_enqueue(taskqueue_thread, &soaio_kproc_task);
574 mtx_unlock(&soaio_jobs_lock);
581 soaio_lifetime = AIOD_LIFETIME_DEFAULT;
582 STAILQ_INIT(&soaio_jobs);
583 mtx_init(&soaio_jobs_lock, "soaio jobs", NULL, MTX_DEF);
584 soaio_kproc_unr = new_unrhdr(1, INT_MAX, NULL);
585 TASK_INIT(&soaio_kproc_task, 0, soaio_kproc_create, NULL);
586 if (soaio_target_procs > 0)
587 taskqueue_enqueue(taskqueue_thread, &soaio_kproc_task);
589 SYSINIT(soaio, SI_SUB_VFS, SI_ORDER_ANY, soaio_init, NULL);
592 soaio_ready(struct socket *so, struct sockbuf *sb)
594 return (sb == &so->so_rcv ? soreadable(so) : sowriteable(so));
598 soaio_process_job(struct socket *so, struct sockbuf *sb, struct kaiocb *job)
600 struct ucred *td_savedcred;
610 aio_switch_vmspace(job);
614 td_savedcred = td->td_ucred;
615 td->td_ucred = job->cred;
617 done = job->aio_done;
618 cnt = job->uaiocb.aio_nbytes - done;
619 iov.iov_base = (void *)((uintptr_t)job->uaiocb.aio_buf + done);
625 uio.uio_segflg = UIO_USERSPACE;
630 * For resource usage accounting, only count a completed request
631 * as a single message to avoid counting multiple calls to
632 * sosend/soreceive on a blocking socket.
635 if (sb == &so->so_rcv) {
636 uio.uio_rw = UIO_READ;
637 ru_before = td->td_ru.ru_msgrcv;
639 error = mac_socket_check_receive(fp->f_cred, so);
643 error = soreceive(so, NULL, &uio, NULL, NULL, &flags);
644 if (td->td_ru.ru_msgrcv != ru_before)
647 if (!TAILQ_EMPTY(&sb->sb_aiojobq))
648 flags |= MSG_MORETOCOME;
649 uio.uio_rw = UIO_WRITE;
650 ru_before = td->td_ru.ru_msgsnd;
652 error = mac_socket_check_send(fp->f_cred, so);
655 error = sosend(so, NULL, &uio, NULL, NULL, flags, td);
656 if (td->td_ru.ru_msgsnd != ru_before)
658 if (error == EPIPE && (so->so_options & SO_NOSIGPIPE) == 0) {
659 PROC_LOCK(job->userproc);
660 kern_psignal(job->userproc, SIGPIPE);
661 PROC_UNLOCK(job->userproc);
665 done += cnt - uio.uio_resid;
666 job->aio_done = done;
667 td->td_ucred = td_savedcred;
669 if (error == EWOULDBLOCK) {
671 * The request was either partially completed or not
672 * completed at all due to racing with a read() or
673 * write() on the socket. If the socket is
674 * non-blocking, return with any partial completion.
675 * If the socket is blocking or if no progress has
676 * been made, requeue this request at the head of the
677 * queue to try again when the socket is ready.
679 MPASS(done != job->uaiocb.aio_nbytes);
681 if (done == 0 || !(so->so_state & SS_NBIO)) {
683 if (soaio_ready(so, sb)) {
689 if (!aio_set_cancel_function(job, soo_aio_cancel)) {
692 aio_complete(job, done, 0);
697 TAILQ_INSERT_HEAD(&sb->sb_aiojobq, job, list);
703 if (done != 0 && (error == ERESTART || error == EINTR ||
704 error == EWOULDBLOCK))
707 aio_complete(job, -1, error);
709 aio_complete(job, done, 0);
714 soaio_process_sb(struct socket *so, struct sockbuf *sb)
718 CURVNET_SET(so->so_vnet);
720 while (!TAILQ_EMPTY(&sb->sb_aiojobq) && soaio_ready(so, sb)) {
721 job = TAILQ_FIRST(&sb->sb_aiojobq);
722 TAILQ_REMOVE(&sb->sb_aiojobq, job, list);
723 if (!aio_clear_cancel_function(job))
726 soaio_process_job(so, sb, job);
730 * If there are still pending requests, the socket must not be
731 * ready so set SB_AIO to request a wakeup when the socket
734 if (!TAILQ_EMPTY(&sb->sb_aiojobq))
735 sb->sb_flags |= SB_AIO;
736 sb->sb_flags &= ~SB_AIO_RUNNING;
745 soaio_rcv(void *context, int pending)
750 soaio_process_sb(so, &so->so_rcv);
754 soaio_snd(void *context, int pending)
759 soaio_process_sb(so, &so->so_snd);
763 sowakeup_aio(struct socket *so, struct sockbuf *sb)
766 SOCKBUF_LOCK_ASSERT(sb);
767 sb->sb_flags &= ~SB_AIO;
768 if (sb->sb_flags & SB_AIO_RUNNING)
770 sb->sb_flags |= SB_AIO_RUNNING;
772 soaio_enqueue(&sb->sb_aiotask);
776 soo_aio_cancel(struct kaiocb *job)
783 so = job->fd_file->f_data;
784 opcode = job->uaiocb.aio_lio_opcode;
785 if (opcode == LIO_READ)
788 MPASS(opcode == LIO_WRITE);
793 if (!aio_cancel_cleared(job))
794 TAILQ_REMOVE(&sb->sb_aiojobq, job, list);
795 if (TAILQ_EMPTY(&sb->sb_aiojobq))
796 sb->sb_flags &= ~SB_AIO;
799 done = job->aio_done;
801 aio_complete(job, done, 0);
807 soo_aio_queue(struct file *fp, struct kaiocb *job)
814 error = (*so->so_proto->pr_usrreqs->pru_aio_queue)(so, job);
818 switch (job->uaiocb.aio_lio_opcode) {
830 if (!aio_set_cancel_function(job, soo_aio_cancel))
831 panic("new job was cancelled");
832 TAILQ_INSERT_TAIL(&sb->sb_aiojobq, job, list);
833 if (!(sb->sb_flags & SB_AIO_RUNNING)) {
834 if (soaio_ready(so, sb))
835 sowakeup_aio(so, sb);
837 sb->sb_flags |= SB_AIO;