blob: 850ef3e962cb36a13b2cdcd560f6bbccb8fcb489 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/ipc/util.h
3 * Copyright (C) 1999 Christoph Rohland
4 *
Christian Kujau624dffc2006-01-15 02:43:54 +01005 * ipc helper functions (c) 1999 Manfred Spraul <manfred@colorfullife.com>
Kirill Korotaev73ea4132006-10-02 02:18:20 -07006 * namespaces support. 2006 OpenVZ, SWsoft Inc.
7 * Pavel Emelianov <xemul@openvz.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 */
9
10#ifndef _IPC_UTIL_H
11#define _IPC_UTIL_H
12
Johannes Weiner232086b2009-06-20 02:23:29 +020013#include <linux/unistd.h>
Nadia Derbey023a5352007-10-18 23:40:51 -070014#include <linux/err.h>
Nadia Derbey7ca7e562007-10-18 23:40:48 -070015
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#define SEQ_MULTIPLIER (IPCMNI)
17
18void sem_init (void);
19void msg_init (void);
20void shm_init (void);
21
Pavel Emelyanovae5e1b22008-02-08 04:18:22 -080022struct ipc_namespace;
23
Serge E. Hallyn614b84c2009-04-06 19:01:08 -070024#ifdef CONFIG_POSIX_MQUEUE
Serge E. Hallyn7eafd7c2009-04-06 19:01:10 -070025extern void mq_clear_sbinfo(struct ipc_namespace *ns);
26extern void mq_put_mnt(struct ipc_namespace *ns);
Serge E. Hallyn614b84c2009-04-06 19:01:08 -070027#else
Serge E. Hallyn7eafd7c2009-04-06 19:01:10 -070028static inline void mq_clear_sbinfo(struct ipc_namespace *ns) { }
29static inline void mq_put_mnt(struct ipc_namespace *ns) { }
Serge E. Hallyn614b84c2009-04-06 19:01:08 -070030#endif
31
32#ifdef CONFIG_SYSVIPC
Pierre Peiffered2ddbf2008-02-08 04:18:57 -080033void sem_init_ns(struct ipc_namespace *ns);
34void msg_init_ns(struct ipc_namespace *ns);
35void shm_init_ns(struct ipc_namespace *ns);
Kirill Korotaev73ea4132006-10-02 02:18:20 -070036
37void sem_exit_ns(struct ipc_namespace *ns);
38void msg_exit_ns(struct ipc_namespace *ns);
39void shm_exit_ns(struct ipc_namespace *ns);
Serge E. Hallyn614b84c2009-04-06 19:01:08 -070040#else
41static inline void sem_init_ns(struct ipc_namespace *ns) { }
42static inline void msg_init_ns(struct ipc_namespace *ns) { }
43static inline void shm_init_ns(struct ipc_namespace *ns) { }
44
45static inline void sem_exit_ns(struct ipc_namespace *ns) { }
46static inline void msg_exit_ns(struct ipc_namespace *ns) { }
47static inline void shm_exit_ns(struct ipc_namespace *ns) { }
48#endif
Kirill Korotaev73ea4132006-10-02 02:18:20 -070049
Nadia Derbey7748dbf2007-10-18 23:40:49 -070050/*
51 * Structure that holds the parameters needed by the ipc operations
52 * (see after)
53 */
54struct ipc_params {
55 key_t key;
56 int flg;
57 union {
58 size_t size; /* for shared memories */
59 int nsems; /* for semaphores */
60 } u; /* holds the getnew() specific param */
61};
62
63/*
64 * Structure that holds some ipc operations. This structure is used to unify
65 * the calls to sys_msgget(), sys_semget(), sys_shmget()
66 * . routine to call to create a new ipc object. Can be one of newque,
67 * newary, newseg
Nadia Derbeyf4566f02007-10-18 23:40:53 -070068 * . routine to call to check permissions for a new ipc object.
Nadia Derbey7748dbf2007-10-18 23:40:49 -070069 * Can be one of security_msg_associate, security_sem_associate,
70 * security_shm_associate
71 * . routine to call for an extra check if needed
72 */
73struct ipc_ops {
74 int (*getnew) (struct ipc_namespace *, struct ipc_params *);
Nadia Derbey03f02c72007-10-18 23:40:51 -070075 int (*associate) (struct kern_ipc_perm *, int);
76 int (*more_checks) (struct kern_ipc_perm *, struct ipc_params *);
Nadia Derbey7748dbf2007-10-18 23:40:49 -070077};
78
Mike Waychisonae781772005-09-06 15:17:09 -070079struct seq_file;
Pierre Peiffered2ddbf2008-02-08 04:18:57 -080080struct ipc_ids;
Cedric Le Goater7d69a1f2007-07-15 23:40:58 -070081
Nadia Derbey7ca7e562007-10-18 23:40:48 -070082void ipc_init_ids(struct ipc_ids *);
Mike Waychisonae781772005-09-06 15:17:09 -070083#ifdef CONFIG_PROC_FS
84void __init ipc_init_proc_interface(const char *path, const char *header,
Kirill Korotaev73ea4132006-10-02 02:18:20 -070085 int ids, int (*show)(struct seq_file *, void *));
Mike Waychisonae781772005-09-06 15:17:09 -070086#else
87#define ipc_init_proc_interface(path, header, ids, show) do {} while (0)
88#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Kirill Korotaev73ea4132006-10-02 02:18:20 -070090#define IPC_SEM_IDS 0
91#define IPC_MSG_IDS 1
92#define IPC_SHM_IDS 2
93
Nadia Derbeyce621f52007-10-18 23:40:52 -070094#define ipcid_to_idx(id) ((id) % SEQ_MULTIPLIER)
95
Nadia Derbey3e148c72007-10-18 23:40:54 -070096/* must be called with ids->rw_mutex acquired for writing */
Nadia Derbey7ca7e562007-10-18 23:40:48 -070097int ipc_addid(struct ipc_ids *, struct kern_ipc_perm *, int);
Nadia Derbey3e148c72007-10-18 23:40:54 -070098
99/* must be called with ids->rw_mutex acquired for reading */
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700100int ipc_get_maxid(struct ipc_ids *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102/* must be called with both locks acquired. */
Nadia Derbey7ca7e562007-10-18 23:40:48 -0700103void ipc_rmid(struct ipc_ids *, struct kern_ipc_perm *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Nadia Derbeyf4566f02007-10-18 23:40:53 -0700105/* must be called with ipcp locked */
Serge E. Hallynb0e77592011-03-23 16:43:24 -0700106int ipcperms(struct ipc_namespace *ns, struct kern_ipc_perm *ipcp, short flg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108/* for rare, potentially huge allocations.
109 * both function can sleep
110 */
111void* ipc_alloc(int size);
112void ipc_free(void* ptr, int size);
113
114/*
115 * For allocation that need to be freed by RCU.
116 * Objects are reference counted, they start with reference count 1.
117 * getref increases the refcount, the putref call that reduces the recount
118 * to 0 schedules the rcu destruction. Caller must guarantee locking.
119 */
120void* ipc_rcu_alloc(int size);
121void ipc_rcu_getref(void *ptr);
122void ipc_rcu_putref(void *ptr);
123
Nadia Derbey023a5352007-10-18 23:40:51 -0700124struct kern_ipc_perm *ipc_lock(struct ipc_ids *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126void kernel_to_ipc64_perm(struct kern_ipc_perm *in, struct ipc64_perm *out);
127void ipc64_perm_to_ipc_perm(struct ipc64_perm *in, struct ipc_perm *out);
Pierre Peiffer8f4a3802008-04-29 01:00:51 -0700128void ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out);
Serge E. Hallynb0e77592011-03-23 16:43:24 -0700129struct kern_ipc_perm *ipcctl_pre_down(struct ipc_namespace *ns,
130 struct ipc_ids *ids, int id, int cmd,
Pierre Peiffera5f75e72008-04-29 01:00:54 -0700131 struct ipc64_perm *perm, int extra_perm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Will Deaconc1d7e012012-07-30 14:42:46 -0700133#ifndef CONFIG_ARCH_WANT_IPC_PARSE_VERSION
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 /* On IA-64, we always use the "64-bit version" of the IPC structures. */
135# define ipc_parse_version(cmd) IPC_64
136#else
137int ipc_parse_version (int *cmd);
138#endif
139
140extern void free_msg(struct msg_msg *msg);
141extern struct msg_msg *load_msg(const void __user *src, int len);
142extern int store_msg(void __user *dest, struct msg_msg *msg, int len);
Nadia Derbey7748dbf2007-10-18 23:40:49 -0700143
Nadia Derbeyb6b337a2008-04-29 01:00:42 -0700144extern void recompute_msgmni(struct ipc_namespace *);
145
Nadia Derbey1b531f22007-10-18 23:40:55 -0700146static inline int ipc_buildid(int id, int seq)
Nadia Derbey28028312007-10-18 23:40:52 -0700147{
148 return SEQ_MULTIPLIER * seq + id;
149}
150
Nadia Derbeyf4566f02007-10-18 23:40:53 -0700151/*
152 * Must be called with ipcp locked
153 */
Nadia Derbey1b531f22007-10-18 23:40:55 -0700154static inline int ipc_checkid(struct kern_ipc_perm *ipcp, int uid)
Nadia Derbey023a5352007-10-18 23:40:51 -0700155{
156 if (uid / SEQ_MULTIPLIER != ipcp->seq)
157 return 1;
158 return 0;
159}
160
161static inline void ipc_lock_by_ptr(struct kern_ipc_perm *perm)
162{
163 rcu_read_lock();
164 spin_lock(&perm->lock);
165}
166
167static inline void ipc_unlock(struct kern_ipc_perm *perm)
168{
169 spin_unlock(&perm->lock);
170 rcu_read_unlock();
171}
172
Pavel Emelyanovb2d75cd2008-02-08 04:18:54 -0800173struct kern_ipc_perm *ipc_lock_check(struct ipc_ids *ids, int id);
174int ipcget(struct ipc_namespace *ns, struct ipc_ids *ids,
175 struct ipc_ops *ops, struct ipc_params *params);
Alexey Dobriyan665c7742009-06-17 16:27:57 -0700176void free_ipcs(struct ipc_namespace *ns, struct ipc_ids *ids,
177 void (*free)(struct ipc_namespace *, struct kern_ipc_perm *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178#endif