]> bbs.cooldavid.org Git - net-next-2.6.git/blame - ipc/util.c
ipc: call idr_find() without locking in ipc_lock()
[net-next-2.6.git] / ipc / util.c
CommitLineData
1da177e4
LT
1/*
2 * linux/ipc/util.c
3 * Copyright (C) 1992 Krishna Balasubramanian
4 *
5 * Sep 1997 - Call suser() last after "normal" permission checks so we
6 * get BSD style process accounting right.
7 * Occurs in several places in the IPC code.
8 * Chris Evans, <chris@ferret.lmh.ox.ac.uk>
9 * Nov 1999 - ipc helper functions, unified SMP locking
624dffcb 10 * Manfred Spraul <manfred@colorfullife.com>
1da177e4
LT
11 * Oct 2002 - One lock per IPC id. RCU ipc_free for lock-free grow_ary().
12 * Mingming Cao <cmm@us.ibm.com>
073115d6
SG
13 * Mar 2006 - support for audit of ipc object properties
14 * Dustin Kirkland <dustin.kirkland@us.ibm.com>
73ea4130
KK
15 * Jun 2006 - namespaces ssupport
16 * OpenVZ, SWsoft Inc.
17 * Pavel Emelianov <xemul@openvz.org>
1da177e4
LT
18 */
19
1da177e4
LT
20#include <linux/mm.h>
21#include <linux/shm.h>
22#include <linux/init.h>
23#include <linux/msg.h>
1da177e4
LT
24#include <linux/vmalloc.h>
25#include <linux/slab.h>
c59ede7b 26#include <linux/capability.h>
1da177e4
LT
27#include <linux/highuid.h>
28#include <linux/security.h>
29#include <linux/rcupdate.h>
30#include <linux/workqueue.h>
ae781774
MW
31#include <linux/seq_file.h>
32#include <linux/proc_fs.h>
073115d6 33#include <linux/audit.h>
73ea4130 34#include <linux/nsproxy.h>
3e148c79 35#include <linux/rwsem.h>
b6b337ad 36#include <linux/memory.h>
ae5e1b22 37#include <linux/ipc_namespace.h>
1da177e4
LT
38
39#include <asm/unistd.h>
40
41#include "util.h"
42
ae781774
MW
43struct ipc_proc_iface {
44 const char *path;
45 const char *header;
73ea4130 46 int ids;
ae781774
MW
47 int (*show)(struct seq_file *, void *);
48};
49
73ea4130
KK
50struct ipc_namespace init_ipc_ns = {
51 .kref = {
52 .refcount = ATOMIC_INIT(2),
53 },
54};
55
4d89dc6a
ND
56atomic_t nr_ipc_ns = ATOMIC_INIT(1);
57
58
b6b337ad
ND
59#ifdef CONFIG_MEMORY_HOTPLUG
60
424450c1
ND
61static void ipc_memory_notifier(struct work_struct *work)
62{
63 ipcns_notify(IPCNS_MEMCHANGED);
64}
65
66static DECLARE_WORK(ipc_memory_wq, ipc_memory_notifier);
67
68
b6b337ad
ND
69static int ipc_memory_callback(struct notifier_block *self,
70 unsigned long action, void *arg)
71{
72 switch (action) {
73 case MEM_ONLINE: /* memory successfully brought online */
74 case MEM_OFFLINE: /* or offline: it's time to recompute msgmni */
75 /*
76 * This is done by invoking the ipcns notifier chain with the
77 * IPC_MEMCHANGED event.
424450c1
ND
78 * In order not to keep the lock on the hotplug memory chain
79 * for too long, queue a work item that will, when waken up,
80 * activate the ipcns notification chain.
81 * No need to keep several ipc work items on the queue.
b6b337ad 82 */
424450c1
ND
83 if (!work_pending(&ipc_memory_wq))
84 schedule_work(&ipc_memory_wq);
b6b337ad
ND
85 break;
86 case MEM_GOING_ONLINE:
87 case MEM_GOING_OFFLINE:
88 case MEM_CANCEL_ONLINE:
89 case MEM_CANCEL_OFFLINE:
90 default:
91 break;
92 }
93
94 return NOTIFY_OK;
95}
96
97#endif /* CONFIG_MEMORY_HOTPLUG */
98
1da177e4
LT
99/**
100 * ipc_init - initialise IPC subsystem
101 *
102 * The various system5 IPC resources (semaphores, messages and shared
72fd4a35 103 * memory) are initialised
b6b337ad
ND
104 * A callback routine is registered into the memory hotplug notifier
105 * chain: since msgmni scales to lowmem this callback routine will be
106 * called upon successful memory add / remove to recompute msmgni.
1da177e4
LT
107 */
108
109static int __init ipc_init(void)
110{
111 sem_init();
112 msg_init();
113 shm_init();
b6b337ad
ND
114 hotplug_memory_notifier(ipc_memory_callback, IPC_CALLBACK_PRI);
115 register_ipcns_notifier(&init_ipc_ns);
1da177e4
LT
116 return 0;
117}
118__initcall(ipc_init);
119
120/**
121 * ipc_init_ids - initialise IPC identifiers
122 * @ids: Identifier set
1da177e4 123 *
7ca7e564
ND
124 * Set up the sequence range to use for the ipc identifier range (limited
125 * below IPCMNI) then initialise the ids idr.
1da177e4
LT
126 */
127
7ca7e564 128void ipc_init_ids(struct ipc_ids *ids)
1da177e4 129{
3e148c79 130 init_rwsem(&ids->rw_mutex);
1da177e4 131
1da177e4 132 ids->in_use = 0;
1da177e4
LT
133 ids->seq = 0;
134 {
135 int seq_limit = INT_MAX/SEQ_MULTIPLIER;
44f564a4
ZY
136 if (seq_limit > USHORT_MAX)
137 ids->seq_max = USHORT_MAX;
1da177e4
LT
138 else
139 ids->seq_max = seq_limit;
140 }
141
7ca7e564 142 idr_init(&ids->ipcs_idr);
1da177e4
LT
143}
144
ae781774 145#ifdef CONFIG_PROC_FS
9a32144e 146static const struct file_operations sysvipc_proc_fops;
ae781774 147/**
72fd4a35 148 * ipc_init_proc_interface - Create a proc interface for sysipc types using a seq_file interface.
ae781774
MW
149 * @path: Path in procfs
150 * @header: Banner to be printed at the beginning of the file.
151 * @ids: ipc id table to iterate.
152 * @show: show routine.
153 */
154void __init ipc_init_proc_interface(const char *path, const char *header,
73ea4130 155 int ids, int (*show)(struct seq_file *, void *))
ae781774
MW
156{
157 struct proc_dir_entry *pde;
158 struct ipc_proc_iface *iface;
159
160 iface = kmalloc(sizeof(*iface), GFP_KERNEL);
161 if (!iface)
162 return;
163 iface->path = path;
164 iface->header = header;
165 iface->ids = ids;
166 iface->show = show;
167
6a6375db
DL
168 pde = proc_create_data(path,
169 S_IRUGO, /* world readable */
170 NULL, /* parent dir */
171 &sysvipc_proc_fops,
172 iface);
173 if (!pde) {
ae781774
MW
174 kfree(iface);
175 }
176}
177#endif
178
1da177e4
LT
179/**
180 * ipc_findkey - find a key in an ipc identifier set
181 * @ids: Identifier set
182 * @key: The key to find
183 *
3e148c79 184 * Requires ipc_ids.rw_mutex locked.
7ca7e564
ND
185 * Returns the LOCKED pointer to the ipc structure if found or NULL
186 * if not.
f4566f04 187 * If key is found ipc points to the owning ipc structure
1da177e4
LT
188 */
189
7748dbfa 190static struct kern_ipc_perm *ipc_findkey(struct ipc_ids *ids, key_t key)
1da177e4 191{
7ca7e564
ND
192 struct kern_ipc_perm *ipc;
193 int next_id;
194 int total;
1da177e4 195
7ca7e564
ND
196 for (total = 0, next_id = 0; total < ids->in_use; next_id++) {
197 ipc = idr_find(&ids->ipcs_idr, next_id);
198
199 if (ipc == NULL)
1da177e4 200 continue;
7ca7e564
ND
201
202 if (ipc->key != key) {
203 total++;
204 continue;
205 }
206
207 ipc_lock_by_ptr(ipc);
208 return ipc;
1da177e4 209 }
7ca7e564
ND
210
211 return NULL;
1da177e4
LT
212}
213
7ca7e564
ND
214/**
215 * ipc_get_maxid - get the last assigned id
216 * @ids: IPC identifier set
217 *
3e148c79 218 * Called with ipc_ids.rw_mutex held.
1da177e4 219 */
1da177e4 220
7ca7e564
ND
221int ipc_get_maxid(struct ipc_ids *ids)
222{
223 struct kern_ipc_perm *ipc;
224 int max_id = -1;
225 int total, id;
226
227 if (ids->in_use == 0)
228 return -1;
1da177e4 229
7ca7e564
ND
230 if (ids->in_use == IPCMNI)
231 return IPCMNI - 1;
232
233 /* Look for the last assigned id */
234 total = 0;
235 for (id = 0; id < IPCMNI && total < ids->in_use; id++) {
236 ipc = idr_find(&ids->ipcs_idr, id);
237 if (ipc != NULL) {
238 max_id = id;
239 total++;
240 }
241 }
242 return max_id;
1da177e4
LT
243}
244
245/**
246 * ipc_addid - add an IPC identifier
247 * @ids: IPC identifier set
248 * @new: new IPC permission set
7ca7e564 249 * @size: limit for the number of used ids
1da177e4 250 *
f4566f04 251 * Add an entry 'new' to the IPC ids idr. The permissions object is
1da177e4 252 * initialised and the first free entry is set up and the id assigned
f4566f04 253 * is returned. The 'new' entry is returned in a locked state on success.
283bb7fa 254 * On failure the entry is not locked and a negative err-code is returned.
1da177e4 255 *
3e148c79 256 * Called with ipc_ids.rw_mutex held as a writer.
1da177e4
LT
257 */
258
259int ipc_addid(struct ipc_ids* ids, struct kern_ipc_perm* new, int size)
260{
7ca7e564 261 int id, err;
1da177e4 262
7ca7e564
ND
263 if (size > IPCMNI)
264 size = IPCMNI;
265
266 if (ids->in_use >= size)
283bb7fa 267 return -ENOSPC;
7ca7e564
ND
268
269 err = idr_get_new(&ids->ipcs_idr, new, &id);
270 if (err)
283bb7fa 271 return err;
7ca7e564 272
1da177e4 273 ids->in_use++;
1da177e4
LT
274
275 new->cuid = new->uid = current->euid;
276 new->gid = new->cgid = current->egid;
277
278 new->seq = ids->seq++;
279 if(ids->seq > ids->seq_max)
280 ids->seq = 0;
281
48dea404 282 new->id = ipc_buildid(id, new->seq);
1da177e4
LT
283 spin_lock_init(&new->lock);
284 new->deleted = 0;
285 rcu_read_lock();
286 spin_lock(&new->lock);
1da177e4
LT
287 return id;
288}
289
7748dbfa
ND
290/**
291 * ipcget_new - create a new ipc object
292 * @ns: namespace
f4566f04 293 * @ids: IPC identifer set
7748dbfa
ND
294 * @ops: the actual creation routine to call
295 * @params: its parameters
296 *
f4566f04
ND
297 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
298 * when the key is IPC_PRIVATE.
7748dbfa 299 */
b2d75cdd 300static int ipcget_new(struct ipc_namespace *ns, struct ipc_ids *ids,
7748dbfa
ND
301 struct ipc_ops *ops, struct ipc_params *params)
302{
303 int err;
283bb7fa 304retry:
7748dbfa
ND
305 err = idr_pre_get(&ids->ipcs_idr, GFP_KERNEL);
306
307 if (!err)
308 return -ENOMEM;
309
3e148c79 310 down_write(&ids->rw_mutex);
7748dbfa 311 err = ops->getnew(ns, params);
3e148c79 312 up_write(&ids->rw_mutex);
7748dbfa 313
283bb7fa
PP
314 if (err == -EAGAIN)
315 goto retry;
316
7748dbfa
ND
317 return err;
318}
319
320/**
321 * ipc_check_perms - check security and permissions for an IPC
322 * @ipcp: ipc permission set
7748dbfa
ND
323 * @ops: the actual security routine to call
324 * @params: its parameters
f4566f04
ND
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 * ids IDR.
329 *
330 * On success, the IPC id is returned.
331 *
3e148c79 332 * It is called with ipc_ids.rw_mutex and ipcp->lock held.
7748dbfa
ND
333 */
334static int ipc_check_perms(struct kern_ipc_perm *ipcp, struct ipc_ops *ops,
335 struct ipc_params *params)
336{
337 int err;
338
339 if (ipcperms(ipcp, params->flg))
340 err = -EACCES;
341 else {
342 err = ops->associate(ipcp, params->flg);
343 if (!err)
344 err = ipcp->id;
345 }
346
347 return err;
348}
349
350/**
351 * ipcget_public - get an ipc object or create a new one
352 * @ns: namespace
f4566f04 353 * @ids: IPC identifer set
7748dbfa
ND
354 * @ops: the actual creation routine to call
355 * @params: its parameters
356 *
f4566f04
ND
357 * This routine is called by sys_msgget, sys_semget() and sys_shmget()
358 * when the key is not IPC_PRIVATE.
359 * It adds a new entry if the key is not found and does some permission
360 * / security checkings if the key is found.
361 *
362 * On success, the ipc id is returned.
7748dbfa 363 */
b2d75cdd 364static int ipcget_public(struct ipc_namespace *ns, struct ipc_ids *ids,
7748dbfa
ND
365 struct ipc_ops *ops, struct ipc_params *params)
366{
367 struct kern_ipc_perm *ipcp;
368 int flg = params->flg;
369 int err;
283bb7fa 370retry:
7748dbfa
ND
371 err = idr_pre_get(&ids->ipcs_idr, GFP_KERNEL);
372
3e148c79
ND
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->rw_mutex);
7748dbfa
ND
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 if (!err)
384 err = -ENOMEM;
385 else
386 err = ops->getnew(ns, params);
387 } else {
388 /* ipc object has been locked by ipc_findkey() */
389
390 if (flg & IPC_CREAT && flg & IPC_EXCL)
391 err = -EEXIST;
392 else {
393 err = 0;
394 if (ops->more_checks)
395 err = ops->more_checks(ipcp, params);
396 if (!err)
f4566f04
ND
397 /*
398 * ipc_check_perms returns the IPC id on
399 * success
400 */
7748dbfa
ND
401 err = ipc_check_perms(ipcp, ops, params);
402 }
403 ipc_unlock(ipcp);
404 }
3e148c79 405 up_write(&ids->rw_mutex);
7748dbfa 406
283bb7fa
PP
407 if (err == -EAGAIN)
408 goto retry;
409
7748dbfa
ND
410 return err;
411}
412
413
1da177e4
LT
414/**
415 * ipc_rmid - remove an IPC identifier
f4566f04
ND
416 * @ids: IPC identifier set
417 * @ipcp: ipc perm structure containing the identifier to remove
1da177e4 418 *
3e148c79
ND
419 * ipc_ids.rw_mutex (as a writer) and the spinlock for this ID are held
420 * before this function is called, and remain locked on the exit.
1da177e4
LT
421 */
422
7ca7e564 423void ipc_rmid(struct ipc_ids *ids, struct kern_ipc_perm *ipcp)
1da177e4 424{
ce621f5b 425 int lid = ipcid_to_idx(ipcp->id);
7ca7e564
ND
426
427 idr_remove(&ids->ipcs_idr, lid);
1da177e4 428
1da177e4
LT
429 ids->in_use--;
430
7ca7e564
ND
431 ipcp->deleted = 1;
432
433 return;
1da177e4
LT
434}
435
436/**
437 * ipc_alloc - allocate ipc space
438 * @size: size desired
439 *
440 * Allocate memory from the appropriate pools and return a pointer to it.
441 * NULL is returned if the allocation fails
442 */
443
444void* ipc_alloc(int size)
445{
446 void* out;
447 if(size > PAGE_SIZE)
448 out = vmalloc(size);
449 else
450 out = kmalloc(size, GFP_KERNEL);
451 return out;
452}
453
454/**
455 * ipc_free - free ipc space
456 * @ptr: pointer returned by ipc_alloc
457 * @size: size of block
458 *
72fd4a35 459 * Free a block created with ipc_alloc(). The caller must know the size
1da177e4
LT
460 * used in the allocation call.
461 */
462
463void ipc_free(void* ptr, int size)
464{
465 if(size > PAGE_SIZE)
466 vfree(ptr);
467 else
468 kfree(ptr);
469}
470
471/*
472 * rcu allocations:
473 * There are three headers that are prepended to the actual allocation:
474 * - during use: ipc_rcu_hdr.
475 * - during the rcu grace period: ipc_rcu_grace.
476 * - [only if vmalloc]: ipc_rcu_sched.
477 * Their lifetime doesn't overlap, thus the headers share the same memory.
478 * Unlike a normal union, they are right-aligned, thus some container_of
479 * forward/backward casting is necessary:
480 */
481struct ipc_rcu_hdr
482{
483 int refcount;
484 int is_vmalloc;
485 void *data[0];
486};
487
488
489struct ipc_rcu_grace
490{
491 struct rcu_head rcu;
492 /* "void *" makes sure alignment of following data is sane. */
493 void *data[0];
494};
495
496struct ipc_rcu_sched
497{
498 struct work_struct work;
499 /* "void *" makes sure alignment of following data is sane. */
500 void *data[0];
501};
502
503#define HDRLEN_KMALLOC (sizeof(struct ipc_rcu_grace) > sizeof(struct ipc_rcu_hdr) ? \
504 sizeof(struct ipc_rcu_grace) : sizeof(struct ipc_rcu_hdr))
505#define HDRLEN_VMALLOC (sizeof(struct ipc_rcu_sched) > HDRLEN_KMALLOC ? \
506 sizeof(struct ipc_rcu_sched) : HDRLEN_KMALLOC)
507
508static inline int rcu_use_vmalloc(int size)
509{
510 /* Too big for a single page? */
511 if (HDRLEN_KMALLOC + size > PAGE_SIZE)
512 return 1;
513 return 0;
514}
515
516/**
517 * ipc_rcu_alloc - allocate ipc and rcu space
518 * @size: size desired
519 *
520 * Allocate memory for the rcu header structure + the object.
521 * Returns the pointer to the object.
522 * NULL is returned if the allocation fails.
523 */
524
525void* ipc_rcu_alloc(int size)
526{
527 void* out;
528 /*
529 * We prepend the allocation with the rcu struct, and
530 * workqueue if necessary (for vmalloc).
531 */
532 if (rcu_use_vmalloc(size)) {
533 out = vmalloc(HDRLEN_VMALLOC + size);
534 if (out) {
535 out += HDRLEN_VMALLOC;
536 container_of(out, struct ipc_rcu_hdr, data)->is_vmalloc = 1;
537 container_of(out, struct ipc_rcu_hdr, data)->refcount = 1;
538 }
539 } else {
540 out = kmalloc(HDRLEN_KMALLOC + size, GFP_KERNEL);
541 if (out) {
542 out += HDRLEN_KMALLOC;
543 container_of(out, struct ipc_rcu_hdr, data)->is_vmalloc = 0;
544 container_of(out, struct ipc_rcu_hdr, data)->refcount = 1;
545 }
546 }
547
548 return out;
549}
550
551void ipc_rcu_getref(void *ptr)
552{
553 container_of(ptr, struct ipc_rcu_hdr, data)->refcount++;
554}
555
65f27f38
DH
556static void ipc_do_vfree(struct work_struct *work)
557{
558 vfree(container_of(work, struct ipc_rcu_sched, work));
559}
560
1da177e4 561/**
1e5d5331
RD
562 * ipc_schedule_free - free ipc + rcu space
563 * @head: RCU callback structure for queued work
1da177e4
LT
564 *
565 * Since RCU callback function is called in bh,
72fd4a35 566 * we need to defer the vfree to schedule_work().
1da177e4
LT
567 */
568static void ipc_schedule_free(struct rcu_head *head)
569{
f4566f04
ND
570 struct ipc_rcu_grace *grace;
571 struct ipc_rcu_sched *sched;
572
573 grace = container_of(head, struct ipc_rcu_grace, rcu);
574 sched = container_of(&(grace->data[0]), struct ipc_rcu_sched,
575 data[0]);
1da177e4 576
65f27f38 577 INIT_WORK(&sched->work, ipc_do_vfree);
1da177e4
LT
578 schedule_work(&sched->work);
579}
580
581/**
1e5d5331
RD
582 * ipc_immediate_free - free ipc + rcu space
583 * @head: RCU callback structure that contains pointer to be freed
1da177e4 584 *
72fd4a35 585 * Free from the RCU callback context.
1da177e4
LT
586 */
587static void ipc_immediate_free(struct rcu_head *head)
588{
589 struct ipc_rcu_grace *free =
590 container_of(head, struct ipc_rcu_grace, rcu);
591 kfree(free);
592}
593
594void ipc_rcu_putref(void *ptr)
595{
596 if (--container_of(ptr, struct ipc_rcu_hdr, data)->refcount > 0)
597 return;
598
599 if (container_of(ptr, struct ipc_rcu_hdr, data)->is_vmalloc) {
600 call_rcu(&container_of(ptr, struct ipc_rcu_grace, data)->rcu,
601 ipc_schedule_free);
602 } else {
603 call_rcu(&container_of(ptr, struct ipc_rcu_grace, data)->rcu,
604 ipc_immediate_free);
605 }
606}
607
608/**
609 * ipcperms - check IPC permissions
610 * @ipcp: IPC permission set
611 * @flag: desired permission set.
612 *
613 * Check user, group, other permissions for access
614 * to ipc resources. return 0 if allowed
615 */
616
617int ipcperms (struct kern_ipc_perm *ipcp, short flag)
618{ /* flag will most probably be 0 or S_...UGO from <linux/stat.h> */
073115d6 619 int requested_mode, granted_mode, err;
1da177e4 620
073115d6
SG
621 if (unlikely((err = audit_ipc_obj(ipcp))))
622 return err;
1da177e4
LT
623 requested_mode = (flag >> 6) | (flag >> 3) | flag;
624 granted_mode = ipcp->mode;
625 if (current->euid == ipcp->cuid || current->euid == ipcp->uid)
626 granted_mode >>= 6;
627 else if (in_group_p(ipcp->cgid) || in_group_p(ipcp->gid))
628 granted_mode >>= 3;
629 /* is there some bit set in requested_mode but not in granted_mode? */
630 if ((requested_mode & ~granted_mode & 0007) &&
631 !capable(CAP_IPC_OWNER))
632 return -1;
633
634 return security_ipc_permission(ipcp, flag);
635}
636
637/*
638 * Functions to convert between the kern_ipc_perm structure and the
639 * old/new ipc_perm structures
640 */
641
642/**
643 * kernel_to_ipc64_perm - convert kernel ipc permissions to user
644 * @in: kernel permissions
645 * @out: new style IPC permissions
646 *
72fd4a35
RD
647 * Turn the kernel object @in into a set of permissions descriptions
648 * for returning to userspace (@out).
1da177e4
LT
649 */
650
651
652void kernel_to_ipc64_perm (struct kern_ipc_perm *in, struct ipc64_perm *out)
653{
654 out->key = in->key;
655 out->uid = in->uid;
656 out->gid = in->gid;
657 out->cuid = in->cuid;
658 out->cgid = in->cgid;
659 out->mode = in->mode;
660 out->seq = in->seq;
661}
662
663/**
f4566f04 664 * ipc64_perm_to_ipc_perm - convert new ipc permissions to old
1da177e4
LT
665 * @in: new style IPC permissions
666 * @out: old style IPC permissions
667 *
72fd4a35
RD
668 * Turn the new style permissions object @in into a compatibility
669 * object and store it into the @out pointer.
1da177e4
LT
670 */
671
672void ipc64_perm_to_ipc_perm (struct ipc64_perm *in, struct ipc_perm *out)
673{
674 out->key = in->key;
675 SET_UID(out->uid, in->uid);
676 SET_GID(out->gid, in->gid);
677 SET_UID(out->cuid, in->cuid);
678 SET_GID(out->cgid, in->cgid);
679 out->mode = in->mode;
680 out->seq = in->seq;
681}
682
f4566f04 683/**
3e148c79 684 * ipc_lock - Lock an ipc structure without rw_mutex held
f4566f04
ND
685 * @ids: IPC identifier set
686 * @id: ipc id to look for
687 *
688 * Look for an id in the ipc ids idr and lock the associated ipc object.
689 *
f4566f04
ND
690 * The ipc object is locked on exit.
691 */
692
7ca7e564 693struct kern_ipc_perm *ipc_lock(struct ipc_ids *ids, int id)
1da177e4 694{
7ca7e564 695 struct kern_ipc_perm *out;
ce621f5b 696 int lid = ipcid_to_idx(id);
1da177e4
LT
697
698 rcu_read_lock();
7ca7e564
ND
699 out = idr_find(&ids->ipcs_idr, lid);
700 if (out == NULL) {
1da177e4 701 rcu_read_unlock();
023a5355 702 return ERR_PTR(-EINVAL);
1da177e4 703 }
7ca7e564 704
1da177e4
LT
705 spin_lock(&out->lock);
706
707 /* ipc_rmid() may have already freed the ID while ipc_lock
708 * was spinning: here verify that the structure is still valid
709 */
710 if (out->deleted) {
711 spin_unlock(&out->lock);
712 rcu_read_unlock();
023a5355 713 return ERR_PTR(-EINVAL);
1da177e4 714 }
7ca7e564 715
1da177e4
LT
716 return out;
717}
718
3e148c79
ND
719/**
720 * ipc_lock_down - Lock an ipc structure with rw_sem held
721 * @ids: IPC identifier set
722 * @id: ipc id to look for
723 *
724 * Look for an id in the ipc ids idr and lock the associated ipc object.
725 *
726 * The ipc object is locked on exit.
727 *
728 * This is the routine that should be called when the rw_mutex is already
729 * held, i.e. idr tree protected.
730 */
731
732struct kern_ipc_perm *ipc_lock_down(struct ipc_ids *ids, int id)
733{
734 struct kern_ipc_perm *out;
735 int lid = ipcid_to_idx(id);
736
737 rcu_read_lock();
738 out = idr_find(&ids->ipcs_idr, lid);
739 if (out == NULL) {
740 rcu_read_unlock();
741 return ERR_PTR(-EINVAL);
742 }
743
744 spin_lock(&out->lock);
745
746 /*
747 * No need to verify that the structure is still valid since the
748 * rw_mutex is held.
749 */
750 return out;
751}
752
b2d75cdd
PE
753struct kern_ipc_perm *ipc_lock_check_down(struct ipc_ids *ids, int id)
754{
755 struct kern_ipc_perm *out;
756
757 out = ipc_lock_down(ids, id);
758 if (IS_ERR(out))
759 return out;
760
761 if (ipc_checkid(out, id)) {
762 ipc_unlock(out);
763 return ERR_PTR(-EIDRM);
764 }
765
766 return out;
767}
768
769struct kern_ipc_perm *ipc_lock_check(struct ipc_ids *ids, int id)
770{
771 struct kern_ipc_perm *out;
772
773 out = ipc_lock(ids, id);
774 if (IS_ERR(out))
775 return out;
776
777 if (ipc_checkid(out, id)) {
778 ipc_unlock(out);
779 return ERR_PTR(-EIDRM);
780 }
781
782 return out;
783}
784
785/**
786 * ipcget - Common sys_*get() code
787 * @ns : namsepace
788 * @ids : IPC identifier set
789 * @ops : operations to be called on ipc object creation, permission checks
790 * and further checks
791 * @params : the parameters needed by the previous operations.
792 *
793 * Common routine called by sys_msgget(), sys_semget() and sys_shmget().
794 */
795int ipcget(struct ipc_namespace *ns, struct ipc_ids *ids,
796 struct ipc_ops *ops, struct ipc_params *params)
797{
798 if (params->key == IPC_PRIVATE)
799 return ipcget_new(ns, ids, ops, params);
800 else
801 return ipcget_public(ns, ids, ops, params);
802}
803
8f4a3809
PP
804/**
805 * ipc_update_perm - update the permissions of an IPC.
806 * @in: the permission given as input.
807 * @out: the permission of the ipc to set.
808 */
809void ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out)
810{
811 out->uid = in->uid;
812 out->gid = in->gid;
813 out->mode = (out->mode & ~S_IRWXUGO)
814 | (in->mode & S_IRWXUGO);
815}
816
a5f75e7f
PP
817/**
818 * ipcctl_pre_down - retrieve an ipc and check permissions for some IPC_XXX cmd
819 * @ids: the table of ids where to look for the ipc
820 * @id: the id of the ipc to retrieve
821 * @cmd: the cmd to check
822 * @perm: the permission to set
823 * @extra_perm: one extra permission parameter used by msq
824 *
825 * This function does some common audit and permissions check for some IPC_XXX
826 * cmd and is called from semctl_down, shmctl_down and msgctl_down.
827 * It must be called without any lock held and
828 * - retrieves the ipc with the given id in the given table.
829 * - performs some audit and permission check, depending on the given cmd
830 * - returns the ipc with both ipc and rw_mutex locks held in case of success
831 * or an err-code without any lock held otherwise.
832 */
833struct kern_ipc_perm *ipcctl_pre_down(struct ipc_ids *ids, int id, int cmd,
834 struct ipc64_perm *perm, int extra_perm)
835{
836 struct kern_ipc_perm *ipcp;
837 int err;
838
839 down_write(&ids->rw_mutex);
840 ipcp = ipc_lock_check_down(ids, id);
841 if (IS_ERR(ipcp)) {
842 err = PTR_ERR(ipcp);
843 goto out_up;
844 }
845
846 err = audit_ipc_obj(ipcp);
847 if (err)
848 goto out_unlock;
849
850 if (cmd == IPC_SET) {
851 err = audit_ipc_set_perm(extra_perm, perm->uid,
852 perm->gid, perm->mode);
853 if (err)
854 goto out_unlock;
855 }
856 if (current->euid == ipcp->cuid ||
857 current->euid == ipcp->uid || capable(CAP_SYS_ADMIN))
858 return ipcp;
859
860 err = -EPERM;
861out_unlock:
862 ipc_unlock(ipcp);
863out_up:
864 up_write(&ids->rw_mutex);
865 return ERR_PTR(err);
866}
867
1da177e4
LT
868#ifdef __ARCH_WANT_IPC_PARSE_VERSION
869
870
871/**
872 * ipc_parse_version - IPC call version
873 * @cmd: pointer to command
874 *
875 * Return IPC_64 for new style IPC and IPC_OLD for old style IPC.
72fd4a35 876 * The @cmd value is turned from an encoding command and version into
1da177e4
LT
877 * just the command code.
878 */
879
880int ipc_parse_version (int *cmd)
881{
882 if (*cmd & IPC_64) {
883 *cmd ^= IPC_64;
884 return IPC_64;
885 } else {
886 return IPC_OLD;
887 }
888}
889
890#endif /* __ARCH_WANT_IPC_PARSE_VERSION */
ae781774
MW
891
892#ifdef CONFIG_PROC_FS
bc1fc6d8
EB
893struct ipc_proc_iter {
894 struct ipc_namespace *ns;
895 struct ipc_proc_iface *iface;
896};
897
7ca7e564
ND
898/*
899 * This routine locks the ipc structure found at least at position pos.
900 */
b524b9ad
AB
901static struct kern_ipc_perm *sysvipc_find_ipc(struct ipc_ids *ids, loff_t pos,
902 loff_t *new_pos)
ae781774 903{
7ca7e564
ND
904 struct kern_ipc_perm *ipc;
905 int total, id;
73ea4130 906
7ca7e564
ND
907 total = 0;
908 for (id = 0; id < pos && total < ids->in_use; id++) {
909 ipc = idr_find(&ids->ipcs_idr, id);
910 if (ipc != NULL)
911 total++;
912 }
ae781774 913
7ca7e564
ND
914 if (total >= ids->in_use)
915 return NULL;
ae781774 916
7ca7e564
ND
917 for ( ; pos < IPCMNI; pos++) {
918 ipc = idr_find(&ids->ipcs_idr, pos);
919 if (ipc != NULL) {
920 *new_pos = pos + 1;
921 ipc_lock_by_ptr(ipc);
ae781774
MW
922 return ipc;
923 }
924 }
925
926 /* Out of range - return NULL to terminate iteration */
927 return NULL;
928}
929
7ca7e564
ND
930static void *sysvipc_proc_next(struct seq_file *s, void *it, loff_t *pos)
931{
932 struct ipc_proc_iter *iter = s->private;
933 struct ipc_proc_iface *iface = iter->iface;
934 struct kern_ipc_perm *ipc = it;
935
936 /* If we had an ipc id locked before, unlock it */
937 if (ipc && ipc != SEQ_START_TOKEN)
938 ipc_unlock(ipc);
939
ed2ddbf8 940 return sysvipc_find_ipc(&iter->ns->ids[iface->ids], *pos, pos);
7ca7e564
ND
941}
942
ae781774 943/*
f4566f04
ND
944 * File positions: pos 0 -> header, pos n -> ipc id = n - 1.
945 * SeqFile iterator: iterator value locked ipc pointer or SEQ_TOKEN_START.
ae781774
MW
946 */
947static void *sysvipc_proc_start(struct seq_file *s, loff_t *pos)
948{
bc1fc6d8
EB
949 struct ipc_proc_iter *iter = s->private;
950 struct ipc_proc_iface *iface = iter->iface;
73ea4130
KK
951 struct ipc_ids *ids;
952
ed2ddbf8 953 ids = &iter->ns->ids[iface->ids];
ae781774
MW
954
955 /*
956 * Take the lock - this will be released by the corresponding
957 * call to stop().
958 */
3e148c79 959 down_read(&ids->rw_mutex);
ae781774
MW
960
961 /* pos < 0 is invalid */
962 if (*pos < 0)
963 return NULL;
964
965 /* pos == 0 means header */
966 if (*pos == 0)
967 return SEQ_START_TOKEN;
968
969 /* Find the (pos-1)th ipc */
7ca7e564 970 return sysvipc_find_ipc(ids, *pos - 1, pos);
ae781774
MW
971}
972
973static void sysvipc_proc_stop(struct seq_file *s, void *it)
974{
975 struct kern_ipc_perm *ipc = it;
bc1fc6d8
EB
976 struct ipc_proc_iter *iter = s->private;
977 struct ipc_proc_iface *iface = iter->iface;
73ea4130 978 struct ipc_ids *ids;
ae781774 979
f4566f04 980 /* If we had a locked structure, release it */
ae781774
MW
981 if (ipc && ipc != SEQ_START_TOKEN)
982 ipc_unlock(ipc);
983
ed2ddbf8 984 ids = &iter->ns->ids[iface->ids];
ae781774 985 /* Release the lock we took in start() */
3e148c79 986 up_read(&ids->rw_mutex);
ae781774
MW
987}
988
989static int sysvipc_proc_show(struct seq_file *s, void *it)
990{
bc1fc6d8
EB
991 struct ipc_proc_iter *iter = s->private;
992 struct ipc_proc_iface *iface = iter->iface;
ae781774
MW
993
994 if (it == SEQ_START_TOKEN)
995 return seq_puts(s, iface->header);
996
997 return iface->show(s, it);
998}
999
1000static struct seq_operations sysvipc_proc_seqops = {
1001 .start = sysvipc_proc_start,
1002 .stop = sysvipc_proc_stop,
1003 .next = sysvipc_proc_next,
1004 .show = sysvipc_proc_show,
1005};
1006
bc1fc6d8
EB
1007static int sysvipc_proc_open(struct inode *inode, struct file *file)
1008{
ae781774
MW
1009 int ret;
1010 struct seq_file *seq;
bc1fc6d8
EB
1011 struct ipc_proc_iter *iter;
1012
1013 ret = -ENOMEM;
1014 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
1015 if (!iter)
1016 goto out;
ae781774
MW
1017
1018 ret = seq_open(file, &sysvipc_proc_seqops);
bc1fc6d8
EB
1019 if (ret)
1020 goto out_kfree;
1021
1022 seq = file->private_data;
1023 seq->private = iter;
1024
1025 iter->iface = PDE(inode)->data;
1026 iter->ns = get_ipc_ns(current->nsproxy->ipc_ns);
1027out:
ae781774 1028 return ret;
bc1fc6d8
EB
1029out_kfree:
1030 kfree(iter);
1031 goto out;
1032}
1033
1034static int sysvipc_proc_release(struct inode *inode, struct file *file)
1035{
1036 struct seq_file *seq = file->private_data;
1037 struct ipc_proc_iter *iter = seq->private;
1038 put_ipc_ns(iter->ns);
1039 return seq_release_private(inode, file);
ae781774
MW
1040}
1041
9a32144e 1042static const struct file_operations sysvipc_proc_fops = {
ae781774
MW
1043 .open = sysvipc_proc_open,
1044 .read = seq_read,
1045 .llseek = seq_lseek,
bc1fc6d8 1046 .release = sysvipc_proc_release,
ae781774
MW
1047};
1048#endif /* CONFIG_PROC_FS */