4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
10 * Notes on the allocation strategy:
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.
17 #include <linux/syscalls.h>
18 #include <linux/string.h>
21 #include <linux/fsnotify.h>
22 #include <linux/slab.h>
23 #include <linux/init.h>
24 #include <linux/hash.h>
25 #include <linux/cache.h>
26 #include <linux/export.h>
27 #include <linux/mount.h>
28 #include <linux/file.h>
29 #include <asm/uaccess.h>
30 #include <linux/security.h>
31 #include <linux/seqlock.h>
32 #include <linux/swap.h>
33 #include <linux/bootmem.h>
34 #include <linux/fs_struct.h>
35 #include <linux/hardirq.h>
36 #include <linux/bit_spinlock.h>
37 #include <linux/rculist_bl.h>
38 #include <linux/prefetch.h>
39 #include <linux/ratelimit.h>
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_anon bl list spinlock protects:
50 * - the s_anon list (see __d_drop)
51 * dcache_lru_lock protects:
52 * - the dcache lru lists and counters
59 * - d_parent and d_subdirs
60 * - childrens' d_child and d_parent
61 * - d_u.d_alias, d_inode
64 * dentry->d_inode->i_lock
67 * dcache_hash_bucket lock
70 * If there is an ancestor relationship:
71 * dentry->d_parent->...->d_parent->d_lock
73 * dentry->d_parent->d_lock
76 * If no ancestor relationship:
77 * if (dentry1 < dentry2)
81 int sysctl_vfs_cache_pressure __read_mostly = 100;
82 EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
84 static __cacheline_aligned_in_smp DEFINE_SPINLOCK(dcache_lru_lock);
85 __cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
87 EXPORT_SYMBOL(rename_lock);
89 static struct kmem_cache *dentry_cache __read_mostly;
92 * This is the single most critical data structure when it comes
93 * to the dcache: the hashtable for lookups. Somebody should try
94 * to make this good - I've just made it work.
96 * This hash-function tries to avoid losing too many bits of hash
97 * information, yet avoid using a prime hash-size or similar.
100 static unsigned int d_hash_mask __read_mostly;
101 static unsigned int d_hash_shift __read_mostly;
103 static struct hlist_bl_head *dentry_hashtable __read_mostly;
105 static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
108 hash += (unsigned long) parent / L1_CACHE_BYTES;
109 return dentry_hashtable + hash_32(hash, d_hash_shift);
112 /* Statistics gathering. */
113 struct dentry_stat_t dentry_stat = {
117 static DEFINE_PER_CPU(unsigned int, nr_dentry);
119 #if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
120 static int get_nr_dentry(void)
124 for_each_possible_cpu(i)
125 sum += per_cpu(nr_dentry, i);
126 return sum < 0 ? 0 : sum;
129 int proc_nr_dentry(ctl_table *table, int write, void __user *buffer,
130 size_t *lenp, loff_t *ppos)
132 dentry_stat.nr_dentry = get_nr_dentry();
133 return proc_dointvec(table, write, buffer, lenp, ppos);
138 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
139 * The strings are both count bytes long, and count is non-zero.
141 #ifdef CONFIG_DCACHE_WORD_ACCESS
143 #include <asm/word-at-a-time.h>
145 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
146 * aligned allocation for this particular component. We don't
147 * strictly need the load_unaligned_zeropad() safety, but it
148 * doesn't hurt either.
150 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
151 * need the careful unaligned handling.
153 static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
155 unsigned long a,b,mask;
158 a = *(unsigned long *)cs;
159 b = load_unaligned_zeropad(ct);
160 if (tcount < sizeof(unsigned long))
162 if (unlikely(a != b))
164 cs += sizeof(unsigned long);
165 ct += sizeof(unsigned long);
166 tcount -= sizeof(unsigned long);
170 mask = ~(~0ul << tcount*8);
171 return unlikely(!!((a ^ b) & mask));
176 static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
190 static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
192 const unsigned char *cs;
194 * Be careful about RCU walk racing with rename:
195 * use ACCESS_ONCE to fetch the name pointer.
197 * NOTE! Even if a rename will mean that the length
198 * was not loaded atomically, we don't care. The
199 * RCU walk will check the sequence count eventually,
200 * and catch it. And we won't overrun the buffer,
201 * because we're reading the name pointer atomically,
202 * and a dentry name is guaranteed to be properly
203 * terminated with a NUL byte.
205 * End result: even if 'len' is wrong, we'll exit
206 * early because the data cannot match (there can
207 * be no NUL in the ct/tcount data)
209 cs = ACCESS_ONCE(dentry->d_name.name);
210 smp_read_barrier_depends();
211 return dentry_string_cmp(cs, ct, tcount);
214 static void __d_free(struct rcu_head *head)
216 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
218 if (dname_external(dentry))
219 kfree(dentry->d_name.name);
220 kmem_cache_free(dentry_cache, dentry);
226 static void d_free(struct dentry *dentry)
228 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
229 BUG_ON(dentry->d_count);
230 this_cpu_dec(nr_dentry);
231 if (dentry->d_op && dentry->d_op->d_release)
232 dentry->d_op->d_release(dentry);
234 /* if dentry was never visible to RCU, immediate free is OK */
235 if (!(dentry->d_flags & DCACHE_RCUACCESS))
236 __d_free(&dentry->d_u.d_rcu);
238 call_rcu(&dentry->d_u.d_rcu, __d_free);
242 * dentry_rcuwalk_barrier - invalidate in-progress rcu-walk lookups
243 * @dentry: the target dentry
244 * After this call, in-progress rcu-walk path lookup will fail. This
245 * should be called after unhashing, and after changing d_inode (if
246 * the dentry has not already been unhashed).
248 static inline void dentry_rcuwalk_barrier(struct dentry *dentry)
250 assert_spin_locked(&dentry->d_lock);
251 /* Go through a barrier */
252 write_seqcount_barrier(&dentry->d_seq);
256 * Release the dentry's inode, using the filesystem
257 * d_iput() operation if defined. Dentry has no refcount
260 static void dentry_iput(struct dentry * dentry)
261 __releases(dentry->d_lock)
262 __releases(dentry->d_inode->i_lock)
264 struct inode *inode = dentry->d_inode;
266 dentry->d_inode = NULL;
267 hlist_del_init(&dentry->d_u.d_alias);
268 spin_unlock(&dentry->d_lock);
269 spin_unlock(&inode->i_lock);
271 fsnotify_inoderemove(inode);
272 if (dentry->d_op && dentry->d_op->d_iput)
273 dentry->d_op->d_iput(dentry, inode);
277 spin_unlock(&dentry->d_lock);
282 * Release the dentry's inode, using the filesystem
283 * d_iput() operation if defined. dentry remains in-use.
285 static void dentry_unlink_inode(struct dentry * dentry)
286 __releases(dentry->d_lock)
287 __releases(dentry->d_inode->i_lock)
289 struct inode *inode = dentry->d_inode;
290 dentry->d_inode = NULL;
291 hlist_del_init(&dentry->d_u.d_alias);
292 dentry_rcuwalk_barrier(dentry);
293 spin_unlock(&dentry->d_lock);
294 spin_unlock(&inode->i_lock);
296 fsnotify_inoderemove(inode);
297 if (dentry->d_op && dentry->d_op->d_iput)
298 dentry->d_op->d_iput(dentry, inode);
304 * dentry_lru_(add|del|prune|move_tail) must be called with d_lock held.
306 static void dentry_lru_add(struct dentry *dentry)
308 if (list_empty(&dentry->d_lru)) {
309 spin_lock(&dcache_lru_lock);
310 list_add(&dentry->d_lru, &dentry->d_sb->s_dentry_lru);
311 dentry->d_sb->s_nr_dentry_unused++;
312 dentry_stat.nr_unused++;
313 spin_unlock(&dcache_lru_lock);
317 static void __dentry_lru_del(struct dentry *dentry)
319 list_del_init(&dentry->d_lru);
320 dentry->d_flags &= ~DCACHE_SHRINK_LIST;
321 dentry->d_sb->s_nr_dentry_unused--;
322 dentry_stat.nr_unused--;
326 * Remove a dentry with references from the LRU.
328 static void dentry_lru_del(struct dentry *dentry)
330 if (!list_empty(&dentry->d_lru)) {
331 spin_lock(&dcache_lru_lock);
332 __dentry_lru_del(dentry);
333 spin_unlock(&dcache_lru_lock);
337 static void dentry_lru_move_list(struct dentry *dentry, struct list_head *list)
339 spin_lock(&dcache_lru_lock);
340 if (list_empty(&dentry->d_lru)) {
341 list_add_tail(&dentry->d_lru, list);
342 dentry->d_sb->s_nr_dentry_unused++;
343 dentry_stat.nr_unused++;
345 list_move_tail(&dentry->d_lru, list);
347 spin_unlock(&dcache_lru_lock);
351 * d_kill - kill dentry and return parent
352 * @dentry: dentry to kill
353 * @parent: parent dentry
355 * The dentry must already be unhashed and removed from the LRU.
357 * If this is the root of the dentry tree, return NULL.
359 * dentry->d_lock and parent->d_lock must be held by caller, and are dropped by
362 static struct dentry *d_kill(struct dentry *dentry, struct dentry *parent)
363 __releases(dentry->d_lock)
364 __releases(parent->d_lock)
365 __releases(dentry->d_inode->i_lock)
367 __list_del_entry(&dentry->d_child);
369 * Inform ascending readers that we are no longer attached to the
372 dentry->d_flags |= DCACHE_DENTRY_KILLED;
374 spin_unlock(&parent->d_lock);
377 * dentry_iput drops the locks, at which point nobody (except
378 * transient RCU lookups) can reach this dentry.
385 * Unhash a dentry without inserting an RCU walk barrier or checking that
386 * dentry->d_lock is locked. The caller must take care of that, if
389 static void __d_shrink(struct dentry *dentry)
391 if (!d_unhashed(dentry)) {
392 struct hlist_bl_head *b;
393 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
394 b = &dentry->d_sb->s_anon;
396 b = d_hash(dentry->d_parent, dentry->d_name.hash);
399 __hlist_bl_del(&dentry->d_hash);
400 dentry->d_hash.pprev = NULL;
406 * d_drop - drop a dentry
407 * @dentry: dentry to drop
409 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
410 * be found through a VFS lookup any more. Note that this is different from
411 * deleting the dentry - d_delete will try to mark the dentry negative if
412 * possible, giving a successful _negative_ lookup, while d_drop will
413 * just make the cache lookup fail.
415 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
416 * reason (NFS timeouts or autofs deletes).
418 * __d_drop requires dentry->d_lock.
420 void __d_drop(struct dentry *dentry)
422 if (!d_unhashed(dentry)) {
424 dentry_rcuwalk_barrier(dentry);
427 EXPORT_SYMBOL(__d_drop);
429 void d_drop(struct dentry *dentry)
431 spin_lock(&dentry->d_lock);
433 spin_unlock(&dentry->d_lock);
435 EXPORT_SYMBOL(d_drop);
438 * Finish off a dentry we've decided to kill.
439 * dentry->d_lock must be held, returns with it unlocked.
440 * If ref is non-zero, then decrement the refcount too.
441 * Returns dentry requiring refcount drop, or NULL if we're done.
443 static inline struct dentry *dentry_kill(struct dentry *dentry, int ref)
444 __releases(dentry->d_lock)
447 struct dentry *parent;
449 inode = dentry->d_inode;
450 if (inode && !spin_trylock(&inode->i_lock)) {
452 spin_unlock(&dentry->d_lock);
454 return dentry; /* try again with same dentry */
459 parent = dentry->d_parent;
460 if (parent && !spin_trylock(&parent->d_lock)) {
462 spin_unlock(&inode->i_lock);
469 * inform the fs via d_prune that this dentry is about to be
470 * unhashed and destroyed.
472 if (dentry->d_flags & DCACHE_OP_PRUNE)
473 dentry->d_op->d_prune(dentry);
475 dentry_lru_del(dentry);
476 /* if it was on the hash then remove it */
478 return d_kill(dentry, parent);
484 * This is complicated by the fact that we do not want to put
485 * dentries that are no longer on any hash chain on the unused
486 * list: we'd much rather just get rid of them immediately.
488 * However, that implies that we have to traverse the dentry
489 * tree upwards to the parents which might _also_ now be
490 * scheduled for deletion (it may have been only waiting for
491 * its last child to go away).
493 * This tail recursion is done by hand as we don't want to depend
494 * on the compiler to always get this right (gcc generally doesn't).
495 * Real recursion would eat up our stack space.
499 * dput - release a dentry
500 * @dentry: dentry to release
502 * Release a dentry. This will drop the usage count and if appropriate
503 * call the dentry unlink method as well as removing it from the queues and
504 * releasing its resources. If the parent dentries were scheduled for release
505 * they too may now get deleted.
507 void dput(struct dentry *dentry)
513 if (dentry->d_count == 1)
515 spin_lock(&dentry->d_lock);
516 BUG_ON(!dentry->d_count);
517 if (dentry->d_count > 1) {
519 spin_unlock(&dentry->d_lock);
523 if (dentry->d_flags & DCACHE_OP_DELETE) {
524 if (dentry->d_op->d_delete(dentry))
528 /* Unreachable? Get rid of it */
529 if (d_unhashed(dentry))
532 dentry->d_flags |= DCACHE_REFERENCED;
533 dentry_lru_add(dentry);
536 spin_unlock(&dentry->d_lock);
540 dentry = dentry_kill(dentry, 1);
547 * d_invalidate - invalidate a dentry
548 * @dentry: dentry to invalidate
550 * Try to invalidate the dentry if it turns out to be
551 * possible. If there are other dentries that can be
552 * reached through this one we can't delete it and we
553 * return -EBUSY. On success we return 0.
558 int d_invalidate(struct dentry * dentry)
561 * If it's already been dropped, return OK.
563 spin_lock(&dentry->d_lock);
564 if (d_unhashed(dentry)) {
565 spin_unlock(&dentry->d_lock);
569 * Check whether to do a partial shrink_dcache
570 * to get rid of unused child entries.
572 if (!list_empty(&dentry->d_subdirs)) {
573 spin_unlock(&dentry->d_lock);
574 shrink_dcache_parent(dentry);
575 spin_lock(&dentry->d_lock);
579 * Somebody else still using it?
581 * If it's a directory, we can't drop it
582 * for fear of somebody re-populating it
583 * with children (even though dropping it
584 * would make it unreachable from the root,
585 * we might still populate it if it was a
586 * working directory or similar).
587 * We also need to leave mountpoints alone,
590 if (dentry->d_count > 1 && dentry->d_inode) {
591 if (S_ISDIR(dentry->d_inode->i_mode) || d_mountpoint(dentry)) {
592 spin_unlock(&dentry->d_lock);
598 spin_unlock(&dentry->d_lock);
601 EXPORT_SYMBOL(d_invalidate);
603 /* This must be called with d_lock held */
604 static inline void __dget_dlock(struct dentry *dentry)
609 static inline void __dget(struct dentry *dentry)
611 spin_lock(&dentry->d_lock);
612 __dget_dlock(dentry);
613 spin_unlock(&dentry->d_lock);
616 struct dentry *dget_parent(struct dentry *dentry)
622 * Don't need rcu_dereference because we re-check it was correct under
626 ret = dentry->d_parent;
627 spin_lock(&ret->d_lock);
628 if (unlikely(ret != dentry->d_parent)) {
629 spin_unlock(&ret->d_lock);
634 BUG_ON(!ret->d_count);
636 spin_unlock(&ret->d_lock);
639 EXPORT_SYMBOL(dget_parent);
642 * d_find_alias - grab a hashed alias of inode
643 * @inode: inode in question
644 * @want_discon: flag, used by d_splice_alias, to request
645 * that only a DISCONNECTED alias be returned.
647 * If inode has a hashed alias, or is a directory and has any alias,
648 * acquire the reference to alias and return it. Otherwise return NULL.
649 * Notice that if inode is a directory there can be only one alias and
650 * it can be unhashed only if it has no children, or if it is the root
653 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
654 * any other hashed alias over that one unless @want_discon is set,
655 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
657 static struct dentry *__d_find_alias(struct inode *inode, int want_discon)
659 struct dentry *alias, *discon_alias;
663 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
664 spin_lock(&alias->d_lock);
665 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
666 if (IS_ROOT(alias) &&
667 (alias->d_flags & DCACHE_DISCONNECTED)) {
668 discon_alias = alias;
669 } else if (!want_discon) {
671 spin_unlock(&alias->d_lock);
675 spin_unlock(&alias->d_lock);
678 alias = discon_alias;
679 spin_lock(&alias->d_lock);
680 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
681 if (IS_ROOT(alias) &&
682 (alias->d_flags & DCACHE_DISCONNECTED)) {
684 spin_unlock(&alias->d_lock);
688 spin_unlock(&alias->d_lock);
694 struct dentry *d_find_alias(struct inode *inode)
696 struct dentry *de = NULL;
698 if (!hlist_empty(&inode->i_dentry)) {
699 spin_lock(&inode->i_lock);
700 de = __d_find_alias(inode, 0);
701 spin_unlock(&inode->i_lock);
705 EXPORT_SYMBOL(d_find_alias);
708 * Try to kill dentries associated with this inode.
709 * WARNING: you must own a reference to inode.
711 void d_prune_aliases(struct inode *inode)
713 struct dentry *dentry;
715 spin_lock(&inode->i_lock);
716 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
717 spin_lock(&dentry->d_lock);
718 if (!dentry->d_count) {
719 __dget_dlock(dentry);
721 spin_unlock(&dentry->d_lock);
722 spin_unlock(&inode->i_lock);
726 spin_unlock(&dentry->d_lock);
728 spin_unlock(&inode->i_lock);
730 EXPORT_SYMBOL(d_prune_aliases);
733 * Try to throw away a dentry - free the inode, dput the parent.
734 * Requires dentry->d_lock is held, and dentry->d_count == 0.
735 * Releases dentry->d_lock.
737 * This may fail if locks cannot be acquired no problem, just try again.
739 static void try_prune_one_dentry(struct dentry *dentry)
740 __releases(dentry->d_lock)
742 struct dentry *parent;
744 parent = dentry_kill(dentry, 0);
746 * If dentry_kill returns NULL, we have nothing more to do.
747 * if it returns the same dentry, trylocks failed. In either
748 * case, just loop again.
750 * Otherwise, we need to prune ancestors too. This is necessary
751 * to prevent quadratic behavior of shrink_dcache_parent(), but
752 * is also expected to be beneficial in reducing dentry cache
757 if (parent == dentry)
760 /* Prune ancestors. */
763 spin_lock(&dentry->d_lock);
764 if (dentry->d_count > 1) {
766 spin_unlock(&dentry->d_lock);
769 dentry = dentry_kill(dentry, 1);
773 static void shrink_dentry_list(struct list_head *list)
775 struct dentry *dentry;
779 dentry = list_entry_rcu(list->prev, struct dentry, d_lru);
780 if (&dentry->d_lru == list)
782 spin_lock(&dentry->d_lock);
783 if (dentry != list_entry(list->prev, struct dentry, d_lru)) {
784 spin_unlock(&dentry->d_lock);
789 * We found an inuse dentry which was not removed from
790 * the LRU because of laziness during lookup. Do not free
791 * it - just keep it off the LRU list.
793 if (dentry->d_count) {
794 dentry_lru_del(dentry);
795 spin_unlock(&dentry->d_lock);
801 try_prune_one_dentry(dentry);
809 * prune_dcache_sb - shrink the dcache
811 * @count: number of entries to try to free
813 * Attempt to shrink the superblock dcache LRU by @count entries. This is
814 * done when we need more memory an called from the superblock shrinker
817 * This function may fail to free any resources if all the dentries are in
820 void prune_dcache_sb(struct super_block *sb, int count)
822 struct dentry *dentry;
823 LIST_HEAD(referenced);
827 spin_lock(&dcache_lru_lock);
828 while (!list_empty(&sb->s_dentry_lru)) {
829 dentry = list_entry(sb->s_dentry_lru.prev,
830 struct dentry, d_lru);
831 BUG_ON(dentry->d_sb != sb);
833 if (!spin_trylock(&dentry->d_lock)) {
834 spin_unlock(&dcache_lru_lock);
839 if (dentry->d_flags & DCACHE_REFERENCED) {
840 dentry->d_flags &= ~DCACHE_REFERENCED;
841 list_move(&dentry->d_lru, &referenced);
842 spin_unlock(&dentry->d_lock);
844 list_move_tail(&dentry->d_lru, &tmp);
845 dentry->d_flags |= DCACHE_SHRINK_LIST;
846 spin_unlock(&dentry->d_lock);
850 cond_resched_lock(&dcache_lru_lock);
852 if (!list_empty(&referenced))
853 list_splice(&referenced, &sb->s_dentry_lru);
854 spin_unlock(&dcache_lru_lock);
856 shrink_dentry_list(&tmp);
860 * shrink_dcache_sb - shrink dcache for a superblock
863 * Shrink the dcache for the specified super block. This is used to free
864 * the dcache before unmounting a file system.
866 void shrink_dcache_sb(struct super_block *sb)
870 spin_lock(&dcache_lru_lock);
871 while (!list_empty(&sb->s_dentry_lru)) {
872 list_splice_init(&sb->s_dentry_lru, &tmp);
873 spin_unlock(&dcache_lru_lock);
874 shrink_dentry_list(&tmp);
875 spin_lock(&dcache_lru_lock);
877 spin_unlock(&dcache_lru_lock);
879 EXPORT_SYMBOL(shrink_dcache_sb);
882 * destroy a single subtree of dentries for unmount
883 * - see the comments on shrink_dcache_for_umount() for a description of the
886 static void shrink_dcache_for_umount_subtree(struct dentry *dentry)
888 struct dentry *parent;
890 BUG_ON(!IS_ROOT(dentry));
893 /* descend to the first leaf in the current subtree */
894 while (!list_empty(&dentry->d_subdirs))
895 dentry = list_entry(dentry->d_subdirs.next,
896 struct dentry, d_child);
898 /* consume the dentries from this leaf up through its parents
899 * until we find one with children or run out altogether */
904 * inform the fs that this dentry is about to be
905 * unhashed and destroyed.
907 if (dentry->d_flags & DCACHE_OP_PRUNE)
908 dentry->d_op->d_prune(dentry);
910 dentry_lru_del(dentry);
913 if (dentry->d_count != 0) {
915 "BUG: Dentry %p{i=%lx,n=%s}"
917 " [unmount of %s %s]\n",
920 dentry->d_inode->i_ino : 0UL,
923 dentry->d_sb->s_type->name,
928 if (IS_ROOT(dentry)) {
930 list_del(&dentry->d_child);
932 parent = dentry->d_parent;
934 list_del(&dentry->d_child);
937 inode = dentry->d_inode;
939 dentry->d_inode = NULL;
940 hlist_del_init(&dentry->d_u.d_alias);
941 if (dentry->d_op && dentry->d_op->d_iput)
942 dentry->d_op->d_iput(dentry, inode);
949 /* finished when we fall off the top of the tree,
950 * otherwise we ascend to the parent and move to the
951 * next sibling if there is one */
955 } while (list_empty(&dentry->d_subdirs));
957 dentry = list_entry(dentry->d_subdirs.next,
958 struct dentry, d_child);
963 * destroy the dentries attached to a superblock on unmounting
964 * - we don't need to use dentry->d_lock because:
965 * - the superblock is detached from all mountings and open files, so the
966 * dentry trees will not be rearranged by the VFS
967 * - s_umount is write-locked, so the memory pressure shrinker will ignore
968 * any dentries belonging to this superblock that it comes across
969 * - the filesystem itself is no longer permitted to rearrange the dentries
972 void shrink_dcache_for_umount(struct super_block *sb)
974 struct dentry *dentry;
976 if (down_read_trylock(&sb->s_umount))
982 shrink_dcache_for_umount_subtree(dentry);
984 while (!hlist_bl_empty(&sb->s_anon)) {
985 dentry = hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash);
986 shrink_dcache_for_umount_subtree(dentry);
991 * Search for at least 1 mount point in the dentry's subdirs.
992 * We descend to the next level whenever the d_subdirs
993 * list is non-empty and continue searching.
997 * have_submounts - check for mounts over a dentry
998 * @parent: dentry to check.
1000 * Return true if the parent or its subdirectories contain
1003 int have_submounts(struct dentry *parent)
1005 struct dentry *this_parent;
1006 struct list_head *next;
1010 seq = read_seqbegin(&rename_lock);
1012 this_parent = parent;
1014 if (d_mountpoint(parent))
1016 spin_lock(&this_parent->d_lock);
1018 next = this_parent->d_subdirs.next;
1020 while (next != &this_parent->d_subdirs) {
1021 struct list_head *tmp = next;
1022 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
1025 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
1026 /* Have we found a mount point ? */
1027 if (d_mountpoint(dentry)) {
1028 spin_unlock(&dentry->d_lock);
1029 spin_unlock(&this_parent->d_lock);
1032 if (!list_empty(&dentry->d_subdirs)) {
1033 spin_unlock(&this_parent->d_lock);
1034 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
1035 this_parent = dentry;
1036 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
1039 spin_unlock(&dentry->d_lock);
1042 * All done at this level ... ascend and resume the search.
1046 if (this_parent != parent) {
1047 struct dentry *child = this_parent;
1048 this_parent = child->d_parent;
1050 spin_unlock(&child->d_lock);
1051 spin_lock(&this_parent->d_lock);
1053 /* might go back up the wrong parent if we have had a rename. */
1054 if (!locked && read_seqretry(&rename_lock, seq))
1056 next = child->d_child.next;
1057 while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED)) {
1058 if (next == &this_parent->d_subdirs)
1060 child = list_entry(next, struct dentry, d_child);
1066 if (!locked && read_seqretry(&rename_lock, seq))
1068 spin_unlock(&this_parent->d_lock);
1071 write_sequnlock(&rename_lock);
1072 return 0; /* No mount points found in tree */
1074 if (!locked && read_seqretry(&rename_lock, seq))
1075 goto rename_retry_unlocked;
1077 write_sequnlock(&rename_lock);
1081 spin_unlock(&this_parent->d_lock);
1085 rename_retry_unlocked:
1087 write_seqlock(&rename_lock);
1090 EXPORT_SYMBOL(have_submounts);
1093 * Search the dentry child list of the specified parent,
1094 * and move any unused dentries to the end of the unused
1095 * list for prune_dcache(). We descend to the next level
1096 * whenever the d_subdirs list is non-empty and continue
1099 * It returns zero iff there are no unused children,
1100 * otherwise it returns the number of children moved to
1101 * the end of the unused list. This may not be the total
1102 * number of unused children, because select_parent can
1103 * drop the lock and return early due to latency
1106 static int select_parent(struct dentry *parent, struct list_head *dispose)
1108 struct dentry *this_parent;
1109 struct list_head *next;
1114 seq = read_seqbegin(&rename_lock);
1116 this_parent = parent;
1117 spin_lock(&this_parent->d_lock);
1119 next = this_parent->d_subdirs.next;
1121 while (next != &this_parent->d_subdirs) {
1122 struct list_head *tmp = next;
1123 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
1126 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
1129 * move only zero ref count dentries to the dispose list.
1131 * Those which are presently on the shrink list, being processed
1132 * by shrink_dentry_list(), shouldn't be moved. Otherwise the
1133 * loop in shrink_dcache_parent() might not make any progress
1136 if (dentry->d_count) {
1137 dentry_lru_del(dentry);
1138 } else if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
1139 dentry_lru_move_list(dentry, dispose);
1140 dentry->d_flags |= DCACHE_SHRINK_LIST;
1144 * We can return to the caller if we have found some (this
1145 * ensures forward progress). We'll be coming back to find
1148 if (found && need_resched()) {
1149 spin_unlock(&dentry->d_lock);
1155 * Descend a level if the d_subdirs list is non-empty.
1157 if (!list_empty(&dentry->d_subdirs)) {
1158 spin_unlock(&this_parent->d_lock);
1159 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
1160 this_parent = dentry;
1161 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
1165 spin_unlock(&dentry->d_lock);
1168 * All done at this level ... ascend and resume the search.
1172 if (this_parent != parent) {
1173 struct dentry *child = this_parent;
1174 this_parent = child->d_parent;
1176 spin_unlock(&child->d_lock);
1177 spin_lock(&this_parent->d_lock);
1179 /* might go back up the wrong parent if we have had a rename. */
1180 if (!locked && read_seqretry(&rename_lock, seq))
1182 /* go into the first sibling still alive */
1184 next = child->d_child.next;
1185 if (next == &this_parent->d_subdirs)
1187 child = list_entry(next, struct dentry, d_child);
1188 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
1193 if (!locked && read_seqretry(&rename_lock, seq))
1195 spin_unlock(&this_parent->d_lock);
1198 write_sequnlock(&rename_lock);
1202 spin_unlock(&this_parent->d_lock);
1209 write_seqlock(&rename_lock);
1214 * shrink_dcache_parent - prune dcache
1215 * @parent: parent of entries to prune
1217 * Prune the dcache to remove unused children of the parent dentry.
1219 void shrink_dcache_parent(struct dentry * parent)
1224 while ((found = select_parent(parent, &dispose)) != 0) {
1225 shrink_dentry_list(&dispose);
1229 EXPORT_SYMBOL(shrink_dcache_parent);
1232 * __d_alloc - allocate a dcache entry
1233 * @sb: filesystem it will belong to
1234 * @name: qstr of the name
1236 * Allocates a dentry. It returns %NULL if there is insufficient memory
1237 * available. On a success the dentry is returned. The name passed in is
1238 * copied and the copy passed in may be reused after this call.
1241 struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
1243 struct dentry *dentry;
1246 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
1251 * We guarantee that the inline name is always NUL-terminated.
1252 * This way the memcpy() done by the name switching in rename
1253 * will still always have a NUL at the end, even if we might
1254 * be overwriting an internal NUL character
1256 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
1257 if (name->len > DNAME_INLINE_LEN-1) {
1258 dname = kmalloc(name->len + 1, GFP_KERNEL);
1260 kmem_cache_free(dentry_cache, dentry);
1264 dname = dentry->d_iname;
1267 dentry->d_name.len = name->len;
1268 dentry->d_name.hash = name->hash;
1269 memcpy(dname, name->name, name->len);
1270 dname[name->len] = 0;
1272 /* Make sure we always see the terminating NUL character */
1274 dentry->d_name.name = dname;
1276 dentry->d_count = 1;
1277 dentry->d_flags = 0;
1278 spin_lock_init(&dentry->d_lock);
1279 seqcount_init(&dentry->d_seq);
1280 dentry->d_inode = NULL;
1281 dentry->d_parent = dentry;
1283 dentry->d_op = NULL;
1284 dentry->d_fsdata = NULL;
1285 INIT_HLIST_BL_NODE(&dentry->d_hash);
1286 INIT_LIST_HEAD(&dentry->d_lru);
1287 INIT_LIST_HEAD(&dentry->d_subdirs);
1288 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1289 INIT_LIST_HEAD(&dentry->d_child);
1290 d_set_d_op(dentry, dentry->d_sb->s_d_op);
1292 this_cpu_inc(nr_dentry);
1298 * d_alloc - allocate a dcache entry
1299 * @parent: parent of entry to allocate
1300 * @name: qstr of the name
1302 * Allocates a dentry. It returns %NULL if there is insufficient memory
1303 * available. On a success the dentry is returned. The name passed in is
1304 * copied and the copy passed in may be reused after this call.
1306 struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1308 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1312 spin_lock(&parent->d_lock);
1314 * don't need child lock because it is not subject
1315 * to concurrency here
1317 __dget_dlock(parent);
1318 dentry->d_parent = parent;
1319 list_add(&dentry->d_child, &parent->d_subdirs);
1320 spin_unlock(&parent->d_lock);
1324 EXPORT_SYMBOL(d_alloc);
1326 struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1328 struct dentry *dentry = __d_alloc(sb, name);
1330 dentry->d_flags |= DCACHE_DISCONNECTED;
1333 EXPORT_SYMBOL(d_alloc_pseudo);
1335 struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1340 q.len = strlen(name);
1341 q.hash = full_name_hash(q.name, q.len);
1342 return d_alloc(parent, &q);
1344 EXPORT_SYMBOL(d_alloc_name);
1346 void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1348 WARN_ON_ONCE(dentry->d_op);
1349 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
1351 DCACHE_OP_REVALIDATE |
1352 DCACHE_OP_WEAK_REVALIDATE |
1353 DCACHE_OP_DELETE ));
1358 dentry->d_flags |= DCACHE_OP_HASH;
1360 dentry->d_flags |= DCACHE_OP_COMPARE;
1361 if (op->d_revalidate)
1362 dentry->d_flags |= DCACHE_OP_REVALIDATE;
1363 if (op->d_weak_revalidate)
1364 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
1366 dentry->d_flags |= DCACHE_OP_DELETE;
1368 dentry->d_flags |= DCACHE_OP_PRUNE;
1371 EXPORT_SYMBOL(d_set_d_op);
1373 static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1375 spin_lock(&dentry->d_lock);
1377 if (unlikely(IS_AUTOMOUNT(inode)))
1378 dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
1379 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
1381 dentry->d_inode = inode;
1382 dentry_rcuwalk_barrier(dentry);
1383 spin_unlock(&dentry->d_lock);
1384 fsnotify_d_instantiate(dentry, inode);
1388 * d_instantiate - fill in inode information for a dentry
1389 * @entry: dentry to complete
1390 * @inode: inode to attach to this dentry
1392 * Fill in inode information in the entry.
1394 * This turns negative dentries into productive full members
1397 * NOTE! This assumes that the inode count has been incremented
1398 * (or otherwise set) by the caller to indicate that it is now
1399 * in use by the dcache.
1402 void d_instantiate(struct dentry *entry, struct inode * inode)
1404 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1406 spin_lock(&inode->i_lock);
1407 __d_instantiate(entry, inode);
1409 spin_unlock(&inode->i_lock);
1410 security_d_instantiate(entry, inode);
1412 EXPORT_SYMBOL(d_instantiate);
1415 * d_instantiate_unique - instantiate a non-aliased dentry
1416 * @entry: dentry to instantiate
1417 * @inode: inode to attach to this dentry
1419 * Fill in inode information in the entry. On success, it returns NULL.
1420 * If an unhashed alias of "entry" already exists, then we return the
1421 * aliased dentry instead and drop one reference to inode.
1423 * Note that in order to avoid conflicts with rename() etc, the caller
1424 * had better be holding the parent directory semaphore.
1426 * This also assumes that the inode count has been incremented
1427 * (or otherwise set) by the caller to indicate that it is now
1428 * in use by the dcache.
1430 static struct dentry *__d_instantiate_unique(struct dentry *entry,
1431 struct inode *inode)
1433 struct dentry *alias;
1434 int len = entry->d_name.len;
1435 const char *name = entry->d_name.name;
1436 unsigned int hash = entry->d_name.hash;
1439 __d_instantiate(entry, NULL);
1443 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
1445 * Don't need alias->d_lock here, because aliases with
1446 * d_parent == entry->d_parent are not subject to name or
1447 * parent changes, because the parent inode i_mutex is held.
1449 if (alias->d_name.hash != hash)
1451 if (alias->d_parent != entry->d_parent)
1453 if (alias->d_name.len != len)
1455 if (dentry_cmp(alias, name, len))
1461 __d_instantiate(entry, inode);
1465 struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1467 struct dentry *result;
1469 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
1472 spin_lock(&inode->i_lock);
1473 result = __d_instantiate_unique(entry, inode);
1475 spin_unlock(&inode->i_lock);
1478 security_d_instantiate(entry, inode);
1482 BUG_ON(!d_unhashed(result));
1487 EXPORT_SYMBOL(d_instantiate_unique);
1489 struct dentry *d_make_root(struct inode *root_inode)
1491 struct dentry *res = NULL;
1494 static const struct qstr name = QSTR_INIT("/", 1);
1496 res = __d_alloc(root_inode->i_sb, &name);
1498 d_instantiate(res, root_inode);
1504 EXPORT_SYMBOL(d_make_root);
1506 static struct dentry * __d_find_any_alias(struct inode *inode)
1508 struct dentry *alias;
1510 if (hlist_empty(&inode->i_dentry))
1512 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
1518 * d_find_any_alias - find any alias for a given inode
1519 * @inode: inode to find an alias for
1521 * If any aliases exist for the given inode, take and return a
1522 * reference for one of them. If no aliases exist, return %NULL.
1524 struct dentry *d_find_any_alias(struct inode *inode)
1528 spin_lock(&inode->i_lock);
1529 de = __d_find_any_alias(inode);
1530 spin_unlock(&inode->i_lock);
1533 EXPORT_SYMBOL(d_find_any_alias);
1536 * d_obtain_alias - find or allocate a dentry for a given inode
1537 * @inode: inode to allocate the dentry for
1539 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1540 * similar open by handle operations. The returned dentry may be anonymous,
1541 * or may have a full name (if the inode was already in the cache).
1543 * When called on a directory inode, we must ensure that the inode only ever
1544 * has one dentry. If a dentry is found, that is returned instead of
1545 * allocating a new one.
1547 * On successful return, the reference to the inode has been transferred
1548 * to the dentry. In case of an error the reference on the inode is released.
1549 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1550 * be passed in and will be the error will be propagate to the return value,
1551 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1553 struct dentry *d_obtain_alias(struct inode *inode)
1555 static const struct qstr anonstring = QSTR_INIT("/", 1);
1560 return ERR_PTR(-ESTALE);
1562 return ERR_CAST(inode);
1564 res = d_find_any_alias(inode);
1568 tmp = __d_alloc(inode->i_sb, &anonstring);
1570 res = ERR_PTR(-ENOMEM);
1574 spin_lock(&inode->i_lock);
1575 res = __d_find_any_alias(inode);
1577 spin_unlock(&inode->i_lock);
1582 /* attach a disconnected dentry */
1583 spin_lock(&tmp->d_lock);
1584 tmp->d_inode = inode;
1585 tmp->d_flags |= DCACHE_DISCONNECTED;
1586 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
1587 hlist_bl_lock(&tmp->d_sb->s_anon);
1588 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
1589 hlist_bl_unlock(&tmp->d_sb->s_anon);
1590 spin_unlock(&tmp->d_lock);
1591 spin_unlock(&inode->i_lock);
1592 security_d_instantiate(tmp, inode);
1597 if (res && !IS_ERR(res))
1598 security_d_instantiate(res, inode);
1602 EXPORT_SYMBOL(d_obtain_alias);
1605 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1606 * @inode: the inode which may have a disconnected dentry
1607 * @dentry: a negative dentry which we want to point to the inode.
1609 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1610 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1611 * and return it, else simply d_add the inode to the dentry and return NULL.
1613 * This is needed in the lookup routine of any filesystem that is exportable
1614 * (via knfsd) so that we can build dcache paths to directories effectively.
1616 * If a dentry was found and moved, then it is returned. Otherwise NULL
1617 * is returned. This matches the expected return value of ->lookup.
1620 struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1622 struct dentry *new = NULL;
1625 return ERR_CAST(inode);
1627 if (inode && S_ISDIR(inode->i_mode)) {
1628 spin_lock(&inode->i_lock);
1629 new = __d_find_alias(inode, 1);
1631 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
1632 spin_unlock(&inode->i_lock);
1633 security_d_instantiate(new, inode);
1634 d_move(new, dentry);
1637 /* already taking inode->i_lock, so d_add() by hand */
1638 __d_instantiate(dentry, inode);
1639 spin_unlock(&inode->i_lock);
1640 security_d_instantiate(dentry, inode);
1644 d_add(dentry, inode);
1647 EXPORT_SYMBOL(d_splice_alias);
1650 * d_add_ci - lookup or allocate new dentry with case-exact name
1651 * @inode: the inode case-insensitive lookup has found
1652 * @dentry: the negative dentry that was passed to the parent's lookup func
1653 * @name: the case-exact name to be associated with the returned dentry
1655 * This is to avoid filling the dcache with case-insensitive names to the
1656 * same inode, only the actual correct case is stored in the dcache for
1657 * case-insensitive filesystems.
1659 * For a case-insensitive lookup match and if the the case-exact dentry
1660 * already exists in in the dcache, use it and return it.
1662 * If no entry exists with the exact case name, allocate new dentry with
1663 * the exact case, and return the spliced entry.
1665 struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
1668 struct dentry *found;
1672 * First check if a dentry matching the name already exists,
1673 * if not go ahead and create it now.
1675 found = d_hash_and_lookup(dentry->d_parent, name);
1676 if (unlikely(IS_ERR(found)))
1679 new = d_alloc(dentry->d_parent, name);
1681 found = ERR_PTR(-ENOMEM);
1685 found = d_splice_alias(inode, new);
1694 * If a matching dentry exists, and it's not negative use it.
1696 * Decrement the reference count to balance the iget() done
1699 if (found->d_inode) {
1700 if (unlikely(found->d_inode != inode)) {
1701 /* This can't happen because bad inodes are unhashed. */
1702 BUG_ON(!is_bad_inode(inode));
1703 BUG_ON(!is_bad_inode(found->d_inode));
1710 * Negative dentry: instantiate it unless the inode is a directory and
1711 * already has a dentry.
1713 new = d_splice_alias(inode, found);
1724 EXPORT_SYMBOL(d_add_ci);
1727 * Do the slow-case of the dentry name compare.
1729 * Unlike the dentry_cmp() function, we need to atomically
1730 * load the name, length and inode information, so that the
1731 * filesystem can rely on them, and can use the 'name' and
1732 * 'len' information without worrying about walking off the
1733 * end of memory etc.
1735 * Thus the read_seqcount_retry() and the "duplicate" info
1736 * in arguments (the low-level filesystem should not look
1737 * at the dentry inode or name contents directly, since
1738 * rename can change them while we're in RCU mode).
1740 enum slow_d_compare {
1746 static noinline enum slow_d_compare slow_dentry_cmp(
1747 const struct dentry *parent,
1748 struct inode *inode,
1749 struct dentry *dentry,
1751 const struct qstr *name)
1753 int tlen = dentry->d_name.len;
1754 const char *tname = dentry->d_name.name;
1755 struct inode *i = dentry->d_inode;
1757 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1759 return D_COMP_SEQRETRY;
1761 if (parent->d_op->d_compare(parent, inode,
1764 return D_COMP_NOMATCH;
1769 * __d_lookup_rcu - search for a dentry (racy, store-free)
1770 * @parent: parent dentry
1771 * @name: qstr of name we wish to find
1772 * @seqp: returns d_seq value at the point where the dentry was found
1773 * @inode: returns dentry->d_inode when the inode was found valid.
1774 * Returns: dentry, or NULL
1776 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
1777 * resolution (store-free path walking) design described in
1778 * Documentation/filesystems/path-lookup.txt.
1780 * This is not to be used outside core vfs.
1782 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
1783 * held, and rcu_read_lock held. The returned dentry must not be stored into
1784 * without taking d_lock and checking d_seq sequence count against @seq
1787 * A refcount may be taken on the found dentry with the __d_rcu_to_refcount
1790 * Alternatively, __d_lookup_rcu may be called again to look up the child of
1791 * the returned dentry, so long as its parent's seqlock is checked after the
1792 * child is looked up. Thus, an interlocking stepping of sequence lock checks
1793 * is formed, giving integrity down the path walk.
1795 * NOTE! The caller *has* to check the resulting dentry against the sequence
1796 * number we've returned before using any of the resulting dentry state!
1798 struct dentry *__d_lookup_rcu(const struct dentry *parent,
1799 const struct qstr *name,
1800 unsigned *seqp, struct inode *inode)
1802 u64 hashlen = name->hash_len;
1803 const unsigned char *str = name->name;
1804 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
1805 struct hlist_bl_node *node;
1806 struct dentry *dentry;
1809 * Note: There is significant duplication with __d_lookup_rcu which is
1810 * required to prevent single threaded performance regressions
1811 * especially on architectures where smp_rmb (in seqcounts) are costly.
1812 * Keep the two functions in sync.
1816 * The hash list is protected using RCU.
1818 * Carefully use d_seq when comparing a candidate dentry, to avoid
1819 * races with d_move().
1821 * It is possible that concurrent renames can mess up our list
1822 * walk here and result in missing our dentry, resulting in the
1823 * false-negative result. d_lookup() protects against concurrent
1824 * renames using rename_lock seqlock.
1826 * See Documentation/filesystems/path-lookup.txt for more details.
1828 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
1833 * The dentry sequence count protects us from concurrent
1834 * renames, and thus protects inode, parent and name fields.
1836 * The caller must perform a seqcount check in order
1837 * to do anything useful with the returned dentry,
1838 * including using the 'd_inode' pointer.
1840 * NOTE! We do a "raw" seqcount_begin here. That means that
1841 * we don't wait for the sequence count to stabilize if it
1842 * is in the middle of a sequence change. If we do the slow
1843 * dentry compare, we will do seqretries until it is stable,
1844 * and if we end up with a successful lookup, we actually
1845 * want to exit RCU lookup anyway.
1847 seq = raw_seqcount_begin(&dentry->d_seq);
1848 if (dentry->d_parent != parent)
1850 if (d_unhashed(dentry))
1854 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
1855 if (dentry->d_name.hash != hashlen_hash(hashlen))
1857 switch (slow_dentry_cmp(parent, inode, dentry, seq, name)) {
1860 case D_COMP_NOMATCH:
1867 if (dentry->d_name.hash_len != hashlen)
1869 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
1876 * d_lookup - search for a dentry
1877 * @parent: parent dentry
1878 * @name: qstr of name we wish to find
1879 * Returns: dentry, or NULL
1881 * d_lookup searches the children of the parent dentry for the name in
1882 * question. If the dentry is found its reference count is incremented and the
1883 * dentry is returned. The caller must use dput to free the entry when it has
1884 * finished using it. %NULL is returned if the dentry does not exist.
1886 struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
1888 struct dentry *dentry;
1892 seq = read_seqbegin(&rename_lock);
1893 dentry = __d_lookup(parent, name);
1896 } while (read_seqretry(&rename_lock, seq));
1899 EXPORT_SYMBOL(d_lookup);
1902 * __d_lookup - search for a dentry (racy)
1903 * @parent: parent dentry
1904 * @name: qstr of name we wish to find
1905 * Returns: dentry, or NULL
1907 * __d_lookup is like d_lookup, however it may (rarely) return a
1908 * false-negative result due to unrelated rename activity.
1910 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
1911 * however it must be used carefully, eg. with a following d_lookup in
1912 * the case of failure.
1914 * __d_lookup callers must be commented.
1916 struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
1918 unsigned int len = name->len;
1919 unsigned int hash = name->hash;
1920 const unsigned char *str = name->name;
1921 struct hlist_bl_head *b = d_hash(parent, hash);
1922 struct hlist_bl_node *node;
1923 struct dentry *found = NULL;
1924 struct dentry *dentry;
1927 * Note: There is significant duplication with __d_lookup_rcu which is
1928 * required to prevent single threaded performance regressions
1929 * especially on architectures where smp_rmb (in seqcounts) are costly.
1930 * Keep the two functions in sync.
1934 * The hash list is protected using RCU.
1936 * Take d_lock when comparing a candidate dentry, to avoid races
1939 * It is possible that concurrent renames can mess up our list
1940 * walk here and result in missing our dentry, resulting in the
1941 * false-negative result. d_lookup() protects against concurrent
1942 * renames using rename_lock seqlock.
1944 * See Documentation/filesystems/path-lookup.txt for more details.
1948 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
1950 if (dentry->d_name.hash != hash)
1953 spin_lock(&dentry->d_lock);
1954 if (dentry->d_parent != parent)
1956 if (d_unhashed(dentry))
1960 * It is safe to compare names since d_move() cannot
1961 * change the qstr (protected by d_lock).
1963 if (parent->d_flags & DCACHE_OP_COMPARE) {
1964 int tlen = dentry->d_name.len;
1965 const char *tname = dentry->d_name.name;
1966 if (parent->d_op->d_compare(parent, parent->d_inode,
1967 dentry, dentry->d_inode,
1971 if (dentry->d_name.len != len)
1973 if (dentry_cmp(dentry, str, len))
1979 spin_unlock(&dentry->d_lock);
1982 spin_unlock(&dentry->d_lock);
1990 * d_hash_and_lookup - hash the qstr then search for a dentry
1991 * @dir: Directory to search in
1992 * @name: qstr of name we wish to find
1994 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
1996 struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
1999 * Check for a fs-specific hash function. Note that we must
2000 * calculate the standard hash first, as the d_op->d_hash()
2001 * routine may choose to leave the hash value unchanged.
2003 name->hash = full_name_hash(name->name, name->len);
2004 if (dir->d_flags & DCACHE_OP_HASH) {
2005 int err = dir->d_op->d_hash(dir, dir->d_inode, name);
2006 if (unlikely(err < 0))
2007 return ERR_PTR(err);
2009 return d_lookup(dir, name);
2011 EXPORT_SYMBOL(d_hash_and_lookup);
2014 * d_validate - verify dentry provided from insecure source (deprecated)
2015 * @dentry: The dentry alleged to be valid child of @dparent
2016 * @dparent: The parent dentry (known to be valid)
2018 * An insecure source has sent us a dentry, here we verify it and dget() it.
2019 * This is used by ncpfs in its readdir implementation.
2020 * Zero is returned in the dentry is invalid.
2022 * This function is slow for big directories, and deprecated, do not use it.
2024 int d_validate(struct dentry *dentry, struct dentry *dparent)
2026 struct dentry *child;
2028 spin_lock(&dparent->d_lock);
2029 list_for_each_entry(child, &dparent->d_subdirs, d_child) {
2030 if (dentry == child) {
2031 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
2032 __dget_dlock(dentry);
2033 spin_unlock(&dentry->d_lock);
2034 spin_unlock(&dparent->d_lock);
2038 spin_unlock(&dparent->d_lock);
2042 EXPORT_SYMBOL(d_validate);
2045 * When a file is deleted, we have two options:
2046 * - turn this dentry into a negative dentry
2047 * - unhash this dentry and free it.
2049 * Usually, we want to just turn this into
2050 * a negative dentry, but if anybody else is
2051 * currently using the dentry or the inode
2052 * we can't do that and we fall back on removing
2053 * it from the hash queues and waiting for
2054 * it to be deleted later when it has no users
2058 * d_delete - delete a dentry
2059 * @dentry: The dentry to delete
2061 * Turn the dentry into a negative dentry if possible, otherwise
2062 * remove it from the hash queues so it can be deleted later
2065 void d_delete(struct dentry * dentry)
2067 struct inode *inode;
2070 * Are we the only user?
2073 spin_lock(&dentry->d_lock);
2074 inode = dentry->d_inode;
2075 isdir = S_ISDIR(inode->i_mode);
2076 if (dentry->d_count == 1) {
2077 if (!spin_trylock(&inode->i_lock)) {
2078 spin_unlock(&dentry->d_lock);
2082 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
2083 dentry_unlink_inode(dentry);
2084 fsnotify_nameremove(dentry, isdir);
2088 if (!d_unhashed(dentry))
2091 spin_unlock(&dentry->d_lock);
2093 fsnotify_nameremove(dentry, isdir);
2095 EXPORT_SYMBOL(d_delete);
2097 static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
2099 BUG_ON(!d_unhashed(entry));
2101 entry->d_flags |= DCACHE_RCUACCESS;
2102 hlist_bl_add_head_rcu(&entry->d_hash, b);
2106 static void _d_rehash(struct dentry * entry)
2108 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2112 * d_rehash - add an entry back to the hash
2113 * @entry: dentry to add to the hash
2115 * Adds a dentry to the hash according to its name.
2118 void d_rehash(struct dentry * entry)
2120 spin_lock(&entry->d_lock);
2122 spin_unlock(&entry->d_lock);
2124 EXPORT_SYMBOL(d_rehash);
2127 * dentry_update_name_case - update case insensitive dentry with a new name
2128 * @dentry: dentry to be updated
2131 * Update a case insensitive dentry with new case of name.
2133 * dentry must have been returned by d_lookup with name @name. Old and new
2134 * name lengths must match (ie. no d_compare which allows mismatched name
2137 * Parent inode i_mutex must be held over d_lookup and into this call (to
2138 * keep renames and concurrent inserts, and readdir(2) away).
2140 void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2142 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
2143 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2145 spin_lock(&dentry->d_lock);
2146 write_seqcount_begin(&dentry->d_seq);
2147 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
2148 write_seqcount_end(&dentry->d_seq);
2149 spin_unlock(&dentry->d_lock);
2151 EXPORT_SYMBOL(dentry_update_name_case);
2153 static void switch_names(struct dentry *dentry, struct dentry *target)
2155 if (dname_external(target)) {
2156 if (dname_external(dentry)) {
2158 * Both external: swap the pointers
2160 swap(target->d_name.name, dentry->d_name.name);
2163 * dentry:internal, target:external. Steal target's
2164 * storage and make target internal.
2166 memcpy(target->d_iname, dentry->d_name.name,
2167 dentry->d_name.len + 1);
2168 dentry->d_name.name = target->d_name.name;
2169 target->d_name.name = target->d_iname;
2172 if (dname_external(dentry)) {
2174 * dentry:external, target:internal. Give dentry's
2175 * storage to target and make dentry internal
2177 memcpy(dentry->d_iname, target->d_name.name,
2178 target->d_name.len + 1);
2179 target->d_name.name = dentry->d_name.name;
2180 dentry->d_name.name = dentry->d_iname;
2183 * Both are internal. Just copy target to dentry
2185 memcpy(dentry->d_iname, target->d_name.name,
2186 target->d_name.len + 1);
2187 dentry->d_name.len = target->d_name.len;
2191 swap(dentry->d_name.len, target->d_name.len);
2194 static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2197 * XXXX: do we really need to take target->d_lock?
2199 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2200 spin_lock(&target->d_parent->d_lock);
2202 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2203 spin_lock(&dentry->d_parent->d_lock);
2204 spin_lock_nested(&target->d_parent->d_lock,
2205 DENTRY_D_LOCK_NESTED);
2207 spin_lock(&target->d_parent->d_lock);
2208 spin_lock_nested(&dentry->d_parent->d_lock,
2209 DENTRY_D_LOCK_NESTED);
2212 if (target < dentry) {
2213 spin_lock_nested(&target->d_lock, 2);
2214 spin_lock_nested(&dentry->d_lock, 3);
2216 spin_lock_nested(&dentry->d_lock, 2);
2217 spin_lock_nested(&target->d_lock, 3);
2221 static void dentry_unlock_parents_for_move(struct dentry *dentry,
2222 struct dentry *target)
2224 if (target->d_parent != dentry->d_parent)
2225 spin_unlock(&dentry->d_parent->d_lock);
2226 if (target->d_parent != target)
2227 spin_unlock(&target->d_parent->d_lock);
2231 * When switching names, the actual string doesn't strictly have to
2232 * be preserved in the target - because we're dropping the target
2233 * anyway. As such, we can just do a simple memcpy() to copy over
2234 * the new name before we switch.
2236 * Note that we have to be a lot more careful about getting the hash
2237 * switched - we have to switch the hash value properly even if it
2238 * then no longer matches the actual (corrupted) string of the target.
2239 * The hash value has to match the hash queue that the dentry is on..
2242 * __d_move - move a dentry
2243 * @dentry: entry to move
2244 * @target: new dentry
2246 * Update the dcache to reflect the move of a file name. Negative
2247 * dcache entries should not be moved in this way. Caller must hold
2248 * rename_lock, the i_mutex of the source and target directories,
2249 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
2251 static void __d_move(struct dentry * dentry, struct dentry * target)
2253 if (!dentry->d_inode)
2254 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2256 BUG_ON(d_ancestor(dentry, target));
2257 BUG_ON(d_ancestor(target, dentry));
2259 dentry_lock_for_move(dentry, target);
2261 write_seqcount_begin(&dentry->d_seq);
2262 write_seqcount_begin(&target->d_seq);
2264 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2267 * Move the dentry to the target hash queue. Don't bother checking
2268 * for the same hash queue because of how unlikely it is.
2271 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
2273 /* Unhash the target: dput() will then get rid of it */
2276 list_del(&dentry->d_child);
2277 list_del(&target->d_child);
2279 /* Switch the names.. */
2280 switch_names(dentry, target);
2281 swap(dentry->d_name.hash, target->d_name.hash);
2283 /* ... and switch the parents */
2284 if (IS_ROOT(dentry)) {
2285 dentry->d_parent = target->d_parent;
2286 target->d_parent = target;
2287 INIT_LIST_HEAD(&target->d_child);
2289 swap(dentry->d_parent, target->d_parent);
2291 /* And add them back to the (new) parent lists */
2292 list_add(&target->d_child, &target->d_parent->d_subdirs);
2295 list_add(&dentry->d_child, &dentry->d_parent->d_subdirs);
2297 write_seqcount_end(&target->d_seq);
2298 write_seqcount_end(&dentry->d_seq);
2300 dentry_unlock_parents_for_move(dentry, target);
2301 spin_unlock(&target->d_lock);
2302 fsnotify_d_move(dentry);
2303 spin_unlock(&dentry->d_lock);
2307 * d_move - move a dentry
2308 * @dentry: entry to move
2309 * @target: new dentry
2311 * Update the dcache to reflect the move of a file name. Negative
2312 * dcache entries should not be moved in this way. See the locking
2313 * requirements for __d_move.
2315 void d_move(struct dentry *dentry, struct dentry *target)
2317 write_seqlock(&rename_lock);
2318 __d_move(dentry, target);
2319 write_sequnlock(&rename_lock);
2321 EXPORT_SYMBOL(d_move);
2324 * d_ancestor - search for an ancestor
2325 * @p1: ancestor dentry
2328 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2329 * an ancestor of p2, else NULL.
2331 struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
2335 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
2336 if (p->d_parent == p1)
2343 * This helper attempts to cope with remotely renamed directories
2345 * It assumes that the caller is already holding
2346 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
2348 * Note: If ever the locking in lock_rename() changes, then please
2349 * remember to update this too...
2351 static struct dentry *__d_unalias(struct inode *inode,
2352 struct dentry *dentry, struct dentry *alias)
2354 struct mutex *m1 = NULL, *m2 = NULL;
2355 struct dentry *ret = ERR_PTR(-EBUSY);
2357 /* If alias and dentry share a parent, then no extra locks required */
2358 if (alias->d_parent == dentry->d_parent)
2361 /* See lock_rename() */
2362 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2364 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2365 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2367 m2 = &alias->d_parent->d_inode->i_mutex;
2369 if (likely(!d_mountpoint(alias))) {
2370 __d_move(alias, dentry);
2374 spin_unlock(&inode->i_lock);
2383 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2384 * named dentry in place of the dentry to be replaced.
2385 * returns with anon->d_lock held!
2387 static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2389 struct dentry *dparent;
2391 dentry_lock_for_move(anon, dentry);
2393 write_seqcount_begin(&dentry->d_seq);
2394 write_seqcount_begin(&anon->d_seq);
2396 dparent = dentry->d_parent;
2398 switch_names(dentry, anon);
2399 swap(dentry->d_name.hash, anon->d_name.hash);
2401 dentry->d_parent = dentry;
2402 list_del_init(&dentry->d_child);
2403 anon->d_parent = dparent;
2404 list_move(&anon->d_child, &dparent->d_subdirs);
2406 write_seqcount_end(&dentry->d_seq);
2407 write_seqcount_end(&anon->d_seq);
2409 dentry_unlock_parents_for_move(anon, dentry);
2410 spin_unlock(&dentry->d_lock);
2412 /* anon->d_lock still locked, returns locked */
2413 anon->d_flags &= ~DCACHE_DISCONNECTED;
2417 * d_materialise_unique - introduce an inode into the tree
2418 * @dentry: candidate dentry
2419 * @inode: inode to bind to the dentry, to which aliases may be attached
2421 * Introduces an dentry into the tree, substituting an extant disconnected
2422 * root directory alias in its place if there is one. Caller must hold the
2423 * i_mutex of the parent directory.
2425 struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2427 struct dentry *actual;
2429 BUG_ON(!d_unhashed(dentry));
2433 __d_instantiate(dentry, NULL);
2438 spin_lock(&inode->i_lock);
2440 if (S_ISDIR(inode->i_mode)) {
2441 struct dentry *alias;
2443 /* Does an aliased dentry already exist? */
2444 alias = __d_find_alias(inode, 0);
2447 write_seqlock(&rename_lock);
2449 if (d_ancestor(alias, dentry)) {
2450 /* Check for loops */
2451 actual = ERR_PTR(-ELOOP);
2452 spin_unlock(&inode->i_lock);
2453 } else if (IS_ROOT(alias)) {
2454 /* Is this an anonymous mountpoint that we
2455 * could splice into our tree? */
2456 __d_materialise_dentry(dentry, alias);
2457 write_sequnlock(&rename_lock);
2461 /* Nope, but we must(!) avoid directory
2462 * aliasing. This drops inode->i_lock */
2463 actual = __d_unalias(inode, dentry, alias);
2465 write_sequnlock(&rename_lock);
2466 if (IS_ERR(actual)) {
2467 if (PTR_ERR(actual) == -ELOOP)
2468 pr_warn_ratelimited(
2469 "VFS: Lookup of '%s' in %s %s"
2470 " would have caused loop\n",
2471 dentry->d_name.name,
2472 inode->i_sb->s_type->name,
2480 /* Add a unique reference */
2481 actual = __d_instantiate_unique(dentry, inode);
2485 BUG_ON(!d_unhashed(actual));
2487 spin_lock(&actual->d_lock);
2490 spin_unlock(&actual->d_lock);
2491 spin_unlock(&inode->i_lock);
2493 if (actual == dentry) {
2494 security_d_instantiate(dentry, inode);
2501 EXPORT_SYMBOL_GPL(d_materialise_unique);
2503 static int prepend(char **buffer, int *buflen, const char *str, int namelen)
2507 return -ENAMETOOLONG;
2509 memcpy(*buffer, str, namelen);
2513 static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2515 return prepend(buffer, buflen, name->name, name->len);
2519 * prepend_path - Prepend path string to a buffer
2520 * @path: the dentry/vfsmount to report
2521 * @root: root vfsmnt/dentry
2522 * @buffer: pointer to the end of the buffer
2523 * @buflen: pointer to buffer length
2525 * Caller holds the rename_lock.
2527 static int prepend_path(const struct path *path,
2528 const struct path *root,
2529 char **buffer, int *buflen)
2531 struct dentry *dentry = path->dentry;
2532 struct vfsmount *vfsmnt = path->mnt;
2533 struct mount *mnt = real_mount(vfsmnt);
2537 while (dentry != root->dentry || vfsmnt != root->mnt) {
2538 struct dentry * parent;
2540 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
2542 if (!mnt_has_parent(mnt))
2544 dentry = mnt->mnt_mountpoint;
2545 mnt = mnt->mnt_parent;
2549 parent = dentry->d_parent;
2551 spin_lock(&dentry->d_lock);
2552 error = prepend_name(buffer, buflen, &dentry->d_name);
2553 spin_unlock(&dentry->d_lock);
2555 error = prepend(buffer, buflen, "/", 1);
2563 if (!error && !slash)
2564 error = prepend(buffer, buflen, "/", 1);
2570 * Filesystems needing to implement special "root names"
2571 * should do so with ->d_dname()
2573 if (IS_ROOT(dentry) &&
2574 (dentry->d_name.len != 1 || dentry->d_name.name[0] != '/')) {
2575 WARN(1, "Root dentry has weird name <%.*s>\n",
2576 (int) dentry->d_name.len, dentry->d_name.name);
2579 error = prepend(buffer, buflen, "/", 1);
2581 error = is_mounted(vfsmnt) ? 1 : 2;
2586 * __d_path - return the path of a dentry
2587 * @path: the dentry/vfsmount to report
2588 * @root: root vfsmnt/dentry
2589 * @buf: buffer to return value in
2590 * @buflen: buffer length
2592 * Convert a dentry into an ASCII path name.
2594 * Returns a pointer into the buffer or an error code if the
2595 * path was too long.
2597 * "buflen" should be positive.
2599 * If the path is not reachable from the supplied root, return %NULL.
2601 char *__d_path(const struct path *path,
2602 const struct path *root,
2603 char *buf, int buflen)
2605 char *res = buf + buflen;
2608 prepend(&res, &buflen, "\0", 1);
2609 br_read_lock(&vfsmount_lock);
2610 write_seqlock(&rename_lock);
2611 error = prepend_path(path, root, &res, &buflen);
2612 write_sequnlock(&rename_lock);
2613 br_read_unlock(&vfsmount_lock);
2616 return ERR_PTR(error);
2622 char *d_absolute_path(const struct path *path,
2623 char *buf, int buflen)
2625 struct path root = {};
2626 char *res = buf + buflen;
2629 prepend(&res, &buflen, "\0", 1);
2630 br_read_lock(&vfsmount_lock);
2631 write_seqlock(&rename_lock);
2632 error = prepend_path(path, &root, &res, &buflen);
2633 write_sequnlock(&rename_lock);
2634 br_read_unlock(&vfsmount_lock);
2639 return ERR_PTR(error);
2644 * same as __d_path but appends "(deleted)" for unlinked files.
2646 static int path_with_deleted(const struct path *path,
2647 const struct path *root,
2648 char **buf, int *buflen)
2650 prepend(buf, buflen, "\0", 1);
2651 if (d_unlinked(path->dentry)) {
2652 int error = prepend(buf, buflen, " (deleted)", 10);
2657 return prepend_path(path, root, buf, buflen);
2660 static int prepend_unreachable(char **buffer, int *buflen)
2662 return prepend(buffer, buflen, "(unreachable)", 13);
2666 * d_path - return the path of a dentry
2667 * @path: path to report
2668 * @buf: buffer to return value in
2669 * @buflen: buffer length
2671 * Convert a dentry into an ASCII path name. If the entry has been deleted
2672 * the string " (deleted)" is appended. Note that this is ambiguous.
2674 * Returns a pointer into the buffer or an error code if the path was
2675 * too long. Note: Callers should use the returned pointer, not the passed
2676 * in buffer, to use the name! The implementation often starts at an offset
2677 * into the buffer, and may leave 0 bytes at the start.
2679 * "buflen" should be positive.
2681 char *d_path(const struct path *path, char *buf, int buflen)
2683 char *res = buf + buflen;
2688 * We have various synthetic filesystems that never get mounted. On
2689 * these filesystems dentries are never used for lookup purposes, and
2690 * thus don't need to be hashed. They also don't need a name until a
2691 * user wants to identify the object in /proc/pid/fd/. The little hack
2692 * below allows us to generate a name for these objects on demand:
2694 * Some pseudo inodes are mountable. When they are mounted
2695 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
2696 * and instead have d_path return the mounted path.
2698 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
2699 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
2700 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
2702 get_fs_root(current->fs, &root);
2703 br_read_lock(&vfsmount_lock);
2704 write_seqlock(&rename_lock);
2705 error = path_with_deleted(path, &root, &res, &buflen);
2706 write_sequnlock(&rename_lock);
2707 br_read_unlock(&vfsmount_lock);
2709 res = ERR_PTR(error);
2713 EXPORT_SYMBOL(d_path);
2716 * Helper function for dentry_operations.d_dname() members
2718 char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
2719 const char *fmt, ...)
2725 va_start(args, fmt);
2726 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
2729 if (sz > sizeof(temp) || sz > buflen)
2730 return ERR_PTR(-ENAMETOOLONG);
2732 buffer += buflen - sz;
2733 return memcpy(buffer, temp, sz);
2736 char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
2738 char *end = buffer + buflen;
2739 /* these dentries are never renamed, so d_lock is not needed */
2740 if (prepend(&end, &buflen, " (deleted)", 11) ||
2741 prepend_name(&end, &buflen, &dentry->d_name) ||
2742 prepend(&end, &buflen, "/", 1))
2743 end = ERR_PTR(-ENAMETOOLONG);
2748 * Write full pathname from the root of the filesystem into the buffer.
2750 static char *__dentry_path(struct dentry *dentry, char *buf, int buflen)
2752 char *end = buf + buflen;
2755 prepend(&end, &buflen, "\0", 1);
2762 while (!IS_ROOT(dentry)) {
2763 struct dentry *parent = dentry->d_parent;
2767 spin_lock(&dentry->d_lock);
2768 error = prepend_name(&end, &buflen, &dentry->d_name);
2769 spin_unlock(&dentry->d_lock);
2770 if (error != 0 || prepend(&end, &buflen, "/", 1) != 0)
2778 return ERR_PTR(-ENAMETOOLONG);
2781 char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
2785 write_seqlock(&rename_lock);
2786 retval = __dentry_path(dentry, buf, buflen);
2787 write_sequnlock(&rename_lock);
2791 EXPORT_SYMBOL(dentry_path_raw);
2793 char *dentry_path(struct dentry *dentry, char *buf, int buflen)
2798 write_seqlock(&rename_lock);
2799 if (d_unlinked(dentry)) {
2801 if (prepend(&p, &buflen, "//deleted", 10) != 0)
2805 retval = __dentry_path(dentry, buf, buflen);
2806 write_sequnlock(&rename_lock);
2807 if (!IS_ERR(retval) && p)
2808 *p = '/'; /* restore '/' overriden with '\0' */
2811 return ERR_PTR(-ENAMETOOLONG);
2815 * NOTE! The user-level library version returns a
2816 * character pointer. The kernel system call just
2817 * returns the length of the buffer filled (which
2818 * includes the ending '\0' character), or a negative
2819 * error value. So libc would do something like
2821 * char *getcwd(char * buf, size_t size)
2825 * retval = sys_getcwd(buf, size);
2832 SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
2835 struct path pwd, root;
2836 char *page = (char *) __get_free_page(GFP_USER);
2841 get_fs_root_and_pwd(current->fs, &root, &pwd);
2844 br_read_lock(&vfsmount_lock);
2845 write_seqlock(&rename_lock);
2846 if (!d_unlinked(pwd.dentry)) {
2848 char *cwd = page + PAGE_SIZE;
2849 int buflen = PAGE_SIZE;
2851 prepend(&cwd, &buflen, "\0", 1);
2852 error = prepend_path(&pwd, &root, &cwd, &buflen);
2853 write_sequnlock(&rename_lock);
2854 br_read_unlock(&vfsmount_lock);
2859 /* Unreachable from current root */
2861 error = prepend_unreachable(&cwd, &buflen);
2867 len = PAGE_SIZE + page - cwd;
2870 if (copy_to_user(buf, cwd, len))
2874 write_sequnlock(&rename_lock);
2875 br_read_unlock(&vfsmount_lock);
2881 free_page((unsigned long) page);
2886 * Test whether new_dentry is a subdirectory of old_dentry.
2888 * Trivially implemented using the dcache structure
2892 * is_subdir - is new dentry a subdirectory of old_dentry
2893 * @new_dentry: new dentry
2894 * @old_dentry: old dentry
2896 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
2897 * Returns 0 otherwise.
2898 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
2901 int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
2906 if (new_dentry == old_dentry)
2910 /* for restarting inner loop in case of seq retry */
2911 seq = read_seqbegin(&rename_lock);
2913 * Need rcu_readlock to protect against the d_parent trashing
2917 if (d_ancestor(old_dentry, new_dentry))
2922 } while (read_seqretry(&rename_lock, seq));
2927 void d_genocide(struct dentry *root)
2929 struct dentry *this_parent;
2930 struct list_head *next;
2934 seq = read_seqbegin(&rename_lock);
2937 spin_lock(&this_parent->d_lock);
2939 next = this_parent->d_subdirs.next;
2941 while (next != &this_parent->d_subdirs) {
2942 struct list_head *tmp = next;
2943 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
2946 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
2947 if (d_unhashed(dentry) || !dentry->d_inode) {
2948 spin_unlock(&dentry->d_lock);
2951 if (!list_empty(&dentry->d_subdirs)) {
2952 spin_unlock(&this_parent->d_lock);
2953 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
2954 this_parent = dentry;
2955 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
2958 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
2959 dentry->d_flags |= DCACHE_GENOCIDE;
2962 spin_unlock(&dentry->d_lock);
2966 if (this_parent != root) {
2967 struct dentry *child = this_parent;
2968 if (!(this_parent->d_flags & DCACHE_GENOCIDE)) {
2969 this_parent->d_flags |= DCACHE_GENOCIDE;
2970 this_parent->d_count--;
2972 this_parent = child->d_parent;
2974 spin_unlock(&child->d_lock);
2975 spin_lock(&this_parent->d_lock);
2977 /* might go back up the wrong parent if we have had a rename. */
2978 if (!locked && read_seqretry(&rename_lock, seq))
2980 next = child->d_child.next;
2981 while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED)) {
2982 if (next == &this_parent->d_subdirs)
2984 child = list_entry(next, struct dentry, d_child);
2990 if (!locked && read_seqretry(&rename_lock, seq))
2992 spin_unlock(&this_parent->d_lock);
2995 write_sequnlock(&rename_lock);
2999 spin_unlock(&this_parent->d_lock);
3004 write_seqlock(&rename_lock);
3009 * find_inode_number - check for dentry with name
3010 * @dir: directory to check
3011 * @name: Name to find.
3013 * Check whether a dentry already exists for the given name,
3014 * and return the inode number if it has an inode. Otherwise
3017 * This routine is used to post-process directory listings for
3018 * filesystems using synthetic inode numbers, and is necessary
3019 * to keep getcwd() working.
3022 ino_t find_inode_number(struct dentry *dir, struct qstr *name)
3024 struct dentry * dentry;
3027 dentry = d_hash_and_lookup(dir, name);
3028 if (!IS_ERR_OR_NULL(dentry)) {
3029 if (dentry->d_inode)
3030 ino = dentry->d_inode->i_ino;
3035 EXPORT_SYMBOL(find_inode_number);
3037 static __initdata unsigned long dhash_entries;
3038 static int __init set_dhash_entries(char *str)
3042 dhash_entries = simple_strtoul(str, &str, 0);
3045 __setup("dhash_entries=", set_dhash_entries);
3047 static void __init dcache_init_early(void)
3051 /* If hashes are distributed across NUMA nodes, defer
3052 * hash allocation until vmalloc space is available.
3058 alloc_large_system_hash("Dentry cache",
3059 sizeof(struct hlist_bl_head),
3068 for (loop = 0; loop < (1U << d_hash_shift); loop++)
3069 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
3072 static void __init dcache_init(void)
3077 * A constructor could be added for stable state like the lists,
3078 * but it is probably not worth it because of the cache nature
3081 dentry_cache = KMEM_CACHE(dentry,
3082 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
3084 /* Hash may have been set up in dcache_init_early */
3089 alloc_large_system_hash("Dentry cache",
3090 sizeof(struct hlist_bl_head),
3099 for (loop = 0; loop < (1U << d_hash_shift); loop++)
3100 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
3103 /* SLAB cache for __getname() consumers */
3104 struct kmem_cache *names_cachep __read_mostly;
3105 EXPORT_SYMBOL(names_cachep);
3107 EXPORT_SYMBOL(d_genocide);
3109 void __init vfs_caches_init_early(void)
3111 dcache_init_early();
3115 void __init vfs_caches_init(unsigned long mempages)
3117 unsigned long reserve;
3119 /* Base hash sizes on available memory, with a reserve equal to
3120 150% of current kernel size */
3122 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3123 mempages -= reserve;
3125 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
3126 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
3130 files_init(mempages);