]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - fs/inode.c
PCI: PM: Skip devices in D0 for suspend-to-idle
[mirror_ubuntu-bionic-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>
bc3b14cb 20#include <linux/list_lru.h>
0ae45f63 21#include <trace/events/writeback.h>
a66979ab 22#include "internal.h"
1da177e4 23
250df6ed 24/*
4b4563dc 25 * Inode locking rules:
250df6ed
DC
26 *
27 * inode->i_lock protects:
28 * inode->i_state, inode->i_hash, __iget()
bc3b14cb 29 * Inode LRU list locks protect:
98b745c6 30 * inode->i_sb->s_inode_lru, inode->i_lru
74278da9
DC
31 * inode->i_sb->s_inode_list_lock protects:
32 * inode->i_sb->s_inodes, inode->i_sb_list
f758eeab 33 * bdi->wb.list_lock protects:
c7f54084 34 * bdi->wb.b_{dirty,io,more_io,dirty_time}, inode->i_io_list
67a23c49
DC
35 * inode_hash_lock protects:
36 * inode_hashtable, inode->i_hash
250df6ed
DC
37 *
38 * Lock ordering:
55fa6091 39 *
74278da9 40 * inode->i_sb->s_inode_list_lock
55fa6091 41 * inode->i_lock
bc3b14cb 42 * Inode LRU list locks
a66979ab 43 *
f758eeab 44 * bdi->wb.list_lock
a66979ab 45 * inode->i_lock
67a23c49
DC
46 *
47 * inode_hash_lock
74278da9 48 * inode->i_sb->s_inode_list_lock
67a23c49
DC
49 * inode->i_lock
50 *
51 * iunique_lock
52 * inode_hash_lock
250df6ed
DC
53 */
54
fa3536cc
ED
55static unsigned int i_hash_mask __read_mostly;
56static unsigned int i_hash_shift __read_mostly;
67a23c49
DC
57static struct hlist_head *inode_hashtable __read_mostly;
58static __cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_hash_lock);
1da177e4 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
3942c07c
GC
73static DEFINE_PER_CPU(unsigned long, nr_inodes);
74static DEFINE_PER_CPU(unsigned long, nr_unused);
cffbc8aa 75
6b3304b5 76static struct kmem_cache *inode_cachep __read_mostly;
1da177e4 77
3942c07c 78static long get_nr_inodes(void)
cffbc8aa 79{
3e880fb5 80 int i;
3942c07c 81 long sum = 0;
3e880fb5
NP
82 for_each_possible_cpu(i)
83 sum += per_cpu(nr_inodes, i);
84 return sum < 0 ? 0 : sum;
cffbc8aa
DC
85}
86
3942c07c 87static inline long get_nr_inodes_unused(void)
cffbc8aa 88{
fcb94f72 89 int i;
3942c07c 90 long sum = 0;
fcb94f72
DC
91 for_each_possible_cpu(i)
92 sum += per_cpu(nr_unused, i);
93 return sum < 0 ? 0 : sum;
cffbc8aa
DC
94}
95
3942c07c 96long get_nr_dirty_inodes(void)
cffbc8aa 97{
3e880fb5 98 /* not actually dirty inodes, but a wild approximation */
3942c07c 99 long nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
cffbc8aa 100 return nr_dirty > 0 ? nr_dirty : 0;
cffbc8aa
DC
101}
102
103/*
104 * Handle nr_inode sysctl
105 */
106#ifdef CONFIG_SYSCTL
1f7e0616 107int proc_nr_inodes(struct ctl_table *table, int write,
cffbc8aa
DC
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();
3942c07c 112 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
cffbc8aa
DC
113}
114#endif
115
bd9b51e7
AV
116static int no_open(struct inode *inode, struct file *file)
117{
118 return -ENXIO;
119}
120
2cb1599f 121/**
6e7c2b4d 122 * inode_init_always - perform inode structure initialisation
0bc02f3f
RD
123 * @sb: superblock inode belongs to
124 * @inode: inode to initialise
2cb1599f
DC
125 *
126 * These are initializations that need to be done on every inode
127 * allocation as the fields are not initialised by slab allocation.
128 */
54e34621 129int inode_init_always(struct super_block *sb, struct inode *inode)
1da177e4 130{
6e1d5dcc 131 static const struct inode_operations empty_iops;
bd9b51e7 132 static const struct file_operations no_open_fops = {.open = no_open};
6b3304b5 133 struct address_space *const mapping = &inode->i_data;
2cb1599f
DC
134
135 inode->i_sb = sb;
136 inode->i_blkbits = sb->s_blocksize_bits;
137 inode->i_flags = 0;
138 atomic_set(&inode->i_count, 1);
139 inode->i_op = &empty_iops;
bd9b51e7 140 inode->i_fop = &no_open_fops;
a78ef704 141 inode->__i_nlink = 1;
3ddcd056 142 inode->i_opflags = 0;
d0a5b995
AG
143 if (sb->s_xattr)
144 inode->i_opflags |= IOP_XATTR;
92361636
EB
145 i_uid_write(inode, 0);
146 i_gid_write(inode, 0);
2cb1599f
DC
147 atomic_set(&inode->i_writecount, 0);
148 inode->i_size = 0;
c75b1d94 149 inode->i_write_hint = WRITE_LIFE_NOT_SET;
2cb1599f
DC
150 inode->i_blocks = 0;
151 inode->i_bytes = 0;
152 inode->i_generation = 0;
2cb1599f
DC
153 inode->i_pipe = NULL;
154 inode->i_bdev = NULL;
155 inode->i_cdev = NULL;
61ba64fc 156 inode->i_link = NULL;
84e710da 157 inode->i_dir_seq = 0;
2cb1599f
DC
158 inode->i_rdev = 0;
159 inode->dirtied_when = 0;
6146f0d5 160
3d65ae46
TE
161#ifdef CONFIG_CGROUP_WRITEBACK
162 inode->i_wb_frn_winner = 0;
163 inode->i_wb_frn_avg_time = 0;
164 inode->i_wb_frn_history = 0;
165#endif
166
6146f0d5 167 if (security_inode_alloc(inode))
54e34621 168 goto out;
2cb1599f
DC
169 spin_lock_init(&inode->i_lock);
170 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
171
9902af79
AV
172 init_rwsem(&inode->i_rwsem);
173 lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
2cb1599f 174
bd5fe6c5 175 atomic_set(&inode->i_dio_count, 0);
2cb1599f
DC
176
177 mapping->a_ops = &empty_aops;
178 mapping->host = inode;
179 mapping->flags = 0;
93eee4bb 180 mapping->wb_err = 0;
4bb5f5d9 181 atomic_set(&mapping->i_mmap_writable, 0);
3c1d4378 182 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
252aa6f5 183 mapping->private_data = NULL;
2cb1599f 184 mapping->writeback_index = 0;
2cb1599f
DC
185 inode->i_private = NULL;
186 inode->i_mapping = mapping;
b3d9b7a3 187 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
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
4a075e39 195 inode->i_flctx = NULL;
3e880fb5 196 this_cpu_inc(nr_inodes);
cffbc8aa 197
54e34621 198 return 0;
54e34621
CH
199out:
200 return -ENOMEM;
1da177e4 201}
2cb1599f
DC
202EXPORT_SYMBOL(inode_init_always);
203
204static struct inode *alloc_inode(struct super_block *sb)
205{
206 struct inode *inode;
207
208 if (sb->s_op->alloc_inode)
209 inode = sb->s_op->alloc_inode(sb);
210 else
211 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
212
54e34621
CH
213 if (!inode)
214 return NULL;
215
216 if (unlikely(inode_init_always(sb, inode))) {
217 if (inode->i_sb->s_op->destroy_inode)
218 inode->i_sb->s_op->destroy_inode(inode);
219 else
220 kmem_cache_free(inode_cachep, inode);
221 return NULL;
222 }
223
224 return inode;
2cb1599f 225}
1da177e4 226
ff0c7d15
NP
227void free_inode_nonrcu(struct inode *inode)
228{
229 kmem_cache_free(inode_cachep, inode);
230}
231EXPORT_SYMBOL(free_inode_nonrcu);
232
2e00c97e 233void __destroy_inode(struct inode *inode)
1da177e4 234{
b7542f8c 235 BUG_ON(inode_has_buffers(inode));
52ebea74 236 inode_detach_wb(inode);
1da177e4 237 security_inode_free(inode);
3be25f49 238 fsnotify_inode_delete(inode);
f27a0fe0 239 locks_free_lock_context(inode);
7ada4db8
MS
240 if (!inode->i_nlink) {
241 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
242 atomic_long_dec(&inode->i_sb->s_remove_count);
243 }
244
f19d4a8f 245#ifdef CONFIG_FS_POSIX_ACL
b8a7a3a6 246 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
f19d4a8f 247 posix_acl_release(inode->i_acl);
b8a7a3a6 248 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
f19d4a8f
AV
249 posix_acl_release(inode->i_default_acl);
250#endif
3e880fb5 251 this_cpu_dec(nr_inodes);
2e00c97e
CH
252}
253EXPORT_SYMBOL(__destroy_inode);
254
fa0d7e3d
NP
255static void i_callback(struct rcu_head *head)
256{
257 struct inode *inode = container_of(head, struct inode, i_rcu);
fa0d7e3d
NP
258 kmem_cache_free(inode_cachep, inode);
259}
260
56b0dacf 261static void destroy_inode(struct inode *inode)
2e00c97e 262{
7ccf19a8 263 BUG_ON(!list_empty(&inode->i_lru));
2e00c97e 264 __destroy_inode(inode);
1da177e4
LT
265 if (inode->i_sb->s_op->destroy_inode)
266 inode->i_sb->s_op->destroy_inode(inode);
267 else
fa0d7e3d 268 call_rcu(&inode->i_rcu, i_callback);
1da177e4 269}
1da177e4 270
7ada4db8
MS
271/**
272 * drop_nlink - directly drop an inode's link count
273 * @inode: inode
274 *
275 * This is a low-level filesystem helper to replace any
276 * direct filesystem manipulation of i_nlink. In cases
277 * where we are attempting to track writes to the
278 * filesystem, a decrement to zero means an imminent
279 * write when the file is truncated and actually unlinked
280 * on the filesystem.
281 */
282void drop_nlink(struct inode *inode)
283{
284 WARN_ON(inode->i_nlink == 0);
285 inode->__i_nlink--;
286 if (!inode->i_nlink)
287 atomic_long_inc(&inode->i_sb->s_remove_count);
288}
289EXPORT_SYMBOL(drop_nlink);
290
291/**
292 * clear_nlink - directly zero an inode's link count
293 * @inode: inode
294 *
295 * This is a low-level filesystem helper to replace any
296 * direct filesystem manipulation of i_nlink. See
297 * drop_nlink() for why we care about i_nlink hitting zero.
298 */
299void clear_nlink(struct inode *inode)
300{
301 if (inode->i_nlink) {
302 inode->__i_nlink = 0;
303 atomic_long_inc(&inode->i_sb->s_remove_count);
304 }
305}
306EXPORT_SYMBOL(clear_nlink);
307
308/**
309 * set_nlink - directly set an inode's link count
310 * @inode: inode
311 * @nlink: new nlink (should be non-zero)
312 *
313 * This is a low-level filesystem helper to replace any
314 * direct filesystem manipulation of i_nlink.
315 */
316void set_nlink(struct inode *inode, unsigned int nlink)
317{
318 if (!nlink) {
7ada4db8
MS
319 clear_nlink(inode);
320 } else {
321 /* Yes, some filesystems do change nlink from zero to one */
322 if (inode->i_nlink == 0)
323 atomic_long_dec(&inode->i_sb->s_remove_count);
324
325 inode->__i_nlink = nlink;
326 }
327}
328EXPORT_SYMBOL(set_nlink);
329
330/**
331 * inc_nlink - directly increment an inode's link count
332 * @inode: inode
333 *
334 * This is a low-level filesystem helper to replace any
335 * direct filesystem manipulation of i_nlink. Currently,
336 * it is only here for parity with dec_nlink().
337 */
338void inc_nlink(struct inode *inode)
339{
f4e0c30c
AV
340 if (unlikely(inode->i_nlink == 0)) {
341 WARN_ON(!(inode->i_state & I_LINKABLE));
7ada4db8 342 atomic_long_dec(&inode->i_sb->s_remove_count);
f4e0c30c 343 }
7ada4db8
MS
344
345 inode->__i_nlink++;
346}
347EXPORT_SYMBOL(inc_nlink);
348
2aa15890
MS
349void address_space_init_once(struct address_space *mapping)
350{
351 memset(mapping, 0, sizeof(*mapping));
05eb6e72 352 INIT_RADIX_TREE(&mapping->page_tree, GFP_ATOMIC | __GFP_ACCOUNT);
2aa15890 353 spin_lock_init(&mapping->tree_lock);
c8c06efa 354 init_rwsem(&mapping->i_mmap_rwsem);
2aa15890
MS
355 INIT_LIST_HEAD(&mapping->private_list);
356 spin_lock_init(&mapping->private_lock);
f808c13f 357 mapping->i_mmap = RB_ROOT_CACHED;
2aa15890
MS
358}
359EXPORT_SYMBOL(address_space_init_once);
360
1da177e4
LT
361/*
362 * These are initializations that only need to be done
363 * once, because the fields are idempotent across use
364 * of the inode, so let the slab aware of that.
365 */
366void inode_init_once(struct inode *inode)
367{
368 memset(inode, 0, sizeof(*inode));
369 INIT_HLIST_NODE(&inode->i_hash);
1da177e4 370 INIT_LIST_HEAD(&inode->i_devices);
c7f54084 371 INIT_LIST_HEAD(&inode->i_io_list);
6c60d2b5 372 INIT_LIST_HEAD(&inode->i_wb_list);
7ccf19a8 373 INIT_LIST_HEAD(&inode->i_lru);
2aa15890 374 address_space_init_once(&inode->i_data);
1da177e4
LT
375 i_size_ordered_init(inode);
376}
1da177e4
LT
377EXPORT_SYMBOL(inode_init_once);
378
51cc5068 379static void init_once(void *foo)
1da177e4 380{
6b3304b5 381 struct inode *inode = (struct inode *) foo;
1da177e4 382
a35afb83 383 inode_init_once(inode);
1da177e4
LT
384}
385
386/*
250df6ed 387 * inode->i_lock must be held
1da177e4 388 */
6b3304b5 389void __iget(struct inode *inode)
1da177e4 390{
9e38d86f
NP
391 atomic_inc(&inode->i_count);
392}
2e147f1e 393
7de9c6ee
AV
394/*
395 * get additional reference to inode; caller must already hold one.
396 */
397void ihold(struct inode *inode)
398{
399 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
400}
401EXPORT_SYMBOL(ihold);
402
9e38d86f
NP
403static void inode_lru_list_add(struct inode *inode)
404{
bc3b14cb 405 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
fcb94f72 406 this_cpu_inc(nr_unused);
563f4001
JB
407 else
408 inode->i_state |= I_REFERENCED;
9e38d86f 409}
2e147f1e 410
4eff96dd
JK
411/*
412 * Add inode to LRU if needed (inode is unused and clean).
413 *
414 * Needs inode->i_lock held.
415 */
416void inode_add_lru(struct inode *inode)
417{
0ae45f63
TT
418 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
419 I_FREEING | I_WILL_FREE)) &&
1751e8a6 420 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & SB_ACTIVE)
4eff96dd
JK
421 inode_lru_list_add(inode);
422}
423
424
9e38d86f
NP
425static void inode_lru_list_del(struct inode *inode)
426{
bc3b14cb
DC
427
428 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
fcb94f72 429 this_cpu_dec(nr_unused);
1da177e4
LT
430}
431
646ec461
CH
432/**
433 * inode_sb_list_add - add inode to the superblock list of inodes
434 * @inode: inode to add
435 */
436void inode_sb_list_add(struct inode *inode)
437{
74278da9 438 spin_lock(&inode->i_sb->s_inode_list_lock);
55fa6091 439 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
74278da9 440 spin_unlock(&inode->i_sb->s_inode_list_lock);
646ec461
CH
441}
442EXPORT_SYMBOL_GPL(inode_sb_list_add);
443
55fa6091 444static inline void inode_sb_list_del(struct inode *inode)
646ec461 445{
a209dfc7 446 if (!list_empty(&inode->i_sb_list)) {
74278da9 447 spin_lock(&inode->i_sb->s_inode_list_lock);
a209dfc7 448 list_del_init(&inode->i_sb_list);
74278da9 449 spin_unlock(&inode->i_sb->s_inode_list_lock);
a209dfc7 450 }
646ec461
CH
451}
452
4c51acbc
DC
453static unsigned long hash(struct super_block *sb, unsigned long hashval)
454{
455 unsigned long tmp;
456
457 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
458 L1_CACHE_BYTES;
4b4563dc
CH
459 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
460 return tmp & i_hash_mask;
4c51acbc
DC
461}
462
463/**
464 * __insert_inode_hash - hash an inode
465 * @inode: unhashed inode
466 * @hashval: unsigned long value used to locate this object in the
467 * inode_hashtable.
468 *
469 * Add an inode to the inode hash for this superblock.
470 */
471void __insert_inode_hash(struct inode *inode, unsigned long hashval)
472{
646ec461
CH
473 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
474
67a23c49 475 spin_lock(&inode_hash_lock);
250df6ed 476 spin_lock(&inode->i_lock);
646ec461 477 hlist_add_head(&inode->i_hash, b);
250df6ed 478 spin_unlock(&inode->i_lock);
67a23c49 479 spin_unlock(&inode_hash_lock);
4c51acbc
DC
480}
481EXPORT_SYMBOL(__insert_inode_hash);
482
4c51acbc 483/**
f2ee7abf 484 * __remove_inode_hash - remove an inode from the hash
4c51acbc
DC
485 * @inode: inode to unhash
486 *
487 * Remove an inode from the superblock.
488 */
f2ee7abf 489void __remove_inode_hash(struct inode *inode)
4c51acbc 490{
67a23c49 491 spin_lock(&inode_hash_lock);
250df6ed 492 spin_lock(&inode->i_lock);
4c51acbc 493 hlist_del_init(&inode->i_hash);
250df6ed 494 spin_unlock(&inode->i_lock);
67a23c49 495 spin_unlock(&inode_hash_lock);
4c51acbc 496}
f2ee7abf 497EXPORT_SYMBOL(__remove_inode_hash);
4c51acbc 498
dbd5768f 499void clear_inode(struct inode *inode)
b0683aa6
AV
500{
501 might_sleep();
08142579
JK
502 /*
503 * We have to cycle tree_lock here because reclaim can be still in the
504 * process of removing the last page (in __delete_from_page_cache())
505 * and we must not free mapping under it.
506 */
507 spin_lock_irq(&inode->i_data.tree_lock);
b0683aa6 508 BUG_ON(inode->i_data.nrpages);
f9fe48be 509 BUG_ON(inode->i_data.nrexceptional);
08142579 510 spin_unlock_irq(&inode->i_data.tree_lock);
b0683aa6
AV
511 BUG_ON(!list_empty(&inode->i_data.private_list));
512 BUG_ON(!(inode->i_state & I_FREEING));
513 BUG_ON(inode->i_state & I_CLEAR);
6c60d2b5 514 BUG_ON(!list_empty(&inode->i_wb_list));
fa0d7e3d 515 /* don't need i_lock here, no concurrent mods to i_state */
b0683aa6
AV
516 inode->i_state = I_FREEING | I_CLEAR;
517}
dbd5768f 518EXPORT_SYMBOL(clear_inode);
b0683aa6 519
b2b2af8e
DC
520/*
521 * Free the inode passed in, removing it from the lists it is still connected
522 * to. We remove any pages still attached to the inode and wait for any IO that
523 * is still in progress before finally destroying the inode.
524 *
525 * An inode must already be marked I_FREEING so that we avoid the inode being
526 * moved back onto lists if we race with other code that manipulates the lists
527 * (e.g. writeback_single_inode). The caller is responsible for setting this.
528 *
529 * An inode must already be removed from the LRU list before being evicted from
530 * the cache. This should occur atomically with setting the I_FREEING state
531 * flag, so no inodes here should ever be on the LRU when being evicted.
532 */
644da596 533static void evict(struct inode *inode)
b4272d4c
AV
534{
535 const struct super_operations *op = inode->i_sb->s_op;
536
b2b2af8e
DC
537 BUG_ON(!(inode->i_state & I_FREEING));
538 BUG_ON(!list_empty(&inode->i_lru));
539
c7f54084
DC
540 if (!list_empty(&inode->i_io_list))
541 inode_io_list_del(inode);
b12362bd 542
55fa6091
DC
543 inode_sb_list_del(inode);
544
169ebd90
JK
545 /*
546 * Wait for flusher thread to be done with the inode so that filesystem
547 * does not start destroying it while writeback is still running. Since
548 * the inode has I_FREEING set, flusher thread won't start new work on
549 * the inode. We just have to wait for running writeback to finish.
550 */
551 inode_wait_for_writeback(inode);
7994e6f7 552
be7ce416
AV
553 if (op->evict_inode) {
554 op->evict_inode(inode);
b4272d4c 555 } else {
91b0abe3 556 truncate_inode_pages_final(&inode->i_data);
dbd5768f 557 clear_inode(inode);
b4272d4c 558 }
661074e9
AV
559 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
560 bd_forget(inode);
561 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
562 cd_forget(inode);
b2b2af8e
DC
563
564 remove_inode_hash(inode);
565
566 spin_lock(&inode->i_lock);
567 wake_up_bit(&inode->i_state, __I_NEW);
568 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
569 spin_unlock(&inode->i_lock);
570
571 destroy_inode(inode);
b4272d4c
AV
572}
573
1da177e4
LT
574/*
575 * dispose_list - dispose of the contents of a local list
576 * @head: the head of the list to free
577 *
578 * Dispose-list gets a local list with local inodes in it, so it doesn't
579 * need to worry about list corruption and SMP locks.
580 */
581static void dispose_list(struct list_head *head)
582{
1da177e4
LT
583 while (!list_empty(head)) {
584 struct inode *inode;
585
7ccf19a8
NP
586 inode = list_first_entry(head, struct inode, i_lru);
587 list_del_init(&inode->i_lru);
1da177e4 588
644da596 589 evict(inode);
ac05fbb4 590 cond_resched();
1da177e4 591 }
1da177e4
LT
592}
593
63997e98
AV
594/**
595 * evict_inodes - evict all evictable inodes for a superblock
596 * @sb: superblock to operate on
597 *
598 * Make sure that no inodes with zero refcount are retained. This is
1751e8a6 599 * called by superblock shutdown after having SB_ACTIVE flag removed,
63997e98
AV
600 * so any inode reaching zero refcount during or after that call will
601 * be immediately evicted.
1da177e4 602 */
63997e98 603void evict_inodes(struct super_block *sb)
1da177e4 604{
63997e98
AV
605 struct inode *inode, *next;
606 LIST_HEAD(dispose);
1da177e4 607
ac05fbb4 608again:
74278da9 609 spin_lock(&sb->s_inode_list_lock);
63997e98
AV
610 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
611 if (atomic_read(&inode->i_count))
aabb8fdb 612 continue;
250df6ed
DC
613
614 spin_lock(&inode->i_lock);
615 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
616 spin_unlock(&inode->i_lock);
1da177e4 617 continue;
250df6ed 618 }
63997e98
AV
619
620 inode->i_state |= I_FREEING;
02afc410 621 inode_lru_list_del(inode);
250df6ed 622 spin_unlock(&inode->i_lock);
02afc410 623 list_add(&inode->i_lru, &dispose);
ac05fbb4
JB
624
625 /*
626 * We can have a ton of inodes to evict at unmount time given
627 * enough memory, check to see if we need to go to sleep for a
628 * bit so we don't livelock.
629 */
630 if (need_resched()) {
631 spin_unlock(&sb->s_inode_list_lock);
632 cond_resched();
633 dispose_list(&dispose);
634 goto again;
635 }
1da177e4 636 }
74278da9 637 spin_unlock(&sb->s_inode_list_lock);
63997e98
AV
638
639 dispose_list(&dispose);
1da177e4 640}
799ea9e9 641EXPORT_SYMBOL_GPL(evict_inodes);
1da177e4 642
1da177e4 643/**
a0318786
CH
644 * invalidate_inodes - attempt to free all inodes on a superblock
645 * @sb: superblock to operate on
93b270f7 646 * @kill_dirty: flag to guide handling of dirty inodes
1da177e4 647 *
a0318786
CH
648 * Attempts to free all inodes for a given superblock. If there were any
649 * busy inodes return a non-zero value, else zero.
93b270f7
N
650 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
651 * them as busy.
1da177e4 652 */
93b270f7 653int invalidate_inodes(struct super_block *sb, bool kill_dirty)
1da177e4 654{
cffbc8aa 655 int busy = 0;
a0318786
CH
656 struct inode *inode, *next;
657 LIST_HEAD(dispose);
1da177e4 658
74278da9 659 spin_lock(&sb->s_inode_list_lock);
a0318786 660 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
250df6ed
DC
661 spin_lock(&inode->i_lock);
662 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
663 spin_unlock(&inode->i_lock);
aabb8fdb 664 continue;
250df6ed 665 }
0ae45f63 666 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
250df6ed 667 spin_unlock(&inode->i_lock);
93b270f7
N
668 busy = 1;
669 continue;
670 }
99a38919 671 if (atomic_read(&inode->i_count)) {
250df6ed 672 spin_unlock(&inode->i_lock);
99a38919 673 busy = 1;
1da177e4
LT
674 continue;
675 }
99a38919 676
99a38919 677 inode->i_state |= I_FREEING;
02afc410 678 inode_lru_list_del(inode);
250df6ed 679 spin_unlock(&inode->i_lock);
02afc410 680 list_add(&inode->i_lru, &dispose);
1da177e4 681 }
74278da9 682 spin_unlock(&sb->s_inode_list_lock);
1da177e4 683
a0318786 684 dispose_list(&dispose);
1da177e4
LT
685
686 return busy;
687}
1da177e4 688
1da177e4 689/*
bc3b14cb 690 * Isolate the inode from the LRU in preparation for freeing it.
1da177e4
LT
691 *
692 * Any inodes which are pinned purely because of attached pagecache have their
9e38d86f
NP
693 * pagecache removed. If the inode has metadata buffers attached to
694 * mapping->private_list then try to remove them.
1da177e4 695 *
9e38d86f
NP
696 * If the inode has the I_REFERENCED flag set, then it means that it has been
697 * used recently - the flag is set in iput_final(). When we encounter such an
698 * inode, clear the flag and move it to the back of the LRU so it gets another
699 * pass through the LRU before it gets reclaimed. This is necessary because of
700 * the fact we are doing lazy LRU updates to minimise lock contention so the
701 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
702 * with this flag set because they are the inodes that are out of order.
1da177e4 703 */
3f97b163
VD
704static enum lru_status inode_lru_isolate(struct list_head *item,
705 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
1da177e4 706{
bc3b14cb
DC
707 struct list_head *freeable = arg;
708 struct inode *inode = container_of(item, struct inode, i_lru);
1da177e4 709
bc3b14cb
DC
710 /*
711 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
712 * If we fail to get the lock, just skip it.
713 */
714 if (!spin_trylock(&inode->i_lock))
715 return LRU_SKIP;
1da177e4 716
bc3b14cb
DC
717 /*
718 * Referenced or dirty inodes are still in use. Give them another pass
719 * through the LRU as we canot reclaim them now.
720 */
721 if (atomic_read(&inode->i_count) ||
722 (inode->i_state & ~I_REFERENCED)) {
3f97b163 723 list_lru_isolate(lru, &inode->i_lru);
bc3b14cb
DC
724 spin_unlock(&inode->i_lock);
725 this_cpu_dec(nr_unused);
726 return LRU_REMOVED;
727 }
1da177e4 728
bc3b14cb
DC
729 /* recently referenced inodes get one more pass */
730 if (inode->i_state & I_REFERENCED) {
731 inode->i_state &= ~I_REFERENCED;
732 spin_unlock(&inode->i_lock);
733 return LRU_ROTATE;
734 }
1da177e4 735
bc3b14cb
DC
736 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
737 __iget(inode);
738 spin_unlock(&inode->i_lock);
739 spin_unlock(lru_lock);
740 if (remove_inode_buffers(inode)) {
741 unsigned long reap;
742 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
743 if (current_is_kswapd())
744 __count_vm_events(KSWAPD_INODESTEAL, reap);
745 else
746 __count_vm_events(PGINODESTEAL, reap);
747 if (current->reclaim_state)
748 current->reclaim_state->reclaimed_slab += reap;
02afc410 749 }
bc3b14cb
DC
750 iput(inode);
751 spin_lock(lru_lock);
752 return LRU_RETRY;
753 }
02afc410 754
bc3b14cb
DC
755 WARN_ON(inode->i_state & I_NEW);
756 inode->i_state |= I_FREEING;
3f97b163 757 list_lru_isolate_move(lru, &inode->i_lru, freeable);
bc3b14cb 758 spin_unlock(&inode->i_lock);
9e38d86f 759
bc3b14cb
DC
760 this_cpu_dec(nr_unused);
761 return LRU_REMOVED;
762}
7ccf19a8 763
bc3b14cb
DC
764/*
765 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
766 * This is called from the superblock shrinker function with a number of inodes
767 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
768 * then are freed outside inode_lock by dispose_list().
769 */
503c358c 770long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
bc3b14cb
DC
771{
772 LIST_HEAD(freeable);
773 long freed;
1da177e4 774
503c358c
VD
775 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
776 inode_lru_isolate, &freeable);
1da177e4 777 dispose_list(&freeable);
0a234c6d 778 return freed;
1da177e4
LT
779}
780
1da177e4
LT
781static void __wait_on_freeing_inode(struct inode *inode);
782/*
783 * Called with the inode lock held.
1da177e4 784 */
6b3304b5
MK
785static struct inode *find_inode(struct super_block *sb,
786 struct hlist_head *head,
787 int (*test)(struct inode *, void *),
788 void *data)
1da177e4 789{
6b3304b5 790 struct inode *inode = NULL;
1da177e4
LT
791
792repeat:
b67bfe0d 793 hlist_for_each_entry(inode, head, i_hash) {
5a3cd992 794 if (inode->i_sb != sb)
1da177e4 795 continue;
5a3cd992 796 if (!test(inode, data))
1da177e4 797 continue;
5a3cd992 798 spin_lock(&inode->i_lock);
a4ffdde6 799 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
1da177e4
LT
800 __wait_on_freeing_inode(inode);
801 goto repeat;
802 }
f7899bd5 803 __iget(inode);
250df6ed 804 spin_unlock(&inode->i_lock);
f7899bd5 805 return inode;
1da177e4 806 }
f7899bd5 807 return NULL;
1da177e4
LT
808}
809
810/*
811 * find_inode_fast is the fast path version of find_inode, see the comment at
812 * iget_locked for details.
813 */
6b3304b5
MK
814static struct inode *find_inode_fast(struct super_block *sb,
815 struct hlist_head *head, unsigned long ino)
1da177e4 816{
6b3304b5 817 struct inode *inode = NULL;
1da177e4
LT
818
819repeat:
b67bfe0d 820 hlist_for_each_entry(inode, head, i_hash) {
5a3cd992 821 if (inode->i_ino != ino)
1da177e4 822 continue;
5a3cd992 823 if (inode->i_sb != sb)
1da177e4 824 continue;
5a3cd992 825 spin_lock(&inode->i_lock);
a4ffdde6 826 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
1da177e4
LT
827 __wait_on_freeing_inode(inode);
828 goto repeat;
829 }
f7899bd5 830 __iget(inode);
250df6ed 831 spin_unlock(&inode->i_lock);
f7899bd5 832 return inode;
1da177e4 833 }
f7899bd5 834 return NULL;
8290c35f
DC
835}
836
f991bd2e
ED
837/*
838 * Each cpu owns a range of LAST_INO_BATCH numbers.
839 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
840 * to renew the exhausted range.
8290c35f 841 *
f991bd2e
ED
842 * This does not significantly increase overflow rate because every CPU can
843 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
844 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
845 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
846 * overflow rate by 2x, which does not seem too significant.
847 *
848 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
849 * error if st_ino won't fit in target struct field. Use 32bit counter
850 * here to attempt to avoid that.
8290c35f 851 */
f991bd2e
ED
852#define LAST_INO_BATCH 1024
853static DEFINE_PER_CPU(unsigned int, last_ino);
854
85fe4025 855unsigned int get_next_ino(void)
8290c35f 856{
f991bd2e
ED
857 unsigned int *p = &get_cpu_var(last_ino);
858 unsigned int res = *p;
8290c35f 859
f991bd2e
ED
860#ifdef CONFIG_SMP
861 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
862 static atomic_t shared_last_ino;
863 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
864
865 res = next - LAST_INO_BATCH;
866 }
867#endif
868
2adc376c
CM
869 res++;
870 /* get_next_ino should not provide a 0 inode number */
871 if (unlikely(!res))
872 res++;
873 *p = res;
f991bd2e
ED
874 put_cpu_var(last_ino);
875 return res;
8290c35f 876}
85fe4025 877EXPORT_SYMBOL(get_next_ino);
8290c35f 878
a209dfc7
ED
879/**
880 * new_inode_pseudo - obtain an inode
881 * @sb: superblock
882 *
883 * Allocates a new inode for given superblock.
884 * Inode wont be chained in superblock s_inodes list
885 * This means :
886 * - fs can't be unmount
887 * - quotas, fsnotify, writeback can't work
888 */
889struct inode *new_inode_pseudo(struct super_block *sb)
890{
891 struct inode *inode = alloc_inode(sb);
892
893 if (inode) {
894 spin_lock(&inode->i_lock);
895 inode->i_state = 0;
896 spin_unlock(&inode->i_lock);
897 INIT_LIST_HEAD(&inode->i_sb_list);
898 }
899 return inode;
900}
901
1da177e4
LT
902/**
903 * new_inode - obtain an inode
904 * @sb: superblock
905 *
769848c0 906 * Allocates a new inode for given superblock. The default gfp_mask
3c1d4378 907 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
769848c0
MG
908 * If HIGHMEM pages are unsuitable or it is known that pages allocated
909 * for the page cache are not reclaimable or migratable,
910 * mapping_set_gfp_mask() must be called with suitable flags on the
911 * newly created inode's mapping
912 *
1da177e4
LT
913 */
914struct inode *new_inode(struct super_block *sb)
915{
6b3304b5 916 struct inode *inode;
1da177e4 917
74278da9 918 spin_lock_prefetch(&sb->s_inode_list_lock);
6b3304b5 919
a209dfc7
ED
920 inode = new_inode_pseudo(sb);
921 if (inode)
55fa6091 922 inode_sb_list_add(inode);
1da177e4
LT
923 return inode;
924}
1da177e4
LT
925EXPORT_SYMBOL(new_inode);
926
14358e6d 927#ifdef CONFIG_DEBUG_LOCK_ALLOC
e096d0c7
JB
928void lockdep_annotate_inode_mutex_key(struct inode *inode)
929{
a3314a0e 930 if (S_ISDIR(inode->i_mode)) {
1e89a5e1
PZ
931 struct file_system_type *type = inode->i_sb->s_type;
932
9a7aa12f 933 /* Set new key only if filesystem hasn't already changed it */
9902af79 934 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
9a7aa12f
JK
935 /*
936 * ensure nobody is actually holding i_mutex
937 */
9902af79
AV
938 // mutex_destroy(&inode->i_mutex);
939 init_rwsem(&inode->i_rwsem);
940 lockdep_set_class(&inode->i_rwsem,
9a7aa12f
JK
941 &type->i_mutex_dir_key);
942 }
1e89a5e1 943 }
e096d0c7
JB
944}
945EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
14358e6d 946#endif
e096d0c7
JB
947
948/**
949 * unlock_new_inode - clear the I_NEW state and wake up any waiters
950 * @inode: new inode to unlock
951 *
952 * Called when the inode is fully initialised to clear the new state of the
953 * inode and wake up anyone waiting for the inode to finish initialisation.
954 */
955void unlock_new_inode(struct inode *inode)
956{
957 lockdep_annotate_inode_mutex_key(inode);
250df6ed 958 spin_lock(&inode->i_lock);
eaff8079
CH
959 WARN_ON(!(inode->i_state & I_NEW));
960 inode->i_state &= ~I_NEW;
310fa7a3 961 smp_mb();
250df6ed
DC
962 wake_up_bit(&inode->i_state, __I_NEW);
963 spin_unlock(&inode->i_lock);
1da177e4 964}
1da177e4
LT
965EXPORT_SYMBOL(unlock_new_inode);
966
375e289e
BF
967/**
968 * lock_two_nondirectories - take two i_mutexes on non-directory objects
4fd699ae
BF
969 *
970 * Lock any non-NULL argument that is not a directory.
971 * Zero, one or two objects may be locked by this function.
972 *
375e289e
BF
973 * @inode1: first inode to lock
974 * @inode2: second inode to lock
975 */
976void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
977{
4fd699ae
BF
978 if (inode1 > inode2)
979 swap(inode1, inode2);
980
981 if (inode1 && !S_ISDIR(inode1->i_mode))
5955102c 982 inode_lock(inode1);
4fd699ae 983 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
5955102c 984 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
375e289e
BF
985}
986EXPORT_SYMBOL(lock_two_nondirectories);
987
988/**
989 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
990 * @inode1: first inode to unlock
991 * @inode2: second inode to unlock
992 */
993void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
994{
4fd699ae 995 if (inode1 && !S_ISDIR(inode1->i_mode))
5955102c 996 inode_unlock(inode1);
4fd699ae 997 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
5955102c 998 inode_unlock(inode2);
375e289e
BF
999}
1000EXPORT_SYMBOL(unlock_two_nondirectories);
1001
0b2d0724
CH
1002/**
1003 * iget5_locked - obtain an inode from a mounted file system
1004 * @sb: super block of file system
1005 * @hashval: hash value (usually inode number) to get
1006 * @test: callback used for comparisons between inodes
1007 * @set: callback used to initialize a new struct inode
1008 * @data: opaque data pointer to pass to @test and @set
1009 *
1010 * Search for the inode specified by @hashval and @data in the inode cache,
1011 * and if present it is return it with an increased reference count. This is
1012 * a generalized version of iget_locked() for file systems where the inode
1013 * number is not sufficient for unique identification of an inode.
1014 *
1015 * If the inode is not in cache, allocate a new inode and return it locked,
1016 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1017 * before unlocking it via unlock_new_inode().
1da177e4 1018 *
0b2d0724
CH
1019 * Note both @test and @set are called with the inode_hash_lock held, so can't
1020 * sleep.
1da177e4 1021 */
0b2d0724
CH
1022struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1023 int (*test)(struct inode *, void *),
1024 int (*set)(struct inode *, void *), void *data)
1da177e4 1025{
0b2d0724 1026 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
6b3304b5 1027 struct inode *inode;
2864f301 1028again:
0b2d0724
CH
1029 spin_lock(&inode_hash_lock);
1030 inode = find_inode(sb, head, test, data);
1031 spin_unlock(&inode_hash_lock);
1032
1033 if (inode) {
1034 wait_on_inode(inode);
2864f301
AV
1035 if (unlikely(inode_unhashed(inode))) {
1036 iput(inode);
1037 goto again;
1038 }
0b2d0724
CH
1039 return inode;
1040 }
1041
1da177e4
LT
1042 inode = alloc_inode(sb);
1043 if (inode) {
6b3304b5 1044 struct inode *old;
1da177e4 1045
67a23c49 1046 spin_lock(&inode_hash_lock);
1da177e4
LT
1047 /* We released the lock, so.. */
1048 old = find_inode(sb, head, test, data);
1049 if (!old) {
1050 if (set(inode, data))
1051 goto set_failed;
1052
250df6ed
DC
1053 spin_lock(&inode->i_lock);
1054 inode->i_state = I_NEW;
646ec461 1055 hlist_add_head(&inode->i_hash, head);
250df6ed 1056 spin_unlock(&inode->i_lock);
55fa6091 1057 inode_sb_list_add(inode);
67a23c49 1058 spin_unlock(&inode_hash_lock);
1da177e4
LT
1059
1060 /* Return the locked inode with I_NEW set, the
1061 * caller is responsible for filling in the contents
1062 */
1063 return inode;
1064 }
1065
1066 /*
1067 * Uhhuh, somebody else created the same inode under
1068 * us. Use the old inode instead of the one we just
1069 * allocated.
1070 */
67a23c49 1071 spin_unlock(&inode_hash_lock);
1da177e4
LT
1072 destroy_inode(inode);
1073 inode = old;
1074 wait_on_inode(inode);
2864f301
AV
1075 if (unlikely(inode_unhashed(inode))) {
1076 iput(inode);
1077 goto again;
1078 }
1da177e4
LT
1079 }
1080 return inode;
1081
1082set_failed:
67a23c49 1083 spin_unlock(&inode_hash_lock);
1da177e4
LT
1084 destroy_inode(inode);
1085 return NULL;
1086}
0b2d0724 1087EXPORT_SYMBOL(iget5_locked);
1da177e4 1088
0b2d0724
CH
1089/**
1090 * iget_locked - obtain an inode from a mounted file system
1091 * @sb: super block of file system
1092 * @ino: inode number to get
1093 *
1094 * Search for the inode specified by @ino in the inode cache and if present
1095 * return it with an increased reference count. This is for file systems
1096 * where the inode number is sufficient for unique identification of an inode.
1097 *
1098 * If the inode is not in cache, allocate a new inode and return it locked,
1099 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1100 * before unlocking it via unlock_new_inode().
1da177e4 1101 */
0b2d0724 1102struct inode *iget_locked(struct super_block *sb, unsigned long ino)
1da177e4 1103{
0b2d0724 1104 struct hlist_head *head = inode_hashtable + hash(sb, ino);
6b3304b5 1105 struct inode *inode;
2864f301 1106again:
0b2d0724
CH
1107 spin_lock(&inode_hash_lock);
1108 inode = find_inode_fast(sb, head, ino);
1109 spin_unlock(&inode_hash_lock);
1110 if (inode) {
1111 wait_on_inode(inode);
2864f301
AV
1112 if (unlikely(inode_unhashed(inode))) {
1113 iput(inode);
1114 goto again;
1115 }
0b2d0724
CH
1116 return inode;
1117 }
1118
1da177e4
LT
1119 inode = alloc_inode(sb);
1120 if (inode) {
6b3304b5 1121 struct inode *old;
1da177e4 1122
67a23c49 1123 spin_lock(&inode_hash_lock);
1da177e4
LT
1124 /* We released the lock, so.. */
1125 old = find_inode_fast(sb, head, ino);
1126 if (!old) {
1127 inode->i_ino = ino;
250df6ed
DC
1128 spin_lock(&inode->i_lock);
1129 inode->i_state = I_NEW;
646ec461 1130 hlist_add_head(&inode->i_hash, head);
250df6ed 1131 spin_unlock(&inode->i_lock);
55fa6091 1132 inode_sb_list_add(inode);
67a23c49 1133 spin_unlock(&inode_hash_lock);
1da177e4
LT
1134
1135 /* Return the locked inode with I_NEW set, the
1136 * caller is responsible for filling in the contents
1137 */
1138 return inode;
1139 }
1140
1141 /*
1142 * Uhhuh, somebody else created the same inode under
1143 * us. Use the old inode instead of the one we just
1144 * allocated.
1145 */
67a23c49 1146 spin_unlock(&inode_hash_lock);
1da177e4
LT
1147 destroy_inode(inode);
1148 inode = old;
1149 wait_on_inode(inode);
2864f301
AV
1150 if (unlikely(inode_unhashed(inode))) {
1151 iput(inode);
1152 goto again;
1153 }
1da177e4
LT
1154 }
1155 return inode;
1156}
0b2d0724 1157EXPORT_SYMBOL(iget_locked);
1da177e4 1158
ad5e195a
CH
1159/*
1160 * search the inode cache for a matching inode number.
1161 * If we find one, then the inode number we are trying to
1162 * allocate is not unique and so we should not use it.
1163 *
1164 * Returns 1 if the inode number is unique, 0 if it is not.
1165 */
1166static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1167{
1168 struct hlist_head *b = inode_hashtable + hash(sb, ino);
ad5e195a
CH
1169 struct inode *inode;
1170
67a23c49 1171 spin_lock(&inode_hash_lock);
b67bfe0d 1172 hlist_for_each_entry(inode, b, i_hash) {
67a23c49
DC
1173 if (inode->i_ino == ino && inode->i_sb == sb) {
1174 spin_unlock(&inode_hash_lock);
ad5e195a 1175 return 0;
67a23c49 1176 }
ad5e195a 1177 }
67a23c49 1178 spin_unlock(&inode_hash_lock);
ad5e195a
CH
1179
1180 return 1;
1181}
1182
1da177e4
LT
1183/**
1184 * iunique - get a unique inode number
1185 * @sb: superblock
1186 * @max_reserved: highest reserved inode number
1187 *
1188 * Obtain an inode number that is unique on the system for a given
1189 * superblock. This is used by file systems that have no natural
1190 * permanent inode numbering system. An inode number is returned that
1191 * is higher than the reserved limit but unique.
1192 *
1193 * BUGS:
1194 * With a large number of inodes live on the file system this function
1195 * currently becomes quite slow.
1196 */
1197ino_t iunique(struct super_block *sb, ino_t max_reserved)
1198{
866b04fc
JL
1199 /*
1200 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1201 * error if st_ino won't fit in target struct field. Use 32bit counter
1202 * here to attempt to avoid that.
1203 */
ad5e195a 1204 static DEFINE_SPINLOCK(iunique_lock);
866b04fc 1205 static unsigned int counter;
1da177e4 1206 ino_t res;
3361c7be 1207
ad5e195a 1208 spin_lock(&iunique_lock);
3361c7be
JL
1209 do {
1210 if (counter <= max_reserved)
1211 counter = max_reserved + 1;
1da177e4 1212 res = counter++;
ad5e195a
CH
1213 } while (!test_inode_iunique(sb, res));
1214 spin_unlock(&iunique_lock);
1da177e4 1215
3361c7be
JL
1216 return res;
1217}
1da177e4
LT
1218EXPORT_SYMBOL(iunique);
1219
1220struct inode *igrab(struct inode *inode)
1221{
250df6ed
DC
1222 spin_lock(&inode->i_lock);
1223 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
1da177e4 1224 __iget(inode);
250df6ed
DC
1225 spin_unlock(&inode->i_lock);
1226 } else {
1227 spin_unlock(&inode->i_lock);
1da177e4
LT
1228 /*
1229 * Handle the case where s_op->clear_inode is not been
1230 * called yet, and somebody is calling igrab
1231 * while the inode is getting freed.
1232 */
1233 inode = NULL;
250df6ed 1234 }
1da177e4
LT
1235 return inode;
1236}
1da177e4
LT
1237EXPORT_SYMBOL(igrab);
1238
1239/**
0b2d0724 1240 * ilookup5_nowait - search for an inode in the inode cache
1da177e4 1241 * @sb: super block of file system to search
0b2d0724 1242 * @hashval: hash value (usually inode number) to search for
1da177e4
LT
1243 * @test: callback used for comparisons between inodes
1244 * @data: opaque data pointer to pass to @test
1da177e4 1245 *
0b2d0724 1246 * Search for the inode specified by @hashval and @data in the inode cache.
1da177e4
LT
1247 * If the inode is in the cache, the inode is returned with an incremented
1248 * reference count.
1249 *
0b2d0724
CH
1250 * Note: I_NEW is not waited upon so you have to be very careful what you do
1251 * with the returned inode. You probably should be using ilookup5() instead.
1da177e4 1252 *
b6d0ad68 1253 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
1da177e4 1254 */
0b2d0724
CH
1255struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1256 int (*test)(struct inode *, void *), void *data)
1da177e4 1257{
0b2d0724 1258 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1da177e4
LT
1259 struct inode *inode;
1260
67a23c49 1261 spin_lock(&inode_hash_lock);
1da177e4 1262 inode = find_inode(sb, head, test, data);
67a23c49 1263 spin_unlock(&inode_hash_lock);
88bd5121 1264
0b2d0724 1265 return inode;
88bd5121 1266}
88bd5121
AA
1267EXPORT_SYMBOL(ilookup5_nowait);
1268
1269/**
1270 * ilookup5 - search for an inode in the inode cache
1271 * @sb: super block of file system to search
1272 * @hashval: hash value (usually inode number) to search for
1273 * @test: callback used for comparisons between inodes
1274 * @data: opaque data pointer to pass to @test
1275 *
0b2d0724
CH
1276 * Search for the inode specified by @hashval and @data in the inode cache,
1277 * and if the inode is in the cache, return the inode with an incremented
1278 * reference count. Waits on I_NEW before returning the inode.
88bd5121 1279 * returned with an incremented reference count.
1da177e4 1280 *
0b2d0724
CH
1281 * This is a generalized version of ilookup() for file systems where the
1282 * inode number is not sufficient for unique identification of an inode.
1da177e4 1283 *
0b2d0724 1284 * Note: @test is called with the inode_hash_lock held, so can't sleep.
1da177e4
LT
1285 */
1286struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1287 int (*test)(struct inode *, void *), void *data)
1288{
2864f301
AV
1289 struct inode *inode;
1290again:
1291 inode = ilookup5_nowait(sb, hashval, test, data);
1292 if (inode) {
0b2d0724 1293 wait_on_inode(inode);
2864f301
AV
1294 if (unlikely(inode_unhashed(inode))) {
1295 iput(inode);
1296 goto again;
1297 }
1298 }
0b2d0724 1299 return inode;
1da177e4 1300}
1da177e4
LT
1301EXPORT_SYMBOL(ilookup5);
1302
1303/**
1304 * ilookup - search for an inode in the inode cache
1305 * @sb: super block of file system to search
1306 * @ino: inode number to search for
1307 *
0b2d0724
CH
1308 * Search for the inode @ino in the inode cache, and if the inode is in the
1309 * cache, the inode is returned with an incremented reference count.
1da177e4
LT
1310 */
1311struct inode *ilookup(struct super_block *sb, unsigned long ino)
1312{
1313 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1da177e4 1314 struct inode *inode;
2864f301 1315again:
0b2d0724
CH
1316 spin_lock(&inode_hash_lock);
1317 inode = find_inode_fast(sb, head, ino);
1318 spin_unlock(&inode_hash_lock);
1da177e4 1319
2864f301 1320 if (inode) {
0b2d0724 1321 wait_on_inode(inode);
2864f301
AV
1322 if (unlikely(inode_unhashed(inode))) {
1323 iput(inode);
1324 goto again;
1325 }
1326 }
0b2d0724 1327 return inode;
1da177e4 1328}
0b2d0724 1329EXPORT_SYMBOL(ilookup);
1da177e4 1330
fe032c42
TT
1331/**
1332 * find_inode_nowait - find an inode in the inode cache
1333 * @sb: super block of file system to search
1334 * @hashval: hash value (usually inode number) to search for
1335 * @match: callback used for comparisons between inodes
1336 * @data: opaque data pointer to pass to @match
1337 *
1338 * Search for the inode specified by @hashval and @data in the inode
1339 * cache, where the helper function @match will return 0 if the inode
1340 * does not match, 1 if the inode does match, and -1 if the search
1341 * should be stopped. The @match function must be responsible for
1342 * taking the i_lock spin_lock and checking i_state for an inode being
1343 * freed or being initialized, and incrementing the reference count
1344 * before returning 1. It also must not sleep, since it is called with
1345 * the inode_hash_lock spinlock held.
1346 *
1347 * This is a even more generalized version of ilookup5() when the
1348 * function must never block --- find_inode() can block in
1349 * __wait_on_freeing_inode() --- or when the caller can not increment
1350 * the reference count because the resulting iput() might cause an
1351 * inode eviction. The tradeoff is that the @match funtion must be
1352 * very carefully implemented.
1353 */
1354struct inode *find_inode_nowait(struct super_block *sb,
1355 unsigned long hashval,
1356 int (*match)(struct inode *, unsigned long,
1357 void *),
1358 void *data)
1359{
1360 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1361 struct inode *inode, *ret_inode = NULL;
1362 int mval;
1363
1364 spin_lock(&inode_hash_lock);
1365 hlist_for_each_entry(inode, head, i_hash) {
1366 if (inode->i_sb != sb)
1367 continue;
1368 mval = match(inode, hashval, data);
1369 if (mval == 0)
1370 continue;
1371 if (mval == 1)
1372 ret_inode = inode;
1373 goto out;
1374 }
1375out:
1376 spin_unlock(&inode_hash_lock);
1377 return ret_inode;
1378}
1379EXPORT_SYMBOL(find_inode_nowait);
1380
261bca86
AV
1381int insert_inode_locked(struct inode *inode)
1382{
1383 struct super_block *sb = inode->i_sb;
1384 ino_t ino = inode->i_ino;
1385 struct hlist_head *head = inode_hashtable + hash(sb, ino);
261bca86 1386
261bca86 1387 while (1) {
72a43d63 1388 struct inode *old = NULL;
67a23c49 1389 spin_lock(&inode_hash_lock);
b67bfe0d 1390 hlist_for_each_entry(old, head, i_hash) {
72a43d63
AV
1391 if (old->i_ino != ino)
1392 continue;
1393 if (old->i_sb != sb)
1394 continue;
250df6ed
DC
1395 spin_lock(&old->i_lock);
1396 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1397 spin_unlock(&old->i_lock);
72a43d63 1398 continue;
250df6ed 1399 }
72a43d63
AV
1400 break;
1401 }
b67bfe0d 1402 if (likely(!old)) {
250df6ed
DC
1403 spin_lock(&inode->i_lock);
1404 inode->i_state |= I_NEW;
261bca86 1405 hlist_add_head(&inode->i_hash, head);
250df6ed 1406 spin_unlock(&inode->i_lock);
67a23c49 1407 spin_unlock(&inode_hash_lock);
261bca86
AV
1408 return 0;
1409 }
1410 __iget(old);
250df6ed 1411 spin_unlock(&old->i_lock);
67a23c49 1412 spin_unlock(&inode_hash_lock);
261bca86 1413 wait_on_inode(old);
1d3382cb 1414 if (unlikely(!inode_unhashed(old))) {
261bca86
AV
1415 iput(old);
1416 return -EBUSY;
1417 }
1418 iput(old);
1419 }
1420}
261bca86
AV
1421EXPORT_SYMBOL(insert_inode_locked);
1422
1423int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1424 int (*test)(struct inode *, void *), void *data)
1425{
1426 struct super_block *sb = inode->i_sb;
1427 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
261bca86 1428
261bca86 1429 while (1) {
72a43d63
AV
1430 struct inode *old = NULL;
1431
67a23c49 1432 spin_lock(&inode_hash_lock);
b67bfe0d 1433 hlist_for_each_entry(old, head, i_hash) {
72a43d63
AV
1434 if (old->i_sb != sb)
1435 continue;
1436 if (!test(old, data))
1437 continue;
250df6ed
DC
1438 spin_lock(&old->i_lock);
1439 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1440 spin_unlock(&old->i_lock);
72a43d63 1441 continue;
250df6ed 1442 }
72a43d63
AV
1443 break;
1444 }
b67bfe0d 1445 if (likely(!old)) {
250df6ed
DC
1446 spin_lock(&inode->i_lock);
1447 inode->i_state |= I_NEW;
261bca86 1448 hlist_add_head(&inode->i_hash, head);
250df6ed 1449 spin_unlock(&inode->i_lock);
67a23c49 1450 spin_unlock(&inode_hash_lock);
261bca86
AV
1451 return 0;
1452 }
1453 __iget(old);
250df6ed 1454 spin_unlock(&old->i_lock);
67a23c49 1455 spin_unlock(&inode_hash_lock);
261bca86 1456 wait_on_inode(old);
1d3382cb 1457 if (unlikely(!inode_unhashed(old))) {
261bca86
AV
1458 iput(old);
1459 return -EBUSY;
1460 }
1461 iput(old);
1462 }
1463}
261bca86
AV
1464EXPORT_SYMBOL(insert_inode_locked4);
1465
1da177e4 1466
45321ac5
AV
1467int generic_delete_inode(struct inode *inode)
1468{
1469 return 1;
1470}
1471EXPORT_SYMBOL(generic_delete_inode);
1472
45321ac5
AV
1473/*
1474 * Called when we're dropping the last reference
1475 * to an inode.
22fe4042 1476 *
45321ac5
AV
1477 * Call the FS "drop_inode()" function, defaulting to
1478 * the legacy UNIX filesystem behaviour. If it tells
1479 * us to evict inode, do so. Otherwise, retain inode
1480 * in cache if fs is alive, sync and evict if fs is
1481 * shutting down.
22fe4042 1482 */
45321ac5 1483static void iput_final(struct inode *inode)
1da177e4
LT
1484{
1485 struct super_block *sb = inode->i_sb;
45321ac5
AV
1486 const struct super_operations *op = inode->i_sb->s_op;
1487 int drop;
1488
250df6ed
DC
1489 WARN_ON(inode->i_state & I_NEW);
1490
e7f59097 1491 if (op->drop_inode)
45321ac5
AV
1492 drop = op->drop_inode(inode);
1493 else
1494 drop = generic_drop_inode(inode);
1da177e4 1495
1751e8a6 1496 if (!drop && (sb->s_flags & SB_ACTIVE)) {
4eff96dd 1497 inode_add_lru(inode);
b2b2af8e 1498 spin_unlock(&inode->i_lock);
b2b2af8e
DC
1499 return;
1500 }
1501
45321ac5 1502 if (!drop) {
991114c6 1503 inode->i_state |= I_WILL_FREE;
250df6ed 1504 spin_unlock(&inode->i_lock);
1da177e4 1505 write_inode_now(inode, 1);
250df6ed 1506 spin_lock(&inode->i_lock);
7ef0d737 1507 WARN_ON(inode->i_state & I_NEW);
991114c6 1508 inode->i_state &= ~I_WILL_FREE;
1da177e4 1509 }
7ccf19a8 1510
991114c6 1511 inode->i_state |= I_FREEING;
c4ae0c65
ED
1512 if (!list_empty(&inode->i_lru))
1513 inode_lru_list_del(inode);
b2b2af8e 1514 spin_unlock(&inode->i_lock);
b2b2af8e 1515
644da596 1516 evict(inode);
1da177e4
LT
1517}
1518
1da177e4 1519/**
6b3304b5 1520 * iput - put an inode
1da177e4
LT
1521 * @inode: inode to put
1522 *
1523 * Puts an inode, dropping its usage count. If the inode use count hits
1524 * zero, the inode is then freed and may also be destroyed.
1525 *
1526 * Consequently, iput() can sleep.
1527 */
1528void iput(struct inode *inode)
1529{
0ae45f63
TT
1530 if (!inode)
1531 return;
1532 BUG_ON(inode->i_state & I_CLEAR);
1533retry:
1534 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1535 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1536 atomic_inc(&inode->i_count);
1537 inode->i_state &= ~I_DIRTY_TIME;
1538 spin_unlock(&inode->i_lock);
1539 trace_writeback_lazytime_iput(inode);
1540 mark_inode_dirty_sync(inode);
1541 goto retry;
1542 }
1543 iput_final(inode);
1da177e4
LT
1544 }
1545}
1da177e4
LT
1546EXPORT_SYMBOL(iput);
1547
1548/**
1549 * bmap - find a block number in a file
1550 * @inode: inode of file
1551 * @block: block to find
1552 *
1553 * Returns the block number on the device holding the inode that
1554 * is the disk block number for the block of the file requested.
1555 * That is, asked for block 4 of inode 1 the function will return the
6b3304b5 1556 * disk block relative to the disk start that holds that block of the
1da177e4
LT
1557 * file.
1558 */
6b3304b5 1559sector_t bmap(struct inode *inode, sector_t block)
1da177e4
LT
1560{
1561 sector_t res = 0;
1562 if (inode->i_mapping->a_ops->bmap)
1563 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1564 return res;
1565}
1da177e4
LT
1566EXPORT_SYMBOL(bmap);
1567
598e3c8f
MS
1568/*
1569 * Update times in overlayed inode from underlying real inode
1570 */
1571static void update_ovl_inode_times(struct dentry *dentry, struct inode *inode,
1572 bool rcu)
1573{
cd91304e 1574 struct dentry *upperdentry;
598e3c8f 1575
cd91304e
MS
1576 /*
1577 * Nothing to do if in rcu or if non-overlayfs
1578 */
1579 if (rcu || likely(!(dentry->d_flags & DCACHE_OP_REAL)))
1580 return;
1581
1582 upperdentry = d_real(dentry, NULL, 0, D_REAL_UPPER);
1583
1584 /*
1585 * If file is on lower then we can't update atime, so no worries about
1586 * stale mtime/ctime.
1587 */
1588 if (upperdentry) {
1589 struct inode *realinode = d_inode(upperdentry);
1590
1591 if ((!timespec_equal(&inode->i_mtime, &realinode->i_mtime) ||
598e3c8f
MS
1592 !timespec_equal(&inode->i_ctime, &realinode->i_ctime))) {
1593 inode->i_mtime = realinode->i_mtime;
1594 inode->i_ctime = realinode->i_ctime;
1595 }
1596 }
1597}
1598
11ff6f05
MG
1599/*
1600 * With relative atime, only update atime if the previous atime is
1601 * earlier than either the ctime or mtime or if at least a day has
1602 * passed since the last atime update.
1603 */
598e3c8f
MS
1604static int relatime_need_update(const struct path *path, struct inode *inode,
1605 struct timespec now, bool rcu)
11ff6f05
MG
1606{
1607
598e3c8f 1608 if (!(path->mnt->mnt_flags & MNT_RELATIME))
11ff6f05 1609 return 1;
598e3c8f
MS
1610
1611 update_ovl_inode_times(path->dentry, inode, rcu);
11ff6f05
MG
1612 /*
1613 * Is mtime younger than atime? If yes, update atime:
1614 */
1615 if (timespec_compare(&inode->i_mtime, &inode->i_atime) >= 0)
1616 return 1;
1617 /*
1618 * Is ctime younger than atime? If yes, update atime:
1619 */
1620 if (timespec_compare(&inode->i_ctime, &inode->i_atime) >= 0)
1621 return 1;
1622
1623 /*
1624 * Is the previous atime value older than a day? If yes,
1625 * update atime:
1626 */
1627 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1628 return 1;
1629 /*
1630 * Good, we can skip the atime update:
1631 */
1632 return 0;
1633}
1634
0ae45f63 1635int generic_update_time(struct inode *inode, struct timespec *time, int flags)
c3b2da31 1636{
0ae45f63 1637 int iflags = I_DIRTY_TIME;
c3b2da31
JB
1638
1639 if (flags & S_ATIME)
1640 inode->i_atime = *time;
1641 if (flags & S_VERSION)
1642 inode_inc_iversion(inode);
1643 if (flags & S_CTIME)
1644 inode->i_ctime = *time;
1645 if (flags & S_MTIME)
1646 inode->i_mtime = *time;
0ae45f63 1647
1751e8a6 1648 if (!(inode->i_sb->s_flags & SB_LAZYTIME) || (flags & S_VERSION))
0ae45f63
TT
1649 iflags |= I_DIRTY_SYNC;
1650 __mark_inode_dirty(inode, iflags);
c3b2da31
JB
1651 return 0;
1652}
0ae45f63
TT
1653EXPORT_SYMBOL(generic_update_time);
1654
1655/*
1656 * This does the actual work of updating an inodes time or version. Must have
1657 * had called mnt_want_write() before calling this.
1658 */
c088e31d 1659int update_time(struct inode *inode, struct timespec *time, int flags)
0ae45f63
TT
1660{
1661 int (*update_time)(struct inode *, struct timespec *, int);
1662
1663 update_time = inode->i_op->update_time ? inode->i_op->update_time :
1664 generic_update_time;
1665
1666 return update_time(inode, time, flags);
1667}
c088e31d 1668EXPORT_SYMBOL_GPL(update_time);
c3b2da31 1669
1da177e4 1670/**
869243a0 1671 * touch_atime - update the access time
185553b2 1672 * @path: the &struct path to update
30fdc8ee 1673 * @inode: inode to update
1da177e4
LT
1674 *
1675 * Update the accessed time on an inode and mark it for writeback.
1676 * This function automatically handles read only file systems and media,
1677 * as well as the "noatime" flag and inode specific "noatime" markers.
1678 */
598e3c8f
MS
1679bool __atime_needs_update(const struct path *path, struct inode *inode,
1680 bool rcu)
1da177e4 1681{
68ac1234 1682 struct vfsmount *mnt = path->mnt;
1da177e4
LT
1683 struct timespec now;
1684
cdb70f3f 1685 if (inode->i_flags & S_NOATIME)
8fa9dd24 1686 return false;
0bd23d09
EB
1687
1688 /* Atime updates will likely cause i_uid and i_gid to be written
1689 * back improprely if their true value is unknown to the vfs.
1690 */
1691 if (HAS_UNMAPPED_ID(inode))
1692 return false;
1693
37756ced 1694 if (IS_NOATIME(inode))
8fa9dd24 1695 return false;
1751e8a6 1696 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
8fa9dd24 1697 return false;
47ae32d6 1698
cdb70f3f 1699 if (mnt->mnt_flags & MNT_NOATIME)
8fa9dd24 1700 return false;
cdb70f3f 1701 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
8fa9dd24 1702 return false;
1da177e4 1703
c2050a45 1704 now = current_time(inode);
11ff6f05 1705
598e3c8f 1706 if (!relatime_need_update(path, inode, now, rcu))
8fa9dd24 1707 return false;
11ff6f05 1708
47ae32d6 1709 if (timespec_equal(&inode->i_atime, &now))
8fa9dd24
N
1710 return false;
1711
1712 return true;
1713}
1714
1715void touch_atime(const struct path *path)
1716{
1717 struct vfsmount *mnt = path->mnt;
1718 struct inode *inode = d_inode(path->dentry);
1719 struct timespec now;
1720
598e3c8f 1721 if (!__atime_needs_update(path, inode, false))
b12536c2
AK
1722 return;
1723
5d37e9e6 1724 if (!sb_start_write_trylock(inode->i_sb))
b12536c2 1725 return;
47ae32d6 1726
8fa9dd24 1727 if (__mnt_want_write(mnt) != 0)
5d37e9e6 1728 goto skip_update;
c3b2da31
JB
1729 /*
1730 * File systems can error out when updating inodes if they need to
1731 * allocate new space to modify an inode (such is the case for
1732 * Btrfs), but since we touch atime while walking down the path we
1733 * really don't care if we failed to update the atime of the file,
1734 * so just ignore the return value.
2bc55652
AB
1735 * We may also fail on filesystems that have the ability to make parts
1736 * of the fs read only, e.g. subvolumes in Btrfs.
c3b2da31 1737 */
c2050a45 1738 now = current_time(inode);
c3b2da31 1739 update_time(inode, &now, S_ATIME);
5d37e9e6
JK
1740 __mnt_drop_write(mnt);
1741skip_update:
1742 sb_end_write(inode->i_sb);
1da177e4 1743}
869243a0 1744EXPORT_SYMBOL(touch_atime);
1da177e4 1745
3ed37648
CW
1746/*
1747 * The logic we want is
1748 *
1749 * if suid or (sgid and xgrp)
1750 * remove privs
1751 */
1752int should_remove_suid(struct dentry *dentry)
1753{
8137963e
SF
1754 struct inode *inode = d_inode(dentry);
1755 umode_t mode = inode->i_mode;
3ed37648
CW
1756 int kill = 0;
1757
1758 /* suid always must be killed */
1759 if (unlikely(mode & S_ISUID))
1760 kill = ATTR_KILL_SUID;
1761
1762 /*
1763 * sgid without any exec bits is just a mandatory locking mark; leave
1764 * it alone. If some exec bits are set, it's a real sgid; kill it.
1765 */
1766 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1767 kill |= ATTR_KILL_SGID;
1768
8137963e
SF
1769 if (unlikely(kill && !capable_wrt_inode_uidgid(inode, CAP_FSETID) &&
1770 S_ISREG(mode)))
3ed37648
CW
1771 return kill;
1772
1773 return 0;
1774}
1775EXPORT_SYMBOL(should_remove_suid);
1776
dbfae0cd
JK
1777/*
1778 * Return mask of changes for notify_change() that need to be done as a
1779 * response to write or truncate. Return 0 if nothing has to be changed.
1780 * Negative value on error (change should be denied).
1781 */
45f147a1 1782int dentry_needs_remove_privs(struct dentry *dentry)
dbfae0cd 1783{
dbfae0cd
JK
1784 struct inode *inode = d_inode(dentry);
1785 int mask = 0;
1786 int ret;
1787
1788 if (IS_NOSEC(inode))
1789 return 0;
1790
1791 mask = should_remove_suid(dentry);
1792 ret = security_inode_need_killpriv(dentry);
1793 if (ret < 0)
1794 return ret;
1795 if (ret)
1796 mask |= ATTR_KILL_PRIV;
1797 return mask;
1798}
dbfae0cd
JK
1799
1800static int __remove_privs(struct dentry *dentry, int kill)
3ed37648
CW
1801{
1802 struct iattr newattrs;
1803
1804 newattrs.ia_valid = ATTR_FORCE | kill;
27ac0ffe
BF
1805 /*
1806 * Note we call this on write, so notify_change will not
1807 * encounter any conflicting delegations:
1808 */
1809 return notify_change(dentry, &newattrs, NULL);
3ed37648
CW
1810}
1811
5fa8e0a1
JK
1812/*
1813 * Remove special file priviledges (suid, capabilities) when file is written
1814 * to or truncated.
1815 */
1816int file_remove_privs(struct file *file)
3ed37648 1817{
c1892c37
MS
1818 struct dentry *dentry = file_dentry(file);
1819 struct inode *inode = file_inode(file);
dbfae0cd 1820 int kill;
3ed37648
CW
1821 int error = 0;
1822
1823 /* Fast path for nothing security related */
1824 if (IS_NOSEC(inode))
1825 return 0;
1826
c1892c37 1827 kill = dentry_needs_remove_privs(dentry);
dbfae0cd
JK
1828 if (kill < 0)
1829 return kill;
1830 if (kill)
1831 error = __remove_privs(dentry, kill);
2426f391
JK
1832 if (!error)
1833 inode_has_no_xattr(inode);
3ed37648
CW
1834
1835 return error;
1836}
5fa8e0a1 1837EXPORT_SYMBOL(file_remove_privs);
3ed37648 1838
1da177e4 1839/**
870f4817
CH
1840 * file_update_time - update mtime and ctime time
1841 * @file: file accessed
1da177e4 1842 *
870f4817
CH
1843 * Update the mtime and ctime members of an inode and mark the inode
1844 * for writeback. Note that this function is meant exclusively for
1845 * usage in the file write path of filesystems, and filesystems may
1846 * choose to explicitly ignore update via this function with the
2eadfc0e 1847 * S_NOCMTIME inode flag, e.g. for network filesystem where these
c3b2da31
JB
1848 * timestamps are handled by the server. This can return an error for
1849 * file systems who need to allocate space in order to update an inode.
1da177e4
LT
1850 */
1851
c3b2da31 1852int file_update_time(struct file *file)
1da177e4 1853{
496ad9aa 1854 struct inode *inode = file_inode(file);
1da177e4 1855 struct timespec now;
c3b2da31
JB
1856 int sync_it = 0;
1857 int ret;
1da177e4 1858
ce06e0b2 1859 /* First try to exhaust all avenues to not sync */
1da177e4 1860 if (IS_NOCMTIME(inode))
c3b2da31 1861 return 0;
20ddee2c 1862
c2050a45 1863 now = current_time(inode);
ce06e0b2
AK
1864 if (!timespec_equal(&inode->i_mtime, &now))
1865 sync_it = S_MTIME;
1da177e4 1866
ce06e0b2
AK
1867 if (!timespec_equal(&inode->i_ctime, &now))
1868 sync_it |= S_CTIME;
870f4817 1869
ce06e0b2
AK
1870 if (IS_I_VERSION(inode))
1871 sync_it |= S_VERSION;
7a224228 1872
ce06e0b2 1873 if (!sync_it)
c3b2da31 1874 return 0;
ce06e0b2
AK
1875
1876 /* Finally allowed to write? Takes lock. */
eb04c282 1877 if (__mnt_want_write_file(file))
c3b2da31 1878 return 0;
ce06e0b2 1879
c3b2da31 1880 ret = update_time(inode, &now, sync_it);
eb04c282 1881 __mnt_drop_write_file(file);
c3b2da31
JB
1882
1883 return ret;
1da177e4 1884}
870f4817 1885EXPORT_SYMBOL(file_update_time);
1da177e4
LT
1886
1887int inode_needs_sync(struct inode *inode)
1888{
1889 if (IS_SYNC(inode))
1890 return 1;
1891 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1892 return 1;
1893 return 0;
1894}
1da177e4
LT
1895EXPORT_SYMBOL(inode_needs_sync);
1896
1da177e4 1897/*
168a9fd6
MS
1898 * If we try to find an inode in the inode hash while it is being
1899 * deleted, we have to wait until the filesystem completes its
1900 * deletion before reporting that it isn't found. This function waits
1901 * until the deletion _might_ have completed. Callers are responsible
1902 * to recheck inode state.
1903 *
eaff8079 1904 * It doesn't matter if I_NEW is not set initially, a call to
250df6ed
DC
1905 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
1906 * will DTRT.
1da177e4
LT
1907 */
1908static void __wait_on_freeing_inode(struct inode *inode)
1909{
1910 wait_queue_head_t *wq;
eaff8079
CH
1911 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1912 wq = bit_waitqueue(&inode->i_state, __I_NEW);
21417136 1913 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
250df6ed 1914 spin_unlock(&inode->i_lock);
67a23c49 1915 spin_unlock(&inode_hash_lock);
1da177e4 1916 schedule();
21417136 1917 finish_wait(wq, &wait.wq_entry);
67a23c49 1918 spin_lock(&inode_hash_lock);
1da177e4
LT
1919}
1920
1da177e4
LT
1921static __initdata unsigned long ihash_entries;
1922static int __init set_ihash_entries(char *str)
1923{
1924 if (!str)
1925 return 0;
1926 ihash_entries = simple_strtoul(str, &str, 0);
1927 return 1;
1928}
1929__setup("ihash_entries=", set_ihash_entries);
1930
1931/*
1932 * Initialize the waitqueues and inode hash table.
1933 */
1934void __init inode_init_early(void)
1935{
1da177e4
LT
1936 /* If hashes are distributed across NUMA nodes, defer
1937 * hash allocation until vmalloc space is available.
1938 */
1939 if (hashdist)
1940 return;
1941
1942 inode_hashtable =
1943 alloc_large_system_hash("Inode-cache",
1944 sizeof(struct hlist_head),
1945 ihash_entries,
1946 14,
3d375d78 1947 HASH_EARLY | HASH_ZERO,
1da177e4
LT
1948 &i_hash_shift,
1949 &i_hash_mask,
31fe62b9 1950 0,
1da177e4 1951 0);
1da177e4
LT
1952}
1953
74bf17cf 1954void __init inode_init(void)
1da177e4 1955{
1da177e4 1956 /* inode slab cache */
b0196009
PJ
1957 inode_cachep = kmem_cache_create("inode_cache",
1958 sizeof(struct inode),
1959 0,
1960 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
5d097056 1961 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
20c2df83 1962 init_once);
1da177e4
LT
1963
1964 /* Hash may have been set up in inode_init_early */
1965 if (!hashdist)
1966 return;
1967
1968 inode_hashtable =
1969 alloc_large_system_hash("Inode-cache",
1970 sizeof(struct hlist_head),
1971 ihash_entries,
1972 14,
3d375d78 1973 HASH_ZERO,
1da177e4
LT
1974 &i_hash_shift,
1975 &i_hash_mask,
31fe62b9 1976 0,
1da177e4 1977 0);
1da177e4
LT
1978}
1979
1980void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
1981{
1982 inode->i_mode = mode;
1983 if (S_ISCHR(mode)) {
1984 inode->i_fop = &def_chr_fops;
1985 inode->i_rdev = rdev;
1986 } else if (S_ISBLK(mode)) {
1987 inode->i_fop = &def_blk_fops;
1988 inode->i_rdev = rdev;
1989 } else if (S_ISFIFO(mode))
599a0ac1 1990 inode->i_fop = &pipefifo_fops;
1da177e4 1991 else if (S_ISSOCK(mode))
bd9b51e7 1992 ; /* leave it no_open_fops */
1da177e4 1993 else
af0d9ae8
MK
1994 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
1995 " inode %s:%lu\n", mode, inode->i_sb->s_id,
1996 inode->i_ino);
1da177e4
LT
1997}
1998EXPORT_SYMBOL(init_special_inode);
a1bd120d
DM
1999
2000/**
eaae668d 2001 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
a1bd120d
DM
2002 * @inode: New inode
2003 * @dir: Directory inode
2004 * @mode: mode of the new inode
2005 */
2006void inode_init_owner(struct inode *inode, const struct inode *dir,
62bb1091 2007 umode_t mode)
a1bd120d
DM
2008{
2009 inode->i_uid = current_fsuid();
2010 if (dir && dir->i_mode & S_ISGID) {
2011 inode->i_gid = dir->i_gid;
ebd8ccf8
LT
2012
2013 /* Directories are special, and always inherit S_ISGID */
a1bd120d
DM
2014 if (S_ISDIR(mode))
2015 mode |= S_ISGID;
ebd8ccf8
LT
2016 else if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP) &&
2017 !in_group_p(inode->i_gid) &&
2018 !capable_wrt_inode_uidgid(dir, CAP_FSETID))
2019 mode &= ~S_ISGID;
a1bd120d
DM
2020 } else
2021 inode->i_gid = current_fsgid();
2022 inode->i_mode = mode;
2023}
2024EXPORT_SYMBOL(inode_init_owner);
e795b717 2025
2e149670
SH
2026/**
2027 * inode_owner_or_capable - check current task permissions to inode
2028 * @inode: inode being checked
2029 *
23adbe12
AL
2030 * Return true if current either has CAP_FOWNER in a namespace with the
2031 * inode owner uid mapped, or owns the file.
e795b717 2032 */
2e149670 2033bool inode_owner_or_capable(const struct inode *inode)
e795b717 2034{
23adbe12
AL
2035 struct user_namespace *ns;
2036
92361636 2037 if (uid_eq(current_fsuid(), inode->i_uid))
e795b717 2038 return true;
23adbe12
AL
2039
2040 ns = current_user_ns();
cc658db4 2041 if (kuid_has_mapping(ns, inode->i_uid) && ns_capable(ns, CAP_FOWNER))
e795b717
SH
2042 return true;
2043 return false;
2044}
2e149670 2045EXPORT_SYMBOL(inode_owner_or_capable);
1d59d61f
TM
2046
2047/*
2048 * Direct i/o helper functions
2049 */
2050static void __inode_dio_wait(struct inode *inode)
2051{
2052 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2053 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2054
2055 do {
21417136 2056 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
1d59d61f
TM
2057 if (atomic_read(&inode->i_dio_count))
2058 schedule();
2059 } while (atomic_read(&inode->i_dio_count));
21417136 2060 finish_wait(wq, &q.wq_entry);
1d59d61f
TM
2061}
2062
2063/**
2064 * inode_dio_wait - wait for outstanding DIO requests to finish
2065 * @inode: inode to wait for
2066 *
2067 * Waits for all pending direct I/O requests to finish so that we can
2068 * proceed with a truncate or equivalent operation.
2069 *
2070 * Must be called under a lock that serializes taking new references
2071 * to i_dio_count, usually by inode->i_mutex.
2072 */
2073void inode_dio_wait(struct inode *inode)
2074{
2075 if (atomic_read(&inode->i_dio_count))
2076 __inode_dio_wait(inode);
2077}
2078EXPORT_SYMBOL(inode_dio_wait);
2079
5f16f322
TT
2080/*
2081 * inode_set_flags - atomically set some inode flags
2082 *
2083 * Note: the caller should be holding i_mutex, or else be sure that
2084 * they have exclusive access to the inode structure (i.e., while the
2085 * inode is being instantiated). The reason for the cmpxchg() loop
2086 * --- which wouldn't be necessary if all code paths which modify
2087 * i_flags actually followed this rule, is that there is at least one
5fa8e0a1
JK
2088 * code path which doesn't today so we use cmpxchg() out of an abundance
2089 * of caution.
5f16f322
TT
2090 *
2091 * In the long run, i_mutex is overkill, and we should probably look
2092 * at using the i_lock spinlock to protect i_flags, and then make sure
2093 * it is so documented in include/linux/fs.h and that all code follows
2094 * the locking convention!!
2095 */
2096void inode_set_flags(struct inode *inode, unsigned int flags,
2097 unsigned int mask)
2098{
2099 unsigned int old_flags, new_flags;
2100
2101 WARN_ON_ONCE(flags & ~mask);
2102 do {
6aa7de05 2103 old_flags = READ_ONCE(inode->i_flags);
5f16f322
TT
2104 new_flags = (old_flags & ~mask) | flags;
2105 } while (unlikely(cmpxchg(&inode->i_flags, old_flags,
2106 new_flags) != old_flags));
2107}
2108EXPORT_SYMBOL(inode_set_flags);
21fc61c7
AV
2109
2110void inode_nohighmem(struct inode *inode)
2111{
2112 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2113}
2114EXPORT_SYMBOL(inode_nohighmem);
3cd88666
DD
2115
2116/**
2117 * current_time - Return FS time
2118 * @inode: inode.
2119 *
2120 * Return the current time truncated to the time granularity supported by
2121 * the fs.
2122 *
2123 * Note that inode and inode->sb cannot be NULL.
2124 * Otherwise, the function warns and returns time without truncation.
2125 */
2126struct timespec current_time(struct inode *inode)
2127{
2128 struct timespec now = current_kernel_time();
2129
2130 if (unlikely(!inode->i_sb)) {
2131 WARN(1, "current_time() called with uninitialized super_block in the inode");
2132 return now;
2133 }
2134
2135 return timespec_trunc(now, inode->i_sb->s_time_gran);
2136}
2137EXPORT_SYMBOL(current_time);