]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - fs/inode.c
vfs: Rename end_writeback() to clear_inode()
[mirror_ubuntu-artful-kernel.git] / fs / inode.c
CommitLineData
1da177e4 1/*
1da177e4 2 * (C) 1997 Linus Torvalds
4b4563dc 3 * (C) 1999 Andrea Arcangeli <andrea@suse.de> (dynamic inode allocation)
1da177e4 4 */
e59cc473 5#include <linux/export.h>
1da177e4
LT
6#include <linux/fs.h>
7#include <linux/mm.h>
1da177e4 8#include <linux/backing-dev.h>
1da177e4
LT
9#include <linux/hash.h>
10#include <linux/swap.h>
11#include <linux/security.h>
1da177e4
LT
12#include <linux/cdev.h>
13#include <linux/bootmem.h>
3be25f49 14#include <linux/fsnotify.h>
fc33a7bb 15#include <linux/mount.h>
f19d4a8f 16#include <linux/posix_acl.h>
9ce6e0be 17#include <linux/prefetch.h>
4b4563dc 18#include <linux/buffer_head.h> /* for inode_has_buffers */
7ada4db8 19#include <linux/ratelimit.h>
a66979ab 20#include "internal.h"
1da177e4 21
250df6ed 22/*
4b4563dc 23 * Inode locking rules:
250df6ed
DC
24 *
25 * inode->i_lock protects:
26 * inode->i_state, inode->i_hash, __iget()
09cc9fc7 27 * inode->i_sb->s_inode_lru_lock protects:
98b745c6 28 * inode->i_sb->s_inode_lru, inode->i_lru
55fa6091
DC
29 * inode_sb_list_lock protects:
30 * sb->s_inodes, inode->i_sb_list
f758eeab 31 * bdi->wb.list_lock protects:
a66979ab 32 * bdi->wb.b_{dirty,io,more_io}, inode->i_wb_list
67a23c49
DC
33 * inode_hash_lock protects:
34 * inode_hashtable, inode->i_hash
250df6ed
DC
35 *
36 * Lock ordering:
55fa6091
DC
37 *
38 * inode_sb_list_lock
39 * inode->i_lock
09cc9fc7 40 * inode->i_sb->s_inode_lru_lock
a66979ab 41 *
f758eeab 42 * bdi->wb.list_lock
a66979ab 43 * inode->i_lock
67a23c49
DC
44 *
45 * inode_hash_lock
46 * inode_sb_list_lock
47 * inode->i_lock
48 *
49 * iunique_lock
50 * inode_hash_lock
250df6ed
DC
51 */
52
fa3536cc
ED
53static unsigned int i_hash_mask __read_mostly;
54static unsigned int i_hash_shift __read_mostly;
67a23c49
DC
55static struct hlist_head *inode_hashtable __read_mostly;
56static __cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_hash_lock);
1da177e4 57
55fa6091
DC
58__cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_sb_list_lock);
59
7dcda1c9
JA
60/*
61 * Empty aops. Can be used for the cases where the user does not
62 * define any of the address_space operations.
63 */
64const struct address_space_operations empty_aops = {
65};
66EXPORT_SYMBOL(empty_aops);
67
1da177e4
LT
68/*
69 * Statistics gathering..
70 */
71struct inodes_stat_t inodes_stat;
72
3e880fb5 73static DEFINE_PER_CPU(unsigned int, nr_inodes);
fcb94f72 74static DEFINE_PER_CPU(unsigned int, nr_unused);
cffbc8aa 75
6b3304b5 76static struct kmem_cache *inode_cachep __read_mostly;
1da177e4 77
3e880fb5 78static int get_nr_inodes(void)
cffbc8aa 79{
3e880fb5
NP
80 int i;
81 int sum = 0;
82 for_each_possible_cpu(i)
83 sum += per_cpu(nr_inodes, i);
84 return sum < 0 ? 0 : sum;
cffbc8aa
DC
85}
86
87static inline int get_nr_inodes_unused(void)
88{
fcb94f72
DC
89 int i;
90 int sum = 0;
91 for_each_possible_cpu(i)
92 sum += per_cpu(nr_unused, i);
93 return sum < 0 ? 0 : sum;
cffbc8aa
DC
94}
95
96int get_nr_dirty_inodes(void)
97{
3e880fb5 98 /* not actually dirty inodes, but a wild approximation */
cffbc8aa
DC
99 int nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
100 return nr_dirty > 0 ? nr_dirty : 0;
cffbc8aa
DC
101}
102
103/*
104 * Handle nr_inode sysctl
105 */
106#ifdef CONFIG_SYSCTL
107int proc_nr_inodes(ctl_table *table, int write,
108 void __user *buffer, size_t *lenp, loff_t *ppos)
109{
110 inodes_stat.nr_inodes = get_nr_inodes();
fcb94f72 111 inodes_stat.nr_unused = get_nr_inodes_unused();
cffbc8aa
DC
112 return proc_dointvec(table, write, buffer, lenp, ppos);
113}
114#endif
115
2cb1599f
DC
116/**
117 * inode_init_always - perform inode structure intialisation
0bc02f3f
RD
118 * @sb: superblock inode belongs to
119 * @inode: inode to initialise
2cb1599f
DC
120 *
121 * These are initializations that need to be done on every inode
122 * allocation as the fields are not initialised by slab allocation.
123 */
54e34621 124int inode_init_always(struct super_block *sb, struct inode *inode)
1da177e4 125{
6e1d5dcc 126 static const struct inode_operations empty_iops;
99ac48f5 127 static const struct file_operations empty_fops;
6b3304b5 128 struct address_space *const mapping = &inode->i_data;
2cb1599f
DC
129
130 inode->i_sb = sb;
131 inode->i_blkbits = sb->s_blocksize_bits;
132 inode->i_flags = 0;
133 atomic_set(&inode->i_count, 1);
134 inode->i_op = &empty_iops;
135 inode->i_fop = &empty_fops;
a78ef704 136 inode->__i_nlink = 1;
3ddcd056 137 inode->i_opflags = 0;
56ff5efa
AV
138 inode->i_uid = 0;
139 inode->i_gid = 0;
2cb1599f
DC
140 atomic_set(&inode->i_writecount, 0);
141 inode->i_size = 0;
142 inode->i_blocks = 0;
143 inode->i_bytes = 0;
144 inode->i_generation = 0;
1da177e4 145#ifdef CONFIG_QUOTA
2cb1599f 146 memset(&inode->i_dquot, 0, sizeof(inode->i_dquot));
1da177e4 147#endif
2cb1599f
DC
148 inode->i_pipe = NULL;
149 inode->i_bdev = NULL;
150 inode->i_cdev = NULL;
151 inode->i_rdev = 0;
152 inode->dirtied_when = 0;
6146f0d5
MZ
153
154 if (security_inode_alloc(inode))
54e34621 155 goto out;
2cb1599f
DC
156 spin_lock_init(&inode->i_lock);
157 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
158
159 mutex_init(&inode->i_mutex);
160 lockdep_set_class(&inode->i_mutex, &sb->s_type->i_mutex_key);
161
bd5fe6c5 162 atomic_set(&inode->i_dio_count, 0);
2cb1599f
DC
163
164 mapping->a_ops = &empty_aops;
165 mapping->host = inode;
166 mapping->flags = 0;
3c1d4378 167 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
2cb1599f
DC
168 mapping->assoc_mapping = NULL;
169 mapping->backing_dev_info = &default_backing_dev_info;
170 mapping->writeback_index = 0;
171
172 /*
173 * If the block_device provides a backing_dev_info for client
174 * inodes then use that. Otherwise the inode share the bdev's
175 * backing_dev_info.
176 */
177 if (sb->s_bdev) {
178 struct backing_dev_info *bdi;
179
2c96ce9f 180 bdi = sb->s_bdev->bd_inode->i_mapping->backing_dev_info;
2cb1599f
DC
181 mapping->backing_dev_info = bdi;
182 }
183 inode->i_private = NULL;
184 inode->i_mapping = mapping;
6b520e05 185 INIT_LIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
f19d4a8f
AV
186#ifdef CONFIG_FS_POSIX_ACL
187 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
188#endif
2cb1599f 189
3be25f49
EP
190#ifdef CONFIG_FSNOTIFY
191 inode->i_fsnotify_mask = 0;
192#endif
193
3e880fb5 194 this_cpu_inc(nr_inodes);
cffbc8aa 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
ff0c7d15
NP
225void free_inode_nonrcu(struct inode *inode)
226{
227 kmem_cache_free(inode_cachep, inode);
228}
229EXPORT_SYMBOL(free_inode_nonrcu);
230
2e00c97e 231void __destroy_inode(struct inode *inode)
1da177e4 232{
b7542f8c 233 BUG_ON(inode_has_buffers(inode));
1da177e4 234 security_inode_free(inode);
3be25f49 235 fsnotify_inode_delete(inode);
7ada4db8
MS
236 if (!inode->i_nlink) {
237 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
238 atomic_long_dec(&inode->i_sb->s_remove_count);
239 }
240
f19d4a8f
AV
241#ifdef CONFIG_FS_POSIX_ACL
242 if (inode->i_acl && inode->i_acl != ACL_NOT_CACHED)
243 posix_acl_release(inode->i_acl);
244 if (inode->i_default_acl && inode->i_default_acl != ACL_NOT_CACHED)
245 posix_acl_release(inode->i_default_acl);
246#endif
3e880fb5 247 this_cpu_dec(nr_inodes);
2e00c97e
CH
248}
249EXPORT_SYMBOL(__destroy_inode);
250
fa0d7e3d
NP
251static void i_callback(struct rcu_head *head)
252{
253 struct inode *inode = container_of(head, struct inode, i_rcu);
fa0d7e3d
NP
254 kmem_cache_free(inode_cachep, inode);
255}
256
56b0dacf 257static void destroy_inode(struct inode *inode)
2e00c97e 258{
7ccf19a8 259 BUG_ON(!list_empty(&inode->i_lru));
2e00c97e 260 __destroy_inode(inode);
1da177e4
LT
261 if (inode->i_sb->s_op->destroy_inode)
262 inode->i_sb->s_op->destroy_inode(inode);
263 else
fa0d7e3d 264 call_rcu(&inode->i_rcu, i_callback);
1da177e4 265}
1da177e4 266
7ada4db8
MS
267/**
268 * drop_nlink - directly drop an inode's link count
269 * @inode: inode
270 *
271 * This is a low-level filesystem helper to replace any
272 * direct filesystem manipulation of i_nlink. In cases
273 * where we are attempting to track writes to the
274 * filesystem, a decrement to zero means an imminent
275 * write when the file is truncated and actually unlinked
276 * on the filesystem.
277 */
278void drop_nlink(struct inode *inode)
279{
280 WARN_ON(inode->i_nlink == 0);
281 inode->__i_nlink--;
282 if (!inode->i_nlink)
283 atomic_long_inc(&inode->i_sb->s_remove_count);
284}
285EXPORT_SYMBOL(drop_nlink);
286
287/**
288 * clear_nlink - directly zero an inode's link count
289 * @inode: inode
290 *
291 * This is a low-level filesystem helper to replace any
292 * direct filesystem manipulation of i_nlink. See
293 * drop_nlink() for why we care about i_nlink hitting zero.
294 */
295void clear_nlink(struct inode *inode)
296{
297 if (inode->i_nlink) {
298 inode->__i_nlink = 0;
299 atomic_long_inc(&inode->i_sb->s_remove_count);
300 }
301}
302EXPORT_SYMBOL(clear_nlink);
303
304/**
305 * set_nlink - directly set an inode's link count
306 * @inode: inode
307 * @nlink: new nlink (should be non-zero)
308 *
309 * This is a low-level filesystem helper to replace any
310 * direct filesystem manipulation of i_nlink.
311 */
312void set_nlink(struct inode *inode, unsigned int nlink)
313{
314 if (!nlink) {
7ada4db8
MS
315 clear_nlink(inode);
316 } else {
317 /* Yes, some filesystems do change nlink from zero to one */
318 if (inode->i_nlink == 0)
319 atomic_long_dec(&inode->i_sb->s_remove_count);
320
321 inode->__i_nlink = nlink;
322 }
323}
324EXPORT_SYMBOL(set_nlink);
325
326/**
327 * inc_nlink - directly increment an inode's link count
328 * @inode: inode
329 *
330 * This is a low-level filesystem helper to replace any
331 * direct filesystem manipulation of i_nlink. Currently,
332 * it is only here for parity with dec_nlink().
333 */
334void inc_nlink(struct inode *inode)
335{
336 if (WARN_ON(inode->i_nlink == 0))
337 atomic_long_dec(&inode->i_sb->s_remove_count);
338
339 inode->__i_nlink++;
340}
341EXPORT_SYMBOL(inc_nlink);
342
2aa15890
MS
343void address_space_init_once(struct address_space *mapping)
344{
345 memset(mapping, 0, sizeof(*mapping));
346 INIT_RADIX_TREE(&mapping->page_tree, GFP_ATOMIC);
347 spin_lock_init(&mapping->tree_lock);
3d48ae45 348 mutex_init(&mapping->i_mmap_mutex);
2aa15890
MS
349 INIT_LIST_HEAD(&mapping->private_list);
350 spin_lock_init(&mapping->private_lock);
351 INIT_RAW_PRIO_TREE_ROOT(&mapping->i_mmap);
352 INIT_LIST_HEAD(&mapping->i_mmap_nonlinear);
2aa15890
MS
353}
354EXPORT_SYMBOL(address_space_init_once);
355
1da177e4
LT
356/*
357 * These are initializations that only need to be done
358 * once, because the fields are idempotent across use
359 * of the inode, so let the slab aware of that.
360 */
361void inode_init_once(struct inode *inode)
362{
363 memset(inode, 0, sizeof(*inode));
364 INIT_HLIST_NODE(&inode->i_hash);
1da177e4 365 INIT_LIST_HEAD(&inode->i_devices);
7ccf19a8
NP
366 INIT_LIST_HEAD(&inode->i_wb_list);
367 INIT_LIST_HEAD(&inode->i_lru);
2aa15890 368 address_space_init_once(&inode->i_data);
1da177e4 369 i_size_ordered_init(inode);
3be25f49 370#ifdef CONFIG_FSNOTIFY
e61ce867 371 INIT_HLIST_HEAD(&inode->i_fsnotify_marks);
3be25f49 372#endif
1da177e4 373}
1da177e4
LT
374EXPORT_SYMBOL(inode_init_once);
375
51cc5068 376static void init_once(void *foo)
1da177e4 377{
6b3304b5 378 struct inode *inode = (struct inode *) foo;
1da177e4 379
a35afb83 380 inode_init_once(inode);
1da177e4
LT
381}
382
383/*
250df6ed 384 * inode->i_lock must be held
1da177e4 385 */
6b3304b5 386void __iget(struct inode *inode)
1da177e4 387{
9e38d86f
NP
388 atomic_inc(&inode->i_count);
389}
2e147f1e 390
7de9c6ee
AV
391/*
392 * get additional reference to inode; caller must already hold one.
393 */
394void ihold(struct inode *inode)
395{
396 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
397}
398EXPORT_SYMBOL(ihold);
399
9e38d86f
NP
400static void inode_lru_list_add(struct inode *inode)
401{
09cc9fc7 402 spin_lock(&inode->i_sb->s_inode_lru_lock);
7ccf19a8 403 if (list_empty(&inode->i_lru)) {
98b745c6
DC
404 list_add(&inode->i_lru, &inode->i_sb->s_inode_lru);
405 inode->i_sb->s_nr_inodes_unused++;
fcb94f72 406 this_cpu_inc(nr_unused);
9e38d86f 407 }
09cc9fc7 408 spin_unlock(&inode->i_sb->s_inode_lru_lock);
9e38d86f 409}
2e147f1e 410
9e38d86f
NP
411static void inode_lru_list_del(struct inode *inode)
412{
09cc9fc7 413 spin_lock(&inode->i_sb->s_inode_lru_lock);
7ccf19a8
NP
414 if (!list_empty(&inode->i_lru)) {
415 list_del_init(&inode->i_lru);
98b745c6 416 inode->i_sb->s_nr_inodes_unused--;
fcb94f72 417 this_cpu_dec(nr_unused);
9e38d86f 418 }
09cc9fc7 419 spin_unlock(&inode->i_sb->s_inode_lru_lock);
1da177e4
LT
420}
421
646ec461
CH
422/**
423 * inode_sb_list_add - add inode to the superblock list of inodes
424 * @inode: inode to add
425 */
426void inode_sb_list_add(struct inode *inode)
427{
55fa6091
DC
428 spin_lock(&inode_sb_list_lock);
429 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
430 spin_unlock(&inode_sb_list_lock);
646ec461
CH
431}
432EXPORT_SYMBOL_GPL(inode_sb_list_add);
433
55fa6091 434static inline void inode_sb_list_del(struct inode *inode)
646ec461 435{
a209dfc7
ED
436 if (!list_empty(&inode->i_sb_list)) {
437 spin_lock(&inode_sb_list_lock);
438 list_del_init(&inode->i_sb_list);
439 spin_unlock(&inode_sb_list_lock);
440 }
646ec461
CH
441}
442
4c51acbc
DC
443static unsigned long hash(struct super_block *sb, unsigned long hashval)
444{
445 unsigned long tmp;
446
447 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
448 L1_CACHE_BYTES;
4b4563dc
CH
449 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
450 return tmp & i_hash_mask;
4c51acbc
DC
451}
452
453/**
454 * __insert_inode_hash - hash an inode
455 * @inode: unhashed inode
456 * @hashval: unsigned long value used to locate this object in the
457 * inode_hashtable.
458 *
459 * Add an inode to the inode hash for this superblock.
460 */
461void __insert_inode_hash(struct inode *inode, unsigned long hashval)
462{
646ec461
CH
463 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
464
67a23c49 465 spin_lock(&inode_hash_lock);
250df6ed 466 spin_lock(&inode->i_lock);
646ec461 467 hlist_add_head(&inode->i_hash, b);
250df6ed 468 spin_unlock(&inode->i_lock);
67a23c49 469 spin_unlock(&inode_hash_lock);
4c51acbc
DC
470}
471EXPORT_SYMBOL(__insert_inode_hash);
472
4c51acbc 473/**
f2ee7abf 474 * __remove_inode_hash - remove an inode from the hash
4c51acbc
DC
475 * @inode: inode to unhash
476 *
477 * Remove an inode from the superblock.
478 */
f2ee7abf 479void __remove_inode_hash(struct inode *inode)
4c51acbc 480{
67a23c49 481 spin_lock(&inode_hash_lock);
250df6ed 482 spin_lock(&inode->i_lock);
4c51acbc 483 hlist_del_init(&inode->i_hash);
250df6ed 484 spin_unlock(&inode->i_lock);
67a23c49 485 spin_unlock(&inode_hash_lock);
4c51acbc 486}
f2ee7abf 487EXPORT_SYMBOL(__remove_inode_hash);
4c51acbc 488
dbd5768f 489void clear_inode(struct inode *inode)
b0683aa6
AV
490{
491 might_sleep();
08142579
JK
492 /*
493 * We have to cycle tree_lock here because reclaim can be still in the
494 * process of removing the last page (in __delete_from_page_cache())
495 * and we must not free mapping under it.
496 */
497 spin_lock_irq(&inode->i_data.tree_lock);
b0683aa6 498 BUG_ON(inode->i_data.nrpages);
08142579 499 spin_unlock_irq(&inode->i_data.tree_lock);
b0683aa6
AV
500 BUG_ON(!list_empty(&inode->i_data.private_list));
501 BUG_ON(!(inode->i_state & I_FREEING));
502 BUG_ON(inode->i_state & I_CLEAR);
fa0d7e3d 503 /* don't need i_lock here, no concurrent mods to i_state */
b0683aa6
AV
504 inode->i_state = I_FREEING | I_CLEAR;
505}
dbd5768f 506EXPORT_SYMBOL(clear_inode);
b0683aa6 507
b2b2af8e
DC
508/*
509 * Free the inode passed in, removing it from the lists it is still connected
510 * to. We remove any pages still attached to the inode and wait for any IO that
511 * is still in progress before finally destroying the inode.
512 *
513 * An inode must already be marked I_FREEING so that we avoid the inode being
514 * moved back onto lists if we race with other code that manipulates the lists
515 * (e.g. writeback_single_inode). The caller is responsible for setting this.
516 *
517 * An inode must already be removed from the LRU list before being evicted from
518 * the cache. This should occur atomically with setting the I_FREEING state
519 * flag, so no inodes here should ever be on the LRU when being evicted.
520 */
644da596 521static void evict(struct inode *inode)
b4272d4c
AV
522{
523 const struct super_operations *op = inode->i_sb->s_op;
524
b2b2af8e
DC
525 BUG_ON(!(inode->i_state & I_FREEING));
526 BUG_ON(!list_empty(&inode->i_lru));
527
b12362bd
ED
528 if (!list_empty(&inode->i_wb_list))
529 inode_wb_list_del(inode);
530
55fa6091
DC
531 inode_sb_list_del(inode);
532
7994e6f7
JK
533 inode_sync_wait(inode);
534
be7ce416
AV
535 if (op->evict_inode) {
536 op->evict_inode(inode);
b4272d4c
AV
537 } else {
538 if (inode->i_data.nrpages)
539 truncate_inode_pages(&inode->i_data, 0);
dbd5768f 540 clear_inode(inode);
b4272d4c 541 }
661074e9
AV
542 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
543 bd_forget(inode);
544 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
545 cd_forget(inode);
b2b2af8e
DC
546
547 remove_inode_hash(inode);
548
549 spin_lock(&inode->i_lock);
550 wake_up_bit(&inode->i_state, __I_NEW);
551 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
552 spin_unlock(&inode->i_lock);
553
554 destroy_inode(inode);
b4272d4c
AV
555}
556
1da177e4
LT
557/*
558 * dispose_list - dispose of the contents of a local list
559 * @head: the head of the list to free
560 *
561 * Dispose-list gets a local list with local inodes in it, so it doesn't
562 * need to worry about list corruption and SMP locks.
563 */
564static void dispose_list(struct list_head *head)
565{
1da177e4
LT
566 while (!list_empty(head)) {
567 struct inode *inode;
568
7ccf19a8
NP
569 inode = list_first_entry(head, struct inode, i_lru);
570 list_del_init(&inode->i_lru);
1da177e4 571
644da596 572 evict(inode);
1da177e4 573 }
1da177e4
LT
574}
575
63997e98
AV
576/**
577 * evict_inodes - evict all evictable inodes for a superblock
578 * @sb: superblock to operate on
579 *
580 * Make sure that no inodes with zero refcount are retained. This is
581 * called by superblock shutdown after having MS_ACTIVE flag removed,
582 * so any inode reaching zero refcount during or after that call will
583 * be immediately evicted.
1da177e4 584 */
63997e98 585void evict_inodes(struct super_block *sb)
1da177e4 586{
63997e98
AV
587 struct inode *inode, *next;
588 LIST_HEAD(dispose);
1da177e4 589
55fa6091 590 spin_lock(&inode_sb_list_lock);
63997e98
AV
591 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
592 if (atomic_read(&inode->i_count))
aabb8fdb 593 continue;
250df6ed
DC
594
595 spin_lock(&inode->i_lock);
596 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
597 spin_unlock(&inode->i_lock);
1da177e4 598 continue;
250df6ed 599 }
63997e98
AV
600
601 inode->i_state |= I_FREEING;
02afc410 602 inode_lru_list_del(inode);
250df6ed 603 spin_unlock(&inode->i_lock);
02afc410 604 list_add(&inode->i_lru, &dispose);
1da177e4 605 }
55fa6091 606 spin_unlock(&inode_sb_list_lock);
63997e98
AV
607
608 dispose_list(&dispose);
1da177e4
LT
609}
610
1da177e4 611/**
a0318786
CH
612 * invalidate_inodes - attempt to free all inodes on a superblock
613 * @sb: superblock to operate on
93b270f7 614 * @kill_dirty: flag to guide handling of dirty inodes
1da177e4 615 *
a0318786
CH
616 * Attempts to free all inodes for a given superblock. If there were any
617 * busy inodes return a non-zero value, else zero.
93b270f7
N
618 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
619 * them as busy.
1da177e4 620 */
93b270f7 621int invalidate_inodes(struct super_block *sb, bool kill_dirty)
1da177e4 622{
cffbc8aa 623 int busy = 0;
a0318786
CH
624 struct inode *inode, *next;
625 LIST_HEAD(dispose);
1da177e4 626
55fa6091 627 spin_lock(&inode_sb_list_lock);
a0318786 628 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
250df6ed
DC
629 spin_lock(&inode->i_lock);
630 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
631 spin_unlock(&inode->i_lock);
aabb8fdb 632 continue;
250df6ed 633 }
93b270f7 634 if (inode->i_state & I_DIRTY && !kill_dirty) {
250df6ed 635 spin_unlock(&inode->i_lock);
93b270f7
N
636 busy = 1;
637 continue;
638 }
99a38919 639 if (atomic_read(&inode->i_count)) {
250df6ed 640 spin_unlock(&inode->i_lock);
99a38919 641 busy = 1;
1da177e4
LT
642 continue;
643 }
99a38919 644
99a38919 645 inode->i_state |= I_FREEING;
02afc410 646 inode_lru_list_del(inode);
250df6ed 647 spin_unlock(&inode->i_lock);
02afc410 648 list_add(&inode->i_lru, &dispose);
1da177e4 649 }
55fa6091 650 spin_unlock(&inode_sb_list_lock);
1da177e4 651
a0318786 652 dispose_list(&dispose);
1da177e4
LT
653
654 return busy;
655}
1da177e4
LT
656
657static int can_unuse(struct inode *inode)
658{
9e38d86f 659 if (inode->i_state & ~I_REFERENCED)
1da177e4
LT
660 return 0;
661 if (inode_has_buffers(inode))
662 return 0;
663 if (atomic_read(&inode->i_count))
664 return 0;
665 if (inode->i_data.nrpages)
666 return 0;
667 return 1;
668}
669
670/*
b0d40c92
DC
671 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
672 * This is called from the superblock shrinker function with a number of inodes
673 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
674 * then are freed outside inode_lock by dispose_list().
1da177e4
LT
675 *
676 * Any inodes which are pinned purely because of attached pagecache have their
9e38d86f
NP
677 * pagecache removed. If the inode has metadata buffers attached to
678 * mapping->private_list then try to remove them.
1da177e4 679 *
9e38d86f
NP
680 * If the inode has the I_REFERENCED flag set, then it means that it has been
681 * used recently - the flag is set in iput_final(). When we encounter such an
682 * inode, clear the flag and move it to the back of the LRU so it gets another
683 * pass through the LRU before it gets reclaimed. This is necessary because of
684 * the fact we are doing lazy LRU updates to minimise lock contention so the
685 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
686 * with this flag set because they are the inodes that are out of order.
1da177e4 687 */
b0d40c92 688void prune_icache_sb(struct super_block *sb, int nr_to_scan)
1da177e4
LT
689{
690 LIST_HEAD(freeable);
1da177e4
LT
691 int nr_scanned;
692 unsigned long reap = 0;
693
09cc9fc7 694 spin_lock(&sb->s_inode_lru_lock);
b0d40c92 695 for (nr_scanned = nr_to_scan; nr_scanned >= 0; nr_scanned--) {
1da177e4
LT
696 struct inode *inode;
697
98b745c6 698 if (list_empty(&sb->s_inode_lru))
1da177e4
LT
699 break;
700
98b745c6 701 inode = list_entry(sb->s_inode_lru.prev, struct inode, i_lru);
1da177e4 702
02afc410 703 /*
09cc9fc7 704 * we are inverting the sb->s_inode_lru_lock/inode->i_lock here,
02afc410
DC
705 * so use a trylock. If we fail to get the lock, just move the
706 * inode to the back of the list so we don't spin on it.
707 */
708 if (!spin_trylock(&inode->i_lock)) {
62a3ddef 709 list_move_tail(&inode->i_lru, &sb->s_inode_lru);
02afc410
DC
710 continue;
711 }
712
9e38d86f
NP
713 /*
714 * Referenced or dirty inodes are still in use. Give them
715 * another pass through the LRU as we canot reclaim them now.
716 */
717 if (atomic_read(&inode->i_count) ||
718 (inode->i_state & ~I_REFERENCED)) {
7ccf19a8 719 list_del_init(&inode->i_lru);
f283c86a 720 spin_unlock(&inode->i_lock);
98b745c6 721 sb->s_nr_inodes_unused--;
fcb94f72 722 this_cpu_dec(nr_unused);
9e38d86f
NP
723 continue;
724 }
725
726 /* recently referenced inodes get one more pass */
727 if (inode->i_state & I_REFERENCED) {
9e38d86f 728 inode->i_state &= ~I_REFERENCED;
98b745c6 729 list_move(&inode->i_lru, &sb->s_inode_lru);
f283c86a 730 spin_unlock(&inode->i_lock);
1da177e4
LT
731 continue;
732 }
733 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
734 __iget(inode);
250df6ed 735 spin_unlock(&inode->i_lock);
09cc9fc7 736 spin_unlock(&sb->s_inode_lru_lock);
1da177e4 737 if (remove_inode_buffers(inode))
fc0ecff6
AM
738 reap += invalidate_mapping_pages(&inode->i_data,
739 0, -1);
1da177e4 740 iput(inode);
09cc9fc7 741 spin_lock(&sb->s_inode_lru_lock);
1da177e4 742
98b745c6 743 if (inode != list_entry(sb->s_inode_lru.next,
7ccf19a8 744 struct inode, i_lru))
1da177e4 745 continue; /* wrong inode or list_empty */
02afc410
DC
746 /* avoid lock inversions with trylock */
747 if (!spin_trylock(&inode->i_lock))
748 continue;
250df6ed
DC
749 if (!can_unuse(inode)) {
750 spin_unlock(&inode->i_lock);
1da177e4 751 continue;
250df6ed 752 }
1da177e4 753 }
7ef0d737 754 WARN_ON(inode->i_state & I_NEW);
1da177e4 755 inode->i_state |= I_FREEING;
250df6ed 756 spin_unlock(&inode->i_lock);
7ccf19a8 757
7ccf19a8 758 list_move(&inode->i_lru, &freeable);
98b745c6 759 sb->s_nr_inodes_unused--;
fcb94f72 760 this_cpu_dec(nr_unused);
1da177e4 761 }
f8891e5e
CL
762 if (current_is_kswapd())
763 __count_vm_events(KSWAPD_INODESTEAL, reap);
764 else
765 __count_vm_events(PGINODESTEAL, reap);
09cc9fc7 766 spin_unlock(&sb->s_inode_lru_lock);
5f8aefd4
KK
767 if (current->reclaim_state)
768 current->reclaim_state->reclaimed_slab += reap;
1da177e4
LT
769
770 dispose_list(&freeable);
1da177e4
LT
771}
772
1da177e4
LT
773static void __wait_on_freeing_inode(struct inode *inode);
774/*
775 * Called with the inode lock held.
1da177e4 776 */
6b3304b5
MK
777static struct inode *find_inode(struct super_block *sb,
778 struct hlist_head *head,
779 int (*test)(struct inode *, void *),
780 void *data)
1da177e4
LT
781{
782 struct hlist_node *node;
6b3304b5 783 struct inode *inode = NULL;
1da177e4
LT
784
785repeat:
c5c8be3c 786 hlist_for_each_entry(inode, node, head, i_hash) {
67a23c49
DC
787 spin_lock(&inode->i_lock);
788 if (inode->i_sb != sb) {
789 spin_unlock(&inode->i_lock);
1da177e4 790 continue;
67a23c49
DC
791 }
792 if (!test(inode, data)) {
793 spin_unlock(&inode->i_lock);
1da177e4 794 continue;
67a23c49 795 }
a4ffdde6 796 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
1da177e4
LT
797 __wait_on_freeing_inode(inode);
798 goto repeat;
799 }
f7899bd5 800 __iget(inode);
250df6ed 801 spin_unlock(&inode->i_lock);
f7899bd5 802 return inode;
1da177e4 803 }
f7899bd5 804 return NULL;
1da177e4
LT
805}
806
807/*
808 * find_inode_fast is the fast path version of find_inode, see the comment at
809 * iget_locked for details.
810 */
6b3304b5
MK
811static struct inode *find_inode_fast(struct super_block *sb,
812 struct hlist_head *head, unsigned long ino)
1da177e4
LT
813{
814 struct hlist_node *node;
6b3304b5 815 struct inode *inode = NULL;
1da177e4
LT
816
817repeat:
c5c8be3c 818 hlist_for_each_entry(inode, node, head, i_hash) {
67a23c49
DC
819 spin_lock(&inode->i_lock);
820 if (inode->i_ino != ino) {
821 spin_unlock(&inode->i_lock);
1da177e4 822 continue;
67a23c49
DC
823 }
824 if (inode->i_sb != sb) {
825 spin_unlock(&inode->i_lock);
1da177e4 826 continue;
67a23c49 827 }
a4ffdde6 828 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
1da177e4
LT
829 __wait_on_freeing_inode(inode);
830 goto repeat;
831 }
f7899bd5 832 __iget(inode);
250df6ed 833 spin_unlock(&inode->i_lock);
f7899bd5 834 return inode;
1da177e4 835 }
f7899bd5 836 return NULL;
8290c35f
DC
837}
838
f991bd2e
ED
839/*
840 * Each cpu owns a range of LAST_INO_BATCH numbers.
841 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
842 * to renew the exhausted range.
8290c35f 843 *
f991bd2e
ED
844 * This does not significantly increase overflow rate because every CPU can
845 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
846 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
847 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
848 * overflow rate by 2x, which does not seem too significant.
849 *
850 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
851 * error if st_ino won't fit in target struct field. Use 32bit counter
852 * here to attempt to avoid that.
8290c35f 853 */
f991bd2e
ED
854#define LAST_INO_BATCH 1024
855static DEFINE_PER_CPU(unsigned int, last_ino);
856
85fe4025 857unsigned int get_next_ino(void)
8290c35f 858{
f991bd2e
ED
859 unsigned int *p = &get_cpu_var(last_ino);
860 unsigned int res = *p;
8290c35f 861
f991bd2e
ED
862#ifdef CONFIG_SMP
863 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
864 static atomic_t shared_last_ino;
865 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
866
867 res = next - LAST_INO_BATCH;
868 }
869#endif
870
871 *p = ++res;
872 put_cpu_var(last_ino);
873 return res;
8290c35f 874}
85fe4025 875EXPORT_SYMBOL(get_next_ino);
8290c35f 876
a209dfc7
ED
877/**
878 * new_inode_pseudo - obtain an inode
879 * @sb: superblock
880 *
881 * Allocates a new inode for given superblock.
882 * Inode wont be chained in superblock s_inodes list
883 * This means :
884 * - fs can't be unmount
885 * - quotas, fsnotify, writeback can't work
886 */
887struct inode *new_inode_pseudo(struct super_block *sb)
888{
889 struct inode *inode = alloc_inode(sb);
890
891 if (inode) {
892 spin_lock(&inode->i_lock);
893 inode->i_state = 0;
894 spin_unlock(&inode->i_lock);
895 INIT_LIST_HEAD(&inode->i_sb_list);
896 }
897 return inode;
898}
899
1da177e4
LT
900/**
901 * new_inode - obtain an inode
902 * @sb: superblock
903 *
769848c0 904 * Allocates a new inode for given superblock. The default gfp_mask
3c1d4378 905 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
769848c0
MG
906 * If HIGHMEM pages are unsuitable or it is known that pages allocated
907 * for the page cache are not reclaimable or migratable,
908 * mapping_set_gfp_mask() must be called with suitable flags on the
909 * newly created inode's mapping
910 *
1da177e4
LT
911 */
912struct inode *new_inode(struct super_block *sb)
913{
6b3304b5 914 struct inode *inode;
1da177e4 915
55fa6091 916 spin_lock_prefetch(&inode_sb_list_lock);
6b3304b5 917
a209dfc7
ED
918 inode = new_inode_pseudo(sb);
919 if (inode)
55fa6091 920 inode_sb_list_add(inode);
1da177e4
LT
921 return inode;
922}
1da177e4
LT
923EXPORT_SYMBOL(new_inode);
924
14358e6d 925#ifdef CONFIG_DEBUG_LOCK_ALLOC
e096d0c7
JB
926void lockdep_annotate_inode_mutex_key(struct inode *inode)
927{
a3314a0e 928 if (S_ISDIR(inode->i_mode)) {
1e89a5e1
PZ
929 struct file_system_type *type = inode->i_sb->s_type;
930
9a7aa12f 931 /* Set new key only if filesystem hasn't already changed it */
978d6d8c 932 if (lockdep_match_class(&inode->i_mutex, &type->i_mutex_key)) {
9a7aa12f
JK
933 /*
934 * ensure nobody is actually holding i_mutex
935 */
936 mutex_destroy(&inode->i_mutex);
937 mutex_init(&inode->i_mutex);
938 lockdep_set_class(&inode->i_mutex,
939 &type->i_mutex_dir_key);
940 }
1e89a5e1 941 }
e096d0c7
JB
942}
943EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
14358e6d 944#endif
e096d0c7
JB
945
946/**
947 * unlock_new_inode - clear the I_NEW state and wake up any waiters
948 * @inode: new inode to unlock
949 *
950 * Called when the inode is fully initialised to clear the new state of the
951 * inode and wake up anyone waiting for the inode to finish initialisation.
952 */
953void unlock_new_inode(struct inode *inode)
954{
955 lockdep_annotate_inode_mutex_key(inode);
250df6ed 956 spin_lock(&inode->i_lock);
eaff8079
CH
957 WARN_ON(!(inode->i_state & I_NEW));
958 inode->i_state &= ~I_NEW;
310fa7a3 959 smp_mb();
250df6ed
DC
960 wake_up_bit(&inode->i_state, __I_NEW);
961 spin_unlock(&inode->i_lock);
1da177e4 962}
1da177e4
LT
963EXPORT_SYMBOL(unlock_new_inode);
964
0b2d0724
CH
965/**
966 * iget5_locked - obtain an inode from a mounted file system
967 * @sb: super block of file system
968 * @hashval: hash value (usually inode number) to get
969 * @test: callback used for comparisons between inodes
970 * @set: callback used to initialize a new struct inode
971 * @data: opaque data pointer to pass to @test and @set
972 *
973 * Search for the inode specified by @hashval and @data in the inode cache,
974 * and if present it is return it with an increased reference count. This is
975 * a generalized version of iget_locked() for file systems where the inode
976 * number is not sufficient for unique identification of an inode.
977 *
978 * If the inode is not in cache, allocate a new inode and return it locked,
979 * hashed, and with the I_NEW flag set. The file system gets to fill it in
980 * before unlocking it via unlock_new_inode().
1da177e4 981 *
0b2d0724
CH
982 * Note both @test and @set are called with the inode_hash_lock held, so can't
983 * sleep.
1da177e4 984 */
0b2d0724
CH
985struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
986 int (*test)(struct inode *, void *),
987 int (*set)(struct inode *, void *), void *data)
1da177e4 988{
0b2d0724 989 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
6b3304b5 990 struct inode *inode;
1da177e4 991
0b2d0724
CH
992 spin_lock(&inode_hash_lock);
993 inode = find_inode(sb, head, test, data);
994 spin_unlock(&inode_hash_lock);
995
996 if (inode) {
997 wait_on_inode(inode);
998 return inode;
999 }
1000
1da177e4
LT
1001 inode = alloc_inode(sb);
1002 if (inode) {
6b3304b5 1003 struct inode *old;
1da177e4 1004
67a23c49 1005 spin_lock(&inode_hash_lock);
1da177e4
LT
1006 /* We released the lock, so.. */
1007 old = find_inode(sb, head, test, data);
1008 if (!old) {
1009 if (set(inode, data))
1010 goto set_failed;
1011
250df6ed
DC
1012 spin_lock(&inode->i_lock);
1013 inode->i_state = I_NEW;
646ec461 1014 hlist_add_head(&inode->i_hash, head);
250df6ed 1015 spin_unlock(&inode->i_lock);
55fa6091 1016 inode_sb_list_add(inode);
67a23c49 1017 spin_unlock(&inode_hash_lock);
1da177e4
LT
1018
1019 /* Return the locked inode with I_NEW set, the
1020 * caller is responsible for filling in the contents
1021 */
1022 return inode;
1023 }
1024
1025 /*
1026 * Uhhuh, somebody else created the same inode under
1027 * us. Use the old inode instead of the one we just
1028 * allocated.
1029 */
67a23c49 1030 spin_unlock(&inode_hash_lock);
1da177e4
LT
1031 destroy_inode(inode);
1032 inode = old;
1033 wait_on_inode(inode);
1034 }
1035 return inode;
1036
1037set_failed:
67a23c49 1038 spin_unlock(&inode_hash_lock);
1da177e4
LT
1039 destroy_inode(inode);
1040 return NULL;
1041}
0b2d0724 1042EXPORT_SYMBOL(iget5_locked);
1da177e4 1043
0b2d0724
CH
1044/**
1045 * iget_locked - obtain an inode from a mounted file system
1046 * @sb: super block of file system
1047 * @ino: inode number to get
1048 *
1049 * Search for the inode specified by @ino in the inode cache and if present
1050 * return it with an increased reference count. This is for file systems
1051 * where the inode number is sufficient for unique identification of an inode.
1052 *
1053 * If the inode is not in cache, allocate a new inode and return it locked,
1054 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1055 * before unlocking it via unlock_new_inode().
1da177e4 1056 */
0b2d0724 1057struct inode *iget_locked(struct super_block *sb, unsigned long ino)
1da177e4 1058{
0b2d0724 1059 struct hlist_head *head = inode_hashtable + hash(sb, ino);
6b3304b5 1060 struct inode *inode;
1da177e4 1061
0b2d0724
CH
1062 spin_lock(&inode_hash_lock);
1063 inode = find_inode_fast(sb, head, ino);
1064 spin_unlock(&inode_hash_lock);
1065 if (inode) {
1066 wait_on_inode(inode);
1067 return inode;
1068 }
1069
1da177e4
LT
1070 inode = alloc_inode(sb);
1071 if (inode) {
6b3304b5 1072 struct inode *old;
1da177e4 1073
67a23c49 1074 spin_lock(&inode_hash_lock);
1da177e4
LT
1075 /* We released the lock, so.. */
1076 old = find_inode_fast(sb, head, ino);
1077 if (!old) {
1078 inode->i_ino = ino;
250df6ed
DC
1079 spin_lock(&inode->i_lock);
1080 inode->i_state = I_NEW;
646ec461 1081 hlist_add_head(&inode->i_hash, head);
250df6ed 1082 spin_unlock(&inode->i_lock);
55fa6091 1083 inode_sb_list_add(inode);
67a23c49 1084 spin_unlock(&inode_hash_lock);
1da177e4
LT
1085
1086 /* Return the locked inode with I_NEW set, the
1087 * caller is responsible for filling in the contents
1088 */
1089 return inode;
1090 }
1091
1092 /*
1093 * Uhhuh, somebody else created the same inode under
1094 * us. Use the old inode instead of the one we just
1095 * allocated.
1096 */
67a23c49 1097 spin_unlock(&inode_hash_lock);
1da177e4
LT
1098 destroy_inode(inode);
1099 inode = old;
1100 wait_on_inode(inode);
1101 }
1102 return inode;
1103}
0b2d0724 1104EXPORT_SYMBOL(iget_locked);
1da177e4 1105
ad5e195a
CH
1106/*
1107 * search the inode cache for a matching inode number.
1108 * If we find one, then the inode number we are trying to
1109 * allocate is not unique and so we should not use it.
1110 *
1111 * Returns 1 if the inode number is unique, 0 if it is not.
1112 */
1113static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1114{
1115 struct hlist_head *b = inode_hashtable + hash(sb, ino);
1116 struct hlist_node *node;
1117 struct inode *inode;
1118
67a23c49 1119 spin_lock(&inode_hash_lock);
ad5e195a 1120 hlist_for_each_entry(inode, node, b, i_hash) {
67a23c49
DC
1121 if (inode->i_ino == ino && inode->i_sb == sb) {
1122 spin_unlock(&inode_hash_lock);
ad5e195a 1123 return 0;
67a23c49 1124 }
ad5e195a 1125 }
67a23c49 1126 spin_unlock(&inode_hash_lock);
ad5e195a
CH
1127
1128 return 1;
1129}
1130
1da177e4
LT
1131/**
1132 * iunique - get a unique inode number
1133 * @sb: superblock
1134 * @max_reserved: highest reserved inode number
1135 *
1136 * Obtain an inode number that is unique on the system for a given
1137 * superblock. This is used by file systems that have no natural
1138 * permanent inode numbering system. An inode number is returned that
1139 * is higher than the reserved limit but unique.
1140 *
1141 * BUGS:
1142 * With a large number of inodes live on the file system this function
1143 * currently becomes quite slow.
1144 */
1145ino_t iunique(struct super_block *sb, ino_t max_reserved)
1146{
866b04fc
JL
1147 /*
1148 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1149 * error if st_ino won't fit in target struct field. Use 32bit counter
1150 * here to attempt to avoid that.
1151 */
ad5e195a 1152 static DEFINE_SPINLOCK(iunique_lock);
866b04fc 1153 static unsigned int counter;
1da177e4 1154 ino_t res;
3361c7be 1155
ad5e195a 1156 spin_lock(&iunique_lock);
3361c7be
JL
1157 do {
1158 if (counter <= max_reserved)
1159 counter = max_reserved + 1;
1da177e4 1160 res = counter++;
ad5e195a
CH
1161 } while (!test_inode_iunique(sb, res));
1162 spin_unlock(&iunique_lock);
1da177e4 1163
3361c7be
JL
1164 return res;
1165}
1da177e4
LT
1166EXPORT_SYMBOL(iunique);
1167
1168struct inode *igrab(struct inode *inode)
1169{
250df6ed
DC
1170 spin_lock(&inode->i_lock);
1171 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
1da177e4 1172 __iget(inode);
250df6ed
DC
1173 spin_unlock(&inode->i_lock);
1174 } else {
1175 spin_unlock(&inode->i_lock);
1da177e4
LT
1176 /*
1177 * Handle the case where s_op->clear_inode is not been
1178 * called yet, and somebody is calling igrab
1179 * while the inode is getting freed.
1180 */
1181 inode = NULL;
250df6ed 1182 }
1da177e4
LT
1183 return inode;
1184}
1da177e4
LT
1185EXPORT_SYMBOL(igrab);
1186
1187/**
0b2d0724 1188 * ilookup5_nowait - search for an inode in the inode cache
1da177e4 1189 * @sb: super block of file system to search
0b2d0724 1190 * @hashval: hash value (usually inode number) to search for
1da177e4
LT
1191 * @test: callback used for comparisons between inodes
1192 * @data: opaque data pointer to pass to @test
1da177e4 1193 *
0b2d0724 1194 * Search for the inode specified by @hashval and @data in the inode cache.
1da177e4
LT
1195 * If the inode is in the cache, the inode is returned with an incremented
1196 * reference count.
1197 *
0b2d0724
CH
1198 * Note: I_NEW is not waited upon so you have to be very careful what you do
1199 * with the returned inode. You probably should be using ilookup5() instead.
1da177e4 1200 *
b6d0ad68 1201 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
1da177e4 1202 */
0b2d0724
CH
1203struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1204 int (*test)(struct inode *, void *), void *data)
1da177e4 1205{
0b2d0724 1206 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1da177e4
LT
1207 struct inode *inode;
1208
67a23c49 1209 spin_lock(&inode_hash_lock);
1da177e4 1210 inode = find_inode(sb, head, test, data);
67a23c49 1211 spin_unlock(&inode_hash_lock);
88bd5121 1212
0b2d0724 1213 return inode;
88bd5121 1214}
88bd5121
AA
1215EXPORT_SYMBOL(ilookup5_nowait);
1216
1217/**
1218 * ilookup5 - search for an inode in the inode cache
1219 * @sb: super block of file system to search
1220 * @hashval: hash value (usually inode number) to search for
1221 * @test: callback used for comparisons between inodes
1222 * @data: opaque data pointer to pass to @test
1223 *
0b2d0724
CH
1224 * Search for the inode specified by @hashval and @data in the inode cache,
1225 * and if the inode is in the cache, return the inode with an incremented
1226 * reference count. Waits on I_NEW before returning the inode.
88bd5121 1227 * returned with an incremented reference count.
1da177e4 1228 *
0b2d0724
CH
1229 * This is a generalized version of ilookup() for file systems where the
1230 * inode number is not sufficient for unique identification of an inode.
1da177e4 1231 *
0b2d0724 1232 * Note: @test is called with the inode_hash_lock held, so can't sleep.
1da177e4
LT
1233 */
1234struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1235 int (*test)(struct inode *, void *), void *data)
1236{
0b2d0724 1237 struct inode *inode = ilookup5_nowait(sb, hashval, test, data);
1da177e4 1238
0b2d0724
CH
1239 if (inode)
1240 wait_on_inode(inode);
1241 return inode;
1da177e4 1242}
1da177e4
LT
1243EXPORT_SYMBOL(ilookup5);
1244
1245/**
1246 * ilookup - search for an inode in the inode cache
1247 * @sb: super block of file system to search
1248 * @ino: inode number to search for
1249 *
0b2d0724
CH
1250 * Search for the inode @ino in the inode cache, and if the inode is in the
1251 * cache, the inode is returned with an incremented reference count.
1da177e4
LT
1252 */
1253struct inode *ilookup(struct super_block *sb, unsigned long ino)
1254{
1255 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1da177e4
LT
1256 struct inode *inode;
1257
0b2d0724
CH
1258 spin_lock(&inode_hash_lock);
1259 inode = find_inode_fast(sb, head, ino);
1260 spin_unlock(&inode_hash_lock);
1da177e4 1261
1da177e4 1262 if (inode)
0b2d0724
CH
1263 wait_on_inode(inode);
1264 return inode;
1da177e4 1265}
0b2d0724 1266EXPORT_SYMBOL(ilookup);
1da177e4 1267
261bca86
AV
1268int insert_inode_locked(struct inode *inode)
1269{
1270 struct super_block *sb = inode->i_sb;
1271 ino_t ino = inode->i_ino;
1272 struct hlist_head *head = inode_hashtable + hash(sb, ino);
261bca86 1273
261bca86 1274 while (1) {
72a43d63
AV
1275 struct hlist_node *node;
1276 struct inode *old = NULL;
67a23c49 1277 spin_lock(&inode_hash_lock);
72a43d63
AV
1278 hlist_for_each_entry(old, node, head, i_hash) {
1279 if (old->i_ino != ino)
1280 continue;
1281 if (old->i_sb != sb)
1282 continue;
250df6ed
DC
1283 spin_lock(&old->i_lock);
1284 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1285 spin_unlock(&old->i_lock);
72a43d63 1286 continue;
250df6ed 1287 }
72a43d63
AV
1288 break;
1289 }
1290 if (likely(!node)) {
250df6ed
DC
1291 spin_lock(&inode->i_lock);
1292 inode->i_state |= I_NEW;
261bca86 1293 hlist_add_head(&inode->i_hash, head);
250df6ed 1294 spin_unlock(&inode->i_lock);
67a23c49 1295 spin_unlock(&inode_hash_lock);
261bca86
AV
1296 return 0;
1297 }
1298 __iget(old);
250df6ed 1299 spin_unlock(&old->i_lock);
67a23c49 1300 spin_unlock(&inode_hash_lock);
261bca86 1301 wait_on_inode(old);
1d3382cb 1302 if (unlikely(!inode_unhashed(old))) {
261bca86
AV
1303 iput(old);
1304 return -EBUSY;
1305 }
1306 iput(old);
1307 }
1308}
261bca86
AV
1309EXPORT_SYMBOL(insert_inode_locked);
1310
1311int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1312 int (*test)(struct inode *, void *), void *data)
1313{
1314 struct super_block *sb = inode->i_sb;
1315 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
261bca86 1316
261bca86 1317 while (1) {
72a43d63
AV
1318 struct hlist_node *node;
1319 struct inode *old = NULL;
1320
67a23c49 1321 spin_lock(&inode_hash_lock);
72a43d63
AV
1322 hlist_for_each_entry(old, node, head, i_hash) {
1323 if (old->i_sb != sb)
1324 continue;
1325 if (!test(old, data))
1326 continue;
250df6ed
DC
1327 spin_lock(&old->i_lock);
1328 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1329 spin_unlock(&old->i_lock);
72a43d63 1330 continue;
250df6ed 1331 }
72a43d63
AV
1332 break;
1333 }
1334 if (likely(!node)) {
250df6ed
DC
1335 spin_lock(&inode->i_lock);
1336 inode->i_state |= I_NEW;
261bca86 1337 hlist_add_head(&inode->i_hash, head);
250df6ed 1338 spin_unlock(&inode->i_lock);
67a23c49 1339 spin_unlock(&inode_hash_lock);
261bca86
AV
1340 return 0;
1341 }
1342 __iget(old);
250df6ed 1343 spin_unlock(&old->i_lock);
67a23c49 1344 spin_unlock(&inode_hash_lock);
261bca86 1345 wait_on_inode(old);
1d3382cb 1346 if (unlikely(!inode_unhashed(old))) {
261bca86
AV
1347 iput(old);
1348 return -EBUSY;
1349 }
1350 iput(old);
1351 }
1352}
261bca86
AV
1353EXPORT_SYMBOL(insert_inode_locked4);
1354
1da177e4 1355
45321ac5
AV
1356int generic_delete_inode(struct inode *inode)
1357{
1358 return 1;
1359}
1360EXPORT_SYMBOL(generic_delete_inode);
1361
45321ac5
AV
1362/*
1363 * Called when we're dropping the last reference
1364 * to an inode.
22fe4042 1365 *
45321ac5
AV
1366 * Call the FS "drop_inode()" function, defaulting to
1367 * the legacy UNIX filesystem behaviour. If it tells
1368 * us to evict inode, do so. Otherwise, retain inode
1369 * in cache if fs is alive, sync and evict if fs is
1370 * shutting down.
22fe4042 1371 */
45321ac5 1372static void iput_final(struct inode *inode)
1da177e4
LT
1373{
1374 struct super_block *sb = inode->i_sb;
45321ac5
AV
1375 const struct super_operations *op = inode->i_sb->s_op;
1376 int drop;
1377
250df6ed
DC
1378 WARN_ON(inode->i_state & I_NEW);
1379
e7f59097 1380 if (op->drop_inode)
45321ac5
AV
1381 drop = op->drop_inode(inode);
1382 else
1383 drop = generic_drop_inode(inode);
1da177e4 1384
b2b2af8e
DC
1385 if (!drop && (sb->s_flags & MS_ACTIVE)) {
1386 inode->i_state |= I_REFERENCED;
1387 if (!(inode->i_state & (I_DIRTY|I_SYNC)))
1388 inode_lru_list_add(inode);
1389 spin_unlock(&inode->i_lock);
b2b2af8e
DC
1390 return;
1391 }
1392
45321ac5 1393 if (!drop) {
991114c6 1394 inode->i_state |= I_WILL_FREE;
250df6ed 1395 spin_unlock(&inode->i_lock);
1da177e4 1396 write_inode_now(inode, 1);
250df6ed 1397 spin_lock(&inode->i_lock);
7ef0d737 1398 WARN_ON(inode->i_state & I_NEW);
991114c6 1399 inode->i_state &= ~I_WILL_FREE;
1da177e4 1400 }
7ccf19a8 1401
991114c6 1402 inode->i_state |= I_FREEING;
c4ae0c65
ED
1403 if (!list_empty(&inode->i_lru))
1404 inode_lru_list_del(inode);
b2b2af8e 1405 spin_unlock(&inode->i_lock);
b2b2af8e 1406
644da596 1407 evict(inode);
1da177e4
LT
1408}
1409
1da177e4 1410/**
6b3304b5 1411 * iput - put an inode
1da177e4
LT
1412 * @inode: inode to put
1413 *
1414 * Puts an inode, dropping its usage count. If the inode use count hits
1415 * zero, the inode is then freed and may also be destroyed.
1416 *
1417 * Consequently, iput() can sleep.
1418 */
1419void iput(struct inode *inode)
1420{
1421 if (inode) {
a4ffdde6 1422 BUG_ON(inode->i_state & I_CLEAR);
1da177e4 1423
f283c86a 1424 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock))
1da177e4
LT
1425 iput_final(inode);
1426 }
1427}
1da177e4
LT
1428EXPORT_SYMBOL(iput);
1429
1430/**
1431 * bmap - find a block number in a file
1432 * @inode: inode of file
1433 * @block: block to find
1434 *
1435 * Returns the block number on the device holding the inode that
1436 * is the disk block number for the block of the file requested.
1437 * That is, asked for block 4 of inode 1 the function will return the
6b3304b5 1438 * disk block relative to the disk start that holds that block of the
1da177e4
LT
1439 * file.
1440 */
6b3304b5 1441sector_t bmap(struct inode *inode, sector_t block)
1da177e4
LT
1442{
1443 sector_t res = 0;
1444 if (inode->i_mapping->a_ops->bmap)
1445 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1446 return res;
1447}
1da177e4
LT
1448EXPORT_SYMBOL(bmap);
1449
11ff6f05
MG
1450/*
1451 * With relative atime, only update atime if the previous atime is
1452 * earlier than either the ctime or mtime or if at least a day has
1453 * passed since the last atime update.
1454 */
1455static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
1456 struct timespec now)
1457{
1458
1459 if (!(mnt->mnt_flags & MNT_RELATIME))
1460 return 1;
1461 /*
1462 * Is mtime younger than atime? If yes, update atime:
1463 */
1464 if (timespec_compare(&inode->i_mtime, &inode->i_atime) >= 0)
1465 return 1;
1466 /*
1467 * Is ctime younger than atime? If yes, update atime:
1468 */
1469 if (timespec_compare(&inode->i_ctime, &inode->i_atime) >= 0)
1470 return 1;
1471
1472 /*
1473 * Is the previous atime value older than a day? If yes,
1474 * update atime:
1475 */
1476 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1477 return 1;
1478 /*
1479 * Good, we can skip the atime update:
1480 */
1481 return 0;
1482}
1483
1da177e4 1484/**
869243a0
CH
1485 * touch_atime - update the access time
1486 * @mnt: mount the inode is accessed on
7045f37b 1487 * @dentry: dentry accessed
1da177e4
LT
1488 *
1489 * Update the accessed time on an inode and mark it for writeback.
1490 * This function automatically handles read only file systems and media,
1491 * as well as the "noatime" flag and inode specific "noatime" markers.
1492 */
68ac1234 1493void touch_atime(struct path *path)
1da177e4 1494{
68ac1234
AV
1495 struct vfsmount *mnt = path->mnt;
1496 struct inode *inode = path->dentry->d_inode;
1da177e4
LT
1497 struct timespec now;
1498
cdb70f3f 1499 if (inode->i_flags & S_NOATIME)
b12536c2 1500 return;
37756ced 1501 if (IS_NOATIME(inode))
b12536c2 1502 return;
b2276138 1503 if ((inode->i_sb->s_flags & MS_NODIRATIME) && S_ISDIR(inode->i_mode))
b12536c2 1504 return;
47ae32d6 1505
cdb70f3f 1506 if (mnt->mnt_flags & MNT_NOATIME)
b12536c2 1507 return;
cdb70f3f 1508 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
b12536c2 1509 return;
1da177e4
LT
1510
1511 now = current_fs_time(inode->i_sb);
11ff6f05
MG
1512
1513 if (!relatime_need_update(mnt, inode, now))
b12536c2 1514 return;
11ff6f05 1515
47ae32d6 1516 if (timespec_equal(&inode->i_atime, &now))
b12536c2
AK
1517 return;
1518
1519 if (mnt_want_write(mnt))
1520 return;
47ae32d6
VH
1521
1522 inode->i_atime = now;
1523 mark_inode_dirty_sync(inode);
cdb70f3f 1524 mnt_drop_write(mnt);
1da177e4 1525}
869243a0 1526EXPORT_SYMBOL(touch_atime);
1da177e4
LT
1527
1528/**
870f4817
CH
1529 * file_update_time - update mtime and ctime time
1530 * @file: file accessed
1da177e4 1531 *
870f4817
CH
1532 * Update the mtime and ctime members of an inode and mark the inode
1533 * for writeback. Note that this function is meant exclusively for
1534 * usage in the file write path of filesystems, and filesystems may
1535 * choose to explicitly ignore update via this function with the
2eadfc0e 1536 * S_NOCMTIME inode flag, e.g. for network filesystem where these
870f4817 1537 * timestamps are handled by the server.
1da177e4
LT
1538 */
1539
870f4817 1540void file_update_time(struct file *file)
1da177e4 1541{
0f7fc9e4 1542 struct inode *inode = file->f_path.dentry->d_inode;
1da177e4 1543 struct timespec now;
ce06e0b2 1544 enum { S_MTIME = 1, S_CTIME = 2, S_VERSION = 4 } sync_it = 0;
1da177e4 1545
ce06e0b2 1546 /* First try to exhaust all avenues to not sync */
1da177e4
LT
1547 if (IS_NOCMTIME(inode))
1548 return;
20ddee2c 1549
1da177e4 1550 now = current_fs_time(inode->i_sb);
ce06e0b2
AK
1551 if (!timespec_equal(&inode->i_mtime, &now))
1552 sync_it = S_MTIME;
1da177e4 1553
ce06e0b2
AK
1554 if (!timespec_equal(&inode->i_ctime, &now))
1555 sync_it |= S_CTIME;
870f4817 1556
ce06e0b2
AK
1557 if (IS_I_VERSION(inode))
1558 sync_it |= S_VERSION;
7a224228 1559
ce06e0b2
AK
1560 if (!sync_it)
1561 return;
1562
1563 /* Finally allowed to write? Takes lock. */
1564 if (mnt_want_write_file(file))
1565 return;
1566
1567 /* Only change inode inside the lock region */
1568 if (sync_it & S_VERSION)
1569 inode_inc_iversion(inode);
1570 if (sync_it & S_CTIME)
1571 inode->i_ctime = now;
1572 if (sync_it & S_MTIME)
1573 inode->i_mtime = now;
1574 mark_inode_dirty_sync(inode);
2a79f17e 1575 mnt_drop_write_file(file);
1da177e4 1576}
870f4817 1577EXPORT_SYMBOL(file_update_time);
1da177e4
LT
1578
1579int inode_needs_sync(struct inode *inode)
1580{
1581 if (IS_SYNC(inode))
1582 return 1;
1583 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1584 return 1;
1585 return 0;
1586}
1da177e4
LT
1587EXPORT_SYMBOL(inode_needs_sync);
1588
1da177e4
LT
1589int inode_wait(void *word)
1590{
1591 schedule();
1592 return 0;
1593}
d44dab8d 1594EXPORT_SYMBOL(inode_wait);
1da177e4
LT
1595
1596/*
168a9fd6
MS
1597 * If we try to find an inode in the inode hash while it is being
1598 * deleted, we have to wait until the filesystem completes its
1599 * deletion before reporting that it isn't found. This function waits
1600 * until the deletion _might_ have completed. Callers are responsible
1601 * to recheck inode state.
1602 *
eaff8079 1603 * It doesn't matter if I_NEW is not set initially, a call to
250df6ed
DC
1604 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
1605 * will DTRT.
1da177e4
LT
1606 */
1607static void __wait_on_freeing_inode(struct inode *inode)
1608{
1609 wait_queue_head_t *wq;
eaff8079
CH
1610 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1611 wq = bit_waitqueue(&inode->i_state, __I_NEW);
1da177e4 1612 prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
250df6ed 1613 spin_unlock(&inode->i_lock);
67a23c49 1614 spin_unlock(&inode_hash_lock);
1da177e4
LT
1615 schedule();
1616 finish_wait(wq, &wait.wait);
67a23c49 1617 spin_lock(&inode_hash_lock);
1da177e4
LT
1618}
1619
1da177e4
LT
1620static __initdata unsigned long ihash_entries;
1621static int __init set_ihash_entries(char *str)
1622{
1623 if (!str)
1624 return 0;
1625 ihash_entries = simple_strtoul(str, &str, 0);
1626 return 1;
1627}
1628__setup("ihash_entries=", set_ihash_entries);
1629
1630/*
1631 * Initialize the waitqueues and inode hash table.
1632 */
1633void __init inode_init_early(void)
1634{
074b8517 1635 unsigned int loop;
1da177e4
LT
1636
1637 /* If hashes are distributed across NUMA nodes, defer
1638 * hash allocation until vmalloc space is available.
1639 */
1640 if (hashdist)
1641 return;
1642
1643 inode_hashtable =
1644 alloc_large_system_hash("Inode-cache",
1645 sizeof(struct hlist_head),
1646 ihash_entries,
1647 14,
1648 HASH_EARLY,
1649 &i_hash_shift,
1650 &i_hash_mask,
1651 0);
1652
074b8517 1653 for (loop = 0; loop < (1U << i_hash_shift); loop++)
1da177e4
LT
1654 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1655}
1656
74bf17cf 1657void __init inode_init(void)
1da177e4 1658{
074b8517 1659 unsigned int loop;
1da177e4
LT
1660
1661 /* inode slab cache */
b0196009
PJ
1662 inode_cachep = kmem_cache_create("inode_cache",
1663 sizeof(struct inode),
1664 0,
1665 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
1666 SLAB_MEM_SPREAD),
20c2df83 1667 init_once);
1da177e4
LT
1668
1669 /* Hash may have been set up in inode_init_early */
1670 if (!hashdist)
1671 return;
1672
1673 inode_hashtable =
1674 alloc_large_system_hash("Inode-cache",
1675 sizeof(struct hlist_head),
1676 ihash_entries,
1677 14,
1678 0,
1679 &i_hash_shift,
1680 &i_hash_mask,
1681 0);
1682
074b8517 1683 for (loop = 0; loop < (1U << i_hash_shift); loop++)
1da177e4
LT
1684 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1685}
1686
1687void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
1688{
1689 inode->i_mode = mode;
1690 if (S_ISCHR(mode)) {
1691 inode->i_fop = &def_chr_fops;
1692 inode->i_rdev = rdev;
1693 } else if (S_ISBLK(mode)) {
1694 inode->i_fop = &def_blk_fops;
1695 inode->i_rdev = rdev;
1696 } else if (S_ISFIFO(mode))
1697 inode->i_fop = &def_fifo_fops;
1698 else if (S_ISSOCK(mode))
1699 inode->i_fop = &bad_sock_fops;
1700 else
af0d9ae8
MK
1701 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
1702 " inode %s:%lu\n", mode, inode->i_sb->s_id,
1703 inode->i_ino);
1da177e4
LT
1704}
1705EXPORT_SYMBOL(init_special_inode);
a1bd120d
DM
1706
1707/**
eaae668d 1708 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
a1bd120d
DM
1709 * @inode: New inode
1710 * @dir: Directory inode
1711 * @mode: mode of the new inode
1712 */
1713void inode_init_owner(struct inode *inode, const struct inode *dir,
62bb1091 1714 umode_t mode)
a1bd120d
DM
1715{
1716 inode->i_uid = current_fsuid();
1717 if (dir && dir->i_mode & S_ISGID) {
1718 inode->i_gid = dir->i_gid;
1719 if (S_ISDIR(mode))
1720 mode |= S_ISGID;
1721 } else
1722 inode->i_gid = current_fsgid();
1723 inode->i_mode = mode;
1724}
1725EXPORT_SYMBOL(inode_init_owner);
e795b717 1726
2e149670
SH
1727/**
1728 * inode_owner_or_capable - check current task permissions to inode
1729 * @inode: inode being checked
1730 *
1731 * Return true if current either has CAP_FOWNER to the inode, or
1732 * owns the file.
e795b717 1733 */
2e149670 1734bool inode_owner_or_capable(const struct inode *inode)
e795b717
SH
1735{
1736 struct user_namespace *ns = inode_userns(inode);
1737
1738 if (current_user_ns() == ns && current_fsuid() == inode->i_uid)
1739 return true;
1740 if (ns_capable(ns, CAP_FOWNER))
1741 return true;
1742 return false;
1743}
2e149670 1744EXPORT_SYMBOL(inode_owner_or_capable);