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