1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LINUX_DCACHE_H
3 #define __LINUX_DCACHE_H
5 #include <linux/atomic.h>
6 #include <linux/list.h>
7 #include <linux/math.h>
8 #include <linux/rculist.h>
9 #include <linux/rculist_bl.h>
10 #include <linux/spinlock.h>
11 #include <linux/seqlock.h>
12 #include <linux/cache.h>
13 #include <linux/rcupdate.h>
14 #include <linux/lockref.h>
15 #include <linux/stringhash.h>
16 #include <linux/wait.h>
22 * linux/include/linux/dcache.h
24 * Dirent cache data structures
26 * (C) Copyright 1997 Thomas Schoebel-Theuer,
27 * with heavy changes by Linus Torvalds
30 #define IS_ROOT(x) ((x) == (x)->d_parent)
32 /* The hash is always the low bits of hash_len */
33 #ifdef __LITTLE_ENDIAN
34 #define HASH_LEN_DECLARE u32 hash; u32 len
35 #define bytemask_from_count(cnt) (~(~0ul << (cnt)*8))
37 #define HASH_LEN_DECLARE u32 len; u32 hash
38 #define bytemask_from_count(cnt) (~(~0ul >> (cnt)*8))
42 * "quick string" -- eases parameter passing, but more importantly
43 * saves "metadata" about the string (ie length and the hash).
45 * hash comes first so it snuggles against d_parent in the
55 const unsigned char *name;
58 #define QSTR_INIT(n,l) { { { .len = l } }, .name = n }
60 extern const struct qstr empty_name;
61 extern const struct qstr slash_name;
63 struct dentry_stat_t {
66 long age_limit; /* age in seconds */
67 long want_pages; /* pages requested by system */
68 long nr_negative; /* # of unused negative dentries */
69 long dummy; /* Reserved for future use */
71 extern struct dentry_stat_t dentry_stat;
74 * Try to keep struct dentry aligned on 64 byte cachelines (this will
75 * give reasonable cacheline footprint with larger lines without the
76 * large memory footprint increase).
79 # define DNAME_INLINE_LEN 32 /* 192 bytes */
82 # define DNAME_INLINE_LEN 36 /* 128 bytes */
84 # define DNAME_INLINE_LEN 40 /* 128 bytes */
88 #define d_lock d_lockref.lock
91 /* RCU lookup touched fields */
92 unsigned int d_flags; /* protected by d_lock */
93 seqcount_spinlock_t d_seq; /* per dentry seqlock */
94 struct hlist_bl_node d_hash; /* lookup hash list */
95 struct dentry *d_parent; /* parent directory */
97 struct inode *d_inode; /* Where the name belongs to - NULL is
99 unsigned char d_iname[DNAME_INLINE_LEN]; /* small names */
101 /* Ref lookup also touches following */
102 struct lockref d_lockref; /* per-dentry lock and refcount */
103 const struct dentry_operations *d_op;
104 struct super_block *d_sb; /* The root of the dentry tree */
105 unsigned long d_time; /* used by d_revalidate */
106 void *d_fsdata; /* fs-specific data */
109 struct list_head d_lru; /* LRU list */
110 wait_queue_head_t *d_wait; /* in-lookup ones only */
112 struct list_head d_child; /* child of parent list */
113 struct list_head d_subdirs; /* our children */
115 * d_alias and d_rcu can share memory
118 struct hlist_node d_alias; /* inode alias list */
119 struct hlist_bl_node d_in_lookup_hash; /* only for in-lookup ones */
120 struct rcu_head d_rcu;
122 } __randomize_layout;
125 * dentry->d_lock spinlock nesting subclasses:
130 enum dentry_d_lock_class
132 DENTRY_D_LOCK_NORMAL, /* implicitly used by plain spin_lock() APIs. */
136 struct dentry_operations {
137 int (*d_revalidate)(struct dentry *, unsigned int);
138 int (*d_weak_revalidate)(struct dentry *, unsigned int);
139 int (*d_hash)(const struct dentry *, struct qstr *);
140 int (*d_compare)(const struct dentry *,
141 unsigned int, const char *, const struct qstr *);
142 int (*d_delete)(const struct dentry *);
143 int (*d_init)(struct dentry *);
144 void (*d_release)(struct dentry *);
145 void (*d_prune)(struct dentry *);
146 void (*d_iput)(struct dentry *, struct inode *);
147 char *(*d_dname)(struct dentry *, char *, int);
148 struct vfsmount *(*d_automount)(struct path *);
149 int (*d_manage)(const struct path *, bool);
150 struct dentry *(*d_real)(struct dentry *, const struct inode *);
151 } ____cacheline_aligned;
154 * Locking rules for dentry_operations callbacks are to be found in
155 * Documentation/filesystems/locking.rst. Keep it updated!
157 * FUrther descriptions are found in Documentation/filesystems/vfs.rst.
158 * Keep it updated too!
161 /* d_flags entries */
162 #define DCACHE_OP_HASH 0x00000001
163 #define DCACHE_OP_COMPARE 0x00000002
164 #define DCACHE_OP_REVALIDATE 0x00000004
165 #define DCACHE_OP_DELETE 0x00000008
166 #define DCACHE_OP_PRUNE 0x00000010
168 #define DCACHE_DISCONNECTED 0x00000020
169 /* This dentry is possibly not currently connected to the dcache tree, in
170 * which case its parent will either be itself, or will have this flag as
171 * well. nfsd will not use a dentry with this bit set, but will first
172 * endeavour to clear the bit either by discovering that it is connected,
173 * or by performing lookup operations. Any filesystem which supports
174 * nfsd_operations MUST have a lookup function which, if it finds a
175 * directory inode with a DCACHE_DISCONNECTED dentry, will d_move that
176 * dentry into place and return that dentry rather than the passed one,
177 * typically using d_splice_alias. */
179 #define DCACHE_REFERENCED 0x00000040 /* Recently used, don't discard. */
181 #define DCACHE_DONTCACHE 0x00000080 /* Purge from memory on final dput() */
183 #define DCACHE_CANT_MOUNT 0x00000100
184 #define DCACHE_GENOCIDE 0x00000200
185 #define DCACHE_SHRINK_LIST 0x00000400
187 #define DCACHE_OP_WEAK_REVALIDATE 0x00000800
189 #define DCACHE_NFSFS_RENAMED 0x00001000
190 /* this dentry has been "silly renamed" and has to be deleted on the last
192 #define DCACHE_COOKIE 0x00002000 /* For use by dcookie subsystem */
193 #define DCACHE_FSNOTIFY_PARENT_WATCHED 0x00004000
194 /* Parent inode is watched by some fsnotify listener */
196 #define DCACHE_DENTRY_KILLED 0x00008000
198 #define DCACHE_MOUNTED 0x00010000 /* is a mountpoint */
199 #define DCACHE_NEED_AUTOMOUNT 0x00020000 /* handle automount on this dir */
200 #define DCACHE_MANAGE_TRANSIT 0x00040000 /* manage transit from this dirent */
201 #define DCACHE_MANAGED_DENTRY \
202 (DCACHE_MOUNTED|DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT)
204 #define DCACHE_LRU_LIST 0x00080000
206 #define DCACHE_ENTRY_TYPE 0x00700000
207 #define DCACHE_MISS_TYPE 0x00000000 /* Negative dentry (maybe fallthru to nowhere) */
208 #define DCACHE_WHITEOUT_TYPE 0x00100000 /* Whiteout dentry (stop pathwalk) */
209 #define DCACHE_DIRECTORY_TYPE 0x00200000 /* Normal directory */
210 #define DCACHE_AUTODIR_TYPE 0x00300000 /* Lookupless directory (presumed automount) */
211 #define DCACHE_REGULAR_TYPE 0x00400000 /* Regular file type (or fallthru to such) */
212 #define DCACHE_SPECIAL_TYPE 0x00500000 /* Other file type (or fallthru to such) */
213 #define DCACHE_SYMLINK_TYPE 0x00600000 /* Symlink (or fallthru to such) */
215 #define DCACHE_MAY_FREE 0x00800000
216 #define DCACHE_FALLTHRU 0x01000000 /* Fall through to lower layer */
217 #define DCACHE_NOKEY_NAME 0x02000000 /* Encrypted name encoded without key */
218 #define DCACHE_OP_REAL 0x04000000
220 #define DCACHE_PAR_LOOKUP 0x10000000 /* being looked up (with parent locked shared) */
221 #define DCACHE_DENTRY_CURSOR 0x20000000
222 #define DCACHE_NORCU 0x40000000 /* No RCU delay for freeing */
224 extern seqlock_t rename_lock;
227 * These are the low-level FS interfaces to the dcache..
229 extern void d_instantiate(struct dentry *, struct inode *);
230 extern void d_instantiate_new(struct dentry *, struct inode *);
231 extern struct dentry * d_instantiate_unique(struct dentry *, struct inode *);
232 extern struct dentry * d_instantiate_anon(struct dentry *, struct inode *);
233 extern void __d_drop(struct dentry *dentry);
234 extern void d_drop(struct dentry *dentry);
235 extern void d_delete(struct dentry *);
236 extern void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op);
238 /* allocate/de-allocate */
239 extern struct dentry * d_alloc(struct dentry *, const struct qstr *);
240 extern struct dentry * d_alloc_anon(struct super_block *);
241 extern struct dentry * d_alloc_parallel(struct dentry *, const struct qstr *,
242 wait_queue_head_t *);
243 extern struct dentry * d_splice_alias(struct inode *, struct dentry *);
244 extern struct dentry * d_add_ci(struct dentry *, struct inode *, struct qstr *);
245 extern struct dentry * d_exact_alias(struct dentry *, struct inode *);
246 extern struct dentry *d_find_any_alias(struct inode *inode);
247 extern struct dentry * d_obtain_alias(struct inode *);
248 extern struct dentry * d_obtain_root(struct inode *);
249 extern void shrink_dcache_sb(struct super_block *);
250 extern void shrink_dcache_parent(struct dentry *);
251 extern void shrink_dcache_for_umount(struct super_block *);
252 extern void d_invalidate(struct dentry *);
254 /* only used at mount-time */
255 extern struct dentry * d_make_root(struct inode *);
257 /* <clickety>-<click> the ramfs-type tree */
258 extern void d_genocide(struct dentry *);
260 extern void d_tmpfile(struct dentry *, struct inode *);
262 extern struct dentry *d_find_alias(struct inode *);
263 extern void d_prune_aliases(struct inode *);
265 extern struct dentry *d_find_alias_rcu(struct inode *);
267 /* test whether we have any submounts in a subdir tree */
268 extern int path_has_submounts(const struct path *);
271 * This adds the entry to the hash queues.
273 extern void d_rehash(struct dentry *);
275 extern void d_add(struct dentry *, struct inode *);
277 /* used for rename() and baskets */
278 extern void d_move(struct dentry *, struct dentry *);
279 extern void d_exchange(struct dentry *, struct dentry *);
280 extern struct dentry *d_ancestor(struct dentry *, struct dentry *);
282 /* appendix may either be NULL or be used for transname suffixes */
283 extern struct dentry *d_lookup(const struct dentry *, const struct qstr *);
284 extern struct dentry *d_hash_and_lookup(struct dentry *, struct qstr *);
285 extern struct dentry *__d_lookup(const struct dentry *, const struct qstr *);
286 extern struct dentry *__d_lookup_rcu(const struct dentry *parent,
287 const struct qstr *name, unsigned *seq);
289 static inline unsigned d_count(const struct dentry *dentry)
291 return dentry->d_lockref.count;
295 * helper function for dentry_operations.d_dname() members
297 extern __printf(4, 5)
298 char *dynamic_dname(struct dentry *, char *, int, const char *, ...);
300 extern char *__d_path(const struct path *, const struct path *, char *, int);
301 extern char *d_absolute_path(const struct path *, char *, int);
302 extern char *d_path(const struct path *, char *, int);
303 extern char *dentry_path_raw(struct dentry *, char *, int);
304 extern char *dentry_path(struct dentry *, char *, int);
306 /* Allocation counts.. */
309 * dget, dget_dlock - get a reference to a dentry
310 * @dentry: dentry to get a reference to
312 * Given a dentry or %NULL pointer increment the reference count
313 * if appropriate and return the dentry. A dentry will not be
314 * destroyed when it has references.
316 static inline struct dentry *dget_dlock(struct dentry *dentry)
319 dentry->d_lockref.count++;
323 static inline struct dentry *dget(struct dentry *dentry)
326 lockref_get(&dentry->d_lockref);
330 extern struct dentry *dget_parent(struct dentry *dentry);
333 * d_unhashed - is dentry hashed
334 * @dentry: entry to check
336 * Returns true if the dentry passed is not currently hashed.
339 static inline int d_unhashed(const struct dentry *dentry)
341 return hlist_bl_unhashed(&dentry->d_hash);
344 static inline int d_unlinked(const struct dentry *dentry)
346 return d_unhashed(dentry) && !IS_ROOT(dentry);
349 static inline int cant_mount(const struct dentry *dentry)
351 return (dentry->d_flags & DCACHE_CANT_MOUNT);
354 static inline void dont_mount(struct dentry *dentry)
356 spin_lock(&dentry->d_lock);
357 dentry->d_flags |= DCACHE_CANT_MOUNT;
358 spin_unlock(&dentry->d_lock);
361 extern void __d_lookup_done(struct dentry *);
363 static inline int d_in_lookup(const struct dentry *dentry)
365 return dentry->d_flags & DCACHE_PAR_LOOKUP;
368 static inline void d_lookup_done(struct dentry *dentry)
370 if (unlikely(d_in_lookup(dentry))) {
371 spin_lock(&dentry->d_lock);
372 __d_lookup_done(dentry);
373 spin_unlock(&dentry->d_lock);
377 extern void dput(struct dentry *);
379 static inline bool d_managed(const struct dentry *dentry)
381 return dentry->d_flags & DCACHE_MANAGED_DENTRY;
384 static inline bool d_mountpoint(const struct dentry *dentry)
386 return dentry->d_flags & DCACHE_MOUNTED;
390 * Directory cache entry type accessor functions.
392 static inline unsigned __d_entry_type(const struct dentry *dentry)
394 return dentry->d_flags & DCACHE_ENTRY_TYPE;
397 static inline bool d_is_miss(const struct dentry *dentry)
399 return __d_entry_type(dentry) == DCACHE_MISS_TYPE;
402 static inline bool d_is_whiteout(const struct dentry *dentry)
404 return __d_entry_type(dentry) == DCACHE_WHITEOUT_TYPE;
407 static inline bool d_can_lookup(const struct dentry *dentry)
409 return __d_entry_type(dentry) == DCACHE_DIRECTORY_TYPE;
412 static inline bool d_is_autodir(const struct dentry *dentry)
414 return __d_entry_type(dentry) == DCACHE_AUTODIR_TYPE;
417 static inline bool d_is_dir(const struct dentry *dentry)
419 return d_can_lookup(dentry) || d_is_autodir(dentry);
422 static inline bool d_is_symlink(const struct dentry *dentry)
424 return __d_entry_type(dentry) == DCACHE_SYMLINK_TYPE;
427 static inline bool d_is_reg(const struct dentry *dentry)
429 return __d_entry_type(dentry) == DCACHE_REGULAR_TYPE;
432 static inline bool d_is_special(const struct dentry *dentry)
434 return __d_entry_type(dentry) == DCACHE_SPECIAL_TYPE;
437 static inline bool d_is_file(const struct dentry *dentry)
439 return d_is_reg(dentry) || d_is_special(dentry);
442 static inline bool d_is_negative(const struct dentry *dentry)
444 // TODO: check d_is_whiteout(dentry) also.
445 return d_is_miss(dentry);
448 static inline bool d_flags_negative(unsigned flags)
450 return (flags & DCACHE_ENTRY_TYPE) == DCACHE_MISS_TYPE;
453 static inline bool d_is_positive(const struct dentry *dentry)
455 return !d_is_negative(dentry);
459 * d_really_is_negative - Determine if a dentry is really negative (ignoring fallthroughs)
460 * @dentry: The dentry in question
462 * Returns true if the dentry represents either an absent name or a name that
463 * doesn't map to an inode (ie. ->d_inode is NULL). The dentry could represent
464 * a true miss, a whiteout that isn't represented by a 0,0 chardev or a
465 * fallthrough marker in an opaque directory.
467 * Note! (1) This should be used *only* by a filesystem to examine its own
468 * dentries. It should not be used to look at some other filesystem's
469 * dentries. (2) It should also be used in combination with d_inode() to get
470 * the inode. (3) The dentry may have something attached to ->d_lower and the
471 * type field of the flags may be set to something other than miss or whiteout.
473 static inline bool d_really_is_negative(const struct dentry *dentry)
475 return dentry->d_inode == NULL;
479 * d_really_is_positive - Determine if a dentry is really positive (ignoring fallthroughs)
480 * @dentry: The dentry in question
482 * Returns true if the dentry represents a name that maps to an inode
483 * (ie. ->d_inode is not NULL). The dentry might still represent a whiteout if
484 * that is represented on medium as a 0,0 chardev.
486 * Note! (1) This should be used *only* by a filesystem to examine its own
487 * dentries. It should not be used to look at some other filesystem's
488 * dentries. (2) It should also be used in combination with d_inode() to get
491 static inline bool d_really_is_positive(const struct dentry *dentry)
493 return dentry->d_inode != NULL;
496 static inline int simple_positive(const struct dentry *dentry)
498 return d_really_is_positive(dentry) && !d_unhashed(dentry);
501 extern void d_set_fallthru(struct dentry *dentry);
503 static inline bool d_is_fallthru(const struct dentry *dentry)
505 return dentry->d_flags & DCACHE_FALLTHRU;
509 extern int sysctl_vfs_cache_pressure;
511 static inline unsigned long vfs_pressure_ratio(unsigned long val)
513 return mult_frac(val, sysctl_vfs_cache_pressure, 100);
517 * d_inode - Get the actual inode of this dentry
518 * @dentry: The dentry to query
520 * This is the helper normal filesystems should use to get at their own inodes
521 * in their own dentries and ignore the layering superimposed upon them.
523 static inline struct inode *d_inode(const struct dentry *dentry)
525 return dentry->d_inode;
529 * d_inode_rcu - Get the actual inode of this dentry with READ_ONCE()
530 * @dentry: The dentry to query
532 * This is the helper normal filesystems should use to get at their own inodes
533 * in their own dentries and ignore the layering superimposed upon them.
535 static inline struct inode *d_inode_rcu(const struct dentry *dentry)
537 return READ_ONCE(dentry->d_inode);
541 * d_backing_inode - Get upper or lower inode we should be using
542 * @upper: The upper layer
544 * This is the helper that should be used to get at the inode that will be used
545 * if this dentry were to be opened as a file. The inode may be on the upper
546 * dentry or it may be on a lower dentry pinned by the upper.
548 * Normal filesystems should not use this to access their own inodes.
550 static inline struct inode *d_backing_inode(const struct dentry *upper)
552 struct inode *inode = upper->d_inode;
558 * d_backing_dentry - Get upper or lower dentry we should be using
559 * @upper: The upper layer
561 * This is the helper that should be used to get the dentry of the inode that
562 * will be used if this dentry were opened as a file. It may be the upper
563 * dentry or it may be a lower dentry pinned by the upper.
565 * Normal filesystems should not use this to access their own dentries.
567 static inline struct dentry *d_backing_dentry(struct dentry *upper)
573 * d_real - Return the real dentry
574 * @dentry: the dentry to query
575 * @inode: inode to select the dentry from multiple layers (can be NULL)
577 * If dentry is on a union/overlay, then return the underlying, real dentry.
578 * Otherwise return the dentry itself.
580 * See also: Documentation/filesystems/vfs.rst
582 static inline struct dentry *d_real(struct dentry *dentry,
583 const struct inode *inode)
585 if (unlikely(dentry->d_flags & DCACHE_OP_REAL))
586 return dentry->d_op->d_real(dentry, inode);
592 * d_real_inode - Return the real inode
593 * @dentry: The dentry to query
595 * If dentry is on a union/overlay, then return the underlying, real inode.
596 * Otherwise return d_inode().
598 static inline struct inode *d_real_inode(const struct dentry *dentry)
600 /* This usage of d_real() results in const dentry */
601 return d_backing_inode(d_real((struct dentry *) dentry, NULL));
604 struct name_snapshot {
606 unsigned char inline_name[DNAME_INLINE_LEN];
608 void take_dentry_name_snapshot(struct name_snapshot *, struct dentry *);
609 void release_dentry_name_snapshot(struct name_snapshot *);
611 #endif /* __LINUX_DCACHE_H */