blob: 6b80a51129d56f4175326e1faf1429e4f730f8b9 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * (C) 1997 Linus Torvalds
Christoph Hellwig4b4563d2011-05-27 09:28:01 -04004 * (C) 1999 Andrea Arcangeli <andrea@suse.de> (dynamic inode allocation)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 */
Al Viroe59cc472011-12-07 13:17:19 -05006#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/fs.h>
8#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/hash.h>
11#include <linux/swap.h>
12#include <linux/security.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/cdev.h>
Mike Rapoport57c8a662018-10-30 15:09:49 -070014#include <linux/memblock.h>
Eric Paris3be25f42009-05-21 17:01:26 -040015#include <linux/fsnotify.h>
Christoph Hellwigfc33a7b2006-01-09 20:52:17 -080016#include <linux/mount.h>
Al Virof19d4a82009-06-08 19:50:45 -040017#include <linux/posix_acl.h>
Heiko Carstens9ce6e0b2011-05-22 18:54:21 +020018#include <linux/prefetch.h>
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040019#include <linux/buffer_head.h> /* for inode_has_buffers */
Miklos Szeredi7ada4db2011-11-21 12:11:32 +010020#include <linux/ratelimit.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100021#include <linux/list_lru.h>
Jeff Laytonae5e1652018-01-29 06:41:30 -050022#include <linux/iversion.h>
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050023#include <trace/events/writeback.h>
Dave Chinnera66979a2011-03-22 22:23:41 +110024#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26/*
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040027 * Inode locking rules:
Dave Chinner250df6e2011-03-22 22:23:36 +110028 *
29 * inode->i_lock protects:
30 * inode->i_state, inode->i_hash, __iget()
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100031 * Inode LRU list locks protect:
Dave Chinner98b745c2011-07-08 14:14:39 +100032 * inode->i_sb->s_inode_lru, inode->i_lru
Dave Chinner74278da2015-03-04 12:37:22 -050033 * inode->i_sb->s_inode_list_lock protects:
34 * inode->i_sb->s_inodes, inode->i_sb_list
Christoph Hellwigf758eea2011-04-21 18:19:44 -060035 * bdi->wb.list_lock protects:
Dave Chinnerc7f54082015-03-04 14:07:22 -050036 * bdi->wb.b_{dirty,io,more_io,dirty_time}, inode->i_io_list
Dave Chinner67a23c42011-03-22 22:23:42 +110037 * inode_hash_lock protects:
38 * inode_hashtable, inode->i_hash
Dave Chinner250df6e2011-03-22 22:23:36 +110039 *
40 * Lock ordering:
Dave Chinner55fa6092011-03-22 22:23:40 +110041 *
Dave Chinner74278da2015-03-04 12:37:22 -050042 * inode->i_sb->s_inode_list_lock
Dave Chinner55fa6092011-03-22 22:23:40 +110043 * inode->i_lock
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100044 * Inode LRU list locks
Dave Chinnera66979a2011-03-22 22:23:41 +110045 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060046 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110047 * inode->i_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110048 *
49 * inode_hash_lock
Dave Chinner74278da2015-03-04 12:37:22 -050050 * inode->i_sb->s_inode_list_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110051 * inode->i_lock
52 *
53 * iunique_lock
54 * inode_hash_lock
Dave Chinner250df6e2011-03-22 22:23:36 +110055 */
56
Eric Dumazetfa3536c2006-03-26 01:37:24 -080057static unsigned int i_hash_mask __read_mostly;
58static unsigned int i_hash_shift __read_mostly;
Dave Chinner67a23c42011-03-22 22:23:42 +110059static struct hlist_head *inode_hashtable __read_mostly;
60static __cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Linus Torvalds1da177e2005-04-16 15:20:36 -070062/*
Jens Axboe7dcda1c2011-04-05 23:51:48 +020063 * Empty aops. Can be used for the cases where the user does not
64 * define any of the address_space operations.
65 */
66const struct address_space_operations empty_aops = {
67};
68EXPORT_SYMBOL(empty_aops);
69
70/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 * Statistics gathering..
72 */
73struct inodes_stat_t inodes_stat;
74
Glauber Costa3942c072013-08-28 10:17:53 +100075static DEFINE_PER_CPU(unsigned long, nr_inodes);
76static DEFINE_PER_CPU(unsigned long, nr_unused);
Dave Chinnercffbc8a2010-10-23 05:03:02 -040077
Manish Katiyar6b3304b2009-03-31 19:35:54 +053078static struct kmem_cache *inode_cachep __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Glauber Costa3942c072013-08-28 10:17:53 +100080static long get_nr_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040081{
Nick Piggin3e880fb2011-01-07 17:49:19 +110082 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100083 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +110084 for_each_possible_cpu(i)
85 sum += per_cpu(nr_inodes, i);
86 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040087}
88
Glauber Costa3942c072013-08-28 10:17:53 +100089static inline long get_nr_inodes_unused(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040090{
Dave Chinnerfcb94f72011-07-08 14:14:38 +100091 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100092 long sum = 0;
Dave Chinnerfcb94f72011-07-08 14:14:38 +100093 for_each_possible_cpu(i)
94 sum += per_cpu(nr_unused, i);
95 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040096}
97
Glauber Costa3942c072013-08-28 10:17:53 +100098long get_nr_dirty_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040099{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100100 /* not actually dirty inodes, but a wild approximation */
Glauber Costa3942c072013-08-28 10:17:53 +1000101 long nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400102 return nr_dirty > 0 ? nr_dirty : 0;
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400103}
104
105/*
106 * Handle nr_inode sysctl
107 */
108#ifdef CONFIG_SYSCTL
Joe Perches1f7e0612014-06-06 14:38:05 -0700109int proc_nr_inodes(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +0200110 void *buffer, size_t *lenp, loff_t *ppos)
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400111{
112 inodes_stat.nr_inodes = get_nr_inodes();
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000113 inodes_stat.nr_unused = get_nr_inodes_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000114 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400115}
116#endif
117
Al Virobd9b51e2014-11-18 23:38:21 -0500118static int no_open(struct inode *inode, struct file *file)
119{
120 return -ENXIO;
121}
122
David Chinner2cb15992008-10-30 17:32:23 +1100123/**
Masahiro Yamada6e7c2b42017-05-08 15:57:53 -0700124 * inode_init_always - perform inode structure initialisation
Randy Dunlap0bc02f32009-01-06 14:41:13 -0800125 * @sb: superblock inode belongs to
126 * @inode: inode to initialise
David Chinner2cb15992008-10-30 17:32:23 +1100127 *
128 * These are initializations that need to be done on every inode
129 * allocation as the fields are not initialised by slab allocation.
130 */
Christoph Hellwig54e34622009-08-07 14:38:25 -0300131int inode_init_always(struct super_block *sb, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
Alexey Dobriyan6e1d5dc2009-09-21 17:01:11 -0700133 static const struct inode_operations empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500134 static const struct file_operations no_open_fops = {.open = no_open};
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530135 struct address_space *const mapping = &inode->i_data;
David Chinner2cb15992008-10-30 17:32:23 +1100136
137 inode->i_sb = sb;
138 inode->i_blkbits = sb->s_blocksize_bits;
139 inode->i_flags = 0;
Peter Zijlstra8019ad12020-03-04 11:28:31 +0100140 atomic64_set(&inode->i_sequence, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100141 atomic_set(&inode->i_count, 1);
142 inode->i_op = &empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500143 inode->i_fop = &no_open_fops;
Eric Biggersedbb35c2020-10-30 17:44:20 -0700144 inode->i_ino = 0;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200145 inode->__i_nlink = 1;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700146 inode->i_opflags = 0;
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200147 if (sb->s_xattr)
148 inode->i_opflags |= IOP_XATTR;
Eric W. Biederman92361632012-02-08 07:07:50 -0800149 i_uid_write(inode, 0);
150 i_gid_write(inode, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100151 atomic_set(&inode->i_writecount, 0);
152 inode->i_size = 0;
Jens Axboec75b1d92017-06-27 11:47:04 -0600153 inode->i_write_hint = WRITE_LIFE_NOT_SET;
David Chinner2cb15992008-10-30 17:32:23 +1100154 inode->i_blocks = 0;
155 inode->i_bytes = 0;
156 inode->i_generation = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100157 inode->i_pipe = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100158 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400159 inode->i_link = NULL;
Al Viro84e710d2016-04-15 00:58:55 -0400160 inode->i_dir_seq = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100161 inode->i_rdev = 0;
162 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500163
Tahsin Erdogan3d65ae42016-02-16 13:34:39 -0800164#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
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500170 if (security_inode_alloc(inode))
Christoph Hellwig54e34622009-08-07 14:38:25 -0300171 goto out;
David Chinner2cb15992008-10-30 17:32:23 +1100172 spin_lock_init(&inode->i_lock);
173 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
174
Al Viro9902af72016-04-15 15:08:36 -0400175 init_rwsem(&inode->i_rwsem);
176 lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
David Chinner2cb15992008-10-30 17:32:23 +1100177
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400178 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100179
180 mapping->a_ops = &empty_aops;
181 mapping->host = inode;
182 mapping->flags = 0;
Darrick J. Wong829bc7872018-05-30 19:43:53 -0700183 mapping->wb_err = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700184 atomic_set(&mapping->i_mmap_writable, 0);
Song Liu09d91cd2019-09-23 15:38:03 -0700185#ifdef CONFIG_READ_ONLY_THP_FOR_FS
186 atomic_set(&mapping->nr_thps, 0);
187#endif
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800188 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800189 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100190 mapping->writeback_index = 0;
Sebastian Andrzej Siewior23ca0672021-09-01 10:44:03 +0200191 init_rwsem(&mapping->invalidate_lock);
192 lockdep_set_class_and_name(&mapping->invalidate_lock,
193 &sb->s_type->invalidate_lock_key,
194 "mapping.invalidate_lock");
David Chinner2cb15992008-10-30 17:32:23 +1100195 inode->i_private = NULL;
196 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400197 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400198#ifdef CONFIG_FS_POSIX_ACL
199 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
200#endif
David Chinner2cb15992008-10-30 17:32:23 +1100201
Eric Paris3be25f42009-05-21 17:01:26 -0400202#ifdef CONFIG_FSNOTIFY
203 inode->i_fsnotify_mask = 0;
204#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500205 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100206 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400207
Christoph Hellwig54e34622009-08-07 14:38:25 -0300208 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300209out:
210 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100211}
212EXPORT_SYMBOL(inode_init_always);
213
Al Virofdb0da82019-04-10 14:43:44 -0400214void free_inode_nonrcu(struct inode *inode)
215{
216 kmem_cache_free(inode_cachep, inode);
217}
218EXPORT_SYMBOL(free_inode_nonrcu);
219
220static void i_callback(struct rcu_head *head)
221{
222 struct inode *inode = container_of(head, struct inode, i_rcu);
223 if (inode->free_inode)
224 inode->free_inode(inode);
225 else
226 free_inode_nonrcu(inode);
227}
228
David Chinner2cb15992008-10-30 17:32:23 +1100229static struct inode *alloc_inode(struct super_block *sb)
230{
Al Virofdb0da82019-04-10 14:43:44 -0400231 const struct super_operations *ops = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 struct inode *inode;
233
Al Virofdb0da82019-04-10 14:43:44 -0400234 if (ops->alloc_inode)
235 inode = ops->alloc_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 else
David Chinner2cb15992008-10-30 17:32:23 +1100237 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Christoph Hellwig54e34622009-08-07 14:38:25 -0300239 if (!inode)
240 return NULL;
241
242 if (unlikely(inode_init_always(sb, inode))) {
Al Virofdb0da82019-04-10 14:43:44 -0400243 if (ops->destroy_inode) {
244 ops->destroy_inode(inode);
245 if (!ops->free_inode)
246 return NULL;
247 }
248 inode->free_inode = ops->free_inode;
249 i_callback(&inode->i_rcu);
Christoph Hellwig54e34622009-08-07 14:38:25 -0300250 return NULL;
251 }
252
253 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254}
255
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300256void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200258 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400259 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400261 fsnotify_inode_delete(inode);
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500262 locks_free_lock_context(inode);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100263 if (!inode->i_nlink) {
264 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
265 atomic_long_dec(&inode->i_sb->s_remove_count);
266 }
267
Al Virof19d4a82009-06-08 19:50:45 -0400268#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100269 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400270 posix_acl_release(inode->i_acl);
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100271 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400272 posix_acl_release(inode->i_default_acl);
273#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100274 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300275}
276EXPORT_SYMBOL(__destroy_inode);
277
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200278static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300279{
Al Virofdb0da82019-04-10 14:43:44 -0400280 const struct super_operations *ops = inode->i_sb->s_op;
281
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100282 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300283 __destroy_inode(inode);
Al Virofdb0da82019-04-10 14:43:44 -0400284 if (ops->destroy_inode) {
285 ops->destroy_inode(inode);
286 if (!ops->free_inode)
287 return;
288 }
289 inode->free_inode = ops->free_inode;
290 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100293/**
294 * drop_nlink - directly drop an inode's link count
295 * @inode: inode
296 *
297 * This is a low-level filesystem helper to replace any
298 * direct filesystem manipulation of i_nlink. In cases
299 * where we are attempting to track writes to the
300 * filesystem, a decrement to zero means an imminent
301 * write when the file is truncated and actually unlinked
302 * on the filesystem.
303 */
304void drop_nlink(struct inode *inode)
305{
306 WARN_ON(inode->i_nlink == 0);
307 inode->__i_nlink--;
308 if (!inode->i_nlink)
309 atomic_long_inc(&inode->i_sb->s_remove_count);
310}
311EXPORT_SYMBOL(drop_nlink);
312
313/**
314 * clear_nlink - directly zero an inode's link count
315 * @inode: inode
316 *
317 * This is a low-level filesystem helper to replace any
318 * direct filesystem manipulation of i_nlink. See
319 * drop_nlink() for why we care about i_nlink hitting zero.
320 */
321void clear_nlink(struct inode *inode)
322{
323 if (inode->i_nlink) {
324 inode->__i_nlink = 0;
325 atomic_long_inc(&inode->i_sb->s_remove_count);
326 }
327}
328EXPORT_SYMBOL(clear_nlink);
329
330/**
331 * set_nlink - directly set an inode's link count
332 * @inode: inode
333 * @nlink: new nlink (should be non-zero)
334 *
335 * This is a low-level filesystem helper to replace any
336 * direct filesystem manipulation of i_nlink.
337 */
338void set_nlink(struct inode *inode, unsigned int nlink)
339{
340 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100341 clear_nlink(inode);
342 } else {
343 /* Yes, some filesystems do change nlink from zero to one */
344 if (inode->i_nlink == 0)
345 atomic_long_dec(&inode->i_sb->s_remove_count);
346
347 inode->__i_nlink = nlink;
348 }
349}
350EXPORT_SYMBOL(set_nlink);
351
352/**
353 * inc_nlink - directly increment an inode's link count
354 * @inode: inode
355 *
356 * This is a low-level filesystem helper to replace any
357 * direct filesystem manipulation of i_nlink. Currently,
358 * it is only here for parity with dec_nlink().
359 */
360void inc_nlink(struct inode *inode)
361{
Al Virof4e0c302013-06-11 08:34:36 +0400362 if (unlikely(inode->i_nlink == 0)) {
363 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100364 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400365 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100366
367 inode->__i_nlink++;
368}
369EXPORT_SYMBOL(inc_nlink);
370
Dave Chinnerae233952018-03-06 17:30:34 -0800371static void __address_space_init_once(struct address_space *mapping)
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100372{
Johannes Weiner7b785642019-05-24 10:12:46 -0400373 xa_init_flags(&mapping->i_pages, XA_FLAGS_LOCK_IRQ | XA_FLAGS_ACCOUNT);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800374 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100375 INIT_LIST_HEAD(&mapping->private_list);
376 spin_lock_init(&mapping->private_lock);
Davidlohr Buesof808c132017-09-08 16:15:08 -0700377 mapping->i_mmap = RB_ROOT_CACHED;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100378}
Dave Chinnerae233952018-03-06 17:30:34 -0800379
380void address_space_init_once(struct address_space *mapping)
381{
382 memset(mapping, 0, sizeof(*mapping));
383 __address_space_init_once(mapping);
384}
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100385EXPORT_SYMBOL(address_space_init_once);
386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387/*
388 * These are initializations that only need to be done
389 * once, because the fields are idempotent across use
390 * of the inode, so let the slab aware of that.
391 */
392void inode_init_once(struct inode *inode)
393{
394 memset(inode, 0, sizeof(*inode));
395 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500397 INIT_LIST_HEAD(&inode->i_io_list);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700398 INIT_LIST_HEAD(&inode->i_wb_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100399 INIT_LIST_HEAD(&inode->i_lru);
Dave Chinnerae233952018-03-06 17:30:34 -0800400 __address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 i_size_ordered_init(inode);
402}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403EXPORT_SYMBOL(inode_init_once);
404
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700405static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530407 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Christoph Lametera35afb82007-05-16 22:10:57 -0700409 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410}
411
412/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100413 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530415void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416{
Nick Piggin9e38d862010-10-23 06:55:17 -0400417 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418}
419
Al Viro7de9c6ee2010-10-23 11:11:40 -0400420/*
421 * get additional reference to inode; caller must already hold one.
422 */
423void ihold(struct inode *inode)
424{
425 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
426}
427EXPORT_SYMBOL(ihold);
428
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800429static void __inode_add_lru(struct inode *inode, bool rotate)
Nick Piggin9e38d862010-10-23 06:55:17 -0400430{
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800431 if (inode->i_state & (I_DIRTY_ALL | I_SYNC | I_FREEING | I_WILL_FREE))
432 return;
433 if (atomic_read(&inode->i_count))
434 return;
435 if (!(inode->i_sb->s_flags & SB_ACTIVE))
436 return;
437 if (!mapping_shrinkable(&inode->i_data))
438 return;
439
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000440 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000441 this_cpu_inc(nr_unused);
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800442 else if (rotate)
Josef Bacik563f4002017-04-18 16:04:17 -0400443 inode->i_state |= I_REFERENCED;
Nick Piggin9e38d862010-10-23 06:55:17 -0400444}
445
Jan Kara4eff96d2012-11-26 16:29:51 -0800446/*
447 * Add inode to LRU if needed (inode is unused and clean).
448 *
449 * Needs inode->i_lock held.
450 */
451void inode_add_lru(struct inode *inode)
452{
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800453 __inode_add_lru(inode, false);
Jan Kara4eff96d2012-11-26 16:29:51 -0800454}
455
Nick Piggin9e38d862010-10-23 06:55:17 -0400456static void inode_lru_list_del(struct inode *inode)
457{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000458 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000459 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460}
461
Christoph Hellwig646ec462010-10-23 07:15:32 -0400462/**
463 * inode_sb_list_add - add inode to the superblock list of inodes
464 * @inode: inode to add
465 */
466void inode_sb_list_add(struct inode *inode)
467{
Dave Chinner74278da2015-03-04 12:37:22 -0500468 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100469 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500470 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400471}
472EXPORT_SYMBOL_GPL(inode_sb_list_add);
473
Dave Chinner55fa6092011-03-22 22:23:40 +1100474static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400475{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200476 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500477 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200478 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500479 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200480 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400481}
482
Dave Chinner4c51acb2010-10-23 06:58:09 -0400483static unsigned long hash(struct super_block *sb, unsigned long hashval)
484{
485 unsigned long tmp;
486
487 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
488 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400489 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
490 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400491}
492
493/**
494 * __insert_inode_hash - hash an inode
495 * @inode: unhashed inode
496 * @hashval: unsigned long value used to locate this object in the
497 * inode_hashtable.
498 *
499 * Add an inode to the inode hash for this superblock.
500 */
501void __insert_inode_hash(struct inode *inode, unsigned long hashval)
502{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400503 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
504
Dave Chinner67a23c42011-03-22 22:23:42 +1100505 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100506 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000507 hlist_add_head_rcu(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100508 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100509 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400510}
511EXPORT_SYMBOL(__insert_inode_hash);
512
513/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200514 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400515 * @inode: inode to unhash
516 *
517 * Remove an inode from the superblock.
518 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200519void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400520{
Dave Chinner67a23c42011-03-22 22:23:42 +1100521 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100522 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000523 hlist_del_init_rcu(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100524 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100525 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400526}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200527EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400528
Jan Karadbd57682012-05-03 14:48:02 +0200529void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400530{
Jan Kara08142572011-06-27 16:18:10 -0700531 /*
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700532 * We have to cycle the i_pages lock here because reclaim can be in the
Jan Kara08142572011-06-27 16:18:10 -0700533 * process of removing the last page (in __delete_from_page_cache())
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700534 * and we must not free the mapping under it.
Jan Kara08142572011-06-27 16:18:10 -0700535 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700536 xa_lock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400537 BUG_ON(inode->i_data.nrpages);
Hugh Dickins786b3112021-05-04 18:32:57 -0700538 /*
539 * Almost always, mapping_empty(&inode->i_data) here; but there are
540 * two known and long-standing ways in which nodes may get left behind
541 * (when deep radix-tree node allocation failed partway; or when THP
542 * collapse_file() failed). Until those two known cases are cleaned up,
543 * or a cleanup function is called here, do not BUG_ON(!mapping_empty),
544 * nor even WARN_ON(!mapping_empty).
545 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700546 xa_unlock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400547 BUG_ON(!list_empty(&inode->i_data.private_list));
548 BUG_ON(!(inode->i_state & I_FREEING));
549 BUG_ON(inode->i_state & I_CLEAR);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700550 BUG_ON(!list_empty(&inode->i_wb_list));
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100551 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400552 inode->i_state = I_FREEING | I_CLEAR;
553}
Jan Karadbd57682012-05-03 14:48:02 +0200554EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400555
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100556/*
557 * Free the inode passed in, removing it from the lists it is still connected
558 * to. We remove any pages still attached to the inode and wait for any IO that
559 * is still in progress before finally destroying the inode.
560 *
561 * An inode must already be marked I_FREEING so that we avoid the inode being
562 * moved back onto lists if we race with other code that manipulates the lists
563 * (e.g. writeback_single_inode). The caller is responsible for setting this.
564 *
565 * An inode must already be removed from the LRU list before being evicted from
566 * the cache. This should occur atomically with setting the I_FREEING state
567 * flag, so no inodes here should ever be on the LRU when being evicted.
568 */
Al Viro644da592010-06-07 13:21:05 -0400569static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400570{
571 const struct super_operations *op = inode->i_sb->s_op;
572
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100573 BUG_ON(!(inode->i_state & I_FREEING));
574 BUG_ON(!list_empty(&inode->i_lru));
575
Dave Chinnerc7f54082015-03-04 14:07:22 -0500576 if (!list_empty(&inode->i_io_list))
577 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200578
Dave Chinner55fa6092011-03-22 22:23:40 +1100579 inode_sb_list_del(inode);
580
Jan Kara169ebd92012-05-03 14:48:03 +0200581 /*
582 * Wait for flusher thread to be done with the inode so that filesystem
583 * does not start destroying it while writeback is still running. Since
584 * the inode has I_FREEING set, flusher thread won't start new work on
585 * the inode. We just have to wait for running writeback to finish.
586 */
587 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200588
Al Virobe7ce412010-06-04 19:40:39 -0400589 if (op->evict_inode) {
590 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400591 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700592 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200593 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400594 }
Al Viro661074e2010-06-04 20:19:55 -0400595 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
596 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100597
598 remove_inode_hash(inode);
599
600 spin_lock(&inode->i_lock);
601 wake_up_bit(&inode->i_state, __I_NEW);
602 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
603 spin_unlock(&inode->i_lock);
604
605 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400606}
607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608/*
609 * dispose_list - dispose of the contents of a local list
610 * @head: the head of the list to free
611 *
612 * Dispose-list gets a local list with local inodes in it, so it doesn't
613 * need to worry about list corruption and SMP locks.
614 */
615static void dispose_list(struct list_head *head)
616{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 while (!list_empty(head)) {
618 struct inode *inode;
619
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100620 inode = list_first_entry(head, struct inode, i_lru);
621 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Al Viro644da592010-06-07 13:21:05 -0400623 evict(inode);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500624 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626}
627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628/**
Al Viro63997e92010-10-25 20:49:35 -0400629 * evict_inodes - evict all evictable inodes for a superblock
630 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 *
Al Viro63997e92010-10-25 20:49:35 -0400632 * Make sure that no inodes with zero refcount are retained. This is
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800633 * called by superblock shutdown after having SB_ACTIVE flag removed,
Al Viro63997e92010-10-25 20:49:35 -0400634 * so any inode reaching zero refcount during or after that call will
635 * be immediately evicted.
636 */
637void evict_inodes(struct super_block *sb)
638{
639 struct inode *inode, *next;
640 LIST_HEAD(dispose);
641
Josef Bacikac05fbb2015-03-04 16:52:52 -0500642again:
Dave Chinner74278da2015-03-04 12:37:22 -0500643 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400644 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
645 if (atomic_read(&inode->i_count))
646 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100647
648 spin_lock(&inode->i_lock);
649 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
650 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400651 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100652 }
Al Viro63997e92010-10-25 20:49:35 -0400653
654 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100655 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100656 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100657 list_add(&inode->i_lru, &dispose);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500658
659 /*
660 * We can have a ton of inodes to evict at unmount time given
661 * enough memory, check to see if we need to go to sleep for a
662 * bit so we don't livelock.
663 */
664 if (need_resched()) {
665 spin_unlock(&sb->s_inode_list_lock);
666 cond_resched();
667 dispose_list(&dispose);
668 goto again;
669 }
Al Viro63997e92010-10-25 20:49:35 -0400670 }
Dave Chinner74278da2015-03-04 12:37:22 -0500671 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400672
673 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400674}
Darrick J. Wong799ea9e2017-08-18 18:08:25 -0700675EXPORT_SYMBOL_GPL(evict_inodes);
Al Viro63997e92010-10-25 20:49:35 -0400676
677/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200678 * invalidate_inodes - attempt to free all inodes on a superblock
679 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100680 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200681 *
682 * Attempts to free all inodes for a given superblock. If there were any
683 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100684 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
685 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 */
NeilBrown93b270f2011-02-24 17:25:47 +1100687int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400689 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200690 struct inode *inode, *next;
691 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
Eric Sandeen04646ae2019-12-06 10:54:23 -0600693again:
Dave Chinner74278da2015-03-04 12:37:22 -0500694 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200695 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100696 spin_lock(&inode->i_lock);
697 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
698 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100700 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500701 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100702 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100703 busy = 1;
704 continue;
705 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200706 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100707 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200708 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 continue;
710 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200711
Christoph Hellwig99a38912010-10-23 19:07:20 +0200712 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100713 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100714 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100715 list_add(&inode->i_lru, &dispose);
Eric Sandeen04646ae2019-12-06 10:54:23 -0600716 if (need_resched()) {
717 spin_unlock(&sb->s_inode_list_lock);
718 cond_resched();
719 dispose_list(&dispose);
720 goto again;
721 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 }
Dave Chinner74278da2015-03-04 12:37:22 -0500723 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Christoph Hellwiga0318782010-10-24 19:40:33 +0200725 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
727 return busy;
728}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000731 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400733 * If the inode has the I_REFERENCED flag set, then it means that it has been
734 * used recently - the flag is set in iput_final(). When we encounter such an
735 * inode, clear the flag and move it to the back of the LRU so it gets another
736 * pass through the LRU before it gets reclaimed. This is necessary because of
737 * the fact we are doing lazy LRU updates to minimise lock contention so the
738 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
739 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800741static enum lru_status inode_lru_isolate(struct list_head *item,
742 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000743{
744 struct list_head *freeable = arg;
745 struct inode *inode = container_of(item, struct inode, i_lru);
746
747 /*
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800748 * We are inverting the lru lock/inode->i_lock here, so use a
749 * trylock. If we fail to get the lock, just skip it.
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000750 */
751 if (!spin_trylock(&inode->i_lock))
752 return LRU_SKIP;
753
754 /*
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800755 * Inodes can get referenced, redirtied, or repopulated while
756 * they're already on the LRU, and this can make them
757 * unreclaimable for a while. Remove them lazily here; iput,
758 * sync, or the last page cache deletion will requeue them.
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000759 */
760 if (atomic_read(&inode->i_count) ||
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800761 (inode->i_state & ~I_REFERENCED) ||
762 !mapping_shrinkable(&inode->i_data)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800763 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000764 spin_unlock(&inode->i_lock);
765 this_cpu_dec(nr_unused);
766 return LRU_REMOVED;
767 }
768
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800769 /* Recently referenced inodes get one more pass */
Dave Chinner69056ee2019-02-12 15:35:51 -0800770 if (inode->i_state & I_REFERENCED) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000771 inode->i_state &= ~I_REFERENCED;
772 spin_unlock(&inode->i_lock);
773 return LRU_ROTATE;
774 }
775
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800776 /*
777 * On highmem systems, mapping_shrinkable() permits dropping
778 * page cache in order to free up struct inodes: lowmem might
779 * be under pressure before the cache inside the highmem zone.
780 */
Johannes Weiner7ae12c82021-09-02 14:53:24 -0700781 if (inode_has_buffers(inode) || !mapping_empty(&inode->i_data)) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000782 __iget(inode);
783 spin_unlock(&inode->i_lock);
784 spin_unlock(lru_lock);
785 if (remove_inode_buffers(inode)) {
786 unsigned long reap;
787 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
788 if (current_is_kswapd())
789 __count_vm_events(KSWAPD_INODESTEAL, reap);
790 else
791 __count_vm_events(PGINODESTEAL, reap);
792 if (current->reclaim_state)
793 current->reclaim_state->reclaimed_slab += reap;
794 }
795 iput(inode);
796 spin_lock(lru_lock);
797 return LRU_RETRY;
798 }
799
800 WARN_ON(inode->i_state & I_NEW);
801 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800802 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000803 spin_unlock(&inode->i_lock);
804
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000805 this_cpu_dec(nr_unused);
806 return LRU_REMOVED;
807}
808
809/*
810 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
811 * This is called from the superblock shrinker function with a number of inodes
812 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
813 * then are freed outside inode_lock by dispose_list().
814 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800815long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816{
817 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000818 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
Vladimir Davydov503c3582015-02-12 14:58:47 -0800820 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
821 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000823 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824}
825
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826static void __wait_on_freeing_inode(struct inode *inode);
827/*
828 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530830static struct inode *find_inode(struct super_block *sb,
831 struct hlist_head *head,
832 int (*test)(struct inode *, void *),
833 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530835 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
837repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800838 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500839 if (inode->i_sb != sb)
840 continue;
841 if (!test(inode, data))
842 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100843 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400844 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 __wait_on_freeing_inode(inode);
846 goto repeat;
847 }
Al Viroc2b6d622018-06-28 15:53:17 -0400848 if (unlikely(inode->i_state & I_CREATING)) {
849 spin_unlock(&inode->i_lock);
850 return ERR_PTR(-ESTALE);
851 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400852 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100853 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400854 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400856 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857}
858
859/*
860 * find_inode_fast is the fast path version of find_inode, see the comment at
861 * iget_locked for details.
862 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530863static struct inode *find_inode_fast(struct super_block *sb,
864 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530866 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
868repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800869 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500870 if (inode->i_ino != ino)
871 continue;
872 if (inode->i_sb != sb)
873 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100874 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400875 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 __wait_on_freeing_inode(inode);
877 goto repeat;
878 }
Al Viroc2b6d622018-06-28 15:53:17 -0400879 if (unlikely(inode->i_state & I_CREATING)) {
880 spin_unlock(&inode->i_lock);
881 return ERR_PTR(-ESTALE);
882 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400883 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100884 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400885 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400887 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888}
889
Eric Dumazetf991bd22010-10-23 11:18:01 -0400890/*
891 * Each cpu owns a range of LAST_INO_BATCH numbers.
892 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
893 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100894 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400895 * This does not significantly increase overflow rate because every CPU can
896 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
897 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
898 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
899 * overflow rate by 2x, which does not seem too significant.
900 *
901 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
902 * error if st_ino won't fit in target struct field. Use 32bit counter
903 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100904 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400905#define LAST_INO_BATCH 1024
906static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100907
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400908unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400909{
910 unsigned int *p = &get_cpu_var(last_ino);
911 unsigned int res = *p;
912
913#ifdef CONFIG_SMP
914 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
915 static atomic_t shared_last_ino;
916 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
917
918 res = next - LAST_INO_BATCH;
919 }
920#endif
921
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300922 res++;
923 /* get_next_ino should not provide a 0 inode number */
924 if (unlikely(!res))
925 res++;
926 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400927 put_cpu_var(last_ino);
928 return res;
David Chinner8290c352008-10-30 17:35:24 +1100929}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400930EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100931
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200933 * new_inode_pseudo - obtain an inode
934 * @sb: superblock
935 *
936 * Allocates a new inode for given superblock.
937 * Inode wont be chained in superblock s_inodes list
938 * This means :
939 * - fs can't be unmount
940 * - quotas, fsnotify, writeback can't work
941 */
942struct inode *new_inode_pseudo(struct super_block *sb)
943{
944 struct inode *inode = alloc_inode(sb);
945
946 if (inode) {
947 spin_lock(&inode->i_lock);
948 inode->i_state = 0;
949 spin_unlock(&inode->i_lock);
950 INIT_LIST_HEAD(&inode->i_sb_list);
951 }
952 return inode;
953}
954
955/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 * new_inode - obtain an inode
957 * @sb: superblock
958 *
Mel Gorman769848c2007-07-17 04:03:05 -0700959 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800960 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700961 * If HIGHMEM pages are unsuitable or it is known that pages allocated
962 * for the page cache are not reclaimable or migratable,
963 * mapping_set_gfp_mask() must be called with suitable flags on the
964 * newly created inode's mapping
965 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 */
967struct inode *new_inode(struct super_block *sb)
968{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530969 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
Dave Chinner74278da2015-03-04 12:37:22 -0500971 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530972
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200973 inode = new_inode_pseudo(sb);
974 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100975 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 return inode;
977}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978EXPORT_SYMBOL(new_inode);
979
Peter Zijlstra14358e62007-10-14 01:38:33 +0200980#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400981void lockdep_annotate_inode_mutex_key(struct inode *inode)
982{
Namhyung Kima3314a02010-10-11 22:38:00 +0900983 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200984 struct file_system_type *type = inode->i_sb->s_type;
985
Jan Kara9a7aa122009-06-04 15:26:49 +0200986 /* Set new key only if filesystem hasn't already changed it */
Al Viro9902af72016-04-15 15:08:36 -0400987 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200988 /*
989 * ensure nobody is actually holding i_mutex
990 */
Al Viro9902af72016-04-15 15:08:36 -0400991 // mutex_destroy(&inode->i_mutex);
992 init_rwsem(&inode->i_rwsem);
993 lockdep_set_class(&inode->i_rwsem,
Jan Kara9a7aa122009-06-04 15:26:49 +0200994 &type->i_mutex_dir_key);
995 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200996 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400997}
998EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200999#endif
Josh Boyere096d0c2011-08-25 07:48:12 -04001000
1001/**
1002 * unlock_new_inode - clear the I_NEW state and wake up any waiters
1003 * @inode: new inode to unlock
1004 *
1005 * Called when the inode is fully initialised to clear the new state of the
1006 * inode and wake up anyone waiting for the inode to finish initialisation.
1007 */
1008void unlock_new_inode(struct inode *inode)
1009{
1010 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001011 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001012 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -04001013 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro310fa7a2012-03-10 17:07:28 -05001014 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +11001015 wake_up_bit(&inode->i_state, __I_NEW);
1016 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018EXPORT_SYMBOL(unlock_new_inode);
1019
Al Viroc2b6d622018-06-28 15:53:17 -04001020void discard_new_inode(struct inode *inode)
1021{
1022 lockdep_annotate_inode_mutex_key(inode);
1023 spin_lock(&inode->i_lock);
1024 WARN_ON(!(inode->i_state & I_NEW));
1025 inode->i_state &= ~I_NEW;
1026 smp_mb();
1027 wake_up_bit(&inode->i_state, __I_NEW);
1028 spin_unlock(&inode->i_lock);
1029 iput(inode);
1030}
1031EXPORT_SYMBOL(discard_new_inode);
1032
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001033/**
J. Bruce Fields375e2892012-04-18 15:16:33 -04001034 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001035 *
1036 * Lock any non-NULL argument that is not a directory.
1037 * Zero, one or two objects may be locked by this function.
1038 *
J. Bruce Fields375e2892012-04-18 15:16:33 -04001039 * @inode1: first inode to lock
1040 * @inode2: second inode to lock
1041 */
1042void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1043{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001044 if (inode1 > inode2)
1045 swap(inode1, inode2);
1046
1047 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001048 inode_lock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001049 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001050 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001051}
1052EXPORT_SYMBOL(lock_two_nondirectories);
1053
1054/**
1055 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
1056 * @inode1: first inode to unlock
1057 * @inode2: second inode to unlock
1058 */
1059void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1060{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001061 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001062 inode_unlock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001063 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001064 inode_unlock(inode2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001065}
1066EXPORT_SYMBOL(unlock_two_nondirectories);
1067
1068/**
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001069 * inode_insert5 - obtain an inode from a mounted file system
1070 * @inode: pre-allocated inode to use for insert to cache
1071 * @hashval: hash value (usually inode number) to get
1072 * @test: callback used for comparisons between inodes
1073 * @set: callback used to initialize a new struct inode
1074 * @data: opaque data pointer to pass to @test and @set
1075 *
1076 * Search for the inode specified by @hashval and @data in the inode cache,
1077 * and if present it is return it with an increased reference count. This is
1078 * a variant of iget5_locked() for callers that don't want to fail on memory
1079 * allocation of inode.
1080 *
1081 * If the inode is not in cache, insert the pre-allocated inode to cache and
1082 * return it locked, hashed, and with the I_NEW flag set. The file system gets
1083 * to fill it in before unlocking it via unlock_new_inode().
1084 *
1085 * Note both @test and @set are called with the inode_hash_lock held, so can't
1086 * sleep.
1087 */
1088struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
1089 int (*test)(struct inode *, void *),
1090 int (*set)(struct inode *, void *), void *data)
1091{
1092 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1093 struct inode *old;
Miklos Szeredie9505642018-07-24 15:01:55 +02001094 bool creating = inode->i_state & I_CREATING;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001095
1096again:
1097 spin_lock(&inode_hash_lock);
1098 old = find_inode(inode->i_sb, head, test, data);
1099 if (unlikely(old)) {
1100 /*
1101 * Uhhuh, somebody else created the same inode under us.
1102 * Use the old inode instead of the preallocated one.
1103 */
1104 spin_unlock(&inode_hash_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001105 if (IS_ERR(old))
1106 return NULL;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001107 wait_on_inode(old);
1108 if (unlikely(inode_unhashed(old))) {
1109 iput(old);
1110 goto again;
1111 }
1112 return old;
1113 }
1114
1115 if (set && unlikely(set(inode, data))) {
1116 inode = NULL;
1117 goto unlock;
1118 }
1119
1120 /*
1121 * Return the locked inode with I_NEW set, the
1122 * caller is responsible for filling in the contents
1123 */
1124 spin_lock(&inode->i_lock);
1125 inode->i_state |= I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001126 hlist_add_head_rcu(&inode->i_hash, head);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001127 spin_unlock(&inode->i_lock);
Miklos Szeredie9505642018-07-24 15:01:55 +02001128 if (!creating)
1129 inode_sb_list_add(inode);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001130unlock:
1131 spin_unlock(&inode_hash_lock);
1132
1133 return inode;
1134}
1135EXPORT_SYMBOL(inode_insert5);
1136
1137/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001138 * iget5_locked - obtain an inode from a mounted file system
1139 * @sb: super block of file system
1140 * @hashval: hash value (usually inode number) to get
1141 * @test: callback used for comparisons between inodes
1142 * @set: callback used to initialize a new struct inode
1143 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001145 * Search for the inode specified by @hashval and @data in the inode cache,
1146 * and if present it is return it with an increased reference count. This is
1147 * a generalized version of iget_locked() for file systems where the inode
1148 * number is not sufficient for unique identification of an inode.
1149 *
1150 * If the inode is not in cache, allocate a new inode and return it locked,
1151 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1152 * before unlocking it via unlock_new_inode().
1153 *
1154 * Note both @test and @set are called with the inode_hash_lock held, so can't
1155 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001157struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1158 int (*test)(struct inode *, void *),
1159 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160{
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001161 struct inode *inode = ilookup5(sb, hashval, test, data);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001162
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001163 if (!inode) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001164 struct inode *new = alloc_inode(sb);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001165
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001166 if (new) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001167 new->i_state = 0;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001168 inode = inode_insert5(new, hashval, test, set, data);
1169 if (unlikely(inode != new))
Miklos Szeredie9505642018-07-24 15:01:55 +02001170 destroy_inode(new);
Al Viro2864f302016-07-03 23:15:21 -04001171 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 }
1173 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001175EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001177/**
1178 * iget_locked - obtain an inode from a mounted file system
1179 * @sb: super block of file system
1180 * @ino: inode number to get
1181 *
1182 * Search for the inode specified by @ino in the inode cache and if present
1183 * return it with an increased reference count. This is for file systems
1184 * where the inode number is sufficient for unique identification of an inode.
1185 *
1186 * If the inode is not in cache, allocate a new inode and return it locked,
1187 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1188 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001190struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001192 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301193 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001194again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001195 spin_lock(&inode_hash_lock);
1196 inode = find_inode_fast(sb, head, ino);
1197 spin_unlock(&inode_hash_lock);
1198 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001199 if (IS_ERR(inode))
1200 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001201 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001202 if (unlikely(inode_unhashed(inode))) {
1203 iput(inode);
1204 goto again;
1205 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001206 return inode;
1207 }
1208
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 inode = alloc_inode(sb);
1210 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301211 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
Dave Chinner67a23c42011-03-22 22:23:42 +11001213 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 /* We released the lock, so.. */
1215 old = find_inode_fast(sb, head, ino);
1216 if (!old) {
1217 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001218 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001219 inode->i_state = I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001220 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001221 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001222 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001223 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
1225 /* Return the locked inode with I_NEW set, the
1226 * caller is responsible for filling in the contents
1227 */
1228 return inode;
1229 }
1230
1231 /*
1232 * Uhhuh, somebody else created the same inode under
1233 * us. Use the old inode instead of the one we just
1234 * allocated.
1235 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001236 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 destroy_inode(inode);
Al Viroc2b6d622018-06-28 15:53:17 -04001238 if (IS_ERR(old))
1239 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 inode = old;
1241 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001242 if (unlikely(inode_unhashed(inode))) {
1243 iput(inode);
1244 goto again;
1245 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 }
1247 return inode;
1248}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001249EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001251/*
1252 * search the inode cache for a matching inode number.
1253 * If we find one, then the inode number we are trying to
1254 * allocate is not unique and so we should not use it.
1255 *
1256 * Returns 1 if the inode number is unique, 0 if it is not.
1257 */
1258static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1259{
1260 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001261 struct inode *inode;
1262
David Howells3f19b2a2017-12-01 11:40:16 +00001263 hlist_for_each_entry_rcu(inode, b, i_hash) {
1264 if (inode->i_ino == ino && inode->i_sb == sb)
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001265 return 0;
1266 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001267 return 1;
1268}
1269
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270/**
1271 * iunique - get a unique inode number
1272 * @sb: superblock
1273 * @max_reserved: highest reserved inode number
1274 *
1275 * Obtain an inode number that is unique on the system for a given
1276 * superblock. This is used by file systems that have no natural
1277 * permanent inode numbering system. An inode number is returned that
1278 * is higher than the reserved limit but unique.
1279 *
1280 * BUGS:
1281 * With a large number of inodes live on the file system this function
1282 * currently becomes quite slow.
1283 */
1284ino_t iunique(struct super_block *sb, ino_t max_reserved)
1285{
Jeff Layton866b04f2007-05-08 00:32:29 -07001286 /*
1287 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1288 * error if st_ino won't fit in target struct field. Use 32bit counter
1289 * here to attempt to avoid that.
1290 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001291 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001292 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294
David Howells3f19b2a2017-12-01 11:40:16 +00001295 rcu_read_lock();
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001296 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001297 do {
1298 if (counter <= max_reserved)
1299 counter = max_reserved + 1;
1300 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001301 } while (!test_inode_iunique(sb, res));
1302 spin_unlock(&iunique_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001303 rcu_read_unlock();
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001304
1305 return res;
1306}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307EXPORT_SYMBOL(iunique);
1308
1309struct inode *igrab(struct inode *inode)
1310{
Dave Chinner250df6e2011-03-22 22:23:36 +11001311 spin_lock(&inode->i_lock);
1312 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001314 spin_unlock(&inode->i_lock);
1315 } else {
1316 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 /*
1318 * Handle the case where s_op->clear_inode is not been
1319 * called yet, and somebody is calling igrab
1320 * while the inode is getting freed.
1321 */
1322 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001323 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 return inode;
1325}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326EXPORT_SYMBOL(igrab);
1327
1328/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001329 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 * @sb: super block of file system to search
1331 * @hashval: hash value (usually inode number) to search for
1332 * @test: callback used for comparisons between inodes
1333 * @data: opaque data pointer to pass to @test
1334 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001335 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001337 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001338 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001339 * Note: I_NEW is not waited upon so you have to be very careful what you do
1340 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001341 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001342 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001343 */
1344struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1345 int (*test)(struct inode *, void *), void *data)
1346{
1347 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001348 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001349
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001350 spin_lock(&inode_hash_lock);
1351 inode = find_inode(sb, head, test, data);
1352 spin_unlock(&inode_hash_lock);
1353
Al Viroc2b6d622018-06-28 15:53:17 -04001354 return IS_ERR(inode) ? NULL : inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001355}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001356EXPORT_SYMBOL(ilookup5_nowait);
1357
1358/**
1359 * ilookup5 - search for an inode in the inode cache
1360 * @sb: super block of file system to search
1361 * @hashval: hash value (usually inode number) to search for
1362 * @test: callback used for comparisons between inodes
1363 * @data: opaque data pointer to pass to @test
1364 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001365 * Search for the inode specified by @hashval and @data in the inode cache,
1366 * and if the inode is in the cache, return the inode with an incremented
1367 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001368 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001370 * This is a generalized version of ilookup() for file systems where the
1371 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001373 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 */
1375struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1376 int (*test)(struct inode *, void *), void *data)
1377{
Al Viro2864f302016-07-03 23:15:21 -04001378 struct inode *inode;
1379again:
1380 inode = ilookup5_nowait(sb, hashval, test, data);
1381 if (inode) {
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001382 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001383 if (unlikely(inode_unhashed(inode))) {
1384 iput(inode);
1385 goto again;
1386 }
1387 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001388 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390EXPORT_SYMBOL(ilookup5);
1391
1392/**
1393 * ilookup - search for an inode in the inode cache
1394 * @sb: super block of file system to search
1395 * @ino: inode number to search for
1396 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001397 * Search for the inode @ino in the inode cache, and if the inode is in the
1398 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 */
1400struct inode *ilookup(struct super_block *sb, unsigned long ino)
1401{
1402 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001403 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001404again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001405 spin_lock(&inode_hash_lock);
1406 inode = find_inode_fast(sb, head, ino);
1407 spin_unlock(&inode_hash_lock);
1408
Al Viro2864f302016-07-03 23:15:21 -04001409 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001410 if (IS_ERR(inode))
1411 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001412 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001413 if (unlikely(inode_unhashed(inode))) {
1414 iput(inode);
1415 goto again;
1416 }
1417 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001418 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420EXPORT_SYMBOL(ilookup);
1421
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001422/**
1423 * find_inode_nowait - find an inode in the inode cache
1424 * @sb: super block of file system to search
1425 * @hashval: hash value (usually inode number) to search for
1426 * @match: callback used for comparisons between inodes
1427 * @data: opaque data pointer to pass to @match
1428 *
1429 * Search for the inode specified by @hashval and @data in the inode
1430 * cache, where the helper function @match will return 0 if the inode
1431 * does not match, 1 if the inode does match, and -1 if the search
1432 * should be stopped. The @match function must be responsible for
1433 * taking the i_lock spin_lock and checking i_state for an inode being
1434 * freed or being initialized, and incrementing the reference count
1435 * before returning 1. It also must not sleep, since it is called with
1436 * the inode_hash_lock spinlock held.
1437 *
1438 * This is a even more generalized version of ilookup5() when the
1439 * function must never block --- find_inode() can block in
1440 * __wait_on_freeing_inode() --- or when the caller can not increment
1441 * the reference count because the resulting iput() might cause an
1442 * inode eviction. The tradeoff is that the @match funtion must be
1443 * very carefully implemented.
1444 */
1445struct inode *find_inode_nowait(struct super_block *sb,
1446 unsigned long hashval,
1447 int (*match)(struct inode *, unsigned long,
1448 void *),
1449 void *data)
1450{
1451 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1452 struct inode *inode, *ret_inode = NULL;
1453 int mval;
1454
1455 spin_lock(&inode_hash_lock);
1456 hlist_for_each_entry(inode, head, i_hash) {
1457 if (inode->i_sb != sb)
1458 continue;
1459 mval = match(inode, hashval, data);
1460 if (mval == 0)
1461 continue;
1462 if (mval == 1)
1463 ret_inode = inode;
1464 goto out;
1465 }
1466out:
1467 spin_unlock(&inode_hash_lock);
1468 return ret_inode;
1469}
1470EXPORT_SYMBOL(find_inode_nowait);
1471
David Howells3f19b2a2017-12-01 11:40:16 +00001472/**
1473 * find_inode_rcu - find an inode in the inode cache
1474 * @sb: Super block of file system to search
1475 * @hashval: Key to hash
1476 * @test: Function to test match on an inode
1477 * @data: Data for test function
1478 *
1479 * Search for the inode specified by @hashval and @data in the inode cache,
1480 * where the helper function @test will return 0 if the inode does not match
1481 * and 1 if it does. The @test function must be responsible for taking the
1482 * i_lock spin_lock and checking i_state for an inode being freed or being
1483 * initialized.
1484 *
1485 * If successful, this will return the inode for which the @test function
1486 * returned 1 and NULL otherwise.
1487 *
1488 * The @test function is not permitted to take a ref on any inode presented.
1489 * It is also not permitted to sleep.
1490 *
1491 * The caller must hold the RCU read lock.
1492 */
1493struct inode *find_inode_rcu(struct super_block *sb, unsigned long hashval,
1494 int (*test)(struct inode *, void *), void *data)
1495{
1496 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1497 struct inode *inode;
1498
1499 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1500 "suspicious find_inode_rcu() usage");
1501
1502 hlist_for_each_entry_rcu(inode, head, i_hash) {
1503 if (inode->i_sb == sb &&
1504 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)) &&
1505 test(inode, data))
1506 return inode;
1507 }
1508 return NULL;
1509}
1510EXPORT_SYMBOL(find_inode_rcu);
1511
1512/**
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001513 * find_inode_by_ino_rcu - Find an inode in the inode cache
David Howells3f19b2a2017-12-01 11:40:16 +00001514 * @sb: Super block of file system to search
1515 * @ino: The inode number to match
1516 *
1517 * Search for the inode specified by @hashval and @data in the inode cache,
1518 * where the helper function @test will return 0 if the inode does not match
1519 * and 1 if it does. The @test function must be responsible for taking the
1520 * i_lock spin_lock and checking i_state for an inode being freed or being
1521 * initialized.
1522 *
1523 * If successful, this will return the inode for which the @test function
1524 * returned 1 and NULL otherwise.
1525 *
1526 * The @test function is not permitted to take a ref on any inode presented.
1527 * It is also not permitted to sleep.
1528 *
1529 * The caller must hold the RCU read lock.
1530 */
1531struct inode *find_inode_by_ino_rcu(struct super_block *sb,
1532 unsigned long ino)
1533{
1534 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1535 struct inode *inode;
1536
1537 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1538 "suspicious find_inode_by_ino_rcu() usage");
1539
1540 hlist_for_each_entry_rcu(inode, head, i_hash) {
1541 if (inode->i_ino == ino &&
1542 inode->i_sb == sb &&
1543 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)))
1544 return inode;
1545 }
1546 return NULL;
1547}
1548EXPORT_SYMBOL(find_inode_by_ino_rcu);
1549
Al Viro261bca82008-12-30 01:48:21 -05001550int insert_inode_locked(struct inode *inode)
1551{
1552 struct super_block *sb = inode->i_sb;
1553 ino_t ino = inode->i_ino;
1554 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001555
Al Viro261bca82008-12-30 01:48:21 -05001556 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001557 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001558 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001559 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001560 if (old->i_ino != ino)
1561 continue;
1562 if (old->i_sb != sb)
1563 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001564 spin_lock(&old->i_lock);
1565 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1566 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001567 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001568 }
Al Viro72a43d62009-05-13 19:13:40 +01001569 break;
1570 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001571 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001572 spin_lock(&inode->i_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001573 inode->i_state |= I_NEW | I_CREATING;
David Howells3f19b2a2017-12-01 11:40:16 +00001574 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001575 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001576 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001577 return 0;
1578 }
Al Viroc2b6d622018-06-28 15:53:17 -04001579 if (unlikely(old->i_state & I_CREATING)) {
1580 spin_unlock(&old->i_lock);
1581 spin_unlock(&inode_hash_lock);
1582 return -EBUSY;
1583 }
Al Viro261bca82008-12-30 01:48:21 -05001584 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001585 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001586 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001587 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001588 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001589 iput(old);
1590 return -EBUSY;
1591 }
1592 iput(old);
1593 }
1594}
Al Viro261bca82008-12-30 01:48:21 -05001595EXPORT_SYMBOL(insert_inode_locked);
1596
1597int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1598 int (*test)(struct inode *, void *), void *data)
1599{
Al Viroc2b6d622018-06-28 15:53:17 -04001600 struct inode *old;
1601
1602 inode->i_state |= I_CREATING;
1603 old = inode_insert5(inode, hashval, test, NULL, data);
Al Viro261bca82008-12-30 01:48:21 -05001604
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001605 if (old != inode) {
Al Viro261bca82008-12-30 01:48:21 -05001606 iput(old);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001607 return -EBUSY;
Al Viro261bca82008-12-30 01:48:21 -05001608 }
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001609 return 0;
Al Viro261bca82008-12-30 01:48:21 -05001610}
Al Viro261bca82008-12-30 01:48:21 -05001611EXPORT_SYMBOL(insert_inode_locked4);
1612
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
Al Viro45321ac2010-06-07 13:43:19 -04001614int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615{
Al Viro45321ac2010-06-07 13:43:19 -04001616 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618EXPORT_SYMBOL(generic_delete_inode);
1619
Al Viro45321ac2010-06-07 13:43:19 -04001620/*
Al Viro45321ac2010-06-07 13:43:19 -04001621 * Called when we're dropping the last reference
1622 * to an inode.
1623 *
1624 * Call the FS "drop_inode()" function, defaulting to
1625 * the legacy UNIX filesystem behaviour. If it tells
1626 * us to evict inode, do so. Otherwise, retain inode
1627 * in cache if fs is alive, sync and evict if fs is
1628 * shutting down.
1629 */
1630static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631{
1632 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001633 const struct super_operations *op = inode->i_sb->s_op;
David Howells3f19b2a2017-12-01 11:40:16 +00001634 unsigned long state;
Al Viro45321ac2010-06-07 13:43:19 -04001635 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
Dave Chinner250df6e2011-03-22 22:23:36 +11001637 WARN_ON(inode->i_state & I_NEW);
1638
Al Viroe7f59092011-07-07 15:45:59 -04001639 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001640 drop = op->drop_inode(inode);
1641 else
1642 drop = generic_drop_inode(inode);
1643
Hao Li88149082020-12-08 10:08:43 +08001644 if (!drop &&
1645 !(inode->i_state & I_DONTCACHE) &&
1646 (sb->s_flags & SB_ACTIVE)) {
Johannes Weiner51b8c1f2021-11-08 18:31:24 -08001647 __inode_add_lru(inode, true);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001648 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001649 return;
1650 }
1651
David Howells3f19b2a2017-12-01 11:40:16 +00001652 state = inode->i_state;
Al Viro45321ac2010-06-07 13:43:19 -04001653 if (!drop) {
David Howells3f19b2a2017-12-01 11:40:16 +00001654 WRITE_ONCE(inode->i_state, state | I_WILL_FREE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001655 spin_unlock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001656
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 write_inode_now(inode, 1);
David Howells3f19b2a2017-12-01 11:40:16 +00001658
Dave Chinner250df6e2011-03-22 22:23:36 +11001659 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001660 state = inode->i_state;
1661 WARN_ON(state & I_NEW);
1662 state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001664
David Howells3f19b2a2017-12-01 11:40:16 +00001665 WRITE_ONCE(inode->i_state, state | I_FREEING);
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001666 if (!list_empty(&inode->i_lru))
1667 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001668 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001669
1670 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671}
1672
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301674 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 * @inode: inode to put
1676 *
1677 * Puts an inode, dropping its usage count. If the inode use count hits
1678 * zero, the inode is then freed and may also be destroyed.
1679 *
1680 * Consequently, iput() can sleep.
1681 */
1682void iput(struct inode *inode)
1683{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001684 if (!inode)
1685 return;
1686 BUG_ON(inode->i_state & I_CLEAR);
1687retry:
1688 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1689 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1690 atomic_inc(&inode->i_count);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001691 spin_unlock(&inode->i_lock);
1692 trace_writeback_lazytime_iput(inode);
1693 mark_inode_dirty_sync(inode);
1694 goto retry;
1695 }
1696 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 }
1698}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699EXPORT_SYMBOL(iput);
1700
Carlos Maiolino30460e12020-01-09 14:30:41 +01001701#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702/**
1703 * bmap - find a block number in a file
Carlos Maiolino30460e12020-01-09 14:30:41 +01001704 * @inode: inode owning the block number being requested
1705 * @block: pointer containing the block to find
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 *
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001707 * Replaces the value in ``*block`` with the block number on the device holding
Carlos Maiolino30460e12020-01-09 14:30:41 +01001708 * corresponding to the requested block number in the file.
1709 * That is, asked for block 4 of inode 1 the function will replace the
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001710 * 4 in ``*block``, with disk block relative to the disk start that holds that
Carlos Maiolino30460e12020-01-09 14:30:41 +01001711 * block of the file.
1712 *
1713 * Returns -EINVAL in case of error, 0 otherwise. If mapping falls into a
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001714 * hole, returns 0 and ``*block`` is also set to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 */
Carlos Maiolino30460e12020-01-09 14:30:41 +01001716int bmap(struct inode *inode, sector_t *block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717{
Carlos Maiolino30460e12020-01-09 14:30:41 +01001718 if (!inode->i_mapping->a_ops->bmap)
1719 return -EINVAL;
1720
1721 *block = inode->i_mapping->a_ops->bmap(inode->i_mapping, *block);
1722 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724EXPORT_SYMBOL(bmap);
Carlos Maiolino30460e12020-01-09 14:30:41 +01001725#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001727/*
1728 * With relative atime, only update atime if the previous atime is
1729 * earlier than either the ctime or mtime or if at least a day has
1730 * passed since the last atime update.
1731 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001732static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001733 struct timespec64 now)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001734{
1735
Miklos Szeredic6718542018-07-18 15:44:43 +02001736 if (!(mnt->mnt_flags & MNT_RELATIME))
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001737 return 1;
1738 /*
1739 * Is mtime younger than atime? If yes, update atime:
1740 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001741 if (timespec64_compare(&inode->i_mtime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001742 return 1;
1743 /*
1744 * Is ctime younger than atime? If yes, update atime:
1745 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001746 if (timespec64_compare(&inode->i_ctime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001747 return 1;
1748
1749 /*
1750 * Is the previous atime value older than a day? If yes,
1751 * update atime:
1752 */
1753 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1754 return 1;
1755 /*
1756 * Good, we can skip the atime update:
1757 */
1758 return 0;
1759}
1760
Deepa Dinamani95582b02018-05-08 19:36:02 -07001761int generic_update_time(struct inode *inode, struct timespec64 *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001762{
Eric Biggerse20b14d2021-01-12 11:02:45 -08001763 int dirty_flags = 0;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001764
Eric Biggerse20b14d2021-01-12 11:02:45 -08001765 if (flags & (S_ATIME | S_CTIME | S_MTIME)) {
1766 if (flags & S_ATIME)
1767 inode->i_atime = *time;
1768 if (flags & S_CTIME)
1769 inode->i_ctime = *time;
1770 if (flags & S_MTIME)
1771 inode->i_mtime = *time;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001772
Eric Biggerse20b14d2021-01-12 11:02:45 -08001773 if (inode->i_sb->s_flags & SB_LAZYTIME)
1774 dirty_flags |= I_DIRTY_TIME;
1775 else
1776 dirty_flags |= I_DIRTY_SYNC;
1777 }
1778
1779 if ((flags & S_VERSION) && inode_maybe_inc_iversion(inode, false))
1780 dirty_flags |= I_DIRTY_SYNC;
1781
1782 __mark_inode_dirty(inode, dirty_flags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001783 return 0;
1784}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001785EXPORT_SYMBOL(generic_update_time);
1786
1787/*
1788 * This does the actual work of updating an inodes time or version. Must have
1789 * had called mnt_want_write() before calling this.
1790 */
Josef Bacike60feb42021-10-14 13:11:00 -04001791int inode_update_time(struct inode *inode, struct timespec64 *time, int flags)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001792{
Deepa Dinamani23b424d2019-12-02 21:19:45 -08001793 if (inode->i_op->update_time)
1794 return inode->i_op->update_time(inode, time, flags);
1795 return generic_update_time(inode, time, flags);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001796}
Josef Bacike60feb42021-10-14 13:11:00 -04001797EXPORT_SYMBOL(inode_update_time);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001798
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799/**
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001800 * atime_needs_update - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001801 * @path: the &struct path to update
Randy Dunlap30fdc8e2015-11-09 14:57:58 -08001802 * @inode: inode to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 *
1804 * Update the accessed time on an inode and mark it for writeback.
1805 * This function automatically handles read only file systems and media,
1806 * as well as the "noatime" flag and inode specific "noatime" markers.
1807 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001808bool atime_needs_update(const struct path *path, struct inode *inode)
NeilBrown8fa9dd22015-03-23 13:37:40 +11001809{
1810 struct vfsmount *mnt = path->mnt;
Deepa Dinamani95582b02018-05-08 19:36:02 -07001811 struct timespec64 now;
NeilBrown8fa9dd22015-03-23 13:37:40 +11001812
1813 if (inode->i_flags & S_NOATIME)
1814 return false;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001815
1816 /* Atime updates will likely cause i_uid and i_gid to be written
1817 * back improprely if their true value is unknown to the vfs.
1818 */
Christian Braunerba73d982021-01-21 14:19:31 +01001819 if (HAS_UNMAPPED_ID(mnt_user_ns(mnt), inode))
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001820 return false;
1821
NeilBrown8fa9dd22015-03-23 13:37:40 +11001822 if (IS_NOATIME(inode))
1823 return false;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001824 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001825 return false;
1826
1827 if (mnt->mnt_flags & MNT_NOATIME)
1828 return false;
1829 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1830 return false;
1831
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001832 now = current_time(inode);
NeilBrown8fa9dd22015-03-23 13:37:40 +11001833
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001834 if (!relatime_need_update(mnt, inode, now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001835 return false;
1836
Deepa Dinamani95582b02018-05-08 19:36:02 -07001837 if (timespec64_equal(&inode->i_atime, &now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001838 return false;
1839
1840 return true;
1841}
1842
Al Virobadcf2b2013-07-16 18:15:46 +04001843void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844{
Al Viro68ac1232012-03-15 08:21:57 -04001845 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001846 struct inode *inode = d_inode(path->dentry);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001847 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848
Miklos Szeredic6718542018-07-18 15:44:43 +02001849 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001850 return;
1851
Jan Kara5d37e9e2012-06-12 16:20:36 +02001852 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001853 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001854
NeilBrown8fa9dd22015-03-23 13:37:40 +11001855 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001856 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001857 /*
1858 * File systems can error out when updating inodes if they need to
1859 * allocate new space to modify an inode (such is the case for
1860 * Btrfs), but since we touch atime while walking down the path we
1861 * really don't care if we failed to update the atime of the file,
1862 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001863 * We may also fail on filesystems that have the ability to make parts
1864 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001865 */
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001866 now = current_time(inode);
Josef Bacike60feb42021-10-14 13:11:00 -04001867 inode_update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001868 __mnt_drop_write(mnt);
1869skip_update:
1870 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001872EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873
Cong Wang3ed37642012-05-15 14:57:33 +08001874/*
1875 * The logic we want is
1876 *
1877 * if suid or (sgid and xgrp)
1878 * remove privs
1879 */
1880int should_remove_suid(struct dentry *dentry)
1881{
David Howellsdf2b1af2015-03-17 22:26:15 +00001882 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001883 int kill = 0;
1884
1885 /* suid always must be killed */
1886 if (unlikely(mode & S_ISUID))
1887 kill = ATTR_KILL_SUID;
1888
1889 /*
1890 * sgid without any exec bits is just a mandatory locking mark; leave
1891 * it alone. If some exec bits are set, it's a real sgid; kill it.
1892 */
1893 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1894 kill |= ATTR_KILL_SGID;
1895
1896 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1897 return kill;
1898
1899 return 0;
1900}
1901EXPORT_SYMBOL(should_remove_suid);
1902
Jan Karadbfae0c2015-05-21 16:05:54 +02001903/*
1904 * Return mask of changes for notify_change() that need to be done as a
1905 * response to write or truncate. Return 0 if nothing has to be changed.
1906 * Negative value on error (change should be denied).
1907 */
Jan Kara45f147a2015-05-21 16:05:55 +02001908int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001909{
Jan Karadbfae0c2015-05-21 16:05:54 +02001910 struct inode *inode = d_inode(dentry);
1911 int mask = 0;
1912 int ret;
1913
1914 if (IS_NOSEC(inode))
1915 return 0;
1916
1917 mask = should_remove_suid(dentry);
1918 ret = security_inode_need_killpriv(dentry);
1919 if (ret < 0)
1920 return ret;
1921 if (ret)
1922 mask |= ATTR_KILL_PRIV;
1923 return mask;
1924}
Jan Karadbfae0c2015-05-21 16:05:54 +02001925
Christian Brauner643fe552021-01-21 14:19:34 +01001926static int __remove_privs(struct user_namespace *mnt_userns,
1927 struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001928{
1929 struct iattr newattrs;
1930
1931 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001932 /*
1933 * Note we call this on write, so notify_change will not
1934 * encounter any conflicting delegations:
1935 */
Christian Brauner643fe552021-01-21 14:19:34 +01001936 return notify_change(mnt_userns, dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001937}
1938
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001939/*
1940 * Remove special file priviledges (suid, capabilities) when file is written
1941 * to or truncated.
1942 */
1943int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001944{
Miklos Szeredic1892c32016-08-03 13:44:27 +02001945 struct dentry *dentry = file_dentry(file);
1946 struct inode *inode = file_inode(file);
Jan Karadbfae0c2015-05-21 16:05:54 +02001947 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001948 int error = 0;
1949
Alexander Lochmannf69e7492018-12-14 11:55:52 +01001950 /*
1951 * Fast path for nothing security related.
1952 * As well for non-regular files, e.g. blkdev inodes.
1953 * For example, blkdev_write_iter() might get here
1954 * trying to remove privs which it is not allowed to.
1955 */
1956 if (IS_NOSEC(inode) || !S_ISREG(inode->i_mode))
Cong Wang3ed37642012-05-15 14:57:33 +08001957 return 0;
1958
Miklos Szeredic1892c32016-08-03 13:44:27 +02001959 kill = dentry_needs_remove_privs(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001960 if (kill < 0)
1961 return kill;
1962 if (kill)
Christian Brauner643fe552021-01-21 14:19:34 +01001963 error = __remove_privs(file_mnt_user_ns(file), dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001964 if (!error)
1965 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001966
1967 return error;
1968}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001969EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001970
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001972 * file_update_time - update mtime and ctime time
1973 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001975 * Update the mtime and ctime members of an inode and mark the inode
1976 * for writeback. Note that this function is meant exclusively for
1977 * usage in the file write path of filesystems, and filesystems may
1978 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001979 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001980 * timestamps are handled by the server. This can return an error for
1981 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 */
1983
Josef Bacikc3b2da32012-03-26 09:59:21 -04001984int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985{
Al Viro496ad9a2013-01-23 17:07:38 -05001986 struct inode *inode = file_inode(file);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001987 struct timespec64 now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001988 int sync_it = 0;
1989 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990
Andi Kleence06e0b2009-09-18 13:05:48 -07001991 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001993 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001994
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001995 now = current_time(inode);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001996 if (!timespec64_equal(&inode->i_mtime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001997 sync_it = S_MTIME;
1998
Deepa Dinamani95582b02018-05-08 19:36:02 -07001999 if (!timespec64_equal(&inode->i_ctime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07002000 sync_it |= S_CTIME;
2001
Jeff Laytone38cf302017-12-11 06:35:22 -05002002 if (IS_I_VERSION(inode) && inode_iversion_need_inc(inode))
Andi Kleence06e0b2009-09-18 13:05:48 -07002003 sync_it |= S_VERSION;
2004
2005 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04002006 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007
Andi Kleence06e0b2009-09-18 13:05:48 -07002008 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02002009 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04002010 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011
Josef Bacike60feb42021-10-14 13:11:00 -04002012 ret = inode_update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02002013 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04002014
2015 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016}
Christoph Hellwig870f4812006-01-09 20:52:01 -08002017EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018
Amir Goldsteine38f7f52019-06-05 08:04:49 -07002019/* Caller must hold the file's inode lock */
2020int file_modified(struct file *file)
2021{
2022 int err;
2023
2024 /*
2025 * Clear the security bits if the process is not being run by root.
2026 * This keeps people from modifying setuid and setgid binaries.
2027 */
2028 err = file_remove_privs(file);
2029 if (err)
2030 return err;
2031
2032 if (unlikely(file->f_mode & FMODE_NOCMTIME))
2033 return 0;
2034
2035 return file_update_time(file);
2036}
2037EXPORT_SYMBOL(file_modified);
2038
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039int inode_needs_sync(struct inode *inode)
2040{
2041 if (IS_SYNC(inode))
2042 return 1;
2043 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
2044 return 1;
2045 return 0;
2046}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047EXPORT_SYMBOL(inode_needs_sync);
2048
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07002050 * If we try to find an inode in the inode hash while it is being
2051 * deleted, we have to wait until the filesystem completes its
2052 * deletion before reporting that it isn't found. This function waits
2053 * until the deletion _might_ have completed. Callers are responsible
2054 * to recheck inode state.
2055 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002056 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11002057 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
2058 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 */
2060static void __wait_on_freeing_inode(struct inode *inode)
2061{
2062 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002063 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
2064 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Ingo Molnar21417132017-03-05 11:25:39 +01002065 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11002066 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11002067 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 schedule();
Ingo Molnar21417132017-03-05 11:25:39 +01002069 finish_wait(wq, &wait.wq_entry);
Dave Chinner67a23c42011-03-22 22:23:42 +11002070 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071}
2072
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073static __initdata unsigned long ihash_entries;
2074static int __init set_ihash_entries(char *str)
2075{
2076 if (!str)
2077 return 0;
2078 ihash_entries = simple_strtoul(str, &str, 0);
2079 return 1;
2080}
2081__setup("ihash_entries=", set_ihash_entries);
2082
2083/*
2084 * Initialize the waitqueues and inode hash table.
2085 */
2086void __init inode_init_early(void)
2087{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 /* If hashes are distributed across NUMA nodes, defer
2089 * hash allocation until vmalloc space is available.
2090 */
2091 if (hashdist)
2092 return;
2093
2094 inode_hashtable =
2095 alloc_large_system_hash("Inode-cache",
2096 sizeof(struct hlist_head),
2097 ihash_entries,
2098 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002099 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 &i_hash_shift,
2101 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002102 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104}
2105
Denis Cheng74bf17c2007-10-16 23:26:30 -07002106void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08002109 inode_cachep = kmem_cache_create("inode_cache",
2110 sizeof(struct inode),
2111 0,
2112 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
Vladimir Davydov5d097052016-01-14 15:18:21 -08002113 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
Paul Mundt20c2df82007-07-20 10:11:58 +09002114 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115
2116 /* Hash may have been set up in inode_init_early */
2117 if (!hashdist)
2118 return;
2119
2120 inode_hashtable =
2121 alloc_large_system_hash("Inode-cache",
2122 sizeof(struct hlist_head),
2123 ihash_entries,
2124 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002125 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 &i_hash_shift,
2127 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002128 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130}
2131
2132void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
2133{
2134 inode->i_mode = mode;
2135 if (S_ISCHR(mode)) {
2136 inode->i_fop = &def_chr_fops;
2137 inode->i_rdev = rdev;
2138 } else if (S_ISBLK(mode)) {
2139 inode->i_fop = &def_blk_fops;
2140 inode->i_rdev = rdev;
2141 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04002142 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05002144 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07002146 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
2147 " inode %s:%lu\n", mode, inode->i_sb->s_id,
2148 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149}
2150EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002151
2152/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00002153 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Christian Brauner21cb47b2021-01-21 14:19:25 +01002154 * @mnt_userns: User namespace of the mount the inode was created from
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002155 * @inode: New inode
2156 * @dir: Directory inode
2157 * @mode: mode of the new inode
Christian Brauner21cb47b2021-01-21 14:19:25 +01002158 *
2159 * If the inode has been created through an idmapped mount the user namespace of
2160 * the vfsmount must be passed through @mnt_userns. This function will then take
2161 * care to map the inode according to @mnt_userns before checking permissions
2162 * and initializing i_uid and i_gid. On non-idmapped mounts or if permission
2163 * checking is to be performed on the raw inode simply passs init_user_ns.
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002164 */
Christian Brauner21cb47b2021-01-21 14:19:25 +01002165void inode_init_owner(struct user_namespace *mnt_userns, struct inode *inode,
2166 const struct inode *dir, umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002167{
Christian Braunerdb998552021-03-20 13:26:24 +01002168 inode_fsuid_set(inode, mnt_userns);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002169 if (dir && dir->i_mode & S_ISGID) {
2170 inode->i_gid = dir->i_gid;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002171
2172 /* Directories are special, and always inherit S_ISGID */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002173 if (S_ISDIR(mode))
2174 mode |= S_ISGID;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002175 else if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP) &&
Christian Brauner21cb47b2021-01-21 14:19:25 +01002176 !in_group_p(i_gid_into_mnt(mnt_userns, dir)) &&
2177 !capable_wrt_inode_uidgid(mnt_userns, dir, CAP_FSETID))
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002178 mode &= ~S_ISGID;
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002179 } else
Christian Braunerdb998552021-03-20 13:26:24 +01002180 inode_fsgid_set(inode, mnt_userns);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002181 inode->i_mode = mode;
2182}
2183EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07002184
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002185/**
2186 * inode_owner_or_capable - check current task permissions to inode
Christian Brauner21cb47b2021-01-21 14:19:25 +01002187 * @mnt_userns: user namespace of the mount the inode was found from
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002188 * @inode: inode being checked
2189 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002190 * Return true if current either has CAP_FOWNER in a namespace with the
2191 * inode owner uid mapped, or owns the file.
Christian Brauner21cb47b2021-01-21 14:19:25 +01002192 *
2193 * If the inode has been found through an idmapped mount the user namespace of
2194 * the vfsmount must be passed through @mnt_userns. This function will then take
2195 * care to map the inode according to @mnt_userns before checking permissions.
2196 * On non-idmapped mounts or if permission checking is to be performed on the
2197 * raw inode simply passs init_user_ns.
Serge E. Hallyne795b712011-03-23 16:43:25 -07002198 */
Christian Brauner21cb47b2021-01-21 14:19:25 +01002199bool inode_owner_or_capable(struct user_namespace *mnt_userns,
2200 const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07002201{
Christian Brauner21cb47b2021-01-21 14:19:25 +01002202 kuid_t i_uid;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002203 struct user_namespace *ns;
2204
Christian Brauner21cb47b2021-01-21 14:19:25 +01002205 i_uid = i_uid_into_mnt(mnt_userns, inode);
2206 if (uid_eq(current_fsuid(), i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002207 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002208
2209 ns = current_user_ns();
Christian Brauner21cb47b2021-01-21 14:19:25 +01002210 if (kuid_has_mapping(ns, i_uid) && ns_capable(ns, CAP_FOWNER))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002211 return true;
2212 return false;
2213}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002214EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002215
2216/*
2217 * Direct i/o helper functions
2218 */
2219static void __inode_dio_wait(struct inode *inode)
2220{
2221 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2222 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2223
2224 do {
Ingo Molnar21417132017-03-05 11:25:39 +01002225 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002226 if (atomic_read(&inode->i_dio_count))
2227 schedule();
2228 } while (atomic_read(&inode->i_dio_count));
Ingo Molnar21417132017-03-05 11:25:39 +01002229 finish_wait(wq, &q.wq_entry);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002230}
2231
2232/**
2233 * inode_dio_wait - wait for outstanding DIO requests to finish
2234 * @inode: inode to wait for
2235 *
2236 * Waits for all pending direct I/O requests to finish so that we can
2237 * proceed with a truncate or equivalent operation.
2238 *
2239 * Must be called under a lock that serializes taking new references
2240 * to i_dio_count, usually by inode->i_mutex.
2241 */
2242void inode_dio_wait(struct inode *inode)
2243{
2244 if (atomic_read(&inode->i_dio_count))
2245 __inode_dio_wait(inode);
2246}
2247EXPORT_SYMBOL(inode_dio_wait);
2248
2249/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002250 * inode_set_flags - atomically set some inode flags
2251 *
2252 * Note: the caller should be holding i_mutex, or else be sure that
2253 * they have exclusive access to the inode structure (i.e., while the
2254 * inode is being instantiated). The reason for the cmpxchg() loop
2255 * --- which wouldn't be necessary if all code paths which modify
2256 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002257 * code path which doesn't today so we use cmpxchg() out of an abundance
2258 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002259 *
2260 * In the long run, i_mutex is overkill, and we should probably look
2261 * at using the i_lock spinlock to protect i_flags, and then make sure
2262 * it is so documented in include/linux/fs.h and that all code follows
2263 * the locking convention!!
2264 */
2265void inode_set_flags(struct inode *inode, unsigned int flags,
2266 unsigned int mask)
2267{
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002268 WARN_ON_ONCE(flags & ~mask);
Vineet Guptaa9057372019-03-05 15:41:52 -08002269 set_mask_bits(&inode->i_flags, mask, flags);
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002270}
2271EXPORT_SYMBOL(inode_set_flags);
Al Viro21fc61c2015-11-17 01:07:57 -05002272
2273void inode_nohighmem(struct inode *inode)
2274{
2275 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2276}
2277EXPORT_SYMBOL(inode_nohighmem);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002278
2279/**
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002280 * timestamp_truncate - Truncate timespec to a granularity
2281 * @t: Timespec
2282 * @inode: inode being updated
2283 *
2284 * Truncate a timespec to the granularity supported by the fs
2285 * containing the inode. Always rounds down. gran must
2286 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2287 */
2288struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode)
2289{
2290 struct super_block *sb = inode->i_sb;
2291 unsigned int gran = sb->s_time_gran;
2292
2293 t.tv_sec = clamp(t.tv_sec, sb->s_time_min, sb->s_time_max);
2294 if (unlikely(t.tv_sec == sb->s_time_max || t.tv_sec == sb->s_time_min))
2295 t.tv_nsec = 0;
2296
2297 /* Avoid division in the common cases 1 ns and 1 s. */
2298 if (gran == 1)
2299 ; /* nothing */
2300 else if (gran == NSEC_PER_SEC)
2301 t.tv_nsec = 0;
2302 else if (gran > 1 && gran < NSEC_PER_SEC)
2303 t.tv_nsec -= t.tv_nsec % gran;
2304 else
2305 WARN(1, "invalid file time granularity: %u", gran);
2306 return t;
2307}
2308EXPORT_SYMBOL(timestamp_truncate);
2309
2310/**
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002311 * current_time - Return FS time
2312 * @inode: inode.
2313 *
2314 * Return the current time truncated to the time granularity supported by
2315 * the fs.
2316 *
2317 * Note that inode and inode->sb cannot be NULL.
2318 * Otherwise, the function warns and returns time without truncation.
2319 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07002320struct timespec64 current_time(struct inode *inode)
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002321{
Arnd Bergmannd651d162018-12-05 11:14:27 +11002322 struct timespec64 now;
2323
2324 ktime_get_coarse_real_ts64(&now);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002325
2326 if (unlikely(!inode->i_sb)) {
2327 WARN(1, "current_time() called with uninitialized super_block in the inode");
2328 return now;
2329 }
2330
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002331 return timestamp_truncate(now, inode);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002332}
2333EXPORT_SYMBOL(current_time);