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