Home | History | Annotate | Line # | Download | only in kern
uipc_sem.c revision 1.56
      1 /*	$NetBSD: uipc_sem.c,v 1.56 2019/12/15 20:25:25 joerg Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2011, 2019 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Mindaugas Rasiukevicius and Jason R. Thorpe.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 /*
     33  * Copyright (c) 2002 Alfred Perlstein <alfred (at) FreeBSD.org>
     34  * All rights reserved.
     35  *
     36  * Redistribution and use in source and binary forms, with or without
     37  * modification, are permitted provided that the following conditions
     38  * are met:
     39  * 1. Redistributions of source code must retain the above copyright
     40  *    notice, this list of conditions and the following disclaimer.
     41  * 2. Redistributions in binary form must reproduce the above copyright
     42  *    notice, this list of conditions and the following disclaimer in the
     43  *    documentation and/or other materials provided with the distribution.
     44  *
     45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     55  * SUCH DAMAGE.
     56  */
     57 
     58 /*
     59  * Implementation of POSIX semaphore.
     60  */
     61 
     62 #include <sys/cdefs.h>
     63 __KERNEL_RCSID(0, "$NetBSD: uipc_sem.c,v 1.56 2019/12/15 20:25:25 joerg Exp $");
     64 
     65 #include <sys/param.h>
     66 #include <sys/kernel.h>
     67 
     68 #include <sys/atomic.h>
     69 #include <sys/proc.h>
     70 #include <sys/lwp.h>
     71 #include <sys/ksem.h>
     72 #include <sys/syscall.h>
     73 #include <sys/stat.h>
     74 #include <sys/kmem.h>
     75 #include <sys/fcntl.h>
     76 #include <sys/file.h>
     77 #include <sys/filedesc.h>
     78 #include <sys/kauth.h>
     79 #include <sys/module.h>
     80 #include <sys/mount.h>
     81 #include <sys/mutex.h>
     82 #include <sys/rwlock.h>
     83 #include <sys/semaphore.h>
     84 #include <sys/syscall.h>
     85 #include <sys/syscallargs.h>
     86 #include <sys/syscallvar.h>
     87 #include <sys/sysctl.h>
     88 #include <sys/uidinfo.h>
     89 #include <sys/cprng.h>
     90 
     91 MODULE(MODULE_CLASS_MISC, ksem, NULL);
     92 
     93 #define	SEM_MAX_NAMELEN		NAME_MAX
     94 
     95 #define	KS_UNLINKED		0x01
     96 
     97 static kmutex_t		ksem_lock	__cacheline_aligned;
     98 static LIST_HEAD(,ksem)	ksem_head	__cacheline_aligned;
     99 static u_int		nsems_total	__cacheline_aligned;
    100 static u_int		nsems		__cacheline_aligned;
    101 
    102 static krwlock_t	ksem_pshared_lock __cacheline_aligned;
    103 static LIST_HEAD(, ksem) *ksem_pshared_hashtab __cacheline_aligned;
    104 static u_long		ksem_pshared_hashmask __read_mostly;
    105 
    106 #define	KSEM_PSHARED_HASHSIZE	32
    107 
    108 static kauth_listener_t	ksem_listener;
    109 
    110 static int		ksem_sysinit(void);
    111 static int		ksem_sysfini(bool);
    112 static int		ksem_modcmd(modcmd_t, void *);
    113 static int		ksem_close_fop(file_t *);
    114 static int		ksem_stat_fop(file_t *, struct stat *);
    115 static int		ksem_read_fop(file_t *, off_t *, struct uio *,
    116     kauth_cred_t, int);
    117 
    118 static const struct fileops semops = {
    119 	.fo_name = "sem",
    120 	.fo_read = ksem_read_fop,
    121 	.fo_write = fbadop_write,
    122 	.fo_ioctl = fbadop_ioctl,
    123 	.fo_fcntl = fnullop_fcntl,
    124 	.fo_poll = fnullop_poll,
    125 	.fo_stat = ksem_stat_fop,
    126 	.fo_close = ksem_close_fop,
    127 	.fo_kqfilter = fnullop_kqfilter,
    128 	.fo_restart = fnullop_restart,
    129 };
    130 
    131 static const struct syscall_package ksem_syscalls[] = {
    132 	{ SYS__ksem_init, 0, (sy_call_t *)sys__ksem_init },
    133 	{ SYS__ksem_open, 0, (sy_call_t *)sys__ksem_open },
    134 	{ SYS__ksem_unlink, 0, (sy_call_t *)sys__ksem_unlink },
    135 	{ SYS__ksem_close, 0, (sy_call_t *)sys__ksem_close },
    136 	{ SYS__ksem_post, 0, (sy_call_t *)sys__ksem_post },
    137 	{ SYS__ksem_wait, 0, (sy_call_t *)sys__ksem_wait },
    138 	{ SYS__ksem_trywait, 0, (sy_call_t *)sys__ksem_trywait },
    139 	{ SYS__ksem_getvalue, 0, (sy_call_t *)sys__ksem_getvalue },
    140 	{ SYS__ksem_destroy, 0, (sy_call_t *)sys__ksem_destroy },
    141 	{ SYS__ksem_timedwait, 0, (sy_call_t *)sys__ksem_timedwait },
    142 	{ 0, 0, NULL },
    143 };
    144 
    145 struct sysctllog *ksem_clog;
    146 int ksem_max;
    147 
    148 static int
    149 name_copyin(const char *uname, char **name)
    150 {
    151 	*name = kmem_alloc(SEM_MAX_NAMELEN, KM_SLEEP);
    152 
    153 	int error = copyinstr(uname, *name, SEM_MAX_NAMELEN, NULL);
    154 	if (error)
    155 		kmem_free(*name, SEM_MAX_NAMELEN);
    156 
    157 	return error;
    158 }
    159 
    160 static void
    161 name_destroy(char **name)
    162 {
    163 	if (!*name)
    164 		return;
    165 
    166 	kmem_free(*name, SEM_MAX_NAMELEN);
    167 	*name = NULL;
    168 }
    169 
    170 static int
    171 ksem_listener_cb(kauth_cred_t cred, kauth_action_t action, void *cookie,
    172     void *arg0, void *arg1, void *arg2, void *arg3)
    173 {
    174 	ksem_t *ks;
    175 	mode_t mode;
    176 
    177 	if (action != KAUTH_SYSTEM_SEMAPHORE)
    178 		return KAUTH_RESULT_DEFER;
    179 
    180 	ks = arg1;
    181 	mode = ks->ks_mode;
    182 
    183 	if ((kauth_cred_geteuid(cred) == ks->ks_uid && (mode & S_IWUSR) != 0) ||
    184 	    (kauth_cred_getegid(cred) == ks->ks_gid && (mode & S_IWGRP) != 0) ||
    185 	    (mode & S_IWOTH) != 0)
    186 		return KAUTH_RESULT_ALLOW;
    187 
    188 	return KAUTH_RESULT_DEFER;
    189 }
    190 
    191 static int
    192 ksem_sysinit(void)
    193 {
    194 	int error;
    195 	const struct sysctlnode *rnode;
    196 
    197 	mutex_init(&ksem_lock, MUTEX_DEFAULT, IPL_NONE);
    198 	LIST_INIT(&ksem_head);
    199 	nsems_total = 0;
    200 	nsems = 0;
    201 
    202 	rw_init(&ksem_pshared_lock);
    203 	ksem_pshared_hashtab = hashinit(KSEM_PSHARED_HASHSIZE, HASH_LIST,
    204 	    true, &ksem_pshared_hashmask);
    205 	KASSERT(ksem_pshared_hashtab != NULL);
    206 
    207 	error = syscall_establish(NULL, ksem_syscalls);
    208 	if (error) {
    209 		(void)ksem_sysfini(false);
    210 	}
    211 
    212 	ksem_listener = kauth_listen_scope(KAUTH_SCOPE_SYSTEM,
    213 	    ksem_listener_cb, NULL);
    214 
    215 	/* Define module-specific sysctl tree */
    216 
    217 	ksem_max = KSEM_MAX;
    218 	ksem_clog = NULL;
    219 
    220 	sysctl_createv(&ksem_clog, 0, NULL, &rnode,
    221 			CTLFLAG_PERMANENT,
    222 			CTLTYPE_NODE, "posix",
    223 			SYSCTL_DESCR("POSIX options"),
    224 			NULL, 0, NULL, 0,
    225 			CTL_KERN, CTL_CREATE, CTL_EOL);
    226 	sysctl_createv(&ksem_clog, 0, &rnode, NULL,
    227 			CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
    228 			CTLTYPE_INT, "semmax",
    229 			SYSCTL_DESCR("Maximal number of semaphores"),
    230 			NULL, 0, &ksem_max, 0,
    231 			CTL_CREATE, CTL_EOL);
    232 	sysctl_createv(&ksem_clog, 0, &rnode, NULL,
    233 			CTLFLAG_PERMANENT | CTLFLAG_READONLY,
    234 			CTLTYPE_INT, "semcnt",
    235 			SYSCTL_DESCR("Current number of semaphores"),
    236 			NULL, 0, &nsems, 0,
    237 			CTL_CREATE, CTL_EOL);
    238 
    239 	return error;
    240 }
    241 
    242 static int
    243 ksem_sysfini(bool interface)
    244 {
    245 	int error;
    246 
    247 	if (interface) {
    248 		error = syscall_disestablish(NULL, ksem_syscalls);
    249 		if (error != 0) {
    250 			return error;
    251 		}
    252 		/*
    253 		 * Make sure that no semaphores are in use.  Note: semops
    254 		 * must be unused at this point.
    255 		 */
    256 		if (nsems_total) {
    257 			error = syscall_establish(NULL, ksem_syscalls);
    258 			KASSERT(error == 0);
    259 			return EBUSY;
    260 		}
    261 	}
    262 	kauth_unlisten_scope(ksem_listener);
    263 	hashdone(ksem_pshared_hashtab, HASH_LIST, ksem_pshared_hashmask);
    264 	rw_destroy(&ksem_pshared_lock);
    265 	mutex_destroy(&ksem_lock);
    266 	sysctl_teardown(&ksem_clog);
    267 	return 0;
    268 }
    269 
    270 static int
    271 ksem_modcmd(modcmd_t cmd, void *arg)
    272 {
    273 
    274 	switch (cmd) {
    275 	case MODULE_CMD_INIT:
    276 		return ksem_sysinit();
    277 
    278 	case MODULE_CMD_FINI:
    279 		return ksem_sysfini(true);
    280 
    281 	default:
    282 		return ENOTTY;
    283 	}
    284 }
    285 
    286 static ksem_t *
    287 ksem_lookup(const char *name)
    288 {
    289 	ksem_t *ks;
    290 
    291 	KASSERT(mutex_owned(&ksem_lock));
    292 
    293 	LIST_FOREACH(ks, &ksem_head, ks_entry) {
    294 		if (strcmp(ks->ks_name, name) == 0) {
    295 			mutex_enter(&ks->ks_lock);
    296 			return ks;
    297 		}
    298 	}
    299 	return NULL;
    300 }
    301 
    302 static int
    303 ksem_perm(lwp_t *l, ksem_t *ks)
    304 {
    305 	kauth_cred_t uc = l->l_cred;
    306 
    307 	KASSERT(mutex_owned(&ks->ks_lock));
    308 
    309 	if (kauth_authorize_system(uc, KAUTH_SYSTEM_SEMAPHORE, 0, ks, NULL, NULL) != 0)
    310 		return EACCES;
    311 
    312 	return 0;
    313 }
    314 
    315 /*
    316  * Bits 1..23 are random, just pluck a few of those and assume the
    317  * distribution is going to be pretty good.
    318  */
    319 #define	KSEM_PSHARED_HASH(id)	(((id) >> 1) & ksem_pshared_hashmask)
    320 
    321 static void
    322 ksem_remove_pshared(ksem_t *ksem)
    323 {
    324 	rw_enter(&ksem_pshared_lock, RW_WRITER);
    325 	LIST_REMOVE(ksem, ks_entry);
    326 	rw_exit(&ksem_pshared_lock);
    327 }
    328 
    329 static ksem_t *
    330 ksem_lookup_pshared_locked(intptr_t id)
    331 {
    332 	u_long bucket = KSEM_PSHARED_HASH(id);
    333 	ksem_t *ksem = NULL;
    334 
    335 	/* ksem_t is locked and referenced upon return. */
    336 
    337 	LIST_FOREACH(ksem, &ksem_pshared_hashtab[bucket], ks_entry) {
    338 		if (ksem->ks_pshared_id == id) {
    339 			mutex_enter(&ksem->ks_lock);
    340 			if (ksem->ks_pshared_proc == NULL) {
    341 				/*
    342 				 * This entry is dead, and in the process
    343 				 * of being torn down; skip it.
    344 				 */
    345 				mutex_exit(&ksem->ks_lock);
    346 				continue;
    347 			}
    348 			ksem->ks_ref++;
    349 			KASSERT(ksem->ks_ref != 0);
    350 			return ksem;
    351 		}
    352 	}
    353 
    354 	return NULL;
    355 }
    356 
    357 static ksem_t *
    358 ksem_lookup_pshared(intptr_t id)
    359 {
    360 	rw_enter(&ksem_pshared_lock, RW_READER);
    361 	ksem_t *ksem = ksem_lookup_pshared_locked(id);
    362 	rw_exit(&ksem_pshared_lock);
    363 	return ksem;
    364 }
    365 
    366 static void
    367 ksem_alloc_pshared_id(ksem_t *ksem)
    368 {
    369 	uint32_t try;
    370 
    371 	KASSERT(ksem->ks_pshared_proc != NULL);
    372 
    373 	rw_enter(&ksem_pshared_lock, RW_WRITER);
    374 	for (;;) {
    375 		try = (cprng_fast32() & ~KSEM_MARKER_MASK) |
    376 		    KSEM_PSHARED_MARKER;
    377 
    378 		if (ksem_lookup_pshared_locked(try) == NULL) {
    379 			/* Got it! */
    380 			break;
    381 		}
    382 	}
    383 	ksem->ks_pshared_id = try;
    384 	u_long bucket = KSEM_PSHARED_HASH(ksem->ks_pshared_id);
    385 	LIST_INSERT_HEAD(&ksem_pshared_hashtab[bucket], ksem, ks_entry);
    386 	rw_exit(&ksem_pshared_lock);
    387 }
    388 
    389 /*
    390  * ksem_get: get the semaphore from the descriptor.
    391  *
    392  * => locks the semaphore, if found, and holds an extra reference.
    393  * => holds a reference on the file descriptor.
    394  */
    395 static int
    396 ksem_get(intptr_t id, ksem_t **ksret, int *fdp)
    397 {
    398 	ksem_t *ks;
    399 	int fd;
    400 
    401 	if ((id & KSEM_MARKER_MASK) == KSEM_PSHARED_MARKER) {
    402 		/*
    403 		 * ksem_lookup_pshared() returns the ksem_t *
    404 		 * locked and referenced.
    405 		 */
    406 		ks = ksem_lookup_pshared(id);
    407 		if (ks == NULL)
    408 			return EINVAL;
    409 		KASSERT(ks->ks_pshared_id == id);
    410 		KASSERT(ks->ks_pshared_proc != NULL);
    411 		fd = -1;
    412 	} else if (id <= INT_MAX) {
    413 		fd = (int)id;
    414 		file_t *fp = fd_getfile(fd);
    415 
    416 		if (__predict_false(fp == NULL))
    417 			return EINVAL;
    418 		if (__predict_false(fp->f_type != DTYPE_SEM)) {
    419 			fd_putfile(fd);
    420 			return EINVAL;
    421 		}
    422 		ks = fp->f_ksem;
    423 		mutex_enter(&ks->ks_lock);
    424 		ks->ks_ref++;
    425 	} else {
    426 		return EINVAL;
    427 	}
    428 
    429 	*ksret = ks;
    430 	*fdp = fd;
    431 	return 0;
    432 }
    433 
    434 /*
    435  * ksem_create: allocate and setup a new semaphore structure.
    436  */
    437 static int
    438 ksem_create(lwp_t *l, const char *name, ksem_t **ksret, mode_t mode, u_int val)
    439 {
    440 	ksem_t *ks;
    441 	kauth_cred_t uc;
    442 	char *kname;
    443 	size_t len;
    444 
    445 	/* Pre-check for the limit. */
    446 	if (nsems >= ksem_max) {
    447 		return ENFILE;
    448 	}
    449 
    450 	if (val > SEM_VALUE_MAX) {
    451 		return EINVAL;
    452 	}
    453 
    454 	if (name != NULL) {
    455 		len = strlen(name);
    456 		if (len > SEM_MAX_NAMELEN) {
    457 			return ENAMETOOLONG;
    458 		}
    459 		/* Name must start with a '/' but not contain one. */
    460 		if (*name != '/' || len < 2 || strchr(name + 1, '/') != NULL) {
    461 			return EINVAL;
    462 		}
    463 		kname = kmem_alloc(++len, KM_SLEEP);
    464 		strlcpy(kname, name, len);
    465 	} else {
    466 		kname = NULL;
    467 		len = 0;
    468 	}
    469 
    470 	chgsemcnt(kauth_cred_getuid(l->l_cred), 1);
    471 
    472 	ks = kmem_zalloc(sizeof(ksem_t), KM_SLEEP);
    473 	mutex_init(&ks->ks_lock, MUTEX_DEFAULT, IPL_NONE);
    474 	cv_init(&ks->ks_cv, "psem");
    475 	ks->ks_name = kname;
    476 	ks->ks_namelen = len;
    477 	ks->ks_mode = mode;
    478 	ks->ks_value = val;
    479 	ks->ks_ref = 1;
    480 
    481 	uc = l->l_cred;
    482 	ks->ks_uid = kauth_cred_geteuid(uc);
    483 	ks->ks_gid = kauth_cred_getegid(uc);
    484 
    485 	atomic_inc_uint(&nsems_total);
    486 	*ksret = ks;
    487 	return 0;
    488 }
    489 
    490 static void
    491 ksem_free(ksem_t *ks)
    492 {
    493 
    494 	KASSERT(!cv_has_waiters(&ks->ks_cv));
    495 
    496 	if (ks->ks_pshared_id) {
    497 		KASSERT(ks->ks_pshared_proc == NULL);
    498 		ksem_remove_pshared(ks);
    499 	}
    500 	if (ks->ks_name) {
    501 		KASSERT(ks->ks_namelen > 0);
    502 		kmem_free(ks->ks_name, ks->ks_namelen);
    503 	}
    504 	mutex_destroy(&ks->ks_lock);
    505 	cv_destroy(&ks->ks_cv);
    506 	kmem_free(ks, sizeof(ksem_t));
    507 
    508 	atomic_dec_uint(&nsems_total);
    509 	chgsemcnt(kauth_cred_getuid(curproc->p_cred), -1);
    510 }
    511 
    512 #define	KSEM_ID_IS_PSHARED(id)		\
    513 	(((id) & KSEM_MARKER_MASK) == KSEM_PSHARED_MARKER)
    514 
    515 static void
    516 ksem_release(ksem_t *ksem, int fd)
    517 {
    518 	bool destroy = false;
    519 
    520 	KASSERT(mutex_owned(&ksem->ks_lock));
    521 
    522 	KASSERT(ksem->ks_ref > 0);
    523 	if (--ksem->ks_ref == 0) {
    524 		/*
    525 		 * Destroy if the last reference and semaphore is unnamed,
    526 		 * or unlinked (for named semaphore).
    527 		 */
    528 		destroy = (ksem->ks_flags & KS_UNLINKED) ||
    529 		    (ksem->ks_name == NULL);
    530 	}
    531 	mutex_exit(&ksem->ks_lock);
    532 
    533 	if (destroy) {
    534 		ksem_free(ksem);
    535 	}
    536 	if (fd != -1) {
    537 		fd_putfile(fd);
    538 	}
    539 }
    540 
    541 int
    542 sys__ksem_init(struct lwp *l, const struct sys__ksem_init_args *uap,
    543     register_t *retval)
    544 {
    545 	/* {
    546 		unsigned int value;
    547 		intptr_t *idp;
    548 	} */
    549 
    550 	return do_ksem_init(l, SCARG(uap, value), SCARG(uap, idp),
    551 	    copyin, copyout);
    552 }
    553 
    554 int
    555 do_ksem_init(lwp_t *l, u_int val, intptr_t *idp, copyin_t docopyin,
    556     copyout_t docopyout)
    557 {
    558 	proc_t *p = l->l_proc;
    559 	ksem_t *ks;
    560 	file_t *fp;
    561 	intptr_t id, arg;
    562 	int fd, error;
    563 
    564 	/*
    565 	 * Newer versions of librt / libpthread pass us 'PSRD' in *idp to
    566 	 * indicate that a pshared semaphore is wanted.  In that case we
    567 	 * allocate globally unique ID and return that, rather than the
    568 	 * process-scoped file descriptor ID.
    569 	 */
    570 	error = (*docopyin)(idp, &arg, sizeof(*idp));
    571 	if (error) {
    572 		return error;
    573 	}
    574 
    575 	error = fd_allocfile(&fp, &fd);
    576 	if (error) {
    577 		return error;
    578 	}
    579 	fp->f_type = DTYPE_SEM;
    580 	fp->f_flag = FREAD | FWRITE;
    581 	fp->f_ops = &semops;
    582 
    583 	if (fd >= KSEM_MARKER_MIN) {
    584 		/*
    585 		 * This is super-unlikely, but we check for it anyway
    586 		 * because potential collisions with the pshared marker
    587 		 * would be bad.
    588 		 */
    589 		fd_abort(p, fp, fd);
    590 		return EMFILE;
    591 	}
    592 
    593 	/* Note the mode does not matter for anonymous semaphores. */
    594 	error = ksem_create(l, NULL, &ks, 0, val);
    595 	if (error) {
    596 		fd_abort(p, fp, fd);
    597 		return error;
    598 	}
    599 
    600 	if (arg == KSEM_PSHARED) {
    601 		ks->ks_pshared_proc = curproc;
    602 		ks->ks_pshared_fd = fd;
    603 		ksem_alloc_pshared_id(ks);
    604 		id = ks->ks_pshared_id;
    605 	} else {
    606 		id = (intptr_t)fd;
    607 	}
    608 
    609 	error = (*docopyout)(&id, idp, sizeof(*idp));
    610 	if (error) {
    611 		ksem_free(ks);
    612 		fd_abort(p, fp, fd);
    613 		return error;
    614 	}
    615 
    616 	fp->f_ksem = ks;
    617 	fd_affix(p, fp, fd);
    618 	return error;
    619 }
    620 
    621 int
    622 sys__ksem_open(struct lwp *l, const struct sys__ksem_open_args *uap,
    623     register_t *retval)
    624 {
    625 	/* {
    626 		const char *name;
    627 		int oflag;
    628 		mode_t mode;
    629 		unsigned int value;
    630 		intptr_t *idp;
    631 	} */
    632 
    633 	return do_ksem_open(l, SCARG(uap, name), SCARG(uap, oflag),
    634 	    SCARG(uap, mode), SCARG(uap, value), SCARG(uap, idp), copyout);
    635 }
    636 
    637 int
    638 do_ksem_open(struct lwp *l, const char *semname, int oflag, mode_t mode,
    639      unsigned int value, intptr_t *idp, copyout_t docopyout)
    640 {
    641 	char *name;
    642 	proc_t *p = l->l_proc;
    643 	ksem_t *ksnew = NULL, *ks;
    644 	file_t *fp;
    645 	intptr_t id;
    646 	int fd, error;
    647 
    648 	error = name_copyin(semname, &name);
    649 	if (error) {
    650 		return error;
    651 	}
    652 	error = fd_allocfile(&fp, &fd);
    653 	if (error) {
    654 		name_destroy(&name);
    655 		return error;
    656 	}
    657 	fp->f_type = DTYPE_SEM;
    658 	fp->f_flag = FREAD | FWRITE;
    659 	fp->f_ops = &semops;
    660 
    661 	if (fd >= KSEM_MARKER_MIN) {
    662 		/*
    663 		 * This is super-unlikely, but we check for it anyway
    664 		 * because potential collisions with the pshared marker
    665 		 * would be bad.
    666 		 */
    667 		fd_abort(p, fp, fd);
    668 		return EMFILE;
    669 	}
    670 
    671 	/*
    672 	 * The ID (file descriptor number) can be stored early.
    673 	 * Note that zero is a special value for libpthread.
    674 	 */
    675 	id = (intptr_t)fd;
    676 	error = (*docopyout)(&id, idp, sizeof(*idp));
    677 	if (error) {
    678 		goto err;
    679 	}
    680 
    681 	if (oflag & O_CREAT) {
    682 		/* Create a new semaphore. */
    683 		error = ksem_create(l, name, &ksnew, mode, value);
    684 		if (error) {
    685 			goto err;
    686 		}
    687 		KASSERT(ksnew != NULL);
    688 	}
    689 
    690 	/* Lookup for a semaphore with such name. */
    691 	mutex_enter(&ksem_lock);
    692 	ks = ksem_lookup(name);
    693 	name_destroy(&name);
    694 	if (ks) {
    695 		KASSERT(mutex_owned(&ks->ks_lock));
    696 		mutex_exit(&ksem_lock);
    697 
    698 		/* Check for exclusive create. */
    699 		if (oflag & O_EXCL) {
    700 			mutex_exit(&ks->ks_lock);
    701 			error = EEXIST;
    702 			goto err;
    703 		}
    704 		/*
    705 		 * Verify permissions.  If we can access it,
    706 		 * add the reference of this thread.
    707 		 */
    708 		error = ksem_perm(l, ks);
    709 		if (error == 0) {
    710 			ks->ks_ref++;
    711 		}
    712 		mutex_exit(&ks->ks_lock);
    713 		if (error) {
    714 			goto err;
    715 		}
    716 	} else {
    717 		/* Fail if not found and not creating. */
    718 		if ((oflag & O_CREAT) == 0) {
    719 			mutex_exit(&ksem_lock);
    720 			KASSERT(ksnew == NULL);
    721 			error = ENOENT;
    722 			goto err;
    723 		}
    724 
    725 		/* Check for the limit locked. */
    726 		if (nsems >= ksem_max) {
    727 			mutex_exit(&ksem_lock);
    728 			error = ENFILE;
    729 			goto err;
    730 		}
    731 
    732 		/*
    733 		 * Finally, insert semaphore into the list.
    734 		 * Note: it already has the initial reference.
    735 		 */
    736 		ks = ksnew;
    737 		LIST_INSERT_HEAD(&ksem_head, ks, ks_entry);
    738 		nsems++;
    739 		mutex_exit(&ksem_lock);
    740 
    741 		ksnew = NULL;
    742 	}
    743 	KASSERT(ks != NULL);
    744 	fp->f_ksem = ks;
    745 	fd_affix(p, fp, fd);
    746 err:
    747 	name_destroy(&name);
    748 	if (error) {
    749 		fd_abort(p, fp, fd);
    750 	}
    751 	if (ksnew) {
    752 		ksem_free(ksnew);
    753 	}
    754 	return error;
    755 }
    756 
    757 int
    758 sys__ksem_close(struct lwp *l, const struct sys__ksem_close_args *uap,
    759     register_t *retval)
    760 {
    761 	/* {
    762 		intptr_t id;
    763 	} */
    764 	intptr_t id = SCARG(uap, id);
    765 	int fd, error;
    766 	ksem_t *ks;
    767 
    768 	error = ksem_get(id, &ks, &fd);
    769 	if (error) {
    770 		return error;
    771 	}
    772 
    773 	/* This is only for named semaphores. */
    774 	if (ks->ks_name == NULL) {
    775 		error = EINVAL;
    776 	}
    777 	ksem_release(ks, -1);
    778 	if (error) {
    779 		if (fd != -1)
    780 			fd_putfile(fd);
    781 		return error;
    782 	}
    783 	return fd_close(fd);
    784 }
    785 
    786 static int
    787 ksem_read_fop(file_t *fp, off_t *offset, struct uio *uio, kauth_cred_t cred,
    788     int flags)
    789 {
    790 	size_t len;
    791 	char *name;
    792 	ksem_t *ks = fp->f_ksem;
    793 
    794 	mutex_enter(&ks->ks_lock);
    795 	len = ks->ks_namelen;
    796 	name = ks->ks_name;
    797 	mutex_exit(&ks->ks_lock);
    798 	if (name == NULL || len == 0)
    799 		return 0;
    800 	return uiomove(name, len, uio);
    801 }
    802 
    803 static int
    804 ksem_stat_fop(file_t *fp, struct stat *ub)
    805 {
    806 	ksem_t *ks = fp->f_ksem;
    807 
    808 	mutex_enter(&ks->ks_lock);
    809 
    810 	memset(ub, 0, sizeof(*ub));
    811 
    812 	ub->st_mode = ks->ks_mode | ((ks->ks_name && ks->ks_namelen)
    813 	    ? _S_IFLNK : _S_IFREG);
    814 	ub->st_uid = ks->ks_uid;
    815 	ub->st_gid = ks->ks_gid;
    816 	ub->st_size = ks->ks_value;
    817 	ub->st_blocks = (ub->st_size) ? 1 : 0;
    818 	ub->st_nlink = ks->ks_ref;
    819 	ub->st_blksize = 4096;
    820 
    821 	nanotime(&ub->st_atimespec);
    822 	ub->st_mtimespec = ub->st_ctimespec = ub->st_birthtimespec =
    823 	    ub->st_atimespec;
    824 
    825 	/*
    826 	 * Left as 0: st_dev, st_ino, st_rdev, st_flags, st_gen.
    827 	 * XXX (st_dev, st_ino) should be unique.
    828 	 */
    829 	mutex_exit(&ks->ks_lock);
    830 	return 0;
    831 }
    832 
    833 static int
    834 ksem_close_fop(file_t *fp)
    835 {
    836 	ksem_t *ks = fp->f_ksem;
    837 
    838 	mutex_enter(&ks->ks_lock);
    839 
    840 	if (ks->ks_pshared_id) {
    841 		if (ks->ks_pshared_proc != curproc) {
    842 			/* Do nothing if this is not the creator. */
    843 			mutex_exit(&ks->ks_lock);
    844 			return 0;
    845 		}
    846 		/* Mark this semaphore as dead. */
    847 		ks->ks_pshared_proc = NULL;
    848 	}
    849 
    850 	ksem_release(ks, -1);
    851 	return 0;
    852 }
    853 
    854 int
    855 sys__ksem_unlink(struct lwp *l, const struct sys__ksem_unlink_args *uap,
    856     register_t *retval)
    857 {
    858 	/* {
    859 		const char *name;
    860 	} */
    861 	char *name;
    862 	ksem_t *ks;
    863 	u_int refcnt;
    864 	int error;
    865 
    866 	error = name_copyin(SCARG(uap, name), &name);
    867 	if (error)
    868 		return error;
    869 
    870 	mutex_enter(&ksem_lock);
    871 	ks = ksem_lookup(name);
    872 	name_destroy(&name);
    873 	if (ks == NULL) {
    874 		mutex_exit(&ksem_lock);
    875 		return ENOENT;
    876 	}
    877 	KASSERT(mutex_owned(&ks->ks_lock));
    878 
    879 	/* Verify permissions. */
    880 	error = ksem_perm(l, ks);
    881 	if (error) {
    882 		mutex_exit(&ks->ks_lock);
    883 		mutex_exit(&ksem_lock);
    884 		return error;
    885 	}
    886 
    887 	/* Remove from the global list. */
    888 	LIST_REMOVE(ks, ks_entry);
    889 	nsems--;
    890 	mutex_exit(&ksem_lock);
    891 
    892 	refcnt = ks->ks_ref;
    893 	if (refcnt) {
    894 		/* Mark as unlinked, if there are references. */
    895 		ks->ks_flags |= KS_UNLINKED;
    896 	}
    897 	mutex_exit(&ks->ks_lock);
    898 
    899 	if (refcnt == 0) {
    900 		ksem_free(ks);
    901 	}
    902 	return 0;
    903 }
    904 
    905 int
    906 sys__ksem_post(struct lwp *l, const struct sys__ksem_post_args *uap,
    907     register_t *retval)
    908 {
    909 	/* {
    910 		intptr_t id;
    911 	} */
    912 	int fd, error;
    913 	ksem_t *ks;
    914 
    915 	error = ksem_get(SCARG(uap, id), &ks, &fd);
    916 	if (error) {
    917 		return error;
    918 	}
    919 	KASSERT(mutex_owned(&ks->ks_lock));
    920 	if (ks->ks_value == SEM_VALUE_MAX) {
    921 		error = EOVERFLOW;
    922 		goto out;
    923 	}
    924 	ks->ks_value++;
    925 	if (ks->ks_waiters) {
    926 		cv_broadcast(&ks->ks_cv);
    927 	}
    928 out:
    929 	ksem_release(ks, fd);
    930 	return error;
    931 }
    932 
    933 int
    934 do_ksem_wait(lwp_t *l, intptr_t id, bool try_p, struct timespec *abstime)
    935 {
    936 	int fd, error, timeo;
    937 	ksem_t *ks;
    938 
    939 	error = ksem_get(id, &ks, &fd);
    940 	if (error) {
    941 		return error;
    942 	}
    943 	KASSERT(mutex_owned(&ks->ks_lock));
    944 	while (ks->ks_value == 0) {
    945 		ks->ks_waiters++;
    946 		if (!try_p && abstime != NULL) {
    947 			error = ts2timo(CLOCK_REALTIME, TIMER_ABSTIME, abstime,
    948 			    &timeo, NULL);
    949 			if (error != 0)
    950 				goto out;
    951 		} else {
    952 			timeo = 0;
    953 		}
    954 		error = try_p ? EAGAIN : cv_timedwait_sig(&ks->ks_cv,
    955 		    &ks->ks_lock, timeo);
    956 		ks->ks_waiters--;
    957 		if (error)
    958 			goto out;
    959 	}
    960 	ks->ks_value--;
    961 out:
    962 	ksem_release(ks, fd);
    963 	return error;
    964 }
    965 
    966 int
    967 sys__ksem_wait(struct lwp *l, const struct sys__ksem_wait_args *uap,
    968     register_t *retval)
    969 {
    970 	/* {
    971 		intptr_t id;
    972 	} */
    973 
    974 	return do_ksem_wait(l, SCARG(uap, id), false, NULL);
    975 }
    976 
    977 int
    978 sys__ksem_timedwait(struct lwp *l, const struct sys__ksem_timedwait_args *uap,
    979     register_t *retval)
    980 {
    981 	/* {
    982 		intptr_t id;
    983 		const struct timespec *abstime;
    984 	} */
    985 	struct timespec ts;
    986 	int error;
    987 
    988 	error = copyin(SCARG(uap, abstime), &ts, sizeof(ts));
    989 	if (error != 0)
    990 		return error;
    991 
    992 	if (ts.tv_sec < 0 || ts.tv_nsec < 0 || ts.tv_nsec >= 1000000000)
    993 		return EINVAL;
    994 
    995 	error = do_ksem_wait(l, SCARG(uap, id), false, &ts);
    996 	if (error == EWOULDBLOCK)
    997 		error = ETIMEDOUT;
    998 	return error;
    999 }
   1000 
   1001 int
   1002 sys__ksem_trywait(struct lwp *l, const struct sys__ksem_trywait_args *uap,
   1003     register_t *retval)
   1004 {
   1005 	/* {
   1006 		intptr_t id;
   1007 	} */
   1008 
   1009 	return do_ksem_wait(l, SCARG(uap, id), true, NULL);
   1010 }
   1011 
   1012 int
   1013 sys__ksem_getvalue(struct lwp *l, const struct sys__ksem_getvalue_args *uap,
   1014     register_t *retval)
   1015 {
   1016 	/* {
   1017 		intptr_t id;
   1018 		unsigned int *value;
   1019 	} */
   1020 	int fd, error;
   1021 	ksem_t *ks;
   1022 	unsigned int val;
   1023 
   1024 	error = ksem_get(SCARG(uap, id), &ks, &fd);
   1025 	if (error) {
   1026 		return error;
   1027 	}
   1028 	KASSERT(mutex_owned(&ks->ks_lock));
   1029 	val = ks->ks_value;
   1030 	ksem_release(ks, fd);
   1031 
   1032 	return copyout(&val, SCARG(uap, value), sizeof(val));
   1033 }
   1034 
   1035 int
   1036 sys__ksem_destroy(struct lwp *l, const struct sys__ksem_destroy_args *uap,
   1037     register_t *retval)
   1038 {
   1039 	/* {
   1040 		intptr_t id;
   1041 	} */
   1042 	int fd, error;
   1043 	ksem_t *ks;
   1044 
   1045 	intptr_t id = SCARG(uap, id);
   1046 
   1047 	error = ksem_get(id, &ks, &fd);
   1048 	if (error) {
   1049 		return error;
   1050 	}
   1051 	KASSERT(mutex_owned(&ks->ks_lock));
   1052 
   1053 	/* Operation is only for unnamed semaphores. */
   1054 	if (ks->ks_name != NULL) {
   1055 		error = EINVAL;
   1056 		goto out;
   1057 	}
   1058 	/* Cannot destroy if there are waiters. */
   1059 	if (ks->ks_waiters) {
   1060 		error = EBUSY;
   1061 		goto out;
   1062 	}
   1063 	if (KSEM_ID_IS_PSHARED(id)) {
   1064 		/* Cannot destroy if we did't create it. */
   1065 		KASSERT(fd == -1);
   1066 		KASSERT(ks->ks_pshared_proc != NULL);
   1067 		if (ks->ks_pshared_proc != curproc) {
   1068 			error = EINVAL;
   1069 			goto out;
   1070 		}
   1071 		fd = ks->ks_pshared_fd;
   1072 
   1073 		/* Mark it dead so subsequent lookups fail. */
   1074 		ks->ks_pshared_proc = NULL;
   1075 
   1076 		/* Do an fd_getfile() to for the benefit of fd_close(). */
   1077 		file_t *fp __diagused = fd_getfile(fd);
   1078 		KASSERT(fp != NULL);
   1079 		KASSERT(fp->f_ksem == ks);
   1080 	}
   1081 out:
   1082 	ksem_release(ks, -1);
   1083 	if (error) {
   1084 		if (!KSEM_ID_IS_PSHARED(id))
   1085 			fd_putfile(fd);
   1086 		return error;
   1087 	}
   1088 	return fd_close(fd);
   1089 }
   1090