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