Home | History | Annotate | Line # | Download | only in kern
sys_select.c revision 1.21.4.1
      1  1.21.4.1     rmind /*	$NetBSD: sys_select.c,v 1.21.4.1 2010/05/30 05:17:58 rmind Exp $	*/
      2       1.1        ad 
      3       1.1        ad /*-
      4  1.21.4.1     rmind  * Copyright (c) 2007, 2008, 2009, 2010 The NetBSD Foundation, Inc.
      5       1.1        ad  * All rights reserved.
      6       1.1        ad  *
      7       1.1        ad  * This code is derived from software contributed to The NetBSD Foundation
      8       1.1        ad  * by Andrew Doran.
      9       1.1        ad  *
     10       1.1        ad  * Redistribution and use in source and binary forms, with or without
     11       1.1        ad  * modification, are permitted provided that the following conditions
     12       1.1        ad  * are met:
     13       1.1        ad  * 1. Redistributions of source code must retain the above copyright
     14       1.1        ad  *    notice, this list of conditions and the following disclaimer.
     15       1.1        ad  * 2. Redistributions in binary form must reproduce the above copyright
     16       1.1        ad  *    notice, this list of conditions and the following disclaimer in the
     17       1.1        ad  *    documentation and/or other materials provided with the distribution.
     18       1.1        ad  *
     19       1.1        ad  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20       1.1        ad  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21       1.1        ad  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22       1.1        ad  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23       1.1        ad  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24       1.1        ad  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25       1.1        ad  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26       1.1        ad  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27       1.1        ad  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28       1.1        ad  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29       1.1        ad  * POSSIBILITY OF SUCH DAMAGE.
     30       1.1        ad  */
     31       1.1        ad 
     32       1.1        ad /*
     33       1.1        ad  * Copyright (c) 1982, 1986, 1989, 1993
     34       1.1        ad  *	The Regents of the University of California.  All rights reserved.
     35       1.1        ad  * (c) UNIX System Laboratories, Inc.
     36       1.1        ad  * All or some portions of this file are derived from material licensed
     37       1.1        ad  * to the University of California by American Telephone and Telegraph
     38       1.1        ad  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
     39       1.1        ad  * the permission of UNIX System Laboratories, Inc.
     40       1.1        ad  *
     41       1.1        ad  * Redistribution and use in source and binary forms, with or without
     42       1.1        ad  * modification, are permitted provided that the following conditions
     43       1.1        ad  * are met:
     44       1.1        ad  * 1. Redistributions of source code must retain the above copyright
     45       1.1        ad  *    notice, this list of conditions and the following disclaimer.
     46       1.1        ad  * 2. Redistributions in binary form must reproduce the above copyright
     47       1.1        ad  *    notice, this list of conditions and the following disclaimer in the
     48       1.1        ad  *    documentation and/or other materials provided with the distribution.
     49       1.1        ad  * 3. Neither the name of the University nor the names of its contributors
     50       1.1        ad  *    may be used to endorse or promote products derived from this software
     51       1.1        ad  *    without specific prior written permission.
     52       1.1        ad  *
     53       1.1        ad  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     54       1.1        ad  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     55       1.1        ad  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     56       1.1        ad  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     57       1.1        ad  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     58       1.1        ad  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     59       1.1        ad  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     60       1.1        ad  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     61       1.1        ad  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     62       1.1        ad  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     63       1.1        ad  * SUCH DAMAGE.
     64       1.1        ad  *
     65       1.1        ad  *	@(#)sys_generic.c	8.9 (Berkeley) 2/14/95
     66       1.1        ad  */
     67       1.1        ad 
     68       1.1        ad /*
     69      1.21     rmind  * System calls of synchronous I/O multiplexing subsystem.
     70      1.21     rmind  *
     71      1.21     rmind  * Locking
     72      1.21     rmind  *
     73  1.21.4.1     rmind  * Two locks are used: <object-lock> and selcluster_t::sc_lock.
     74      1.21     rmind  *
     75      1.21     rmind  * The <object-lock> might be a device driver or another subsystem, e.g.
     76      1.21     rmind  * socket or pipe.  This lock is not exported, and thus invisible to this
     77      1.21     rmind  * subsystem.  Mainly, synchronisation between selrecord() and selnotify()
     78      1.21     rmind  * routines depends on this lock, as it will be described in the comments.
     79      1.21     rmind  *
     80      1.21     rmind  * Lock order
     81      1.21     rmind  *
     82      1.21     rmind  *	<object-lock> ->
     83  1.21.4.1     rmind  *		selcluster_t::sc_lock
     84       1.1        ad  */
     85       1.1        ad 
     86       1.1        ad #include <sys/cdefs.h>
     87  1.21.4.1     rmind __KERNEL_RCSID(0, "$NetBSD: sys_select.c,v 1.21.4.1 2010/05/30 05:17:58 rmind Exp $");
     88       1.1        ad 
     89       1.1        ad #include <sys/param.h>
     90       1.1        ad #include <sys/systm.h>
     91       1.1        ad #include <sys/filedesc.h>
     92       1.1        ad #include <sys/ioctl.h>
     93       1.1        ad #include <sys/file.h>
     94       1.1        ad #include <sys/proc.h>
     95       1.1        ad #include <sys/socketvar.h>
     96       1.1        ad #include <sys/signalvar.h>
     97       1.1        ad #include <sys/uio.h>
     98       1.1        ad #include <sys/kernel.h>
     99       1.1        ad #include <sys/stat.h>
    100       1.1        ad #include <sys/poll.h>
    101       1.1        ad #include <sys/vnode.h>
    102       1.1        ad #include <sys/mount.h>
    103       1.1        ad #include <sys/syscallargs.h>
    104       1.1        ad #include <sys/cpu.h>
    105       1.1        ad #include <sys/atomic.h>
    106       1.1        ad #include <sys/socketvar.h>
    107       1.1        ad #include <sys/sleepq.h>
    108       1.1        ad 
    109       1.1        ad /* Flags for lwp::l_selflag. */
    110       1.1        ad #define	SEL_RESET	0	/* awoken, interrupted, or not yet polling */
    111       1.1        ad #define	SEL_SCANNING	1	/* polling descriptors */
    112       1.1        ad #define	SEL_BLOCKING	2	/* about to block on select_cv */
    113       1.1        ad 
    114  1.21.4.1     rmind /*
    115  1.21.4.1     rmind  * Per-cluster state for select()/poll().  For a system with fewer
    116  1.21.4.1     rmind  * than 32 CPUs, this gives us per-CPU clusters.
    117  1.21.4.1     rmind  */
    118  1.21.4.1     rmind #define	SELCLUSTERS	32
    119  1.21.4.1     rmind #define	SELCLUSTERMASK	(SELCLUSTERS - 1)
    120  1.21.4.1     rmind 
    121  1.21.4.1     rmind typedef struct selcluster {
    122      1.13        ad 	kmutex_t	*sc_lock;
    123       1.1        ad 	sleepq_t	sc_sleepq;
    124       1.1        ad 	int		sc_ncoll;
    125       1.1        ad 	uint32_t	sc_mask;
    126  1.21.4.1     rmind } selcluster_t;
    127       1.1        ad 
    128      1.19     rmind static inline int	selscan(char *, u_int, register_t *);
    129      1.19     rmind static inline int	pollscan(struct pollfd *, u_int, register_t *);
    130      1.19     rmind static void		selclear(void);
    131       1.1        ad 
    132       1.1        ad static syncobj_t select_sobj = {
    133       1.1        ad 	SOBJ_SLEEPQ_FIFO,
    134       1.1        ad 	sleepq_unsleep,
    135       1.1        ad 	sleepq_changepri,
    136       1.1        ad 	sleepq_lendpri,
    137       1.1        ad 	syncobj_noowner,
    138       1.1        ad };
    139       1.1        ad 
    140  1.21.4.1     rmind static selcluster_t	*selcluster[SELCLUSTERS];
    141  1.21.4.1     rmind 
    142       1.1        ad /*
    143       1.1        ad  * Select system call.
    144       1.1        ad  */
    145       1.1        ad int
    146      1.12  christos sys___pselect50(struct lwp *l, const struct sys___pselect50_args *uap,
    147      1.12  christos     register_t *retval)
    148       1.1        ad {
    149       1.1        ad 	/* {
    150       1.1        ad 		syscallarg(int)				nd;
    151       1.1        ad 		syscallarg(fd_set *)			in;
    152       1.1        ad 		syscallarg(fd_set *)			ou;
    153       1.1        ad 		syscallarg(fd_set *)			ex;
    154       1.1        ad 		syscallarg(const struct timespec *)	ts;
    155       1.1        ad 		syscallarg(sigset_t *)			mask;
    156       1.1        ad 	} */
    157      1.14  christos 	struct timespec	ats, *ts = NULL;
    158       1.1        ad 	sigset_t	amask, *mask = NULL;
    159       1.1        ad 	int		error;
    160       1.1        ad 
    161       1.1        ad 	if (SCARG(uap, ts)) {
    162       1.1        ad 		error = copyin(SCARG(uap, ts), &ats, sizeof(ats));
    163       1.1        ad 		if (error)
    164       1.1        ad 			return error;
    165      1.14  christos 		ts = &ats;
    166       1.1        ad 	}
    167       1.1        ad 	if (SCARG(uap, mask) != NULL) {
    168       1.1        ad 		error = copyin(SCARG(uap, mask), &amask, sizeof(amask));
    169       1.1        ad 		if (error)
    170       1.1        ad 			return error;
    171       1.1        ad 		mask = &amask;
    172       1.1        ad 	}
    173       1.1        ad 
    174      1.19     rmind 	return selcommon(retval, SCARG(uap, nd), SCARG(uap, in),
    175      1.14  christos 	    SCARG(uap, ou), SCARG(uap, ex), ts, mask);
    176       1.1        ad }
    177       1.1        ad 
    178       1.1        ad int
    179      1.12  christos sys___select50(struct lwp *l, const struct sys___select50_args *uap,
    180      1.12  christos     register_t *retval)
    181       1.1        ad {
    182       1.1        ad 	/* {
    183       1.1        ad 		syscallarg(int)			nd;
    184       1.1        ad 		syscallarg(fd_set *)		in;
    185       1.1        ad 		syscallarg(fd_set *)		ou;
    186       1.1        ad 		syscallarg(fd_set *)		ex;
    187       1.1        ad 		syscallarg(struct timeval *)	tv;
    188       1.1        ad 	} */
    189      1.14  christos 	struct timeval atv;
    190      1.14  christos 	struct timespec ats, *ts = NULL;
    191       1.1        ad 	int error;
    192       1.1        ad 
    193       1.1        ad 	if (SCARG(uap, tv)) {
    194      1.14  christos 		error = copyin(SCARG(uap, tv), (void *)&atv, sizeof(atv));
    195       1.1        ad 		if (error)
    196       1.1        ad 			return error;
    197      1.14  christos 		TIMEVAL_TO_TIMESPEC(&atv, &ats);
    198      1.14  christos 		ts = &ats;
    199       1.1        ad 	}
    200       1.1        ad 
    201      1.19     rmind 	return selcommon(retval, SCARG(uap, nd), SCARG(uap, in),
    202      1.14  christos 	    SCARG(uap, ou), SCARG(uap, ex), ts, NULL);
    203       1.1        ad }
    204       1.1        ad 
    205      1.17     rmind /*
    206      1.17     rmind  * sel_do_scan: common code to perform the scan on descriptors.
    207      1.17     rmind  */
    208      1.17     rmind static int
    209      1.17     rmind sel_do_scan(void *fds, u_int nfds, struct timespec *ts, sigset_t *mask,
    210      1.17     rmind     register_t *retval, int selpoll)
    211       1.1        ad {
    212      1.17     rmind 	lwp_t		* const l = curlwp;
    213       1.1        ad 	proc_t		* const p = l->l_proc;
    214  1.21.4.1     rmind 	selcluster_t	*sc;
    215      1.13        ad 	kmutex_t	*lock;
    216      1.17     rmind 	sigset_t	oldmask;
    217      1.17     rmind 	struct timespec	sleepts;
    218      1.17     rmind 	int		error, timo;
    219       1.1        ad 
    220       1.1        ad 	timo = 0;
    221      1.14  christos 	if (ts && inittimeleft(ts, &sleepts) == -1) {
    222      1.17     rmind 		return EINVAL;
    223       1.1        ad 	}
    224       1.1        ad 
    225      1.17     rmind 	if (__predict_false(mask)) {
    226       1.1        ad 		sigminusset(&sigcantmask, mask);
    227       1.5        ad 		mutex_enter(p->p_lock);
    228       1.1        ad 		oldmask = l->l_sigmask;
    229       1.1        ad 		l->l_sigmask = *mask;
    230       1.5        ad 		mutex_exit(p->p_lock);
    231      1.17     rmind 	} else {
    232      1.17     rmind 		/* XXXgcc */
    233      1.17     rmind 		oldmask = l->l_sigmask;
    234      1.17     rmind 	}
    235       1.1        ad 
    236  1.21.4.1     rmind 	sc = curcpu()->ci_data.cpu_selcluster;
    237      1.13        ad 	lock = sc->sc_lock;
    238  1.21.4.1     rmind 	l->l_selcluster = sc;
    239       1.1        ad 	SLIST_INIT(&l->l_selwait);
    240       1.1        ad 	for (;;) {
    241      1.17     rmind 		int ncoll;
    242      1.17     rmind 
    243       1.1        ad 		/*
    244      1.17     rmind 		 * No need to lock.  If this is overwritten by another value
    245      1.17     rmind 		 * while scanning, we will retry below.  We only need to see
    246      1.17     rmind 		 * exact state from the descriptors that we are about to poll,
    247      1.17     rmind 		 * and lock activity resulting from fo_poll is enough to
    248      1.17     rmind 		 * provide an up to date value for new polling activity.
    249       1.1        ad 		 */
    250      1.17     rmind 		l->l_selflag = SEL_SCANNING;
    251       1.1        ad 		ncoll = sc->sc_ncoll;
    252       1.1        ad 
    253      1.17     rmind 		if (selpoll) {
    254      1.17     rmind 			error = selscan((char *)fds, nfds, retval);
    255      1.17     rmind 		} else {
    256      1.17     rmind 			error = pollscan((struct pollfd *)fds, nfds, retval);
    257      1.17     rmind 		}
    258       1.1        ad 
    259       1.1        ad 		if (error || *retval)
    260       1.1        ad 			break;
    261      1.14  christos 		if (ts && (timo = gettimeleft(ts, &sleepts)) <= 0)
    262       1.1        ad 			break;
    263      1.13        ad 		mutex_spin_enter(lock);
    264       1.1        ad 		if (l->l_selflag != SEL_SCANNING || sc->sc_ncoll != ncoll) {
    265      1.13        ad 			mutex_spin_exit(lock);
    266       1.1        ad 			continue;
    267       1.1        ad 		}
    268       1.1        ad 		l->l_selflag = SEL_BLOCKING;
    269       1.7        ad 		l->l_kpriority = true;
    270      1.13        ad 		sleepq_enter(&sc->sc_sleepq, l, lock);
    271       1.1        ad 		sleepq_enqueue(&sc->sc_sleepq, sc, "select", &select_sobj);
    272       1.1        ad 		error = sleepq_block(timo, true);
    273       1.1        ad 		if (error != 0)
    274       1.1        ad 			break;
    275       1.1        ad 	}
    276       1.1        ad 	selclear();
    277       1.1        ad 
    278      1.17     rmind 	if (__predict_false(mask)) {
    279       1.5        ad 		mutex_enter(p->p_lock);
    280       1.1        ad 		l->l_sigmask = oldmask;
    281       1.5        ad 		mutex_exit(p->p_lock);
    282       1.1        ad 	}
    283      1.20       dsl 
    284      1.20       dsl 	/* select and poll are not restarted after signals... */
    285      1.20       dsl 	if (error == ERESTART)
    286      1.20       dsl 		return EINTR;
    287      1.20       dsl 	if (error == EWOULDBLOCK)
    288      1.20       dsl 		return 0;
    289      1.17     rmind 	return error;
    290      1.17     rmind }
    291      1.17     rmind 
    292      1.17     rmind int
    293      1.19     rmind selcommon(register_t *retval, int nd, fd_set *u_in, fd_set *u_ou,
    294      1.19     rmind     fd_set *u_ex, struct timespec *ts, sigset_t *mask)
    295      1.17     rmind {
    296      1.17     rmind 	char		smallbits[howmany(FD_SETSIZE, NFDBITS) *
    297      1.17     rmind 			    sizeof(fd_mask) * 6];
    298      1.17     rmind 	char 		*bits;
    299      1.17     rmind 	int		error, nf;
    300      1.17     rmind 	size_t		ni;
    301      1.17     rmind 
    302      1.17     rmind 	if (nd < 0)
    303      1.17     rmind 		return (EINVAL);
    304      1.19     rmind 	nf = curlwp->l_fd->fd_dt->dt_nfiles;
    305      1.17     rmind 	if (nd > nf) {
    306      1.17     rmind 		/* forgiving; slightly wrong */
    307      1.17     rmind 		nd = nf;
    308      1.17     rmind 	}
    309      1.17     rmind 	ni = howmany(nd, NFDBITS) * sizeof(fd_mask);
    310      1.17     rmind 	if (ni * 6 > sizeof(smallbits)) {
    311      1.17     rmind 		bits = kmem_alloc(ni * 6, KM_SLEEP);
    312      1.17     rmind 		if (bits == NULL)
    313      1.17     rmind 			return ENOMEM;
    314      1.17     rmind 	} else
    315      1.17     rmind 		bits = smallbits;
    316      1.17     rmind 
    317      1.17     rmind #define	getbits(name, x)						\
    318      1.17     rmind 	if (u_ ## name) {						\
    319      1.17     rmind 		error = copyin(u_ ## name, bits + ni * x, ni);		\
    320      1.17     rmind 		if (error)						\
    321      1.20       dsl 			goto fail;					\
    322      1.17     rmind 	} else								\
    323      1.17     rmind 		memset(bits + ni * x, 0, ni);
    324      1.17     rmind 	getbits(in, 0);
    325      1.17     rmind 	getbits(ou, 1);
    326      1.17     rmind 	getbits(ex, 2);
    327      1.17     rmind #undef	getbits
    328       1.1        ad 
    329      1.17     rmind 	error = sel_do_scan(bits, nd, ts, mask, retval, 1);
    330       1.1        ad 	if (error == 0 && u_in != NULL)
    331       1.1        ad 		error = copyout(bits + ni * 3, u_in, ni);
    332       1.1        ad 	if (error == 0 && u_ou != NULL)
    333       1.1        ad 		error = copyout(bits + ni * 4, u_ou, ni);
    334       1.1        ad 	if (error == 0 && u_ex != NULL)
    335       1.1        ad 		error = copyout(bits + ni * 5, u_ex, ni);
    336      1.20       dsl  fail:
    337       1.1        ad 	if (bits != smallbits)
    338       1.1        ad 		kmem_free(bits, ni * 6);
    339       1.1        ad 	return (error);
    340       1.1        ad }
    341       1.1        ad 
    342      1.19     rmind static inline int
    343      1.17     rmind selscan(char *bits, u_int nfd, register_t *retval)
    344       1.1        ad {
    345       1.1        ad 	static const int flag[3] = { POLLRDNORM | POLLHUP | POLLERR,
    346       1.1        ad 			       POLLWRNORM | POLLHUP | POLLERR,
    347       1.1        ad 			       POLLRDBAND };
    348      1.17     rmind 	fd_mask *ibitp, *obitp;
    349      1.17     rmind 	int msk, i, j, fd, ni, n;
    350       1.1        ad 	fd_mask ibits, obits;
    351       1.1        ad 	file_t *fp;
    352       1.1        ad 
    353      1.17     rmind 	ni = howmany(nfd, NFDBITS) * sizeof(fd_mask);
    354      1.17     rmind 	ibitp = (fd_mask *)(bits + ni * 0);
    355      1.17     rmind 	obitp = (fd_mask *)(bits + ni * 3);
    356       1.1        ad 	n = 0;
    357      1.17     rmind 
    358       1.1        ad 	for (msk = 0; msk < 3; msk++) {
    359       1.1        ad 		for (i = 0; i < nfd; i += NFDBITS) {
    360       1.1        ad 			ibits = *ibitp++;
    361       1.1        ad 			obits = 0;
    362       1.1        ad 			while ((j = ffs(ibits)) && (fd = i + --j) < nfd) {
    363       1.1        ad 				ibits &= ~(1 << j);
    364       1.1        ad 				if ((fp = fd_getfile(fd)) == NULL)
    365       1.1        ad 					return (EBADF);
    366       1.1        ad 				if ((*fp->f_ops->fo_poll)(fp, flag[msk])) {
    367       1.1        ad 					obits |= (1 << j);
    368       1.1        ad 					n++;
    369       1.1        ad 				}
    370       1.1        ad 				fd_putfile(fd);
    371       1.1        ad 			}
    372       1.1        ad 			*obitp++ = obits;
    373       1.1        ad 		}
    374       1.1        ad 	}
    375       1.1        ad 	*retval = n;
    376       1.1        ad 	return (0);
    377       1.1        ad }
    378       1.1        ad 
    379       1.1        ad /*
    380       1.1        ad  * Poll system call.
    381       1.1        ad  */
    382       1.1        ad int
    383       1.1        ad sys_poll(struct lwp *l, const struct sys_poll_args *uap, register_t *retval)
    384       1.1        ad {
    385       1.1        ad 	/* {
    386       1.1        ad 		syscallarg(struct pollfd *)	fds;
    387       1.1        ad 		syscallarg(u_int)		nfds;
    388       1.1        ad 		syscallarg(int)			timeout;
    389       1.1        ad 	} */
    390      1.14  christos 	struct timespec	ats, *ts = NULL;
    391       1.1        ad 
    392       1.1        ad 	if (SCARG(uap, timeout) != INFTIM) {
    393      1.14  christos 		ats.tv_sec = SCARG(uap, timeout) / 1000;
    394      1.14  christos 		ats.tv_nsec = (SCARG(uap, timeout) % 1000) * 1000000;
    395      1.14  christos 		ts = &ats;
    396       1.1        ad 	}
    397       1.1        ad 
    398      1.19     rmind 	return pollcommon(retval, SCARG(uap, fds), SCARG(uap, nfds), ts, NULL);
    399       1.1        ad }
    400       1.1        ad 
    401       1.1        ad /*
    402       1.1        ad  * Poll system call.
    403       1.1        ad  */
    404       1.1        ad int
    405      1.12  christos sys___pollts50(struct lwp *l, const struct sys___pollts50_args *uap,
    406      1.12  christos     register_t *retval)
    407       1.1        ad {
    408       1.1        ad 	/* {
    409       1.1        ad 		syscallarg(struct pollfd *)		fds;
    410       1.1        ad 		syscallarg(u_int)			nfds;
    411       1.1        ad 		syscallarg(const struct timespec *)	ts;
    412       1.1        ad 		syscallarg(const sigset_t *)		mask;
    413       1.1        ad 	} */
    414      1.14  christos 	struct timespec	ats, *ts = NULL;
    415       1.1        ad 	sigset_t	amask, *mask = NULL;
    416       1.1        ad 	int		error;
    417       1.1        ad 
    418       1.1        ad 	if (SCARG(uap, ts)) {
    419       1.1        ad 		error = copyin(SCARG(uap, ts), &ats, sizeof(ats));
    420       1.1        ad 		if (error)
    421       1.1        ad 			return error;
    422      1.14  christos 		ts = &ats;
    423       1.1        ad 	}
    424       1.1        ad 	if (SCARG(uap, mask)) {
    425       1.1        ad 		error = copyin(SCARG(uap, mask), &amask, sizeof(amask));
    426       1.1        ad 		if (error)
    427       1.1        ad 			return error;
    428       1.1        ad 		mask = &amask;
    429       1.1        ad 	}
    430       1.1        ad 
    431      1.19     rmind 	return pollcommon(retval, SCARG(uap, fds), SCARG(uap, nfds), ts, mask);
    432       1.1        ad }
    433       1.1        ad 
    434       1.1        ad int
    435      1.19     rmind pollcommon(register_t *retval, struct pollfd *u_fds, u_int nfds,
    436      1.14  christos     struct timespec *ts, sigset_t *mask)
    437       1.1        ad {
    438      1.11      yamt 	struct pollfd	smallfds[32];
    439      1.11      yamt 	struct pollfd	*fds;
    440      1.17     rmind 	int		error;
    441      1.20       dsl 	size_t		ni;
    442       1.1        ad 
    443      1.20       dsl 	if (nfds > 1000 + curlwp->l_fd->fd_dt->dt_nfiles) {
    444      1.20       dsl 		/*
    445      1.20       dsl 		 * Either the user passed in a very sparse 'fds' or junk!
    446      1.20       dsl 		 * The kmem_alloc() call below would be bad news.
    447      1.20       dsl 		 * We could process the 'fds' array in chunks, but that
    448      1.20       dsl 		 * is a lot of code that isn't normally useful.
    449      1.20       dsl 		 * (Or just move the copyin/out into pollscan().)
    450      1.20       dsl 		 * Historically the code silently truncated 'fds' to
    451      1.20       dsl 		 * dt_nfiles entries - but that does cause issues.
    452      1.20       dsl 		 */
    453      1.20       dsl 		return EINVAL;
    454       1.1        ad 	}
    455       1.1        ad 	ni = nfds * sizeof(struct pollfd);
    456      1.11      yamt 	if (ni > sizeof(smallfds)) {
    457      1.11      yamt 		fds = kmem_alloc(ni, KM_SLEEP);
    458      1.11      yamt 		if (fds == NULL)
    459       1.9     rmind 			return ENOMEM;
    460       1.9     rmind 	} else
    461      1.11      yamt 		fds = smallfds;
    462       1.1        ad 
    463      1.11      yamt 	error = copyin(u_fds, fds, ni);
    464       1.1        ad 	if (error)
    465      1.20       dsl 		goto fail;
    466       1.1        ad 
    467      1.17     rmind 	error = sel_do_scan(fds, nfds, ts, mask, retval, 0);
    468       1.1        ad 	if (error == 0)
    469      1.11      yamt 		error = copyout(fds, u_fds, ni);
    470      1.20       dsl  fail:
    471      1.11      yamt 	if (fds != smallfds)
    472      1.11      yamt 		kmem_free(fds, ni);
    473       1.1        ad 	return (error);
    474       1.1        ad }
    475       1.1        ad 
    476      1.19     rmind static inline int
    477      1.17     rmind pollscan(struct pollfd *fds, u_int nfd, register_t *retval)
    478       1.1        ad {
    479       1.1        ad 	int i, n;
    480       1.1        ad 	file_t *fp;
    481       1.1        ad 
    482       1.1        ad 	n = 0;
    483       1.1        ad 	for (i = 0; i < nfd; i++, fds++) {
    484       1.1        ad 		if (fds->fd < 0) {
    485       1.1        ad 			fds->revents = 0;
    486       1.1        ad 		} else if ((fp = fd_getfile(fds->fd)) == NULL) {
    487       1.1        ad 			fds->revents = POLLNVAL;
    488       1.1        ad 			n++;
    489       1.1        ad 		} else {
    490       1.1        ad 			fds->revents = (*fp->f_ops->fo_poll)(fp,
    491       1.1        ad 			    fds->events | POLLERR | POLLHUP);
    492       1.1        ad 			if (fds->revents != 0)
    493       1.1        ad 				n++;
    494       1.1        ad 			fd_putfile(fds->fd);
    495       1.1        ad 		}
    496       1.1        ad 	}
    497       1.1        ad 	*retval = n;
    498       1.1        ad 	return (0);
    499       1.1        ad }
    500       1.1        ad 
    501       1.1        ad /*ARGSUSED*/
    502       1.1        ad int
    503       1.1        ad seltrue(dev_t dev, int events, lwp_t *l)
    504       1.1        ad {
    505       1.1        ad 
    506       1.1        ad 	return (events & (POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM));
    507       1.1        ad }
    508       1.1        ad 
    509       1.1        ad /*
    510       1.1        ad  * Record a select request.  Concurrency issues:
    511       1.1        ad  *
    512       1.1        ad  * The caller holds the same lock across calls to selrecord() and
    513       1.4      yamt  * selnotify(), so we don't need to consider a concurrent wakeup
    514       1.1        ad  * while in this routine.
    515       1.1        ad  *
    516       1.1        ad  * The only activity we need to guard against is selclear(), called by
    517      1.17     rmind  * another thread that is exiting sel_do_scan().
    518       1.1        ad  * `sel_lwp' can only become non-NULL while the caller's lock is held,
    519       1.1        ad  * so it cannot become non-NULL due to a change made by another thread
    520       1.1        ad  * while we are in this routine.  It can only become _NULL_ due to a
    521       1.1        ad  * call to selclear().
    522       1.1        ad  *
    523       1.1        ad  * If it is non-NULL and != selector there is the potential for
    524       1.1        ad  * selclear() to be called by another thread.  If either of those
    525       1.1        ad  * conditions are true, we're not interested in touching the `named
    526       1.1        ad  * waiter' part of the selinfo record because we need to record a
    527       1.1        ad  * collision.  Hence there is no need for additional locking in this
    528       1.1        ad  * routine.
    529       1.1        ad  */
    530       1.1        ad void
    531       1.1        ad selrecord(lwp_t *selector, struct selinfo *sip)
    532       1.1        ad {
    533  1.21.4.1     rmind 	selcluster_t *sc;
    534       1.1        ad 	lwp_t *other;
    535       1.1        ad 
    536       1.1        ad 	KASSERT(selector == curlwp);
    537       1.1        ad 
    538  1.21.4.1     rmind 	sc = selector->l_selcluster;
    539       1.1        ad 	other = sip->sel_lwp;
    540       1.1        ad 
    541       1.1        ad 	if (other == selector) {
    542       1.1        ad 		/* `selector' has already claimed it. */
    543  1.21.4.1     rmind 		KASSERT(sip->sel_cluster = sc);
    544       1.1        ad 	} else if (other == NULL) {
    545       1.1        ad 		/*
    546       1.1        ad 		 * First named waiter, although there may be unnamed
    547       1.1        ad 		 * waiters (collisions).  Issue a memory barrier to
    548       1.1        ad 		 * ensure that we access sel_lwp (above) before other
    549       1.1        ad 		 * fields - this guards against a call to selclear().
    550       1.1        ad 		 */
    551       1.1        ad 		membar_enter();
    552       1.1        ad 		sip->sel_lwp = selector;
    553       1.1        ad 		SLIST_INSERT_HEAD(&selector->l_selwait, sip, sel_chain);
    554  1.21.4.1     rmind 		/* Replace selinfo's lock with the chosen cluster's lock. */
    555  1.21.4.1     rmind 		sip->sel_cluster = sc;
    556       1.1        ad 	} else {
    557       1.1        ad 		/* Multiple waiters: record a collision. */
    558       1.1        ad 		sip->sel_collision |= sc->sc_mask;
    559  1.21.4.1     rmind 		KASSERT(sip->sel_cluster != NULL);
    560       1.1        ad 	}
    561       1.1        ad }
    562       1.1        ad 
    563       1.1        ad /*
    564       1.1        ad  * Do a wakeup when a selectable event occurs.  Concurrency issues:
    565       1.1        ad  *
    566       1.1        ad  * As per selrecord(), the caller's object lock is held.  If there
    567  1.21.4.1     rmind  * is a named waiter, we must acquire the associated selcluster's lock
    568       1.1        ad  * in order to synchronize with selclear() and pollers going to sleep
    569      1.17     rmind  * in sel_do_scan().
    570       1.1        ad  *
    571  1.21.4.1     rmind  * sip->sel_cluser cannot change at this point, as it is only changed
    572       1.1        ad  * in selrecord(), and concurrent calls to selrecord() are locked
    573       1.1        ad  * out by the caller.
    574       1.1        ad  */
    575       1.1        ad void
    576       1.1        ad selnotify(struct selinfo *sip, int events, long knhint)
    577       1.1        ad {
    578  1.21.4.1     rmind 	selcluster_t *sc;
    579       1.1        ad 	uint32_t mask;
    580      1.16     rmind 	int index, oflag;
    581       1.1        ad 	lwp_t *l;
    582      1.13        ad 	kmutex_t *lock;
    583       1.1        ad 
    584       1.1        ad 	KNOTE(&sip->sel_klist, knhint);
    585       1.1        ad 
    586       1.1        ad 	if (sip->sel_lwp != NULL) {
    587       1.1        ad 		/* One named LWP is waiting. */
    588  1.21.4.1     rmind 		sc = sip->sel_cluster;
    589      1.13        ad 		lock = sc->sc_lock;
    590      1.13        ad 		mutex_spin_enter(lock);
    591       1.1        ad 		/* Still there? */
    592       1.1        ad 		if (sip->sel_lwp != NULL) {
    593       1.1        ad 			l = sip->sel_lwp;
    594       1.1        ad 			/*
    595       1.1        ad 			 * If thread is sleeping, wake it up.  If it's not
    596       1.1        ad 			 * yet asleep, it will notice the change in state
    597       1.1        ad 			 * and will re-poll the descriptors.
    598       1.1        ad 			 */
    599       1.1        ad 			oflag = l->l_selflag;
    600       1.1        ad 			l->l_selflag = SEL_RESET;
    601      1.13        ad 			if (oflag == SEL_BLOCKING && l->l_mutex == lock) {
    602       1.1        ad 				KASSERT(l->l_wchan == sc);
    603      1.16     rmind 				sleepq_unsleep(l, false);
    604       1.1        ad 			}
    605       1.1        ad 		}
    606      1.13        ad 		mutex_spin_exit(lock);
    607       1.1        ad 	}
    608       1.1        ad 
    609       1.1        ad 	if ((mask = sip->sel_collision) != 0) {
    610       1.1        ad 		/*
    611       1.1        ad 		 * There was a collision (multiple waiters): we must
    612       1.1        ad 		 * inform all potentially interested waiters.
    613       1.1        ad 		 */
    614       1.1        ad 		sip->sel_collision = 0;
    615       1.3        ad 		do {
    616       1.1        ad 			index = ffs(mask) - 1;
    617       1.1        ad 			mask &= ~(1 << index);
    618  1.21.4.1     rmind 			sc = selcluster[index];
    619      1.13        ad 			lock = sc->sc_lock;
    620      1.13        ad 			mutex_spin_enter(lock);
    621       1.1        ad 			sc->sc_ncoll++;
    622      1.13        ad 			sleepq_wake(&sc->sc_sleepq, sc, (u_int)-1, lock);
    623       1.3        ad 		} while (__predict_false(mask != 0));
    624       1.1        ad 	}
    625       1.1        ad }
    626       1.1        ad 
    627       1.1        ad /*
    628       1.1        ad  * Remove an LWP from all objects that it is waiting for.  Concurrency
    629       1.1        ad  * issues:
    630       1.1        ad  *
    631       1.1        ad  * The object owner's (e.g. device driver) lock is not held here.  Calls
    632       1.1        ad  * can be made to selrecord() and we do not synchronize against those
    633       1.1        ad  * directly using locks.  However, we use `sel_lwp' to lock out changes.
    634       1.1        ad  * Before clearing it we must use memory barriers to ensure that we can
    635       1.1        ad  * safely traverse the list of selinfo records.
    636       1.1        ad  */
    637       1.1        ad static void
    638       1.1        ad selclear(void)
    639       1.1        ad {
    640       1.1        ad 	struct selinfo *sip, *next;
    641  1.21.4.1     rmind 	selcluster_t *sc;
    642       1.1        ad 	lwp_t *l;
    643      1.13        ad 	kmutex_t *lock;
    644       1.1        ad 
    645       1.1        ad 	l = curlwp;
    646  1.21.4.1     rmind 	sc = l->l_selcluster;
    647      1.13        ad 	lock = sc->sc_lock;
    648       1.1        ad 
    649      1.13        ad 	mutex_spin_enter(lock);
    650       1.1        ad 	for (sip = SLIST_FIRST(&l->l_selwait); sip != NULL; sip = next) {
    651       1.1        ad 		KASSERT(sip->sel_lwp == l);
    652  1.21.4.1     rmind 		KASSERT(sip->sel_cluster == l->l_selcluster);
    653  1.21.4.1     rmind 
    654       1.1        ad 		/*
    655       1.1        ad 		 * Read link to next selinfo record, if any.
    656       1.1        ad 		 * It's no longer safe to touch `sip' after clearing
    657       1.1        ad 		 * `sel_lwp', so ensure that the read of `sel_chain'
    658       1.1        ad 		 * completes before the clearing of sel_lwp becomes
    659       1.1        ad 		 * globally visible.
    660       1.1        ad 		 */
    661       1.1        ad 		next = SLIST_NEXT(sip, sel_chain);
    662       1.1        ad 		membar_exit();
    663       1.1        ad 		/* Release the record for another named waiter to use. */
    664       1.1        ad 		sip->sel_lwp = NULL;
    665       1.1        ad 	}
    666      1.13        ad 	mutex_spin_exit(lock);
    667       1.1        ad }
    668       1.1        ad 
    669       1.1        ad /*
    670       1.1        ad  * Initialize the select/poll system calls.  Called once for each
    671       1.1        ad  * CPU in the system, as they are attached.
    672       1.1        ad  */
    673       1.1        ad void
    674       1.1        ad selsysinit(struct cpu_info *ci)
    675       1.1        ad {
    676  1.21.4.1     rmind 	selcluster_t *sc;
    677  1.21.4.1     rmind 	u_int index;
    678       1.1        ad 
    679  1.21.4.1     rmind 	/* If already a cluster in place for this bit, re-use. */
    680  1.21.4.1     rmind 	index = cpu_index(ci) & SELCLUSTERMASK;
    681  1.21.4.1     rmind 	sc = selcluster[index];
    682  1.21.4.1     rmind 	if (sc == NULL) {
    683  1.21.4.1     rmind 		sc = kmem_alloc(roundup2(sizeof(selcluster_t),
    684  1.21.4.1     rmind 		    coherency_unit) + coherency_unit, KM_SLEEP);
    685  1.21.4.1     rmind 		sc = (void *)roundup2((uintptr_t)sc, coherency_unit);
    686  1.21.4.1     rmind 		sc->sc_lock = mutex_obj_alloc(MUTEX_DEFAULT, IPL_SCHED);
    687  1.21.4.1     rmind 		sleepq_init(&sc->sc_sleepq);
    688  1.21.4.1     rmind 		sc->sc_ncoll = 0;
    689  1.21.4.1     rmind 		sc->sc_mask = (1 << index);
    690  1.21.4.1     rmind 		selcluster[index] = sc;
    691  1.21.4.1     rmind 	}
    692  1.21.4.1     rmind 	ci->ci_data.cpu_selcluster = sc;
    693       1.1        ad }
    694       1.1        ad 
    695       1.1        ad /*
    696       1.1        ad  * Initialize a selinfo record.
    697       1.1        ad  */
    698       1.1        ad void
    699       1.1        ad selinit(struct selinfo *sip)
    700       1.1        ad {
    701       1.1        ad 
    702       1.1        ad 	memset(sip, 0, sizeof(*sip));
    703       1.1        ad }
    704       1.1        ad 
    705       1.1        ad /*
    706       1.1        ad  * Destroy a selinfo record.  The owning object must not gain new
    707       1.1        ad  * references while this is in progress: all activity on the record
    708       1.1        ad  * must be stopped.
    709       1.1        ad  *
    710       1.1        ad  * Concurrency issues: we only need guard against a call to selclear()
    711      1.17     rmind  * by a thread exiting sel_do_scan().  The caller has prevented further
    712      1.17     rmind  * references being made to the selinfo record via selrecord(), and it
    713      1.17     rmind  * won't call selwakeup() again.
    714       1.1        ad  */
    715       1.1        ad void
    716       1.1        ad seldestroy(struct selinfo *sip)
    717       1.1        ad {
    718  1.21.4.1     rmind 	selcluster_t *sc;
    719      1.13        ad 	kmutex_t *lock;
    720       1.1        ad 	lwp_t *l;
    721       1.1        ad 
    722       1.1        ad 	if (sip->sel_lwp == NULL)
    723       1.1        ad 		return;
    724       1.1        ad 
    725       1.1        ad 	/*
    726  1.21.4.1     rmind 	 * Lock out selclear().  The selcluster pointer can't change while
    727       1.1        ad 	 * we are here since it is only ever changed in selrecord(),
    728       1.1        ad 	 * and that will not be entered again for this record because
    729       1.1        ad 	 * it is dying.
    730       1.1        ad 	 */
    731  1.21.4.1     rmind 	KASSERT(sip->sel_cluster != NULL);
    732  1.21.4.1     rmind 	sc = sip->sel_cluster;
    733      1.13        ad 	lock = sc->sc_lock;
    734      1.13        ad 	mutex_spin_enter(lock);
    735       1.1        ad 	if ((l = sip->sel_lwp) != NULL) {
    736       1.1        ad 		/*
    737       1.1        ad 		 * This should rarely happen, so although SLIST_REMOVE()
    738       1.1        ad 		 * is slow, using it here is not a problem.
    739       1.1        ad 		 */
    740  1.21.4.1     rmind 		KASSERT(l->l_selcluster == sc);
    741       1.1        ad 		SLIST_REMOVE(&l->l_selwait, sip, selinfo, sel_chain);
    742       1.1        ad 		sip->sel_lwp = NULL;
    743       1.1        ad 	}
    744      1.13        ad 	mutex_spin_exit(lock);
    745       1.1        ad }
    746       1.1        ad 
    747       1.1        ad int
    748      1.14  christos pollsock(struct socket *so, const struct timespec *tsp, int events)
    749       1.1        ad {
    750       1.1        ad 	int		ncoll, error, timo;
    751      1.14  christos 	struct timespec	sleepts, ts;
    752  1.21.4.1     rmind 	selcluster_t	*sc;
    753       1.1        ad 	lwp_t		*l;
    754      1.13        ad 	kmutex_t	*lock;
    755       1.1        ad 
    756       1.1        ad 	timo = 0;
    757      1.14  christos 	if (tsp != NULL) {
    758      1.14  christos 		ts = *tsp;
    759      1.14  christos 		if (inittimeleft(&ts, &sleepts) == -1)
    760       1.1        ad 			return EINVAL;
    761       1.1        ad 	}
    762       1.1        ad 
    763       1.1        ad 	l = curlwp;
    764  1.21.4.1     rmind 	sc = curcpu()->ci_data.cpu_selcluster;
    765      1.13        ad 	lock = sc->sc_lock;
    766  1.21.4.1     rmind 	l->l_selcluster = sc;
    767       1.1        ad 	SLIST_INIT(&l->l_selwait);
    768       1.1        ad 	error = 0;
    769       1.1        ad 	for (;;) {
    770       1.1        ad 		/*
    771       1.1        ad 		 * No need to lock.  If this is overwritten by another
    772       1.1        ad 		 * value while scanning, we will retry below.  We only
    773       1.1        ad 		 * need to see exact state from the descriptors that
    774       1.1        ad 		 * we are about to poll, and lock activity resulting
    775       1.1        ad 		 * from fo_poll is enough to provide an up to date value
    776       1.1        ad 		 * for new polling activity.
    777       1.1        ad 		 */
    778       1.1        ad 		ncoll = sc->sc_ncoll;
    779       1.1        ad 		l->l_selflag = SEL_SCANNING;
    780       1.1        ad 		if (sopoll(so, events) != 0)
    781       1.1        ad 			break;
    782      1.14  christos 		if (tsp && (timo = gettimeleft(&ts, &sleepts)) <= 0)
    783       1.1        ad 			break;
    784      1.13        ad 		mutex_spin_enter(lock);
    785       1.1        ad 		if (l->l_selflag != SEL_SCANNING || sc->sc_ncoll != ncoll) {
    786      1.13        ad 			mutex_spin_exit(lock);
    787       1.1        ad 			continue;
    788       1.1        ad 		}
    789       1.1        ad 		l->l_selflag = SEL_BLOCKING;
    790      1.13        ad 		sleepq_enter(&sc->sc_sleepq, l, lock);
    791       1.1        ad 		sleepq_enqueue(&sc->sc_sleepq, sc, "pollsock", &select_sobj);
    792       1.1        ad 		error = sleepq_block(timo, true);
    793       1.1        ad 		if (error != 0)
    794       1.1        ad 			break;
    795       1.1        ad 	}
    796       1.1        ad 	selclear();
    797       1.1        ad 	/* poll is not restarted after signals... */
    798       1.1        ad 	if (error == ERESTART)
    799       1.1        ad 		error = EINTR;
    800       1.1        ad 	if (error == EWOULDBLOCK)
    801       1.1        ad 		error = 0;
    802       1.1        ad 	return (error);
    803       1.1        ad }
    804