]> bbs.cooldavid.org Git - net-next-2.6.git/blame - fs/inode.c
->delete_inode() is gone
[net-next-2.6.git] / fs / inode.c
CommitLineData
1da177e4
LT
1/*
2 * linux/fs/inode.c
3 *
4 * (C) 1997 Linus Torvalds
5 */
6
1da177e4
LT
7#include <linux/fs.h>
8#include <linux/mm.h>
9#include <linux/dcache.h>
10#include <linux/init.h>
1da177e4
LT
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>
88e0fbc4 16#include <linux/rwsem.h>
1da177e4
LT
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>
0eeca283 23#include <linux/inotify.h>
3be25f49 24#include <linux/fsnotify.h>
fc33a7bb 25#include <linux/mount.h>
efaee192 26#include <linux/async.h>
f19d4a8f 27#include <linux/posix_acl.h>
1da177e4
LT
28
29/*
30 * This is needed for the following functions:
31 * - inode_has_buffers
32 * - invalidate_inode_buffers
1da177e4
LT
33 * - invalidate_bdev
34 *
35 * FIXME: remove all knowledge of the buffer layer from this file
36 */
37#include <linux/buffer_head.h>
38
39/*
40 * New inode.c implementation.
41 *
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".
45 *
46 * Famous last words.
47 */
48
49/* inode dynamic allocation 1999, Andrea Arcangeli <andrea@suse.de> */
50
51/* #define INODE_PARANOIA 1 */
52/* #define INODE_DEBUG 1 */
53
54/*
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.
57 */
58#define I_HASHBITS i_hash_shift
59#define I_HASHMASK i_hash_mask
60
fa3536cc
ED
61static unsigned int i_hash_mask __read_mostly;
62static unsigned int i_hash_shift __read_mostly;
1da177e4
LT
63
64/*
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
71 *
72 * A "dirty" list is maintained for each super block,
73 * allowing for low-overhead inode sync() operations.
74 */
75
76LIST_HEAD(inode_in_use);
77LIST_HEAD(inode_unused);
fa3536cc 78static struct hlist_head *inode_hashtable __read_mostly;
1da177e4
LT
79
80/*
81 * A simple spinlock to protect the list manipulations.
82 *
83 * NOTE! You also have to own the lock if you change
84 * the i_state of an inode while it is in use..
85 */
86DEFINE_SPINLOCK(inode_lock);
87
88/*
88e0fbc4 89 * iprune_sem provides exclusion between the kswapd or try_to_free_pages
1da177e4
LT
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.
88e0fbc4
NP
95 *
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.
1da177e4 99 */
88e0fbc4 100static DECLARE_RWSEM(iprune_sem);
1da177e4
LT
101
102/*
103 * Statistics gathering..
104 */
105struct inodes_stat_t inodes_stat;
106
6b3304b5 107static struct kmem_cache *inode_cachep __read_mostly;
1da177e4 108
1c0eeaf5
JE
109static void wake_up_inode(struct inode *inode)
110{
111 /*
112 * Prevent speculative execution through spin_unlock(&inode_lock);
113 */
114 smp_mb();
eaff8079 115 wake_up_bit(&inode->i_state, __I_NEW);
1c0eeaf5
JE
116}
117
2cb1599f
DC
118/**
119 * inode_init_always - perform inode structure intialisation
0bc02f3f
RD
120 * @sb: superblock inode belongs to
121 * @inode: inode to initialise
2cb1599f
DC
122 *
123 * These are initializations that need to be done on every inode
124 * allocation as the fields are not initialised by slab allocation.
125 */
54e34621 126int inode_init_always(struct super_block *sb, struct inode *inode)
1da177e4 127{
f5e54d6e 128 static const struct address_space_operations empty_aops;
6e1d5dcc 129 static const struct inode_operations empty_iops;
99ac48f5 130 static const struct file_operations empty_fops;
6b3304b5 131 struct address_space *const mapping = &inode->i_data;
2cb1599f
DC
132
133 inode->i_sb = sb;
134 inode->i_blkbits = sb->s_blocksize_bits;
135 inode->i_flags = 0;
136 atomic_set(&inode->i_count, 1);
137 inode->i_op = &empty_iops;
138 inode->i_fop = &empty_fops;
139 inode->i_nlink = 1;
56ff5efa
AV
140 inode->i_uid = 0;
141 inode->i_gid = 0;
2cb1599f
DC
142 atomic_set(&inode->i_writecount, 0);
143 inode->i_size = 0;
144 inode->i_blocks = 0;
145 inode->i_bytes = 0;
146 inode->i_generation = 0;
1da177e4 147#ifdef CONFIG_QUOTA
2cb1599f 148 memset(&inode->i_dquot, 0, sizeof(inode->i_dquot));
1da177e4 149#endif
2cb1599f
DC
150 inode->i_pipe = NULL;
151 inode->i_bdev = NULL;
152 inode->i_cdev = NULL;
153 inode->i_rdev = 0;
154 inode->dirtied_when = 0;
6146f0d5
MZ
155
156 if (security_inode_alloc(inode))
54e34621 157 goto out;
2cb1599f
DC
158 spin_lock_init(&inode->i_lock);
159 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
160
161 mutex_init(&inode->i_mutex);
162 lockdep_set_class(&inode->i_mutex, &sb->s_type->i_mutex_key);
163
164 init_rwsem(&inode->i_alloc_sem);
165 lockdep_set_class(&inode->i_alloc_sem, &sb->s_type->i_alloc_sem_key);
166
167 mapping->a_ops = &empty_aops;
168 mapping->host = inode;
169 mapping->flags = 0;
3c1d4378 170 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
2cb1599f
DC
171 mapping->assoc_mapping = NULL;
172 mapping->backing_dev_info = &default_backing_dev_info;
173 mapping->writeback_index = 0;
174
175 /*
176 * If the block_device provides a backing_dev_info for client
177 * inodes then use that. Otherwise the inode share the bdev's
178 * backing_dev_info.
179 */
180 if (sb->s_bdev) {
181 struct backing_dev_info *bdi;
182
2c96ce9f 183 bdi = sb->s_bdev->bd_inode->i_mapping->backing_dev_info;
2cb1599f
DC
184 mapping->backing_dev_info = bdi;
185 }
186 inode->i_private = NULL;
187 inode->i_mapping = mapping;
f19d4a8f
AV
188#ifdef CONFIG_FS_POSIX_ACL
189 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
190#endif
2cb1599f 191
3be25f49
EP
192#ifdef CONFIG_FSNOTIFY
193 inode->i_fsnotify_mask = 0;
194#endif
195
54e34621 196 return 0;
54e34621
CH
197out:
198 return -ENOMEM;
1da177e4 199}
2cb1599f
DC
200EXPORT_SYMBOL(inode_init_always);
201
202static struct inode *alloc_inode(struct super_block *sb)
203{
204 struct inode *inode;
205
206 if (sb->s_op->alloc_inode)
207 inode = sb->s_op->alloc_inode(sb);
208 else
209 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
210
54e34621
CH
211 if (!inode)
212 return NULL;
213
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);
217 else
218 kmem_cache_free(inode_cachep, inode);
219 return NULL;
220 }
221
222 return inode;
2cb1599f 223}
1da177e4 224
2e00c97e 225void __destroy_inode(struct inode *inode)
1da177e4 226{
b7542f8c 227 BUG_ON(inode_has_buffers(inode));
1da177e4 228 security_inode_free(inode);
3be25f49 229 fsnotify_inode_delete(inode);
f19d4a8f
AV
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);
235#endif
2e00c97e
CH
236}
237EXPORT_SYMBOL(__destroy_inode);
238
239void destroy_inode(struct inode *inode)
240{
241 __destroy_inode(inode);
1da177e4
LT
242 if (inode->i_sb->s_op->destroy_inode)
243 inode->i_sb->s_op->destroy_inode(inode);
244 else
245 kmem_cache_free(inode_cachep, (inode));
246}
1da177e4
LT
247
248/*
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.
252 */
253void inode_init_once(struct inode *inode)
254{
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);
1da177e4 259 INIT_RADIX_TREE(&inode->i_data.page_tree, GFP_ATOMIC);
19fd6231 260 spin_lock_init(&inode->i_data.tree_lock);
1da177e4
LT
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);
1da177e4 266 i_size_ordered_init(inode);
0eeca283
RL
267#ifdef CONFIG_INOTIFY
268 INIT_LIST_HEAD(&inode->inotify_watches);
d4f9af9d 269 mutex_init(&inode->inotify_mutex);
0eeca283 270#endif
3be25f49
EP
271#ifdef CONFIG_FSNOTIFY
272 INIT_HLIST_HEAD(&inode->i_fsnotify_mark_entries);
273#endif
1da177e4 274}
1da177e4
LT
275EXPORT_SYMBOL(inode_init_once);
276
51cc5068 277static void init_once(void *foo)
1da177e4 278{
6b3304b5 279 struct inode *inode = (struct inode *) foo;
1da177e4 280
a35afb83 281 inode_init_once(inode);
1da177e4
LT
282}
283
284/*
285 * inode_lock must be held
286 */
6b3304b5 287void __iget(struct inode *inode)
1da177e4 288{
2e147f1e 289 if (atomic_inc_return(&inode->i_count) != 1)
1da177e4 290 return;
2e147f1e 291
1c0eeaf5 292 if (!(inode->i_state & (I_DIRTY|I_SYNC)))
1da177e4
LT
293 list_move(&inode->i_list, &inode_in_use);
294 inodes_stat.nr_unused--;
295}
296
b0683aa6
AV
297void end_writeback(struct inode *inode)
298{
299 might_sleep();
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;
306}
307EXPORT_SYMBOL(end_writeback);
308
1da177e4
LT
309/**
310 * clear_inode - clear an inode
311 * @inode: inode to clear
312 *
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.
316 */
317void clear_inode(struct inode *inode)
318{
319 might_sleep();
320 invalidate_inode_buffers(inode);
6b3304b5 321
b7542f8c
ES
322 BUG_ON(inode->i_data.nrpages);
323 BUG_ON(!(inode->i_state & I_FREEING));
324 BUG_ON(inode->i_state & I_CLEAR);
1c0eeaf5 325 inode_sync_wait(inode);
acb0c854 326 if (inode->i_sb->s_op->clear_inode)
1da177e4 327 inode->i_sb->s_op->clear_inode(inode);
a4ffdde6 328 inode->i_state = I_FREEING | I_CLEAR;
1da177e4 329}
1da177e4
LT
330EXPORT_SYMBOL(clear_inode);
331
b4272d4c
AV
332static void evict(struct inode *inode, int delete)
333{
334 const struct super_operations *op = inode->i_sb->s_op;
335
be7ce416
AV
336 if (op->evict_inode) {
337 op->evict_inode(inode);
b4272d4c
AV
338 } else {
339 if (inode->i_data.nrpages)
340 truncate_inode_pages(&inode->i_data, 0);
341 clear_inode(inode);
342 }
661074e9
AV
343 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
344 bd_forget(inode);
345 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
346 cd_forget(inode);
b4272d4c
AV
347}
348
1da177e4
LT
349/*
350 * dispose_list - dispose of the contents of a local list
351 * @head: the head of the list to free
352 *
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.
355 */
356static void dispose_list(struct list_head *head)
357{
358 int nr_disposed = 0;
359
360 while (!list_empty(head)) {
361 struct inode *inode;
362
b5e61818 363 inode = list_first_entry(head, struct inode, i_list);
1da177e4
LT
364 list_del(&inode->i_list);
365
b4272d4c 366 evict(inode, 0);
4120db47
AB
367
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);
372
373 wake_up_inode(inode);
1da177e4
LT
374 destroy_inode(inode);
375 nr_disposed++;
376 }
377 spin_lock(&inode_lock);
378 inodes_stat.nr_inodes -= nr_disposed;
379 spin_unlock(&inode_lock);
380}
381
382/*
383 * Invalidate all inodes for a device.
384 */
385static int invalidate_list(struct list_head *head, struct list_head *dispose)
386{
387 struct list_head *next;
388 int busy = 0, count = 0;
389
390 next = head->next;
391 for (;;) {
6b3304b5
MK
392 struct list_head *tmp = next;
393 struct inode *inode;
1da177e4
LT
394
395 /*
396 * We can reschedule here without worrying about the list's
397 * consistency because the per-sb list of inodes must not
88e0fbc4 398 * change during umount anymore, and because iprune_sem keeps
1da177e4
LT
399 * shrink_icache_memory() away.
400 */
401 cond_resched_lock(&inode_lock);
402
403 next = next->next;
404 if (tmp == head)
405 break;
406 inode = list_entry(tmp, struct inode, i_sb_list);
aabb8fdb
NP
407 if (inode->i_state & I_NEW)
408 continue;
1da177e4
LT
409 invalidate_inode_buffers(inode);
410 if (!atomic_read(&inode->i_count)) {
1da177e4 411 list_move(&inode->i_list, dispose);
7ef0d737 412 WARN_ON(inode->i_state & I_NEW);
1da177e4
LT
413 inode->i_state |= I_FREEING;
414 count++;
415 continue;
416 }
417 busy = 1;
418 }
419 /* only unused inodes may be cached with i_count zero */
420 inodes_stat.nr_unused -= count;
421 return busy;
422}
423
1da177e4
LT
424/**
425 * invalidate_inodes - discard the inodes on a device
426 * @sb: superblock
427 *
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.
431 */
6b3304b5 432int invalidate_inodes(struct super_block *sb)
1da177e4
LT
433{
434 int busy;
435 LIST_HEAD(throw_away);
436
88e0fbc4 437 down_write(&iprune_sem);
1da177e4 438 spin_lock(&inode_lock);
0eeca283 439 inotify_unmount_inodes(&sb->s_inodes);
164bc619 440 fsnotify_unmount_inodes(&sb->s_inodes);
1da177e4
LT
441 busy = invalidate_list(&sb->s_inodes, &throw_away);
442 spin_unlock(&inode_lock);
443
444 dispose_list(&throw_away);
88e0fbc4 445 up_write(&iprune_sem);
1da177e4
LT
446
447 return busy;
448}
1da177e4 449EXPORT_SYMBOL(invalidate_inodes);
1da177e4
LT
450
451static int can_unuse(struct inode *inode)
452{
453 if (inode->i_state)
454 return 0;
455 if (inode_has_buffers(inode))
456 return 0;
457 if (atomic_read(&inode->i_count))
458 return 0;
459 if (inode->i_data.nrpages)
460 return 0;
461 return 1;
462}
463
464/*
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().
467 *
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.
473 *
474 * If the inode has metadata buffers attached to mapping->private_list then
475 * try to remove them.
476 */
477static void prune_icache(int nr_to_scan)
478{
479 LIST_HEAD(freeable);
480 int nr_pruned = 0;
481 int nr_scanned;
482 unsigned long reap = 0;
483
88e0fbc4 484 down_read(&iprune_sem);
1da177e4
LT
485 spin_lock(&inode_lock);
486 for (nr_scanned = 0; nr_scanned < nr_to_scan; nr_scanned++) {
487 struct inode *inode;
488
489 if (list_empty(&inode_unused))
490 break;
491
492 inode = list_entry(inode_unused.prev, struct inode, i_list);
493
494 if (inode->i_state || atomic_read(&inode->i_count)) {
495 list_move(&inode->i_list, &inode_unused);
496 continue;
497 }
498 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
499 __iget(inode);
500 spin_unlock(&inode_lock);
501 if (remove_inode_buffers(inode))
fc0ecff6
AM
502 reap += invalidate_mapping_pages(&inode->i_data,
503 0, -1);
1da177e4
LT
504 iput(inode);
505 spin_lock(&inode_lock);
506
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))
511 continue;
512 }
1da177e4 513 list_move(&inode->i_list, &freeable);
7ef0d737 514 WARN_ON(inode->i_state & I_NEW);
1da177e4
LT
515 inode->i_state |= I_FREEING;
516 nr_pruned++;
517 }
518 inodes_stat.nr_unused -= nr_pruned;
f8891e5e
CL
519 if (current_is_kswapd())
520 __count_vm_events(KSWAPD_INODESTEAL, reap);
521 else
522 __count_vm_events(PGINODESTEAL, reap);
1da177e4
LT
523 spin_unlock(&inode_lock);
524
525 dispose_list(&freeable);
88e0fbc4 526 up_read(&iprune_sem);
1da177e4
LT
527}
528
529/*
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
533 * reclaimed.
534 *
535 * This function is passed the number of inodes to scan, and it returns the
536 * total number of remaining possibly-reclaimable inodes.
537 */
7f8275d0 538static int shrink_icache_memory(struct shrinker *shrink, int nr, gfp_t gfp_mask)
1da177e4
LT
539{
540 if (nr) {
541 /*
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..
6b3304b5 545 */
1da177e4
LT
546 if (!(gfp_mask & __GFP_FS))
547 return -1;
548 prune_icache(nr);
549 }
550 return (inodes_stat.nr_unused / 100) * sysctl_vfs_cache_pressure;
551}
552
8e1f936b
RR
553static struct shrinker icache_shrinker = {
554 .shrink = shrink_icache_memory,
555 .seeks = DEFAULT_SEEKS,
556};
557
1da177e4
LT
558static void __wait_on_freeing_inode(struct inode *inode);
559/*
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.
564 */
6b3304b5
MK
565static struct inode *find_inode(struct super_block *sb,
566 struct hlist_head *head,
567 int (*test)(struct inode *, void *),
568 void *data)
1da177e4
LT
569{
570 struct hlist_node *node;
6b3304b5 571 struct inode *inode = NULL;
1da177e4
LT
572
573repeat:
c5c8be3c 574 hlist_for_each_entry(inode, node, head, i_hash) {
1da177e4
LT
575 if (inode->i_sb != sb)
576 continue;
577 if (!test(inode, data))
578 continue;
a4ffdde6 579 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
1da177e4
LT
580 __wait_on_freeing_inode(inode);
581 goto repeat;
582 }
583 break;
584 }
585 return node ? inode : NULL;
586}
587
588/*
589 * find_inode_fast is the fast path version of find_inode, see the comment at
590 * iget_locked for details.
591 */
6b3304b5
MK
592static struct inode *find_inode_fast(struct super_block *sb,
593 struct hlist_head *head, unsigned long ino)
1da177e4
LT
594{
595 struct hlist_node *node;
6b3304b5 596 struct inode *inode = NULL;
1da177e4
LT
597
598repeat:
c5c8be3c 599 hlist_for_each_entry(inode, node, head, i_hash) {
1da177e4
LT
600 if (inode->i_ino != ino)
601 continue;
602 if (inode->i_sb != sb)
603 continue;
a4ffdde6 604 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
1da177e4
LT
605 __wait_on_freeing_inode(inode);
606 goto repeat;
607 }
608 break;
609 }
610 return node ? inode : NULL;
611}
612
8290c35f
DC
613static unsigned long hash(struct super_block *sb, unsigned long hashval)
614{
615 unsigned long tmp;
616
617 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
618 L1_CACHE_BYTES;
619 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> I_HASHBITS);
620 return tmp & I_HASHMASK;
621}
622
623static inline void
624__inode_add_to_lists(struct super_block *sb, struct hlist_head *head,
625 struct inode *inode)
626{
627 inodes_stat.nr_inodes++;
628 list_add(&inode->i_list, &inode_in_use);
629 list_add(&inode->i_sb_list, &sb->s_inodes);
630 if (head)
631 hlist_add_head(&inode->i_hash, head);
632}
633
634/**
635 * inode_add_to_lists - add a new inode to relevant lists
0bc02f3f
RD
636 * @sb: superblock inode belongs to
637 * @inode: inode to mark in use
8290c35f
DC
638 *
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
644 * inode to add.
645 */
646void inode_add_to_lists(struct super_block *sb, struct inode *inode)
647{
648 struct hlist_head *head = inode_hashtable + hash(sb, inode->i_ino);
649
650 spin_lock(&inode_lock);
651 __inode_add_to_lists(sb, head, inode);
652 spin_unlock(&inode_lock);
653}
654EXPORT_SYMBOL_GPL(inode_add_to_lists);
655
1da177e4
LT
656/**
657 * new_inode - obtain an inode
658 * @sb: superblock
659 *
769848c0 660 * Allocates a new inode for given superblock. The default gfp_mask
3c1d4378 661 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
769848c0
MG
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
666 *
1da177e4
LT
667 */
668struct inode *new_inode(struct super_block *sb)
669{
866b04fc
JL
670 /*
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.
674 */
675 static unsigned int last_ino;
6b3304b5 676 struct inode *inode;
1da177e4
LT
677
678 spin_lock_prefetch(&inode_lock);
6b3304b5 679
1da177e4
LT
680 inode = alloc_inode(sb);
681 if (inode) {
682 spin_lock(&inode_lock);
8290c35f 683 __inode_add_to_lists(sb, NULL, inode);
1da177e4
LT
684 inode->i_ino = ++last_ino;
685 inode->i_state = 0;
686 spin_unlock(&inode_lock);
687 }
688 return inode;
689}
1da177e4
LT
690EXPORT_SYMBOL(new_inode);
691
692void unlock_new_inode(struct inode *inode)
693{
14358e6d 694#ifdef CONFIG_DEBUG_LOCK_ALLOC
1e89a5e1
PZ
695 if (inode->i_mode & S_IFDIR) {
696 struct file_system_type *type = inode->i_sb->s_type;
697
9a7aa12f
JK
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)) {
701 /*
702 * ensure nobody is actually holding i_mutex
703 */
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);
708 }
1e89a5e1 709 }
14358e6d 710#endif
1da177e4 711 /*
eaff8079 712 * This is special! We do not need the spinlock when clearing I_NEW,
580be083
JK
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
eaff8079 715 * there can be no old holders that haven't tested I_NEW).
580be083 716 * However we must emit the memory barrier so that other CPUs reliably
eaff8079 717 * see the clearing of I_NEW after the other inode initialisation has
580be083 718 * completed.
1da177e4 719 */
580be083 720 smp_mb();
eaff8079
CH
721 WARN_ON(!(inode->i_state & I_NEW));
722 inode->i_state &= ~I_NEW;
1da177e4
LT
723 wake_up_inode(inode);
724}
1da177e4
LT
725EXPORT_SYMBOL(unlock_new_inode);
726
727/*
728 * This is called without the inode lock held.. Be careful.
729 *
730 * We no longer cache the sb_flags in i_flags - see fs.h
731 * -- rmk@arm.uk.linux.org
732 */
6b3304b5
MK
733static 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 *),
737 void *data)
1da177e4 738{
6b3304b5 739 struct inode *inode;
1da177e4
LT
740
741 inode = alloc_inode(sb);
742 if (inode) {
6b3304b5 743 struct inode *old;
1da177e4
LT
744
745 spin_lock(&inode_lock);
746 /* We released the lock, so.. */
747 old = find_inode(sb, head, test, data);
748 if (!old) {
749 if (set(inode, data))
750 goto set_failed;
751
8290c35f 752 __inode_add_to_lists(sb, head, inode);
eaff8079 753 inode->i_state = I_NEW;
1da177e4
LT
754 spin_unlock(&inode_lock);
755
756 /* Return the locked inode with I_NEW set, the
757 * caller is responsible for filling in the contents
758 */
759 return inode;
760 }
761
762 /*
763 * Uhhuh, somebody else created the same inode under
764 * us. Use the old inode instead of the one we just
765 * allocated.
766 */
767 __iget(old);
768 spin_unlock(&inode_lock);
769 destroy_inode(inode);
770 inode = old;
771 wait_on_inode(inode);
772 }
773 return inode;
774
775set_failed:
776 spin_unlock(&inode_lock);
777 destroy_inode(inode);
778 return NULL;
779}
780
781/*
782 * get_new_inode_fast is the fast path version of get_new_inode, see the
783 * comment at iget_locked for details.
784 */
6b3304b5
MK
785static struct inode *get_new_inode_fast(struct super_block *sb,
786 struct hlist_head *head, unsigned long ino)
1da177e4 787{
6b3304b5 788 struct inode *inode;
1da177e4
LT
789
790 inode = alloc_inode(sb);
791 if (inode) {
6b3304b5 792 struct inode *old;
1da177e4
LT
793
794 spin_lock(&inode_lock);
795 /* We released the lock, so.. */
796 old = find_inode_fast(sb, head, ino);
797 if (!old) {
798 inode->i_ino = ino;
8290c35f 799 __inode_add_to_lists(sb, head, inode);
eaff8079 800 inode->i_state = I_NEW;
1da177e4
LT
801 spin_unlock(&inode_lock);
802
803 /* Return the locked inode with I_NEW set, the
804 * caller is responsible for filling in the contents
805 */
806 return inode;
807 }
808
809 /*
810 * Uhhuh, somebody else created the same inode under
811 * us. Use the old inode instead of the one we just
812 * allocated.
813 */
814 __iget(old);
815 spin_unlock(&inode_lock);
816 destroy_inode(inode);
817 inode = old;
818 wait_on_inode(inode);
819 }
820 return inode;
821}
822
1da177e4
LT
823/**
824 * iunique - get a unique inode number
825 * @sb: superblock
826 * @max_reserved: highest reserved inode number
827 *
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.
832 *
833 * BUGS:
834 * With a large number of inodes live on the file system this function
835 * currently becomes quite slow.
836 */
837ino_t iunique(struct super_block *sb, ino_t max_reserved)
838{
866b04fc
JL
839 /*
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.
843 */
844 static unsigned int counter;
1da177e4 845 struct inode *inode;
3361c7be 846 struct hlist_head *head;
1da177e4 847 ino_t res;
3361c7be 848
1da177e4 849 spin_lock(&inode_lock);
3361c7be
JL
850 do {
851 if (counter <= max_reserved)
852 counter = max_reserved + 1;
1da177e4 853 res = counter++;
3361c7be 854 head = inode_hashtable + hash(sb, res);
1da177e4 855 inode = find_inode_fast(sb, head, res);
3361c7be
JL
856 } while (inode != NULL);
857 spin_unlock(&inode_lock);
1da177e4 858
3361c7be
JL
859 return res;
860}
1da177e4
LT
861EXPORT_SYMBOL(iunique);
862
863struct inode *igrab(struct inode *inode)
864{
865 spin_lock(&inode_lock);
a4ffdde6 866 if (!(inode->i_state & (I_FREEING|I_WILL_FREE)))
1da177e4
LT
867 __iget(inode);
868 else
869 /*
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.
873 */
874 inode = NULL;
875 spin_unlock(&inode_lock);
876 return inode;
877}
1da177e4
LT
878EXPORT_SYMBOL(igrab);
879
880/**
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
88bd5121 886 * @wait: if true wait for the inode to be unlocked, if false do not
1da177e4
LT
887 *
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.
891 *
892 * If the inode is in the cache, the inode is returned with an incremented
893 * reference count.
894 *
895 * Otherwise NULL is returned.
896 *
897 * Note, @test is called with the inode_lock held, so can't sleep.
898 */
5d2bea45 899static struct inode *ifind(struct super_block *sb,
1da177e4 900 struct hlist_head *head, int (*test)(struct inode *, void *),
88bd5121 901 void *data, const int wait)
1da177e4
LT
902{
903 struct inode *inode;
904
905 spin_lock(&inode_lock);
906 inode = find_inode(sb, head, test, data);
907 if (inode) {
908 __iget(inode);
909 spin_unlock(&inode_lock);
88bd5121
AA
910 if (likely(wait))
911 wait_on_inode(inode);
1da177e4
LT
912 return inode;
913 }
914 spin_unlock(&inode_lock);
915 return NULL;
916}
917
918/**
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
923 *
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
926 * of an inode.
927 *
928 * If the inode is in the cache, the inode is returned with an incremented
929 * reference count.
930 *
931 * Otherwise NULL is returned.
932 */
5d2bea45 933static struct inode *ifind_fast(struct super_block *sb,
1da177e4
LT
934 struct hlist_head *head, unsigned long ino)
935{
936 struct inode *inode;
937
938 spin_lock(&inode_lock);
939 inode = find_inode_fast(sb, head, ino);
940 if (inode) {
941 __iget(inode);
942 spin_unlock(&inode_lock);
943 wait_on_inode(inode);
944 return inode;
945 }
946 spin_unlock(&inode_lock);
947 return NULL;
948}
949
950/**
88bd5121 951 * ilookup5_nowait - search for an inode in the inode cache
1da177e4
LT
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
956 *
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.
961 *
962 * If the inode is in the cache, the inode is returned with an incremented
88bd5121
AA
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.
966 *
967 * Otherwise NULL is returned.
968 *
969 * Note, @test is called with the inode_lock held, so can't sleep.
970 */
971struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
972 int (*test)(struct inode *, void *), void *data)
973{
974 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
975
976 return ifind(sb, head, test, data, 0);
977}
88bd5121
AA
978EXPORT_SYMBOL(ilookup5_nowait);
979
980/**
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
986 *
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.
991 *
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.
1da177e4
LT
994 *
995 * Otherwise NULL is returned.
996 *
997 * Note, @test is called with the inode_lock held, so can't sleep.
998 */
999struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1000 int (*test)(struct inode *, void *), void *data)
1001{
1002 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1003
88bd5121 1004 return ifind(sb, head, test, data, 1);
1da177e4 1005}
1da177e4
LT
1006EXPORT_SYMBOL(ilookup5);
1007
1008/**
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
1012 *
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.
1016 *
1017 * If the inode is in the cache, the inode is returned with an incremented
1018 * reference count.
1019 *
1020 * Otherwise NULL is returned.
1021 */
1022struct inode *ilookup(struct super_block *sb, unsigned long ino)
1023{
1024 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1025
1026 return ifind_fast(sb, head, ino);
1027}
1da177e4
LT
1028EXPORT_SYMBOL(ilookup);
1029
1030/**
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
1037 *
1da177e4
LT
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
1042 * of an inode.
1043 *
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().
1047 *
1048 * Note both @test and @set are called with the inode_lock held, so can't sleep.
1049 */
1050struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1051 int (*test)(struct inode *, void *),
1052 int (*set)(struct inode *, void *), void *data)
1053{
1054 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1055 struct inode *inode;
1056
88bd5121 1057 inode = ifind(sb, head, test, data, 1);
1da177e4
LT
1058 if (inode)
1059 return inode;
1060 /*
1061 * get_new_inode() will do the right thing, re-trying the search
1062 * in case it had to block at any point.
1063 */
1064 return get_new_inode(sb, head, test, set, data);
1065}
1da177e4
LT
1066EXPORT_SYMBOL(iget5_locked);
1067
1068/**
1069 * iget_locked - obtain an inode from a mounted file system
1070 * @sb: super block of file system
1071 * @ino: inode number to get
1072 *
1da177e4
LT
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.
1077 *
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().
1082 */
1083struct inode *iget_locked(struct super_block *sb, unsigned long ino)
1084{
1085 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1086 struct inode *inode;
1087
1088 inode = ifind_fast(sb, head, ino);
1089 if (inode)
1090 return inode;
1091 /*
1092 * get_new_inode_fast() will do the right thing, re-trying the search
1093 * in case it had to block at any point.
1094 */
1095 return get_new_inode_fast(sb, head, ino);
1096}
1da177e4
LT
1097EXPORT_SYMBOL(iget_locked);
1098
261bca86
AV
1099int insert_inode_locked(struct inode *inode)
1100{
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);
261bca86 1104
eaff8079 1105 inode->i_state |= I_NEW;
261bca86 1106 while (1) {
72a43d63
AV
1107 struct hlist_node *node;
1108 struct inode *old = NULL;
261bca86 1109 spin_lock(&inode_lock);
72a43d63
AV
1110 hlist_for_each_entry(old, node, head, i_hash) {
1111 if (old->i_ino != ino)
1112 continue;
1113 if (old->i_sb != sb)
1114 continue;
a4ffdde6 1115 if (old->i_state & (I_FREEING|I_WILL_FREE))
72a43d63
AV
1116 continue;
1117 break;
1118 }
1119 if (likely(!node)) {
261bca86
AV
1120 hlist_add_head(&inode->i_hash, head);
1121 spin_unlock(&inode_lock);
1122 return 0;
1123 }
1124 __iget(old);
1125 spin_unlock(&inode_lock);
1126 wait_on_inode(old);
1127 if (unlikely(!hlist_unhashed(&old->i_hash))) {
1128 iput(old);
1129 return -EBUSY;
1130 }
1131 iput(old);
1132 }
1133}
261bca86
AV
1134EXPORT_SYMBOL(insert_inode_locked);
1135
1136int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1137 int (*test)(struct inode *, void *), void *data)
1138{
1139 struct super_block *sb = inode->i_sb;
1140 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
261bca86 1141
eaff8079 1142 inode->i_state |= I_NEW;
261bca86
AV
1143
1144 while (1) {
72a43d63
AV
1145 struct hlist_node *node;
1146 struct inode *old = NULL;
1147
261bca86 1148 spin_lock(&inode_lock);
72a43d63
AV
1149 hlist_for_each_entry(old, node, head, i_hash) {
1150 if (old->i_sb != sb)
1151 continue;
1152 if (!test(old, data))
1153 continue;
a4ffdde6 1154 if (old->i_state & (I_FREEING|I_WILL_FREE))
72a43d63
AV
1155 continue;
1156 break;
1157 }
1158 if (likely(!node)) {
261bca86
AV
1159 hlist_add_head(&inode->i_hash, head);
1160 spin_unlock(&inode_lock);
1161 return 0;
1162 }
1163 __iget(old);
1164 spin_unlock(&inode_lock);
1165 wait_on_inode(old);
1166 if (unlikely(!hlist_unhashed(&old->i_hash))) {
1167 iput(old);
1168 return -EBUSY;
1169 }
1170 iput(old);
1171 }
1172}
261bca86
AV
1173EXPORT_SYMBOL(insert_inode_locked4);
1174
1da177e4
LT
1175/**
1176 * __insert_inode_hash - hash an inode
1177 * @inode: unhashed inode
1178 * @hashval: unsigned long value used to locate this object in the
1179 * inode_hashtable.
1180 *
1181 * Add an inode to the inode hash for this superblock.
1182 */
1183void __insert_inode_hash(struct inode *inode, unsigned long hashval)
1184{
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);
1189}
1da177e4
LT
1190EXPORT_SYMBOL(__insert_inode_hash);
1191
1192/**
1193 * remove_inode_hash - remove an inode from the hash
1194 * @inode: inode to unhash
1195 *
1196 * Remove an inode from the superblock.
1197 */
1198void remove_inode_hash(struct inode *inode)
1199{
1200 spin_lock(&inode_lock);
1201 hlist_del_init(&inode->i_hash);
1202 spin_unlock(&inode_lock);
1203}
1da177e4
LT
1204EXPORT_SYMBOL(remove_inode_hash);
1205
1206/*
1207 * Tell the filesystem that this inode is no longer of any interest and should
1208 * be completely destroyed.
1209 *
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
1213 * disk.
1214 *
1215 * I_FREEING is set so that no-one will take a new reference to the inode while
1216 * it is being deleted.
1217 */
b32714ba 1218void generic_delete_inode(struct inode *inode)
1da177e4 1219{
b32714ba
AV
1220 list_del_init(&inode->i_list);
1221 list_del_init(&inode->i_sb_list);
7ef0d737 1222 WARN_ON(inode->i_state & I_NEW);
b32714ba
AV
1223 inode->i_state |= I_FREEING;
1224 inodes_stat.nr_inodes--;
1225 spin_unlock(&inode_lock);
1226
b4272d4c
AV
1227 evict(inode, 1);
1228
1da177e4
LT
1229 spin_lock(&inode_lock);
1230 hlist_del_init(&inode->i_hash);
1231 spin_unlock(&inode_lock);
1232 wake_up_inode(inode);
a4ffdde6 1233 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
1da177e4
LT
1234 destroy_inode(inode);
1235}
1da177e4
LT
1236EXPORT_SYMBOL(generic_delete_inode);
1237
22fe4042
JK
1238/**
1239 * generic_detach_inode - remove inode from inode lists
1240 * @inode: inode to remove
1241 *
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!
1244 *
1245 * Returns 1 if inode should be completely destroyed.
1246 */
c6287315 1247static int generic_detach_inode(struct inode *inode)
1da177e4
LT
1248{
1249 struct super_block *sb = inode->i_sb;
1250
1251 if (!hlist_unhashed(&inode->i_hash)) {
1c0eeaf5 1252 if (!(inode->i_state & (I_DIRTY|I_SYNC)))
1da177e4
LT
1253 list_move(&inode->i_list, &inode_unused);
1254 inodes_stat.nr_unused++;
acb0c854 1255 if (sb->s_flags & MS_ACTIVE) {
991114c6 1256 spin_unlock(&inode_lock);
22fe4042 1257 return 0;
991114c6 1258 }
7ef0d737 1259 WARN_ON(inode->i_state & I_NEW);
991114c6
AV
1260 inode->i_state |= I_WILL_FREE;
1261 spin_unlock(&inode_lock);
1da177e4
LT
1262 write_inode_now(inode, 1);
1263 spin_lock(&inode_lock);
7ef0d737 1264 WARN_ON(inode->i_state & I_NEW);
991114c6 1265 inode->i_state &= ~I_WILL_FREE;
1da177e4
LT
1266 inodes_stat.nr_unused--;
1267 hlist_del_init(&inode->i_hash);
1268 }
1269 list_del_init(&inode->i_list);
1270 list_del_init(&inode->i_sb_list);
7ef0d737 1271 WARN_ON(inode->i_state & I_NEW);
991114c6 1272 inode->i_state |= I_FREEING;
1da177e4
LT
1273 inodes_stat.nr_inodes--;
1274 spin_unlock(&inode_lock);
22fe4042
JK
1275 return 1;
1276}
22fe4042
JK
1277
1278static void generic_forget_inode(struct inode *inode)
1279{
1280 if (!generic_detach_inode(inode))
1281 return;
b4272d4c 1282 evict(inode, 0);
7f04c26d 1283 wake_up_inode(inode);
1da177e4
LT
1284 destroy_inode(inode);
1285}
1286
1287/*
1288 * Normal UNIX filesystem behaviour: delete the
1289 * inode when the usage count drops to zero, and
1290 * i_nlink is zero.
1291 */
cb2c0233 1292void generic_drop_inode(struct inode *inode)
1da177e4
LT
1293{
1294 if (!inode->i_nlink)
1295 generic_delete_inode(inode);
1296 else
1297 generic_forget_inode(inode);
1298}
cb2c0233
MF
1299EXPORT_SYMBOL_GPL(generic_drop_inode);
1300
1da177e4
LT
1301/*
1302 * Called when we're dropping the last reference
6b3304b5 1303 * to an inode.
1da177e4
LT
1304 *
1305 * Call the FS "drop()" function, defaulting to
1306 * the legacy UNIX filesystem behaviour..
1307 *
1308 * NOTE! NOTE! NOTE! We're called with the inode lock
1309 * held, and the drop function is supposed to release
1310 * the lock!
1311 */
1312static inline void iput_final(struct inode *inode)
1313{
ee9b6d61 1314 const struct super_operations *op = inode->i_sb->s_op;
1da177e4
LT
1315 void (*drop)(struct inode *) = generic_drop_inode;
1316
1317 if (op && op->drop_inode)
1318 drop = op->drop_inode;
1319 drop(inode);
1320}
1321
1322/**
6b3304b5 1323 * iput - put an inode
1da177e4
LT
1324 * @inode: inode to put
1325 *
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.
1328 *
1329 * Consequently, iput() can sleep.
1330 */
1331void iput(struct inode *inode)
1332{
1333 if (inode) {
a4ffdde6 1334 BUG_ON(inode->i_state & I_CLEAR);
1da177e4 1335
1da177e4
LT
1336 if (atomic_dec_and_lock(&inode->i_count, &inode_lock))
1337 iput_final(inode);
1338 }
1339}
1da177e4
LT
1340EXPORT_SYMBOL(iput);
1341
1342/**
1343 * bmap - find a block number in a file
1344 * @inode: inode of file
1345 * @block: block to find
1346 *
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
6b3304b5 1350 * disk block relative to the disk start that holds that block of the
1da177e4
LT
1351 * file.
1352 */
6b3304b5 1353sector_t bmap(struct inode *inode, sector_t block)
1da177e4
LT
1354{
1355 sector_t res = 0;
1356 if (inode->i_mapping->a_ops->bmap)
1357 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1358 return res;
1359}
1da177e4
LT
1360EXPORT_SYMBOL(bmap);
1361
11ff6f05
MG
1362/*
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.
1366 */
1367static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
1368 struct timespec now)
1369{
1370
1371 if (!(mnt->mnt_flags & MNT_RELATIME))
1372 return 1;
1373 /*
1374 * Is mtime younger than atime? If yes, update atime:
1375 */
1376 if (timespec_compare(&inode->i_mtime, &inode->i_atime) >= 0)
1377 return 1;
1378 /*
1379 * Is ctime younger than atime? If yes, update atime:
1380 */
1381 if (timespec_compare(&inode->i_ctime, &inode->i_atime) >= 0)
1382 return 1;
1383
1384 /*
1385 * Is the previous atime value older than a day? If yes,
1386 * update atime:
1387 */
1388 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1389 return 1;
1390 /*
1391 * Good, we can skip the atime update:
1392 */
1393 return 0;
1394}
1395
1da177e4 1396/**
869243a0
CH
1397 * touch_atime - update the access time
1398 * @mnt: mount the inode is accessed on
7045f37b 1399 * @dentry: dentry accessed
1da177e4
LT
1400 *
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.
1404 */
869243a0 1405void touch_atime(struct vfsmount *mnt, struct dentry *dentry)
1da177e4 1406{
869243a0 1407 struct inode *inode = dentry->d_inode;
1da177e4
LT
1408 struct timespec now;
1409
cdb70f3f 1410 if (inode->i_flags & S_NOATIME)
b12536c2 1411 return;
37756ced 1412 if (IS_NOATIME(inode))
b12536c2 1413 return;
b2276138 1414 if ((inode->i_sb->s_flags & MS_NODIRATIME) && S_ISDIR(inode->i_mode))
b12536c2 1415 return;
47ae32d6 1416
cdb70f3f 1417 if (mnt->mnt_flags & MNT_NOATIME)
b12536c2 1418 return;
cdb70f3f 1419 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
b12536c2 1420 return;
1da177e4
LT
1421
1422 now = current_fs_time(inode->i_sb);
11ff6f05
MG
1423
1424 if (!relatime_need_update(mnt, inode, now))
b12536c2 1425 return;
11ff6f05 1426
47ae32d6 1427 if (timespec_equal(&inode->i_atime, &now))
b12536c2
AK
1428 return;
1429
1430 if (mnt_want_write(mnt))
1431 return;
47ae32d6
VH
1432
1433 inode->i_atime = now;
1434 mark_inode_dirty_sync(inode);
cdb70f3f 1435 mnt_drop_write(mnt);
1da177e4 1436}
869243a0 1437EXPORT_SYMBOL(touch_atime);
1da177e4
LT
1438
1439/**
870f4817
CH
1440 * file_update_time - update mtime and ctime time
1441 * @file: file accessed
1da177e4 1442 *
870f4817
CH
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
2eadfc0e 1447 * S_NOCMTIME inode flag, e.g. for network filesystem where these
870f4817 1448 * timestamps are handled by the server.
1da177e4
LT
1449 */
1450
870f4817 1451void file_update_time(struct file *file)
1da177e4 1452{
0f7fc9e4 1453 struct inode *inode = file->f_path.dentry->d_inode;
1da177e4 1454 struct timespec now;
ce06e0b2 1455 enum { S_MTIME = 1, S_CTIME = 2, S_VERSION = 4 } sync_it = 0;
1da177e4 1456
ce06e0b2 1457 /* First try to exhaust all avenues to not sync */
1da177e4
LT
1458 if (IS_NOCMTIME(inode))
1459 return;
20ddee2c 1460
1da177e4 1461 now = current_fs_time(inode->i_sb);
ce06e0b2
AK
1462 if (!timespec_equal(&inode->i_mtime, &now))
1463 sync_it = S_MTIME;
1da177e4 1464
ce06e0b2
AK
1465 if (!timespec_equal(&inode->i_ctime, &now))
1466 sync_it |= S_CTIME;
870f4817 1467
ce06e0b2
AK
1468 if (IS_I_VERSION(inode))
1469 sync_it |= S_VERSION;
7a224228 1470
ce06e0b2
AK
1471 if (!sync_it)
1472 return;
1473
1474 /* Finally allowed to write? Takes lock. */
1475 if (mnt_want_write_file(file))
1476 return;
1477
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);
20ddee2c 1486 mnt_drop_write(file->f_path.mnt);
1da177e4 1487}
870f4817 1488EXPORT_SYMBOL(file_update_time);
1da177e4
LT
1489
1490int inode_needs_sync(struct inode *inode)
1491{
1492 if (IS_SYNC(inode))
1493 return 1;
1494 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1495 return 1;
1496 return 0;
1497}
1da177e4
LT
1498EXPORT_SYMBOL(inode_needs_sync);
1499
1da177e4
LT
1500int inode_wait(void *word)
1501{
1502 schedule();
1503 return 0;
1504}
d44dab8d 1505EXPORT_SYMBOL(inode_wait);
1da177e4
LT
1506
1507/*
168a9fd6
MS
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.
1513 *
eaff8079 1514 * It doesn't matter if I_NEW is not set initially, a call to
168a9fd6
MS
1515 * wake_up_inode() after removing from the hash list will DTRT.
1516 *
1da177e4
LT
1517 * This is called with inode_lock held.
1518 */
1519static void __wait_on_freeing_inode(struct inode *inode)
1520{
1521 wait_queue_head_t *wq;
eaff8079
CH
1522 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1523 wq = bit_waitqueue(&inode->i_state, __I_NEW);
1da177e4
LT
1524 prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
1525 spin_unlock(&inode_lock);
1526 schedule();
1527 finish_wait(wq, &wait.wait);
1528 spin_lock(&inode_lock);
1529}
1530
1da177e4
LT
1531static __initdata unsigned long ihash_entries;
1532static int __init set_ihash_entries(char *str)
1533{
1534 if (!str)
1535 return 0;
1536 ihash_entries = simple_strtoul(str, &str, 0);
1537 return 1;
1538}
1539__setup("ihash_entries=", set_ihash_entries);
1540
1541/*
1542 * Initialize the waitqueues and inode hash table.
1543 */
1544void __init inode_init_early(void)
1545{
1546 int loop;
1547
1548 /* If hashes are distributed across NUMA nodes, defer
1549 * hash allocation until vmalloc space is available.
1550 */
1551 if (hashdist)
1552 return;
1553
1554 inode_hashtable =
1555 alloc_large_system_hash("Inode-cache",
1556 sizeof(struct hlist_head),
1557 ihash_entries,
1558 14,
1559 HASH_EARLY,
1560 &i_hash_shift,
1561 &i_hash_mask,
1562 0);
1563
1564 for (loop = 0; loop < (1 << i_hash_shift); loop++)
1565 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1566}
1567
74bf17cf 1568void __init inode_init(void)
1da177e4
LT
1569{
1570 int loop;
1571
1572 /* inode slab cache */
b0196009
PJ
1573 inode_cachep = kmem_cache_create("inode_cache",
1574 sizeof(struct inode),
1575 0,
1576 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
1577 SLAB_MEM_SPREAD),
20c2df83 1578 init_once);
8e1f936b 1579 register_shrinker(&icache_shrinker);
1da177e4
LT
1580
1581 /* Hash may have been set up in inode_init_early */
1582 if (!hashdist)
1583 return;
1584
1585 inode_hashtable =
1586 alloc_large_system_hash("Inode-cache",
1587 sizeof(struct hlist_head),
1588 ihash_entries,
1589 14,
1590 0,
1591 &i_hash_shift,
1592 &i_hash_mask,
1593 0);
1594
1595 for (loop = 0; loop < (1 << i_hash_shift); loop++)
1596 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1597}
1598
1599void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
1600{
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;
1612 else
af0d9ae8
MK
1613 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
1614 " inode %s:%lu\n", mode, inode->i_sb->s_id,
1615 inode->i_ino);
1da177e4
LT
1616}
1617EXPORT_SYMBOL(init_special_inode);
a1bd120d
DM
1618
1619/**
1620 * Init uid,gid,mode for new inode according to posix standards
1621 * @inode: New inode
1622 * @dir: Directory inode
1623 * @mode: mode of the new inode
1624 */
1625void inode_init_owner(struct inode *inode, const struct inode *dir,
1626 mode_t mode)
1627{
1628 inode->i_uid = current_fsuid();
1629 if (dir && dir->i_mode & S_ISGID) {
1630 inode->i_gid = dir->i_gid;
1631 if (S_ISDIR(mode))
1632 mode |= S_ISGID;
1633 } else
1634 inode->i_gid = current_fsgid();
1635 inode->i_mode = mode;
1636}
1637EXPORT_SYMBOL(inode_init_owner);