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