4 * (C) 1997 Linus Torvalds
9 #include <linux/dcache.h>
10 #include <linux/init.h>
11 #include <linux/slab.h>
12 #include <linux/writeback.h>
13 #include <linux/module.h>
14 #include <linux/backing-dev.h>
15 #include <linux/wait.h>
16 #include <linux/rwsem.h>
17 #include <linux/hash.h>
18 #include <linux/swap.h>
19 #include <linux/security.h>
20 #include <linux/pagemap.h>
21 #include <linux/cdev.h>
22 #include <linux/bootmem.h>
23 #include <linux/inotify.h>
24 #include <linux/fsnotify.h>
25 #include <linux/mount.h>
26 #include <linux/async.h>
27 #include <linux/posix_acl.h>
30 * This is needed for the following functions:
32 * - invalidate_inode_buffers
35 * FIXME: remove all knowledge of the buffer layer from this file
37 #include <linux/buffer_head.h>
40 * New inode.c implementation.
42 * This implementation has the basic premise of trying
43 * to be extremely low-overhead and SMP-safe, yet be
44 * simple enough to be "obviously correct".
51 /* #define INODE_PARANOIA 1 */
52 /* #define INODE_DEBUG 1 */
55 * Inode lookup is no longer as critical as it used to be:
56 * most of the lookups are going to be through the dcache.
58 #define I_HASHBITS i_hash_shift
59 #define I_HASHMASK i_hash_mask
61 static unsigned int i_hash_mask __read_mostly;
62 static unsigned int i_hash_shift __read_mostly;
65 * Each inode can be on two separate lists. One is
66 * the hash list of the inode, used for lookups. The
67 * other linked list is the "type" list:
68 * "in_use" - valid inode, i_count > 0, i_nlink > 0
69 * "dirty" - as "in_use" but also dirty
70 * "unused" - valid inode, i_count = 0
72 * A "dirty" list is maintained for each super block,
73 * allowing for low-overhead inode sync() operations.
76 LIST_HEAD(inode_in_use);
77 LIST_HEAD(inode_unused);
78 static struct hlist_head *inode_hashtable __read_mostly;
81 * A simple spinlock to protect the list manipulations.
83 * NOTE! You also have to own the lock if you change
84 * the i_state of an inode while it is in use..
86 DEFINE_SPINLOCK(inode_lock);
89 * iprune_sem provides exclusion between the kswapd or try_to_free_pages
90 * icache shrinking path, and the umount path. Without this exclusion,
91 * by the time prune_icache calls iput for the inode whose pages it has
92 * been invalidating, or by the time it calls clear_inode & destroy_inode
93 * from its final dispose_list, the struct super_block they refer to
94 * (for inode->i_sb->s_op) may already have been freed and reused.
96 * We make this an rwsem because the fastpath is icache shrinking. In
97 * some cases a filesystem may be doing a significant amount of work in
98 * its inode reclaim code, so this should improve parallelism.
100 static DECLARE_RWSEM(iprune_sem);
103 * Statistics gathering..
105 struct inodes_stat_t inodes_stat;
107 static struct kmem_cache *inode_cachep __read_mostly;
109 static void wake_up_inode(struct inode *inode)
112 * Prevent speculative execution through spin_unlock(&inode_lock);
115 wake_up_bit(&inode->i_state, __I_NEW);
119 * inode_init_always - perform inode structure intialisation
120 * @sb: superblock inode belongs to
121 * @inode: inode to initialise
123 * These are initializations that need to be done on every inode
124 * allocation as the fields are not initialised by slab allocation.
126 int inode_init_always(struct super_block *sb, struct inode *inode)
128 static const struct address_space_operations empty_aops;
129 static const struct inode_operations empty_iops;
130 static const struct file_operations empty_fops;
131 struct address_space *const mapping = &inode->i_data;
134 inode->i_blkbits = sb->s_blocksize_bits;
136 atomic_set(&inode->i_count, 1);
137 inode->i_op = &empty_iops;
138 inode->i_fop = &empty_fops;
142 atomic_set(&inode->i_writecount, 0);
146 inode->i_generation = 0;
148 memset(&inode->i_dquot, 0, sizeof(inode->i_dquot));
150 inode->i_pipe = NULL;
151 inode->i_bdev = NULL;
152 inode->i_cdev = NULL;
154 inode->dirtied_when = 0;
156 if (security_inode_alloc(inode))
158 spin_lock_init(&inode->i_lock);
159 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
161 mutex_init(&inode->i_mutex);
162 lockdep_set_class(&inode->i_mutex, &sb->s_type->i_mutex_key);
164 init_rwsem(&inode->i_alloc_sem);
165 lockdep_set_class(&inode->i_alloc_sem, &sb->s_type->i_alloc_sem_key);
167 mapping->a_ops = &empty_aops;
168 mapping->host = inode;
170 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
171 mapping->assoc_mapping = NULL;
172 mapping->backing_dev_info = &default_backing_dev_info;
173 mapping->writeback_index = 0;
176 * If the block_device provides a backing_dev_info for client
177 * inodes then use that. Otherwise the inode share the bdev's
181 struct backing_dev_info *bdi;
183 bdi = sb->s_bdev->bd_inode->i_mapping->backing_dev_info;
184 mapping->backing_dev_info = bdi;
186 inode->i_private = NULL;
187 inode->i_mapping = mapping;
188 #ifdef CONFIG_FS_POSIX_ACL
189 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
192 #ifdef CONFIG_FSNOTIFY
193 inode->i_fsnotify_mask = 0;
200 EXPORT_SYMBOL(inode_init_always);
202 static struct inode *alloc_inode(struct super_block *sb)
206 if (sb->s_op->alloc_inode)
207 inode = sb->s_op->alloc_inode(sb);
209 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
214 if (unlikely(inode_init_always(sb, inode))) {
215 if (inode->i_sb->s_op->destroy_inode)
216 inode->i_sb->s_op->destroy_inode(inode);
218 kmem_cache_free(inode_cachep, inode);
225 void __destroy_inode(struct inode *inode)
227 BUG_ON(inode_has_buffers(inode));
228 security_inode_free(inode);
229 fsnotify_inode_delete(inode);
230 #ifdef CONFIG_FS_POSIX_ACL
231 if (inode->i_acl && inode->i_acl != ACL_NOT_CACHED)
232 posix_acl_release(inode->i_acl);
233 if (inode->i_default_acl && inode->i_default_acl != ACL_NOT_CACHED)
234 posix_acl_release(inode->i_default_acl);
237 EXPORT_SYMBOL(__destroy_inode);
239 void destroy_inode(struct inode *inode)
241 __destroy_inode(inode);
242 if (inode->i_sb->s_op->destroy_inode)
243 inode->i_sb->s_op->destroy_inode(inode);
245 kmem_cache_free(inode_cachep, (inode));
249 * These are initializations that only need to be done
250 * once, because the fields are idempotent across use
251 * of the inode, so let the slab aware of that.
253 void inode_init_once(struct inode *inode)
255 memset(inode, 0, sizeof(*inode));
256 INIT_HLIST_NODE(&inode->i_hash);
257 INIT_LIST_HEAD(&inode->i_dentry);
258 INIT_LIST_HEAD(&inode->i_devices);
259 INIT_RADIX_TREE(&inode->i_data.page_tree, GFP_ATOMIC);
260 spin_lock_init(&inode->i_data.tree_lock);
261 spin_lock_init(&inode->i_data.i_mmap_lock);
262 INIT_LIST_HEAD(&inode->i_data.private_list);
263 spin_lock_init(&inode->i_data.private_lock);
264 INIT_RAW_PRIO_TREE_ROOT(&inode->i_data.i_mmap);
265 INIT_LIST_HEAD(&inode->i_data.i_mmap_nonlinear);
266 i_size_ordered_init(inode);
267 #ifdef CONFIG_INOTIFY
268 INIT_LIST_HEAD(&inode->inotify_watches);
269 mutex_init(&inode->inotify_mutex);
271 #ifdef CONFIG_FSNOTIFY
272 INIT_HLIST_HEAD(&inode->i_fsnotify_mark_entries);
275 EXPORT_SYMBOL(inode_init_once);
277 static void init_once(void *foo)
279 struct inode *inode = (struct inode *) foo;
281 inode_init_once(inode);
285 * inode_lock must be held
287 void __iget(struct inode *inode)
289 if (atomic_inc_return(&inode->i_count) != 1)
292 if (!(inode->i_state & (I_DIRTY|I_SYNC)))
293 list_move(&inode->i_list, &inode_in_use);
294 inodes_stat.nr_unused--;
297 void end_writeback(struct inode *inode)
300 BUG_ON(inode->i_data.nrpages);
301 BUG_ON(!list_empty(&inode->i_data.private_list));
302 BUG_ON(!(inode->i_state & I_FREEING));
303 BUG_ON(inode->i_state & I_CLEAR);
304 inode_sync_wait(inode);
305 inode->i_state = I_FREEING | I_CLEAR;
307 EXPORT_SYMBOL(end_writeback);
310 * clear_inode - clear an inode
311 * @inode: inode to clear
313 * This is called by the filesystem to tell us
314 * that the inode is no longer useful. We just
315 * terminate it with extreme prejudice.
317 void clear_inode(struct inode *inode)
320 invalidate_inode_buffers(inode);
322 BUG_ON(inode->i_data.nrpages);
323 BUG_ON(!(inode->i_state & I_FREEING));
324 BUG_ON(inode->i_state & I_CLEAR);
325 inode_sync_wait(inode);
326 if (inode->i_sb->s_op->clear_inode)
327 inode->i_sb->s_op->clear_inode(inode);
328 inode->i_state = I_FREEING | I_CLEAR;
330 EXPORT_SYMBOL(clear_inode);
332 static void evict(struct inode *inode, int delete)
334 const struct super_operations *op = inode->i_sb->s_op;
336 if (op->evict_inode) {
337 op->evict_inode(inode);
339 if (inode->i_data.nrpages)
340 truncate_inode_pages(&inode->i_data, 0);
343 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
345 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
350 * dispose_list - dispose of the contents of a local list
351 * @head: the head of the list to free
353 * Dispose-list gets a local list with local inodes in it, so it doesn't
354 * need to worry about list corruption and SMP locks.
356 static void dispose_list(struct list_head *head)
360 while (!list_empty(head)) {
363 inode = list_first_entry(head, struct inode, i_list);
364 list_del(&inode->i_list);
368 spin_lock(&inode_lock);
369 hlist_del_init(&inode->i_hash);
370 list_del_init(&inode->i_sb_list);
371 spin_unlock(&inode_lock);
373 wake_up_inode(inode);
374 destroy_inode(inode);
377 spin_lock(&inode_lock);
378 inodes_stat.nr_inodes -= nr_disposed;
379 spin_unlock(&inode_lock);
383 * Invalidate all inodes for a device.
385 static int invalidate_list(struct list_head *head, struct list_head *dispose)
387 struct list_head *next;
388 int busy = 0, count = 0;
392 struct list_head *tmp = next;
396 * We can reschedule here without worrying about the list's
397 * consistency because the per-sb list of inodes must not
398 * change during umount anymore, and because iprune_sem keeps
399 * shrink_icache_memory() away.
401 cond_resched_lock(&inode_lock);
406 inode = list_entry(tmp, struct inode, i_sb_list);
407 if (inode->i_state & I_NEW)
409 invalidate_inode_buffers(inode);
410 if (!atomic_read(&inode->i_count)) {
411 list_move(&inode->i_list, dispose);
412 WARN_ON(inode->i_state & I_NEW);
413 inode->i_state |= I_FREEING;
419 /* only unused inodes may be cached with i_count zero */
420 inodes_stat.nr_unused -= count;
425 * invalidate_inodes - discard the inodes on a device
428 * Discard all of the inodes for a given superblock. If the discard
429 * fails because there are busy inodes then a non zero value is returned.
430 * If the discard is successful all the inodes have been discarded.
432 int invalidate_inodes(struct super_block *sb)
435 LIST_HEAD(throw_away);
437 down_write(&iprune_sem);
438 spin_lock(&inode_lock);
439 inotify_unmount_inodes(&sb->s_inodes);
440 fsnotify_unmount_inodes(&sb->s_inodes);
441 busy = invalidate_list(&sb->s_inodes, &throw_away);
442 spin_unlock(&inode_lock);
444 dispose_list(&throw_away);
445 up_write(&iprune_sem);
449 EXPORT_SYMBOL(invalidate_inodes);
451 static int can_unuse(struct inode *inode)
455 if (inode_has_buffers(inode))
457 if (atomic_read(&inode->i_count))
459 if (inode->i_data.nrpages)
465 * Scan `goal' inodes on the unused list for freeable ones. They are moved to
466 * a temporary list and then are freed outside inode_lock by dispose_list().
468 * Any inodes which are pinned purely because of attached pagecache have their
469 * pagecache removed. We expect the final iput() on that inode to add it to
470 * the front of the inode_unused list. So look for it there and if the
471 * inode is still freeable, proceed. The right inode is found 99.9% of the
472 * time in testing on a 4-way.
474 * If the inode has metadata buffers attached to mapping->private_list then
475 * try to remove them.
477 static void prune_icache(int nr_to_scan)
482 unsigned long reap = 0;
484 down_read(&iprune_sem);
485 spin_lock(&inode_lock);
486 for (nr_scanned = 0; nr_scanned < nr_to_scan; nr_scanned++) {
489 if (list_empty(&inode_unused))
492 inode = list_entry(inode_unused.prev, struct inode, i_list);
494 if (inode->i_state || atomic_read(&inode->i_count)) {
495 list_move(&inode->i_list, &inode_unused);
498 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
500 spin_unlock(&inode_lock);
501 if (remove_inode_buffers(inode))
502 reap += invalidate_mapping_pages(&inode->i_data,
505 spin_lock(&inode_lock);
507 if (inode != list_entry(inode_unused.next,
508 struct inode, i_list))
509 continue; /* wrong inode or list_empty */
510 if (!can_unuse(inode))
513 list_move(&inode->i_list, &freeable);
514 WARN_ON(inode->i_state & I_NEW);
515 inode->i_state |= I_FREEING;
518 inodes_stat.nr_unused -= nr_pruned;
519 if (current_is_kswapd())
520 __count_vm_events(KSWAPD_INODESTEAL, reap);
522 __count_vm_events(PGINODESTEAL, reap);
523 spin_unlock(&inode_lock);
525 dispose_list(&freeable);
526 up_read(&iprune_sem);
530 * shrink_icache_memory() will attempt to reclaim some unused inodes. Here,
531 * "unused" means that no dentries are referring to the inodes: the files are
532 * not open and the dcache references to those inodes have already been
535 * This function is passed the number of inodes to scan, and it returns the
536 * total number of remaining possibly-reclaimable inodes.
538 static int shrink_icache_memory(struct shrinker *shrink, int nr, gfp_t gfp_mask)
542 * Nasty deadlock avoidance. We may hold various FS locks,
543 * and we don't want to recurse into the FS that called us
544 * in clear_inode() and friends..
546 if (!(gfp_mask & __GFP_FS))
550 return (inodes_stat.nr_unused / 100) * sysctl_vfs_cache_pressure;
553 static struct shrinker icache_shrinker = {
554 .shrink = shrink_icache_memory,
555 .seeks = DEFAULT_SEEKS,
558 static void __wait_on_freeing_inode(struct inode *inode);
560 * Called with the inode lock held.
561 * NOTE: we are not increasing the inode-refcount, you must call __iget()
562 * by hand after calling find_inode now! This simplifies iunique and won't
563 * add any additional branch in the common code.
565 static struct inode *find_inode(struct super_block *sb,
566 struct hlist_head *head,
567 int (*test)(struct inode *, void *),
570 struct hlist_node *node;
571 struct inode *inode = NULL;
574 hlist_for_each_entry(inode, node, head, i_hash) {
575 if (inode->i_sb != sb)
577 if (!test(inode, data))
579 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
580 __wait_on_freeing_inode(inode);
585 return node ? inode : NULL;
589 * find_inode_fast is the fast path version of find_inode, see the comment at
590 * iget_locked for details.
592 static struct inode *find_inode_fast(struct super_block *sb,
593 struct hlist_head *head, unsigned long ino)
595 struct hlist_node *node;
596 struct inode *inode = NULL;
599 hlist_for_each_entry(inode, node, head, i_hash) {
600 if (inode->i_ino != ino)
602 if (inode->i_sb != sb)
604 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
605 __wait_on_freeing_inode(inode);
610 return node ? inode : NULL;
613 static unsigned long hash(struct super_block *sb, unsigned long hashval)
617 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
619 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> I_HASHBITS);
620 return tmp & I_HASHMASK;
624 __inode_add_to_lists(struct super_block *sb, struct hlist_head *head,
627 inodes_stat.nr_inodes++;
628 list_add(&inode->i_list, &inode_in_use);
629 list_add(&inode->i_sb_list, &sb->s_inodes);
631 hlist_add_head(&inode->i_hash, head);
635 * inode_add_to_lists - add a new inode to relevant lists
636 * @sb: superblock inode belongs to
637 * @inode: inode to mark in use
639 * When an inode is allocated it needs to be accounted for, added to the in use
640 * list, the owning superblock and the inode hash. This needs to be done under
641 * the inode_lock, so export a function to do this rather than the inode lock
642 * itself. We calculate the hash list to add to here so it is all internal
643 * which requires the caller to have already set up the inode number in the
646 void inode_add_to_lists(struct super_block *sb, struct inode *inode)
648 struct hlist_head *head = inode_hashtable + hash(sb, inode->i_ino);
650 spin_lock(&inode_lock);
651 __inode_add_to_lists(sb, head, inode);
652 spin_unlock(&inode_lock);
654 EXPORT_SYMBOL_GPL(inode_add_to_lists);
657 * new_inode - obtain an inode
660 * Allocates a new inode for given superblock. The default gfp_mask
661 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
662 * If HIGHMEM pages are unsuitable or it is known that pages allocated
663 * for the page cache are not reclaimable or migratable,
664 * mapping_set_gfp_mask() must be called with suitable flags on the
665 * newly created inode's mapping
668 struct inode *new_inode(struct super_block *sb)
671 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
672 * error if st_ino won't fit in target struct field. Use 32bit counter
673 * here to attempt to avoid that.
675 static unsigned int last_ino;
678 spin_lock_prefetch(&inode_lock);
680 inode = alloc_inode(sb);
682 spin_lock(&inode_lock);
683 __inode_add_to_lists(sb, NULL, inode);
684 inode->i_ino = ++last_ino;
686 spin_unlock(&inode_lock);
690 EXPORT_SYMBOL(new_inode);
692 void unlock_new_inode(struct inode *inode)
694 #ifdef CONFIG_DEBUG_LOCK_ALLOC
695 if (inode->i_mode & S_IFDIR) {
696 struct file_system_type *type = inode->i_sb->s_type;
698 /* Set new key only if filesystem hasn't already changed it */
699 if (!lockdep_match_class(&inode->i_mutex,
700 &type->i_mutex_key)) {
702 * ensure nobody is actually holding i_mutex
704 mutex_destroy(&inode->i_mutex);
705 mutex_init(&inode->i_mutex);
706 lockdep_set_class(&inode->i_mutex,
707 &type->i_mutex_dir_key);
712 * This is special! We do not need the spinlock when clearing I_NEW,
713 * because we're guaranteed that nobody else tries to do anything about
714 * the state of the inode when it is locked, as we just created it (so
715 * there can be no old holders that haven't tested I_NEW).
716 * However we must emit the memory barrier so that other CPUs reliably
717 * see the clearing of I_NEW after the other inode initialisation has
721 WARN_ON(!(inode->i_state & I_NEW));
722 inode->i_state &= ~I_NEW;
723 wake_up_inode(inode);
725 EXPORT_SYMBOL(unlock_new_inode);
728 * This is called without the inode lock held.. Be careful.
730 * We no longer cache the sb_flags in i_flags - see fs.h
733 static struct inode *get_new_inode(struct super_block *sb,
734 struct hlist_head *head,
735 int (*test)(struct inode *, void *),
736 int (*set)(struct inode *, void *),
741 inode = alloc_inode(sb);
745 spin_lock(&inode_lock);
746 /* We released the lock, so.. */
747 old = find_inode(sb, head, test, data);
749 if (set(inode, data))
752 __inode_add_to_lists(sb, head, inode);
753 inode->i_state = I_NEW;
754 spin_unlock(&inode_lock);
756 /* Return the locked inode with I_NEW set, the
757 * caller is responsible for filling in the contents
763 * Uhhuh, somebody else created the same inode under
764 * us. Use the old inode instead of the one we just
768 spin_unlock(&inode_lock);
769 destroy_inode(inode);
771 wait_on_inode(inode);
776 spin_unlock(&inode_lock);
777 destroy_inode(inode);
782 * get_new_inode_fast is the fast path version of get_new_inode, see the
783 * comment at iget_locked for details.
785 static struct inode *get_new_inode_fast(struct super_block *sb,
786 struct hlist_head *head, unsigned long ino)
790 inode = alloc_inode(sb);
794 spin_lock(&inode_lock);
795 /* We released the lock, so.. */
796 old = find_inode_fast(sb, head, ino);
799 __inode_add_to_lists(sb, head, inode);
800 inode->i_state = I_NEW;
801 spin_unlock(&inode_lock);
803 /* Return the locked inode with I_NEW set, the
804 * caller is responsible for filling in the contents
810 * Uhhuh, somebody else created the same inode under
811 * us. Use the old inode instead of the one we just
815 spin_unlock(&inode_lock);
816 destroy_inode(inode);
818 wait_on_inode(inode);
824 * iunique - get a unique inode number
826 * @max_reserved: highest reserved inode number
828 * Obtain an inode number that is unique on the system for a given
829 * superblock. This is used by file systems that have no natural
830 * permanent inode numbering system. An inode number is returned that
831 * is higher than the reserved limit but unique.
834 * With a large number of inodes live on the file system this function
835 * currently becomes quite slow.
837 ino_t iunique(struct super_block *sb, ino_t max_reserved)
840 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
841 * error if st_ino won't fit in target struct field. Use 32bit counter
842 * here to attempt to avoid that.
844 static unsigned int counter;
846 struct hlist_head *head;
849 spin_lock(&inode_lock);
851 if (counter <= max_reserved)
852 counter = max_reserved + 1;
854 head = inode_hashtable + hash(sb, res);
855 inode = find_inode_fast(sb, head, res);
856 } while (inode != NULL);
857 spin_unlock(&inode_lock);
861 EXPORT_SYMBOL(iunique);
863 struct inode *igrab(struct inode *inode)
865 spin_lock(&inode_lock);
866 if (!(inode->i_state & (I_FREEING|I_WILL_FREE)))
870 * Handle the case where s_op->clear_inode is not been
871 * called yet, and somebody is calling igrab
872 * while the inode is getting freed.
875 spin_unlock(&inode_lock);
878 EXPORT_SYMBOL(igrab);
881 * ifind - internal function, you want ilookup5() or iget5().
882 * @sb: super block of file system to search
883 * @head: the head of the list to search
884 * @test: callback used for comparisons between inodes
885 * @data: opaque data pointer to pass to @test
886 * @wait: if true wait for the inode to be unlocked, if false do not
888 * ifind() searches for the inode specified by @data in the inode
889 * cache. This is a generalized version of ifind_fast() for file systems where
890 * the inode number is not sufficient for unique identification of an inode.
892 * If the inode is in the cache, the inode is returned with an incremented
895 * Otherwise NULL is returned.
897 * Note, @test is called with the inode_lock held, so can't sleep.
899 static struct inode *ifind(struct super_block *sb,
900 struct hlist_head *head, int (*test)(struct inode *, void *),
901 void *data, const int wait)
905 spin_lock(&inode_lock);
906 inode = find_inode(sb, head, test, data);
909 spin_unlock(&inode_lock);
911 wait_on_inode(inode);
914 spin_unlock(&inode_lock);
919 * ifind_fast - internal function, you want ilookup() or iget().
920 * @sb: super block of file system to search
921 * @head: head of the list to search
922 * @ino: inode number to search for
924 * ifind_fast() searches for the inode @ino in the inode cache. This is for
925 * file systems where the inode number is sufficient for unique identification
928 * If the inode is in the cache, the inode is returned with an incremented
931 * Otherwise NULL is returned.
933 static struct inode *ifind_fast(struct super_block *sb,
934 struct hlist_head *head, unsigned long ino)
938 spin_lock(&inode_lock);
939 inode = find_inode_fast(sb, head, ino);
942 spin_unlock(&inode_lock);
943 wait_on_inode(inode);
946 spin_unlock(&inode_lock);
951 * ilookup5_nowait - search for an inode in the inode cache
952 * @sb: super block of file system to search
953 * @hashval: hash value (usually inode number) to search for
954 * @test: callback used for comparisons between inodes
955 * @data: opaque data pointer to pass to @test
957 * ilookup5() uses ifind() to search for the inode specified by @hashval and
958 * @data in the inode cache. This is a generalized version of ilookup() for
959 * file systems where the inode number is not sufficient for unique
960 * identification of an inode.
962 * If the inode is in the cache, the inode is returned with an incremented
963 * reference count. Note, the inode lock is not waited upon so you have to be
964 * very careful what you do with the returned inode. You probably should be
965 * using ilookup5() instead.
967 * Otherwise NULL is returned.
969 * Note, @test is called with the inode_lock held, so can't sleep.
971 struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
972 int (*test)(struct inode *, void *), void *data)
974 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
976 return ifind(sb, head, test, data, 0);
978 EXPORT_SYMBOL(ilookup5_nowait);
981 * ilookup5 - search for an inode in the inode cache
982 * @sb: super block of file system to search
983 * @hashval: hash value (usually inode number) to search for
984 * @test: callback used for comparisons between inodes
985 * @data: opaque data pointer to pass to @test
987 * ilookup5() uses ifind() to search for the inode specified by @hashval and
988 * @data in the inode cache. This is a generalized version of ilookup() for
989 * file systems where the inode number is not sufficient for unique
990 * identification of an inode.
992 * If the inode is in the cache, the inode lock is waited upon and the inode is
993 * returned with an incremented reference count.
995 * Otherwise NULL is returned.
997 * Note, @test is called with the inode_lock held, so can't sleep.
999 struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1000 int (*test)(struct inode *, void *), void *data)
1002 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1004 return ifind(sb, head, test, data, 1);
1006 EXPORT_SYMBOL(ilookup5);
1009 * ilookup - search for an inode in the inode cache
1010 * @sb: super block of file system to search
1011 * @ino: inode number to search for
1013 * ilookup() uses ifind_fast() to search for the inode @ino in the inode cache.
1014 * This is for file systems where the inode number is sufficient for unique
1015 * identification of an inode.
1017 * If the inode is in the cache, the inode is returned with an incremented
1020 * Otherwise NULL is returned.
1022 struct inode *ilookup(struct super_block *sb, unsigned long ino)
1024 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1026 return ifind_fast(sb, head, ino);
1028 EXPORT_SYMBOL(ilookup);
1031 * iget5_locked - obtain an inode from a mounted file system
1032 * @sb: super block of file system
1033 * @hashval: hash value (usually inode number) to get
1034 * @test: callback used for comparisons between inodes
1035 * @set: callback used to initialize a new struct inode
1036 * @data: opaque data pointer to pass to @test and @set
1038 * iget5_locked() uses ifind() to search for the inode specified by @hashval
1039 * and @data in the inode cache and if present it is returned with an increased
1040 * reference count. This is a generalized version of iget_locked() for file
1041 * systems where the inode number is not sufficient for unique identification
1044 * If the inode is not in cache, get_new_inode() is called to allocate a new
1045 * inode and this is returned locked, hashed, and with the I_NEW flag set. The
1046 * file system gets to fill it in before unlocking it via unlock_new_inode().
1048 * Note both @test and @set are called with the inode_lock held, so can't sleep.
1050 struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1051 int (*test)(struct inode *, void *),
1052 int (*set)(struct inode *, void *), void *data)
1054 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1055 struct inode *inode;
1057 inode = ifind(sb, head, test, data, 1);
1061 * get_new_inode() will do the right thing, re-trying the search
1062 * in case it had to block at any point.
1064 return get_new_inode(sb, head, test, set, data);
1066 EXPORT_SYMBOL(iget5_locked);
1069 * iget_locked - obtain an inode from a mounted file system
1070 * @sb: super block of file system
1071 * @ino: inode number to get
1073 * iget_locked() uses ifind_fast() to search for the inode specified by @ino in
1074 * the inode cache and if present it is returned with an increased reference
1075 * count. This is for file systems where the inode number is sufficient for
1076 * unique identification of an inode.
1078 * If the inode is not in cache, get_new_inode_fast() is called to allocate a
1079 * new inode and this is returned locked, hashed, and with the I_NEW flag set.
1080 * The file system gets to fill it in before unlocking it via
1081 * unlock_new_inode().
1083 struct inode *iget_locked(struct super_block *sb, unsigned long ino)
1085 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1086 struct inode *inode;
1088 inode = ifind_fast(sb, head, ino);
1092 * get_new_inode_fast() will do the right thing, re-trying the search
1093 * in case it had to block at any point.
1095 return get_new_inode_fast(sb, head, ino);
1097 EXPORT_SYMBOL(iget_locked);
1099 int insert_inode_locked(struct inode *inode)
1101 struct super_block *sb = inode->i_sb;
1102 ino_t ino = inode->i_ino;
1103 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1105 inode->i_state |= I_NEW;
1107 struct hlist_node *node;
1108 struct inode *old = NULL;
1109 spin_lock(&inode_lock);
1110 hlist_for_each_entry(old, node, head, i_hash) {
1111 if (old->i_ino != ino)
1113 if (old->i_sb != sb)
1115 if (old->i_state & (I_FREEING|I_WILL_FREE))
1119 if (likely(!node)) {
1120 hlist_add_head(&inode->i_hash, head);
1121 spin_unlock(&inode_lock);
1125 spin_unlock(&inode_lock);
1127 if (unlikely(!hlist_unhashed(&old->i_hash))) {
1134 EXPORT_SYMBOL(insert_inode_locked);
1136 int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1137 int (*test)(struct inode *, void *), void *data)
1139 struct super_block *sb = inode->i_sb;
1140 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1142 inode->i_state |= I_NEW;
1145 struct hlist_node *node;
1146 struct inode *old = NULL;
1148 spin_lock(&inode_lock);
1149 hlist_for_each_entry(old, node, head, i_hash) {
1150 if (old->i_sb != sb)
1152 if (!test(old, data))
1154 if (old->i_state & (I_FREEING|I_WILL_FREE))
1158 if (likely(!node)) {
1159 hlist_add_head(&inode->i_hash, head);
1160 spin_unlock(&inode_lock);
1164 spin_unlock(&inode_lock);
1166 if (unlikely(!hlist_unhashed(&old->i_hash))) {
1173 EXPORT_SYMBOL(insert_inode_locked4);
1176 * __insert_inode_hash - hash an inode
1177 * @inode: unhashed inode
1178 * @hashval: unsigned long value used to locate this object in the
1181 * Add an inode to the inode hash for this superblock.
1183 void __insert_inode_hash(struct inode *inode, unsigned long hashval)
1185 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1186 spin_lock(&inode_lock);
1187 hlist_add_head(&inode->i_hash, head);
1188 spin_unlock(&inode_lock);
1190 EXPORT_SYMBOL(__insert_inode_hash);
1193 * remove_inode_hash - remove an inode from the hash
1194 * @inode: inode to unhash
1196 * Remove an inode from the superblock.
1198 void remove_inode_hash(struct inode *inode)
1200 spin_lock(&inode_lock);
1201 hlist_del_init(&inode->i_hash);
1202 spin_unlock(&inode_lock);
1204 EXPORT_SYMBOL(remove_inode_hash);
1207 * Tell the filesystem that this inode is no longer of any interest and should
1208 * be completely destroyed.
1210 * We leave the inode in the inode hash table until *after* the filesystem's
1211 * ->delete_inode completes. This ensures that an iget (such as nfsd might
1212 * instigate) will always find up-to-date information either in the hash or on
1215 * I_FREEING is set so that no-one will take a new reference to the inode while
1216 * it is being deleted.
1218 void generic_delete_inode(struct inode *inode)
1220 list_del_init(&inode->i_list);
1221 list_del_init(&inode->i_sb_list);
1222 WARN_ON(inode->i_state & I_NEW);
1223 inode->i_state |= I_FREEING;
1224 inodes_stat.nr_inodes--;
1225 spin_unlock(&inode_lock);
1229 spin_lock(&inode_lock);
1230 hlist_del_init(&inode->i_hash);
1231 spin_unlock(&inode_lock);
1232 wake_up_inode(inode);
1233 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
1234 destroy_inode(inode);
1236 EXPORT_SYMBOL(generic_delete_inode);
1239 * generic_detach_inode - remove inode from inode lists
1240 * @inode: inode to remove
1242 * Remove inode from inode lists, write it if it's dirty. This is just an
1243 * internal VFS helper exported for hugetlbfs. Do not use!
1245 * Returns 1 if inode should be completely destroyed.
1247 static int generic_detach_inode(struct inode *inode)
1249 struct super_block *sb = inode->i_sb;
1251 if (!hlist_unhashed(&inode->i_hash)) {
1252 if (!(inode->i_state & (I_DIRTY|I_SYNC)))
1253 list_move(&inode->i_list, &inode_unused);
1254 inodes_stat.nr_unused++;
1255 if (sb->s_flags & MS_ACTIVE) {
1256 spin_unlock(&inode_lock);
1259 WARN_ON(inode->i_state & I_NEW);
1260 inode->i_state |= I_WILL_FREE;
1261 spin_unlock(&inode_lock);
1262 write_inode_now(inode, 1);
1263 spin_lock(&inode_lock);
1264 WARN_ON(inode->i_state & I_NEW);
1265 inode->i_state &= ~I_WILL_FREE;
1266 inodes_stat.nr_unused--;
1267 hlist_del_init(&inode->i_hash);
1269 list_del_init(&inode->i_list);
1270 list_del_init(&inode->i_sb_list);
1271 WARN_ON(inode->i_state & I_NEW);
1272 inode->i_state |= I_FREEING;
1273 inodes_stat.nr_inodes--;
1274 spin_unlock(&inode_lock);
1278 static void generic_forget_inode(struct inode *inode)
1280 if (!generic_detach_inode(inode))
1283 wake_up_inode(inode);
1284 destroy_inode(inode);
1288 * Normal UNIX filesystem behaviour: delete the
1289 * inode when the usage count drops to zero, and
1292 void generic_drop_inode(struct inode *inode)
1294 if (!inode->i_nlink)
1295 generic_delete_inode(inode);
1297 generic_forget_inode(inode);
1299 EXPORT_SYMBOL_GPL(generic_drop_inode);
1302 * Called when we're dropping the last reference
1305 * Call the FS "drop()" function, defaulting to
1306 * the legacy UNIX filesystem behaviour..
1308 * NOTE! NOTE! NOTE! We're called with the inode lock
1309 * held, and the drop function is supposed to release
1312 static inline void iput_final(struct inode *inode)
1314 const struct super_operations *op = inode->i_sb->s_op;
1315 void (*drop)(struct inode *) = generic_drop_inode;
1317 if (op && op->drop_inode)
1318 drop = op->drop_inode;
1323 * iput - put an inode
1324 * @inode: inode to put
1326 * Puts an inode, dropping its usage count. If the inode use count hits
1327 * zero, the inode is then freed and may also be destroyed.
1329 * Consequently, iput() can sleep.
1331 void iput(struct inode *inode)
1334 BUG_ON(inode->i_state & I_CLEAR);
1336 if (atomic_dec_and_lock(&inode->i_count, &inode_lock))
1340 EXPORT_SYMBOL(iput);
1343 * bmap - find a block number in a file
1344 * @inode: inode of file
1345 * @block: block to find
1347 * Returns the block number on the device holding the inode that
1348 * is the disk block number for the block of the file requested.
1349 * That is, asked for block 4 of inode 1 the function will return the
1350 * disk block relative to the disk start that holds that block of the
1353 sector_t bmap(struct inode *inode, sector_t block)
1356 if (inode->i_mapping->a_ops->bmap)
1357 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1360 EXPORT_SYMBOL(bmap);
1363 * With relative atime, only update atime if the previous atime is
1364 * earlier than either the ctime or mtime or if at least a day has
1365 * passed since the last atime update.
1367 static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
1368 struct timespec now)
1371 if (!(mnt->mnt_flags & MNT_RELATIME))
1374 * Is mtime younger than atime? If yes, update atime:
1376 if (timespec_compare(&inode->i_mtime, &inode->i_atime) >= 0)
1379 * Is ctime younger than atime? If yes, update atime:
1381 if (timespec_compare(&inode->i_ctime, &inode->i_atime) >= 0)
1385 * Is the previous atime value older than a day? If yes,
1388 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1391 * Good, we can skip the atime update:
1397 * touch_atime - update the access time
1398 * @mnt: mount the inode is accessed on
1399 * @dentry: dentry accessed
1401 * Update the accessed time on an inode and mark it for writeback.
1402 * This function automatically handles read only file systems and media,
1403 * as well as the "noatime" flag and inode specific "noatime" markers.
1405 void touch_atime(struct vfsmount *mnt, struct dentry *dentry)
1407 struct inode *inode = dentry->d_inode;
1408 struct timespec now;
1410 if (inode->i_flags & S_NOATIME)
1412 if (IS_NOATIME(inode))
1414 if ((inode->i_sb->s_flags & MS_NODIRATIME) && S_ISDIR(inode->i_mode))
1417 if (mnt->mnt_flags & MNT_NOATIME)
1419 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1422 now = current_fs_time(inode->i_sb);
1424 if (!relatime_need_update(mnt, inode, now))
1427 if (timespec_equal(&inode->i_atime, &now))
1430 if (mnt_want_write(mnt))
1433 inode->i_atime = now;
1434 mark_inode_dirty_sync(inode);
1435 mnt_drop_write(mnt);
1437 EXPORT_SYMBOL(touch_atime);
1440 * file_update_time - update mtime and ctime time
1441 * @file: file accessed
1443 * Update the mtime and ctime members of an inode and mark the inode
1444 * for writeback. Note that this function is meant exclusively for
1445 * usage in the file write path of filesystems, and filesystems may
1446 * choose to explicitly ignore update via this function with the
1447 * S_NOCMTIME inode flag, e.g. for network filesystem where these
1448 * timestamps are handled by the server.
1451 void file_update_time(struct file *file)
1453 struct inode *inode = file->f_path.dentry->d_inode;
1454 struct timespec now;
1455 enum { S_MTIME = 1, S_CTIME = 2, S_VERSION = 4 } sync_it = 0;
1457 /* First try to exhaust all avenues to not sync */
1458 if (IS_NOCMTIME(inode))
1461 now = current_fs_time(inode->i_sb);
1462 if (!timespec_equal(&inode->i_mtime, &now))
1465 if (!timespec_equal(&inode->i_ctime, &now))
1468 if (IS_I_VERSION(inode))
1469 sync_it |= S_VERSION;
1474 /* Finally allowed to write? Takes lock. */
1475 if (mnt_want_write_file(file))
1478 /* Only change inode inside the lock region */
1479 if (sync_it & S_VERSION)
1480 inode_inc_iversion(inode);
1481 if (sync_it & S_CTIME)
1482 inode->i_ctime = now;
1483 if (sync_it & S_MTIME)
1484 inode->i_mtime = now;
1485 mark_inode_dirty_sync(inode);
1486 mnt_drop_write(file->f_path.mnt);
1488 EXPORT_SYMBOL(file_update_time);
1490 int inode_needs_sync(struct inode *inode)
1494 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1498 EXPORT_SYMBOL(inode_needs_sync);
1500 int inode_wait(void *word)
1505 EXPORT_SYMBOL(inode_wait);
1508 * If we try to find an inode in the inode hash while it is being
1509 * deleted, we have to wait until the filesystem completes its
1510 * deletion before reporting that it isn't found. This function waits
1511 * until the deletion _might_ have completed. Callers are responsible
1512 * to recheck inode state.
1514 * It doesn't matter if I_NEW is not set initially, a call to
1515 * wake_up_inode() after removing from the hash list will DTRT.
1517 * This is called with inode_lock held.
1519 static void __wait_on_freeing_inode(struct inode *inode)
1521 wait_queue_head_t *wq;
1522 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1523 wq = bit_waitqueue(&inode->i_state, __I_NEW);
1524 prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
1525 spin_unlock(&inode_lock);
1527 finish_wait(wq, &wait.wait);
1528 spin_lock(&inode_lock);
1531 static __initdata unsigned long ihash_entries;
1532 static int __init set_ihash_entries(char *str)
1536 ihash_entries = simple_strtoul(str, &str, 0);
1539 __setup("ihash_entries=", set_ihash_entries);
1542 * Initialize the waitqueues and inode hash table.
1544 void __init inode_init_early(void)
1548 /* If hashes are distributed across NUMA nodes, defer
1549 * hash allocation until vmalloc space is available.
1555 alloc_large_system_hash("Inode-cache",
1556 sizeof(struct hlist_head),
1564 for (loop = 0; loop < (1 << i_hash_shift); loop++)
1565 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1568 void __init inode_init(void)
1572 /* inode slab cache */
1573 inode_cachep = kmem_cache_create("inode_cache",
1574 sizeof(struct inode),
1576 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
1579 register_shrinker(&icache_shrinker);
1581 /* Hash may have been set up in inode_init_early */
1586 alloc_large_system_hash("Inode-cache",
1587 sizeof(struct hlist_head),
1595 for (loop = 0; loop < (1 << i_hash_shift); loop++)
1596 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1599 void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
1601 inode->i_mode = mode;
1602 if (S_ISCHR(mode)) {
1603 inode->i_fop = &def_chr_fops;
1604 inode->i_rdev = rdev;
1605 } else if (S_ISBLK(mode)) {
1606 inode->i_fop = &def_blk_fops;
1607 inode->i_rdev = rdev;
1608 } else if (S_ISFIFO(mode))
1609 inode->i_fop = &def_fifo_fops;
1610 else if (S_ISSOCK(mode))
1611 inode->i_fop = &bad_sock_fops;
1613 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
1614 " inode %s:%lu\n", mode, inode->i_sb->s_id,
1617 EXPORT_SYMBOL(init_special_inode);
1620 * Init uid,gid,mode for new inode according to posix standards
1622 * @dir: Directory inode
1623 * @mode: mode of the new inode
1625 void inode_init_owner(struct inode *inode, const struct inode *dir,
1628 inode->i_uid = current_fsuid();
1629 if (dir && dir->i_mode & S_ISGID) {
1630 inode->i_gid = dir->i_gid;
1634 inode->i_gid = current_fsgid();
1635 inode->i_mode = mode;
1637 EXPORT_SYMBOL(inode_init_owner);