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