fs/ceph/mds_client.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _FS_CEPH_MDS_CLIENT_H
   3 #define _FS_CEPH_MDS_CLIENT_H
   4
   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
  14 #include <linux/ceph/types.h>
  15 #include <linux/ceph/messenger.h>
  16 #include <linux/ceph/mdsmap.h>
  17 #include <linux/ceph/auth.h>
  18
  19 /* The first 8 bits are reserved for old ceph releases */
  20 #define CEPHFS_FEATURE_MIMIC            8
  21 #define CEPHFS_FEATURE_REPLY_ENCODING   9
  22 #define CEPHFS_FEATURE_RECLAIM_CLIENT   10
  23 #define CEPHFS_FEATURE_LAZY_CAP_WANTED  11
  24 #define CEPHFS_FEATURE_MULTI_RECONNECT  12
  25
  26 #define CEPHFS_FEATURES_CLIENT_SUPPORTED {      \
  27         0, 1, 2, 3, 4, 5, 6, 7,                 \
  28         CEPHFS_FEATURE_MIMIC,                   \
  29         CEPHFS_FEATURE_REPLY_ENCODING,          \
  30         CEPHFS_FEATURE_LAZY_CAP_WANTED,         \
  31         CEPHFS_FEATURE_MULTI_RECONNECT,         \
  32 }
  33 #define CEPHFS_FEATURES_CLIENT_REQUIRED {}
  34
  35
  36 /*
  37  * Some lock dependencies:
  38  *
  39  * session->s_mutex
  40  *         mdsc->mutex
  41  *
  42  *         mdsc->snap_rwsem
  43  *
  44  *         ci->i_ceph_lock
  45  *                 mdsc->snap_flush_lock
  46  *                 mdsc->cap_delay_lock
  47  *
  48  */
  49
  50 struct ceph_fs_client;
  51 struct ceph_cap;
  52
  53 /*
  54  * parsed info about a single inode.  pointers are into the encoded
  55  * on-wire structures within the mds reply message payload.
  56  */
  57 struct ceph_mds_reply_info_in {
  58         struct ceph_mds_reply_inode *in;
  59         struct ceph_dir_layout dir_layout;
  60         u32 symlink_len;
  61         char *symlink;
  62         u32 xattr_len;
  63         char *xattr_data;
  64         u64 inline_version;
  65         u32 inline_len;
  66         char *inline_data;
  67         u32 pool_ns_len;
  68         char *pool_ns_data;
  69         u64 max_bytes;
  70         u64 max_files;
  71 };
  72
  73 struct ceph_mds_reply_dir_entry {
  74         char                          *name;
  75         u32                           name_len;
  76         struct ceph_mds_reply_lease   *lease;
  77         struct ceph_mds_reply_info_in inode;
  78         loff_t                        offset;
  79 };
  80
  81 /*
  82  * parsed info about an mds reply, including information about
  83  * either: 1) the target inode and/or its parent directory and dentry,
  84  * and directory contents (for readdir results), or
  85  * 2) the file range lock info (for fcntl F_GETLK results).
  86  */
  87 struct ceph_mds_reply_info_parsed {
  88         struct ceph_mds_reply_head    *head;
  89
  90         /* trace */
  91         struct ceph_mds_reply_info_in diri, targeti;
  92         struct ceph_mds_reply_dirfrag *dirfrag;
  93         char                          *dname;
  94         u32                           dname_len;
  95         struct ceph_mds_reply_lease   *dlease;
  96
  97         /* extra */
  98         union {
  99                 /* for fcntl F_GETLK results */
 100                 struct ceph_filelock *filelock_reply;
 101
 102                 /* for readdir results */
 103                 struct {
 104                         struct ceph_mds_reply_dirfrag *dir_dir;
 105                         size_t                        dir_buf_size;
 106                         int                           dir_nr;
 107                         bool                          dir_end;
 108                         bool                          dir_complete;
 109                         bool                          hash_order;
 110                         bool                          offset_hash;
 111                         struct ceph_mds_reply_dir_entry  *dir_entries;
 112                 };
 113
 114                 /* for create results */
 115                 struct {
 116                         bool has_create_ino;
 117                         u64 ino;
 118                 };
 119         };
 120
 121         /* encoded blob describing snapshot contexts for certain
 122            operations (e.g., open) */
 123         void *snapblob;
 124         int snapblob_len;
 125 };
 126
 127
 128 /*
 129  * cap releases are batched and sent to the MDS en masse.
 130  *
 131  * Account for per-message overhead of mds_cap_release header
 132  * and __le32 for osd epoch barrier trailing field.
 133  */
 134 #define CEPH_CAPS_PER_RELEASE ((PAGE_SIZE - sizeof(u32) -               \
 135                                 sizeof(struct ceph_mds_cap_release)) /  \
 136                                 sizeof(struct ceph_mds_cap_item))
 137
 138
 139 /*
 140  * state associated with each MDS<->client session
 141  */
 142 enum {
 143         CEPH_MDS_SESSION_NEW = 1,
 144         CEPH_MDS_SESSION_OPENING = 2,
 145         CEPH_MDS_SESSION_OPEN = 3,
 146         CEPH_MDS_SESSION_HUNG = 4,
 147         CEPH_MDS_SESSION_CLOSING = 5,
 148         CEPH_MDS_SESSION_RESTARTING = 6,
 149         CEPH_MDS_SESSION_RECONNECTING = 7,
 150         CEPH_MDS_SESSION_REJECTED = 8,
 151 };
 152
 153 struct ceph_mds_session {
 154         struct ceph_mds_client *s_mdsc;
 155         int               s_mds;
 156         int               s_state;
 157         unsigned long     s_ttl;      /* time until mds kills us */
 158         unsigned long     s_features;
 159         u64               s_seq;      /* incoming msg seq # */
 160         struct mutex      s_mutex;    /* serialize session messages */
 161
 162         struct ceph_connection s_con;
 163
 164         struct ceph_auth_handshake s_auth;
 165
 166         /* protected by s_gen_ttl_lock */
 167         spinlock_t        s_gen_ttl_lock;
 168         u32               s_cap_gen;  /* inc each time we get mds stale msg */
 169         unsigned long     s_cap_ttl;  /* when session caps expire */
 170
 171         /* protected by s_cap_lock */
 172         spinlock_t        s_cap_lock;
 173         struct list_head  s_caps;     /* all caps issued by this session */
 174         int               s_nr_caps, s_trim_caps;
 175         int               s_num_cap_releases;
 176         int               s_cap_reconnect;
 177         int               s_readonly;
 178         struct list_head  s_cap_releases; /* waiting cap_release messages */
 179         struct ceph_cap  *s_cap_iterator;
 180
 181         /* protected by mutex */
 182         struct list_head  s_cap_flushing;     /* inodes w/ flushing caps */
 183         unsigned long     s_renew_requested; /* last time we sent a renew req */
 184         u64               s_renew_seq;
 185
 186         refcount_t        s_ref;
 187         struct list_head  s_waiting;  /* waiting requests */
 188         struct list_head  s_unsafe;   /* unsafe requests */
 189 };
 190
 191 /*
 192  * modes of choosing which MDS to send a request to
 193  */
 194 enum {
 195         USE_ANY_MDS,
 196         USE_RANDOM_MDS,
 197         USE_AUTH_MDS,   /* prefer authoritative mds for this metadata item */
 198 };
 199
 200 struct ceph_mds_request;
 201 struct ceph_mds_client;
 202
 203 /*
 204  * request completion callback
 205  */
 206 typedef void (*ceph_mds_request_callback_t) (struct ceph_mds_client *mdsc,
 207                                              struct ceph_mds_request *req);
 208 /*
 209  * wait for request completion callback
 210  */
 211 typedef int (*ceph_mds_request_wait_callback_t) (struct ceph_mds_client *mdsc,
 212                                                  struct ceph_mds_request *req);
 213
 214 /*
 215  * an in-flight mds request
 216  */
 217 struct ceph_mds_request {
 218         u64 r_tid;                   /* transaction id */
 219         struct rb_node r_node;
 220         struct ceph_mds_client *r_mdsc;
 221
 222         int r_op;                    /* mds op code */
 223
 224         /* operation on what? */
 225         struct inode *r_inode;              /* arg1 */
 226         struct dentry *r_dentry;            /* arg1 */
 227         struct dentry *r_old_dentry;        /* arg2: rename from or link from */
 228         struct inode *r_old_dentry_dir;     /* arg2: old dentry's parent dir */
 229         char *r_path1, *r_path2;
 230         struct ceph_vino r_ino1, r_ino2;
 231
 232         struct inode *r_parent;             /* parent dir inode */
 233         struct inode *r_target_inode;       /* resulting inode */
 234
 235 #define CEPH_MDS_R_DIRECT_IS_HASH       (1) /* r_direct_hash is valid */
 236 #define CEPH_MDS_R_ABORTED              (2) /* call was aborted */
 237 #define CEPH_MDS_R_GOT_UNSAFE           (3) /* got an unsafe reply */
 238 #define CEPH_MDS_R_GOT_SAFE             (4) /* got a safe reply */
 239 #define CEPH_MDS_R_GOT_RESULT           (5) /* got a result */
 240 #define CEPH_MDS_R_DID_PREPOPULATE      (6) /* prepopulated readdir */
 241 #define CEPH_MDS_R_PARENT_LOCKED        (7) /* is r_parent->i_rwsem wlocked? */
 242         unsigned long   r_req_flags;
 243
 244         struct mutex r_fill_mutex;
 245
 246         union ceph_mds_request_args r_args;
 247         int r_fmode;        /* file mode, if expecting cap */
 248         kuid_t r_uid;
 249         kgid_t r_gid;
 250         struct timespec64 r_stamp;
 251
 252         /* for choosing which mds to send this request to */
 253         int r_direct_mode;
 254         u32 r_direct_hash;      /* choose dir frag based on this dentry hash */
 255
 256         /* data payload is used for xattr ops */
 257         struct ceph_pagelist *r_pagelist;
 258
 259         /* what caps shall we drop? */
 260         int r_inode_drop, r_inode_unless;
 261         int r_dentry_drop, r_dentry_unless;
 262         int r_old_dentry_drop, r_old_dentry_unless;
 263         struct inode *r_old_inode;
 264         int r_old_inode_drop, r_old_inode_unless;
 265
 266         struct ceph_msg  *r_request;  /* original request */
 267         int r_request_release_offset;
 268         struct ceph_msg  *r_reply;
 269         struct ceph_mds_reply_info_parsed r_reply_info;
 270         struct page *r_locked_page;
 271         int r_err;
 272
 273         unsigned long r_timeout;  /* optional.  jiffies, 0 is "wait forever" */
 274         unsigned long r_started;  /* start time to measure timeout against */
 275         unsigned long r_request_started; /* start time for mds request only,
 276                                             used to measure lease durations */
 277
 278         /* link unsafe requests to parent directory, for fsync */
 279         struct inode    *r_unsafe_dir;
 280         struct list_head r_unsafe_dir_item;
 281
 282         /* unsafe requests that modify the target inode */
 283         struct list_head r_unsafe_target_item;
 284
 285         struct ceph_mds_session *r_session;
 286
 287         int               r_attempts;   /* resend attempts */
 288         int               r_num_fwd;    /* number of forward attempts */
 289         int               r_resend_mds; /* mds to resend to next, if any*/
 290         u32               r_sent_on_mseq; /* cap mseq request was sent at*/
 291
 292         struct kref       r_kref;
 293         struct list_head  r_wait;
 294         struct completion r_completion;
 295         struct completion r_safe_completion;
 296         ceph_mds_request_callback_t r_callback;
 297         ceph_mds_request_wait_callback_t r_wait_for_completion;
 298         struct list_head  r_unsafe_item;  /* per-session unsafe list item */
 299
 300         long long         r_dir_release_cnt;
 301         long long         r_dir_ordered_cnt;
 302         int               r_readdir_cache_idx;
 303         u32               r_readdir_offset;
 304
 305         struct ceph_cap_reservation r_caps_reservation;
 306         int r_num_caps;
 307 };
 308
 309 struct ceph_pool_perm {
 310         struct rb_node node;
 311         int perm;
 312         s64 pool;
 313         size_t pool_ns_len;
 314         char pool_ns[];
 315 };
 316
 317 struct ceph_snapid_map {
 318         struct rb_node node;
 319         struct list_head lru;
 320         atomic_t ref;
 321         u64 snap;
 322         dev_t dev;
 323         unsigned long last_used;
 324 };
 325
 326 /*
 327  * mds client state
 328  */
 329 struct ceph_mds_client {
 330         struct ceph_fs_client  *fsc;
 331         struct mutex            mutex;         /* all nested structures */
 332
 333         struct ceph_mdsmap      *mdsmap;
 334         struct completion       safe_umount_waiters;
 335         wait_queue_head_t       session_close_wq;
 336         struct list_head        waiting_for_map;
 337         int                     mdsmap_err;
 338
 339         struct ceph_mds_session **sessions;    /* NULL for mds if no session */
 340         atomic_t                num_sessions;
 341         int                     max_sessions;  /* len of s_mds_sessions */
 342         int                     stopping;      /* true if shutting down */
 343
 344         atomic64_t              quotarealms_count; /* # realms with quota */
 345
 346         /*
 347          * snap_rwsem will cover cap linkage into snaprealms, and
 348          * realm snap contexts.  (later, we can do per-realm snap
 349          * contexts locks..)  the empty list contains realms with no
 350          * references (implying they contain no inodes with caps) that
 351          * should be destroyed.
 352          */
 353         u64                     last_snap_seq;
 354         struct rw_semaphore     snap_rwsem;
 355         struct rb_root          snap_realms;
 356         struct list_head        snap_empty;
 357         int                     num_snap_realms;
 358         spinlock_t              snap_empty_lock;  /* protect snap_empty */
 359
 360         u64                    last_tid;      /* most recent mds request */
 361         u64                    oldest_tid;    /* oldest incomplete mds request,
 362                                                  excluding setfilelock requests */
 363         struct rb_root         request_tree;  /* pending mds requests */
 364         struct delayed_work    delayed_work;  /* delayed work */
 365         unsigned long    last_renew_caps;  /* last time we renewed our caps */
 366         struct list_head cap_delay_list;   /* caps with delayed release */
 367         spinlock_t       cap_delay_lock;   /* protects cap_delay_list */
 368         struct list_head snap_flush_list;  /* cap_snaps ready to flush */
 369         spinlock_t       snap_flush_lock;
 370
 371         u64               last_cap_flush_tid;
 372         struct list_head  cap_flush_list;
 373         struct list_head  cap_dirty;        /* inodes with dirty caps */
 374         struct list_head  cap_dirty_migrating; /* ...that are migration... */
 375         int               num_cap_flushing; /* # caps we are flushing */
 376         spinlock_t        cap_dirty_lock;   /* protects above items */
 377         wait_queue_head_t cap_flushing_wq;
 378
 379         /*
 380          * Cap reservations
 381          *
 382          * Maintain a global pool of preallocated struct ceph_caps, referenced
 383          * by struct ceph_caps_reservations.  This ensures that we preallocate
 384          * memory needed to successfully process an MDS response.  (If an MDS
 385          * sends us cap information and we fail to process it, we will have
 386          * problems due to the client and MDS being out of sync.)
 387          *
 388          * Reservations are 'owned' by a ceph_cap_reservation context.
 389          */
 390         spinlock_t      caps_list_lock;
 391         struct          list_head caps_list; /* unused (reserved or
 392                                                 unreserved) */
 393         int             caps_total_count;    /* total caps allocated */
 394         int             caps_use_count;      /* in use */
 395         int             caps_reserve_count;  /* unused, reserved */
 396         int             caps_avail_count;    /* unused, unreserved */
 397         int             caps_min_count;      /* keep at least this many
 398                                                 (unreserved) */
 399         spinlock_t        dentry_lru_lock;
 400         struct list_head  dentry_lru;
 401         int               num_dentry;
 402
 403         spinlock_t              snapid_map_lock;
 404         struct rb_root          snapid_map_tree;
 405         struct list_head        snapid_map_lru;
 406
 407         struct rw_semaphore     pool_perm_rwsem;
 408         struct rb_root          pool_perm_tree;
 409
 410         char nodename[__NEW_UTS_LEN + 1];
 411 };
 412
 413 extern const char *ceph_mds_op_name(int op);
 414
 415 extern struct ceph_mds_session *
 416 __ceph_lookup_mds_session(struct ceph_mds_client *, int mds);
 417
 418 static inline struct ceph_mds_session *
 419 ceph_get_mds_session(struct ceph_mds_session *s)
 420 {
 421         refcount_inc(&s->s_ref);
 422         return s;
 423 }
 424
 425 extern const char *ceph_session_state_name(int s);
 426
 427 extern void ceph_put_mds_session(struct ceph_mds_session *s);
 428
 429 extern int ceph_send_msg_mds(struct ceph_mds_client *mdsc,
 430                              struct ceph_msg *msg, int mds);
 431
 432 extern int ceph_mdsc_init(struct ceph_fs_client *fsc);
 433 extern void ceph_mdsc_close_sessions(struct ceph_mds_client *mdsc);
 434 extern void ceph_mdsc_force_umount(struct ceph_mds_client *mdsc);
 435 extern void ceph_mdsc_destroy(struct ceph_fs_client *fsc);
 436
 437 extern void ceph_mdsc_sync(struct ceph_mds_client *mdsc);
 438
 439 extern void ceph_invalidate_dir_request(struct ceph_mds_request *req);
 440 extern int ceph_alloc_readdir_reply_buffer(struct ceph_mds_request *req,
 441                                            struct inode *dir);
 442 extern struct ceph_mds_request *
 443 ceph_mdsc_create_request(struct ceph_mds_client *mdsc, int op, int mode);
 444 extern void ceph_mdsc_submit_request(struct ceph_mds_client *mdsc,
 445                                      struct ceph_mds_request *req);
 446 extern int ceph_mdsc_do_request(struct ceph_mds_client *mdsc,
 447                                 struct inode *dir,
 448                                 struct ceph_mds_request *req);
 449 static inline void ceph_mdsc_get_request(struct ceph_mds_request *req)
 450 {
 451         kref_get(&req->r_kref);
 452 }
 453 extern void ceph_mdsc_release_request(struct kref *kref);
 454 static inline void ceph_mdsc_put_request(struct ceph_mds_request *req)
 455 {
 456         kref_put(&req->r_kref, ceph_mdsc_release_request);
 457 }
 458
 459 extern void ceph_send_cap_releases(struct ceph_mds_client *mdsc,
 460                                    struct ceph_mds_session *session);
 461
 462 extern void ceph_mdsc_pre_umount(struct ceph_mds_client *mdsc);
 463
 464 extern char *ceph_mdsc_build_path(struct dentry *dentry, int *plen, u64 *base,
 465                                   int stop_on_nosnap);
 466
 467 extern void __ceph_mdsc_drop_dentry_lease(struct dentry *dentry);
 468 extern void ceph_mdsc_lease_send_msg(struct ceph_mds_session *session,
 469                                      struct inode *inode,
 470                                      struct dentry *dentry, char action,
 471                                      u32 seq);
 472
 473 extern void ceph_mdsc_handle_mdsmap(struct ceph_mds_client *mdsc,
 474                                     struct ceph_msg *msg);
 475 extern void ceph_mdsc_handle_fsmap(struct ceph_mds_client *mdsc,
 476                                    struct ceph_msg *msg);
 477
 478 extern struct ceph_mds_session *
 479 ceph_mdsc_open_export_target_session(struct ceph_mds_client *mdsc, int target);
 480 extern void ceph_mdsc_open_export_target_sessions(struct ceph_mds_client *mdsc,
 481                                           struct ceph_mds_session *session);
 482
 483 extern int ceph_trim_caps(struct ceph_mds_client *mdsc,
 484                           struct ceph_mds_session *session,
 485                           int max_caps);
 486 #endif