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, 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 *(int *)data = sbavail(&so->so_rcv);
215 *(int *)data = sbavail(&so->so_snd);
220 if ((so->so_snd.sb_hiwat < sbused(&so->so_snd)) ||
221 (so->so_snd.sb_mbmax < so->so_snd.sb_mbcnt))
224 *(int *)data = sbspace(&so->so_snd);
228 error = fsetown(*(int *)data, &so->so_sigio);
232 *(int *)data = fgetown(&so->so_sigio);
236 error = fsetown(-(*(int *)data), &so->so_sigio);
240 *(int *)data = -fgetown(&so->so_sigio);
245 *(int *)data = (so->so_rcv.sb_state & SBS_RCVATMARK) != 0;
249 * Interface/routing/protocol specific ioctls: interface and
250 * routing ioctls should have a different entry since a
251 * socket is unnecessary.
253 if (IOCGROUP(cmd) == 'i')
254 error = ifioctl(so, cmd, data, td);
255 else if (IOCGROUP(cmd) == 'r') {
256 CURVNET_SET(so->so_vnet);
257 error = rtioctl_fib(cmd, data, so->so_fibnum);
260 CURVNET_SET(so->so_vnet);
261 error = ((*so->so_proto->pr_usrreqs->pru_control)
262 (so, cmd, data, 0, td));
271 soo_poll(struct file *fp, int events, struct ucred *active_cred,
274 struct socket *so = fp->f_data;
278 error = mac_socket_check_poll(active_cred, so);
282 return (sopoll(so, events, fp->f_cred, td));
286 soo_stat(struct file *fp, struct stat *ub, struct ucred *active_cred,
289 struct socket *so = fp->f_data;
294 bzero((caddr_t)ub, sizeof (*ub));
295 ub->st_mode = S_IFSOCK;
297 error = mac_socket_check_stat(active_cred, so);
301 if (!SOLISTENING(so)) {
305 * If SBS_CANTRCVMORE is set, but there's still data left
306 * in the receive buffer, the socket is still readable.
310 if ((sb->sb_state & SBS_CANTRCVMORE) == 0 || sbavail(sb))
311 ub->st_mode |= S_IRUSR | S_IRGRP | S_IROTH;
312 ub->st_size = sbavail(sb) - sb->sb_ctl;
317 if ((sb->sb_state & SBS_CANTSENDMORE) == 0)
318 ub->st_mode |= S_IWUSR | S_IWGRP | S_IWOTH;
321 ub->st_uid = so->so_cred->cr_uid;
322 ub->st_gid = so->so_cred->cr_gid;
323 return (*so->so_proto->pr_usrreqs->pru_sense)(so, ub);
327 * API socket close on file pointer. We call soclose() to close the socket
328 * (including initiating closing protocols). soclose() will sorele() the
329 * file reference but the actual socket will not go away until the socket's
333 soo_close(struct file *fp, struct thread *td)
339 fp->f_ops = &badfileops;
348 soo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
356 kif->kf_type = KF_TYPE_SOCKET;
358 CURVNET_SET(so->so_vnet);
359 kif->kf_un.kf_sock.kf_sock_domain0 =
360 so->so_proto->pr_domain->dom_family;
361 kif->kf_un.kf_sock.kf_sock_type0 = so->so_type;
362 kif->kf_un.kf_sock.kf_sock_protocol0 = so->so_proto->pr_protocol;
363 kif->kf_un.kf_sock.kf_sock_pcb = (uintptr_t)so->so_pcb;
364 switch (kif->kf_un.kf_sock.kf_sock_domain0) {
367 if (kif->kf_un.kf_sock.kf_sock_protocol0 == IPPROTO_TCP) {
368 if (so->so_pcb != NULL) {
369 inpcb = (struct inpcb *)(so->so_pcb);
370 kif->kf_un.kf_sock.kf_sock_inpcb =
371 (uintptr_t)inpcb->inp_ppcb;
372 kif->kf_un.kf_sock.kf_sock_sendq =
374 kif->kf_un.kf_sock.kf_sock_recvq =
380 if (so->so_pcb != NULL) {
381 unpcb = (struct unpcb *)(so->so_pcb);
382 if (unpcb->unp_conn) {
383 kif->kf_un.kf_sock.kf_sock_unpconn =
384 (uintptr_t)unpcb->unp_conn;
385 kif->kf_un.kf_sock.kf_sock_rcv_sb_state =
387 kif->kf_un.kf_sock.kf_sock_snd_sb_state =
389 kif->kf_un.kf_sock.kf_sock_sendq =
391 kif->kf_un.kf_sock.kf_sock_recvq =
397 error = so->so_proto->pr_usrreqs->pru_sockaddr(so, &sa);
399 sa->sa_len <= sizeof(kif->kf_un.kf_sock.kf_sa_local)) {
400 bcopy(sa, &kif->kf_un.kf_sock.kf_sa_local, sa->sa_len);
403 error = so->so_proto->pr_usrreqs->pru_peeraddr(so, &sa);
405 sa->sa_len <= sizeof(kif->kf_un.kf_sock.kf_sa_peer)) {
406 bcopy(sa, &kif->kf_un.kf_sock.kf_sa_peer, sa->sa_len);
409 strncpy(kif->kf_path, so->so_proto->pr_domain->dom_name,
410 sizeof(kif->kf_path));
416 * Use the 'backend3' field in AIO jobs to store the amount of data
417 * completed by the AIO job so far.
419 #define aio_done backend3
421 static STAILQ_HEAD(, task) soaio_jobs;
422 static struct mtx soaio_jobs_lock;
423 static struct task soaio_kproc_task;
424 static int soaio_starting, soaio_idle, soaio_queued;
425 static struct unrhdr *soaio_kproc_unr;
427 static int soaio_max_procs = MAX_AIO_PROCS;
428 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, max_procs, CTLFLAG_RW, &soaio_max_procs, 0,
429 "Maximum number of kernel processes to use for async socket IO");
431 static int soaio_num_procs;
432 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, num_procs, CTLFLAG_RD, &soaio_num_procs, 0,
433 "Number of active kernel processes for async socket IO");
435 static int soaio_target_procs = TARGET_AIO_PROCS;
436 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, target_procs, CTLFLAG_RD,
437 &soaio_target_procs, 0,
438 "Preferred number of ready kernel processes for async socket IO");
440 static int soaio_lifetime;
441 SYSCTL_INT(_kern_ipc_aio, OID_AUTO, lifetime, CTLFLAG_RW, &soaio_lifetime, 0,
442 "Maximum lifetime for idle aiod");
445 soaio_kproc_loop(void *arg)
448 struct vmspace *myvm;
450 int error, id, pending;
455 * Grab an extra reference on the daemon's vmspace so that it
456 * doesn't get freed by jobs that switch to a different
460 myvm = vmspace_acquire_ref(p);
462 mtx_lock(&soaio_jobs_lock);
463 MPASS(soaio_starting > 0);
466 while (!STAILQ_EMPTY(&soaio_jobs)) {
467 task = STAILQ_FIRST(&soaio_jobs);
468 STAILQ_REMOVE_HEAD(&soaio_jobs, ta_link);
470 pending = task->ta_pending;
471 task->ta_pending = 0;
472 mtx_unlock(&soaio_jobs_lock);
474 task->ta_func(task->ta_context, pending);
476 mtx_lock(&soaio_jobs_lock);
478 MPASS(soaio_queued == 0);
480 if (p->p_vmspace != myvm) {
481 mtx_unlock(&soaio_jobs_lock);
482 vmspace_switch_aio(myvm);
483 mtx_lock(&soaio_jobs_lock);
488 error = mtx_sleep(&soaio_idle, &soaio_jobs_lock, 0, "-",
491 if (error == EWOULDBLOCK && STAILQ_EMPTY(&soaio_jobs) &&
492 soaio_num_procs > soaio_target_procs)
496 mtx_unlock(&soaio_jobs_lock);
497 free_unr(soaio_kproc_unr, id);
502 soaio_kproc_create(void *context, int pending)
507 mtx_lock(&soaio_jobs_lock);
509 if (soaio_num_procs < soaio_target_procs) {
511 } else if (soaio_num_procs >= soaio_max_procs) {
513 * Hit the limit on kernel processes, don't
514 * create another one.
517 } else if (soaio_queued <= soaio_idle + soaio_starting) {
519 * No more AIO jobs waiting for a process to be
525 mtx_unlock(&soaio_jobs_lock);
527 id = alloc_unr(soaio_kproc_unr);
528 error = kproc_create(soaio_kproc_loop, (void *)(intptr_t)id,
529 &p, 0, 0, "soaiod%d", id);
531 free_unr(soaio_kproc_unr, id);
532 mtx_lock(&soaio_jobs_lock);
537 mtx_lock(&soaio_jobs_lock);
540 mtx_unlock(&soaio_jobs_lock);
544 soaio_enqueue(struct task *task)
547 mtx_lock(&soaio_jobs_lock);
548 MPASS(task->ta_pending == 0);
550 STAILQ_INSERT_TAIL(&soaio_jobs, task, ta_link);
552 if (soaio_queued <= soaio_idle)
553 wakeup_one(&soaio_idle);
554 else if (soaio_num_procs < soaio_max_procs)
555 taskqueue_enqueue(taskqueue_thread, &soaio_kproc_task);
556 mtx_unlock(&soaio_jobs_lock);
563 soaio_lifetime = AIOD_LIFETIME_DEFAULT;
564 STAILQ_INIT(&soaio_jobs);
565 mtx_init(&soaio_jobs_lock, "soaio jobs", NULL, MTX_DEF);
566 soaio_kproc_unr = new_unrhdr(1, INT_MAX, NULL);
567 TASK_INIT(&soaio_kproc_task, 0, soaio_kproc_create, NULL);
568 if (soaio_target_procs > 0)
569 taskqueue_enqueue(taskqueue_thread, &soaio_kproc_task);
571 SYSINIT(soaio, SI_SUB_VFS, SI_ORDER_ANY, soaio_init, NULL);
574 soaio_ready(struct socket *so, struct sockbuf *sb)
576 return (sb == &so->so_rcv ? soreadable(so) : sowriteable(so));
580 soaio_process_job(struct socket *so, struct sockbuf *sb, struct kaiocb *job)
582 struct ucred *td_savedcred;
592 aio_switch_vmspace(job);
596 td_savedcred = td->td_ucred;
597 td->td_ucred = job->cred;
599 done = job->aio_done;
600 cnt = job->uaiocb.aio_nbytes - done;
601 iov.iov_base = (void *)((uintptr_t)job->uaiocb.aio_buf + done);
607 uio.uio_segflg = UIO_USERSPACE;
612 * For resource usage accounting, only count a completed request
613 * as a single message to avoid counting multiple calls to
614 * sosend/soreceive on a blocking socket.
617 if (sb == &so->so_rcv) {
618 uio.uio_rw = UIO_READ;
619 ru_before = td->td_ru.ru_msgrcv;
621 error = mac_socket_check_receive(fp->f_cred, so);
625 error = soreceive(so, NULL, &uio, NULL, NULL, &flags);
626 if (td->td_ru.ru_msgrcv != ru_before)
629 if (!TAILQ_EMPTY(&sb->sb_aiojobq))
630 flags |= MSG_MORETOCOME;
631 uio.uio_rw = UIO_WRITE;
632 ru_before = td->td_ru.ru_msgsnd;
634 error = mac_socket_check_send(fp->f_cred, so);
637 error = sosend(so, NULL, &uio, NULL, NULL, flags, td);
638 if (td->td_ru.ru_msgsnd != ru_before)
640 if (error == EPIPE && (so->so_options & SO_NOSIGPIPE) == 0) {
641 PROC_LOCK(job->userproc);
642 kern_psignal(job->userproc, SIGPIPE);
643 PROC_UNLOCK(job->userproc);
647 done += cnt - uio.uio_resid;
648 job->aio_done = done;
649 td->td_ucred = td_savedcred;
651 if (error == EWOULDBLOCK) {
653 * The request was either partially completed or not
654 * completed at all due to racing with a read() or
655 * write() on the socket. If the socket is
656 * non-blocking, return with any partial completion.
657 * If the socket is blocking or if no progress has
658 * been made, requeue this request at the head of the
659 * queue to try again when the socket is ready.
661 MPASS(done != job->uaiocb.aio_nbytes);
663 if (done == 0 || !(so->so_state & SS_NBIO)) {
665 if (soaio_ready(so, sb)) {
671 if (!aio_set_cancel_function(job, soo_aio_cancel)) {
674 aio_complete(job, done, 0);
679 TAILQ_INSERT_HEAD(&sb->sb_aiojobq, job, list);
685 if (done != 0 && (error == ERESTART || error == EINTR ||
686 error == EWOULDBLOCK))
689 aio_complete(job, -1, error);
691 aio_complete(job, done, 0);
696 soaio_process_sb(struct socket *so, struct sockbuf *sb)
700 CURVNET_SET(so->so_vnet);
702 while (!TAILQ_EMPTY(&sb->sb_aiojobq) && soaio_ready(so, sb)) {
703 job = TAILQ_FIRST(&sb->sb_aiojobq);
704 TAILQ_REMOVE(&sb->sb_aiojobq, job, list);
705 if (!aio_clear_cancel_function(job))
708 soaio_process_job(so, sb, job);
712 * If there are still pending requests, the socket must not be
713 * ready so set SB_AIO to request a wakeup when the socket
716 if (!TAILQ_EMPTY(&sb->sb_aiojobq))
717 sb->sb_flags |= SB_AIO;
718 sb->sb_flags &= ~SB_AIO_RUNNING;
727 soaio_rcv(void *context, int pending)
732 soaio_process_sb(so, &so->so_rcv);
736 soaio_snd(void *context, int pending)
741 soaio_process_sb(so, &so->so_snd);
745 sowakeup_aio(struct socket *so, struct sockbuf *sb)
748 SOCKBUF_LOCK_ASSERT(sb);
749 sb->sb_flags &= ~SB_AIO;
750 if (sb->sb_flags & SB_AIO_RUNNING)
752 sb->sb_flags |= SB_AIO_RUNNING;
754 soaio_enqueue(&sb->sb_aiotask);
758 soo_aio_cancel(struct kaiocb *job)
765 so = job->fd_file->f_data;
766 opcode = job->uaiocb.aio_lio_opcode;
767 if (opcode == LIO_READ)
770 MPASS(opcode == LIO_WRITE);
775 if (!aio_cancel_cleared(job))
776 TAILQ_REMOVE(&sb->sb_aiojobq, job, list);
777 if (TAILQ_EMPTY(&sb->sb_aiojobq))
778 sb->sb_flags &= ~SB_AIO;
781 done = job->aio_done;
783 aio_complete(job, done, 0);
789 soo_aio_queue(struct file *fp, struct kaiocb *job)
796 error = (*so->so_proto->pr_usrreqs->pru_aio_queue)(so, job);
800 switch (job->uaiocb.aio_lio_opcode) {
812 if (!aio_set_cancel_function(job, soo_aio_cancel))
813 panic("new job was cancelled");
814 TAILQ_INSERT_TAIL(&sb->sb_aiojobq, job, list);
815 if (!(sb->sb_flags & SB_AIO_RUNNING)) {
816 if (soaio_ready(so, sb))
817 sowakeup_aio(so, sb);
819 sb->sb_flags |= SB_AIO;