Merge branch 'cpufreq/arm/linux-next' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-block.git] / include / linux / ceph / libceph.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
3d14c5d2
YS
2#ifndef _FS_CEPH_LIBCEPH_H
3#define _FS_CEPH_LIBCEPH_H
4
a1ce3928 5#include <linux/ceph/ceph_debug.h>
3d14c5d2
YS
6
7#include <asm/unaligned.h>
8#include <linux/backing-dev.h>
9#include <linux/completion.h>
10#include <linux/exportfs.h>
187f1882 11#include <linux/bug.h>
3d14c5d2
YS
12#include <linux/fs.h>
13#include <linux/mempool.h>
14#include <linux/pagemap.h>
15#include <linux/wait.h>
16#include <linux/writeback.h>
17#include <linux/slab.h>
06dfa963 18#include <linux/refcount.h>
3d14c5d2 19
a1ce3928
DH
20#include <linux/ceph/types.h>
21#include <linux/ceph/messenger.h>
22#include <linux/ceph/msgpool.h>
23#include <linux/ceph/mon_client.h>
24#include <linux/ceph/osd_client.h>
25#include <linux/ceph/ceph_fs.h>
51e92737 26#include <linux/ceph/string_table.h>
3d14c5d2 27
3d14c5d2
YS
28/*
29 * mount options
30 */
31#define CEPH_OPT_FSID (1<<0)
32#define CEPH_OPT_NOSHARE (1<<1) /* don't share client with other sbs */
33#define CEPH_OPT_MYIP (1<<2) /* specified my ip */
34#define CEPH_OPT_NOCRC (1<<3) /* no data crc on writes */
a51983e4 35#define CEPH_OPT_NOMSGAUTH (1<<4) /* don't require msg signing feat */
ba988f87 36#define CEPH_OPT_TCP_NODELAY (1<<5) /* TCP_NODELAY on TCP sockets */
a51983e4 37#define CEPH_OPT_NOMSGSIGN (1<<6) /* don't sign msgs */
02b2f549 38#define CEPH_OPT_ABORT_ON_FULL (1<<7) /* abort w/ ENOSPC when full */
3d14c5d2 39
ba988f87 40#define CEPH_OPT_DEFAULT (CEPH_OPT_TCP_NODELAY)
3d14c5d2
YS
41
42#define ceph_set_opt(client, opt) \
43 (client)->options->flags |= CEPH_OPT_##opt;
44#define ceph_test_opt(client, opt) \
45 (!!((client)->options->flags & CEPH_OPT_##opt))
46
47struct ceph_options {
48 int flags;
49 struct ceph_fsid fsid;
50 struct ceph_entity_addr my_addr;
a319bf56
ID
51 unsigned long mount_timeout; /* jiffies */
52 unsigned long osd_idle_ttl; /* jiffies */
53 unsigned long osd_keepalive_timeout; /* jiffies */
7cc5e38f 54 unsigned long osd_request_timeout; /* jiffies */
3d14c5d2
YS
55
56 /*
02b2f549 57 * any type that can't be simply compared or doesn't need
3d14c5d2
YS
58 * to be compared should go beyond this point,
59 * ceph_compare_options() should be updated accordingly
60 */
61
62 struct ceph_entity_addr *mon_addr; /* should be the first
63 pointer type of args */
64 int num_mon;
65 char *name;
8323c3aa 66 struct ceph_crypto_key *key;
3d14c5d2
YS
67};
68
69/*
70 * defaults
71 */
a319bf56
ID
72#define CEPH_MOUNT_TIMEOUT_DEFAULT msecs_to_jiffies(60 * 1000)
73#define CEPH_OSD_KEEPALIVE_DEFAULT msecs_to_jiffies(5 * 1000)
74#define CEPH_OSD_IDLE_TTL_DEFAULT msecs_to_jiffies(60 * 1000)
7cc5e38f 75#define CEPH_OSD_REQUEST_TIMEOUT_DEFAULT 0 /* no timeout */
58d81b12 76
168b9090 77#define CEPH_MONC_HUNT_INTERVAL msecs_to_jiffies(3 * 1000)
58d81b12
ID
78#define CEPH_MONC_PING_INTERVAL msecs_to_jiffies(10 * 1000)
79#define CEPH_MONC_PING_TIMEOUT msecs_to_jiffies(30 * 1000)
168b9090
ID
80#define CEPH_MONC_HUNT_BACKOFF 2
81#define CEPH_MONC_HUNT_MAX_MULT 10
3d14c5d2
YS
82
83#define CEPH_MSG_MAX_FRONT_LEN (16*1024*1024)
7b11ba37 84#define CEPH_MSG_MAX_MIDDLE_LEN (16*1024*1024)
94e6992b
ID
85
86/*
87 * Handle the largest possible rbd object in one message.
88 * There is no limit on the size of cephfs objects, but it has to obey
89 * rsize and wsize mount options anyway.
90 */
91#define CEPH_MSG_MAX_DATA_LEN (32*1024*1024)
3d14c5d2
YS
92
93#define CEPH_AUTH_NAME_DEFAULT "guest"
94
3d14c5d2
YS
95/* mount state */
96enum {
97 CEPH_MOUNT_MOUNTING,
98 CEPH_MOUNT_MOUNTED,
99 CEPH_MOUNT_UNMOUNTING,
100 CEPH_MOUNT_UNMOUNTED,
101 CEPH_MOUNT_SHUTDOWN,
102};
103
a319bf56
ID
104static inline unsigned long ceph_timeout_jiffies(unsigned long timeout)
105{
106 return timeout ?: MAX_SCHEDULE_TIMEOUT;
107}
108
3d14c5d2
YS
109struct ceph_mds_client;
110
111/*
112 * per client state
113 *
114 * possibly shared by multiple mount points, if they are
115 * mounting the same ceph filesystem/cluster.
116 */
117struct ceph_client {
118 struct ceph_fsid fsid;
119 bool have_fsid;
120
121 void *private;
122
123 struct ceph_options *options;
124
125 struct mutex mount_mutex; /* serialize mount attempts */
126 wait_queue_head_t auth_wq;
127 int auth_err;
128
129 int (*extra_mon_dispatch)(struct ceph_client *, struct ceph_msg *);
130
12b4629a
ID
131 u64 supported_features;
132 u64 required_features;
3d14c5d2 133
15d9882c 134 struct ceph_messenger msgr; /* messenger instance */
3d14c5d2
YS
135 struct ceph_mon_client monc;
136 struct ceph_osd_client osdc;
137
138#ifdef CONFIG_DEBUG_FS
139 struct dentry *debugfs_dir;
140 struct dentry *debugfs_monmap;
141 struct dentry *debugfs_osdmap;
5cf7bd30 142 struct dentry *debugfs_options;
3d14c5d2
YS
143#endif
144};
145
859bff51 146#define from_msgr(ms) container_of(ms, struct ceph_client, msgr)
3d14c5d2
YS
147
148
149/*
150 * snapshots
151 */
152
153/*
154 * A "snap context" is the set of existing snapshots when we
155 * write data. It is used by the OSD to guide its COW behavior.
156 *
157 * The ceph_snap_context is refcounted, and attached to each dirty
158 * page, indicating which context the dirty data belonged when it was
159 * dirtied.
160 */
161struct ceph_snap_context {
06dfa963 162 refcount_t nref;
3d14c5d2 163 u64 seq;
aa711ee3 164 u32 num_snaps;
3d14c5d2
YS
165 u64 snaps[];
166};
167
4f0dcb10
AE
168extern struct ceph_snap_context *ceph_create_snap_context(u32 snap_count,
169 gfp_t gfp_flags);
170extern struct ceph_snap_context *ceph_get_snap_context(
171 struct ceph_snap_context *sc);
172extern void ceph_put_snap_context(struct ceph_snap_context *sc);
3d14c5d2
YS
173
174/*
175 * calculate the number of pages a given length and offset map onto,
176 * if we align the data.
177 */
178static inline int calc_pages_for(u64 off, u64 len)
179{
09cbfeaf
KS
180 return ((off+len+PAGE_SIZE-1) >> PAGE_SHIFT) -
181 (off >> PAGE_SHIFT);
3d14c5d2
YS
182}
183
76f827a7
ID
184#define RB_BYVAL(a) (a)
185#define RB_BYPTR(a) (&(a))
186#define RB_CMP3WAY(a, b) ((a) < (b) ? -1 : (a) > (b))
187
188#define DEFINE_RB_INSDEL_FUNCS2(name, type, keyfld, cmpexp, keyexp, nodefld) \
fcd00b68
ID
189static void insert_##name(struct rb_root *root, type *t) \
190{ \
191 struct rb_node **n = &root->rb_node; \
192 struct rb_node *parent = NULL; \
193 \
194 BUG_ON(!RB_EMPTY_NODE(&t->nodefld)); \
195 \
196 while (*n) { \
197 type *cur = rb_entry(*n, type, nodefld); \
76f827a7 198 int cmp; \
fcd00b68
ID
199 \
200 parent = *n; \
76f827a7
ID
201 cmp = cmpexp(keyexp(t->keyfld), keyexp(cur->keyfld)); \
202 if (cmp < 0) \
fcd00b68 203 n = &(*n)->rb_left; \
76f827a7 204 else if (cmp > 0) \
fcd00b68
ID
205 n = &(*n)->rb_right; \
206 else \
207 BUG(); \
208 } \
209 \
210 rb_link_node(&t->nodefld, parent, n); \
211 rb_insert_color(&t->nodefld, root); \
212} \
213static void erase_##name(struct rb_root *root, type *t) \
214{ \
215 BUG_ON(RB_EMPTY_NODE(&t->nodefld)); \
216 rb_erase(&t->nodefld, root); \
217 RB_CLEAR_NODE(&t->nodefld); \
218}
219
76f827a7
ID
220/*
221 * @lookup_param_type is a parameter and not constructed from (@type,
222 * @keyfld) with typeof() because adding const is too unwieldy.
223 */
224#define DEFINE_RB_LOOKUP_FUNC2(name, type, keyfld, cmpexp, keyexp, \
225 lookup_param_type, nodefld) \
226static type *lookup_##name(struct rb_root *root, lookup_param_type key) \
fcd00b68
ID
227{ \
228 struct rb_node *n = root->rb_node; \
229 \
230 while (n) { \
231 type *cur = rb_entry(n, type, nodefld); \
76f827a7 232 int cmp; \
fcd00b68 233 \
76f827a7
ID
234 cmp = cmpexp(key, keyexp(cur->keyfld)); \
235 if (cmp < 0) \
fcd00b68 236 n = n->rb_left; \
76f827a7 237 else if (cmp > 0) \
fcd00b68
ID
238 n = n->rb_right; \
239 else \
240 return cur; \
241 } \
242 \
243 return NULL; \
244}
245
76f827a7
ID
246#define DEFINE_RB_FUNCS2(name, type, keyfld, cmpexp, keyexp, \
247 lookup_param_type, nodefld) \
248DEFINE_RB_INSDEL_FUNCS2(name, type, keyfld, cmpexp, keyexp, nodefld) \
249DEFINE_RB_LOOKUP_FUNC2(name, type, keyfld, cmpexp, keyexp, \
250 lookup_param_type, nodefld)
251
252/*
253 * Shorthands for integer keys.
254 */
255#define DEFINE_RB_INSDEL_FUNCS(name, type, keyfld, nodefld) \
256DEFINE_RB_INSDEL_FUNCS2(name, type, keyfld, RB_CMP3WAY, RB_BYVAL, nodefld)
257
258#define DEFINE_RB_LOOKUP_FUNC(name, type, keyfld, nodefld) \
259extern type __lookup_##name##_key; \
260DEFINE_RB_LOOKUP_FUNC2(name, type, keyfld, RB_CMP3WAY, RB_BYVAL, \
261 typeof(__lookup_##name##_key.keyfld), nodefld)
262
fcd00b68
ID
263#define DEFINE_RB_FUNCS(name, type, keyfld, nodefld) \
264DEFINE_RB_INSDEL_FUNCS(name, type, keyfld, nodefld) \
265DEFINE_RB_LOOKUP_FUNC(name, type, keyfld, nodefld)
266
eeb0bed5
ID
267extern struct kmem_cache *ceph_inode_cachep;
268extern struct kmem_cache *ceph_cap_cachep;
f66fd9f0 269extern struct kmem_cache *ceph_cap_flush_cachep;
eeb0bed5
ID
270extern struct kmem_cache *ceph_dentry_cachep;
271extern struct kmem_cache *ceph_file_cachep;
bb48bd4d 272extern struct kmem_cache *ceph_dir_file_cachep;
eeb0bed5 273
3d14c5d2 274/* ceph_common.c */
72fe25e3
AE
275extern bool libceph_compatible(void *data);
276
3d14c5d2
YS
277extern const char *ceph_msg_type_name(int type);
278extern int ceph_check_fsid(struct ceph_client *client, struct ceph_fsid *fsid);
eeb0bed5 279extern void *ceph_kvmalloc(size_t size, gfp_t flags);
3d14c5d2 280
ee57741c 281extern struct ceph_options *ceph_parse_options(char *options,
3d14c5d2
YS
282 const char *dev_name, const char *dev_name_end,
283 int (*parse_extra_token)(char *c, void *private),
284 void *private);
02b2f549
DY
285int ceph_print_client_options(struct seq_file *m, struct ceph_client *client,
286 bool show_all);
3d14c5d2
YS
287extern void ceph_destroy_options(struct ceph_options *opt);
288extern int ceph_compare_options(struct ceph_options *new_opt,
289 struct ceph_client *client);
74da4a0f 290struct ceph_client *ceph_create_client(struct ceph_options *opt, void *private);
005a07bf 291struct ceph_entity_addr *ceph_client_addr(struct ceph_client *client);
033268a5 292u64 ceph_client_gid(struct ceph_client *client);
3d14c5d2
YS
293extern void ceph_destroy_client(struct ceph_client *client);
294extern int __ceph_open_session(struct ceph_client *client,
295 unsigned long started);
296extern int ceph_open_session(struct ceph_client *client);
297
298/* pagevec.c */
299extern void ceph_release_page_vector(struct page **pages, int num_pages);
300
b324814e 301extern struct page **ceph_get_direct_page_vector(const void __user *data,
b6aa5901
HC
302 int num_pages,
303 bool write_page);
304extern void ceph_put_page_vector(struct page **pages, int num_pages,
305 bool dirty);
3d14c5d2
YS
306extern struct page **ceph_alloc_page_vector(int num_pages, gfp_t flags);
307extern int ceph_copy_user_to_page_vector(struct page **pages,
b324814e 308 const void __user *data,
3d14c5d2 309 loff_t off, size_t len);
903bb32e 310extern void ceph_copy_to_page_vector(struct page **pages,
b324814e 311 const void *data,
3d14c5d2 312 loff_t off, size_t len);
903bb32e 313extern void ceph_copy_from_page_vector(struct page **pages,
b324814e 314 void *data,
3d14c5d2 315 loff_t off, size_t len);
3d14c5d2
YS
316extern void ceph_zero_page_vector_range(int off, int len, struct page **pages);
317
318
319#endif /* _FS_CEPH_SUPER_H */