fs/ceph/super.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _FS_CEPH_SUPER_H
   3 #define _FS_CEPH_SUPER_H
   4
   5 #include <linux/ceph/ceph_debug.h>
   6
   7 #include <asm/unaligned.h>
   8 #include <linux/backing-dev.h>
   9 #include <linux/completion.h>
  10 #include <linux/exportfs.h>
  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>
  17 #include <linux/posix_acl.h>
  18 #include <linux/refcount.h>
  19
  20 #include <linux/ceph/libceph.h>
  21
  22 #ifdef CONFIG_CEPH_FSCACHE
  23 #include <linux/fscache.h>
  24 #endif
  25
  26 /* f_type in struct statfs */
  27 #define CEPH_SUPER_MAGIC 0x00c36400
  28
  29 /* large granularity for statfs utilization stats to facilitate
  30  * large volume sizes on 32-bit machines. */
  31 #define CEPH_BLOCK_SHIFT   22  /* 4 MB */
  32 #define CEPH_BLOCK         (1 << CEPH_BLOCK_SHIFT)
  33
  34 #define CEPH_MOUNT_OPT_DIRSTAT         (1<<4) /* `cat dirname` for stats */
  35 #define CEPH_MOUNT_OPT_RBYTES          (1<<5) /* dir st_bytes = rbytes */
  36 #define CEPH_MOUNT_OPT_NOASYNCREADDIR  (1<<7) /* no dcache readdir */
  37 #define CEPH_MOUNT_OPT_INO32           (1<<8) /* 32 bit inos */
  38 #define CEPH_MOUNT_OPT_DCACHE          (1<<9) /* use dcache for readdir etc */
  39 #define CEPH_MOUNT_OPT_FSCACHE         (1<<10) /* use fscache */
  40 #define CEPH_MOUNT_OPT_NOPOOLPERM      (1<<11) /* no pool permission check */
  41 #define CEPH_MOUNT_OPT_MOUNTWAIT       (1<<12) /* mount waits if no mds is up */
  42 #define CEPH_MOUNT_OPT_NOQUOTADF       (1<<13) /* no root dir quota in statfs */
  43 #define CEPH_MOUNT_OPT_NOCOPYFROM      (1<<14) /* don't use RADOS 'copy-from' op */
  44
  45 #define CEPH_MOUNT_OPT_DEFAULT                  \
  46         (CEPH_MOUNT_OPT_DCACHE |                \
  47          CEPH_MOUNT_OPT_NOCOPYFROM)
  48
  49 #define ceph_set_mount_opt(fsc, opt) \
  50         (fsc)->mount_options->flags |= CEPH_MOUNT_OPT_##opt;
  51 #define ceph_test_mount_opt(fsc, opt) \
  52         (!!((fsc)->mount_options->flags & CEPH_MOUNT_OPT_##opt))
  53
  54 /* max size of osd read request, limited by libceph */
  55 #define CEPH_MAX_READ_SIZE              CEPH_MSG_MAX_DATA_LEN
  56 /* osd has a configurable limitaion of max write size.
  57  * CEPH_MSG_MAX_DATA_LEN should be small enough. */
  58 #define CEPH_MAX_WRITE_SIZE             CEPH_MSG_MAX_DATA_LEN
  59 #define CEPH_RASIZE_DEFAULT             (8192*1024)    /* max readahead */
  60 #define CEPH_MAX_READDIR_DEFAULT        1024
  61 #define CEPH_MAX_READDIR_BYTES_DEFAULT  (512*1024)
  62 #define CEPH_SNAPDIRNAME_DEFAULT        ".snap"
  63
  64 /*
  65  * Delay telling the MDS we no longer want caps, in case we reopen
  66  * the file.  Delay a minimum amount of time, even if we send a cap
  67  * message for some other reason.  Otherwise, take the oppotunity to
  68  * update the mds to avoid sending another message later.
  69  */
  70 #define CEPH_CAPS_WANTED_DELAY_MIN_DEFAULT      5  /* cap release delay */
  71 #define CEPH_CAPS_WANTED_DELAY_MAX_DEFAULT     60  /* cap release delay */
  72
  73 struct ceph_mount_options {
  74         int flags;
  75         int sb_flags;
  76
  77         int wsize;            /* max write size */
  78         int rsize;            /* max read size */
  79         int rasize;           /* max readahead */
  80         int congestion_kb;    /* max writeback in flight */
  81         int caps_wanted_delay_min, caps_wanted_delay_max;
  82         int max_readdir;       /* max readdir result (entires) */
  83         int max_readdir_bytes; /* max readdir result (bytes) */
  84
  85         /*
  86          * everything above this point can be memcmp'd; everything below
  87          * is handled in compare_mount_options()
  88          */
  89
  90         char *snapdir_name;   /* default ".snap" */
  91         char *mds_namespace;  /* default NULL */
  92         char *server_path;    /* default  "/" */
  93         char *fscache_uniq;   /* default NULL */
  94 };
  95
  96 struct ceph_fs_client {
  97         struct super_block *sb;
  98
  99         struct ceph_mount_options *mount_options;
 100         struct ceph_client *client;
 101
 102         unsigned long mount_state;
 103         int min_caps;                  /* min caps i added */
 104         loff_t max_file_size;
 105
 106         struct ceph_mds_client *mdsc;
 107
 108         /* writeback */
 109         mempool_t *wb_pagevec_pool;
 110         struct workqueue_struct *wb_wq;
 111         struct workqueue_struct *pg_inv_wq;
 112         struct workqueue_struct *trunc_wq;
 113         atomic_long_t writeback_count;
 114
 115 #ifdef CONFIG_DEBUG_FS
 116         struct dentry *debugfs_dentry_lru, *debugfs_caps;
 117         struct dentry *debugfs_congestion_kb;
 118         struct dentry *debugfs_bdi;
 119         struct dentry *debugfs_mdsc, *debugfs_mdsmap;
 120         struct dentry *debugfs_mds_sessions;
 121 #endif
 122
 123 #ifdef CONFIG_CEPH_FSCACHE
 124         struct fscache_cookie *fscache;
 125 #endif
 126 };
 127
 128
 129 /*
 130  * File i/o capability.  This tracks shared state with the metadata
 131  * server that allows us to cache or writeback attributes or to read
 132  * and write data.  For any given inode, we should have one or more
 133  * capabilities, one issued by each metadata server, and our
 134  * cumulative access is the OR of all issued capabilities.
 135  *
 136  * Each cap is referenced by the inode's i_caps rbtree and by per-mds
 137  * session capability lists.
 138  */
 139 struct ceph_cap {
 140         struct ceph_inode_info *ci;
 141         struct rb_node ci_node;          /* per-ci cap tree */
 142         struct ceph_mds_session *session;
 143         struct list_head session_caps;   /* per-session caplist */
 144         u64 cap_id;       /* unique cap id (mds provided) */
 145         union {
 146                 /* in-use caps */
 147                 struct {
 148                         int issued;       /* latest, from the mds */
 149                         int implemented;  /* implemented superset of
 150                                              issued (for revocation) */
 151                         int mds, mds_wanted;
 152                 };
 153                 /* caps to release */
 154                 struct {
 155                         u64 cap_ino;
 156                         int queue_release;
 157                 };
 158         };
 159         u32 seq, issue_seq, mseq;
 160         u32 cap_gen;      /* active/stale cycle */
 161         unsigned long last_used;
 162         struct list_head caps_item;
 163 };
 164
 165 #define CHECK_CAPS_NODELAY    1  /* do not delay any further */
 166 #define CHECK_CAPS_AUTHONLY   2  /* only check auth cap */
 167 #define CHECK_CAPS_FLUSH      4  /* flush any dirty caps */
 168
 169 struct ceph_cap_flush {
 170         u64 tid;
 171         int caps; /* 0 means capsnap */
 172         bool wake; /* wake up flush waiters when finish ? */
 173         struct list_head g_list; // global
 174         struct list_head i_list; // per inode
 175 };
 176
 177 /*
 178  * Snapped cap state that is pending flush to mds.  When a snapshot occurs,
 179  * we first complete any in-process sync writes and writeback any dirty
 180  * data before flushing the snapped state (tracked here) back to the MDS.
 181  */
 182 struct ceph_cap_snap {
 183         refcount_t nref;
 184         struct list_head ci_item;
 185
 186         struct ceph_cap_flush cap_flush;
 187
 188         u64 follows;
 189         int issued, dirty;
 190         struct ceph_snap_context *context;
 191
 192         umode_t mode;
 193         kuid_t uid;
 194         kgid_t gid;
 195
 196         struct ceph_buffer *xattr_blob;
 197         u64 xattr_version;
 198
 199         u64 size;
 200         struct timespec64 mtime, atime, ctime;
 201         u64 time_warp_seq;
 202         u64 truncate_size;
 203         u32 truncate_seq;
 204         int writing;   /* a sync write is still in progress */
 205         int dirty_pages;     /* dirty pages awaiting writeback */
 206         bool inline_data;
 207         bool need_flush;
 208 };
 209
 210 static inline void ceph_put_cap_snap(struct ceph_cap_snap *capsnap)
 211 {
 212         if (refcount_dec_and_test(&capsnap->nref)) {
 213                 if (capsnap->xattr_blob)
 214                         ceph_buffer_put(capsnap->xattr_blob);
 215                 kfree(capsnap);
 216         }
 217 }
 218
 219 /*
 220  * The frag tree describes how a directory is fragmented, potentially across
 221  * multiple metadata servers.  It is also used to indicate points where
 222  * metadata authority is delegated, and whether/where metadata is replicated.
 223  *
 224  * A _leaf_ frag will be present in the i_fragtree IFF there is
 225  * delegation info.  That is, if mds >= 0 || ndist > 0.
 226  */
 227 #define CEPH_MAX_DIRFRAG_REP 4
 228
 229 struct ceph_inode_frag {
 230         struct rb_node node;
 231
 232         /* fragtree state */
 233         u32 frag;
 234         int split_by;         /* i.e. 2^(split_by) children */
 235
 236         /* delegation and replication info */
 237         int mds;              /* -1 if same authority as parent */
 238         int ndist;            /* >0 if replicated */
 239         int dist[CEPH_MAX_DIRFRAG_REP];
 240 };
 241
 242 /*
 243  * We cache inode xattrs as an encoded blob until they are first used,
 244  * at which point we parse them into an rbtree.
 245  */
 246 struct ceph_inode_xattr {
 247         struct rb_node node;
 248
 249         const char *name;
 250         int name_len;
 251         const char *val;
 252         int val_len;
 253         int dirty;
 254
 255         int should_free_name;
 256         int should_free_val;
 257 };
 258
 259 /*
 260  * Ceph dentry state
 261  */
 262 struct ceph_dentry_info {
 263         struct ceph_mds_session *lease_session;
 264         int lease_shared_gen;
 265         u32 lease_gen;
 266         u32 lease_seq;
 267         unsigned long lease_renew_after, lease_renew_from;
 268         struct list_head lru;
 269         struct dentry *dentry;
 270         unsigned long time;
 271         u64 offset;
 272 };
 273
 274 struct ceph_inode_xattrs_info {
 275         /*
 276          * (still encoded) xattr blob. we avoid the overhead of parsing
 277          * this until someone actually calls getxattr, etc.
 278          *
 279          * blob->vec.iov_len == 4 implies there are no xattrs; blob ==
 280          * NULL means we don't know.
 281         */
 282         struct ceph_buffer *blob, *prealloc_blob;
 283
 284         struct rb_root index;
 285         bool dirty;
 286         int count;
 287         int names_size;
 288         int vals_size;
 289         u64 version, index_version;
 290 };
 291
 292 /*
 293  * Ceph inode.
 294  */
 295 struct ceph_inode_info {
 296         struct ceph_vino i_vino;   /* ceph ino + snap */
 297
 298         spinlock_t i_ceph_lock;
 299
 300         u64 i_version;
 301         u64 i_inline_version;
 302         u32 i_time_warp_seq;
 303
 304         unsigned i_ceph_flags;
 305         atomic64_t i_release_count;
 306         atomic64_t i_ordered_count;
 307         atomic64_t i_complete_seq[2];
 308
 309         struct ceph_dir_layout i_dir_layout;
 310         struct ceph_file_layout i_layout;
 311         char *i_symlink;
 312
 313         /* for dirs */
 314         struct timespec64 i_rctime;
 315         u64 i_rbytes, i_rfiles, i_rsubdirs;
 316         u64 i_files, i_subdirs;
 317
 318         /* quotas */
 319         u64 i_max_bytes, i_max_files;
 320
 321         struct rb_root i_fragtree;
 322         int i_fragtree_nsplits;
 323         struct mutex i_fragtree_mutex;
 324
 325         struct ceph_inode_xattrs_info i_xattrs;
 326
 327         /* capabilities.  protected _both_ by i_ceph_lock and cap->session's
 328          * s_mutex. */
 329         struct rb_root i_caps;           /* cap list */
 330         struct ceph_cap *i_auth_cap;     /* authoritative cap, if any */
 331         unsigned i_dirty_caps, i_flushing_caps;     /* mask of dirtied fields */
 332         struct list_head i_dirty_item, i_flushing_item;
 333         /* we need to track cap writeback on a per-cap-bit basis, to allow
 334          * overlapping, pipelined cap flushes to the mds.  we can probably
 335          * reduce the tid to 8 bits if we're concerned about inode size. */
 336         struct ceph_cap_flush *i_prealloc_cap_flush;
 337         struct list_head i_cap_flush_list;
 338         wait_queue_head_t i_cap_wq;      /* threads waiting on a capability */
 339         unsigned long i_hold_caps_min; /* jiffies */
 340         unsigned long i_hold_caps_max; /* jiffies */
 341         struct list_head i_cap_delay_list;  /* for delayed cap release to mds */
 342         struct ceph_cap_reservation i_cap_migration_resv;
 343         struct list_head i_cap_snaps;   /* snapped state pending flush to mds */
 344         struct ceph_snap_context *i_head_snapc;  /* set if wr_buffer_head > 0 or
 345                                                     dirty|flushing caps */
 346         unsigned i_snap_caps;           /* cap bits for snapped files */
 347
 348         int i_nr_by_mode[CEPH_FILE_MODE_BITS];  /* open file counts */
 349
 350         struct mutex i_truncate_mutex;
 351         u32 i_truncate_seq;        /* last truncate to smaller size */
 352         u64 i_truncate_size;       /*  and the size we last truncated down to */
 353         int i_truncate_pending;    /*  still need to call vmtruncate */
 354
 355         u64 i_max_size;            /* max file size authorized by mds */
 356         u64 i_reported_size; /* (max_)size reported to or requested of mds */
 357         u64 i_wanted_max_size;     /* offset we'd like to write too */
 358         u64 i_requested_max_size;  /* max_size we've requested */
 359
 360         /* held references to caps */
 361         int i_pin_ref;
 362         int i_rd_ref, i_rdcache_ref, i_wr_ref, i_wb_ref;
 363         int i_wrbuffer_ref, i_wrbuffer_ref_head;
 364         atomic_t i_filelock_ref;
 365         atomic_t i_shared_gen;       /* increment each time we get FILE_SHARED */
 366         u32 i_rdcache_gen;      /* incremented each time we get FILE_CACHE. */
 367         u32 i_rdcache_revoking; /* RDCACHE gen to async invalidate, if any */
 368
 369         struct list_head i_unsafe_dirops; /* uncommitted mds dir ops */
 370         struct list_head i_unsafe_iops;   /* uncommitted mds inode ops */
 371         spinlock_t i_unsafe_lock;
 372
 373         union {
 374                 struct ceph_snap_realm *i_snap_realm; /* snap realm (if caps) */
 375                 struct ceph_snapid_map *i_snapid_map; /* snapid -> dev_t */
 376         };
 377         int i_snap_realm_counter; /* snap realm (if caps) */
 378         struct list_head i_snap_realm_item;
 379         struct list_head i_snap_flush_item;
 380
 381         struct work_struct i_wb_work;  /* writeback work */
 382         struct work_struct i_pg_inv_work;  /* page invalidation work */
 383
 384         struct work_struct i_vmtruncate_work;
 385
 386 #ifdef CONFIG_CEPH_FSCACHE
 387         struct fscache_cookie *fscache;
 388         u32 i_fscache_gen;
 389 #endif
 390         struct inode vfs_inode; /* at end */
 391 };
 392
 393 static inline struct ceph_inode_info *ceph_inode(struct inode *inode)
 394 {
 395         return container_of(inode, struct ceph_inode_info, vfs_inode);
 396 }
 397
 398 static inline struct ceph_fs_client *ceph_inode_to_client(struct inode *inode)
 399 {
 400         return (struct ceph_fs_client *)inode->i_sb->s_fs_info;
 401 }
 402
 403 static inline struct ceph_fs_client *ceph_sb_to_client(struct super_block *sb)
 404 {
 405         return (struct ceph_fs_client *)sb->s_fs_info;
 406 }
 407
 408 static inline struct ceph_vino ceph_vino(struct inode *inode)
 409 {
 410         return ceph_inode(inode)->i_vino;
 411 }
 412
 413 /*
 414  * ino_t is <64 bits on many architectures, blech.
 415  *
 416  *               i_ino (kernel inode)   st_ino (userspace)
 417  * i386          32                     32
 418  * x86_64+ino32  64                     32
 419  * x86_64        64                     64
 420  */
 421 static inline u32 ceph_ino_to_ino32(__u64 vino)
 422 {
 423         u32 ino = vino & 0xffffffff;
 424         ino ^= vino >> 32;
 425         if (!ino)
 426                 ino = 2;
 427         return ino;
 428 }
 429
 430 /*
 431  * kernel i_ino value
 432  */
 433 static inline ino_t ceph_vino_to_ino(struct ceph_vino vino)
 434 {
 435 #if BITS_PER_LONG == 32
 436         return ceph_ino_to_ino32(vino.ino);
 437 #else
 438         return (ino_t)vino.ino;
 439 #endif
 440 }
 441
 442 /*
 443  * user-visible ino (stat, filldir)
 444  */
 445 #if BITS_PER_LONG == 32
 446 static inline ino_t ceph_translate_ino(struct super_block *sb, ino_t ino)
 447 {
 448         return ino;
 449 }
 450 #else
 451 static inline ino_t ceph_translate_ino(struct super_block *sb, ino_t ino)
 452 {
 453         if (ceph_test_mount_opt(ceph_sb_to_client(sb), INO32))
 454                 ino = ceph_ino_to_ino32(ino);
 455         return ino;
 456 }
 457 #endif
 458
 459
 460 /* for printf-style formatting */
 461 #define ceph_vinop(i) ceph_inode(i)->i_vino.ino, ceph_inode(i)->i_vino.snap
 462
 463 static inline u64 ceph_ino(struct inode *inode)
 464 {
 465         return ceph_inode(inode)->i_vino.ino;
 466 }
 467 static inline u64 ceph_snap(struct inode *inode)
 468 {
 469         return ceph_inode(inode)->i_vino.snap;
 470 }
 471
 472 static inline int ceph_ino_compare(struct inode *inode, void *data)
 473 {
 474         struct ceph_vino *pvino = (struct ceph_vino *)data;
 475         struct ceph_inode_info *ci = ceph_inode(inode);
 476         return ci->i_vino.ino == pvino->ino &&
 477                 ci->i_vino.snap == pvino->snap;
 478 }
 479
 480 static inline struct inode *ceph_find_inode(struct super_block *sb,
 481                                             struct ceph_vino vino)
 482 {
 483         ino_t t = ceph_vino_to_ino(vino);
 484         return ilookup5(sb, t, ceph_ino_compare, &vino);
 485 }
 486
 487
 488 /*
 489  * Ceph inode.
 490  */
 491 #define CEPH_I_DIR_ORDERED      (1 << 0)  /* dentries in dir are ordered */
 492 #define CEPH_I_NODELAY          (1 << 1)  /* do not delay cap release */
 493 #define CEPH_I_FLUSH            (1 << 2)  /* do not delay flush of dirty metadata */
 494 #define CEPH_I_NOFLUSH          (1 << 3)  /* do not flush dirty caps */
 495 #define CEPH_I_POOL_PERM        (1 << 4)  /* pool rd/wr bits are valid */
 496 #define CEPH_I_POOL_RD          (1 << 5)  /* can read from pool */
 497 #define CEPH_I_POOL_WR          (1 << 6)  /* can write to pool */
 498 #define CEPH_I_SEC_INITED       (1 << 7)  /* security initialized */
 499 #define CEPH_I_CAP_DROPPED      (1 << 8)  /* caps were forcibly dropped */
 500 #define CEPH_I_KICK_FLUSH       (1 << 9)  /* kick flushing caps */
 501 #define CEPH_I_FLUSH_SNAPS      (1 << 10) /* need flush snapss */
 502 #define CEPH_I_ERROR_WRITE      (1 << 11) /* have seen write errors */
 503 #define CEPH_I_ERROR_FILELOCK   (1 << 12) /* have seen file lock errors */
 504
 505
 506 /*
 507  * We set the ERROR_WRITE bit when we start seeing write errors on an inode
 508  * and then clear it when they start succeeding. Note that we do a lockless
 509  * check first, and only take the lock if it looks like it needs to be changed.
 510  * The write submission code just takes this as a hint, so we're not too
 511  * worried if a few slip through in either direction.
 512  */
 513 static inline void ceph_set_error_write(struct ceph_inode_info *ci)
 514 {
 515         if (!(READ_ONCE(ci->i_ceph_flags) & CEPH_I_ERROR_WRITE)) {
 516                 spin_lock(&ci->i_ceph_lock);
 517                 ci->i_ceph_flags |= CEPH_I_ERROR_WRITE;
 518                 spin_unlock(&ci->i_ceph_lock);
 519         }
 520 }
 521
 522 static inline void ceph_clear_error_write(struct ceph_inode_info *ci)
 523 {
 524         if (READ_ONCE(ci->i_ceph_flags) & CEPH_I_ERROR_WRITE) {
 525                 spin_lock(&ci->i_ceph_lock);
 526                 ci->i_ceph_flags &= ~CEPH_I_ERROR_WRITE;
 527                 spin_unlock(&ci->i_ceph_lock);
 528         }
 529 }
 530
 531 static inline void __ceph_dir_set_complete(struct ceph_inode_info *ci,
 532                                            long long release_count,
 533                                            long long ordered_count)
 534 {
 535         smp_mb__before_atomic();
 536         atomic64_set(&ci->i_complete_seq[0], release_count);
 537         atomic64_set(&ci->i_complete_seq[1], ordered_count);
 538 }
 539
 540 static inline void __ceph_dir_clear_complete(struct ceph_inode_info *ci)
 541 {
 542         atomic64_inc(&ci->i_release_count);
 543 }
 544
 545 static inline void __ceph_dir_clear_ordered(struct ceph_inode_info *ci)
 546 {
 547         atomic64_inc(&ci->i_ordered_count);
 548 }
 549
 550 static inline bool __ceph_dir_is_complete(struct ceph_inode_info *ci)
 551 {
 552         return atomic64_read(&ci->i_complete_seq[0]) ==
 553                 atomic64_read(&ci->i_release_count);
 554 }
 555
 556 static inline bool __ceph_dir_is_complete_ordered(struct ceph_inode_info *ci)
 557 {
 558         return  atomic64_read(&ci->i_complete_seq[0]) ==
 559                 atomic64_read(&ci->i_release_count) &&
 560                 atomic64_read(&ci->i_complete_seq[1]) ==
 561                 atomic64_read(&ci->i_ordered_count);
 562 }
 563
 564 static inline void ceph_dir_clear_complete(struct inode *inode)
 565 {
 566         __ceph_dir_clear_complete(ceph_inode(inode));
 567 }
 568
 569 static inline void ceph_dir_clear_ordered(struct inode *inode)
 570 {
 571         __ceph_dir_clear_ordered(ceph_inode(inode));
 572 }
 573
 574 static inline bool ceph_dir_is_complete_ordered(struct inode *inode)
 575 {
 576         bool ret = __ceph_dir_is_complete_ordered(ceph_inode(inode));
 577         smp_rmb();
 578         return ret;
 579 }
 580
 581 /* find a specific frag @f */
 582 extern struct ceph_inode_frag *__ceph_find_frag(struct ceph_inode_info *ci,
 583                                                 u32 f);
 584
 585 /*
 586  * choose fragment for value @v.  copy frag content to pfrag, if leaf
 587  * exists
 588  */
 589 extern u32 ceph_choose_frag(struct ceph_inode_info *ci, u32 v,
 590                             struct ceph_inode_frag *pfrag,
 591                             int *found);
 592
 593 static inline struct ceph_dentry_info *ceph_dentry(struct dentry *dentry)
 594 {
 595         return (struct ceph_dentry_info *)dentry->d_fsdata;
 596 }
 597
 598 /*
 599  * caps helpers
 600  */
 601 static inline bool __ceph_is_any_real_caps(struct ceph_inode_info *ci)
 602 {
 603         return !RB_EMPTY_ROOT(&ci->i_caps);
 604 }
 605
 606 extern int __ceph_caps_issued(struct ceph_inode_info *ci, int *implemented);
 607 extern int __ceph_caps_issued_mask(struct ceph_inode_info *ci, int mask, int t);
 608 extern int __ceph_caps_issued_other(struct ceph_inode_info *ci,
 609                                     struct ceph_cap *cap);
 610
 611 static inline int ceph_caps_issued(struct ceph_inode_info *ci)
 612 {
 613         int issued;
 614         spin_lock(&ci->i_ceph_lock);
 615         issued = __ceph_caps_issued(ci, NULL);
 616         spin_unlock(&ci->i_ceph_lock);
 617         return issued;
 618 }
 619
 620 static inline int ceph_caps_issued_mask(struct ceph_inode_info *ci, int mask,
 621                                         int touch)
 622 {
 623         int r;
 624         spin_lock(&ci->i_ceph_lock);
 625         r = __ceph_caps_issued_mask(ci, mask, touch);
 626         spin_unlock(&ci->i_ceph_lock);
 627         return r;
 628 }
 629
 630 static inline int __ceph_caps_dirty(struct ceph_inode_info *ci)
 631 {
 632         return ci->i_dirty_caps | ci->i_flushing_caps;
 633 }
 634 extern struct ceph_cap_flush *ceph_alloc_cap_flush(void);
 635 extern void ceph_free_cap_flush(struct ceph_cap_flush *cf);
 636 extern int __ceph_mark_dirty_caps(struct ceph_inode_info *ci, int mask,
 637                                   struct ceph_cap_flush **pcf);
 638
 639 extern int __ceph_caps_revoking_other(struct ceph_inode_info *ci,
 640                                       struct ceph_cap *ocap, int mask);
 641 extern int ceph_caps_revoking(struct ceph_inode_info *ci, int mask);
 642 extern int __ceph_caps_used(struct ceph_inode_info *ci);
 643
 644 extern int __ceph_caps_file_wanted(struct ceph_inode_info *ci);
 645
 646 /*
 647  * wanted, by virtue of open file modes AND cap refs (buffered/cached data)
 648  */
 649 static inline int __ceph_caps_wanted(struct ceph_inode_info *ci)
 650 {
 651         int w = __ceph_caps_file_wanted(ci) | __ceph_caps_used(ci);
 652         if (w & CEPH_CAP_FILE_BUFFER)
 653                 w |= CEPH_CAP_FILE_EXCL;  /* we want EXCL if dirty data */
 654         return w;
 655 }
 656
 657 /* what the mds thinks we want */
 658 extern int __ceph_caps_mds_wanted(struct ceph_inode_info *ci, bool check);
 659
 660 extern void ceph_caps_init(struct ceph_mds_client *mdsc);
 661 extern void ceph_caps_finalize(struct ceph_mds_client *mdsc);
 662 extern void ceph_adjust_min_caps(struct ceph_mds_client *mdsc, int delta);
 663 extern int ceph_reserve_caps(struct ceph_mds_client *mdsc,
 664                              struct ceph_cap_reservation *ctx, int need);
 665 extern void ceph_unreserve_caps(struct ceph_mds_client *mdsc,
 666                                struct ceph_cap_reservation *ctx);
 667 extern void ceph_reservation_status(struct ceph_fs_client *client,
 668                                     int *total, int *avail, int *used,
 669                                     int *reserved, int *min);
 670
 671
 672
 673 /*
 674  * we keep buffered readdir results attached to file->private_data
 675  */
 676 #define CEPH_F_SYNC     1
 677 #define CEPH_F_ATEND    2
 678
 679 struct ceph_file_info {
 680         short fmode;     /* initialized on open */
 681         short flags;     /* CEPH_F_* */
 682
 683         spinlock_t rw_contexts_lock;
 684         struct list_head rw_contexts;
 685 };
 686
 687 struct ceph_dir_file_info {
 688         struct ceph_file_info file_info;
 689
 690         /* readdir: position within the dir */
 691         u32 frag;
 692         struct ceph_mds_request *last_readdir;
 693
 694         /* readdir: position within a frag */
 695         unsigned next_offset;  /* offset of next chunk (last_name's + 1) */
 696         char *last_name;       /* last entry in previous chunk */
 697         long long dir_release_count;
 698         long long dir_ordered_count;
 699         int readdir_cache_idx;
 700
 701         /* used for -o dirstat read() on directory thing */
 702         char *dir_info;
 703         int dir_info_len;
 704 };
 705
 706 struct ceph_rw_context {
 707         struct list_head list;
 708         struct task_struct *thread;
 709         int caps;
 710 };
 711
 712 #define CEPH_DEFINE_RW_CONTEXT(_name, _caps)    \
 713         struct ceph_rw_context _name = {        \
 714                 .thread = current,              \
 715                 .caps = _caps,                  \
 716         }
 717
 718 static inline void ceph_add_rw_context(struct ceph_file_info *cf,
 719                                        struct ceph_rw_context *ctx)
 720 {
 721         spin_lock(&cf->rw_contexts_lock);
 722         list_add(&ctx->list, &cf->rw_contexts);
 723         spin_unlock(&cf->rw_contexts_lock);
 724 }
 725
 726 static inline void ceph_del_rw_context(struct ceph_file_info *cf,
 727                                        struct ceph_rw_context *ctx)
 728 {
 729         spin_lock(&cf->rw_contexts_lock);
 730         list_del(&ctx->list);
 731         spin_unlock(&cf->rw_contexts_lock);
 732 }
 733
 734 static inline struct ceph_rw_context*
 735 ceph_find_rw_context(struct ceph_file_info *cf)
 736 {
 737         struct ceph_rw_context *ctx, *found = NULL;
 738         spin_lock(&cf->rw_contexts_lock);
 739         list_for_each_entry(ctx, &cf->rw_contexts, list) {
 740                 if (ctx->thread == current) {
 741                         found = ctx;
 742                         break;
 743                 }
 744         }
 745         spin_unlock(&cf->rw_contexts_lock);
 746         return found;
 747 }
 748
 749 struct ceph_readdir_cache_control {
 750         struct page  *page;
 751         struct dentry **dentries;
 752         int index;
 753 };
 754
 755 /*
 756  * A "snap realm" describes a subset of the file hierarchy sharing
 757  * the same set of snapshots that apply to it.  The realms themselves
 758  * are organized into a hierarchy, such that children inherit (some of)
 759  * the snapshots of their parents.
 760  *
 761  * All inodes within the realm that have capabilities are linked into a
 762  * per-realm list.
 763  */
 764 struct ceph_snap_realm {
 765         u64 ino;
 766         struct inode *inode;
 767         atomic_t nref;
 768         struct rb_node node;
 769
 770         u64 created, seq;
 771         u64 parent_ino;
 772         u64 parent_since;   /* snapid when our current parent became so */
 773
 774         u64 *prior_parent_snaps;      /* snaps inherited from any parents we */
 775         u32 num_prior_parent_snaps;   /*  had prior to parent_since */
 776         u64 *snaps;                   /* snaps specific to this realm */
 777         u32 num_snaps;
 778
 779         struct ceph_snap_realm *parent;
 780         struct list_head children;       /* list of child realms */
 781         struct list_head child_item;
 782
 783         struct list_head empty_item;     /* if i have ref==0 */
 784
 785         struct list_head dirty_item;     /* if realm needs new context */
 786
 787         /* the current set of snaps for this realm */
 788         struct ceph_snap_context *cached_context;
 789
 790         struct list_head inodes_with_caps;
 791         spinlock_t inodes_with_caps_lock;
 792 };
 793
 794 static inline int default_congestion_kb(void)
 795 {
 796         int congestion_kb;
 797
 798         /*
 799          * Copied from NFS
 800          *
 801          * congestion size, scale with available memory.
 802          *
 803          *  64MB:    8192k
 804          * 128MB:   11585k
 805          * 256MB:   16384k
 806          * 512MB:   23170k
 807          *   1GB:   32768k
 808          *   2GB:   46340k
 809          *   4GB:   65536k
 810          *   8GB:   92681k
 811          *  16GB:  131072k
 812          *
 813          * This allows larger machines to have larger/more transfers.
 814          * Limit the default to 256M
 815          */
 816         congestion_kb = (16*int_sqrt(totalram_pages())) << (PAGE_SHIFT-10);
 817         if (congestion_kb > 256*1024)
 818                 congestion_kb = 256*1024;
 819
 820         return congestion_kb;
 821 }
 822
 823
 824
 825 /* snap.c */
 826 struct ceph_snap_realm *ceph_lookup_snap_realm(struct ceph_mds_client *mdsc,
 827                                                u64 ino);
 828 extern void ceph_get_snap_realm(struct ceph_mds_client *mdsc,
 829                                 struct ceph_snap_realm *realm);
 830 extern void ceph_put_snap_realm(struct ceph_mds_client *mdsc,
 831                                 struct ceph_snap_realm *realm);
 832 extern int ceph_update_snap_trace(struct ceph_mds_client *m,
 833                                   void *p, void *e, bool deletion,
 834                                   struct ceph_snap_realm **realm_ret);
 835 extern void ceph_handle_snap(struct ceph_mds_client *mdsc,
 836                              struct ceph_mds_session *session,
 837                              struct ceph_msg *msg);
 838 extern void ceph_queue_cap_snap(struct ceph_inode_info *ci);
 839 extern int __ceph_finish_cap_snap(struct ceph_inode_info *ci,
 840                                   struct ceph_cap_snap *capsnap);
 841 extern void ceph_cleanup_empty_realms(struct ceph_mds_client *mdsc);
 842
 843 extern struct ceph_snapid_map *ceph_get_snapid_map(struct ceph_mds_client *mdsc,
 844                                                    u64 snap);
 845 extern void ceph_put_snapid_map(struct ceph_mds_client* mdsc,
 846                                 struct ceph_snapid_map *sm);
 847 extern void ceph_trim_snapid_map(struct ceph_mds_client *mdsc);
 848 extern void ceph_cleanup_snapid_map(struct ceph_mds_client *mdsc);
 849
 850
 851 /*
 852  * a cap_snap is "pending" if it is still awaiting an in-progress
 853  * sync write (that may/may not still update size, mtime, etc.).
 854  */
 855 static inline bool __ceph_have_pending_cap_snap(struct ceph_inode_info *ci)
 856 {
 857         return !list_empty(&ci->i_cap_snaps) &&
 858                list_last_entry(&ci->i_cap_snaps, struct ceph_cap_snap,
 859                                ci_item)->writing;
 860 }
 861
 862 /* inode.c */
 863 extern const struct inode_operations ceph_file_iops;
 864
 865 extern struct inode *ceph_alloc_inode(struct super_block *sb);
 866 extern void ceph_destroy_inode(struct inode *inode);
 867 extern int ceph_drop_inode(struct inode *inode);
 868
 869 extern struct inode *ceph_get_inode(struct super_block *sb,
 870                                     struct ceph_vino vino);
 871 extern struct inode *ceph_get_snapdir(struct inode *parent);
 872 extern int ceph_fill_file_size(struct inode *inode, int issued,
 873                                u32 truncate_seq, u64 truncate_size, u64 size);
 874 extern void ceph_fill_file_time(struct inode *inode, int issued,
 875                                 u64 time_warp_seq, struct timespec64 *ctime,
 876                                 struct timespec64 *mtime,
 877                                 struct timespec64 *atime);
 878 extern int ceph_fill_trace(struct super_block *sb,
 879                            struct ceph_mds_request *req);
 880 extern int ceph_readdir_prepopulate(struct ceph_mds_request *req,
 881                                     struct ceph_mds_session *session);
 882
 883 extern int ceph_inode_holds_cap(struct inode *inode, int mask);
 884
 885 extern bool ceph_inode_set_size(struct inode *inode, loff_t size);
 886 extern void __ceph_do_pending_vmtruncate(struct inode *inode);
 887 extern void ceph_queue_vmtruncate(struct inode *inode);
 888
 889 extern void ceph_queue_invalidate(struct inode *inode);
 890 extern void ceph_queue_writeback(struct inode *inode);
 891
 892 extern int __ceph_do_getattr(struct inode *inode, struct page *locked_page,
 893                              int mask, bool force);
 894 static inline int ceph_do_getattr(struct inode *inode, int mask, bool force)
 895 {
 896         return __ceph_do_getattr(inode, NULL, mask, force);
 897 }
 898 extern int ceph_permission(struct inode *inode, int mask);
 899 extern int __ceph_setattr(struct inode *inode, struct iattr *attr);
 900 extern int ceph_setattr(struct dentry *dentry, struct iattr *attr);
 901 extern int ceph_getattr(const struct path *path, struct kstat *stat,
 902                         u32 request_mask, unsigned int flags);
 903
 904 /* xattr.c */
 905 int __ceph_setxattr(struct inode *, const char *, const void *, size_t, int);
 906 ssize_t __ceph_getxattr(struct inode *, const char *, void *, size_t);
 907 extern ssize_t ceph_listxattr(struct dentry *, char *, size_t);
 908 extern void __ceph_build_xattrs_blob(struct ceph_inode_info *ci);
 909 extern void __ceph_destroy_xattrs(struct ceph_inode_info *ci);
 910 extern void __init ceph_xattr_init(void);
 911 extern void ceph_xattr_exit(void);
 912 extern const struct xattr_handler *ceph_xattr_handlers[];
 913
 914 #ifdef CONFIG_SECURITY
 915 extern bool ceph_security_xattr_deadlock(struct inode *in);
 916 extern bool ceph_security_xattr_wanted(struct inode *in);
 917 #else
 918 static inline bool ceph_security_xattr_deadlock(struct inode *in)
 919 {
 920         return false;
 921 }
 922 static inline bool ceph_security_xattr_wanted(struct inode *in)
 923 {
 924         return false;
 925 }
 926 #endif
 927
 928 /* acl.c */
 929 struct ceph_acls_info {
 930         void *default_acl;
 931         void *acl;
 932         struct ceph_pagelist *pagelist;
 933 };
 934
 935 #ifdef CONFIG_CEPH_FS_POSIX_ACL
 936
 937 struct posix_acl *ceph_get_acl(struct inode *, int);
 938 int ceph_set_acl(struct inode *inode, struct posix_acl *acl, int type);
 939 int ceph_pre_init_acls(struct inode *dir, umode_t *mode,
 940                        struct ceph_acls_info *info);
 941 void ceph_init_inode_acls(struct inode *inode, struct ceph_acls_info *info);
 942 void ceph_release_acls_info(struct ceph_acls_info *info);
 943
 944 static inline void ceph_forget_all_cached_acls(struct inode *inode)
 945 {
 946        forget_all_cached_acls(inode);
 947 }
 948
 949 #else
 950
 951 #define ceph_get_acl NULL
 952 #define ceph_set_acl NULL
 953
 954 static inline int ceph_pre_init_acls(struct inode *dir, umode_t *mode,
 955                                      struct ceph_acls_info *info)
 956 {
 957         return 0;
 958 }
 959 static inline void ceph_init_inode_acls(struct inode *inode,
 960                                         struct ceph_acls_info *info)
 961 {
 962 }
 963 static inline void ceph_release_acls_info(struct ceph_acls_info *info)
 964 {
 965 }
 966 static inline int ceph_acl_chmod(struct dentry *dentry, struct inode *inode)
 967 {
 968         return 0;
 969 }
 970
 971 static inline void ceph_forget_all_cached_acls(struct inode *inode)
 972 {
 973 }
 974
 975 #endif
 976
 977 /* caps.c */
 978 extern const char *ceph_cap_string(int c);
 979 extern void ceph_handle_caps(struct ceph_mds_session *session,
 980                              struct ceph_msg *msg);
 981 extern struct ceph_cap *ceph_get_cap(struct ceph_mds_client *mdsc,
 982                                      struct ceph_cap_reservation *ctx);
 983 extern void ceph_add_cap(struct inode *inode,
 984                          struct ceph_mds_session *session, u64 cap_id,
 985                          int fmode, unsigned issued, unsigned wanted,
 986                          unsigned cap, unsigned seq, u64 realmino, int flags,
 987                          struct ceph_cap **new_cap);
 988 extern void __ceph_remove_cap(struct ceph_cap *cap, bool queue_release);
 989 extern void ceph_put_cap(struct ceph_mds_client *mdsc,
 990                          struct ceph_cap *cap);
 991 extern int ceph_is_any_caps(struct inode *inode);
 992
 993 extern void ceph_queue_caps_release(struct inode *inode);
 994 extern int ceph_write_inode(struct inode *inode, struct writeback_control *wbc);
 995 extern int ceph_fsync(struct file *file, loff_t start, loff_t end,
 996                       int datasync);
 997 extern void ceph_early_kick_flushing_caps(struct ceph_mds_client *mdsc,
 998                                           struct ceph_mds_session *session);
 999 extern void ceph_kick_flushing_caps(struct ceph_mds_client *mdsc,
1000                                     struct ceph_mds_session *session);
1001 extern struct ceph_cap *ceph_get_cap_for_mds(struct ceph_inode_info *ci,
1002                                              int mds);
1003 extern int ceph_get_cap_mds(struct inode *inode);
1004 extern void ceph_get_cap_refs(struct ceph_inode_info *ci, int caps);
1005 extern void ceph_put_cap_refs(struct ceph_inode_info *ci, int had);
1006 extern void ceph_put_wrbuffer_cap_refs(struct ceph_inode_info *ci, int nr,
1007                                        struct ceph_snap_context *snapc);
1008 extern void ceph_flush_snaps(struct ceph_inode_info *ci,
1009                              struct ceph_mds_session **psession);
1010 extern bool __ceph_should_report_size(struct ceph_inode_info *ci);
1011 extern void ceph_check_caps(struct ceph_inode_info *ci, int flags,
1012                             struct ceph_mds_session *session);
1013 extern void ceph_check_delayed_caps(struct ceph_mds_client *mdsc);
1014 extern void ceph_flush_dirty_caps(struct ceph_mds_client *mdsc);
1015 extern int  ceph_drop_caps_for_unlink(struct inode *inode);
1016 extern int ceph_encode_inode_release(void **p, struct inode *inode,
1017                                      int mds, int drop, int unless, int force);
1018 extern int ceph_encode_dentry_release(void **p, struct dentry *dn,
1019                                       struct inode *dir,
1020                                       int mds, int drop, int unless);
1021
1022 extern int ceph_get_caps(struct ceph_inode_info *ci, int need, int want,
1023                          loff_t endoff, int *got, struct page **pinned_page);
1024 extern int ceph_try_get_caps(struct ceph_inode_info *ci,
1025                              int need, int want, bool nonblock, int *got);
1026
1027 /* for counting open files by mode */
1028 extern void __ceph_get_fmode(struct ceph_inode_info *ci, int mode);
1029 extern void ceph_put_fmode(struct ceph_inode_info *ci, int mode);
1030
1031 /* addr.c */
1032 extern const struct address_space_operations ceph_aops;
1033 extern int ceph_mmap(struct file *file, struct vm_area_struct *vma);
1034 extern int ceph_uninline_data(struct file *filp, struct page *locked_page);
1035 extern int ceph_pool_perm_check(struct ceph_inode_info *ci, int need);
1036 extern void ceph_pool_perm_destroy(struct ceph_mds_client* mdsc);
1037
1038 /* file.c */
1039 extern const struct file_operations ceph_file_fops;
1040
1041 extern int ceph_renew_caps(struct inode *inode);
1042 extern int ceph_open(struct inode *inode, struct file *file);
1043 extern int ceph_atomic_open(struct inode *dir, struct dentry *dentry,
1044                             struct file *file, unsigned flags, umode_t mode);
1045 extern int ceph_release(struct inode *inode, struct file *filp);
1046 extern void ceph_fill_inline_data(struct inode *inode, struct page *locked_page,
1047                                   char *data, size_t len);
1048
1049 /* dir.c */
1050 extern const struct file_operations ceph_dir_fops;
1051 extern const struct file_operations ceph_snapdir_fops;
1052 extern const struct inode_operations ceph_dir_iops;
1053 extern const struct inode_operations ceph_snapdir_iops;
1054 extern const struct dentry_operations ceph_dentry_ops;
1055
1056 extern loff_t ceph_make_fpos(unsigned high, unsigned off, bool hash_order);
1057 extern int ceph_handle_notrace_create(struct inode *dir, struct dentry *dentry);
1058 extern int ceph_handle_snapdir(struct ceph_mds_request *req,
1059                                struct dentry *dentry, int err);
1060 extern struct dentry *ceph_finish_lookup(struct ceph_mds_request *req,
1061                                          struct dentry *dentry, int err);
1062
1063 extern void ceph_dentry_lru_add(struct dentry *dn);
1064 extern void ceph_dentry_lru_touch(struct dentry *dn);
1065 extern void ceph_dentry_lru_del(struct dentry *dn);
1066 extern void ceph_invalidate_dentry_lease(struct dentry *dentry);
1067 extern unsigned ceph_dentry_hash(struct inode *dir, struct dentry *dn);
1068 extern void ceph_readdir_cache_release(struct ceph_readdir_cache_control *ctl);
1069
1070 /* ioctl.c */
1071 extern long ceph_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1072
1073 /* export.c */
1074 extern const struct export_operations ceph_export_ops;
1075
1076 /* locks.c */
1077 extern __init void ceph_flock_init(void);
1078 extern int ceph_lock(struct file *file, int cmd, struct file_lock *fl);
1079 extern int ceph_flock(struct file *file, int cmd, struct file_lock *fl);
1080 extern void ceph_count_locks(struct inode *inode, int *p_num, int *f_num);
1081 extern int ceph_encode_locks_to_buffer(struct inode *inode,
1082                                        struct ceph_filelock *flocks,
1083                                        int num_fcntl_locks,
1084                                        int num_flock_locks);
1085 extern int ceph_locks_to_pagelist(struct ceph_filelock *flocks,
1086                                   struct ceph_pagelist *pagelist,
1087                                   int num_fcntl_locks, int num_flock_locks);
1088
1089 /* debugfs.c */
1090 extern int ceph_fs_debugfs_init(struct ceph_fs_client *client);
1091 extern void ceph_fs_debugfs_cleanup(struct ceph_fs_client *client);
1092
1093 /* quota.c */
1094 static inline bool __ceph_has_any_quota(struct ceph_inode_info *ci)
1095 {
1096         return ci->i_max_files || ci->i_max_bytes;
1097 }
1098
1099 extern void ceph_adjust_quota_realms_count(struct inode *inode, bool inc);
1100
1101 static inline void __ceph_update_quota(struct ceph_inode_info *ci,
1102                                        u64 max_bytes, u64 max_files)
1103 {
1104         bool had_quota, has_quota;
1105         had_quota = __ceph_has_any_quota(ci);
1106         ci->i_max_bytes = max_bytes;
1107         ci->i_max_files = max_files;
1108         has_quota = __ceph_has_any_quota(ci);
1109
1110         if (had_quota != has_quota)
1111                 ceph_adjust_quota_realms_count(&ci->vfs_inode, has_quota);
1112 }
1113
1114 extern void ceph_handle_quota(struct ceph_mds_client *mdsc,
1115                               struct ceph_mds_session *session,
1116                               struct ceph_msg *msg);
1117 extern bool ceph_quota_is_max_files_exceeded(struct inode *inode);
1118 extern bool ceph_quota_is_same_realm(struct inode *old, struct inode *new);
1119 extern bool ceph_quota_is_max_bytes_exceeded(struct inode *inode,
1120                                              loff_t newlen);
1121 extern bool ceph_quota_is_max_bytes_approaching(struct inode *inode,
1122                                                 loff_t newlen);
1123 extern bool ceph_quota_update_statfs(struct ceph_fs_client *fsc,
1124                                      struct kstatfs *buf);
1125
1126 #endif /* _FS_CEPH_SUPER_H */