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