OSDN Git Service

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