3 * Copyright (C) 1992, 1993 Krishna Balasubramanian
4 * Many improvements/fixes by Bruno Haible.
5 * Replaced `struct shm_desc' by `struct vm_area_struct', July 1994.
6 * Fixed the shm swap deallocation (shm_unuse()), August 1998 Andrea Arcangeli.
8 * /proc/sysvipc/shm support (c) 1999 Dragos Acostachioaie <dragos@iname.com>
9 * BIGMEM support, Andrea Arcangeli <andrea@suse.de>
10 * SMP thread shm, Jean-Luc Boyard <jean-luc.boyard@siemens.fr>
11 * HIGHMEM support, Ingo Molnar <mingo@redhat.com>
12 * Make shmmax, shmall, shmmni sysctl'able, Christoph Rohland <cr@sap.com>
13 * Shared /dev/zero support, Kanoj Sarcar <kanoj@sgi.com>
14 * Move the mm functionality over to mm/shmem.c, Christoph Rohland <cr@sap.com>
18 #include <linux/config.h>
19 #include <linux/slab.h>
21 #include <linux/hugetlb.h>
22 #include <linux/shm.h>
23 #include <linux/init.h>
24 #include <linux/file.h>
25 #include <linux/mman.h>
26 #include <linux/proc_fs.h>
27 #include <linux/shmem_fs.h>
28 #include <linux/security.h>
29 #include <asm/uaccess.h>
33 #define shm_flags shm_perm.mode
35 static struct file_operations shm_file_operations;
36 static struct vm_operations_struct shm_vm_ops;
38 static struct ipc_ids shm_ids;
40 #define shm_lock(id) ((struct shmid_kernel*)ipc_lock(&shm_ids,id))
41 #define shm_unlock(shp) ipc_unlock(&(shp)->shm_perm)
42 #define shm_get(id) ((struct shmid_kernel*)ipc_get(&shm_ids,id))
43 #define shm_buildid(id, seq) \
44 ipc_buildid(&shm_ids, id, seq)
46 static int newseg (key_t key, int shmflg, size_t size);
47 static void shm_open (struct vm_area_struct *shmd);
48 static void shm_close (struct vm_area_struct *shmd);
50 static int sysvipc_shm_read_proc(char *buffer, char **start, off_t offset, int length, int *eof, void *data);
53 size_t shm_ctlmax = SHMMAX;
54 size_t shm_ctlall = SHMALL;
55 int shm_ctlmni = SHMMNI;
57 static int shm_tot; /* total number of shared memory pages */
59 void __init shm_init (void)
61 ipc_init_ids(&shm_ids, 1);
63 create_proc_read_entry("sysvipc/shm", 0, 0, sysvipc_shm_read_proc, NULL);
67 static inline int shm_checkid(struct shmid_kernel *s, int id)
69 if (ipc_checkid(&shm_ids,&s->shm_perm,id))
74 static inline struct shmid_kernel *shm_rmid(int id)
76 return (struct shmid_kernel *)ipc_rmid(&shm_ids,id);
79 static inline int shm_addid(struct shmid_kernel *shp)
81 return ipc_addid(&shm_ids, &shp->shm_perm, shm_ctlmni+1);
86 static inline void shm_inc (int id) {
87 struct shmid_kernel *shp;
89 if(!(shp = shm_lock(id)))
91 shp->shm_atim = get_seconds();
92 shp->shm_lprid = current->tgid;
97 /* This is called by fork, once for every shm attach. */
98 static void shm_open (struct vm_area_struct *shmd)
100 shm_inc (shmd->vm_file->f_dentry->d_inode->i_ino);
104 * shm_destroy - free the struct shmid_kernel
106 * @shp: struct to free
108 * It has to be called with shp and shm_ids.sem locked,
109 * but returns with shp unlocked and freed.
111 static void shm_destroy (struct shmid_kernel *shp)
113 shm_tot -= (shp->shm_segsz + PAGE_SIZE - 1) >> PAGE_SHIFT;
116 if (!is_file_hugepages(shp->shm_file))
117 shmem_lock(shp->shm_file, 0);
118 fput (shp->shm_file);
119 security_shm_free(shp);
120 ipc_rcu_free(shp, sizeof(struct shmid_kernel));
124 * remove the attach descriptor shmd.
125 * free memory for segment if it is marked destroyed.
126 * The descriptor has already been removed from the current->mm->mmap list
127 * and will later be kfree()d.
129 static void shm_close (struct vm_area_struct *shmd)
131 struct file * file = shmd->vm_file;
132 int id = file->f_dentry->d_inode->i_ino;
133 struct shmid_kernel *shp;
136 /* remove from the list of attaches of the shm segment */
137 if(!(shp = shm_lock(id)))
139 shp->shm_lprid = current->tgid;
140 shp->shm_dtim = get_seconds();
142 if(shp->shm_nattch == 0 &&
143 shp->shm_flags & SHM_DEST)
150 static int shm_mmap(struct file * file, struct vm_area_struct * vma)
153 vma->vm_ops = &shm_vm_ops;
154 shm_inc(file->f_dentry->d_inode->i_ino);
158 static struct file_operations shm_file_operations = {
162 static struct vm_operations_struct shm_vm_ops = {
163 .open = shm_open, /* callback for a new vm-area open */
164 .close = shm_close, /* callback for when the vm-area is released */
165 .nopage = shmem_nopage,
167 .set_policy = shmem_set_policy,
168 .get_policy = shmem_get_policy,
172 static int newseg (key_t key, int shmflg, size_t size)
175 struct shmid_kernel *shp;
176 int numpages = (size + PAGE_SIZE -1) >> PAGE_SHIFT;
181 if (size < SHMMIN || size > shm_ctlmax)
184 if (shm_tot + numpages >= shm_ctlall)
187 shp = ipc_rcu_alloc(sizeof(*shp));
191 shp->shm_perm.key = key;
192 shp->shm_flags = (shmflg & S_IRWXUGO);
194 shp->shm_perm.security = NULL;
195 error = security_shm_alloc(shp);
197 ipc_rcu_free(shp, sizeof(*shp));
201 if (shmflg & SHM_HUGETLB)
202 file = hugetlb_zero_setup(size);
204 sprintf (name, "SYSV%08x", key);
205 file = shmem_file_setup(name, size, VM_ACCOUNT);
207 error = PTR_ERR(file);
216 shp->shm_cprid = current->tgid;
218 shp->shm_atim = shp->shm_dtim = 0;
219 shp->shm_ctim = get_seconds();
220 shp->shm_segsz = size;
222 shp->id = shm_buildid(id,shp->shm_perm.seq);
223 shp->shm_file = file;
224 file->f_dentry->d_inode->i_ino = shp->id;
225 if (shmflg & SHM_HUGETLB)
226 set_file_hugepages(file);
228 file->f_op = &shm_file_operations;
236 security_shm_free(shp);
237 ipc_rcu_free(shp, sizeof(*shp));
241 asmlinkage long sys_shmget (key_t key, size_t size, int shmflg)
243 struct shmid_kernel *shp;
247 if (key == IPC_PRIVATE) {
248 err = newseg(key, shmflg, size);
249 } else if ((id = ipc_findkey(&shm_ids, key)) == -1) {
250 if (!(shmflg & IPC_CREAT))
253 err = newseg(key, shmflg, size);
254 } else if ((shmflg & IPC_CREAT) && (shmflg & IPC_EXCL)) {
260 if (shp->shm_segsz < size)
262 else if (ipcperms(&shp->shm_perm, shmflg))
265 int shmid = shm_buildid(id, shp->shm_perm.seq);
266 err = security_shm_associate(shp, shmflg);
277 static inline unsigned long copy_shmid_to_user(void __user *buf, struct shmid64_ds *in, int version)
281 return copy_to_user(buf, in, sizeof(*in));
286 ipc64_perm_to_ipc_perm(&in->shm_perm, &out.shm_perm);
287 out.shm_segsz = in->shm_segsz;
288 out.shm_atime = in->shm_atime;
289 out.shm_dtime = in->shm_dtime;
290 out.shm_ctime = in->shm_ctime;
291 out.shm_cpid = in->shm_cpid;
292 out.shm_lpid = in->shm_lpid;
293 out.shm_nattch = in->shm_nattch;
295 return copy_to_user(buf, &out, sizeof(out));
308 static inline unsigned long copy_shmid_from_user(struct shm_setbuf *out, void __user *buf, int version)
313 struct shmid64_ds tbuf;
315 if (copy_from_user(&tbuf, buf, sizeof(tbuf)))
318 out->uid = tbuf.shm_perm.uid;
319 out->gid = tbuf.shm_perm.gid;
320 out->mode = tbuf.shm_flags;
326 struct shmid_ds tbuf_old;
328 if (copy_from_user(&tbuf_old, buf, sizeof(tbuf_old)))
331 out->uid = tbuf_old.shm_perm.uid;
332 out->gid = tbuf_old.shm_perm.gid;
333 out->mode = tbuf_old.shm_flags;
342 static inline unsigned long copy_shminfo_to_user(void __user *buf, struct shminfo64 *in, int version)
346 return copy_to_user(buf, in, sizeof(*in));
351 if(in->shmmax > INT_MAX)
352 out.shmmax = INT_MAX;
354 out.shmmax = (int)in->shmmax;
356 out.shmmin = in->shmmin;
357 out.shmmni = in->shmmni;
358 out.shmseg = in->shmseg;
359 out.shmall = in->shmall;
361 return copy_to_user(buf, &out, sizeof(out));
368 static void shm_get_stat(unsigned long *rss, unsigned long *swp)
375 for (i = 0; i <= shm_ids.max_id; i++) {
376 struct shmid_kernel *shp;
383 inode = shp->shm_file->f_dentry->d_inode;
385 if (is_file_hugepages(shp->shm_file)) {
386 struct address_space *mapping = inode->i_mapping;
387 *rss += (HPAGE_SIZE/PAGE_SIZE)*mapping->nrpages;
389 struct shmem_inode_info *info = SHMEM_I(inode);
390 spin_lock(&info->lock);
391 *rss += inode->i_mapping->nrpages;
392 *swp += info->swapped;
393 spin_unlock(&info->lock);
398 asmlinkage long sys_shmctl (int shmid, int cmd, struct shmid_ds __user *buf)
400 struct shm_setbuf setbuf;
401 struct shmid_kernel *shp;
404 if (cmd < 0 || shmid < 0) {
409 version = ipc_parse_version(&cmd);
411 switch (cmd) { /* replace with proc interface ? */
414 struct shminfo64 shminfo;
416 err = security_shm_shmctl(NULL, cmd);
420 memset(&shminfo,0,sizeof(shminfo));
421 shminfo.shmmni = shminfo.shmseg = shm_ctlmni;
422 shminfo.shmmax = shm_ctlmax;
423 shminfo.shmall = shm_ctlall;
425 shminfo.shmmin = SHMMIN;
426 if(copy_shminfo_to_user (buf, &shminfo, version))
428 /* reading a integer is always atomic */
436 struct shm_info shm_info;
438 err = security_shm_shmctl(NULL, cmd);
442 memset(&shm_info,0,sizeof(shm_info));
444 shm_info.used_ids = shm_ids.in_use;
445 shm_get_stat (&shm_info.shm_rss, &shm_info.shm_swp);
446 shm_info.shm_tot = shm_tot;
447 shm_info.swap_attempts = 0;
448 shm_info.swap_successes = 0;
449 err = shm_ids.max_id;
451 if(copy_to_user (buf, &shm_info, sizeof(shm_info))) {
456 err = err < 0 ? 0 : err;
462 struct shmid64_ds tbuf;
464 memset(&tbuf, 0, sizeof(tbuf));
465 shp = shm_lock(shmid);
469 } else if(cmd==SHM_STAT) {
471 if (shmid > shm_ids.max_id)
473 result = shm_buildid(shmid, shp->shm_perm.seq);
475 err = shm_checkid(shp,shmid);
481 if (ipcperms (&shp->shm_perm, S_IRUGO))
483 err = security_shm_shmctl(shp, cmd);
486 kernel_to_ipc64_perm(&shp->shm_perm, &tbuf.shm_perm);
487 tbuf.shm_segsz = shp->shm_segsz;
488 tbuf.shm_atime = shp->shm_atim;
489 tbuf.shm_dtime = shp->shm_dtim;
490 tbuf.shm_ctime = shp->shm_ctim;
491 tbuf.shm_cpid = shp->shm_cprid;
492 tbuf.shm_lpid = shp->shm_lprid;
493 if (!is_file_hugepages(shp->shm_file))
494 tbuf.shm_nattch = shp->shm_nattch;
496 tbuf.shm_nattch = file_count(shp->shm_file) - 1;
498 if(copy_shmid_to_user (buf, &tbuf, version))
507 /* Allow superuser to lock segment in memory */
508 /* Should the pages be faulted in here or leave it to user? */
509 /* need to determine interaction with current->swappable */
510 if (!capable(CAP_IPC_LOCK)) {
515 shp = shm_lock(shmid);
520 err = shm_checkid(shp,shmid);
524 err = security_shm_shmctl(shp, cmd);
529 if (!is_file_hugepages(shp->shm_file))
530 shmem_lock(shp->shm_file, 1);
531 shp->shm_flags |= SHM_LOCKED;
533 if (!is_file_hugepages(shp->shm_file))
534 shmem_lock(shp->shm_file, 0);
535 shp->shm_flags &= ~SHM_LOCKED;
543 * We cannot simply remove the file. The SVID states
544 * that the block remains until the last person
545 * detaches from it, then is deleted. A shmat() on
546 * an RMID segment is legal in older Linux and if
547 * we change it apps break...
549 * Instead we set a destroyed flag, and then blow
550 * the name away when the usage hits zero.
553 shp = shm_lock(shmid);
557 err = shm_checkid(shp, shmid);
561 if (current->euid != shp->shm_perm.uid &&
562 current->euid != shp->shm_perm.cuid &&
563 !capable(CAP_SYS_ADMIN)) {
568 err = security_shm_shmctl(shp, cmd);
572 if (shp->shm_nattch){
573 shp->shm_flags |= SHM_DEST;
574 /* Do not find it any more */
575 shp->shm_perm.key = IPC_PRIVATE;
585 if (copy_shmid_from_user (&setbuf, buf, version)) {
590 shp = shm_lock(shmid);
594 err = shm_checkid(shp,shmid);
598 if (current->euid != shp->shm_perm.uid &&
599 current->euid != shp->shm_perm.cuid &&
600 !capable(CAP_SYS_ADMIN)) {
604 err = security_shm_shmctl(shp, cmd);
608 shp->shm_perm.uid = setbuf.uid;
609 shp->shm_perm.gid = setbuf.gid;
610 shp->shm_flags = (shp->shm_flags & ~S_IRWXUGO)
611 | (setbuf.mode & S_IRWXUGO);
612 shp->shm_ctim = get_seconds();
634 * Fix shmaddr, allocate descriptor, map shm, add attach descriptor to lists.
636 * NOTE! Despite the name, this is NOT a direct system call entrypoint. The
637 * "raddr" thing points to kernel space, and there has to be a wrapper around
640 long do_shmat(int shmid, char __user *shmaddr, int shmflg, ulong *raddr)
642 struct shmid_kernel *shp;
649 unsigned long o_flags;
656 } else if ((addr = (ulong)shmaddr)) {
657 if (addr & (SHMLBA-1)) {
658 if (shmflg & SHM_RND)
659 addr &= ~(SHMLBA-1); /* round down */
661 #ifndef __ARCH_FORCE_SHMLBA
662 if (addr & ~PAGE_MASK)
666 flags = MAP_SHARED | MAP_FIXED;
668 if ((shmflg & SHM_REMAP))
674 if (shmflg & SHM_RDONLY) {
679 prot = PROT_READ | PROT_WRITE;
681 acc_mode = S_IRUGO | S_IWUGO;
685 * We cannot rely on the fs check since SYSV IPC does have an
686 * additional creator id...
688 shp = shm_lock(shmid);
693 err = shm_checkid(shp,shmid);
698 if (ipcperms(&shp->shm_perm, acc_mode)) {
704 err = security_shm_shmat(shp, shmaddr, shmflg);
710 file = shp->shm_file;
711 size = i_size_read(file->f_dentry->d_inode);
715 down_write(¤t->mm->mmap_sem);
716 if (addr && !(shmflg & SHM_REMAP)) {
717 user_addr = ERR_PTR(-EINVAL);
718 if (find_vma_intersection(current->mm, addr, addr + size))
721 * If shm segment goes below stack, make sure there is some
722 * space left for the stack to grow (at least 4 pages).
724 if (addr < current->mm->start_stack &&
725 addr > current->mm->start_stack - size - PAGE_SIZE * 5)
729 user_addr = (void*) do_mmap (file, addr, size, prot, flags, 0);
732 up_write(¤t->mm->mmap_sem);
735 if(!(shp = shm_lock(shmid)))
738 if(shp->shm_nattch == 0 &&
739 shp->shm_flags & SHM_DEST)
745 *raddr = (unsigned long) user_addr;
747 if (IS_ERR(user_addr))
748 err = PTR_ERR(user_addr);
754 * detach and kill segment if marked destroyed.
755 * The work is done in shm_close.
757 asmlinkage long sys_shmdt(char __user *shmaddr)
759 struct mm_struct *mm = current->mm;
760 struct vm_area_struct *vma, *next;
761 unsigned long addr = (unsigned long)shmaddr;
763 int retval = -EINVAL;
765 down_write(&mm->mmap_sem);
768 * This function tries to be smart and unmap shm segments that
769 * were modified by partial mlock or munmap calls:
770 * - It first determines the size of the shm segment that should be
771 * unmapped: It searches for a vma that is backed by shm and that
772 * started at address shmaddr. It records it's size and then unmaps
774 * - Then it unmaps all shm vmas that started at shmaddr and that
775 * are within the initially determined size.
776 * Errors from do_munmap are ignored: the function only fails if
777 * it's called with invalid parameters or if it's called to unmap
778 * a part of a vma. Both calls in this function are for full vmas,
779 * the parameters are directly copied from the vma itself and always
780 * valid - therefore do_munmap cannot fail. (famous last words?)
783 * If it had been mremap()'d, the starting address would not
784 * match the usual checks anyway. So assume all vma's are
785 * above the starting address given.
787 vma = find_vma(mm, addr);
793 * Check if the starting address would match, i.e. it's
794 * a fragment created by mprotect() and/or munmap(), or it
795 * otherwise it starts at this address with no hassles.
797 if ((vma->vm_ops == &shm_vm_ops || is_vm_hugetlb_page(vma)) &&
798 (vma->vm_start - addr)/PAGE_SIZE == vma->vm_pgoff) {
801 size = vma->vm_file->f_dentry->d_inode->i_size;
802 do_munmap(mm, vma->vm_start, vma->vm_end - vma->vm_start);
804 * We discovered the size of the shm segment, so
805 * break out of here and fall through to the next
806 * loop that uses the size information to stop
807 * searching for matching vma's.
817 * We need look no further than the maximum address a fragment
818 * could possibly have landed at. Also cast things to loff_t to
819 * prevent overflows and make comparisions vs. equal-width types.
821 while (vma && (loff_t)(vma->vm_end - addr) <= size) {
824 /* finding a matching vma now does not alter retval */
825 if ((vma->vm_ops == &shm_vm_ops || is_vm_hugetlb_page(vma)) &&
826 (vma->vm_start - addr)/PAGE_SIZE == vma->vm_pgoff)
828 do_munmap(mm, vma->vm_start, vma->vm_end - vma->vm_start);
832 up_write(&mm->mmap_sem);
836 #ifdef CONFIG_PROC_FS
837 static int sysvipc_shm_read_proc(char *buffer, char **start, off_t offset, int length, int *eof, void *data)
844 len += sprintf(buffer, " key shmid perms size cpid lpid nattch uid gid cuid cgid atime dtime ctime\n");
846 for(i = 0; i <= shm_ids.max_id; i++) {
847 struct shmid_kernel* shp;
851 #define SMALL_STRING "%10d %10d %4o %10u %5u %5u %5d %5u %5u %5u %5u %10lu %10lu %10lu\n"
852 #define BIG_STRING "%10d %10d %4o %21u %5u %5u %5d %5u %5u %5u %5u %10lu %10lu %10lu\n"
855 if (sizeof(size_t) <= sizeof(int))
856 format = SMALL_STRING;
859 len += sprintf(buffer + len, format,
861 shm_buildid(i, shp->shm_perm.seq),
866 is_file_hugepages(shp->shm_file) ? (file_count(shp->shm_file) - 1) : shp->shm_nattch,
881 if(pos > offset + length)
888 *start = buffer + (offset - begin);
889 len -= (offset - begin);