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 struct ipc_namespace init_ipc_ns = {
52 .refcount = ATOMIC_INIT(2),
56 atomic_t nr_ipc_ns = ATOMIC_INIT(1);
59 #ifdef CONFIG_MEMORY_HOTPLUG
61 static void ipc_memory_notifier(struct work_struct *work)
63 ipcns_notify(IPCNS_MEMCHANGED);
66 static DECLARE_WORK(ipc_memory_wq, ipc_memory_notifier);
69 static int ipc_memory_callback(struct notifier_block *self,
70 unsigned long action, void *arg)
73 case MEM_ONLINE: /* memory successfully brought online */
74 case MEM_OFFLINE: /* or offline: it's time to recompute msgmni */
76 * This is done by invoking the ipcns notifier chain with the
77 * IPC_MEMCHANGED event.
78 * In order not to keep the lock on the hotplug memory chain
79 * for too long, queue a work item that will, when waken up,
80 * activate the ipcns notification chain.
81 * No need to keep several ipc work items on the queue.
83 if (!work_pending(&ipc_memory_wq))
84 schedule_work(&ipc_memory_wq);
86 case MEM_GOING_ONLINE:
87 case MEM_GOING_OFFLINE:
88 case MEM_CANCEL_ONLINE:
89 case MEM_CANCEL_OFFLINE:
97 #endif /* CONFIG_MEMORY_HOTPLUG */
100 * ipc_init - initialise IPC subsystem
102 * The various system5 IPC resources (semaphores, messages and shared
103 * memory) are initialised
104 * A callback routine is registered into the memory hotplug notifier
105 * chain: since msgmni scales to lowmem this callback routine will be
106 * called upon successful memory add / remove to recompute msmgni.
109 static int __init ipc_init(void)
114 hotplug_memory_notifier(ipc_memory_callback, IPC_CALLBACK_PRI);
115 register_ipcns_notifier(&init_ipc_ns);
118 __initcall(ipc_init);
121 * ipc_init_ids - initialise IPC identifiers
122 * @ids: Identifier set
124 * Set up the sequence range to use for the ipc identifier range (limited
125 * below IPCMNI) then initialise the ids idr.
128 void ipc_init_ids(struct ipc_ids *ids)
130 init_rwsem(&ids->rw_mutex);
135 int seq_limit = INT_MAX/SEQ_MULTIPLIER;
136 if (seq_limit > USHORT_MAX)
137 ids->seq_max = USHORT_MAX;
139 ids->seq_max = seq_limit;
142 idr_init(&ids->ipcs_idr);
145 #ifdef CONFIG_PROC_FS
146 static const struct file_operations sysvipc_proc_fops;
148 * ipc_init_proc_interface - Create a proc interface for sysipc types using a seq_file interface.
149 * @path: Path in procfs
150 * @header: Banner to be printed at the beginning of the file.
151 * @ids: ipc id table to iterate.
152 * @show: show routine.
154 void __init ipc_init_proc_interface(const char *path, const char *header,
155 int ids, int (*show)(struct seq_file *, void *))
157 struct proc_dir_entry *pde;
158 struct ipc_proc_iface *iface;
160 iface = kmalloc(sizeof(*iface), GFP_KERNEL);
164 iface->header = header;
168 pde = proc_create_data(path,
169 S_IRUGO, /* world readable */
170 NULL, /* parent dir */
180 * ipc_findkey - find a key in an ipc identifier set
181 * @ids: Identifier set
182 * @key: The key to find
184 * Requires ipc_ids.rw_mutex locked.
185 * Returns the LOCKED pointer to the ipc structure if found or NULL
187 * If key is found ipc points to the owning ipc structure
190 static struct kern_ipc_perm *ipc_findkey(struct ipc_ids *ids, key_t key)
192 struct kern_ipc_perm *ipc;
196 for (total = 0, next_id = 0; total < ids->in_use; next_id++) {
197 ipc = idr_find(&ids->ipcs_idr, next_id);
202 if (ipc->key != key) {
207 ipc_lock_by_ptr(ipc);
215 * ipc_get_maxid - get the last assigned id
216 * @ids: IPC identifier set
218 * Called with ipc_ids.rw_mutex held.
221 int ipc_get_maxid(struct ipc_ids *ids)
223 struct kern_ipc_perm *ipc;
227 if (ids->in_use == 0)
230 if (ids->in_use == IPCMNI)
233 /* Look for the last assigned id */
235 for (id = 0; id < IPCMNI && total < ids->in_use; id++) {
236 ipc = idr_find(&ids->ipcs_idr, id);
246 * ipc_addid - add an IPC identifier
247 * @ids: IPC identifier set
248 * @new: new IPC permission set
249 * @size: limit for the number of used ids
251 * Add an entry 'new' to the IPC ids idr. The permissions object is
252 * initialised and the first free entry is set up and the id assigned
253 * is returned. The 'new' entry is returned in a locked state on success.
254 * On failure the entry is not locked and a negative err-code is returned.
256 * Called with ipc_ids.rw_mutex held as a writer.
259 int ipc_addid(struct ipc_ids* ids, struct kern_ipc_perm* new, int size)
268 if (ids->in_use >= size)
271 spin_lock_init(&new->lock);
274 spin_lock(&new->lock);
276 err = idr_get_new(&ids->ipcs_idr, new, &id);
278 spin_unlock(&new->lock);
285 current_euid_egid(&euid, &egid);
286 new->cuid = new->uid = euid;
287 new->gid = new->cgid = egid;
289 new->seq = ids->seq++;
290 if(ids->seq > ids->seq_max)
293 new->id = ipc_buildid(id, new->seq);
298 * ipcget_new - create a new ipc object
300 * @ids: IPC identifer set
301 * @ops: the actual creation routine to call
302 * @params: its parameters
304 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
305 * when the key is IPC_PRIVATE.
307 static int ipcget_new(struct ipc_namespace *ns, struct ipc_ids *ids,
308 struct ipc_ops *ops, struct ipc_params *params)
312 err = idr_pre_get(&ids->ipcs_idr, GFP_KERNEL);
317 down_write(&ids->rw_mutex);
318 err = ops->getnew(ns, params);
319 up_write(&ids->rw_mutex);
328 * ipc_check_perms - check security and permissions for an IPC
329 * @ipcp: ipc permission set
330 * @ops: the actual security routine to call
331 * @params: its parameters
333 * This routine is called by sys_msgget(), sys_semget() and sys_shmget()
334 * when the key is not IPC_PRIVATE and that key already exists in the
337 * On success, the IPC id is returned.
339 * It is called with ipc_ids.rw_mutex and ipcp->lock held.
341 static int ipc_check_perms(struct kern_ipc_perm *ipcp, struct ipc_ops *ops,
342 struct ipc_params *params)
346 if (ipcperms(ipcp, params->flg))
349 err = ops->associate(ipcp, params->flg);
358 * ipcget_public - get an ipc object or create a new one
360 * @ids: IPC identifer set
361 * @ops: the actual creation routine to call
362 * @params: its parameters
364 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
365 * when the key is not IPC_PRIVATE.
366 * It adds a new entry if the key is not found and does some permission
367 * / security checkings if the key is found.
369 * On success, the ipc id is returned.
371 static int ipcget_public(struct ipc_namespace *ns, struct ipc_ids *ids,
372 struct ipc_ops *ops, struct ipc_params *params)
374 struct kern_ipc_perm *ipcp;
375 int flg = params->flg;
378 err = idr_pre_get(&ids->ipcs_idr, GFP_KERNEL);
381 * Take the lock as a writer since we are potentially going to add
382 * a new entry + read locks are not "upgradable"
384 down_write(&ids->rw_mutex);
385 ipcp = ipc_findkey(ids, params->key);
388 if (!(flg & IPC_CREAT))
393 err = ops->getnew(ns, params);
395 /* ipc object has been locked by ipc_findkey() */
397 if (flg & IPC_CREAT && flg & IPC_EXCL)
401 if (ops->more_checks)
402 err = ops->more_checks(ipcp, params);
405 * ipc_check_perms returns the IPC id on
408 err = ipc_check_perms(ipcp, ops, params);
412 up_write(&ids->rw_mutex);
422 * ipc_rmid - remove an IPC identifier
423 * @ids: IPC identifier set
424 * @ipcp: ipc perm structure containing the identifier to remove
426 * ipc_ids.rw_mutex (as a writer) and the spinlock for this ID are held
427 * before this function is called, and remain locked on the exit.
430 void ipc_rmid(struct ipc_ids *ids, struct kern_ipc_perm *ipcp)
432 int lid = ipcid_to_idx(ipcp->id);
434 idr_remove(&ids->ipcs_idr, lid);
444 * ipc_alloc - allocate ipc space
445 * @size: size desired
447 * Allocate memory from the appropriate pools and return a pointer to it.
448 * NULL is returned if the allocation fails
451 void* ipc_alloc(int size)
457 out = kmalloc(size, GFP_KERNEL);
462 * ipc_free - free ipc space
463 * @ptr: pointer returned by ipc_alloc
464 * @size: size of block
466 * Free a block created with ipc_alloc(). The caller must know the size
467 * used in the allocation call.
470 void ipc_free(void* ptr, int size)
480 * There are three headers that are prepended to the actual allocation:
481 * - during use: ipc_rcu_hdr.
482 * - during the rcu grace period: ipc_rcu_grace.
483 * - [only if vmalloc]: ipc_rcu_sched.
484 * Their lifetime doesn't overlap, thus the headers share the same memory.
485 * Unlike a normal union, they are right-aligned, thus some container_of
486 * forward/backward casting is necessary:
499 /* "void *" makes sure alignment of following data is sane. */
505 struct work_struct work;
506 /* "void *" makes sure alignment of following data is sane. */
510 #define HDRLEN_KMALLOC (sizeof(struct ipc_rcu_grace) > sizeof(struct ipc_rcu_hdr) ? \
511 sizeof(struct ipc_rcu_grace) : sizeof(struct ipc_rcu_hdr))
512 #define HDRLEN_VMALLOC (sizeof(struct ipc_rcu_sched) > HDRLEN_KMALLOC ? \
513 sizeof(struct ipc_rcu_sched) : HDRLEN_KMALLOC)
515 static inline int rcu_use_vmalloc(int size)
517 /* Too big for a single page? */
518 if (HDRLEN_KMALLOC + size > PAGE_SIZE)
524 * ipc_rcu_alloc - allocate ipc and rcu space
525 * @size: size desired
527 * Allocate memory for the rcu header structure + the object.
528 * Returns the pointer to the object.
529 * NULL is returned if the allocation fails.
532 void* ipc_rcu_alloc(int size)
536 * We prepend the allocation with the rcu struct, and
537 * workqueue if necessary (for vmalloc).
539 if (rcu_use_vmalloc(size)) {
540 out = vmalloc(HDRLEN_VMALLOC + size);
542 out += HDRLEN_VMALLOC;
543 container_of(out, struct ipc_rcu_hdr, data)->is_vmalloc = 1;
544 container_of(out, struct ipc_rcu_hdr, data)->refcount = 1;
547 out = kmalloc(HDRLEN_KMALLOC + size, GFP_KERNEL);
549 out += HDRLEN_KMALLOC;
550 container_of(out, struct ipc_rcu_hdr, data)->is_vmalloc = 0;
551 container_of(out, struct ipc_rcu_hdr, data)->refcount = 1;
558 void ipc_rcu_getref(void *ptr)
560 container_of(ptr, struct ipc_rcu_hdr, data)->refcount++;
563 static void ipc_do_vfree(struct work_struct *work)
565 vfree(container_of(work, struct ipc_rcu_sched, work));
569 * ipc_schedule_free - free ipc + rcu space
570 * @head: RCU callback structure for queued work
572 * Since RCU callback function is called in bh,
573 * we need to defer the vfree to schedule_work().
575 static void ipc_schedule_free(struct rcu_head *head)
577 struct ipc_rcu_grace *grace;
578 struct ipc_rcu_sched *sched;
580 grace = container_of(head, struct ipc_rcu_grace, rcu);
581 sched = container_of(&(grace->data[0]), struct ipc_rcu_sched,
584 INIT_WORK(&sched->work, ipc_do_vfree);
585 schedule_work(&sched->work);
589 * ipc_immediate_free - free ipc + rcu space
590 * @head: RCU callback structure that contains pointer to be freed
592 * Free from the RCU callback context.
594 static void ipc_immediate_free(struct rcu_head *head)
596 struct ipc_rcu_grace *free =
597 container_of(head, struct ipc_rcu_grace, rcu);
601 void ipc_rcu_putref(void *ptr)
603 if (--container_of(ptr, struct ipc_rcu_hdr, data)->refcount > 0)
606 if (container_of(ptr, struct ipc_rcu_hdr, data)->is_vmalloc) {
607 call_rcu(&container_of(ptr, struct ipc_rcu_grace, data)->rcu,
610 call_rcu(&container_of(ptr, struct ipc_rcu_grace, data)->rcu,
616 * ipcperms - check IPC permissions
617 * @ipcp: IPC permission set
618 * @flag: desired permission set.
620 * Check user, group, other permissions for access
621 * to ipc resources. return 0 if allowed
624 int ipcperms (struct kern_ipc_perm *ipcp, short flag)
625 { /* flag will most probably be 0 or S_...UGO from <linux/stat.h> */
626 uid_t euid = current_euid();
627 int requested_mode, granted_mode;
630 requested_mode = (flag >> 6) | (flag >> 3) | flag;
631 granted_mode = ipcp->mode;
632 if (euid == ipcp->cuid ||
635 else if (in_group_p(ipcp->cgid) || in_group_p(ipcp->gid))
637 /* is there some bit set in requested_mode but not in granted_mode? */
638 if ((requested_mode & ~granted_mode & 0007) &&
639 !capable(CAP_IPC_OWNER))
642 return security_ipc_permission(ipcp, flag);
646 * Functions to convert between the kern_ipc_perm structure and the
647 * old/new ipc_perm structures
651 * kernel_to_ipc64_perm - convert kernel ipc permissions to user
652 * @in: kernel permissions
653 * @out: new style IPC permissions
655 * Turn the kernel object @in into a set of permissions descriptions
656 * for returning to userspace (@out).
660 void kernel_to_ipc64_perm (struct kern_ipc_perm *in, struct ipc64_perm *out)
665 out->cuid = in->cuid;
666 out->cgid = in->cgid;
667 out->mode = in->mode;
672 * ipc64_perm_to_ipc_perm - convert new ipc permissions to old
673 * @in: new style IPC permissions
674 * @out: old style IPC permissions
676 * Turn the new style permissions object @in into a compatibility
677 * object and store it into the @out pointer.
680 void ipc64_perm_to_ipc_perm (struct ipc64_perm *in, struct ipc_perm *out)
683 SET_UID(out->uid, in->uid);
684 SET_GID(out->gid, in->gid);
685 SET_UID(out->cuid, in->cuid);
686 SET_GID(out->cgid, in->cgid);
687 out->mode = in->mode;
692 * ipc_lock - Lock an ipc structure without rw_mutex held
693 * @ids: IPC identifier set
694 * @id: ipc id to look for
696 * Look for an id in the ipc ids idr and lock the associated ipc object.
698 * The ipc object is locked on exit.
701 struct kern_ipc_perm *ipc_lock(struct ipc_ids *ids, int id)
703 struct kern_ipc_perm *out;
704 int lid = ipcid_to_idx(id);
707 out = idr_find(&ids->ipcs_idr, lid);
710 return ERR_PTR(-EINVAL);
713 spin_lock(&out->lock);
715 /* ipc_rmid() may have already freed the ID while ipc_lock
716 * was spinning: here verify that the structure is still valid
719 spin_unlock(&out->lock);
721 return ERR_PTR(-EINVAL);
727 struct kern_ipc_perm *ipc_lock_check(struct ipc_ids *ids, int id)
729 struct kern_ipc_perm *out;
731 out = ipc_lock(ids, id);
735 if (ipc_checkid(out, id)) {
737 return ERR_PTR(-EIDRM);
744 * ipcget - Common sys_*get() code
746 * @ids : IPC identifier set
747 * @ops : operations to be called on ipc object creation, permission checks
749 * @params : the parameters needed by the previous operations.
751 * Common routine called by sys_msgget(), sys_semget() and sys_shmget().
753 int ipcget(struct ipc_namespace *ns, struct ipc_ids *ids,
754 struct ipc_ops *ops, struct ipc_params *params)
756 if (params->key == IPC_PRIVATE)
757 return ipcget_new(ns, ids, ops, params);
759 return ipcget_public(ns, ids, ops, params);
763 * ipc_update_perm - update the permissions of an IPC.
764 * @in: the permission given as input.
765 * @out: the permission of the ipc to set.
767 void ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out)
771 out->mode = (out->mode & ~S_IRWXUGO)
772 | (in->mode & S_IRWXUGO);
776 * ipcctl_pre_down - retrieve an ipc and check permissions for some IPC_XXX cmd
777 * @ids: the table of ids where to look for the ipc
778 * @id: the id of the ipc to retrieve
779 * @cmd: the cmd to check
780 * @perm: the permission to set
781 * @extra_perm: one extra permission parameter used by msq
783 * This function does some common audit and permissions check for some IPC_XXX
784 * cmd and is called from semctl_down, shmctl_down and msgctl_down.
785 * It must be called without any lock held and
786 * - retrieves the ipc with the given id in the given table.
787 * - performs some audit and permission check, depending on the given cmd
788 * - returns the ipc with both ipc and rw_mutex locks held in case of success
789 * or an err-code without any lock held otherwise.
791 struct kern_ipc_perm *ipcctl_pre_down(struct ipc_ids *ids, int id, int cmd,
792 struct ipc64_perm *perm, int extra_perm)
794 struct kern_ipc_perm *ipcp;
798 down_write(&ids->rw_mutex);
799 ipcp = ipc_lock_check(ids, id);
807 audit_ipc_set_perm(extra_perm, perm->uid,
808 perm->gid, perm->mode);
810 euid = current_euid();
811 if (euid == ipcp->cuid ||
812 euid == ipcp->uid || capable(CAP_SYS_ADMIN))
818 up_write(&ids->rw_mutex);
822 #ifdef __ARCH_WANT_IPC_PARSE_VERSION
826 * ipc_parse_version - IPC call version
827 * @cmd: pointer to command
829 * Return IPC_64 for new style IPC and IPC_OLD for old style IPC.
830 * The @cmd value is turned from an encoding command and version into
831 * just the command code.
834 int ipc_parse_version (int *cmd)
844 #endif /* __ARCH_WANT_IPC_PARSE_VERSION */
846 #ifdef CONFIG_PROC_FS
847 struct ipc_proc_iter {
848 struct ipc_namespace *ns;
849 struct ipc_proc_iface *iface;
853 * This routine locks the ipc structure found at least at position pos.
855 static struct kern_ipc_perm *sysvipc_find_ipc(struct ipc_ids *ids, loff_t pos,
858 struct kern_ipc_perm *ipc;
862 for (id = 0; id < pos && total < ids->in_use; id++) {
863 ipc = idr_find(&ids->ipcs_idr, id);
868 if (total >= ids->in_use)
871 for ( ; pos < IPCMNI; pos++) {
872 ipc = idr_find(&ids->ipcs_idr, pos);
875 ipc_lock_by_ptr(ipc);
880 /* Out of range - return NULL to terminate iteration */
884 static void *sysvipc_proc_next(struct seq_file *s, void *it, loff_t *pos)
886 struct ipc_proc_iter *iter = s->private;
887 struct ipc_proc_iface *iface = iter->iface;
888 struct kern_ipc_perm *ipc = it;
890 /* If we had an ipc id locked before, unlock it */
891 if (ipc && ipc != SEQ_START_TOKEN)
894 return sysvipc_find_ipc(&iter->ns->ids[iface->ids], *pos, pos);
898 * File positions: pos 0 -> header, pos n -> ipc id = n - 1.
899 * SeqFile iterator: iterator value locked ipc pointer or SEQ_TOKEN_START.
901 static void *sysvipc_proc_start(struct seq_file *s, loff_t *pos)
903 struct ipc_proc_iter *iter = s->private;
904 struct ipc_proc_iface *iface = iter->iface;
907 ids = &iter->ns->ids[iface->ids];
910 * Take the lock - this will be released by the corresponding
913 down_read(&ids->rw_mutex);
915 /* pos < 0 is invalid */
919 /* pos == 0 means header */
921 return SEQ_START_TOKEN;
923 /* Find the (pos-1)th ipc */
924 return sysvipc_find_ipc(ids, *pos - 1, pos);
927 static void sysvipc_proc_stop(struct seq_file *s, void *it)
929 struct kern_ipc_perm *ipc = it;
930 struct ipc_proc_iter *iter = s->private;
931 struct ipc_proc_iface *iface = iter->iface;
934 /* If we had a locked structure, release it */
935 if (ipc && ipc != SEQ_START_TOKEN)
938 ids = &iter->ns->ids[iface->ids];
939 /* Release the lock we took in start() */
940 up_read(&ids->rw_mutex);
943 static int sysvipc_proc_show(struct seq_file *s, void *it)
945 struct ipc_proc_iter *iter = s->private;
946 struct ipc_proc_iface *iface = iter->iface;
948 if (it == SEQ_START_TOKEN)
949 return seq_puts(s, iface->header);
951 return iface->show(s, it);
954 static struct seq_operations sysvipc_proc_seqops = {
955 .start = sysvipc_proc_start,
956 .stop = sysvipc_proc_stop,
957 .next = sysvipc_proc_next,
958 .show = sysvipc_proc_show,
961 static int sysvipc_proc_open(struct inode *inode, struct file *file)
964 struct seq_file *seq;
965 struct ipc_proc_iter *iter;
968 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
972 ret = seq_open(file, &sysvipc_proc_seqops);
976 seq = file->private_data;
979 iter->iface = PDE(inode)->data;
980 iter->ns = get_ipc_ns(current->nsproxy->ipc_ns);
988 static int sysvipc_proc_release(struct inode *inode, struct file *file)
990 struct seq_file *seq = file->private_data;
991 struct ipc_proc_iter *iter = seq->private;
992 put_ipc_ns(iter->ns);
993 return seq_release_private(inode, file);
996 static const struct file_operations sysvipc_proc_fops = {
997 .open = sysvipc_proc_open,
1000 .release = sysvipc_proc_release,
1002 #endif /* CONFIG_PROC_FS */