3 * Copyright (C) 1992 Krishna Balasubramanian
5 * Sep 1997 - Call suser() last after "normal" permission checks so we
6 * get BSD style process accounting right.
7 * Occurs in several places in the IPC code.
8 * Chris Evans, <chris@ferret.lmh.ox.ac.uk>
9 * Nov 1999 - ipc helper functions, unified SMP locking
10 * Manfred Spraul <manfred@colorfullife.com>
11 * Oct 2002 - One lock per IPC id. RCU ipc_free for lock-free grow_ary().
12 * Mingming Cao <cmm@us.ibm.com>
13 * Mar 2006 - support for audit of ipc object properties
14 * Dustin Kirkland <dustin.kirkland@us.ibm.com>
15 * Jun 2006 - namespaces ssupport
17 * Pavel Emelianov <xemul@openvz.org>
19 * General sysv ipc locking scheme:
21 * obtain the ipc object (kern_ipc_perm) by looking up the id in an idr
23 * - perform initial checks (capabilities, auditing and permission,
25 * - perform read-only operations, such as STAT, INFO commands.
26 * acquire the ipc lock (kern_ipc_perm.lock) through
28 * - perform data updates, such as SET, RMID commands and
29 * mechanism-specific operations (semop/semtimedop,
30 * msgsnd/msgrcv, shmat/shmdt).
31 * drop the ipc lock, through ipc_unlock_object().
34 * The ids->rwsem must be taken when:
35 * - creating, removing and iterating the existing entries in ipc
37 * - iterating through files under /proc/sysvipc/
39 * Note that sems have a special fast path that avoids kern_ipc_perm.lock -
44 #include <linux/shm.h>
45 #include <linux/init.h>
46 #include <linux/msg.h>
47 #include <linux/vmalloc.h>
48 #include <linux/slab.h>
49 #include <linux/notifier.h>
50 #include <linux/capability.h>
51 #include <linux/highuid.h>
52 #include <linux/security.h>
53 #include <linux/rcupdate.h>
54 #include <linux/workqueue.h>
55 #include <linux/seq_file.h>
56 #include <linux/proc_fs.h>
57 #include <linux/audit.h>
58 #include <linux/nsproxy.h>
59 #include <linux/rwsem.h>
60 #include <linux/memory.h>
61 #include <linux/ipc_namespace.h>
63 #include <asm/unistd.h>
67 struct ipc_proc_iface {
71 int (*show)(struct seq_file *, void *);
75 * ipc_init - initialise ipc subsystem
77 * The various sysv ipc resources (semaphores, messages and shared
78 * memory) are initialised.
80 * A callback routine is registered into the memory hotplug notifier
81 * chain: since msgmni scales to lowmem this callback routine will be
82 * called upon successful memory add / remove to recompute msmgni.
84 static int __init ipc_init(void)
91 device_initcall(ipc_init);
94 * ipc_init_ids - initialise ipc identifiers
95 * @ids: ipc identifier set
97 * Set up the sequence range to use for the ipc identifier range (limited
98 * below IPCMNI) then initialise the ids idr.
100 void ipc_init_ids(struct ipc_ids *ids)
105 init_rwsem(&ids->rwsem);
106 idr_init(&ids->ipcs_idr);
109 #ifdef CONFIG_PROC_FS
110 static const struct file_operations sysvipc_proc_fops;
112 * ipc_init_proc_interface - create a proc interface for sysipc types using a seq_file interface.
113 * @path: Path in procfs
114 * @header: Banner to be printed at the beginning of the file.
115 * @ids: ipc id table to iterate.
116 * @show: show routine.
118 void __init ipc_init_proc_interface(const char *path, const char *header,
119 int ids, int (*show)(struct seq_file *, void *))
121 struct proc_dir_entry *pde;
122 struct ipc_proc_iface *iface;
124 iface = kmalloc(sizeof(*iface), GFP_KERNEL);
128 iface->header = header;
132 pde = proc_create_data(path,
133 S_IRUGO, /* world readable */
134 NULL, /* parent dir */
143 * ipc_findkey - find a key in an ipc identifier set
144 * @ids: ipc identifier set
147 * Returns the locked pointer to the ipc structure if found or NULL
148 * otherwise. If key is found ipc points to the owning ipc structure
150 * Called with ipc_ids.rwsem held.
152 static struct kern_ipc_perm *ipc_findkey(struct ipc_ids *ids, key_t key)
154 struct kern_ipc_perm *ipc;
158 for (total = 0, next_id = 0; total < ids->in_use; next_id++) {
159 ipc = idr_find(&ids->ipcs_idr, next_id);
164 if (ipc->key != key) {
170 ipc_lock_object(ipc);
178 * ipc_get_maxid - get the last assigned id
179 * @ids: ipc identifier set
181 * Called with ipc_ids.rwsem held.
183 int ipc_get_maxid(struct ipc_ids *ids)
185 struct kern_ipc_perm *ipc;
189 if (ids->in_use == 0)
192 if (ids->in_use == IPCMNI)
195 /* Look for the last assigned id */
197 for (id = 0; id < IPCMNI && total < ids->in_use; id++) {
198 ipc = idr_find(&ids->ipcs_idr, id);
208 * ipc_addid - add an ipc identifier
209 * @ids: ipc identifier set
210 * @new: new ipc permission set
211 * @size: limit for the number of used ids
213 * Add an entry 'new' to the ipc ids idr. The permissions object is
214 * initialised and the first free entry is set up and the id assigned
215 * is returned. The 'new' entry is returned in a locked state on success.
216 * On failure the entry is not locked and a negative err-code is returned.
218 * Called with writer ipc_ids.rwsem held.
220 int ipc_addid(struct ipc_ids *ids, struct kern_ipc_perm *new, int size)
225 int next_id = ids->next_id;
230 if (ids->in_use >= size)
233 idr_preload(GFP_KERNEL);
235 atomic_set(&new->refcount, 1);
236 spin_lock_init(&new->lock);
237 new->deleted = false;
239 spin_lock(&new->lock);
241 current_euid_egid(&euid, &egid);
242 new->cuid = new->uid = euid;
243 new->gid = new->cgid = egid;
245 id = idr_alloc(&ids->ipcs_idr, new,
246 (next_id < 0) ? 0 : ipcid_to_idx(next_id), 0,
250 spin_unlock(&new->lock);
258 new->seq = ids->seq++;
259 if (ids->seq > IPCID_SEQ_MAX)
262 new->seq = ipcid_to_seqx(next_id);
266 new->id = ipc_buildid(id, new->seq);
271 * ipcget_new - create a new ipc object
273 * @ids: ipc identifier set
274 * @ops: the actual creation routine to call
275 * @params: its parameters
277 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
278 * when the key is IPC_PRIVATE.
280 static int ipcget_new(struct ipc_namespace *ns, struct ipc_ids *ids,
281 const struct ipc_ops *ops, struct ipc_params *params)
285 down_write(&ids->rwsem);
286 err = ops->getnew(ns, params);
287 up_write(&ids->rwsem);
292 * ipc_check_perms - check security and permissions for an ipc object
294 * @ipcp: ipc permission set
295 * @ops: the actual security routine to call
296 * @params: its parameters
298 * This routine is called by sys_msgget(), sys_semget() and sys_shmget()
299 * when the key is not IPC_PRIVATE and that key already exists in the
302 * On success, the ipc id is returned.
304 * It is called with ipc_ids.rwsem and ipcp->lock held.
306 static int ipc_check_perms(struct ipc_namespace *ns,
307 struct kern_ipc_perm *ipcp,
308 const struct ipc_ops *ops,
309 struct ipc_params *params)
313 if (ipcperms(ns, ipcp, params->flg))
316 err = ops->associate(ipcp, params->flg);
325 * ipcget_public - get an ipc object or create a new one
327 * @ids: ipc identifier set
328 * @ops: the actual creation routine to call
329 * @params: its parameters
331 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
332 * when the key is not IPC_PRIVATE.
333 * It adds a new entry if the key is not found and does some permission
334 * / security checkings if the key is found.
336 * On success, the ipc id is returned.
338 static int ipcget_public(struct ipc_namespace *ns, struct ipc_ids *ids,
339 const struct ipc_ops *ops, struct ipc_params *params)
341 struct kern_ipc_perm *ipcp;
342 int flg = params->flg;
346 * Take the lock as a writer since we are potentially going to add
347 * a new entry + read locks are not "upgradable"
349 down_write(&ids->rwsem);
350 ipcp = ipc_findkey(ids, params->key);
353 if (!(flg & IPC_CREAT))
356 err = ops->getnew(ns, params);
358 /* ipc object has been locked by ipc_findkey() */
360 if (flg & IPC_CREAT && flg & IPC_EXCL)
364 if (ops->more_checks)
365 err = ops->more_checks(ipcp, params);
368 * ipc_check_perms returns the IPC id on
371 err = ipc_check_perms(ns, ipcp, ops, params);
375 up_write(&ids->rwsem);
382 * ipc_rmid - remove an ipc identifier
383 * @ids: ipc identifier set
384 * @ipcp: ipc perm structure containing the identifier to remove
386 * ipc_ids.rwsem (as a writer) and the spinlock for this ID are held
387 * before this function is called, and remain locked on the exit.
389 void ipc_rmid(struct ipc_ids *ids, struct kern_ipc_perm *ipcp)
391 int lid = ipcid_to_idx(ipcp->id);
393 idr_remove(&ids->ipcs_idr, lid);
395 ipcp->deleted = true;
398 int ipc_rcu_getref(struct kern_ipc_perm *ptr)
400 return atomic_inc_not_zero(&ptr->refcount);
403 void ipc_rcu_putref(struct kern_ipc_perm *ptr,
404 void (*func)(struct rcu_head *head))
406 if (!atomic_dec_and_test(&ptr->refcount))
409 call_rcu(&ptr->rcu, func);
413 * ipcperms - check ipc permissions
415 * @ipcp: ipc permission set
416 * @flag: desired permission set
418 * Check user, group, other permissions for access
419 * to ipc resources. return 0 if allowed
421 * @flag will most probably be 0 or ``S_...UGO`` from <linux/stat.h>
423 int ipcperms(struct ipc_namespace *ns, struct kern_ipc_perm *ipcp, short flag)
425 kuid_t euid = current_euid();
426 int requested_mode, granted_mode;
429 requested_mode = (flag >> 6) | (flag >> 3) | flag;
430 granted_mode = ipcp->mode;
431 if (uid_eq(euid, ipcp->cuid) ||
432 uid_eq(euid, ipcp->uid))
434 else if (in_group_p(ipcp->cgid) || in_group_p(ipcp->gid))
436 /* is there some bit set in requested_mode but not in granted_mode? */
437 if ((requested_mode & ~granted_mode & 0007) &&
438 !ns_capable(ns->user_ns, CAP_IPC_OWNER))
441 return security_ipc_permission(ipcp, flag);
445 * Functions to convert between the kern_ipc_perm structure and the
446 * old/new ipc_perm structures
450 * kernel_to_ipc64_perm - convert kernel ipc permissions to user
451 * @in: kernel permissions
452 * @out: new style ipc permissions
454 * Turn the kernel object @in into a set of permissions descriptions
455 * for returning to userspace (@out).
457 void kernel_to_ipc64_perm(struct kern_ipc_perm *in, struct ipc64_perm *out)
460 out->uid = from_kuid_munged(current_user_ns(), in->uid);
461 out->gid = from_kgid_munged(current_user_ns(), in->gid);
462 out->cuid = from_kuid_munged(current_user_ns(), in->cuid);
463 out->cgid = from_kgid_munged(current_user_ns(), in->cgid);
464 out->mode = in->mode;
469 * ipc64_perm_to_ipc_perm - convert new ipc permissions to old
470 * @in: new style ipc permissions
471 * @out: old style ipc permissions
473 * Turn the new style permissions object @in into a compatibility
474 * object and store it into the @out pointer.
476 void ipc64_perm_to_ipc_perm(struct ipc64_perm *in, struct ipc_perm *out)
479 SET_UID(out->uid, in->uid);
480 SET_GID(out->gid, in->gid);
481 SET_UID(out->cuid, in->cuid);
482 SET_GID(out->cgid, in->cgid);
483 out->mode = in->mode;
489 * @ids: ipc identifier set
490 * @id: ipc id to look for
492 * Look for an id in the ipc ids idr and return associated ipc object.
494 * Call inside the RCU critical section.
495 * The ipc object is *not* locked on exit.
497 struct kern_ipc_perm *ipc_obtain_object_idr(struct ipc_ids *ids, int id)
499 struct kern_ipc_perm *out;
500 int lid = ipcid_to_idx(id);
502 out = idr_find(&ids->ipcs_idr, lid);
504 return ERR_PTR(-EINVAL);
510 * ipc_lock - lock an ipc structure without rwsem held
511 * @ids: ipc identifier set
512 * @id: ipc id to look for
514 * Look for an id in the ipc ids idr and lock the associated ipc object.
516 * The ipc object is locked on successful exit.
518 struct kern_ipc_perm *ipc_lock(struct ipc_ids *ids, int id)
520 struct kern_ipc_perm *out;
523 out = ipc_obtain_object_idr(ids, id);
527 spin_lock(&out->lock);
530 * ipc_rmid() may have already freed the ID while ipc_lock()
531 * was spinning: here verify that the structure is still valid.
532 * Upon races with RMID, return -EIDRM, thus indicating that
533 * the ID points to a removed identifier.
535 if (ipc_valid_object(out))
538 spin_unlock(&out->lock);
539 out = ERR_PTR(-EIDRM);
546 * ipc_obtain_object_check
547 * @ids: ipc identifier set
548 * @id: ipc id to look for
550 * Similar to ipc_obtain_object_idr() but also checks
551 * the ipc object reference counter.
553 * Call inside the RCU critical section.
554 * The ipc object is *not* locked on exit.
556 struct kern_ipc_perm *ipc_obtain_object_check(struct ipc_ids *ids, int id)
558 struct kern_ipc_perm *out = ipc_obtain_object_idr(ids, id);
563 if (ipc_checkid(out, id))
564 return ERR_PTR(-EINVAL);
570 * ipcget - Common sys_*get() code
572 * @ids: ipc identifier set
573 * @ops: operations to be called on ipc object creation, permission checks
575 * @params: the parameters needed by the previous operations.
577 * Common routine called by sys_msgget(), sys_semget() and sys_shmget().
579 int ipcget(struct ipc_namespace *ns, struct ipc_ids *ids,
580 const struct ipc_ops *ops, struct ipc_params *params)
582 if (params->key == IPC_PRIVATE)
583 return ipcget_new(ns, ids, ops, params);
585 return ipcget_public(ns, ids, ops, params);
589 * ipc_update_perm - update the permissions of an ipc object
590 * @in: the permission given as input.
591 * @out: the permission of the ipc to set.
593 int ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out)
595 kuid_t uid = make_kuid(current_user_ns(), in->uid);
596 kgid_t gid = make_kgid(current_user_ns(), in->gid);
597 if (!uid_valid(uid) || !gid_valid(gid))
602 out->mode = (out->mode & ~S_IRWXUGO)
603 | (in->mode & S_IRWXUGO);
609 * ipcctl_pre_down_nolock - retrieve an ipc and check permissions for some IPC_XXX cmd
611 * @ids: the table of ids where to look for the ipc
612 * @id: the id of the ipc to retrieve
613 * @cmd: the cmd to check
614 * @perm: the permission to set
615 * @extra_perm: one extra permission parameter used by msq
617 * This function does some common audit and permissions check for some IPC_XXX
618 * cmd and is called from semctl_down, shmctl_down and msgctl_down.
619 * It must be called without any lock held and:
621 * - retrieves the ipc with the given id in the given table.
622 * - performs some audit and permission check, depending on the given cmd
623 * - returns a pointer to the ipc object or otherwise, the corresponding
626 * Call holding the both the rwsem and the rcu read lock.
628 struct kern_ipc_perm *ipcctl_pre_down_nolock(struct ipc_namespace *ns,
629 struct ipc_ids *ids, int id, int cmd,
630 struct ipc64_perm *perm, int extra_perm)
634 struct kern_ipc_perm *ipcp;
636 ipcp = ipc_obtain_object_check(ids, id);
644 audit_ipc_set_perm(extra_perm, perm->uid,
645 perm->gid, perm->mode);
647 euid = current_euid();
648 if (uid_eq(euid, ipcp->cuid) || uid_eq(euid, ipcp->uid) ||
649 ns_capable(ns->user_ns, CAP_SYS_ADMIN))
650 return ipcp; /* successful lookup */
655 #ifdef CONFIG_ARCH_WANT_IPC_PARSE_VERSION
659 * ipc_parse_version - ipc call version
660 * @cmd: pointer to command
662 * Return IPC_64 for new style IPC and IPC_OLD for old style IPC.
663 * The @cmd value is turned from an encoding command and version into
664 * just the command code.
666 int ipc_parse_version(int *cmd)
676 #endif /* CONFIG_ARCH_WANT_IPC_PARSE_VERSION */
678 #ifdef CONFIG_PROC_FS
679 struct ipc_proc_iter {
680 struct ipc_namespace *ns;
681 struct ipc_proc_iface *iface;
685 * This routine locks the ipc structure found at least at position pos.
687 static struct kern_ipc_perm *sysvipc_find_ipc(struct ipc_ids *ids, loff_t pos,
690 struct kern_ipc_perm *ipc;
694 for (id = 0; id < pos && total < ids->in_use; id++) {
695 ipc = idr_find(&ids->ipcs_idr, id);
700 if (total >= ids->in_use)
703 for (; pos < IPCMNI; pos++) {
704 ipc = idr_find(&ids->ipcs_idr, pos);
708 ipc_lock_object(ipc);
713 /* Out of range - return NULL to terminate iteration */
717 static void *sysvipc_proc_next(struct seq_file *s, void *it, loff_t *pos)
719 struct ipc_proc_iter *iter = s->private;
720 struct ipc_proc_iface *iface = iter->iface;
721 struct kern_ipc_perm *ipc = it;
723 /* If we had an ipc id locked before, unlock it */
724 if (ipc && ipc != SEQ_START_TOKEN)
727 return sysvipc_find_ipc(&iter->ns->ids[iface->ids], *pos, pos);
731 * File positions: pos 0 -> header, pos n -> ipc id = n - 1.
732 * SeqFile iterator: iterator value locked ipc pointer or SEQ_TOKEN_START.
734 static void *sysvipc_proc_start(struct seq_file *s, loff_t *pos)
736 struct ipc_proc_iter *iter = s->private;
737 struct ipc_proc_iface *iface = iter->iface;
740 ids = &iter->ns->ids[iface->ids];
743 * Take the lock - this will be released by the corresponding
746 down_read(&ids->rwsem);
748 /* pos < 0 is invalid */
752 /* pos == 0 means header */
754 return SEQ_START_TOKEN;
756 /* Find the (pos-1)th ipc */
757 return sysvipc_find_ipc(ids, *pos - 1, pos);
760 static void sysvipc_proc_stop(struct seq_file *s, void *it)
762 struct kern_ipc_perm *ipc = it;
763 struct ipc_proc_iter *iter = s->private;
764 struct ipc_proc_iface *iface = iter->iface;
767 /* If we had a locked structure, release it */
768 if (ipc && ipc != SEQ_START_TOKEN)
771 ids = &iter->ns->ids[iface->ids];
772 /* Release the lock we took in start() */
773 up_read(&ids->rwsem);
776 static int sysvipc_proc_show(struct seq_file *s, void *it)
778 struct ipc_proc_iter *iter = s->private;
779 struct ipc_proc_iface *iface = iter->iface;
781 if (it == SEQ_START_TOKEN) {
782 seq_puts(s, iface->header);
786 return iface->show(s, it);
789 static const struct seq_operations sysvipc_proc_seqops = {
790 .start = sysvipc_proc_start,
791 .stop = sysvipc_proc_stop,
792 .next = sysvipc_proc_next,
793 .show = sysvipc_proc_show,
796 static int sysvipc_proc_open(struct inode *inode, struct file *file)
798 struct ipc_proc_iter *iter;
800 iter = __seq_open_private(file, &sysvipc_proc_seqops, sizeof(*iter));
804 iter->iface = PDE_DATA(inode);
805 iter->ns = get_ipc_ns(current->nsproxy->ipc_ns);
810 static int sysvipc_proc_release(struct inode *inode, struct file *file)
812 struct seq_file *seq = file->private_data;
813 struct ipc_proc_iter *iter = seq->private;
814 put_ipc_ns(iter->ns);
815 return seq_release_private(inode, file);
818 static const struct file_operations sysvipc_proc_fops = {
819 .open = sysvipc_proc_open,
822 .release = sysvipc_proc_release,
824 #endif /* CONFIG_PROC_FS */