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