xref: /netbsd-src/sys/kern/sysv_shm.c (revision 1b9578b8c2c1f848eeb16dabbfd7d1f0d9fdefbd)
1 /*	$NetBSD: sysv_shm.c,v 1.120 2011/06/12 03:35:56 rmind Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999, 2007 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center, and by Mindaugas Rasiukevicius.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1994 Adam Glass and Charles M. Hannum.  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  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by Adam Glass and Charles M.
47  *	Hannum.
48  * 4. The names of the authors may not be used to endorse or promote products
49  *    derived from this software without specific prior written permission.
50  *
51  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
52  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
53  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
54  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
55  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
56  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
60  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61  */
62 
63 #include <sys/cdefs.h>
64 __KERNEL_RCSID(0, "$NetBSD: sysv_shm.c,v 1.120 2011/06/12 03:35:56 rmind Exp $");
65 
66 #define SYSVSHM
67 
68 #include <sys/param.h>
69 #include <sys/kernel.h>
70 #include <sys/kmem.h>
71 #include <sys/shm.h>
72 #include <sys/mutex.h>
73 #include <sys/mman.h>
74 #include <sys/stat.h>
75 #include <sys/sysctl.h>
76 #include <sys/mount.h>		/* XXX for <sys/syscallargs.h> */
77 #include <sys/syscallargs.h>
78 #include <sys/queue.h>
79 #include <sys/kauth.h>
80 
81 #include <uvm/uvm_extern.h>
82 #include <uvm/uvm_object.h>
83 
84 struct shmmap_entry {
85 	SLIST_ENTRY(shmmap_entry) next;
86 	vaddr_t va;
87 	int shmid;
88 };
89 
90 int			shm_nused		__cacheline_aligned;
91 struct shmid_ds *	shmsegs			__read_mostly;
92 
93 static kmutex_t		shm_lock		__cacheline_aligned;
94 static kcondvar_t *	shm_cv			__cacheline_aligned;
95 static int		shm_last_free		__cacheline_aligned;
96 static size_t		shm_committed		__cacheline_aligned;
97 static int		shm_use_phys		__read_mostly;
98 
99 static kcondvar_t	shm_realloc_cv;
100 static bool		shm_realloc_state;
101 static u_int		shm_realloc_disable;
102 
103 struct shmmap_state {
104 	unsigned int nitems;
105 	unsigned int nrefs;
106 	SLIST_HEAD(, shmmap_entry) entries;
107 };
108 
109 #ifdef SHMDEBUG
110 #define SHMPRINTF(a) printf a
111 #else
112 #define SHMPRINTF(a)
113 #endif
114 
115 static int shmrealloc(int);
116 
117 /*
118  * Find the shared memory segment by the identifier.
119  *  => must be called with shm_lock held;
120  */
121 static struct shmid_ds *
122 shm_find_segment_by_shmid(int shmid)
123 {
124 	int segnum;
125 	struct shmid_ds *shmseg;
126 
127 	KASSERT(mutex_owned(&shm_lock));
128 
129 	segnum = IPCID_TO_IX(shmid);
130 	if (segnum < 0 || segnum >= shminfo.shmmni)
131 		return NULL;
132 	shmseg = &shmsegs[segnum];
133 	if ((shmseg->shm_perm.mode & SHMSEG_ALLOCATED) == 0)
134 		return NULL;
135 	if ((shmseg->shm_perm.mode &
136 	    (SHMSEG_REMOVED|SHMSEG_RMLINGER)) == SHMSEG_REMOVED)
137 		return NULL;
138 	if (shmseg->shm_perm._seq != IPCID_TO_SEQ(shmid))
139 		return NULL;
140 
141 	return shmseg;
142 }
143 
144 /*
145  * Free memory segment.
146  *  => must be called with shm_lock held;
147  */
148 static void
149 shm_free_segment(int segnum)
150 {
151 	struct shmid_ds *shmseg;
152 	size_t size;
153 	bool wanted;
154 
155 	KASSERT(mutex_owned(&shm_lock));
156 
157 	shmseg = &shmsegs[segnum];
158 	SHMPRINTF(("shm freeing key 0x%lx seq 0x%x\n",
159 	    shmseg->shm_perm._key, shmseg->shm_perm._seq));
160 
161 	size = (shmseg->shm_segsz + PGOFSET) & ~PGOFSET;
162 	wanted = (shmseg->shm_perm.mode & SHMSEG_WANTED);
163 
164 	shmseg->_shm_internal = NULL;
165 	shm_committed -= btoc(size);
166 	shm_nused--;
167 	shmseg->shm_perm.mode = SHMSEG_FREE;
168 	shm_last_free = segnum;
169 	if (wanted == true)
170 		cv_broadcast(&shm_cv[segnum]);
171 }
172 
173 /*
174  * Delete entry from the shm map.
175  *  => must be called with shm_lock held;
176  */
177 static struct uvm_object *
178 shm_delete_mapping(struct shmmap_state *shmmap_s,
179     struct shmmap_entry *shmmap_se)
180 {
181 	struct uvm_object *uobj = NULL;
182 	struct shmid_ds *shmseg;
183 	int segnum;
184 
185 	KASSERT(mutex_owned(&shm_lock));
186 
187 	segnum = IPCID_TO_IX(shmmap_se->shmid);
188 	shmseg = &shmsegs[segnum];
189 	SLIST_REMOVE(&shmmap_s->entries, shmmap_se, shmmap_entry, next);
190 	shmmap_s->nitems--;
191 	shmseg->shm_dtime = time_second;
192 	if ((--shmseg->shm_nattch <= 0) &&
193 	    (shmseg->shm_perm.mode & SHMSEG_REMOVED)) {
194 		uobj = shmseg->_shm_internal;
195 		shm_free_segment(segnum);
196 	}
197 
198 	return uobj;
199 }
200 
201 /*
202  * Get a non-shared shm map for that vmspace.  Note, that memory
203  * allocation might be performed with lock held.
204  */
205 static struct shmmap_state *
206 shmmap_getprivate(struct proc *p)
207 {
208 	struct shmmap_state *oshmmap_s, *shmmap_s;
209 	struct shmmap_entry *oshmmap_se, *shmmap_se;
210 
211 	KASSERT(mutex_owned(&shm_lock));
212 
213 	/* 1. A shm map with refcnt = 1, used by ourselves, thus return */
214 	oshmmap_s = (struct shmmap_state *)p->p_vmspace->vm_shm;
215 	if (oshmmap_s && oshmmap_s->nrefs == 1)
216 		return oshmmap_s;
217 
218 	/* 2. No shm map preset - create a fresh one */
219 	shmmap_s = kmem_zalloc(sizeof(struct shmmap_state), KM_SLEEP);
220 	shmmap_s->nrefs = 1;
221 	SLIST_INIT(&shmmap_s->entries);
222 	p->p_vmspace->vm_shm = (void *)shmmap_s;
223 
224 	if (oshmmap_s == NULL)
225 		return shmmap_s;
226 
227 	SHMPRINTF(("shmmap_getprivate: vm %p split (%d entries), was used by %d\n",
228 	    p->p_vmspace, oshmmap_s->nitems, oshmmap_s->nrefs));
229 
230 	/* 3. A shared shm map, copy to a fresh one and adjust refcounts */
231 	SLIST_FOREACH(oshmmap_se, &oshmmap_s->entries, next) {
232 		shmmap_se = kmem_alloc(sizeof(struct shmmap_entry), KM_SLEEP);
233 		shmmap_se->va = oshmmap_se->va;
234 		shmmap_se->shmid = oshmmap_se->shmid;
235 		SLIST_INSERT_HEAD(&shmmap_s->entries, shmmap_se, next);
236 	}
237 	shmmap_s->nitems = oshmmap_s->nitems;
238 	oshmmap_s->nrefs--;
239 
240 	return shmmap_s;
241 }
242 
243 /*
244  * Lock/unlock the memory.
245  *  => must be called with shm_lock held;
246  *  => called from one place, thus, inline;
247  */
248 static inline int
249 shm_memlock(struct lwp *l, struct shmid_ds *shmseg, int shmid, int cmd)
250 {
251 	struct proc *p = l->l_proc;
252 	struct shmmap_entry *shmmap_se;
253 	struct shmmap_state *shmmap_s;
254 	size_t size;
255 	int error;
256 
257 	KASSERT(mutex_owned(&shm_lock));
258 	shmmap_s = shmmap_getprivate(p);
259 
260 	/* Find our shared memory address by shmid */
261 	SLIST_FOREACH(shmmap_se, &shmmap_s->entries, next) {
262 		if (shmmap_se->shmid != shmid)
263 			continue;
264 
265 		size = (shmseg->shm_segsz + PGOFSET) & ~PGOFSET;
266 
267 		if (cmd == SHM_LOCK &&
268 		    (shmseg->shm_perm.mode & SHMSEG_WIRED) == 0) {
269 			/* Wire the object and map, then tag it */
270 			error = uvm_obj_wirepages(shmseg->_shm_internal,
271 			    0, size);
272 			if (error)
273 				return EIO;
274 			error = uvm_map_pageable(&p->p_vmspace->vm_map,
275 			    shmmap_se->va, shmmap_se->va + size, false, 0);
276 			if (error) {
277 				uvm_obj_unwirepages(shmseg->_shm_internal,
278 				    0, size);
279 				if (error == EFAULT)
280 					error = ENOMEM;
281 				return error;
282 			}
283 			shmseg->shm_perm.mode |= SHMSEG_WIRED;
284 
285 		} else if (cmd == SHM_UNLOCK &&
286 		    (shmseg->shm_perm.mode & SHMSEG_WIRED) != 0) {
287 			/* Unwire the object and map, then untag it */
288 			uvm_obj_unwirepages(shmseg->_shm_internal, 0, size);
289 			error = uvm_map_pageable(&p->p_vmspace->vm_map,
290 			    shmmap_se->va, shmmap_se->va + size, true, 0);
291 			if (error)
292 				return EIO;
293 			shmseg->shm_perm.mode &= ~SHMSEG_WIRED;
294 		}
295 	}
296 
297 	return 0;
298 }
299 
300 /*
301  * Unmap shared memory.
302  */
303 int
304 sys_shmdt(struct lwp *l, const struct sys_shmdt_args *uap, register_t *retval)
305 {
306 	/* {
307 		syscallarg(const void *) shmaddr;
308 	} */
309 	struct proc *p = l->l_proc;
310 	struct shmmap_state *shmmap_s1, *shmmap_s;
311 	struct shmmap_entry *shmmap_se;
312 	struct uvm_object *uobj;
313 	struct shmid_ds *shmseg;
314 	size_t size;
315 
316 	mutex_enter(&shm_lock);
317 	/* In case of reallocation, we will wait for completion */
318 	while (__predict_false(shm_realloc_state))
319 		cv_wait(&shm_realloc_cv, &shm_lock);
320 
321 	shmmap_s1 = (struct shmmap_state *)p->p_vmspace->vm_shm;
322 	if (shmmap_s1 == NULL) {
323 		mutex_exit(&shm_lock);
324 		return EINVAL;
325 	}
326 
327 	/* Find the map entry */
328 	SLIST_FOREACH(shmmap_se, &shmmap_s1->entries, next)
329 		if (shmmap_se->va == (vaddr_t)SCARG(uap, shmaddr))
330 			break;
331 	if (shmmap_se == NULL) {
332 		mutex_exit(&shm_lock);
333 		return EINVAL;
334 	}
335 
336 	shmmap_s = shmmap_getprivate(p);
337 	if (shmmap_s != shmmap_s1) {
338 		/* Map has been copied, lookup entry in new map */
339 		SLIST_FOREACH(shmmap_se, &shmmap_s->entries, next)
340 			if (shmmap_se->va == (vaddr_t)SCARG(uap, shmaddr))
341 				break;
342 		if (shmmap_se == NULL) {
343 			mutex_exit(&shm_lock);
344 			return EINVAL;
345 		}
346 	}
347 
348 	SHMPRINTF(("shmdt: vm %p: remove %d @%lx\n",
349 	    p->p_vmspace, shmmap_se->shmid, shmmap_se->va));
350 
351 	/* Delete the entry from shm map */
352 	uobj = shm_delete_mapping(shmmap_s, shmmap_se);
353 	shmseg = &shmsegs[IPCID_TO_IX(shmmap_se->shmid)];
354 	size = (shmseg->shm_segsz + PGOFSET) & ~PGOFSET;
355 	mutex_exit(&shm_lock);
356 
357 	uvm_deallocate(&p->p_vmspace->vm_map, shmmap_se->va, size);
358 	if (uobj != NULL) {
359 		uao_detach(uobj);
360 	}
361 	kmem_free(shmmap_se, sizeof(struct shmmap_entry));
362 
363 	return 0;
364 }
365 
366 /*
367  * Map shared memory.
368  */
369 int
370 sys_shmat(struct lwp *l, const struct sys_shmat_args *uap, register_t *retval)
371 {
372 	/* {
373 		syscallarg(int) shmid;
374 		syscallarg(const void *) shmaddr;
375 		syscallarg(int) shmflg;
376 	} */
377 	int error, flags = 0;
378 	struct proc *p = l->l_proc;
379 	kauth_cred_t cred = l->l_cred;
380 	struct shmid_ds *shmseg;
381 	struct shmmap_state *shmmap_s;
382 	struct shmmap_entry *shmmap_se;
383 	struct uvm_object *uobj;
384 	struct vmspace *vm;
385 	vaddr_t attach_va;
386 	vm_prot_t prot;
387 	vsize_t size;
388 
389 	/* Allocate a new map entry and set it */
390 	shmmap_se = kmem_alloc(sizeof(struct shmmap_entry), KM_SLEEP);
391 	shmmap_se->shmid = SCARG(uap, shmid);
392 
393 	mutex_enter(&shm_lock);
394 	/* In case of reallocation, we will wait for completion */
395 	while (__predict_false(shm_realloc_state))
396 		cv_wait(&shm_realloc_cv, &shm_lock);
397 
398 	shmseg = shm_find_segment_by_shmid(SCARG(uap, shmid));
399 	if (shmseg == NULL) {
400 		error = EINVAL;
401 		goto err;
402 	}
403 	error = ipcperm(cred, &shmseg->shm_perm,
404 	    (SCARG(uap, shmflg) & SHM_RDONLY) ? IPC_R : IPC_R|IPC_W);
405 	if (error)
406 		goto err;
407 
408 	vm = p->p_vmspace;
409 	shmmap_s = (struct shmmap_state *)vm->vm_shm;
410 	if (shmmap_s && shmmap_s->nitems >= shminfo.shmseg) {
411 		error = EMFILE;
412 		goto err;
413 	}
414 
415 	size = (shmseg->shm_segsz + PGOFSET) & ~PGOFSET;
416 	prot = VM_PROT_READ;
417 	if ((SCARG(uap, shmflg) & SHM_RDONLY) == 0)
418 		prot |= VM_PROT_WRITE;
419 	if (SCARG(uap, shmaddr)) {
420 		flags |= UVM_FLAG_FIXED;
421 		if (SCARG(uap, shmflg) & SHM_RND)
422 			attach_va =
423 			    (vaddr_t)SCARG(uap, shmaddr) & ~(SHMLBA-1);
424 		else if (((vaddr_t)SCARG(uap, shmaddr) & (SHMLBA-1)) == 0)
425 			attach_va = (vaddr_t)SCARG(uap, shmaddr);
426 		else {
427 			error = EINVAL;
428 			goto err;
429 		}
430 	} else {
431 		/* This is just a hint to uvm_map() about where to put it. */
432 		attach_va = p->p_emul->e_vm_default_addr(p,
433 		    (vaddr_t)vm->vm_daddr, size);
434 	}
435 
436 	/*
437 	 * Create a map entry, add it to the list and increase the counters.
438 	 * The lock will be dropped before the mapping, disable reallocation.
439 	 */
440 	shmmap_s = shmmap_getprivate(p);
441 	SLIST_INSERT_HEAD(&shmmap_s->entries, shmmap_se, next);
442 	shmmap_s->nitems++;
443 	shmseg->shm_lpid = p->p_pid;
444 	shmseg->shm_nattch++;
445 	shm_realloc_disable++;
446 	mutex_exit(&shm_lock);
447 
448 	/*
449 	 * Add a reference to the memory object, map it to the
450 	 * address space, and lock the memory, if needed.
451 	 */
452 	uobj = shmseg->_shm_internal;
453 	uao_reference(uobj);
454 	error = uvm_map(&vm->vm_map, &attach_va, size, uobj, 0, 0,
455 	    UVM_MAPFLAG(prot, prot, UVM_INH_SHARE, UVM_ADV_RANDOM, flags));
456 	if (error)
457 		goto err_detach;
458 	if (shm_use_phys || (shmseg->shm_perm.mode & SHMSEG_WIRED)) {
459 		error = uvm_map_pageable(&vm->vm_map, attach_va,
460 		    attach_va + size, false, 0);
461 		if (error) {
462 			if (error == EFAULT)
463 				error = ENOMEM;
464 			uvm_deallocate(&vm->vm_map, attach_va, size);
465 			goto err_detach;
466 		}
467 	}
468 
469 	/* Set the new address, and update the time */
470 	mutex_enter(&shm_lock);
471 	shmmap_se->va = attach_va;
472 	shmseg->shm_atime = time_second;
473 	shm_realloc_disable--;
474 	retval[0] = attach_va;
475 	SHMPRINTF(("shmat: vm %p: add %d @%lx\n",
476 	    p->p_vmspace, shmmap_se->shmid, attach_va));
477 err:
478 	cv_broadcast(&shm_realloc_cv);
479 	mutex_exit(&shm_lock);
480 	if (error && shmmap_se) {
481 		kmem_free(shmmap_se, sizeof(struct shmmap_entry));
482 	}
483 	return error;
484 
485 err_detach:
486 	uao_detach(uobj);
487 	mutex_enter(&shm_lock);
488 	uobj = shm_delete_mapping(shmmap_s, shmmap_se);
489 	shm_realloc_disable--;
490 	cv_broadcast(&shm_realloc_cv);
491 	mutex_exit(&shm_lock);
492 	if (uobj != NULL) {
493 		uao_detach(uobj);
494 	}
495 	kmem_free(shmmap_se, sizeof(struct shmmap_entry));
496 	return error;
497 }
498 
499 /*
500  * Shared memory control operations.
501  */
502 int
503 sys___shmctl50(struct lwp *l, const struct sys___shmctl50_args *uap,
504     register_t *retval)
505 {
506 	/* {
507 		syscallarg(int) shmid;
508 		syscallarg(int) cmd;
509 		syscallarg(struct shmid_ds *) buf;
510 	} */
511 	struct shmid_ds shmbuf;
512 	int cmd, error;
513 
514 	cmd = SCARG(uap, cmd);
515 	if (cmd == IPC_SET) {
516 		error = copyin(SCARG(uap, buf), &shmbuf, sizeof(shmbuf));
517 		if (error)
518 			return error;
519 	}
520 
521 	error = shmctl1(l, SCARG(uap, shmid), cmd,
522 	    (cmd == IPC_SET || cmd == IPC_STAT) ? &shmbuf : NULL);
523 
524 	if (error == 0 && cmd == IPC_STAT)
525 		error = copyout(&shmbuf, SCARG(uap, buf), sizeof(shmbuf));
526 
527 	return error;
528 }
529 
530 int
531 shmctl1(struct lwp *l, int shmid, int cmd, struct shmid_ds *shmbuf)
532 {
533 	struct uvm_object *uobj = NULL;
534 	kauth_cred_t cred = l->l_cred;
535 	struct shmid_ds *shmseg;
536 	int error = 0;
537 
538 	mutex_enter(&shm_lock);
539 	/* In case of reallocation, we will wait for completion */
540 	while (__predict_false(shm_realloc_state))
541 		cv_wait(&shm_realloc_cv, &shm_lock);
542 
543 	shmseg = shm_find_segment_by_shmid(shmid);
544 	if (shmseg == NULL) {
545 		mutex_exit(&shm_lock);
546 		return EINVAL;
547 	}
548 
549 	switch (cmd) {
550 	case IPC_STAT:
551 		if ((error = ipcperm(cred, &shmseg->shm_perm, IPC_R)) != 0)
552 			break;
553 		memcpy(shmbuf, shmseg, sizeof(struct shmid_ds));
554 		break;
555 	case IPC_SET:
556 		if ((error = ipcperm(cred, &shmseg->shm_perm, IPC_M)) != 0)
557 			break;
558 		shmseg->shm_perm.uid = shmbuf->shm_perm.uid;
559 		shmseg->shm_perm.gid = shmbuf->shm_perm.gid;
560 		shmseg->shm_perm.mode =
561 		    (shmseg->shm_perm.mode & ~ACCESSPERMS) |
562 		    (shmbuf->shm_perm.mode & ACCESSPERMS);
563 		shmseg->shm_ctime = time_second;
564 		break;
565 	case IPC_RMID:
566 		if ((error = ipcperm(cred, &shmseg->shm_perm, IPC_M)) != 0)
567 			break;
568 		shmseg->shm_perm._key = IPC_PRIVATE;
569 		shmseg->shm_perm.mode |= SHMSEG_REMOVED;
570 		if (shmseg->shm_nattch <= 0) {
571 			uobj = shmseg->_shm_internal;
572 			shm_free_segment(IPCID_TO_IX(shmid));
573 		}
574 		break;
575 	case SHM_LOCK:
576 	case SHM_UNLOCK:
577 		if ((error = kauth_authorize_generic(cred,
578 		    KAUTH_GENERIC_ISSUSER, NULL)) != 0)
579 			break;
580 		error = shm_memlock(l, shmseg, shmid, cmd);
581 		break;
582 	default:
583 		error = EINVAL;
584 	}
585 
586 	mutex_exit(&shm_lock);
587 	if (uobj != NULL)
588 		uao_detach(uobj);
589 	return error;
590 }
591 
592 /*
593  * Try to take an already existing segment.
594  *  => must be called with shm_lock held;
595  *  => called from one place, thus, inline;
596  */
597 static inline int
598 shmget_existing(struct lwp *l, const struct sys_shmget_args *uap, int mode,
599     register_t *retval)
600 {
601 	struct shmid_ds *shmseg;
602 	kauth_cred_t cred = l->l_cred;
603 	int segnum, error;
604 again:
605 	KASSERT(mutex_owned(&shm_lock));
606 
607 	/* Find segment by key */
608 	for (segnum = 0; segnum < shminfo.shmmni; segnum++)
609 		if ((shmsegs[segnum].shm_perm.mode & SHMSEG_ALLOCATED) &&
610 		    shmsegs[segnum].shm_perm._key == SCARG(uap, key))
611 			break;
612 	if (segnum == shminfo.shmmni) {
613 		/* Not found */
614 		return -1;
615 	}
616 
617 	shmseg = &shmsegs[segnum];
618 	if (shmseg->shm_perm.mode & SHMSEG_REMOVED) {
619 		/*
620 		 * This segment is in the process of being allocated.  Wait
621 		 * until it's done, and look the key up again (in case the
622 		 * allocation failed or it was freed).
623 		 */
624 		shmseg->shm_perm.mode |= SHMSEG_WANTED;
625 		error = cv_wait_sig(&shm_cv[segnum], &shm_lock);
626 		if (error)
627 			return error;
628 		goto again;
629 	}
630 
631 	/*
632 	 * First check the flags, to generate a useful error when a
633 	 * segment already exists.
634 	 */
635 	if ((SCARG(uap, shmflg) & (IPC_CREAT | IPC_EXCL)) ==
636 	    (IPC_CREAT | IPC_EXCL))
637 		return EEXIST;
638 
639 	/* Check the permission and segment size. */
640 	error = ipcperm(cred, &shmseg->shm_perm, mode);
641 	if (error)
642 		return error;
643 	if (SCARG(uap, size) && SCARG(uap, size) > shmseg->shm_segsz)
644 		return EINVAL;
645 
646 	*retval = IXSEQ_TO_IPCID(segnum, shmseg->shm_perm);
647 	return 0;
648 }
649 
650 int
651 sys_shmget(struct lwp *l, const struct sys_shmget_args *uap, register_t *retval)
652 {
653 	/* {
654 		syscallarg(key_t) key;
655 		syscallarg(size_t) size;
656 		syscallarg(int) shmflg;
657 	} */
658 	struct shmid_ds *shmseg;
659 	kauth_cred_t cred = l->l_cred;
660 	key_t key = SCARG(uap, key);
661 	size_t size;
662 	int error, mode, segnum;
663 	bool lockmem;
664 
665 	mode = SCARG(uap, shmflg) & ACCESSPERMS;
666 	if (SCARG(uap, shmflg) & _SHM_RMLINGER)
667 		mode |= SHMSEG_RMLINGER;
668 
669 	SHMPRINTF(("shmget: key 0x%lx size 0x%zx shmflg 0x%x mode 0x%x\n",
670 	    SCARG(uap, key), SCARG(uap, size), SCARG(uap, shmflg), mode));
671 
672 	mutex_enter(&shm_lock);
673 	/* In case of reallocation, we will wait for completion */
674 	while (__predict_false(shm_realloc_state))
675 		cv_wait(&shm_realloc_cv, &shm_lock);
676 
677 	if (key != IPC_PRIVATE) {
678 		error = shmget_existing(l, uap, mode, retval);
679 		if (error != -1) {
680 			mutex_exit(&shm_lock);
681 			return error;
682 		}
683 		if ((SCARG(uap, shmflg) & IPC_CREAT) == 0) {
684 			mutex_exit(&shm_lock);
685 			return ENOENT;
686 		}
687 	}
688 	error = 0;
689 
690 	/*
691 	 * Check the for the limits.
692 	 */
693 	size = SCARG(uap, size);
694 	if (size < shminfo.shmmin || size > shminfo.shmmax) {
695 		mutex_exit(&shm_lock);
696 		return EINVAL;
697 	}
698 	if (shm_nused >= shminfo.shmmni) {
699 		mutex_exit(&shm_lock);
700 		return ENOSPC;
701 	}
702 	size = (size + PGOFSET) & ~PGOFSET;
703 	if (shm_committed + btoc(size) > shminfo.shmall) {
704 		mutex_exit(&shm_lock);
705 		return ENOMEM;
706 	}
707 
708 	/* Find the first available segment */
709 	if (shm_last_free < 0) {
710 		for (segnum = 0; segnum < shminfo.shmmni; segnum++)
711 			if (shmsegs[segnum].shm_perm.mode & SHMSEG_FREE)
712 				break;
713 		KASSERT(segnum < shminfo.shmmni);
714 	} else {
715 		segnum = shm_last_free;
716 		shm_last_free = -1;
717 	}
718 
719 	/*
720 	 * Initialize the segment.
721 	 * We will drop the lock while allocating the memory, thus mark the
722 	 * segment present, but removed, that no other thread could take it.
723 	 * Also, disable reallocation, while lock is dropped.
724 	 */
725 	shmseg = &shmsegs[segnum];
726 	shmseg->shm_perm.mode = SHMSEG_ALLOCATED | SHMSEG_REMOVED;
727 	shm_committed += btoc(size);
728 	shm_nused++;
729 	lockmem = shm_use_phys;
730 	shm_realloc_disable++;
731 	mutex_exit(&shm_lock);
732 
733 	/* Allocate the memory object and lock it if needed */
734 	shmseg->_shm_internal = uao_create(size, 0);
735 	if (lockmem) {
736 		/* Wire the pages and tag it */
737 		error = uvm_obj_wirepages(shmseg->_shm_internal, 0, size);
738 		if (error) {
739 			uao_detach(shmseg->_shm_internal);
740 			mutex_enter(&shm_lock);
741 			shm_free_segment(segnum);
742 			shm_realloc_disable--;
743 			mutex_exit(&shm_lock);
744 			return error;
745 		}
746 	}
747 
748 	/*
749 	 * Please note, while segment is marked, there are no need to hold the
750 	 * lock, while setting it (except shm_perm.mode).
751 	 */
752 	shmseg->shm_perm._key = SCARG(uap, key);
753 	shmseg->shm_perm._seq = (shmseg->shm_perm._seq + 1) & 0x7fff;
754 	*retval = IXSEQ_TO_IPCID(segnum, shmseg->shm_perm);
755 
756 	shmseg->shm_perm.cuid = shmseg->shm_perm.uid = kauth_cred_geteuid(cred);
757 	shmseg->shm_perm.cgid = shmseg->shm_perm.gid = kauth_cred_getegid(cred);
758 	shmseg->shm_segsz = SCARG(uap, size);
759 	shmseg->shm_cpid = l->l_proc->p_pid;
760 	shmseg->shm_lpid = shmseg->shm_nattch = 0;
761 	shmseg->shm_atime = shmseg->shm_dtime = 0;
762 	shmseg->shm_ctime = time_second;
763 
764 	/*
765 	 * Segment is initialized.
766 	 * Enter the lock, mark as allocated, and notify waiters (if any).
767 	 * Also, unmark the state of reallocation.
768 	 */
769 	mutex_enter(&shm_lock);
770 	shmseg->shm_perm.mode = (shmseg->shm_perm.mode & SHMSEG_WANTED) |
771 	    (mode & (ACCESSPERMS | SHMSEG_RMLINGER)) |
772 	    SHMSEG_ALLOCATED | (lockmem ? SHMSEG_WIRED : 0);
773 	if (shmseg->shm_perm.mode & SHMSEG_WANTED) {
774 		shmseg->shm_perm.mode &= ~SHMSEG_WANTED;
775 		cv_broadcast(&shm_cv[segnum]);
776 	}
777 	shm_realloc_disable--;
778 	cv_broadcast(&shm_realloc_cv);
779 	mutex_exit(&shm_lock);
780 
781 	return error;
782 }
783 
784 void
785 shmfork(struct vmspace *vm1, struct vmspace *vm2)
786 {
787 	struct shmmap_state *shmmap_s;
788 	struct shmmap_entry *shmmap_se;
789 
790 	SHMPRINTF(("shmfork %p->%p\n", vm1, vm2));
791 	mutex_enter(&shm_lock);
792 	vm2->vm_shm = vm1->vm_shm;
793 	if (vm1->vm_shm) {
794 		shmmap_s = (struct shmmap_state *)vm1->vm_shm;
795 		SLIST_FOREACH(shmmap_se, &shmmap_s->entries, next)
796 			shmsegs[IPCID_TO_IX(shmmap_se->shmid)].shm_nattch++;
797 		shmmap_s->nrefs++;
798 	}
799 	mutex_exit(&shm_lock);
800 }
801 
802 void
803 shmexit(struct vmspace *vm)
804 {
805 	struct shmmap_state *shmmap_s;
806 	struct shmmap_entry *shmmap_se;
807 
808 	mutex_enter(&shm_lock);
809 	shmmap_s = (struct shmmap_state *)vm->vm_shm;
810 	if (shmmap_s == NULL) {
811 		mutex_exit(&shm_lock);
812 		return;
813 	}
814 	vm->vm_shm = NULL;
815 
816 	if (--shmmap_s->nrefs > 0) {
817 		SHMPRINTF(("shmexit: vm %p drop ref (%d entries), refs = %d\n",
818 		    vm, shmmap_s->nitems, shmmap_s->nrefs));
819 		SLIST_FOREACH(shmmap_se, &shmmap_s->entries, next) {
820 			shmsegs[IPCID_TO_IX(shmmap_se->shmid)].shm_nattch--;
821 		}
822 		mutex_exit(&shm_lock);
823 		return;
824 	}
825 
826 	SHMPRINTF(("shmexit: vm %p cleanup (%d entries)\n", vm, shmmap_s->nitems));
827 	if (shmmap_s->nitems == 0) {
828 		mutex_exit(&shm_lock);
829 		kmem_free(shmmap_s, sizeof(struct shmmap_state));
830 		return;
831 	}
832 
833 	/*
834 	 * Delete the entry from shm map.
835 	 */
836 	for (;;) {
837 		struct shmid_ds *shmseg;
838 		struct uvm_object *uobj;
839 		size_t sz;
840 
841 		shmmap_se = SLIST_FIRST(&shmmap_s->entries);
842 		KASSERT(shmmap_se != NULL);
843 
844 		shmseg = &shmsegs[IPCID_TO_IX(shmmap_se->shmid)];
845 		sz = (shmseg->shm_segsz + PGOFSET) & ~PGOFSET;
846 		/* shm_delete_mapping() removes from the list. */
847 		uobj = shm_delete_mapping(shmmap_s, shmmap_se);
848 		mutex_exit(&shm_lock);
849 
850 		uvm_deallocate(&vm->vm_map, shmmap_se->va, sz);
851 		if (uobj != NULL) {
852 			uao_detach(uobj);
853 		}
854 		kmem_free(shmmap_se, sizeof(struct shmmap_entry));
855 
856 		if (SLIST_EMPTY(&shmmap_s->entries)) {
857 			break;
858 		}
859 		mutex_enter(&shm_lock);
860 		KASSERT(!SLIST_EMPTY(&shmmap_s->entries));
861 	}
862 	kmem_free(shmmap_s, sizeof(struct shmmap_state));
863 }
864 
865 static int
866 shmrealloc(int newshmni)
867 {
868 	vaddr_t v;
869 	struct shmid_ds *oldshmsegs, *newshmsegs;
870 	kcondvar_t *newshm_cv, *oldshm_cv;
871 	size_t sz;
872 	int i, lsegid, oldshmni;
873 
874 	if (newshmni < 1)
875 		return EINVAL;
876 
877 	/* Allocate new memory area */
878 	sz = ALIGN(newshmni * sizeof(struct shmid_ds)) +
879 	    ALIGN(newshmni * sizeof(kcondvar_t));
880 	v = uvm_km_alloc(kernel_map, round_page(sz), 0,
881 	    UVM_KMF_WIRED|UVM_KMF_ZERO);
882 	if (v == 0)
883 		return ENOMEM;
884 
885 	mutex_enter(&shm_lock);
886 	while (shm_realloc_state || shm_realloc_disable)
887 		cv_wait(&shm_realloc_cv, &shm_lock);
888 
889 	/*
890 	 * Get the number of last segment.  Fail we are trying to
891 	 * reallocate less memory than we use.
892 	 */
893 	lsegid = 0;
894 	for (i = 0; i < shminfo.shmmni; i++)
895 		if ((shmsegs[i].shm_perm.mode & SHMSEG_FREE) == 0)
896 			lsegid = i;
897 	if (lsegid >= newshmni) {
898 		mutex_exit(&shm_lock);
899 		uvm_km_free(kernel_map, v, sz, UVM_KMF_WIRED);
900 		return EBUSY;
901 	}
902 	shm_realloc_state = true;
903 
904 	newshmsegs = (void *)v;
905 	newshm_cv = (void *)((uintptr_t)newshmsegs +
906 	    ALIGN(newshmni * sizeof(struct shmid_ds)));
907 
908 	/* Copy all memory to the new area */
909 	for (i = 0; i < shm_nused; i++)
910 		(void)memcpy(&newshmsegs[i], &shmsegs[i],
911 		    sizeof(newshmsegs[0]));
912 
913 	/* Mark as free all new segments, if there is any */
914 	for (; i < newshmni; i++) {
915 		cv_init(&newshm_cv[i], "shmwait");
916 		newshmsegs[i].shm_perm.mode = SHMSEG_FREE;
917 		newshmsegs[i].shm_perm._seq = 0;
918 	}
919 
920 	oldshmsegs = shmsegs;
921 	oldshmni = shminfo.shmmni;
922 	shminfo.shmmni = newshmni;
923 	shmsegs = newshmsegs;
924 	shm_cv = newshm_cv;
925 
926 	/* Reallocation completed - notify all waiters, if any */
927 	shm_realloc_state = false;
928 	cv_broadcast(&shm_realloc_cv);
929 	mutex_exit(&shm_lock);
930 
931 	/* Release now unused resources. */
932 	oldshm_cv = (void *)((uintptr_t)oldshmsegs +
933 	    ALIGN(oldshmni * sizeof(struct shmid_ds)));
934 	for (i = 0; i < oldshmni; i++)
935 		cv_destroy(&oldshm_cv[i]);
936 
937 	sz = ALIGN(oldshmni * sizeof(struct shmid_ds)) +
938 	    ALIGN(oldshmni * sizeof(kcondvar_t));
939 	uvm_km_free(kernel_map, (vaddr_t)oldshmsegs, sz, UVM_KMF_WIRED);
940 
941 	return 0;
942 }
943 
944 void
945 shminit(void)
946 {
947 	vaddr_t v;
948 	size_t sz;
949 	int i;
950 
951 	mutex_init(&shm_lock, MUTEX_DEFAULT, IPL_NONE);
952 	cv_init(&shm_realloc_cv, "shmrealc");
953 
954 	/* Allocate the wired memory for our structures */
955 	sz = ALIGN(shminfo.shmmni * sizeof(struct shmid_ds)) +
956 	    ALIGN(shminfo.shmmni * sizeof(kcondvar_t));
957 	v = uvm_km_alloc(kernel_map, round_page(sz), 0,
958 	    UVM_KMF_WIRED|UVM_KMF_ZERO);
959 	if (v == 0)
960 		panic("sysv_shm: cannot allocate memory");
961 	shmsegs = (void *)v;
962 	shm_cv = (void *)((uintptr_t)shmsegs +
963 	    ALIGN(shminfo.shmmni * sizeof(struct shmid_ds)));
964 
965 	if (shminfo.shmmax == 0)
966 		shminfo.shmmax = max(physmem / 4, 1024) * PAGE_SIZE;
967 	else
968 		shminfo.shmmax *= PAGE_SIZE;
969 	shminfo.shmall = shminfo.shmmax / PAGE_SIZE;
970 
971 	for (i = 0; i < shminfo.shmmni; i++) {
972 		cv_init(&shm_cv[i], "shmwait");
973 		shmsegs[i].shm_perm.mode = SHMSEG_FREE;
974 		shmsegs[i].shm_perm._seq = 0;
975 	}
976 	shm_last_free = 0;
977 	shm_nused = 0;
978 	shm_committed = 0;
979 	shm_realloc_disable = 0;
980 	shm_realloc_state = false;
981 }
982 
983 static int
984 sysctl_ipc_shmmni(SYSCTLFN_ARGS)
985 {
986 	int newsize, error;
987 	struct sysctlnode node;
988 	node = *rnode;
989 	node.sysctl_data = &newsize;
990 
991 	newsize = shminfo.shmmni;
992 	error = sysctl_lookup(SYSCTLFN_CALL(&node));
993 	if (error || newp == NULL)
994 		return error;
995 
996 	sysctl_unlock();
997 	error = shmrealloc(newsize);
998 	sysctl_relock();
999 	return error;
1000 }
1001 
1002 static int
1003 sysctl_ipc_shmmaxpgs(SYSCTLFN_ARGS)
1004 {
1005 	uint32_t newsize;
1006 	int error;
1007 	struct sysctlnode node;
1008 	node = *rnode;
1009 	node.sysctl_data = &newsize;
1010 
1011 	newsize = shminfo.shmall;
1012 	error = sysctl_lookup(SYSCTLFN_CALL(&node));
1013 	if (error || newp == NULL)
1014 		return error;
1015 
1016 	if (newsize < 1)
1017 		return EINVAL;
1018 
1019 	shminfo.shmall = newsize;
1020 	shminfo.shmmax = (uint64_t)shminfo.shmall * PAGE_SIZE;
1021 
1022 	return 0;
1023 }
1024 
1025 static int
1026 sysctl_ipc_shmmax(SYSCTLFN_ARGS)
1027 {
1028 	uint64_t newsize;
1029 	int error;
1030 	struct sysctlnode node;
1031 	node = *rnode;
1032 	node.sysctl_data = &newsize;
1033 
1034 	newsize = shminfo.shmmax;
1035 	error = sysctl_lookup(SYSCTLFN_CALL(&node));
1036 	if (error || newp == NULL)
1037 		return error;
1038 
1039 	if (newsize < PAGE_SIZE)
1040 		return EINVAL;
1041 
1042 	shminfo.shmmax = round_page(newsize);
1043 	shminfo.shmall = shminfo.shmmax >> PAGE_SHIFT;
1044 
1045 	return 0;
1046 }
1047 
1048 SYSCTL_SETUP(sysctl_ipc_shm_setup, "sysctl kern.ipc subtree setup")
1049 {
1050 
1051 	sysctl_createv(clog, 0, NULL, NULL,
1052 		CTLFLAG_PERMANENT,
1053 		CTLTYPE_NODE, "kern", NULL,
1054 		NULL, 0, NULL, 0,
1055 		CTL_KERN, CTL_EOL);
1056 	sysctl_createv(clog, 0, NULL, NULL,
1057 		CTLFLAG_PERMANENT,
1058 		CTLTYPE_NODE, "ipc",
1059 		SYSCTL_DESCR("SysV IPC options"),
1060 		NULL, 0, NULL, 0,
1061 		CTL_KERN, KERN_SYSVIPC, CTL_EOL);
1062 	sysctl_createv(clog, 0, NULL, NULL,
1063 		CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
1064 		CTLTYPE_QUAD, "shmmax",
1065 		SYSCTL_DESCR("Max shared memory segment size in bytes"),
1066 		sysctl_ipc_shmmax, 0, &shminfo.shmmax, 0,
1067 		CTL_KERN, KERN_SYSVIPC, KERN_SYSVIPC_SHMMAX, CTL_EOL);
1068 	sysctl_createv(clog, 0, NULL, NULL,
1069 		CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
1070 		CTLTYPE_INT, "shmmni",
1071 		SYSCTL_DESCR("Max number of shared memory identifiers"),
1072 		sysctl_ipc_shmmni, 0, &shminfo.shmmni, 0,
1073 		CTL_KERN, KERN_SYSVIPC, KERN_SYSVIPC_SHMMNI, CTL_EOL);
1074 	sysctl_createv(clog, 0, NULL, NULL,
1075 		CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
1076 		CTLTYPE_INT, "shmseg",
1077 		SYSCTL_DESCR("Max shared memory segments per process"),
1078 		NULL, 0, &shminfo.shmseg, 0,
1079 		CTL_KERN, KERN_SYSVIPC, KERN_SYSVIPC_SHMSEG, CTL_EOL);
1080 	sysctl_createv(clog, 0, NULL, NULL,
1081 		CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
1082 		CTLTYPE_INT, "shmmaxpgs",
1083 		SYSCTL_DESCR("Max amount of shared memory in pages"),
1084 		sysctl_ipc_shmmaxpgs, 0, &shminfo.shmall, 0,
1085 		CTL_KERN, KERN_SYSVIPC, KERN_SYSVIPC_SHMMAXPGS, CTL_EOL);
1086 	sysctl_createv(clog, 0, NULL, NULL,
1087 		CTLFLAG_PERMANENT | CTLFLAG_READWRITE,
1088 		CTLTYPE_INT, "shm_use_phys",
1089 		SYSCTL_DESCR("Enable/disable locking of shared memory in "
1090 		    "physical memory"), NULL, 0, &shm_use_phys, 0,
1091 		CTL_KERN, KERN_SYSVIPC, KERN_SYSVIPC_SHMUSEPHYS, CTL_EOL);
1092 }
1093