libceph: fix wrong name "Ceph filesystem for Linux"
[deliverable/linux.git] / fs / ceph / mds_client.h
CommitLineData
2f2dc053
SW
1#ifndef _FS_CEPH_MDS_CLIENT_H
2#define _FS_CEPH_MDS_CLIENT_H
3
4#include <linux/completion.h>
153c8e6b 5#include <linux/kref.h>
2f2dc053
SW
6#include <linux/list.h>
7#include <linux/mutex.h>
44ca18f2 8#include <linux/rbtree.h>
2f2dc053
SW
9#include <linux/spinlock.h>
10
3d14c5d2
YS
11#include <linux/ceph/types.h>
12#include <linux/ceph/messenger.h>
13#include <linux/ceph/mdsmap.h>
6c4a1915 14#include <linux/ceph/auth.h>
2f2dc053
SW
15
16/*
17 * Some lock dependencies:
18 *
19 * session->s_mutex
20 * mdsc->mutex
21 *
22 * mdsc->snap_rwsem
23 *
be655596 24 * ci->i_ceph_lock
2f2dc053
SW
25 * mdsc->snap_flush_lock
26 * mdsc->cap_delay_lock
27 *
28 */
29
3d14c5d2 30struct ceph_fs_client;
2f2dc053
SW
31struct ceph_cap;
32
33/*
34 * parsed info about a single inode. pointers are into the encoded
35 * on-wire structures within the mds reply message payload.
36 */
37struct ceph_mds_reply_info_in {
38 struct ceph_mds_reply_inode *in;
14303d20 39 struct ceph_dir_layout dir_layout;
2f2dc053
SW
40 u32 symlink_len;
41 char *symlink;
42 u32 xattr_len;
43 char *xattr_data;
fb01d1f8
YZ
44 u64 inline_version;
45 u32 inline_len;
46 char *inline_data;
2f2dc053
SW
47};
48
49/*
25933abd
HS
50 * parsed info about an mds reply, including information about
51 * either: 1) the target inode and/or its parent directory and dentry,
52 * and directory contents (for readdir results), or
53 * 2) the file range lock info (for fcntl F_GETLK results).
2f2dc053
SW
54 */
55struct ceph_mds_reply_info_parsed {
56 struct ceph_mds_reply_head *head;
57
25933abd 58 /* trace */
2f2dc053
SW
59 struct ceph_mds_reply_info_in diri, targeti;
60 struct ceph_mds_reply_dirfrag *dirfrag;
61 char *dname;
62 u32 dname_len;
63 struct ceph_mds_reply_lease *dlease;
64
25933abd
HS
65 /* extra */
66 union {
67 /* for fcntl F_GETLK results */
68 struct ceph_filelock *filelock_reply;
69
70 /* for readdir results */
71 struct {
72 struct ceph_mds_reply_dirfrag *dir_dir;
54008399 73 size_t dir_buf_size;
25933abd
HS
74 int dir_nr;
75 char **dir_dname;
76 u32 *dir_dname_len;
77 struct ceph_mds_reply_lease **dir_dlease;
78 struct ceph_mds_reply_info_in *dir_in;
79 u8 dir_complete, dir_end;
80 };
6e8575fa
SL
81
82 /* for create results */
83 struct {
84 bool has_create_ino;
85 u64 ino;
86 };
25933abd 87 };
2f2dc053
SW
88
89 /* encoded blob describing snapshot contexts for certain
90 operations (e.g., open) */
91 void *snapblob;
92 int snapblob_len;
93};
94
95
96/*
97 * cap releases are batched and sent to the MDS en masse.
98 */
99#define CEPH_CAPS_PER_RELEASE ((PAGE_CACHE_SIZE - \
100 sizeof(struct ceph_mds_cap_release)) / \
101 sizeof(struct ceph_mds_cap_item))
102
103
104/*
105 * state associated with each MDS<->client session
106 */
107enum {
108 CEPH_MDS_SESSION_NEW = 1,
109 CEPH_MDS_SESSION_OPENING = 2,
110 CEPH_MDS_SESSION_OPEN = 3,
111 CEPH_MDS_SESSION_HUNG = 4,
112 CEPH_MDS_SESSION_CLOSING = 5,
113 CEPH_MDS_SESSION_RESTARTING = 6,
114 CEPH_MDS_SESSION_RECONNECTING = 7,
115};
116
117struct ceph_mds_session {
118 struct ceph_mds_client *s_mdsc;
119 int s_mds;
120 int s_state;
121 unsigned long s_ttl; /* time until mds kills us */
122 u64 s_seq; /* incoming msg seq # */
123 struct mutex s_mutex; /* serialize session messages */
124
125 struct ceph_connection s_con;
126
6c4a1915 127 struct ceph_auth_handshake s_auth;
4e7a5dcd 128
d8fb02ab
AE
129 /* protected by s_gen_ttl_lock */
130 spinlock_t s_gen_ttl_lock;
2f2dc053
SW
131 u32 s_cap_gen; /* inc each time we get mds stale msg */
132 unsigned long s_cap_ttl; /* when session caps expire */
d8fb02ab
AE
133
134 /* protected by s_cap_lock */
135 spinlock_t s_cap_lock;
2f2dc053
SW
136 struct list_head s_caps; /* all caps issued by this session */
137 int s_nr_caps, s_trim_caps;
138 int s_num_cap_releases;
99a9c273 139 int s_cap_reconnect;
03f4fcb0 140 int s_readonly;
2f2dc053 141 struct list_head s_cap_releases; /* waiting cap_release messages */
7c1332b8 142 struct ceph_cap *s_cap_iterator;
2f2dc053
SW
143
144 /* protected by mutex */
145 struct list_head s_cap_flushing; /* inodes w/ flushing caps */
146 struct list_head s_cap_snaps_flushing;
147 unsigned long s_renew_requested; /* last time we sent a renew req */
148 u64 s_renew_seq;
149
150 atomic_t s_ref;
151 struct list_head s_waiting; /* waiting requests */
152 struct list_head s_unsafe; /* unsafe requests */
153};
154
155/*
156 * modes of choosing which MDS to send a request to
157 */
158enum {
159 USE_ANY_MDS,
160 USE_RANDOM_MDS,
161 USE_AUTH_MDS, /* prefer authoritative mds for this metadata item */
162};
163
164struct ceph_mds_request;
165struct ceph_mds_client;
166
167/*
168 * request completion callback
169 */
170typedef void (*ceph_mds_request_callback_t) (struct ceph_mds_client *mdsc,
171 struct ceph_mds_request *req);
9280be24
YZ
172/*
173 * wait for request completion callback
174 */
175typedef int (*ceph_mds_request_wait_callback_t) (struct ceph_mds_client *mdsc,
176 struct ceph_mds_request *req);
2f2dc053
SW
177
178/*
179 * an in-flight mds request
180 */
181struct ceph_mds_request {
182 u64 r_tid; /* transaction id */
44ca18f2 183 struct rb_node r_node;
37151668 184 struct ceph_mds_client *r_mdsc;
2f2dc053
SW
185
186 int r_op; /* mds op code */
2f2dc053
SW
187
188 /* operation on what? */
189 struct inode *r_inode; /* arg1 */
190 struct dentry *r_dentry; /* arg1 */
191 struct dentry *r_old_dentry; /* arg2: rename from or link from */
41b02e1f 192 struct inode *r_old_dentry_dir; /* arg2: old dentry's parent dir */
2f2dc053
SW
193 char *r_path1, *r_path2;
194 struct ceph_vino r_ino1, r_ino2;
195
196 struct inode *r_locked_dir; /* dir (if any) i_mutex locked by vfs */
197 struct inode *r_target_inode; /* resulting inode */
198
b4556396
SW
199 struct mutex r_fill_mutex;
200
2f2dc053
SW
201 union ceph_mds_request_args r_args;
202 int r_fmode; /* file mode, if expecting cap */
ff3d0046
EB
203 kuid_t r_uid;
204 kgid_t r_gid;
b8e69066 205 struct timespec r_stamp;
2f2dc053
SW
206
207 /* for choosing which mds to send this request to */
208 int r_direct_mode;
209 u32 r_direct_hash; /* choose dir frag based on this dentry hash */
210 bool r_direct_is_hash; /* true if r_direct_hash is valid */
211
212 /* data payload is used for xattr ops */
25e6bae3 213 struct ceph_pagelist *r_pagelist;
2f2dc053
SW
214
215 /* what caps shall we drop? */
216 int r_inode_drop, r_inode_unless;
217 int r_dentry_drop, r_dentry_unless;
218 int r_old_dentry_drop, r_old_dentry_unless;
219 struct inode *r_old_inode;
220 int r_old_inode_drop, r_old_inode_unless;
221
222 struct ceph_msg *r_request; /* original request */
e979cf50 223 int r_request_release_offset;
2f2dc053
SW
224 struct ceph_msg *r_reply;
225 struct ceph_mds_reply_info_parsed r_reply_info;
01deead0 226 struct page *r_locked_page;
2f2dc053 227 int r_err;
5b1daecd 228 bool r_aborted;
2f2dc053 229
a319bf56 230 unsigned long r_timeout; /* optional. jiffies, 0 is "wait forever" */
2f2dc053
SW
231 unsigned long r_started; /* start time to measure timeout against */
232 unsigned long r_request_started; /* start time for mds request only,
233 used to measure lease durations */
234
235 /* link unsafe requests to parent directory, for fsync */
236 struct inode *r_unsafe_dir;
237 struct list_head r_unsafe_dir_item;
238
239 struct ceph_mds_session *r_session;
240
241 int r_attempts; /* resend attempts */
242 int r_num_fwd; /* number of forward attempts */
2f2dc053 243 int r_resend_mds; /* mds to resend to next, if any*/
e55b71f8 244 u32 r_sent_on_mseq; /* cap mseq request was sent at*/
2f2dc053 245
153c8e6b 246 struct kref r_kref;
2f2dc053
SW
247 struct list_head r_wait;
248 struct completion r_completion;
249 struct completion r_safe_completion;
250 ceph_mds_request_callback_t r_callback;
9280be24 251 ceph_mds_request_wait_callback_t r_wait_for_completion;
2f2dc053 252 struct list_head r_unsafe_item; /* per-session unsafe list item */
e1518c7c 253 bool r_got_unsafe, r_got_safe, r_got_result;
2f2dc053
SW
254
255 bool r_did_prepopulate;
256 u32 r_readdir_offset;
257
258 struct ceph_cap_reservation r_caps_reservation;
259 int r_num_caps;
260};
261
10183a69
YZ
262struct ceph_pool_perm {
263 struct rb_node node;
264 u32 pool;
265 int perm;
266};
267
2f2dc053
SW
268/*
269 * mds client state
270 */
271struct ceph_mds_client {
3d14c5d2 272 struct ceph_fs_client *fsc;
2f2dc053
SW
273 struct mutex mutex; /* all nested structures */
274
275 struct ceph_mdsmap *mdsmap;
f3c60c59
SW
276 struct completion safe_umount_waiters;
277 wait_queue_head_t session_close_wq;
2f2dc053
SW
278 struct list_head waiting_for_map;
279
280 struct ceph_mds_session **sessions; /* NULL for mds if no session */
86d8f67b 281 atomic_t num_sessions;
2f2dc053
SW
282 int max_sessions; /* len of s_mds_sessions */
283 int stopping; /* true if shutting down */
284
285 /*
286 * snap_rwsem will cover cap linkage into snaprealms, and
287 * realm snap contexts. (later, we can do per-realm snap
288 * contexts locks..) the empty list contains realms with no
289 * references (implying they contain no inodes with caps) that
290 * should be destroyed.
291 */
affbc19a 292 u64 last_snap_seq;
2f2dc053 293 struct rw_semaphore snap_rwsem;
a105f00c 294 struct rb_root snap_realms;
2f2dc053
SW
295 struct list_head snap_empty;
296 spinlock_t snap_empty_lock; /* protect snap_empty */
297
298 u64 last_tid; /* most recent mds request */
e8a7b8b1
YZ
299 u64 oldest_tid; /* oldest incomplete mds request,
300 excluding setfilelock requests */
44ca18f2 301 struct rb_root request_tree; /* pending mds requests */
2f2dc053
SW
302 struct delayed_work delayed_work; /* delayed work */
303 unsigned long last_renew_caps; /* last time we renewed our caps */
304 struct list_head cap_delay_list; /* caps with delayed release */
305 spinlock_t cap_delay_lock; /* protects cap_delay_list */
306 struct list_head snap_flush_list; /* cap_snaps ready to flush */
307 spinlock_t snap_flush_lock;
308
309 u64 cap_flush_seq;
310 struct list_head cap_dirty; /* inodes with dirty caps */
db354052 311 struct list_head cap_dirty_migrating; /* ...that are migration... */
2f2dc053
SW
312 int num_cap_flushing; /* # caps we are flushing */
313 spinlock_t cap_dirty_lock; /* protects above items */
314 wait_queue_head_t cap_flushing_wq;
315
37151668
YS
316 /*
317 * Cap reservations
318 *
319 * Maintain a global pool of preallocated struct ceph_caps, referenced
320 * by struct ceph_caps_reservations. This ensures that we preallocate
321 * memory needed to successfully process an MDS response. (If an MDS
322 * sends us cap information and we fail to process it, we will have
323 * problems due to the client and MDS being out of sync.)
324 *
325 * Reservations are 'owned' by a ceph_cap_reservation context.
326 */
327 spinlock_t caps_list_lock;
328 struct list_head caps_list; /* unused (reserved or
329 unreserved) */
330 int caps_total_count; /* total caps allocated */
331 int caps_use_count; /* in use */
332 int caps_reserve_count; /* unused, reserved */
333 int caps_avail_count; /* unused, unreserved */
334 int caps_min_count; /* keep at least this many
335 (unreserved) */
2f2dc053
SW
336 spinlock_t dentry_lru_lock;
337 struct list_head dentry_lru;
338 int num_dentry;
10183a69
YZ
339
340 struct rw_semaphore pool_perm_rwsem;
341 struct rb_root pool_perm_tree;
2f2dc053
SW
342};
343
344extern const char *ceph_mds_op_name(int op);
345
346extern struct ceph_mds_session *
347__ceph_lookup_mds_session(struct ceph_mds_client *, int mds);
348
349static inline struct ceph_mds_session *
350ceph_get_mds_session(struct ceph_mds_session *s)
351{
352 atomic_inc(&s->s_ref);
353 return s;
354}
355
a687ecaf
JS
356extern const char *ceph_session_state_name(int s);
357
2f2dc053
SW
358extern void ceph_put_mds_session(struct ceph_mds_session *s);
359
360extern int ceph_send_msg_mds(struct ceph_mds_client *mdsc,
361 struct ceph_msg *msg, int mds);
362
3d14c5d2 363extern int ceph_mdsc_init(struct ceph_fs_client *fsc);
2f2dc053 364extern void ceph_mdsc_close_sessions(struct ceph_mds_client *mdsc);
3d14c5d2 365extern void ceph_mdsc_destroy(struct ceph_fs_client *fsc);
2f2dc053
SW
366
367extern void ceph_mdsc_sync(struct ceph_mds_client *mdsc);
368
369extern void ceph_mdsc_lease_release(struct ceph_mds_client *mdsc,
370 struct inode *inode,
2f90b852 371 struct dentry *dn);
2f2dc053 372
167c9e35 373extern void ceph_invalidate_dir_request(struct ceph_mds_request *req);
54008399
YZ
374extern int ceph_alloc_readdir_reply_buffer(struct ceph_mds_request *req,
375 struct inode *dir);
2f2dc053
SW
376extern struct ceph_mds_request *
377ceph_mdsc_create_request(struct ceph_mds_client *mdsc, int op, int mode);
378extern void ceph_mdsc_submit_request(struct ceph_mds_client *mdsc,
379 struct ceph_mds_request *req);
380extern int ceph_mdsc_do_request(struct ceph_mds_client *mdsc,
381 struct inode *dir,
382 struct ceph_mds_request *req);
383static inline void ceph_mdsc_get_request(struct ceph_mds_request *req)
384{
153c8e6b
SW
385 kref_get(&req->r_kref);
386}
387extern void ceph_mdsc_release_request(struct kref *kref);
388static inline void ceph_mdsc_put_request(struct ceph_mds_request *req)
389{
390 kref_put(&req->r_kref, ceph_mdsc_release_request);
2f2dc053 391}
2f2dc053 392
3d7ded4d
SW
393extern void ceph_send_cap_releases(struct ceph_mds_client *mdsc,
394 struct ceph_mds_session *session);
395
2f2dc053
SW
396extern void ceph_mdsc_pre_umount(struct ceph_mds_client *mdsc);
397
398extern char *ceph_mdsc_build_path(struct dentry *dentry, int *plen, u64 *base,
399 int stop_on_nosnap);
400
401extern void __ceph_mdsc_drop_dentry_lease(struct dentry *dentry);
402extern void ceph_mdsc_lease_send_msg(struct ceph_mds_session *session,
403 struct inode *inode,
404 struct dentry *dentry, char action,
405 u32 seq);
406
407extern void ceph_mdsc_handle_map(struct ceph_mds_client *mdsc,
408 struct ceph_msg *msg);
409
5d72d13c
YZ
410extern struct ceph_mds_session *
411ceph_mdsc_open_export_target_session(struct ceph_mds_client *mdsc, int target);
154f42c2
SW
412extern void ceph_mdsc_open_export_target_sessions(struct ceph_mds_client *mdsc,
413 struct ceph_mds_session *session);
414
2f2dc053 415#endif
This page took 0.23616 seconds and 5 git commands to generate.