blob: a49695f57e1eaa2f047c93b77f40f9269ea32aa5 [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;
Matthew Wilcox (Oracle)01c70262020-10-15 20:06:00 -0700183 if (sb->s_type->fs_flags & FS_THP_SUPPORT)
184 __set_bit(AS_THP_SUPPORT, &mapping->flags);
Darrick J. Wong829bc7872018-05-30 19:43:53 -0700185 mapping->wb_err = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700186 atomic_set(&mapping->i_mmap_writable, 0);
Song Liu09d91cd2019-09-23 15:38:03 -0700187#ifdef CONFIG_READ_ONLY_THP_FOR_FS
188 atomic_set(&mapping->nr_thps, 0);
189#endif
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800190 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800191 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100192 mapping->writeback_index = 0;
Sebastian Andrzej Siewior23ca0672021-09-01 10:44:03 +0200193 init_rwsem(&mapping->invalidate_lock);
194 lockdep_set_class_and_name(&mapping->invalidate_lock,
195 &sb->s_type->invalidate_lock_key,
196 "mapping.invalidate_lock");
David Chinner2cb15992008-10-30 17:32:23 +1100197 inode->i_private = NULL;
198 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400199 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400200#ifdef CONFIG_FS_POSIX_ACL
201 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
202#endif
David Chinner2cb15992008-10-30 17:32:23 +1100203
Eric Paris3be25f42009-05-21 17:01:26 -0400204#ifdef CONFIG_FSNOTIFY
205 inode->i_fsnotify_mask = 0;
206#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500207 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100208 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400209
Christoph Hellwig54e34622009-08-07 14:38:25 -0300210 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300211out:
212 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100213}
214EXPORT_SYMBOL(inode_init_always);
215
Al Virofdb0da82019-04-10 14:43:44 -0400216void free_inode_nonrcu(struct inode *inode)
217{
218 kmem_cache_free(inode_cachep, inode);
219}
220EXPORT_SYMBOL(free_inode_nonrcu);
221
222static void i_callback(struct rcu_head *head)
223{
224 struct inode *inode = container_of(head, struct inode, i_rcu);
225 if (inode->free_inode)
226 inode->free_inode(inode);
227 else
228 free_inode_nonrcu(inode);
229}
230
David Chinner2cb15992008-10-30 17:32:23 +1100231static struct inode *alloc_inode(struct super_block *sb)
232{
Al Virofdb0da82019-04-10 14:43:44 -0400233 const struct super_operations *ops = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 struct inode *inode;
235
Al Virofdb0da82019-04-10 14:43:44 -0400236 if (ops->alloc_inode)
237 inode = ops->alloc_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 else
David Chinner2cb15992008-10-30 17:32:23 +1100239 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Christoph Hellwig54e34622009-08-07 14:38:25 -0300241 if (!inode)
242 return NULL;
243
244 if (unlikely(inode_init_always(sb, inode))) {
Al Virofdb0da82019-04-10 14:43:44 -0400245 if (ops->destroy_inode) {
246 ops->destroy_inode(inode);
247 if (!ops->free_inode)
248 return NULL;
249 }
250 inode->free_inode = ops->free_inode;
251 i_callback(&inode->i_rcu);
Christoph Hellwig54e34622009-08-07 14:38:25 -0300252 return NULL;
253 }
254
255 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256}
257
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300258void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200260 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400261 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400263 fsnotify_inode_delete(inode);
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500264 locks_free_lock_context(inode);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100265 if (!inode->i_nlink) {
266 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
267 atomic_long_dec(&inode->i_sb->s_remove_count);
268 }
269
Al Virof19d4a82009-06-08 19:50:45 -0400270#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100271 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400272 posix_acl_release(inode->i_acl);
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100273 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400274 posix_acl_release(inode->i_default_acl);
275#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100276 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300277}
278EXPORT_SYMBOL(__destroy_inode);
279
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200280static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300281{
Al Virofdb0da82019-04-10 14:43:44 -0400282 const struct super_operations *ops = inode->i_sb->s_op;
283
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100284 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300285 __destroy_inode(inode);
Al Virofdb0da82019-04-10 14:43:44 -0400286 if (ops->destroy_inode) {
287 ops->destroy_inode(inode);
288 if (!ops->free_inode)
289 return;
290 }
291 inode->free_inode = ops->free_inode;
292 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100295/**
296 * drop_nlink - directly drop an inode's link count
297 * @inode: inode
298 *
299 * This is a low-level filesystem helper to replace any
300 * direct filesystem manipulation of i_nlink. In cases
301 * where we are attempting to track writes to the
302 * filesystem, a decrement to zero means an imminent
303 * write when the file is truncated and actually unlinked
304 * on the filesystem.
305 */
306void drop_nlink(struct inode *inode)
307{
308 WARN_ON(inode->i_nlink == 0);
309 inode->__i_nlink--;
310 if (!inode->i_nlink)
311 atomic_long_inc(&inode->i_sb->s_remove_count);
312}
313EXPORT_SYMBOL(drop_nlink);
314
315/**
316 * clear_nlink - directly zero an inode's link count
317 * @inode: inode
318 *
319 * This is a low-level filesystem helper to replace any
320 * direct filesystem manipulation of i_nlink. See
321 * drop_nlink() for why we care about i_nlink hitting zero.
322 */
323void clear_nlink(struct inode *inode)
324{
325 if (inode->i_nlink) {
326 inode->__i_nlink = 0;
327 atomic_long_inc(&inode->i_sb->s_remove_count);
328 }
329}
330EXPORT_SYMBOL(clear_nlink);
331
332/**
333 * set_nlink - directly set an inode's link count
334 * @inode: inode
335 * @nlink: new nlink (should be non-zero)
336 *
337 * This is a low-level filesystem helper to replace any
338 * direct filesystem manipulation of i_nlink.
339 */
340void set_nlink(struct inode *inode, unsigned int nlink)
341{
342 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100343 clear_nlink(inode);
344 } else {
345 /* Yes, some filesystems do change nlink from zero to one */
346 if (inode->i_nlink == 0)
347 atomic_long_dec(&inode->i_sb->s_remove_count);
348
349 inode->__i_nlink = nlink;
350 }
351}
352EXPORT_SYMBOL(set_nlink);
353
354/**
355 * inc_nlink - directly increment an inode's link count
356 * @inode: inode
357 *
358 * This is a low-level filesystem helper to replace any
359 * direct filesystem manipulation of i_nlink. Currently,
360 * it is only here for parity with dec_nlink().
361 */
362void inc_nlink(struct inode *inode)
363{
Al Virof4e0c302013-06-11 08:34:36 +0400364 if (unlikely(inode->i_nlink == 0)) {
365 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100366 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400367 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100368
369 inode->__i_nlink++;
370}
371EXPORT_SYMBOL(inc_nlink);
372
Dave Chinnerae233952018-03-06 17:30:34 -0800373static void __address_space_init_once(struct address_space *mapping)
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100374{
Johannes Weiner7b785642019-05-24 10:12:46 -0400375 xa_init_flags(&mapping->i_pages, XA_FLAGS_LOCK_IRQ | XA_FLAGS_ACCOUNT);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800376 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100377 INIT_LIST_HEAD(&mapping->private_list);
378 spin_lock_init(&mapping->private_lock);
Davidlohr Buesof808c132017-09-08 16:15:08 -0700379 mapping->i_mmap = RB_ROOT_CACHED;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100380}
Dave Chinnerae233952018-03-06 17:30:34 -0800381
382void address_space_init_once(struct address_space *mapping)
383{
384 memset(mapping, 0, sizeof(*mapping));
385 __address_space_init_once(mapping);
386}
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100387EXPORT_SYMBOL(address_space_init_once);
388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389/*
390 * These are initializations that only need to be done
391 * once, because the fields are idempotent across use
392 * of the inode, so let the slab aware of that.
393 */
394void inode_init_once(struct inode *inode)
395{
396 memset(inode, 0, sizeof(*inode));
397 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500399 INIT_LIST_HEAD(&inode->i_io_list);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700400 INIT_LIST_HEAD(&inode->i_wb_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100401 INIT_LIST_HEAD(&inode->i_lru);
Dave Chinnerae233952018-03-06 17:30:34 -0800402 __address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 i_size_ordered_init(inode);
404}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405EXPORT_SYMBOL(inode_init_once);
406
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700407static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530409 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Christoph Lametera35afb82007-05-16 22:10:57 -0700411 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412}
413
414/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100415 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530417void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
Nick Piggin9e38d862010-10-23 06:55:17 -0400419 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420}
421
Al Viro7de9c6ee2010-10-23 11:11:40 -0400422/*
423 * get additional reference to inode; caller must already hold one.
424 */
425void ihold(struct inode *inode)
426{
427 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
428}
429EXPORT_SYMBOL(ihold);
430
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800431static void __inode_add_lru(struct inode *inode, bool rotate)
Nick Piggin9e38d862010-10-23 06:55:17 -0400432{
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800433 if (inode->i_state & (I_DIRTY_ALL | I_SYNC | I_FREEING | I_WILL_FREE))
434 return;
435 if (atomic_read(&inode->i_count))
436 return;
437 if (!(inode->i_sb->s_flags & SB_ACTIVE))
438 return;
439 if (!mapping_shrinkable(&inode->i_data))
440 return;
441
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000442 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000443 this_cpu_inc(nr_unused);
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800444 else if (rotate)
Josef Bacik563f4002017-04-18 16:04:17 -0400445 inode->i_state |= I_REFERENCED;
Nick Piggin9e38d862010-10-23 06:55:17 -0400446}
447
Jan Kara4eff96d2012-11-26 16:29:51 -0800448/*
449 * Add inode to LRU if needed (inode is unused and clean).
450 *
451 * Needs inode->i_lock held.
452 */
453void inode_add_lru(struct inode *inode)
454{
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800455 __inode_add_lru(inode, false);
Jan Kara4eff96d2012-11-26 16:29:51 -0800456}
457
Nick Piggin9e38d862010-10-23 06:55:17 -0400458static void inode_lru_list_del(struct inode *inode)
459{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000460 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000461 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462}
463
Christoph Hellwig646ec462010-10-23 07:15:32 -0400464/**
465 * inode_sb_list_add - add inode to the superblock list of inodes
466 * @inode: inode to add
467 */
468void inode_sb_list_add(struct inode *inode)
469{
Dave Chinner74278da2015-03-04 12:37:22 -0500470 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100471 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500472 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400473}
474EXPORT_SYMBOL_GPL(inode_sb_list_add);
475
Dave Chinner55fa6092011-03-22 22:23:40 +1100476static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400477{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200478 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500479 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200480 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500481 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200482 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400483}
484
Dave Chinner4c51acb2010-10-23 06:58:09 -0400485static unsigned long hash(struct super_block *sb, unsigned long hashval)
486{
487 unsigned long tmp;
488
489 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
490 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400491 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
492 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400493}
494
495/**
496 * __insert_inode_hash - hash an inode
497 * @inode: unhashed inode
498 * @hashval: unsigned long value used to locate this object in the
499 * inode_hashtable.
500 *
501 * Add an inode to the inode hash for this superblock.
502 */
503void __insert_inode_hash(struct inode *inode, unsigned long hashval)
504{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400505 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
506
Dave Chinner67a23c42011-03-22 22:23:42 +1100507 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100508 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000509 hlist_add_head_rcu(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100510 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100511 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400512}
513EXPORT_SYMBOL(__insert_inode_hash);
514
515/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200516 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400517 * @inode: inode to unhash
518 *
519 * Remove an inode from the superblock.
520 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200521void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400522{
Dave Chinner67a23c42011-03-22 22:23:42 +1100523 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100524 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000525 hlist_del_init_rcu(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100526 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100527 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400528}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200529EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400530
Jan Karadbd57682012-05-03 14:48:02 +0200531void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400532{
Jan Kara08142572011-06-27 16:18:10 -0700533 /*
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700534 * We have to cycle the i_pages lock here because reclaim can be in the
Jan Kara08142572011-06-27 16:18:10 -0700535 * process of removing the last page (in __delete_from_page_cache())
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700536 * and we must not free the mapping under it.
Jan Kara08142572011-06-27 16:18:10 -0700537 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700538 xa_lock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400539 BUG_ON(inode->i_data.nrpages);
Hugh Dickins786b3112021-05-04 18:32:57 -0700540 /*
541 * Almost always, mapping_empty(&inode->i_data) here; but there are
542 * two known and long-standing ways in which nodes may get left behind
543 * (when deep radix-tree node allocation failed partway; or when THP
544 * collapse_file() failed). Until those two known cases are cleaned up,
545 * or a cleanup function is called here, do not BUG_ON(!mapping_empty),
546 * nor even WARN_ON(!mapping_empty).
547 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700548 xa_unlock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400549 BUG_ON(!list_empty(&inode->i_data.private_list));
550 BUG_ON(!(inode->i_state & I_FREEING));
551 BUG_ON(inode->i_state & I_CLEAR);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700552 BUG_ON(!list_empty(&inode->i_wb_list));
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100553 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400554 inode->i_state = I_FREEING | I_CLEAR;
555}
Jan Karadbd57682012-05-03 14:48:02 +0200556EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400557
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100558/*
559 * Free the inode passed in, removing it from the lists it is still connected
560 * to. We remove any pages still attached to the inode and wait for any IO that
561 * is still in progress before finally destroying the inode.
562 *
563 * An inode must already be marked I_FREEING so that we avoid the inode being
564 * moved back onto lists if we race with other code that manipulates the lists
565 * (e.g. writeback_single_inode). The caller is responsible for setting this.
566 *
567 * An inode must already be removed from the LRU list before being evicted from
568 * the cache. This should occur atomically with setting the I_FREEING state
569 * flag, so no inodes here should ever be on the LRU when being evicted.
570 */
Al Viro644da592010-06-07 13:21:05 -0400571static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400572{
573 const struct super_operations *op = inode->i_sb->s_op;
574
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100575 BUG_ON(!(inode->i_state & I_FREEING));
576 BUG_ON(!list_empty(&inode->i_lru));
577
Dave Chinnerc7f54082015-03-04 14:07:22 -0500578 if (!list_empty(&inode->i_io_list))
579 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200580
Dave Chinner55fa6092011-03-22 22:23:40 +1100581 inode_sb_list_del(inode);
582
Jan Kara169ebd92012-05-03 14:48:03 +0200583 /*
584 * Wait for flusher thread to be done with the inode so that filesystem
585 * does not start destroying it while writeback is still running. Since
586 * the inode has I_FREEING set, flusher thread won't start new work on
587 * the inode. We just have to wait for running writeback to finish.
588 */
589 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200590
Al Virobe7ce412010-06-04 19:40:39 -0400591 if (op->evict_inode) {
592 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400593 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700594 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200595 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400596 }
Al Viro661074e2010-06-04 20:19:55 -0400597 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
598 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100599
600 remove_inode_hash(inode);
601
602 spin_lock(&inode->i_lock);
603 wake_up_bit(&inode->i_state, __I_NEW);
604 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
605 spin_unlock(&inode->i_lock);
606
607 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400608}
609
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610/*
611 * dispose_list - dispose of the contents of a local list
612 * @head: the head of the list to free
613 *
614 * Dispose-list gets a local list with local inodes in it, so it doesn't
615 * need to worry about list corruption and SMP locks.
616 */
617static void dispose_list(struct list_head *head)
618{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 while (!list_empty(head)) {
620 struct inode *inode;
621
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100622 inode = list_first_entry(head, struct inode, i_lru);
623 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
Al Viro644da592010-06-07 13:21:05 -0400625 evict(inode);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500626 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628}
629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630/**
Al Viro63997e92010-10-25 20:49:35 -0400631 * evict_inodes - evict all evictable inodes for a superblock
632 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 *
Al Viro63997e92010-10-25 20:49:35 -0400634 * Make sure that no inodes with zero refcount are retained. This is
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800635 * called by superblock shutdown after having SB_ACTIVE flag removed,
Al Viro63997e92010-10-25 20:49:35 -0400636 * so any inode reaching zero refcount during or after that call will
637 * be immediately evicted.
638 */
639void evict_inodes(struct super_block *sb)
640{
641 struct inode *inode, *next;
642 LIST_HEAD(dispose);
643
Josef Bacikac05fbb2015-03-04 16:52:52 -0500644again:
Dave Chinner74278da2015-03-04 12:37:22 -0500645 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400646 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
647 if (atomic_read(&inode->i_count))
648 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100649
650 spin_lock(&inode->i_lock);
651 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
652 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400653 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100654 }
Al Viro63997e92010-10-25 20:49:35 -0400655
656 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100657 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100658 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100659 list_add(&inode->i_lru, &dispose);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500660
661 /*
662 * We can have a ton of inodes to evict at unmount time given
663 * enough memory, check to see if we need to go to sleep for a
664 * bit so we don't livelock.
665 */
666 if (need_resched()) {
667 spin_unlock(&sb->s_inode_list_lock);
668 cond_resched();
669 dispose_list(&dispose);
670 goto again;
671 }
Al Viro63997e92010-10-25 20:49:35 -0400672 }
Dave Chinner74278da2015-03-04 12:37:22 -0500673 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400674
675 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400676}
Darrick J. Wong799ea9e2017-08-18 18:08:25 -0700677EXPORT_SYMBOL_GPL(evict_inodes);
Al Viro63997e92010-10-25 20:49:35 -0400678
679/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200680 * invalidate_inodes - attempt to free all inodes on a superblock
681 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100682 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200683 *
684 * Attempts to free all inodes for a given superblock. If there were any
685 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100686 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
687 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 */
NeilBrown93b270f2011-02-24 17:25:47 +1100689int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400691 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200692 struct inode *inode, *next;
693 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Eric Sandeen04646ae2019-12-06 10:54:23 -0600695again:
Dave Chinner74278da2015-03-04 12:37:22 -0500696 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200697 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100698 spin_lock(&inode->i_lock);
699 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
700 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100702 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500703 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100704 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100705 busy = 1;
706 continue;
707 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200708 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100709 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200710 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 continue;
712 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200713
Christoph Hellwig99a38912010-10-23 19:07:20 +0200714 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100715 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100716 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100717 list_add(&inode->i_lru, &dispose);
Eric Sandeen04646ae2019-12-06 10:54:23 -0600718 if (need_resched()) {
719 spin_unlock(&sb->s_inode_list_lock);
720 cond_resched();
721 dispose_list(&dispose);
722 goto again;
723 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 }
Dave Chinner74278da2015-03-04 12:37:22 -0500725 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Christoph Hellwiga0318782010-10-24 19:40:33 +0200727 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
729 return busy;
730}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000733 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400735 * If the inode has the I_REFERENCED flag set, then it means that it has been
736 * used recently - the flag is set in iput_final(). When we encounter such an
737 * inode, clear the flag and move it to the back of the LRU so it gets another
738 * pass through the LRU before it gets reclaimed. This is necessary because of
739 * the fact we are doing lazy LRU updates to minimise lock contention so the
740 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
741 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800743static enum lru_status inode_lru_isolate(struct list_head *item,
744 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000745{
746 struct list_head *freeable = arg;
747 struct inode *inode = container_of(item, struct inode, i_lru);
748
749 /*
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800750 * We are inverting the lru lock/inode->i_lock here, so use a
751 * trylock. If we fail to get the lock, just skip it.
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000752 */
753 if (!spin_trylock(&inode->i_lock))
754 return LRU_SKIP;
755
756 /*
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800757 * Inodes can get referenced, redirtied, or repopulated while
758 * they're already on the LRU, and this can make them
759 * unreclaimable for a while. Remove them lazily here; iput,
760 * sync, or the last page cache deletion will requeue them.
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000761 */
762 if (atomic_read(&inode->i_count) ||
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800763 (inode->i_state & ~I_REFERENCED) ||
764 !mapping_shrinkable(&inode->i_data)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800765 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000766 spin_unlock(&inode->i_lock);
767 this_cpu_dec(nr_unused);
768 return LRU_REMOVED;
769 }
770
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800771 /* Recently referenced inodes get one more pass */
Dave Chinner69056ee2019-02-12 15:35:51 -0800772 if (inode->i_state & I_REFERENCED) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000773 inode->i_state &= ~I_REFERENCED;
774 spin_unlock(&inode->i_lock);
775 return LRU_ROTATE;
776 }
777
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800778 /*
779 * On highmem systems, mapping_shrinkable() permits dropping
780 * page cache in order to free up struct inodes: lowmem might
781 * be under pressure before the cache inside the highmem zone.
782 */
Johannes Weiner7ae12c82021-09-02 14:53:24 -0700783 if (inode_has_buffers(inode) || !mapping_empty(&inode->i_data)) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000784 __iget(inode);
785 spin_unlock(&inode->i_lock);
786 spin_unlock(lru_lock);
787 if (remove_inode_buffers(inode)) {
788 unsigned long reap;
789 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
790 if (current_is_kswapd())
791 __count_vm_events(KSWAPD_INODESTEAL, reap);
792 else
793 __count_vm_events(PGINODESTEAL, reap);
794 if (current->reclaim_state)
795 current->reclaim_state->reclaimed_slab += reap;
796 }
797 iput(inode);
798 spin_lock(lru_lock);
799 return LRU_RETRY;
800 }
801
802 WARN_ON(inode->i_state & I_NEW);
803 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800804 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000805 spin_unlock(&inode->i_lock);
806
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000807 this_cpu_dec(nr_unused);
808 return LRU_REMOVED;
809}
810
811/*
812 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
813 * This is called from the superblock shrinker function with a number of inodes
814 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
815 * then are freed outside inode_lock by dispose_list().
816 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800817long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818{
819 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000820 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
Vladimir Davydov503c3582015-02-12 14:58:47 -0800822 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
823 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000825 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826}
827
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828static void __wait_on_freeing_inode(struct inode *inode);
829/*
830 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530832static struct inode *find_inode(struct super_block *sb,
833 struct hlist_head *head,
834 int (*test)(struct inode *, void *),
835 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530837 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
839repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800840 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500841 if (inode->i_sb != sb)
842 continue;
843 if (!test(inode, data))
844 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100845 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400846 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 __wait_on_freeing_inode(inode);
848 goto repeat;
849 }
Al Viroc2b6d622018-06-28 15:53:17 -0400850 if (unlikely(inode->i_state & I_CREATING)) {
851 spin_unlock(&inode->i_lock);
852 return ERR_PTR(-ESTALE);
853 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400854 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100855 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400856 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400858 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859}
860
861/*
862 * find_inode_fast is the fast path version of find_inode, see the comment at
863 * iget_locked for details.
864 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530865static struct inode *find_inode_fast(struct super_block *sb,
866 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530868 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
870repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800871 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500872 if (inode->i_ino != ino)
873 continue;
874 if (inode->i_sb != sb)
875 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100876 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400877 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 __wait_on_freeing_inode(inode);
879 goto repeat;
880 }
Al Viroc2b6d622018-06-28 15:53:17 -0400881 if (unlikely(inode->i_state & I_CREATING)) {
882 spin_unlock(&inode->i_lock);
883 return ERR_PTR(-ESTALE);
884 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400885 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100886 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400887 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400889 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890}
891
Eric Dumazetf991bd22010-10-23 11:18:01 -0400892/*
893 * Each cpu owns a range of LAST_INO_BATCH numbers.
894 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
895 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100896 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400897 * This does not significantly increase overflow rate because every CPU can
898 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
899 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
900 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
901 * overflow rate by 2x, which does not seem too significant.
902 *
903 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
904 * error if st_ino won't fit in target struct field. Use 32bit counter
905 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100906 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400907#define LAST_INO_BATCH 1024
908static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100909
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400910unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400911{
912 unsigned int *p = &get_cpu_var(last_ino);
913 unsigned int res = *p;
914
915#ifdef CONFIG_SMP
916 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
917 static atomic_t shared_last_ino;
918 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
919
920 res = next - LAST_INO_BATCH;
921 }
922#endif
923
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300924 res++;
925 /* get_next_ino should not provide a 0 inode number */
926 if (unlikely(!res))
927 res++;
928 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400929 put_cpu_var(last_ino);
930 return res;
David Chinner8290c352008-10-30 17:35:24 +1100931}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400932EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100933
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200935 * new_inode_pseudo - obtain an inode
936 * @sb: superblock
937 *
938 * Allocates a new inode for given superblock.
939 * Inode wont be chained in superblock s_inodes list
940 * This means :
941 * - fs can't be unmount
942 * - quotas, fsnotify, writeback can't work
943 */
944struct inode *new_inode_pseudo(struct super_block *sb)
945{
946 struct inode *inode = alloc_inode(sb);
947
948 if (inode) {
949 spin_lock(&inode->i_lock);
950 inode->i_state = 0;
951 spin_unlock(&inode->i_lock);
952 INIT_LIST_HEAD(&inode->i_sb_list);
953 }
954 return inode;
955}
956
957/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 * new_inode - obtain an inode
959 * @sb: superblock
960 *
Mel Gorman769848c2007-07-17 04:03:05 -0700961 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800962 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700963 * If HIGHMEM pages are unsuitable or it is known that pages allocated
964 * for the page cache are not reclaimable or migratable,
965 * mapping_set_gfp_mask() must be called with suitable flags on the
966 * newly created inode's mapping
967 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 */
969struct inode *new_inode(struct super_block *sb)
970{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530971 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
Dave Chinner74278da2015-03-04 12:37:22 -0500973 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530974
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200975 inode = new_inode_pseudo(sb);
976 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100977 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 return inode;
979}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980EXPORT_SYMBOL(new_inode);
981
Peter Zijlstra14358e62007-10-14 01:38:33 +0200982#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400983void lockdep_annotate_inode_mutex_key(struct inode *inode)
984{
Namhyung Kima3314a02010-10-11 22:38:00 +0900985 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200986 struct file_system_type *type = inode->i_sb->s_type;
987
Jan Kara9a7aa122009-06-04 15:26:49 +0200988 /* Set new key only if filesystem hasn't already changed it */
Al Viro9902af72016-04-15 15:08:36 -0400989 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200990 /*
991 * ensure nobody is actually holding i_mutex
992 */
Al Viro9902af72016-04-15 15:08:36 -0400993 // mutex_destroy(&inode->i_mutex);
994 init_rwsem(&inode->i_rwsem);
995 lockdep_set_class(&inode->i_rwsem,
Jan Kara9a7aa122009-06-04 15:26:49 +0200996 &type->i_mutex_dir_key);
997 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200998 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400999}
1000EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +02001001#endif
Josh Boyere096d0c2011-08-25 07:48:12 -04001002
1003/**
1004 * unlock_new_inode - clear the I_NEW state and wake up any waiters
1005 * @inode: new inode to unlock
1006 *
1007 * Called when the inode is fully initialised to clear the new state of the
1008 * inode and wake up anyone waiting for the inode to finish initialisation.
1009 */
1010void unlock_new_inode(struct inode *inode)
1011{
1012 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001013 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001014 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -04001015 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro310fa7a2012-03-10 17:07:28 -05001016 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +11001017 wake_up_bit(&inode->i_state, __I_NEW);
1018 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020EXPORT_SYMBOL(unlock_new_inode);
1021
Al Viroc2b6d622018-06-28 15:53:17 -04001022void discard_new_inode(struct inode *inode)
1023{
1024 lockdep_annotate_inode_mutex_key(inode);
1025 spin_lock(&inode->i_lock);
1026 WARN_ON(!(inode->i_state & I_NEW));
1027 inode->i_state &= ~I_NEW;
1028 smp_mb();
1029 wake_up_bit(&inode->i_state, __I_NEW);
1030 spin_unlock(&inode->i_lock);
1031 iput(inode);
1032}
1033EXPORT_SYMBOL(discard_new_inode);
1034
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001035/**
J. Bruce Fields375e2892012-04-18 15:16:33 -04001036 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001037 *
1038 * Lock any non-NULL argument that is not a directory.
1039 * Zero, one or two objects may be locked by this function.
1040 *
J. Bruce Fields375e2892012-04-18 15:16:33 -04001041 * @inode1: first inode to lock
1042 * @inode2: second inode to lock
1043 */
1044void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1045{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001046 if (inode1 > inode2)
1047 swap(inode1, inode2);
1048
1049 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001050 inode_lock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001051 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001052 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001053}
1054EXPORT_SYMBOL(lock_two_nondirectories);
1055
1056/**
1057 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
1058 * @inode1: first inode to unlock
1059 * @inode2: second inode to unlock
1060 */
1061void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1062{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001063 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001064 inode_unlock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001065 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001066 inode_unlock(inode2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001067}
1068EXPORT_SYMBOL(unlock_two_nondirectories);
1069
1070/**
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001071 * inode_insert5 - obtain an inode from a mounted file system
1072 * @inode: pre-allocated inode to use for insert to cache
1073 * @hashval: hash value (usually inode number) to get
1074 * @test: callback used for comparisons between inodes
1075 * @set: callback used to initialize a new struct inode
1076 * @data: opaque data pointer to pass to @test and @set
1077 *
1078 * Search for the inode specified by @hashval and @data in the inode cache,
1079 * and if present it is return it with an increased reference count. This is
1080 * a variant of iget5_locked() for callers that don't want to fail on memory
1081 * allocation of inode.
1082 *
1083 * If the inode is not in cache, insert the pre-allocated inode to cache and
1084 * return it locked, hashed, and with the I_NEW flag set. The file system gets
1085 * to fill it in before unlocking it via unlock_new_inode().
1086 *
1087 * Note both @test and @set are called with the inode_hash_lock held, so can't
1088 * sleep.
1089 */
1090struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
1091 int (*test)(struct inode *, void *),
1092 int (*set)(struct inode *, void *), void *data)
1093{
1094 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1095 struct inode *old;
Miklos Szeredie9505642018-07-24 15:01:55 +02001096 bool creating = inode->i_state & I_CREATING;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001097
1098again:
1099 spin_lock(&inode_hash_lock);
1100 old = find_inode(inode->i_sb, head, test, data);
1101 if (unlikely(old)) {
1102 /*
1103 * Uhhuh, somebody else created the same inode under us.
1104 * Use the old inode instead of the preallocated one.
1105 */
1106 spin_unlock(&inode_hash_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001107 if (IS_ERR(old))
1108 return NULL;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001109 wait_on_inode(old);
1110 if (unlikely(inode_unhashed(old))) {
1111 iput(old);
1112 goto again;
1113 }
1114 return old;
1115 }
1116
1117 if (set && unlikely(set(inode, data))) {
1118 inode = NULL;
1119 goto unlock;
1120 }
1121
1122 /*
1123 * Return the locked inode with I_NEW set, the
1124 * caller is responsible for filling in the contents
1125 */
1126 spin_lock(&inode->i_lock);
1127 inode->i_state |= I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001128 hlist_add_head_rcu(&inode->i_hash, head);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001129 spin_unlock(&inode->i_lock);
Miklos Szeredie9505642018-07-24 15:01:55 +02001130 if (!creating)
1131 inode_sb_list_add(inode);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001132unlock:
1133 spin_unlock(&inode_hash_lock);
1134
1135 return inode;
1136}
1137EXPORT_SYMBOL(inode_insert5);
1138
1139/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001140 * iget5_locked - obtain an inode from a mounted file system
1141 * @sb: super block of file system
1142 * @hashval: hash value (usually inode number) to get
1143 * @test: callback used for comparisons between inodes
1144 * @set: callback used to initialize a new struct inode
1145 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001147 * Search for the inode specified by @hashval and @data in the inode cache,
1148 * and if present it is return it with an increased reference count. This is
1149 * a generalized version of iget_locked() for file systems where the inode
1150 * number is not sufficient for unique identification of an inode.
1151 *
1152 * If the inode is not in cache, allocate a new inode and return it locked,
1153 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1154 * before unlocking it via unlock_new_inode().
1155 *
1156 * Note both @test and @set are called with the inode_hash_lock held, so can't
1157 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001159struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1160 int (*test)(struct inode *, void *),
1161 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162{
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001163 struct inode *inode = ilookup5(sb, hashval, test, data);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001164
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001165 if (!inode) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001166 struct inode *new = alloc_inode(sb);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001167
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001168 if (new) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001169 new->i_state = 0;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001170 inode = inode_insert5(new, hashval, test, set, data);
1171 if (unlikely(inode != new))
Miklos Szeredie9505642018-07-24 15:01:55 +02001172 destroy_inode(new);
Al Viro2864f302016-07-03 23:15:21 -04001173 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 }
1175 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001177EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001179/**
1180 * iget_locked - obtain an inode from a mounted file system
1181 * @sb: super block of file system
1182 * @ino: inode number to get
1183 *
1184 * Search for the inode specified by @ino in the inode cache and if present
1185 * return it with an increased reference count. This is for file systems
1186 * where the inode number is sufficient for unique identification of an inode.
1187 *
1188 * If the inode is not in cache, allocate a new inode and return it locked,
1189 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1190 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001192struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001194 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301195 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001196again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001197 spin_lock(&inode_hash_lock);
1198 inode = find_inode_fast(sb, head, ino);
1199 spin_unlock(&inode_hash_lock);
1200 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001201 if (IS_ERR(inode))
1202 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001203 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001204 if (unlikely(inode_unhashed(inode))) {
1205 iput(inode);
1206 goto again;
1207 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001208 return inode;
1209 }
1210
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 inode = alloc_inode(sb);
1212 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301213 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214
Dave Chinner67a23c42011-03-22 22:23:42 +11001215 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 /* We released the lock, so.. */
1217 old = find_inode_fast(sb, head, ino);
1218 if (!old) {
1219 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001220 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001221 inode->i_state = I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001222 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001223 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001224 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001225 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
1227 /* Return the locked inode with I_NEW set, the
1228 * caller is responsible for filling in the contents
1229 */
1230 return inode;
1231 }
1232
1233 /*
1234 * Uhhuh, somebody else created the same inode under
1235 * us. Use the old inode instead of the one we just
1236 * allocated.
1237 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001238 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 destroy_inode(inode);
Al Viroc2b6d622018-06-28 15:53:17 -04001240 if (IS_ERR(old))
1241 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 inode = old;
1243 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001244 if (unlikely(inode_unhashed(inode))) {
1245 iput(inode);
1246 goto again;
1247 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 }
1249 return inode;
1250}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001251EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001253/*
1254 * search the inode cache for a matching inode number.
1255 * If we find one, then the inode number we are trying to
1256 * allocate is not unique and so we should not use it.
1257 *
1258 * Returns 1 if the inode number is unique, 0 if it is not.
1259 */
1260static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1261{
1262 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001263 struct inode *inode;
1264
David Howells3f19b2a2017-12-01 11:40:16 +00001265 hlist_for_each_entry_rcu(inode, b, i_hash) {
1266 if (inode->i_ino == ino && inode->i_sb == sb)
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001267 return 0;
1268 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001269 return 1;
1270}
1271
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272/**
1273 * iunique - get a unique inode number
1274 * @sb: superblock
1275 * @max_reserved: highest reserved inode number
1276 *
1277 * Obtain an inode number that is unique on the system for a given
1278 * superblock. This is used by file systems that have no natural
1279 * permanent inode numbering system. An inode number is returned that
1280 * is higher than the reserved limit but unique.
1281 *
1282 * BUGS:
1283 * With a large number of inodes live on the file system this function
1284 * currently becomes quite slow.
1285 */
1286ino_t iunique(struct super_block *sb, ino_t max_reserved)
1287{
Jeff Layton866b04f2007-05-08 00:32:29 -07001288 /*
1289 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1290 * error if st_ino won't fit in target struct field. Use 32bit counter
1291 * here to attempt to avoid that.
1292 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001293 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001294 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296
David Howells3f19b2a2017-12-01 11:40:16 +00001297 rcu_read_lock();
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001298 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001299 do {
1300 if (counter <= max_reserved)
1301 counter = max_reserved + 1;
1302 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001303 } while (!test_inode_iunique(sb, res));
1304 spin_unlock(&iunique_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001305 rcu_read_unlock();
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001306
1307 return res;
1308}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309EXPORT_SYMBOL(iunique);
1310
1311struct inode *igrab(struct inode *inode)
1312{
Dave Chinner250df6e2011-03-22 22:23:36 +11001313 spin_lock(&inode->i_lock);
1314 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001316 spin_unlock(&inode->i_lock);
1317 } else {
1318 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 /*
1320 * Handle the case where s_op->clear_inode is not been
1321 * called yet, and somebody is calling igrab
1322 * while the inode is getting freed.
1323 */
1324 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001325 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 return inode;
1327}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328EXPORT_SYMBOL(igrab);
1329
1330/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001331 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 * @sb: super block of file system to search
1333 * @hashval: hash value (usually inode number) to search for
1334 * @test: callback used for comparisons between inodes
1335 * @data: opaque data pointer to pass to @test
1336 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001337 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001339 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001340 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001341 * Note: I_NEW is not waited upon so you have to be very careful what you do
1342 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001343 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001344 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001345 */
1346struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1347 int (*test)(struct inode *, void *), void *data)
1348{
1349 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001350 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001351
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001352 spin_lock(&inode_hash_lock);
1353 inode = find_inode(sb, head, test, data);
1354 spin_unlock(&inode_hash_lock);
1355
Al Viroc2b6d622018-06-28 15:53:17 -04001356 return IS_ERR(inode) ? NULL : inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001357}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001358EXPORT_SYMBOL(ilookup5_nowait);
1359
1360/**
1361 * ilookup5 - search for an inode in the inode cache
1362 * @sb: super block of file system to search
1363 * @hashval: hash value (usually inode number) to search for
1364 * @test: callback used for comparisons between inodes
1365 * @data: opaque data pointer to pass to @test
1366 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001367 * Search for the inode specified by @hashval and @data in the inode cache,
1368 * and if the inode is in the cache, return the inode with an incremented
1369 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001370 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001372 * This is a generalized version of ilookup() for file systems where the
1373 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001375 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 */
1377struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1378 int (*test)(struct inode *, void *), void *data)
1379{
Al Viro2864f302016-07-03 23:15:21 -04001380 struct inode *inode;
1381again:
1382 inode = ilookup5_nowait(sb, hashval, test, data);
1383 if (inode) {
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001384 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001385 if (unlikely(inode_unhashed(inode))) {
1386 iput(inode);
1387 goto again;
1388 }
1389 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001390 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392EXPORT_SYMBOL(ilookup5);
1393
1394/**
1395 * ilookup - search for an inode in the inode cache
1396 * @sb: super block of file system to search
1397 * @ino: inode number to search for
1398 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001399 * Search for the inode @ino in the inode cache, and if the inode is in the
1400 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 */
1402struct inode *ilookup(struct super_block *sb, unsigned long ino)
1403{
1404 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001405 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001406again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001407 spin_lock(&inode_hash_lock);
1408 inode = find_inode_fast(sb, head, ino);
1409 spin_unlock(&inode_hash_lock);
1410
Al Viro2864f302016-07-03 23:15:21 -04001411 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001412 if (IS_ERR(inode))
1413 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001414 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001415 if (unlikely(inode_unhashed(inode))) {
1416 iput(inode);
1417 goto again;
1418 }
1419 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001420 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422EXPORT_SYMBOL(ilookup);
1423
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001424/**
1425 * find_inode_nowait - find an inode in the inode cache
1426 * @sb: super block of file system to search
1427 * @hashval: hash value (usually inode number) to search for
1428 * @match: callback used for comparisons between inodes
1429 * @data: opaque data pointer to pass to @match
1430 *
1431 * Search for the inode specified by @hashval and @data in the inode
1432 * cache, where the helper function @match will return 0 if the inode
1433 * does not match, 1 if the inode does match, and -1 if the search
1434 * should be stopped. The @match function must be responsible for
1435 * taking the i_lock spin_lock and checking i_state for an inode being
1436 * freed or being initialized, and incrementing the reference count
1437 * before returning 1. It also must not sleep, since it is called with
1438 * the inode_hash_lock spinlock held.
1439 *
1440 * This is a even more generalized version of ilookup5() when the
1441 * function must never block --- find_inode() can block in
1442 * __wait_on_freeing_inode() --- or when the caller can not increment
1443 * the reference count because the resulting iput() might cause an
1444 * inode eviction. The tradeoff is that the @match funtion must be
1445 * very carefully implemented.
1446 */
1447struct inode *find_inode_nowait(struct super_block *sb,
1448 unsigned long hashval,
1449 int (*match)(struct inode *, unsigned long,
1450 void *),
1451 void *data)
1452{
1453 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1454 struct inode *inode, *ret_inode = NULL;
1455 int mval;
1456
1457 spin_lock(&inode_hash_lock);
1458 hlist_for_each_entry(inode, head, i_hash) {
1459 if (inode->i_sb != sb)
1460 continue;
1461 mval = match(inode, hashval, data);
1462 if (mval == 0)
1463 continue;
1464 if (mval == 1)
1465 ret_inode = inode;
1466 goto out;
1467 }
1468out:
1469 spin_unlock(&inode_hash_lock);
1470 return ret_inode;
1471}
1472EXPORT_SYMBOL(find_inode_nowait);
1473
David Howells3f19b2a2017-12-01 11:40:16 +00001474/**
1475 * find_inode_rcu - find an inode in the inode cache
1476 * @sb: Super block of file system to search
1477 * @hashval: Key to hash
1478 * @test: Function to test match on an inode
1479 * @data: Data for test function
1480 *
1481 * Search for the inode specified by @hashval and @data in the inode cache,
1482 * where the helper function @test will return 0 if the inode does not match
1483 * and 1 if it does. The @test function must be responsible for taking the
1484 * i_lock spin_lock and checking i_state for an inode being freed or being
1485 * initialized.
1486 *
1487 * If successful, this will return the inode for which the @test function
1488 * returned 1 and NULL otherwise.
1489 *
1490 * The @test function is not permitted to take a ref on any inode presented.
1491 * It is also not permitted to sleep.
1492 *
1493 * The caller must hold the RCU read lock.
1494 */
1495struct inode *find_inode_rcu(struct super_block *sb, unsigned long hashval,
1496 int (*test)(struct inode *, void *), void *data)
1497{
1498 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1499 struct inode *inode;
1500
1501 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1502 "suspicious find_inode_rcu() usage");
1503
1504 hlist_for_each_entry_rcu(inode, head, i_hash) {
1505 if (inode->i_sb == sb &&
1506 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)) &&
1507 test(inode, data))
1508 return inode;
1509 }
1510 return NULL;
1511}
1512EXPORT_SYMBOL(find_inode_rcu);
1513
1514/**
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001515 * find_inode_by_ino_rcu - Find an inode in the inode cache
David Howells3f19b2a2017-12-01 11:40:16 +00001516 * @sb: Super block of file system to search
1517 * @ino: The inode number to match
1518 *
1519 * Search for the inode specified by @hashval and @data in the inode cache,
1520 * where the helper function @test will return 0 if the inode does not match
1521 * and 1 if it does. The @test function must be responsible for taking the
1522 * i_lock spin_lock and checking i_state for an inode being freed or being
1523 * initialized.
1524 *
1525 * If successful, this will return the inode for which the @test function
1526 * returned 1 and NULL otherwise.
1527 *
1528 * The @test function is not permitted to take a ref on any inode presented.
1529 * It is also not permitted to sleep.
1530 *
1531 * The caller must hold the RCU read lock.
1532 */
1533struct inode *find_inode_by_ino_rcu(struct super_block *sb,
1534 unsigned long ino)
1535{
1536 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1537 struct inode *inode;
1538
1539 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1540 "suspicious find_inode_by_ino_rcu() usage");
1541
1542 hlist_for_each_entry_rcu(inode, head, i_hash) {
1543 if (inode->i_ino == ino &&
1544 inode->i_sb == sb &&
1545 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)))
1546 return inode;
1547 }
1548 return NULL;
1549}
1550EXPORT_SYMBOL(find_inode_by_ino_rcu);
1551
Al Viro261bca82008-12-30 01:48:21 -05001552int insert_inode_locked(struct inode *inode)
1553{
1554 struct super_block *sb = inode->i_sb;
1555 ino_t ino = inode->i_ino;
1556 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001557
Al Viro261bca82008-12-30 01:48:21 -05001558 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001559 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001560 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001561 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001562 if (old->i_ino != ino)
1563 continue;
1564 if (old->i_sb != sb)
1565 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001566 spin_lock(&old->i_lock);
1567 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1568 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001569 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001570 }
Al Viro72a43d62009-05-13 19:13:40 +01001571 break;
1572 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001573 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001574 spin_lock(&inode->i_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001575 inode->i_state |= I_NEW | I_CREATING;
David Howells3f19b2a2017-12-01 11:40:16 +00001576 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001577 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001578 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001579 return 0;
1580 }
Al Viroc2b6d622018-06-28 15:53:17 -04001581 if (unlikely(old->i_state & I_CREATING)) {
1582 spin_unlock(&old->i_lock);
1583 spin_unlock(&inode_hash_lock);
1584 return -EBUSY;
1585 }
Al Viro261bca82008-12-30 01:48:21 -05001586 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001587 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001588 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001589 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001590 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001591 iput(old);
1592 return -EBUSY;
1593 }
1594 iput(old);
1595 }
1596}
Al Viro261bca82008-12-30 01:48:21 -05001597EXPORT_SYMBOL(insert_inode_locked);
1598
1599int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1600 int (*test)(struct inode *, void *), void *data)
1601{
Al Viroc2b6d622018-06-28 15:53:17 -04001602 struct inode *old;
1603
1604 inode->i_state |= I_CREATING;
1605 old = inode_insert5(inode, hashval, test, NULL, data);
Al Viro261bca82008-12-30 01:48:21 -05001606
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001607 if (old != inode) {
Al Viro261bca82008-12-30 01:48:21 -05001608 iput(old);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001609 return -EBUSY;
Al Viro261bca82008-12-30 01:48:21 -05001610 }
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001611 return 0;
Al Viro261bca82008-12-30 01:48:21 -05001612}
Al Viro261bca82008-12-30 01:48:21 -05001613EXPORT_SYMBOL(insert_inode_locked4);
1614
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615
Al Viro45321ac2010-06-07 13:43:19 -04001616int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617{
Al Viro45321ac2010-06-07 13:43:19 -04001618 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620EXPORT_SYMBOL(generic_delete_inode);
1621
Al Viro45321ac2010-06-07 13:43:19 -04001622/*
Al Viro45321ac2010-06-07 13:43:19 -04001623 * Called when we're dropping the last reference
1624 * to an inode.
1625 *
1626 * Call the FS "drop_inode()" function, defaulting to
1627 * the legacy UNIX filesystem behaviour. If it tells
1628 * us to evict inode, do so. Otherwise, retain inode
1629 * in cache if fs is alive, sync and evict if fs is
1630 * shutting down.
1631 */
1632static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633{
1634 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001635 const struct super_operations *op = inode->i_sb->s_op;
David Howells3f19b2a2017-12-01 11:40:16 +00001636 unsigned long state;
Al Viro45321ac2010-06-07 13:43:19 -04001637 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
Dave Chinner250df6e2011-03-22 22:23:36 +11001639 WARN_ON(inode->i_state & I_NEW);
1640
Al Viroe7f59092011-07-07 15:45:59 -04001641 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001642 drop = op->drop_inode(inode);
1643 else
1644 drop = generic_drop_inode(inode);
1645
Hao Li88149082020-12-08 10:08:43 +08001646 if (!drop &&
1647 !(inode->i_state & I_DONTCACHE) &&
1648 (sb->s_flags & SB_ACTIVE)) {
Johannes Weiner51b8c1f2021-11-08 18:31:24 -08001649 __inode_add_lru(inode, true);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001650 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001651 return;
1652 }
1653
David Howells3f19b2a2017-12-01 11:40:16 +00001654 state = inode->i_state;
Al Viro45321ac2010-06-07 13:43:19 -04001655 if (!drop) {
David Howells3f19b2a2017-12-01 11:40:16 +00001656 WRITE_ONCE(inode->i_state, state | I_WILL_FREE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001657 spin_unlock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001658
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 write_inode_now(inode, 1);
David Howells3f19b2a2017-12-01 11:40:16 +00001660
Dave Chinner250df6e2011-03-22 22:23:36 +11001661 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001662 state = inode->i_state;
1663 WARN_ON(state & I_NEW);
1664 state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001666
David Howells3f19b2a2017-12-01 11:40:16 +00001667 WRITE_ONCE(inode->i_state, state | I_FREEING);
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001668 if (!list_empty(&inode->i_lru))
1669 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001670 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001671
1672 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673}
1674
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301676 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 * @inode: inode to put
1678 *
1679 * Puts an inode, dropping its usage count. If the inode use count hits
1680 * zero, the inode is then freed and may also be destroyed.
1681 *
1682 * Consequently, iput() can sleep.
1683 */
1684void iput(struct inode *inode)
1685{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001686 if (!inode)
1687 return;
1688 BUG_ON(inode->i_state & I_CLEAR);
1689retry:
1690 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1691 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1692 atomic_inc(&inode->i_count);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001693 spin_unlock(&inode->i_lock);
1694 trace_writeback_lazytime_iput(inode);
1695 mark_inode_dirty_sync(inode);
1696 goto retry;
1697 }
1698 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 }
1700}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701EXPORT_SYMBOL(iput);
1702
Carlos Maiolino30460e12020-01-09 14:30:41 +01001703#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704/**
1705 * bmap - find a block number in a file
Carlos Maiolino30460e12020-01-09 14:30:41 +01001706 * @inode: inode owning the block number being requested
1707 * @block: pointer containing the block to find
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 *
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001709 * Replaces the value in ``*block`` with the block number on the device holding
Carlos Maiolino30460e12020-01-09 14:30:41 +01001710 * corresponding to the requested block number in the file.
1711 * That is, asked for block 4 of inode 1 the function will replace the
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001712 * 4 in ``*block``, with disk block relative to the disk start that holds that
Carlos Maiolino30460e12020-01-09 14:30:41 +01001713 * block of the file.
1714 *
1715 * Returns -EINVAL in case of error, 0 otherwise. If mapping falls into a
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001716 * hole, returns 0 and ``*block`` is also set to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 */
Carlos Maiolino30460e12020-01-09 14:30:41 +01001718int bmap(struct inode *inode, sector_t *block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719{
Carlos Maiolino30460e12020-01-09 14:30:41 +01001720 if (!inode->i_mapping->a_ops->bmap)
1721 return -EINVAL;
1722
1723 *block = inode->i_mapping->a_ops->bmap(inode->i_mapping, *block);
1724 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726EXPORT_SYMBOL(bmap);
Carlos Maiolino30460e12020-01-09 14:30:41 +01001727#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001729/*
1730 * With relative atime, only update atime if the previous atime is
1731 * earlier than either the ctime or mtime or if at least a day has
1732 * passed since the last atime update.
1733 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001734static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001735 struct timespec64 now)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001736{
1737
Miklos Szeredic6718542018-07-18 15:44:43 +02001738 if (!(mnt->mnt_flags & MNT_RELATIME))
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001739 return 1;
1740 /*
1741 * Is mtime younger than atime? If yes, update atime:
1742 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001743 if (timespec64_compare(&inode->i_mtime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001744 return 1;
1745 /*
1746 * Is ctime younger than atime? If yes, update atime:
1747 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001748 if (timespec64_compare(&inode->i_ctime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001749 return 1;
1750
1751 /*
1752 * Is the previous atime value older than a day? If yes,
1753 * update atime:
1754 */
1755 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1756 return 1;
1757 /*
1758 * Good, we can skip the atime update:
1759 */
1760 return 0;
1761}
1762
Deepa Dinamani95582b02018-05-08 19:36:02 -07001763int generic_update_time(struct inode *inode, struct timespec64 *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001764{
Eric Biggerse20b14d2021-01-12 11:02:45 -08001765 int dirty_flags = 0;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001766
Eric Biggerse20b14d2021-01-12 11:02:45 -08001767 if (flags & (S_ATIME | S_CTIME | S_MTIME)) {
1768 if (flags & S_ATIME)
1769 inode->i_atime = *time;
1770 if (flags & S_CTIME)
1771 inode->i_ctime = *time;
1772 if (flags & S_MTIME)
1773 inode->i_mtime = *time;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001774
Eric Biggerse20b14d2021-01-12 11:02:45 -08001775 if (inode->i_sb->s_flags & SB_LAZYTIME)
1776 dirty_flags |= I_DIRTY_TIME;
1777 else
1778 dirty_flags |= I_DIRTY_SYNC;
1779 }
1780
1781 if ((flags & S_VERSION) && inode_maybe_inc_iversion(inode, false))
1782 dirty_flags |= I_DIRTY_SYNC;
1783
1784 __mark_inode_dirty(inode, dirty_flags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001785 return 0;
1786}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001787EXPORT_SYMBOL(generic_update_time);
1788
1789/*
1790 * This does the actual work of updating an inodes time or version. Must have
1791 * had called mnt_want_write() before calling this.
1792 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001793static int update_time(struct inode *inode, struct timespec64 *time, int flags)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001794{
Deepa Dinamani23b424d2019-12-02 21:19:45 -08001795 if (inode->i_op->update_time)
1796 return inode->i_op->update_time(inode, time, flags);
1797 return generic_update_time(inode, time, flags);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001798}
Josef Bacikc3b2da32012-03-26 09:59:21 -04001799
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800/**
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001801 * atime_needs_update - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001802 * @path: the &struct path to update
Randy Dunlap30fdc8e2015-11-09 14:57:58 -08001803 * @inode: inode to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 *
1805 * Update the accessed time on an inode and mark it for writeback.
1806 * This function automatically handles read only file systems and media,
1807 * as well as the "noatime" flag and inode specific "noatime" markers.
1808 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001809bool atime_needs_update(const struct path *path, struct inode *inode)
NeilBrown8fa9dd22015-03-23 13:37:40 +11001810{
1811 struct vfsmount *mnt = path->mnt;
Deepa Dinamani95582b02018-05-08 19:36:02 -07001812 struct timespec64 now;
NeilBrown8fa9dd22015-03-23 13:37:40 +11001813
1814 if (inode->i_flags & S_NOATIME)
1815 return false;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001816
1817 /* Atime updates will likely cause i_uid and i_gid to be written
1818 * back improprely if their true value is unknown to the vfs.
1819 */
Christian Braunerba73d982021-01-21 14:19:31 +01001820 if (HAS_UNMAPPED_ID(mnt_user_ns(mnt), inode))
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001821 return false;
1822
NeilBrown8fa9dd22015-03-23 13:37:40 +11001823 if (IS_NOATIME(inode))
1824 return false;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001825 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001826 return false;
1827
1828 if (mnt->mnt_flags & MNT_NOATIME)
1829 return false;
1830 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1831 return false;
1832
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001833 now = current_time(inode);
NeilBrown8fa9dd22015-03-23 13:37:40 +11001834
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001835 if (!relatime_need_update(mnt, inode, now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001836 return false;
1837
Deepa Dinamani95582b02018-05-08 19:36:02 -07001838 if (timespec64_equal(&inode->i_atime, &now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001839 return false;
1840
1841 return true;
1842}
1843
Al Virobadcf2b2013-07-16 18:15:46 +04001844void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845{
Al Viro68ac1232012-03-15 08:21:57 -04001846 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001847 struct inode *inode = d_inode(path->dentry);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001848 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849
Miklos Szeredic6718542018-07-18 15:44:43 +02001850 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001851 return;
1852
Jan Kara5d37e9e2012-06-12 16:20:36 +02001853 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001854 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001855
NeilBrown8fa9dd22015-03-23 13:37:40 +11001856 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001857 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001858 /*
1859 * File systems can error out when updating inodes if they need to
1860 * allocate new space to modify an inode (such is the case for
1861 * Btrfs), but since we touch atime while walking down the path we
1862 * really don't care if we failed to update the atime of the file,
1863 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001864 * We may also fail on filesystems that have the ability to make parts
1865 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001866 */
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001867 now = current_time(inode);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001868 update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001869 __mnt_drop_write(mnt);
1870skip_update:
1871 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001873EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874
Cong Wang3ed37642012-05-15 14:57:33 +08001875/*
1876 * The logic we want is
1877 *
1878 * if suid or (sgid and xgrp)
1879 * remove privs
1880 */
1881int should_remove_suid(struct dentry *dentry)
1882{
David Howellsdf2b1af2015-03-17 22:26:15 +00001883 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001884 int kill = 0;
1885
1886 /* suid always must be killed */
1887 if (unlikely(mode & S_ISUID))
1888 kill = ATTR_KILL_SUID;
1889
1890 /*
1891 * sgid without any exec bits is just a mandatory locking mark; leave
1892 * it alone. If some exec bits are set, it's a real sgid; kill it.
1893 */
1894 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1895 kill |= ATTR_KILL_SGID;
1896
1897 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1898 return kill;
1899
1900 return 0;
1901}
1902EXPORT_SYMBOL(should_remove_suid);
1903
Jan Karadbfae0c2015-05-21 16:05:54 +02001904/*
1905 * Return mask of changes for notify_change() that need to be done as a
1906 * response to write or truncate. Return 0 if nothing has to be changed.
1907 * Negative value on error (change should be denied).
1908 */
Jan Kara45f147a2015-05-21 16:05:55 +02001909int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001910{
Jan Karadbfae0c2015-05-21 16:05:54 +02001911 struct inode *inode = d_inode(dentry);
1912 int mask = 0;
1913 int ret;
1914
1915 if (IS_NOSEC(inode))
1916 return 0;
1917
1918 mask = should_remove_suid(dentry);
1919 ret = security_inode_need_killpriv(dentry);
1920 if (ret < 0)
1921 return ret;
1922 if (ret)
1923 mask |= ATTR_KILL_PRIV;
1924 return mask;
1925}
Jan Karadbfae0c2015-05-21 16:05:54 +02001926
Christian Brauner643fe552021-01-21 14:19:34 +01001927static int __remove_privs(struct user_namespace *mnt_userns,
1928 struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001929{
1930 struct iattr newattrs;
1931
1932 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001933 /*
1934 * Note we call this on write, so notify_change will not
1935 * encounter any conflicting delegations:
1936 */
Christian Brauner643fe552021-01-21 14:19:34 +01001937 return notify_change(mnt_userns, dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001938}
1939
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001940/*
1941 * Remove special file priviledges (suid, capabilities) when file is written
1942 * to or truncated.
1943 */
1944int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001945{
Miklos Szeredic1892c32016-08-03 13:44:27 +02001946 struct dentry *dentry = file_dentry(file);
1947 struct inode *inode = file_inode(file);
Jan Karadbfae0c2015-05-21 16:05:54 +02001948 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001949 int error = 0;
1950
Alexander Lochmannf69e7492018-12-14 11:55:52 +01001951 /*
1952 * Fast path for nothing security related.
1953 * As well for non-regular files, e.g. blkdev inodes.
1954 * For example, blkdev_write_iter() might get here
1955 * trying to remove privs which it is not allowed to.
1956 */
1957 if (IS_NOSEC(inode) || !S_ISREG(inode->i_mode))
Cong Wang3ed37642012-05-15 14:57:33 +08001958 return 0;
1959
Miklos Szeredic1892c32016-08-03 13:44:27 +02001960 kill = dentry_needs_remove_privs(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001961 if (kill < 0)
1962 return kill;
1963 if (kill)
Christian Brauner643fe552021-01-21 14:19:34 +01001964 error = __remove_privs(file_mnt_user_ns(file), dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001965 if (!error)
1966 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001967
1968 return error;
1969}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001970EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001971
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001973 * file_update_time - update mtime and ctime time
1974 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001976 * Update the mtime and ctime members of an inode and mark the inode
1977 * for writeback. Note that this function is meant exclusively for
1978 * usage in the file write path of filesystems, and filesystems may
1979 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001980 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001981 * timestamps are handled by the server. This can return an error for
1982 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 */
1984
Josef Bacikc3b2da32012-03-26 09:59:21 -04001985int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986{
Al Viro496ad9a2013-01-23 17:07:38 -05001987 struct inode *inode = file_inode(file);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001988 struct timespec64 now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001989 int sync_it = 0;
1990 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991
Andi Kleence06e0b2009-09-18 13:05:48 -07001992 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001994 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001995
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001996 now = current_time(inode);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001997 if (!timespec64_equal(&inode->i_mtime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001998 sync_it = S_MTIME;
1999
Deepa Dinamani95582b02018-05-08 19:36:02 -07002000 if (!timespec64_equal(&inode->i_ctime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07002001 sync_it |= S_CTIME;
2002
Jeff Laytone38cf302017-12-11 06:35:22 -05002003 if (IS_I_VERSION(inode) && inode_iversion_need_inc(inode))
Andi Kleence06e0b2009-09-18 13:05:48 -07002004 sync_it |= S_VERSION;
2005
2006 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04002007 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008
Andi Kleence06e0b2009-09-18 13:05:48 -07002009 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02002010 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04002011 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
Josef Bacikc3b2da32012-03-26 09:59:21 -04002013 ret = update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02002014 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04002015
2016 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017}
Christoph Hellwig870f4812006-01-09 20:52:01 -08002018EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019
Amir Goldsteine38f7f52019-06-05 08:04:49 -07002020/* Caller must hold the file's inode lock */
2021int file_modified(struct file *file)
2022{
2023 int err;
2024
2025 /*
2026 * Clear the security bits if the process is not being run by root.
2027 * This keeps people from modifying setuid and setgid binaries.
2028 */
2029 err = file_remove_privs(file);
2030 if (err)
2031 return err;
2032
2033 if (unlikely(file->f_mode & FMODE_NOCMTIME))
2034 return 0;
2035
2036 return file_update_time(file);
2037}
2038EXPORT_SYMBOL(file_modified);
2039
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040int inode_needs_sync(struct inode *inode)
2041{
2042 if (IS_SYNC(inode))
2043 return 1;
2044 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
2045 return 1;
2046 return 0;
2047}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048EXPORT_SYMBOL(inode_needs_sync);
2049
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07002051 * If we try to find an inode in the inode hash while it is being
2052 * deleted, we have to wait until the filesystem completes its
2053 * deletion before reporting that it isn't found. This function waits
2054 * until the deletion _might_ have completed. Callers are responsible
2055 * to recheck inode state.
2056 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002057 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11002058 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
2059 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 */
2061static void __wait_on_freeing_inode(struct inode *inode)
2062{
2063 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002064 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
2065 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Ingo Molnar21417132017-03-05 11:25:39 +01002066 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11002067 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11002068 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 schedule();
Ingo Molnar21417132017-03-05 11:25:39 +01002070 finish_wait(wq, &wait.wq_entry);
Dave Chinner67a23c42011-03-22 22:23:42 +11002071 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072}
2073
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074static __initdata unsigned long ihash_entries;
2075static int __init set_ihash_entries(char *str)
2076{
2077 if (!str)
2078 return 0;
2079 ihash_entries = simple_strtoul(str, &str, 0);
2080 return 1;
2081}
2082__setup("ihash_entries=", set_ihash_entries);
2083
2084/*
2085 * Initialize the waitqueues and inode hash table.
2086 */
2087void __init inode_init_early(void)
2088{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 /* If hashes are distributed across NUMA nodes, defer
2090 * hash allocation until vmalloc space is available.
2091 */
2092 if (hashdist)
2093 return;
2094
2095 inode_hashtable =
2096 alloc_large_system_hash("Inode-cache",
2097 sizeof(struct hlist_head),
2098 ihash_entries,
2099 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002100 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 &i_hash_shift,
2102 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002103 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105}
2106
Denis Cheng74bf17c2007-10-16 23:26:30 -07002107void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08002110 inode_cachep = kmem_cache_create("inode_cache",
2111 sizeof(struct inode),
2112 0,
2113 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
Vladimir Davydov5d097052016-01-14 15:18:21 -08002114 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
Paul Mundt20c2df82007-07-20 10:11:58 +09002115 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116
2117 /* Hash may have been set up in inode_init_early */
2118 if (!hashdist)
2119 return;
2120
2121 inode_hashtable =
2122 alloc_large_system_hash("Inode-cache",
2123 sizeof(struct hlist_head),
2124 ihash_entries,
2125 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002126 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 &i_hash_shift,
2128 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002129 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131}
2132
2133void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
2134{
2135 inode->i_mode = mode;
2136 if (S_ISCHR(mode)) {
2137 inode->i_fop = &def_chr_fops;
2138 inode->i_rdev = rdev;
2139 } else if (S_ISBLK(mode)) {
2140 inode->i_fop = &def_blk_fops;
2141 inode->i_rdev = rdev;
2142 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04002143 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05002145 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07002147 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
2148 " inode %s:%lu\n", mode, inode->i_sb->s_id,
2149 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150}
2151EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002152
2153/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00002154 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Christian Brauner21cb47b2021-01-21 14:19:25 +01002155 * @mnt_userns: User namespace of the mount the inode was created from
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002156 * @inode: New inode
2157 * @dir: Directory inode
2158 * @mode: mode of the new inode
Christian Brauner21cb47b2021-01-21 14:19:25 +01002159 *
2160 * If the inode has been created through an idmapped mount the user namespace of
2161 * the vfsmount must be passed through @mnt_userns. This function will then take
2162 * care to map the inode according to @mnt_userns before checking permissions
2163 * and initializing i_uid and i_gid. On non-idmapped mounts or if permission
2164 * checking is to be performed on the raw inode simply passs init_user_ns.
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002165 */
Christian Brauner21cb47b2021-01-21 14:19:25 +01002166void inode_init_owner(struct user_namespace *mnt_userns, struct inode *inode,
2167 const struct inode *dir, umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002168{
Christian Braunerdb998552021-03-20 13:26:24 +01002169 inode_fsuid_set(inode, mnt_userns);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002170 if (dir && dir->i_mode & S_ISGID) {
2171 inode->i_gid = dir->i_gid;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002172
2173 /* Directories are special, and always inherit S_ISGID */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002174 if (S_ISDIR(mode))
2175 mode |= S_ISGID;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002176 else if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP) &&
Christian Brauner21cb47b2021-01-21 14:19:25 +01002177 !in_group_p(i_gid_into_mnt(mnt_userns, dir)) &&
2178 !capable_wrt_inode_uidgid(mnt_userns, dir, CAP_FSETID))
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002179 mode &= ~S_ISGID;
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002180 } else
Christian Braunerdb998552021-03-20 13:26:24 +01002181 inode_fsgid_set(inode, mnt_userns);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002182 inode->i_mode = mode;
2183}
2184EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07002185
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002186/**
2187 * inode_owner_or_capable - check current task permissions to inode
Christian Brauner21cb47b2021-01-21 14:19:25 +01002188 * @mnt_userns: user namespace of the mount the inode was found from
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002189 * @inode: inode being checked
2190 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002191 * Return true if current either has CAP_FOWNER in a namespace with the
2192 * inode owner uid mapped, or owns the file.
Christian Brauner21cb47b2021-01-21 14:19:25 +01002193 *
2194 * If the inode has been found through an idmapped mount the user namespace of
2195 * the vfsmount must be passed through @mnt_userns. This function will then take
2196 * care to map the inode according to @mnt_userns before checking permissions.
2197 * On non-idmapped mounts or if permission checking is to be performed on the
2198 * raw inode simply passs init_user_ns.
Serge E. Hallyne795b712011-03-23 16:43:25 -07002199 */
Christian Brauner21cb47b2021-01-21 14:19:25 +01002200bool inode_owner_or_capable(struct user_namespace *mnt_userns,
2201 const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07002202{
Christian Brauner21cb47b2021-01-21 14:19:25 +01002203 kuid_t i_uid;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002204 struct user_namespace *ns;
2205
Christian Brauner21cb47b2021-01-21 14:19:25 +01002206 i_uid = i_uid_into_mnt(mnt_userns, inode);
2207 if (uid_eq(current_fsuid(), i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002208 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002209
2210 ns = current_user_ns();
Christian Brauner21cb47b2021-01-21 14:19:25 +01002211 if (kuid_has_mapping(ns, i_uid) && ns_capable(ns, CAP_FOWNER))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002212 return true;
2213 return false;
2214}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002215EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002216
2217/*
2218 * Direct i/o helper functions
2219 */
2220static void __inode_dio_wait(struct inode *inode)
2221{
2222 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2223 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2224
2225 do {
Ingo Molnar21417132017-03-05 11:25:39 +01002226 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002227 if (atomic_read(&inode->i_dio_count))
2228 schedule();
2229 } while (atomic_read(&inode->i_dio_count));
Ingo Molnar21417132017-03-05 11:25:39 +01002230 finish_wait(wq, &q.wq_entry);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002231}
2232
2233/**
2234 * inode_dio_wait - wait for outstanding DIO requests to finish
2235 * @inode: inode to wait for
2236 *
2237 * Waits for all pending direct I/O requests to finish so that we can
2238 * proceed with a truncate or equivalent operation.
2239 *
2240 * Must be called under a lock that serializes taking new references
2241 * to i_dio_count, usually by inode->i_mutex.
2242 */
2243void inode_dio_wait(struct inode *inode)
2244{
2245 if (atomic_read(&inode->i_dio_count))
2246 __inode_dio_wait(inode);
2247}
2248EXPORT_SYMBOL(inode_dio_wait);
2249
2250/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002251 * inode_set_flags - atomically set some inode flags
2252 *
2253 * Note: the caller should be holding i_mutex, or else be sure that
2254 * they have exclusive access to the inode structure (i.e., while the
2255 * inode is being instantiated). The reason for the cmpxchg() loop
2256 * --- which wouldn't be necessary if all code paths which modify
2257 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002258 * code path which doesn't today so we use cmpxchg() out of an abundance
2259 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002260 *
2261 * In the long run, i_mutex is overkill, and we should probably look
2262 * at using the i_lock spinlock to protect i_flags, and then make sure
2263 * it is so documented in include/linux/fs.h and that all code follows
2264 * the locking convention!!
2265 */
2266void inode_set_flags(struct inode *inode, unsigned int flags,
2267 unsigned int mask)
2268{
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002269 WARN_ON_ONCE(flags & ~mask);
Vineet Guptaa9057372019-03-05 15:41:52 -08002270 set_mask_bits(&inode->i_flags, mask, flags);
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002271}
2272EXPORT_SYMBOL(inode_set_flags);
Al Viro21fc61c2015-11-17 01:07:57 -05002273
2274void inode_nohighmem(struct inode *inode)
2275{
2276 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2277}
2278EXPORT_SYMBOL(inode_nohighmem);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002279
2280/**
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002281 * timestamp_truncate - Truncate timespec to a granularity
2282 * @t: Timespec
2283 * @inode: inode being updated
2284 *
2285 * Truncate a timespec to the granularity supported by the fs
2286 * containing the inode. Always rounds down. gran must
2287 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2288 */
2289struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode)
2290{
2291 struct super_block *sb = inode->i_sb;
2292 unsigned int gran = sb->s_time_gran;
2293
2294 t.tv_sec = clamp(t.tv_sec, sb->s_time_min, sb->s_time_max);
2295 if (unlikely(t.tv_sec == sb->s_time_max || t.tv_sec == sb->s_time_min))
2296 t.tv_nsec = 0;
2297
2298 /* Avoid division in the common cases 1 ns and 1 s. */
2299 if (gran == 1)
2300 ; /* nothing */
2301 else if (gran == NSEC_PER_SEC)
2302 t.tv_nsec = 0;
2303 else if (gran > 1 && gran < NSEC_PER_SEC)
2304 t.tv_nsec -= t.tv_nsec % gran;
2305 else
2306 WARN(1, "invalid file time granularity: %u", gran);
2307 return t;
2308}
2309EXPORT_SYMBOL(timestamp_truncate);
2310
2311/**
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002312 * current_time - Return FS time
2313 * @inode: inode.
2314 *
2315 * Return the current time truncated to the time granularity supported by
2316 * the fs.
2317 *
2318 * Note that inode and inode->sb cannot be NULL.
2319 * Otherwise, the function warns and returns time without truncation.
2320 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07002321struct timespec64 current_time(struct inode *inode)
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002322{
Arnd Bergmannd651d162018-12-05 11:14:27 +11002323 struct timespec64 now;
2324
2325 ktime_get_coarse_real_ts64(&now);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002326
2327 if (unlikely(!inode->i_sb)) {
2328 WARN(1, "current_time() called with uninitialized super_block in the inode");
2329 return now;
2330 }
2331
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002332 return timestamp_truncate(now, inode);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002333}
2334EXPORT_SYMBOL(current_time);