]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - fs/dcache.c
untangle fsnotify_d_instantiate() a bit
[mirror_ubuntu-artful-kernel.git] / fs / dcache.c
CommitLineData
1da177e4
LT
1/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
1da177e4
LT
17#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
7a91bf7f 21#include <linux/fsnotify.h>
1da177e4
LT
22#include <linux/slab.h>
23#include <linux/init.h>
1da177e4
LT
24#include <linux/hash.h>
25#include <linux/cache.h>
630d9c47 26#include <linux/export.h>
1da177e4
LT
27#include <linux/mount.h>
28#include <linux/file.h>
29#include <asm/uaccess.h>
30#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
5ad4e53b 34#include <linux/fs_struct.h>
613afbf8 35#include <linux/hardirq.h>
ceb5bdc2
NP
36#include <linux/bit_spinlock.h>
37#include <linux/rculist_bl.h>
268bb0ce 38#include <linux/prefetch.h>
dd179946 39#include <linux/ratelimit.h>
f6041567 40#include <linux/list_lru.h>
df4c0e36
AR
41#include <linux/kasan.h>
42
07f3f05c 43#include "internal.h"
b2dba1af 44#include "mount.h"
1da177e4 45
789680d1
NP
46/*
47 * Usage:
873feea0 48 * dcache->d_inode->i_lock protects:
946e51f2 49 * - i_dentry, d_u.d_alias, d_inode of aliases
ceb5bdc2
NP
50 * dcache_hash_bucket lock protects:
51 * - the dcache hash table
52 * s_anon bl list spinlock protects:
53 * - the s_anon list (see __d_drop)
19156840 54 * dentry->d_sb->s_dentry_lru_lock protects:
23044507
NP
55 * - the dcache lru lists and counters
56 * d_lock protects:
57 * - d_flags
58 * - d_name
59 * - d_lru
b7ab39f6 60 * - d_count
da502956 61 * - d_unhashed()
2fd6b7f5
NP
62 * - d_parent and d_subdirs
63 * - childrens' d_child and d_parent
946e51f2 64 * - d_u.d_alias, d_inode
789680d1
NP
65 *
66 * Ordering:
873feea0 67 * dentry->d_inode->i_lock
b5c84bf6 68 * dentry->d_lock
19156840 69 * dentry->d_sb->s_dentry_lru_lock
ceb5bdc2
NP
70 * dcache_hash_bucket lock
71 * s_anon lock
789680d1 72 *
da502956
NP
73 * If there is an ancestor relationship:
74 * dentry->d_parent->...->d_parent->d_lock
75 * ...
76 * dentry->d_parent->d_lock
77 * dentry->d_lock
78 *
79 * If no ancestor relationship:
789680d1
NP
80 * if (dentry1 < dentry2)
81 * dentry1->d_lock
82 * dentry2->d_lock
83 */
fa3536cc 84int sysctl_vfs_cache_pressure __read_mostly = 100;
1da177e4
LT
85EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
86
74c3cbe3 87__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
1da177e4 88
949854d0 89EXPORT_SYMBOL(rename_lock);
1da177e4 90
e18b890b 91static struct kmem_cache *dentry_cache __read_mostly;
1da177e4 92
1da177e4
LT
93/*
94 * This is the single most critical data structure when it comes
95 * to the dcache: the hashtable for lookups. Somebody should try
96 * to make this good - I've just made it work.
97 *
98 * This hash-function tries to avoid losing too many bits of hash
99 * information, yet avoid using a prime hash-size or similar.
100 */
1da177e4 101
fa3536cc
ED
102static unsigned int d_hash_mask __read_mostly;
103static unsigned int d_hash_shift __read_mostly;
ceb5bdc2 104
b07ad996 105static struct hlist_bl_head *dentry_hashtable __read_mostly;
ceb5bdc2 106
8966be90 107static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
6d7d1a0d 108 unsigned int hash)
ceb5bdc2 109{
6d7d1a0d 110 hash += (unsigned long) parent / L1_CACHE_BYTES;
99d263d4 111 return dentry_hashtable + hash_32(hash, d_hash_shift);
ceb5bdc2
NP
112}
113
1da177e4
LT
114/* Statistics gathering. */
115struct dentry_stat_t dentry_stat = {
116 .age_limit = 45,
117};
118
3942c07c 119static DEFINE_PER_CPU(long, nr_dentry);
62d36c77 120static DEFINE_PER_CPU(long, nr_dentry_unused);
312d3ca8
CH
121
122#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
62d36c77
DC
123
124/*
125 * Here we resort to our own counters instead of using generic per-cpu counters
126 * for consistency with what the vfs inode code does. We are expected to harvest
127 * better code and performance by having our own specialized counters.
128 *
129 * Please note that the loop is done over all possible CPUs, not over all online
130 * CPUs. The reason for this is that we don't want to play games with CPUs going
131 * on and off. If one of them goes off, we will just keep their counters.
132 *
133 * glommer: See cffbc8a for details, and if you ever intend to change this,
134 * please update all vfs counters to match.
135 */
3942c07c 136static long get_nr_dentry(void)
3e880fb5
NP
137{
138 int i;
3942c07c 139 long sum = 0;
3e880fb5
NP
140 for_each_possible_cpu(i)
141 sum += per_cpu(nr_dentry, i);
142 return sum < 0 ? 0 : sum;
143}
144
62d36c77
DC
145static long get_nr_dentry_unused(void)
146{
147 int i;
148 long sum = 0;
149 for_each_possible_cpu(i)
150 sum += per_cpu(nr_dentry_unused, i);
151 return sum < 0 ? 0 : sum;
152}
153
1f7e0616 154int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
312d3ca8
CH
155 size_t *lenp, loff_t *ppos)
156{
3e880fb5 157 dentry_stat.nr_dentry = get_nr_dentry();
62d36c77 158 dentry_stat.nr_unused = get_nr_dentry_unused();
3942c07c 159 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
312d3ca8
CH
160}
161#endif
162
5483f18e
LT
163/*
164 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
165 * The strings are both count bytes long, and count is non-zero.
166 */
e419b4cc
LT
167#ifdef CONFIG_DCACHE_WORD_ACCESS
168
169#include <asm/word-at-a-time.h>
170/*
171 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
172 * aligned allocation for this particular component. We don't
173 * strictly need the load_unaligned_zeropad() safety, but it
174 * doesn't hurt either.
175 *
176 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
177 * need the careful unaligned handling.
178 */
94753db5 179static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
5483f18e 180{
bfcfaa77 181 unsigned long a,b,mask;
bfcfaa77
LT
182
183 for (;;) {
12f8ad4b 184 a = *(unsigned long *)cs;
e419b4cc 185 b = load_unaligned_zeropad(ct);
bfcfaa77
LT
186 if (tcount < sizeof(unsigned long))
187 break;
188 if (unlikely(a != b))
189 return 1;
190 cs += sizeof(unsigned long);
191 ct += sizeof(unsigned long);
192 tcount -= sizeof(unsigned long);
193 if (!tcount)
194 return 0;
195 }
a5c21dce 196 mask = bytemask_from_count(tcount);
bfcfaa77 197 return unlikely(!!((a ^ b) & mask));
e419b4cc
LT
198}
199
bfcfaa77 200#else
e419b4cc 201
94753db5 202static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
e419b4cc 203{
5483f18e
LT
204 do {
205 if (*cs != *ct)
206 return 1;
207 cs++;
208 ct++;
209 tcount--;
210 } while (tcount);
211 return 0;
212}
213
e419b4cc
LT
214#endif
215
94753db5
LT
216static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
217{
6326c71f 218 const unsigned char *cs;
94753db5
LT
219 /*
220 * Be careful about RCU walk racing with rename:
221 * use ACCESS_ONCE to fetch the name pointer.
222 *
223 * NOTE! Even if a rename will mean that the length
224 * was not loaded atomically, we don't care. The
225 * RCU walk will check the sequence count eventually,
226 * and catch it. And we won't overrun the buffer,
227 * because we're reading the name pointer atomically,
228 * and a dentry name is guaranteed to be properly
229 * terminated with a NUL byte.
230 *
231 * End result: even if 'len' is wrong, we'll exit
232 * early because the data cannot match (there can
233 * be no NUL in the ct/tcount data)
234 */
6326c71f
LT
235 cs = ACCESS_ONCE(dentry->d_name.name);
236 smp_read_barrier_depends();
237 return dentry_string_cmp(cs, ct, tcount);
94753db5
LT
238}
239
8d85b484
AV
240struct external_name {
241 union {
242 atomic_t count;
243 struct rcu_head head;
244 } u;
245 unsigned char name[];
246};
247
248static inline struct external_name *external_name(struct dentry *dentry)
249{
250 return container_of(dentry->d_name.name, struct external_name, name[0]);
251}
252
9c82ab9c 253static void __d_free(struct rcu_head *head)
1da177e4 254{
9c82ab9c
CH
255 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
256
8d85b484
AV
257 kmem_cache_free(dentry_cache, dentry);
258}
259
260static void __d_free_external(struct rcu_head *head)
261{
262 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
8d85b484 263 kfree(external_name(dentry));
1da177e4
LT
264 kmem_cache_free(dentry_cache, dentry);
265}
266
810bb172
AV
267static inline int dname_external(const struct dentry *dentry)
268{
269 return dentry->d_name.name != dentry->d_iname;
270}
271
4bf46a27
DH
272static inline void __d_set_inode_and_type(struct dentry *dentry,
273 struct inode *inode,
274 unsigned type_flags)
275{
276 unsigned flags;
277
278 dentry->d_inode = inode;
4bf46a27
DH
279 flags = READ_ONCE(dentry->d_flags);
280 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
281 flags |= type_flags;
282 WRITE_ONCE(dentry->d_flags, flags);
283}
284
4bf46a27
DH
285static inline void __d_clear_type_and_inode(struct dentry *dentry)
286{
287 unsigned flags = READ_ONCE(dentry->d_flags);
288
289 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
290 WRITE_ONCE(dentry->d_flags, flags);
4bf46a27
DH
291 dentry->d_inode = NULL;
292}
293
b4f0354e
AV
294static void dentry_free(struct dentry *dentry)
295{
946e51f2 296 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
8d85b484
AV
297 if (unlikely(dname_external(dentry))) {
298 struct external_name *p = external_name(dentry);
299 if (likely(atomic_dec_and_test(&p->u.count))) {
300 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
301 return;
302 }
303 }
b4f0354e
AV
304 /* if dentry was never visible to RCU, immediate free is OK */
305 if (!(dentry->d_flags & DCACHE_RCUACCESS))
306 __d_free(&dentry->d_u.d_rcu);
307 else
308 call_rcu(&dentry->d_u.d_rcu, __d_free);
309}
310
31e6b01f 311/**
a7c6f571 312 * dentry_rcuwalk_invalidate - invalidate in-progress rcu-walk lookups
ff5fdb61 313 * @dentry: the target dentry
31e6b01f
NP
314 * After this call, in-progress rcu-walk path lookup will fail. This
315 * should be called after unhashing, and after changing d_inode (if
316 * the dentry has not already been unhashed).
317 */
a7c6f571 318static inline void dentry_rcuwalk_invalidate(struct dentry *dentry)
31e6b01f 319{
a7c6f571
PZ
320 lockdep_assert_held(&dentry->d_lock);
321 /* Go through am invalidation barrier */
322 write_seqcount_invalidate(&dentry->d_seq);
31e6b01f
NP
323}
324
1da177e4
LT
325/*
326 * Release the dentry's inode, using the filesystem
31e6b01f
NP
327 * d_iput() operation if defined. Dentry has no refcount
328 * and is unhashed.
1da177e4 329 */
858119e1 330static void dentry_iput(struct dentry * dentry)
31f3e0b3 331 __releases(dentry->d_lock)
873feea0 332 __releases(dentry->d_inode->i_lock)
1da177e4
LT
333{
334 struct inode *inode = dentry->d_inode;
335 if (inode) {
4bf46a27 336 __d_clear_type_and_inode(dentry);
946e51f2 337 hlist_del_init(&dentry->d_u.d_alias);
1da177e4 338 spin_unlock(&dentry->d_lock);
873feea0 339 spin_unlock(&inode->i_lock);
f805fbda
LT
340 if (!inode->i_nlink)
341 fsnotify_inoderemove(inode);
1da177e4
LT
342 if (dentry->d_op && dentry->d_op->d_iput)
343 dentry->d_op->d_iput(dentry, inode);
344 else
345 iput(inode);
346 } else {
347 spin_unlock(&dentry->d_lock);
1da177e4
LT
348 }
349}
350
31e6b01f
NP
351/*
352 * Release the dentry's inode, using the filesystem
353 * d_iput() operation if defined. dentry remains in-use.
354 */
355static void dentry_unlink_inode(struct dentry * dentry)
356 __releases(dentry->d_lock)
873feea0 357 __releases(dentry->d_inode->i_lock)
31e6b01f
NP
358{
359 struct inode *inode = dentry->d_inode;
a528aca7
AV
360
361 raw_write_seqcount_begin(&dentry->d_seq);
4bf46a27 362 __d_clear_type_and_inode(dentry);
946e51f2 363 hlist_del_init(&dentry->d_u.d_alias);
a528aca7 364 raw_write_seqcount_end(&dentry->d_seq);
31e6b01f 365 spin_unlock(&dentry->d_lock);
873feea0 366 spin_unlock(&inode->i_lock);
31e6b01f
NP
367 if (!inode->i_nlink)
368 fsnotify_inoderemove(inode);
369 if (dentry->d_op && dentry->d_op->d_iput)
370 dentry->d_op->d_iput(dentry, inode);
371 else
372 iput(inode);
373}
374
89dc77bc
LT
375/*
376 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
377 * is in use - which includes both the "real" per-superblock
378 * LRU list _and_ the DCACHE_SHRINK_LIST use.
379 *
380 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
381 * on the shrink list (ie not on the superblock LRU list).
382 *
383 * The per-cpu "nr_dentry_unused" counters are updated with
384 * the DCACHE_LRU_LIST bit.
385 *
386 * These helper functions make sure we always follow the
387 * rules. d_lock must be held by the caller.
388 */
389#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
390static void d_lru_add(struct dentry *dentry)
391{
392 D_FLAG_VERIFY(dentry, 0);
393 dentry->d_flags |= DCACHE_LRU_LIST;
394 this_cpu_inc(nr_dentry_unused);
395 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
396}
397
398static void d_lru_del(struct dentry *dentry)
399{
400 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
401 dentry->d_flags &= ~DCACHE_LRU_LIST;
402 this_cpu_dec(nr_dentry_unused);
403 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
404}
405
406static void d_shrink_del(struct dentry *dentry)
407{
408 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
409 list_del_init(&dentry->d_lru);
410 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
411 this_cpu_dec(nr_dentry_unused);
412}
413
414static void d_shrink_add(struct dentry *dentry, struct list_head *list)
415{
416 D_FLAG_VERIFY(dentry, 0);
417 list_add(&dentry->d_lru, list);
418 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
419 this_cpu_inc(nr_dentry_unused);
420}
421
422/*
423 * These can only be called under the global LRU lock, ie during the
424 * callback for freeing the LRU list. "isolate" removes it from the
425 * LRU lists entirely, while shrink_move moves it to the indicated
426 * private list.
427 */
3f97b163 428static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
89dc77bc
LT
429{
430 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
431 dentry->d_flags &= ~DCACHE_LRU_LIST;
432 this_cpu_dec(nr_dentry_unused);
3f97b163 433 list_lru_isolate(lru, &dentry->d_lru);
89dc77bc
LT
434}
435
3f97b163
VD
436static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
437 struct list_head *list)
89dc77bc
LT
438{
439 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
440 dentry->d_flags |= DCACHE_SHRINK_LIST;
3f97b163 441 list_lru_isolate_move(lru, &dentry->d_lru, list);
89dc77bc
LT
442}
443
da3bbdd4 444/*
f6041567 445 * dentry_lru_(add|del)_list) must be called with d_lock held.
da3bbdd4
KM
446 */
447static void dentry_lru_add(struct dentry *dentry)
448{
89dc77bc
LT
449 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
450 d_lru_add(dentry);
da3bbdd4
KM
451}
452
789680d1
NP
453/**
454 * d_drop - drop a dentry
455 * @dentry: dentry to drop
456 *
457 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
458 * be found through a VFS lookup any more. Note that this is different from
459 * deleting the dentry - d_delete will try to mark the dentry negative if
460 * possible, giving a successful _negative_ lookup, while d_drop will
461 * just make the cache lookup fail.
462 *
463 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
464 * reason (NFS timeouts or autofs deletes).
465 *
466 * __d_drop requires dentry->d_lock.
467 */
468void __d_drop(struct dentry *dentry)
469{
dea3667b 470 if (!d_unhashed(dentry)) {
b61625d2 471 struct hlist_bl_head *b;
7632e465
BF
472 /*
473 * Hashed dentries are normally on the dentry hashtable,
474 * with the exception of those newly allocated by
475 * d_obtain_alias, which are always IS_ROOT:
476 */
477 if (unlikely(IS_ROOT(dentry)))
b61625d2
AV
478 b = &dentry->d_sb->s_anon;
479 else
480 b = d_hash(dentry->d_parent, dentry->d_name.hash);
481
482 hlist_bl_lock(b);
483 __hlist_bl_del(&dentry->d_hash);
484 dentry->d_hash.pprev = NULL;
485 hlist_bl_unlock(b);
a7c6f571 486 dentry_rcuwalk_invalidate(dentry);
789680d1
NP
487 }
488}
489EXPORT_SYMBOL(__d_drop);
490
491void d_drop(struct dentry *dentry)
492{
789680d1
NP
493 spin_lock(&dentry->d_lock);
494 __d_drop(dentry);
495 spin_unlock(&dentry->d_lock);
789680d1
NP
496}
497EXPORT_SYMBOL(d_drop);
498
e55fd011 499static void __dentry_kill(struct dentry *dentry)
77812a1e 500{
41edf278
AV
501 struct dentry *parent = NULL;
502 bool can_free = true;
41edf278 503 if (!IS_ROOT(dentry))
77812a1e 504 parent = dentry->d_parent;
31e6b01f 505
0d98439e
LT
506 /*
507 * The dentry is now unrecoverably dead to the world.
508 */
509 lockref_mark_dead(&dentry->d_lockref);
510
f0023bc6 511 /*
f0023bc6
SW
512 * inform the fs via d_prune that this dentry is about to be
513 * unhashed and destroyed.
514 */
29266201 515 if (dentry->d_flags & DCACHE_OP_PRUNE)
61572bb1
YZ
516 dentry->d_op->d_prune(dentry);
517
01b60351
AV
518 if (dentry->d_flags & DCACHE_LRU_LIST) {
519 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
520 d_lru_del(dentry);
01b60351 521 }
77812a1e
NP
522 /* if it was on the hash then remove it */
523 __d_drop(dentry);
ca5358ef 524 __list_del_entry(&dentry->d_child);
03b3b889
AV
525 /*
526 * Inform d_walk() that we are no longer attached to the
527 * dentry tree
528 */
529 dentry->d_flags |= DCACHE_DENTRY_KILLED;
530 if (parent)
531 spin_unlock(&parent->d_lock);
532 dentry_iput(dentry);
533 /*
534 * dentry_iput drops the locks, at which point nobody (except
535 * transient RCU lookups) can reach this dentry.
536 */
360f5479 537 BUG_ON(dentry->d_lockref.count > 0);
03b3b889
AV
538 this_cpu_dec(nr_dentry);
539 if (dentry->d_op && dentry->d_op->d_release)
540 dentry->d_op->d_release(dentry);
541
41edf278
AV
542 spin_lock(&dentry->d_lock);
543 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
544 dentry->d_flags |= DCACHE_MAY_FREE;
545 can_free = false;
546 }
547 spin_unlock(&dentry->d_lock);
41edf278
AV
548 if (likely(can_free))
549 dentry_free(dentry);
e55fd011
AV
550}
551
552/*
553 * Finish off a dentry we've decided to kill.
554 * dentry->d_lock must be held, returns with it unlocked.
555 * If ref is non-zero, then decrement the refcount too.
556 * Returns dentry requiring refcount drop, or NULL if we're done.
557 */
8cbf74da 558static struct dentry *dentry_kill(struct dentry *dentry)
e55fd011
AV
559 __releases(dentry->d_lock)
560{
561 struct inode *inode = dentry->d_inode;
562 struct dentry *parent = NULL;
563
564 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
565 goto failed;
566
567 if (!IS_ROOT(dentry)) {
568 parent = dentry->d_parent;
569 if (unlikely(!spin_trylock(&parent->d_lock))) {
570 if (inode)
571 spin_unlock(&inode->i_lock);
572 goto failed;
573 }
574 }
575
576 __dentry_kill(dentry);
03b3b889 577 return parent;
e55fd011
AV
578
579failed:
8cbf74da
AV
580 spin_unlock(&dentry->d_lock);
581 cpu_relax();
e55fd011 582 return dentry; /* try again with same dentry */
77812a1e
NP
583}
584
046b961b
AV
585static inline struct dentry *lock_parent(struct dentry *dentry)
586{
587 struct dentry *parent = dentry->d_parent;
588 if (IS_ROOT(dentry))
589 return NULL;
360f5479 590 if (unlikely(dentry->d_lockref.count < 0))
c2338f2d 591 return NULL;
046b961b
AV
592 if (likely(spin_trylock(&parent->d_lock)))
593 return parent;
046b961b 594 rcu_read_lock();
c2338f2d 595 spin_unlock(&dentry->d_lock);
046b961b
AV
596again:
597 parent = ACCESS_ONCE(dentry->d_parent);
598 spin_lock(&parent->d_lock);
599 /*
600 * We can't blindly lock dentry until we are sure
601 * that we won't violate the locking order.
602 * Any changes of dentry->d_parent must have
603 * been done with parent->d_lock held, so
604 * spin_lock() above is enough of a barrier
605 * for checking if it's still our child.
606 */
607 if (unlikely(parent != dentry->d_parent)) {
608 spin_unlock(&parent->d_lock);
609 goto again;
610 }
611 rcu_read_unlock();
612 if (parent != dentry)
9f12600f 613 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
046b961b
AV
614 else
615 parent = NULL;
616 return parent;
617}
618
360f5479
LT
619/*
620 * Try to do a lockless dput(), and return whether that was successful.
621 *
622 * If unsuccessful, we return false, having already taken the dentry lock.
623 *
624 * The caller needs to hold the RCU read lock, so that the dentry is
625 * guaranteed to stay around even if the refcount goes down to zero!
626 */
627static inline bool fast_dput(struct dentry *dentry)
628{
629 int ret;
630 unsigned int d_flags;
631
632 /*
633 * If we have a d_op->d_delete() operation, we sould not
75a6f82a 634 * let the dentry count go to zero, so use "put_or_lock".
360f5479
LT
635 */
636 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
637 return lockref_put_or_lock(&dentry->d_lockref);
638
639 /*
640 * .. otherwise, we can try to just decrement the
641 * lockref optimistically.
642 */
643 ret = lockref_put_return(&dentry->d_lockref);
644
645 /*
646 * If the lockref_put_return() failed due to the lock being held
647 * by somebody else, the fast path has failed. We will need to
648 * get the lock, and then check the count again.
649 */
650 if (unlikely(ret < 0)) {
651 spin_lock(&dentry->d_lock);
652 if (dentry->d_lockref.count > 1) {
653 dentry->d_lockref.count--;
654 spin_unlock(&dentry->d_lock);
655 return 1;
656 }
657 return 0;
658 }
659
660 /*
661 * If we weren't the last ref, we're done.
662 */
663 if (ret)
664 return 1;
665
666 /*
667 * Careful, careful. The reference count went down
668 * to zero, but we don't hold the dentry lock, so
669 * somebody else could get it again, and do another
670 * dput(), and we need to not race with that.
671 *
672 * However, there is a very special and common case
673 * where we don't care, because there is nothing to
674 * do: the dentry is still hashed, it does not have
675 * a 'delete' op, and it's referenced and already on
676 * the LRU list.
677 *
678 * NOTE! Since we aren't locked, these values are
679 * not "stable". However, it is sufficient that at
680 * some point after we dropped the reference the
681 * dentry was hashed and the flags had the proper
682 * value. Other dentry users may have re-gotten
683 * a reference to the dentry and change that, but
684 * our work is done - we can leave the dentry
685 * around with a zero refcount.
686 */
687 smp_rmb();
688 d_flags = ACCESS_ONCE(dentry->d_flags);
75a6f82a 689 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
360f5479
LT
690
691 /* Nothing to do? Dropping the reference was all we needed? */
692 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
693 return 1;
694
695 /*
696 * Not the fast normal case? Get the lock. We've already decremented
697 * the refcount, but we'll need to re-check the situation after
698 * getting the lock.
699 */
700 spin_lock(&dentry->d_lock);
701
702 /*
703 * Did somebody else grab a reference to it in the meantime, and
704 * we're no longer the last user after all? Alternatively, somebody
705 * else could have killed it and marked it dead. Either way, we
706 * don't need to do anything else.
707 */
708 if (dentry->d_lockref.count) {
709 spin_unlock(&dentry->d_lock);
710 return 1;
711 }
712
713 /*
714 * Re-get the reference we optimistically dropped. We hold the
715 * lock, and we just tested that it was zero, so we can just
716 * set it to 1.
717 */
718 dentry->d_lockref.count = 1;
719 return 0;
720}
721
722
1da177e4
LT
723/*
724 * This is dput
725 *
726 * This is complicated by the fact that we do not want to put
727 * dentries that are no longer on any hash chain on the unused
728 * list: we'd much rather just get rid of them immediately.
729 *
730 * However, that implies that we have to traverse the dentry
731 * tree upwards to the parents which might _also_ now be
732 * scheduled for deletion (it may have been only waiting for
733 * its last child to go away).
734 *
735 * This tail recursion is done by hand as we don't want to depend
736 * on the compiler to always get this right (gcc generally doesn't).
737 * Real recursion would eat up our stack space.
738 */
739
740/*
741 * dput - release a dentry
742 * @dentry: dentry to release
743 *
744 * Release a dentry. This will drop the usage count and if appropriate
745 * call the dentry unlink method as well as removing it from the queues and
746 * releasing its resources. If the parent dentries were scheduled for release
747 * they too may now get deleted.
1da177e4 748 */
1da177e4
LT
749void dput(struct dentry *dentry)
750{
8aab6a27 751 if (unlikely(!dentry))
1da177e4
LT
752 return;
753
754repeat:
360f5479
LT
755 rcu_read_lock();
756 if (likely(fast_dput(dentry))) {
757 rcu_read_unlock();
1da177e4 758 return;
360f5479
LT
759 }
760
761 /* Slow case: now with the dentry lock held */
762 rcu_read_unlock();
1da177e4 763
8aab6a27
LT
764 /* Unreachable? Get rid of it */
765 if (unlikely(d_unhashed(dentry)))
766 goto kill_it;
767
75a6f82a
AV
768 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
769 goto kill_it;
770
8aab6a27 771 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
1da177e4 772 if (dentry->d_op->d_delete(dentry))
61f3dee4 773 goto kill_it;
1da177e4 774 }
265ac902 775
358eec18
LT
776 if (!(dentry->d_flags & DCACHE_REFERENCED))
777 dentry->d_flags |= DCACHE_REFERENCED;
a4633357 778 dentry_lru_add(dentry);
265ac902 779
98474236 780 dentry->d_lockref.count--;
61f3dee4 781 spin_unlock(&dentry->d_lock);
1da177e4
LT
782 return;
783
d52b9086 784kill_it:
8cbf74da 785 dentry = dentry_kill(dentry);
d52b9086
MS
786 if (dentry)
787 goto repeat;
1da177e4 788}
ec4f8605 789EXPORT_SYMBOL(dput);
1da177e4 790
1da177e4 791
b5c84bf6 792/* This must be called with d_lock held */
dc0474be 793static inline void __dget_dlock(struct dentry *dentry)
23044507 794{
98474236 795 dentry->d_lockref.count++;
23044507
NP
796}
797
dc0474be 798static inline void __dget(struct dentry *dentry)
1da177e4 799{
98474236 800 lockref_get(&dentry->d_lockref);
1da177e4
LT
801}
802
b7ab39f6
NP
803struct dentry *dget_parent(struct dentry *dentry)
804{
df3d0bbc 805 int gotref;
b7ab39f6
NP
806 struct dentry *ret;
807
df3d0bbc
WL
808 /*
809 * Do optimistic parent lookup without any
810 * locking.
811 */
812 rcu_read_lock();
813 ret = ACCESS_ONCE(dentry->d_parent);
814 gotref = lockref_get_not_zero(&ret->d_lockref);
815 rcu_read_unlock();
816 if (likely(gotref)) {
817 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
818 return ret;
819 dput(ret);
820 }
821
b7ab39f6 822repeat:
a734eb45
NP
823 /*
824 * Don't need rcu_dereference because we re-check it was correct under
825 * the lock.
826 */
827 rcu_read_lock();
b7ab39f6 828 ret = dentry->d_parent;
a734eb45
NP
829 spin_lock(&ret->d_lock);
830 if (unlikely(ret != dentry->d_parent)) {
831 spin_unlock(&ret->d_lock);
832 rcu_read_unlock();
b7ab39f6
NP
833 goto repeat;
834 }
a734eb45 835 rcu_read_unlock();
98474236
WL
836 BUG_ON(!ret->d_lockref.count);
837 ret->d_lockref.count++;
b7ab39f6 838 spin_unlock(&ret->d_lock);
b7ab39f6
NP
839 return ret;
840}
841EXPORT_SYMBOL(dget_parent);
842
1da177e4
LT
843/**
844 * d_find_alias - grab a hashed alias of inode
845 * @inode: inode in question
1da177e4
LT
846 *
847 * If inode has a hashed alias, or is a directory and has any alias,
848 * acquire the reference to alias and return it. Otherwise return NULL.
849 * Notice that if inode is a directory there can be only one alias and
850 * it can be unhashed only if it has no children, or if it is the root
3ccb354d
EB
851 * of a filesystem, or if the directory was renamed and d_revalidate
852 * was the first vfs operation to notice.
1da177e4 853 *
21c0d8fd 854 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
52ed46f0 855 * any other hashed alias over that one.
1da177e4 856 */
52ed46f0 857static struct dentry *__d_find_alias(struct inode *inode)
1da177e4 858{
da502956 859 struct dentry *alias, *discon_alias;
1da177e4 860
da502956
NP
861again:
862 discon_alias = NULL;
946e51f2 863 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
da502956 864 spin_lock(&alias->d_lock);
1da177e4 865 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
21c0d8fd 866 if (IS_ROOT(alias) &&
da502956 867 (alias->d_flags & DCACHE_DISCONNECTED)) {
1da177e4 868 discon_alias = alias;
52ed46f0 869 } else {
dc0474be 870 __dget_dlock(alias);
da502956
NP
871 spin_unlock(&alias->d_lock);
872 return alias;
873 }
874 }
875 spin_unlock(&alias->d_lock);
876 }
877 if (discon_alias) {
878 alias = discon_alias;
879 spin_lock(&alias->d_lock);
880 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
8d80d7da
BF
881 __dget_dlock(alias);
882 spin_unlock(&alias->d_lock);
883 return alias;
1da177e4 884 }
da502956
NP
885 spin_unlock(&alias->d_lock);
886 goto again;
1da177e4 887 }
da502956 888 return NULL;
1da177e4
LT
889}
890
da502956 891struct dentry *d_find_alias(struct inode *inode)
1da177e4 892{
214fda1f
DH
893 struct dentry *de = NULL;
894
b3d9b7a3 895 if (!hlist_empty(&inode->i_dentry)) {
873feea0 896 spin_lock(&inode->i_lock);
52ed46f0 897 de = __d_find_alias(inode);
873feea0 898 spin_unlock(&inode->i_lock);
214fda1f 899 }
1da177e4
LT
900 return de;
901}
ec4f8605 902EXPORT_SYMBOL(d_find_alias);
1da177e4
LT
903
904/*
905 * Try to kill dentries associated with this inode.
906 * WARNING: you must own a reference to inode.
907 */
908void d_prune_aliases(struct inode *inode)
909{
0cdca3f9 910 struct dentry *dentry;
1da177e4 911restart:
873feea0 912 spin_lock(&inode->i_lock);
946e51f2 913 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
1da177e4 914 spin_lock(&dentry->d_lock);
98474236 915 if (!dentry->d_lockref.count) {
29355c39
AV
916 struct dentry *parent = lock_parent(dentry);
917 if (likely(!dentry->d_lockref.count)) {
918 __dentry_kill(dentry);
4a7795d3 919 dput(parent);
29355c39
AV
920 goto restart;
921 }
922 if (parent)
923 spin_unlock(&parent->d_lock);
1da177e4
LT
924 }
925 spin_unlock(&dentry->d_lock);
926 }
873feea0 927 spin_unlock(&inode->i_lock);
1da177e4 928}
ec4f8605 929EXPORT_SYMBOL(d_prune_aliases);
1da177e4 930
3049cfe2 931static void shrink_dentry_list(struct list_head *list)
1da177e4 932{
5c47e6d0 933 struct dentry *dentry, *parent;
da3bbdd4 934
60942f2f 935 while (!list_empty(list)) {
ff2fde99 936 struct inode *inode;
60942f2f 937 dentry = list_entry(list->prev, struct dentry, d_lru);
ec33679d 938 spin_lock(&dentry->d_lock);
046b961b
AV
939 parent = lock_parent(dentry);
940
dd1f6b2e
DC
941 /*
942 * The dispose list is isolated and dentries are not accounted
943 * to the LRU here, so we can simply remove it from the list
944 * here regardless of whether it is referenced or not.
945 */
89dc77bc 946 d_shrink_del(dentry);
dd1f6b2e 947
1da177e4
LT
948 /*
949 * We found an inuse dentry which was not removed from
dd1f6b2e 950 * the LRU because of laziness during lookup. Do not free it.
1da177e4 951 */
360f5479 952 if (dentry->d_lockref.count > 0) {
da3bbdd4 953 spin_unlock(&dentry->d_lock);
046b961b
AV
954 if (parent)
955 spin_unlock(&parent->d_lock);
1da177e4
LT
956 continue;
957 }
77812a1e 958
64fd72e0
AV
959
960 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
961 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
962 spin_unlock(&dentry->d_lock);
046b961b
AV
963 if (parent)
964 spin_unlock(&parent->d_lock);
64fd72e0
AV
965 if (can_free)
966 dentry_free(dentry);
967 continue;
968 }
969
ff2fde99
AV
970 inode = dentry->d_inode;
971 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
89dc77bc 972 d_shrink_add(dentry, list);
dd1f6b2e 973 spin_unlock(&dentry->d_lock);
046b961b
AV
974 if (parent)
975 spin_unlock(&parent->d_lock);
5c47e6d0 976 continue;
dd1f6b2e 977 }
ff2fde99 978
ff2fde99 979 __dentry_kill(dentry);
046b961b 980
5c47e6d0
AV
981 /*
982 * We need to prune ancestors too. This is necessary to prevent
983 * quadratic behavior of shrink_dcache_parent(), but is also
984 * expected to be beneficial in reducing dentry cache
985 * fragmentation.
986 */
987 dentry = parent;
b2b80195
AV
988 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
989 parent = lock_parent(dentry);
990 if (dentry->d_lockref.count != 1) {
991 dentry->d_lockref.count--;
992 spin_unlock(&dentry->d_lock);
993 if (parent)
994 spin_unlock(&parent->d_lock);
995 break;
996 }
997 inode = dentry->d_inode; /* can't be NULL */
998 if (unlikely(!spin_trylock(&inode->i_lock))) {
999 spin_unlock(&dentry->d_lock);
1000 if (parent)
1001 spin_unlock(&parent->d_lock);
1002 cpu_relax();
1003 continue;
1004 }
1005 __dentry_kill(dentry);
1006 dentry = parent;
1007 }
da3bbdd4 1008 }
3049cfe2
CH
1009}
1010
3f97b163
VD
1011static enum lru_status dentry_lru_isolate(struct list_head *item,
1012 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
f6041567
DC
1013{
1014 struct list_head *freeable = arg;
1015 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1016
1017
1018 /*
1019 * we are inverting the lru lock/dentry->d_lock here,
1020 * so use a trylock. If we fail to get the lock, just skip
1021 * it
1022 */
1023 if (!spin_trylock(&dentry->d_lock))
1024 return LRU_SKIP;
1025
1026 /*
1027 * Referenced dentries are still in use. If they have active
1028 * counts, just remove them from the LRU. Otherwise give them
1029 * another pass through the LRU.
1030 */
1031 if (dentry->d_lockref.count) {
3f97b163 1032 d_lru_isolate(lru, dentry);
f6041567
DC
1033 spin_unlock(&dentry->d_lock);
1034 return LRU_REMOVED;
1035 }
1036
1037 if (dentry->d_flags & DCACHE_REFERENCED) {
1038 dentry->d_flags &= ~DCACHE_REFERENCED;
1039 spin_unlock(&dentry->d_lock);
1040
1041 /*
1042 * The list move itself will be made by the common LRU code. At
1043 * this point, we've dropped the dentry->d_lock but keep the
1044 * lru lock. This is safe to do, since every list movement is
1045 * protected by the lru lock even if both locks are held.
1046 *
1047 * This is guaranteed by the fact that all LRU management
1048 * functions are intermediated by the LRU API calls like
1049 * list_lru_add and list_lru_del. List movement in this file
1050 * only ever occur through this functions or through callbacks
1051 * like this one, that are called from the LRU API.
1052 *
1053 * The only exceptions to this are functions like
1054 * shrink_dentry_list, and code that first checks for the
1055 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1056 * operating only with stack provided lists after they are
1057 * properly isolated from the main list. It is thus, always a
1058 * local access.
1059 */
1060 return LRU_ROTATE;
1061 }
1062
3f97b163 1063 d_lru_shrink_move(lru, dentry, freeable);
f6041567
DC
1064 spin_unlock(&dentry->d_lock);
1065
1066 return LRU_REMOVED;
1067}
1068
3049cfe2 1069/**
b48f03b3
DC
1070 * prune_dcache_sb - shrink the dcache
1071 * @sb: superblock
503c358c 1072 * @sc: shrink control, passed to list_lru_shrink_walk()
b48f03b3 1073 *
503c358c
VD
1074 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1075 * is done when we need more memory and called from the superblock shrinker
b48f03b3 1076 * function.
3049cfe2 1077 *
b48f03b3
DC
1078 * This function may fail to free any resources if all the dentries are in
1079 * use.
3049cfe2 1080 */
503c358c 1081long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
3049cfe2 1082{
f6041567
DC
1083 LIST_HEAD(dispose);
1084 long freed;
3049cfe2 1085
503c358c
VD
1086 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1087 dentry_lru_isolate, &dispose);
f6041567 1088 shrink_dentry_list(&dispose);
0a234c6d 1089 return freed;
da3bbdd4 1090}
23044507 1091
4e717f5c 1092static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
3f97b163 1093 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
dd1f6b2e 1094{
4e717f5c
GC
1095 struct list_head *freeable = arg;
1096 struct dentry *dentry = container_of(item, struct dentry, d_lru);
dd1f6b2e 1097
4e717f5c
GC
1098 /*
1099 * we are inverting the lru lock/dentry->d_lock here,
1100 * so use a trylock. If we fail to get the lock, just skip
1101 * it
1102 */
1103 if (!spin_trylock(&dentry->d_lock))
1104 return LRU_SKIP;
1105
3f97b163 1106 d_lru_shrink_move(lru, dentry, freeable);
4e717f5c 1107 spin_unlock(&dentry->d_lock);
ec33679d 1108
4e717f5c 1109 return LRU_REMOVED;
da3bbdd4
KM
1110}
1111
4e717f5c 1112
1da177e4
LT
1113/**
1114 * shrink_dcache_sb - shrink dcache for a superblock
1115 * @sb: superblock
1116 *
3049cfe2
CH
1117 * Shrink the dcache for the specified super block. This is used to free
1118 * the dcache before unmounting a file system.
1da177e4 1119 */
3049cfe2 1120void shrink_dcache_sb(struct super_block *sb)
1da177e4 1121{
4e717f5c
GC
1122 long freed;
1123
1124 do {
1125 LIST_HEAD(dispose);
1126
1127 freed = list_lru_walk(&sb->s_dentry_lru,
1128 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
3049cfe2 1129
4e717f5c
GC
1130 this_cpu_sub(nr_dentry_unused, freed);
1131 shrink_dentry_list(&dispose);
1132 } while (freed > 0);
1da177e4 1133}
ec4f8605 1134EXPORT_SYMBOL(shrink_dcache_sb);
1da177e4 1135
db14fc3a
MS
1136/**
1137 * enum d_walk_ret - action to talke during tree walk
1138 * @D_WALK_CONTINUE: contrinue walk
1139 * @D_WALK_QUIT: quit walk
1140 * @D_WALK_NORETRY: quit when retry is needed
1141 * @D_WALK_SKIP: skip this dentry and its children
1142 */
1143enum d_walk_ret {
1144 D_WALK_CONTINUE,
1145 D_WALK_QUIT,
1146 D_WALK_NORETRY,
1147 D_WALK_SKIP,
1148};
c826cb7d 1149
1da177e4 1150/**
db14fc3a
MS
1151 * d_walk - walk the dentry tree
1152 * @parent: start of walk
1153 * @data: data passed to @enter() and @finish()
1154 * @enter: callback when first entering the dentry
1155 * @finish: callback when successfully finished the walk
1da177e4 1156 *
db14fc3a 1157 * The @enter() and @finish() callbacks are called with d_lock held.
1da177e4 1158 */
db14fc3a
MS
1159static void d_walk(struct dentry *parent, void *data,
1160 enum d_walk_ret (*enter)(void *, struct dentry *),
1161 void (*finish)(void *))
1da177e4 1162{
949854d0 1163 struct dentry *this_parent;
1da177e4 1164 struct list_head *next;
48f5ec21 1165 unsigned seq = 0;
db14fc3a
MS
1166 enum d_walk_ret ret;
1167 bool retry = true;
949854d0 1168
58db63d0 1169again:
48f5ec21 1170 read_seqbegin_or_lock(&rename_lock, &seq);
58db63d0 1171 this_parent = parent;
2fd6b7f5 1172 spin_lock(&this_parent->d_lock);
db14fc3a
MS
1173
1174 ret = enter(data, this_parent);
1175 switch (ret) {
1176 case D_WALK_CONTINUE:
1177 break;
1178 case D_WALK_QUIT:
1179 case D_WALK_SKIP:
1180 goto out_unlock;
1181 case D_WALK_NORETRY:
1182 retry = false;
1183 break;
1184 }
1da177e4
LT
1185repeat:
1186 next = this_parent->d_subdirs.next;
1187resume:
1188 while (next != &this_parent->d_subdirs) {
1189 struct list_head *tmp = next;
946e51f2 1190 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
1da177e4 1191 next = tmp->next;
2fd6b7f5
NP
1192
1193 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
db14fc3a
MS
1194
1195 ret = enter(data, dentry);
1196 switch (ret) {
1197 case D_WALK_CONTINUE:
1198 break;
1199 case D_WALK_QUIT:
2fd6b7f5 1200 spin_unlock(&dentry->d_lock);
db14fc3a
MS
1201 goto out_unlock;
1202 case D_WALK_NORETRY:
1203 retry = false;
1204 break;
1205 case D_WALK_SKIP:
1206 spin_unlock(&dentry->d_lock);
1207 continue;
2fd6b7f5 1208 }
db14fc3a 1209
1da177e4 1210 if (!list_empty(&dentry->d_subdirs)) {
2fd6b7f5
NP
1211 spin_unlock(&this_parent->d_lock);
1212 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
1da177e4 1213 this_parent = dentry;
2fd6b7f5 1214 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
1da177e4
LT
1215 goto repeat;
1216 }
2fd6b7f5 1217 spin_unlock(&dentry->d_lock);
1da177e4
LT
1218 }
1219 /*
1220 * All done at this level ... ascend and resume the search.
1221 */
ca5358ef
AV
1222 rcu_read_lock();
1223ascend:
1da177e4 1224 if (this_parent != parent) {
c826cb7d 1225 struct dentry *child = this_parent;
31dec132
AV
1226 this_parent = child->d_parent;
1227
31dec132
AV
1228 spin_unlock(&child->d_lock);
1229 spin_lock(&this_parent->d_lock);
1230
ca5358ef
AV
1231 /* might go back up the wrong parent if we have had a rename. */
1232 if (need_seqretry(&rename_lock, seq))
949854d0 1233 goto rename_retry;
2159184e
AV
1234 /* go into the first sibling still alive */
1235 do {
1236 next = child->d_child.next;
ca5358ef
AV
1237 if (next == &this_parent->d_subdirs)
1238 goto ascend;
1239 child = list_entry(next, struct dentry, d_child);
2159184e 1240 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
31dec132 1241 rcu_read_unlock();
1da177e4
LT
1242 goto resume;
1243 }
ca5358ef 1244 if (need_seqretry(&rename_lock, seq))
949854d0 1245 goto rename_retry;
ca5358ef 1246 rcu_read_unlock();
db14fc3a
MS
1247 if (finish)
1248 finish(data);
1249
1250out_unlock:
1251 spin_unlock(&this_parent->d_lock);
48f5ec21 1252 done_seqretry(&rename_lock, seq);
db14fc3a 1253 return;
58db63d0
NP
1254
1255rename_retry:
ca5358ef
AV
1256 spin_unlock(&this_parent->d_lock);
1257 rcu_read_unlock();
1258 BUG_ON(seq & 1);
db14fc3a
MS
1259 if (!retry)
1260 return;
48f5ec21 1261 seq = 1;
58db63d0 1262 goto again;
1da177e4 1263}
db14fc3a
MS
1264
1265/*
1266 * Search for at least 1 mount point in the dentry's subdirs.
1267 * We descend to the next level whenever the d_subdirs
1268 * list is non-empty and continue searching.
1269 */
1270
db14fc3a
MS
1271static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1272{
1273 int *ret = data;
1274 if (d_mountpoint(dentry)) {
1275 *ret = 1;
1276 return D_WALK_QUIT;
1277 }
1278 return D_WALK_CONTINUE;
1279}
1280
69c88dc7
RD
1281/**
1282 * have_submounts - check for mounts over a dentry
1283 * @parent: dentry to check.
1284 *
1285 * Return true if the parent or its subdirectories contain
1286 * a mount point
1287 */
db14fc3a
MS
1288int have_submounts(struct dentry *parent)
1289{
1290 int ret = 0;
1291
1292 d_walk(parent, &ret, check_mount, NULL);
1293
1294 return ret;
1295}
ec4f8605 1296EXPORT_SYMBOL(have_submounts);
1da177e4 1297
eed81007
MS
1298/*
1299 * Called by mount code to set a mountpoint and check if the mountpoint is
1300 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1301 * subtree can become unreachable).
1302 *
1ffe46d1 1303 * Only one of d_invalidate() and d_set_mounted() must succeed. For
eed81007
MS
1304 * this reason take rename_lock and d_lock on dentry and ancestors.
1305 */
1306int d_set_mounted(struct dentry *dentry)
1307{
1308 struct dentry *p;
1309 int ret = -ENOENT;
1310 write_seqlock(&rename_lock);
1311 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1ffe46d1 1312 /* Need exclusion wrt. d_invalidate() */
eed81007
MS
1313 spin_lock(&p->d_lock);
1314 if (unlikely(d_unhashed(p))) {
1315 spin_unlock(&p->d_lock);
1316 goto out;
1317 }
1318 spin_unlock(&p->d_lock);
1319 }
1320 spin_lock(&dentry->d_lock);
1321 if (!d_unlinked(dentry)) {
1322 dentry->d_flags |= DCACHE_MOUNTED;
1323 ret = 0;
1324 }
1325 spin_unlock(&dentry->d_lock);
1326out:
1327 write_sequnlock(&rename_lock);
1328 return ret;
1329}
1330
1da177e4 1331/*
fd517909 1332 * Search the dentry child list of the specified parent,
1da177e4
LT
1333 * and move any unused dentries to the end of the unused
1334 * list for prune_dcache(). We descend to the next level
1335 * whenever the d_subdirs list is non-empty and continue
1336 * searching.
1337 *
1338 * It returns zero iff there are no unused children,
1339 * otherwise it returns the number of children moved to
1340 * the end of the unused list. This may not be the total
1341 * number of unused children, because select_parent can
1342 * drop the lock and return early due to latency
1343 * constraints.
1344 */
1da177e4 1345
db14fc3a
MS
1346struct select_data {
1347 struct dentry *start;
1348 struct list_head dispose;
1349 int found;
1350};
23044507 1351
db14fc3a
MS
1352static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
1353{
1354 struct select_data *data = _data;
1355 enum d_walk_ret ret = D_WALK_CONTINUE;
1da177e4 1356
db14fc3a
MS
1357 if (data->start == dentry)
1358 goto out;
2fd6b7f5 1359
fe91522a 1360 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
db14fc3a 1361 data->found++;
fe91522a
AV
1362 } else {
1363 if (dentry->d_flags & DCACHE_LRU_LIST)
1364 d_lru_del(dentry);
1365 if (!dentry->d_lockref.count) {
1366 d_shrink_add(dentry, &data->dispose);
1367 data->found++;
1368 }
1da177e4 1369 }
db14fc3a
MS
1370 /*
1371 * We can return to the caller if we have found some (this
1372 * ensures forward progress). We'll be coming back to find
1373 * the rest.
1374 */
fe91522a
AV
1375 if (!list_empty(&data->dispose))
1376 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
1da177e4 1377out:
db14fc3a 1378 return ret;
1da177e4
LT
1379}
1380
1381/**
1382 * shrink_dcache_parent - prune dcache
1383 * @parent: parent of entries to prune
1384 *
1385 * Prune the dcache to remove unused children of the parent dentry.
1386 */
db14fc3a 1387void shrink_dcache_parent(struct dentry *parent)
1da177e4 1388{
db14fc3a
MS
1389 for (;;) {
1390 struct select_data data;
1da177e4 1391
db14fc3a
MS
1392 INIT_LIST_HEAD(&data.dispose);
1393 data.start = parent;
1394 data.found = 0;
1395
1396 d_walk(parent, &data, select_collect, NULL);
1397 if (!data.found)
1398 break;
1399
1400 shrink_dentry_list(&data.dispose);
421348f1
GT
1401 cond_resched();
1402 }
1da177e4 1403}
ec4f8605 1404EXPORT_SYMBOL(shrink_dcache_parent);
1da177e4 1405
9c8c10e2 1406static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
42c32608 1407{
9c8c10e2
AV
1408 /* it has busy descendents; complain about those instead */
1409 if (!list_empty(&dentry->d_subdirs))
1410 return D_WALK_CONTINUE;
42c32608 1411
9c8c10e2
AV
1412 /* root with refcount 1 is fine */
1413 if (dentry == _data && dentry->d_lockref.count == 1)
1414 return D_WALK_CONTINUE;
1415
1416 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1417 " still in use (%d) [unmount of %s %s]\n",
42c32608
AV
1418 dentry,
1419 dentry->d_inode ?
1420 dentry->d_inode->i_ino : 0UL,
9c8c10e2 1421 dentry,
42c32608
AV
1422 dentry->d_lockref.count,
1423 dentry->d_sb->s_type->name,
1424 dentry->d_sb->s_id);
9c8c10e2
AV
1425 WARN_ON(1);
1426 return D_WALK_CONTINUE;
1427}
1428
1429static void do_one_tree(struct dentry *dentry)
1430{
1431 shrink_dcache_parent(dentry);
1432 d_walk(dentry, dentry, umount_check, NULL);
1433 d_drop(dentry);
1434 dput(dentry);
42c32608
AV
1435}
1436
1437/*
1438 * destroy the dentries attached to a superblock on unmounting
1439 */
1440void shrink_dcache_for_umount(struct super_block *sb)
1441{
1442 struct dentry *dentry;
1443
9c8c10e2 1444 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
42c32608
AV
1445
1446 dentry = sb->s_root;
1447 sb->s_root = NULL;
9c8c10e2 1448 do_one_tree(dentry);
42c32608
AV
1449
1450 while (!hlist_bl_empty(&sb->s_anon)) {
9c8c10e2
AV
1451 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1452 do_one_tree(dentry);
42c32608
AV
1453 }
1454}
1455
8ed936b5
EB
1456struct detach_data {
1457 struct select_data select;
1458 struct dentry *mountpoint;
1459};
1460static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
848ac114 1461{
8ed936b5 1462 struct detach_data *data = _data;
848ac114
MS
1463
1464 if (d_mountpoint(dentry)) {
8ed936b5
EB
1465 __dget_dlock(dentry);
1466 data->mountpoint = dentry;
848ac114
MS
1467 return D_WALK_QUIT;
1468 }
1469
8ed936b5 1470 return select_collect(&data->select, dentry);
848ac114
MS
1471}
1472
1473static void check_and_drop(void *_data)
1474{
8ed936b5 1475 struct detach_data *data = _data;
848ac114 1476
8ed936b5
EB
1477 if (!data->mountpoint && !data->select.found)
1478 __d_drop(data->select.start);
848ac114
MS
1479}
1480
1481/**
1ffe46d1
EB
1482 * d_invalidate - detach submounts, prune dcache, and drop
1483 * @dentry: dentry to invalidate (aka detach, prune and drop)
1484 *
1ffe46d1 1485 * no dcache lock.
848ac114 1486 *
8ed936b5
EB
1487 * The final d_drop is done as an atomic operation relative to
1488 * rename_lock ensuring there are no races with d_set_mounted. This
1489 * ensures there are no unhashed dentries on the path to a mountpoint.
848ac114 1490 */
5542aa2f 1491void d_invalidate(struct dentry *dentry)
848ac114 1492{
1ffe46d1
EB
1493 /*
1494 * If it's already been dropped, return OK.
1495 */
1496 spin_lock(&dentry->d_lock);
1497 if (d_unhashed(dentry)) {
1498 spin_unlock(&dentry->d_lock);
5542aa2f 1499 return;
1ffe46d1
EB
1500 }
1501 spin_unlock(&dentry->d_lock);
1502
848ac114
MS
1503 /* Negative dentries can be dropped without further checks */
1504 if (!dentry->d_inode) {
1505 d_drop(dentry);
5542aa2f 1506 return;
848ac114
MS
1507 }
1508
1509 for (;;) {
8ed936b5 1510 struct detach_data data;
848ac114 1511
8ed936b5
EB
1512 data.mountpoint = NULL;
1513 INIT_LIST_HEAD(&data.select.dispose);
1514 data.select.start = dentry;
1515 data.select.found = 0;
1516
1517 d_walk(dentry, &data, detach_and_collect, check_and_drop);
848ac114 1518
8ed936b5
EB
1519 if (data.select.found)
1520 shrink_dentry_list(&data.select.dispose);
848ac114 1521
8ed936b5
EB
1522 if (data.mountpoint) {
1523 detach_mounts(data.mountpoint);
1524 dput(data.mountpoint);
1525 }
848ac114 1526
8ed936b5 1527 if (!data.mountpoint && !data.select.found)
848ac114
MS
1528 break;
1529
1530 cond_resched();
1531 }
848ac114 1532}
1ffe46d1 1533EXPORT_SYMBOL(d_invalidate);
848ac114 1534
1da177e4 1535/**
a4464dbc
AV
1536 * __d_alloc - allocate a dcache entry
1537 * @sb: filesystem it will belong to
1da177e4
LT
1538 * @name: qstr of the name
1539 *
1540 * Allocates a dentry. It returns %NULL if there is insufficient memory
1541 * available. On a success the dentry is returned. The name passed in is
1542 * copied and the copy passed in may be reused after this call.
1543 */
1544
a4464dbc 1545struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
1da177e4
LT
1546{
1547 struct dentry *dentry;
1548 char *dname;
1549
e12ba74d 1550 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
1da177e4
LT
1551 if (!dentry)
1552 return NULL;
1553
6326c71f
LT
1554 /*
1555 * We guarantee that the inline name is always NUL-terminated.
1556 * This way the memcpy() done by the name switching in rename
1557 * will still always have a NUL at the end, even if we might
1558 * be overwriting an internal NUL character
1559 */
1560 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
1da177e4 1561 if (name->len > DNAME_INLINE_LEN-1) {
8d85b484 1562 size_t size = offsetof(struct external_name, name[1]);
5d097056
VD
1563 struct external_name *p = kmalloc(size + name->len,
1564 GFP_KERNEL_ACCOUNT);
8d85b484 1565 if (!p) {
1da177e4
LT
1566 kmem_cache_free(dentry_cache, dentry);
1567 return NULL;
1568 }
8d85b484
AV
1569 atomic_set(&p->u.count, 1);
1570 dname = p->name;
df4c0e36
AR
1571 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1572 kasan_unpoison_shadow(dname,
1573 round_up(name->len + 1, sizeof(unsigned long)));
1da177e4
LT
1574 } else {
1575 dname = dentry->d_iname;
1576 }
1da177e4
LT
1577
1578 dentry->d_name.len = name->len;
1579 dentry->d_name.hash = name->hash;
1580 memcpy(dname, name->name, name->len);
1581 dname[name->len] = 0;
1582
6326c71f
LT
1583 /* Make sure we always see the terminating NUL character */
1584 smp_wmb();
1585 dentry->d_name.name = dname;
1586
98474236 1587 dentry->d_lockref.count = 1;
dea3667b 1588 dentry->d_flags = 0;
1da177e4 1589 spin_lock_init(&dentry->d_lock);
31e6b01f 1590 seqcount_init(&dentry->d_seq);
1da177e4 1591 dentry->d_inode = NULL;
a4464dbc
AV
1592 dentry->d_parent = dentry;
1593 dentry->d_sb = sb;
1da177e4
LT
1594 dentry->d_op = NULL;
1595 dentry->d_fsdata = NULL;
ceb5bdc2 1596 INIT_HLIST_BL_NODE(&dentry->d_hash);
1da177e4
LT
1597 INIT_LIST_HEAD(&dentry->d_lru);
1598 INIT_LIST_HEAD(&dentry->d_subdirs);
946e51f2
AV
1599 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1600 INIT_LIST_HEAD(&dentry->d_child);
a4464dbc 1601 d_set_d_op(dentry, dentry->d_sb->s_d_op);
1da177e4 1602
3e880fb5 1603 this_cpu_inc(nr_dentry);
312d3ca8 1604
1da177e4
LT
1605 return dentry;
1606}
a4464dbc
AV
1607
1608/**
1609 * d_alloc - allocate a dcache entry
1610 * @parent: parent of entry to allocate
1611 * @name: qstr of the name
1612 *
1613 * Allocates a dentry. It returns %NULL if there is insufficient memory
1614 * available. On a success the dentry is returned. The name passed in is
1615 * copied and the copy passed in may be reused after this call.
1616 */
1617struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1618{
1619 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1620 if (!dentry)
1621 return NULL;
1622
1623 spin_lock(&parent->d_lock);
1624 /*
1625 * don't need child lock because it is not subject
1626 * to concurrency here
1627 */
1628 __dget_dlock(parent);
1629 dentry->d_parent = parent;
946e51f2 1630 list_add(&dentry->d_child, &parent->d_subdirs);
a4464dbc
AV
1631 spin_unlock(&parent->d_lock);
1632
1633 return dentry;
1634}
ec4f8605 1635EXPORT_SYMBOL(d_alloc);
1da177e4 1636
e1a24bb0
BF
1637/**
1638 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1639 * @sb: the superblock
1640 * @name: qstr of the name
1641 *
1642 * For a filesystem that just pins its dentries in memory and never
1643 * performs lookups at all, return an unhashed IS_ROOT dentry.
1644 */
4b936885
NP
1645struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1646{
e1a24bb0 1647 return __d_alloc(sb, name);
4b936885
NP
1648}
1649EXPORT_SYMBOL(d_alloc_pseudo);
1650
1da177e4
LT
1651struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1652{
1653 struct qstr q;
1654
1655 q.name = name;
1656 q.len = strlen(name);
1657 q.hash = full_name_hash(q.name, q.len);
1658 return d_alloc(parent, &q);
1659}
ef26ca97 1660EXPORT_SYMBOL(d_alloc_name);
1da177e4 1661
fb045adb
NP
1662void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1663{
6f7f7caa
LT
1664 WARN_ON_ONCE(dentry->d_op);
1665 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
fb045adb
NP
1666 DCACHE_OP_COMPARE |
1667 DCACHE_OP_REVALIDATE |
ecf3d1f1 1668 DCACHE_OP_WEAK_REVALIDATE |
4bacc9c9
DH
1669 DCACHE_OP_DELETE |
1670 DCACHE_OP_SELECT_INODE));
fb045adb
NP
1671 dentry->d_op = op;
1672 if (!op)
1673 return;
1674 if (op->d_hash)
1675 dentry->d_flags |= DCACHE_OP_HASH;
1676 if (op->d_compare)
1677 dentry->d_flags |= DCACHE_OP_COMPARE;
1678 if (op->d_revalidate)
1679 dentry->d_flags |= DCACHE_OP_REVALIDATE;
ecf3d1f1
JL
1680 if (op->d_weak_revalidate)
1681 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
fb045adb
NP
1682 if (op->d_delete)
1683 dentry->d_flags |= DCACHE_OP_DELETE;
f0023bc6
SW
1684 if (op->d_prune)
1685 dentry->d_flags |= DCACHE_OP_PRUNE;
4bacc9c9
DH
1686 if (op->d_select_inode)
1687 dentry->d_flags |= DCACHE_OP_SELECT_INODE;
fb045adb
NP
1688
1689}
1690EXPORT_SYMBOL(d_set_d_op);
1691
df1a085a
DH
1692
1693/*
1694 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1695 * @dentry - The dentry to mark
1696 *
1697 * Mark a dentry as falling through to the lower layer (as set with
1698 * d_pin_lower()). This flag may be recorded on the medium.
1699 */
1700void d_set_fallthru(struct dentry *dentry)
1701{
1702 spin_lock(&dentry->d_lock);
1703 dentry->d_flags |= DCACHE_FALLTHRU;
1704 spin_unlock(&dentry->d_lock);
1705}
1706EXPORT_SYMBOL(d_set_fallthru);
1707
b18825a7
DH
1708static unsigned d_flags_for_inode(struct inode *inode)
1709{
44bdb5e5 1710 unsigned add_flags = DCACHE_REGULAR_TYPE;
b18825a7
DH
1711
1712 if (!inode)
1713 return DCACHE_MISS_TYPE;
1714
1715 if (S_ISDIR(inode->i_mode)) {
1716 add_flags = DCACHE_DIRECTORY_TYPE;
1717 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1718 if (unlikely(!inode->i_op->lookup))
1719 add_flags = DCACHE_AUTODIR_TYPE;
1720 else
1721 inode->i_opflags |= IOP_LOOKUP;
1722 }
44bdb5e5
DH
1723 goto type_determined;
1724 }
1725
1726 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
6b255391 1727 if (unlikely(inode->i_op->get_link)) {
b18825a7 1728 add_flags = DCACHE_SYMLINK_TYPE;
44bdb5e5
DH
1729 goto type_determined;
1730 }
1731 inode->i_opflags |= IOP_NOFOLLOW;
b18825a7
DH
1732 }
1733
44bdb5e5
DH
1734 if (unlikely(!S_ISREG(inode->i_mode)))
1735 add_flags = DCACHE_SPECIAL_TYPE;
1736
1737type_determined:
b18825a7
DH
1738 if (unlikely(IS_AUTOMOUNT(inode)))
1739 add_flags |= DCACHE_NEED_AUTOMOUNT;
1740 return add_flags;
1741}
1742
360da900
OH
1743static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1744{
b18825a7
DH
1745 unsigned add_flags = d_flags_for_inode(inode);
1746
b23fb0a6 1747 spin_lock(&dentry->d_lock);
b18825a7 1748 if (inode)
946e51f2 1749 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
a528aca7 1750 raw_write_seqcount_begin(&dentry->d_seq);
4bf46a27 1751 __d_set_inode_and_type(dentry, inode, add_flags);
a528aca7 1752 raw_write_seqcount_end(&dentry->d_seq);
27f203f6
AV
1753 if (inode)
1754 __fsnotify_d_instantiate(dentry);
b23fb0a6 1755 spin_unlock(&dentry->d_lock);
360da900
OH
1756}
1757
1da177e4
LT
1758/**
1759 * d_instantiate - fill in inode information for a dentry
1760 * @entry: dentry to complete
1761 * @inode: inode to attach to this dentry
1762 *
1763 * Fill in inode information in the entry.
1764 *
1765 * This turns negative dentries into productive full members
1766 * of society.
1767 *
1768 * NOTE! This assumes that the inode count has been incremented
1769 * (or otherwise set) by the caller to indicate that it is now
1770 * in use by the dcache.
1771 */
1772
1773void d_instantiate(struct dentry *entry, struct inode * inode)
1774{
946e51f2 1775 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
873feea0
NP
1776 if (inode)
1777 spin_lock(&inode->i_lock);
360da900 1778 __d_instantiate(entry, inode);
873feea0
NP
1779 if (inode)
1780 spin_unlock(&inode->i_lock);
1da177e4
LT
1781 security_d_instantiate(entry, inode);
1782}
ec4f8605 1783EXPORT_SYMBOL(d_instantiate);
1da177e4 1784
b70a80e7
MS
1785/**
1786 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1787 * @entry: dentry to complete
1788 * @inode: inode to attach to this dentry
1789 *
1790 * Fill in inode information in the entry. If a directory alias is found, then
1791 * return an error (and drop inode). Together with d_materialise_unique() this
1792 * guarantees that a directory inode may never have more than one alias.
1793 */
1794int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1795{
946e51f2 1796 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
b70a80e7
MS
1797
1798 spin_lock(&inode->i_lock);
1799 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1800 spin_unlock(&inode->i_lock);
1801 iput(inode);
1802 return -EBUSY;
1803 }
1804 __d_instantiate(entry, inode);
1805 spin_unlock(&inode->i_lock);
1806 security_d_instantiate(entry, inode);
1807
1808 return 0;
1809}
1810EXPORT_SYMBOL(d_instantiate_no_diralias);
1811
adc0e91a
AV
1812struct dentry *d_make_root(struct inode *root_inode)
1813{
1814 struct dentry *res = NULL;
1815
1816 if (root_inode) {
26fe5750 1817 static const struct qstr name = QSTR_INIT("/", 1);
adc0e91a
AV
1818
1819 res = __d_alloc(root_inode->i_sb, &name);
1820 if (res)
1821 d_instantiate(res, root_inode);
1822 else
1823 iput(root_inode);
1824 }
1825 return res;
1826}
1827EXPORT_SYMBOL(d_make_root);
1828
d891eedb
BF
1829static struct dentry * __d_find_any_alias(struct inode *inode)
1830{
1831 struct dentry *alias;
1832
b3d9b7a3 1833 if (hlist_empty(&inode->i_dentry))
d891eedb 1834 return NULL;
946e51f2 1835 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
d891eedb
BF
1836 __dget(alias);
1837 return alias;
1838}
1839
46f72b34
SW
1840/**
1841 * d_find_any_alias - find any alias for a given inode
1842 * @inode: inode to find an alias for
1843 *
1844 * If any aliases exist for the given inode, take and return a
1845 * reference for one of them. If no aliases exist, return %NULL.
1846 */
1847struct dentry *d_find_any_alias(struct inode *inode)
d891eedb
BF
1848{
1849 struct dentry *de;
1850
1851 spin_lock(&inode->i_lock);
1852 de = __d_find_any_alias(inode);
1853 spin_unlock(&inode->i_lock);
1854 return de;
1855}
46f72b34 1856EXPORT_SYMBOL(d_find_any_alias);
d891eedb 1857
49c7dd28 1858static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
4ea3ada2 1859{
b911a6bd 1860 static const struct qstr anonstring = QSTR_INIT("/", 1);
9308a612
CH
1861 struct dentry *tmp;
1862 struct dentry *res;
b18825a7 1863 unsigned add_flags;
4ea3ada2
CH
1864
1865 if (!inode)
44003728 1866 return ERR_PTR(-ESTALE);
4ea3ada2
CH
1867 if (IS_ERR(inode))
1868 return ERR_CAST(inode);
1869
d891eedb 1870 res = d_find_any_alias(inode);
9308a612
CH
1871 if (res)
1872 goto out_iput;
1873
a4464dbc 1874 tmp = __d_alloc(inode->i_sb, &anonstring);
9308a612
CH
1875 if (!tmp) {
1876 res = ERR_PTR(-ENOMEM);
1877 goto out_iput;
4ea3ada2 1878 }
b5c84bf6 1879
873feea0 1880 spin_lock(&inode->i_lock);
d891eedb 1881 res = __d_find_any_alias(inode);
9308a612 1882 if (res) {
873feea0 1883 spin_unlock(&inode->i_lock);
9308a612
CH
1884 dput(tmp);
1885 goto out_iput;
1886 }
1887
1888 /* attach a disconnected dentry */
1a0a397e
BF
1889 add_flags = d_flags_for_inode(inode);
1890
1891 if (disconnected)
1892 add_flags |= DCACHE_DISCONNECTED;
b18825a7 1893
9308a612 1894 spin_lock(&tmp->d_lock);
4bf46a27 1895 __d_set_inode_and_type(tmp, inode, add_flags);
946e51f2 1896 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
1879fd6a 1897 hlist_bl_lock(&tmp->d_sb->s_anon);
ceb5bdc2 1898 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
1879fd6a 1899 hlist_bl_unlock(&tmp->d_sb->s_anon);
9308a612 1900 spin_unlock(&tmp->d_lock);
873feea0 1901 spin_unlock(&inode->i_lock);
24ff6663 1902 security_d_instantiate(tmp, inode);
9308a612 1903
9308a612
CH
1904 return tmp;
1905
1906 out_iput:
24ff6663
JB
1907 if (res && !IS_ERR(res))
1908 security_d_instantiate(res, inode);
9308a612
CH
1909 iput(inode);
1910 return res;
4ea3ada2 1911}
1a0a397e
BF
1912
1913/**
1914 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1915 * @inode: inode to allocate the dentry for
1916 *
1917 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1918 * similar open by handle operations. The returned dentry may be anonymous,
1919 * or may have a full name (if the inode was already in the cache).
1920 *
1921 * When called on a directory inode, we must ensure that the inode only ever
1922 * has one dentry. If a dentry is found, that is returned instead of
1923 * allocating a new one.
1924 *
1925 * On successful return, the reference to the inode has been transferred
1926 * to the dentry. In case of an error the reference on the inode is released.
1927 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1928 * be passed in and the error will be propagated to the return value,
1929 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1930 */
1931struct dentry *d_obtain_alias(struct inode *inode)
1932{
1933 return __d_obtain_alias(inode, 1);
1934}
adc48720 1935EXPORT_SYMBOL(d_obtain_alias);
1da177e4 1936
1a0a397e
BF
1937/**
1938 * d_obtain_root - find or allocate a dentry for a given inode
1939 * @inode: inode to allocate the dentry for
1940 *
1941 * Obtain an IS_ROOT dentry for the root of a filesystem.
1942 *
1943 * We must ensure that directory inodes only ever have one dentry. If a
1944 * dentry is found, that is returned instead of allocating a new one.
1945 *
1946 * On successful return, the reference to the inode has been transferred
1947 * to the dentry. In case of an error the reference on the inode is
1948 * released. A %NULL or IS_ERR inode may be passed in and will be the
1949 * error will be propagate to the return value, with a %NULL @inode
1950 * replaced by ERR_PTR(-ESTALE).
1951 */
1952struct dentry *d_obtain_root(struct inode *inode)
1953{
1954 return __d_obtain_alias(inode, 0);
1955}
1956EXPORT_SYMBOL(d_obtain_root);
1957
9403540c
BN
1958/**
1959 * d_add_ci - lookup or allocate new dentry with case-exact name
1960 * @inode: the inode case-insensitive lookup has found
1961 * @dentry: the negative dentry that was passed to the parent's lookup func
1962 * @name: the case-exact name to be associated with the returned dentry
1963 *
1964 * This is to avoid filling the dcache with case-insensitive names to the
1965 * same inode, only the actual correct case is stored in the dcache for
1966 * case-insensitive filesystems.
1967 *
1968 * For a case-insensitive lookup match and if the the case-exact dentry
1969 * already exists in in the dcache, use it and return it.
1970 *
1971 * If no entry exists with the exact case name, allocate new dentry with
1972 * the exact case, and return the spliced entry.
1973 */
e45b590b 1974struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
9403540c
BN
1975 struct qstr *name)
1976{
9403540c
BN
1977 struct dentry *found;
1978 struct dentry *new;
1979
b6520c81
CH
1980 /*
1981 * First check if a dentry matching the name already exists,
1982 * if not go ahead and create it now.
1983 */
9403540c 1984 found = d_hash_and_lookup(dentry->d_parent, name);
9403540c
BN
1985 if (!found) {
1986 new = d_alloc(dentry->d_parent, name);
1987 if (!new) {
4f522a24 1988 found = ERR_PTR(-ENOMEM);
427c77d4
AV
1989 } else {
1990 found = d_splice_alias(inode, new);
1991 if (found) {
1992 dput(new);
1993 return found;
1994 }
1995 return new;
9403540c 1996 }
9403540c 1997 }
9403540c 1998 iput(inode);
4f522a24 1999 return found;
9403540c 2000}
ec4f8605 2001EXPORT_SYMBOL(d_add_ci);
1da177e4 2002
12f8ad4b
LT
2003/*
2004 * Do the slow-case of the dentry name compare.
2005 *
2006 * Unlike the dentry_cmp() function, we need to atomically
da53be12 2007 * load the name and length information, so that the
12f8ad4b
LT
2008 * filesystem can rely on them, and can use the 'name' and
2009 * 'len' information without worrying about walking off the
2010 * end of memory etc.
2011 *
2012 * Thus the read_seqcount_retry() and the "duplicate" info
2013 * in arguments (the low-level filesystem should not look
2014 * at the dentry inode or name contents directly, since
2015 * rename can change them while we're in RCU mode).
2016 */
2017enum slow_d_compare {
2018 D_COMP_OK,
2019 D_COMP_NOMATCH,
2020 D_COMP_SEQRETRY,
2021};
2022
2023static noinline enum slow_d_compare slow_dentry_cmp(
2024 const struct dentry *parent,
12f8ad4b
LT
2025 struct dentry *dentry,
2026 unsigned int seq,
2027 const struct qstr *name)
2028{
2029 int tlen = dentry->d_name.len;
2030 const char *tname = dentry->d_name.name;
12f8ad4b
LT
2031
2032 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2033 cpu_relax();
2034 return D_COMP_SEQRETRY;
2035 }
da53be12 2036 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
12f8ad4b
LT
2037 return D_COMP_NOMATCH;
2038 return D_COMP_OK;
2039}
2040
31e6b01f
NP
2041/**
2042 * __d_lookup_rcu - search for a dentry (racy, store-free)
2043 * @parent: parent dentry
2044 * @name: qstr of name we wish to find
1f1e6e52 2045 * @seqp: returns d_seq value at the point where the dentry was found
31e6b01f
NP
2046 * Returns: dentry, or NULL
2047 *
2048 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2049 * resolution (store-free path walking) design described in
2050 * Documentation/filesystems/path-lookup.txt.
2051 *
2052 * This is not to be used outside core vfs.
2053 *
2054 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2055 * held, and rcu_read_lock held. The returned dentry must not be stored into
2056 * without taking d_lock and checking d_seq sequence count against @seq
2057 * returned here.
2058 *
15570086 2059 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
31e6b01f
NP
2060 * function.
2061 *
2062 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2063 * the returned dentry, so long as its parent's seqlock is checked after the
2064 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2065 * is formed, giving integrity down the path walk.
12f8ad4b
LT
2066 *
2067 * NOTE! The caller *has* to check the resulting dentry against the sequence
2068 * number we've returned before using any of the resulting dentry state!
31e6b01f 2069 */
8966be90
LT
2070struct dentry *__d_lookup_rcu(const struct dentry *parent,
2071 const struct qstr *name,
da53be12 2072 unsigned *seqp)
31e6b01f 2073{
26fe5750 2074 u64 hashlen = name->hash_len;
31e6b01f 2075 const unsigned char *str = name->name;
26fe5750 2076 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
ceb5bdc2 2077 struct hlist_bl_node *node;
31e6b01f
NP
2078 struct dentry *dentry;
2079
2080 /*
2081 * Note: There is significant duplication with __d_lookup_rcu which is
2082 * required to prevent single threaded performance regressions
2083 * especially on architectures where smp_rmb (in seqcounts) are costly.
2084 * Keep the two functions in sync.
2085 */
2086
2087 /*
2088 * The hash list is protected using RCU.
2089 *
2090 * Carefully use d_seq when comparing a candidate dentry, to avoid
2091 * races with d_move().
2092 *
2093 * It is possible that concurrent renames can mess up our list
2094 * walk here and result in missing our dentry, resulting in the
2095 * false-negative result. d_lookup() protects against concurrent
2096 * renames using rename_lock seqlock.
2097 *
b0a4bb83 2098 * See Documentation/filesystems/path-lookup.txt for more details.
31e6b01f 2099 */
b07ad996 2100 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
8966be90 2101 unsigned seq;
31e6b01f 2102
31e6b01f 2103seqretry:
12f8ad4b
LT
2104 /*
2105 * The dentry sequence count protects us from concurrent
da53be12 2106 * renames, and thus protects parent and name fields.
12f8ad4b
LT
2107 *
2108 * The caller must perform a seqcount check in order
da53be12 2109 * to do anything useful with the returned dentry.
12f8ad4b
LT
2110 *
2111 * NOTE! We do a "raw" seqcount_begin here. That means that
2112 * we don't wait for the sequence count to stabilize if it
2113 * is in the middle of a sequence change. If we do the slow
2114 * dentry compare, we will do seqretries until it is stable,
2115 * and if we end up with a successful lookup, we actually
2116 * want to exit RCU lookup anyway.
2117 */
2118 seq = raw_seqcount_begin(&dentry->d_seq);
31e6b01f
NP
2119 if (dentry->d_parent != parent)
2120 continue;
2e321806
LT
2121 if (d_unhashed(dentry))
2122 continue;
12f8ad4b 2123
830c0f0e 2124 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
26fe5750
LT
2125 if (dentry->d_name.hash != hashlen_hash(hashlen))
2126 continue;
da53be12
LT
2127 *seqp = seq;
2128 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
12f8ad4b
LT
2129 case D_COMP_OK:
2130 return dentry;
2131 case D_COMP_NOMATCH:
31e6b01f 2132 continue;
12f8ad4b
LT
2133 default:
2134 goto seqretry;
2135 }
31e6b01f 2136 }
12f8ad4b 2137
26fe5750 2138 if (dentry->d_name.hash_len != hashlen)
ee983e89 2139 continue;
da53be12 2140 *seqp = seq;
26fe5750 2141 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
12f8ad4b 2142 return dentry;
31e6b01f
NP
2143 }
2144 return NULL;
2145}
2146
1da177e4
LT
2147/**
2148 * d_lookup - search for a dentry
2149 * @parent: parent dentry
2150 * @name: qstr of name we wish to find
b04f784e 2151 * Returns: dentry, or NULL
1da177e4 2152 *
b04f784e
NP
2153 * d_lookup searches the children of the parent dentry for the name in
2154 * question. If the dentry is found its reference count is incremented and the
2155 * dentry is returned. The caller must use dput to free the entry when it has
2156 * finished using it. %NULL is returned if the dentry does not exist.
1da177e4 2157 */
da2d8455 2158struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
1da177e4 2159{
31e6b01f 2160 struct dentry *dentry;
949854d0 2161 unsigned seq;
1da177e4 2162
b8314f93
DY
2163 do {
2164 seq = read_seqbegin(&rename_lock);
2165 dentry = __d_lookup(parent, name);
2166 if (dentry)
1da177e4
LT
2167 break;
2168 } while (read_seqretry(&rename_lock, seq));
2169 return dentry;
2170}
ec4f8605 2171EXPORT_SYMBOL(d_lookup);
1da177e4 2172
31e6b01f 2173/**
b04f784e
NP
2174 * __d_lookup - search for a dentry (racy)
2175 * @parent: parent dentry
2176 * @name: qstr of name we wish to find
2177 * Returns: dentry, or NULL
2178 *
2179 * __d_lookup is like d_lookup, however it may (rarely) return a
2180 * false-negative result due to unrelated rename activity.
2181 *
2182 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2183 * however it must be used carefully, eg. with a following d_lookup in
2184 * the case of failure.
2185 *
2186 * __d_lookup callers must be commented.
2187 */
a713ca2a 2188struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
1da177e4
LT
2189{
2190 unsigned int len = name->len;
2191 unsigned int hash = name->hash;
2192 const unsigned char *str = name->name;
b07ad996 2193 struct hlist_bl_head *b = d_hash(parent, hash);
ceb5bdc2 2194 struct hlist_bl_node *node;
31e6b01f 2195 struct dentry *found = NULL;
665a7583 2196 struct dentry *dentry;
1da177e4 2197
31e6b01f
NP
2198 /*
2199 * Note: There is significant duplication with __d_lookup_rcu which is
2200 * required to prevent single threaded performance regressions
2201 * especially on architectures where smp_rmb (in seqcounts) are costly.
2202 * Keep the two functions in sync.
2203 */
2204
b04f784e
NP
2205 /*
2206 * The hash list is protected using RCU.
2207 *
2208 * Take d_lock when comparing a candidate dentry, to avoid races
2209 * with d_move().
2210 *
2211 * It is possible that concurrent renames can mess up our list
2212 * walk here and result in missing our dentry, resulting in the
2213 * false-negative result. d_lookup() protects against concurrent
2214 * renames using rename_lock seqlock.
2215 *
b0a4bb83 2216 * See Documentation/filesystems/path-lookup.txt for more details.
b04f784e 2217 */
1da177e4
LT
2218 rcu_read_lock();
2219
b07ad996 2220 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
1da177e4 2221
1da177e4
LT
2222 if (dentry->d_name.hash != hash)
2223 continue;
1da177e4
LT
2224
2225 spin_lock(&dentry->d_lock);
1da177e4
LT
2226 if (dentry->d_parent != parent)
2227 goto next;
d0185c08
LT
2228 if (d_unhashed(dentry))
2229 goto next;
2230
1da177e4
LT
2231 /*
2232 * It is safe to compare names since d_move() cannot
2233 * change the qstr (protected by d_lock).
2234 */
fb045adb 2235 if (parent->d_flags & DCACHE_OP_COMPARE) {
12f8ad4b
LT
2236 int tlen = dentry->d_name.len;
2237 const char *tname = dentry->d_name.name;
da53be12 2238 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
1da177e4
LT
2239 goto next;
2240 } else {
ee983e89
LT
2241 if (dentry->d_name.len != len)
2242 goto next;
12f8ad4b 2243 if (dentry_cmp(dentry, str, len))
1da177e4
LT
2244 goto next;
2245 }
2246
98474236 2247 dentry->d_lockref.count++;
d0185c08 2248 found = dentry;
1da177e4
LT
2249 spin_unlock(&dentry->d_lock);
2250 break;
2251next:
2252 spin_unlock(&dentry->d_lock);
2253 }
2254 rcu_read_unlock();
2255
2256 return found;
2257}
2258
3e7e241f
EB
2259/**
2260 * d_hash_and_lookup - hash the qstr then search for a dentry
2261 * @dir: Directory to search in
2262 * @name: qstr of name we wish to find
2263 *
4f522a24 2264 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
3e7e241f
EB
2265 */
2266struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2267{
3e7e241f
EB
2268 /*
2269 * Check for a fs-specific hash function. Note that we must
2270 * calculate the standard hash first, as the d_op->d_hash()
2271 * routine may choose to leave the hash value unchanged.
2272 */
2273 name->hash = full_name_hash(name->name, name->len);
fb045adb 2274 if (dir->d_flags & DCACHE_OP_HASH) {
da53be12 2275 int err = dir->d_op->d_hash(dir, name);
4f522a24
AV
2276 if (unlikely(err < 0))
2277 return ERR_PTR(err);
3e7e241f 2278 }
4f522a24 2279 return d_lookup(dir, name);
3e7e241f 2280}
4f522a24 2281EXPORT_SYMBOL(d_hash_and_lookup);
3e7e241f 2282
1da177e4
LT
2283/*
2284 * When a file is deleted, we have two options:
2285 * - turn this dentry into a negative dentry
2286 * - unhash this dentry and free it.
2287 *
2288 * Usually, we want to just turn this into
2289 * a negative dentry, but if anybody else is
2290 * currently using the dentry or the inode
2291 * we can't do that and we fall back on removing
2292 * it from the hash queues and waiting for
2293 * it to be deleted later when it has no users
2294 */
2295
2296/**
2297 * d_delete - delete a dentry
2298 * @dentry: The dentry to delete
2299 *
2300 * Turn the dentry into a negative dentry if possible, otherwise
2301 * remove it from the hash queues so it can be deleted later
2302 */
2303
2304void d_delete(struct dentry * dentry)
2305{
873feea0 2306 struct inode *inode;
7a91bf7f 2307 int isdir = 0;
1da177e4
LT
2308 /*
2309 * Are we the only user?
2310 */
357f8e65 2311again:
1da177e4 2312 spin_lock(&dentry->d_lock);
873feea0
NP
2313 inode = dentry->d_inode;
2314 isdir = S_ISDIR(inode->i_mode);
98474236 2315 if (dentry->d_lockref.count == 1) {
1fe0c023 2316 if (!spin_trylock(&inode->i_lock)) {
357f8e65
NP
2317 spin_unlock(&dentry->d_lock);
2318 cpu_relax();
2319 goto again;
2320 }
13e3c5e5 2321 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
31e6b01f 2322 dentry_unlink_inode(dentry);
7a91bf7f 2323 fsnotify_nameremove(dentry, isdir);
1da177e4
LT
2324 return;
2325 }
2326
2327 if (!d_unhashed(dentry))
2328 __d_drop(dentry);
2329
2330 spin_unlock(&dentry->d_lock);
7a91bf7f
JM
2331
2332 fsnotify_nameremove(dentry, isdir);
1da177e4 2333}
ec4f8605 2334EXPORT_SYMBOL(d_delete);
1da177e4 2335
b07ad996 2336static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
1da177e4 2337{
ceb5bdc2 2338 BUG_ON(!d_unhashed(entry));
1879fd6a 2339 hlist_bl_lock(b);
dea3667b 2340 entry->d_flags |= DCACHE_RCUACCESS;
b07ad996 2341 hlist_bl_add_head_rcu(&entry->d_hash, b);
1879fd6a 2342 hlist_bl_unlock(b);
1da177e4
LT
2343}
2344
770bfad8
DH
2345static void _d_rehash(struct dentry * entry)
2346{
2347 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2348}
2349
1da177e4
LT
2350/**
2351 * d_rehash - add an entry back to the hash
2352 * @entry: dentry to add to the hash
2353 *
2354 * Adds a dentry to the hash according to its name.
2355 */
2356
2357void d_rehash(struct dentry * entry)
2358{
1da177e4 2359 spin_lock(&entry->d_lock);
770bfad8 2360 _d_rehash(entry);
1da177e4 2361 spin_unlock(&entry->d_lock);
1da177e4 2362}
ec4f8605 2363EXPORT_SYMBOL(d_rehash);
1da177e4 2364
34d0d19d
AV
2365/**
2366 * d_add - add dentry to hash queues
2367 * @entry: dentry to add
2368 * @inode: The inode to attach to this dentry
2369 *
2370 * This adds the entry to the hash queues and initializes @inode.
2371 * The entry was actually filled in earlier during d_alloc().
2372 */
2373
2374void d_add(struct dentry *entry, struct inode *inode)
2375{
2376 d_instantiate(entry, inode);
2377 d_rehash(entry);
2378}
2379EXPORT_SYMBOL(d_add);
2380
668d0cd5
AV
2381/**
2382 * d_exact_alias - find and hash an exact unhashed alias
2383 * @entry: dentry to add
2384 * @inode: The inode to go with this dentry
2385 *
2386 * If an unhashed dentry with the same name/parent and desired
2387 * inode already exists, hash and return it. Otherwise, return
2388 * NULL.
2389 *
2390 * Parent directory should be locked.
2391 */
2392struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2393{
2394 struct dentry *alias;
2395 int len = entry->d_name.len;
2396 const char *name = entry->d_name.name;
2397 unsigned int hash = entry->d_name.hash;
2398
2399 spin_lock(&inode->i_lock);
2400 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2401 /*
2402 * Don't need alias->d_lock here, because aliases with
2403 * d_parent == entry->d_parent are not subject to name or
2404 * parent changes, because the parent inode i_mutex is held.
2405 */
2406 if (alias->d_name.hash != hash)
2407 continue;
2408 if (alias->d_parent != entry->d_parent)
2409 continue;
2410 if (alias->d_name.len != len)
2411 continue;
2412 if (dentry_cmp(alias, name, len))
2413 continue;
2414 spin_lock(&alias->d_lock);
2415 if (!d_unhashed(alias)) {
2416 spin_unlock(&alias->d_lock);
2417 alias = NULL;
2418 } else {
2419 __dget_dlock(alias);
2420 _d_rehash(alias);
2421 spin_unlock(&alias->d_lock);
2422 }
2423 spin_unlock(&inode->i_lock);
2424 return alias;
2425 }
2426 spin_unlock(&inode->i_lock);
2427 return NULL;
2428}
2429EXPORT_SYMBOL(d_exact_alias);
2430
fb2d5b86
NP
2431/**
2432 * dentry_update_name_case - update case insensitive dentry with a new name
2433 * @dentry: dentry to be updated
2434 * @name: new name
2435 *
2436 * Update a case insensitive dentry with new case of name.
2437 *
2438 * dentry must have been returned by d_lookup with name @name. Old and new
2439 * name lengths must match (ie. no d_compare which allows mismatched name
2440 * lengths).
2441 *
2442 * Parent inode i_mutex must be held over d_lookup and into this call (to
2443 * keep renames and concurrent inserts, and readdir(2) away).
2444 */
2445void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2446{
5955102c 2447 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
fb2d5b86
NP
2448 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2449
fb2d5b86 2450 spin_lock(&dentry->d_lock);
31e6b01f 2451 write_seqcount_begin(&dentry->d_seq);
fb2d5b86 2452 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
31e6b01f 2453 write_seqcount_end(&dentry->d_seq);
fb2d5b86 2454 spin_unlock(&dentry->d_lock);
fb2d5b86
NP
2455}
2456EXPORT_SYMBOL(dentry_update_name_case);
2457
8d85b484 2458static void swap_names(struct dentry *dentry, struct dentry *target)
1da177e4 2459{
8d85b484
AV
2460 if (unlikely(dname_external(target))) {
2461 if (unlikely(dname_external(dentry))) {
1da177e4
LT
2462 /*
2463 * Both external: swap the pointers
2464 */
9a8d5bb4 2465 swap(target->d_name.name, dentry->d_name.name);
1da177e4
LT
2466 } else {
2467 /*
2468 * dentry:internal, target:external. Steal target's
2469 * storage and make target internal.
2470 */
321bcf92
BF
2471 memcpy(target->d_iname, dentry->d_name.name,
2472 dentry->d_name.len + 1);
1da177e4
LT
2473 dentry->d_name.name = target->d_name.name;
2474 target->d_name.name = target->d_iname;
2475 }
2476 } else {
8d85b484 2477 if (unlikely(dname_external(dentry))) {
1da177e4
LT
2478 /*
2479 * dentry:external, target:internal. Give dentry's
2480 * storage to target and make dentry internal
2481 */
2482 memcpy(dentry->d_iname, target->d_name.name,
2483 target->d_name.len + 1);
2484 target->d_name.name = dentry->d_name.name;
2485 dentry->d_name.name = dentry->d_iname;
2486 } else {
2487 /*
da1ce067 2488 * Both are internal.
1da177e4 2489 */
da1ce067
MS
2490 unsigned int i;
2491 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
08d4f772
MP
2492 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2493 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
da1ce067
MS
2494 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2495 swap(((long *) &dentry->d_iname)[i],
2496 ((long *) &target->d_iname)[i]);
2497 }
1da177e4
LT
2498 }
2499 }
a28ddb87 2500 swap(dentry->d_name.hash_len, target->d_name.hash_len);
1da177e4
LT
2501}
2502
8d85b484
AV
2503static void copy_name(struct dentry *dentry, struct dentry *target)
2504{
2505 struct external_name *old_name = NULL;
2506 if (unlikely(dname_external(dentry)))
2507 old_name = external_name(dentry);
2508 if (unlikely(dname_external(target))) {
2509 atomic_inc(&external_name(target)->u.count);
2510 dentry->d_name = target->d_name;
2511 } else {
2512 memcpy(dentry->d_iname, target->d_name.name,
2513 target->d_name.len + 1);
2514 dentry->d_name.name = dentry->d_iname;
2515 dentry->d_name.hash_len = target->d_name.hash_len;
2516 }
2517 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2518 kfree_rcu(old_name, u.head);
2519}
2520
2fd6b7f5
NP
2521static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2522{
2523 /*
2524 * XXXX: do we really need to take target->d_lock?
2525 */
2526 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2527 spin_lock(&target->d_parent->d_lock);
2528 else {
2529 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2530 spin_lock(&dentry->d_parent->d_lock);
2531 spin_lock_nested(&target->d_parent->d_lock,
2532 DENTRY_D_LOCK_NESTED);
2533 } else {
2534 spin_lock(&target->d_parent->d_lock);
2535 spin_lock_nested(&dentry->d_parent->d_lock,
2536 DENTRY_D_LOCK_NESTED);
2537 }
2538 }
2539 if (target < dentry) {
2540 spin_lock_nested(&target->d_lock, 2);
2541 spin_lock_nested(&dentry->d_lock, 3);
2542 } else {
2543 spin_lock_nested(&dentry->d_lock, 2);
2544 spin_lock_nested(&target->d_lock, 3);
2545 }
2546}
2547
986c0194 2548static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
2fd6b7f5
NP
2549{
2550 if (target->d_parent != dentry->d_parent)
2551 spin_unlock(&dentry->d_parent->d_lock);
2552 if (target->d_parent != target)
2553 spin_unlock(&target->d_parent->d_lock);
986c0194
AV
2554 spin_unlock(&target->d_lock);
2555 spin_unlock(&dentry->d_lock);
2fd6b7f5
NP
2556}
2557
1da177e4 2558/*
2fd6b7f5
NP
2559 * When switching names, the actual string doesn't strictly have to
2560 * be preserved in the target - because we're dropping the target
2561 * anyway. As such, we can just do a simple memcpy() to copy over
d2fa4a84
ME
2562 * the new name before we switch, unless we are going to rehash
2563 * it. Note that if we *do* unhash the target, we are not allowed
2564 * to rehash it without giving it a new name/hash key - whether
2565 * we swap or overwrite the names here, resulting name won't match
2566 * the reality in filesystem; it's only there for d_path() purposes.
2567 * Note that all of this is happening under rename_lock, so the
2568 * any hash lookup seeing it in the middle of manipulations will
2569 * be discarded anyway. So we do not care what happens to the hash
2570 * key in that case.
1da177e4 2571 */
9eaef27b 2572/*
18367501 2573 * __d_move - move a dentry
1da177e4
LT
2574 * @dentry: entry to move
2575 * @target: new dentry
da1ce067 2576 * @exchange: exchange the two dentries
1da177e4
LT
2577 *
2578 * Update the dcache to reflect the move of a file name. Negative
c46c8877
JL
2579 * dcache entries should not be moved in this way. Caller must hold
2580 * rename_lock, the i_mutex of the source and target directories,
2581 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
1da177e4 2582 */
da1ce067
MS
2583static void __d_move(struct dentry *dentry, struct dentry *target,
2584 bool exchange)
1da177e4 2585{
1da177e4
LT
2586 if (!dentry->d_inode)
2587 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2588
2fd6b7f5
NP
2589 BUG_ON(d_ancestor(dentry, target));
2590 BUG_ON(d_ancestor(target, dentry));
2591
2fd6b7f5 2592 dentry_lock_for_move(dentry, target);
1da177e4 2593
31e6b01f 2594 write_seqcount_begin(&dentry->d_seq);
1ca7d67c 2595 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
31e6b01f 2596
ceb5bdc2
NP
2597 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2598
2599 /*
2600 * Move the dentry to the target hash queue. Don't bother checking
2601 * for the same hash queue because of how unlikely it is.
2602 */
2603 __d_drop(dentry);
789680d1 2604 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
1da177e4 2605
da1ce067
MS
2606 /*
2607 * Unhash the target (d_delete() is not usable here). If exchanging
2608 * the two dentries, then rehash onto the other's hash queue.
2609 */
1da177e4 2610 __d_drop(target);
da1ce067
MS
2611 if (exchange) {
2612 __d_rehash(target,
2613 d_hash(dentry->d_parent, dentry->d_name.hash));
2614 }
1da177e4 2615
1da177e4 2616 /* Switch the names.. */
8d85b484
AV
2617 if (exchange)
2618 swap_names(dentry, target);
2619 else
2620 copy_name(dentry, target);
1da177e4 2621
63cf427a 2622 /* ... and switch them in the tree */
1da177e4 2623 if (IS_ROOT(dentry)) {
63cf427a 2624 /* splicing a tree */
1da177e4
LT
2625 dentry->d_parent = target->d_parent;
2626 target->d_parent = target;
946e51f2
AV
2627 list_del_init(&target->d_child);
2628 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
1da177e4 2629 } else {
63cf427a 2630 /* swapping two dentries */
9a8d5bb4 2631 swap(dentry->d_parent, target->d_parent);
946e51f2
AV
2632 list_move(&target->d_child, &target->d_parent->d_subdirs);
2633 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
63cf427a
AV
2634 if (exchange)
2635 fsnotify_d_move(target);
2636 fsnotify_d_move(dentry);
1da177e4
LT
2637 }
2638
31e6b01f
NP
2639 write_seqcount_end(&target->d_seq);
2640 write_seqcount_end(&dentry->d_seq);
2641
986c0194 2642 dentry_unlock_for_move(dentry, target);
18367501
AV
2643}
2644
2645/*
2646 * d_move - move a dentry
2647 * @dentry: entry to move
2648 * @target: new dentry
2649 *
2650 * Update the dcache to reflect the move of a file name. Negative
c46c8877
JL
2651 * dcache entries should not be moved in this way. See the locking
2652 * requirements for __d_move.
18367501
AV
2653 */
2654void d_move(struct dentry *dentry, struct dentry *target)
2655{
2656 write_seqlock(&rename_lock);
da1ce067 2657 __d_move(dentry, target, false);
1da177e4 2658 write_sequnlock(&rename_lock);
9eaef27b 2659}
ec4f8605 2660EXPORT_SYMBOL(d_move);
1da177e4 2661
da1ce067
MS
2662/*
2663 * d_exchange - exchange two dentries
2664 * @dentry1: first dentry
2665 * @dentry2: second dentry
2666 */
2667void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2668{
2669 write_seqlock(&rename_lock);
2670
2671 WARN_ON(!dentry1->d_inode);
2672 WARN_ON(!dentry2->d_inode);
2673 WARN_ON(IS_ROOT(dentry1));
2674 WARN_ON(IS_ROOT(dentry2));
2675
2676 __d_move(dentry1, dentry2, true);
2677
2678 write_sequnlock(&rename_lock);
2679}
2680
e2761a11
OH
2681/**
2682 * d_ancestor - search for an ancestor
2683 * @p1: ancestor dentry
2684 * @p2: child dentry
2685 *
2686 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2687 * an ancestor of p2, else NULL.
9eaef27b 2688 */
e2761a11 2689struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
9eaef27b
TM
2690{
2691 struct dentry *p;
2692
871c0067 2693 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
9eaef27b 2694 if (p->d_parent == p1)
e2761a11 2695 return p;
9eaef27b 2696 }
e2761a11 2697 return NULL;
9eaef27b
TM
2698}
2699
2700/*
2701 * This helper attempts to cope with remotely renamed directories
2702 *
2703 * It assumes that the caller is already holding
a03e283b 2704 * dentry->d_parent->d_inode->i_mutex, and rename_lock
9eaef27b
TM
2705 *
2706 * Note: If ever the locking in lock_rename() changes, then please
2707 * remember to update this too...
9eaef27b 2708 */
b5ae6b15 2709static int __d_unalias(struct inode *inode,
873feea0 2710 struct dentry *dentry, struct dentry *alias)
9eaef27b
TM
2711{
2712 struct mutex *m1 = NULL, *m2 = NULL;
3d330dc1 2713 int ret = -ESTALE;
9eaef27b
TM
2714
2715 /* If alias and dentry share a parent, then no extra locks required */
2716 if (alias->d_parent == dentry->d_parent)
2717 goto out_unalias;
2718
9eaef27b 2719 /* See lock_rename() */
9eaef27b
TM
2720 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2721 goto out_err;
2722 m1 = &dentry->d_sb->s_vfs_rename_mutex;
5955102c 2723 if (!inode_trylock(alias->d_parent->d_inode))
9eaef27b
TM
2724 goto out_err;
2725 m2 = &alias->d_parent->d_inode->i_mutex;
2726out_unalias:
8ed936b5 2727 __d_move(alias, dentry, false);
b5ae6b15 2728 ret = 0;
9eaef27b 2729out_err:
9eaef27b
TM
2730 if (m2)
2731 mutex_unlock(m2);
2732 if (m1)
2733 mutex_unlock(m1);
2734 return ret;
2735}
2736
3f70bd51
BF
2737/**
2738 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2739 * @inode: the inode which may have a disconnected dentry
2740 * @dentry: a negative dentry which we want to point to the inode.
2741 *
da093a9b
BF
2742 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2743 * place of the given dentry and return it, else simply d_add the inode
2744 * to the dentry and return NULL.
3f70bd51 2745 *
908790fa
BF
2746 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2747 * we should error out: directories can't have multiple aliases.
2748 *
3f70bd51
BF
2749 * This is needed in the lookup routine of any filesystem that is exportable
2750 * (via knfsd) so that we can build dcache paths to directories effectively.
2751 *
2752 * If a dentry was found and moved, then it is returned. Otherwise NULL
2753 * is returned. This matches the expected return value of ->lookup.
2754 *
2755 * Cluster filesystems may call this function with a negative, hashed dentry.
2756 * In that case, we know that the inode will be a regular file, and also this
2757 * will only occur during atomic_open. So we need to check for the dentry
2758 * being already hashed only in the final case.
2759 */
2760struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2761{
3f70bd51
BF
2762 if (IS_ERR(inode))
2763 return ERR_CAST(inode);
2764
770bfad8
DH
2765 BUG_ON(!d_unhashed(dentry));
2766
770bfad8 2767 if (!inode) {
360da900 2768 __d_instantiate(dentry, NULL);
b5ae6b15 2769 goto out;
770bfad8 2770 }
873feea0 2771 spin_lock(&inode->i_lock);
9eaef27b 2772 if (S_ISDIR(inode->i_mode)) {
b5ae6b15
AV
2773 struct dentry *new = __d_find_any_alias(inode);
2774 if (unlikely(new)) {
a03e283b
EB
2775 /* The reference to new ensures it remains an alias */
2776 spin_unlock(&inode->i_lock);
18367501 2777 write_seqlock(&rename_lock);
b5ae6b15
AV
2778 if (unlikely(d_ancestor(new, dentry))) {
2779 write_sequnlock(&rename_lock);
b5ae6b15
AV
2780 dput(new);
2781 new = ERR_PTR(-ELOOP);
2782 pr_warn_ratelimited(
2783 "VFS: Lookup of '%s' in %s %s"
2784 " would have caused loop\n",
2785 dentry->d_name.name,
2786 inode->i_sb->s_type->name,
2787 inode->i_sb->s_id);
2788 } else if (!IS_ROOT(new)) {
2789 int err = __d_unalias(inode, dentry, new);
18367501 2790 write_sequnlock(&rename_lock);
b5ae6b15
AV
2791 if (err) {
2792 dput(new);
2793 new = ERR_PTR(err);
2794 }
18367501 2795 } else {
b5ae6b15
AV
2796 __d_move(new, dentry, false);
2797 write_sequnlock(&rename_lock);
b5ae6b15 2798 security_d_instantiate(new, inode);
dd179946 2799 }
b5ae6b15
AV
2800 iput(inode);
2801 return new;
9eaef27b 2802 }
770bfad8 2803 }
b5ae6b15
AV
2804 /* already taking inode->i_lock, so d_add() by hand */
2805 __d_instantiate(dentry, inode);
873feea0 2806 spin_unlock(&inode->i_lock);
b5ae6b15
AV
2807out:
2808 security_d_instantiate(dentry, inode);
2809 d_rehash(dentry);
2810 return NULL;
770bfad8 2811}
b5ae6b15 2812EXPORT_SYMBOL(d_splice_alias);
770bfad8 2813
cdd16d02 2814static int prepend(char **buffer, int *buflen, const char *str, int namelen)
6092d048
RP
2815{
2816 *buflen -= namelen;
2817 if (*buflen < 0)
2818 return -ENAMETOOLONG;
2819 *buffer -= namelen;
2820 memcpy(*buffer, str, namelen);
2821 return 0;
2822}
2823
232d2d60
WL
2824/**
2825 * prepend_name - prepend a pathname in front of current buffer pointer
18129977
WL
2826 * @buffer: buffer pointer
2827 * @buflen: allocated length of the buffer
2828 * @name: name string and length qstr structure
232d2d60
WL
2829 *
2830 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2831 * make sure that either the old or the new name pointer and length are
2832 * fetched. However, there may be mismatch between length and pointer.
2833 * The length cannot be trusted, we need to copy it byte-by-byte until
2834 * the length is reached or a null byte is found. It also prepends "/" at
2835 * the beginning of the name. The sequence number check at the caller will
2836 * retry it again when a d_move() does happen. So any garbage in the buffer
2837 * due to mismatched pointer and length will be discarded.
6d13f694
AV
2838 *
2839 * Data dependency barrier is needed to make sure that we see that terminating
2840 * NUL. Alpha strikes again, film at 11...
232d2d60 2841 */
cdd16d02
MS
2842static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2843{
232d2d60
WL
2844 const char *dname = ACCESS_ONCE(name->name);
2845 u32 dlen = ACCESS_ONCE(name->len);
2846 char *p;
2847
6d13f694
AV
2848 smp_read_barrier_depends();
2849
232d2d60 2850 *buflen -= dlen + 1;
e825196d
AV
2851 if (*buflen < 0)
2852 return -ENAMETOOLONG;
232d2d60
WL
2853 p = *buffer -= dlen + 1;
2854 *p++ = '/';
2855 while (dlen--) {
2856 char c = *dname++;
2857 if (!c)
2858 break;
2859 *p++ = c;
2860 }
2861 return 0;
cdd16d02
MS
2862}
2863
1da177e4 2864/**
208898c1 2865 * prepend_path - Prepend path string to a buffer
9d1bc601 2866 * @path: the dentry/vfsmount to report
02125a82 2867 * @root: root vfsmnt/dentry
f2eb6575
MS
2868 * @buffer: pointer to the end of the buffer
2869 * @buflen: pointer to buffer length
552ce544 2870 *
18129977
WL
2871 * The function will first try to write out the pathname without taking any
2872 * lock other than the RCU read lock to make sure that dentries won't go away.
2873 * It only checks the sequence number of the global rename_lock as any change
2874 * in the dentry's d_seq will be preceded by changes in the rename_lock
2875 * sequence number. If the sequence number had been changed, it will restart
2876 * the whole pathname back-tracing sequence again by taking the rename_lock.
2877 * In this case, there is no need to take the RCU read lock as the recursive
2878 * parent pointer references will keep the dentry chain alive as long as no
2879 * rename operation is performed.
1da177e4 2880 */
02125a82
AV
2881static int prepend_path(const struct path *path,
2882 const struct path *root,
f2eb6575 2883 char **buffer, int *buflen)
1da177e4 2884{
ede4cebc
AV
2885 struct dentry *dentry;
2886 struct vfsmount *vfsmnt;
2887 struct mount *mnt;
f2eb6575 2888 int error = 0;
48a066e7 2889 unsigned seq, m_seq = 0;
232d2d60
WL
2890 char *bptr;
2891 int blen;
6092d048 2892
48f5ec21 2893 rcu_read_lock();
48a066e7
AV
2894restart_mnt:
2895 read_seqbegin_or_lock(&mount_lock, &m_seq);
2896 seq = 0;
4ec6c2ae 2897 rcu_read_lock();
232d2d60
WL
2898restart:
2899 bptr = *buffer;
2900 blen = *buflen;
48a066e7 2901 error = 0;
ede4cebc
AV
2902 dentry = path->dentry;
2903 vfsmnt = path->mnt;
2904 mnt = real_mount(vfsmnt);
232d2d60 2905 read_seqbegin_or_lock(&rename_lock, &seq);
f2eb6575 2906 while (dentry != root->dentry || vfsmnt != root->mnt) {
1da177e4
LT
2907 struct dentry * parent;
2908
1da177e4 2909 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
48a066e7 2910 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
cde93be4
EB
2911 /* Escaped? */
2912 if (dentry != vfsmnt->mnt_root) {
2913 bptr = *buffer;
2914 blen = *buflen;
2915 error = 3;
2916 break;
2917 }
552ce544 2918 /* Global root? */
48a066e7
AV
2919 if (mnt != parent) {
2920 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
2921 mnt = parent;
232d2d60
WL
2922 vfsmnt = &mnt->mnt;
2923 continue;
2924 }
232d2d60
WL
2925 if (!error)
2926 error = is_mounted(vfsmnt) ? 1 : 2;
2927 break;
1da177e4
LT
2928 }
2929 parent = dentry->d_parent;
2930 prefetch(parent);
232d2d60 2931 error = prepend_name(&bptr, &blen, &dentry->d_name);
f2eb6575
MS
2932 if (error)
2933 break;
2934
1da177e4
LT
2935 dentry = parent;
2936 }
48f5ec21
AV
2937 if (!(seq & 1))
2938 rcu_read_unlock();
2939 if (need_seqretry(&rename_lock, seq)) {
2940 seq = 1;
232d2d60 2941 goto restart;
48f5ec21
AV
2942 }
2943 done_seqretry(&rename_lock, seq);
4ec6c2ae
LZ
2944
2945 if (!(m_seq & 1))
2946 rcu_read_unlock();
48a066e7
AV
2947 if (need_seqretry(&mount_lock, m_seq)) {
2948 m_seq = 1;
2949 goto restart_mnt;
2950 }
2951 done_seqretry(&mount_lock, m_seq);
1da177e4 2952
232d2d60
WL
2953 if (error >= 0 && bptr == *buffer) {
2954 if (--blen < 0)
2955 error = -ENAMETOOLONG;
2956 else
2957 *--bptr = '/';
2958 }
2959 *buffer = bptr;
2960 *buflen = blen;
7ea600b5 2961 return error;
f2eb6575 2962}
be285c71 2963
f2eb6575
MS
2964/**
2965 * __d_path - return the path of a dentry
2966 * @path: the dentry/vfsmount to report
02125a82 2967 * @root: root vfsmnt/dentry
cd956a1c 2968 * @buf: buffer to return value in
f2eb6575
MS
2969 * @buflen: buffer length
2970 *
ffd1f4ed 2971 * Convert a dentry into an ASCII path name.
f2eb6575
MS
2972 *
2973 * Returns a pointer into the buffer or an error code if the
2974 * path was too long.
2975 *
be148247 2976 * "buflen" should be positive.
f2eb6575 2977 *
02125a82 2978 * If the path is not reachable from the supplied root, return %NULL.
f2eb6575 2979 */
02125a82
AV
2980char *__d_path(const struct path *path,
2981 const struct path *root,
f2eb6575
MS
2982 char *buf, int buflen)
2983{
2984 char *res = buf + buflen;
2985 int error;
2986
2987 prepend(&res, &buflen, "\0", 1);
f2eb6575 2988 error = prepend_path(path, root, &res, &buflen);
be148247 2989
02125a82
AV
2990 if (error < 0)
2991 return ERR_PTR(error);
2992 if (error > 0)
2993 return NULL;
2994 return res;
2995}
2996
2997char *d_absolute_path(const struct path *path,
2998 char *buf, int buflen)
2999{
3000 struct path root = {};
3001 char *res = buf + buflen;
3002 int error;
3003
3004 prepend(&res, &buflen, "\0", 1);
02125a82 3005 error = prepend_path(path, &root, &res, &buflen);
02125a82
AV
3006
3007 if (error > 1)
3008 error = -EINVAL;
3009 if (error < 0)
f2eb6575 3010 return ERR_PTR(error);
f2eb6575 3011 return res;
1da177e4
LT
3012}
3013
ffd1f4ed
MS
3014/*
3015 * same as __d_path but appends "(deleted)" for unlinked files.
3016 */
02125a82
AV
3017static int path_with_deleted(const struct path *path,
3018 const struct path *root,
3019 char **buf, int *buflen)
ffd1f4ed
MS
3020{
3021 prepend(buf, buflen, "\0", 1);
3022 if (d_unlinked(path->dentry)) {
3023 int error = prepend(buf, buflen, " (deleted)", 10);
3024 if (error)
3025 return error;
3026 }
3027
3028 return prepend_path(path, root, buf, buflen);
3029}
3030
8df9d1a4
MS
3031static int prepend_unreachable(char **buffer, int *buflen)
3032{
3033 return prepend(buffer, buflen, "(unreachable)", 13);
3034}
3035
68f0d9d9
LT
3036static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3037{
3038 unsigned seq;
3039
3040 do {
3041 seq = read_seqcount_begin(&fs->seq);
3042 *root = fs->root;
3043 } while (read_seqcount_retry(&fs->seq, seq));
3044}
3045
a03a8a70
JB
3046/**
3047 * d_path - return the path of a dentry
cf28b486 3048 * @path: path to report
a03a8a70
JB
3049 * @buf: buffer to return value in
3050 * @buflen: buffer length
3051 *
3052 * Convert a dentry into an ASCII path name. If the entry has been deleted
3053 * the string " (deleted)" is appended. Note that this is ambiguous.
3054 *
52afeefb
AV
3055 * Returns a pointer into the buffer or an error code if the path was
3056 * too long. Note: Callers should use the returned pointer, not the passed
3057 * in buffer, to use the name! The implementation often starts at an offset
3058 * into the buffer, and may leave 0 bytes at the start.
a03a8a70 3059 *
31f3e0b3 3060 * "buflen" should be positive.
a03a8a70 3061 */
20d4fdc1 3062char *d_path(const struct path *path, char *buf, int buflen)
1da177e4 3063{
ffd1f4ed 3064 char *res = buf + buflen;
6ac08c39 3065 struct path root;
ffd1f4ed 3066 int error;
1da177e4 3067
c23fbb6b
ED
3068 /*
3069 * We have various synthetic filesystems that never get mounted. On
3070 * these filesystems dentries are never used for lookup purposes, and
3071 * thus don't need to be hashed. They also don't need a name until a
3072 * user wants to identify the object in /proc/pid/fd/. The little hack
3073 * below allows us to generate a name for these objects on demand:
f48cfddc
EB
3074 *
3075 * Some pseudo inodes are mountable. When they are mounted
3076 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3077 * and instead have d_path return the mounted path.
c23fbb6b 3078 */
f48cfddc
EB
3079 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3080 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
cf28b486 3081 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
c23fbb6b 3082
68f0d9d9
LT
3083 rcu_read_lock();
3084 get_fs_root_rcu(current->fs, &root);
02125a82 3085 error = path_with_deleted(path, &root, &res, &buflen);
68f0d9d9
LT
3086 rcu_read_unlock();
3087
02125a82 3088 if (error < 0)
ffd1f4ed 3089 res = ERR_PTR(error);
1da177e4
LT
3090 return res;
3091}
ec4f8605 3092EXPORT_SYMBOL(d_path);
1da177e4 3093
c23fbb6b
ED
3094/*
3095 * Helper function for dentry_operations.d_dname() members
3096 */
3097char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3098 const char *fmt, ...)
3099{
3100 va_list args;
3101 char temp[64];
3102 int sz;
3103
3104 va_start(args, fmt);
3105 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3106 va_end(args);
3107
3108 if (sz > sizeof(temp) || sz > buflen)
3109 return ERR_PTR(-ENAMETOOLONG);
3110
3111 buffer += buflen - sz;
3112 return memcpy(buffer, temp, sz);
3113}
3114
118b2302
AV
3115char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3116{
3117 char *end = buffer + buflen;
3118 /* these dentries are never renamed, so d_lock is not needed */
3119 if (prepend(&end, &buflen, " (deleted)", 11) ||
232d2d60 3120 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
118b2302
AV
3121 prepend(&end, &buflen, "/", 1))
3122 end = ERR_PTR(-ENAMETOOLONG);
232d2d60 3123 return end;
118b2302 3124}
31bbe16f 3125EXPORT_SYMBOL(simple_dname);
118b2302 3126
6092d048
RP
3127/*
3128 * Write full pathname from the root of the filesystem into the buffer.
3129 */
f6500801 3130static char *__dentry_path(struct dentry *d, char *buf, int buflen)
6092d048 3131{
f6500801 3132 struct dentry *dentry;
232d2d60
WL
3133 char *end, *retval;
3134 int len, seq = 0;
3135 int error = 0;
6092d048 3136
f6500801
AV
3137 if (buflen < 2)
3138 goto Elong;
3139
48f5ec21 3140 rcu_read_lock();
232d2d60 3141restart:
f6500801 3142 dentry = d;
232d2d60
WL
3143 end = buf + buflen;
3144 len = buflen;
3145 prepend(&end, &len, "\0", 1);
6092d048
RP
3146 /* Get '/' right */
3147 retval = end-1;
3148 *retval = '/';
232d2d60 3149 read_seqbegin_or_lock(&rename_lock, &seq);
cdd16d02
MS
3150 while (!IS_ROOT(dentry)) {
3151 struct dentry *parent = dentry->d_parent;
6092d048 3152
6092d048 3153 prefetch(parent);
232d2d60
WL
3154 error = prepend_name(&end, &len, &dentry->d_name);
3155 if (error)
3156 break;
6092d048
RP
3157
3158 retval = end;
3159 dentry = parent;
3160 }
48f5ec21
AV
3161 if (!(seq & 1))
3162 rcu_read_unlock();
3163 if (need_seqretry(&rename_lock, seq)) {
3164 seq = 1;
232d2d60 3165 goto restart;
48f5ec21
AV
3166 }
3167 done_seqretry(&rename_lock, seq);
232d2d60
WL
3168 if (error)
3169 goto Elong;
c103135c
AV
3170 return retval;
3171Elong:
3172 return ERR_PTR(-ENAMETOOLONG);
3173}
ec2447c2
NP
3174
3175char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3176{
232d2d60 3177 return __dentry_path(dentry, buf, buflen);
ec2447c2
NP
3178}
3179EXPORT_SYMBOL(dentry_path_raw);
c103135c
AV
3180
3181char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3182{
3183 char *p = NULL;
3184 char *retval;
3185
c103135c
AV
3186 if (d_unlinked(dentry)) {
3187 p = buf + buflen;
3188 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3189 goto Elong;
3190 buflen++;
3191 }
3192 retval = __dentry_path(dentry, buf, buflen);
c103135c
AV
3193 if (!IS_ERR(retval) && p)
3194 *p = '/'; /* restore '/' overriden with '\0' */
6092d048
RP
3195 return retval;
3196Elong:
6092d048
RP
3197 return ERR_PTR(-ENAMETOOLONG);
3198}
3199
8b19e341
LT
3200static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3201 struct path *pwd)
5762482f 3202{
8b19e341
LT
3203 unsigned seq;
3204
3205 do {
3206 seq = read_seqcount_begin(&fs->seq);
3207 *root = fs->root;
3208 *pwd = fs->pwd;
3209 } while (read_seqcount_retry(&fs->seq, seq));
5762482f
LT
3210}
3211
1da177e4
LT
3212/*
3213 * NOTE! The user-level library version returns a
3214 * character pointer. The kernel system call just
3215 * returns the length of the buffer filled (which
3216 * includes the ending '\0' character), or a negative
3217 * error value. So libc would do something like
3218 *
3219 * char *getcwd(char * buf, size_t size)
3220 * {
3221 * int retval;
3222 *
3223 * retval = sys_getcwd(buf, size);
3224 * if (retval >= 0)
3225 * return buf;
3226 * errno = -retval;
3227 * return NULL;
3228 * }
3229 */
3cdad428 3230SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
1da177e4 3231{
552ce544 3232 int error;
6ac08c39 3233 struct path pwd, root;
3272c544 3234 char *page = __getname();
1da177e4
LT
3235
3236 if (!page)
3237 return -ENOMEM;
3238
8b19e341
LT
3239 rcu_read_lock();
3240 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
1da177e4 3241
552ce544 3242 error = -ENOENT;
f3da392e 3243 if (!d_unlinked(pwd.dentry)) {
552ce544 3244 unsigned long len;
3272c544
LT
3245 char *cwd = page + PATH_MAX;
3246 int buflen = PATH_MAX;
1da177e4 3247
8df9d1a4 3248 prepend(&cwd, &buflen, "\0", 1);
02125a82 3249 error = prepend_path(&pwd, &root, &cwd, &buflen);
ff812d72 3250 rcu_read_unlock();
552ce544 3251
02125a82 3252 if (error < 0)
552ce544
LT
3253 goto out;
3254
8df9d1a4 3255 /* Unreachable from current root */
02125a82 3256 if (error > 0) {
8df9d1a4
MS
3257 error = prepend_unreachable(&cwd, &buflen);
3258 if (error)
3259 goto out;
3260 }
3261
552ce544 3262 error = -ERANGE;
3272c544 3263 len = PATH_MAX + page - cwd;
552ce544
LT
3264 if (len <= size) {
3265 error = len;
3266 if (copy_to_user(buf, cwd, len))
3267 error = -EFAULT;
3268 }
949854d0 3269 } else {
ff812d72 3270 rcu_read_unlock();
949854d0 3271 }
1da177e4
LT
3272
3273out:
3272c544 3274 __putname(page);
1da177e4
LT
3275 return error;
3276}
3277
3278/*
3279 * Test whether new_dentry is a subdirectory of old_dentry.
3280 *
3281 * Trivially implemented using the dcache structure
3282 */
3283
3284/**
3285 * is_subdir - is new dentry a subdirectory of old_dentry
3286 * @new_dentry: new dentry
3287 * @old_dentry: old dentry
3288 *
a6e5787f
YB
3289 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3290 * Returns false otherwise.
1da177e4
LT
3291 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3292 */
3293
a6e5787f 3294bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
1da177e4 3295{
a6e5787f 3296 bool result;
949854d0 3297 unsigned seq;
1da177e4 3298
e2761a11 3299 if (new_dentry == old_dentry)
a6e5787f 3300 return true;
e2761a11 3301
e2761a11 3302 do {
1da177e4 3303 /* for restarting inner loop in case of seq retry */
1da177e4 3304 seq = read_seqbegin(&rename_lock);
949854d0
NP
3305 /*
3306 * Need rcu_readlock to protect against the d_parent trashing
3307 * due to d_move
3308 */
3309 rcu_read_lock();
e2761a11 3310 if (d_ancestor(old_dentry, new_dentry))
a6e5787f 3311 result = true;
e2761a11 3312 else
a6e5787f 3313 result = false;
949854d0 3314 rcu_read_unlock();
1da177e4 3315 } while (read_seqretry(&rename_lock, seq));
1da177e4
LT
3316
3317 return result;
3318}
3319
db14fc3a 3320static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
1da177e4 3321{
db14fc3a
MS
3322 struct dentry *root = data;
3323 if (dentry != root) {
3324 if (d_unhashed(dentry) || !dentry->d_inode)
3325 return D_WALK_SKIP;
1da177e4 3326
01ddc4ed
MS
3327 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3328 dentry->d_flags |= DCACHE_GENOCIDE;
3329 dentry->d_lockref.count--;
3330 }
1da177e4 3331 }
db14fc3a
MS
3332 return D_WALK_CONTINUE;
3333}
58db63d0 3334
db14fc3a
MS
3335void d_genocide(struct dentry *parent)
3336{
3337 d_walk(parent, parent, d_genocide_kill, NULL);
1da177e4
LT
3338}
3339
60545d0d 3340void d_tmpfile(struct dentry *dentry, struct inode *inode)
1da177e4 3341{
60545d0d
AV
3342 inode_dec_link_count(inode);
3343 BUG_ON(dentry->d_name.name != dentry->d_iname ||
946e51f2 3344 !hlist_unhashed(&dentry->d_u.d_alias) ||
60545d0d
AV
3345 !d_unlinked(dentry));
3346 spin_lock(&dentry->d_parent->d_lock);
3347 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3348 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3349 (unsigned long long)inode->i_ino);
3350 spin_unlock(&dentry->d_lock);
3351 spin_unlock(&dentry->d_parent->d_lock);
3352 d_instantiate(dentry, inode);
1da177e4 3353}
60545d0d 3354EXPORT_SYMBOL(d_tmpfile);
1da177e4
LT
3355
3356static __initdata unsigned long dhash_entries;
3357static int __init set_dhash_entries(char *str)
3358{
3359 if (!str)
3360 return 0;
3361 dhash_entries = simple_strtoul(str, &str, 0);
3362 return 1;
3363}
3364__setup("dhash_entries=", set_dhash_entries);
3365
3366static void __init dcache_init_early(void)
3367{
074b8517 3368 unsigned int loop;
1da177e4
LT
3369
3370 /* If hashes are distributed across NUMA nodes, defer
3371 * hash allocation until vmalloc space is available.
3372 */
3373 if (hashdist)
3374 return;
3375
3376 dentry_hashtable =
3377 alloc_large_system_hash("Dentry cache",
b07ad996 3378 sizeof(struct hlist_bl_head),
1da177e4
LT
3379 dhash_entries,
3380 13,
3381 HASH_EARLY,
3382 &d_hash_shift,
3383 &d_hash_mask,
31fe62b9 3384 0,
1da177e4
LT
3385 0);
3386
074b8517 3387 for (loop = 0; loop < (1U << d_hash_shift); loop++)
b07ad996 3388 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
1da177e4
LT
3389}
3390
74bf17cf 3391static void __init dcache_init(void)
1da177e4 3392{
074b8517 3393 unsigned int loop;
1da177e4
LT
3394
3395 /*
3396 * A constructor could be added for stable state like the lists,
3397 * but it is probably not worth it because of the cache nature
3398 * of the dcache.
3399 */
0a31bd5f 3400 dentry_cache = KMEM_CACHE(dentry,
5d097056 3401 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
1da177e4
LT
3402
3403 /* Hash may have been set up in dcache_init_early */
3404 if (!hashdist)
3405 return;
3406
3407 dentry_hashtable =
3408 alloc_large_system_hash("Dentry cache",
b07ad996 3409 sizeof(struct hlist_bl_head),
1da177e4
LT
3410 dhash_entries,
3411 13,
3412 0,
3413 &d_hash_shift,
3414 &d_hash_mask,
31fe62b9 3415 0,
1da177e4
LT
3416 0);
3417
074b8517 3418 for (loop = 0; loop < (1U << d_hash_shift); loop++)
b07ad996 3419 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
1da177e4
LT
3420}
3421
3422/* SLAB cache for __getname() consumers */
e18b890b 3423struct kmem_cache *names_cachep __read_mostly;
ec4f8605 3424EXPORT_SYMBOL(names_cachep);
1da177e4 3425
1da177e4
LT
3426EXPORT_SYMBOL(d_genocide);
3427
1da177e4
LT
3428void __init vfs_caches_init_early(void)
3429{
3430 dcache_init_early();
3431 inode_init_early();
3432}
3433
4248b0da 3434void __init vfs_caches_init(void)
1da177e4 3435{
1da177e4 3436 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
20c2df83 3437 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
1da177e4 3438
74bf17cf
DC
3439 dcache_init();
3440 inode_init();
4248b0da
MG
3441 files_init();
3442 files_maxfiles_init();
74bf17cf 3443 mnt_init();
1da177e4
LT
3444 bdev_cache_init();
3445 chrdev_init();
3446}