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