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