[PATCH vfs-2.6 1/6] vfs: replace parent == dentry->d_parent by IS_ROOT()
[linux-2.6/linux-2.6-openrd.git] / fs / dcache.c
blobc6fd1f27da5777f7912c7d10bba421093d1719ce
1 /*
2 * fs/dcache.c
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
9 /*
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>
19 #include <linux/mm.h>
20 #include <linux/fdtable.h>
21 #include <linux/fs.h>
22 #include <linux/fsnotify.h>
23 #include <linux/slab.h>
24 #include <linux/init.h>
25 #include <linux/hash.h>
26 #include <linux/cache.h>
27 #include <linux/module.h>
28 #include <linux/mount.h>
29 #include <linux/file.h>
30 #include <asm/uaccess.h>
31 #include <linux/security.h>
32 #include <linux/seqlock.h>
33 #include <linux/swap.h>
34 #include <linux/bootmem.h>
35 #include "internal.h"
38 int sysctl_vfs_cache_pressure __read_mostly = 100;
39 EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
41 __cacheline_aligned_in_smp DEFINE_SPINLOCK(dcache_lock);
42 __cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
44 EXPORT_SYMBOL(dcache_lock);
46 static struct kmem_cache *dentry_cache __read_mostly;
48 #define DNAME_INLINE_LEN (sizeof(struct dentry)-offsetof(struct dentry,d_iname))
51 * This is the single most critical data structure when it comes
52 * to the dcache: the hashtable for lookups. Somebody should try
53 * to make this good - I've just made it work.
55 * This hash-function tries to avoid losing too many bits of hash
56 * information, yet avoid using a prime hash-size or similar.
58 #define D_HASHBITS d_hash_shift
59 #define D_HASHMASK d_hash_mask
61 static unsigned int d_hash_mask __read_mostly;
62 static unsigned int d_hash_shift __read_mostly;
63 static struct hlist_head *dentry_hashtable __read_mostly;
65 /* Statistics gathering. */
66 struct dentry_stat_t dentry_stat = {
67 .age_limit = 45,
70 static void __d_free(struct dentry *dentry)
72 if (dname_external(dentry))
73 kfree(dentry->d_name.name);
74 kmem_cache_free(dentry_cache, dentry);
77 static void d_callback(struct rcu_head *head)
79 struct dentry * dentry = container_of(head, struct dentry, d_u.d_rcu);
80 __d_free(dentry);
84 * no dcache_lock, please. The caller must decrement dentry_stat.nr_dentry
85 * inside dcache_lock.
87 static void d_free(struct dentry *dentry)
89 if (dentry->d_op && dentry->d_op->d_release)
90 dentry->d_op->d_release(dentry);
91 /* if dentry was never inserted into hash, immediate free is OK */
92 if (hlist_unhashed(&dentry->d_hash))
93 __d_free(dentry);
94 else
95 call_rcu(&dentry->d_u.d_rcu, d_callback);
99 * Release the dentry's inode, using the filesystem
100 * d_iput() operation if defined.
102 static void dentry_iput(struct dentry * dentry)
103 __releases(dentry->d_lock)
104 __releases(dcache_lock)
106 struct inode *inode = dentry->d_inode;
107 if (inode) {
108 dentry->d_inode = NULL;
109 list_del_init(&dentry->d_alias);
110 spin_unlock(&dentry->d_lock);
111 spin_unlock(&dcache_lock);
112 if (!inode->i_nlink)
113 fsnotify_inoderemove(inode);
114 if (dentry->d_op && dentry->d_op->d_iput)
115 dentry->d_op->d_iput(dentry, inode);
116 else
117 iput(inode);
118 } else {
119 spin_unlock(&dentry->d_lock);
120 spin_unlock(&dcache_lock);
125 * dentry_lru_(add|add_tail|del|del_init) must be called with dcache_lock held.
127 static void dentry_lru_add(struct dentry *dentry)
129 list_add(&dentry->d_lru, &dentry->d_sb->s_dentry_lru);
130 dentry->d_sb->s_nr_dentry_unused++;
131 dentry_stat.nr_unused++;
134 static void dentry_lru_add_tail(struct dentry *dentry)
136 list_add_tail(&dentry->d_lru, &dentry->d_sb->s_dentry_lru);
137 dentry->d_sb->s_nr_dentry_unused++;
138 dentry_stat.nr_unused++;
141 static void dentry_lru_del(struct dentry *dentry)
143 if (!list_empty(&dentry->d_lru)) {
144 list_del(&dentry->d_lru);
145 dentry->d_sb->s_nr_dentry_unused--;
146 dentry_stat.nr_unused--;
150 static void dentry_lru_del_init(struct dentry *dentry)
152 if (likely(!list_empty(&dentry->d_lru))) {
153 list_del_init(&dentry->d_lru);
154 dentry->d_sb->s_nr_dentry_unused--;
155 dentry_stat.nr_unused--;
160 * d_kill - kill dentry and return parent
161 * @dentry: dentry to kill
163 * The dentry must already be unhashed and removed from the LRU.
165 * If this is the root of the dentry tree, return NULL.
167 static struct dentry *d_kill(struct dentry *dentry)
168 __releases(dentry->d_lock)
169 __releases(dcache_lock)
171 struct dentry *parent;
173 list_del(&dentry->d_u.d_child);
174 dentry_stat.nr_dentry--; /* For d_free, below */
175 /*drops the locks, at that point nobody can reach this dentry */
176 dentry_iput(dentry);
177 if (IS_ROOT(dentry))
178 parent = NULL;
179 else
180 parent = dentry->d_parent;
181 d_free(dentry);
182 return parent;
186 * This is dput
188 * This is complicated by the fact that we do not want to put
189 * dentries that are no longer on any hash chain on the unused
190 * list: we'd much rather just get rid of them immediately.
192 * However, that implies that we have to traverse the dentry
193 * tree upwards to the parents which might _also_ now be
194 * scheduled for deletion (it may have been only waiting for
195 * its last child to go away).
197 * This tail recursion is done by hand as we don't want to depend
198 * on the compiler to always get this right (gcc generally doesn't).
199 * Real recursion would eat up our stack space.
203 * dput - release a dentry
204 * @dentry: dentry to release
206 * Release a dentry. This will drop the usage count and if appropriate
207 * call the dentry unlink method as well as removing it from the queues and
208 * releasing its resources. If the parent dentries were scheduled for release
209 * they too may now get deleted.
211 * no dcache lock, please.
214 void dput(struct dentry *dentry)
216 if (!dentry)
217 return;
219 repeat:
220 if (atomic_read(&dentry->d_count) == 1)
221 might_sleep();
222 if (!atomic_dec_and_lock(&dentry->d_count, &dcache_lock))
223 return;
225 spin_lock(&dentry->d_lock);
226 if (atomic_read(&dentry->d_count)) {
227 spin_unlock(&dentry->d_lock);
228 spin_unlock(&dcache_lock);
229 return;
233 * AV: ->d_delete() is _NOT_ allowed to block now.
235 if (dentry->d_op && dentry->d_op->d_delete) {
236 if (dentry->d_op->d_delete(dentry))
237 goto unhash_it;
239 /* Unreachable? Get rid of it */
240 if (d_unhashed(dentry))
241 goto kill_it;
242 if (list_empty(&dentry->d_lru)) {
243 dentry->d_flags |= DCACHE_REFERENCED;
244 dentry_lru_add(dentry);
246 spin_unlock(&dentry->d_lock);
247 spin_unlock(&dcache_lock);
248 return;
250 unhash_it:
251 __d_drop(dentry);
252 kill_it:
253 /* if dentry was on the d_lru list delete it from there */
254 dentry_lru_del(dentry);
255 dentry = d_kill(dentry);
256 if (dentry)
257 goto repeat;
261 * d_invalidate - invalidate a dentry
262 * @dentry: dentry to invalidate
264 * Try to invalidate the dentry if it turns out to be
265 * possible. If there are other dentries that can be
266 * reached through this one we can't delete it and we
267 * return -EBUSY. On success we return 0.
269 * no dcache lock.
272 int d_invalidate(struct dentry * dentry)
275 * If it's already been dropped, return OK.
277 spin_lock(&dcache_lock);
278 if (d_unhashed(dentry)) {
279 spin_unlock(&dcache_lock);
280 return 0;
283 * Check whether to do a partial shrink_dcache
284 * to get rid of unused child entries.
286 if (!list_empty(&dentry->d_subdirs)) {
287 spin_unlock(&dcache_lock);
288 shrink_dcache_parent(dentry);
289 spin_lock(&dcache_lock);
293 * Somebody else still using it?
295 * If it's a directory, we can't drop it
296 * for fear of somebody re-populating it
297 * with children (even though dropping it
298 * would make it unreachable from the root,
299 * we might still populate it if it was a
300 * working directory or similar).
302 spin_lock(&dentry->d_lock);
303 if (atomic_read(&dentry->d_count) > 1) {
304 if (dentry->d_inode && S_ISDIR(dentry->d_inode->i_mode)) {
305 spin_unlock(&dentry->d_lock);
306 spin_unlock(&dcache_lock);
307 return -EBUSY;
311 __d_drop(dentry);
312 spin_unlock(&dentry->d_lock);
313 spin_unlock(&dcache_lock);
314 return 0;
317 /* This should be called _only_ with dcache_lock held */
319 static inline struct dentry * __dget_locked(struct dentry *dentry)
321 atomic_inc(&dentry->d_count);
322 dentry_lru_del_init(dentry);
323 return dentry;
326 struct dentry * dget_locked(struct dentry *dentry)
328 return __dget_locked(dentry);
332 * d_find_alias - grab a hashed alias of inode
333 * @inode: inode in question
334 * @want_discon: flag, used by d_splice_alias, to request
335 * that only a DISCONNECTED alias be returned.
337 * If inode has a hashed alias, or is a directory and has any alias,
338 * acquire the reference to alias and return it. Otherwise return NULL.
339 * Notice that if inode is a directory there can be only one alias and
340 * it can be unhashed only if it has no children, or if it is the root
341 * of a filesystem.
343 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
344 * any other hashed alias over that one unless @want_discon is set,
345 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
348 static struct dentry * __d_find_alias(struct inode *inode, int want_discon)
350 struct list_head *head, *next, *tmp;
351 struct dentry *alias, *discon_alias=NULL;
353 head = &inode->i_dentry;
354 next = inode->i_dentry.next;
355 while (next != head) {
356 tmp = next;
357 next = tmp->next;
358 prefetch(next);
359 alias = list_entry(tmp, struct dentry, d_alias);
360 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
361 if (IS_ROOT(alias) &&
362 (alias->d_flags & DCACHE_DISCONNECTED))
363 discon_alias = alias;
364 else if (!want_discon) {
365 __dget_locked(alias);
366 return alias;
370 if (discon_alias)
371 __dget_locked(discon_alias);
372 return discon_alias;
375 struct dentry * d_find_alias(struct inode *inode)
377 struct dentry *de = NULL;
379 if (!list_empty(&inode->i_dentry)) {
380 spin_lock(&dcache_lock);
381 de = __d_find_alias(inode, 0);
382 spin_unlock(&dcache_lock);
384 return de;
388 * Try to kill dentries associated with this inode.
389 * WARNING: you must own a reference to inode.
391 void d_prune_aliases(struct inode *inode)
393 struct dentry *dentry;
394 restart:
395 spin_lock(&dcache_lock);
396 list_for_each_entry(dentry, &inode->i_dentry, d_alias) {
397 spin_lock(&dentry->d_lock);
398 if (!atomic_read(&dentry->d_count)) {
399 __dget_locked(dentry);
400 __d_drop(dentry);
401 spin_unlock(&dentry->d_lock);
402 spin_unlock(&dcache_lock);
403 dput(dentry);
404 goto restart;
406 spin_unlock(&dentry->d_lock);
408 spin_unlock(&dcache_lock);
412 * Throw away a dentry - free the inode, dput the parent. This requires that
413 * the LRU list has already been removed.
415 * Try to prune ancestors as well. This is necessary to prevent
416 * quadratic behavior of shrink_dcache_parent(), but is also expected
417 * to be beneficial in reducing dentry cache fragmentation.
419 static void prune_one_dentry(struct dentry * dentry)
420 __releases(dentry->d_lock)
421 __releases(dcache_lock)
422 __acquires(dcache_lock)
424 __d_drop(dentry);
425 dentry = d_kill(dentry);
428 * Prune ancestors. Locking is simpler than in dput(),
429 * because dcache_lock needs to be taken anyway.
431 spin_lock(&dcache_lock);
432 while (dentry) {
433 if (!atomic_dec_and_lock(&dentry->d_count, &dentry->d_lock))
434 return;
436 if (dentry->d_op && dentry->d_op->d_delete)
437 dentry->d_op->d_delete(dentry);
438 dentry_lru_del_init(dentry);
439 __d_drop(dentry);
440 dentry = d_kill(dentry);
441 spin_lock(&dcache_lock);
446 * Shrink the dentry LRU on a given superblock.
447 * @sb : superblock to shrink dentry LRU.
448 * @count: If count is NULL, we prune all dentries on superblock.
449 * @flags: If flags is non-zero, we need to do special processing based on
450 * which flags are set. This means we don't need to maintain multiple
451 * similar copies of this loop.
453 static void __shrink_dcache_sb(struct super_block *sb, int *count, int flags)
455 LIST_HEAD(referenced);
456 LIST_HEAD(tmp);
457 struct dentry *dentry;
458 int cnt = 0;
460 BUG_ON(!sb);
461 BUG_ON((flags & DCACHE_REFERENCED) && count == NULL);
462 spin_lock(&dcache_lock);
463 if (count != NULL)
464 /* called from prune_dcache() and shrink_dcache_parent() */
465 cnt = *count;
466 restart:
467 if (count == NULL)
468 list_splice_init(&sb->s_dentry_lru, &tmp);
469 else {
470 while (!list_empty(&sb->s_dentry_lru)) {
471 dentry = list_entry(sb->s_dentry_lru.prev,
472 struct dentry, d_lru);
473 BUG_ON(dentry->d_sb != sb);
475 spin_lock(&dentry->d_lock);
477 * If we are honouring the DCACHE_REFERENCED flag and
478 * the dentry has this flag set, don't free it. Clear
479 * the flag and put it back on the LRU.
481 if ((flags & DCACHE_REFERENCED)
482 && (dentry->d_flags & DCACHE_REFERENCED)) {
483 dentry->d_flags &= ~DCACHE_REFERENCED;
484 list_move_tail(&dentry->d_lru, &referenced);
485 spin_unlock(&dentry->d_lock);
486 } else {
487 list_move_tail(&dentry->d_lru, &tmp);
488 spin_unlock(&dentry->d_lock);
489 cnt--;
490 if (!cnt)
491 break;
493 cond_resched_lock(&dcache_lock);
496 while (!list_empty(&tmp)) {
497 dentry = list_entry(tmp.prev, struct dentry, d_lru);
498 dentry_lru_del_init(dentry);
499 spin_lock(&dentry->d_lock);
501 * We found an inuse dentry which was not removed from
502 * the LRU because of laziness during lookup. Do not free
503 * it - just keep it off the LRU list.
505 if (atomic_read(&dentry->d_count)) {
506 spin_unlock(&dentry->d_lock);
507 continue;
509 prune_one_dentry(dentry);
510 /* dentry->d_lock was dropped in prune_one_dentry() */
511 cond_resched_lock(&dcache_lock);
513 if (count == NULL && !list_empty(&sb->s_dentry_lru))
514 goto restart;
515 if (count != NULL)
516 *count = cnt;
517 if (!list_empty(&referenced))
518 list_splice(&referenced, &sb->s_dentry_lru);
519 spin_unlock(&dcache_lock);
523 * prune_dcache - shrink the dcache
524 * @count: number of entries to try to free
526 * Shrink the dcache. This is done when we need more memory, or simply when we
527 * need to unmount something (at which point we need to unuse all dentries).
529 * This function may fail to free any resources if all the dentries are in use.
531 static void prune_dcache(int count)
533 struct super_block *sb;
534 int w_count;
535 int unused = dentry_stat.nr_unused;
536 int prune_ratio;
537 int pruned;
539 if (unused == 0 || count == 0)
540 return;
541 spin_lock(&dcache_lock);
542 restart:
543 if (count >= unused)
544 prune_ratio = 1;
545 else
546 prune_ratio = unused / count;
547 spin_lock(&sb_lock);
548 list_for_each_entry(sb, &super_blocks, s_list) {
549 if (sb->s_nr_dentry_unused == 0)
550 continue;
551 sb->s_count++;
552 /* Now, we reclaim unused dentrins with fairness.
553 * We reclaim them same percentage from each superblock.
554 * We calculate number of dentries to scan on this sb
555 * as follows, but the implementation is arranged to avoid
556 * overflows:
557 * number of dentries to scan on this sb =
558 * count * (number of dentries on this sb /
559 * number of dentries in the machine)
561 spin_unlock(&sb_lock);
562 if (prune_ratio != 1)
563 w_count = (sb->s_nr_dentry_unused / prune_ratio) + 1;
564 else
565 w_count = sb->s_nr_dentry_unused;
566 pruned = w_count;
568 * We need to be sure this filesystem isn't being unmounted,
569 * otherwise we could race with generic_shutdown_super(), and
570 * end up holding a reference to an inode while the filesystem
571 * is unmounted. So we try to get s_umount, and make sure
572 * s_root isn't NULL.
574 if (down_read_trylock(&sb->s_umount)) {
575 if ((sb->s_root != NULL) &&
576 (!list_empty(&sb->s_dentry_lru))) {
577 spin_unlock(&dcache_lock);
578 __shrink_dcache_sb(sb, &w_count,
579 DCACHE_REFERENCED);
580 pruned -= w_count;
581 spin_lock(&dcache_lock);
583 up_read(&sb->s_umount);
585 spin_lock(&sb_lock);
586 count -= pruned;
588 * restart only when sb is no longer on the list and
589 * we have more work to do.
591 if (__put_super_and_need_restart(sb) && count > 0) {
592 spin_unlock(&sb_lock);
593 goto restart;
596 spin_unlock(&sb_lock);
597 spin_unlock(&dcache_lock);
601 * shrink_dcache_sb - shrink dcache for a superblock
602 * @sb: superblock
604 * Shrink the dcache for the specified super block. This
605 * is used to free the dcache before unmounting a file
606 * system
608 void shrink_dcache_sb(struct super_block * sb)
610 __shrink_dcache_sb(sb, NULL, 0);
614 * destroy a single subtree of dentries for unmount
615 * - see the comments on shrink_dcache_for_umount() for a description of the
616 * locking
618 static void shrink_dcache_for_umount_subtree(struct dentry *dentry)
620 struct dentry *parent;
621 unsigned detached = 0;
623 BUG_ON(!IS_ROOT(dentry));
625 /* detach this root from the system */
626 spin_lock(&dcache_lock);
627 dentry_lru_del_init(dentry);
628 __d_drop(dentry);
629 spin_unlock(&dcache_lock);
631 for (;;) {
632 /* descend to the first leaf in the current subtree */
633 while (!list_empty(&dentry->d_subdirs)) {
634 struct dentry *loop;
636 /* this is a branch with children - detach all of them
637 * from the system in one go */
638 spin_lock(&dcache_lock);
639 list_for_each_entry(loop, &dentry->d_subdirs,
640 d_u.d_child) {
641 dentry_lru_del_init(loop);
642 __d_drop(loop);
643 cond_resched_lock(&dcache_lock);
645 spin_unlock(&dcache_lock);
647 /* move to the first child */
648 dentry = list_entry(dentry->d_subdirs.next,
649 struct dentry, d_u.d_child);
652 /* consume the dentries from this leaf up through its parents
653 * until we find one with children or run out altogether */
654 do {
655 struct inode *inode;
657 if (atomic_read(&dentry->d_count) != 0) {
658 printk(KERN_ERR
659 "BUG: Dentry %p{i=%lx,n=%s}"
660 " still in use (%d)"
661 " [unmount of %s %s]\n",
662 dentry,
663 dentry->d_inode ?
664 dentry->d_inode->i_ino : 0UL,
665 dentry->d_name.name,
666 atomic_read(&dentry->d_count),
667 dentry->d_sb->s_type->name,
668 dentry->d_sb->s_id);
669 BUG();
672 if (IS_ROOT(dentry))
673 parent = NULL;
674 else {
675 parent = dentry->d_parent;
676 atomic_dec(&parent->d_count);
679 list_del(&dentry->d_u.d_child);
680 detached++;
682 inode = dentry->d_inode;
683 if (inode) {
684 dentry->d_inode = NULL;
685 list_del_init(&dentry->d_alias);
686 if (dentry->d_op && dentry->d_op->d_iput)
687 dentry->d_op->d_iput(dentry, inode);
688 else
689 iput(inode);
692 d_free(dentry);
694 /* finished when we fall off the top of the tree,
695 * otherwise we ascend to the parent and move to the
696 * next sibling if there is one */
697 if (!parent)
698 goto out;
700 dentry = parent;
702 } while (list_empty(&dentry->d_subdirs));
704 dentry = list_entry(dentry->d_subdirs.next,
705 struct dentry, d_u.d_child);
707 out:
708 /* several dentries were freed, need to correct nr_dentry */
709 spin_lock(&dcache_lock);
710 dentry_stat.nr_dentry -= detached;
711 spin_unlock(&dcache_lock);
715 * destroy the dentries attached to a superblock on unmounting
716 * - we don't need to use dentry->d_lock, and only need dcache_lock when
717 * removing the dentry from the system lists and hashes because:
718 * - the superblock is detached from all mountings and open files, so the
719 * dentry trees will not be rearranged by the VFS
720 * - s_umount is write-locked, so the memory pressure shrinker will ignore
721 * any dentries belonging to this superblock that it comes across
722 * - the filesystem itself is no longer permitted to rearrange the dentries
723 * in this superblock
725 void shrink_dcache_for_umount(struct super_block *sb)
727 struct dentry *dentry;
729 if (down_read_trylock(&sb->s_umount))
730 BUG();
732 dentry = sb->s_root;
733 sb->s_root = NULL;
734 atomic_dec(&dentry->d_count);
735 shrink_dcache_for_umount_subtree(dentry);
737 while (!hlist_empty(&sb->s_anon)) {
738 dentry = hlist_entry(sb->s_anon.first, struct dentry, d_hash);
739 shrink_dcache_for_umount_subtree(dentry);
744 * Search for at least 1 mount point in the dentry's subdirs.
745 * We descend to the next level whenever the d_subdirs
746 * list is non-empty and continue searching.
750 * have_submounts - check for mounts over a dentry
751 * @parent: dentry to check.
753 * Return true if the parent or its subdirectories contain
754 * a mount point
757 int have_submounts(struct dentry *parent)
759 struct dentry *this_parent = parent;
760 struct list_head *next;
762 spin_lock(&dcache_lock);
763 if (d_mountpoint(parent))
764 goto positive;
765 repeat:
766 next = this_parent->d_subdirs.next;
767 resume:
768 while (next != &this_parent->d_subdirs) {
769 struct list_head *tmp = next;
770 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
771 next = tmp->next;
772 /* Have we found a mount point ? */
773 if (d_mountpoint(dentry))
774 goto positive;
775 if (!list_empty(&dentry->d_subdirs)) {
776 this_parent = dentry;
777 goto repeat;
781 * All done at this level ... ascend and resume the search.
783 if (this_parent != parent) {
784 next = this_parent->d_u.d_child.next;
785 this_parent = this_parent->d_parent;
786 goto resume;
788 spin_unlock(&dcache_lock);
789 return 0; /* No mount points found in tree */
790 positive:
791 spin_unlock(&dcache_lock);
792 return 1;
796 * Search the dentry child list for the specified parent,
797 * and move any unused dentries to the end of the unused
798 * list for prune_dcache(). We descend to the next level
799 * whenever the d_subdirs list is non-empty and continue
800 * searching.
802 * It returns zero iff there are no unused children,
803 * otherwise it returns the number of children moved to
804 * the end of the unused list. This may not be the total
805 * number of unused children, because select_parent can
806 * drop the lock and return early due to latency
807 * constraints.
809 static int select_parent(struct dentry * parent)
811 struct dentry *this_parent = parent;
812 struct list_head *next;
813 int found = 0;
815 spin_lock(&dcache_lock);
816 repeat:
817 next = this_parent->d_subdirs.next;
818 resume:
819 while (next != &this_parent->d_subdirs) {
820 struct list_head *tmp = next;
821 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
822 next = tmp->next;
824 dentry_lru_del_init(dentry);
826 * move only zero ref count dentries to the end
827 * of the unused list for prune_dcache
829 if (!atomic_read(&dentry->d_count)) {
830 dentry_lru_add_tail(dentry);
831 found++;
835 * We can return to the caller if we have found some (this
836 * ensures forward progress). We'll be coming back to find
837 * the rest.
839 if (found && need_resched())
840 goto out;
843 * Descend a level if the d_subdirs list is non-empty.
845 if (!list_empty(&dentry->d_subdirs)) {
846 this_parent = dentry;
847 goto repeat;
851 * All done at this level ... ascend and resume the search.
853 if (this_parent != parent) {
854 next = this_parent->d_u.d_child.next;
855 this_parent = this_parent->d_parent;
856 goto resume;
858 out:
859 spin_unlock(&dcache_lock);
860 return found;
864 * shrink_dcache_parent - prune dcache
865 * @parent: parent of entries to prune
867 * Prune the dcache to remove unused children of the parent dentry.
870 void shrink_dcache_parent(struct dentry * parent)
872 struct super_block *sb = parent->d_sb;
873 int found;
875 while ((found = select_parent(parent)) != 0)
876 __shrink_dcache_sb(sb, &found, 0);
880 * Scan `nr' dentries and return the number which remain.
882 * We need to avoid reentering the filesystem if the caller is performing a
883 * GFP_NOFS allocation attempt. One example deadlock is:
885 * ext2_new_block->getblk->GFP->shrink_dcache_memory->prune_dcache->
886 * prune_one_dentry->dput->dentry_iput->iput->inode->i_sb->s_op->put_inode->
887 * ext2_discard_prealloc->ext2_free_blocks->lock_super->DEADLOCK.
889 * In this case we return -1 to tell the caller that we baled.
891 static int shrink_dcache_memory(int nr, gfp_t gfp_mask)
893 if (nr) {
894 if (!(gfp_mask & __GFP_FS))
895 return -1;
896 prune_dcache(nr);
898 return (dentry_stat.nr_unused / 100) * sysctl_vfs_cache_pressure;
901 static struct shrinker dcache_shrinker = {
902 .shrink = shrink_dcache_memory,
903 .seeks = DEFAULT_SEEKS,
907 * d_alloc - allocate a dcache entry
908 * @parent: parent of entry to allocate
909 * @name: qstr of the name
911 * Allocates a dentry. It returns %NULL if there is insufficient memory
912 * available. On a success the dentry is returned. The name passed in is
913 * copied and the copy passed in may be reused after this call.
916 struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
918 struct dentry *dentry;
919 char *dname;
921 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
922 if (!dentry)
923 return NULL;
925 if (name->len > DNAME_INLINE_LEN-1) {
926 dname = kmalloc(name->len + 1, GFP_KERNEL);
927 if (!dname) {
928 kmem_cache_free(dentry_cache, dentry);
929 return NULL;
931 } else {
932 dname = dentry->d_iname;
934 dentry->d_name.name = dname;
936 dentry->d_name.len = name->len;
937 dentry->d_name.hash = name->hash;
938 memcpy(dname, name->name, name->len);
939 dname[name->len] = 0;
941 atomic_set(&dentry->d_count, 1);
942 dentry->d_flags = DCACHE_UNHASHED;
943 spin_lock_init(&dentry->d_lock);
944 dentry->d_inode = NULL;
945 dentry->d_parent = NULL;
946 dentry->d_sb = NULL;
947 dentry->d_op = NULL;
948 dentry->d_fsdata = NULL;
949 dentry->d_mounted = 0;
950 #ifdef CONFIG_PROFILING
951 dentry->d_cookie = NULL;
952 #endif
953 INIT_HLIST_NODE(&dentry->d_hash);
954 INIT_LIST_HEAD(&dentry->d_lru);
955 INIT_LIST_HEAD(&dentry->d_subdirs);
956 INIT_LIST_HEAD(&dentry->d_alias);
958 if (parent) {
959 dentry->d_parent = dget(parent);
960 dentry->d_sb = parent->d_sb;
961 } else {
962 INIT_LIST_HEAD(&dentry->d_u.d_child);
965 spin_lock(&dcache_lock);
966 if (parent)
967 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
968 dentry_stat.nr_dentry++;
969 spin_unlock(&dcache_lock);
971 return dentry;
974 struct dentry *d_alloc_name(struct dentry *parent, const char *name)
976 struct qstr q;
978 q.name = name;
979 q.len = strlen(name);
980 q.hash = full_name_hash(q.name, q.len);
981 return d_alloc(parent, &q);
985 * d_instantiate - fill in inode information for a dentry
986 * @entry: dentry to complete
987 * @inode: inode to attach to this dentry
989 * Fill in inode information in the entry.
991 * This turns negative dentries into productive full members
992 * of society.
994 * NOTE! This assumes that the inode count has been incremented
995 * (or otherwise set) by the caller to indicate that it is now
996 * in use by the dcache.
999 void d_instantiate(struct dentry *entry, struct inode * inode)
1001 BUG_ON(!list_empty(&entry->d_alias));
1002 spin_lock(&dcache_lock);
1003 if (inode)
1004 list_add(&entry->d_alias, &inode->i_dentry);
1005 entry->d_inode = inode;
1006 fsnotify_d_instantiate(entry, inode);
1007 spin_unlock(&dcache_lock);
1008 security_d_instantiate(entry, inode);
1012 * d_instantiate_unique - instantiate a non-aliased dentry
1013 * @entry: dentry to instantiate
1014 * @inode: inode to attach to this dentry
1016 * Fill in inode information in the entry. On success, it returns NULL.
1017 * If an unhashed alias of "entry" already exists, then we return the
1018 * aliased dentry instead and drop one reference to inode.
1020 * Note that in order to avoid conflicts with rename() etc, the caller
1021 * had better be holding the parent directory semaphore.
1023 * This also assumes that the inode count has been incremented
1024 * (or otherwise set) by the caller to indicate that it is now
1025 * in use by the dcache.
1027 static struct dentry *__d_instantiate_unique(struct dentry *entry,
1028 struct inode *inode)
1030 struct dentry *alias;
1031 int len = entry->d_name.len;
1032 const char *name = entry->d_name.name;
1033 unsigned int hash = entry->d_name.hash;
1035 if (!inode) {
1036 entry->d_inode = NULL;
1037 return NULL;
1040 list_for_each_entry(alias, &inode->i_dentry, d_alias) {
1041 struct qstr *qstr = &alias->d_name;
1043 if (qstr->hash != hash)
1044 continue;
1045 if (alias->d_parent != entry->d_parent)
1046 continue;
1047 if (qstr->len != len)
1048 continue;
1049 if (memcmp(qstr->name, name, len))
1050 continue;
1051 dget_locked(alias);
1052 return alias;
1055 list_add(&entry->d_alias, &inode->i_dentry);
1056 entry->d_inode = inode;
1057 fsnotify_d_instantiate(entry, inode);
1058 return NULL;
1061 struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1063 struct dentry *result;
1065 BUG_ON(!list_empty(&entry->d_alias));
1067 spin_lock(&dcache_lock);
1068 result = __d_instantiate_unique(entry, inode);
1069 spin_unlock(&dcache_lock);
1071 if (!result) {
1072 security_d_instantiate(entry, inode);
1073 return NULL;
1076 BUG_ON(!d_unhashed(result));
1077 iput(inode);
1078 return result;
1081 EXPORT_SYMBOL(d_instantiate_unique);
1084 * d_alloc_root - allocate root dentry
1085 * @root_inode: inode to allocate the root for
1087 * Allocate a root ("/") dentry for the inode given. The inode is
1088 * instantiated and returned. %NULL is returned if there is insufficient
1089 * memory or the inode passed is %NULL.
1092 struct dentry * d_alloc_root(struct inode * root_inode)
1094 struct dentry *res = NULL;
1096 if (root_inode) {
1097 static const struct qstr name = { .name = "/", .len = 1 };
1099 res = d_alloc(NULL, &name);
1100 if (res) {
1101 res->d_sb = root_inode->i_sb;
1102 res->d_parent = res;
1103 d_instantiate(res, root_inode);
1106 return res;
1109 static inline struct hlist_head *d_hash(struct dentry *parent,
1110 unsigned long hash)
1112 hash += ((unsigned long) parent ^ GOLDEN_RATIO_PRIME) / L1_CACHE_BYTES;
1113 hash = hash ^ ((hash ^ GOLDEN_RATIO_PRIME) >> D_HASHBITS);
1114 return dentry_hashtable + (hash & D_HASHMASK);
1118 * d_obtain_alias - find or allocate a dentry for a given inode
1119 * @inode: inode to allocate the dentry for
1121 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1122 * similar open by handle operations. The returned dentry may be anonymous,
1123 * or may have a full name (if the inode was already in the cache).
1125 * When called on a directory inode, we must ensure that the inode only ever
1126 * has one dentry. If a dentry is found, that is returned instead of
1127 * allocating a new one.
1129 * On successful return, the reference to the inode has been transferred
1130 * to the dentry. In case of an error the reference on the inode is released.
1131 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1132 * be passed in and will be the error will be propagate to the return value,
1133 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1135 struct dentry *d_obtain_alias(struct inode *inode)
1137 static const struct qstr anonstring = { .name = "" };
1138 struct dentry *tmp;
1139 struct dentry *res;
1141 if (!inode)
1142 return ERR_PTR(-ESTALE);
1143 if (IS_ERR(inode))
1144 return ERR_CAST(inode);
1146 res = d_find_alias(inode);
1147 if (res)
1148 goto out_iput;
1150 tmp = d_alloc(NULL, &anonstring);
1151 if (!tmp) {
1152 res = ERR_PTR(-ENOMEM);
1153 goto out_iput;
1155 tmp->d_parent = tmp; /* make sure dput doesn't croak */
1157 spin_lock(&dcache_lock);
1158 res = __d_find_alias(inode, 0);
1159 if (res) {
1160 spin_unlock(&dcache_lock);
1161 dput(tmp);
1162 goto out_iput;
1165 /* attach a disconnected dentry */
1166 spin_lock(&tmp->d_lock);
1167 tmp->d_sb = inode->i_sb;
1168 tmp->d_inode = inode;
1169 tmp->d_flags |= DCACHE_DISCONNECTED;
1170 tmp->d_flags &= ~DCACHE_UNHASHED;
1171 list_add(&tmp->d_alias, &inode->i_dentry);
1172 hlist_add_head(&tmp->d_hash, &inode->i_sb->s_anon);
1173 spin_unlock(&tmp->d_lock);
1175 spin_unlock(&dcache_lock);
1176 return tmp;
1178 out_iput:
1179 iput(inode);
1180 return res;
1182 EXPORT_SYMBOL_GPL(d_obtain_alias);
1185 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1186 * @inode: the inode which may have a disconnected dentry
1187 * @dentry: a negative dentry which we want to point to the inode.
1189 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1190 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1191 * and return it, else simply d_add the inode to the dentry and return NULL.
1193 * This is needed in the lookup routine of any filesystem that is exportable
1194 * (via knfsd) so that we can build dcache paths to directories effectively.
1196 * If a dentry was found and moved, then it is returned. Otherwise NULL
1197 * is returned. This matches the expected return value of ->lookup.
1200 struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1202 struct dentry *new = NULL;
1204 if (inode && S_ISDIR(inode->i_mode)) {
1205 spin_lock(&dcache_lock);
1206 new = __d_find_alias(inode, 1);
1207 if (new) {
1208 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
1209 fsnotify_d_instantiate(new, inode);
1210 spin_unlock(&dcache_lock);
1211 security_d_instantiate(new, inode);
1212 d_rehash(dentry);
1213 d_move(new, dentry);
1214 iput(inode);
1215 } else {
1216 /* d_instantiate takes dcache_lock, so we do it by hand */
1217 list_add(&dentry->d_alias, &inode->i_dentry);
1218 dentry->d_inode = inode;
1219 fsnotify_d_instantiate(dentry, inode);
1220 spin_unlock(&dcache_lock);
1221 security_d_instantiate(dentry, inode);
1222 d_rehash(dentry);
1224 } else
1225 d_add(dentry, inode);
1226 return new;
1230 * d_add_ci - lookup or allocate new dentry with case-exact name
1231 * @inode: the inode case-insensitive lookup has found
1232 * @dentry: the negative dentry that was passed to the parent's lookup func
1233 * @name: the case-exact name to be associated with the returned dentry
1235 * This is to avoid filling the dcache with case-insensitive names to the
1236 * same inode, only the actual correct case is stored in the dcache for
1237 * case-insensitive filesystems.
1239 * For a case-insensitive lookup match and if the the case-exact dentry
1240 * already exists in in the dcache, use it and return it.
1242 * If no entry exists with the exact case name, allocate new dentry with
1243 * the exact case, and return the spliced entry.
1245 struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
1246 struct qstr *name)
1248 int error;
1249 struct dentry *found;
1250 struct dentry *new;
1252 /* Does a dentry matching the name exist already? */
1253 found = d_hash_and_lookup(dentry->d_parent, name);
1254 /* If not, create it now and return */
1255 if (!found) {
1256 new = d_alloc(dentry->d_parent, name);
1257 if (!new) {
1258 error = -ENOMEM;
1259 goto err_out;
1261 found = d_splice_alias(inode, new);
1262 if (found) {
1263 dput(new);
1264 return found;
1266 return new;
1268 /* Matching dentry exists, check if it is negative. */
1269 if (found->d_inode) {
1270 if (unlikely(found->d_inode != inode)) {
1271 /* This can't happen because bad inodes are unhashed. */
1272 BUG_ON(!is_bad_inode(inode));
1273 BUG_ON(!is_bad_inode(found->d_inode));
1276 * Already have the inode and the dentry attached, decrement
1277 * the reference count to balance the iget() done
1278 * earlier on. We found the dentry using d_lookup() so it
1279 * cannot be disconnected and thus we do not need to worry
1280 * about any NFS/disconnectedness issues here.
1282 iput(inode);
1283 return found;
1286 * Negative dentry: instantiate it unless the inode is a directory and
1287 * has a 'disconnected' dentry (i.e. IS_ROOT and DCACHE_DISCONNECTED),
1288 * in which case d_move() that in place of the found dentry.
1290 if (!S_ISDIR(inode->i_mode)) {
1291 /* Not a directory; everything is easy. */
1292 d_instantiate(found, inode);
1293 return found;
1295 spin_lock(&dcache_lock);
1296 if (list_empty(&inode->i_dentry)) {
1298 * Directory without a 'disconnected' dentry; we need to do
1299 * d_instantiate() by hand because it takes dcache_lock which
1300 * we already hold.
1302 list_add(&found->d_alias, &inode->i_dentry);
1303 found->d_inode = inode;
1304 spin_unlock(&dcache_lock);
1305 security_d_instantiate(found, inode);
1306 return found;
1309 * Directory with a 'disconnected' dentry; get a reference to the
1310 * 'disconnected' dentry.
1312 new = list_entry(inode->i_dentry.next, struct dentry, d_alias);
1313 dget_locked(new);
1314 spin_unlock(&dcache_lock);
1315 /* Do security vodoo. */
1316 security_d_instantiate(found, inode);
1317 /* Move new in place of found. */
1318 d_move(new, found);
1319 /* Balance the iget() we did above. */
1320 iput(inode);
1321 /* Throw away found. */
1322 dput(found);
1323 /* Use new as the actual dentry. */
1324 return new;
1326 err_out:
1327 iput(inode);
1328 return ERR_PTR(error);
1332 * d_lookup - search for a dentry
1333 * @parent: parent dentry
1334 * @name: qstr of name we wish to find
1336 * Searches the children of the parent dentry for the name in question. If
1337 * the dentry is found its reference count is incremented and the dentry
1338 * is returned. The caller must use d_put to free the entry when it has
1339 * finished using it. %NULL is returned on failure.
1341 * __d_lookup is dcache_lock free. The hash list is protected using RCU.
1342 * Memory barriers are used while updating and doing lockless traversal.
1343 * To avoid races with d_move while rename is happening, d_lock is used.
1345 * Overflows in memcmp(), while d_move, are avoided by keeping the length
1346 * and name pointer in one structure pointed by d_qstr.
1348 * rcu_read_lock() and rcu_read_unlock() are used to disable preemption while
1349 * lookup is going on.
1351 * The dentry unused LRU is not updated even if lookup finds the required dentry
1352 * in there. It is updated in places such as prune_dcache, shrink_dcache_sb,
1353 * select_parent and __dget_locked. This laziness saves lookup from dcache_lock
1354 * acquisition.
1356 * d_lookup() is protected against the concurrent renames in some unrelated
1357 * directory using the seqlockt_t rename_lock.
1360 struct dentry * d_lookup(struct dentry * parent, struct qstr * name)
1362 struct dentry * dentry = NULL;
1363 unsigned long seq;
1365 do {
1366 seq = read_seqbegin(&rename_lock);
1367 dentry = __d_lookup(parent, name);
1368 if (dentry)
1369 break;
1370 } while (read_seqretry(&rename_lock, seq));
1371 return dentry;
1374 struct dentry * __d_lookup(struct dentry * parent, struct qstr * name)
1376 unsigned int len = name->len;
1377 unsigned int hash = name->hash;
1378 const unsigned char *str = name->name;
1379 struct hlist_head *head = d_hash(parent,hash);
1380 struct dentry *found = NULL;
1381 struct hlist_node *node;
1382 struct dentry *dentry;
1384 rcu_read_lock();
1386 hlist_for_each_entry_rcu(dentry, node, head, d_hash) {
1387 struct qstr *qstr;
1389 if (dentry->d_name.hash != hash)
1390 continue;
1391 if (dentry->d_parent != parent)
1392 continue;
1394 spin_lock(&dentry->d_lock);
1397 * Recheck the dentry after taking the lock - d_move may have
1398 * changed things. Don't bother checking the hash because we're
1399 * about to compare the whole name anyway.
1401 if (dentry->d_parent != parent)
1402 goto next;
1404 /* non-existing due to RCU? */
1405 if (d_unhashed(dentry))
1406 goto next;
1409 * It is safe to compare names since d_move() cannot
1410 * change the qstr (protected by d_lock).
1412 qstr = &dentry->d_name;
1413 if (parent->d_op && parent->d_op->d_compare) {
1414 if (parent->d_op->d_compare(parent, qstr, name))
1415 goto next;
1416 } else {
1417 if (qstr->len != len)
1418 goto next;
1419 if (memcmp(qstr->name, str, len))
1420 goto next;
1423 atomic_inc(&dentry->d_count);
1424 found = dentry;
1425 spin_unlock(&dentry->d_lock);
1426 break;
1427 next:
1428 spin_unlock(&dentry->d_lock);
1430 rcu_read_unlock();
1432 return found;
1436 * d_hash_and_lookup - hash the qstr then search for a dentry
1437 * @dir: Directory to search in
1438 * @name: qstr of name we wish to find
1440 * On hash failure or on lookup failure NULL is returned.
1442 struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
1444 struct dentry *dentry = NULL;
1447 * Check for a fs-specific hash function. Note that we must
1448 * calculate the standard hash first, as the d_op->d_hash()
1449 * routine may choose to leave the hash value unchanged.
1451 name->hash = full_name_hash(name->name, name->len);
1452 if (dir->d_op && dir->d_op->d_hash) {
1453 if (dir->d_op->d_hash(dir, name) < 0)
1454 goto out;
1456 dentry = d_lookup(dir, name);
1457 out:
1458 return dentry;
1462 * d_validate - verify dentry provided from insecure source
1463 * @dentry: The dentry alleged to be valid child of @dparent
1464 * @dparent: The parent dentry (known to be valid)
1465 * @hash: Hash of the dentry
1466 * @len: Length of the name
1468 * An insecure source has sent us a dentry, here we verify it and dget() it.
1469 * This is used by ncpfs in its readdir implementation.
1470 * Zero is returned in the dentry is invalid.
1473 int d_validate(struct dentry *dentry, struct dentry *dparent)
1475 struct hlist_head *base;
1476 struct hlist_node *lhp;
1478 /* Check whether the ptr might be valid at all.. */
1479 if (!kmem_ptr_validate(dentry_cache, dentry))
1480 goto out;
1482 if (dentry->d_parent != dparent)
1483 goto out;
1485 spin_lock(&dcache_lock);
1486 base = d_hash(dparent, dentry->d_name.hash);
1487 hlist_for_each(lhp,base) {
1488 /* hlist_for_each_entry_rcu() not required for d_hash list
1489 * as it is parsed under dcache_lock
1491 if (dentry == hlist_entry(lhp, struct dentry, d_hash)) {
1492 __dget_locked(dentry);
1493 spin_unlock(&dcache_lock);
1494 return 1;
1497 spin_unlock(&dcache_lock);
1498 out:
1499 return 0;
1503 * When a file is deleted, we have two options:
1504 * - turn this dentry into a negative dentry
1505 * - unhash this dentry and free it.
1507 * Usually, we want to just turn this into
1508 * a negative dentry, but if anybody else is
1509 * currently using the dentry or the inode
1510 * we can't do that and we fall back on removing
1511 * it from the hash queues and waiting for
1512 * it to be deleted later when it has no users
1516 * d_delete - delete a dentry
1517 * @dentry: The dentry to delete
1519 * Turn the dentry into a negative dentry if possible, otherwise
1520 * remove it from the hash queues so it can be deleted later
1523 void d_delete(struct dentry * dentry)
1525 int isdir = 0;
1527 * Are we the only user?
1529 spin_lock(&dcache_lock);
1530 spin_lock(&dentry->d_lock);
1531 isdir = S_ISDIR(dentry->d_inode->i_mode);
1532 if (atomic_read(&dentry->d_count) == 1) {
1533 dentry_iput(dentry);
1534 fsnotify_nameremove(dentry, isdir);
1535 return;
1538 if (!d_unhashed(dentry))
1539 __d_drop(dentry);
1541 spin_unlock(&dentry->d_lock);
1542 spin_unlock(&dcache_lock);
1544 fsnotify_nameremove(dentry, isdir);
1547 static void __d_rehash(struct dentry * entry, struct hlist_head *list)
1550 entry->d_flags &= ~DCACHE_UNHASHED;
1551 hlist_add_head_rcu(&entry->d_hash, list);
1554 static void _d_rehash(struct dentry * entry)
1556 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
1560 * d_rehash - add an entry back to the hash
1561 * @entry: dentry to add to the hash
1563 * Adds a dentry to the hash according to its name.
1566 void d_rehash(struct dentry * entry)
1568 spin_lock(&dcache_lock);
1569 spin_lock(&entry->d_lock);
1570 _d_rehash(entry);
1571 spin_unlock(&entry->d_lock);
1572 spin_unlock(&dcache_lock);
1575 #define do_switch(x,y) do { \
1576 __typeof__ (x) __tmp = x; \
1577 x = y; y = __tmp; } while (0)
1580 * When switching names, the actual string doesn't strictly have to
1581 * be preserved in the target - because we're dropping the target
1582 * anyway. As such, we can just do a simple memcpy() to copy over
1583 * the new name before we switch.
1585 * Note that we have to be a lot more careful about getting the hash
1586 * switched - we have to switch the hash value properly even if it
1587 * then no longer matches the actual (corrupted) string of the target.
1588 * The hash value has to match the hash queue that the dentry is on..
1590 static void switch_names(struct dentry *dentry, struct dentry *target)
1592 if (dname_external(target)) {
1593 if (dname_external(dentry)) {
1595 * Both external: swap the pointers
1597 do_switch(target->d_name.name, dentry->d_name.name);
1598 } else {
1600 * dentry:internal, target:external. Steal target's
1601 * storage and make target internal.
1603 memcpy(target->d_iname, dentry->d_name.name,
1604 dentry->d_name.len + 1);
1605 dentry->d_name.name = target->d_name.name;
1606 target->d_name.name = target->d_iname;
1608 } else {
1609 if (dname_external(dentry)) {
1611 * dentry:external, target:internal. Give dentry's
1612 * storage to target and make dentry internal
1614 memcpy(dentry->d_iname, target->d_name.name,
1615 target->d_name.len + 1);
1616 target->d_name.name = dentry->d_name.name;
1617 dentry->d_name.name = dentry->d_iname;
1618 } else {
1620 * Both are internal. Just copy target to dentry
1622 memcpy(dentry->d_iname, target->d_name.name,
1623 target->d_name.len + 1);
1629 * We cannibalize "target" when moving dentry on top of it,
1630 * because it's going to be thrown away anyway. We could be more
1631 * polite about it, though.
1633 * This forceful removal will result in ugly /proc output if
1634 * somebody holds a file open that got deleted due to a rename.
1635 * We could be nicer about the deleted file, and let it show
1636 * up under the name it had before it was deleted rather than
1637 * under the original name of the file that was moved on top of it.
1641 * d_move_locked - move a dentry
1642 * @dentry: entry to move
1643 * @target: new dentry
1645 * Update the dcache to reflect the move of a file name. Negative
1646 * dcache entries should not be moved in this way.
1648 static void d_move_locked(struct dentry * dentry, struct dentry * target)
1650 struct hlist_head *list;
1652 if (!dentry->d_inode)
1653 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
1655 write_seqlock(&rename_lock);
1657 * XXXX: do we really need to take target->d_lock?
1659 if (target < dentry) {
1660 spin_lock(&target->d_lock);
1661 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
1662 } else {
1663 spin_lock(&dentry->d_lock);
1664 spin_lock_nested(&target->d_lock, DENTRY_D_LOCK_NESTED);
1667 /* Move the dentry to the target hash queue, if on different bucket */
1668 if (d_unhashed(dentry))
1669 goto already_unhashed;
1671 hlist_del_rcu(&dentry->d_hash);
1673 already_unhashed:
1674 list = d_hash(target->d_parent, target->d_name.hash);
1675 __d_rehash(dentry, list);
1677 /* Unhash the target: dput() will then get rid of it */
1678 __d_drop(target);
1680 list_del(&dentry->d_u.d_child);
1681 list_del(&target->d_u.d_child);
1683 /* Switch the names.. */
1684 switch_names(dentry, target);
1685 do_switch(dentry->d_name.len, target->d_name.len);
1686 do_switch(dentry->d_name.hash, target->d_name.hash);
1688 /* ... and switch the parents */
1689 if (IS_ROOT(dentry)) {
1690 dentry->d_parent = target->d_parent;
1691 target->d_parent = target;
1692 INIT_LIST_HEAD(&target->d_u.d_child);
1693 } else {
1694 do_switch(dentry->d_parent, target->d_parent);
1696 /* And add them back to the (new) parent lists */
1697 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
1700 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
1701 spin_unlock(&target->d_lock);
1702 fsnotify_d_move(dentry);
1703 spin_unlock(&dentry->d_lock);
1704 write_sequnlock(&rename_lock);
1708 * d_move - move a dentry
1709 * @dentry: entry to move
1710 * @target: new dentry
1712 * Update the dcache to reflect the move of a file name. Negative
1713 * dcache entries should not be moved in this way.
1716 void d_move(struct dentry * dentry, struct dentry * target)
1718 spin_lock(&dcache_lock);
1719 d_move_locked(dentry, target);
1720 spin_unlock(&dcache_lock);
1724 * Helper that returns 1 if p1 is a parent of p2, else 0
1726 static int d_isparent(struct dentry *p1, struct dentry *p2)
1728 struct dentry *p;
1730 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
1731 if (p->d_parent == p1)
1732 return 1;
1734 return 0;
1738 * This helper attempts to cope with remotely renamed directories
1740 * It assumes that the caller is already holding
1741 * dentry->d_parent->d_inode->i_mutex and the dcache_lock
1743 * Note: If ever the locking in lock_rename() changes, then please
1744 * remember to update this too...
1746 static struct dentry *__d_unalias(struct dentry *dentry, struct dentry *alias)
1747 __releases(dcache_lock)
1749 struct mutex *m1 = NULL, *m2 = NULL;
1750 struct dentry *ret;
1752 /* If alias and dentry share a parent, then no extra locks required */
1753 if (alias->d_parent == dentry->d_parent)
1754 goto out_unalias;
1756 /* Check for loops */
1757 ret = ERR_PTR(-ELOOP);
1758 if (d_isparent(alias, dentry))
1759 goto out_err;
1761 /* See lock_rename() */
1762 ret = ERR_PTR(-EBUSY);
1763 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
1764 goto out_err;
1765 m1 = &dentry->d_sb->s_vfs_rename_mutex;
1766 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
1767 goto out_err;
1768 m2 = &alias->d_parent->d_inode->i_mutex;
1769 out_unalias:
1770 d_move_locked(alias, dentry);
1771 ret = alias;
1772 out_err:
1773 spin_unlock(&dcache_lock);
1774 if (m2)
1775 mutex_unlock(m2);
1776 if (m1)
1777 mutex_unlock(m1);
1778 return ret;
1782 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
1783 * named dentry in place of the dentry to be replaced.
1785 static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
1787 struct dentry *dparent, *aparent;
1789 switch_names(dentry, anon);
1790 do_switch(dentry->d_name.len, anon->d_name.len);
1791 do_switch(dentry->d_name.hash, anon->d_name.hash);
1793 dparent = dentry->d_parent;
1794 aparent = anon->d_parent;
1796 dentry->d_parent = (aparent == anon) ? dentry : aparent;
1797 list_del(&dentry->d_u.d_child);
1798 if (!IS_ROOT(dentry))
1799 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
1800 else
1801 INIT_LIST_HEAD(&dentry->d_u.d_child);
1803 anon->d_parent = (dparent == dentry) ? anon : dparent;
1804 list_del(&anon->d_u.d_child);
1805 if (!IS_ROOT(anon))
1806 list_add(&anon->d_u.d_child, &anon->d_parent->d_subdirs);
1807 else
1808 INIT_LIST_HEAD(&anon->d_u.d_child);
1810 anon->d_flags &= ~DCACHE_DISCONNECTED;
1814 * d_materialise_unique - introduce an inode into the tree
1815 * @dentry: candidate dentry
1816 * @inode: inode to bind to the dentry, to which aliases may be attached
1818 * Introduces an dentry into the tree, substituting an extant disconnected
1819 * root directory alias in its place if there is one
1821 struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
1823 struct dentry *actual;
1825 BUG_ON(!d_unhashed(dentry));
1827 spin_lock(&dcache_lock);
1829 if (!inode) {
1830 actual = dentry;
1831 dentry->d_inode = NULL;
1832 goto found_lock;
1835 if (S_ISDIR(inode->i_mode)) {
1836 struct dentry *alias;
1838 /* Does an aliased dentry already exist? */
1839 alias = __d_find_alias(inode, 0);
1840 if (alias) {
1841 actual = alias;
1842 /* Is this an anonymous mountpoint that we could splice
1843 * into our tree? */
1844 if (IS_ROOT(alias)) {
1845 spin_lock(&alias->d_lock);
1846 __d_materialise_dentry(dentry, alias);
1847 __d_drop(alias);
1848 goto found;
1850 /* Nope, but we must(!) avoid directory aliasing */
1851 actual = __d_unalias(dentry, alias);
1852 if (IS_ERR(actual))
1853 dput(alias);
1854 goto out_nolock;
1858 /* Add a unique reference */
1859 actual = __d_instantiate_unique(dentry, inode);
1860 if (!actual)
1861 actual = dentry;
1862 else if (unlikely(!d_unhashed(actual)))
1863 goto shouldnt_be_hashed;
1865 found_lock:
1866 spin_lock(&actual->d_lock);
1867 found:
1868 _d_rehash(actual);
1869 spin_unlock(&actual->d_lock);
1870 spin_unlock(&dcache_lock);
1871 out_nolock:
1872 if (actual == dentry) {
1873 security_d_instantiate(dentry, inode);
1874 return NULL;
1877 iput(inode);
1878 return actual;
1880 shouldnt_be_hashed:
1881 spin_unlock(&dcache_lock);
1882 BUG();
1885 static int prepend(char **buffer, int *buflen, const char *str, int namelen)
1887 *buflen -= namelen;
1888 if (*buflen < 0)
1889 return -ENAMETOOLONG;
1890 *buffer -= namelen;
1891 memcpy(*buffer, str, namelen);
1892 return 0;
1895 static int prepend_name(char **buffer, int *buflen, struct qstr *name)
1897 return prepend(buffer, buflen, name->name, name->len);
1901 * __d_path - return the path of a dentry
1902 * @path: the dentry/vfsmount to report
1903 * @root: root vfsmnt/dentry (may be modified by this function)
1904 * @buffer: buffer to return value in
1905 * @buflen: buffer length
1907 * Convert a dentry into an ASCII path name. If the entry has been deleted
1908 * the string " (deleted)" is appended. Note that this is ambiguous.
1910 * Returns the buffer or an error code if the path was too long.
1912 * "buflen" should be positive. Caller holds the dcache_lock.
1914 * If path is not reachable from the supplied root, then the value of
1915 * root is changed (without modifying refcounts).
1917 char *__d_path(const struct path *path, struct path *root,
1918 char *buffer, int buflen)
1920 struct dentry *dentry = path->dentry;
1921 struct vfsmount *vfsmnt = path->mnt;
1922 char *end = buffer + buflen;
1923 char *retval;
1925 spin_lock(&vfsmount_lock);
1926 prepend(&end, &buflen, "\0", 1);
1927 if (!IS_ROOT(dentry) && d_unhashed(dentry) &&
1928 (prepend(&end, &buflen, " (deleted)", 10) != 0))
1929 goto Elong;
1931 if (buflen < 1)
1932 goto Elong;
1933 /* Get '/' right */
1934 retval = end-1;
1935 *retval = '/';
1937 for (;;) {
1938 struct dentry * parent;
1940 if (dentry == root->dentry && vfsmnt == root->mnt)
1941 break;
1942 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
1943 /* Global root? */
1944 if (vfsmnt->mnt_parent == vfsmnt) {
1945 goto global_root;
1947 dentry = vfsmnt->mnt_mountpoint;
1948 vfsmnt = vfsmnt->mnt_parent;
1949 continue;
1951 parent = dentry->d_parent;
1952 prefetch(parent);
1953 if ((prepend_name(&end, &buflen, &dentry->d_name) != 0) ||
1954 (prepend(&end, &buflen, "/", 1) != 0))
1955 goto Elong;
1956 retval = end;
1957 dentry = parent;
1960 out:
1961 spin_unlock(&vfsmount_lock);
1962 return retval;
1964 global_root:
1965 retval += 1; /* hit the slash */
1966 if (prepend_name(&retval, &buflen, &dentry->d_name) != 0)
1967 goto Elong;
1968 root->mnt = vfsmnt;
1969 root->dentry = dentry;
1970 goto out;
1972 Elong:
1973 retval = ERR_PTR(-ENAMETOOLONG);
1974 goto out;
1978 * d_path - return the path of a dentry
1979 * @path: path to report
1980 * @buf: buffer to return value in
1981 * @buflen: buffer length
1983 * Convert a dentry into an ASCII path name. If the entry has been deleted
1984 * the string " (deleted)" is appended. Note that this is ambiguous.
1986 * Returns the buffer or an error code if the path was too long.
1988 * "buflen" should be positive.
1990 char *d_path(const struct path *path, char *buf, int buflen)
1992 char *res;
1993 struct path root;
1994 struct path tmp;
1997 * We have various synthetic filesystems that never get mounted. On
1998 * these filesystems dentries are never used for lookup purposes, and
1999 * thus don't need to be hashed. They also don't need a name until a
2000 * user wants to identify the object in /proc/pid/fd/. The little hack
2001 * below allows us to generate a name for these objects on demand:
2003 if (path->dentry->d_op && path->dentry->d_op->d_dname)
2004 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
2006 read_lock(&current->fs->lock);
2007 root = current->fs->root;
2008 path_get(&root);
2009 read_unlock(&current->fs->lock);
2010 spin_lock(&dcache_lock);
2011 tmp = root;
2012 res = __d_path(path, &tmp, buf, buflen);
2013 spin_unlock(&dcache_lock);
2014 path_put(&root);
2015 return res;
2019 * Helper function for dentry_operations.d_dname() members
2021 char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
2022 const char *fmt, ...)
2024 va_list args;
2025 char temp[64];
2026 int sz;
2028 va_start(args, fmt);
2029 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
2030 va_end(args);
2032 if (sz > sizeof(temp) || sz > buflen)
2033 return ERR_PTR(-ENAMETOOLONG);
2035 buffer += buflen - sz;
2036 return memcpy(buffer, temp, sz);
2040 * Write full pathname from the root of the filesystem into the buffer.
2042 char *dentry_path(struct dentry *dentry, char *buf, int buflen)
2044 char *end = buf + buflen;
2045 char *retval;
2047 spin_lock(&dcache_lock);
2048 prepend(&end, &buflen, "\0", 1);
2049 if (!IS_ROOT(dentry) && d_unhashed(dentry) &&
2050 (prepend(&end, &buflen, "//deleted", 9) != 0))
2051 goto Elong;
2052 if (buflen < 1)
2053 goto Elong;
2054 /* Get '/' right */
2055 retval = end-1;
2056 *retval = '/';
2058 while (!IS_ROOT(dentry)) {
2059 struct dentry *parent = dentry->d_parent;
2061 prefetch(parent);
2062 if ((prepend_name(&end, &buflen, &dentry->d_name) != 0) ||
2063 (prepend(&end, &buflen, "/", 1) != 0))
2064 goto Elong;
2066 retval = end;
2067 dentry = parent;
2069 spin_unlock(&dcache_lock);
2070 return retval;
2071 Elong:
2072 spin_unlock(&dcache_lock);
2073 return ERR_PTR(-ENAMETOOLONG);
2077 * NOTE! The user-level library version returns a
2078 * character pointer. The kernel system call just
2079 * returns the length of the buffer filled (which
2080 * includes the ending '\0' character), or a negative
2081 * error value. So libc would do something like
2083 * char *getcwd(char * buf, size_t size)
2085 * int retval;
2087 * retval = sys_getcwd(buf, size);
2088 * if (retval >= 0)
2089 * return buf;
2090 * errno = -retval;
2091 * return NULL;
2094 asmlinkage long sys_getcwd(char __user *buf, unsigned long size)
2096 int error;
2097 struct path pwd, root;
2098 char *page = (char *) __get_free_page(GFP_USER);
2100 if (!page)
2101 return -ENOMEM;
2103 read_lock(&current->fs->lock);
2104 pwd = current->fs->pwd;
2105 path_get(&pwd);
2106 root = current->fs->root;
2107 path_get(&root);
2108 read_unlock(&current->fs->lock);
2110 error = -ENOENT;
2111 /* Has the current directory has been unlinked? */
2112 spin_lock(&dcache_lock);
2113 if (IS_ROOT(pwd.dentry) || !d_unhashed(pwd.dentry)) {
2114 unsigned long len;
2115 struct path tmp = root;
2116 char * cwd;
2118 cwd = __d_path(&pwd, &tmp, page, PAGE_SIZE);
2119 spin_unlock(&dcache_lock);
2121 error = PTR_ERR(cwd);
2122 if (IS_ERR(cwd))
2123 goto out;
2125 error = -ERANGE;
2126 len = PAGE_SIZE + page - cwd;
2127 if (len <= size) {
2128 error = len;
2129 if (copy_to_user(buf, cwd, len))
2130 error = -EFAULT;
2132 } else
2133 spin_unlock(&dcache_lock);
2135 out:
2136 path_put(&pwd);
2137 path_put(&root);
2138 free_page((unsigned long) page);
2139 return error;
2143 * Test whether new_dentry is a subdirectory of old_dentry.
2145 * Trivially implemented using the dcache structure
2149 * is_subdir - is new dentry a subdirectory of old_dentry
2150 * @new_dentry: new dentry
2151 * @old_dentry: old dentry
2153 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
2154 * Returns 0 otherwise.
2155 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
2158 int is_subdir(struct dentry * new_dentry, struct dentry * old_dentry)
2160 int result;
2161 struct dentry * saved = new_dentry;
2162 unsigned long seq;
2164 /* need rcu_readlock to protect against the d_parent trashing due to
2165 * d_move
2167 rcu_read_lock();
2168 do {
2169 /* for restarting inner loop in case of seq retry */
2170 new_dentry = saved;
2171 result = 0;
2172 seq = read_seqbegin(&rename_lock);
2173 for (;;) {
2174 if (new_dentry != old_dentry) {
2175 if (IS_ROOT(new_dentry))
2176 break;
2177 new_dentry = new_dentry->d_parent;
2178 continue;
2180 result = 1;
2181 break;
2183 } while (read_seqretry(&rename_lock, seq));
2184 rcu_read_unlock();
2186 return result;
2189 void d_genocide(struct dentry *root)
2191 struct dentry *this_parent = root;
2192 struct list_head *next;
2194 spin_lock(&dcache_lock);
2195 repeat:
2196 next = this_parent->d_subdirs.next;
2197 resume:
2198 while (next != &this_parent->d_subdirs) {
2199 struct list_head *tmp = next;
2200 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
2201 next = tmp->next;
2202 if (d_unhashed(dentry)||!dentry->d_inode)
2203 continue;
2204 if (!list_empty(&dentry->d_subdirs)) {
2205 this_parent = dentry;
2206 goto repeat;
2208 atomic_dec(&dentry->d_count);
2210 if (this_parent != root) {
2211 next = this_parent->d_u.d_child.next;
2212 atomic_dec(&this_parent->d_count);
2213 this_parent = this_parent->d_parent;
2214 goto resume;
2216 spin_unlock(&dcache_lock);
2220 * find_inode_number - check for dentry with name
2221 * @dir: directory to check
2222 * @name: Name to find.
2224 * Check whether a dentry already exists for the given name,
2225 * and return the inode number if it has an inode. Otherwise
2226 * 0 is returned.
2228 * This routine is used to post-process directory listings for
2229 * filesystems using synthetic inode numbers, and is necessary
2230 * to keep getcwd() working.
2233 ino_t find_inode_number(struct dentry *dir, struct qstr *name)
2235 struct dentry * dentry;
2236 ino_t ino = 0;
2238 dentry = d_hash_and_lookup(dir, name);
2239 if (dentry) {
2240 if (dentry->d_inode)
2241 ino = dentry->d_inode->i_ino;
2242 dput(dentry);
2244 return ino;
2247 static __initdata unsigned long dhash_entries;
2248 static int __init set_dhash_entries(char *str)
2250 if (!str)
2251 return 0;
2252 dhash_entries = simple_strtoul(str, &str, 0);
2253 return 1;
2255 __setup("dhash_entries=", set_dhash_entries);
2257 static void __init dcache_init_early(void)
2259 int loop;
2261 /* If hashes are distributed across NUMA nodes, defer
2262 * hash allocation until vmalloc space is available.
2264 if (hashdist)
2265 return;
2267 dentry_hashtable =
2268 alloc_large_system_hash("Dentry cache",
2269 sizeof(struct hlist_head),
2270 dhash_entries,
2272 HASH_EARLY,
2273 &d_hash_shift,
2274 &d_hash_mask,
2277 for (loop = 0; loop < (1 << d_hash_shift); loop++)
2278 INIT_HLIST_HEAD(&dentry_hashtable[loop]);
2281 static void __init dcache_init(void)
2283 int loop;
2286 * A constructor could be added for stable state like the lists,
2287 * but it is probably not worth it because of the cache nature
2288 * of the dcache.
2290 dentry_cache = KMEM_CACHE(dentry,
2291 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
2293 register_shrinker(&dcache_shrinker);
2295 /* Hash may have been set up in dcache_init_early */
2296 if (!hashdist)
2297 return;
2299 dentry_hashtable =
2300 alloc_large_system_hash("Dentry cache",
2301 sizeof(struct hlist_head),
2302 dhash_entries,
2305 &d_hash_shift,
2306 &d_hash_mask,
2309 for (loop = 0; loop < (1 << d_hash_shift); loop++)
2310 INIT_HLIST_HEAD(&dentry_hashtable[loop]);
2313 /* SLAB cache for __getname() consumers */
2314 struct kmem_cache *names_cachep __read_mostly;
2316 /* SLAB cache for file structures */
2317 struct kmem_cache *filp_cachep __read_mostly;
2319 EXPORT_SYMBOL(d_genocide);
2321 void __init vfs_caches_init_early(void)
2323 dcache_init_early();
2324 inode_init_early();
2327 void __init vfs_caches_init(unsigned long mempages)
2329 unsigned long reserve;
2331 /* Base hash sizes on available memory, with a reserve equal to
2332 150% of current kernel size */
2334 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
2335 mempages -= reserve;
2337 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
2338 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
2340 filp_cachep = kmem_cache_create("filp", sizeof(struct file), 0,
2341 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
2343 dcache_init();
2344 inode_init();
2345 files_init(mempages);
2346 mnt_init();
2347 bdev_cache_init();
2348 chrdev_init();
2351 EXPORT_SYMBOL(d_alloc);
2352 EXPORT_SYMBOL(d_alloc_root);
2353 EXPORT_SYMBOL(d_delete);
2354 EXPORT_SYMBOL(d_find_alias);
2355 EXPORT_SYMBOL(d_instantiate);
2356 EXPORT_SYMBOL(d_invalidate);
2357 EXPORT_SYMBOL(d_lookup);
2358 EXPORT_SYMBOL(d_move);
2359 EXPORT_SYMBOL_GPL(d_materialise_unique);
2360 EXPORT_SYMBOL(d_path);
2361 EXPORT_SYMBOL(d_prune_aliases);
2362 EXPORT_SYMBOL(d_rehash);
2363 EXPORT_SYMBOL(d_splice_alias);
2364 EXPORT_SYMBOL(d_add_ci);
2365 EXPORT_SYMBOL(d_validate);
2366 EXPORT_SYMBOL(dget_locked);
2367 EXPORT_SYMBOL(dput);
2368 EXPORT_SYMBOL(find_inode_number);
2369 EXPORT_SYMBOL(have_submounts);
2370 EXPORT_SYMBOL(names_cachep);
2371 EXPORT_SYMBOL(shrink_dcache_parent);
2372 EXPORT_SYMBOL(shrink_dcache_sb);