blob: 63324df6fa273426765c37e14f83ff2ecc93e1b8 [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
Glauber Costa3942c072013-08-28 10:17:53 +100070static DEFINE_PER_CPU(unsigned long, nr_inodes);
71static DEFINE_PER_CPU(unsigned long, nr_unused);
Dave Chinnercffbc8a2010-10-23 05:03:02 -040072
Manish Katiyar6b3304b2009-03-31 19:35:54 +053073static struct kmem_cache *inode_cachep __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Glauber Costa3942c072013-08-28 10:17:53 +100075static long get_nr_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040076{
Nick Piggin3e880fb2011-01-07 17:49:19 +110077 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100078 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +110079 for_each_possible_cpu(i)
80 sum += per_cpu(nr_inodes, i);
81 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040082}
83
Glauber Costa3942c072013-08-28 10:17:53 +100084static inline long get_nr_inodes_unused(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040085{
Dave Chinnerfcb94f72011-07-08 14:14:38 +100086 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100087 long sum = 0;
Dave Chinnerfcb94f72011-07-08 14:14:38 +100088 for_each_possible_cpu(i)
89 sum += per_cpu(nr_unused, i);
90 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040091}
92
Glauber Costa3942c072013-08-28 10:17:53 +100093long get_nr_dirty_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040094{
Nick Piggin3e880fb2011-01-07 17:49:19 +110095 /* not actually dirty inodes, but a wild approximation */
Glauber Costa3942c072013-08-28 10:17:53 +100096 long nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
Dave Chinnercffbc8a2010-10-23 05:03:02 -040097 return nr_dirty > 0 ? nr_dirty : 0;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040098}
99
100/*
101 * Handle nr_inode sysctl
102 */
103#ifdef CONFIG_SYSCTL
Luis Chamberlain1d67fe52022-01-21 22:12:52 -0800104/*
105 * Statistics gathering..
106 */
107static struct inodes_stat_t inodes_stat;
108
109static int proc_nr_inodes(struct ctl_table *table, int write, void *buffer,
110 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}
Luis Chamberlain1d67fe52022-01-21 22:12:52 -0800116
117static struct ctl_table inodes_sysctls[] = {
118 {
119 .procname = "inode-nr",
120 .data = &inodes_stat,
121 .maxlen = 2*sizeof(long),
122 .mode = 0444,
123 .proc_handler = proc_nr_inodes,
124 },
125 {
126 .procname = "inode-state",
127 .data = &inodes_stat,
128 .maxlen = 7*sizeof(long),
129 .mode = 0444,
130 .proc_handler = proc_nr_inodes,
131 },
132 { }
133};
134
135static int __init init_fs_inode_sysctls(void)
136{
137 register_sysctl_init("fs", inodes_sysctls);
138 return 0;
139}
140early_initcall(init_fs_inode_sysctls);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400141#endif
142
Al Virobd9b51e2014-11-18 23:38:21 -0500143static int no_open(struct inode *inode, struct file *file)
144{
145 return -ENXIO;
146}
147
David Chinner2cb15992008-10-30 17:32:23 +1100148/**
Masahiro Yamada6e7c2b42017-05-08 15:57:53 -0700149 * inode_init_always - perform inode structure initialisation
Randy Dunlap0bc02f32009-01-06 14:41:13 -0800150 * @sb: superblock inode belongs to
151 * @inode: inode to initialise
David Chinner2cb15992008-10-30 17:32:23 +1100152 *
153 * These are initializations that need to be done on every inode
154 * allocation as the fields are not initialised by slab allocation.
155 */
Christoph Hellwig54e34622009-08-07 14:38:25 -0300156int inode_init_always(struct super_block *sb, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157{
Alexey Dobriyan6e1d5dc2009-09-21 17:01:11 -0700158 static const struct inode_operations empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500159 static const struct file_operations no_open_fops = {.open = no_open};
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530160 struct address_space *const mapping = &inode->i_data;
David Chinner2cb15992008-10-30 17:32:23 +1100161
162 inode->i_sb = sb;
163 inode->i_blkbits = sb->s_blocksize_bits;
164 inode->i_flags = 0;
Peter Zijlstra8019ad12020-03-04 11:28:31 +0100165 atomic64_set(&inode->i_sequence, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100166 atomic_set(&inode->i_count, 1);
167 inode->i_op = &empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500168 inode->i_fop = &no_open_fops;
Eric Biggersedbb35c2020-10-30 17:44:20 -0700169 inode->i_ino = 0;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200170 inode->__i_nlink = 1;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700171 inode->i_opflags = 0;
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200172 if (sb->s_xattr)
173 inode->i_opflags |= IOP_XATTR;
Eric W. Biederman92361632012-02-08 07:07:50 -0800174 i_uid_write(inode, 0);
175 i_gid_write(inode, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100176 atomic_set(&inode->i_writecount, 0);
177 inode->i_size = 0;
Jens Axboec75b1d92017-06-27 11:47:04 -0600178 inode->i_write_hint = WRITE_LIFE_NOT_SET;
David Chinner2cb15992008-10-30 17:32:23 +1100179 inode->i_blocks = 0;
180 inode->i_bytes = 0;
181 inode->i_generation = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100182 inode->i_pipe = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100183 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400184 inode->i_link = NULL;
Al Viro84e710d2016-04-15 00:58:55 -0400185 inode->i_dir_seq = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100186 inode->i_rdev = 0;
187 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500188
Tahsin Erdogan3d65ae42016-02-16 13:34:39 -0800189#ifdef CONFIG_CGROUP_WRITEBACK
190 inode->i_wb_frn_winner = 0;
191 inode->i_wb_frn_avg_time = 0;
192 inode->i_wb_frn_history = 0;
193#endif
194
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500195 if (security_inode_alloc(inode))
Christoph Hellwig54e34622009-08-07 14:38:25 -0300196 goto out;
David Chinner2cb15992008-10-30 17:32:23 +1100197 spin_lock_init(&inode->i_lock);
198 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
199
Al Viro9902af72016-04-15 15:08:36 -0400200 init_rwsem(&inode->i_rwsem);
201 lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
David Chinner2cb15992008-10-30 17:32:23 +1100202
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400203 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100204
205 mapping->a_ops = &empty_aops;
206 mapping->host = inode;
207 mapping->flags = 0;
Darrick J. Wong829bc7872018-05-30 19:43:53 -0700208 mapping->wb_err = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700209 atomic_set(&mapping->i_mmap_writable, 0);
Song Liu09d91cd2019-09-23 15:38:03 -0700210#ifdef CONFIG_READ_ONLY_THP_FOR_FS
211 atomic_set(&mapping->nr_thps, 0);
212#endif
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800213 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800214 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100215 mapping->writeback_index = 0;
Sebastian Andrzej Siewior23ca0672021-09-01 10:44:03 +0200216 init_rwsem(&mapping->invalidate_lock);
217 lockdep_set_class_and_name(&mapping->invalidate_lock,
218 &sb->s_type->invalidate_lock_key,
219 "mapping.invalidate_lock");
David Chinner2cb15992008-10-30 17:32:23 +1100220 inode->i_private = NULL;
221 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400222 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400223#ifdef CONFIG_FS_POSIX_ACL
224 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
225#endif
David Chinner2cb15992008-10-30 17:32:23 +1100226
Eric Paris3be25f42009-05-21 17:01:26 -0400227#ifdef CONFIG_FSNOTIFY
228 inode->i_fsnotify_mask = 0;
229#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500230 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100231 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400232
Christoph Hellwig54e34622009-08-07 14:38:25 -0300233 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300234out:
235 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100236}
237EXPORT_SYMBOL(inode_init_always);
238
Al Virofdb0da82019-04-10 14:43:44 -0400239void free_inode_nonrcu(struct inode *inode)
240{
241 kmem_cache_free(inode_cachep, inode);
242}
243EXPORT_SYMBOL(free_inode_nonrcu);
244
245static void i_callback(struct rcu_head *head)
246{
247 struct inode *inode = container_of(head, struct inode, i_rcu);
248 if (inode->free_inode)
249 inode->free_inode(inode);
250 else
251 free_inode_nonrcu(inode);
252}
253
David Chinner2cb15992008-10-30 17:32:23 +1100254static struct inode *alloc_inode(struct super_block *sb)
255{
Al Virofdb0da82019-04-10 14:43:44 -0400256 const struct super_operations *ops = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 struct inode *inode;
258
Al Virofdb0da82019-04-10 14:43:44 -0400259 if (ops->alloc_inode)
260 inode = ops->alloc_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 else
David Chinner2cb15992008-10-30 17:32:23 +1100262 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Christoph Hellwig54e34622009-08-07 14:38:25 -0300264 if (!inode)
265 return NULL;
266
267 if (unlikely(inode_init_always(sb, inode))) {
Al Virofdb0da82019-04-10 14:43:44 -0400268 if (ops->destroy_inode) {
269 ops->destroy_inode(inode);
270 if (!ops->free_inode)
271 return NULL;
272 }
273 inode->free_inode = ops->free_inode;
274 i_callback(&inode->i_rcu);
Christoph Hellwig54e34622009-08-07 14:38:25 -0300275 return NULL;
276 }
277
278 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279}
280
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300281void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200283 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400284 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400286 fsnotify_inode_delete(inode);
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500287 locks_free_lock_context(inode);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100288 if (!inode->i_nlink) {
289 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
290 atomic_long_dec(&inode->i_sb->s_remove_count);
291 }
292
Al Virof19d4a82009-06-08 19:50:45 -0400293#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100294 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400295 posix_acl_release(inode->i_acl);
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100296 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400297 posix_acl_release(inode->i_default_acl);
298#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100299 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300300}
301EXPORT_SYMBOL(__destroy_inode);
302
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200303static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300304{
Al Virofdb0da82019-04-10 14:43:44 -0400305 const struct super_operations *ops = inode->i_sb->s_op;
306
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100307 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300308 __destroy_inode(inode);
Al Virofdb0da82019-04-10 14:43:44 -0400309 if (ops->destroy_inode) {
310 ops->destroy_inode(inode);
311 if (!ops->free_inode)
312 return;
313 }
314 inode->free_inode = ops->free_inode;
315 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100318/**
319 * drop_nlink - directly drop an inode's link count
320 * @inode: inode
321 *
322 * This is a low-level filesystem helper to replace any
323 * direct filesystem manipulation of i_nlink. In cases
324 * where we are attempting to track writes to the
325 * filesystem, a decrement to zero means an imminent
326 * write when the file is truncated and actually unlinked
327 * on the filesystem.
328 */
329void drop_nlink(struct inode *inode)
330{
331 WARN_ON(inode->i_nlink == 0);
332 inode->__i_nlink--;
333 if (!inode->i_nlink)
334 atomic_long_inc(&inode->i_sb->s_remove_count);
335}
336EXPORT_SYMBOL(drop_nlink);
337
338/**
339 * clear_nlink - directly zero an inode's link count
340 * @inode: inode
341 *
342 * This is a low-level filesystem helper to replace any
343 * direct filesystem manipulation of i_nlink. See
344 * drop_nlink() for why we care about i_nlink hitting zero.
345 */
346void clear_nlink(struct inode *inode)
347{
348 if (inode->i_nlink) {
349 inode->__i_nlink = 0;
350 atomic_long_inc(&inode->i_sb->s_remove_count);
351 }
352}
353EXPORT_SYMBOL(clear_nlink);
354
355/**
356 * set_nlink - directly set an inode's link count
357 * @inode: inode
358 * @nlink: new nlink (should be non-zero)
359 *
360 * This is a low-level filesystem helper to replace any
361 * direct filesystem manipulation of i_nlink.
362 */
363void set_nlink(struct inode *inode, unsigned int nlink)
364{
365 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100366 clear_nlink(inode);
367 } else {
368 /* Yes, some filesystems do change nlink from zero to one */
369 if (inode->i_nlink == 0)
370 atomic_long_dec(&inode->i_sb->s_remove_count);
371
372 inode->__i_nlink = nlink;
373 }
374}
375EXPORT_SYMBOL(set_nlink);
376
377/**
378 * inc_nlink - directly increment an inode's link count
379 * @inode: inode
380 *
381 * This is a low-level filesystem helper to replace any
382 * direct filesystem manipulation of i_nlink. Currently,
383 * it is only here for parity with dec_nlink().
384 */
385void inc_nlink(struct inode *inode)
386{
Al Virof4e0c302013-06-11 08:34:36 +0400387 if (unlikely(inode->i_nlink == 0)) {
388 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100389 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400390 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100391
392 inode->__i_nlink++;
393}
394EXPORT_SYMBOL(inc_nlink);
395
Dave Chinnerae233952018-03-06 17:30:34 -0800396static void __address_space_init_once(struct address_space *mapping)
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100397{
Johannes Weiner7b785642019-05-24 10:12:46 -0400398 xa_init_flags(&mapping->i_pages, XA_FLAGS_LOCK_IRQ | XA_FLAGS_ACCOUNT);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800399 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100400 INIT_LIST_HEAD(&mapping->private_list);
401 spin_lock_init(&mapping->private_lock);
Davidlohr Buesof808c132017-09-08 16:15:08 -0700402 mapping->i_mmap = RB_ROOT_CACHED;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100403}
Dave Chinnerae233952018-03-06 17:30:34 -0800404
405void address_space_init_once(struct address_space *mapping)
406{
407 memset(mapping, 0, sizeof(*mapping));
408 __address_space_init_once(mapping);
409}
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100410EXPORT_SYMBOL(address_space_init_once);
411
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412/*
413 * These are initializations that only need to be done
414 * once, because the fields are idempotent across use
415 * of the inode, so let the slab aware of that.
416 */
417void inode_init_once(struct inode *inode)
418{
419 memset(inode, 0, sizeof(*inode));
420 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500422 INIT_LIST_HEAD(&inode->i_io_list);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700423 INIT_LIST_HEAD(&inode->i_wb_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100424 INIT_LIST_HEAD(&inode->i_lru);
Dave Chinnerae233952018-03-06 17:30:34 -0800425 __address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 i_size_ordered_init(inode);
427}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428EXPORT_SYMBOL(inode_init_once);
429
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700430static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530432 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
Christoph Lametera35afb82007-05-16 22:10:57 -0700434 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435}
436
437/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100438 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530440void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
Nick Piggin9e38d862010-10-23 06:55:17 -0400442 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443}
444
Al Viro7de9c6ee2010-10-23 11:11:40 -0400445/*
446 * get additional reference to inode; caller must already hold one.
447 */
448void ihold(struct inode *inode)
449{
450 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
451}
452EXPORT_SYMBOL(ihold);
453
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800454static void __inode_add_lru(struct inode *inode, bool rotate)
Nick Piggin9e38d862010-10-23 06:55:17 -0400455{
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800456 if (inode->i_state & (I_DIRTY_ALL | I_SYNC | I_FREEING | I_WILL_FREE))
457 return;
458 if (atomic_read(&inode->i_count))
459 return;
460 if (!(inode->i_sb->s_flags & SB_ACTIVE))
461 return;
462 if (!mapping_shrinkable(&inode->i_data))
463 return;
464
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000465 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000466 this_cpu_inc(nr_unused);
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800467 else if (rotate)
Josef Bacik563f4002017-04-18 16:04:17 -0400468 inode->i_state |= I_REFERENCED;
Nick Piggin9e38d862010-10-23 06:55:17 -0400469}
470
Jan Kara4eff96d2012-11-26 16:29:51 -0800471/*
472 * Add inode to LRU if needed (inode is unused and clean).
473 *
474 * Needs inode->i_lock held.
475 */
476void inode_add_lru(struct inode *inode)
477{
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800478 __inode_add_lru(inode, false);
Jan Kara4eff96d2012-11-26 16:29:51 -0800479}
480
Nick Piggin9e38d862010-10-23 06:55:17 -0400481static void inode_lru_list_del(struct inode *inode)
482{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000483 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000484 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485}
486
Christoph Hellwig646ec462010-10-23 07:15:32 -0400487/**
488 * inode_sb_list_add - add inode to the superblock list of inodes
489 * @inode: inode to add
490 */
491void inode_sb_list_add(struct inode *inode)
492{
Dave Chinner74278da2015-03-04 12:37:22 -0500493 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100494 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500495 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400496}
497EXPORT_SYMBOL_GPL(inode_sb_list_add);
498
Dave Chinner55fa6092011-03-22 22:23:40 +1100499static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400500{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200501 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500502 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200503 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500504 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200505 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400506}
507
Dave Chinner4c51acb2010-10-23 06:58:09 -0400508static unsigned long hash(struct super_block *sb, unsigned long hashval)
509{
510 unsigned long tmp;
511
512 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
513 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400514 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
515 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400516}
517
518/**
519 * __insert_inode_hash - hash an inode
520 * @inode: unhashed inode
521 * @hashval: unsigned long value used to locate this object in the
522 * inode_hashtable.
523 *
524 * Add an inode to the inode hash for this superblock.
525 */
526void __insert_inode_hash(struct inode *inode, unsigned long hashval)
527{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400528 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
529
Dave Chinner67a23c42011-03-22 22:23:42 +1100530 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100531 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000532 hlist_add_head_rcu(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100533 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100534 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400535}
536EXPORT_SYMBOL(__insert_inode_hash);
537
538/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200539 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400540 * @inode: inode to unhash
541 *
542 * Remove an inode from the superblock.
543 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200544void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400545{
Dave Chinner67a23c42011-03-22 22:23:42 +1100546 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100547 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000548 hlist_del_init_rcu(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100549 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100550 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400551}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200552EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400553
Matthew Wilcox (Oracle)3e9d80a82022-01-14 14:05:04 -0800554void dump_mapping(const struct address_space *mapping)
555{
556 struct inode *host;
557 const struct address_space_operations *a_ops;
558 struct hlist_node *dentry_first;
559 struct dentry *dentry_ptr;
560 struct dentry dentry;
561 unsigned long ino;
562
563 /*
564 * If mapping is an invalid pointer, we don't want to crash
565 * accessing it, so probe everything depending on it carefully.
566 */
567 if (get_kernel_nofault(host, &mapping->host) ||
568 get_kernel_nofault(a_ops, &mapping->a_ops)) {
569 pr_warn("invalid mapping:%px\n", mapping);
570 return;
571 }
572
573 if (!host) {
574 pr_warn("aops:%ps\n", a_ops);
575 return;
576 }
577
578 if (get_kernel_nofault(dentry_first, &host->i_dentry.first) ||
579 get_kernel_nofault(ino, &host->i_ino)) {
580 pr_warn("aops:%ps invalid inode:%px\n", a_ops, host);
581 return;
582 }
583
584 if (!dentry_first) {
585 pr_warn("aops:%ps ino:%lx\n", a_ops, ino);
586 return;
587 }
588
589 dentry_ptr = container_of(dentry_first, struct dentry, d_u.d_alias);
590 if (get_kernel_nofault(dentry, dentry_ptr)) {
591 pr_warn("aops:%ps ino:%lx invalid dentry:%px\n",
592 a_ops, ino, dentry_ptr);
593 return;
594 }
595
596 /*
597 * if dentry is corrupted, the %pd handler may still crash,
598 * but it's unlikely that we reach here with a corrupt mapping
599 */
600 pr_warn("aops:%ps ino:%lx dentry name:\"%pd\"\n", a_ops, ino, &dentry);
601}
602
Jan Karadbd57682012-05-03 14:48:02 +0200603void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400604{
Jan Kara08142572011-06-27 16:18:10 -0700605 /*
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700606 * We have to cycle the i_pages lock here because reclaim can be in the
Jan Kara08142572011-06-27 16:18:10 -0700607 * process of removing the last page (in __delete_from_page_cache())
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700608 * and we must not free the mapping under it.
Jan Kara08142572011-06-27 16:18:10 -0700609 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700610 xa_lock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400611 BUG_ON(inode->i_data.nrpages);
Hugh Dickins786b3112021-05-04 18:32:57 -0700612 /*
613 * Almost always, mapping_empty(&inode->i_data) here; but there are
614 * two known and long-standing ways in which nodes may get left behind
615 * (when deep radix-tree node allocation failed partway; or when THP
616 * collapse_file() failed). Until those two known cases are cleaned up,
617 * or a cleanup function is called here, do not BUG_ON(!mapping_empty),
618 * nor even WARN_ON(!mapping_empty).
619 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700620 xa_unlock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400621 BUG_ON(!list_empty(&inode->i_data.private_list));
622 BUG_ON(!(inode->i_state & I_FREEING));
623 BUG_ON(inode->i_state & I_CLEAR);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700624 BUG_ON(!list_empty(&inode->i_wb_list));
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100625 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400626 inode->i_state = I_FREEING | I_CLEAR;
627}
Jan Karadbd57682012-05-03 14:48:02 +0200628EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400629
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100630/*
631 * Free the inode passed in, removing it from the lists it is still connected
632 * to. We remove any pages still attached to the inode and wait for any IO that
633 * is still in progress before finally destroying the inode.
634 *
635 * An inode must already be marked I_FREEING so that we avoid the inode being
636 * moved back onto lists if we race with other code that manipulates the lists
637 * (e.g. writeback_single_inode). The caller is responsible for setting this.
638 *
639 * An inode must already be removed from the LRU list before being evicted from
640 * the cache. This should occur atomically with setting the I_FREEING state
641 * flag, so no inodes here should ever be on the LRU when being evicted.
642 */
Al Viro644da592010-06-07 13:21:05 -0400643static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400644{
645 const struct super_operations *op = inode->i_sb->s_op;
646
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100647 BUG_ON(!(inode->i_state & I_FREEING));
648 BUG_ON(!list_empty(&inode->i_lru));
649
Dave Chinnerc7f54082015-03-04 14:07:22 -0500650 if (!list_empty(&inode->i_io_list))
651 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200652
Dave Chinner55fa6092011-03-22 22:23:40 +1100653 inode_sb_list_del(inode);
654
Jan Kara169ebd92012-05-03 14:48:03 +0200655 /*
656 * Wait for flusher thread to be done with the inode so that filesystem
657 * does not start destroying it while writeback is still running. Since
658 * the inode has I_FREEING set, flusher thread won't start new work on
659 * the inode. We just have to wait for running writeback to finish.
660 */
661 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200662
Al Virobe7ce412010-06-04 19:40:39 -0400663 if (op->evict_inode) {
664 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400665 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700666 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200667 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400668 }
Al Viro661074e2010-06-04 20:19:55 -0400669 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
670 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100671
672 remove_inode_hash(inode);
673
674 spin_lock(&inode->i_lock);
675 wake_up_bit(&inode->i_state, __I_NEW);
676 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
677 spin_unlock(&inode->i_lock);
678
679 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400680}
681
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682/*
683 * dispose_list - dispose of the contents of a local list
684 * @head: the head of the list to free
685 *
686 * Dispose-list gets a local list with local inodes in it, so it doesn't
687 * need to worry about list corruption and SMP locks.
688 */
689static void dispose_list(struct list_head *head)
690{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 while (!list_empty(head)) {
692 struct inode *inode;
693
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100694 inode = list_first_entry(head, struct inode, i_lru);
695 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
Al Viro644da592010-06-07 13:21:05 -0400697 evict(inode);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500698 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700}
701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702/**
Al Viro63997e92010-10-25 20:49:35 -0400703 * evict_inodes - evict all evictable inodes for a superblock
704 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 *
Al Viro63997e92010-10-25 20:49:35 -0400706 * Make sure that no inodes with zero refcount are retained. This is
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800707 * called by superblock shutdown after having SB_ACTIVE flag removed,
Al Viro63997e92010-10-25 20:49:35 -0400708 * so any inode reaching zero refcount during or after that call will
709 * be immediately evicted.
710 */
711void evict_inodes(struct super_block *sb)
712{
713 struct inode *inode, *next;
714 LIST_HEAD(dispose);
715
Josef Bacikac05fbb2015-03-04 16:52:52 -0500716again:
Dave Chinner74278da2015-03-04 12:37:22 -0500717 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400718 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
719 if (atomic_read(&inode->i_count))
720 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100721
722 spin_lock(&inode->i_lock);
723 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
724 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400725 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100726 }
Al Viro63997e92010-10-25 20:49:35 -0400727
728 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100729 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100730 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100731 list_add(&inode->i_lru, &dispose);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500732
733 /*
734 * We can have a ton of inodes to evict at unmount time given
735 * enough memory, check to see if we need to go to sleep for a
736 * bit so we don't livelock.
737 */
738 if (need_resched()) {
739 spin_unlock(&sb->s_inode_list_lock);
740 cond_resched();
741 dispose_list(&dispose);
742 goto again;
743 }
Al Viro63997e92010-10-25 20:49:35 -0400744 }
Dave Chinner74278da2015-03-04 12:37:22 -0500745 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400746
747 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400748}
Darrick J. Wong799ea9e2017-08-18 18:08:25 -0700749EXPORT_SYMBOL_GPL(evict_inodes);
Al Viro63997e92010-10-25 20:49:35 -0400750
751/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200752 * invalidate_inodes - attempt to free all inodes on a superblock
753 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100754 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200755 *
756 * Attempts to free all inodes for a given superblock. If there were any
757 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100758 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
759 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 */
NeilBrown93b270f2011-02-24 17:25:47 +1100761int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400763 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200764 struct inode *inode, *next;
765 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
Eric Sandeen04646ae2019-12-06 10:54:23 -0600767again:
Dave Chinner74278da2015-03-04 12:37:22 -0500768 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200769 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100770 spin_lock(&inode->i_lock);
771 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
772 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100774 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500775 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100776 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100777 busy = 1;
778 continue;
779 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200780 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100781 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200782 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 continue;
784 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200785
Christoph Hellwig99a38912010-10-23 19:07:20 +0200786 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100787 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100788 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100789 list_add(&inode->i_lru, &dispose);
Eric Sandeen04646ae2019-12-06 10:54:23 -0600790 if (need_resched()) {
791 spin_unlock(&sb->s_inode_list_lock);
792 cond_resched();
793 dispose_list(&dispose);
794 goto again;
795 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 }
Dave Chinner74278da2015-03-04 12:37:22 -0500797 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Christoph Hellwiga0318782010-10-24 19:40:33 +0200799 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
801 return busy;
802}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000805 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400807 * If the inode has the I_REFERENCED flag set, then it means that it has been
808 * used recently - the flag is set in iput_final(). When we encounter such an
809 * inode, clear the flag and move it to the back of the LRU so it gets another
810 * pass through the LRU before it gets reclaimed. This is necessary because of
811 * the fact we are doing lazy LRU updates to minimise lock contention so the
812 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
813 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800815static enum lru_status inode_lru_isolate(struct list_head *item,
816 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000817{
818 struct list_head *freeable = arg;
819 struct inode *inode = container_of(item, struct inode, i_lru);
820
821 /*
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800822 * We are inverting the lru lock/inode->i_lock here, so use a
823 * trylock. If we fail to get the lock, just skip it.
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000824 */
825 if (!spin_trylock(&inode->i_lock))
826 return LRU_SKIP;
827
828 /*
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800829 * Inodes can get referenced, redirtied, or repopulated while
830 * they're already on the LRU, and this can make them
831 * unreclaimable for a while. Remove them lazily here; iput,
832 * sync, or the last page cache deletion will requeue them.
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000833 */
834 if (atomic_read(&inode->i_count) ||
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800835 (inode->i_state & ~I_REFERENCED) ||
836 !mapping_shrinkable(&inode->i_data)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800837 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000838 spin_unlock(&inode->i_lock);
839 this_cpu_dec(nr_unused);
840 return LRU_REMOVED;
841 }
842
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800843 /* Recently referenced inodes get one more pass */
Dave Chinner69056ee2019-02-12 15:35:51 -0800844 if (inode->i_state & I_REFERENCED) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000845 inode->i_state &= ~I_REFERENCED;
846 spin_unlock(&inode->i_lock);
847 return LRU_ROTATE;
848 }
849
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800850 /*
851 * On highmem systems, mapping_shrinkable() permits dropping
852 * page cache in order to free up struct inodes: lowmem might
853 * be under pressure before the cache inside the highmem zone.
854 */
Johannes Weiner7ae12c82021-09-02 14:53:24 -0700855 if (inode_has_buffers(inode) || !mapping_empty(&inode->i_data)) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000856 __iget(inode);
857 spin_unlock(&inode->i_lock);
858 spin_unlock(lru_lock);
859 if (remove_inode_buffers(inode)) {
860 unsigned long reap;
861 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
862 if (current_is_kswapd())
863 __count_vm_events(KSWAPD_INODESTEAL, reap);
864 else
865 __count_vm_events(PGINODESTEAL, reap);
866 if (current->reclaim_state)
867 current->reclaim_state->reclaimed_slab += reap;
868 }
869 iput(inode);
870 spin_lock(lru_lock);
871 return LRU_RETRY;
872 }
873
874 WARN_ON(inode->i_state & I_NEW);
875 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800876 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000877 spin_unlock(&inode->i_lock);
878
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000879 this_cpu_dec(nr_unused);
880 return LRU_REMOVED;
881}
882
883/*
884 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
885 * This is called from the superblock shrinker function with a number of inodes
886 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
887 * then are freed outside inode_lock by dispose_list().
888 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800889long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890{
891 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000892 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893
Vladimir Davydov503c3582015-02-12 14:58:47 -0800894 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
895 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000897 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898}
899
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900static void __wait_on_freeing_inode(struct inode *inode);
901/*
902 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530904static struct inode *find_inode(struct super_block *sb,
905 struct hlist_head *head,
906 int (*test)(struct inode *, void *),
907 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530909 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910
911repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800912 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500913 if (inode->i_sb != sb)
914 continue;
915 if (!test(inode, data))
916 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100917 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400918 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 __wait_on_freeing_inode(inode);
920 goto repeat;
921 }
Al Viroc2b6d622018-06-28 15:53:17 -0400922 if (unlikely(inode->i_state & I_CREATING)) {
923 spin_unlock(&inode->i_lock);
924 return ERR_PTR(-ESTALE);
925 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400926 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100927 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400928 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400930 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931}
932
933/*
934 * find_inode_fast is the fast path version of find_inode, see the comment at
935 * iget_locked for details.
936 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530937static struct inode *find_inode_fast(struct super_block *sb,
938 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530940 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941
942repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800943 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500944 if (inode->i_ino != ino)
945 continue;
946 if (inode->i_sb != sb)
947 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100948 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400949 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 __wait_on_freeing_inode(inode);
951 goto repeat;
952 }
Al Viroc2b6d622018-06-28 15:53:17 -0400953 if (unlikely(inode->i_state & I_CREATING)) {
954 spin_unlock(&inode->i_lock);
955 return ERR_PTR(-ESTALE);
956 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400957 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100958 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400959 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400961 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962}
963
Eric Dumazetf991bd22010-10-23 11:18:01 -0400964/*
965 * Each cpu owns a range of LAST_INO_BATCH numbers.
966 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
967 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100968 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400969 * This does not significantly increase overflow rate because every CPU can
970 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
971 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
972 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
973 * overflow rate by 2x, which does not seem too significant.
974 *
975 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
976 * error if st_ino won't fit in target struct field. Use 32bit counter
977 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100978 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400979#define LAST_INO_BATCH 1024
980static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100981
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400982unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400983{
984 unsigned int *p = &get_cpu_var(last_ino);
985 unsigned int res = *p;
986
987#ifdef CONFIG_SMP
988 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
989 static atomic_t shared_last_ino;
990 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
991
992 res = next - LAST_INO_BATCH;
993 }
994#endif
995
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300996 res++;
997 /* get_next_ino should not provide a 0 inode number */
998 if (unlikely(!res))
999 res++;
1000 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -04001001 put_cpu_var(last_ino);
1002 return res;
David Chinner8290c352008-10-30 17:35:24 +11001003}
Christoph Hellwig85fe4022010-10-23 11:19:54 -04001004EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +11001005
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +02001007 * new_inode_pseudo - obtain an inode
1008 * @sb: superblock
1009 *
1010 * Allocates a new inode for given superblock.
1011 * Inode wont be chained in superblock s_inodes list
1012 * This means :
1013 * - fs can't be unmount
1014 * - quotas, fsnotify, writeback can't work
1015 */
1016struct inode *new_inode_pseudo(struct super_block *sb)
1017{
1018 struct inode *inode = alloc_inode(sb);
1019
1020 if (inode) {
1021 spin_lock(&inode->i_lock);
1022 inode->i_state = 0;
1023 spin_unlock(&inode->i_lock);
1024 INIT_LIST_HEAD(&inode->i_sb_list);
1025 }
1026 return inode;
1027}
1028
1029/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 * new_inode - obtain an inode
1031 * @sb: superblock
1032 *
Mel Gorman769848c2007-07-17 04:03:05 -07001033 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -08001034 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -07001035 * If HIGHMEM pages are unsuitable or it is known that pages allocated
1036 * for the page cache are not reclaimable or migratable,
1037 * mapping_set_gfp_mask() must be called with suitable flags on the
1038 * newly created inode's mapping
1039 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 */
1041struct inode *new_inode(struct super_block *sb)
1042{
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301043 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
Dave Chinner74278da2015-03-04 12:37:22 -05001045 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301046
Eric Dumazeta209dfc2011-07-26 11:36:34 +02001047 inode = new_inode_pseudo(sb);
1048 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +11001049 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 return inode;
1051}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052EXPORT_SYMBOL(new_inode);
1053
Peter Zijlstra14358e62007-10-14 01:38:33 +02001054#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -04001055void lockdep_annotate_inode_mutex_key(struct inode *inode)
1056{
Namhyung Kima3314a02010-10-11 22:38:00 +09001057 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +02001058 struct file_system_type *type = inode->i_sb->s_type;
1059
Jan Kara9a7aa122009-06-04 15:26:49 +02001060 /* Set new key only if filesystem hasn't already changed it */
Al Viro9902af72016-04-15 15:08:36 -04001061 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +02001062 /*
1063 * ensure nobody is actually holding i_mutex
1064 */
Al Viro9902af72016-04-15 15:08:36 -04001065 // mutex_destroy(&inode->i_mutex);
1066 init_rwsem(&inode->i_rwsem);
1067 lockdep_set_class(&inode->i_rwsem,
Jan Kara9a7aa122009-06-04 15:26:49 +02001068 &type->i_mutex_dir_key);
1069 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +02001070 }
Josh Boyere096d0c2011-08-25 07:48:12 -04001071}
1072EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +02001073#endif
Josh Boyere096d0c2011-08-25 07:48:12 -04001074
1075/**
1076 * unlock_new_inode - clear the I_NEW state and wake up any waiters
1077 * @inode: new inode to unlock
1078 *
1079 * Called when the inode is fully initialised to clear the new state of the
1080 * inode and wake up anyone waiting for the inode to finish initialisation.
1081 */
1082void unlock_new_inode(struct inode *inode)
1083{
1084 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001085 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001086 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -04001087 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro310fa7a2012-03-10 17:07:28 -05001088 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +11001089 wake_up_bit(&inode->i_state, __I_NEW);
1090 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092EXPORT_SYMBOL(unlock_new_inode);
1093
Al Viroc2b6d622018-06-28 15:53:17 -04001094void discard_new_inode(struct inode *inode)
1095{
1096 lockdep_annotate_inode_mutex_key(inode);
1097 spin_lock(&inode->i_lock);
1098 WARN_ON(!(inode->i_state & I_NEW));
1099 inode->i_state &= ~I_NEW;
1100 smp_mb();
1101 wake_up_bit(&inode->i_state, __I_NEW);
1102 spin_unlock(&inode->i_lock);
1103 iput(inode);
1104}
1105EXPORT_SYMBOL(discard_new_inode);
1106
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001107/**
J. Bruce Fields375e2892012-04-18 15:16:33 -04001108 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001109 *
1110 * Lock any non-NULL argument that is not a directory.
1111 * Zero, one or two objects may be locked by this function.
1112 *
J. Bruce Fields375e2892012-04-18 15:16:33 -04001113 * @inode1: first inode to lock
1114 * @inode2: second inode to lock
1115 */
1116void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1117{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001118 if (inode1 > inode2)
1119 swap(inode1, inode2);
1120
1121 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001122 inode_lock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001123 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001124 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001125}
1126EXPORT_SYMBOL(lock_two_nondirectories);
1127
1128/**
1129 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
1130 * @inode1: first inode to unlock
1131 * @inode2: second inode to unlock
1132 */
1133void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1134{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001135 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001136 inode_unlock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001137 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001138 inode_unlock(inode2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001139}
1140EXPORT_SYMBOL(unlock_two_nondirectories);
1141
1142/**
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001143 * inode_insert5 - obtain an inode from a mounted file system
1144 * @inode: pre-allocated inode to use for insert to cache
1145 * @hashval: hash value (usually inode number) to get
1146 * @test: callback used for comparisons between inodes
1147 * @set: callback used to initialize a new struct inode
1148 * @data: opaque data pointer to pass to @test and @set
1149 *
1150 * Search for the inode specified by @hashval and @data in the inode cache,
1151 * and if present it is return it with an increased reference count. This is
1152 * a variant of iget5_locked() for callers that don't want to fail on memory
1153 * allocation of inode.
1154 *
1155 * If the inode is not in cache, insert the pre-allocated inode to cache and
1156 * return it locked, hashed, and with the I_NEW flag set. The file system gets
1157 * to fill it in before unlocking it via unlock_new_inode().
1158 *
1159 * Note both @test and @set are called with the inode_hash_lock held, so can't
1160 * sleep.
1161 */
1162struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
1163 int (*test)(struct inode *, void *),
1164 int (*set)(struct inode *, void *), void *data)
1165{
1166 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1167 struct inode *old;
Miklos Szeredie9505642018-07-24 15:01:55 +02001168 bool creating = inode->i_state & I_CREATING;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001169
1170again:
1171 spin_lock(&inode_hash_lock);
1172 old = find_inode(inode->i_sb, head, test, data);
1173 if (unlikely(old)) {
1174 /*
1175 * Uhhuh, somebody else created the same inode under us.
1176 * Use the old inode instead of the preallocated one.
1177 */
1178 spin_unlock(&inode_hash_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001179 if (IS_ERR(old))
1180 return NULL;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001181 wait_on_inode(old);
1182 if (unlikely(inode_unhashed(old))) {
1183 iput(old);
1184 goto again;
1185 }
1186 return old;
1187 }
1188
1189 if (set && unlikely(set(inode, data))) {
1190 inode = NULL;
1191 goto unlock;
1192 }
1193
1194 /*
1195 * Return the locked inode with I_NEW set, the
1196 * caller is responsible for filling in the contents
1197 */
1198 spin_lock(&inode->i_lock);
1199 inode->i_state |= I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001200 hlist_add_head_rcu(&inode->i_hash, head);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001201 spin_unlock(&inode->i_lock);
Miklos Szeredie9505642018-07-24 15:01:55 +02001202 if (!creating)
1203 inode_sb_list_add(inode);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001204unlock:
1205 spin_unlock(&inode_hash_lock);
1206
1207 return inode;
1208}
1209EXPORT_SYMBOL(inode_insert5);
1210
1211/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001212 * iget5_locked - obtain an inode from a mounted file system
1213 * @sb: super block of file system
1214 * @hashval: hash value (usually inode number) to get
1215 * @test: callback used for comparisons between inodes
1216 * @set: callback used to initialize a new struct inode
1217 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001219 * Search for the inode specified by @hashval and @data in the inode cache,
1220 * and if present it is return it with an increased reference count. This is
1221 * a generalized version of iget_locked() for file systems where the inode
1222 * number is not sufficient for unique identification of an inode.
1223 *
1224 * If the inode is not in cache, allocate a new inode and return it locked,
1225 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1226 * before unlocking it via unlock_new_inode().
1227 *
1228 * Note both @test and @set are called with the inode_hash_lock held, so can't
1229 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001231struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1232 int (*test)(struct inode *, void *),
1233 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234{
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001235 struct inode *inode = ilookup5(sb, hashval, test, data);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001236
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001237 if (!inode) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001238 struct inode *new = alloc_inode(sb);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001239
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001240 if (new) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001241 new->i_state = 0;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001242 inode = inode_insert5(new, hashval, test, set, data);
1243 if (unlikely(inode != new))
Miklos Szeredie9505642018-07-24 15:01:55 +02001244 destroy_inode(new);
Al Viro2864f302016-07-03 23:15:21 -04001245 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 }
1247 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001249EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001251/**
1252 * iget_locked - obtain an inode from a mounted file system
1253 * @sb: super block of file system
1254 * @ino: inode number to get
1255 *
1256 * Search for the inode specified by @ino in the inode cache and if present
1257 * return it with an increased reference count. This is for file systems
1258 * where the inode number is sufficient for unique identification of an inode.
1259 *
1260 * If the inode is not in cache, allocate a new inode and return it locked,
1261 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1262 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001264struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001266 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301267 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001268again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001269 spin_lock(&inode_hash_lock);
1270 inode = find_inode_fast(sb, head, ino);
1271 spin_unlock(&inode_hash_lock);
1272 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001273 if (IS_ERR(inode))
1274 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001275 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001276 if (unlikely(inode_unhashed(inode))) {
1277 iput(inode);
1278 goto again;
1279 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001280 return inode;
1281 }
1282
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 inode = alloc_inode(sb);
1284 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301285 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
Dave Chinner67a23c42011-03-22 22:23:42 +11001287 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 /* We released the lock, so.. */
1289 old = find_inode_fast(sb, head, ino);
1290 if (!old) {
1291 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001292 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001293 inode->i_state = I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001294 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001295 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001296 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001297 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
1299 /* Return the locked inode with I_NEW set, the
1300 * caller is responsible for filling in the contents
1301 */
1302 return inode;
1303 }
1304
1305 /*
1306 * Uhhuh, somebody else created the same inode under
1307 * us. Use the old inode instead of the one we just
1308 * allocated.
1309 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001310 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 destroy_inode(inode);
Al Viroc2b6d622018-06-28 15:53:17 -04001312 if (IS_ERR(old))
1313 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 inode = old;
1315 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001316 if (unlikely(inode_unhashed(inode))) {
1317 iput(inode);
1318 goto again;
1319 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 }
1321 return inode;
1322}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001323EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001325/*
1326 * search the inode cache for a matching inode number.
1327 * If we find one, then the inode number we are trying to
1328 * allocate is not unique and so we should not use it.
1329 *
1330 * Returns 1 if the inode number is unique, 0 if it is not.
1331 */
1332static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1333{
1334 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001335 struct inode *inode;
1336
David Howells3f19b2a2017-12-01 11:40:16 +00001337 hlist_for_each_entry_rcu(inode, b, i_hash) {
1338 if (inode->i_ino == ino && inode->i_sb == sb)
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001339 return 0;
1340 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001341 return 1;
1342}
1343
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344/**
1345 * iunique - get a unique inode number
1346 * @sb: superblock
1347 * @max_reserved: highest reserved inode number
1348 *
1349 * Obtain an inode number that is unique on the system for a given
1350 * superblock. This is used by file systems that have no natural
1351 * permanent inode numbering system. An inode number is returned that
1352 * is higher than the reserved limit but unique.
1353 *
1354 * BUGS:
1355 * With a large number of inodes live on the file system this function
1356 * currently becomes quite slow.
1357 */
1358ino_t iunique(struct super_block *sb, ino_t max_reserved)
1359{
Jeff Layton866b04f2007-05-08 00:32:29 -07001360 /*
1361 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1362 * error if st_ino won't fit in target struct field. Use 32bit counter
1363 * here to attempt to avoid that.
1364 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001365 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001366 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368
David Howells3f19b2a2017-12-01 11:40:16 +00001369 rcu_read_lock();
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001370 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001371 do {
1372 if (counter <= max_reserved)
1373 counter = max_reserved + 1;
1374 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001375 } while (!test_inode_iunique(sb, res));
1376 spin_unlock(&iunique_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001377 rcu_read_unlock();
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001378
1379 return res;
1380}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381EXPORT_SYMBOL(iunique);
1382
1383struct inode *igrab(struct inode *inode)
1384{
Dave Chinner250df6e2011-03-22 22:23:36 +11001385 spin_lock(&inode->i_lock);
1386 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001388 spin_unlock(&inode->i_lock);
1389 } else {
1390 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 /*
1392 * Handle the case where s_op->clear_inode is not been
1393 * called yet, and somebody is calling igrab
1394 * while the inode is getting freed.
1395 */
1396 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001397 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 return inode;
1399}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400EXPORT_SYMBOL(igrab);
1401
1402/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001403 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 * @sb: super block of file system to search
1405 * @hashval: hash value (usually inode number) to search for
1406 * @test: callback used for comparisons between inodes
1407 * @data: opaque data pointer to pass to @test
1408 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001409 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001411 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001412 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001413 * Note: I_NEW is not waited upon so you have to be very careful what you do
1414 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001415 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001416 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001417 */
1418struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1419 int (*test)(struct inode *, void *), void *data)
1420{
1421 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001422 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001423
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001424 spin_lock(&inode_hash_lock);
1425 inode = find_inode(sb, head, test, data);
1426 spin_unlock(&inode_hash_lock);
1427
Al Viroc2b6d622018-06-28 15:53:17 -04001428 return IS_ERR(inode) ? NULL : inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001429}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001430EXPORT_SYMBOL(ilookup5_nowait);
1431
1432/**
1433 * ilookup5 - search for an inode in the inode cache
1434 * @sb: super block of file system to search
1435 * @hashval: hash value (usually inode number) to search for
1436 * @test: callback used for comparisons between inodes
1437 * @data: opaque data pointer to pass to @test
1438 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001439 * Search for the inode specified by @hashval and @data in the inode cache,
1440 * and if the inode is in the cache, return the inode with an incremented
1441 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001442 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001444 * This is a generalized version of ilookup() for file systems where the
1445 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001447 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 */
1449struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1450 int (*test)(struct inode *, void *), void *data)
1451{
Al Viro2864f302016-07-03 23:15:21 -04001452 struct inode *inode;
1453again:
1454 inode = ilookup5_nowait(sb, hashval, test, data);
1455 if (inode) {
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001456 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001457 if (unlikely(inode_unhashed(inode))) {
1458 iput(inode);
1459 goto again;
1460 }
1461 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001462 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464EXPORT_SYMBOL(ilookup5);
1465
1466/**
1467 * ilookup - search for an inode in the inode cache
1468 * @sb: super block of file system to search
1469 * @ino: inode number to search for
1470 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001471 * Search for the inode @ino in the inode cache, and if the inode is in the
1472 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 */
1474struct inode *ilookup(struct super_block *sb, unsigned long ino)
1475{
1476 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001477 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001478again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001479 spin_lock(&inode_hash_lock);
1480 inode = find_inode_fast(sb, head, ino);
1481 spin_unlock(&inode_hash_lock);
1482
Al Viro2864f302016-07-03 23:15:21 -04001483 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001484 if (IS_ERR(inode))
1485 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001486 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001487 if (unlikely(inode_unhashed(inode))) {
1488 iput(inode);
1489 goto again;
1490 }
1491 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001492 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494EXPORT_SYMBOL(ilookup);
1495
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001496/**
1497 * find_inode_nowait - find an inode in the inode cache
1498 * @sb: super block of file system to search
1499 * @hashval: hash value (usually inode number) to search for
1500 * @match: callback used for comparisons between inodes
1501 * @data: opaque data pointer to pass to @match
1502 *
1503 * Search for the inode specified by @hashval and @data in the inode
1504 * cache, where the helper function @match will return 0 if the inode
1505 * does not match, 1 if the inode does match, and -1 if the search
1506 * should be stopped. The @match function must be responsible for
1507 * taking the i_lock spin_lock and checking i_state for an inode being
1508 * freed or being initialized, and incrementing the reference count
1509 * before returning 1. It also must not sleep, since it is called with
1510 * the inode_hash_lock spinlock held.
1511 *
1512 * This is a even more generalized version of ilookup5() when the
1513 * function must never block --- find_inode() can block in
1514 * __wait_on_freeing_inode() --- or when the caller can not increment
1515 * the reference count because the resulting iput() might cause an
1516 * inode eviction. The tradeoff is that the @match funtion must be
1517 * very carefully implemented.
1518 */
1519struct inode *find_inode_nowait(struct super_block *sb,
1520 unsigned long hashval,
1521 int (*match)(struct inode *, unsigned long,
1522 void *),
1523 void *data)
1524{
1525 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1526 struct inode *inode, *ret_inode = NULL;
1527 int mval;
1528
1529 spin_lock(&inode_hash_lock);
1530 hlist_for_each_entry(inode, head, i_hash) {
1531 if (inode->i_sb != sb)
1532 continue;
1533 mval = match(inode, hashval, data);
1534 if (mval == 0)
1535 continue;
1536 if (mval == 1)
1537 ret_inode = inode;
1538 goto out;
1539 }
1540out:
1541 spin_unlock(&inode_hash_lock);
1542 return ret_inode;
1543}
1544EXPORT_SYMBOL(find_inode_nowait);
1545
David Howells3f19b2a2017-12-01 11:40:16 +00001546/**
1547 * find_inode_rcu - find an inode in the inode cache
1548 * @sb: Super block of file system to search
1549 * @hashval: Key to hash
1550 * @test: Function to test match on an inode
1551 * @data: Data for test function
1552 *
1553 * Search for the inode specified by @hashval and @data in the inode cache,
1554 * where the helper function @test will return 0 if the inode does not match
1555 * and 1 if it does. The @test function must be responsible for taking the
1556 * i_lock spin_lock and checking i_state for an inode being freed or being
1557 * initialized.
1558 *
1559 * If successful, this will return the inode for which the @test function
1560 * returned 1 and NULL otherwise.
1561 *
1562 * The @test function is not permitted to take a ref on any inode presented.
1563 * It is also not permitted to sleep.
1564 *
1565 * The caller must hold the RCU read lock.
1566 */
1567struct inode *find_inode_rcu(struct super_block *sb, unsigned long hashval,
1568 int (*test)(struct inode *, void *), void *data)
1569{
1570 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1571 struct inode *inode;
1572
1573 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1574 "suspicious find_inode_rcu() usage");
1575
1576 hlist_for_each_entry_rcu(inode, head, i_hash) {
1577 if (inode->i_sb == sb &&
1578 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)) &&
1579 test(inode, data))
1580 return inode;
1581 }
1582 return NULL;
1583}
1584EXPORT_SYMBOL(find_inode_rcu);
1585
1586/**
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001587 * find_inode_by_ino_rcu - Find an inode in the inode cache
David Howells3f19b2a2017-12-01 11:40:16 +00001588 * @sb: Super block of file system to search
1589 * @ino: The inode number to match
1590 *
1591 * Search for the inode specified by @hashval and @data in the inode cache,
1592 * where the helper function @test will return 0 if the inode does not match
1593 * and 1 if it does. The @test function must be responsible for taking the
1594 * i_lock spin_lock and checking i_state for an inode being freed or being
1595 * initialized.
1596 *
1597 * If successful, this will return the inode for which the @test function
1598 * returned 1 and NULL otherwise.
1599 *
1600 * The @test function is not permitted to take a ref on any inode presented.
1601 * It is also not permitted to sleep.
1602 *
1603 * The caller must hold the RCU read lock.
1604 */
1605struct inode *find_inode_by_ino_rcu(struct super_block *sb,
1606 unsigned long ino)
1607{
1608 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1609 struct inode *inode;
1610
1611 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1612 "suspicious find_inode_by_ino_rcu() usage");
1613
1614 hlist_for_each_entry_rcu(inode, head, i_hash) {
1615 if (inode->i_ino == ino &&
1616 inode->i_sb == sb &&
1617 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)))
1618 return inode;
1619 }
1620 return NULL;
1621}
1622EXPORT_SYMBOL(find_inode_by_ino_rcu);
1623
Al Viro261bca82008-12-30 01:48:21 -05001624int insert_inode_locked(struct inode *inode)
1625{
1626 struct super_block *sb = inode->i_sb;
1627 ino_t ino = inode->i_ino;
1628 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001629
Al Viro261bca82008-12-30 01:48:21 -05001630 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001631 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001632 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001633 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001634 if (old->i_ino != ino)
1635 continue;
1636 if (old->i_sb != sb)
1637 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001638 spin_lock(&old->i_lock);
1639 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1640 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001641 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001642 }
Al Viro72a43d62009-05-13 19:13:40 +01001643 break;
1644 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001645 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001646 spin_lock(&inode->i_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001647 inode->i_state |= I_NEW | I_CREATING;
David Howells3f19b2a2017-12-01 11:40:16 +00001648 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001649 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001650 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001651 return 0;
1652 }
Al Viroc2b6d622018-06-28 15:53:17 -04001653 if (unlikely(old->i_state & I_CREATING)) {
1654 spin_unlock(&old->i_lock);
1655 spin_unlock(&inode_hash_lock);
1656 return -EBUSY;
1657 }
Al Viro261bca82008-12-30 01:48:21 -05001658 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001659 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001660 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001661 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001662 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001663 iput(old);
1664 return -EBUSY;
1665 }
1666 iput(old);
1667 }
1668}
Al Viro261bca82008-12-30 01:48:21 -05001669EXPORT_SYMBOL(insert_inode_locked);
1670
1671int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1672 int (*test)(struct inode *, void *), void *data)
1673{
Al Viroc2b6d622018-06-28 15:53:17 -04001674 struct inode *old;
1675
1676 inode->i_state |= I_CREATING;
1677 old = inode_insert5(inode, hashval, test, NULL, data);
Al Viro261bca82008-12-30 01:48:21 -05001678
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001679 if (old != inode) {
Al Viro261bca82008-12-30 01:48:21 -05001680 iput(old);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001681 return -EBUSY;
Al Viro261bca82008-12-30 01:48:21 -05001682 }
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001683 return 0;
Al Viro261bca82008-12-30 01:48:21 -05001684}
Al Viro261bca82008-12-30 01:48:21 -05001685EXPORT_SYMBOL(insert_inode_locked4);
1686
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687
Al Viro45321ac2010-06-07 13:43:19 -04001688int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689{
Al Viro45321ac2010-06-07 13:43:19 -04001690 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692EXPORT_SYMBOL(generic_delete_inode);
1693
Al Viro45321ac2010-06-07 13:43:19 -04001694/*
Al Viro45321ac2010-06-07 13:43:19 -04001695 * Called when we're dropping the last reference
1696 * to an inode.
1697 *
1698 * Call the FS "drop_inode()" function, defaulting to
1699 * the legacy UNIX filesystem behaviour. If it tells
1700 * us to evict inode, do so. Otherwise, retain inode
1701 * in cache if fs is alive, sync and evict if fs is
1702 * shutting down.
1703 */
1704static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705{
1706 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001707 const struct super_operations *op = inode->i_sb->s_op;
David Howells3f19b2a2017-12-01 11:40:16 +00001708 unsigned long state;
Al Viro45321ac2010-06-07 13:43:19 -04001709 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Dave Chinner250df6e2011-03-22 22:23:36 +11001711 WARN_ON(inode->i_state & I_NEW);
1712
Al Viroe7f59092011-07-07 15:45:59 -04001713 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001714 drop = op->drop_inode(inode);
1715 else
1716 drop = generic_drop_inode(inode);
1717
Hao Li88149082020-12-08 10:08:43 +08001718 if (!drop &&
1719 !(inode->i_state & I_DONTCACHE) &&
1720 (sb->s_flags & SB_ACTIVE)) {
Johannes Weiner51b8c1f2021-11-08 18:31:24 -08001721 __inode_add_lru(inode, true);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001722 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001723 return;
1724 }
1725
David Howells3f19b2a2017-12-01 11:40:16 +00001726 state = inode->i_state;
Al Viro45321ac2010-06-07 13:43:19 -04001727 if (!drop) {
David Howells3f19b2a2017-12-01 11:40:16 +00001728 WRITE_ONCE(inode->i_state, state | I_WILL_FREE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001729 spin_unlock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001730
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 write_inode_now(inode, 1);
David Howells3f19b2a2017-12-01 11:40:16 +00001732
Dave Chinner250df6e2011-03-22 22:23:36 +11001733 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001734 state = inode->i_state;
1735 WARN_ON(state & I_NEW);
1736 state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001738
David Howells3f19b2a2017-12-01 11:40:16 +00001739 WRITE_ONCE(inode->i_state, state | I_FREEING);
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001740 if (!list_empty(&inode->i_lru))
1741 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001742 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001743
1744 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745}
1746
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301748 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 * @inode: inode to put
1750 *
1751 * Puts an inode, dropping its usage count. If the inode use count hits
1752 * zero, the inode is then freed and may also be destroyed.
1753 *
1754 * Consequently, iput() can sleep.
1755 */
1756void iput(struct inode *inode)
1757{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001758 if (!inode)
1759 return;
1760 BUG_ON(inode->i_state & I_CLEAR);
1761retry:
1762 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1763 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1764 atomic_inc(&inode->i_count);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001765 spin_unlock(&inode->i_lock);
1766 trace_writeback_lazytime_iput(inode);
1767 mark_inode_dirty_sync(inode);
1768 goto retry;
1769 }
1770 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 }
1772}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773EXPORT_SYMBOL(iput);
1774
Carlos Maiolino30460e12020-01-09 14:30:41 +01001775#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776/**
1777 * bmap - find a block number in a file
Carlos Maiolino30460e12020-01-09 14:30:41 +01001778 * @inode: inode owning the block number being requested
1779 * @block: pointer containing the block to find
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 *
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001781 * Replaces the value in ``*block`` with the block number on the device holding
Carlos Maiolino30460e12020-01-09 14:30:41 +01001782 * corresponding to the requested block number in the file.
1783 * That is, asked for block 4 of inode 1 the function will replace the
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001784 * 4 in ``*block``, with disk block relative to the disk start that holds that
Carlos Maiolino30460e12020-01-09 14:30:41 +01001785 * block of the file.
1786 *
1787 * Returns -EINVAL in case of error, 0 otherwise. If mapping falls into a
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001788 * hole, returns 0 and ``*block`` is also set to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 */
Carlos Maiolino30460e12020-01-09 14:30:41 +01001790int bmap(struct inode *inode, sector_t *block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791{
Carlos Maiolino30460e12020-01-09 14:30:41 +01001792 if (!inode->i_mapping->a_ops->bmap)
1793 return -EINVAL;
1794
1795 *block = inode->i_mapping->a_ops->bmap(inode->i_mapping, *block);
1796 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798EXPORT_SYMBOL(bmap);
Carlos Maiolino30460e12020-01-09 14:30:41 +01001799#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001801/*
1802 * With relative atime, only update atime if the previous atime is
1803 * earlier than either the ctime or mtime or if at least a day has
1804 * passed since the last atime update.
1805 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001806static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001807 struct timespec64 now)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001808{
1809
Miklos Szeredic6718542018-07-18 15:44:43 +02001810 if (!(mnt->mnt_flags & MNT_RELATIME))
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001811 return 1;
1812 /*
1813 * Is mtime younger than atime? If yes, update atime:
1814 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001815 if (timespec64_compare(&inode->i_mtime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001816 return 1;
1817 /*
1818 * Is ctime younger than atime? If yes, update atime:
1819 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001820 if (timespec64_compare(&inode->i_ctime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001821 return 1;
1822
1823 /*
1824 * Is the previous atime value older than a day? If yes,
1825 * update atime:
1826 */
1827 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1828 return 1;
1829 /*
1830 * Good, we can skip the atime update:
1831 */
1832 return 0;
1833}
1834
Deepa Dinamani95582b02018-05-08 19:36:02 -07001835int generic_update_time(struct inode *inode, struct timespec64 *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001836{
Eric Biggerse20b14d2021-01-12 11:02:45 -08001837 int dirty_flags = 0;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001838
Eric Biggerse20b14d2021-01-12 11:02:45 -08001839 if (flags & (S_ATIME | S_CTIME | S_MTIME)) {
1840 if (flags & S_ATIME)
1841 inode->i_atime = *time;
1842 if (flags & S_CTIME)
1843 inode->i_ctime = *time;
1844 if (flags & S_MTIME)
1845 inode->i_mtime = *time;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001846
Eric Biggerse20b14d2021-01-12 11:02:45 -08001847 if (inode->i_sb->s_flags & SB_LAZYTIME)
1848 dirty_flags |= I_DIRTY_TIME;
1849 else
1850 dirty_flags |= I_DIRTY_SYNC;
1851 }
1852
1853 if ((flags & S_VERSION) && inode_maybe_inc_iversion(inode, false))
1854 dirty_flags |= I_DIRTY_SYNC;
1855
1856 __mark_inode_dirty(inode, dirty_flags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001857 return 0;
1858}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001859EXPORT_SYMBOL(generic_update_time);
1860
1861/*
1862 * This does the actual work of updating an inodes time or version. Must have
1863 * had called mnt_want_write() before calling this.
1864 */
Josef Bacike60feb42021-10-14 13:11:00 -04001865int inode_update_time(struct inode *inode, struct timespec64 *time, int flags)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001866{
Deepa Dinamani23b424d2019-12-02 21:19:45 -08001867 if (inode->i_op->update_time)
1868 return inode->i_op->update_time(inode, time, flags);
1869 return generic_update_time(inode, time, flags);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001870}
Josef Bacike60feb42021-10-14 13:11:00 -04001871EXPORT_SYMBOL(inode_update_time);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001872
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873/**
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001874 * atime_needs_update - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001875 * @path: the &struct path to update
Randy Dunlap30fdc8e2015-11-09 14:57:58 -08001876 * @inode: inode to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 *
1878 * Update the accessed time on an inode and mark it for writeback.
1879 * This function automatically handles read only file systems and media,
1880 * as well as the "noatime" flag and inode specific "noatime" markers.
1881 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001882bool atime_needs_update(const struct path *path, struct inode *inode)
NeilBrown8fa9dd22015-03-23 13:37:40 +11001883{
1884 struct vfsmount *mnt = path->mnt;
Deepa Dinamani95582b02018-05-08 19:36:02 -07001885 struct timespec64 now;
NeilBrown8fa9dd22015-03-23 13:37:40 +11001886
1887 if (inode->i_flags & S_NOATIME)
1888 return false;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001889
1890 /* Atime updates will likely cause i_uid and i_gid to be written
1891 * back improprely if their true value is unknown to the vfs.
1892 */
Christian Braunerba73d982021-01-21 14:19:31 +01001893 if (HAS_UNMAPPED_ID(mnt_user_ns(mnt), inode))
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001894 return false;
1895
NeilBrown8fa9dd22015-03-23 13:37:40 +11001896 if (IS_NOATIME(inode))
1897 return false;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001898 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001899 return false;
1900
1901 if (mnt->mnt_flags & MNT_NOATIME)
1902 return false;
1903 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1904 return false;
1905
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001906 now = current_time(inode);
NeilBrown8fa9dd22015-03-23 13:37:40 +11001907
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001908 if (!relatime_need_update(mnt, inode, now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001909 return false;
1910
Deepa Dinamani95582b02018-05-08 19:36:02 -07001911 if (timespec64_equal(&inode->i_atime, &now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001912 return false;
1913
1914 return true;
1915}
1916
Al Virobadcf2b2013-07-16 18:15:46 +04001917void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918{
Al Viro68ac1232012-03-15 08:21:57 -04001919 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001920 struct inode *inode = d_inode(path->dentry);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001921 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922
Miklos Szeredic6718542018-07-18 15:44:43 +02001923 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001924 return;
1925
Jan Kara5d37e9e2012-06-12 16:20:36 +02001926 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001927 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001928
NeilBrown8fa9dd22015-03-23 13:37:40 +11001929 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001930 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001931 /*
1932 * File systems can error out when updating inodes if they need to
1933 * allocate new space to modify an inode (such is the case for
1934 * Btrfs), but since we touch atime while walking down the path we
1935 * really don't care if we failed to update the atime of the file,
1936 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001937 * We may also fail on filesystems that have the ability to make parts
1938 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001939 */
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001940 now = current_time(inode);
Josef Bacike60feb42021-10-14 13:11:00 -04001941 inode_update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001942 __mnt_drop_write(mnt);
1943skip_update:
1944 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001946EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
Cong Wang3ed37642012-05-15 14:57:33 +08001948/*
1949 * The logic we want is
1950 *
1951 * if suid or (sgid and xgrp)
1952 * remove privs
1953 */
1954int should_remove_suid(struct dentry *dentry)
1955{
David Howellsdf2b1af2015-03-17 22:26:15 +00001956 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001957 int kill = 0;
1958
1959 /* suid always must be killed */
1960 if (unlikely(mode & S_ISUID))
1961 kill = ATTR_KILL_SUID;
1962
1963 /*
1964 * sgid without any exec bits is just a mandatory locking mark; leave
1965 * it alone. If some exec bits are set, it's a real sgid; kill it.
1966 */
1967 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1968 kill |= ATTR_KILL_SGID;
1969
1970 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1971 return kill;
1972
1973 return 0;
1974}
1975EXPORT_SYMBOL(should_remove_suid);
1976
Jan Karadbfae0c2015-05-21 16:05:54 +02001977/*
1978 * Return mask of changes for notify_change() that need to be done as a
1979 * response to write or truncate. Return 0 if nothing has to be changed.
1980 * Negative value on error (change should be denied).
1981 */
Jan Kara45f147a2015-05-21 16:05:55 +02001982int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001983{
Jan Karadbfae0c2015-05-21 16:05:54 +02001984 struct inode *inode = d_inode(dentry);
1985 int mask = 0;
1986 int ret;
1987
1988 if (IS_NOSEC(inode))
1989 return 0;
1990
1991 mask = should_remove_suid(dentry);
1992 ret = security_inode_need_killpriv(dentry);
1993 if (ret < 0)
1994 return ret;
1995 if (ret)
1996 mask |= ATTR_KILL_PRIV;
1997 return mask;
1998}
Jan Karadbfae0c2015-05-21 16:05:54 +02001999
Christian Brauner643fe552021-01-21 14:19:34 +01002000static int __remove_privs(struct user_namespace *mnt_userns,
2001 struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08002002{
2003 struct iattr newattrs;
2004
2005 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002006 /*
2007 * Note we call this on write, so notify_change will not
2008 * encounter any conflicting delegations:
2009 */
Christian Brauner643fe552021-01-21 14:19:34 +01002010 return notify_change(mnt_userns, dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08002011}
2012
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002013/*
2014 * Remove special file priviledges (suid, capabilities) when file is written
2015 * to or truncated.
2016 */
2017int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08002018{
Miklos Szeredic1892c32016-08-03 13:44:27 +02002019 struct dentry *dentry = file_dentry(file);
2020 struct inode *inode = file_inode(file);
Jan Karadbfae0c2015-05-21 16:05:54 +02002021 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08002022 int error = 0;
2023
Alexander Lochmannf69e7492018-12-14 11:55:52 +01002024 /*
2025 * Fast path for nothing security related.
2026 * As well for non-regular files, e.g. blkdev inodes.
2027 * For example, blkdev_write_iter() might get here
2028 * trying to remove privs which it is not allowed to.
2029 */
2030 if (IS_NOSEC(inode) || !S_ISREG(inode->i_mode))
Cong Wang3ed37642012-05-15 14:57:33 +08002031 return 0;
2032
Miklos Szeredic1892c32016-08-03 13:44:27 +02002033 kill = dentry_needs_remove_privs(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02002034 if (kill < 0)
2035 return kill;
2036 if (kill)
Christian Brauner643fe552021-01-21 14:19:34 +01002037 error = __remove_privs(file_mnt_user_ns(file), dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02002038 if (!error)
2039 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08002040
2041 return error;
2042}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002043EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08002044
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08002046 * file_update_time - update mtime and ctime time
2047 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08002049 * Update the mtime and ctime members of an inode and mark the inode
2050 * for writeback. Note that this function is meant exclusively for
2051 * usage in the file write path of filesystems, and filesystems may
2052 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02002053 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04002054 * timestamps are handled by the server. This can return an error for
2055 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 */
2057
Josef Bacikc3b2da32012-03-26 09:59:21 -04002058int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059{
Al Viro496ad9a2013-01-23 17:07:38 -05002060 struct inode *inode = file_inode(file);
Deepa Dinamani95582b02018-05-08 19:36:02 -07002061 struct timespec64 now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04002062 int sync_it = 0;
2063 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064
Andi Kleence06e0b2009-09-18 13:05:48 -07002065 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04002067 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08002068
Deepa Dinamanic2050a42016-09-14 07:48:06 -07002069 now = current_time(inode);
Deepa Dinamani95582b02018-05-08 19:36:02 -07002070 if (!timespec64_equal(&inode->i_mtime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07002071 sync_it = S_MTIME;
2072
Deepa Dinamani95582b02018-05-08 19:36:02 -07002073 if (!timespec64_equal(&inode->i_ctime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07002074 sync_it |= S_CTIME;
2075
Jeff Laytone38cf302017-12-11 06:35:22 -05002076 if (IS_I_VERSION(inode) && inode_iversion_need_inc(inode))
Andi Kleence06e0b2009-09-18 13:05:48 -07002077 sync_it |= S_VERSION;
2078
2079 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04002080 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081
Andi Kleence06e0b2009-09-18 13:05:48 -07002082 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02002083 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04002084 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085
Josef Bacike60feb42021-10-14 13:11:00 -04002086 ret = inode_update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02002087 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04002088
2089 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090}
Christoph Hellwig870f4812006-01-09 20:52:01 -08002091EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092
Amir Goldsteine38f7f52019-06-05 08:04:49 -07002093/* Caller must hold the file's inode lock */
2094int file_modified(struct file *file)
2095{
2096 int err;
2097
2098 /*
2099 * Clear the security bits if the process is not being run by root.
2100 * This keeps people from modifying setuid and setgid binaries.
2101 */
2102 err = file_remove_privs(file);
2103 if (err)
2104 return err;
2105
2106 if (unlikely(file->f_mode & FMODE_NOCMTIME))
2107 return 0;
2108
2109 return file_update_time(file);
2110}
2111EXPORT_SYMBOL(file_modified);
2112
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113int inode_needs_sync(struct inode *inode)
2114{
2115 if (IS_SYNC(inode))
2116 return 1;
2117 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
2118 return 1;
2119 return 0;
2120}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121EXPORT_SYMBOL(inode_needs_sync);
2122
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07002124 * If we try to find an inode in the inode hash while it is being
2125 * deleted, we have to wait until the filesystem completes its
2126 * deletion before reporting that it isn't found. This function waits
2127 * until the deletion _might_ have completed. Callers are responsible
2128 * to recheck inode state.
2129 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002130 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11002131 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
2132 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 */
2134static void __wait_on_freeing_inode(struct inode *inode)
2135{
2136 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002137 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
2138 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Ingo Molnar21417132017-03-05 11:25:39 +01002139 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11002140 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11002141 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 schedule();
Ingo Molnar21417132017-03-05 11:25:39 +01002143 finish_wait(wq, &wait.wq_entry);
Dave Chinner67a23c42011-03-22 22:23:42 +11002144 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145}
2146
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147static __initdata unsigned long ihash_entries;
2148static int __init set_ihash_entries(char *str)
2149{
2150 if (!str)
2151 return 0;
2152 ihash_entries = simple_strtoul(str, &str, 0);
2153 return 1;
2154}
2155__setup("ihash_entries=", set_ihash_entries);
2156
2157/*
2158 * Initialize the waitqueues and inode hash table.
2159 */
2160void __init inode_init_early(void)
2161{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 /* If hashes are distributed across NUMA nodes, defer
2163 * hash allocation until vmalloc space is available.
2164 */
2165 if (hashdist)
2166 return;
2167
2168 inode_hashtable =
2169 alloc_large_system_hash("Inode-cache",
2170 sizeof(struct hlist_head),
2171 ihash_entries,
2172 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002173 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 &i_hash_shift,
2175 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002176 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178}
2179
Denis Cheng74bf17c2007-10-16 23:26:30 -07002180void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08002183 inode_cachep = kmem_cache_create("inode_cache",
2184 sizeof(struct inode),
2185 0,
2186 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
Vladimir Davydov5d097052016-01-14 15:18:21 -08002187 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
Paul Mundt20c2df82007-07-20 10:11:58 +09002188 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189
2190 /* Hash may have been set up in inode_init_early */
2191 if (!hashdist)
2192 return;
2193
2194 inode_hashtable =
2195 alloc_large_system_hash("Inode-cache",
2196 sizeof(struct hlist_head),
2197 ihash_entries,
2198 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002199 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 &i_hash_shift,
2201 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002202 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204}
2205
2206void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
2207{
2208 inode->i_mode = mode;
2209 if (S_ISCHR(mode)) {
2210 inode->i_fop = &def_chr_fops;
2211 inode->i_rdev = rdev;
2212 } else if (S_ISBLK(mode)) {
2213 inode->i_fop = &def_blk_fops;
2214 inode->i_rdev = rdev;
2215 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04002216 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05002218 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07002220 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
2221 " inode %s:%lu\n", mode, inode->i_sb->s_id,
2222 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223}
2224EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002225
2226/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00002227 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Christian Brauner21cb47b2021-01-21 14:19:25 +01002228 * @mnt_userns: User namespace of the mount the inode was created from
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002229 * @inode: New inode
2230 * @dir: Directory inode
2231 * @mode: mode of the new inode
Christian Brauner21cb47b2021-01-21 14:19:25 +01002232 *
2233 * If the inode has been created through an idmapped mount the user namespace of
2234 * the vfsmount must be passed through @mnt_userns. This function will then take
2235 * care to map the inode according to @mnt_userns before checking permissions
2236 * and initializing i_uid and i_gid. On non-idmapped mounts or if permission
2237 * checking is to be performed on the raw inode simply passs init_user_ns.
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002238 */
Christian Brauner21cb47b2021-01-21 14:19:25 +01002239void inode_init_owner(struct user_namespace *mnt_userns, struct inode *inode,
2240 const struct inode *dir, umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002241{
Christian Braunerdb998552021-03-20 13:26:24 +01002242 inode_fsuid_set(inode, mnt_userns);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002243 if (dir && dir->i_mode & S_ISGID) {
2244 inode->i_gid = dir->i_gid;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002245
2246 /* Directories are special, and always inherit S_ISGID */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002247 if (S_ISDIR(mode))
2248 mode |= S_ISGID;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002249 else if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP) &&
Christian Brauner21cb47b2021-01-21 14:19:25 +01002250 !in_group_p(i_gid_into_mnt(mnt_userns, dir)) &&
2251 !capable_wrt_inode_uidgid(mnt_userns, dir, CAP_FSETID))
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002252 mode &= ~S_ISGID;
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002253 } else
Christian Braunerdb998552021-03-20 13:26:24 +01002254 inode_fsgid_set(inode, mnt_userns);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002255 inode->i_mode = mode;
2256}
2257EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07002258
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002259/**
2260 * inode_owner_or_capable - check current task permissions to inode
Christian Brauner21cb47b2021-01-21 14:19:25 +01002261 * @mnt_userns: user namespace of the mount the inode was found from
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002262 * @inode: inode being checked
2263 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002264 * Return true if current either has CAP_FOWNER in a namespace with the
2265 * inode owner uid mapped, or owns the file.
Christian Brauner21cb47b2021-01-21 14:19:25 +01002266 *
2267 * If the inode has been found through an idmapped mount the user namespace of
2268 * the vfsmount must be passed through @mnt_userns. This function will then take
2269 * care to map the inode according to @mnt_userns before checking permissions.
2270 * On non-idmapped mounts or if permission checking is to be performed on the
2271 * raw inode simply passs init_user_ns.
Serge E. Hallyne795b712011-03-23 16:43:25 -07002272 */
Christian Brauner21cb47b2021-01-21 14:19:25 +01002273bool inode_owner_or_capable(struct user_namespace *mnt_userns,
2274 const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07002275{
Christian Brauner21cb47b2021-01-21 14:19:25 +01002276 kuid_t i_uid;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002277 struct user_namespace *ns;
2278
Christian Brauner21cb47b2021-01-21 14:19:25 +01002279 i_uid = i_uid_into_mnt(mnt_userns, inode);
2280 if (uid_eq(current_fsuid(), i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002281 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002282
2283 ns = current_user_ns();
Christian Brauner21cb47b2021-01-21 14:19:25 +01002284 if (kuid_has_mapping(ns, i_uid) && ns_capable(ns, CAP_FOWNER))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002285 return true;
2286 return false;
2287}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002288EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002289
2290/*
2291 * Direct i/o helper functions
2292 */
2293static void __inode_dio_wait(struct inode *inode)
2294{
2295 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2296 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2297
2298 do {
Ingo Molnar21417132017-03-05 11:25:39 +01002299 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002300 if (atomic_read(&inode->i_dio_count))
2301 schedule();
2302 } while (atomic_read(&inode->i_dio_count));
Ingo Molnar21417132017-03-05 11:25:39 +01002303 finish_wait(wq, &q.wq_entry);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002304}
2305
2306/**
2307 * inode_dio_wait - wait for outstanding DIO requests to finish
2308 * @inode: inode to wait for
2309 *
2310 * Waits for all pending direct I/O requests to finish so that we can
2311 * proceed with a truncate or equivalent operation.
2312 *
2313 * Must be called under a lock that serializes taking new references
2314 * to i_dio_count, usually by inode->i_mutex.
2315 */
2316void inode_dio_wait(struct inode *inode)
2317{
2318 if (atomic_read(&inode->i_dio_count))
2319 __inode_dio_wait(inode);
2320}
2321EXPORT_SYMBOL(inode_dio_wait);
2322
2323/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002324 * inode_set_flags - atomically set some inode flags
2325 *
2326 * Note: the caller should be holding i_mutex, or else be sure that
2327 * they have exclusive access to the inode structure (i.e., while the
2328 * inode is being instantiated). The reason for the cmpxchg() loop
2329 * --- which wouldn't be necessary if all code paths which modify
2330 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002331 * code path which doesn't today so we use cmpxchg() out of an abundance
2332 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002333 *
2334 * In the long run, i_mutex is overkill, and we should probably look
2335 * at using the i_lock spinlock to protect i_flags, and then make sure
2336 * it is so documented in include/linux/fs.h and that all code follows
2337 * the locking convention!!
2338 */
2339void inode_set_flags(struct inode *inode, unsigned int flags,
2340 unsigned int mask)
2341{
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002342 WARN_ON_ONCE(flags & ~mask);
Vineet Guptaa9057372019-03-05 15:41:52 -08002343 set_mask_bits(&inode->i_flags, mask, flags);
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002344}
2345EXPORT_SYMBOL(inode_set_flags);
Al Viro21fc61c2015-11-17 01:07:57 -05002346
2347void inode_nohighmem(struct inode *inode)
2348{
2349 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2350}
2351EXPORT_SYMBOL(inode_nohighmem);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002352
2353/**
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002354 * timestamp_truncate - Truncate timespec to a granularity
2355 * @t: Timespec
2356 * @inode: inode being updated
2357 *
2358 * Truncate a timespec to the granularity supported by the fs
2359 * containing the inode. Always rounds down. gran must
2360 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2361 */
2362struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode)
2363{
2364 struct super_block *sb = inode->i_sb;
2365 unsigned int gran = sb->s_time_gran;
2366
2367 t.tv_sec = clamp(t.tv_sec, sb->s_time_min, sb->s_time_max);
2368 if (unlikely(t.tv_sec == sb->s_time_max || t.tv_sec == sb->s_time_min))
2369 t.tv_nsec = 0;
2370
2371 /* Avoid division in the common cases 1 ns and 1 s. */
2372 if (gran == 1)
2373 ; /* nothing */
2374 else if (gran == NSEC_PER_SEC)
2375 t.tv_nsec = 0;
2376 else if (gran > 1 && gran < NSEC_PER_SEC)
2377 t.tv_nsec -= t.tv_nsec % gran;
2378 else
2379 WARN(1, "invalid file time granularity: %u", gran);
2380 return t;
2381}
2382EXPORT_SYMBOL(timestamp_truncate);
2383
2384/**
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002385 * current_time - Return FS time
2386 * @inode: inode.
2387 *
2388 * Return the current time truncated to the time granularity supported by
2389 * the fs.
2390 *
2391 * Note that inode and inode->sb cannot be NULL.
2392 * Otherwise, the function warns and returns time without truncation.
2393 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07002394struct timespec64 current_time(struct inode *inode)
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002395{
Arnd Bergmannd651d162018-12-05 11:14:27 +11002396 struct timespec64 now;
2397
2398 ktime_get_coarse_real_ts64(&now);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002399
2400 if (unlikely(!inode->i_sb)) {
2401 WARN(1, "current_time() called with uninitialized super_block in the inode");
2402 return now;
2403 }
2404
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002405 return timestamp_truncate(now, inode);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002406}
2407EXPORT_SYMBOL(current_time);