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 <linux/syscalls.h>
30 #include <linux/audit.h>
31 #include <linux/ptrace.h>
33 #include <asm/uaccess.h>
37 #define shm_flags shm_perm.mode
39 static struct file_operations shm_file_operations;
40 static struct vm_operations_struct shm_vm_ops;
42 static struct ipc_ids shm_ids;
44 #define shm_lock(id) ((struct shmid_kernel*)ipc_lock(&shm_ids,id))
45 #define shm_unlock(shp) ipc_unlock(&(shp)->shm_perm)
46 #define shm_get(id) ((struct shmid_kernel*)ipc_get(&shm_ids,id))
47 #define shm_buildid(id, seq) \
48 ipc_buildid(&shm_ids, id, seq)
50 static int newseg (key_t key, int shmflg, size_t size);
51 static void shm_open (struct vm_area_struct *shmd);
52 static void shm_close (struct vm_area_struct *shmd);
54 static int sysvipc_shm_read_proc(char *buffer, char **start, off_t offset, int length, int *eof, void *data);
57 size_t shm_ctlmax = SHMMAX;
58 size_t shm_ctlall = SHMALL;
59 int shm_ctlmni = SHMMNI;
61 static int shm_tot; /* total number of shared memory pages */
63 void __init shm_init (void)
65 ipc_init_ids(&shm_ids, 1);
67 create_proc_read_entry("sysvipc/shm", 0, NULL, sysvipc_shm_read_proc, NULL);
71 static inline int shm_checkid(struct shmid_kernel *s, int id)
73 if (ipc_checkid(&shm_ids,&s->shm_perm,id))
78 static inline struct shmid_kernel *shm_rmid(int id)
80 return (struct shmid_kernel *)ipc_rmid(&shm_ids,id);
83 static inline int shm_addid(struct shmid_kernel *shp)
85 return ipc_addid(&shm_ids, &shp->shm_perm, shm_ctlmni);
90 static inline void shm_inc (int id) {
91 struct shmid_kernel *shp;
93 if(!(shp = shm_lock(id)))
95 shp->shm_atim = get_seconds();
96 shp->shm_lprid = current->tgid;
101 /* This is called by fork, once for every shm attach. */
102 static void shm_open (struct vm_area_struct *shmd)
104 shm_inc (shmd->vm_file->f_dentry->d_inode->i_ino);
108 * shm_destroy - free the struct shmid_kernel
110 * @shp: struct to free
112 * It has to be called with shp and shm_ids.sem locked,
113 * but returns with shp unlocked and freed.
115 static void shm_destroy (struct shmid_kernel *shp)
117 shm_tot -= (shp->shm_segsz + PAGE_SIZE - 1) >> PAGE_SHIFT;
120 if (!is_file_hugepages(shp->shm_file))
121 shmem_lock(shp->shm_file, 0, shp->mlock_user);
123 user_shm_unlock(shp->shm_file->f_dentry->d_inode->i_size,
125 fput (shp->shm_file);
126 security_shm_free(shp);
131 * remove the attach descriptor shmd.
132 * free memory for segment if it is marked destroyed.
133 * The descriptor has already been removed from the current->mm->mmap list
134 * and will later be kfree()d.
136 static void shm_close (struct vm_area_struct *shmd)
138 struct file * file = shmd->vm_file;
139 int id = file->f_dentry->d_inode->i_ino;
140 struct shmid_kernel *shp;
143 /* remove from the list of attaches of the shm segment */
144 if(!(shp = shm_lock(id)))
146 shp->shm_lprid = current->tgid;
147 shp->shm_dtim = get_seconds();
149 if(shp->shm_nattch == 0 &&
150 shp->shm_flags & SHM_DEST)
157 static int shm_mmap(struct file * file, struct vm_area_struct * vma)
160 vma->vm_ops = &shm_vm_ops;
161 shm_inc(file->f_dentry->d_inode->i_ino);
165 static struct file_operations shm_file_operations = {
169 static struct vm_operations_struct shm_vm_ops = {
170 .open = shm_open, /* callback for a new vm-area open */
171 .close = shm_close, /* callback for when the vm-area is released */
172 .nopage = shmem_nopage,
173 #if defined(CONFIG_NUMA) && defined(CONFIG_SHMEM)
174 .set_policy = shmem_set_policy,
175 .get_policy = shmem_get_policy,
179 static int newseg (key_t key, int shmflg, size_t size)
182 struct shmid_kernel *shp;
183 int numpages = (size + PAGE_SIZE -1) >> PAGE_SHIFT;
188 if (size < SHMMIN || size > shm_ctlmax)
191 if (shm_tot + numpages >= shm_ctlall)
194 shp = ipc_rcu_alloc(sizeof(*shp));
198 shp->shm_perm.key = key;
199 shp->shm_flags = (shmflg & S_IRWXUGO);
200 shp->mlock_user = NULL;
202 shp->shm_perm.security = NULL;
203 error = security_shm_alloc(shp);
209 if (shmflg & SHM_HUGETLB) {
210 /* hugetlb_zero_setup takes care of mlock user accounting */
211 file = hugetlb_zero_setup(size);
212 shp->mlock_user = current->user;
214 sprintf (name, "SYSV%08x", key);
215 file = shmem_file_setup(name, size, VM_ACCOUNT);
217 error = PTR_ERR(file);
226 shp->shm_cprid = current->tgid;
228 shp->shm_atim = shp->shm_dtim = 0;
229 shp->shm_ctim = get_seconds();
230 shp->shm_segsz = size;
232 shp->id = shm_buildid(id,shp->shm_perm.seq);
233 shp->shm_file = file;
234 file->f_dentry->d_inode->i_ino = shp->id;
235 if (shmflg & SHM_HUGETLB)
236 set_file_hugepages(file);
238 file->f_op = &shm_file_operations;
246 security_shm_free(shp);
251 asmlinkage long sys_shmget (key_t key, size_t size, int shmflg)
253 struct shmid_kernel *shp;
257 if (key == IPC_PRIVATE) {
258 err = newseg(key, shmflg, size);
259 } else if ((id = ipc_findkey(&shm_ids, key)) == -1) {
260 if (!(shmflg & IPC_CREAT))
263 err = newseg(key, shmflg, size);
264 } else if ((shmflg & IPC_CREAT) && (shmflg & IPC_EXCL)) {
270 if (shp->shm_segsz < size)
272 else if (ipcperms(&shp->shm_perm, shmflg))
275 int shmid = shm_buildid(id, shp->shm_perm.seq);
276 err = security_shm_associate(shp, shmflg);
287 static inline unsigned long copy_shmid_to_user(void __user *buf, struct shmid64_ds *in, int version)
291 return copy_to_user(buf, in, sizeof(*in));
296 ipc64_perm_to_ipc_perm(&in->shm_perm, &out.shm_perm);
297 out.shm_segsz = in->shm_segsz;
298 out.shm_atime = in->shm_atime;
299 out.shm_dtime = in->shm_dtime;
300 out.shm_ctime = in->shm_ctime;
301 out.shm_cpid = in->shm_cpid;
302 out.shm_lpid = in->shm_lpid;
303 out.shm_nattch = in->shm_nattch;
305 return copy_to_user(buf, &out, sizeof(out));
318 static inline unsigned long copy_shmid_from_user(struct shm_setbuf *out, void __user *buf, int version)
323 struct shmid64_ds tbuf;
325 if (copy_from_user(&tbuf, buf, sizeof(tbuf)))
328 out->uid = tbuf.shm_perm.uid;
329 out->gid = tbuf.shm_perm.gid;
330 out->mode = tbuf.shm_flags;
336 struct shmid_ds tbuf_old;
338 if (copy_from_user(&tbuf_old, buf, sizeof(tbuf_old)))
341 out->uid = tbuf_old.shm_perm.uid;
342 out->gid = tbuf_old.shm_perm.gid;
343 out->mode = tbuf_old.shm_flags;
352 static inline unsigned long copy_shminfo_to_user(void __user *buf, struct shminfo64 *in, int version)
356 return copy_to_user(buf, in, sizeof(*in));
361 if(in->shmmax > INT_MAX)
362 out.shmmax = INT_MAX;
364 out.shmmax = (int)in->shmmax;
366 out.shmmin = in->shmmin;
367 out.shmmni = in->shmmni;
368 out.shmseg = in->shmseg;
369 out.shmall = in->shmall;
371 return copy_to_user(buf, &out, sizeof(out));
378 static void shm_get_stat(unsigned long *rss, unsigned long *swp)
385 for (i = 0; i <= shm_ids.max_id; i++) {
386 struct shmid_kernel *shp;
393 inode = shp->shm_file->f_dentry->d_inode;
395 if (is_file_hugepages(shp->shm_file)) {
396 struct address_space *mapping = inode->i_mapping;
397 *rss += (HPAGE_SIZE/PAGE_SIZE)*mapping->nrpages;
399 struct shmem_inode_info *info = SHMEM_I(inode);
400 spin_lock(&info->lock);
401 *rss += inode->i_mapping->nrpages;
402 *swp += info->swapped;
403 spin_unlock(&info->lock);
408 asmlinkage long sys_shmctl (int shmid, int cmd, struct shmid_ds __user *buf)
410 struct shm_setbuf setbuf;
411 struct shmid_kernel *shp;
414 if (cmd < 0 || shmid < 0) {
419 version = ipc_parse_version(&cmd);
421 switch (cmd) { /* replace with proc interface ? */
424 struct shminfo64 shminfo;
426 err = security_shm_shmctl(NULL, cmd);
430 memset(&shminfo,0,sizeof(shminfo));
431 shminfo.shmmni = shminfo.shmseg = shm_ctlmni;
432 shminfo.shmmax = shm_ctlmax;
433 shminfo.shmall = shm_ctlall;
435 shminfo.shmmin = SHMMIN;
436 if(copy_shminfo_to_user (buf, &shminfo, version))
438 /* reading a integer is always atomic */
446 struct shm_info shm_info;
448 err = security_shm_shmctl(NULL, cmd);
452 memset(&shm_info,0,sizeof(shm_info));
454 shm_info.used_ids = shm_ids.in_use;
455 shm_get_stat (&shm_info.shm_rss, &shm_info.shm_swp);
456 shm_info.shm_tot = shm_tot;
457 shm_info.swap_attempts = 0;
458 shm_info.swap_successes = 0;
459 err = shm_ids.max_id;
461 if(copy_to_user (buf, &shm_info, sizeof(shm_info))) {
466 err = err < 0 ? 0 : err;
472 struct shmid64_ds tbuf;
474 memset(&tbuf, 0, sizeof(tbuf));
475 shp = shm_lock(shmid);
479 } else if(cmd==SHM_STAT) {
481 if (shmid > shm_ids.max_id)
483 result = shm_buildid(shmid, shp->shm_perm.seq);
485 err = shm_checkid(shp,shmid);
491 if (ipcperms (&shp->shm_perm, S_IRUGO))
493 err = security_shm_shmctl(shp, cmd);
496 kernel_to_ipc64_perm(&shp->shm_perm, &tbuf.shm_perm);
497 tbuf.shm_segsz = shp->shm_segsz;
498 tbuf.shm_atime = shp->shm_atim;
499 tbuf.shm_dtime = shp->shm_dtim;
500 tbuf.shm_ctime = shp->shm_ctim;
501 tbuf.shm_cpid = shp->shm_cprid;
502 tbuf.shm_lpid = shp->shm_lprid;
503 if (!is_file_hugepages(shp->shm_file))
504 tbuf.shm_nattch = shp->shm_nattch;
506 tbuf.shm_nattch = file_count(shp->shm_file) - 1;
508 if(copy_shmid_to_user (buf, &tbuf, version))
517 shp = shm_lock(shmid);
522 err = shm_checkid(shp,shmid);
526 if (!capable(CAP_IPC_LOCK)) {
528 if (current->euid != shp->shm_perm.uid &&
529 current->euid != shp->shm_perm.cuid)
531 if (cmd == SHM_LOCK &&
532 !current->signal->rlim[RLIMIT_MEMLOCK].rlim_cur)
536 err = security_shm_shmctl(shp, cmd);
541 struct user_struct * user = current->user;
542 if (!is_file_hugepages(shp->shm_file)) {
543 err = shmem_lock(shp->shm_file, 1, user);
545 shp->shm_flags |= SHM_LOCKED;
546 shp->mlock_user = user;
549 } else if (!is_file_hugepages(shp->shm_file)) {
550 shmem_lock(shp->shm_file, 0, shp->mlock_user);
551 shp->shm_flags &= ~SHM_LOCKED;
552 shp->mlock_user = NULL;
560 * We cannot simply remove the file. The SVID states
561 * that the block remains until the last person
562 * detaches from it, then is deleted. A shmat() on
563 * an RMID segment is legal in older Linux and if
564 * we change it apps break...
566 * Instead we set a destroyed flag, and then blow
567 * the name away when the usage hits zero.
570 shp = shm_lock(shmid);
574 err = shm_checkid(shp, shmid);
578 if (current->euid != shp->shm_perm.uid &&
579 current->euid != shp->shm_perm.cuid &&
580 !capable(CAP_SYS_ADMIN)) {
585 err = security_shm_shmctl(shp, cmd);
589 if (shp->shm_nattch){
590 shp->shm_flags |= SHM_DEST;
591 /* Do not find it any more */
592 shp->shm_perm.key = IPC_PRIVATE;
602 if (copy_shmid_from_user (&setbuf, buf, version)) {
606 if ((err = audit_ipc_perms(0, setbuf.uid, setbuf.gid, setbuf.mode)))
609 shp = shm_lock(shmid);
613 err = shm_checkid(shp,shmid);
617 if (current->euid != shp->shm_perm.uid &&
618 current->euid != shp->shm_perm.cuid &&
619 !capable(CAP_SYS_ADMIN)) {
623 err = security_shm_shmctl(shp, cmd);
627 shp->shm_perm.uid = setbuf.uid;
628 shp->shm_perm.gid = setbuf.gid;
629 shp->shm_flags = (shp->shm_flags & ~S_IRWXUGO)
630 | (setbuf.mode & S_IRWXUGO);
631 shp->shm_ctim = get_seconds();
653 * Fix shmaddr, allocate descriptor, map shm, add attach descriptor to lists.
655 * NOTE! Despite the name, this is NOT a direct system call entrypoint. The
656 * "raddr" thing points to kernel space, and there has to be a wrapper around
659 long do_shmat(int shmid, char __user *shmaddr, int shmflg, ulong *raddr)
661 struct shmid_kernel *shp;
668 unsigned long o_flags;
675 } else if ((addr = (ulong)shmaddr)) {
676 if (addr & (SHMLBA-1)) {
677 if (shmflg & SHM_RND)
678 addr &= ~(SHMLBA-1); /* round down */
680 #ifndef __ARCH_FORCE_SHMLBA
681 if (addr & ~PAGE_MASK)
685 flags = MAP_SHARED | MAP_FIXED;
687 if ((shmflg & SHM_REMAP))
693 if (shmflg & SHM_RDONLY) {
698 prot = PROT_READ | PROT_WRITE;
700 acc_mode = S_IRUGO | S_IWUGO;
702 if (shmflg & SHM_EXEC) {
708 * We cannot rely on the fs check since SYSV IPC does have an
709 * additional creator id...
711 shp = shm_lock(shmid);
716 err = shm_checkid(shp,shmid);
721 if (ipcperms(&shp->shm_perm, acc_mode)) {
727 err = security_shm_shmat(shp, shmaddr, shmflg);
733 file = shp->shm_file;
734 size = i_size_read(file->f_dentry->d_inode);
738 down_write(¤t->mm->mmap_sem);
739 if (addr && !(shmflg & SHM_REMAP)) {
740 user_addr = ERR_PTR(-EINVAL);
741 if (find_vma_intersection(current->mm, addr, addr + size))
744 * If shm segment goes below stack, make sure there is some
745 * space left for the stack to grow (at least 4 pages).
747 if (addr < current->mm->start_stack &&
748 addr > current->mm->start_stack - size - PAGE_SIZE * 5)
752 user_addr = (void*) do_mmap (file, addr, size, prot, flags, 0);
755 up_write(¤t->mm->mmap_sem);
758 if(!(shp = shm_lock(shmid)))
761 if(shp->shm_nattch == 0 &&
762 shp->shm_flags & SHM_DEST)
768 *raddr = (unsigned long) user_addr;
770 if (IS_ERR(user_addr))
771 err = PTR_ERR(user_addr);
776 asmlinkage long sys_shmat(int shmid, char __user *shmaddr, int shmflg)
781 err = do_shmat(shmid, shmaddr, shmflg, &ret);
784 force_successful_syscall_return();
789 * detach and kill segment if marked destroyed.
790 * The work is done in shm_close.
792 asmlinkage long sys_shmdt(char __user *shmaddr)
794 struct mm_struct *mm = current->mm;
795 struct vm_area_struct *vma, *next;
796 unsigned long addr = (unsigned long)shmaddr;
798 int retval = -EINVAL;
800 down_write(&mm->mmap_sem);
803 * This function tries to be smart and unmap shm segments that
804 * were modified by partial mlock or munmap calls:
805 * - It first determines the size of the shm segment that should be
806 * unmapped: It searches for a vma that is backed by shm and that
807 * started at address shmaddr. It records it's size and then unmaps
809 * - Then it unmaps all shm vmas that started at shmaddr and that
810 * are within the initially determined size.
811 * Errors from do_munmap are ignored: the function only fails if
812 * it's called with invalid parameters or if it's called to unmap
813 * a part of a vma. Both calls in this function are for full vmas,
814 * the parameters are directly copied from the vma itself and always
815 * valid - therefore do_munmap cannot fail. (famous last words?)
818 * If it had been mremap()'d, the starting address would not
819 * match the usual checks anyway. So assume all vma's are
820 * above the starting address given.
822 vma = find_vma(mm, addr);
828 * Check if the starting address would match, i.e. it's
829 * a fragment created by mprotect() and/or munmap(), or it
830 * otherwise it starts at this address with no hassles.
832 if ((vma->vm_ops == &shm_vm_ops || is_vm_hugetlb_page(vma)) &&
833 (vma->vm_start - addr)/PAGE_SIZE == vma->vm_pgoff) {
836 size = vma->vm_file->f_dentry->d_inode->i_size;
837 do_munmap(mm, vma->vm_start, vma->vm_end - vma->vm_start);
839 * We discovered the size of the shm segment, so
840 * break out of here and fall through to the next
841 * loop that uses the size information to stop
842 * searching for matching vma's.
852 * We need look no further than the maximum address a fragment
853 * could possibly have landed at. Also cast things to loff_t to
854 * prevent overflows and make comparisions vs. equal-width types.
856 while (vma && (loff_t)(vma->vm_end - addr) <= size) {
859 /* finding a matching vma now does not alter retval */
860 if ((vma->vm_ops == &shm_vm_ops || is_vm_hugetlb_page(vma)) &&
861 (vma->vm_start - addr)/PAGE_SIZE == vma->vm_pgoff)
863 do_munmap(mm, vma->vm_start, vma->vm_end - vma->vm_start);
867 up_write(&mm->mmap_sem);
871 #ifdef CONFIG_PROC_FS
872 static int sysvipc_shm_read_proc(char *buffer, char **start, off_t offset, int length, int *eof, void *data)
879 len += sprintf(buffer, " key shmid perms size cpid lpid nattch uid gid cuid cgid atime dtime ctime\n");
881 for(i = 0; i <= shm_ids.max_id; i++) {
882 struct shmid_kernel* shp;
886 #define SMALL_STRING "%10d %10d %4o %10u %5u %5u %5d %5u %5u %5u %5u %10lu %10lu %10lu\n"
887 #define BIG_STRING "%10d %10d %4o %21u %5u %5u %5d %5u %5u %5u %5u %10lu %10lu %10lu\n"
890 if (sizeof(size_t) <= sizeof(int))
891 format = SMALL_STRING;
894 len += sprintf(buffer + len, format,
896 shm_buildid(i, shp->shm_perm.seq),
901 is_file_hugepages(shp->shm_file) ? (file_count(shp->shm_file) - 1) : shp->shm_nattch,
916 if(pos > offset + length)
923 *start = buffer + (offset - begin);
924 len -= (offset - begin);