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