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