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