1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _FS_CEPH_SUPER_H
3 #define _FS_CEPH_SUPER_H
5 #include <linux/ceph/ceph_debug.h>
7 #include <asm/unaligned.h>
8 #include <linux/backing-dev.h>
9 #include <linux/completion.h>
10 #include <linux/exportfs.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 #include <linux/security.h>
21 #include <linux/ceph/libceph.h>
23 #ifdef CONFIG_CEPH_FSCACHE
24 #define FSCACHE_USE_NEW_IO_API
25 #include <linux/fscache.h>
28 /* f_type in struct statfs */
29 #define CEPH_SUPER_MAGIC 0x00c36400
31 /* large granularity for statfs utilization stats to facilitate
32 * large volume sizes on 32-bit machines. */
33 #define CEPH_BLOCK_SHIFT 22 /* 4 MB */
34 #define CEPH_BLOCK (1 << CEPH_BLOCK_SHIFT)
36 #define CEPH_MOUNT_OPT_CLEANRECOVER (1<<1) /* auto reonnect (clean mode) after blocklisted */
37 #define CEPH_MOUNT_OPT_DIRSTAT (1<<4) /* `cat dirname` for stats */
38 #define CEPH_MOUNT_OPT_RBYTES (1<<5) /* dir st_bytes = rbytes */
39 #define CEPH_MOUNT_OPT_NOASYNCREADDIR (1<<7) /* no dcache readdir */
40 #define CEPH_MOUNT_OPT_INO32 (1<<8) /* 32 bit inos */
41 #define CEPH_MOUNT_OPT_DCACHE (1<<9) /* use dcache for readdir etc */
42 #define CEPH_MOUNT_OPT_FSCACHE (1<<10) /* use fscache */
43 #define CEPH_MOUNT_OPT_NOPOOLPERM (1<<11) /* no pool permission check */
44 #define CEPH_MOUNT_OPT_MOUNTWAIT (1<<12) /* mount waits if no mds is up */
45 #define CEPH_MOUNT_OPT_NOQUOTADF (1<<13) /* no root dir quota in statfs */
46 #define CEPH_MOUNT_OPT_NOCOPYFROM (1<<14) /* don't use RADOS 'copy-from' op */
47 #define CEPH_MOUNT_OPT_ASYNC_DIROPS (1<<15) /* allow async directory ops */
49 #define CEPH_MOUNT_OPT_DEFAULT \
50 (CEPH_MOUNT_OPT_DCACHE | \
51 CEPH_MOUNT_OPT_NOCOPYFROM)
53 #define ceph_set_mount_opt(fsc, opt) \
54 (fsc)->mount_options->flags |= CEPH_MOUNT_OPT_##opt
55 #define ceph_clear_mount_opt(fsc, opt) \
56 (fsc)->mount_options->flags &= ~CEPH_MOUNT_OPT_##opt
57 #define ceph_test_mount_opt(fsc, opt) \
58 (!!((fsc)->mount_options->flags & CEPH_MOUNT_OPT_##opt))
60 /* max size of osd read request, limited by libceph */
61 #define CEPH_MAX_READ_SIZE CEPH_MSG_MAX_DATA_LEN
62 /* osd has a configurable limitaion of max write size.
63 * CEPH_MSG_MAX_DATA_LEN should be small enough. */
64 #define CEPH_MAX_WRITE_SIZE CEPH_MSG_MAX_DATA_LEN
65 #define CEPH_RASIZE_DEFAULT (8192*1024) /* max readahead */
66 #define CEPH_MAX_READDIR_DEFAULT 1024
67 #define CEPH_MAX_READDIR_BYTES_DEFAULT (512*1024)
68 #define CEPH_SNAPDIRNAME_DEFAULT ".snap"
71 * Delay telling the MDS we no longer want caps, in case we reopen
72 * the file. Delay a minimum amount of time, even if we send a cap
73 * message for some other reason. Otherwise, take the oppotunity to
74 * update the mds to avoid sending another message later.
76 #define CEPH_CAPS_WANTED_DELAY_MIN_DEFAULT 5 /* cap release delay */
77 #define CEPH_CAPS_WANTED_DELAY_MAX_DEFAULT 60 /* cap release delay */
79 struct ceph_mount_options {
82 unsigned int wsize; /* max write size */
83 unsigned int rsize; /* max read size */
84 unsigned int rasize; /* max readahead */
85 unsigned int congestion_kb; /* max writeback in flight */
86 unsigned int caps_wanted_delay_min, caps_wanted_delay_max;
88 unsigned int max_readdir; /* max readdir result (entries) */
89 unsigned int max_readdir_bytes; /* max readdir result (bytes) */
92 * everything above this point can be memcmp'd; everything below
93 * is handled in compare_mount_options()
96 char *snapdir_name; /* default ".snap" */
97 char *mds_namespace; /* default NULL */
98 char *server_path; /* default NULL (means "/") */
99 char *fscache_uniq; /* default NULL */
102 struct ceph_fs_client {
103 struct super_block *sb;
105 struct list_head metric_wakeup;
107 struct ceph_mount_options *mount_options;
108 struct ceph_client *client;
114 bool have_copy_from2;
117 loff_t max_file_size;
119 struct ceph_mds_client *mdsc;
121 atomic_long_t writeback_count;
123 struct workqueue_struct *inode_wq;
124 struct workqueue_struct *cap_wq;
126 #ifdef CONFIG_DEBUG_FS
127 struct dentry *debugfs_dentry_lru, *debugfs_caps;
128 struct dentry *debugfs_congestion_kb;
129 struct dentry *debugfs_bdi;
130 struct dentry *debugfs_mdsc, *debugfs_mdsmap;
131 struct dentry *debugfs_metric;
132 struct dentry *debugfs_status;
133 struct dentry *debugfs_mds_sessions;
136 #ifdef CONFIG_CEPH_FSCACHE
137 struct fscache_cookie *fscache;
143 * File i/o capability. This tracks shared state with the metadata
144 * server that allows us to cache or writeback attributes or to read
145 * and write data. For any given inode, we should have one or more
146 * capabilities, one issued by each metadata server, and our
147 * cumulative access is the OR of all issued capabilities.
149 * Each cap is referenced by the inode's i_caps rbtree and by per-mds
150 * session capability lists.
153 struct ceph_inode_info *ci;
154 struct rb_node ci_node; /* per-ci cap tree */
155 struct ceph_mds_session *session;
156 struct list_head session_caps; /* per-session caplist */
157 u64 cap_id; /* unique cap id (mds provided) */
161 int issued; /* latest, from the mds */
162 int implemented; /* implemented superset of
163 issued (for revocation) */
164 int mds; /* mds index for this cap */
165 int mds_wanted; /* caps wanted from this mds */
167 /* caps to release */
173 u32 seq, issue_seq, mseq;
174 u32 cap_gen; /* active/stale cycle */
175 unsigned long last_used;
176 struct list_head caps_item;
179 #define CHECK_CAPS_AUTHONLY 1 /* only check auth cap */
180 #define CHECK_CAPS_FLUSH 2 /* flush any dirty caps */
181 #define CHECK_CAPS_NOINVAL 4 /* don't invalidate pagecache */
183 struct ceph_cap_flush {
186 bool wake; /* wake up flush waiters when finish ? */
187 bool is_capsnap; /* true means capsnap */
188 struct list_head g_list; // global
189 struct list_head i_list; // per inode
193 * Snapped cap state that is pending flush to mds. When a snapshot occurs,
194 * we first complete any in-process sync writes and writeback any dirty
195 * data before flushing the snapped state (tracked here) back to the MDS.
197 struct ceph_cap_snap {
199 struct list_head ci_item;
201 struct ceph_cap_flush cap_flush;
205 struct ceph_snap_context *context;
211 struct ceph_buffer *xattr_blob;
216 struct timespec64 mtime, atime, ctime, btime;
220 int writing; /* a sync write is still in progress */
221 int dirty_pages; /* dirty pages awaiting writeback */
226 static inline void ceph_put_cap_snap(struct ceph_cap_snap *capsnap)
228 if (refcount_dec_and_test(&capsnap->nref)) {
229 if (capsnap->xattr_blob)
230 ceph_buffer_put(capsnap->xattr_blob);
236 * The frag tree describes how a directory is fragmented, potentially across
237 * multiple metadata servers. It is also used to indicate points where
238 * metadata authority is delegated, and whether/where metadata is replicated.
240 * A _leaf_ frag will be present in the i_fragtree IFF there is
241 * delegation info. That is, if mds >= 0 || ndist > 0.
243 #define CEPH_MAX_DIRFRAG_REP 4
245 struct ceph_inode_frag {
250 int split_by; /* i.e. 2^(split_by) children */
252 /* delegation and replication info */
253 int mds; /* -1 if same authority as parent */
254 int ndist; /* >0 if replicated */
255 int dist[CEPH_MAX_DIRFRAG_REP];
259 * We cache inode xattrs as an encoded blob until they are first used,
260 * at which point we parse them into an rbtree.
262 struct ceph_inode_xattr {
271 int should_free_name;
278 struct ceph_dentry_info {
279 struct dentry *dentry;
280 struct ceph_mds_session *lease_session;
281 struct list_head lease_list;
283 int lease_shared_gen;
286 unsigned long lease_renew_after, lease_renew_from;
291 #define CEPH_DENTRY_REFERENCED 1
292 #define CEPH_DENTRY_LEASE_LIST 2
293 #define CEPH_DENTRY_SHRINK_LIST 4
294 #define CEPH_DENTRY_PRIMARY_LINK 8
296 struct ceph_inode_xattrs_info {
298 * (still encoded) xattr blob. we avoid the overhead of parsing
299 * this until someone actually calls getxattr, etc.
301 * blob->vec.iov_len == 4 implies there are no xattrs; blob ==
302 * NULL means we don't know.
304 struct ceph_buffer *blob, *prealloc_blob;
306 struct rb_root index;
311 u64 version, index_version;
317 struct ceph_inode_info {
318 struct ceph_vino i_vino; /* ceph ino + snap */
320 spinlock_t i_ceph_lock;
323 u64 i_inline_version;
326 unsigned long i_ceph_flags;
327 atomic64_t i_release_count;
328 atomic64_t i_ordered_count;
329 atomic64_t i_complete_seq[2];
331 struct ceph_dir_layout i_dir_layout;
332 struct ceph_file_layout i_layout;
333 struct ceph_file_layout i_cached_layout; // for async creates
337 struct timespec64 i_rctime;
338 u64 i_rbytes, i_rfiles, i_rsubdirs, i_rsnaps;
339 u64 i_files, i_subdirs;
342 u64 i_max_bytes, i_max_files;
346 struct rb_root i_fragtree;
347 int i_fragtree_nsplits;
348 struct mutex i_fragtree_mutex;
350 struct ceph_inode_xattrs_info i_xattrs;
352 /* capabilities. protected _both_ by i_ceph_lock and cap->session's
354 struct rb_root i_caps; /* cap list */
355 struct ceph_cap *i_auth_cap; /* authoritative cap, if any */
356 unsigned i_dirty_caps, i_flushing_caps; /* mask of dirtied fields */
359 * Link to the auth cap's session's s_cap_dirty list. s_cap_dirty
360 * is protected by the mdsc->cap_dirty_lock, but each individual item
361 * is also protected by the inode's i_ceph_lock. Walking s_cap_dirty
362 * requires the mdsc->cap_dirty_lock. List presence for an item can
363 * be tested under the i_ceph_lock. Changing anything requires both.
365 struct list_head i_dirty_item;
368 * Link to session's s_cap_flushing list. Protected in a similar
369 * fashion to i_dirty_item, but also by the s_mutex for changes. The
370 * s_cap_flushing list can be walked while holding either the s_mutex
371 * or msdc->cap_dirty_lock. List presence can also be checked while
372 * holding the i_ceph_lock for this inode.
374 struct list_head i_flushing_item;
376 /* we need to track cap writeback on a per-cap-bit basis, to allow
377 * overlapping, pipelined cap flushes to the mds. we can probably
378 * reduce the tid to 8 bits if we're concerned about inode size. */
379 struct ceph_cap_flush *i_prealloc_cap_flush;
380 struct list_head i_cap_flush_list;
381 wait_queue_head_t i_cap_wq; /* threads waiting on a capability */
382 unsigned long i_hold_caps_max; /* jiffies */
383 struct list_head i_cap_delay_list; /* for delayed cap release to mds */
384 struct ceph_cap_reservation i_cap_migration_resv;
385 struct list_head i_cap_snaps; /* snapped state pending flush to mds */
386 struct ceph_snap_context *i_head_snapc; /* set if wr_buffer_head > 0 or
387 dirty|flushing caps */
388 unsigned i_snap_caps; /* cap bits for snapped files */
390 unsigned long i_last_rd;
391 unsigned long i_last_wr;
392 int i_nr_by_mode[CEPH_FILE_MODE_BITS]; /* open file counts */
394 struct mutex i_truncate_mutex;
395 u32 i_truncate_seq; /* last truncate to smaller size */
396 u64 i_truncate_size; /* and the size we last truncated down to */
397 int i_truncate_pending; /* still need to call vmtruncate */
399 u64 i_max_size; /* max file size authorized by mds */
400 u64 i_reported_size; /* (max_)size reported to or requested of mds */
401 u64 i_wanted_max_size; /* offset we'd like to write too */
402 u64 i_requested_max_size; /* max_size we've requested */
404 /* held references to caps */
406 int i_rd_ref, i_rdcache_ref, i_wr_ref, i_wb_ref, i_fx_ref;
407 int i_wrbuffer_ref, i_wrbuffer_ref_head;
408 atomic_t i_filelock_ref;
409 atomic_t i_shared_gen; /* increment each time we get FILE_SHARED */
410 u32 i_rdcache_gen; /* incremented each time we get FILE_CACHE. */
411 u32 i_rdcache_revoking; /* RDCACHE gen to async invalidate, if any */
413 struct list_head i_unsafe_dirops; /* uncommitted mds dir ops */
414 struct list_head i_unsafe_iops; /* uncommitted mds inode ops */
415 spinlock_t i_unsafe_lock;
418 struct ceph_snap_realm *i_snap_realm; /* snap realm (if caps) */
419 struct ceph_snapid_map *i_snapid_map; /* snapid -> dev_t */
421 int i_snap_realm_counter; /* snap realm (if caps) */
422 struct list_head i_snap_realm_item;
423 struct list_head i_snap_flush_item;
424 struct timespec64 i_btime;
425 struct timespec64 i_snap_btime;
427 struct work_struct i_work;
428 unsigned long i_work_mask;
430 #ifdef CONFIG_CEPH_FSCACHE
431 struct fscache_cookie *fscache;
435 struct inode vfs_inode; /* at end */
438 static inline struct ceph_inode_info *
439 ceph_inode(const struct inode *inode)
441 return container_of(inode, struct ceph_inode_info, vfs_inode);
444 static inline struct ceph_fs_client *
445 ceph_inode_to_client(const struct inode *inode)
447 return (struct ceph_fs_client *)inode->i_sb->s_fs_info;
450 static inline struct ceph_fs_client *
451 ceph_sb_to_client(const struct super_block *sb)
453 return (struct ceph_fs_client *)sb->s_fs_info;
456 static inline struct ceph_mds_client *
457 ceph_sb_to_mdsc(const struct super_block *sb)
459 return (struct ceph_mds_client *)ceph_sb_to_client(sb)->mdsc;
462 static inline struct ceph_vino
463 ceph_vino(const struct inode *inode)
465 return ceph_inode(inode)->i_vino;
468 static inline u32 ceph_ino_to_ino32(u64 vino)
470 u32 ino = vino & 0xffffffff;
478 * Inode numbers in cephfs are 64 bits, but inode->i_ino is 32-bits on
479 * some arches. We generally do not use this value inside the ceph driver, but
480 * we do want to set it to something, so that generic vfs code has an
481 * appropriate value for tracepoints and the like.
483 static inline ino_t ceph_vino_to_ino_t(struct ceph_vino vino)
485 if (sizeof(ino_t) == sizeof(u32))
486 return ceph_ino_to_ino32(vino.ino);
487 return (ino_t)vino.ino;
490 /* for printf-style formatting */
491 #define ceph_vinop(i) ceph_inode(i)->i_vino.ino, ceph_inode(i)->i_vino.snap
493 static inline u64 ceph_ino(struct inode *inode)
495 return ceph_inode(inode)->i_vino.ino;
498 static inline u64 ceph_snap(struct inode *inode)
500 return ceph_inode(inode)->i_vino.snap;
504 * ceph_present_ino - format an inode number for presentation to userland
505 * @sb: superblock where the inode lives
506 * @ino: inode number to (possibly) convert
508 * If the user mounted with the ino32 option, then the 64-bit value needs
509 * to be converted to something that can fit inside 32 bits. Note that
510 * internal kernel code never uses this value, so this is entirely for
511 * userland consumption.
513 static inline u64 ceph_present_ino(struct super_block *sb, u64 ino)
515 if (unlikely(ceph_test_mount_opt(ceph_sb_to_client(sb), INO32)))
516 return ceph_ino_to_ino32(ino);
520 static inline u64 ceph_present_inode(struct inode *inode)
522 return ceph_present_ino(inode->i_sb, ceph_ino(inode));
525 static inline int ceph_ino_compare(struct inode *inode, void *data)
527 struct ceph_vino *pvino = (struct ceph_vino *)data;
528 struct ceph_inode_info *ci = ceph_inode(inode);
529 return ci->i_vino.ino == pvino->ino &&
530 ci->i_vino.snap == pvino->snap;
534 * The MDS reserves a set of inodes for its own usage. These should never
535 * be accessible by clients, and so the MDS has no reason to ever hand these
536 * out. The range is CEPH_MDS_INO_MDSDIR_OFFSET..CEPH_INO_SYSTEM_BASE.
538 * These come from src/mds/mdstypes.h in the ceph sources.
540 #define CEPH_MAX_MDS 0x100
541 #define CEPH_NUM_STRAY 10
542 #define CEPH_MDS_INO_MDSDIR_OFFSET (1 * CEPH_MAX_MDS)
543 #define CEPH_INO_SYSTEM_BASE ((6*CEPH_MAX_MDS) + (CEPH_MAX_MDS * CEPH_NUM_STRAY))
545 static inline bool ceph_vino_is_reserved(const struct ceph_vino vino)
547 if (vino.ino < CEPH_INO_SYSTEM_BASE &&
548 vino.ino >= CEPH_MDS_INO_MDSDIR_OFFSET) {
549 WARN_RATELIMIT(1, "Attempt to access reserved inode number 0x%llx", vino.ino);
555 static inline struct inode *ceph_find_inode(struct super_block *sb,
556 struct ceph_vino vino)
558 if (ceph_vino_is_reserved(vino))
562 * NB: The hashval will be run through the fs/inode.c hash function
563 * anyway, so there is no need to squash the inode number down to
564 * 32-bits first. Just use low-order bits on arches with 32-bit long.
566 return ilookup5(sb, (unsigned long)vino.ino, ceph_ino_compare, &vino);
573 #define CEPH_I_DIR_ORDERED (1 << 0) /* dentries in dir are ordered */
574 #define CEPH_I_FLUSH (1 << 2) /* do not delay flush of dirty metadata */
575 #define CEPH_I_POOL_PERM (1 << 3) /* pool rd/wr bits are valid */
576 #define CEPH_I_POOL_RD (1 << 4) /* can read from pool */
577 #define CEPH_I_POOL_WR (1 << 5) /* can write to pool */
578 #define CEPH_I_SEC_INITED (1 << 6) /* security initialized */
579 #define CEPH_I_KICK_FLUSH (1 << 7) /* kick flushing caps */
580 #define CEPH_I_FLUSH_SNAPS (1 << 8) /* need flush snapss */
581 #define CEPH_I_ERROR_WRITE (1 << 9) /* have seen write errors */
582 #define CEPH_I_ERROR_FILELOCK (1 << 10) /* have seen file lock errors */
583 #define CEPH_I_ODIRECT (1 << 11) /* inode in direct I/O mode */
584 #define CEPH_ASYNC_CREATE_BIT (12) /* async create in flight for this */
585 #define CEPH_I_ASYNC_CREATE (1 << CEPH_ASYNC_CREATE_BIT)
588 * Masks of ceph inode work.
590 #define CEPH_I_WORK_WRITEBACK 0
591 #define CEPH_I_WORK_INVALIDATE_PAGES 1
592 #define CEPH_I_WORK_VMTRUNCATE 2
593 #define CEPH_I_WORK_CHECK_CAPS 3
594 #define CEPH_I_WORK_FLUSH_SNAPS 4
597 * We set the ERROR_WRITE bit when we start seeing write errors on an inode
598 * and then clear it when they start succeeding. Note that we do a lockless
599 * check first, and only take the lock if it looks like it needs to be changed.
600 * The write submission code just takes this as a hint, so we're not too
601 * worried if a few slip through in either direction.
603 static inline void ceph_set_error_write(struct ceph_inode_info *ci)
605 if (!(READ_ONCE(ci->i_ceph_flags) & CEPH_I_ERROR_WRITE)) {
606 spin_lock(&ci->i_ceph_lock);
607 ci->i_ceph_flags |= CEPH_I_ERROR_WRITE;
608 spin_unlock(&ci->i_ceph_lock);
612 static inline void ceph_clear_error_write(struct ceph_inode_info *ci)
614 if (READ_ONCE(ci->i_ceph_flags) & CEPH_I_ERROR_WRITE) {
615 spin_lock(&ci->i_ceph_lock);
616 ci->i_ceph_flags &= ~CEPH_I_ERROR_WRITE;
617 spin_unlock(&ci->i_ceph_lock);
621 static inline void __ceph_dir_set_complete(struct ceph_inode_info *ci,
622 long long release_count,
623 long long ordered_count)
626 * Makes sure operations that setup readdir cache (update page
627 * cache and i_size) are strongly ordered w.r.t. the following
628 * atomic64_set() operations.
631 atomic64_set(&ci->i_complete_seq[0], release_count);
632 atomic64_set(&ci->i_complete_seq[1], ordered_count);
635 static inline void __ceph_dir_clear_complete(struct ceph_inode_info *ci)
637 atomic64_inc(&ci->i_release_count);
640 static inline void __ceph_dir_clear_ordered(struct ceph_inode_info *ci)
642 atomic64_inc(&ci->i_ordered_count);
645 static inline bool __ceph_dir_is_complete(struct ceph_inode_info *ci)
647 return atomic64_read(&ci->i_complete_seq[0]) ==
648 atomic64_read(&ci->i_release_count);
651 static inline bool __ceph_dir_is_complete_ordered(struct ceph_inode_info *ci)
653 return atomic64_read(&ci->i_complete_seq[0]) ==
654 atomic64_read(&ci->i_release_count) &&
655 atomic64_read(&ci->i_complete_seq[1]) ==
656 atomic64_read(&ci->i_ordered_count);
659 static inline void ceph_dir_clear_complete(struct inode *inode)
661 __ceph_dir_clear_complete(ceph_inode(inode));
664 static inline void ceph_dir_clear_ordered(struct inode *inode)
666 __ceph_dir_clear_ordered(ceph_inode(inode));
669 static inline bool ceph_dir_is_complete_ordered(struct inode *inode)
671 bool ret = __ceph_dir_is_complete_ordered(ceph_inode(inode));
676 /* find a specific frag @f */
677 extern struct ceph_inode_frag *__ceph_find_frag(struct ceph_inode_info *ci,
681 * choose fragment for value @v. copy frag content to pfrag, if leaf
684 extern u32 ceph_choose_frag(struct ceph_inode_info *ci, u32 v,
685 struct ceph_inode_frag *pfrag,
688 static inline struct ceph_dentry_info *ceph_dentry(const struct dentry *dentry)
690 return (struct ceph_dentry_info *)dentry->d_fsdata;
696 static inline bool __ceph_is_any_real_caps(struct ceph_inode_info *ci)
698 return !RB_EMPTY_ROOT(&ci->i_caps);
701 extern int __ceph_caps_issued(struct ceph_inode_info *ci, int *implemented);
702 extern int __ceph_caps_issued_mask(struct ceph_inode_info *ci, int mask, int t);
703 extern int __ceph_caps_issued_mask_metric(struct ceph_inode_info *ci, int mask,
705 extern int __ceph_caps_issued_other(struct ceph_inode_info *ci,
706 struct ceph_cap *cap);
708 static inline int ceph_caps_issued(struct ceph_inode_info *ci)
711 spin_lock(&ci->i_ceph_lock);
712 issued = __ceph_caps_issued(ci, NULL);
713 spin_unlock(&ci->i_ceph_lock);
717 static inline int ceph_caps_issued_mask_metric(struct ceph_inode_info *ci,
721 spin_lock(&ci->i_ceph_lock);
722 r = __ceph_caps_issued_mask_metric(ci, mask, touch);
723 spin_unlock(&ci->i_ceph_lock);
727 static inline int __ceph_caps_dirty(struct ceph_inode_info *ci)
729 return ci->i_dirty_caps | ci->i_flushing_caps;
731 extern struct ceph_cap_flush *ceph_alloc_cap_flush(void);
732 extern void ceph_free_cap_flush(struct ceph_cap_flush *cf);
733 extern int __ceph_mark_dirty_caps(struct ceph_inode_info *ci, int mask,
734 struct ceph_cap_flush **pcf);
736 extern int __ceph_caps_revoking_other(struct ceph_inode_info *ci,
737 struct ceph_cap *ocap, int mask);
738 extern int ceph_caps_revoking(struct ceph_inode_info *ci, int mask);
739 extern int __ceph_caps_used(struct ceph_inode_info *ci);
741 static inline bool __ceph_is_file_opened(struct ceph_inode_info *ci)
743 return ci->i_nr_by_mode[0];
745 extern int __ceph_caps_file_wanted(struct ceph_inode_info *ci);
746 extern int __ceph_caps_wanted(struct ceph_inode_info *ci);
748 /* what the mds thinks we want */
749 extern int __ceph_caps_mds_wanted(struct ceph_inode_info *ci, bool check);
751 extern void ceph_caps_init(struct ceph_mds_client *mdsc);
752 extern void ceph_caps_finalize(struct ceph_mds_client *mdsc);
753 extern void ceph_adjust_caps_max_min(struct ceph_mds_client *mdsc,
754 struct ceph_mount_options *fsopt);
755 extern int ceph_reserve_caps(struct ceph_mds_client *mdsc,
756 struct ceph_cap_reservation *ctx, int need);
757 extern void ceph_unreserve_caps(struct ceph_mds_client *mdsc,
758 struct ceph_cap_reservation *ctx);
759 extern void ceph_reservation_status(struct ceph_fs_client *client,
760 int *total, int *avail, int *used,
761 int *reserved, int *min);
766 * we keep buffered readdir results attached to file->private_data
768 #define CEPH_F_SYNC 1
769 #define CEPH_F_ATEND 2
771 struct ceph_file_info {
772 short fmode; /* initialized on open */
773 short flags; /* CEPH_F_* */
775 spinlock_t rw_contexts_lock;
776 struct list_head rw_contexts;
783 struct ceph_dir_file_info {
784 struct ceph_file_info file_info;
786 /* readdir: position within the dir */
788 struct ceph_mds_request *last_readdir;
790 /* readdir: position within a frag */
791 unsigned next_offset; /* offset of next chunk (last_name's + 1) */
792 char *last_name; /* last entry in previous chunk */
793 long long dir_release_count;
794 long long dir_ordered_count;
795 int readdir_cache_idx;
797 /* used for -o dirstat read() on directory thing */
802 struct ceph_rw_context {
803 struct list_head list;
804 struct task_struct *thread;
808 #define CEPH_DEFINE_RW_CONTEXT(_name, _caps) \
809 struct ceph_rw_context _name = { \
814 static inline void ceph_add_rw_context(struct ceph_file_info *cf,
815 struct ceph_rw_context *ctx)
817 spin_lock(&cf->rw_contexts_lock);
818 list_add(&ctx->list, &cf->rw_contexts);
819 spin_unlock(&cf->rw_contexts_lock);
822 static inline void ceph_del_rw_context(struct ceph_file_info *cf,
823 struct ceph_rw_context *ctx)
825 spin_lock(&cf->rw_contexts_lock);
826 list_del(&ctx->list);
827 spin_unlock(&cf->rw_contexts_lock);
830 static inline struct ceph_rw_context*
831 ceph_find_rw_context(struct ceph_file_info *cf)
833 struct ceph_rw_context *ctx, *found = NULL;
834 spin_lock(&cf->rw_contexts_lock);
835 list_for_each_entry(ctx, &cf->rw_contexts, list) {
836 if (ctx->thread == current) {
841 spin_unlock(&cf->rw_contexts_lock);
845 struct ceph_readdir_cache_control {
847 struct dentry **dentries;
852 * A "snap realm" describes a subset of the file hierarchy sharing
853 * the same set of snapshots that apply to it. The realms themselves
854 * are organized into a hierarchy, such that children inherit (some of)
855 * the snapshots of their parents.
857 * All inodes within the realm that have capabilities are linked into a
860 struct ceph_snap_realm {
868 u64 parent_since; /* snapid when our current parent became so */
870 u64 *prior_parent_snaps; /* snaps inherited from any parents we */
871 u32 num_prior_parent_snaps; /* had prior to parent_since */
872 u64 *snaps; /* snaps specific to this realm */
875 struct ceph_snap_realm *parent;
876 struct list_head children; /* list of child realms */
877 struct list_head child_item;
879 struct list_head empty_item; /* if i have ref==0 */
881 struct list_head dirty_item; /* if realm needs new context */
883 /* the current set of snaps for this realm */
884 struct ceph_snap_context *cached_context;
886 struct list_head inodes_with_caps;
887 spinlock_t inodes_with_caps_lock;
890 static inline int default_congestion_kb(void)
897 * congestion size, scale with available memory.
909 * This allows larger machines to have larger/more transfers.
910 * Limit the default to 256M
912 congestion_kb = (16*int_sqrt(totalram_pages())) << (PAGE_SHIFT-10);
913 if (congestion_kb > 256*1024)
914 congestion_kb = 256*1024;
916 return congestion_kb;
921 extern int ceph_force_reconnect(struct super_block *sb);
923 struct ceph_snap_realm *ceph_lookup_snap_realm(struct ceph_mds_client *mdsc,
925 extern void ceph_get_snap_realm(struct ceph_mds_client *mdsc,
926 struct ceph_snap_realm *realm);
927 extern void ceph_put_snap_realm(struct ceph_mds_client *mdsc,
928 struct ceph_snap_realm *realm);
929 extern int ceph_update_snap_trace(struct ceph_mds_client *m,
930 void *p, void *e, bool deletion,
931 struct ceph_snap_realm **realm_ret);
932 extern void ceph_handle_snap(struct ceph_mds_client *mdsc,
933 struct ceph_mds_session *session,
934 struct ceph_msg *msg);
935 extern int __ceph_finish_cap_snap(struct ceph_inode_info *ci,
936 struct ceph_cap_snap *capsnap);
937 extern void ceph_cleanup_empty_realms(struct ceph_mds_client *mdsc);
939 extern struct ceph_snapid_map *ceph_get_snapid_map(struct ceph_mds_client *mdsc,
941 extern void ceph_put_snapid_map(struct ceph_mds_client* mdsc,
942 struct ceph_snapid_map *sm);
943 extern void ceph_trim_snapid_map(struct ceph_mds_client *mdsc);
944 extern void ceph_cleanup_snapid_map(struct ceph_mds_client *mdsc);
948 * a cap_snap is "pending" if it is still awaiting an in-progress
949 * sync write (that may/may not still update size, mtime, etc.).
951 static inline bool __ceph_have_pending_cap_snap(struct ceph_inode_info *ci)
953 return !list_empty(&ci->i_cap_snaps) &&
954 list_last_entry(&ci->i_cap_snaps, struct ceph_cap_snap,
959 struct ceph_mds_reply_info_in;
960 struct ceph_mds_reply_dirfrag;
962 extern const struct inode_operations ceph_file_iops;
964 extern struct inode *ceph_alloc_inode(struct super_block *sb);
965 extern void ceph_evict_inode(struct inode *inode);
966 extern void ceph_free_inode(struct inode *inode);
968 extern struct inode *ceph_get_inode(struct super_block *sb,
969 struct ceph_vino vino);
970 extern struct inode *ceph_get_snapdir(struct inode *parent);
971 extern int ceph_fill_file_size(struct inode *inode, int issued,
972 u32 truncate_seq, u64 truncate_size, u64 size);
973 extern void ceph_fill_file_time(struct inode *inode, int issued,
974 u64 time_warp_seq, struct timespec64 *ctime,
975 struct timespec64 *mtime,
976 struct timespec64 *atime);
977 extern int ceph_fill_inode(struct inode *inode, struct page *locked_page,
978 struct ceph_mds_reply_info_in *iinfo,
979 struct ceph_mds_reply_dirfrag *dirinfo,
980 struct ceph_mds_session *session, int cap_fmode,
981 struct ceph_cap_reservation *caps_reservation);
982 extern int ceph_fill_trace(struct super_block *sb,
983 struct ceph_mds_request *req);
984 extern int ceph_readdir_prepopulate(struct ceph_mds_request *req,
985 struct ceph_mds_session *session);
987 extern int ceph_inode_holds_cap(struct inode *inode, int mask);
989 extern bool ceph_inode_set_size(struct inode *inode, loff_t size);
990 extern void __ceph_do_pending_vmtruncate(struct inode *inode);
992 void ceph_queue_inode_work(struct inode *inode, int work_bit);
994 static inline void ceph_queue_vmtruncate(struct inode *inode)
996 ceph_queue_inode_work(inode, CEPH_I_WORK_VMTRUNCATE);
999 static inline void ceph_queue_invalidate(struct inode *inode)
1001 ceph_queue_inode_work(inode, CEPH_I_WORK_INVALIDATE_PAGES);
1004 static inline void ceph_queue_writeback(struct inode *inode)
1006 ceph_queue_inode_work(inode, CEPH_I_WORK_WRITEBACK);
1009 static inline void ceph_queue_check_caps(struct inode *inode)
1011 ceph_queue_inode_work(inode, CEPH_I_WORK_CHECK_CAPS);
1014 static inline void ceph_queue_flush_snaps(struct inode *inode)
1016 ceph_queue_inode_work(inode, CEPH_I_WORK_FLUSH_SNAPS);
1019 extern int __ceph_do_getattr(struct inode *inode, struct page *locked_page,
1020 int mask, bool force);
1021 static inline int ceph_do_getattr(struct inode *inode, int mask, bool force)
1023 return __ceph_do_getattr(inode, NULL, mask, force);
1025 extern int ceph_permission(struct user_namespace *mnt_userns,
1026 struct inode *inode, int mask);
1027 extern int __ceph_setattr(struct inode *inode, struct iattr *attr);
1028 extern int ceph_setattr(struct user_namespace *mnt_userns,
1029 struct dentry *dentry, struct iattr *attr);
1030 extern int ceph_getattr(struct user_namespace *mnt_userns,
1031 const struct path *path, struct kstat *stat,
1032 u32 request_mask, unsigned int flags);
1035 int __ceph_setxattr(struct inode *, const char *, const void *, size_t, int);
1036 ssize_t __ceph_getxattr(struct inode *, const char *, void *, size_t);
1037 extern ssize_t ceph_listxattr(struct dentry *, char *, size_t);
1038 extern struct ceph_buffer *__ceph_build_xattrs_blob(struct ceph_inode_info *ci);
1039 extern void __ceph_destroy_xattrs(struct ceph_inode_info *ci);
1040 extern const struct xattr_handler *ceph_xattr_handlers[];
1042 struct ceph_acl_sec_ctx {
1043 #ifdef CONFIG_CEPH_FS_POSIX_ACL
1047 #ifdef CONFIG_CEPH_FS_SECURITY_LABEL
1051 struct ceph_pagelist *pagelist;
1054 #ifdef CONFIG_SECURITY
1055 extern bool ceph_security_xattr_deadlock(struct inode *in);
1056 extern bool ceph_security_xattr_wanted(struct inode *in);
1058 static inline bool ceph_security_xattr_deadlock(struct inode *in)
1062 static inline bool ceph_security_xattr_wanted(struct inode *in)
1068 #ifdef CONFIG_CEPH_FS_SECURITY_LABEL
1069 extern int ceph_security_init_secctx(struct dentry *dentry, umode_t mode,
1070 struct ceph_acl_sec_ctx *ctx);
1071 static inline void ceph_security_invalidate_secctx(struct inode *inode)
1073 security_inode_invalidate_secctx(inode);
1076 static inline int ceph_security_init_secctx(struct dentry *dentry, umode_t mode,
1077 struct ceph_acl_sec_ctx *ctx)
1081 static inline void ceph_security_invalidate_secctx(struct inode *inode)
1086 void ceph_release_acl_sec_ctx(struct ceph_acl_sec_ctx *as_ctx);
1089 #ifdef CONFIG_CEPH_FS_POSIX_ACL
1091 struct posix_acl *ceph_get_acl(struct inode *, int);
1092 int ceph_set_acl(struct user_namespace *mnt_userns,
1093 struct inode *inode, struct posix_acl *acl, int type);
1094 int ceph_pre_init_acls(struct inode *dir, umode_t *mode,
1095 struct ceph_acl_sec_ctx *as_ctx);
1096 void ceph_init_inode_acls(struct inode *inode,
1097 struct ceph_acl_sec_ctx *as_ctx);
1099 static inline void ceph_forget_all_cached_acls(struct inode *inode)
1101 forget_all_cached_acls(inode);
1106 #define ceph_get_acl NULL
1107 #define ceph_set_acl NULL
1109 static inline int ceph_pre_init_acls(struct inode *dir, umode_t *mode,
1110 struct ceph_acl_sec_ctx *as_ctx)
1114 static inline void ceph_init_inode_acls(struct inode *inode,
1115 struct ceph_acl_sec_ctx *as_ctx)
1118 static inline int ceph_acl_chmod(struct dentry *dentry, struct inode *inode)
1123 static inline void ceph_forget_all_cached_acls(struct inode *inode)
1130 extern const char *ceph_cap_string(int c);
1131 extern void ceph_handle_caps(struct ceph_mds_session *session,
1132 struct ceph_msg *msg);
1133 extern struct ceph_cap *ceph_get_cap(struct ceph_mds_client *mdsc,
1134 struct ceph_cap_reservation *ctx);
1135 extern void ceph_add_cap(struct inode *inode,
1136 struct ceph_mds_session *session, u64 cap_id,
1137 unsigned issued, unsigned wanted,
1138 unsigned cap, unsigned seq, u64 realmino, int flags,
1139 struct ceph_cap **new_cap);
1140 extern void __ceph_remove_cap(struct ceph_cap *cap, bool queue_release);
1141 extern void __ceph_remove_caps(struct ceph_inode_info *ci);
1142 extern void ceph_put_cap(struct ceph_mds_client *mdsc,
1143 struct ceph_cap *cap);
1144 extern int ceph_is_any_caps(struct inode *inode);
1146 extern int ceph_write_inode(struct inode *inode, struct writeback_control *wbc);
1147 extern int ceph_fsync(struct file *file, loff_t start, loff_t end,
1149 extern void ceph_early_kick_flushing_caps(struct ceph_mds_client *mdsc,
1150 struct ceph_mds_session *session);
1151 extern void ceph_kick_flushing_caps(struct ceph_mds_client *mdsc,
1152 struct ceph_mds_session *session);
1153 void ceph_kick_flushing_inode_caps(struct ceph_mds_session *session,
1154 struct ceph_inode_info *ci);
1155 extern struct ceph_cap *ceph_get_cap_for_mds(struct ceph_inode_info *ci,
1157 extern void ceph_take_cap_refs(struct ceph_inode_info *ci, int caps,
1158 bool snap_rwsem_locked);
1159 extern void ceph_get_cap_refs(struct ceph_inode_info *ci, int caps);
1160 extern void ceph_put_cap_refs(struct ceph_inode_info *ci, int had);
1161 extern void ceph_put_cap_refs_async(struct ceph_inode_info *ci, int had);
1162 extern void ceph_put_cap_refs_no_check_caps(struct ceph_inode_info *ci,
1164 extern void ceph_put_wrbuffer_cap_refs(struct ceph_inode_info *ci, int nr,
1165 struct ceph_snap_context *snapc);
1166 extern void ceph_flush_snaps(struct ceph_inode_info *ci,
1167 struct ceph_mds_session **psession);
1168 extern bool __ceph_should_report_size(struct ceph_inode_info *ci);
1169 extern void ceph_check_caps(struct ceph_inode_info *ci, int flags,
1170 struct ceph_mds_session *session);
1171 extern unsigned long ceph_check_delayed_caps(struct ceph_mds_client *mdsc);
1172 extern void ceph_flush_dirty_caps(struct ceph_mds_client *mdsc);
1173 extern int ceph_drop_caps_for_unlink(struct inode *inode);
1174 extern int ceph_encode_inode_release(void **p, struct inode *inode,
1175 int mds, int drop, int unless, int force);
1176 extern int ceph_encode_dentry_release(void **p, struct dentry *dn,
1178 int mds, int drop, int unless);
1180 extern int ceph_get_caps(struct file *filp, int need, int want,
1181 loff_t endoff, int *got);
1182 extern int ceph_try_get_caps(struct inode *inode,
1183 int need, int want, bool nonblock, int *got);
1185 /* for counting open files by mode */
1186 extern void ceph_get_fmode(struct ceph_inode_info *ci, int mode, int count);
1187 extern void ceph_put_fmode(struct ceph_inode_info *ci, int mode, int count);
1188 extern void __ceph_touch_fmode(struct ceph_inode_info *ci,
1189 struct ceph_mds_client *mdsc, int fmode);
1192 extern const struct address_space_operations ceph_aops;
1193 extern int ceph_mmap(struct file *file, struct vm_area_struct *vma);
1194 extern int ceph_uninline_data(struct file *filp, struct page *locked_page);
1195 extern int ceph_pool_perm_check(struct inode *inode, int need);
1196 extern void ceph_pool_perm_destroy(struct ceph_mds_client* mdsc);
1199 extern const struct file_operations ceph_file_fops;
1201 extern int ceph_renew_caps(struct inode *inode, int fmode);
1202 extern int ceph_open(struct inode *inode, struct file *file);
1203 extern int ceph_atomic_open(struct inode *dir, struct dentry *dentry,
1204 struct file *file, unsigned flags, umode_t mode);
1205 extern int ceph_release(struct inode *inode, struct file *filp);
1206 extern void ceph_fill_inline_data(struct inode *inode, struct page *locked_page,
1207 char *data, size_t len);
1210 extern const struct file_operations ceph_dir_fops;
1211 extern const struct file_operations ceph_snapdir_fops;
1212 extern const struct inode_operations ceph_dir_iops;
1213 extern const struct inode_operations ceph_snapdir_iops;
1214 extern const struct dentry_operations ceph_dentry_ops;
1216 extern loff_t ceph_make_fpos(unsigned high, unsigned off, bool hash_order);
1217 extern int ceph_handle_notrace_create(struct inode *dir, struct dentry *dentry);
1218 extern struct dentry *ceph_handle_snapdir(struct ceph_mds_request *req,
1219 struct dentry *dentry);
1220 extern struct dentry *ceph_finish_lookup(struct ceph_mds_request *req,
1221 struct dentry *dentry, int err);
1223 extern void __ceph_dentry_lease_touch(struct ceph_dentry_info *di);
1224 extern void __ceph_dentry_dir_lease_touch(struct ceph_dentry_info *di);
1225 extern void ceph_invalidate_dentry_lease(struct dentry *dentry);
1226 extern int ceph_trim_dentries(struct ceph_mds_client *mdsc);
1227 extern unsigned ceph_dentry_hash(struct inode *dir, struct dentry *dn);
1228 extern void ceph_readdir_cache_release(struct ceph_readdir_cache_control *ctl);
1231 extern long ceph_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1234 extern const struct export_operations ceph_export_ops;
1235 struct inode *ceph_lookup_inode(struct super_block *sb, u64 ino);
1238 extern __init void ceph_flock_init(void);
1239 extern int ceph_lock(struct file *file, int cmd, struct file_lock *fl);
1240 extern int ceph_flock(struct file *file, int cmd, struct file_lock *fl);
1241 extern void ceph_count_locks(struct inode *inode, int *p_num, int *f_num);
1242 extern int ceph_encode_locks_to_buffer(struct inode *inode,
1243 struct ceph_filelock *flocks,
1244 int num_fcntl_locks,
1245 int num_flock_locks);
1246 extern int ceph_locks_to_pagelist(struct ceph_filelock *flocks,
1247 struct ceph_pagelist *pagelist,
1248 int num_fcntl_locks, int num_flock_locks);
1251 extern void ceph_fs_debugfs_init(struct ceph_fs_client *client);
1252 extern void ceph_fs_debugfs_cleanup(struct ceph_fs_client *client);
1255 static inline bool __ceph_has_any_quota(struct ceph_inode_info *ci)
1257 return ci->i_max_files || ci->i_max_bytes;
1260 extern void ceph_adjust_quota_realms_count(struct inode *inode, bool inc);
1262 static inline void __ceph_update_quota(struct ceph_inode_info *ci,
1263 u64 max_bytes, u64 max_files)
1265 bool had_quota, has_quota;
1266 had_quota = __ceph_has_any_quota(ci);
1267 ci->i_max_bytes = max_bytes;
1268 ci->i_max_files = max_files;
1269 has_quota = __ceph_has_any_quota(ci);
1271 if (had_quota != has_quota)
1272 ceph_adjust_quota_realms_count(&ci->vfs_inode, has_quota);
1275 extern void ceph_handle_quota(struct ceph_mds_client *mdsc,
1276 struct ceph_mds_session *session,
1277 struct ceph_msg *msg);
1278 extern bool ceph_quota_is_max_files_exceeded(struct inode *inode);
1279 extern bool ceph_quota_is_same_realm(struct inode *old, struct inode *new);
1280 extern bool ceph_quota_is_max_bytes_exceeded(struct inode *inode,
1282 extern bool ceph_quota_is_max_bytes_approaching(struct inode *inode,
1284 extern bool ceph_quota_update_statfs(struct ceph_fs_client *fsc,
1285 struct kstatfs *buf);
1286 extern void ceph_cleanup_quotarealms_inodes(struct ceph_mds_client *mdsc);
1288 #endif /* _FS_CEPH_SUPER_H */