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);
209 SOCK_RECVBUF_LOCK(so);
210 if (SOLISTENING(so)) {
213 *(int *)data = sbavail(&so->so_rcv) - so->so_rcv.sb_ctl;
215 SOCK_RECVBUF_UNLOCK(so);
220 if (SOLISTENING(so)) {
223 *(int *)data = sbavail(&so->so_snd);
229 if (SOLISTENING(so)) {
232 if ((so->so_snd.sb_hiwat < sbused(&so->so_snd)) ||
233 (so->so_snd.sb_mbmax < so->so_snd.sb_mbcnt)) {
236 *(int *)data = sbspace(&so->so_snd);
242 error = fsetown(*(int *)data, &so->so_sigio);
246 *(int *)data = fgetown(&so->so_sigio);
250 error = fsetown(-(*(int *)data), &so->so_sigio);
254 *(int *)data = -fgetown(&so->so_sigio);
259 if (SOLISTENING(so)) {
262 *(int *)data = (so->so_rcv.sb_state & SBS_RCVATMARK) != 0;
267 * Interface/routing/protocol specific ioctls: interface and
268 * routing ioctls should have a different entry since a
269 * socket is unnecessary.
271 if (IOCGROUP(cmd) == 'i')
272 error = ifioctl(so, cmd, data, td);
273 else if (IOCGROUP(cmd) == 'r') {
274 CURVNET_SET(so->so_vnet);
275 error = rtioctl_fib(cmd, data, so->so_fibnum);
278 CURVNET_SET(so->so_vnet);
279 error = ((*so->so_proto->pr_usrreqs->pru_control)
280 (so, cmd, data, 0, td));
289 soo_poll(struct file *fp, int events, struct ucred *active_cred,
292 struct socket *so = fp->f_data;
296 error = mac_socket_check_poll(active_cred, so);
300 return (sopoll(so, events, fp->f_cred, td));
304 soo_stat(struct file *fp, struct stat *ub, struct ucred *active_cred,
307 struct socket *so = fp->f_data;
310 bzero((caddr_t)ub, sizeof (*ub));
311 ub->st_mode = S_IFSOCK;
313 error = mac_socket_check_stat(active_cred, so);
318 if (!SOLISTENING(so)) {
322 * If SBS_CANTRCVMORE is set, but there's still data left
323 * in the receive buffer, the socket is still readable.
327 if ((sb->sb_state & SBS_CANTRCVMORE) == 0 || sbavail(sb))
328 ub->st_mode |= S_IRUSR | S_IRGRP | S_IROTH;
329 ub->st_size = sbavail(sb) - sb->sb_ctl;
334 if ((sb->sb_state & SBS_CANTSENDMORE) == 0)
335 ub->st_mode |= S_IWUSR | S_IWGRP | S_IWOTH;
338 ub->st_uid = so->so_cred->cr_uid;
339 ub->st_gid = so->so_cred->cr_gid;
340 error = so->so_proto->pr_usrreqs->pru_sense(so, ub);
346 * API socket close on file pointer. We call soclose() to close the socket
347 * (including initiating closing protocols). soclose() will sorele() the
348 * file reference but the actual socket will not go away until the socket's
352 soo_close(struct file *fp, struct thread *td)
358 fp->f_ops = &badfileops;
367 soo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
375 kif->kf_type = KF_TYPE_SOCKET;
377 CURVNET_SET(so->so_vnet);
378 kif->kf_un.kf_sock.kf_sock_domain0 =
379 so->so_proto->pr_domain->dom_family;
380 kif->kf_un.kf_sock.kf_sock_type0 = so->so_type;
381 kif->kf_un.kf_sock.kf_sock_protocol0 = so->so_proto->pr_protocol;
382 kif->kf_un.kf_sock.kf_sock_pcb = (uintptr_t)so->so_pcb;
383 switch (kif->kf_un.kf_sock.kf_sock_domain0) {
386 if (kif->kf_un.kf_sock.kf_sock_protocol0 == IPPROTO_TCP) {
387 if (so->so_pcb != NULL) {
388 inpcb = (struct inpcb *)(so->so_pcb);
389 kif->kf_un.kf_sock.kf_sock_inpcb =
390 (uintptr_t)inpcb->inp_ppcb;
391 kif->kf_un.kf_sock.kf_sock_sendq =
393 kif->kf_un.kf_sock.kf_sock_recvq =
399 if (so->so_pcb != NULL) {
400 unpcb = (struct unpcb *)(so->so_pcb);
401 if (unpcb->unp_conn) {
402 kif->kf_un.kf_sock.kf_sock_unpconn =
403 (uintptr_t)unpcb->unp_conn;
404 kif->kf_un.kf_sock.kf_sock_rcv_sb_state =
406 kif->kf_un.kf_sock.kf_sock_snd_sb_state =
408 kif->kf_un.kf_sock.kf_sock_sendq =
410 kif->kf_un.kf_sock.kf_sock_recvq =
416 error = so->so_proto->pr_usrreqs->pru_sockaddr(so, &sa);
418 sa->sa_len <= sizeof(kif->kf_un.kf_sock.kf_sa_local)) {
419 bcopy(sa, &kif->kf_un.kf_sock.kf_sa_local, sa->sa_len);
422 error = so->so_proto->pr_usrreqs->pru_peeraddr(so, &sa);
424 sa->sa_len <= sizeof(kif->kf_un.kf_sock.kf_sa_peer)) {
425 bcopy(sa, &kif->kf_un.kf_sock.kf_sa_peer, sa->sa_len);
428 strncpy(kif->kf_path, so->so_proto->pr_domain->dom_name,
429 sizeof(kif->kf_path));
435 * Use the 'backend3' field in AIO jobs to store the amount of data
436 * completed by the AIO job so far.
438 #define aio_done backend3
440 static STAILQ_HEAD(, task) soaio_jobs;
441 static struct mtx soaio_jobs_lock;
442 static struct task soaio_kproc_task;
443 static int soaio_starting, soaio_idle, soaio_queued;
444 static struct unrhdr *soaio_kproc_unr;
446 static int soaio_max_procs = MAX_AIO_PROCS;
447 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, max_procs, CTLFLAG_RW, &soaio_max_procs, 0,
448 "Maximum number of kernel processes to use for async socket IO");
450 static int soaio_num_procs;
451 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, num_procs, CTLFLAG_RD, &soaio_num_procs, 0,
452 "Number of active kernel processes for async socket IO");
454 static int soaio_target_procs = TARGET_AIO_PROCS;
455 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, target_procs, CTLFLAG_RD,
456 &soaio_target_procs, 0,
457 "Preferred number of ready kernel processes for async socket IO");
459 static int soaio_lifetime;
460 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, lifetime, CTLFLAG_RW, &soaio_lifetime, 0,
461 "Maximum lifetime for idle aiod");
464 soaio_kproc_loop(void *arg)
467 struct vmspace *myvm;
469 int error, id, pending;
474 * Grab an extra reference on the daemon's vmspace so that it
475 * doesn't get freed by jobs that switch to a different
479 myvm = vmspace_acquire_ref(p);
481 mtx_lock(&soaio_jobs_lock);
482 MPASS(soaio_starting > 0);
485 while (!STAILQ_EMPTY(&soaio_jobs)) {
486 task = STAILQ_FIRST(&soaio_jobs);
487 STAILQ_REMOVE_HEAD(&soaio_jobs, ta_link);
489 pending = task->ta_pending;
490 task->ta_pending = 0;
491 mtx_unlock(&soaio_jobs_lock);
493 task->ta_func(task->ta_context, pending);
495 mtx_lock(&soaio_jobs_lock);
497 MPASS(soaio_queued == 0);
499 if (p->p_vmspace != myvm) {
500 mtx_unlock(&soaio_jobs_lock);
501 vmspace_switch_aio(myvm);
502 mtx_lock(&soaio_jobs_lock);
507 error = mtx_sleep(&soaio_idle, &soaio_jobs_lock, 0, "-",
510 if (error == EWOULDBLOCK && STAILQ_EMPTY(&soaio_jobs) &&
511 soaio_num_procs > soaio_target_procs)
515 mtx_unlock(&soaio_jobs_lock);
516 free_unr(soaio_kproc_unr, id);
521 soaio_kproc_create(void *context, int pending)
526 mtx_lock(&soaio_jobs_lock);
528 if (soaio_num_procs < soaio_target_procs) {
530 } else if (soaio_num_procs >= soaio_max_procs) {
532 * Hit the limit on kernel processes, don't
533 * create another one.
536 } else if (soaio_queued <= soaio_idle + soaio_starting) {
538 * No more AIO jobs waiting for a process to be
544 mtx_unlock(&soaio_jobs_lock);
546 id = alloc_unr(soaio_kproc_unr);
547 error = kproc_create(soaio_kproc_loop, (void *)(intptr_t)id,
548 &p, 0, 0, "soaiod%d", id);
550 free_unr(soaio_kproc_unr, id);
551 mtx_lock(&soaio_jobs_lock);
556 mtx_lock(&soaio_jobs_lock);
559 mtx_unlock(&soaio_jobs_lock);
563 soaio_enqueue(struct task *task)
566 mtx_lock(&soaio_jobs_lock);
567 MPASS(task->ta_pending == 0);
569 STAILQ_INSERT_TAIL(&soaio_jobs, task, ta_link);
571 if (soaio_queued <= soaio_idle)
572 wakeup_one(&soaio_idle);
573 else if (soaio_num_procs < soaio_max_procs)
574 taskqueue_enqueue(taskqueue_thread, &soaio_kproc_task);
575 mtx_unlock(&soaio_jobs_lock);
582 soaio_lifetime = AIOD_LIFETIME_DEFAULT;
583 STAILQ_INIT(&soaio_jobs);
584 mtx_init(&soaio_jobs_lock, "soaio jobs", NULL, MTX_DEF);
585 soaio_kproc_unr = new_unrhdr(1, INT_MAX, NULL);
586 TASK_INIT(&soaio_kproc_task, 0, soaio_kproc_create, NULL);
587 if (soaio_target_procs > 0)
588 taskqueue_enqueue(taskqueue_thread, &soaio_kproc_task);
590 SYSINIT(soaio, SI_SUB_VFS, SI_ORDER_ANY, soaio_init, NULL);
593 soaio_ready(struct socket *so, struct sockbuf *sb)
595 return (sb == &so->so_rcv ? soreadable(so) : sowriteable(so));
599 soaio_process_job(struct socket *so, struct sockbuf *sb, struct kaiocb *job)
601 struct ucred *td_savedcred;
604 size_t cnt, done, job_total_nbytes;
609 aio_switch_vmspace(job);
613 td_savedcred = td->td_ucred;
614 td->td_ucred = job->cred;
616 job_total_nbytes = job->uiop->uio_resid + job->aio_done;
617 done = job->aio_done;
618 cnt = job->uiop->uio_resid;
619 job->uiop->uio_offset = 0;
620 job->uiop->uio_td = td;
624 * For resource usage accounting, only count a completed request
625 * as a single message to avoid counting multiple calls to
626 * sosend/soreceive on a blocking socket.
629 if (sb == &so->so_rcv) {
630 ru_before = td->td_ru.ru_msgrcv;
632 error = mac_socket_check_receive(fp->f_cred, so);
636 error = soreceive(so, NULL, job->uiop, NULL, NULL,
638 if (td->td_ru.ru_msgrcv != ru_before)
641 if (!TAILQ_EMPTY(&sb->sb_aiojobq))
642 flags |= MSG_MORETOCOME;
643 ru_before = td->td_ru.ru_msgsnd;
645 error = mac_socket_check_send(fp->f_cred, so);
648 error = sosend(so, NULL, job->uiop, NULL, NULL, flags,
650 if (td->td_ru.ru_msgsnd != ru_before)
652 if (error == EPIPE && (so->so_options & SO_NOSIGPIPE) == 0) {
653 PROC_LOCK(job->userproc);
654 kern_psignal(job->userproc, SIGPIPE);
655 PROC_UNLOCK(job->userproc);
659 done += cnt - job->uiop->uio_resid;
660 job->aio_done = done;
661 td->td_ucred = td_savedcred;
663 if (error == EWOULDBLOCK) {
665 * The request was either partially completed or not
666 * completed at all due to racing with a read() or
667 * write() on the socket. If the socket is
668 * non-blocking, return with any partial completion.
669 * If the socket is blocking or if no progress has
670 * been made, requeue this request at the head of the
671 * queue to try again when the socket is ready.
673 MPASS(done != job_total_nbytes);
675 if (done == 0 || !(so->so_state & SS_NBIO)) {
677 if (soaio_ready(so, sb)) {
683 if (!aio_set_cancel_function(job, soo_aio_cancel)) {
686 aio_complete(job, done, 0);
691 TAILQ_INSERT_HEAD(&sb->sb_aiojobq, job, list);
697 if (done != 0 && (error == ERESTART || error == EINTR ||
698 error == EWOULDBLOCK))
701 aio_complete(job, -1, error);
703 aio_complete(job, done, 0);
708 soaio_process_sb(struct socket *so, struct sockbuf *sb)
712 CURVNET_SET(so->so_vnet);
714 while (!TAILQ_EMPTY(&sb->sb_aiojobq) && soaio_ready(so, sb)) {
715 job = TAILQ_FIRST(&sb->sb_aiojobq);
716 TAILQ_REMOVE(&sb->sb_aiojobq, job, list);
717 if (!aio_clear_cancel_function(job))
720 soaio_process_job(so, sb, job);
724 * If there are still pending requests, the socket must not be
725 * ready so set SB_AIO to request a wakeup when the socket
728 if (!TAILQ_EMPTY(&sb->sb_aiojobq))
729 sb->sb_flags |= SB_AIO;
730 sb->sb_flags &= ~SB_AIO_RUNNING;
739 soaio_rcv(void *context, int pending)
744 soaio_process_sb(so, &so->so_rcv);
748 soaio_snd(void *context, int pending)
753 soaio_process_sb(so, &so->so_snd);
757 sowakeup_aio(struct socket *so, struct sockbuf *sb)
760 SOCKBUF_LOCK_ASSERT(sb);
761 sb->sb_flags &= ~SB_AIO;
762 if (sb->sb_flags & SB_AIO_RUNNING)
764 sb->sb_flags |= SB_AIO_RUNNING;
766 soaio_enqueue(&sb->sb_aiotask);
770 soo_aio_cancel(struct kaiocb *job)
777 so = job->fd_file->f_data;
778 opcode = job->uaiocb.aio_lio_opcode;
779 if (opcode & LIO_READ)
782 MPASS(opcode & LIO_WRITE);
787 if (!aio_cancel_cleared(job))
788 TAILQ_REMOVE(&sb->sb_aiojobq, job, list);
789 if (TAILQ_EMPTY(&sb->sb_aiojobq))
790 sb->sb_flags &= ~SB_AIO;
793 done = job->aio_done;
795 aio_complete(job, done, 0);
801 soo_aio_queue(struct file *fp, struct kaiocb *job)
808 error = (*so->so_proto->pr_usrreqs->pru_aio_queue)(so, job);
812 /* Lock through the socket, since this may be a listening socket. */
813 switch (job->uaiocb.aio_lio_opcode & (LIO_WRITE | LIO_READ)) {
816 SOCK_RECVBUF_LOCK(so);
820 SOCK_SENDBUF_LOCK(so);
826 if (SOLISTENING(so)) {
827 if (sb == &so->so_rcv)
828 SOCK_RECVBUF_UNLOCK(so);
830 SOCK_SENDBUF_UNLOCK(so);
834 if (!aio_set_cancel_function(job, soo_aio_cancel))
835 panic("new job was cancelled");
836 TAILQ_INSERT_TAIL(&sb->sb_aiojobq, job, list);
837 if (!(sb->sb_flags & SB_AIO_RUNNING)) {
838 if (soaio_ready(so, sb))
839 sowakeup_aio(so, sb);
841 sb->sb_flags |= SB_AIO;