blob: a047ab306f9a86aa60b28fed5bd786839f888236 [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>
Daniel Rosenberg6e1918c2020-01-20 14:31:56 -080015#include <linux/fscrypt.h>
Eric Paris3be25f42009-05-21 17:01:26 -040016#include <linux/fsnotify.h>
Christoph Hellwigfc33a7b2006-01-09 20:52:17 -080017#include <linux/mount.h>
Al Virof19d4a82009-06-08 19:50:45 -040018#include <linux/posix_acl.h>
Heiko Carstens9ce6e0b2011-05-22 18:54:21 +020019#include <linux/prefetch.h>
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040020#include <linux/buffer_head.h> /* for inode_has_buffers */
Miklos Szeredi7ada4db2011-11-21 12:11:32 +010021#include <linux/ratelimit.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100022#include <linux/list_lru.h>
Jeff Laytonae5e1652018-01-29 06:41:30 -050023#include <linux/iversion.h>
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050024#include <trace/events/writeback.h>
Dave Chinnera66979a2011-03-22 22:23:41 +110025#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27/*
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040028 * Inode locking rules:
Dave Chinner250df6e2011-03-22 22:23:36 +110029 *
30 * inode->i_lock protects:
31 * inode->i_state, inode->i_hash, __iget()
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100032 * Inode LRU list locks protect:
Dave Chinner98b745c2011-07-08 14:14:39 +100033 * inode->i_sb->s_inode_lru, inode->i_lru
Dave Chinner74278da2015-03-04 12:37:22 -050034 * inode->i_sb->s_inode_list_lock protects:
35 * inode->i_sb->s_inodes, inode->i_sb_list
Christoph Hellwigf758eea2011-04-21 18:19:44 -060036 * bdi->wb.list_lock protects:
Dave Chinnerc7f54082015-03-04 14:07:22 -050037 * bdi->wb.b_{dirty,io,more_io,dirty_time}, inode->i_io_list
Dave Chinner67a23c42011-03-22 22:23:42 +110038 * inode_hash_lock protects:
39 * inode_hashtable, inode->i_hash
Dave Chinner250df6e2011-03-22 22:23:36 +110040 *
41 * Lock ordering:
Dave Chinner55fa6092011-03-22 22:23:40 +110042 *
Dave Chinner74278da2015-03-04 12:37:22 -050043 * inode->i_sb->s_inode_list_lock
Dave Chinner55fa6092011-03-22 22:23:40 +110044 * inode->i_lock
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100045 * Inode LRU list locks
Dave Chinnera66979a2011-03-22 22:23:41 +110046 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060047 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110048 * inode->i_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110049 *
50 * inode_hash_lock
Dave Chinner74278da2015-03-04 12:37:22 -050051 * inode->i_sb->s_inode_list_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110052 * inode->i_lock
53 *
54 * iunique_lock
55 * inode_hash_lock
Dave Chinner250df6e2011-03-22 22:23:36 +110056 */
57
Eric Dumazetfa3536c2006-03-26 01:37:24 -080058static unsigned int i_hash_mask __read_mostly;
59static unsigned int i_hash_shift __read_mostly;
Dave Chinner67a23c42011-03-22 22:23:42 +110060static struct hlist_head *inode_hashtable __read_mostly;
61static __cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Linus Torvalds1da177e2005-04-16 15:20:36 -070063/*
Jens Axboe7dcda1c2011-04-05 23:51:48 +020064 * Empty aops. Can be used for the cases where the user does not
65 * define any of the address_space operations.
66 */
67const struct address_space_operations empty_aops = {
68};
69EXPORT_SYMBOL(empty_aops);
70
71/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * Statistics gathering..
73 */
74struct inodes_stat_t inodes_stat;
75
Glauber Costa3942c072013-08-28 10:17:53 +100076static DEFINE_PER_CPU(unsigned long, nr_inodes);
77static DEFINE_PER_CPU(unsigned long, nr_unused);
Dave Chinnercffbc8a2010-10-23 05:03:02 -040078
Manish Katiyar6b3304b2009-03-31 19:35:54 +053079static struct kmem_cache *inode_cachep __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Glauber Costa3942c072013-08-28 10:17:53 +100081static long get_nr_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040082{
Nick Piggin3e880fb2011-01-07 17:49:19 +110083 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100084 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +110085 for_each_possible_cpu(i)
86 sum += per_cpu(nr_inodes, i);
87 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040088}
89
Glauber Costa3942c072013-08-28 10:17:53 +100090static inline long get_nr_inodes_unused(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040091{
Dave Chinnerfcb94f72011-07-08 14:14:38 +100092 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100093 long sum = 0;
Dave Chinnerfcb94f72011-07-08 14:14:38 +100094 for_each_possible_cpu(i)
95 sum += per_cpu(nr_unused, i);
96 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040097}
98
Glauber Costa3942c072013-08-28 10:17:53 +100099long get_nr_dirty_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400100{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100101 /* not actually dirty inodes, but a wild approximation */
Glauber Costa3942c072013-08-28 10:17:53 +1000102 long nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400103 return nr_dirty > 0 ? nr_dirty : 0;
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400104}
105
106/*
107 * Handle nr_inode sysctl
108 */
109#ifdef CONFIG_SYSCTL
Joe Perches1f7e0612014-06-06 14:38:05 -0700110int proc_nr_inodes(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +0200111 void *buffer, size_t *lenp, loff_t *ppos)
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400112{
113 inodes_stat.nr_inodes = get_nr_inodes();
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000114 inodes_stat.nr_unused = get_nr_inodes_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000115 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400116}
117#endif
118
Al Virobd9b51e2014-11-18 23:38:21 -0500119static int no_open(struct inode *inode, struct file *file)
120{
121 return -ENXIO;
122}
123
David Chinner2cb15992008-10-30 17:32:23 +1100124/**
Masahiro Yamada6e7c2b42017-05-08 15:57:53 -0700125 * inode_init_always - perform inode structure initialisation
Randy Dunlap0bc02f32009-01-06 14:41:13 -0800126 * @sb: superblock inode belongs to
127 * @inode: inode to initialise
David Chinner2cb15992008-10-30 17:32:23 +1100128 *
129 * These are initializations that need to be done on every inode
130 * allocation as the fields are not initialised by slab allocation.
131 */
Christoph Hellwig54e34622009-08-07 14:38:25 -0300132int inode_init_always(struct super_block *sb, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
Alexey Dobriyan6e1d5dc2009-09-21 17:01:11 -0700134 static const struct inode_operations empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500135 static const struct file_operations no_open_fops = {.open = no_open};
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530136 struct address_space *const mapping = &inode->i_data;
David Chinner2cb15992008-10-30 17:32:23 +1100137
138 inode->i_sb = sb;
139 inode->i_blkbits = sb->s_blocksize_bits;
140 inode->i_flags = 0;
Peter Zijlstra8019ad12020-03-04 11:28:31 +0100141 atomic64_set(&inode->i_sequence, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100142 atomic_set(&inode->i_count, 1);
143 inode->i_op = &empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500144 inode->i_fop = &no_open_fops;
Eric Biggersedbb35c2020-10-30 17:44:20 -0700145 inode->i_ino = 0;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200146 inode->__i_nlink = 1;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700147 inode->i_opflags = 0;
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200148 if (sb->s_xattr)
149 inode->i_opflags |= IOP_XATTR;
Eric W. Biederman92361632012-02-08 07:07:50 -0800150 i_uid_write(inode, 0);
151 i_gid_write(inode, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100152 atomic_set(&inode->i_writecount, 0);
153 inode->i_size = 0;
Jens Axboec75b1d92017-06-27 11:47:04 -0600154 inode->i_write_hint = WRITE_LIFE_NOT_SET;
David Chinner2cb15992008-10-30 17:32:23 +1100155 inode->i_blocks = 0;
156 inode->i_bytes = 0;
157 inode->i_generation = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100158 inode->i_pipe = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100159 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400160 inode->i_link = NULL;
Al Viro84e710d2016-04-15 00:58:55 -0400161 inode->i_dir_seq = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100162 inode->i_rdev = 0;
163 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500164
Tahsin Erdogan3d65ae42016-02-16 13:34:39 -0800165#ifdef CONFIG_CGROUP_WRITEBACK
166 inode->i_wb_frn_winner = 0;
167 inode->i_wb_frn_avg_time = 0;
168 inode->i_wb_frn_history = 0;
169#endif
170
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500171 if (security_inode_alloc(inode))
Christoph Hellwig54e34622009-08-07 14:38:25 -0300172 goto out;
David Chinner2cb15992008-10-30 17:32:23 +1100173 spin_lock_init(&inode->i_lock);
174 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
175
Al Viro9902af72016-04-15 15:08:36 -0400176 init_rwsem(&inode->i_rwsem);
177 lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
David Chinner2cb15992008-10-30 17:32:23 +1100178
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400179 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100180
181 mapping->a_ops = &empty_aops;
182 mapping->host = inode;
183 mapping->flags = 0;
Matthew Wilcox (Oracle)01c70262020-10-15 20:06:00 -0700184 if (sb->s_type->fs_flags & FS_THP_SUPPORT)
185 __set_bit(AS_THP_SUPPORT, &mapping->flags);
Darrick J. Wong829bc7872018-05-30 19:43:53 -0700186 mapping->wb_err = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700187 atomic_set(&mapping->i_mmap_writable, 0);
Song Liu09d91cd2019-09-23 15:38:03 -0700188#ifdef CONFIG_READ_ONLY_THP_FOR_FS
189 atomic_set(&mapping->nr_thps, 0);
190#endif
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800191 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800192 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100193 mapping->writeback_index = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100194 inode->i_private = NULL;
195 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400196 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400197#ifdef CONFIG_FS_POSIX_ACL
198 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
199#endif
David Chinner2cb15992008-10-30 17:32:23 +1100200
Eric Paris3be25f42009-05-21 17:01:26 -0400201#ifdef CONFIG_FSNOTIFY
202 inode->i_fsnotify_mask = 0;
203#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500204 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100205 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400206
Christoph Hellwig54e34622009-08-07 14:38:25 -0300207 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300208out:
209 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100210}
211EXPORT_SYMBOL(inode_init_always);
212
Al Virofdb0da82019-04-10 14:43:44 -0400213void free_inode_nonrcu(struct inode *inode)
214{
215 kmem_cache_free(inode_cachep, inode);
216}
217EXPORT_SYMBOL(free_inode_nonrcu);
218
219static void i_callback(struct rcu_head *head)
220{
221 struct inode *inode = container_of(head, struct inode, i_rcu);
222 if (inode->free_inode)
223 inode->free_inode(inode);
224 else
225 free_inode_nonrcu(inode);
226}
227
David Chinner2cb15992008-10-30 17:32:23 +1100228static struct inode *alloc_inode(struct super_block *sb)
229{
Al Virofdb0da82019-04-10 14:43:44 -0400230 const struct super_operations *ops = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 struct inode *inode;
232
Al Virofdb0da82019-04-10 14:43:44 -0400233 if (ops->alloc_inode)
234 inode = ops->alloc_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 else
David Chinner2cb15992008-10-30 17:32:23 +1100236 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Christoph Hellwig54e34622009-08-07 14:38:25 -0300238 if (!inode)
239 return NULL;
240
241 if (unlikely(inode_init_always(sb, inode))) {
Al Virofdb0da82019-04-10 14:43:44 -0400242 if (ops->destroy_inode) {
243 ops->destroy_inode(inode);
244 if (!ops->free_inode)
245 return NULL;
246 }
247 inode->free_inode = ops->free_inode;
248 i_callback(&inode->i_rcu);
Christoph Hellwig54e34622009-08-07 14:38:25 -0300249 return NULL;
250 }
251
252 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253}
254
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300255void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200257 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400258 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400260 fsnotify_inode_delete(inode);
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500261 locks_free_lock_context(inode);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100262 if (!inode->i_nlink) {
263 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
264 atomic_long_dec(&inode->i_sb->s_remove_count);
265 }
266
Al Virof19d4a82009-06-08 19:50:45 -0400267#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100268 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400269 posix_acl_release(inode->i_acl);
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100270 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400271 posix_acl_release(inode->i_default_acl);
272#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100273 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300274}
275EXPORT_SYMBOL(__destroy_inode);
276
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200277static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300278{
Al Virofdb0da82019-04-10 14:43:44 -0400279 const struct super_operations *ops = inode->i_sb->s_op;
280
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100281 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300282 __destroy_inode(inode);
Al Virofdb0da82019-04-10 14:43:44 -0400283 if (ops->destroy_inode) {
284 ops->destroy_inode(inode);
285 if (!ops->free_inode)
286 return;
287 }
288 inode->free_inode = ops->free_inode;
289 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100292/**
293 * drop_nlink - directly drop an inode's link count
294 * @inode: inode
295 *
296 * This is a low-level filesystem helper to replace any
297 * direct filesystem manipulation of i_nlink. In cases
298 * where we are attempting to track writes to the
299 * filesystem, a decrement to zero means an imminent
300 * write when the file is truncated and actually unlinked
301 * on the filesystem.
302 */
303void drop_nlink(struct inode *inode)
304{
305 WARN_ON(inode->i_nlink == 0);
306 inode->__i_nlink--;
307 if (!inode->i_nlink)
308 atomic_long_inc(&inode->i_sb->s_remove_count);
309}
310EXPORT_SYMBOL(drop_nlink);
311
312/**
313 * clear_nlink - directly zero an inode's link count
314 * @inode: inode
315 *
316 * This is a low-level filesystem helper to replace any
317 * direct filesystem manipulation of i_nlink. See
318 * drop_nlink() for why we care about i_nlink hitting zero.
319 */
320void clear_nlink(struct inode *inode)
321{
322 if (inode->i_nlink) {
323 inode->__i_nlink = 0;
324 atomic_long_inc(&inode->i_sb->s_remove_count);
325 }
326}
327EXPORT_SYMBOL(clear_nlink);
328
329/**
330 * set_nlink - directly set an inode's link count
331 * @inode: inode
332 * @nlink: new nlink (should be non-zero)
333 *
334 * This is a low-level filesystem helper to replace any
335 * direct filesystem manipulation of i_nlink.
336 */
337void set_nlink(struct inode *inode, unsigned int nlink)
338{
339 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100340 clear_nlink(inode);
341 } else {
342 /* Yes, some filesystems do change nlink from zero to one */
343 if (inode->i_nlink == 0)
344 atomic_long_dec(&inode->i_sb->s_remove_count);
345
346 inode->__i_nlink = nlink;
347 }
348}
349EXPORT_SYMBOL(set_nlink);
350
351/**
352 * inc_nlink - directly increment an inode's link count
353 * @inode: inode
354 *
355 * This is a low-level filesystem helper to replace any
356 * direct filesystem manipulation of i_nlink. Currently,
357 * it is only here for parity with dec_nlink().
358 */
359void inc_nlink(struct inode *inode)
360{
Al Virof4e0c302013-06-11 08:34:36 +0400361 if (unlikely(inode->i_nlink == 0)) {
362 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100363 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400364 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100365
366 inode->__i_nlink++;
367}
368EXPORT_SYMBOL(inc_nlink);
369
Dave Chinnerae233952018-03-06 17:30:34 -0800370static void __address_space_init_once(struct address_space *mapping)
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100371{
Johannes Weiner7b785642019-05-24 10:12:46 -0400372 xa_init_flags(&mapping->i_pages, XA_FLAGS_LOCK_IRQ | XA_FLAGS_ACCOUNT);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800373 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100374 INIT_LIST_HEAD(&mapping->private_list);
375 spin_lock_init(&mapping->private_lock);
Davidlohr Buesof808c132017-09-08 16:15:08 -0700376 mapping->i_mmap = RB_ROOT_CACHED;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100377}
Dave Chinnerae233952018-03-06 17:30:34 -0800378
379void address_space_init_once(struct address_space *mapping)
380{
381 memset(mapping, 0, sizeof(*mapping));
382 __address_space_init_once(mapping);
383}
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100384EXPORT_SYMBOL(address_space_init_once);
385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386/*
387 * These are initializations that only need to be done
388 * once, because the fields are idempotent across use
389 * of the inode, so let the slab aware of that.
390 */
391void inode_init_once(struct inode *inode)
392{
393 memset(inode, 0, sizeof(*inode));
394 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500396 INIT_LIST_HEAD(&inode->i_io_list);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700397 INIT_LIST_HEAD(&inode->i_wb_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100398 INIT_LIST_HEAD(&inode->i_lru);
Dave Chinnerae233952018-03-06 17:30:34 -0800399 __address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 i_size_ordered_init(inode);
401}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402EXPORT_SYMBOL(inode_init_once);
403
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700404static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530406 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
Christoph Lametera35afb82007-05-16 22:10:57 -0700408 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409}
410
411/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100412 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530414void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415{
Nick Piggin9e38d862010-10-23 06:55:17 -0400416 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417}
418
Al Viro7de9c6ee2010-10-23 11:11:40 -0400419/*
420 * get additional reference to inode; caller must already hold one.
421 */
422void ihold(struct inode *inode)
423{
424 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
425}
426EXPORT_SYMBOL(ihold);
427
Nick Piggin9e38d862010-10-23 06:55:17 -0400428static void inode_lru_list_add(struct inode *inode)
429{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000430 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000431 this_cpu_inc(nr_unused);
Josef Bacik563f4002017-04-18 16:04:17 -0400432 else
433 inode->i_state |= I_REFERENCED;
Nick Piggin9e38d862010-10-23 06:55:17 -0400434}
435
Jan Kara4eff96d2012-11-26 16:29:51 -0800436/*
437 * Add inode to LRU if needed (inode is unused and clean).
438 *
439 * Needs inode->i_lock held.
440 */
441void inode_add_lru(struct inode *inode)
442{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500443 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
444 I_FREEING | I_WILL_FREE)) &&
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800445 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & SB_ACTIVE)
Jan Kara4eff96d2012-11-26 16:29:51 -0800446 inode_lru_list_add(inode);
447}
448
449
Nick Piggin9e38d862010-10-23 06:55:17 -0400450static void inode_lru_list_del(struct inode *inode)
451{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000452
453 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000454 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455}
456
Christoph Hellwig646ec462010-10-23 07:15:32 -0400457/**
458 * inode_sb_list_add - add inode to the superblock list of inodes
459 * @inode: inode to add
460 */
461void inode_sb_list_add(struct inode *inode)
462{
Dave Chinner74278da2015-03-04 12:37:22 -0500463 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100464 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500465 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400466}
467EXPORT_SYMBOL_GPL(inode_sb_list_add);
468
Dave Chinner55fa6092011-03-22 22:23:40 +1100469static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400470{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200471 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500472 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200473 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500474 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200475 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400476}
477
Dave Chinner4c51acb2010-10-23 06:58:09 -0400478static unsigned long hash(struct super_block *sb, unsigned long hashval)
479{
480 unsigned long tmp;
481
482 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
483 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400484 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
485 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400486}
487
488/**
489 * __insert_inode_hash - hash an inode
490 * @inode: unhashed inode
491 * @hashval: unsigned long value used to locate this object in the
492 * inode_hashtable.
493 *
494 * Add an inode to the inode hash for this superblock.
495 */
496void __insert_inode_hash(struct inode *inode, unsigned long hashval)
497{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400498 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
499
Dave Chinner67a23c42011-03-22 22:23:42 +1100500 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100501 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000502 hlist_add_head_rcu(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100503 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100504 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400505}
506EXPORT_SYMBOL(__insert_inode_hash);
507
508/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200509 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400510 * @inode: inode to unhash
511 *
512 * Remove an inode from the superblock.
513 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200514void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400515{
Dave Chinner67a23c42011-03-22 22:23:42 +1100516 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100517 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000518 hlist_del_init_rcu(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100519 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100520 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400521}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200522EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400523
Jan Karadbd57682012-05-03 14:48:02 +0200524void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400525{
Jan Kara08142572011-06-27 16:18:10 -0700526 /*
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700527 * We have to cycle the i_pages lock here because reclaim can be in the
Jan Kara08142572011-06-27 16:18:10 -0700528 * process of removing the last page (in __delete_from_page_cache())
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700529 * and we must not free the mapping under it.
Jan Kara08142572011-06-27 16:18:10 -0700530 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700531 xa_lock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400532 BUG_ON(inode->i_data.nrpages);
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800533 BUG_ON(inode->i_data.nrexceptional);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700534 xa_unlock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400535 BUG_ON(!list_empty(&inode->i_data.private_list));
536 BUG_ON(!(inode->i_state & I_FREEING));
537 BUG_ON(inode->i_state & I_CLEAR);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700538 BUG_ON(!list_empty(&inode->i_wb_list));
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100539 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400540 inode->i_state = I_FREEING | I_CLEAR;
541}
Jan Karadbd57682012-05-03 14:48:02 +0200542EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400543
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100544/*
545 * Free the inode passed in, removing it from the lists it is still connected
546 * to. We remove any pages still attached to the inode and wait for any IO that
547 * is still in progress before finally destroying the inode.
548 *
549 * An inode must already be marked I_FREEING so that we avoid the inode being
550 * moved back onto lists if we race with other code that manipulates the lists
551 * (e.g. writeback_single_inode). The caller is responsible for setting this.
552 *
553 * An inode must already be removed from the LRU list before being evicted from
554 * the cache. This should occur atomically with setting the I_FREEING state
555 * flag, so no inodes here should ever be on the LRU when being evicted.
556 */
Al Viro644da592010-06-07 13:21:05 -0400557static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400558{
559 const struct super_operations *op = inode->i_sb->s_op;
560
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100561 BUG_ON(!(inode->i_state & I_FREEING));
562 BUG_ON(!list_empty(&inode->i_lru));
563
Dave Chinnerc7f54082015-03-04 14:07:22 -0500564 if (!list_empty(&inode->i_io_list))
565 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200566
Dave Chinner55fa6092011-03-22 22:23:40 +1100567 inode_sb_list_del(inode);
568
Jan Kara169ebd92012-05-03 14:48:03 +0200569 /*
570 * Wait for flusher thread to be done with the inode so that filesystem
571 * does not start destroying it while writeback is still running. Since
572 * the inode has I_FREEING set, flusher thread won't start new work on
573 * the inode. We just have to wait for running writeback to finish.
574 */
575 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200576
Al Virobe7ce412010-06-04 19:40:39 -0400577 if (op->evict_inode) {
578 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400579 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700580 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200581 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400582 }
Al Viro661074e2010-06-04 20:19:55 -0400583 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
584 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100585
586 remove_inode_hash(inode);
587
588 spin_lock(&inode->i_lock);
589 wake_up_bit(&inode->i_state, __I_NEW);
590 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
591 spin_unlock(&inode->i_lock);
592
593 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400594}
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596/*
597 * dispose_list - dispose of the contents of a local list
598 * @head: the head of the list to free
599 *
600 * Dispose-list gets a local list with local inodes in it, so it doesn't
601 * need to worry about list corruption and SMP locks.
602 */
603static void dispose_list(struct list_head *head)
604{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 while (!list_empty(head)) {
606 struct inode *inode;
607
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100608 inode = list_first_entry(head, struct inode, i_lru);
609 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Al Viro644da592010-06-07 13:21:05 -0400611 evict(inode);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500612 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614}
615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616/**
Al Viro63997e92010-10-25 20:49:35 -0400617 * evict_inodes - evict all evictable inodes for a superblock
618 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 *
Al Viro63997e92010-10-25 20:49:35 -0400620 * Make sure that no inodes with zero refcount are retained. This is
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800621 * called by superblock shutdown after having SB_ACTIVE flag removed,
Al Viro63997e92010-10-25 20:49:35 -0400622 * so any inode reaching zero refcount during or after that call will
623 * be immediately evicted.
624 */
625void evict_inodes(struct super_block *sb)
626{
627 struct inode *inode, *next;
628 LIST_HEAD(dispose);
629
Josef Bacikac05fbb2015-03-04 16:52:52 -0500630again:
Dave Chinner74278da2015-03-04 12:37:22 -0500631 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400632 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
633 if (atomic_read(&inode->i_count))
634 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100635
636 spin_lock(&inode->i_lock);
637 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
638 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400639 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100640 }
Al Viro63997e92010-10-25 20:49:35 -0400641
642 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100643 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100644 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100645 list_add(&inode->i_lru, &dispose);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500646
647 /*
648 * We can have a ton of inodes to evict at unmount time given
649 * enough memory, check to see if we need to go to sleep for a
650 * bit so we don't livelock.
651 */
652 if (need_resched()) {
653 spin_unlock(&sb->s_inode_list_lock);
654 cond_resched();
655 dispose_list(&dispose);
656 goto again;
657 }
Al Viro63997e92010-10-25 20:49:35 -0400658 }
Dave Chinner74278da2015-03-04 12:37:22 -0500659 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400660
661 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400662}
Darrick J. Wong799ea9e2017-08-18 18:08:25 -0700663EXPORT_SYMBOL_GPL(evict_inodes);
Al Viro63997e92010-10-25 20:49:35 -0400664
665/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200666 * invalidate_inodes - attempt to free all inodes on a superblock
667 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100668 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200669 *
670 * Attempts to free all inodes for a given superblock. If there were any
671 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100672 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
673 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 */
NeilBrown93b270f2011-02-24 17:25:47 +1100675int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400677 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200678 struct inode *inode, *next;
679 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Eric Sandeen04646ae2019-12-06 10:54:23 -0600681again:
Dave Chinner74278da2015-03-04 12:37:22 -0500682 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200683 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100684 spin_lock(&inode->i_lock);
685 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
686 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100688 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500689 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100690 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100691 busy = 1;
692 continue;
693 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200694 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100695 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200696 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 continue;
698 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200699
Christoph Hellwig99a38912010-10-23 19:07:20 +0200700 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100701 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100702 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100703 list_add(&inode->i_lru, &dispose);
Eric Sandeen04646ae2019-12-06 10:54:23 -0600704 if (need_resched()) {
705 spin_unlock(&sb->s_inode_list_lock);
706 cond_resched();
707 dispose_list(&dispose);
708 goto again;
709 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 }
Dave Chinner74278da2015-03-04 12:37:22 -0500711 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
Christoph Hellwiga0318782010-10-24 19:40:33 +0200713 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 return busy;
716}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000719 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 *
721 * Any inodes which are pinned purely because of attached pagecache have their
Nick Piggin9e38d862010-10-23 06:55:17 -0400722 * pagecache removed. If the inode has metadata buffers attached to
723 * mapping->private_list then try to remove them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400725 * If the inode has the I_REFERENCED flag set, then it means that it has been
726 * used recently - the flag is set in iput_final(). When we encounter such an
727 * inode, clear the flag and move it to the back of the LRU so it gets another
728 * pass through the LRU before it gets reclaimed. This is necessary because of
729 * the fact we are doing lazy LRU updates to minimise lock contention so the
730 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
731 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800733static enum lru_status inode_lru_isolate(struct list_head *item,
734 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000735{
736 struct list_head *freeable = arg;
737 struct inode *inode = container_of(item, struct inode, i_lru);
738
739 /*
740 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
741 * If we fail to get the lock, just skip it.
742 */
743 if (!spin_trylock(&inode->i_lock))
744 return LRU_SKIP;
745
746 /*
747 * Referenced or dirty inodes are still in use. Give them another pass
748 * through the LRU as we canot reclaim them now.
749 */
750 if (atomic_read(&inode->i_count) ||
751 (inode->i_state & ~I_REFERENCED)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800752 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000753 spin_unlock(&inode->i_lock);
754 this_cpu_dec(nr_unused);
755 return LRU_REMOVED;
756 }
757
Dave Chinner69056ee2019-02-12 15:35:51 -0800758 /* recently referenced inodes get one more pass */
759 if (inode->i_state & I_REFERENCED) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000760 inode->i_state &= ~I_REFERENCED;
761 spin_unlock(&inode->i_lock);
762 return LRU_ROTATE;
763 }
764
765 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
766 __iget(inode);
767 spin_unlock(&inode->i_lock);
768 spin_unlock(lru_lock);
769 if (remove_inode_buffers(inode)) {
770 unsigned long reap;
771 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
772 if (current_is_kswapd())
773 __count_vm_events(KSWAPD_INODESTEAL, reap);
774 else
775 __count_vm_events(PGINODESTEAL, reap);
776 if (current->reclaim_state)
777 current->reclaim_state->reclaimed_slab += reap;
778 }
779 iput(inode);
780 spin_lock(lru_lock);
781 return LRU_RETRY;
782 }
783
784 WARN_ON(inode->i_state & I_NEW);
785 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800786 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000787 spin_unlock(&inode->i_lock);
788
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000789 this_cpu_dec(nr_unused);
790 return LRU_REMOVED;
791}
792
793/*
794 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
795 * This is called from the superblock shrinker function with a number of inodes
796 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
797 * then are freed outside inode_lock by dispose_list().
798 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800799long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800{
801 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000802 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Vladimir Davydov503c3582015-02-12 14:58:47 -0800804 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
805 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000807 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808}
809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810static void __wait_on_freeing_inode(struct inode *inode);
811/*
812 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530814static struct inode *find_inode(struct super_block *sb,
815 struct hlist_head *head,
816 int (*test)(struct inode *, void *),
817 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530819 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800822 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500823 if (inode->i_sb != sb)
824 continue;
825 if (!test(inode, data))
826 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100827 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400828 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 __wait_on_freeing_inode(inode);
830 goto repeat;
831 }
Al Viroc2b6d622018-06-28 15:53:17 -0400832 if (unlikely(inode->i_state & I_CREATING)) {
833 spin_unlock(&inode->i_lock);
834 return ERR_PTR(-ESTALE);
835 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400836 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100837 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400838 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400840 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841}
842
843/*
844 * find_inode_fast is the fast path version of find_inode, see the comment at
845 * iget_locked for details.
846 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530847static struct inode *find_inode_fast(struct super_block *sb,
848 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530850 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
852repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800853 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500854 if (inode->i_ino != ino)
855 continue;
856 if (inode->i_sb != sb)
857 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100858 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400859 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 __wait_on_freeing_inode(inode);
861 goto repeat;
862 }
Al Viroc2b6d622018-06-28 15:53:17 -0400863 if (unlikely(inode->i_state & I_CREATING)) {
864 spin_unlock(&inode->i_lock);
865 return ERR_PTR(-ESTALE);
866 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400867 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100868 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400869 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400871 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872}
873
Eric Dumazetf991bd22010-10-23 11:18:01 -0400874/*
875 * Each cpu owns a range of LAST_INO_BATCH numbers.
876 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
877 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100878 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400879 * This does not significantly increase overflow rate because every CPU can
880 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
881 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
882 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
883 * overflow rate by 2x, which does not seem too significant.
884 *
885 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
886 * error if st_ino won't fit in target struct field. Use 32bit counter
887 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100888 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400889#define LAST_INO_BATCH 1024
890static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100891
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400892unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400893{
894 unsigned int *p = &get_cpu_var(last_ino);
895 unsigned int res = *p;
896
897#ifdef CONFIG_SMP
898 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
899 static atomic_t shared_last_ino;
900 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
901
902 res = next - LAST_INO_BATCH;
903 }
904#endif
905
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300906 res++;
907 /* get_next_ino should not provide a 0 inode number */
908 if (unlikely(!res))
909 res++;
910 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400911 put_cpu_var(last_ino);
912 return res;
David Chinner8290c352008-10-30 17:35:24 +1100913}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400914EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100915
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200917 * new_inode_pseudo - obtain an inode
918 * @sb: superblock
919 *
920 * Allocates a new inode for given superblock.
921 * Inode wont be chained in superblock s_inodes list
922 * This means :
923 * - fs can't be unmount
924 * - quotas, fsnotify, writeback can't work
925 */
926struct inode *new_inode_pseudo(struct super_block *sb)
927{
928 struct inode *inode = alloc_inode(sb);
929
930 if (inode) {
931 spin_lock(&inode->i_lock);
932 inode->i_state = 0;
933 spin_unlock(&inode->i_lock);
934 INIT_LIST_HEAD(&inode->i_sb_list);
935 }
936 return inode;
937}
938
939/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 * new_inode - obtain an inode
941 * @sb: superblock
942 *
Mel Gorman769848c2007-07-17 04:03:05 -0700943 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800944 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700945 * If HIGHMEM pages are unsuitable or it is known that pages allocated
946 * for the page cache are not reclaimable or migratable,
947 * mapping_set_gfp_mask() must be called with suitable flags on the
948 * newly created inode's mapping
949 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 */
951struct inode *new_inode(struct super_block *sb)
952{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530953 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
Dave Chinner74278da2015-03-04 12:37:22 -0500955 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530956
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200957 inode = new_inode_pseudo(sb);
958 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100959 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 return inode;
961}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962EXPORT_SYMBOL(new_inode);
963
Peter Zijlstra14358e62007-10-14 01:38:33 +0200964#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400965void lockdep_annotate_inode_mutex_key(struct inode *inode)
966{
Namhyung Kima3314a02010-10-11 22:38:00 +0900967 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200968 struct file_system_type *type = inode->i_sb->s_type;
969
Jan Kara9a7aa122009-06-04 15:26:49 +0200970 /* Set new key only if filesystem hasn't already changed it */
Al Viro9902af72016-04-15 15:08:36 -0400971 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200972 /*
973 * ensure nobody is actually holding i_mutex
974 */
Al Viro9902af72016-04-15 15:08:36 -0400975 // mutex_destroy(&inode->i_mutex);
976 init_rwsem(&inode->i_rwsem);
977 lockdep_set_class(&inode->i_rwsem,
Jan Kara9a7aa122009-06-04 15:26:49 +0200978 &type->i_mutex_dir_key);
979 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200980 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400981}
982EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200983#endif
Josh Boyere096d0c2011-08-25 07:48:12 -0400984
985/**
986 * unlock_new_inode - clear the I_NEW state and wake up any waiters
987 * @inode: new inode to unlock
988 *
989 * Called when the inode is fully initialised to clear the new state of the
990 * inode and wake up anyone waiting for the inode to finish initialisation.
991 */
992void unlock_new_inode(struct inode *inode)
993{
994 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100995 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100996 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -0400997 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro310fa7a2012-03-10 17:07:28 -0500998 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +1100999 wake_up_bit(&inode->i_state, __I_NEW);
1000 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002EXPORT_SYMBOL(unlock_new_inode);
1003
Al Viroc2b6d622018-06-28 15:53:17 -04001004void discard_new_inode(struct inode *inode)
1005{
1006 lockdep_annotate_inode_mutex_key(inode);
1007 spin_lock(&inode->i_lock);
1008 WARN_ON(!(inode->i_state & I_NEW));
1009 inode->i_state &= ~I_NEW;
1010 smp_mb();
1011 wake_up_bit(&inode->i_state, __I_NEW);
1012 spin_unlock(&inode->i_lock);
1013 iput(inode);
1014}
1015EXPORT_SYMBOL(discard_new_inode);
1016
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001017/**
J. Bruce Fields375e2892012-04-18 15:16:33 -04001018 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001019 *
1020 * Lock any non-NULL argument that is not a directory.
1021 * Zero, one or two objects may be locked by this function.
1022 *
J. Bruce Fields375e2892012-04-18 15:16:33 -04001023 * @inode1: first inode to lock
1024 * @inode2: second inode to lock
1025 */
1026void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1027{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001028 if (inode1 > inode2)
1029 swap(inode1, inode2);
1030
1031 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001032 inode_lock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001033 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001034 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001035}
1036EXPORT_SYMBOL(lock_two_nondirectories);
1037
1038/**
1039 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
1040 * @inode1: first inode to unlock
1041 * @inode2: second inode to unlock
1042 */
1043void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1044{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001045 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001046 inode_unlock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001047 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001048 inode_unlock(inode2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001049}
1050EXPORT_SYMBOL(unlock_two_nondirectories);
1051
1052/**
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001053 * inode_insert5 - obtain an inode from a mounted file system
1054 * @inode: pre-allocated inode to use for insert to cache
1055 * @hashval: hash value (usually inode number) to get
1056 * @test: callback used for comparisons between inodes
1057 * @set: callback used to initialize a new struct inode
1058 * @data: opaque data pointer to pass to @test and @set
1059 *
1060 * Search for the inode specified by @hashval and @data in the inode cache,
1061 * and if present it is return it with an increased reference count. This is
1062 * a variant of iget5_locked() for callers that don't want to fail on memory
1063 * allocation of inode.
1064 *
1065 * If the inode is not in cache, insert the pre-allocated inode to cache and
1066 * return it locked, hashed, and with the I_NEW flag set. The file system gets
1067 * to fill it in before unlocking it via unlock_new_inode().
1068 *
1069 * Note both @test and @set are called with the inode_hash_lock held, so can't
1070 * sleep.
1071 */
1072struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
1073 int (*test)(struct inode *, void *),
1074 int (*set)(struct inode *, void *), void *data)
1075{
1076 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1077 struct inode *old;
Miklos Szeredie9505642018-07-24 15:01:55 +02001078 bool creating = inode->i_state & I_CREATING;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001079
1080again:
1081 spin_lock(&inode_hash_lock);
1082 old = find_inode(inode->i_sb, head, test, data);
1083 if (unlikely(old)) {
1084 /*
1085 * Uhhuh, somebody else created the same inode under us.
1086 * Use the old inode instead of the preallocated one.
1087 */
1088 spin_unlock(&inode_hash_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001089 if (IS_ERR(old))
1090 return NULL;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001091 wait_on_inode(old);
1092 if (unlikely(inode_unhashed(old))) {
1093 iput(old);
1094 goto again;
1095 }
1096 return old;
1097 }
1098
1099 if (set && unlikely(set(inode, data))) {
1100 inode = NULL;
1101 goto unlock;
1102 }
1103
1104 /*
1105 * Return the locked inode with I_NEW set, the
1106 * caller is responsible for filling in the contents
1107 */
1108 spin_lock(&inode->i_lock);
1109 inode->i_state |= I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001110 hlist_add_head_rcu(&inode->i_hash, head);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001111 spin_unlock(&inode->i_lock);
Miklos Szeredie9505642018-07-24 15:01:55 +02001112 if (!creating)
1113 inode_sb_list_add(inode);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001114unlock:
1115 spin_unlock(&inode_hash_lock);
1116
1117 return inode;
1118}
1119EXPORT_SYMBOL(inode_insert5);
1120
1121/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001122 * iget5_locked - obtain an inode from a mounted file system
1123 * @sb: super block of file system
1124 * @hashval: hash value (usually inode number) to get
1125 * @test: callback used for comparisons between inodes
1126 * @set: callback used to initialize a new struct inode
1127 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001129 * Search for the inode specified by @hashval and @data in the inode cache,
1130 * and if present it is return it with an increased reference count. This is
1131 * a generalized version of iget_locked() for file systems where the inode
1132 * number is not sufficient for unique identification of an inode.
1133 *
1134 * If the inode is not in cache, allocate a new inode and return it locked,
1135 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1136 * before unlocking it via unlock_new_inode().
1137 *
1138 * Note both @test and @set are called with the inode_hash_lock held, so can't
1139 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001141struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1142 int (*test)(struct inode *, void *),
1143 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144{
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001145 struct inode *inode = ilookup5(sb, hashval, test, data);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001146
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001147 if (!inode) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001148 struct inode *new = alloc_inode(sb);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001149
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001150 if (new) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001151 new->i_state = 0;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001152 inode = inode_insert5(new, hashval, test, set, data);
1153 if (unlikely(inode != new))
Miklos Szeredie9505642018-07-24 15:01:55 +02001154 destroy_inode(new);
Al Viro2864f302016-07-03 23:15:21 -04001155 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 }
1157 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001159EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001161/**
1162 * iget_locked - obtain an inode from a mounted file system
1163 * @sb: super block of file system
1164 * @ino: inode number to get
1165 *
1166 * Search for the inode specified by @ino in the inode cache and if present
1167 * return it with an increased reference count. This is for file systems
1168 * where the inode number is sufficient for unique identification of an inode.
1169 *
1170 * If the inode is not in cache, allocate a new inode and return it locked,
1171 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1172 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001174struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001176 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301177 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001178again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001179 spin_lock(&inode_hash_lock);
1180 inode = find_inode_fast(sb, head, ino);
1181 spin_unlock(&inode_hash_lock);
1182 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001183 if (IS_ERR(inode))
1184 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001185 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001186 if (unlikely(inode_unhashed(inode))) {
1187 iput(inode);
1188 goto again;
1189 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001190 return inode;
1191 }
1192
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 inode = alloc_inode(sb);
1194 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301195 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196
Dave Chinner67a23c42011-03-22 22:23:42 +11001197 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 /* We released the lock, so.. */
1199 old = find_inode_fast(sb, head, ino);
1200 if (!old) {
1201 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001202 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001203 inode->i_state = I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001204 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001205 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001206 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001207 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
1209 /* Return the locked inode with I_NEW set, the
1210 * caller is responsible for filling in the contents
1211 */
1212 return inode;
1213 }
1214
1215 /*
1216 * Uhhuh, somebody else created the same inode under
1217 * us. Use the old inode instead of the one we just
1218 * allocated.
1219 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001220 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 destroy_inode(inode);
Al Viroc2b6d622018-06-28 15:53:17 -04001222 if (IS_ERR(old))
1223 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 inode = old;
1225 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001226 if (unlikely(inode_unhashed(inode))) {
1227 iput(inode);
1228 goto again;
1229 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 }
1231 return inode;
1232}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001233EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001235/*
1236 * search the inode cache for a matching inode number.
1237 * If we find one, then the inode number we are trying to
1238 * allocate is not unique and so we should not use it.
1239 *
1240 * Returns 1 if the inode number is unique, 0 if it is not.
1241 */
1242static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1243{
1244 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001245 struct inode *inode;
1246
David Howells3f19b2a2017-12-01 11:40:16 +00001247 hlist_for_each_entry_rcu(inode, b, i_hash) {
1248 if (inode->i_ino == ino && inode->i_sb == sb)
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001249 return 0;
1250 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001251 return 1;
1252}
1253
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254/**
1255 * iunique - get a unique inode number
1256 * @sb: superblock
1257 * @max_reserved: highest reserved inode number
1258 *
1259 * Obtain an inode number that is unique on the system for a given
1260 * superblock. This is used by file systems that have no natural
1261 * permanent inode numbering system. An inode number is returned that
1262 * is higher than the reserved limit but unique.
1263 *
1264 * BUGS:
1265 * With a large number of inodes live on the file system this function
1266 * currently becomes quite slow.
1267 */
1268ino_t iunique(struct super_block *sb, ino_t max_reserved)
1269{
Jeff Layton866b04f2007-05-08 00:32:29 -07001270 /*
1271 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1272 * error if st_ino won't fit in target struct field. Use 32bit counter
1273 * here to attempt to avoid that.
1274 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001275 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001276 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278
David Howells3f19b2a2017-12-01 11:40:16 +00001279 rcu_read_lock();
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001280 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001281 do {
1282 if (counter <= max_reserved)
1283 counter = max_reserved + 1;
1284 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001285 } while (!test_inode_iunique(sb, res));
1286 spin_unlock(&iunique_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001287 rcu_read_unlock();
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001288
1289 return res;
1290}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291EXPORT_SYMBOL(iunique);
1292
1293struct inode *igrab(struct inode *inode)
1294{
Dave Chinner250df6e2011-03-22 22:23:36 +11001295 spin_lock(&inode->i_lock);
1296 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001298 spin_unlock(&inode->i_lock);
1299 } else {
1300 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 /*
1302 * Handle the case where s_op->clear_inode is not been
1303 * called yet, and somebody is calling igrab
1304 * while the inode is getting freed.
1305 */
1306 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001307 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 return inode;
1309}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310EXPORT_SYMBOL(igrab);
1311
1312/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001313 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 * @sb: super block of file system to search
1315 * @hashval: hash value (usually inode number) to search for
1316 * @test: callback used for comparisons between inodes
1317 * @data: opaque data pointer to pass to @test
1318 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001319 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001321 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001322 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001323 * Note: I_NEW is not waited upon so you have to be very careful what you do
1324 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001325 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001326 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001327 */
1328struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1329 int (*test)(struct inode *, void *), void *data)
1330{
1331 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001332 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001333
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001334 spin_lock(&inode_hash_lock);
1335 inode = find_inode(sb, head, test, data);
1336 spin_unlock(&inode_hash_lock);
1337
Al Viroc2b6d622018-06-28 15:53:17 -04001338 return IS_ERR(inode) ? NULL : inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001339}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001340EXPORT_SYMBOL(ilookup5_nowait);
1341
1342/**
1343 * ilookup5 - search for an inode in the inode cache
1344 * @sb: super block of file system to search
1345 * @hashval: hash value (usually inode number) to search for
1346 * @test: callback used for comparisons between inodes
1347 * @data: opaque data pointer to pass to @test
1348 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001349 * Search for the inode specified by @hashval and @data in the inode cache,
1350 * and if the inode is in the cache, return the inode with an incremented
1351 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001352 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001354 * This is a generalized version of ilookup() for file systems where the
1355 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001357 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 */
1359struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1360 int (*test)(struct inode *, void *), void *data)
1361{
Al Viro2864f302016-07-03 23:15:21 -04001362 struct inode *inode;
1363again:
1364 inode = ilookup5_nowait(sb, hashval, test, data);
1365 if (inode) {
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001366 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001367 if (unlikely(inode_unhashed(inode))) {
1368 iput(inode);
1369 goto again;
1370 }
1371 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001372 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374EXPORT_SYMBOL(ilookup5);
1375
1376/**
1377 * ilookup - search for an inode in the inode cache
1378 * @sb: super block of file system to search
1379 * @ino: inode number to search for
1380 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001381 * Search for the inode @ino in the inode cache, and if the inode is in the
1382 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 */
1384struct inode *ilookup(struct super_block *sb, unsigned long ino)
1385{
1386 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001387 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001388again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001389 spin_lock(&inode_hash_lock);
1390 inode = find_inode_fast(sb, head, ino);
1391 spin_unlock(&inode_hash_lock);
1392
Al Viro2864f302016-07-03 23:15:21 -04001393 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001394 if (IS_ERR(inode))
1395 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001396 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001397 if (unlikely(inode_unhashed(inode))) {
1398 iput(inode);
1399 goto again;
1400 }
1401 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001402 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404EXPORT_SYMBOL(ilookup);
1405
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001406/**
1407 * find_inode_nowait - find an inode in the inode cache
1408 * @sb: super block of file system to search
1409 * @hashval: hash value (usually inode number) to search for
1410 * @match: callback used for comparisons between inodes
1411 * @data: opaque data pointer to pass to @match
1412 *
1413 * Search for the inode specified by @hashval and @data in the inode
1414 * cache, where the helper function @match will return 0 if the inode
1415 * does not match, 1 if the inode does match, and -1 if the search
1416 * should be stopped. The @match function must be responsible for
1417 * taking the i_lock spin_lock and checking i_state for an inode being
1418 * freed or being initialized, and incrementing the reference count
1419 * before returning 1. It also must not sleep, since it is called with
1420 * the inode_hash_lock spinlock held.
1421 *
1422 * This is a even more generalized version of ilookup5() when the
1423 * function must never block --- find_inode() can block in
1424 * __wait_on_freeing_inode() --- or when the caller can not increment
1425 * the reference count because the resulting iput() might cause an
1426 * inode eviction. The tradeoff is that the @match funtion must be
1427 * very carefully implemented.
1428 */
1429struct inode *find_inode_nowait(struct super_block *sb,
1430 unsigned long hashval,
1431 int (*match)(struct inode *, unsigned long,
1432 void *),
1433 void *data)
1434{
1435 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1436 struct inode *inode, *ret_inode = NULL;
1437 int mval;
1438
1439 spin_lock(&inode_hash_lock);
1440 hlist_for_each_entry(inode, head, i_hash) {
1441 if (inode->i_sb != sb)
1442 continue;
1443 mval = match(inode, hashval, data);
1444 if (mval == 0)
1445 continue;
1446 if (mval == 1)
1447 ret_inode = inode;
1448 goto out;
1449 }
1450out:
1451 spin_unlock(&inode_hash_lock);
1452 return ret_inode;
1453}
1454EXPORT_SYMBOL(find_inode_nowait);
1455
David Howells3f19b2a2017-12-01 11:40:16 +00001456/**
1457 * find_inode_rcu - find an inode in the inode cache
1458 * @sb: Super block of file system to search
1459 * @hashval: Key to hash
1460 * @test: Function to test match on an inode
1461 * @data: Data for test function
1462 *
1463 * Search for the inode specified by @hashval and @data in the inode cache,
1464 * where the helper function @test will return 0 if the inode does not match
1465 * and 1 if it does. The @test function must be responsible for taking the
1466 * i_lock spin_lock and checking i_state for an inode being freed or being
1467 * initialized.
1468 *
1469 * If successful, this will return the inode for which the @test function
1470 * returned 1 and NULL otherwise.
1471 *
1472 * The @test function is not permitted to take a ref on any inode presented.
1473 * It is also not permitted to sleep.
1474 *
1475 * The caller must hold the RCU read lock.
1476 */
1477struct inode *find_inode_rcu(struct super_block *sb, unsigned long hashval,
1478 int (*test)(struct inode *, void *), void *data)
1479{
1480 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1481 struct inode *inode;
1482
1483 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1484 "suspicious find_inode_rcu() usage");
1485
1486 hlist_for_each_entry_rcu(inode, head, i_hash) {
1487 if (inode->i_sb == sb &&
1488 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)) &&
1489 test(inode, data))
1490 return inode;
1491 }
1492 return NULL;
1493}
1494EXPORT_SYMBOL(find_inode_rcu);
1495
1496/**
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001497 * find_inode_by_ino_rcu - Find an inode in the inode cache
David Howells3f19b2a2017-12-01 11:40:16 +00001498 * @sb: Super block of file system to search
1499 * @ino: The inode number to match
1500 *
1501 * Search for the inode specified by @hashval and @data in the inode cache,
1502 * where the helper function @test will return 0 if the inode does not match
1503 * and 1 if it does. The @test function must be responsible for taking the
1504 * i_lock spin_lock and checking i_state for an inode being freed or being
1505 * initialized.
1506 *
1507 * If successful, this will return the inode for which the @test function
1508 * returned 1 and NULL otherwise.
1509 *
1510 * The @test function is not permitted to take a ref on any inode presented.
1511 * It is also not permitted to sleep.
1512 *
1513 * The caller must hold the RCU read lock.
1514 */
1515struct inode *find_inode_by_ino_rcu(struct super_block *sb,
1516 unsigned long ino)
1517{
1518 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1519 struct inode *inode;
1520
1521 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1522 "suspicious find_inode_by_ino_rcu() usage");
1523
1524 hlist_for_each_entry_rcu(inode, head, i_hash) {
1525 if (inode->i_ino == ino &&
1526 inode->i_sb == sb &&
1527 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)))
1528 return inode;
1529 }
1530 return NULL;
1531}
1532EXPORT_SYMBOL(find_inode_by_ino_rcu);
1533
Al Viro261bca82008-12-30 01:48:21 -05001534int insert_inode_locked(struct inode *inode)
1535{
1536 struct super_block *sb = inode->i_sb;
1537 ino_t ino = inode->i_ino;
1538 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001539
Al Viro261bca82008-12-30 01:48:21 -05001540 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001541 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001542 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001543 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001544 if (old->i_ino != ino)
1545 continue;
1546 if (old->i_sb != sb)
1547 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001548 spin_lock(&old->i_lock);
1549 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1550 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001551 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001552 }
Al Viro72a43d62009-05-13 19:13:40 +01001553 break;
1554 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001555 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001556 spin_lock(&inode->i_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001557 inode->i_state |= I_NEW | I_CREATING;
David Howells3f19b2a2017-12-01 11:40:16 +00001558 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001559 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001560 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001561 return 0;
1562 }
Al Viroc2b6d622018-06-28 15:53:17 -04001563 if (unlikely(old->i_state & I_CREATING)) {
1564 spin_unlock(&old->i_lock);
1565 spin_unlock(&inode_hash_lock);
1566 return -EBUSY;
1567 }
Al Viro261bca82008-12-30 01:48:21 -05001568 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001569 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001570 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001571 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001572 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001573 iput(old);
1574 return -EBUSY;
1575 }
1576 iput(old);
1577 }
1578}
Al Viro261bca82008-12-30 01:48:21 -05001579EXPORT_SYMBOL(insert_inode_locked);
1580
1581int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1582 int (*test)(struct inode *, void *), void *data)
1583{
Al Viroc2b6d622018-06-28 15:53:17 -04001584 struct inode *old;
1585
1586 inode->i_state |= I_CREATING;
1587 old = inode_insert5(inode, hashval, test, NULL, data);
Al Viro261bca82008-12-30 01:48:21 -05001588
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001589 if (old != inode) {
Al Viro261bca82008-12-30 01:48:21 -05001590 iput(old);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001591 return -EBUSY;
Al Viro261bca82008-12-30 01:48:21 -05001592 }
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001593 return 0;
Al Viro261bca82008-12-30 01:48:21 -05001594}
Al Viro261bca82008-12-30 01:48:21 -05001595EXPORT_SYMBOL(insert_inode_locked4);
1596
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597
Al Viro45321ac2010-06-07 13:43:19 -04001598int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599{
Al Viro45321ac2010-06-07 13:43:19 -04001600 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602EXPORT_SYMBOL(generic_delete_inode);
1603
Al Viro45321ac2010-06-07 13:43:19 -04001604/*
Al Viro45321ac2010-06-07 13:43:19 -04001605 * Called when we're dropping the last reference
1606 * to an inode.
1607 *
1608 * Call the FS "drop_inode()" function, defaulting to
1609 * the legacy UNIX filesystem behaviour. If it tells
1610 * us to evict inode, do so. Otherwise, retain inode
1611 * in cache if fs is alive, sync and evict if fs is
1612 * shutting down.
1613 */
1614static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615{
1616 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001617 const struct super_operations *op = inode->i_sb->s_op;
David Howells3f19b2a2017-12-01 11:40:16 +00001618 unsigned long state;
Al Viro45321ac2010-06-07 13:43:19 -04001619 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620
Dave Chinner250df6e2011-03-22 22:23:36 +11001621 WARN_ON(inode->i_state & I_NEW);
1622
Al Viroe7f59092011-07-07 15:45:59 -04001623 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001624 drop = op->drop_inode(inode);
1625 else
1626 drop = generic_drop_inode(inode);
1627
Hao Li88149082020-12-08 10:08:43 +08001628 if (!drop &&
1629 !(inode->i_state & I_DONTCACHE) &&
1630 (sb->s_flags & SB_ACTIVE)) {
Jan Kara4eff96d2012-11-26 16:29:51 -08001631 inode_add_lru(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001632 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001633 return;
1634 }
1635
David Howells3f19b2a2017-12-01 11:40:16 +00001636 state = inode->i_state;
Al Viro45321ac2010-06-07 13:43:19 -04001637 if (!drop) {
David Howells3f19b2a2017-12-01 11:40:16 +00001638 WRITE_ONCE(inode->i_state, state | I_WILL_FREE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001639 spin_unlock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001640
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 write_inode_now(inode, 1);
David Howells3f19b2a2017-12-01 11:40:16 +00001642
Dave Chinner250df6e2011-03-22 22:23:36 +11001643 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001644 state = inode->i_state;
1645 WARN_ON(state & I_NEW);
1646 state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001648
David Howells3f19b2a2017-12-01 11:40:16 +00001649 WRITE_ONCE(inode->i_state, state | I_FREEING);
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001650 if (!list_empty(&inode->i_lru))
1651 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001652 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001653
1654 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655}
1656
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301658 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 * @inode: inode to put
1660 *
1661 * Puts an inode, dropping its usage count. If the inode use count hits
1662 * zero, the inode is then freed and may also be destroyed.
1663 *
1664 * Consequently, iput() can sleep.
1665 */
1666void iput(struct inode *inode)
1667{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001668 if (!inode)
1669 return;
1670 BUG_ON(inode->i_state & I_CLEAR);
1671retry:
1672 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1673 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1674 atomic_inc(&inode->i_count);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001675 spin_unlock(&inode->i_lock);
1676 trace_writeback_lazytime_iput(inode);
1677 mark_inode_dirty_sync(inode);
1678 goto retry;
1679 }
1680 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 }
1682}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683EXPORT_SYMBOL(iput);
1684
Carlos Maiolino30460e12020-01-09 14:30:41 +01001685#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686/**
1687 * bmap - find a block number in a file
Carlos Maiolino30460e12020-01-09 14:30:41 +01001688 * @inode: inode owning the block number being requested
1689 * @block: pointer containing the block to find
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 *
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001691 * Replaces the value in ``*block`` with the block number on the device holding
Carlos Maiolino30460e12020-01-09 14:30:41 +01001692 * corresponding to the requested block number in the file.
1693 * That is, asked for block 4 of inode 1 the function will replace the
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001694 * 4 in ``*block``, with disk block relative to the disk start that holds that
Carlos Maiolino30460e12020-01-09 14:30:41 +01001695 * block of the file.
1696 *
1697 * Returns -EINVAL in case of error, 0 otherwise. If mapping falls into a
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001698 * hole, returns 0 and ``*block`` is also set to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 */
Carlos Maiolino30460e12020-01-09 14:30:41 +01001700int bmap(struct inode *inode, sector_t *block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701{
Carlos Maiolino30460e12020-01-09 14:30:41 +01001702 if (!inode->i_mapping->a_ops->bmap)
1703 return -EINVAL;
1704
1705 *block = inode->i_mapping->a_ops->bmap(inode->i_mapping, *block);
1706 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708EXPORT_SYMBOL(bmap);
Carlos Maiolino30460e12020-01-09 14:30:41 +01001709#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001711/*
1712 * With relative atime, only update atime if the previous atime is
1713 * earlier than either the ctime or mtime or if at least a day has
1714 * passed since the last atime update.
1715 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001716static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001717 struct timespec64 now)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001718{
1719
Miklos Szeredic6718542018-07-18 15:44:43 +02001720 if (!(mnt->mnt_flags & MNT_RELATIME))
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001721 return 1;
1722 /*
1723 * Is mtime younger than atime? If yes, update atime:
1724 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001725 if (timespec64_compare(&inode->i_mtime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001726 return 1;
1727 /*
1728 * Is ctime younger than atime? If yes, update atime:
1729 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001730 if (timespec64_compare(&inode->i_ctime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001731 return 1;
1732
1733 /*
1734 * Is the previous atime value older than a day? If yes,
1735 * update atime:
1736 */
1737 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1738 return 1;
1739 /*
1740 * Good, we can skip the atime update:
1741 */
1742 return 0;
1743}
1744
Deepa Dinamani95582b02018-05-08 19:36:02 -07001745int generic_update_time(struct inode *inode, struct timespec64 *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001746{
Eric Biggerse20b14d2021-01-12 11:02:45 -08001747 int dirty_flags = 0;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001748
Eric Biggerse20b14d2021-01-12 11:02:45 -08001749 if (flags & (S_ATIME | S_CTIME | S_MTIME)) {
1750 if (flags & S_ATIME)
1751 inode->i_atime = *time;
1752 if (flags & S_CTIME)
1753 inode->i_ctime = *time;
1754 if (flags & S_MTIME)
1755 inode->i_mtime = *time;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001756
Eric Biggerse20b14d2021-01-12 11:02:45 -08001757 if (inode->i_sb->s_flags & SB_LAZYTIME)
1758 dirty_flags |= I_DIRTY_TIME;
1759 else
1760 dirty_flags |= I_DIRTY_SYNC;
1761 }
1762
1763 if ((flags & S_VERSION) && inode_maybe_inc_iversion(inode, false))
1764 dirty_flags |= I_DIRTY_SYNC;
1765
1766 __mark_inode_dirty(inode, dirty_flags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001767 return 0;
1768}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001769EXPORT_SYMBOL(generic_update_time);
1770
1771/*
1772 * This does the actual work of updating an inodes time or version. Must have
1773 * had called mnt_want_write() before calling this.
1774 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001775static int update_time(struct inode *inode, struct timespec64 *time, int flags)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001776{
Deepa Dinamani23b424d2019-12-02 21:19:45 -08001777 if (inode->i_op->update_time)
1778 return inode->i_op->update_time(inode, time, flags);
1779 return generic_update_time(inode, time, flags);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001780}
Josef Bacikc3b2da32012-03-26 09:59:21 -04001781
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782/**
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001783 * atime_needs_update - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001784 * @path: the &struct path to update
Randy Dunlap30fdc8e2015-11-09 14:57:58 -08001785 * @inode: inode to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 *
1787 * Update the accessed time on an inode and mark it for writeback.
1788 * This function automatically handles read only file systems and media,
1789 * as well as the "noatime" flag and inode specific "noatime" markers.
1790 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001791bool atime_needs_update(const struct path *path, struct inode *inode)
NeilBrown8fa9dd22015-03-23 13:37:40 +11001792{
1793 struct vfsmount *mnt = path->mnt;
Deepa Dinamani95582b02018-05-08 19:36:02 -07001794 struct timespec64 now;
NeilBrown8fa9dd22015-03-23 13:37:40 +11001795
1796 if (inode->i_flags & S_NOATIME)
1797 return false;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001798
1799 /* Atime updates will likely cause i_uid and i_gid to be written
1800 * back improprely if their true value is unknown to the vfs.
1801 */
Christian Braunerba73d982021-01-21 14:19:31 +01001802 if (HAS_UNMAPPED_ID(mnt_user_ns(mnt), inode))
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001803 return false;
1804
NeilBrown8fa9dd22015-03-23 13:37:40 +11001805 if (IS_NOATIME(inode))
1806 return false;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001807 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001808 return false;
1809
1810 if (mnt->mnt_flags & MNT_NOATIME)
1811 return false;
1812 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1813 return false;
1814
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001815 now = current_time(inode);
NeilBrown8fa9dd22015-03-23 13:37:40 +11001816
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001817 if (!relatime_need_update(mnt, inode, now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001818 return false;
1819
Deepa Dinamani95582b02018-05-08 19:36:02 -07001820 if (timespec64_equal(&inode->i_atime, &now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001821 return false;
1822
1823 return true;
1824}
1825
Al Virobadcf2b2013-07-16 18:15:46 +04001826void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827{
Al Viro68ac1232012-03-15 08:21:57 -04001828 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001829 struct inode *inode = d_inode(path->dentry);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001830 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831
Miklos Szeredic6718542018-07-18 15:44:43 +02001832 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001833 return;
1834
Jan Kara5d37e9e2012-06-12 16:20:36 +02001835 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001836 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001837
NeilBrown8fa9dd22015-03-23 13:37:40 +11001838 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001839 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001840 /*
1841 * File systems can error out when updating inodes if they need to
1842 * allocate new space to modify an inode (such is the case for
1843 * Btrfs), but since we touch atime while walking down the path we
1844 * really don't care if we failed to update the atime of the file,
1845 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001846 * We may also fail on filesystems that have the ability to make parts
1847 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001848 */
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001849 now = current_time(inode);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001850 update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001851 __mnt_drop_write(mnt);
1852skip_update:
1853 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001855EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856
Cong Wang3ed37642012-05-15 14:57:33 +08001857/*
1858 * The logic we want is
1859 *
1860 * if suid or (sgid and xgrp)
1861 * remove privs
1862 */
1863int should_remove_suid(struct dentry *dentry)
1864{
David Howellsdf2b1af2015-03-17 22:26:15 +00001865 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001866 int kill = 0;
1867
1868 /* suid always must be killed */
1869 if (unlikely(mode & S_ISUID))
1870 kill = ATTR_KILL_SUID;
1871
1872 /*
1873 * sgid without any exec bits is just a mandatory locking mark; leave
1874 * it alone. If some exec bits are set, it's a real sgid; kill it.
1875 */
1876 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1877 kill |= ATTR_KILL_SGID;
1878
1879 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1880 return kill;
1881
1882 return 0;
1883}
1884EXPORT_SYMBOL(should_remove_suid);
1885
Jan Karadbfae0c2015-05-21 16:05:54 +02001886/*
1887 * Return mask of changes for notify_change() that need to be done as a
1888 * response to write or truncate. Return 0 if nothing has to be changed.
1889 * Negative value on error (change should be denied).
1890 */
Jan Kara45f147a2015-05-21 16:05:55 +02001891int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001892{
Jan Karadbfae0c2015-05-21 16:05:54 +02001893 struct inode *inode = d_inode(dentry);
1894 int mask = 0;
1895 int ret;
1896
1897 if (IS_NOSEC(inode))
1898 return 0;
1899
1900 mask = should_remove_suid(dentry);
1901 ret = security_inode_need_killpriv(dentry);
1902 if (ret < 0)
1903 return ret;
1904 if (ret)
1905 mask |= ATTR_KILL_PRIV;
1906 return mask;
1907}
Jan Karadbfae0c2015-05-21 16:05:54 +02001908
Christian Brauner643fe552021-01-21 14:19:34 +01001909static int __remove_privs(struct user_namespace *mnt_userns,
1910 struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001911{
1912 struct iattr newattrs;
1913
1914 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001915 /*
1916 * Note we call this on write, so notify_change will not
1917 * encounter any conflicting delegations:
1918 */
Christian Brauner643fe552021-01-21 14:19:34 +01001919 return notify_change(mnt_userns, dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001920}
1921
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001922/*
1923 * Remove special file priviledges (suid, capabilities) when file is written
1924 * to or truncated.
1925 */
1926int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001927{
Miklos Szeredic1892c32016-08-03 13:44:27 +02001928 struct dentry *dentry = file_dentry(file);
1929 struct inode *inode = file_inode(file);
Jan Karadbfae0c2015-05-21 16:05:54 +02001930 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001931 int error = 0;
1932
Alexander Lochmannf69e7492018-12-14 11:55:52 +01001933 /*
1934 * Fast path for nothing security related.
1935 * As well for non-regular files, e.g. blkdev inodes.
1936 * For example, blkdev_write_iter() might get here
1937 * trying to remove privs which it is not allowed to.
1938 */
1939 if (IS_NOSEC(inode) || !S_ISREG(inode->i_mode))
Cong Wang3ed37642012-05-15 14:57:33 +08001940 return 0;
1941
Miklos Szeredic1892c32016-08-03 13:44:27 +02001942 kill = dentry_needs_remove_privs(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001943 if (kill < 0)
1944 return kill;
1945 if (kill)
Christian Brauner643fe552021-01-21 14:19:34 +01001946 error = __remove_privs(file_mnt_user_ns(file), dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001947 if (!error)
1948 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001949
1950 return error;
1951}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001952EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001953
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001955 * file_update_time - update mtime and ctime time
1956 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001958 * Update the mtime and ctime members of an inode and mark the inode
1959 * for writeback. Note that this function is meant exclusively for
1960 * usage in the file write path of filesystems, and filesystems may
1961 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001962 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001963 * timestamps are handled by the server. This can return an error for
1964 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 */
1966
Josef Bacikc3b2da32012-03-26 09:59:21 -04001967int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968{
Al Viro496ad9a2013-01-23 17:07:38 -05001969 struct inode *inode = file_inode(file);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001970 struct timespec64 now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001971 int sync_it = 0;
1972 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973
Andi Kleence06e0b2009-09-18 13:05:48 -07001974 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001976 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001977
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001978 now = current_time(inode);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001979 if (!timespec64_equal(&inode->i_mtime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001980 sync_it = S_MTIME;
1981
Deepa Dinamani95582b02018-05-08 19:36:02 -07001982 if (!timespec64_equal(&inode->i_ctime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001983 sync_it |= S_CTIME;
1984
Jeff Laytone38cf302017-12-11 06:35:22 -05001985 if (IS_I_VERSION(inode) && inode_iversion_need_inc(inode))
Andi Kleence06e0b2009-09-18 13:05:48 -07001986 sync_it |= S_VERSION;
1987
1988 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001989 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990
Andi Kleence06e0b2009-09-18 13:05:48 -07001991 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02001992 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001993 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994
Josef Bacikc3b2da32012-03-26 09:59:21 -04001995 ret = update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02001996 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001997
1998 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999}
Christoph Hellwig870f4812006-01-09 20:52:01 -08002000EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001
Amir Goldsteine38f7f52019-06-05 08:04:49 -07002002/* Caller must hold the file's inode lock */
2003int file_modified(struct file *file)
2004{
2005 int err;
2006
2007 /*
2008 * Clear the security bits if the process is not being run by root.
2009 * This keeps people from modifying setuid and setgid binaries.
2010 */
2011 err = file_remove_privs(file);
2012 if (err)
2013 return err;
2014
2015 if (unlikely(file->f_mode & FMODE_NOCMTIME))
2016 return 0;
2017
2018 return file_update_time(file);
2019}
2020EXPORT_SYMBOL(file_modified);
2021
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022int inode_needs_sync(struct inode *inode)
2023{
2024 if (IS_SYNC(inode))
2025 return 1;
2026 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
2027 return 1;
2028 return 0;
2029}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030EXPORT_SYMBOL(inode_needs_sync);
2031
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07002033 * If we try to find an inode in the inode hash while it is being
2034 * deleted, we have to wait until the filesystem completes its
2035 * deletion before reporting that it isn't found. This function waits
2036 * until the deletion _might_ have completed. Callers are responsible
2037 * to recheck inode state.
2038 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002039 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11002040 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
2041 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 */
2043static void __wait_on_freeing_inode(struct inode *inode)
2044{
2045 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002046 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
2047 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Ingo Molnar21417132017-03-05 11:25:39 +01002048 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11002049 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11002050 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 schedule();
Ingo Molnar21417132017-03-05 11:25:39 +01002052 finish_wait(wq, &wait.wq_entry);
Dave Chinner67a23c42011-03-22 22:23:42 +11002053 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054}
2055
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056static __initdata unsigned long ihash_entries;
2057static int __init set_ihash_entries(char *str)
2058{
2059 if (!str)
2060 return 0;
2061 ihash_entries = simple_strtoul(str, &str, 0);
2062 return 1;
2063}
2064__setup("ihash_entries=", set_ihash_entries);
2065
2066/*
2067 * Initialize the waitqueues and inode hash table.
2068 */
2069void __init inode_init_early(void)
2070{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 /* If hashes are distributed across NUMA nodes, defer
2072 * hash allocation until vmalloc space is available.
2073 */
2074 if (hashdist)
2075 return;
2076
2077 inode_hashtable =
2078 alloc_large_system_hash("Inode-cache",
2079 sizeof(struct hlist_head),
2080 ihash_entries,
2081 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002082 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 &i_hash_shift,
2084 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002085 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087}
2088
Denis Cheng74bf17c2007-10-16 23:26:30 -07002089void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08002092 inode_cachep = kmem_cache_create("inode_cache",
2093 sizeof(struct inode),
2094 0,
2095 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
Vladimir Davydov5d097052016-01-14 15:18:21 -08002096 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
Paul Mundt20c2df82007-07-20 10:11:58 +09002097 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098
2099 /* Hash may have been set up in inode_init_early */
2100 if (!hashdist)
2101 return;
2102
2103 inode_hashtable =
2104 alloc_large_system_hash("Inode-cache",
2105 sizeof(struct hlist_head),
2106 ihash_entries,
2107 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002108 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 &i_hash_shift,
2110 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002111 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113}
2114
2115void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
2116{
2117 inode->i_mode = mode;
2118 if (S_ISCHR(mode)) {
2119 inode->i_fop = &def_chr_fops;
2120 inode->i_rdev = rdev;
2121 } else if (S_ISBLK(mode)) {
2122 inode->i_fop = &def_blk_fops;
2123 inode->i_rdev = rdev;
2124 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04002125 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05002127 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07002129 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
2130 " inode %s:%lu\n", mode, inode->i_sb->s_id,
2131 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132}
2133EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002134
2135/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00002136 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Christian Brauner21cb47b2021-01-21 14:19:25 +01002137 * @mnt_userns: User namespace of the mount the inode was created from
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002138 * @inode: New inode
2139 * @dir: Directory inode
2140 * @mode: mode of the new inode
Christian Brauner21cb47b2021-01-21 14:19:25 +01002141 *
2142 * If the inode has been created through an idmapped mount the user namespace of
2143 * the vfsmount must be passed through @mnt_userns. This function will then take
2144 * care to map the inode according to @mnt_userns before checking permissions
2145 * and initializing i_uid and i_gid. On non-idmapped mounts or if permission
2146 * checking is to be performed on the raw inode simply passs init_user_ns.
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002147 */
Christian Brauner21cb47b2021-01-21 14:19:25 +01002148void inode_init_owner(struct user_namespace *mnt_userns, struct inode *inode,
2149 const struct inode *dir, umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002150{
Christian Brauner21cb47b2021-01-21 14:19:25 +01002151 inode->i_uid = fsuid_into_mnt(mnt_userns);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002152 if (dir && dir->i_mode & S_ISGID) {
2153 inode->i_gid = dir->i_gid;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002154
2155 /* Directories are special, and always inherit S_ISGID */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002156 if (S_ISDIR(mode))
2157 mode |= S_ISGID;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002158 else if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP) &&
Christian Brauner21cb47b2021-01-21 14:19:25 +01002159 !in_group_p(i_gid_into_mnt(mnt_userns, dir)) &&
2160 !capable_wrt_inode_uidgid(mnt_userns, dir, CAP_FSETID))
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002161 mode &= ~S_ISGID;
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002162 } else
Christian Brauner21cb47b2021-01-21 14:19:25 +01002163 inode->i_gid = fsgid_into_mnt(mnt_userns);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002164 inode->i_mode = mode;
2165}
2166EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07002167
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002168/**
2169 * inode_owner_or_capable - check current task permissions to inode
Christian Brauner21cb47b2021-01-21 14:19:25 +01002170 * @mnt_userns: user namespace of the mount the inode was found from
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002171 * @inode: inode being checked
2172 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002173 * Return true if current either has CAP_FOWNER in a namespace with the
2174 * inode owner uid mapped, or owns the file.
Christian Brauner21cb47b2021-01-21 14:19:25 +01002175 *
2176 * If the inode has been found through an idmapped mount the user namespace of
2177 * the vfsmount must be passed through @mnt_userns. This function will then take
2178 * care to map the inode according to @mnt_userns before checking permissions.
2179 * On non-idmapped mounts or if permission checking is to be performed on the
2180 * raw inode simply passs init_user_ns.
Serge E. Hallyne795b712011-03-23 16:43:25 -07002181 */
Christian Brauner21cb47b2021-01-21 14:19:25 +01002182bool inode_owner_or_capable(struct user_namespace *mnt_userns,
2183 const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07002184{
Christian Brauner21cb47b2021-01-21 14:19:25 +01002185 kuid_t i_uid;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002186 struct user_namespace *ns;
2187
Christian Brauner21cb47b2021-01-21 14:19:25 +01002188 i_uid = i_uid_into_mnt(mnt_userns, inode);
2189 if (uid_eq(current_fsuid(), i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002190 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002191
2192 ns = current_user_ns();
Christian Brauner21cb47b2021-01-21 14:19:25 +01002193 if (kuid_has_mapping(ns, i_uid) && ns_capable(ns, CAP_FOWNER))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002194 return true;
2195 return false;
2196}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002197EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002198
2199/*
2200 * Direct i/o helper functions
2201 */
2202static void __inode_dio_wait(struct inode *inode)
2203{
2204 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2205 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2206
2207 do {
Ingo Molnar21417132017-03-05 11:25:39 +01002208 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002209 if (atomic_read(&inode->i_dio_count))
2210 schedule();
2211 } while (atomic_read(&inode->i_dio_count));
Ingo Molnar21417132017-03-05 11:25:39 +01002212 finish_wait(wq, &q.wq_entry);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002213}
2214
2215/**
2216 * inode_dio_wait - wait for outstanding DIO requests to finish
2217 * @inode: inode to wait for
2218 *
2219 * Waits for all pending direct I/O requests to finish so that we can
2220 * proceed with a truncate or equivalent operation.
2221 *
2222 * Must be called under a lock that serializes taking new references
2223 * to i_dio_count, usually by inode->i_mutex.
2224 */
2225void inode_dio_wait(struct inode *inode)
2226{
2227 if (atomic_read(&inode->i_dio_count))
2228 __inode_dio_wait(inode);
2229}
2230EXPORT_SYMBOL(inode_dio_wait);
2231
2232/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002233 * inode_set_flags - atomically set some inode flags
2234 *
2235 * Note: the caller should be holding i_mutex, or else be sure that
2236 * they have exclusive access to the inode structure (i.e., while the
2237 * inode is being instantiated). The reason for the cmpxchg() loop
2238 * --- which wouldn't be necessary if all code paths which modify
2239 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002240 * code path which doesn't today so we use cmpxchg() out of an abundance
2241 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002242 *
2243 * In the long run, i_mutex is overkill, and we should probably look
2244 * at using the i_lock spinlock to protect i_flags, and then make sure
2245 * it is so documented in include/linux/fs.h and that all code follows
2246 * the locking convention!!
2247 */
2248void inode_set_flags(struct inode *inode, unsigned int flags,
2249 unsigned int mask)
2250{
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002251 WARN_ON_ONCE(flags & ~mask);
Vineet Guptaa9057372019-03-05 15:41:52 -08002252 set_mask_bits(&inode->i_flags, mask, flags);
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002253}
2254EXPORT_SYMBOL(inode_set_flags);
Al Viro21fc61c2015-11-17 01:07:57 -05002255
2256void inode_nohighmem(struct inode *inode)
2257{
2258 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2259}
2260EXPORT_SYMBOL(inode_nohighmem);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002261
2262/**
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002263 * timestamp_truncate - Truncate timespec to a granularity
2264 * @t: Timespec
2265 * @inode: inode being updated
2266 *
2267 * Truncate a timespec to the granularity supported by the fs
2268 * containing the inode. Always rounds down. gran must
2269 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2270 */
2271struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode)
2272{
2273 struct super_block *sb = inode->i_sb;
2274 unsigned int gran = sb->s_time_gran;
2275
2276 t.tv_sec = clamp(t.tv_sec, sb->s_time_min, sb->s_time_max);
2277 if (unlikely(t.tv_sec == sb->s_time_max || t.tv_sec == sb->s_time_min))
2278 t.tv_nsec = 0;
2279
2280 /* Avoid division in the common cases 1 ns and 1 s. */
2281 if (gran == 1)
2282 ; /* nothing */
2283 else if (gran == NSEC_PER_SEC)
2284 t.tv_nsec = 0;
2285 else if (gran > 1 && gran < NSEC_PER_SEC)
2286 t.tv_nsec -= t.tv_nsec % gran;
2287 else
2288 WARN(1, "invalid file time granularity: %u", gran);
2289 return t;
2290}
2291EXPORT_SYMBOL(timestamp_truncate);
2292
2293/**
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002294 * current_time - Return FS time
2295 * @inode: inode.
2296 *
2297 * Return the current time truncated to the time granularity supported by
2298 * the fs.
2299 *
2300 * Note that inode and inode->sb cannot be NULL.
2301 * Otherwise, the function warns and returns time without truncation.
2302 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07002303struct timespec64 current_time(struct inode *inode)
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002304{
Arnd Bergmannd651d162018-12-05 11:14:27 +11002305 struct timespec64 now;
2306
2307 ktime_get_coarse_real_ts64(&now);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002308
2309 if (unlikely(!inode->i_sb)) {
2310 WARN(1, "current_time() called with uninitialized super_block in the inode");
2311 return now;
2312 }
2313
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002314 return timestamp_truncate(now, inode);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002315}
2316EXPORT_SYMBOL(current_time);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002317
2318/*
2319 * Generic function to check FS_IOC_SETFLAGS values and reject any invalid
2320 * configurations.
2321 *
2322 * Note: the caller should be holding i_mutex, or else be sure that they have
2323 * exclusive access to the inode structure.
2324 */
2325int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
2326 unsigned int flags)
2327{
2328 /*
2329 * The IMMUTABLE and APPEND_ONLY flags can only be changed by
2330 * the relevant capability.
2331 *
2332 * This test looks nicer. Thanks to Pauline Middelink
2333 */
2334 if ((flags ^ oldflags) & (FS_APPEND_FL | FS_IMMUTABLE_FL) &&
2335 !capable(CAP_LINUX_IMMUTABLE))
2336 return -EPERM;
2337
Daniel Rosenberg6e1918c2020-01-20 14:31:56 -08002338 return fscrypt_prepare_setflags(inode, oldflags, flags);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002339}
2340EXPORT_SYMBOL(vfs_ioc_setflags_prepare);
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002341
2342/*
2343 * Generic function to check FS_IOC_FSSETXATTR values and reject any invalid
2344 * configurations.
2345 *
2346 * Note: the caller should be holding i_mutex, or else be sure that they have
2347 * exclusive access to the inode structure.
2348 */
2349int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
2350 struct fsxattr *fa)
2351{
2352 /*
2353 * Can't modify an immutable/append-only file unless we have
2354 * appropriate permission.
2355 */
2356 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2357 (FS_XFLAG_IMMUTABLE | FS_XFLAG_APPEND) &&
2358 !capable(CAP_LINUX_IMMUTABLE))
2359 return -EPERM;
2360
Darrick J. Wongf9914922019-07-01 08:25:35 -07002361 /*
2362 * Project Quota ID state is only allowed to change from within the init
2363 * namespace. Enforce that restriction only if we are trying to change
2364 * the quota ID state. Everything else is allowed in user namespaces.
2365 */
2366 if (current_user_ns() != &init_user_ns) {
2367 if (old_fa->fsx_projid != fa->fsx_projid)
2368 return -EINVAL;
2369 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2370 FS_XFLAG_PROJINHERIT)
2371 return -EINVAL;
2372 }
2373
Darrick J. Wongca29be72019-07-01 08:25:36 -07002374 /* Check extent size hints. */
2375 if ((fa->fsx_xflags & FS_XFLAG_EXTSIZE) && !S_ISREG(inode->i_mode))
2376 return -EINVAL;
2377
2378 if ((fa->fsx_xflags & FS_XFLAG_EXTSZINHERIT) &&
2379 !S_ISDIR(inode->i_mode))
2380 return -EINVAL;
2381
2382 if ((fa->fsx_xflags & FS_XFLAG_COWEXTSIZE) &&
2383 !S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
2384 return -EINVAL;
2385
Darrick J. Wongdbc77f32019-07-01 08:25:36 -07002386 /*
2387 * It is only valid to set the DAX flag on regular files and
2388 * directories on filesystems.
2389 */
2390 if ((fa->fsx_xflags & FS_XFLAG_DAX) &&
2391 !(S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode)))
2392 return -EINVAL;
2393
Darrick J. Wongca29be72019-07-01 08:25:36 -07002394 /* Extent size hints of zero turn off the flags. */
2395 if (fa->fsx_extsize == 0)
2396 fa->fsx_xflags &= ~(FS_XFLAG_EXTSIZE | FS_XFLAG_EXTSZINHERIT);
2397 if (fa->fsx_cowextsize == 0)
2398 fa->fsx_xflags &= ~FS_XFLAG_COWEXTSIZE;
2399
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002400 return 0;
2401}
2402EXPORT_SYMBOL(vfs_ioc_fssetxattr_check);