ipc: rename ipcctl_pre_down_nolock()
[linux-2.6-block.git] / ipc / util.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
1da177e4
LT
2/*
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
624dffcb 11 * Manfred Spraul <manfred@colorfullife.com>
1da177e4
LT
12 * Oct 2002 - One lock per IPC id. RCU ipc_free for lock-free grow_ary().
13 * Mingming Cao <cmm@us.ibm.com>
073115d6
SG
14 * Mar 2006 - support for audit of ipc object properties
15 * Dustin Kirkland <dustin.kirkland@us.ibm.com>
73ea4130
KK
16 * Jun 2006 - namespaces ssupport
17 * OpenVZ, SWsoft Inc.
18 * Pavel Emelianov <xemul@openvz.org>
05603c44
DB
19 *
20 * General sysv ipc locking scheme:
18ccee26
DB
21 * 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).
87ad4b0d
PM
26 * - perform read-only operations, such as INFO command, that
27 * do not demand atomicity
18ccee26
DB
28 * acquire the ipc lock (kern_ipc_perm.lock) through
29 * ipc_lock_object()
87ad4b0d
PM
30 * - perform read-only operations that demand atomicity,
31 * such as STAT command.
18ccee26
DB
32 * - 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().
1da177e4
LT
45 */
46
1da177e4
LT
47#include <linux/mm.h>
48#include <linux/shm.h>
49#include <linux/init.h>
50#include <linux/msg.h>
1da177e4
LT
51#include <linux/vmalloc.h>
52#include <linux/slab.h>
8f68fa2d 53#include <linux/notifier.h>
c59ede7b 54#include <linux/capability.h>
1da177e4
LT
55#include <linux/highuid.h>
56#include <linux/security.h>
57#include <linux/rcupdate.h>
58#include <linux/workqueue.h>
ae781774
MW
59#include <linux/seq_file.h>
60#include <linux/proc_fs.h>
073115d6 61#include <linux/audit.h>
73ea4130 62#include <linux/nsproxy.h>
3e148c79 63#include <linux/rwsem.h>
b6b337ad 64#include <linux/memory.h>
ae5e1b22 65#include <linux/ipc_namespace.h>
0eb71a9d 66#include <linux/rhashtable.h>
1da177e4
LT
67
68#include <asm/unistd.h>
69
70#include "util.h"
71
ae781774
MW
72struct ipc_proc_iface {
73 const char *path;
74 const char *header;
73ea4130 75 int ids;
ae781774
MW
76 int (*show)(struct seq_file *, void *);
77};
78
1da177e4 79/**
8001c858 80 * ipc_init - initialise ipc subsystem
1da177e4 81 *
8001c858
DB
82 * The various sysv ipc resources (semaphores, messages and shared
83 * memory) are initialised.
84 *
85 * A callback routine is registered into the memory hotplug notifier
86 * chain: since msgmni scales to lowmem this callback routine will be
87 * called upon successful memory add / remove to recompute msmgni.
1da177e4 88 */
1da177e4
LT
89static int __init ipc_init(void)
90{
0cfb6aee
GK
91 int err_sem, err_msg;
92
e74a0eff 93 proc_mkdir("sysvipc", NULL);
0cfb6aee
GK
94 err_sem = sem_init();
95 WARN(err_sem, "ipc: sysv sem_init failed: %d\n", err_sem);
96 err_msg = msg_init();
97 WARN(err_msg, "ipc: sysv msg_init failed: %d\n", err_msg);
1da177e4 98 shm_init();
0cfb6aee
GK
99
100 return err_msg ? err_msg : err_sem;
1da177e4 101}
6d08a256 102device_initcall(ipc_init);
1da177e4 103
0cfb6aee
GK
104static const struct rhashtable_params ipc_kht_params = {
105 .head_offset = offsetof(struct kern_ipc_perm, khtnode),
106 .key_offset = offsetof(struct kern_ipc_perm, key),
107 .key_len = FIELD_SIZEOF(struct kern_ipc_perm, key),
108 .locks_mul = 1,
109 .automatic_shrinking = true,
110};
111
1da177e4 112/**
8001c858
DB
113 * ipc_init_ids - initialise ipc identifiers
114 * @ids: ipc identifier set
1da177e4 115 *
8001c858 116 * Set up the sequence range to use for the ipc identifier range (limited
0cfb6aee 117 * below IPCMNI) then initialise the keys hashtable and ids idr.
1da177e4 118 */
0cfb6aee 119int ipc_init_ids(struct ipc_ids *ids)
1da177e4 120{
0cfb6aee 121 int err;
1da177e4 122 ids->in_use = 0;
1da177e4 123 ids->seq = 0;
daf948c7 124 init_rwsem(&ids->rwsem);
0cfb6aee
GK
125 err = rhashtable_init(&ids->key_ht, &ipc_kht_params);
126 if (err)
127 return err;
7ca7e564 128 idr_init(&ids->ipcs_idr);
0cfb6aee 129 ids->tables_initialized = true;
15df03c8 130 ids->max_id = -1;
b8fd9983
DB
131#ifdef CONFIG_CHECKPOINT_RESTORE
132 ids->next_id = -1;
133#endif
0cfb6aee 134 return 0;
1da177e4
LT
135}
136
ae781774 137#ifdef CONFIG_PROC_FS
9a32144e 138static const struct file_operations sysvipc_proc_fops;
ae781774 139/**
8001c858
DB
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.
ae781774
MW
145 */
146void __init ipc_init_proc_interface(const char *path, const char *header,
73ea4130 147 int ids, int (*show)(struct seq_file *, void *))
ae781774
MW
148{
149 struct proc_dir_entry *pde;
150 struct ipc_proc_iface *iface;
151
152 iface = kmalloc(sizeof(*iface), GFP_KERNEL);
153 if (!iface)
154 return;
155 iface->path = path;
156 iface->header = header;
157 iface->ids = ids;
158 iface->show = show;
159
6a6375db
DL
160 pde = proc_create_data(path,
161 S_IRUGO, /* world readable */
162 NULL, /* parent dir */
163 &sysvipc_proc_fops,
164 iface);
3ab08fe2 165 if (!pde)
ae781774 166 kfree(iface);
ae781774
MW
167}
168#endif
169
1da177e4 170/**
8001c858
DB
171 * ipc_findkey - find a key in an ipc identifier set
172 * @ids: ipc identifier set
173 * @key: key to find
46c0a8ca 174 *
8001c858
DB
175 * Returns the locked pointer to the ipc structure if found or NULL
176 * otherwise. If key is found ipc points to the owning ipc structure
177 *
0cfb6aee 178 * Called with writer ipc_ids.rwsem held.
1da177e4 179 */
7748dbfa 180static struct kern_ipc_perm *ipc_findkey(struct ipc_ids *ids, key_t key)
1da177e4 181{
0cfb6aee 182 struct kern_ipc_perm *ipcp = NULL;
7ca7e564 183
0cfb6aee
GK
184 if (likely(ids->tables_initialized))
185 ipcp = rhashtable_lookup_fast(&ids->key_ht, &key,
186 ipc_kht_params);
7ca7e564 187
0cfb6aee 188 if (ipcp) {
32a27500 189 rcu_read_lock();
0cfb6aee
GK
190 ipc_lock_object(ipcp);
191 return ipcp;
1da177e4 192 }
7ca7e564
ND
193
194 return NULL;
1da177e4
LT
195}
196
b8fd9983 197/*
e2652ae6
MS
198 * Insert new IPC object into idr tree, and set sequence number and id
199 * in the correct order.
200 * Especially:
201 * - the sequence number must be set before inserting the object into the idr,
202 * because the sequence number is accessed without a lock.
203 * - the id can/must be set after inserting the object into the idr.
204 * All accesses must be done after getting kern_ipc_perm.lock.
205 *
206 * The caller must own kern_ipc_perm.lock.of the new object.
207 * On error, the function returns a (negative) error code.
b8fd9983 208 */
e2652ae6 209static inline int ipc_idr_alloc(struct ipc_ids *ids, struct kern_ipc_perm *new)
b8fd9983 210{
e2652ae6
MS
211 int idx, next_id = -1;
212
213#ifdef CONFIG_CHECKPOINT_RESTORE
214 next_id = ids->next_id;
215 ids->next_id = -1;
216#endif
217
218 /*
219 * As soon as a new object is inserted into the idr,
220 * ipc_obtain_object_idr() or ipc_obtain_object_check() can find it,
221 * and the lockless preparations for ipc operations can start.
222 * This means especially: permission checks, audit calls, allocation
223 * of undo structures, ...
224 *
225 * Thus the object must be fully initialized, and if something fails,
226 * then the full tear-down sequence must be followed.
227 * (i.e.: set new->deleted, reduce refcount, call_rcu())
228 */
229
230 if (next_id < 0) { /* !CHECKPOINT_RESTORE or next_id is unset */
b8fd9983
DB
231 new->seq = ids->seq++;
232 if (ids->seq > IPCID_SEQ_MAX)
233 ids->seq = 0;
e2652ae6 234 idx = idr_alloc(&ids->ipcs_idr, new, 0, 0, GFP_NOWAIT);
b8fd9983 235 } else {
e2652ae6
MS
236 new->seq = ipcid_to_seqx(next_id);
237 idx = idr_alloc(&ids->ipcs_idr, new, ipcid_to_idx(next_id),
238 0, GFP_NOWAIT);
b8fd9983 239 }
e2652ae6
MS
240 if (idx >= 0)
241 new->id = SEQ_MULTIPLIER * new->seq + idx;
242 return idx;
b8fd9983
DB
243}
244
1da177e4 245/**
8001c858
DB
246 * ipc_addid - add an ipc identifier
247 * @ids: ipc identifier set
248 * @new: new ipc permission set
ebf66799 249 * @limit: limit for the number of used ids
1da177e4 250 *
8001c858
DB
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.
39cfffd7 254 *
8001c858 255 * On failure the entry is not locked and a negative err-code is returned.
39cfffd7 256 * The caller must use ipc_rcu_putref() to free the identifier.
1da177e4 257 *
8001c858 258 * Called with writer ipc_ids.rwsem held.
1da177e4 259 */
ebf66799 260int ipc_addid(struct ipc_ids *ids, struct kern_ipc_perm *new, int limit)
1da177e4 261{
1efdb69b
EB
262 kuid_t euid;
263 kgid_t egid;
e2652ae6 264 int idx, err;
1da177e4 265
39cfffd7
MS
266 /* 1) Initialize the refcount so that ipc_rcu_putref works */
267 refcount_set(&new->refcount, 1);
268
ebf66799
DB
269 if (limit > IPCMNI)
270 limit = IPCMNI;
7ca7e564 271
ebf66799 272 if (!ids->tables_initialized || ids->in_use >= limit)
283bb7fa 273 return -ENOSPC;
7ca7e564 274
54924ea3
TH
275 idr_preload(GFP_KERNEL);
276
e00b4ff7 277 spin_lock_init(&new->lock);
e00b4ff7
ND
278 rcu_read_lock();
279 spin_lock(&new->lock);
280
b9a53227
LT
281 current_euid_egid(&euid, &egid);
282 new->cuid = new->uid = euid;
283 new->gid = new->cgid = egid;
284
39cfffd7
MS
285 new->deleted = false;
286
e2652ae6 287 idx = ipc_idr_alloc(ids, new);
54924ea3 288 idr_preload_end();
0cfb6aee 289
e2652ae6 290 if (idx >= 0 && new->key != IPC_PRIVATE) {
0cfb6aee
GK
291 err = rhashtable_insert_fast(&ids->key_ht, &new->khtnode,
292 ipc_kht_params);
293 if (err < 0) {
e2652ae6
MS
294 idr_remove(&ids->ipcs_idr, idx);
295 idx = err;
0cfb6aee
GK
296 }
297 }
e2652ae6 298 if (idx < 0) {
39cfffd7 299 new->deleted = true;
e00b4ff7
ND
300 spin_unlock(&new->lock);
301 rcu_read_unlock();
e2652ae6 302 return idx;
e00b4ff7 303 }
7ca7e564 304
1da177e4 305 ids->in_use++;
e2652ae6
MS
306 if (idx > ids->max_id)
307 ids->max_id = idx;
308 return idx;
1da177e4
LT
309}
310
7748dbfa 311/**
8001c858
DB
312 * ipcget_new - create a new ipc object
313 * @ns: ipc namespace
da3dae54 314 * @ids: ipc identifier set
8001c858
DB
315 * @ops: the actual creation routine to call
316 * @params: its parameters
317 *
318 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
319 * when the key is IPC_PRIVATE.
7748dbfa 320 */
b2d75cdd 321static int ipcget_new(struct ipc_namespace *ns, struct ipc_ids *ids,
eb66ec44 322 const struct ipc_ops *ops, struct ipc_params *params)
7748dbfa
ND
323{
324 int err;
7748dbfa 325
d9a605e4 326 down_write(&ids->rwsem);
7748dbfa 327 err = ops->getnew(ns, params);
d9a605e4 328 up_write(&ids->rwsem);
7748dbfa
ND
329 return err;
330}
331
332/**
8001c858
DB
333 * ipc_check_perms - check security and permissions for an ipc object
334 * @ns: ipc namespace
335 * @ipcp: ipc permission set
336 * @ops: the actual security routine to call
337 * @params: its parameters
f4566f04 338 *
8001c858
DB
339 * This routine is called by sys_msgget(), sys_semget() and sys_shmget()
340 * when the key is not IPC_PRIVATE and that key already exists in the
341 * ds IDR.
f4566f04 342 *
8001c858 343 * On success, the ipc id is returned.
f4566f04 344 *
8001c858 345 * It is called with ipc_ids.rwsem and ipcp->lock held.
7748dbfa 346 */
b0e77598
SH
347static int ipc_check_perms(struct ipc_namespace *ns,
348 struct kern_ipc_perm *ipcp,
eb66ec44 349 const struct ipc_ops *ops,
b0e77598 350 struct ipc_params *params)
7748dbfa
ND
351{
352 int err;
353
b0e77598 354 if (ipcperms(ns, ipcp, params->flg))
7748dbfa
ND
355 err = -EACCES;
356 else {
357 err = ops->associate(ipcp, params->flg);
358 if (!err)
359 err = ipcp->id;
360 }
361
362 return err;
363}
364
365/**
8001c858
DB
366 * ipcget_public - get an ipc object or create a new one
367 * @ns: ipc namespace
da3dae54 368 * @ids: ipc identifier set
8001c858
DB
369 * @ops: the actual creation routine to call
370 * @params: its parameters
371 *
372 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
373 * when the key is not IPC_PRIVATE.
374 * It adds a new entry if the key is not found and does some permission
375 * / security checkings if the key is found.
376 *
377 * On success, the ipc id is returned.
7748dbfa 378 */
b2d75cdd 379static int ipcget_public(struct ipc_namespace *ns, struct ipc_ids *ids,
eb66ec44 380 const struct ipc_ops *ops, struct ipc_params *params)
7748dbfa
ND
381{
382 struct kern_ipc_perm *ipcp;
383 int flg = params->flg;
384 int err;
7748dbfa 385
3e148c79
ND
386 /*
387 * Take the lock as a writer since we are potentially going to add
388 * a new entry + read locks are not "upgradable"
389 */
d9a605e4 390 down_write(&ids->rwsem);
7748dbfa
ND
391 ipcp = ipc_findkey(ids, params->key);
392 if (ipcp == NULL) {
393 /* key not used */
394 if (!(flg & IPC_CREAT))
395 err = -ENOENT;
7748dbfa
ND
396 else
397 err = ops->getnew(ns, params);
398 } else {
399 /* ipc object has been locked by ipc_findkey() */
400
401 if (flg & IPC_CREAT && flg & IPC_EXCL)
402 err = -EEXIST;
403 else {
404 err = 0;
405 if (ops->more_checks)
406 err = ops->more_checks(ipcp, params);
407 if (!err)
f4566f04
ND
408 /*
409 * ipc_check_perms returns the IPC id on
410 * success
411 */
b0e77598 412 err = ipc_check_perms(ns, ipcp, ops, params);
7748dbfa
ND
413 }
414 ipc_unlock(ipcp);
415 }
d9a605e4 416 up_write(&ids->rwsem);
7748dbfa
ND
417
418 return err;
419}
420
0cfb6aee
GK
421/**
422 * ipc_kht_remove - remove an ipc from the key hashtable
423 * @ids: ipc identifier set
424 * @ipcp: ipc perm structure containing the key to remove
425 *
426 * ipc_ids.rwsem (as a writer) and the spinlock for this ID are held
427 * before this function is called, and remain locked on the exit.
428 */
429static void ipc_kht_remove(struct ipc_ids *ids, struct kern_ipc_perm *ipcp)
430{
431 if (ipcp->key != IPC_PRIVATE)
432 rhashtable_remove_fast(&ids->key_ht, &ipcp->khtnode,
433 ipc_kht_params);
434}
7748dbfa 435
1da177e4 436/**
8001c858
DB
437 * ipc_rmid - remove an ipc identifier
438 * @ids: ipc identifier set
439 * @ipcp: ipc perm structure containing the identifier to remove
1da177e4 440 *
8001c858
DB
441 * ipc_ids.rwsem (as a writer) and the spinlock for this ID are held
442 * before this function is called, and remain locked on the exit.
1da177e4 443 */
7ca7e564 444void ipc_rmid(struct ipc_ids *ids, struct kern_ipc_perm *ipcp)
1da177e4 445{
ce621f5b 446 int lid = ipcid_to_idx(ipcp->id);
7ca7e564
ND
447
448 idr_remove(&ids->ipcs_idr, lid);
0cfb6aee 449 ipc_kht_remove(ids, ipcp);
1da177e4 450 ids->in_use--;
72a8ff2f 451 ipcp->deleted = true;
15df03c8
DB
452
453 if (unlikely(lid == ids->max_id)) {
454 do {
455 lid--;
456 if (lid == -1)
457 break;
458 } while (!idr_find(&ids->ipcs_idr, lid));
459 ids->max_id = lid;
460 }
1da177e4
LT
461}
462
0cfb6aee
GK
463/**
464 * ipc_set_key_private - switch the key of an existing ipc to IPC_PRIVATE
465 * @ids: ipc identifier set
466 * @ipcp: ipc perm structure containing the key to modify
467 *
468 * ipc_ids.rwsem (as a writer) and the spinlock for this ID are held
469 * before this function is called, and remain locked on the exit.
470 */
471void ipc_set_key_private(struct ipc_ids *ids, struct kern_ipc_perm *ipcp)
472{
473 ipc_kht_remove(ids, ipcp);
474 ipcp->key = IPC_PRIVATE;
475}
476
dba4cdd3 477int ipc_rcu_getref(struct kern_ipc_perm *ptr)
1da177e4 478{
9405c03e 479 return refcount_inc_not_zero(&ptr->refcount);
65f27f38
DH
480}
481
dba4cdd3
MS
482void ipc_rcu_putref(struct kern_ipc_perm *ptr,
483 void (*func)(struct rcu_head *head))
1da177e4 484{
9405c03e 485 if (!refcount_dec_and_test(&ptr->refcount))
1da177e4
LT
486 return;
487
dba4cdd3 488 call_rcu(&ptr->rcu, func);
53dad6d3
DB
489}
490
1da177e4 491/**
8001c858
DB
492 * ipcperms - check ipc permissions
493 * @ns: ipc namespace
494 * @ipcp: ipc permission set
495 * @flag: desired permission set
1da177e4 496 *
8001c858
DB
497 * Check user, group, other permissions for access
498 * to ipc resources. return 0 if allowed
b0e77598 499 *
0e056eb5 500 * @flag will most probably be 0 or ``S_...UGO`` from <linux/stat.h>
1da177e4 501 */
b0e77598
SH
502int ipcperms(struct ipc_namespace *ns, struct kern_ipc_perm *ipcp, short flag)
503{
1efdb69b 504 kuid_t euid = current_euid();
a33e6751 505 int requested_mode, granted_mode;
1da177e4 506
a33e6751 507 audit_ipc_obj(ipcp);
1da177e4
LT
508 requested_mode = (flag >> 6) | (flag >> 3) | flag;
509 granted_mode = ipcp->mode;
1efdb69b
EB
510 if (uid_eq(euid, ipcp->cuid) ||
511 uid_eq(euid, ipcp->uid))
1da177e4
LT
512 granted_mode >>= 6;
513 else if (in_group_p(ipcp->cgid) || in_group_p(ipcp->gid))
514 granted_mode >>= 3;
515 /* is there some bit set in requested_mode but not in granted_mode? */
46c0a8ca 516 if ((requested_mode & ~granted_mode & 0007) &&
b0e77598 517 !ns_capable(ns->user_ns, CAP_IPC_OWNER))
1da177e4
LT
518 return -1;
519
520 return security_ipc_permission(ipcp, flag);
521}
522
523/*
524 * Functions to convert between the kern_ipc_perm structure and the
525 * old/new ipc_perm structures
526 */
527
528/**
8001c858
DB
529 * kernel_to_ipc64_perm - convert kernel ipc permissions to user
530 * @in: kernel permissions
531 * @out: new style ipc permissions
1da177e4 532 *
8001c858
DB
533 * Turn the kernel object @in into a set of permissions descriptions
534 * for returning to userspace (@out).
1da177e4 535 */
239521f3 536void kernel_to_ipc64_perm(struct kern_ipc_perm *in, struct ipc64_perm *out)
1da177e4
LT
537{
538 out->key = in->key;
1efdb69b
EB
539 out->uid = from_kuid_munged(current_user_ns(), in->uid);
540 out->gid = from_kgid_munged(current_user_ns(), in->gid);
541 out->cuid = from_kuid_munged(current_user_ns(), in->cuid);
542 out->cgid = from_kgid_munged(current_user_ns(), in->cgid);
1da177e4
LT
543 out->mode = in->mode;
544 out->seq = in->seq;
545}
546
547/**
8001c858
DB
548 * ipc64_perm_to_ipc_perm - convert new ipc permissions to old
549 * @in: new style ipc permissions
550 * @out: old style ipc permissions
1da177e4 551 *
8001c858
DB
552 * Turn the new style permissions object @in into a compatibility
553 * object and store it into the @out pointer.
1da177e4 554 */
239521f3 555void ipc64_perm_to_ipc_perm(struct ipc64_perm *in, struct ipc_perm *out)
1da177e4
LT
556{
557 out->key = in->key;
558 SET_UID(out->uid, in->uid);
559 SET_GID(out->gid, in->gid);
560 SET_UID(out->cuid, in->cuid);
561 SET_GID(out->cgid, in->cgid);
562 out->mode = in->mode;
563 out->seq = in->seq;
564}
565
4d2bff5e 566/**
0cfb6aee 567 * ipc_obtain_object_idr
4d2bff5e
DB
568 * @ids: ipc identifier set
569 * @id: ipc id to look for
570 *
571 * Look for an id in the ipc ids idr and return associated ipc object.
572 *
573 * Call inside the RCU critical section.
574 * The ipc object is *not* locked on exit.
575 */
55b7ae50 576struct kern_ipc_perm *ipc_obtain_object_idr(struct ipc_ids *ids, int id)
4d2bff5e
DB
577{
578 struct kern_ipc_perm *out;
579 int lid = ipcid_to_idx(id);
580
0cfb6aee
GK
581 if (unlikely(!ids->tables_initialized))
582 return ERR_PTR(-EINVAL);
583
4d2bff5e
DB
584 out = idr_find(&ids->ipcs_idr, lid);
585 if (!out)
586 return ERR_PTR(-EINVAL);
587
588 return out;
589}
590
f4566f04 591/**
8001c858
DB
592 * ipc_lock - lock an ipc structure without rwsem held
593 * @ids: ipc identifier set
f4566f04
ND
594 * @id: ipc id to look for
595 *
596 * Look for an id in the ipc ids idr and lock the associated ipc object.
597 *
4d2bff5e 598 * The ipc object is locked on successful exit.
f4566f04 599 */
7ca7e564 600struct kern_ipc_perm *ipc_lock(struct ipc_ids *ids, int id)
1da177e4 601{
7ca7e564 602 struct kern_ipc_perm *out;
1da177e4
LT
603
604 rcu_read_lock();
55b7ae50 605 out = ipc_obtain_object_idr(ids, id);
4d2bff5e 606 if (IS_ERR(out))
f8b59184 607 goto err;
7ca7e564 608
1da177e4 609 spin_lock(&out->lock);
4d2bff5e 610
f8b59184
DB
611 /*
612 * ipc_rmid() may have already freed the ID while ipc_lock()
613 * was spinning: here verify that the structure is still valid.
614 * Upon races with RMID, return -EIDRM, thus indicating that
615 * the ID points to a removed identifier.
1da177e4 616 */
72a8ff2f 617 if (ipc_valid_object(out))
4d2bff5e
DB
618 return out;
619
620 spin_unlock(&out->lock);
f8b59184
DB
621 out = ERR_PTR(-EIDRM);
622err:
4d2bff5e
DB
623 rcu_read_unlock();
624 return out;
625}
7ca7e564 626
4d2bff5e
DB
627/**
628 * ipc_obtain_object_check
629 * @ids: ipc identifier set
630 * @id: ipc id to look for
631 *
55b7ae50 632 * Similar to ipc_obtain_object_idr() but also checks
4d2bff5e
DB
633 * the ipc object reference counter.
634 *
635 * Call inside the RCU critical section.
636 * The ipc object is *not* locked on exit.
637 */
638struct kern_ipc_perm *ipc_obtain_object_check(struct ipc_ids *ids, int id)
639{
55b7ae50 640 struct kern_ipc_perm *out = ipc_obtain_object_idr(ids, id);
4d2bff5e
DB
641
642 if (IS_ERR(out))
643 goto out;
644
645 if (ipc_checkid(out, id))
6157dbbf 646 return ERR_PTR(-EINVAL);
4d2bff5e 647out:
1da177e4
LT
648 return out;
649}
650
b2d75cdd
PE
651/**
652 * ipcget - Common sys_*get() code
da3dae54 653 * @ns: namespace
8001c858
DB
654 * @ids: ipc identifier set
655 * @ops: operations to be called on ipc object creation, permission checks
656 * and further checks
657 * @params: the parameters needed by the previous operations.
b2d75cdd
PE
658 *
659 * Common routine called by sys_msgget(), sys_semget() and sys_shmget().
660 */
661int ipcget(struct ipc_namespace *ns, struct ipc_ids *ids,
eb66ec44 662 const struct ipc_ops *ops, struct ipc_params *params)
b2d75cdd
PE
663{
664 if (params->key == IPC_PRIVATE)
665 return ipcget_new(ns, ids, ops, params);
666 else
667 return ipcget_public(ns, ids, ops, params);
668}
669
8f4a3809 670/**
8001c858 671 * ipc_update_perm - update the permissions of an ipc object
8f4a3809
PP
672 * @in: the permission given as input.
673 * @out: the permission of the ipc to set.
674 */
1efdb69b 675int ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out)
8f4a3809 676{
1efdb69b
EB
677 kuid_t uid = make_kuid(current_user_ns(), in->uid);
678 kgid_t gid = make_kgid(current_user_ns(), in->gid);
679 if (!uid_valid(uid) || !gid_valid(gid))
680 return -EINVAL;
681
682 out->uid = uid;
683 out->gid = gid;
8f4a3809
PP
684 out->mode = (out->mode & ~S_IRWXUGO)
685 | (in->mode & S_IRWXUGO);
1efdb69b
EB
686
687 return 0;
8f4a3809
PP
688}
689
a5f75e7f 690/**
4241c1a3 691 * ipcctl_obtain_check - retrieve an ipc object and check permissions
8001c858 692 * @ns: ipc namespace
a5f75e7f
PP
693 * @ids: the table of ids where to look for the ipc
694 * @id: the id of the ipc to retrieve
695 * @cmd: the cmd to check
696 * @perm: the permission to set
697 * @extra_perm: one extra permission parameter used by msq
698 *
699 * This function does some common audit and permissions check for some IPC_XXX
700 * cmd and is called from semctl_down, shmctl_down and msgctl_down.
0e056eb5 701 *
4241c1a3
MS
702 * It:
703 * - retrieves the ipc object with the given id in the given table.
0e056eb5 704 * - performs some audit and permission check, depending on the given cmd
705 * - returns a pointer to the ipc object or otherwise, the corresponding
706 * error.
7b4cc5d8 707 *
d9a605e4 708 * Call holding the both the rwsem and the rcu read lock.
a5f75e7f 709 */
4241c1a3 710struct kern_ipc_perm *ipcctl_obtain_check(struct ipc_namespace *ns,
3b1c4ad3
DB
711 struct ipc_ids *ids, int id, int cmd,
712 struct ipc64_perm *perm, int extra_perm)
444d0f62 713{
1efdb69b 714 kuid_t euid;
444d0f62
DB
715 int err = -EPERM;
716 struct kern_ipc_perm *ipcp;
a5f75e7f 717
444d0f62 718 ipcp = ipc_obtain_object_check(ids, id);
a5f75e7f
PP
719 if (IS_ERR(ipcp)) {
720 err = PTR_ERR(ipcp);
7b4cc5d8 721 goto err;
a5f75e7f
PP
722 }
723
a33e6751 724 audit_ipc_obj(ipcp);
e816f370
AV
725 if (cmd == IPC_SET)
726 audit_ipc_set_perm(extra_perm, perm->uid,
444d0f62 727 perm->gid, perm->mode);
414c0708
DH
728
729 euid = current_euid();
1efdb69b 730 if (uid_eq(euid, ipcp->cuid) || uid_eq(euid, ipcp->uid) ||
b0e77598 731 ns_capable(ns->user_ns, CAP_SYS_ADMIN))
7b4cc5d8
DB
732 return ipcp; /* successful lookup */
733err:
a5f75e7f
PP
734 return ERR_PTR(err);
735}
736
c1d7e01d 737#ifdef CONFIG_ARCH_WANT_IPC_PARSE_VERSION
1da177e4
LT
738
739
740/**
8001c858
DB
741 * ipc_parse_version - ipc call version
742 * @cmd: pointer to command
1da177e4 743 *
8001c858
DB
744 * Return IPC_64 for new style IPC and IPC_OLD for old style IPC.
745 * The @cmd value is turned from an encoding command and version into
746 * just the command code.
1da177e4 747 */
239521f3 748int ipc_parse_version(int *cmd)
1da177e4
LT
749{
750 if (*cmd & IPC_64) {
751 *cmd ^= IPC_64;
752 return IPC_64;
753 } else {
754 return IPC_OLD;
755 }
756}
757
c1d7e01d 758#endif /* CONFIG_ARCH_WANT_IPC_PARSE_VERSION */
ae781774
MW
759
760#ifdef CONFIG_PROC_FS
bc1fc6d8
EB
761struct ipc_proc_iter {
762 struct ipc_namespace *ns;
03f1fc09 763 struct pid_namespace *pid_ns;
bc1fc6d8
EB
764 struct ipc_proc_iface *iface;
765};
766
03f1fc09
EB
767struct pid_namespace *ipc_seq_pid_ns(struct seq_file *s)
768{
769 struct ipc_proc_iter *iter = s->private;
770 return iter->pid_ns;
771}
772
7ca7e564
ND
773/*
774 * This routine locks the ipc structure found at least at position pos.
775 */
b524b9ad
AB
776static struct kern_ipc_perm *sysvipc_find_ipc(struct ipc_ids *ids, loff_t pos,
777 loff_t *new_pos)
ae781774 778{
7ca7e564
ND
779 struct kern_ipc_perm *ipc;
780 int total, id;
73ea4130 781
7ca7e564
ND
782 total = 0;
783 for (id = 0; id < pos && total < ids->in_use; id++) {
784 ipc = idr_find(&ids->ipcs_idr, id);
785 if (ipc != NULL)
786 total++;
787 }
ae781774 788
7ca7e564
ND
789 if (total >= ids->in_use)
790 return NULL;
ae781774 791
239521f3 792 for (; pos < IPCMNI; pos++) {
7ca7e564
ND
793 ipc = idr_find(&ids->ipcs_idr, pos);
794 if (ipc != NULL) {
795 *new_pos = pos + 1;
32a27500
DB
796 rcu_read_lock();
797 ipc_lock_object(ipc);
ae781774
MW
798 return ipc;
799 }
800 }
801
802 /* Out of range - return NULL to terminate iteration */
803 return NULL;
804}
805
7ca7e564
ND
806static void *sysvipc_proc_next(struct seq_file *s, void *it, loff_t *pos)
807{
808 struct ipc_proc_iter *iter = s->private;
809 struct ipc_proc_iface *iface = iter->iface;
810 struct kern_ipc_perm *ipc = it;
811
812 /* If we had an ipc id locked before, unlock it */
813 if (ipc && ipc != SEQ_START_TOKEN)
814 ipc_unlock(ipc);
815
ed2ddbf8 816 return sysvipc_find_ipc(&iter->ns->ids[iface->ids], *pos, pos);
7ca7e564
ND
817}
818
ae781774 819/*
f4566f04
ND
820 * File positions: pos 0 -> header, pos n -> ipc id = n - 1.
821 * SeqFile iterator: iterator value locked ipc pointer or SEQ_TOKEN_START.
ae781774
MW
822 */
823static void *sysvipc_proc_start(struct seq_file *s, loff_t *pos)
824{
bc1fc6d8
EB
825 struct ipc_proc_iter *iter = s->private;
826 struct ipc_proc_iface *iface = iter->iface;
73ea4130
KK
827 struct ipc_ids *ids;
828
ed2ddbf8 829 ids = &iter->ns->ids[iface->ids];
ae781774
MW
830
831 /*
832 * Take the lock - this will be released by the corresponding
833 * call to stop().
834 */
d9a605e4 835 down_read(&ids->rwsem);
ae781774
MW
836
837 /* pos < 0 is invalid */
838 if (*pos < 0)
839 return NULL;
840
841 /* pos == 0 means header */
842 if (*pos == 0)
843 return SEQ_START_TOKEN;
844
845 /* Find the (pos-1)th ipc */
7ca7e564 846 return sysvipc_find_ipc(ids, *pos - 1, pos);
ae781774
MW
847}
848
849static void sysvipc_proc_stop(struct seq_file *s, void *it)
850{
851 struct kern_ipc_perm *ipc = it;
bc1fc6d8
EB
852 struct ipc_proc_iter *iter = s->private;
853 struct ipc_proc_iface *iface = iter->iface;
73ea4130 854 struct ipc_ids *ids;
ae781774 855
f4566f04 856 /* If we had a locked structure, release it */
ae781774
MW
857 if (ipc && ipc != SEQ_START_TOKEN)
858 ipc_unlock(ipc);
859
ed2ddbf8 860 ids = &iter->ns->ids[iface->ids];
ae781774 861 /* Release the lock we took in start() */
d9a605e4 862 up_read(&ids->rwsem);
ae781774
MW
863}
864
865static int sysvipc_proc_show(struct seq_file *s, void *it)
866{
bc1fc6d8
EB
867 struct ipc_proc_iter *iter = s->private;
868 struct ipc_proc_iface *iface = iter->iface;
ae781774 869
7f032d6e
JP
870 if (it == SEQ_START_TOKEN) {
871 seq_puts(s, iface->header);
872 return 0;
873 }
ae781774
MW
874
875 return iface->show(s, it);
876}
877
88e9d34c 878static const struct seq_operations sysvipc_proc_seqops = {
ae781774
MW
879 .start = sysvipc_proc_start,
880 .stop = sysvipc_proc_stop,
881 .next = sysvipc_proc_next,
882 .show = sysvipc_proc_show,
883};
884
bc1fc6d8
EB
885static int sysvipc_proc_open(struct inode *inode, struct file *file)
886{
bc1fc6d8
EB
887 struct ipc_proc_iter *iter;
888
d66a0520 889 iter = __seq_open_private(file, &sysvipc_proc_seqops, sizeof(*iter));
bc1fc6d8 890 if (!iter)
d66a0520 891 return -ENOMEM;
bc1fc6d8 892
d9dda78b 893 iter->iface = PDE_DATA(inode);
bc1fc6d8 894 iter->ns = get_ipc_ns(current->nsproxy->ipc_ns);
03f1fc09 895 iter->pid_ns = get_pid_ns(task_active_pid_ns(current));
d66a0520
RJ
896
897 return 0;
bc1fc6d8
EB
898}
899
900static int sysvipc_proc_release(struct inode *inode, struct file *file)
901{
902 struct seq_file *seq = file->private_data;
903 struct ipc_proc_iter *iter = seq->private;
904 put_ipc_ns(iter->ns);
03f1fc09 905 put_pid_ns(iter->pid_ns);
bc1fc6d8 906 return seq_release_private(inode, file);
ae781774
MW
907}
908
9a32144e 909static const struct file_operations sysvipc_proc_fops = {
ae781774
MW
910 .open = sysvipc_proc_open,
911 .read = seq_read,
912 .llseek = seq_lseek,
bc1fc6d8 913 .release = sysvipc_proc_release,
ae781774
MW
914};
915#endif /* CONFIG_PROC_FS */