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