blob: fa2d86ef3fb80b1a828043190a69f8c935715354 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/ipc/util.c
4 * Copyright (C) 1992 Krishna Balasubramanian
5 *
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
Christian Kujau624dffc2006-01-15 02:43:54 +010011 * Manfred Spraul <manfred@colorfullife.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * Oct 2002 - One lock per IPC id. RCU ipc_free for lock-free grow_ary().
13 * Mingming Cao <cmm@us.ibm.com>
Steve Grubb073115d2006-04-02 17:07:33 -040014 * Mar 2006 - support for audit of ipc object properties
15 * Dustin Kirkland <dustin.kirkland@us.ibm.com>
Kirill Korotaev73ea4132006-10-02 02:18:20 -070016 * Jun 2006 - namespaces ssupport
17 * OpenVZ, SWsoft Inc.
18 * Pavel Emelianov <xemul@openvz.org>
Davidlohr Bueso05603c42013-09-11 14:26:26 -070019 *
20 * General sysv ipc locking scheme:
Davidlohr Bueso18ccee22013-10-16 13:46:45 -070021 * rcu_read_lock()
22 * obtain the ipc object (kern_ipc_perm) by looking up the id in an idr
23 * tree.
24 * - perform initial checks (capabilities, auditing and permission,
25 * etc).
Philippe Mikoyan87ad4b02018-02-06 15:40:49 -080026 * - perform read-only operations, such as INFO command, that
27 * do not demand atomicity
Davidlohr Bueso18ccee22013-10-16 13:46:45 -070028 * acquire the ipc lock (kern_ipc_perm.lock) through
29 * ipc_lock_object()
Philippe Mikoyan87ad4b02018-02-06 15:40:49 -080030 * - perform read-only operations that demand atomicity,
31 * such as STAT command.
Davidlohr Bueso18ccee22013-10-16 13:46:45 -070032 * - perform data updates, such as SET, RMID commands and
33 * mechanism-specific operations (semop/semtimedop,
34 * msgsnd/msgrcv, shmat/shmdt).
35 * drop the ipc lock, through ipc_unlock_object().
36 * rcu_read_unlock()
37 *
38 * The ids->rwsem must be taken when:
39 * - creating, removing and iterating the existing entries in ipc
40 * identifier sets.
41 * - iterating through files under /proc/sysvipc/
42 *
43 * Note that sems have a special fast path that avoids kern_ipc_perm.lock -
44 * see sem_lock().
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 */
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <linux/mm.h>
48#include <linux/shm.h>
49#include <linux/init.h>
50#include <linux/msg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#include <linux/vmalloc.h>
52#include <linux/slab.h>
Andrew Morton8f68fa22013-04-29 15:08:05 -070053#include <linux/notifier.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080054#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#include <linux/highuid.h>
56#include <linux/security.h>
57#include <linux/rcupdate.h>
58#include <linux/workqueue.h>
Mike Waychisonae781772005-09-06 15:17:09 -070059#include <linux/seq_file.h>
60#include <linux/proc_fs.h>
Steve Grubb073115d2006-04-02 17:07:33 -040061#include <linux/audit.h>
Kirill Korotaev73ea4132006-10-02 02:18:20 -070062#include <linux/nsproxy.h>
Nadia Derbey3e148c72007-10-18 23:40:54 -070063#include <linux/rwsem.h>
Nadia Derbeyb6b337a2008-04-29 01:00:42 -070064#include <linux/memory.h>
Pavel Emelyanovae5e1b22008-02-08 04:18:22 -080065#include <linux/ipc_namespace.h>
NeilBrown0eb71a92018-06-18 12:52:50 +100066#include <linux/rhashtable.h>
Manfred Spraulb869d5b2021-06-30 18:57:18 -070067#include <linux/log2.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69#include <asm/unistd.h>
70
71#include "util.h"
72
Mike Waychisonae781772005-09-06 15:17:09 -070073struct ipc_proc_iface {
74 const char *path;
75 const char *header;
Kirill Korotaev73ea4132006-10-02 02:18:20 -070076 int ids;
Mike Waychisonae781772005-09-06 15:17:09 -070077 int (*show)(struct seq_file *, void *);
78};
79
Linus Torvalds1da177e2005-04-16 15:20:36 -070080/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -080081 * ipc_init - initialise ipc subsystem
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -080083 * The various sysv ipc resources (semaphores, messages and shared
84 * memory) are initialised.
85 *
86 * A callback routine is registered into the memory hotplug notifier
87 * chain: since msgmni scales to lowmem this callback routine will be
88 * called upon successful memory add / remove to recompute msmgni.
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090static int __init ipc_init(void)
91{
Alexey Dobriyane74a0ef2018-04-10 16:30:58 -070092 proc_mkdir("sysvipc", NULL);
Davidlohr Buesoeae04d22018-08-21 22:01:56 -070093 sem_init();
94 msg_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 shm_init();
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -070096
Davidlohr Buesoeae04d22018-08-21 22:01:56 -070097 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070098}
Davidlohr Bueso6d08a252014-04-07 15:39:18 -070099device_initcall(ipc_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700101static const struct rhashtable_params ipc_kht_params = {
102 .head_offset = offsetof(struct kern_ipc_perm, khtnode),
103 .key_offset = offsetof(struct kern_ipc_perm, key),
Pankaj Bharadiyac5936422019-12-09 10:31:43 -0800104 .key_len = sizeof_field(struct kern_ipc_perm, key),
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700105 .automatic_shrinking = true,
106};
107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800109 * ipc_init_ids - initialise ipc identifiers
110 * @ids: ipc identifier set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800112 * Set up the sequence range to use for the ipc identifier range (limited
Waiman Long5ac893b2019-05-14 15:46:29 -0700113 * below ipc_mni) then initialise the keys hashtable and ids idr.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 */
Davidlohr Buesoeae04d22018-08-21 22:01:56 -0700115void ipc_init_ids(struct ipc_ids *ids)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 ids->in_use = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 ids->seq = 0;
Davidlohr Buesodaf948c2014-01-27 17:07:09 -0800119 init_rwsem(&ids->rwsem);
Davidlohr Buesoeae04d22018-08-21 22:01:56 -0700120 rhashtable_init(&ids->key_ht, &ipc_kht_params);
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700121 idr_init(&ids->ipcs_idr);
Manfred Spraul27c331a2018-08-21 22:02:00 -0700122 ids->max_idx = -1;
Manfred Spraul3278a2c2019-05-14 15:46:33 -0700123 ids->last_idx = -1;
Davidlohr Buesob8fd9982017-11-17 15:31:08 -0800124#ifdef CONFIG_CHECKPOINT_RESTORE
125 ids->next_id = -1;
126#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127}
128
Mike Waychisonae781772005-09-06 15:17:09 -0700129#ifdef CONFIG_PROC_FS
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800130static const struct proc_ops sysvipc_proc_ops;
Mike Waychisonae781772005-09-06 15:17:09 -0700131/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800132 * 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.
Mike Waychisonae781772005-09-06 15:17:09 -0700137 */
138void __init ipc_init_proc_interface(const char *path, const char *header,
Kirill Korotaev73ea4132006-10-02 02:18:20 -0700139 int ids, int (*show)(struct seq_file *, void *))
Mike Waychisonae781772005-09-06 15:17:09 -0700140{
141 struct proc_dir_entry *pde;
142 struct ipc_proc_iface *iface;
143
144 iface = kmalloc(sizeof(*iface), GFP_KERNEL);
145 if (!iface)
146 return;
147 iface->path = path;
148 iface->header = header;
149 iface->ids = ids;
150 iface->show = show;
151
Denis V. Lunev6a6375d2008-04-29 01:02:12 -0700152 pde = proc_create_data(path,
153 S_IRUGO, /* world readable */
154 NULL, /* parent dir */
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800155 &sysvipc_proc_ops,
Denis V. Lunev6a6375d2008-04-29 01:02:12 -0700156 iface);
Davidlohr Bueso3ab08fe2014-01-27 17:07:06 -0800157 if (!pde)
Mike Waychisonae781772005-09-06 15:17:09 -0700158 kfree(iface);
Mike Waychisonae781772005-09-06 15:17:09 -0700159}
160#endif
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800163 * ipc_findkey - find a key in an ipc identifier set
164 * @ids: ipc identifier set
165 * @key: key to find
Paul McQuade46c0a8c2014-06-06 14:37:37 -0700166 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800167 * 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
169 *
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700170 * Called with writer ipc_ids.rwsem held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 */
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700172static struct kern_ipc_perm *ipc_findkey(struct ipc_ids *ids, key_t key)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173{
Davidlohr Buesodc2c8c82018-08-21 22:01:52 -0700174 struct kern_ipc_perm *ipcp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Davidlohr Buesodc2c8c82018-08-21 22:01:52 -0700176 ipcp = rhashtable_lookup_fast(&ids->key_ht, &key,
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700177 ipc_kht_params);
Davidlohr Buesodc2c8c82018-08-21 22:01:52 -0700178 if (!ipcp)
179 return NULL;
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700180
Davidlohr Buesodc2c8c82018-08-21 22:01:52 -0700181 rcu_read_lock();
182 ipc_lock_object(ipcp);
183 return ipcp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184}
185
Davidlohr Buesob8fd9982017-11-17 15:31:08 -0800186/*
Manfred Spraule2652ae2018-08-21 22:01:25 -0700187 * Insert new IPC object into idr tree, and set sequence number and id
188 * in the correct order.
189 * Especially:
190 * - the sequence number must be set before inserting the object into the idr,
191 * because the sequence number is accessed without a lock.
192 * - the id can/must be set after inserting the object into the idr.
193 * All accesses must be done after getting kern_ipc_perm.lock.
194 *
195 * The caller must own kern_ipc_perm.lock.of the new object.
196 * On error, the function returns a (negative) error code.
Manfred Spraul3278a2c2019-05-14 15:46:33 -0700197 *
198 * To conserve sequence number space, especially with extended ipc_mni,
199 * the sequence number is incremented only when the returned ID is less than
200 * the last one.
Davidlohr Buesob8fd9982017-11-17 15:31:08 -0800201 */
Manfred Spraule2652ae2018-08-21 22:01:25 -0700202static inline int ipc_idr_alloc(struct ipc_ids *ids, struct kern_ipc_perm *new)
Davidlohr Buesob8fd9982017-11-17 15:31:08 -0800203{
Manfred Spraule2652ae2018-08-21 22:01:25 -0700204 int idx, next_id = -1;
205
206#ifdef CONFIG_CHECKPOINT_RESTORE
207 next_id = ids->next_id;
208 ids->next_id = -1;
209#endif
210
211 /*
212 * As soon as a new object is inserted into the idr,
213 * ipc_obtain_object_idr() or ipc_obtain_object_check() can find it,
214 * and the lockless preparations for ipc operations can start.
215 * This means especially: permission checks, audit calls, allocation
216 * of undo structures, ...
217 *
218 * Thus the object must be fully initialized, and if something fails,
219 * then the full tear-down sequence must be followed.
220 * (i.e.: set new->deleted, reduce refcount, call_rcu())
221 */
222
223 if (next_id < 0) { /* !CHECKPOINT_RESTORE or next_id is unset */
Manfred Spraul99db46e2019-05-14 15:46:36 -0700224 int max_idx;
225
226 max_idx = max(ids->in_use*3/2, ipc_min_cycle);
227 max_idx = min(max_idx, ipc_mni);
Manfred Spraul3278a2c2019-05-14 15:46:33 -0700228
229 /* allocate the idx, with a NULL struct kern_ipc_perm */
Manfred Spraul99db46e2019-05-14 15:46:36 -0700230 idx = idr_alloc_cyclic(&ids->ipcs_idr, NULL, 0, max_idx,
231 GFP_NOWAIT);
Manfred Spraul3278a2c2019-05-14 15:46:33 -0700232
233 if (idx >= 0) {
234 /*
235 * idx got allocated successfully.
236 * Now calculate the sequence number and set the
237 * pointer for real.
238 */
239 if (idx <= ids->last_idx) {
240 ids->seq++;
241 if (ids->seq >= ipcid_seq_max())
242 ids->seq = 0;
243 }
244 ids->last_idx = idx;
245
246 new->seq = ids->seq;
247 /* no need for smp_wmb(), this is done
248 * inside idr_replace, as part of
249 * rcu_assign_pointer
250 */
251 idr_replace(&ids->ipcs_idr, new, idx);
252 }
Davidlohr Buesob8fd9982017-11-17 15:31:08 -0800253 } else {
Manfred Spraule2652ae2018-08-21 22:01:25 -0700254 new->seq = ipcid_to_seqx(next_id);
255 idx = idr_alloc(&ids->ipcs_idr, new, ipcid_to_idx(next_id),
256 0, GFP_NOWAIT);
Davidlohr Buesob8fd9982017-11-17 15:31:08 -0800257 }
Manfred Spraule2652ae2018-08-21 22:01:25 -0700258 if (idx >= 0)
Manfred Spraul3278a2c2019-05-14 15:46:33 -0700259 new->id = (new->seq << ipcmni_seq_shift()) + idx;
Manfred Spraule2652ae2018-08-21 22:01:25 -0700260 return idx;
Davidlohr Buesob8fd9982017-11-17 15:31:08 -0800261}
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800264 * ipc_addid - add an ipc identifier
265 * @ids: ipc identifier set
266 * @new: new ipc permission set
Davidlohr Buesoebf66792017-11-17 15:31:15 -0800267 * @limit: limit for the number of used ids
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800269 * Add an entry 'new' to the ipc ids idr. The permissions object is
Manfred Spraul27c331a2018-08-21 22:02:00 -0700270 * initialised and the first free entry is set up and the index assigned
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800271 * is returned. The 'new' entry is returned in a locked state on success.
Manfred Spraul39cfffd2018-08-21 22:01:29 -0700272 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800273 * On failure the entry is not locked and a negative err-code is returned.
Manfred Spraul39cfffd2018-08-21 22:01:29 -0700274 * The caller must use ipc_rcu_putref() to free the identifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800276 * Called with writer ipc_ids.rwsem held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 */
Davidlohr Buesoebf66792017-11-17 15:31:15 -0800278int ipc_addid(struct ipc_ids *ids, struct kern_ipc_perm *new, int limit)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279{
Eric W. Biederman1efdb692012-02-07 16:54:11 -0800280 kuid_t euid;
281 kgid_t egid;
Manfred Spraule2652ae2018-08-21 22:01:25 -0700282 int idx, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
Manfred Spraul39cfffd2018-08-21 22:01:29 -0700284 /* 1) Initialize the refcount so that ipc_rcu_putref works */
285 refcount_set(&new->refcount, 1);
286
Waiman Long5ac893b2019-05-14 15:46:29 -0700287 if (limit > ipc_mni)
288 limit = ipc_mni;
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700289
Davidlohr Buesodc2c8c82018-08-21 22:01:52 -0700290 if (ids->in_use >= limit)
Pierre Peiffer283bb7f2007-10-18 23:40:57 -0700291 return -ENOSPC;
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700292
Tejun Heo54924ea2013-02-27 17:04:53 -0800293 idr_preload(GFP_KERNEL);
294
Nadia Derbeye00b4ff7e2008-11-19 15:36:08 -0800295 spin_lock_init(&new->lock);
Nadia Derbeye00b4ff7e2008-11-19 15:36:08 -0800296 rcu_read_lock();
297 spin_lock(&new->lock);
298
Linus Torvaldsb9a53222015-09-30 12:48:40 -0400299 current_euid_egid(&euid, &egid);
300 new->cuid = new->uid = euid;
301 new->gid = new->cgid = egid;
302
Manfred Spraul39cfffd2018-08-21 22:01:29 -0700303 new->deleted = false;
304
Manfred Spraule2652ae2018-08-21 22:01:25 -0700305 idx = ipc_idr_alloc(ids, new);
Tejun Heo54924ea2013-02-27 17:04:53 -0800306 idr_preload_end();
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700307
Manfred Spraule2652ae2018-08-21 22:01:25 -0700308 if (idx >= 0 && new->key != IPC_PRIVATE) {
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700309 err = rhashtable_insert_fast(&ids->key_ht, &new->khtnode,
310 ipc_kht_params);
311 if (err < 0) {
Manfred Spraule2652ae2018-08-21 22:01:25 -0700312 idr_remove(&ids->ipcs_idr, idx);
313 idx = err;
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700314 }
315 }
Manfred Spraule2652ae2018-08-21 22:01:25 -0700316 if (idx < 0) {
Manfred Spraul39cfffd2018-08-21 22:01:29 -0700317 new->deleted = true;
Nadia Derbeye00b4ff7e2008-11-19 15:36:08 -0800318 spin_unlock(&new->lock);
319 rcu_read_unlock();
Manfred Spraule2652ae2018-08-21 22:01:25 -0700320 return idx;
Nadia Derbeye00b4ff7e2008-11-19 15:36:08 -0800321 }
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700322
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 ids->in_use++;
Manfred Spraul27c331a2018-08-21 22:02:00 -0700324 if (idx > ids->max_idx)
325 ids->max_idx = idx;
Manfred Spraule2652ae2018-08-21 22:01:25 -0700326 return idx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327}
328
329/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800330 * ipcget_new - create a new ipc object
331 * @ns: ipc namespace
Masanari Iidada3dae52014-09-09 01:27:23 +0900332 * @ids: ipc identifier set
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800333 * @ops: the actual creation routine to call
334 * @params: its parameters
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700335 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800336 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
337 * when the key is IPC_PRIVATE.
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700338 */
Pavel Emelyanovb2d75cd2008-02-08 04:18:54 -0800339static int ipcget_new(struct ipc_namespace *ns, struct ipc_ids *ids,
Mathias Krauseeb66ec42014-06-06 14:37:36 -0700340 const struct ipc_ops *ops, struct ipc_params *params)
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700341{
342 int err;
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700343
Davidlohr Buesod9a605e2013-09-11 14:26:24 -0700344 down_write(&ids->rwsem);
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700345 err = ops->getnew(ns, params);
Davidlohr Buesod9a605e2013-09-11 14:26:24 -0700346 up_write(&ids->rwsem);
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700347 return err;
348}
349
350/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800351 * ipc_check_perms - check security and permissions for an ipc object
352 * @ns: ipc namespace
353 * @ipcp: ipc permission set
354 * @ops: the actual security routine to call
355 * @params: its parameters
Nadia Derbeyf4566f02007-10-18 23:40:53 -0700356 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800357 * This routine is called by sys_msgget(), sys_semget() and sys_shmget()
358 * when the key is not IPC_PRIVATE and that key already exists in the
359 * ds IDR.
Nadia Derbeyf4566f02007-10-18 23:40:53 -0700360 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800361 * On success, the ipc id is returned.
Nadia Derbeyf4566f02007-10-18 23:40:53 -0700362 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800363 * It is called with ipc_ids.rwsem and ipcp->lock held.
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700364 */
Serge E. Hallynb0e77592011-03-23 16:43:24 -0700365static int ipc_check_perms(struct ipc_namespace *ns,
366 struct kern_ipc_perm *ipcp,
Mathias Krauseeb66ec42014-06-06 14:37:36 -0700367 const struct ipc_ops *ops,
Serge E. Hallynb0e77592011-03-23 16:43:24 -0700368 struct ipc_params *params)
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700369{
370 int err;
371
Serge E. Hallynb0e77592011-03-23 16:43:24 -0700372 if (ipcperms(ns, ipcp, params->flg))
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700373 err = -EACCES;
374 else {
375 err = ops->associate(ipcp, params->flg);
376 if (!err)
377 err = ipcp->id;
378 }
379
380 return err;
381}
382
383/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800384 * ipcget_public - get an ipc object or create a new one
385 * @ns: ipc namespace
Masanari Iidada3dae52014-09-09 01:27:23 +0900386 * @ids: ipc identifier set
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800387 * @ops: the actual creation routine to call
388 * @params: its parameters
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700389 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800390 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
391 * when the key is not IPC_PRIVATE.
392 * It adds a new entry if the key is not found and does some permission
393 * / security checkings if the key is found.
Nadia Derbeyf4566f02007-10-18 23:40:53 -0700394 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800395 * On success, the ipc id is returned.
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700396 */
Pavel Emelyanovb2d75cd2008-02-08 04:18:54 -0800397static int ipcget_public(struct ipc_namespace *ns, struct ipc_ids *ids,
Mathias Krauseeb66ec42014-06-06 14:37:36 -0700398 const struct ipc_ops *ops, struct ipc_params *params)
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700399{
400 struct kern_ipc_perm *ipcp;
401 int flg = params->flg;
402 int err;
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700403
Nadia Derbey3e148c72007-10-18 23:40:54 -0700404 /*
405 * Take the lock as a writer since we are potentially going to add
406 * a new entry + read locks are not "upgradable"
407 */
Davidlohr Buesod9a605e2013-09-11 14:26:24 -0700408 down_write(&ids->rwsem);
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700409 ipcp = ipc_findkey(ids, params->key);
410 if (ipcp == NULL) {
411 /* key not used */
412 if (!(flg & IPC_CREAT))
413 err = -ENOENT;
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700414 else
415 err = ops->getnew(ns, params);
416 } else {
417 /* ipc object has been locked by ipc_findkey() */
418
419 if (flg & IPC_CREAT && flg & IPC_EXCL)
420 err = -EEXIST;
421 else {
422 err = 0;
423 if (ops->more_checks)
424 err = ops->more_checks(ipcp, params);
425 if (!err)
Nadia Derbeyf4566f02007-10-18 23:40:53 -0700426 /*
427 * ipc_check_perms returns the IPC id on
428 * success
429 */
Serge E. Hallynb0e77592011-03-23 16:43:24 -0700430 err = ipc_check_perms(ns, ipcp, ops, params);
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700431 }
432 ipc_unlock(ipcp);
433 }
Davidlohr Buesod9a605e2013-09-11 14:26:24 -0700434 up_write(&ids->rwsem);
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700435
436 return err;
437}
438
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700439/**
440 * ipc_kht_remove - remove an ipc from the key hashtable
441 * @ids: ipc identifier set
442 * @ipcp: ipc perm structure containing the key to remove
443 *
444 * ipc_ids.rwsem (as a writer) and the spinlock for this ID are held
445 * before this function is called, and remain locked on the exit.
446 */
447static void ipc_kht_remove(struct ipc_ids *ids, struct kern_ipc_perm *ipcp)
448{
449 if (ipcp->key != IPC_PRIVATE)
Alexander Mikhalitsyn126e8be2021-11-19 16:43:18 -0800450 WARN_ON_ONCE(rhashtable_remove_fast(&ids->key_ht, &ipcp->khtnode,
451 ipc_kht_params));
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700452}
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700453
454/**
Manfred Spraulb869d5b2021-06-30 18:57:18 -0700455 * ipc_search_maxidx - search for the highest assigned index
456 * @ids: ipc identifier set
457 * @limit: known upper limit for highest assigned index
458 *
459 * The function determines the highest assigned index in @ids. It is intended
460 * to be called when ids->max_idx needs to be updated.
461 * Updating ids->max_idx is necessary when the current highest index ipc
462 * object is deleted.
463 * If no ipc object is allocated, then -1 is returned.
464 *
465 * ipc_ids.rwsem needs to be held by the caller.
466 */
467static int ipc_search_maxidx(struct ipc_ids *ids, int limit)
468{
469 int tmpidx;
470 int i;
471 int retval;
472
473 i = ilog2(limit+1);
474
475 retval = 0;
476 for (; i >= 0; i--) {
477 tmpidx = retval | (1<<i);
478 /*
479 * "0" is a possible index value, thus search using
480 * e.g. 15,7,3,1,0 instead of 16,8,4,2,1.
481 */
482 tmpidx = tmpidx-1;
483 if (idr_get_next(&ids->ipcs_idr, &tmpidx))
484 retval |= (1<<i);
485 }
486 return retval - 1;
487}
488
489/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800490 * ipc_rmid - remove an ipc identifier
491 * @ids: ipc identifier set
492 * @ipcp: ipc perm structure containing the identifier to remove
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800494 * ipc_ids.rwsem (as a writer) and the spinlock for this ID are held
495 * before this function is called, and remain locked on the exit.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 */
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700497void ipc_rmid(struct ipc_ids *ids, struct kern_ipc_perm *ipcp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498{
Manfred Spraul27c331a2018-08-21 22:02:00 -0700499 int idx = ipcid_to_idx(ipcp->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
Alexander Mikhalitsyn126e8be2021-11-19 16:43:18 -0800501 WARN_ON_ONCE(idr_remove(&ids->ipcs_idr, idx) != ipcp);
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700502 ipc_kht_remove(ids, ipcp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 ids->in_use--;
Rafael Aquini72a8ff22014-01-27 17:07:02 -0800504 ipcp->deleted = true;
Davidlohr Bueso15df03c82017-11-17 15:31:18 -0800505
Manfred Spraul27c331a2018-08-21 22:02:00 -0700506 if (unlikely(idx == ids->max_idx)) {
Manfred Spraulb869d5b2021-06-30 18:57:18 -0700507 idx = ids->max_idx-1;
508 if (idx >= 0)
509 idx = ipc_search_maxidx(ids, idx);
Manfred Spraul27c331a2018-08-21 22:02:00 -0700510 ids->max_idx = idx;
Davidlohr Bueso15df03c82017-11-17 15:31:18 -0800511 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512}
513
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700514/**
515 * ipc_set_key_private - switch the key of an existing ipc to IPC_PRIVATE
516 * @ids: ipc identifier set
517 * @ipcp: ipc perm structure containing the key to modify
518 *
519 * ipc_ids.rwsem (as a writer) and the spinlock for this ID are held
520 * before this function is called, and remain locked on the exit.
521 */
522void ipc_set_key_private(struct ipc_ids *ids, struct kern_ipc_perm *ipcp)
523{
524 ipc_kht_remove(ids, ipcp);
525 ipcp->key = IPC_PRIVATE;
526}
527
Manfred Spraul2a9d6482018-08-21 22:02:04 -0700528bool ipc_rcu_getref(struct kern_ipc_perm *ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529{
Elena Reshetova9405c032017-09-08 16:17:45 -0700530 return refcount_inc_not_zero(&ptr->refcount);
David Howells65f27f32006-11-22 14:55:48 +0000531}
532
Manfred Sprauldba4cdd2017-07-12 14:34:41 -0700533void ipc_rcu_putref(struct kern_ipc_perm *ptr,
534 void (*func)(struct rcu_head *head))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535{
Elena Reshetova9405c032017-09-08 16:17:45 -0700536 if (!refcount_dec_and_test(&ptr->refcount))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 return;
538
Manfred Sprauldba4cdd2017-07-12 14:34:41 -0700539 call_rcu(&ptr->rcu, func);
Davidlohr Bueso53dad6d2013-09-23 17:04:45 -0700540}
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800543 * ipcperms - check ipc permissions
544 * @ns: ipc namespace
545 * @ipcp: ipc permission set
546 * @flag: desired permission set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800548 * Check user, group, other permissions for access
549 * to ipc resources. return 0 if allowed
Serge E. Hallynb0e77592011-03-23 16:43:24 -0700550 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300551 * @flag will most probably be 0 or ``S_...UGO`` from <linux/stat.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 */
Serge E. Hallynb0e77592011-03-23 16:43:24 -0700553int ipcperms(struct ipc_namespace *ns, struct kern_ipc_perm *ipcp, short flag)
554{
Eric W. Biederman1efdb692012-02-07 16:54:11 -0800555 kuid_t euid = current_euid();
Al Viroa33e6752008-12-10 03:40:06 -0500556 int requested_mode, granted_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Al Viroa33e6752008-12-10 03:40:06 -0500558 audit_ipc_obj(ipcp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 requested_mode = (flag >> 6) | (flag >> 3) | flag;
560 granted_mode = ipcp->mode;
Eric W. Biederman1efdb692012-02-07 16:54:11 -0800561 if (uid_eq(euid, ipcp->cuid) ||
562 uid_eq(euid, ipcp->uid))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 granted_mode >>= 6;
564 else if (in_group_p(ipcp->cgid) || in_group_p(ipcp->gid))
565 granted_mode >>= 3;
566 /* is there some bit set in requested_mode but not in granted_mode? */
Paul McQuade46c0a8c2014-06-06 14:37:37 -0700567 if ((requested_mode & ~granted_mode & 0007) &&
Serge E. Hallynb0e77592011-03-23 16:43:24 -0700568 !ns_capable(ns->user_ns, CAP_IPC_OWNER))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 return -1;
570
571 return security_ipc_permission(ipcp, flag);
572}
573
574/*
575 * Functions to convert between the kern_ipc_perm structure and the
576 * old/new ipc_perm structures
577 */
578
579/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800580 * kernel_to_ipc64_perm - convert kernel ipc permissions to user
581 * @in: kernel permissions
582 * @out: new style ipc permissions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800584 * Turn the kernel object @in into a set of permissions descriptions
585 * for returning to userspace (@out).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 */
Manfred Spraul239521f2014-01-27 17:07:04 -0800587void kernel_to_ipc64_perm(struct kern_ipc_perm *in, struct ipc64_perm *out)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588{
589 out->key = in->key;
Eric W. Biederman1efdb692012-02-07 16:54:11 -0800590 out->uid = from_kuid_munged(current_user_ns(), in->uid);
591 out->gid = from_kgid_munged(current_user_ns(), in->gid);
592 out->cuid = from_kuid_munged(current_user_ns(), in->cuid);
593 out->cgid = from_kgid_munged(current_user_ns(), in->cgid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 out->mode = in->mode;
595 out->seq = in->seq;
596}
597
598/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800599 * ipc64_perm_to_ipc_perm - convert new ipc permissions to old
600 * @in: new style ipc permissions
601 * @out: old style ipc permissions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800603 * Turn the new style permissions object @in into a compatibility
604 * object and store it into the @out pointer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 */
Manfred Spraul239521f2014-01-27 17:07:04 -0800606void ipc64_perm_to_ipc_perm(struct ipc64_perm *in, struct ipc_perm *out)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
608 out->key = in->key;
609 SET_UID(out->uid, in->uid);
610 SET_GID(out->gid, in->gid);
611 SET_UID(out->cuid, in->cuid);
612 SET_GID(out->cgid, in->cgid);
613 out->mode = in->mode;
614 out->seq = in->seq;
615}
616
Nadia Derbeyf4566f02007-10-18 23:40:53 -0700617/**
Guillaume Knispel0cfb6ae2017-09-08 16:17:55 -0700618 * ipc_obtain_object_idr
Davidlohr Bueso4d2bff52013-04-30 19:15:19 -0700619 * @ids: ipc identifier set
620 * @id: ipc id to look for
621 *
622 * Look for an id in the ipc ids idr and return associated ipc object.
623 *
624 * Call inside the RCU critical section.
625 * The ipc object is *not* locked on exit.
626 */
Davidlohr Bueso55b7ae52015-06-30 14:58:42 -0700627struct kern_ipc_perm *ipc_obtain_object_idr(struct ipc_ids *ids, int id)
Davidlohr Bueso4d2bff52013-04-30 19:15:19 -0700628{
629 struct kern_ipc_perm *out;
Manfred Spraul27c331a2018-08-21 22:02:00 -0700630 int idx = ipcid_to_idx(id);
Davidlohr Bueso4d2bff52013-04-30 19:15:19 -0700631
Manfred Spraul27c331a2018-08-21 22:02:00 -0700632 out = idr_find(&ids->ipcs_idr, idx);
Davidlohr Bueso4d2bff52013-04-30 19:15:19 -0700633 if (!out)
634 return ERR_PTR(-EINVAL);
635
636 return out;
637}
638
639/**
Davidlohr Bueso4d2bff52013-04-30 19:15:19 -0700640 * ipc_obtain_object_check
641 * @ids: ipc identifier set
642 * @id: ipc id to look for
643 *
Manfred Spraul2e5ceb42018-08-21 22:01:37 -0700644 * Similar to ipc_obtain_object_idr() but also checks the ipc object
645 * sequence number.
Davidlohr Bueso4d2bff52013-04-30 19:15:19 -0700646 *
647 * Call inside the RCU critical section.
648 * The ipc object is *not* locked on exit.
649 */
650struct kern_ipc_perm *ipc_obtain_object_check(struct ipc_ids *ids, int id)
651{
Davidlohr Bueso55b7ae52015-06-30 14:58:42 -0700652 struct kern_ipc_perm *out = ipc_obtain_object_idr(ids, id);
Davidlohr Bueso4d2bff52013-04-30 19:15:19 -0700653
654 if (IS_ERR(out))
655 goto out;
656
657 if (ipc_checkid(out, id))
Davidlohr Bueso6157dbb2015-06-30 14:58:48 -0700658 return ERR_PTR(-EINVAL);
Davidlohr Bueso4d2bff52013-04-30 19:15:19 -0700659out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 return out;
661}
662
Pavel Emelyanovb2d75cd2008-02-08 04:18:54 -0800663/**
664 * ipcget - Common sys_*get() code
Masanari Iidada3dae52014-09-09 01:27:23 +0900665 * @ns: namespace
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800666 * @ids: ipc identifier set
667 * @ops: operations to be called on ipc object creation, permission checks
668 * and further checks
669 * @params: the parameters needed by the previous operations.
Pavel Emelyanovb2d75cd2008-02-08 04:18:54 -0800670 *
671 * Common routine called by sys_msgget(), sys_semget() and sys_shmget().
672 */
673int ipcget(struct ipc_namespace *ns, struct ipc_ids *ids,
Mathias Krauseeb66ec42014-06-06 14:37:36 -0700674 const struct ipc_ops *ops, struct ipc_params *params)
Pavel Emelyanovb2d75cd2008-02-08 04:18:54 -0800675{
676 if (params->key == IPC_PRIVATE)
677 return ipcget_new(ns, ids, ops, params);
678 else
679 return ipcget_public(ns, ids, ops, params);
680}
681
Pierre Peiffer8f4a3802008-04-29 01:00:51 -0700682/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800683 * ipc_update_perm - update the permissions of an ipc object
Pierre Peiffer8f4a3802008-04-29 01:00:51 -0700684 * @in: the permission given as input.
685 * @out: the permission of the ipc to set.
686 */
Eric W. Biederman1efdb692012-02-07 16:54:11 -0800687int ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out)
Pierre Peiffer8f4a3802008-04-29 01:00:51 -0700688{
Eric W. Biederman1efdb692012-02-07 16:54:11 -0800689 kuid_t uid = make_kuid(current_user_ns(), in->uid);
690 kgid_t gid = make_kgid(current_user_ns(), in->gid);
691 if (!uid_valid(uid) || !gid_valid(gid))
692 return -EINVAL;
693
694 out->uid = uid;
695 out->gid = gid;
Pierre Peiffer8f4a3802008-04-29 01:00:51 -0700696 out->mode = (out->mode & ~S_IRWXUGO)
697 | (in->mode & S_IRWXUGO);
Eric W. Biederman1efdb692012-02-07 16:54:11 -0800698
699 return 0;
Pierre Peiffer8f4a3802008-04-29 01:00:51 -0700700}
701
Pierre Peiffera5f75e72008-04-29 01:00:54 -0700702/**
Manfred Spraul4241c1a2018-08-21 22:01:34 -0700703 * ipcctl_obtain_check - retrieve an ipc object and check permissions
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800704 * @ns: ipc namespace
Pierre Peiffera5f75e72008-04-29 01:00:54 -0700705 * @ids: the table of ids where to look for the ipc
706 * @id: the id of the ipc to retrieve
707 * @cmd: the cmd to check
708 * @perm: the permission to set
709 * @extra_perm: one extra permission parameter used by msq
710 *
711 * This function does some common audit and permissions check for some IPC_XXX
712 * cmd and is called from semctl_down, shmctl_down and msgctl_down.
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300713 *
Manfred Spraul4241c1a2018-08-21 22:01:34 -0700714 * It:
715 * - retrieves the ipc object with the given id in the given table.
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300716 * - performs some audit and permission check, depending on the given cmd
717 * - returns a pointer to the ipc object or otherwise, the corresponding
718 * error.
Davidlohr Bueso7b4cc5d2013-07-08 16:01:12 -0700719 *
Davidlohr Buesod9a605e2013-09-11 14:26:24 -0700720 * Call holding the both the rwsem and the rcu read lock.
Pierre Peiffera5f75e72008-04-29 01:00:54 -0700721 */
Manfred Spraul4241c1a2018-08-21 22:01:34 -0700722struct kern_ipc_perm *ipcctl_obtain_check(struct ipc_namespace *ns,
Davidlohr Bueso3b1c4ad2013-09-11 14:26:17 -0700723 struct ipc_ids *ids, int id, int cmd,
724 struct ipc64_perm *perm, int extra_perm)
Davidlohr Bueso444d0f62013-04-30 19:15:24 -0700725{
Eric W. Biederman1efdb692012-02-07 16:54:11 -0800726 kuid_t euid;
Davidlohr Bueso444d0f62013-04-30 19:15:24 -0700727 int err = -EPERM;
728 struct kern_ipc_perm *ipcp;
Pierre Peiffera5f75e72008-04-29 01:00:54 -0700729
Davidlohr Bueso444d0f62013-04-30 19:15:24 -0700730 ipcp = ipc_obtain_object_check(ids, id);
Pierre Peiffera5f75e72008-04-29 01:00:54 -0700731 if (IS_ERR(ipcp)) {
732 err = PTR_ERR(ipcp);
Davidlohr Bueso7b4cc5d2013-07-08 16:01:12 -0700733 goto err;
Pierre Peiffera5f75e72008-04-29 01:00:54 -0700734 }
735
Al Viroa33e6752008-12-10 03:40:06 -0500736 audit_ipc_obj(ipcp);
Al Viroe816f372008-12-10 03:47:15 -0500737 if (cmd == IPC_SET)
738 audit_ipc_set_perm(extra_perm, perm->uid,
Davidlohr Bueso444d0f62013-04-30 19:15:24 -0700739 perm->gid, perm->mode);
David Howells414c0702008-11-14 10:39:06 +1100740
741 euid = current_euid();
Eric W. Biederman1efdb692012-02-07 16:54:11 -0800742 if (uid_eq(euid, ipcp->cuid) || uid_eq(euid, ipcp->uid) ||
Serge E. Hallynb0e77592011-03-23 16:43:24 -0700743 ns_capable(ns->user_ns, CAP_SYS_ADMIN))
Davidlohr Bueso7b4cc5d2013-07-08 16:01:12 -0700744 return ipcp; /* successful lookup */
745err:
Pierre Peiffera5f75e72008-04-29 01:00:54 -0700746 return ERR_PTR(err);
747}
748
Will Deaconc1d7e012012-07-30 14:42:46 -0700749#ifdef CONFIG_ARCH_WANT_IPC_PARSE_VERSION
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
751
752/**
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800753 * ipc_parse_version - ipc call version
754 * @cmd: pointer to command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 *
Davidlohr Bueso8001c852014-01-27 17:07:05 -0800756 * Return IPC_64 for new style IPC and IPC_OLD for old style IPC.
757 * The @cmd value is turned from an encoding command and version into
758 * just the command code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 */
Manfred Spraul239521f2014-01-27 17:07:04 -0800760int ipc_parse_version(int *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
762 if (*cmd & IPC_64) {
763 *cmd ^= IPC_64;
764 return IPC_64;
765 } else {
766 return IPC_OLD;
767 }
768}
769
Will Deaconc1d7e012012-07-30 14:42:46 -0700770#endif /* CONFIG_ARCH_WANT_IPC_PARSE_VERSION */
Mike Waychisonae781772005-09-06 15:17:09 -0700771
772#ifdef CONFIG_PROC_FS
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800773struct ipc_proc_iter {
774 struct ipc_namespace *ns;
Eric W. Biederman03f1fc02018-03-23 00:22:05 -0500775 struct pid_namespace *pid_ns;
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800776 struct ipc_proc_iface *iface;
777};
778
Eric W. Biederman03f1fc02018-03-23 00:22:05 -0500779struct pid_namespace *ipc_seq_pid_ns(struct seq_file *s)
780{
781 struct ipc_proc_iter *iter = s->private;
782 return iter->pid_ns;
783}
784
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700785/*
786 * This routine locks the ipc structure found at least at position pos.
787 */
Adrian Bunkb524b9a2008-02-06 01:36:28 -0800788static struct kern_ipc_perm *sysvipc_find_ipc(struct ipc_ids *ids, loff_t pos,
789 loff_t *new_pos)
Mike Waychisonae781772005-09-06 15:17:09 -0700790{
Rafael Aquini20401d12021-09-07 20:00:53 -0700791 struct kern_ipc_perm *ipc = NULL;
792 int max_idx = ipc_get_maxidx(ids);
Kirill Korotaev73ea4132006-10-02 02:18:20 -0700793
Rafael Aquini20401d12021-09-07 20:00:53 -0700794 if (max_idx == -1 || pos > max_idx)
Vasily Averin5e698222020-05-13 17:50:48 -0700795 goto out;
Mike Waychisonae781772005-09-06 15:17:09 -0700796
Rafael Aquini20401d12021-09-07 20:00:53 -0700797 for (; pos <= max_idx; pos++) {
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700798 ipc = idr_find(&ids->ipcs_idr, pos);
799 if (ipc != NULL) {
Davidlohr Bueso32a27502013-09-11 14:26:29 -0700800 rcu_read_lock();
801 ipc_lock_object(ipc);
Vasily Averin5e698222020-05-13 17:50:48 -0700802 break;
Mike Waychisonae781772005-09-06 15:17:09 -0700803 }
804 }
Vasily Averin5e698222020-05-13 17:50:48 -0700805out:
806 *new_pos = pos + 1;
807 return ipc;
Mike Waychisonae781772005-09-06 15:17:09 -0700808}
809
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700810static void *sysvipc_proc_next(struct seq_file *s, void *it, loff_t *pos)
811{
812 struct ipc_proc_iter *iter = s->private;
813 struct ipc_proc_iface *iface = iter->iface;
814 struct kern_ipc_perm *ipc = it;
815
816 /* If we had an ipc id locked before, unlock it */
817 if (ipc && ipc != SEQ_START_TOKEN)
818 ipc_unlock(ipc);
819
Pierre Peiffered2ddbf2008-02-08 04:18:57 -0800820 return sysvipc_find_ipc(&iter->ns->ids[iface->ids], *pos, pos);
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700821}
822
Mike Waychisonae781772005-09-06 15:17:09 -0700823/*
Nadia Derbeyf4566f02007-10-18 23:40:53 -0700824 * File positions: pos 0 -> header, pos n -> ipc id = n - 1.
825 * SeqFile iterator: iterator value locked ipc pointer or SEQ_TOKEN_START.
Mike Waychisonae781772005-09-06 15:17:09 -0700826 */
827static void *sysvipc_proc_start(struct seq_file *s, loff_t *pos)
828{
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800829 struct ipc_proc_iter *iter = s->private;
830 struct ipc_proc_iface *iface = iter->iface;
Kirill Korotaev73ea4132006-10-02 02:18:20 -0700831 struct ipc_ids *ids;
832
Pierre Peiffered2ddbf2008-02-08 04:18:57 -0800833 ids = &iter->ns->ids[iface->ids];
Mike Waychisonae781772005-09-06 15:17:09 -0700834
835 /*
836 * Take the lock - this will be released by the corresponding
837 * call to stop().
838 */
Davidlohr Buesod9a605e2013-09-11 14:26:24 -0700839 down_read(&ids->rwsem);
Mike Waychisonae781772005-09-06 15:17:09 -0700840
841 /* pos < 0 is invalid */
842 if (*pos < 0)
843 return NULL;
844
845 /* pos == 0 means header */
846 if (*pos == 0)
847 return SEQ_START_TOKEN;
848
849 /* Find the (pos-1)th ipc */
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700850 return sysvipc_find_ipc(ids, *pos - 1, pos);
Mike Waychisonae781772005-09-06 15:17:09 -0700851}
852
853static void sysvipc_proc_stop(struct seq_file *s, void *it)
854{
855 struct kern_ipc_perm *ipc = it;
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800856 struct ipc_proc_iter *iter = s->private;
857 struct ipc_proc_iface *iface = iter->iface;
Kirill Korotaev73ea4132006-10-02 02:18:20 -0700858 struct ipc_ids *ids;
Mike Waychisonae781772005-09-06 15:17:09 -0700859
Nadia Derbeyf4566f02007-10-18 23:40:53 -0700860 /* If we had a locked structure, release it */
Mike Waychisonae781772005-09-06 15:17:09 -0700861 if (ipc && ipc != SEQ_START_TOKEN)
862 ipc_unlock(ipc);
863
Pierre Peiffered2ddbf2008-02-08 04:18:57 -0800864 ids = &iter->ns->ids[iface->ids];
Mike Waychisonae781772005-09-06 15:17:09 -0700865 /* Release the lock we took in start() */
Davidlohr Buesod9a605e2013-09-11 14:26:24 -0700866 up_read(&ids->rwsem);
Mike Waychisonae781772005-09-06 15:17:09 -0700867}
868
869static int sysvipc_proc_show(struct seq_file *s, void *it)
870{
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800871 struct ipc_proc_iter *iter = s->private;
872 struct ipc_proc_iface *iface = iter->iface;
Mike Waychisonae781772005-09-06 15:17:09 -0700873
Joe Perches7f032d62015-04-15 16:17:54 -0700874 if (it == SEQ_START_TOKEN) {
875 seq_puts(s, iface->header);
876 return 0;
877 }
Mike Waychisonae781772005-09-06 15:17:09 -0700878
879 return iface->show(s, it);
880}
881
James Morris88e9d342009-09-22 16:43:43 -0700882static const struct seq_operations sysvipc_proc_seqops = {
Mike Waychisonae781772005-09-06 15:17:09 -0700883 .start = sysvipc_proc_start,
884 .stop = sysvipc_proc_stop,
885 .next = sysvipc_proc_next,
886 .show = sysvipc_proc_show,
887};
888
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800889static int sysvipc_proc_open(struct inode *inode, struct file *file)
890{
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800891 struct ipc_proc_iter *iter;
892
Rob Jonesd66a0522014-10-13 15:54:14 -0700893 iter = __seq_open_private(file, &sysvipc_proc_seqops, sizeof(*iter));
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800894 if (!iter)
Rob Jonesd66a0522014-10-13 15:54:14 -0700895 return -ENOMEM;
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800896
Al Virod9dda782013-03-31 18:16:14 -0400897 iter->iface = PDE_DATA(inode);
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800898 iter->ns = get_ipc_ns(current->nsproxy->ipc_ns);
Eric W. Biederman03f1fc02018-03-23 00:22:05 -0500899 iter->pid_ns = get_pid_ns(task_active_pid_ns(current));
Rob Jonesd66a0522014-10-13 15:54:14 -0700900
901 return 0;
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800902}
903
904static int sysvipc_proc_release(struct inode *inode, struct file *file)
905{
906 struct seq_file *seq = file->private_data;
907 struct ipc_proc_iter *iter = seq->private;
908 put_ipc_ns(iter->ns);
Eric W. Biederman03f1fc02018-03-23 00:22:05 -0500909 put_pid_ns(iter->pid_ns);
Eric W. Biedermanbc1fc6d2007-02-12 00:52:10 -0800910 return seq_release_private(inode, file);
Mike Waychisonae781772005-09-06 15:17:09 -0700911}
912
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800913static const struct proc_ops sysvipc_proc_ops = {
Alexey Dobriyand919b332020-04-06 20:09:01 -0700914 .proc_flags = PROC_ENTRY_PERMANENT,
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800915 .proc_open = sysvipc_proc_open,
916 .proc_read = seq_read,
917 .proc_lseek = seq_lseek,
918 .proc_release = sysvipc_proc_release,
Mike Waychisonae781772005-09-06 15:17:09 -0700919};
920#endif /* CONFIG_PROC_FS */