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