1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _FS_CEPH_MDS_CLIENT_H
3 #define _FS_CEPH_MDS_CLIENT_H
5 #include <linux/completion.h>
6 #include <linux/kref.h>
7 #include <linux/list.h>
8 #include <linux/mutex.h>
9 #include <linux/rbtree.h>
10 #include <linux/spinlock.h>
11 #include <linux/refcount.h>
12 #include <linux/utsname.h>
13 #include <linux/ktime.h>
15 #include <linux/ceph/types.h>
16 #include <linux/ceph/messenger.h>
17 #include <linux/ceph/auth.h>
23 /* The first 8 bits are reserved for old ceph releases */
24 enum ceph_feature_type {
25 CEPHFS_FEATURE_MIMIC = 8,
26 CEPHFS_FEATURE_REPLY_ENCODING,
27 CEPHFS_FEATURE_RECLAIM_CLIENT,
28 CEPHFS_FEATURE_LAZY_CAP_WANTED,
29 CEPHFS_FEATURE_MULTI_RECONNECT,
30 CEPHFS_FEATURE_DELEG_INO,
31 CEPHFS_FEATURE_METRIC_COLLECT,
32 CEPHFS_FEATURE_ALTERNATE_NAME,
33 CEPHFS_FEATURE_NOTIFY_SESSION_STATE,
34 CEPHFS_FEATURE_OP_GETVXATTR,
35 CEPHFS_FEATURE_32BITS_RETRY_FWD,
36 CEPHFS_FEATURE_NEW_SNAPREALM_INFO,
37 CEPHFS_FEATURE_HAS_OWNER_UIDGID,
39 CEPHFS_FEATURE_MAX = CEPHFS_FEATURE_HAS_OWNER_UIDGID,
42 #define CEPHFS_FEATURES_CLIENT_SUPPORTED { \
43 0, 1, 2, 3, 4, 5, 6, 7, \
44 CEPHFS_FEATURE_MIMIC, \
45 CEPHFS_FEATURE_REPLY_ENCODING, \
46 CEPHFS_FEATURE_LAZY_CAP_WANTED, \
47 CEPHFS_FEATURE_MULTI_RECONNECT, \
48 CEPHFS_FEATURE_DELEG_INO, \
49 CEPHFS_FEATURE_METRIC_COLLECT, \
50 CEPHFS_FEATURE_ALTERNATE_NAME, \
51 CEPHFS_FEATURE_NOTIFY_SESSION_STATE, \
52 CEPHFS_FEATURE_OP_GETVXATTR, \
53 CEPHFS_FEATURE_32BITS_RETRY_FWD, \
54 CEPHFS_FEATURE_HAS_OWNER_UIDGID, \
58 * Some lock dependencies:
66 * mdsc->snap_flush_lock
67 * mdsc->cap_delay_lock
71 struct ceph_fs_client;
75 * parsed info about a single inode. pointers are into the encoded
76 * on-wire structures within the mds reply message payload.
78 struct ceph_mds_reply_info_in {
79 struct ceph_mds_reply_inode *in;
80 struct ceph_dir_layout dir_layout;
93 struct ceph_timespec btime;
94 struct ceph_timespec snap_btime;
103 struct ceph_mds_reply_dir_entry {
108 struct ceph_mds_reply_lease *lease;
109 struct ceph_mds_reply_info_in inode;
113 struct ceph_mds_reply_xattr {
115 size_t xattr_value_len;
119 * parsed info about an mds reply, including information about
120 * either: 1) the target inode and/or its parent directory and dentry,
121 * and directory contents (for readdir results), or
122 * 2) the file range lock info (for fcntl F_GETLK results).
124 struct ceph_mds_reply_info_parsed {
125 struct ceph_mds_reply_head *head;
128 struct ceph_mds_reply_info_in diri, targeti;
129 struct ceph_mds_reply_dirfrag *dirfrag;
134 struct ceph_mds_reply_lease *dlease;
135 struct ceph_mds_reply_xattr xattr_info;
139 /* for fcntl F_GETLK results */
140 struct ceph_filelock *filelock_reply;
142 /* for readdir results */
144 struct ceph_mds_reply_dirfrag *dir_dir;
151 struct ceph_mds_reply_dir_entry *dir_entries;
154 /* for create results */
161 /* encoded blob describing snapshot contexts for certain
162 operations (e.g., open) */
169 * cap releases are batched and sent to the MDS en masse.
171 * Account for per-message overhead of mds_cap_release header
172 * and __le32 for osd epoch barrier trailing field.
174 #define CEPH_CAPS_PER_RELEASE ((PAGE_SIZE - sizeof(u32) - \
175 sizeof(struct ceph_mds_cap_release)) / \
176 sizeof(struct ceph_mds_cap_item))
180 * state associated with each MDS<->client session
183 CEPH_MDS_SESSION_NEW = 1,
184 CEPH_MDS_SESSION_OPENING = 2,
185 CEPH_MDS_SESSION_OPEN = 3,
186 CEPH_MDS_SESSION_HUNG = 4,
187 CEPH_MDS_SESSION_RESTARTING = 5,
188 CEPH_MDS_SESSION_RECONNECTING = 6,
189 CEPH_MDS_SESSION_CLOSING = 7,
190 CEPH_MDS_SESSION_CLOSED = 8,
191 CEPH_MDS_SESSION_REJECTED = 9,
194 struct ceph_mds_session {
195 struct ceph_mds_client *s_mdsc;
198 unsigned long s_ttl; /* time until mds kills us */
199 unsigned long s_features;
200 u64 s_seq; /* incoming msg seq # */
201 struct mutex s_mutex; /* serialize session messages */
203 struct ceph_connection s_con;
205 struct ceph_auth_handshake s_auth;
207 atomic_t s_cap_gen; /* inc each time we get mds stale msg */
208 unsigned long s_cap_ttl; /* when session caps expire. protected by s_mutex */
210 /* protected by s_cap_lock */
211 spinlock_t s_cap_lock;
213 struct list_head s_caps; /* all caps issued by this session */
214 struct ceph_cap *s_cap_iterator;
216 int s_num_cap_releases;
219 struct list_head s_cap_releases; /* waiting cap_release messages */
220 struct work_struct s_cap_release_work;
222 /* See ceph_inode_info->i_dirty_item. */
223 struct list_head s_cap_dirty; /* inodes w/ dirty caps */
225 /* See ceph_inode_info->i_flushing_item. */
226 struct list_head s_cap_flushing; /* inodes w/ flushing caps */
228 unsigned long s_renew_requested; /* last time we sent a renew req */
231 struct list_head s_waiting; /* waiting requests */
232 struct list_head s_unsafe; /* unsafe requests */
233 struct xarray s_delegated_inos;
237 * modes of choosing which MDS to send a request to
242 USE_AUTH_MDS, /* prefer authoritative mds for this metadata item */
245 struct ceph_mds_request;
246 struct ceph_mds_client;
249 * request completion callback
251 typedef void (*ceph_mds_request_callback_t) (struct ceph_mds_client *mdsc,
252 struct ceph_mds_request *req);
254 * wait for request completion callback
256 typedef int (*ceph_mds_request_wait_callback_t) (struct ceph_mds_client *mdsc,
257 struct ceph_mds_request *req);
260 * an in-flight mds request
262 struct ceph_mds_request {
263 u64 r_tid; /* transaction id */
264 struct rb_node r_node;
265 struct ceph_mds_client *r_mdsc;
268 int r_op; /* mds op code */
270 /* operation on what? */
271 struct inode *r_inode; /* arg1 */
272 struct dentry *r_dentry; /* arg1 */
273 struct dentry *r_old_dentry; /* arg2: rename from or link from */
274 struct inode *r_old_dentry_dir; /* arg2: old dentry's parent dir */
275 char *r_path1, *r_path2;
276 struct ceph_vino r_ino1, r_ino2;
278 struct inode *r_parent; /* parent dir inode */
279 struct inode *r_target_inode; /* resulting inode */
280 struct inode *r_new_inode; /* new inode (for creates) */
282 #define CEPH_MDS_R_DIRECT_IS_HASH (1) /* r_direct_hash is valid */
283 #define CEPH_MDS_R_ABORTED (2) /* call was aborted */
284 #define CEPH_MDS_R_GOT_UNSAFE (3) /* got an unsafe reply */
285 #define CEPH_MDS_R_GOT_SAFE (4) /* got a safe reply */
286 #define CEPH_MDS_R_GOT_RESULT (5) /* got a result */
287 #define CEPH_MDS_R_DID_PREPOPULATE (6) /* prepopulated readdir */
288 #define CEPH_MDS_R_PARENT_LOCKED (7) /* is r_parent->i_rwsem wlocked? */
289 #define CEPH_MDS_R_ASYNC (8) /* async request */
290 #define CEPH_MDS_R_FSCRYPT_FILE (9) /* must marshal fscrypt_file field */
291 unsigned long r_req_flags;
293 struct mutex r_fill_mutex;
295 union ceph_mds_request_args r_args;
297 struct ceph_fscrypt_auth *r_fscrypt_auth;
300 u8 *r_altname; /* fscrypt binary crypttext for long filenames */
301 u32 r_altname_len; /* length of r_altname */
303 int r_fmode; /* file mode, if expecting cap */
304 int r_request_release_offset;
305 const struct cred *r_cred;
306 struct mnt_idmap *r_mnt_idmap;
307 struct timespec64 r_stamp;
309 /* for choosing which mds to send this request to */
311 u32 r_direct_hash; /* choose dir frag based on this dentry hash */
313 /* data payload is used for xattr ops */
314 struct ceph_pagelist *r_pagelist;
316 /* what caps shall we drop? */
317 int r_inode_drop, r_inode_unless;
318 int r_dentry_drop, r_dentry_unless;
319 int r_old_dentry_drop, r_old_dentry_unless;
320 struct inode *r_old_inode;
321 int r_old_inode_drop, r_old_inode_unless;
323 struct ceph_msg *r_request; /* original request */
324 struct ceph_msg *r_reply;
325 struct ceph_mds_reply_info_parsed r_reply_info;
327 u32 r_readdir_offset;
329 struct page *r_locked_page;
333 unsigned long r_timeout; /* optional. jiffies, 0 is "wait forever" */
334 unsigned long r_started; /* start time to measure timeout against */
335 unsigned long r_start_latency; /* start time to measure latency */
336 unsigned long r_end_latency; /* finish time to measure latency */
337 unsigned long r_request_started; /* start time for mds request only,
338 used to measure lease durations */
340 /* link unsafe requests to parent directory, for fsync */
341 struct inode *r_unsafe_dir;
342 struct list_head r_unsafe_dir_item;
344 /* unsafe requests that modify the target inode */
345 struct list_head r_unsafe_target_item;
347 struct ceph_mds_session *r_session;
349 int r_attempts; /* resend attempts */
350 int r_num_fwd; /* number of forward attempts */
351 int r_resend_mds; /* mds to resend to next, if any*/
352 u32 r_sent_on_mseq; /* cap mseq request was sent at*/
355 struct list_head r_wait;
356 struct completion r_completion;
357 struct completion r_safe_completion;
358 ceph_mds_request_callback_t r_callback;
359 struct list_head r_unsafe_item; /* per-session unsafe list item */
361 long long r_dir_release_cnt;
362 long long r_dir_ordered_cnt;
363 int r_readdir_cache_idx;
365 int r_feature_needed;
367 struct ceph_cap_reservation r_caps_reservation;
370 struct ceph_pool_perm {
378 struct ceph_snapid_map {
380 struct list_head lru;
384 unsigned long last_used;
388 * node for list of quotarealm inodes that are not visible from the filesystem
389 * mountpoint, but required to handle, e.g. quotas.
391 struct ceph_quotarealm_inode {
394 unsigned long timeout; /* last time a lookup failed for this inode */
400 struct list_head list;
408 CEPH_MDSC_STOPPING_BEGIN = 1,
409 CEPH_MDSC_STOPPING_FLUSHING = 2,
410 CEPH_MDSC_STOPPING_FLUSHED = 3,
416 struct ceph_mds_client {
417 struct ceph_fs_client *fsc;
418 struct mutex mutex; /* all nested structures */
420 struct ceph_mdsmap *mdsmap;
421 struct completion safe_umount_waiters;
422 wait_queue_head_t session_close_wq;
423 struct list_head waiting_for_map;
426 struct ceph_mds_session **sessions; /* NULL for mds if no session */
427 atomic_t num_sessions;
428 int max_sessions; /* len of sessions array */
430 spinlock_t stopping_lock; /* protect snap_empty */
431 int stopping; /* the stage of shutting down */
432 atomic_t stopping_blockers;
433 struct completion stopping_waiter;
435 atomic64_t quotarealms_count; /* # realms with quota */
437 * We keep a list of inodes we don't see in the mountpoint but that we
438 * need to track quota realms.
440 struct rb_root quotarealms_inodes;
441 struct mutex quotarealms_inodes_mutex;
444 * snap_rwsem will cover cap linkage into snaprealms, and
445 * realm snap contexts. (later, we can do per-realm snap
446 * contexts locks..) the empty list contains realms with no
447 * references (implying they contain no inodes with caps) that
448 * should be destroyed.
451 struct rw_semaphore snap_rwsem;
452 struct rb_root snap_realms;
453 struct list_head snap_empty;
455 spinlock_t snap_empty_lock; /* protect snap_empty */
457 u64 last_tid; /* most recent mds request */
458 u64 oldest_tid; /* oldest incomplete mds request,
459 excluding setfilelock requests */
460 struct rb_root request_tree; /* pending mds requests */
461 struct delayed_work delayed_work; /* delayed work */
462 unsigned long last_renew_caps; /* last time we renewed our caps */
463 struct list_head cap_delay_list; /* caps with delayed release */
464 spinlock_t cap_delay_lock; /* protects cap_delay_list */
465 struct list_head snap_flush_list; /* cap_snaps ready to flush */
466 spinlock_t snap_flush_lock;
468 u64 last_cap_flush_tid;
469 struct list_head cap_flush_list;
470 struct list_head cap_dirty_migrating; /* ...that are migration... */
471 int num_cap_flushing; /* # caps we are flushing */
472 spinlock_t cap_dirty_lock; /* protects above items */
473 wait_queue_head_t cap_flushing_wq;
475 struct work_struct cap_reclaim_work;
476 atomic_t cap_reclaim_pending;
481 * Maintain a global pool of preallocated struct ceph_caps, referenced
482 * by struct ceph_caps_reservations. This ensures that we preallocate
483 * memory needed to successfully process an MDS response. (If an MDS
484 * sends us cap information and we fail to process it, we will have
485 * problems due to the client and MDS being out of sync.)
487 * Reservations are 'owned' by a ceph_cap_reservation context.
489 spinlock_t caps_list_lock;
490 struct list_head caps_list; /* unused (reserved or
492 struct list_head cap_wait_list;
493 int caps_total_count; /* total caps allocated */
494 int caps_use_count; /* in use */
495 int caps_use_max; /* max used caps */
496 int caps_reserve_count; /* unused, reserved */
497 int caps_avail_count; /* unused, unreserved */
498 int caps_min_count; /* keep at least this many
500 spinlock_t dentry_list_lock;
501 struct list_head dentry_leases; /* fifo list */
502 struct list_head dentry_dir_leases; /* lru list */
504 struct ceph_client_metric metric;
506 spinlock_t snapid_map_lock;
507 struct rb_root snapid_map_tree;
508 struct list_head snapid_map_lru;
510 struct rw_semaphore pool_perm_rwsem;
511 struct rb_root pool_perm_tree;
513 char nodename[__NEW_UTS_LEN + 1];
516 extern const char *ceph_mds_op_name(int op);
518 extern bool check_session_state(struct ceph_mds_session *s);
519 void inc_session_sequence(struct ceph_mds_session *s);
521 extern struct ceph_mds_session *
522 __ceph_lookup_mds_session(struct ceph_mds_client *, int mds);
524 extern const char *ceph_session_state_name(int s);
526 extern struct ceph_mds_session *
527 ceph_get_mds_session(struct ceph_mds_session *s);
528 extern void ceph_put_mds_session(struct ceph_mds_session *s);
530 extern int ceph_send_msg_mds(struct ceph_mds_client *mdsc,
531 struct ceph_msg *msg, int mds);
533 extern int ceph_mdsc_init(struct ceph_fs_client *fsc);
534 extern void ceph_mdsc_close_sessions(struct ceph_mds_client *mdsc);
535 extern void ceph_mdsc_force_umount(struct ceph_mds_client *mdsc);
536 extern void ceph_mdsc_destroy(struct ceph_fs_client *fsc);
538 extern void ceph_mdsc_sync(struct ceph_mds_client *mdsc);
540 extern void ceph_invalidate_dir_request(struct ceph_mds_request *req);
541 extern int ceph_alloc_readdir_reply_buffer(struct ceph_mds_request *req,
543 extern struct ceph_mds_request *
544 ceph_mdsc_create_request(struct ceph_mds_client *mdsc, int op, int mode);
545 extern int ceph_mdsc_submit_request(struct ceph_mds_client *mdsc,
547 struct ceph_mds_request *req);
548 int ceph_mdsc_wait_request(struct ceph_mds_client *mdsc,
549 struct ceph_mds_request *req,
550 ceph_mds_request_wait_callback_t wait_func);
551 extern int ceph_mdsc_do_request(struct ceph_mds_client *mdsc,
553 struct ceph_mds_request *req);
554 extern void ceph_mdsc_release_dir_caps(struct ceph_mds_request *req);
555 extern void ceph_mdsc_release_dir_caps_no_check(struct ceph_mds_request *req);
556 static inline void ceph_mdsc_get_request(struct ceph_mds_request *req)
558 kref_get(&req->r_kref);
560 extern void ceph_mdsc_release_request(struct kref *kref);
561 static inline void ceph_mdsc_put_request(struct ceph_mds_request *req)
563 kref_put(&req->r_kref, ceph_mdsc_release_request);
566 extern void send_flush_mdlog(struct ceph_mds_session *s);
567 extern void ceph_mdsc_iterate_sessions(struct ceph_mds_client *mdsc,
568 void (*cb)(struct ceph_mds_session *),
570 extern struct ceph_msg *ceph_create_session_msg(u32 op, u64 seq);
571 extern void __ceph_queue_cap_release(struct ceph_mds_session *session,
572 struct ceph_cap *cap);
573 extern void ceph_flush_cap_releases(struct ceph_mds_client *mdsc,
574 struct ceph_mds_session *session);
575 extern void ceph_queue_cap_reclaim_work(struct ceph_mds_client *mdsc);
576 extern void ceph_reclaim_caps_nr(struct ceph_mds_client *mdsc, int nr);
577 extern int ceph_iterate_session_caps(struct ceph_mds_session *session,
578 int (*cb)(struct inode *, int mds, void *),
580 extern void ceph_mdsc_pre_umount(struct ceph_mds_client *mdsc);
582 static inline void ceph_mdsc_free_path(char *path, int len)
584 if (!IS_ERR_OR_NULL(path))
585 __putname(path - (PATH_MAX - 1 - len));
588 extern char *ceph_mdsc_build_path(struct ceph_mds_client *mdsc,
589 struct dentry *dentry, int *plen, u64 *base,
592 extern void __ceph_mdsc_drop_dentry_lease(struct dentry *dentry);
593 extern void ceph_mdsc_lease_send_msg(struct ceph_mds_session *session,
594 struct dentry *dentry, char action,
597 extern void ceph_mdsc_handle_mdsmap(struct ceph_mds_client *mdsc,
598 struct ceph_msg *msg);
599 extern void ceph_mdsc_handle_fsmap(struct ceph_mds_client *mdsc,
600 struct ceph_msg *msg);
602 extern struct ceph_mds_session *
603 ceph_mdsc_open_export_target_session(struct ceph_mds_client *mdsc, int target);
604 extern void ceph_mdsc_open_export_target_sessions(struct ceph_mds_client *mdsc,
605 struct ceph_mds_session *session);
607 extern int ceph_trim_caps(struct ceph_mds_client *mdsc,
608 struct ceph_mds_session *session,
611 static inline int ceph_wait_on_async_create(struct inode *inode)
613 struct ceph_inode_info *ci = ceph_inode(inode);
615 return wait_on_bit(&ci->i_ceph_flags, CEPH_ASYNC_CREATE_BIT,
619 extern int ceph_wait_on_conflict_unlink(struct dentry *dentry);
620 extern u64 ceph_get_deleg_ino(struct ceph_mds_session *session);
621 extern int ceph_restore_deleg_ino(struct ceph_mds_session *session, u64 ino);
623 extern bool enable_unsafe_idmap;