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