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