util.h 4.6 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4
/*
 * linux/ipc/util.h
 * Copyright (C) 1999 Christoph Rohland
 *
5
 * ipc helper functions (c) 1999 Manfred Spraul <manfred@colorfullife.com>
6 7
 * namespaces support.      2006 OpenVZ, SWsoft Inc.
 *                               Pavel Emelianov <xemul@openvz.org>
Linus Torvalds's avatar
Linus Torvalds committed
8 9 10 11 12
 */

#ifndef _IPC_UTIL_H
#define _IPC_UTIL_H

Nadia Derbey's avatar
Nadia Derbey committed
13
#include <linux/idr.h>
14
#include <linux/err.h>
Nadia Derbey's avatar
Nadia Derbey committed
15

Linus Torvalds's avatar
Linus Torvalds committed
16 17 18 19 20 21 22
#define USHRT_MAX 0xffff
#define SEQ_MULTIPLIER	(IPCMNI)

void sem_init (void);
void msg_init (void);
void shm_init (void);

23 24
struct ipc_namespace;

25 26 27 28 29 30 31 32
int sem_init_ns(struct ipc_namespace *ns);
int msg_init_ns(struct ipc_namespace *ns);
int shm_init_ns(struct ipc_namespace *ns);

void sem_exit_ns(struct ipc_namespace *ns);
void msg_exit_ns(struct ipc_namespace *ns);
void shm_exit_ns(struct ipc_namespace *ns);

Linus Torvalds's avatar
Linus Torvalds committed
33 34 35 36
struct ipc_ids {
	int in_use;
	unsigned short seq;
	unsigned short seq_max;
Nadia Derbey's avatar
Nadia Derbey committed
37
	struct rw_semaphore rw_mutex;
Nadia Derbey's avatar
Nadia Derbey committed
38
	struct idr ipcs_idr;
Linus Torvalds's avatar
Linus Torvalds committed
39 40
};

Nadia Derbey's avatar
Nadia Derbey committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
/*
 * Structure that holds the parameters needed by the ipc operations
 * (see after)
 */
struct ipc_params {
	key_t key;
	int flg;
	union {
		size_t size;	/* for shared memories */
		int nsems;	/* for semaphores */
	} u;			/* holds the getnew() specific param */
};

/*
 * Structure that holds some ipc operations. This structure is used to unify
 * the calls to sys_msgget(), sys_semget(), sys_shmget()
 *      . routine to call to create a new ipc object. Can be one of newque,
 *        newary, newseg
Nadia Derbey's avatar
Nadia Derbey committed
59
 *      . routine to call to check permissions for a new ipc object.
Nadia Derbey's avatar
Nadia Derbey committed
60 61 62 63 64 65
 *        Can be one of security_msg_associate, security_sem_associate,
 *        security_shm_associate
 *      . routine to call for an extra check if needed
 */
struct ipc_ops {
	int (*getnew) (struct ipc_namespace *, struct ipc_params *);
Nadia Derbey's avatar
Nadia Derbey committed
66 67
	int (*associate) (struct kern_ipc_perm *, int);
	int (*more_checks) (struct kern_ipc_perm *, struct ipc_params *);
Nadia Derbey's avatar
Nadia Derbey committed
68 69
};

70
struct seq_file;
71

Nadia Derbey's avatar
Nadia Derbey committed
72
void ipc_init_ids(struct ipc_ids *);
73 74
#ifdef CONFIG_PROC_FS
void __init ipc_init_proc_interface(const char *path, const char *header,
75
		int ids, int (*show)(struct seq_file *, void *));
76 77 78
#else
#define ipc_init_proc_interface(path, header, ids, show) do {} while (0)
#endif
Linus Torvalds's avatar
Linus Torvalds committed
79

80 81 82 83
#define IPC_SEM_IDS	0
#define IPC_MSG_IDS	1
#define IPC_SHM_IDS	2

84 85
#define ipcid_to_idx(id) ((id) % SEQ_MULTIPLIER)

Nadia Derbey's avatar
Nadia Derbey committed
86
/* must be called with ids->rw_mutex acquired for writing */
Nadia Derbey's avatar
Nadia Derbey committed
87
int ipc_addid(struct ipc_ids *, struct kern_ipc_perm *, int);
Nadia Derbey's avatar
Nadia Derbey committed
88 89

/* must be called with ids->rw_mutex acquired for reading */
Nadia Derbey's avatar
Nadia Derbey committed
90
int ipc_get_maxid(struct ipc_ids *);
Linus Torvalds's avatar
Linus Torvalds committed
91 92

/* must be called with both locks acquired. */
Nadia Derbey's avatar
Nadia Derbey committed
93
void ipc_rmid(struct ipc_ids *, struct kern_ipc_perm *);
Linus Torvalds's avatar
Linus Torvalds committed
94

Nadia Derbey's avatar
Nadia Derbey committed
95 96
/* must be called with ipcp locked */
int ipcperms(struct kern_ipc_perm *ipcp, short flg);
Linus Torvalds's avatar
Linus Torvalds committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113

/* for rare, potentially huge allocations.
 * both function can sleep
 */
void* ipc_alloc(int size);
void ipc_free(void* ptr, int size);

/*
 * For allocation that need to be freed by RCU.
 * Objects are reference counted, they start with reference count 1.
 * getref increases the refcount, the putref call that reduces the recount
 * to 0 schedules the rcu destruction. Caller must guarantee locking.
 */
void* ipc_rcu_alloc(int size);
void ipc_rcu_getref(void *ptr);
void ipc_rcu_putref(void *ptr);

Nadia Derbey's avatar
Nadia Derbey committed
114 115 116 117 118
/*
 * ipc_lock_down: called with rw_mutex held
 * ipc_lock: called without that lock held
 */
struct kern_ipc_perm *ipc_lock_down(struct ipc_ids *, int);
119
struct kern_ipc_perm *ipc_lock(struct ipc_ids *, int);
Linus Torvalds's avatar
Linus Torvalds committed
120 121 122 123

void kernel_to_ipc64_perm(struct kern_ipc_perm *in, struct ipc64_perm *out);
void ipc64_perm_to_ipc_perm(struct ipc64_perm *in, struct ipc_perm *out);

124
#if defined(__ia64__) || defined(__x86_64__) || defined(__hppa__) || defined(__XTENSA__)
Linus Torvalds's avatar
Linus Torvalds committed
125 126 127 128 129 130 131 132 133
  /* On IA-64, we always use the "64-bit version" of the IPC structures.  */ 
# define ipc_parse_version(cmd)	IPC_64
#else
int ipc_parse_version (int *cmd);
#endif

extern void free_msg(struct msg_msg *msg);
extern struct msg_msg *load_msg(const void __user *src, int len);
extern int store_msg(void __user *dest, struct msg_msg *msg, int len);
Nadia Derbey's avatar
Nadia Derbey committed
134

Nadia Derbey's avatar
Nadia Derbey committed
135
static inline int ipc_buildid(int id, int seq)
Nadia Derbey's avatar
Nadia Derbey committed
136 137 138 139
{
	return SEQ_MULTIPLIER * seq + id;
}

Nadia Derbey's avatar
Nadia Derbey committed
140 141 142
/*
 * Must be called with ipcp locked
 */
Nadia Derbey's avatar
Nadia Derbey committed
143
static inline int ipc_checkid(struct kern_ipc_perm *ipcp, int uid)
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
{
	if (uid / SEQ_MULTIPLIER != ipcp->seq)
		return 1;
	return 0;
}

static inline void ipc_lock_by_ptr(struct kern_ipc_perm *perm)
{
	rcu_read_lock();
	spin_lock(&perm->lock);
}

static inline void ipc_unlock(struct kern_ipc_perm *perm)
{
	spin_unlock(&perm->lock);
	rcu_read_unlock();
}

162 163 164 165
struct kern_ipc_perm *ipc_lock_check_down(struct ipc_ids *ids, int id);
struct kern_ipc_perm *ipc_lock_check(struct ipc_ids *ids, int id);
int ipcget(struct ipc_namespace *ns, struct ipc_ids *ids,
			struct ipc_ops *ops, struct ipc_params *params);
Linus Torvalds's avatar
Linus Torvalds committed
166 167

#endif