1 // SPDX-License-Identifier: GPL-2.0
4 * Copyright (C) 1992 Krishna Balasubramanian
6 * Sep 1997 - Call suser() last after "normal" permission checks so we
7 * get BSD style process accounting right.
8 * Occurs in several places in the IPC code.
9 * Chris Evans, <chris@ferret.lmh.ox.ac.uk>
10 * Nov 1999 - ipc helper functions, unified SMP locking
11 * Manfred Spraul <manfred@colorfullife.com>
12 * Oct 2002 - One lock per IPC id. RCU ipc_free for lock-free grow_ary().
13 * Mingming Cao <cmm@us.ibm.com>
14 * Mar 2006 - support for audit of ipc object properties
15 * Dustin Kirkland <dustin.kirkland@us.ibm.com>
16 * Jun 2006 - namespaces ssupport
18 * Pavel Emelianov <xemul@openvz.org>
20 * General sysv ipc locking scheme:
22 * obtain the ipc object (kern_ipc_perm) by looking up the id in an idr
24 * - perform initial checks (capabilities, auditing and permission,
26 * - perform read-only operations, such as STAT, INFO commands.
27 * acquire the ipc lock (kern_ipc_perm.lock) through
29 * - perform data updates, such as SET, RMID commands and
30 * mechanism-specific operations (semop/semtimedop,
31 * msgsnd/msgrcv, shmat/shmdt).
32 * drop the ipc lock, through ipc_unlock_object().
35 * The ids->rwsem must be taken when:
36 * - creating, removing and iterating the existing entries in ipc
38 * - iterating through files under /proc/sysvipc/
40 * Note that sems have a special fast path that avoids kern_ipc_perm.lock -
45 #include <linux/shm.h>
46 #include <linux/init.h>
47 #include <linux/msg.h>
48 #include <linux/vmalloc.h>
49 #include <linux/slab.h>
50 #include <linux/notifier.h>
51 #include <linux/capability.h>
52 #include <linux/highuid.h>
53 #include <linux/security.h>
54 #include <linux/rcupdate.h>
55 #include <linux/workqueue.h>
56 #include <linux/seq_file.h>
57 #include <linux/proc_fs.h>
58 #include <linux/audit.h>
59 #include <linux/nsproxy.h>
60 #include <linux/rwsem.h>
61 #include <linux/memory.h>
62 #include <linux/ipc_namespace.h>
64 #include <asm/unistd.h>
68 struct ipc_proc_iface
{
72 int (*show
)(struct seq_file
*, void *);
76 * ipc_init - initialise ipc subsystem
78 * The various sysv ipc resources (semaphores, messages and shared
79 * memory) are initialised.
81 * A callback routine is registered into the memory hotplug notifier
82 * chain: since msgmni scales to lowmem this callback routine will be
83 * called upon successful memory add / remove to recompute msmgni.
85 static int __init
ipc_init(void)
90 WARN(err_sem
, "ipc: sysv sem_init failed: %d\n", err_sem
);
92 WARN(err_msg
, "ipc: sysv msg_init failed: %d\n", err_msg
);
95 return err_msg
? err_msg
: err_sem
;
97 device_initcall(ipc_init
);
99 static const struct rhashtable_params ipc_kht_params
= {
100 .head_offset
= offsetof(struct kern_ipc_perm
, khtnode
),
101 .key_offset
= offsetof(struct kern_ipc_perm
, key
),
102 .key_len
= FIELD_SIZEOF(struct kern_ipc_perm
, key
),
104 .automatic_shrinking
= true,
108 * ipc_init_ids - initialise ipc identifiers
109 * @ids: ipc identifier set
111 * Set up the sequence range to use for the ipc identifier range (limited
112 * below IPCMNI) then initialise the keys hashtable and ids idr.
114 int ipc_init_ids(struct ipc_ids
*ids
)
120 init_rwsem(&ids
->rwsem
);
121 err
= rhashtable_init(&ids
->key_ht
, &ipc_kht_params
);
124 idr_init(&ids
->ipcs_idr
);
125 ids
->tables_initialized
= true;
129 #ifdef CONFIG_PROC_FS
130 static const struct file_operations sysvipc_proc_fops
;
132 * ipc_init_proc_interface - create a proc interface for sysipc types using a seq_file interface.
133 * @path: Path in procfs
134 * @header: Banner to be printed at the beginning of the file.
135 * @ids: ipc id table to iterate.
136 * @show: show routine.
138 void __init
ipc_init_proc_interface(const char *path
, const char *header
,
139 int ids
, int (*show
)(struct seq_file
*, void *))
141 struct proc_dir_entry
*pde
;
142 struct ipc_proc_iface
*iface
;
144 iface
= kmalloc(sizeof(*iface
), GFP_KERNEL
);
148 iface
->header
= header
;
152 pde
= proc_create_data(path
,
153 S_IRUGO
, /* world readable */
154 NULL
, /* parent dir */
163 * ipc_findkey - find a key in an ipc identifier set
164 * @ids: ipc identifier set
167 * Returns the locked pointer to the ipc structure if found or NULL
168 * otherwise. If key is found ipc points to the owning ipc structure
170 * Called with writer ipc_ids.rwsem held.
172 static struct kern_ipc_perm
*ipc_findkey(struct ipc_ids
*ids
, key_t key
)
174 struct kern_ipc_perm
*ipcp
= NULL
;
176 if (likely(ids
->tables_initialized
))
177 ipcp
= rhashtable_lookup_fast(&ids
->key_ht
, &key
,
182 ipc_lock_object(ipcp
);
190 * ipc_get_maxid - get the last assigned id
191 * @ids: ipc identifier set
193 * Called with ipc_ids.rwsem held.
195 int ipc_get_maxid(struct ipc_ids
*ids
)
197 struct kern_ipc_perm
*ipc
;
201 if (ids
->in_use
== 0)
204 if (ids
->in_use
== IPCMNI
)
207 /* Look for the last assigned id */
209 for (id
= 0; id
< IPCMNI
&& total
< ids
->in_use
; id
++) {
210 ipc
= idr_find(&ids
->ipcs_idr
, id
);
220 * ipc_addid - add an ipc identifier
221 * @ids: ipc identifier set
222 * @new: new ipc permission set
223 * @size: limit for the number of used ids
225 * Add an entry 'new' to the ipc ids idr. The permissions object is
226 * initialised and the first free entry is set up and the id assigned
227 * is returned. The 'new' entry is returned in a locked state on success.
228 * On failure the entry is not locked and a negative err-code is returned.
230 * Called with writer ipc_ids.rwsem held.
232 int ipc_addid(struct ipc_ids
*ids
, struct kern_ipc_perm
*new, int size
)
237 int next_id
= ids
->next_id
;
242 if (!ids
->tables_initialized
|| ids
->in_use
>= size
)
245 idr_preload(GFP_KERNEL
);
247 refcount_set(&new->refcount
, 1);
248 spin_lock_init(&new->lock
);
249 new->deleted
= false;
251 spin_lock(&new->lock
);
253 current_euid_egid(&euid
, &egid
);
254 new->cuid
= new->uid
= euid
;
255 new->gid
= new->cgid
= egid
;
257 id
= idr_alloc(&ids
->ipcs_idr
, new,
258 (next_id
< 0) ? 0 : ipcid_to_idx(next_id
), 0,
262 if (id
>= 0 && new->key
!= IPC_PRIVATE
) {
263 err
= rhashtable_insert_fast(&ids
->key_ht
, &new->khtnode
,
266 idr_remove(&ids
->ipcs_idr
, id
);
271 spin_unlock(&new->lock
);
279 new->seq
= ids
->seq
++;
280 if (ids
->seq
> IPCID_SEQ_MAX
)
283 new->seq
= ipcid_to_seqx(next_id
);
287 new->id
= ipc_buildid(id
, new->seq
);
292 * ipcget_new - create a new ipc object
294 * @ids: ipc identifier set
295 * @ops: the actual creation 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 IPC_PRIVATE.
301 static int ipcget_new(struct ipc_namespace
*ns
, struct ipc_ids
*ids
,
302 const struct ipc_ops
*ops
, struct ipc_params
*params
)
306 down_write(&ids
->rwsem
);
307 err
= ops
->getnew(ns
, params
);
308 up_write(&ids
->rwsem
);
313 * ipc_check_perms - check security and permissions for an ipc object
315 * @ipcp: ipc permission set
316 * @ops: the actual security routine to call
317 * @params: its parameters
319 * This routine is called by sys_msgget(), sys_semget() and sys_shmget()
320 * when the key is not IPC_PRIVATE and that key already exists in the
323 * On success, the ipc id is returned.
325 * It is called with ipc_ids.rwsem and ipcp->lock held.
327 static int ipc_check_perms(struct ipc_namespace
*ns
,
328 struct kern_ipc_perm
*ipcp
,
329 const struct ipc_ops
*ops
,
330 struct ipc_params
*params
)
334 if (ipcperms(ns
, ipcp
, params
->flg
))
337 err
= ops
->associate(ipcp
, params
->flg
);
346 * ipcget_public - get an ipc object or create a new one
348 * @ids: ipc identifier set
349 * @ops: the actual creation routine to call
350 * @params: its parameters
352 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
353 * when the key is not IPC_PRIVATE.
354 * It adds a new entry if the key is not found and does some permission
355 * / security checkings if the key is found.
357 * On success, the ipc id is returned.
359 static int ipcget_public(struct ipc_namespace
*ns
, struct ipc_ids
*ids
,
360 const struct ipc_ops
*ops
, struct ipc_params
*params
)
362 struct kern_ipc_perm
*ipcp
;
363 int flg
= params
->flg
;
367 * Take the lock as a writer since we are potentially going to add
368 * a new entry + read locks are not "upgradable"
370 down_write(&ids
->rwsem
);
371 ipcp
= ipc_findkey(ids
, params
->key
);
374 if (!(flg
& IPC_CREAT
))
377 err
= ops
->getnew(ns
, params
);
379 /* ipc object has been locked by ipc_findkey() */
381 if (flg
& IPC_CREAT
&& flg
& IPC_EXCL
)
385 if (ops
->more_checks
)
386 err
= ops
->more_checks(ipcp
, params
);
389 * ipc_check_perms returns the IPC id on
392 err
= ipc_check_perms(ns
, ipcp
, ops
, params
);
396 up_write(&ids
->rwsem
);
402 * ipc_kht_remove - remove an ipc from the key hashtable
403 * @ids: ipc identifier set
404 * @ipcp: ipc perm structure containing the key to remove
406 * ipc_ids.rwsem (as a writer) and the spinlock for this ID are held
407 * before this function is called, and remain locked on the exit.
409 static void ipc_kht_remove(struct ipc_ids
*ids
, struct kern_ipc_perm
*ipcp
)
411 if (ipcp
->key
!= IPC_PRIVATE
)
412 rhashtable_remove_fast(&ids
->key_ht
, &ipcp
->khtnode
,
417 * ipc_rmid - remove an ipc identifier
418 * @ids: ipc identifier set
419 * @ipcp: ipc perm structure containing the identifier to remove
421 * ipc_ids.rwsem (as a writer) and the spinlock for this ID are held
422 * before this function is called, and remain locked on the exit.
424 void ipc_rmid(struct ipc_ids
*ids
, struct kern_ipc_perm
*ipcp
)
426 int lid
= ipcid_to_idx(ipcp
->id
);
428 idr_remove(&ids
->ipcs_idr
, lid
);
429 ipc_kht_remove(ids
, ipcp
);
431 ipcp
->deleted
= true;
435 * ipc_set_key_private - switch the key of an existing ipc to IPC_PRIVATE
436 * @ids: ipc identifier set
437 * @ipcp: ipc perm structure containing the key to modify
439 * ipc_ids.rwsem (as a writer) and the spinlock for this ID are held
440 * before this function is called, and remain locked on the exit.
442 void ipc_set_key_private(struct ipc_ids
*ids
, struct kern_ipc_perm
*ipcp
)
444 ipc_kht_remove(ids
, ipcp
);
445 ipcp
->key
= IPC_PRIVATE
;
448 int ipc_rcu_getref(struct kern_ipc_perm
*ptr
)
450 return refcount_inc_not_zero(&ptr
->refcount
);
453 void ipc_rcu_putref(struct kern_ipc_perm
*ptr
,
454 void (*func
)(struct rcu_head
*head
))
456 if (!refcount_dec_and_test(&ptr
->refcount
))
459 call_rcu(&ptr
->rcu
, func
);
463 * ipcperms - check ipc permissions
465 * @ipcp: ipc permission set
466 * @flag: desired permission set
468 * Check user, group, other permissions for access
469 * to ipc resources. return 0 if allowed
471 * @flag will most probably be 0 or ``S_...UGO`` from <linux/stat.h>
473 int ipcperms(struct ipc_namespace
*ns
, struct kern_ipc_perm
*ipcp
, short flag
)
475 kuid_t euid
= current_euid();
476 int requested_mode
, granted_mode
;
479 requested_mode
= (flag
>> 6) | (flag
>> 3) | flag
;
480 granted_mode
= ipcp
->mode
;
481 if (uid_eq(euid
, ipcp
->cuid
) ||
482 uid_eq(euid
, ipcp
->uid
))
484 else if (in_group_p(ipcp
->cgid
) || in_group_p(ipcp
->gid
))
486 /* is there some bit set in requested_mode but not in granted_mode? */
487 if ((requested_mode
& ~granted_mode
& 0007) &&
488 !ns_capable(ns
->user_ns
, CAP_IPC_OWNER
))
491 return security_ipc_permission(ipcp
, flag
);
495 * Functions to convert between the kern_ipc_perm structure and the
496 * old/new ipc_perm structures
500 * kernel_to_ipc64_perm - convert kernel ipc permissions to user
501 * @in: kernel permissions
502 * @out: new style ipc permissions
504 * Turn the kernel object @in into a set of permissions descriptions
505 * for returning to userspace (@out).
507 void kernel_to_ipc64_perm(struct kern_ipc_perm
*in
, struct ipc64_perm
*out
)
510 out
->uid
= from_kuid_munged(current_user_ns(), in
->uid
);
511 out
->gid
= from_kgid_munged(current_user_ns(), in
->gid
);
512 out
->cuid
= from_kuid_munged(current_user_ns(), in
->cuid
);
513 out
->cgid
= from_kgid_munged(current_user_ns(), in
->cgid
);
514 out
->mode
= in
->mode
;
519 * ipc64_perm_to_ipc_perm - convert new ipc permissions to old
520 * @in: new style ipc permissions
521 * @out: old style ipc permissions
523 * Turn the new style permissions object @in into a compatibility
524 * object and store it into the @out pointer.
526 void ipc64_perm_to_ipc_perm(struct ipc64_perm
*in
, struct ipc_perm
*out
)
529 SET_UID(out
->uid
, in
->uid
);
530 SET_GID(out
->gid
, in
->gid
);
531 SET_UID(out
->cuid
, in
->cuid
);
532 SET_GID(out
->cgid
, in
->cgid
);
533 out
->mode
= in
->mode
;
538 * ipc_obtain_object_idr
539 * @ids: ipc identifier set
540 * @id: ipc id to look for
542 * Look for an id in the ipc ids idr and return associated ipc object.
544 * Call inside the RCU critical section.
545 * The ipc object is *not* locked on exit.
547 struct kern_ipc_perm
*ipc_obtain_object_idr(struct ipc_ids
*ids
, int id
)
549 struct kern_ipc_perm
*out
;
550 int lid
= ipcid_to_idx(id
);
552 if (unlikely(!ids
->tables_initialized
))
553 return ERR_PTR(-EINVAL
);
555 out
= idr_find(&ids
->ipcs_idr
, lid
);
557 return ERR_PTR(-EINVAL
);
563 * ipc_lock - lock an ipc structure without rwsem held
564 * @ids: ipc identifier set
565 * @id: ipc id to look for
567 * Look for an id in the ipc ids idr and lock the associated ipc object.
569 * The ipc object is locked on successful exit.
571 struct kern_ipc_perm
*ipc_lock(struct ipc_ids
*ids
, int id
)
573 struct kern_ipc_perm
*out
;
576 out
= ipc_obtain_object_idr(ids
, id
);
580 spin_lock(&out
->lock
);
583 * ipc_rmid() may have already freed the ID while ipc_lock()
584 * was spinning: here verify that the structure is still valid.
585 * Upon races with RMID, return -EIDRM, thus indicating that
586 * the ID points to a removed identifier.
588 if (ipc_valid_object(out
))
591 spin_unlock(&out
->lock
);
592 out
= ERR_PTR(-EIDRM
);
599 * ipc_obtain_object_check
600 * @ids: ipc identifier set
601 * @id: ipc id to look for
603 * Similar to ipc_obtain_object_idr() but also checks
604 * the ipc object reference counter.
606 * Call inside the RCU critical section.
607 * The ipc object is *not* locked on exit.
609 struct kern_ipc_perm
*ipc_obtain_object_check(struct ipc_ids
*ids
, int id
)
611 struct kern_ipc_perm
*out
= ipc_obtain_object_idr(ids
, id
);
616 if (ipc_checkid(out
, id
))
617 return ERR_PTR(-EINVAL
);
623 * ipcget - Common sys_*get() code
625 * @ids: ipc identifier set
626 * @ops: operations to be called on ipc object creation, permission checks
628 * @params: the parameters needed by the previous operations.
630 * Common routine called by sys_msgget(), sys_semget() and sys_shmget().
632 int ipcget(struct ipc_namespace
*ns
, struct ipc_ids
*ids
,
633 const struct ipc_ops
*ops
, struct ipc_params
*params
)
635 if (params
->key
== IPC_PRIVATE
)
636 return ipcget_new(ns
, ids
, ops
, params
);
638 return ipcget_public(ns
, ids
, ops
, params
);
642 * ipc_update_perm - update the permissions of an ipc object
643 * @in: the permission given as input.
644 * @out: the permission of the ipc to set.
646 int ipc_update_perm(struct ipc64_perm
*in
, struct kern_ipc_perm
*out
)
648 kuid_t uid
= make_kuid(current_user_ns(), in
->uid
);
649 kgid_t gid
= make_kgid(current_user_ns(), in
->gid
);
650 if (!uid_valid(uid
) || !gid_valid(gid
))
655 out
->mode
= (out
->mode
& ~S_IRWXUGO
)
656 | (in
->mode
& S_IRWXUGO
);
662 * ipcctl_pre_down_nolock - retrieve an ipc and check permissions for some IPC_XXX cmd
664 * @ids: the table of ids where to look for the ipc
665 * @id: the id of the ipc to retrieve
666 * @cmd: the cmd to check
667 * @perm: the permission to set
668 * @extra_perm: one extra permission parameter used by msq
670 * This function does some common audit and permissions check for some IPC_XXX
671 * cmd and is called from semctl_down, shmctl_down and msgctl_down.
672 * It must be called without any lock held and:
674 * - retrieves the ipc with the given id in the given table.
675 * - performs some audit and permission check, depending on the given cmd
676 * - returns a pointer to the ipc object or otherwise, the corresponding
679 * Call holding the both the rwsem and the rcu read lock.
681 struct kern_ipc_perm
*ipcctl_pre_down_nolock(struct ipc_namespace
*ns
,
682 struct ipc_ids
*ids
, int id
, int cmd
,
683 struct ipc64_perm
*perm
, int extra_perm
)
687 struct kern_ipc_perm
*ipcp
;
689 ipcp
= ipc_obtain_object_check(ids
, id
);
697 audit_ipc_set_perm(extra_perm
, perm
->uid
,
698 perm
->gid
, perm
->mode
);
700 euid
= current_euid();
701 if (uid_eq(euid
, ipcp
->cuid
) || uid_eq(euid
, ipcp
->uid
) ||
702 ns_capable(ns
->user_ns
, CAP_SYS_ADMIN
))
703 return ipcp
; /* successful lookup */
708 #ifdef CONFIG_ARCH_WANT_IPC_PARSE_VERSION
712 * ipc_parse_version - ipc call version
713 * @cmd: pointer to command
715 * Return IPC_64 for new style IPC and IPC_OLD for old style IPC.
716 * The @cmd value is turned from an encoding command and version into
717 * just the command code.
719 int ipc_parse_version(int *cmd
)
729 #endif /* CONFIG_ARCH_WANT_IPC_PARSE_VERSION */
731 #ifdef CONFIG_PROC_FS
732 struct ipc_proc_iter
{
733 struct ipc_namespace
*ns
;
734 struct ipc_proc_iface
*iface
;
738 * This routine locks the ipc structure found at least at position pos.
740 static struct kern_ipc_perm
*sysvipc_find_ipc(struct ipc_ids
*ids
, loff_t pos
,
743 struct kern_ipc_perm
*ipc
;
747 for (id
= 0; id
< pos
&& total
< ids
->in_use
; id
++) {
748 ipc
= idr_find(&ids
->ipcs_idr
, id
);
753 if (total
>= ids
->in_use
)
756 for (; pos
< IPCMNI
; pos
++) {
757 ipc
= idr_find(&ids
->ipcs_idr
, pos
);
761 ipc_lock_object(ipc
);
766 /* Out of range - return NULL to terminate iteration */
770 static void *sysvipc_proc_next(struct seq_file
*s
, void *it
, loff_t
*pos
)
772 struct ipc_proc_iter
*iter
= s
->private;
773 struct ipc_proc_iface
*iface
= iter
->iface
;
774 struct kern_ipc_perm
*ipc
= it
;
776 /* If we had an ipc id locked before, unlock it */
777 if (ipc
&& ipc
!= SEQ_START_TOKEN
)
780 return sysvipc_find_ipc(&iter
->ns
->ids
[iface
->ids
], *pos
, pos
);
784 * File positions: pos 0 -> header, pos n -> ipc id = n - 1.
785 * SeqFile iterator: iterator value locked ipc pointer or SEQ_TOKEN_START.
787 static void *sysvipc_proc_start(struct seq_file
*s
, loff_t
*pos
)
789 struct ipc_proc_iter
*iter
= s
->private;
790 struct ipc_proc_iface
*iface
= iter
->iface
;
793 ids
= &iter
->ns
->ids
[iface
->ids
];
796 * Take the lock - this will be released by the corresponding
799 down_read(&ids
->rwsem
);
801 /* pos < 0 is invalid */
805 /* pos == 0 means header */
807 return SEQ_START_TOKEN
;
809 /* Find the (pos-1)th ipc */
810 return sysvipc_find_ipc(ids
, *pos
- 1, pos
);
813 static void sysvipc_proc_stop(struct seq_file
*s
, void *it
)
815 struct kern_ipc_perm
*ipc
= it
;
816 struct ipc_proc_iter
*iter
= s
->private;
817 struct ipc_proc_iface
*iface
= iter
->iface
;
820 /* If we had a locked structure, release it */
821 if (ipc
&& ipc
!= SEQ_START_TOKEN
)
824 ids
= &iter
->ns
->ids
[iface
->ids
];
825 /* Release the lock we took in start() */
826 up_read(&ids
->rwsem
);
829 static int sysvipc_proc_show(struct seq_file
*s
, void *it
)
831 struct ipc_proc_iter
*iter
= s
->private;
832 struct ipc_proc_iface
*iface
= iter
->iface
;
834 if (it
== SEQ_START_TOKEN
) {
835 seq_puts(s
, iface
->header
);
839 return iface
->show(s
, it
);
842 static const struct seq_operations sysvipc_proc_seqops
= {
843 .start
= sysvipc_proc_start
,
844 .stop
= sysvipc_proc_stop
,
845 .next
= sysvipc_proc_next
,
846 .show
= sysvipc_proc_show
,
849 static int sysvipc_proc_open(struct inode
*inode
, struct file
*file
)
851 struct ipc_proc_iter
*iter
;
853 iter
= __seq_open_private(file
, &sysvipc_proc_seqops
, sizeof(*iter
));
857 iter
->iface
= PDE_DATA(inode
);
858 iter
->ns
= get_ipc_ns(current
->nsproxy
->ipc_ns
);
863 static int sysvipc_proc_release(struct inode
*inode
, struct file
*file
)
865 struct seq_file
*seq
= file
->private_data
;
866 struct ipc_proc_iter
*iter
= seq
->private;
867 put_ipc_ns(iter
->ns
);
868 return seq_release_private(inode
, file
);
871 static const struct file_operations sysvipc_proc_fops
= {
872 .open
= sysvipc_proc_open
,
875 .release
= sysvipc_proc_release
,
877 #endif /* CONFIG_PROC_FS */