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>
21 #include <linux/shm.h>
22 #include <linux/init.h>
23 #include <linux/msg.h>
24 #include <linux/vmalloc.h>
25 #include <linux/slab.h>
26 #include <linux/capability.h>
27 #include <linux/highuid.h>
28 #include <linux/security.h>
29 #include <linux/rcupdate.h>
30 #include <linux/workqueue.h>
31 #include <linux/seq_file.h>
32 #include <linux/proc_fs.h>
33 #include <linux/audit.h>
34 #include <linux/nsproxy.h>
35 #include <linux/rwsem.h>
36 #include <linux/memory.h>
37 #include <linux/ipc_namespace.h>
39 #include <asm/unistd.h>
43 struct ipc_proc_iface {
47 int (*show)(struct seq_file *, void *);
50 #ifdef CONFIG_MEMORY_HOTPLUG
52 static void ipc_memory_notifier(struct work_struct *work)
54 ipcns_notify(IPCNS_MEMCHANGED);
57 static DECLARE_WORK(ipc_memory_wq, ipc_memory_notifier);
60 static int ipc_memory_callback(struct notifier_block *self,
61 unsigned long action, void *arg)
64 case MEM_ONLINE: /* memory successfully brought online */
65 case MEM_OFFLINE: /* or offline: it's time to recompute msgmni */
67 * This is done by invoking the ipcns notifier chain with the
68 * IPC_MEMCHANGED event.
69 * In order not to keep the lock on the hotplug memory chain
70 * for too long, queue a work item that will, when waken up,
71 * activate the ipcns notification chain.
72 * No need to keep several ipc work items on the queue.
74 if (!work_pending(&ipc_memory_wq))
75 schedule_work(&ipc_memory_wq);
77 case MEM_GOING_ONLINE:
78 case MEM_GOING_OFFLINE:
79 case MEM_CANCEL_ONLINE:
80 case MEM_CANCEL_OFFLINE:
88 #endif /* CONFIG_MEMORY_HOTPLUG */
91 * ipc_init - initialise IPC subsystem
93 * The various system5 IPC resources (semaphores, messages and shared
94 * memory) are initialised
95 * A callback routine is registered into the memory hotplug notifier
96 * chain: since msgmni scales to lowmem this callback routine will be
97 * called upon successful memory add / remove to recompute msmgni.
100 static int __init ipc_init(void)
105 hotplug_memory_notifier(ipc_memory_callback, IPC_CALLBACK_PRI);
106 register_ipcns_notifier(&init_ipc_ns);
109 __initcall(ipc_init);
112 * ipc_init_ids - initialise IPC identifiers
113 * @ids: Identifier set
115 * Set up the sequence range to use for the ipc identifier range (limited
116 * below IPCMNI) then initialise the ids idr.
119 void ipc_init_ids(struct ipc_ids *ids)
121 init_rwsem(&ids->rw_mutex);
127 int seq_limit = INT_MAX/SEQ_MULTIPLIER;
128 if (seq_limit > USHRT_MAX)
129 ids->seq_max = USHRT_MAX;
131 ids->seq_max = seq_limit;
134 idr_init(&ids->ipcs_idr);
137 #ifdef CONFIG_PROC_FS
138 static const struct file_operations sysvipc_proc_fops;
140 * ipc_init_proc_interface - Create a proc interface for sysipc types using a seq_file interface.
141 * @path: Path in procfs
142 * @header: Banner to be printed at the beginning of the file.
143 * @ids: ipc id table to iterate.
144 * @show: show routine.
146 void __init ipc_init_proc_interface(const char *path, const char *header,
147 int ids, int (*show)(struct seq_file *, void *))
149 struct proc_dir_entry *pde;
150 struct ipc_proc_iface *iface;
152 iface = kmalloc(sizeof(*iface), GFP_KERNEL);
156 iface->header = header;
160 pde = proc_create_data(path,
161 S_IRUGO, /* world readable */
162 NULL, /* parent dir */
172 * ipc_findkey - find a key in an ipc identifier set
173 * @ids: Identifier set
174 * @key: The key to find
176 * Requires ipc_ids.rw_mutex locked.
177 * Returns the LOCKED pointer to the ipc structure if found or NULL
179 * If key is found ipc points to the owning ipc structure
182 static struct kern_ipc_perm *ipc_findkey(struct ipc_ids *ids, key_t key)
184 struct kern_ipc_perm *ipc;
188 for (total = 0, next_id = 0; total < ids->in_use; next_id++) {
189 ipc = idr_find(&ids->ipcs_idr, next_id);
194 if (ipc->key != key) {
199 ipc_lock_by_ptr(ipc);
207 * ipc_get_maxid - get the last assigned id
208 * @ids: IPC identifier set
210 * Called with ipc_ids.rw_mutex held.
213 int ipc_get_maxid(struct ipc_ids *ids)
215 struct kern_ipc_perm *ipc;
219 if (ids->in_use == 0)
222 if (ids->in_use == IPCMNI)
225 /* Look for the last assigned id */
227 for (id = 0; id < IPCMNI && total < ids->in_use; id++) {
228 ipc = idr_find(&ids->ipcs_idr, id);
238 * ipc_addid - add an IPC identifier
239 * @ids: IPC identifier set
240 * @new: new IPC permission set
241 * @size: limit for the number of used ids
243 * Add an entry 'new' to the IPC ids idr. The permissions object is
244 * initialised and the first free entry is set up and the id assigned
245 * is returned. The 'new' entry is returned in a locked state on success.
246 * On failure the entry is not locked and a negative err-code is returned.
248 * Called with ipc_ids.rw_mutex held as a writer.
251 int ipc_addid(struct ipc_ids* ids, struct kern_ipc_perm* new, int size)
256 int next_id = ids->next_id;
261 if (ids->in_use >= size)
264 idr_preload(GFP_KERNEL);
266 spin_lock_init(&new->lock);
269 spin_lock(&new->lock);
271 id = idr_alloc(&ids->ipcs_idr, new,
272 (next_id < 0) ? 0 : ipcid_to_idx(next_id), 0,
276 spin_unlock(&new->lock);
283 current_euid_egid(&euid, &egid);
284 new->cuid = new->uid = euid;
285 new->gid = new->cgid = egid;
288 new->seq = ids->seq++;
289 if (ids->seq > ids->seq_max)
292 new->seq = ipcid_to_seqx(next_id);
296 new->id = ipc_buildid(id, new->seq);
301 * ipcget_new - create a new ipc object
303 * @ids: IPC identifer set
304 * @ops: the actual creation routine to call
305 * @params: its parameters
307 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
308 * when the key is IPC_PRIVATE.
310 static int ipcget_new(struct ipc_namespace *ns, struct ipc_ids *ids,
311 struct ipc_ops *ops, struct ipc_params *params)
315 down_write(&ids->rw_mutex);
316 err = ops->getnew(ns, params);
317 up_write(&ids->rw_mutex);
322 * ipc_check_perms - check security and permissions for an IPC
324 * @ipcp: ipc permission set
325 * @ops: the actual security routine to call
326 * @params: its parameters
328 * This routine is called by sys_msgget(), sys_semget() and sys_shmget()
329 * when the key is not IPC_PRIVATE and that key already exists in the
332 * On success, the IPC id is returned.
334 * It is called with ipc_ids.rw_mutex and ipcp->lock held.
336 static int ipc_check_perms(struct ipc_namespace *ns,
337 struct kern_ipc_perm *ipcp,
339 struct ipc_params *params)
343 if (ipcperms(ns, ipcp, params->flg))
346 err = ops->associate(ipcp, params->flg);
355 * ipcget_public - get an ipc object or create a new one
357 * @ids: IPC identifer set
358 * @ops: the actual creation routine to call
359 * @params: its parameters
361 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
362 * when the key is not IPC_PRIVATE.
363 * It adds a new entry if the key is not found and does some permission
364 * / security checkings if the key is found.
366 * On success, the ipc id is returned.
368 static int ipcget_public(struct ipc_namespace *ns, struct ipc_ids *ids,
369 struct ipc_ops *ops, struct ipc_params *params)
371 struct kern_ipc_perm *ipcp;
372 int flg = params->flg;
376 * Take the lock as a writer since we are potentially going to add
377 * a new entry + read locks are not "upgradable"
379 down_write(&ids->rw_mutex);
380 ipcp = ipc_findkey(ids, params->key);
383 if (!(flg & IPC_CREAT))
386 err = ops->getnew(ns, params);
388 /* ipc object has been locked by ipc_findkey() */
390 if (flg & IPC_CREAT && flg & IPC_EXCL)
394 if (ops->more_checks)
395 err = ops->more_checks(ipcp, params);
398 * ipc_check_perms returns the IPC id on
401 err = ipc_check_perms(ns, ipcp, ops, params);
405 up_write(&ids->rw_mutex);
412 * ipc_rmid - remove an IPC identifier
413 * @ids: IPC identifier set
414 * @ipcp: ipc perm structure containing the identifier to remove
416 * ipc_ids.rw_mutex (as a writer) and the spinlock for this ID are held
417 * before this function is called, and remain locked on the exit.
420 void ipc_rmid(struct ipc_ids *ids, struct kern_ipc_perm *ipcp)
422 int lid = ipcid_to_idx(ipcp->id);
424 idr_remove(&ids->ipcs_idr, lid);
434 * ipc_alloc - allocate ipc space
435 * @size: size desired
437 * Allocate memory from the appropriate pools and return a pointer to it.
438 * NULL is returned if the allocation fails
441 void* ipc_alloc(int size)
447 out = kmalloc(size, GFP_KERNEL);
452 * ipc_free - free ipc space
453 * @ptr: pointer returned by ipc_alloc
454 * @size: size of block
456 * Free a block created with ipc_alloc(). The caller must know the size
457 * used in the allocation call.
460 void ipc_free(void* ptr, int size)
470 * There are three headers that are prepended to the actual allocation:
471 * - during use: ipc_rcu_hdr.
472 * - during the rcu grace period: ipc_rcu_grace.
473 * - [only if vmalloc]: ipc_rcu_sched.
474 * Their lifetime doesn't overlap, thus the headers share the same memory.
475 * Unlike a normal union, they are right-aligned, thus some container_of
476 * forward/backward casting is necessary:
489 /* "void *" makes sure alignment of following data is sane. */
495 struct work_struct work;
496 /* "void *" makes sure alignment of following data is sane. */
500 #define HDRLEN_KMALLOC (sizeof(struct ipc_rcu_grace) > sizeof(struct ipc_rcu_hdr) ? \
501 sizeof(struct ipc_rcu_grace) : sizeof(struct ipc_rcu_hdr))
502 #define HDRLEN_VMALLOC (sizeof(struct ipc_rcu_sched) > HDRLEN_KMALLOC ? \
503 sizeof(struct ipc_rcu_sched) : HDRLEN_KMALLOC)
505 static inline int rcu_use_vmalloc(int size)
507 /* Too big for a single page? */
508 if (HDRLEN_KMALLOC + size > PAGE_SIZE)
514 * ipc_rcu_alloc - allocate ipc and rcu space
515 * @size: size desired
517 * Allocate memory for the rcu header structure + the object.
518 * Returns the pointer to the object.
519 * NULL is returned if the allocation fails.
522 void* ipc_rcu_alloc(int size)
526 * We prepend the allocation with the rcu struct, and
527 * workqueue if necessary (for vmalloc).
529 if (rcu_use_vmalloc(size)) {
530 out = vmalloc(HDRLEN_VMALLOC + size);
532 out += HDRLEN_VMALLOC;
533 container_of(out, struct ipc_rcu_hdr, data)->is_vmalloc = 1;
534 container_of(out, struct ipc_rcu_hdr, data)->refcount = 1;
537 out = kmalloc(HDRLEN_KMALLOC + size, GFP_KERNEL);
539 out += HDRLEN_KMALLOC;
540 container_of(out, struct ipc_rcu_hdr, data)->is_vmalloc = 0;
541 container_of(out, struct ipc_rcu_hdr, data)->refcount = 1;
548 void ipc_rcu_getref(void *ptr)
550 container_of(ptr, struct ipc_rcu_hdr, data)->refcount++;
553 static void ipc_do_vfree(struct work_struct *work)
555 vfree(container_of(work, struct ipc_rcu_sched, work));
559 * ipc_schedule_free - free ipc + rcu space
560 * @head: RCU callback structure for queued work
562 * Since RCU callback function is called in bh,
563 * we need to defer the vfree to schedule_work().
565 static void ipc_schedule_free(struct rcu_head *head)
567 struct ipc_rcu_grace *grace;
568 struct ipc_rcu_sched *sched;
570 grace = container_of(head, struct ipc_rcu_grace, rcu);
571 sched = container_of(&(grace->data[0]), struct ipc_rcu_sched,
574 INIT_WORK(&sched->work, ipc_do_vfree);
575 schedule_work(&sched->work);
578 void ipc_rcu_putref(void *ptr)
580 if (--container_of(ptr, struct ipc_rcu_hdr, data)->refcount > 0)
583 if (container_of(ptr, struct ipc_rcu_hdr, data)->is_vmalloc) {
584 call_rcu(&container_of(ptr, struct ipc_rcu_grace, data)->rcu,
587 kfree_rcu(container_of(ptr, struct ipc_rcu_grace, data), rcu);
592 * ipcperms - check IPC permissions
594 * @ipcp: IPC permission set
595 * @flag: desired permission set.
597 * Check user, group, other permissions for access
598 * to ipc resources. return 0 if allowed
600 * @flag will most probably be 0 or S_...UGO from <linux/stat.h>
603 int ipcperms(struct ipc_namespace *ns, struct kern_ipc_perm *ipcp, short flag)
605 kuid_t euid = current_euid();
606 int requested_mode, granted_mode;
609 requested_mode = (flag >> 6) | (flag >> 3) | flag;
610 granted_mode = ipcp->mode;
611 if (uid_eq(euid, ipcp->cuid) ||
612 uid_eq(euid, ipcp->uid))
614 else if (in_group_p(ipcp->cgid) || in_group_p(ipcp->gid))
616 /* is there some bit set in requested_mode but not in granted_mode? */
617 if ((requested_mode & ~granted_mode & 0007) &&
618 !ns_capable(ns->user_ns, CAP_IPC_OWNER))
621 return security_ipc_permission(ipcp, flag);
625 * Functions to convert between the kern_ipc_perm structure and the
626 * old/new ipc_perm structures
630 * kernel_to_ipc64_perm - convert kernel ipc permissions to user
631 * @in: kernel permissions
632 * @out: new style IPC permissions
634 * Turn the kernel object @in into a set of permissions descriptions
635 * for returning to userspace (@out).
639 void kernel_to_ipc64_perm (struct kern_ipc_perm *in, struct ipc64_perm *out)
642 out->uid = from_kuid_munged(current_user_ns(), in->uid);
643 out->gid = from_kgid_munged(current_user_ns(), in->gid);
644 out->cuid = from_kuid_munged(current_user_ns(), in->cuid);
645 out->cgid = from_kgid_munged(current_user_ns(), in->cgid);
646 out->mode = in->mode;
651 * ipc64_perm_to_ipc_perm - convert new ipc permissions to old
652 * @in: new style IPC permissions
653 * @out: old style IPC permissions
655 * Turn the new style permissions object @in into a compatibility
656 * object and store it into the @out pointer.
659 void ipc64_perm_to_ipc_perm (struct ipc64_perm *in, struct ipc_perm *out)
662 SET_UID(out->uid, in->uid);
663 SET_GID(out->gid, in->gid);
664 SET_UID(out->cuid, in->cuid);
665 SET_GID(out->cgid, in->cgid);
666 out->mode = in->mode;
671 * ipc_lock - Lock an ipc structure without rw_mutex held
672 * @ids: IPC identifier set
673 * @id: ipc id to look for
675 * Look for an id in the ipc ids idr and lock the associated ipc object.
677 * The ipc object is locked on exit.
680 struct kern_ipc_perm *ipc_lock(struct ipc_ids *ids, int id)
682 struct kern_ipc_perm *out;
683 int lid = ipcid_to_idx(id);
686 out = idr_find(&ids->ipcs_idr, lid);
689 return ERR_PTR(-EINVAL);
692 spin_lock(&out->lock);
694 /* ipc_rmid() may have already freed the ID while ipc_lock
695 * was spinning: here verify that the structure is still valid
698 spin_unlock(&out->lock);
700 return ERR_PTR(-EINVAL);
706 struct kern_ipc_perm *ipc_lock_check(struct ipc_ids *ids, int id)
708 struct kern_ipc_perm *out;
710 out = ipc_lock(ids, id);
714 if (ipc_checkid(out, id)) {
716 return ERR_PTR(-EIDRM);
723 * ipcget - Common sys_*get() code
725 * @ids : IPC identifier set
726 * @ops : operations to be called on ipc object creation, permission checks
728 * @params : the parameters needed by the previous operations.
730 * Common routine called by sys_msgget(), sys_semget() and sys_shmget().
732 int ipcget(struct ipc_namespace *ns, struct ipc_ids *ids,
733 struct ipc_ops *ops, struct ipc_params *params)
735 if (params->key == IPC_PRIVATE)
736 return ipcget_new(ns, ids, ops, params);
738 return ipcget_public(ns, ids, ops, params);
742 * ipc_update_perm - update the permissions of an IPC.
743 * @in: the permission given as input.
744 * @out: the permission of the ipc to set.
746 int ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out)
748 kuid_t uid = make_kuid(current_user_ns(), in->uid);
749 kgid_t gid = make_kgid(current_user_ns(), in->gid);
750 if (!uid_valid(uid) || !gid_valid(gid))
755 out->mode = (out->mode & ~S_IRWXUGO)
756 | (in->mode & S_IRWXUGO);
762 * ipcctl_pre_down - retrieve an ipc and check permissions for some IPC_XXX cmd
763 * @ns: the ipc namespace
764 * @ids: the table of ids where to look for the ipc
765 * @id: the id of the ipc to retrieve
766 * @cmd: the cmd to check
767 * @perm: the permission to set
768 * @extra_perm: one extra permission parameter used by msq
770 * This function does some common audit and permissions check for some IPC_XXX
771 * cmd and is called from semctl_down, shmctl_down and msgctl_down.
772 * It must be called without any lock held and
773 * - retrieves the ipc with the given id in the given table.
774 * - performs some audit and permission check, depending on the given cmd
775 * - returns the ipc with both ipc and rw_mutex locks held in case of success
776 * or an err-code without any lock held otherwise.
778 struct kern_ipc_perm *ipcctl_pre_down(struct ipc_namespace *ns,
779 struct ipc_ids *ids, int id, int cmd,
780 struct ipc64_perm *perm, int extra_perm)
782 struct kern_ipc_perm *ipcp;
786 down_write(&ids->rw_mutex);
787 ipcp = ipc_lock_check(ids, id);
795 audit_ipc_set_perm(extra_perm, perm->uid,
796 perm->gid, perm->mode);
798 euid = current_euid();
799 if (uid_eq(euid, ipcp->cuid) || uid_eq(euid, ipcp->uid) ||
800 ns_capable(ns->user_ns, CAP_SYS_ADMIN))
806 up_write(&ids->rw_mutex);
810 #ifdef CONFIG_ARCH_WANT_IPC_PARSE_VERSION
814 * ipc_parse_version - IPC call version
815 * @cmd: pointer to command
817 * Return IPC_64 for new style IPC and IPC_OLD for old style IPC.
818 * The @cmd value is turned from an encoding command and version into
819 * just the command code.
822 int ipc_parse_version (int *cmd)
832 #endif /* CONFIG_ARCH_WANT_IPC_PARSE_VERSION */
834 #ifdef CONFIG_PROC_FS
835 struct ipc_proc_iter {
836 struct ipc_namespace *ns;
837 struct ipc_proc_iface *iface;
841 * This routine locks the ipc structure found at least at position pos.
843 static struct kern_ipc_perm *sysvipc_find_ipc(struct ipc_ids *ids, loff_t pos,
846 struct kern_ipc_perm *ipc;
850 for (id = 0; id < pos && total < ids->in_use; id++) {
851 ipc = idr_find(&ids->ipcs_idr, id);
856 if (total >= ids->in_use)
859 for ( ; pos < IPCMNI; pos++) {
860 ipc = idr_find(&ids->ipcs_idr, pos);
863 ipc_lock_by_ptr(ipc);
868 /* Out of range - return NULL to terminate iteration */
872 static void *sysvipc_proc_next(struct seq_file *s, void *it, loff_t *pos)
874 struct ipc_proc_iter *iter = s->private;
875 struct ipc_proc_iface *iface = iter->iface;
876 struct kern_ipc_perm *ipc = it;
878 /* If we had an ipc id locked before, unlock it */
879 if (ipc && ipc != SEQ_START_TOKEN)
882 return sysvipc_find_ipc(&iter->ns->ids[iface->ids], *pos, pos);
886 * File positions: pos 0 -> header, pos n -> ipc id = n - 1.
887 * SeqFile iterator: iterator value locked ipc pointer or SEQ_TOKEN_START.
889 static void *sysvipc_proc_start(struct seq_file *s, loff_t *pos)
891 struct ipc_proc_iter *iter = s->private;
892 struct ipc_proc_iface *iface = iter->iface;
895 ids = &iter->ns->ids[iface->ids];
898 * Take the lock - this will be released by the corresponding
901 down_read(&ids->rw_mutex);
903 /* pos < 0 is invalid */
907 /* pos == 0 means header */
909 return SEQ_START_TOKEN;
911 /* Find the (pos-1)th ipc */
912 return sysvipc_find_ipc(ids, *pos - 1, pos);
915 static void sysvipc_proc_stop(struct seq_file *s, void *it)
917 struct kern_ipc_perm *ipc = it;
918 struct ipc_proc_iter *iter = s->private;
919 struct ipc_proc_iface *iface = iter->iface;
922 /* If we had a locked structure, release it */
923 if (ipc && ipc != SEQ_START_TOKEN)
926 ids = &iter->ns->ids[iface->ids];
927 /* Release the lock we took in start() */
928 up_read(&ids->rw_mutex);
931 static int sysvipc_proc_show(struct seq_file *s, void *it)
933 struct ipc_proc_iter *iter = s->private;
934 struct ipc_proc_iface *iface = iter->iface;
936 if (it == SEQ_START_TOKEN)
937 return seq_puts(s, iface->header);
939 return iface->show(s, it);
942 static const struct seq_operations sysvipc_proc_seqops = {
943 .start = sysvipc_proc_start,
944 .stop = sysvipc_proc_stop,
945 .next = sysvipc_proc_next,
946 .show = sysvipc_proc_show,
949 static int sysvipc_proc_open(struct inode *inode, struct file *file)
952 struct seq_file *seq;
953 struct ipc_proc_iter *iter;
956 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
960 ret = seq_open(file, &sysvipc_proc_seqops);
964 seq = file->private_data;
967 iter->iface = PDE(inode)->data;
968 iter->ns = get_ipc_ns(current->nsproxy->ipc_ns);
976 static int sysvipc_proc_release(struct inode *inode, struct file *file)
978 struct seq_file *seq = file->private_data;
979 struct ipc_proc_iter *iter = seq->private;
980 put_ipc_ns(iter->ns);
981 return seq_release_private(inode, file);
984 static const struct file_operations sysvipc_proc_fops = {
985 .open = sysvipc_proc_open,
988 .release = sysvipc_proc_release,
990 #endif /* CONFIG_PROC_FS */