OSDN Git Service

random: use chacha20 for get_random_int/long
[sagit-ice-cold/kernel_xiaomi_msm8998.git] / include / linux / dcache.h
1 #ifndef __LINUX_DCACHE_H
2 #define __LINUX_DCACHE_H
3
4 #include <linux/atomic.h>
5 #include <linux/list.h>
6 #include <linux/rculist.h>
7 #include <linux/rculist_bl.h>
8 #include <linux/spinlock.h>
9 #include <linux/seqlock.h>
10 #include <linux/cache.h>
11 #include <linux/rcupdate.h>
12 #include <linux/lockref.h>
13
14 struct path;
15 struct vfsmount;
16
17 /*
18  * linux/include/linux/dcache.h
19  *
20  * Dirent cache data structures
21  *
22  * (C) Copyright 1997 Thomas Schoebel-Theuer,
23  * with heavy changes by Linus Torvalds
24  */
25
26 #define IS_ROOT(x) ((x) == (x)->d_parent)
27
28 /* The hash is always the low bits of hash_len */
29 #ifdef __LITTLE_ENDIAN
30  #define HASH_LEN_DECLARE u32 hash; u32 len;
31  #define bytemask_from_count(cnt)       (~(~0ul << (cnt)*8))
32 #else
33  #define HASH_LEN_DECLARE u32 len; u32 hash;
34  #define bytemask_from_count(cnt)       (~(~0ul >> (cnt)*8))
35 #endif
36
37 /*
38  * "quick string" -- eases parameter passing, but more importantly
39  * saves "metadata" about the string (ie length and the hash).
40  *
41  * hash comes first so it snuggles against d_parent in the
42  * dentry.
43  */
44 struct qstr {
45         union {
46                 struct {
47                         HASH_LEN_DECLARE;
48                 };
49                 u64 hash_len;
50         };
51         const unsigned char *name;
52 };
53
54 #define QSTR_INIT(n,l) { { { .len = l } }, .name = n }
55 #define hashlen_hash(hashlen) ((u32) (hashlen))
56 #define hashlen_len(hashlen)  ((u32)((hashlen) >> 32))
57 #define hashlen_create(hash,len) (((u64)(len)<<32)|(u32)(hash))
58
59 struct dentry_stat_t {
60         long nr_dentry;
61         long nr_unused;
62         long age_limit;          /* age in seconds */
63         long want_pages;         /* pages requested by system */
64         long dummy[2];
65 };
66 extern struct dentry_stat_t dentry_stat;
67
68 /* Name hashing routines. Initial hash value */
69 /* Hash courtesy of the R5 hash in reiserfs modulo sign bits */
70 #define init_name_hash()                0
71
72 /* partial hash update function. Assume roughly 4 bits per character */
73 static inline unsigned long
74 partial_name_hash(unsigned long c, unsigned long prevhash)
75 {
76         return (prevhash + (c << 4) + (c >> 4)) * 11;
77 }
78
79 /*
80  * Finally: cut down the number of bits to a int value (and try to avoid
81  * losing bits)
82  */
83 static inline unsigned long end_name_hash(unsigned long hash)
84 {
85         return (unsigned int) hash;
86 }
87
88 /* Compute the hash for a name string. */
89 extern unsigned int full_name_hash(const unsigned char *, unsigned int);
90
91 /*
92  * Try to keep struct dentry aligned on 64 byte cachelines (this will
93  * give reasonable cacheline footprint with larger lines without the
94  * large memory footprint increase).
95  */
96 #ifdef CONFIG_64BIT
97 # define DNAME_INLINE_LEN 32 /* 192 bytes */
98 #else
99 # ifdef CONFIG_SMP
100 #  define DNAME_INLINE_LEN 36 /* 128 bytes */
101 # else
102 #  define DNAME_INLINE_LEN 40 /* 128 bytes */
103 # endif
104 #endif
105
106 #define d_lock  d_lockref.lock
107
108 struct dentry {
109         /* RCU lookup touched fields */
110         unsigned int d_flags;           /* protected by d_lock */
111         seqcount_t d_seq;               /* per dentry seqlock */
112         struct hlist_bl_node d_hash;    /* lookup hash list */
113         struct dentry *d_parent;        /* parent directory */
114         struct qstr d_name;
115         struct inode *d_inode;          /* Where the name belongs to - NULL is
116                                          * negative */
117         unsigned char d_iname[DNAME_INLINE_LEN];        /* small names */
118
119         /* Ref lookup also touches following */
120         struct lockref d_lockref;       /* per-dentry lock and refcount */
121         const struct dentry_operations *d_op;
122         struct super_block *d_sb;       /* The root of the dentry tree */
123         unsigned long d_time;           /* used by d_revalidate */
124         void *d_fsdata;                 /* fs-specific data */
125
126         struct list_head d_lru;         /* LRU list */
127         struct list_head d_child;       /* child of parent list */
128         struct list_head d_subdirs;     /* our children */
129         /*
130          * d_alias and d_rcu can share memory
131          */
132         union {
133                 struct hlist_node d_alias;      /* inode alias list */
134                 struct rcu_head d_rcu;
135         } d_u;
136 };
137
138 /*
139  * dentry->d_lock spinlock nesting subclasses:
140  *
141  * 0: normal
142  * 1: nested
143  */
144 enum dentry_d_lock_class
145 {
146         DENTRY_D_LOCK_NORMAL, /* implicitly used by plain spin_lock() APIs. */
147         DENTRY_D_LOCK_NESTED
148 };
149
150 struct dentry_operations {
151         int (*d_revalidate)(struct dentry *, unsigned int);
152         int (*d_weak_revalidate)(struct dentry *, unsigned int);
153         int (*d_hash)(const struct dentry *, struct qstr *);
154         int (*d_compare)(const struct dentry *, const struct dentry *,
155                         unsigned int, const char *, const struct qstr *);
156         int (*d_delete)(const struct dentry *);
157         void (*d_release)(struct dentry *);
158         void (*d_prune)(struct dentry *);
159         void (*d_iput)(struct dentry *, struct inode *);
160         char *(*d_dname)(struct dentry *, char *, int);
161         struct vfsmount *(*d_automount)(struct path *);
162         int (*d_manage)(struct dentry *, bool);
163         struct inode *(*d_select_inode)(struct dentry *, unsigned);
164         struct dentry *(*d_real)(struct dentry *, struct inode *);
165         void (*d_canonical_path)(const struct path *, struct path *);
166 } ____cacheline_aligned;
167
168 /*
169  * Locking rules for dentry_operations callbacks are to be found in
170  * Documentation/filesystems/Locking. Keep it updated!
171  *
172  * FUrther descriptions are found in Documentation/filesystems/vfs.txt.
173  * Keep it updated too!
174  */
175
176 /* d_flags entries */
177 #define DCACHE_OP_HASH                  0x00000001
178 #define DCACHE_OP_COMPARE               0x00000002
179 #define DCACHE_OP_REVALIDATE            0x00000004
180 #define DCACHE_OP_DELETE                0x00000008
181 #define DCACHE_OP_PRUNE                 0x00000010
182
183 #define DCACHE_DISCONNECTED             0x00000020
184      /* This dentry is possibly not currently connected to the dcache tree, in
185       * which case its parent will either be itself, or will have this flag as
186       * well.  nfsd will not use a dentry with this bit set, but will first
187       * endeavour to clear the bit either by discovering that it is connected,
188       * or by performing lookup operations.   Any filesystem which supports
189       * nfsd_operations MUST have a lookup function which, if it finds a
190       * directory inode with a DCACHE_DISCONNECTED dentry, will d_move that
191       * dentry into place and return that dentry rather than the passed one,
192       * typically using d_splice_alias. */
193
194 #define DCACHE_REFERENCED               0x00000040 /* Recently used, don't discard. */
195 #define DCACHE_RCUACCESS                0x00000080 /* Entry has ever been RCU-visible */
196
197 #define DCACHE_CANT_MOUNT               0x00000100
198 #define DCACHE_GENOCIDE                 0x00000200
199 #define DCACHE_SHRINK_LIST              0x00000400
200
201 #define DCACHE_OP_WEAK_REVALIDATE       0x00000800
202
203 #define DCACHE_NFSFS_RENAMED            0x00001000
204      /* this dentry has been "silly renamed" and has to be deleted on the last
205       * dput() */
206 #define DCACHE_COOKIE                   0x00002000 /* For use by dcookie subsystem */
207 #define DCACHE_FSNOTIFY_PARENT_WATCHED  0x00004000
208      /* Parent inode is watched by some fsnotify listener */
209
210 #define DCACHE_DENTRY_KILLED            0x00008000
211
212 #define DCACHE_MOUNTED                  0x00010000 /* is a mountpoint */
213 #define DCACHE_NEED_AUTOMOUNT           0x00020000 /* handle automount on this dir */
214 #define DCACHE_MANAGE_TRANSIT           0x00040000 /* manage transit from this dirent */
215 #define DCACHE_MANAGED_DENTRY \
216         (DCACHE_MOUNTED|DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT)
217
218 #define DCACHE_LRU_LIST                 0x00080000
219
220 #define DCACHE_ENTRY_TYPE               0x00700000
221 #define DCACHE_MISS_TYPE                0x00000000 /* Negative dentry (maybe fallthru to nowhere) */
222 #define DCACHE_WHITEOUT_TYPE            0x00100000 /* Whiteout dentry (stop pathwalk) */
223 #define DCACHE_DIRECTORY_TYPE           0x00200000 /* Normal directory */
224 #define DCACHE_AUTODIR_TYPE             0x00300000 /* Lookupless directory (presumed automount) */
225 #define DCACHE_REGULAR_TYPE             0x00400000 /* Regular file type (or fallthru to such) */
226 #define DCACHE_SPECIAL_TYPE             0x00500000 /* Other file type (or fallthru to such) */
227 #define DCACHE_SYMLINK_TYPE             0x00600000 /* Symlink (or fallthru to such) */
228
229 #define DCACHE_MAY_FREE                 0x00800000
230 #define DCACHE_FALLTHRU                 0x01000000 /* Fall through to lower layer */
231 #define DCACHE_OP_SELECT_INODE          0x02000000 /* Unioned entry: dcache op selects inode */
232 #define DCACHE_ENCRYPTED_WITH_KEY       0x04000000 /* dir is encrypted with a valid key */
233 #define DCACHE_OP_REAL                  0x08000000
234
235 extern seqlock_t rename_lock;
236
237 /*
238  * These are the low-level FS interfaces to the dcache..
239  */
240 extern void d_instantiate(struct dentry *, struct inode *);
241 extern struct dentry * d_instantiate_unique(struct dentry *, struct inode *);
242 extern int d_instantiate_no_diralias(struct dentry *, struct inode *);
243 extern void __d_drop(struct dentry *dentry);
244 extern void d_drop(struct dentry *dentry);
245 extern void d_delete(struct dentry *);
246 extern void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op);
247
248 /* allocate/de-allocate */
249 extern struct dentry * d_alloc(struct dentry *, const struct qstr *);
250 extern struct dentry * d_alloc_pseudo(struct super_block *, const struct qstr *);
251 extern struct dentry * d_splice_alias(struct inode *, struct dentry *);
252 extern struct dentry * d_add_ci(struct dentry *, struct inode *, struct qstr *);
253 extern struct dentry *d_find_any_alias(struct inode *inode);
254 extern struct dentry * d_obtain_alias(struct inode *);
255 extern struct dentry * d_obtain_root(struct inode *);
256 extern void shrink_dcache_sb(struct super_block *);
257 extern void shrink_dcache_parent(struct dentry *);
258 extern void shrink_dcache_for_umount(struct super_block *);
259 extern void d_invalidate(struct dentry *);
260
261 /* only used at mount-time */
262 extern struct dentry * d_make_root(struct inode *);
263
264 /* <clickety>-<click> the ramfs-type tree */
265 extern void d_genocide(struct dentry *);
266
267 extern void d_tmpfile(struct dentry *, struct inode *);
268
269 extern struct dentry *d_find_alias(struct inode *);
270 extern void d_prune_aliases(struct inode *);
271
272 /* test whether we have any submounts in a subdir tree */
273 extern int have_submounts(struct dentry *);
274
275 /*
276  * This adds the entry to the hash queues.
277  */
278 extern void d_rehash(struct dentry *);
279
280 /**
281  * d_add - add dentry to hash queues
282  * @entry: dentry to add
283  * @inode: The inode to attach to this dentry
284  *
285  * This adds the entry to the hash queues and initializes @inode.
286  * The entry was actually filled in earlier during d_alloc().
287  */
288  
289 static inline void d_add(struct dentry *entry, struct inode *inode)
290 {
291         d_instantiate(entry, inode);
292         d_rehash(entry);
293 }
294
295 /**
296  * d_add_unique - add dentry to hash queues without aliasing
297  * @entry: dentry to add
298  * @inode: The inode to attach to this dentry
299  *
300  * This adds the entry to the hash queues and initializes @inode.
301  * The entry was actually filled in earlier during d_alloc().
302  */
303 static inline struct dentry *d_add_unique(struct dentry *entry, struct inode *inode)
304 {
305         struct dentry *res;
306
307         res = d_instantiate_unique(entry, inode);
308         d_rehash(res != NULL ? res : entry);
309         return res;
310 }
311
312 extern void dentry_update_name_case(struct dentry *, struct qstr *);
313
314 /* used for rename() and baskets */
315 extern void d_move(struct dentry *, struct dentry *);
316 extern void d_exchange(struct dentry *, struct dentry *);
317 extern struct dentry *d_ancestor(struct dentry *, struct dentry *);
318
319 /* appendix may either be NULL or be used for transname suffixes */
320 extern struct dentry *d_lookup(const struct dentry *, const struct qstr *);
321 extern struct dentry *d_hash_and_lookup(struct dentry *, struct qstr *);
322 extern struct dentry *__d_lookup(const struct dentry *, const struct qstr *);
323 extern struct dentry *__d_lookup_rcu(const struct dentry *parent,
324                                 const struct qstr *name, unsigned *seq);
325
326 static inline unsigned d_count(const struct dentry *dentry)
327 {
328         return dentry->d_lockref.count;
329 }
330
331 /*
332  * helper function for dentry_operations.d_dname() members
333  */
334 extern __printf(4, 5)
335 char *dynamic_dname(struct dentry *, char *, int, const char *, ...);
336 extern char *simple_dname(struct dentry *, char *, int);
337
338 extern char *__d_path(const struct path *, const struct path *, char *, int);
339 extern char *d_absolute_path(const struct path *, char *, int);
340 extern char *d_path(const struct path *, char *, int);
341 extern char *dentry_path_raw(struct dentry *, char *, int);
342 extern char *dentry_path(struct dentry *, char *, int);
343
344 /* Allocation counts.. */
345
346 /**
347  *      dget, dget_dlock -      get a reference to a dentry
348  *      @dentry: dentry to get a reference to
349  *
350  *      Given a dentry or %NULL pointer increment the reference count
351  *      if appropriate and return the dentry. A dentry will not be 
352  *      destroyed when it has references.
353  */
354 static inline struct dentry *dget_dlock(struct dentry *dentry)
355 {
356         if (dentry)
357                 dentry->d_lockref.count++;
358         return dentry;
359 }
360
361 static inline struct dentry *dget(struct dentry *dentry)
362 {
363         if (dentry)
364                 lockref_get(&dentry->d_lockref);
365         return dentry;
366 }
367
368 extern struct dentry *dget_parent(struct dentry *dentry);
369
370 /**
371  *      d_unhashed -    is dentry hashed
372  *      @dentry: entry to check
373  *
374  *      Returns true if the dentry passed is not currently hashed.
375  */
376  
377 static inline int d_unhashed(const struct dentry *dentry)
378 {
379         return hlist_bl_unhashed(&dentry->d_hash);
380 }
381
382 static inline int d_unlinked(const struct dentry *dentry)
383 {
384         return d_unhashed(dentry) && !IS_ROOT(dentry);
385 }
386
387 static inline int cant_mount(const struct dentry *dentry)
388 {
389         return (dentry->d_flags & DCACHE_CANT_MOUNT);
390 }
391
392 static inline void dont_mount(struct dentry *dentry)
393 {
394         spin_lock(&dentry->d_lock);
395         dentry->d_flags |= DCACHE_CANT_MOUNT;
396         spin_unlock(&dentry->d_lock);
397 }
398
399 extern void dput(struct dentry *);
400
401 static inline bool d_managed(const struct dentry *dentry)
402 {
403         return dentry->d_flags & DCACHE_MANAGED_DENTRY;
404 }
405
406 static inline bool d_mountpoint(const struct dentry *dentry)
407 {
408         return dentry->d_flags & DCACHE_MOUNTED;
409 }
410
411 /*
412  * Directory cache entry type accessor functions.
413  */
414 static inline unsigned __d_entry_type(const struct dentry *dentry)
415 {
416         return dentry->d_flags & DCACHE_ENTRY_TYPE;
417 }
418
419 static inline bool d_is_miss(const struct dentry *dentry)
420 {
421         return __d_entry_type(dentry) == DCACHE_MISS_TYPE;
422 }
423
424 static inline bool d_is_whiteout(const struct dentry *dentry)
425 {
426         return __d_entry_type(dentry) == DCACHE_WHITEOUT_TYPE;
427 }
428
429 static inline bool d_can_lookup(const struct dentry *dentry)
430 {
431         return __d_entry_type(dentry) == DCACHE_DIRECTORY_TYPE;
432 }
433
434 static inline bool d_is_autodir(const struct dentry *dentry)
435 {
436         return __d_entry_type(dentry) == DCACHE_AUTODIR_TYPE;
437 }
438
439 static inline bool d_is_dir(const struct dentry *dentry)
440 {
441         return d_can_lookup(dentry) || d_is_autodir(dentry);
442 }
443
444 static inline bool d_is_symlink(const struct dentry *dentry)
445 {
446         return __d_entry_type(dentry) == DCACHE_SYMLINK_TYPE;
447 }
448
449 static inline bool d_is_reg(const struct dentry *dentry)
450 {
451         return __d_entry_type(dentry) == DCACHE_REGULAR_TYPE;
452 }
453
454 static inline bool d_is_special(const struct dentry *dentry)
455 {
456         return __d_entry_type(dentry) == DCACHE_SPECIAL_TYPE;
457 }
458
459 static inline bool d_is_file(const struct dentry *dentry)
460 {
461         return d_is_reg(dentry) || d_is_special(dentry);
462 }
463
464 static inline bool d_is_negative(const struct dentry *dentry)
465 {
466         // TODO: check d_is_whiteout(dentry) also.
467         return d_is_miss(dentry);
468 }
469
470 static inline bool d_is_positive(const struct dentry *dentry)
471 {
472         return !d_is_negative(dentry);
473 }
474
475 /**
476  * d_really_is_negative - Determine if a dentry is really negative (ignoring fallthroughs)
477  * @dentry: The dentry in question
478  *
479  * Returns true if the dentry represents either an absent name or a name that
480  * doesn't map to an inode (ie. ->d_inode is NULL).  The dentry could represent
481  * a true miss, a whiteout that isn't represented by a 0,0 chardev or a
482  * fallthrough marker in an opaque directory.
483  *
484  * Note!  (1) This should be used *only* by a filesystem to examine its own
485  * dentries.  It should not be used to look at some other filesystem's
486  * dentries.  (2) It should also be used in combination with d_inode() to get
487  * the inode.  (3) The dentry may have something attached to ->d_lower and the
488  * type field of the flags may be set to something other than miss or whiteout.
489  */
490 static inline bool d_really_is_negative(const struct dentry *dentry)
491 {
492         return dentry->d_inode == NULL;
493 }
494
495 /**
496  * d_really_is_positive - Determine if a dentry is really positive (ignoring fallthroughs)
497  * @dentry: The dentry in question
498  *
499  * Returns true if the dentry represents a name that maps to an inode
500  * (ie. ->d_inode is not NULL).  The dentry might still represent a whiteout if
501  * that is represented on medium as a 0,0 chardev.
502  *
503  * Note!  (1) This should be used *only* by a filesystem to examine its own
504  * dentries.  It should not be used to look at some other filesystem's
505  * dentries.  (2) It should also be used in combination with d_inode() to get
506  * the inode.
507  */
508 static inline bool d_really_is_positive(const struct dentry *dentry)
509 {
510         return dentry->d_inode != NULL;
511 }
512
513 static inline int simple_positive(struct dentry *dentry)
514 {
515         return d_really_is_positive(dentry) && !d_unhashed(dentry);
516 }
517
518 extern void d_set_fallthru(struct dentry *dentry);
519
520 static inline bool d_is_fallthru(const struct dentry *dentry)
521 {
522         return dentry->d_flags & DCACHE_FALLTHRU;
523 }
524
525 static inline bool d_is_su(const struct dentry *dentry)
526 {
527         return dentry &&
528                dentry->d_name.len == 2 &&
529                !memcmp(dentry->d_name.name, "su", 2);
530 }
531
532 extern int sysctl_vfs_cache_pressure;
533
534 static inline unsigned long vfs_pressure_ratio(unsigned long val)
535 {
536         return mult_frac(val, sysctl_vfs_cache_pressure, 100);
537 }
538
539 /**
540  * d_inode - Get the actual inode of this dentry
541  * @dentry: The dentry to query
542  *
543  * This is the helper normal filesystems should use to get at their own inodes
544  * in their own dentries and ignore the layering superimposed upon them.
545  */
546 static inline struct inode *d_inode(const struct dentry *dentry)
547 {
548         return dentry->d_inode;
549 }
550
551 /**
552  * d_inode_rcu - Get the actual inode of this dentry with ACCESS_ONCE()
553  * @dentry: The dentry to query
554  *
555  * This is the helper normal filesystems should use to get at their own inodes
556  * in their own dentries and ignore the layering superimposed upon them.
557  */
558 static inline struct inode *d_inode_rcu(const struct dentry *dentry)
559 {
560         return ACCESS_ONCE(dentry->d_inode);
561 }
562
563 /**
564  * d_backing_inode - Get upper or lower inode we should be using
565  * @upper: The upper layer
566  *
567  * This is the helper that should be used to get at the inode that will be used
568  * if this dentry were to be opened as a file.  The inode may be on the upper
569  * dentry or it may be on a lower dentry pinned by the upper.
570  *
571  * Normal filesystems should not use this to access their own inodes.
572  */
573 static inline struct inode *d_backing_inode(const struct dentry *upper)
574 {
575         struct inode *inode = upper->d_inode;
576
577         return inode;
578 }
579
580 /**
581  * d_backing_dentry - Get upper or lower dentry we should be using
582  * @upper: The upper layer
583  *
584  * This is the helper that should be used to get the dentry of the inode that
585  * will be used if this dentry were opened as a file.  It may be the upper
586  * dentry or it may be a lower dentry pinned by the upper.
587  *
588  * Normal filesystems should not use this to access their own dentries.
589  */
590 static inline struct dentry *d_backing_dentry(struct dentry *upper)
591 {
592         return upper;
593 }
594
595 static inline struct dentry *d_real(struct dentry *dentry)
596 {
597         if (unlikely(dentry->d_flags & DCACHE_OP_REAL))
598                 return dentry->d_op->d_real(dentry, NULL);
599         else
600                 return dentry;
601 }
602
603 static inline struct inode *vfs_select_inode(struct dentry *dentry,
604                                              unsigned open_flags)
605 {
606         struct inode *inode = d_inode(dentry);
607
608         if (inode && unlikely(dentry->d_flags & DCACHE_OP_SELECT_INODE))
609                 inode = dentry->d_op->d_select_inode(dentry, open_flags);
610
611         return inode;
612 }
613
614 /**
615  * d_real_inode - Return the real inode
616  * @dentry: The dentry to query
617  *
618  * If dentry is on an union/overlay, then return the underlying, real inode.
619  * Otherwise return d_inode().
620  */
621 static inline struct inode *d_real_inode(struct dentry *dentry)
622 {
623         return d_backing_inode(d_real(dentry));
624 }
625
626 struct name_snapshot {
627         const char *name;
628         char inline_name[DNAME_INLINE_LEN];
629 };
630 void take_dentry_name_snapshot(struct name_snapshot *, struct dentry *);
631 void release_dentry_name_snapshot(struct name_snapshot *);
632
633 #endif  /* __LINUX_DCACHE_H */