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