Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | #ifndef __LINUX_DCACHE_H |
3 | #define __LINUX_DCACHE_H | |
4 | ||
60063497 | 5 | #include <linux/atomic.h> |
1da177e4 | 6 | #include <linux/list.h> |
aa6159ab | 7 | #include <linux/math.h> |
82524746 | 8 | #include <linux/rculist.h> |
ceb5bdc2 | 9 | #include <linux/rculist_bl.h> |
1da177e4 | 10 | #include <linux/spinlock.h> |
31e6b01f | 11 | #include <linux/seqlock.h> |
1da177e4 LT |
12 | #include <linux/cache.h> |
13 | #include <linux/rcupdate.h> | |
98474236 | 14 | #include <linux/lockref.h> |
f4bcbe79 | 15 | #include <linux/stringhash.h> |
f9411ebe | 16 | #include <linux/wait.h> |
1da177e4 | 17 | |
cf28b486 | 18 | struct path; |
863f144f | 19 | struct file; |
1da177e4 LT |
20 | struct vfsmount; |
21 | ||
22 | /* | |
23 | * linux/include/linux/dcache.h | |
24 | * | |
25 | * Dirent cache data structures | |
26 | * | |
27 | * (C) Copyright 1997 Thomas Schoebel-Theuer, | |
28 | * with heavy changes by Linus Torvalds | |
29 | */ | |
30 | ||
31 | #define IS_ROOT(x) ((x) == (x)->d_parent) | |
32 | ||
26fe5750 LT |
33 | /* The hash is always the low bits of hash_len */ |
34 | #ifdef __LITTLE_ENDIAN | |
2bd03e49 | 35 | #define HASH_LEN_DECLARE u32 hash; u32 len |
a5c21dce | 36 | #define bytemask_from_count(cnt) (~(~0ul << (cnt)*8)) |
26fe5750 | 37 | #else |
2bd03e49 | 38 | #define HASH_LEN_DECLARE u32 len; u32 hash |
a5c21dce | 39 | #define bytemask_from_count(cnt) (~(~0ul >> (cnt)*8)) |
26fe5750 LT |
40 | #endif |
41 | ||
1da177e4 LT |
42 | /* |
43 | * "quick string" -- eases parameter passing, but more importantly | |
44 | * saves "metadata" about the string (ie length and the hash). | |
45 | * | |
46 | * hash comes first so it snuggles against d_parent in the | |
47 | * dentry. | |
48 | */ | |
49 | struct qstr { | |
26fe5750 LT |
50 | union { |
51 | struct { | |
52 | HASH_LEN_DECLARE; | |
53 | }; | |
54 | u64 hash_len; | |
55 | }; | |
1da177e4 LT |
56 | const unsigned char *name; |
57 | }; | |
58 | ||
26fe5750 | 59 | #define QSTR_INIT(n,l) { { { .len = l } }, .name = n } |
26fe5750 | 60 | |
cdf01226 | 61 | extern const struct qstr empty_name; |
cdf01226 | 62 | extern const struct qstr slash_name; |
80e5d1ff | 63 | extern const struct qstr dotdot_name; |
cdf01226 | 64 | |
c2452f32 NP |
65 | /* |
66 | * Try to keep struct dentry aligned on 64 byte cachelines (this will | |
67 | * give reasonable cacheline footprint with larger lines without the | |
68 | * large memory footprint increase). | |
69 | */ | |
70 | #ifdef CONFIG_64BIT | |
44a7d7a8 | 71 | # define DNAME_INLINE_LEN 32 /* 192 bytes */ |
c2452f32 | 72 | #else |
44a7d7a8 NP |
73 | # ifdef CONFIG_SMP |
74 | # define DNAME_INLINE_LEN 36 /* 128 bytes */ | |
75 | # else | |
76 | # define DNAME_INLINE_LEN 40 /* 128 bytes */ | |
77 | # endif | |
c2452f32 | 78 | #endif |
1da177e4 | 79 | |
98474236 WL |
80 | #define d_lock d_lockref.lock |
81 | ||
1da177e4 | 82 | struct dentry { |
44a7d7a8 | 83 | /* RCU lookup touched fields */ |
1da177e4 | 84 | unsigned int d_flags; /* protected by d_lock */ |
26475371 | 85 | seqcount_spinlock_t d_seq; /* per dentry seqlock */ |
ceb5bdc2 | 86 | struct hlist_bl_node d_hash; /* lookup hash list */ |
1da177e4 LT |
87 | struct dentry *d_parent; /* parent directory */ |
88 | struct qstr d_name; | |
44a7d7a8 NP |
89 | struct inode *d_inode; /* Where the name belongs to - NULL is |
90 | * negative */ | |
91 | unsigned char d_iname[DNAME_INLINE_LEN]; /* small names */ | |
92 | ||
93 | /* Ref lookup also touches following */ | |
98474236 | 94 | struct lockref d_lockref; /* per-dentry lock and refcount */ |
44a7d7a8 NP |
95 | const struct dentry_operations *d_op; |
96 | struct super_block *d_sb; /* The root of the dentry tree */ | |
97 | unsigned long d_time; /* used by d_revalidate */ | |
98 | void *d_fsdata; /* fs-specific data */ | |
1da177e4 | 99 | |
d9171b93 AV |
100 | union { |
101 | struct list_head d_lru; /* LRU list */ | |
102 | wait_queue_head_t *d_wait; /* in-lookup ones only */ | |
103 | }; | |
946e51f2 AV |
104 | struct list_head d_child; /* child of parent list */ |
105 | struct list_head d_subdirs; /* our children */ | |
5160ee6f | 106 | /* |
946e51f2 | 107 | * d_alias and d_rcu can share memory |
5160ee6f ED |
108 | */ |
109 | union { | |
946e51f2 | 110 | struct hlist_node d_alias; /* inode alias list */ |
94bdd655 | 111 | struct hlist_bl_node d_in_lookup_hash; /* only for in-lookup ones */ |
5160ee6f ED |
112 | struct rcu_head d_rcu; |
113 | } d_u; | |
3859a271 | 114 | } __randomize_layout; |
1da177e4 | 115 | |
a90b9c05 IM |
116 | /* |
117 | * dentry->d_lock spinlock nesting subclasses: | |
118 | * | |
119 | * 0: normal | |
120 | * 1: nested | |
121 | */ | |
122 | enum dentry_d_lock_class | |
123 | { | |
124 | DENTRY_D_LOCK_NORMAL, /* implicitly used by plain spin_lock() APIs. */ | |
125 | DENTRY_D_LOCK_NESTED | |
126 | }; | |
127 | ||
1da177e4 | 128 | struct dentry_operations { |
0b728e19 | 129 | int (*d_revalidate)(struct dentry *, unsigned int); |
ecf3d1f1 | 130 | int (*d_weak_revalidate)(struct dentry *, unsigned int); |
da53be12 | 131 | int (*d_hash)(const struct dentry *, struct qstr *); |
6fa67e70 | 132 | int (*d_compare)(const struct dentry *, |
621e155a | 133 | unsigned int, const char *, const struct qstr *); |
fe15ce44 | 134 | int (*d_delete)(const struct dentry *); |
285b102d | 135 | int (*d_init)(struct dentry *); |
1da177e4 | 136 | void (*d_release)(struct dentry *); |
f0023bc6 | 137 | void (*d_prune)(struct dentry *); |
1da177e4 | 138 | void (*d_iput)(struct dentry *, struct inode *); |
c23fbb6b | 139 | char *(*d_dname)(struct dentry *, char *, int); |
9875cf80 | 140 | struct vfsmount *(*d_automount)(struct path *); |
fb5f51c7 | 141 | int (*d_manage)(const struct path *, bool); |
fb16043b | 142 | struct dentry *(*d_real)(struct dentry *, const struct inode *); |
44a7d7a8 | 143 | } ____cacheline_aligned; |
1da177e4 | 144 | |
5eef7fa9 NP |
145 | /* |
146 | * Locking rules for dentry_operations callbacks are to be found in | |
ec23eb54 | 147 | * Documentation/filesystems/locking.rst. Keep it updated! |
5eef7fa9 | 148 | * |
5c437fa2 | 149 | * FUrther descriptions are found in Documentation/filesystems/vfs.rst. |
621e155a | 150 | * Keep it updated too! |
1da177e4 LT |
151 | */ |
152 | ||
153 | /* d_flags entries */ | |
b18825a7 DH |
154 | #define DCACHE_OP_HASH 0x00000001 |
155 | #define DCACHE_OP_COMPARE 0x00000002 | |
156 | #define DCACHE_OP_REVALIDATE 0x00000004 | |
157 | #define DCACHE_OP_DELETE 0x00000008 | |
158 | #define DCACHE_OP_PRUNE 0x00000010 | |
5f57cbcc | 159 | |
b18825a7 | 160 | #define DCACHE_DISCONNECTED 0x00000020 |
5f57cbcc NP |
161 | /* This dentry is possibly not currently connected to the dcache tree, in |
162 | * which case its parent will either be itself, or will have this flag as | |
163 | * well. nfsd will not use a dentry with this bit set, but will first | |
164 | * endeavour to clear the bit either by discovering that it is connected, | |
165 | * or by performing lookup operations. Any filesystem which supports | |
166 | * nfsd_operations MUST have a lookup function which, if it finds a | |
167 | * directory inode with a DCACHE_DISCONNECTED dentry, will d_move that | |
168 | * dentry into place and return that dentry rather than the passed one, | |
169 | * typically using d_splice_alias. */ | |
1da177e4 | 170 | |
b18825a7 | 171 | #define DCACHE_REFERENCED 0x00000040 /* Recently used, don't discard. */ |
c28f7e56 | 172 | |
2c567af4 IW |
173 | #define DCACHE_DONTCACHE 0x00000080 /* Purge from memory on final dput() */ |
174 | ||
b18825a7 DH |
175 | #define DCACHE_CANT_MOUNT 0x00000100 |
176 | #define DCACHE_GENOCIDE 0x00000200 | |
177 | #define DCACHE_SHRINK_LIST 0x00000400 | |
5f57cbcc | 178 | |
b18825a7 | 179 | #define DCACHE_OP_WEAK_REVALIDATE 0x00000800 |
ecf3d1f1 | 180 | |
b18825a7 | 181 | #define DCACHE_NFSFS_RENAMED 0x00001000 |
830c0f0e LT |
182 | /* this dentry has been "silly renamed" and has to be deleted on the last |
183 | * dput() */ | |
b18825a7 DH |
184 | #define DCACHE_COOKIE 0x00002000 /* For use by dcookie subsystem */ |
185 | #define DCACHE_FSNOTIFY_PARENT_WATCHED 0x00004000 | |
830c0f0e | 186 | /* Parent inode is watched by some fsnotify listener */ |
fb045adb | 187 | |
b18825a7 DH |
188 | #define DCACHE_DENTRY_KILLED 0x00008000 |
189 | ||
190 | #define DCACHE_MOUNTED 0x00010000 /* is a mountpoint */ | |
191 | #define DCACHE_NEED_AUTOMOUNT 0x00020000 /* handle automount on this dir */ | |
192 | #define DCACHE_MANAGE_TRANSIT 0x00040000 /* manage transit from this dirent */ | |
9875cf80 | 193 | #define DCACHE_MANAGED_DENTRY \ |
cc53ce53 | 194 | (DCACHE_MOUNTED|DCACHE_NEED_AUTOMOUNT|DCACHE_MANAGE_TRANSIT) |
9875cf80 | 195 | |
b18825a7 DH |
196 | #define DCACHE_LRU_LIST 0x00080000 |
197 | ||
198 | #define DCACHE_ENTRY_TYPE 0x00700000 | |
e7f7d225 DH |
199 | #define DCACHE_MISS_TYPE 0x00000000 /* Negative dentry (maybe fallthru to nowhere) */ |
200 | #define DCACHE_WHITEOUT_TYPE 0x00100000 /* Whiteout dentry (stop pathwalk) */ | |
201 | #define DCACHE_DIRECTORY_TYPE 0x00200000 /* Normal directory */ | |
202 | #define DCACHE_AUTODIR_TYPE 0x00300000 /* Lookupless directory (presumed automount) */ | |
44bdb5e5 DH |
203 | #define DCACHE_REGULAR_TYPE 0x00400000 /* Regular file type (or fallthru to such) */ |
204 | #define DCACHE_SPECIAL_TYPE 0x00500000 /* Other file type (or fallthru to such) */ | |
205 | #define DCACHE_SYMLINK_TYPE 0x00600000 /* Symlink (or fallthru to such) */ | |
b161dfa6 | 206 | |
41edf278 | 207 | #define DCACHE_MAY_FREE 0x00800000 |
df1a085a | 208 | #define DCACHE_FALLTHRU 0x01000000 /* Fall through to lower layer */ |
501e43fb | 209 | #define DCACHE_NOKEY_NAME 0x02000000 /* Encrypted name encoded without key */ |
2d902671 | 210 | #define DCACHE_OP_REAL 0x04000000 |
0b81d077 | 211 | |
85c7f810 | 212 | #define DCACHE_PAR_LOOKUP 0x10000000 /* being looked up (with parent locked shared) */ |
ba65dc5e | 213 | #define DCACHE_DENTRY_CURSOR 0x20000000 |
5467a68c | 214 | #define DCACHE_NORCU 0x40000000 /* No RCU delay for freeing */ |
85c7f810 | 215 | |
74c3cbe3 | 216 | extern seqlock_t rename_lock; |
1da177e4 | 217 | |
1da177e4 LT |
218 | /* |
219 | * These are the low-level FS interfaces to the dcache.. | |
220 | */ | |
221 | extern void d_instantiate(struct dentry *, struct inode *); | |
1e2e547a | 222 | extern void d_instantiate_new(struct dentry *, struct inode *); |
1da177e4 | 223 | extern struct dentry * d_instantiate_unique(struct dentry *, struct inode *); |
f9c34674 | 224 | extern struct dentry * d_instantiate_anon(struct dentry *, struct inode *); |
789680d1 NP |
225 | extern void __d_drop(struct dentry *dentry); |
226 | extern void d_drop(struct dentry *dentry); | |
1da177e4 | 227 | extern void d_delete(struct dentry *); |
fb045adb | 228 | extern void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op); |
1da177e4 LT |
229 | |
230 | /* allocate/de-allocate */ | |
231 | extern struct dentry * d_alloc(struct dentry *, const struct qstr *); | |
f9c34674 | 232 | extern struct dentry * d_alloc_anon(struct super_block *); |
d9171b93 AV |
233 | extern struct dentry * d_alloc_parallel(struct dentry *, const struct qstr *, |
234 | wait_queue_head_t *); | |
1da177e4 | 235 | extern struct dentry * d_splice_alias(struct inode *, struct dentry *); |
e45b590b | 236 | extern struct dentry * d_add_ci(struct dentry *, struct inode *, struct qstr *); |
4f48d5da XL |
237 | extern bool d_same_name(const struct dentry *dentry, const struct dentry *parent, |
238 | const struct qstr *name); | |
668d0cd5 | 239 | extern struct dentry * d_exact_alias(struct dentry *, struct inode *); |
46f72b34 | 240 | extern struct dentry *d_find_any_alias(struct inode *inode); |
4ea3ada2 | 241 | extern struct dentry * d_obtain_alias(struct inode *); |
1a0a397e | 242 | extern struct dentry * d_obtain_root(struct inode *); |
1da177e4 LT |
243 | extern void shrink_dcache_sb(struct super_block *); |
244 | extern void shrink_dcache_parent(struct dentry *); | |
c636ebdb | 245 | extern void shrink_dcache_for_umount(struct super_block *); |
5542aa2f | 246 | extern void d_invalidate(struct dentry *); |
1da177e4 LT |
247 | |
248 | /* only used at mount-time */ | |
adc0e91a | 249 | extern struct dentry * d_make_root(struct inode *); |
1da177e4 LT |
250 | |
251 | /* <clickety>-<click> the ramfs-type tree */ | |
252 | extern void d_genocide(struct dentry *); | |
253 | ||
771eb4fe | 254 | extern void d_mark_tmpfile(struct file *, struct inode *); |
863f144f | 255 | extern void d_tmpfile(struct file *, struct inode *); |
60545d0d | 256 | |
1da177e4 LT |
257 | extern struct dentry *d_find_alias(struct inode *); |
258 | extern void d_prune_aliases(struct inode *); | |
259 | ||
bca585d2 AV |
260 | extern struct dentry *d_find_alias_rcu(struct inode *); |
261 | ||
1da177e4 | 262 | /* test whether we have any submounts in a subdir tree */ |
01619491 | 263 | extern int path_has_submounts(const struct path *); |
1da177e4 LT |
264 | |
265 | /* | |
266 | * This adds the entry to the hash queues. | |
267 | */ | |
268 | extern void d_rehash(struct dentry *); | |
1da177e4 | 269 | |
34d0d19d | 270 | extern void d_add(struct dentry *, struct inode *); |
1da177e4 | 271 | |
1da177e4 LT |
272 | /* used for rename() and baskets */ |
273 | extern void d_move(struct dentry *, struct dentry *); | |
da1ce067 | 274 | extern void d_exchange(struct dentry *, struct dentry *); |
e2761a11 | 275 | extern struct dentry *d_ancestor(struct dentry *, struct dentry *); |
1da177e4 LT |
276 | |
277 | /* appendix may either be NULL or be used for transname suffixes */ | |
da2d8455 | 278 | extern struct dentry *d_lookup(const struct dentry *, const struct qstr *); |
31e6b01f | 279 | extern struct dentry *d_hash_and_lookup(struct dentry *, struct qstr *); |
a713ca2a | 280 | extern struct dentry *__d_lookup(const struct dentry *, const struct qstr *); |
8966be90 | 281 | extern struct dentry *__d_lookup_rcu(const struct dentry *parent, |
da53be12 | 282 | const struct qstr *name, unsigned *seq); |
31e6b01f | 283 | |
24924a20 | 284 | static inline unsigned d_count(const struct dentry *dentry) |
84d08fa8 | 285 | { |
98474236 | 286 | return dentry->d_lockref.count; |
84d08fa8 AV |
287 | } |
288 | ||
c23fbb6b ED |
289 | /* |
290 | * helper function for dentry_operations.d_dname() members | |
291 | */ | |
0f60d288 AV |
292 | extern __printf(3, 4) |
293 | char *dynamic_dname(char *, int, const char *, ...); | |
c23fbb6b | 294 | |
02125a82 AV |
295 | extern char *__d_path(const struct path *, const struct path *, char *, int); |
296 | extern char *d_absolute_path(const struct path *, char *, int); | |
20d4fdc1 | 297 | extern char *d_path(const struct path *, char *, int); |
a2bbe664 AV |
298 | extern char *dentry_path_raw(const struct dentry *, char *, int); |
299 | extern char *dentry_path(const struct dentry *, char *, int); | |
cf28b486 | 300 | |
1da177e4 LT |
301 | /* Allocation counts.. */ |
302 | ||
303 | /** | |
dc0474be | 304 | * dget, dget_dlock - get a reference to a dentry |
1da177e4 LT |
305 | * @dentry: dentry to get a reference to |
306 | * | |
307 | * Given a dentry or %NULL pointer increment the reference count | |
308 | * if appropriate and return the dentry. A dentry will not be | |
dc0474be | 309 | * destroyed when it has references. |
1da177e4 | 310 | */ |
b7ab39f6 NP |
311 | static inline struct dentry *dget_dlock(struct dentry *dentry) |
312 | { | |
dc0474be | 313 | if (dentry) |
98474236 | 314 | dentry->d_lockref.count++; |
b7ab39f6 NP |
315 | return dentry; |
316 | } | |
2fd6b7f5 | 317 | |
1da177e4 LT |
318 | static inline struct dentry *dget(struct dentry *dentry) |
319 | { | |
98474236 WL |
320 | if (dentry) |
321 | lockref_get(&dentry->d_lockref); | |
1da177e4 LT |
322 | return dentry; |
323 | } | |
324 | ||
b7ab39f6 | 325 | extern struct dentry *dget_parent(struct dentry *dentry); |
1da177e4 LT |
326 | |
327 | /** | |
328 | * d_unhashed - is dentry hashed | |
329 | * @dentry: entry to check | |
330 | * | |
331 | * Returns true if the dentry passed is not currently hashed. | |
332 | */ | |
333 | ||
f0d3b3de | 334 | static inline int d_unhashed(const struct dentry *dentry) |
1da177e4 | 335 | { |
dea3667b | 336 | return hlist_bl_unhashed(&dentry->d_hash); |
1da177e4 LT |
337 | } |
338 | ||
f0d3b3de | 339 | static inline int d_unlinked(const struct dentry *dentry) |
f3da392e AD |
340 | { |
341 | return d_unhashed(dentry) && !IS_ROOT(dentry); | |
342 | } | |
343 | ||
f0d3b3de | 344 | static inline int cant_mount(const struct dentry *dentry) |
d83c49f3 AV |
345 | { |
346 | return (dentry->d_flags & DCACHE_CANT_MOUNT); | |
347 | } | |
348 | ||
349 | static inline void dont_mount(struct dentry *dentry) | |
350 | { | |
351 | spin_lock(&dentry->d_lock); | |
352 | dentry->d_flags |= DCACHE_CANT_MOUNT; | |
353 | spin_unlock(&dentry->d_lock); | |
354 | } | |
355 | ||
45f78b0a | 356 | extern void __d_lookup_unhash_wake(struct dentry *dentry); |
85c7f810 | 357 | |
4ded097b | 358 | static inline int d_in_lookup(const struct dentry *dentry) |
85c7f810 AV |
359 | { |
360 | return dentry->d_flags & DCACHE_PAR_LOOKUP; | |
361 | } | |
362 | ||
363 | static inline void d_lookup_done(struct dentry *dentry) | |
364 | { | |
45f78b0a SAS |
365 | if (unlikely(d_in_lookup(dentry))) |
366 | __d_lookup_unhash_wake(dentry); | |
85c7f810 AV |
367 | } |
368 | ||
1da177e4 LT |
369 | extern void dput(struct dentry *); |
370 | ||
f0d3b3de | 371 | static inline bool d_managed(const struct dentry *dentry) |
cc53ce53 DH |
372 | { |
373 | return dentry->d_flags & DCACHE_MANAGED_DENTRY; | |
374 | } | |
375 | ||
f0d3b3de | 376 | static inline bool d_mountpoint(const struct dentry *dentry) |
1da177e4 | 377 | { |
5f57cbcc | 378 | return dentry->d_flags & DCACHE_MOUNTED; |
1da177e4 LT |
379 | } |
380 | ||
b18825a7 DH |
381 | /* |
382 | * Directory cache entry type accessor functions. | |
383 | */ | |
b18825a7 DH |
384 | static inline unsigned __d_entry_type(const struct dentry *dentry) |
385 | { | |
a528aca7 | 386 | return dentry->d_flags & DCACHE_ENTRY_TYPE; |
b18825a7 DH |
387 | } |
388 | ||
e7f7d225 DH |
389 | static inline bool d_is_miss(const struct dentry *dentry) |
390 | { | |
391 | return __d_entry_type(dentry) == DCACHE_MISS_TYPE; | |
392 | } | |
393 | ||
394 | static inline bool d_is_whiteout(const struct dentry *dentry) | |
395 | { | |
396 | return __d_entry_type(dentry) == DCACHE_WHITEOUT_TYPE; | |
397 | } | |
398 | ||
44b1d530 | 399 | static inline bool d_can_lookup(const struct dentry *dentry) |
b18825a7 DH |
400 | { |
401 | return __d_entry_type(dentry) == DCACHE_DIRECTORY_TYPE; | |
402 | } | |
403 | ||
404 | static inline bool d_is_autodir(const struct dentry *dentry) | |
405 | { | |
406 | return __d_entry_type(dentry) == DCACHE_AUTODIR_TYPE; | |
407 | } | |
408 | ||
44b1d530 MS |
409 | static inline bool d_is_dir(const struct dentry *dentry) |
410 | { | |
411 | return d_can_lookup(dentry) || d_is_autodir(dentry); | |
412 | } | |
413 | ||
b18825a7 DH |
414 | static inline bool d_is_symlink(const struct dentry *dentry) |
415 | { | |
416 | return __d_entry_type(dentry) == DCACHE_SYMLINK_TYPE; | |
417 | } | |
418 | ||
44bdb5e5 DH |
419 | static inline bool d_is_reg(const struct dentry *dentry) |
420 | { | |
421 | return __d_entry_type(dentry) == DCACHE_REGULAR_TYPE; | |
422 | } | |
423 | ||
424 | static inline bool d_is_special(const struct dentry *dentry) | |
425 | { | |
426 | return __d_entry_type(dentry) == DCACHE_SPECIAL_TYPE; | |
427 | } | |
428 | ||
b18825a7 DH |
429 | static inline bool d_is_file(const struct dentry *dentry) |
430 | { | |
44bdb5e5 | 431 | return d_is_reg(dentry) || d_is_special(dentry); |
b18825a7 DH |
432 | } |
433 | ||
434 | static inline bool d_is_negative(const struct dentry *dentry) | |
435 | { | |
e7f7d225 DH |
436 | // TODO: check d_is_whiteout(dentry) also. |
437 | return d_is_miss(dentry); | |
b18825a7 DH |
438 | } |
439 | ||
d41efb52 AV |
440 | static inline bool d_flags_negative(unsigned flags) |
441 | { | |
442 | return (flags & DCACHE_ENTRY_TYPE) == DCACHE_MISS_TYPE; | |
443 | } | |
444 | ||
b18825a7 DH |
445 | static inline bool d_is_positive(const struct dentry *dentry) |
446 | { | |
447 | return !d_is_negative(dentry); | |
448 | } | |
449 | ||
525d27b2 DH |
450 | /** |
451 | * d_really_is_negative - Determine if a dentry is really negative (ignoring fallthroughs) | |
452 | * @dentry: The dentry in question | |
453 | * | |
454 | * Returns true if the dentry represents either an absent name or a name that | |
455 | * doesn't map to an inode (ie. ->d_inode is NULL). The dentry could represent | |
456 | * a true miss, a whiteout that isn't represented by a 0,0 chardev or a | |
457 | * fallthrough marker in an opaque directory. | |
458 | * | |
459 | * Note! (1) This should be used *only* by a filesystem to examine its own | |
460 | * dentries. It should not be used to look at some other filesystem's | |
461 | * dentries. (2) It should also be used in combination with d_inode() to get | |
462 | * the inode. (3) The dentry may have something attached to ->d_lower and the | |
463 | * type field of the flags may be set to something other than miss or whiteout. | |
464 | */ | |
465 | static inline bool d_really_is_negative(const struct dentry *dentry) | |
466 | { | |
467 | return dentry->d_inode == NULL; | |
468 | } | |
469 | ||
470 | /** | |
471 | * d_really_is_positive - Determine if a dentry is really positive (ignoring fallthroughs) | |
472 | * @dentry: The dentry in question | |
473 | * | |
474 | * Returns true if the dentry represents a name that maps to an inode | |
475 | * (ie. ->d_inode is not NULL). The dentry might still represent a whiteout if | |
476 | * that is represented on medium as a 0,0 chardev. | |
477 | * | |
478 | * Note! (1) This should be used *only* by a filesystem to examine its own | |
479 | * dentries. It should not be used to look at some other filesystem's | |
480 | * dentries. (2) It should also be used in combination with d_inode() to get | |
481 | * the inode. | |
482 | */ | |
483 | static inline bool d_really_is_positive(const struct dentry *dentry) | |
484 | { | |
485 | return dentry->d_inode != NULL; | |
486 | } | |
487 | ||
4ded097b | 488 | static inline int simple_positive(const struct dentry *dentry) |
dc3f4198 AV |
489 | { |
490 | return d_really_is_positive(dentry) && !d_unhashed(dentry); | |
491 | } | |
492 | ||
df1a085a DH |
493 | extern void d_set_fallthru(struct dentry *dentry); |
494 | ||
495 | static inline bool d_is_fallthru(const struct dentry *dentry) | |
496 | { | |
497 | return dentry->d_flags & DCACHE_FALLTHRU; | |
498 | } | |
499 | ||
500 | ||
1da177e4 LT |
501 | extern int sysctl_vfs_cache_pressure; |
502 | ||
55f841ce GC |
503 | static inline unsigned long vfs_pressure_ratio(unsigned long val) |
504 | { | |
505 | return mult_frac(val, sysctl_vfs_cache_pressure, 100); | |
506 | } | |
155e35d4 DH |
507 | |
508 | /** | |
509 | * d_inode - Get the actual inode of this dentry | |
510 | * @dentry: The dentry to query | |
511 | * | |
512 | * This is the helper normal filesystems should use to get at their own inodes | |
513 | * in their own dentries and ignore the layering superimposed upon them. | |
514 | */ | |
515 | static inline struct inode *d_inode(const struct dentry *dentry) | |
516 | { | |
517 | return dentry->d_inode; | |
518 | } | |
519 | ||
520 | /** | |
66702eb5 | 521 | * d_inode_rcu - Get the actual inode of this dentry with READ_ONCE() |
155e35d4 DH |
522 | * @dentry: The dentry to query |
523 | * | |
524 | * This is the helper normal filesystems should use to get at their own inodes | |
525 | * in their own dentries and ignore the layering superimposed upon them. | |
526 | */ | |
527 | static inline struct inode *d_inode_rcu(const struct dentry *dentry) | |
528 | { | |
66702eb5 | 529 | return READ_ONCE(dentry->d_inode); |
155e35d4 DH |
530 | } |
531 | ||
532 | /** | |
533 | * d_backing_inode - Get upper or lower inode we should be using | |
534 | * @upper: The upper layer | |
535 | * | |
536 | * This is the helper that should be used to get at the inode that will be used | |
537 | * if this dentry were to be opened as a file. The inode may be on the upper | |
538 | * dentry or it may be on a lower dentry pinned by the upper. | |
539 | * | |
540 | * Normal filesystems should not use this to access their own inodes. | |
541 | */ | |
542 | static inline struct inode *d_backing_inode(const struct dentry *upper) | |
543 | { | |
544 | struct inode *inode = upper->d_inode; | |
545 | ||
546 | return inode; | |
547 | } | |
548 | ||
549 | /** | |
550 | * d_backing_dentry - Get upper or lower dentry we should be using | |
551 | * @upper: The upper layer | |
552 | * | |
553 | * This is the helper that should be used to get the dentry of the inode that | |
554 | * will be used if this dentry were opened as a file. It may be the upper | |
555 | * dentry or it may be a lower dentry pinned by the upper. | |
556 | * | |
557 | * Normal filesystems should not use this to access their own dentries. | |
558 | */ | |
559 | static inline struct dentry *d_backing_dentry(struct dentry *upper) | |
560 | { | |
561 | return upper; | |
562 | } | |
563 | ||
e698b8a4 MS |
564 | /** |
565 | * d_real - Return the real dentry | |
566 | * @dentry: the dentry to query | |
567 | * @inode: inode to select the dentry from multiple layers (can be NULL) | |
e698b8a4 | 568 | * |
03440c4e | 569 | * If dentry is on a union/overlay, then return the underlying, real dentry. |
e698b8a4 MS |
570 | * Otherwise return the dentry itself. |
571 | * | |
5c437fa2 | 572 | * See also: Documentation/filesystems/vfs.rst |
e698b8a4 | 573 | */ |
2d902671 | 574 | static inline struct dentry *d_real(struct dentry *dentry, |
fb16043b | 575 | const struct inode *inode) |
d101a125 MS |
576 | { |
577 | if (unlikely(dentry->d_flags & DCACHE_OP_REAL)) | |
fb16043b | 578 | return dentry->d_op->d_real(dentry, inode); |
d101a125 MS |
579 | else |
580 | return dentry; | |
581 | } | |
582 | ||
a1180844 MS |
583 | /** |
584 | * d_real_inode - Return the real inode | |
585 | * @dentry: The dentry to query | |
586 | * | |
03440c4e | 587 | * If dentry is on a union/overlay, then return the underlying, real inode. |
a1180844 MS |
588 | * Otherwise return d_inode(). |
589 | */ | |
7b1742eb | 590 | static inline struct inode *d_real_inode(const struct dentry *dentry) |
a1180844 | 591 | { |
7b1742eb | 592 | /* This usage of d_real() results in const dentry */ |
fb16043b | 593 | return d_backing_inode(d_real((struct dentry *) dentry, NULL)); |
a1180844 MS |
594 | } |
595 | ||
49d31c2f | 596 | struct name_snapshot { |
230c6402 | 597 | struct qstr name; |
0a2c13d9 | 598 | unsigned char inline_name[DNAME_INLINE_LEN]; |
49d31c2f AV |
599 | }; |
600 | void take_dentry_name_snapshot(struct name_snapshot *, struct dentry *); | |
601 | void release_dentry_name_snapshot(struct name_snapshot *); | |
54d5ca87 | 602 | |
1da177e4 | 603 | #endif /* __LINUX_DCACHE_H */ |