1 /* $FreeBSD: src/sys/kern/sysv_shm.c,v 1.45.2.6 2002/10/22 20:45:03 fjoe Exp $ */
2 /* $DragonFly: src/sys/kern/sysv_shm.c,v 1.21 2008/01/06 16:55:51 swildner Exp $ */
3 /* $NetBSD: sysv_shm.c,v 1.23 1994/07/04 23:25:12 glass Exp $ */
6 * Copyright (c) 1994 Adam Glass and Charles Hannum. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by Adam Glass and Charles
20 * 4. The names of the authors may not be used to endorse or promote products
21 * derived from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include "opt_compat.h"
36 #include "opt_sysvipc.h"
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/sysproto.h>
41 #include <sys/kernel.h>
42 #include <sys/sysctl.h>
45 #include <sys/malloc.h>
48 #include <sys/sysent.h>
52 #include <vm/vm_param.h>
55 #include <vm/vm_object.h>
56 #include <vm/vm_map.h>
57 #include <vm/vm_page.h>
58 #include <vm/vm_pager.h>
60 static MALLOC_DEFINE(M_SHM, "shm", "SVID compatible shared memory segments");
63 static int sys_oshmctl (struct proc *p, struct oshmctl_args *uap);
65 static int shmget_allocate_segment (struct proc *p, struct shmget_args *uap, int mode);
66 static int shmget_existing (struct proc *p, struct shmget_args *uap, int mode, int segnum);
68 /* XXX casting to (sy_call_t *) is bogus, as usual. */
69 static sy_call_t *shmcalls[] = {
70 (sy_call_t *)sys_shmat, (sy_call_t *)sys_oshmctl,
71 (sy_call_t *)sys_shmdt, (sy_call_t *)sys_shmget,
72 (sy_call_t *)sys_shmctl
75 #define SHMSEG_FREE 0x0200
76 #define SHMSEG_REMOVED 0x0400
77 #define SHMSEG_ALLOCATED 0x0800
78 #define SHMSEG_WANTED 0x1000
80 static int shm_last_free, shm_nused, shm_committed, shmalloced;
81 static struct shmid_ds *shmsegs;
84 /* vm_offset_t kva; */
85 vm_object_t shm_object;
93 static void shm_deallocate_segment (struct shmid_ds *);
94 static int shm_find_segment_by_key (key_t);
95 static struct shmid_ds *shm_find_segment_by_shmid (int);
96 static int shm_delete_mapping (struct vmspace *vm, struct shmmap_state *);
97 static void shmrealloc (void);
98 static void shminit (void *);
104 #define SHMMAXPGS 8192 /* note: sysv shared memory is swap backed */
107 #define SHMMAX (SHMMAXPGS*PAGE_SIZE)
119 #define SHMALL (SHMMAXPGS)
122 struct shminfo shminfo = {
130 static int shm_use_phys;
132 TUNABLE_INT("kern.ipc.shmmin", &shminfo.shmmin);
133 TUNABLE_INT("kern.ipc.shmmni", &shminfo.shmmni);
134 TUNABLE_INT("kern.ipc.shmseg", &shminfo.shmseg);
135 TUNABLE_INT("kern.ipc.shmmaxpgs", &shminfo.shmall);
136 TUNABLE_INT("kern.ipc.shm_use_phys", &shm_use_phys);
138 SYSCTL_INT(_kern_ipc, OID_AUTO, shmmax, CTLFLAG_RW, &shminfo.shmmax, 0, "");
139 SYSCTL_INT(_kern_ipc, OID_AUTO, shmmin, CTLFLAG_RW, &shminfo.shmmin, 0, "");
140 SYSCTL_INT(_kern_ipc, OID_AUTO, shmmni, CTLFLAG_RD, &shminfo.shmmni, 0, "");
141 SYSCTL_INT(_kern_ipc, OID_AUTO, shmseg, CTLFLAG_RW, &shminfo.shmseg, 0, "");
142 SYSCTL_INT(_kern_ipc, OID_AUTO, shmall, CTLFLAG_RW, &shminfo.shmall, 0, "");
143 SYSCTL_INT(_kern_ipc, OID_AUTO, shm_use_phys, CTLFLAG_RW, &shm_use_phys, 0, "");
146 shm_find_segment_by_key(key_t key)
150 for (i = 0; i < shmalloced; i++)
151 if ((shmsegs[i].shm_perm.mode & SHMSEG_ALLOCATED) &&
152 shmsegs[i].shm_perm.key == key)
157 static struct shmid_ds *
158 shm_find_segment_by_shmid(int shmid)
161 struct shmid_ds *shmseg;
163 segnum = IPCID_TO_IX(shmid);
164 if (segnum < 0 || segnum >= shmalloced)
166 shmseg = &shmsegs[segnum];
167 if ((shmseg->shm_perm.mode & (SHMSEG_ALLOCATED | SHMSEG_REMOVED))
168 != SHMSEG_ALLOCATED ||
169 shmseg->shm_perm.seq != IPCID_TO_SEQ(shmid))
175 shm_deallocate_segment(struct shmid_ds *shmseg)
177 struct shm_handle *shm_handle;
180 shm_handle = shmseg->shm_internal;
181 vm_object_deallocate(shm_handle->shm_object);
182 kfree((caddr_t)shm_handle, M_SHM);
183 shmseg->shm_internal = NULL;
184 size = round_page(shmseg->shm_segsz);
185 shm_committed -= btoc(size);
187 shmseg->shm_perm.mode = SHMSEG_FREE;
191 shm_delete_mapping(struct vmspace *vm, struct shmmap_state *shmmap_s)
193 struct shmid_ds *shmseg;
197 segnum = IPCID_TO_IX(shmmap_s->shmid);
198 shmseg = &shmsegs[segnum];
199 size = round_page(shmseg->shm_segsz);
200 result = vm_map_remove(&vm->vm_map, shmmap_s->va, shmmap_s->va + size);
201 if (result != KERN_SUCCESS)
203 shmmap_s->shmid = -1;
204 shmseg->shm_dtime = time_second;
205 if ((--shmseg->shm_nattch <= 0) &&
206 (shmseg->shm_perm.mode & SHMSEG_REMOVED)) {
207 shm_deallocate_segment(shmseg);
208 shm_last_free = segnum;
217 sys_shmdt(struct shmdt_args *uap)
219 struct proc *p = curproc;
220 struct shmmap_state *shmmap_s;
224 if (!jail_sysvipc_allowed && p->p_ucred->cr_prison != NULL)
228 shmmap_s = (struct shmmap_state *)p->p_vmspace->vm_shm;
229 if (shmmap_s == NULL) {
233 for (i = 0; i < shminfo.shmseg; i++, shmmap_s++) {
234 if (shmmap_s->shmid != -1 &&
235 shmmap_s->va == (vm_offset_t)uap->shmaddr)
238 if (i == shminfo.shmseg)
241 error = shm_delete_mapping(p->p_vmspace, shmmap_s);
251 sys_shmat(struct shmat_args *uap)
253 struct proc *p = curproc;
255 struct shmid_ds *shmseg;
256 struct shmmap_state *shmmap_s = NULL;
257 struct shm_handle *shm_handle;
258 vm_offset_t attach_va;
263 if (!jail_sysvipc_allowed && p->p_ucred->cr_prison != NULL)
268 shmmap_s = (struct shmmap_state *)p->p_vmspace->vm_shm;
269 if (shmmap_s == NULL) {
270 size = shminfo.shmseg * sizeof(struct shmmap_state);
271 shmmap_s = kmalloc(size, M_SHM, M_WAITOK);
272 for (i = 0; i < shminfo.shmseg; i++)
273 shmmap_s[i].shmid = -1;
274 if (p->p_vmspace->vm_shm != NULL) {
275 kfree(shmmap_s, M_SHM);
278 p->p_vmspace->vm_shm = (caddr_t)shmmap_s;
280 shmseg = shm_find_segment_by_shmid(uap->shmid);
281 if (shmseg == NULL) {
285 error = ipcperm(p, &shmseg->shm_perm,
286 (uap->shmflg & SHM_RDONLY) ? IPC_R : IPC_R|IPC_W);
289 for (i = 0; i < shminfo.shmseg; i++) {
290 if (shmmap_s->shmid == -1)
294 if (i >= shminfo.shmseg) {
298 size = round_page(shmseg->shm_segsz);
299 #ifdef VM_PROT_READ_IS_EXEC
300 prot = VM_PROT_READ | VM_PROT_EXECUTE;
304 if ((uap->shmflg & SHM_RDONLY) == 0)
305 prot |= VM_PROT_WRITE;
306 flags = MAP_ANON | MAP_SHARED;
309 if (uap->shmflg & SHM_RND) {
310 attach_va = (vm_offset_t)uap->shmaddr & ~(SHMLBA-1);
311 } else if (((vm_offset_t)uap->shmaddr & (SHMLBA-1)) == 0) {
312 attach_va = (vm_offset_t)uap->shmaddr;
319 * This is just a hint to vm_map_find() about where to put it.
321 attach_va = round_page((vm_offset_t)p->p_vmspace->vm_taddr + maxtsiz + maxdsiz);
324 shm_handle = shmseg->shm_internal;
325 vm_object_reference(shm_handle->shm_object);
326 rv = vm_map_find(&p->p_vmspace->vm_map,
327 shm_handle->shm_object, 0,
329 ((flags & MAP_FIXED) ? 0 : 1),
333 if (rv != KERN_SUCCESS) {
334 vm_object_deallocate(shm_handle->shm_object);
338 vm_map_inherit(&p->p_vmspace->vm_map,
339 attach_va, attach_va + size, VM_INHERIT_SHARE);
341 KKASSERT(shmmap_s->shmid == -1);
342 shmmap_s->va = attach_va;
343 shmmap_s->shmid = uap->shmid;
344 shmseg->shm_lpid = p->p_pid;
345 shmseg->shm_atime = time_second;
346 shmseg->shm_nattch++;
347 uap->sysmsg_result = attach_va;
355 struct ipc_perm shm_perm; /* operation perms */
356 int shm_segsz; /* size of segment (bytes) */
357 ushort shm_cpid; /* pid, creator */
358 ushort shm_lpid; /* pid, last operation */
359 short shm_nattch; /* no. of current attaches */
360 time_t shm_atime; /* last attach time */
361 time_t shm_dtime; /* last detach time */
362 time_t shm_ctime; /* last change time */
363 void *shm_handle; /* internal handle for shm segment */
366 struct oshmctl_args {
367 struct sysmsg sysmsg;
370 struct oshmid_ds *ubuf;
377 sys_oshmctl(struct proc *p, struct oshmctl_args *uap)
381 struct shmid_ds *shmseg;
382 struct oshmid_ds outbuf;
384 if (!jail_sysvipc_allowed && p->p_ucred->cr_prison != NULL)
388 shmseg = shm_find_segment_by_shmid(uap->shmid);
389 if (shmseg == NULL) {
396 error = ipcperm(p, &shmseg->shm_perm, IPC_R);
399 outbuf.shm_perm = shmseg->shm_perm;
400 outbuf.shm_segsz = shmseg->shm_segsz;
401 outbuf.shm_cpid = shmseg->shm_cpid;
402 outbuf.shm_lpid = shmseg->shm_lpid;
403 outbuf.shm_nattch = shmseg->shm_nattch;
404 outbuf.shm_atime = shmseg->shm_atime;
405 outbuf.shm_dtime = shmseg->shm_dtime;
406 outbuf.shm_ctime = shmseg->shm_ctime;
407 outbuf.shm_handle = shmseg->shm_internal;
408 error = copyout((caddr_t)&outbuf, uap->ubuf, sizeof(outbuf));
411 /* XXX casting to (sy_call_t *) is bogus, as usual. */
412 error = sys_shmctl((struct shmctl_args *)uap);
426 sys_shmctl(struct shmctl_args *uap)
428 struct proc *p = curproc;
430 struct shmid_ds inbuf;
431 struct shmid_ds *shmseg;
433 if (!jail_sysvipc_allowed && p->p_ucred->cr_prison != NULL)
437 shmseg = shm_find_segment_by_shmid(uap->shmid);
438 if (shmseg == NULL) {
445 error = ipcperm(p, &shmseg->shm_perm, IPC_R);
447 error = copyout(shmseg, uap->buf, sizeof(inbuf));
450 error = ipcperm(p, &shmseg->shm_perm, IPC_M);
452 error = copyin(uap->buf, &inbuf, sizeof(inbuf));
454 shmseg->shm_perm.uid = inbuf.shm_perm.uid;
455 shmseg->shm_perm.gid = inbuf.shm_perm.gid;
456 shmseg->shm_perm.mode =
457 (shmseg->shm_perm.mode & ~ACCESSPERMS) |
458 (inbuf.shm_perm.mode & ACCESSPERMS);
459 shmseg->shm_ctime = time_second;
463 error = ipcperm(p, &shmseg->shm_perm, IPC_M);
465 shmseg->shm_perm.key = IPC_PRIVATE;
466 shmseg->shm_perm.mode |= SHMSEG_REMOVED;
467 if (shmseg->shm_nattch <= 0) {
468 shm_deallocate_segment(shmseg);
469 shm_last_free = IPCID_TO_IX(uap->shmid);
487 shmget_existing(struct proc *p, struct shmget_args *uap, int mode, int segnum)
489 struct shmid_ds *shmseg;
492 shmseg = &shmsegs[segnum];
493 if (shmseg->shm_perm.mode & SHMSEG_REMOVED) {
495 * This segment is in the process of being allocated. Wait
496 * until it's done, and look the key up again (in case the
497 * allocation failed or it was freed).
499 shmseg->shm_perm.mode |= SHMSEG_WANTED;
500 error = tsleep((caddr_t)shmseg, PCATCH, "shmget", 0);
505 if ((uap->shmflg & (IPC_CREAT | IPC_EXCL)) == (IPC_CREAT | IPC_EXCL))
507 error = ipcperm(p, &shmseg->shm_perm, mode);
510 if (uap->size && uap->size > shmseg->shm_segsz)
512 uap->sysmsg_result = IXSEQ_TO_IPCID(segnum, shmseg->shm_perm);
517 shmget_allocate_segment(struct proc *p, struct shmget_args *uap, int mode)
519 int i, segnum, shmid, size;
520 struct ucred *cred = p->p_ucred;
521 struct shmid_ds *shmseg;
522 struct shm_handle *shm_handle;
524 if (uap->size < shminfo.shmmin || uap->size > shminfo.shmmax)
526 if (shm_nused >= shminfo.shmmni) /* any shmids left? */
528 size = round_page(uap->size);
529 if (shm_committed + btoc(size) > shminfo.shmall)
531 if (shm_last_free < 0) {
532 shmrealloc(); /* maybe expand the shmsegs[] array */
533 for (i = 0; i < shmalloced; i++)
534 if (shmsegs[i].shm_perm.mode & SHMSEG_FREE)
540 segnum = shm_last_free;
543 shmseg = &shmsegs[segnum];
545 * In case we sleep in malloc(), mark the segment present but deleted
546 * so that noone else tries to create the same key.
548 shmseg->shm_perm.mode = SHMSEG_ALLOCATED | SHMSEG_REMOVED;
549 shmseg->shm_perm.key = uap->key;
550 shmseg->shm_perm.seq = (shmseg->shm_perm.seq + 1) & 0x7fff;
551 shm_handle = kmalloc(sizeof(struct shm_handle), M_SHM, M_WAITOK);
552 shmid = IXSEQ_TO_IPCID(segnum, shmseg->shm_perm);
555 * We make sure that we have allocated a pager before we need
559 shm_handle->shm_object =
560 vm_pager_allocate(OBJT_PHYS, 0, size, VM_PROT_DEFAULT, 0);
562 shm_handle->shm_object =
563 vm_pager_allocate(OBJT_SWAP, 0, size, VM_PROT_DEFAULT, 0);
565 vm_object_clear_flag(shm_handle->shm_object, OBJ_ONEMAPPING);
566 vm_object_set_flag(shm_handle->shm_object, OBJ_NOSPLIT);
568 shmseg->shm_internal = shm_handle;
569 shmseg->shm_perm.cuid = shmseg->shm_perm.uid = cred->cr_uid;
570 shmseg->shm_perm.cgid = shmseg->shm_perm.gid = cred->cr_gid;
571 shmseg->shm_perm.mode = (shmseg->shm_perm.mode & SHMSEG_WANTED) |
572 (mode & ACCESSPERMS) | SHMSEG_ALLOCATED;
573 shmseg->shm_segsz = uap->size;
574 shmseg->shm_cpid = p->p_pid;
575 shmseg->shm_lpid = shmseg->shm_nattch = 0;
576 shmseg->shm_atime = shmseg->shm_dtime = 0;
577 shmseg->shm_ctime = time_second;
578 shm_committed += btoc(size);
580 if (shmseg->shm_perm.mode & SHMSEG_WANTED) {
582 * Somebody else wanted this key while we were asleep. Wake
585 shmseg->shm_perm.mode &= ~SHMSEG_WANTED;
586 wakeup((caddr_t)shmseg);
588 uap->sysmsg_result = shmid;
596 sys_shmget(struct shmget_args *uap)
598 struct proc *p = curproc;
599 int segnum, mode, error;
601 if (!jail_sysvipc_allowed && p->p_ucred->cr_prison != NULL)
604 mode = uap->shmflg & ACCESSPERMS;
607 if (uap->key != IPC_PRIVATE) {
609 segnum = shm_find_segment_by_key(uap->key);
611 error = shmget_existing(p, uap, mode, segnum);
616 if ((uap->shmflg & IPC_CREAT) == 0) {
621 error = shmget_allocate_segment(p, uap, mode);
628 * shmsys_args(int which, int a2, ...) (VARARGS)
633 sys_shmsys(struct shmsys_args *uap)
635 struct proc *p = curproc;
636 unsigned int which = (unsigned int)uap->which;
639 if (!jail_sysvipc_allowed && p->p_ucred->cr_prison != NULL)
642 if (which >= sizeof(shmcalls)/sizeof(shmcalls[0]))
645 bcopy(&uap->a2, &uap->which,
646 sizeof(struct shmsys_args) - offsetof(struct shmsys_args, a2));
647 error = ((*shmcalls[which])(uap));
654 shmfork(struct proc *p1, struct proc *p2)
656 struct shmmap_state *shmmap_s;
660 size = shminfo.shmseg * sizeof(struct shmmap_state);
661 shmmap_s = kmalloc(size, M_SHM, M_WAITOK);
662 bcopy((caddr_t)p1->p_vmspace->vm_shm, (caddr_t)shmmap_s, size);
663 p2->p_vmspace->vm_shm = (caddr_t)shmmap_s;
664 for (i = 0; i < shminfo.shmseg; i++, shmmap_s++)
665 if (shmmap_s->shmid != -1)
666 shmsegs[IPCID_TO_IX(shmmap_s->shmid)].shm_nattch++;
670 shmexit(struct vmspace *vm)
672 struct shmmap_state *base, *shm;
675 if ((base = (struct shmmap_state *)vm->vm_shm) != NULL) {
677 for (i = 0, shm = base; i < shminfo.shmseg; i++, shm++) {
678 if (shm->shmid != -1)
679 shm_delete_mapping(vm, shm);
689 struct shmid_ds *newsegs;
691 if (shmalloced >= shminfo.shmmni)
694 newsegs = kmalloc(shminfo.shmmni * sizeof(*newsegs), M_SHM, M_WAITOK);
695 for (i = 0; i < shmalloced; i++)
696 bcopy(&shmsegs[i], &newsegs[i], sizeof(newsegs[0]));
697 for (; i < shminfo.shmmni; i++) {
698 shmsegs[i].shm_perm.mode = SHMSEG_FREE;
699 shmsegs[i].shm_perm.seq = 0;
701 kfree(shmsegs, M_SHM);
703 shmalloced = shminfo.shmmni;
711 shminfo.shmmax = shminfo.shmall * PAGE_SIZE;
712 shmalloced = shminfo.shmmni;
713 shmsegs = kmalloc(shmalloced * sizeof(shmsegs[0]), M_SHM, M_WAITOK);
714 for (i = 0; i < shmalloced; i++) {
715 shmsegs[i].shm_perm.mode = SHMSEG_FREE;
716 shmsegs[i].shm_perm.seq = 0;
722 SYSINIT(sysv_shm, SI_SUB_SYSV_SHM, SI_ORDER_FIRST, shminit, NULL);