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