drivers: power: report battery voltage in AOSP compatible format
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / ipc / util.h
CommitLineData
1da177e4
LT
1/*
2 * linux/ipc/util.h
3 * Copyright (C) 1999 Christoph Rohland
4 *
624dffcb 5 * ipc helper functions (c) 1999 Manfred Spraul <manfred@colorfullife.com>
73ea4130
KK
6 * namespaces support. 2006 OpenVZ, SWsoft Inc.
7 * Pavel Emelianov <xemul@openvz.org>
1da177e4
LT
8 */
9
10#ifndef _IPC_UTIL_H
11#define _IPC_UTIL_H
12
232086b1 13#include <linux/unistd.h>
023a5355 14#include <linux/err.h>
7ca7e564 15
1da177e4
LT
16#define SEQ_MULTIPLIER (IPCMNI)
17
18void sem_init (void);
19void msg_init (void);
20void shm_init (void);
21
ae5e1b22
PE
22struct ipc_namespace;
23
614b84cf 24#ifdef CONFIG_POSIX_MQUEUE
7eafd7c7
SH
25extern void mq_clear_sbinfo(struct ipc_namespace *ns);
26extern void mq_put_mnt(struct ipc_namespace *ns);
614b84cf 27#else
7eafd7c7
SH
28static inline void mq_clear_sbinfo(struct ipc_namespace *ns) { }
29static inline void mq_put_mnt(struct ipc_namespace *ns) { }
614b84cf
SH
30#endif
31
32#ifdef CONFIG_SYSVIPC
ed2ddbf8
PP
33void sem_init_ns(struct ipc_namespace *ns);
34void msg_init_ns(struct ipc_namespace *ns);
35void shm_init_ns(struct ipc_namespace *ns);
73ea4130
KK
36
37void sem_exit_ns(struct ipc_namespace *ns);
38void msg_exit_ns(struct ipc_namespace *ns);
39void shm_exit_ns(struct ipc_namespace *ns);
614b84cf
SH
40#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
73ea4130 49
e84ca333
DB
50struct ipc_rcu {
51 struct rcu_head rcu;
52 atomic_t refcount;
53} ____cacheline_aligned_in_smp;
54
55#define ipc_rcu_to_struct(p) ((void *)(p+1))
56
7748dbfa
ND
57/*
58 * Structure that holds the parameters needed by the ipc operations
59 * (see after)
60 */
61struct ipc_params {
62 key_t key;
63 int flg;
64 union {
65 size_t size; /* for shared memories */
66 int nsems; /* for semaphores */
67 } u; /* holds the getnew() specific param */
68};
69
70/*
71 * Structure that holds some ipc operations. This structure is used to unify
72 * the calls to sys_msgget(), sys_semget(), sys_shmget()
73 * . routine to call to create a new ipc object. Can be one of newque,
74 * newary, newseg
f4566f04 75 * . routine to call to check permissions for a new ipc object.
7748dbfa
ND
76 * Can be one of security_msg_associate, security_sem_associate,
77 * security_shm_associate
78 * . routine to call for an extra check if needed
79 */
80struct ipc_ops {
81 int (*getnew) (struct ipc_namespace *, struct ipc_params *);
03f02c76
ND
82 int (*associate) (struct kern_ipc_perm *, int);
83 int (*more_checks) (struct kern_ipc_perm *, struct ipc_params *);
7748dbfa
ND
84};
85
ae781774 86struct seq_file;
ed2ddbf8 87struct ipc_ids;
7d69a1f4 88
7ca7e564 89void ipc_init_ids(struct ipc_ids *);
ae781774
MW
90#ifdef CONFIG_PROC_FS
91void __init ipc_init_proc_interface(const char *path, const char *header,
73ea4130 92 int ids, int (*show)(struct seq_file *, void *));
ae781774
MW
93#else
94#define ipc_init_proc_interface(path, header, ids, show) do {} while (0)
95#endif
1da177e4 96
73ea4130
KK
97#define IPC_SEM_IDS 0
98#define IPC_MSG_IDS 1
99#define IPC_SHM_IDS 2
100
ce621f5b 101#define ipcid_to_idx(id) ((id) % SEQ_MULTIPLIER)
03f59566 102#define ipcid_to_seqx(id) ((id) / SEQ_MULTIPLIER)
ce621f5b 103
33b74669 104/* must be called with ids->rwsem acquired for writing */
7ca7e564 105int ipc_addid(struct ipc_ids *, struct kern_ipc_perm *, int);
3e148c79 106
33b74669 107/* must be called with ids->rwsem acquired for reading */
7ca7e564 108int ipc_get_maxid(struct ipc_ids *);
1da177e4
LT
109
110/* must be called with both locks acquired. */
7ca7e564 111void ipc_rmid(struct ipc_ids *, struct kern_ipc_perm *);
1da177e4 112
f4566f04 113/* must be called with ipcp locked */
b0e77598 114int ipcperms(struct ipc_namespace *ns, struct kern_ipc_perm *ipcp, short flg);
1da177e4
LT
115
116/* for rare, potentially huge allocations.
117 * both function can sleep
118 */
119void* ipc_alloc(int size);
120void ipc_free(void* ptr, int size);
121
122/*
123 * For allocation that need to be freed by RCU.
124 * Objects are reference counted, they start with reference count 1.
125 * getref increases the refcount, the putref call that reduces the recount
126 * to 0 schedules the rcu destruction. Caller must guarantee locking.
127 */
128void* ipc_rcu_alloc(int size);
6062a8dc 129int ipc_rcu_getref(void *ptr);
e84ca333
DB
130void ipc_rcu_putref(void *ptr, void (*func)(struct rcu_head *head));
131void ipc_rcu_free(struct rcu_head *head);
1da177e4 132
023a5355 133struct kern_ipc_perm *ipc_lock(struct ipc_ids *, int);
4d2bff5e 134struct kern_ipc_perm *ipc_obtain_object(struct ipc_ids *ids, int id);
1da177e4
LT
135
136void kernel_to_ipc64_perm(struct kern_ipc_perm *in, struct ipc64_perm *out);
137void ipc64_perm_to_ipc_perm(struct ipc64_perm *in, struct ipc_perm *out);
1efdb69b 138int ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out);
444d0f62
DB
139struct kern_ipc_perm *ipcctl_pre_down_nolock(struct ipc_namespace *ns,
140 struct ipc_ids *ids, int id, int cmd,
141 struct ipc64_perm *perm, int extra_perm);
1da177e4 142
c1d7e01d 143#ifndef CONFIG_ARCH_WANT_IPC_PARSE_VERSION
1da177e4
LT
144 /* On IA-64, we always use the "64-bit version" of the IPC structures. */
145# define ipc_parse_version(cmd) IPC_64
146#else
147int ipc_parse_version (int *cmd);
148#endif
149
150extern void free_msg(struct msg_msg *msg);
4b825b95 151extern struct msg_msg *load_msg(const void __user *src, size_t len);
4a674f34 152extern struct msg_msg *copy_msg(struct msg_msg *src, struct msg_msg *dst);
4b825b95 153extern int store_msg(void __user *dest, struct msg_msg *msg, size_t len);
7748dbfa 154
b6b337ad
ND
155extern void recompute_msgmni(struct ipc_namespace *);
156
1b531f21 157static inline int ipc_buildid(int id, int seq)
28028313
ND
158{
159 return SEQ_MULTIPLIER * seq + id;
160}
161
1b531f21 162static inline int ipc_checkid(struct kern_ipc_perm *ipcp, int uid)
023a5355 163{
7bb4deff 164 return uid / SEQ_MULTIPLIER != ipcp->seq;
023a5355
ND
165}
166
9f7b399c 167static inline void ipc_lock_object(struct kern_ipc_perm *perm)
023a5355 168{
023a5355
ND
169 spin_lock(&perm->lock);
170}
171
9f7b399c 172static inline void ipc_unlock_object(struct kern_ipc_perm *perm)
023a5355
ND
173{
174 spin_unlock(&perm->lock);
023a5355
ND
175}
176
9f7b399c 177static inline void ipc_assert_locked_object(struct kern_ipc_perm *perm)
16df3674 178{
9f7b399c
DB
179 assert_spin_locked(&perm->lock);
180}
181
9f7b399c
DB
182static inline void ipc_unlock(struct kern_ipc_perm *perm)
183{
115d40db 184 ipc_unlock_object(perm);
9f7b399c
DB
185 rcu_read_unlock();
186}
187
4d2bff5e 188struct kern_ipc_perm *ipc_obtain_object_check(struct ipc_ids *ids, int id);
b2d75cdd
PE
189int ipcget(struct ipc_namespace *ns, struct ipc_ids *ids,
190 struct ipc_ops *ops, struct ipc_params *params);
665c7741
AD
191void free_ipcs(struct ipc_namespace *ns, struct ipc_ids *ids,
192 void (*free)(struct ipc_namespace *, struct kern_ipc_perm *));
1da177e4 193#endif