blob: 6442d97d9a4ab37a82f55dda5801c5067ef9bf01 [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;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200145 inode->__i_nlink = 1;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700146 inode->i_opflags = 0;
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200147 if (sb->s_xattr)
148 inode->i_opflags |= IOP_XATTR;
Eric W. Biederman92361632012-02-08 07:07:50 -0800149 i_uid_write(inode, 0);
150 i_gid_write(inode, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100151 atomic_set(&inode->i_writecount, 0);
152 inode->i_size = 0;
Jens Axboec75b1d92017-06-27 11:47:04 -0600153 inode->i_write_hint = WRITE_LIFE_NOT_SET;
David Chinner2cb15992008-10-30 17:32:23 +1100154 inode->i_blocks = 0;
155 inode->i_bytes = 0;
156 inode->i_generation = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100157 inode->i_pipe = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100158 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400159 inode->i_link = NULL;
Al Viro84e710d2016-04-15 00:58:55 -0400160 inode->i_dir_seq = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100161 inode->i_rdev = 0;
162 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500163
Tahsin Erdogan3d65ae42016-02-16 13:34:39 -0800164#ifdef CONFIG_CGROUP_WRITEBACK
165 inode->i_wb_frn_winner = 0;
166 inode->i_wb_frn_avg_time = 0;
167 inode->i_wb_frn_history = 0;
168#endif
169
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500170 if (security_inode_alloc(inode))
Christoph Hellwig54e34622009-08-07 14:38:25 -0300171 goto out;
David Chinner2cb15992008-10-30 17:32:23 +1100172 spin_lock_init(&inode->i_lock);
173 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
174
Al Viro9902af72016-04-15 15:08:36 -0400175 init_rwsem(&inode->i_rwsem);
176 lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
David Chinner2cb15992008-10-30 17:32:23 +1100177
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400178 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100179
180 mapping->a_ops = &empty_aops;
181 mapping->host = inode;
182 mapping->flags = 0;
Matthew Wilcox (Oracle)01c70262020-10-15 20:06:00 -0700183 if (sb->s_type->fs_flags & FS_THP_SUPPORT)
184 __set_bit(AS_THP_SUPPORT, &mapping->flags);
Darrick J. Wong829bc7872018-05-30 19:43:53 -0700185 mapping->wb_err = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700186 atomic_set(&mapping->i_mmap_writable, 0);
Song Liu09d91cd2019-09-23 15:38:03 -0700187#ifdef CONFIG_READ_ONLY_THP_FOR_FS
188 atomic_set(&mapping->nr_thps, 0);
189#endif
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800190 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800191 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100192 mapping->writeback_index = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100193 inode->i_private = NULL;
194 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400195 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400196#ifdef CONFIG_FS_POSIX_ACL
197 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
198#endif
David Chinner2cb15992008-10-30 17:32:23 +1100199
Eric Paris3be25f42009-05-21 17:01:26 -0400200#ifdef CONFIG_FSNOTIFY
201 inode->i_fsnotify_mask = 0;
202#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500203 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100204 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400205
Christoph Hellwig54e34622009-08-07 14:38:25 -0300206 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300207out:
208 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100209}
210EXPORT_SYMBOL(inode_init_always);
211
Al Virofdb0da82019-04-10 14:43:44 -0400212void free_inode_nonrcu(struct inode *inode)
213{
214 kmem_cache_free(inode_cachep, inode);
215}
216EXPORT_SYMBOL(free_inode_nonrcu);
217
218static void i_callback(struct rcu_head *head)
219{
220 struct inode *inode = container_of(head, struct inode, i_rcu);
221 if (inode->free_inode)
222 inode->free_inode(inode);
223 else
224 free_inode_nonrcu(inode);
225}
226
David Chinner2cb15992008-10-30 17:32:23 +1100227static struct inode *alloc_inode(struct super_block *sb)
228{
Al Virofdb0da82019-04-10 14:43:44 -0400229 const struct super_operations *ops = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 struct inode *inode;
231
Al Virofdb0da82019-04-10 14:43:44 -0400232 if (ops->alloc_inode)
233 inode = ops->alloc_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 else
David Chinner2cb15992008-10-30 17:32:23 +1100235 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Christoph Hellwig54e34622009-08-07 14:38:25 -0300237 if (!inode)
238 return NULL;
239
240 if (unlikely(inode_init_always(sb, inode))) {
Al Virofdb0da82019-04-10 14:43:44 -0400241 if (ops->destroy_inode) {
242 ops->destroy_inode(inode);
243 if (!ops->free_inode)
244 return NULL;
245 }
246 inode->free_inode = ops->free_inode;
247 i_callback(&inode->i_rcu);
Christoph Hellwig54e34622009-08-07 14:38:25 -0300248 return NULL;
249 }
250
251 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252}
253
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300254void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200256 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400257 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400259 fsnotify_inode_delete(inode);
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500260 locks_free_lock_context(inode);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100261 if (!inode->i_nlink) {
262 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
263 atomic_long_dec(&inode->i_sb->s_remove_count);
264 }
265
Al Virof19d4a82009-06-08 19:50:45 -0400266#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100267 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400268 posix_acl_release(inode->i_acl);
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100269 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400270 posix_acl_release(inode->i_default_acl);
271#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100272 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300273}
274EXPORT_SYMBOL(__destroy_inode);
275
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200276static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300277{
Al Virofdb0da82019-04-10 14:43:44 -0400278 const struct super_operations *ops = inode->i_sb->s_op;
279
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100280 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300281 __destroy_inode(inode);
Al Virofdb0da82019-04-10 14:43:44 -0400282 if (ops->destroy_inode) {
283 ops->destroy_inode(inode);
284 if (!ops->free_inode)
285 return;
286 }
287 inode->free_inode = ops->free_inode;
288 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100291/**
292 * drop_nlink - directly drop an inode's link count
293 * @inode: inode
294 *
295 * This is a low-level filesystem helper to replace any
296 * direct filesystem manipulation of i_nlink. In cases
297 * where we are attempting to track writes to the
298 * filesystem, a decrement to zero means an imminent
299 * write when the file is truncated and actually unlinked
300 * on the filesystem.
301 */
302void drop_nlink(struct inode *inode)
303{
304 WARN_ON(inode->i_nlink == 0);
305 inode->__i_nlink--;
306 if (!inode->i_nlink)
307 atomic_long_inc(&inode->i_sb->s_remove_count);
308}
309EXPORT_SYMBOL(drop_nlink);
310
311/**
312 * clear_nlink - directly zero an inode's link count
313 * @inode: inode
314 *
315 * This is a low-level filesystem helper to replace any
316 * direct filesystem manipulation of i_nlink. See
317 * drop_nlink() for why we care about i_nlink hitting zero.
318 */
319void clear_nlink(struct inode *inode)
320{
321 if (inode->i_nlink) {
322 inode->__i_nlink = 0;
323 atomic_long_inc(&inode->i_sb->s_remove_count);
324 }
325}
326EXPORT_SYMBOL(clear_nlink);
327
328/**
329 * set_nlink - directly set an inode's link count
330 * @inode: inode
331 * @nlink: new nlink (should be non-zero)
332 *
333 * This is a low-level filesystem helper to replace any
334 * direct filesystem manipulation of i_nlink.
335 */
336void set_nlink(struct inode *inode, unsigned int nlink)
337{
338 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100339 clear_nlink(inode);
340 } else {
341 /* Yes, some filesystems do change nlink from zero to one */
342 if (inode->i_nlink == 0)
343 atomic_long_dec(&inode->i_sb->s_remove_count);
344
345 inode->__i_nlink = nlink;
346 }
347}
348EXPORT_SYMBOL(set_nlink);
349
350/**
351 * inc_nlink - directly increment an inode's link count
352 * @inode: inode
353 *
354 * This is a low-level filesystem helper to replace any
355 * direct filesystem manipulation of i_nlink. Currently,
356 * it is only here for parity with dec_nlink().
357 */
358void inc_nlink(struct inode *inode)
359{
Al Virof4e0c302013-06-11 08:34:36 +0400360 if (unlikely(inode->i_nlink == 0)) {
361 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100362 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400363 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100364
365 inode->__i_nlink++;
366}
367EXPORT_SYMBOL(inc_nlink);
368
Dave Chinnerae233952018-03-06 17:30:34 -0800369static void __address_space_init_once(struct address_space *mapping)
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100370{
Johannes Weiner7b785642019-05-24 10:12:46 -0400371 xa_init_flags(&mapping->i_pages, XA_FLAGS_LOCK_IRQ | XA_FLAGS_ACCOUNT);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800372 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100373 INIT_LIST_HEAD(&mapping->private_list);
374 spin_lock_init(&mapping->private_lock);
Davidlohr Buesof808c132017-09-08 16:15:08 -0700375 mapping->i_mmap = RB_ROOT_CACHED;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100376}
Dave Chinnerae233952018-03-06 17:30:34 -0800377
378void address_space_init_once(struct address_space *mapping)
379{
380 memset(mapping, 0, sizeof(*mapping));
381 __address_space_init_once(mapping);
382}
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100383EXPORT_SYMBOL(address_space_init_once);
384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385/*
386 * These are initializations that only need to be done
387 * once, because the fields are idempotent across use
388 * of the inode, so let the slab aware of that.
389 */
390void inode_init_once(struct inode *inode)
391{
392 memset(inode, 0, sizeof(*inode));
393 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500395 INIT_LIST_HEAD(&inode->i_io_list);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700396 INIT_LIST_HEAD(&inode->i_wb_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100397 INIT_LIST_HEAD(&inode->i_lru);
Dave Chinnerae233952018-03-06 17:30:34 -0800398 __address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 i_size_ordered_init(inode);
400}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401EXPORT_SYMBOL(inode_init_once);
402
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700403static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530405 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Christoph Lametera35afb82007-05-16 22:10:57 -0700407 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408}
409
410/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100411 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530413void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414{
Nick Piggin9e38d862010-10-23 06:55:17 -0400415 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416}
417
Al Viro7de9c6ee2010-10-23 11:11:40 -0400418/*
419 * get additional reference to inode; caller must already hold one.
420 */
421void ihold(struct inode *inode)
422{
423 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
424}
425EXPORT_SYMBOL(ihold);
426
Nick Piggin9e38d862010-10-23 06:55:17 -0400427static void inode_lru_list_add(struct inode *inode)
428{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000429 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000430 this_cpu_inc(nr_unused);
Josef Bacik563f4002017-04-18 16:04:17 -0400431 else
432 inode->i_state |= I_REFERENCED;
Nick Piggin9e38d862010-10-23 06:55:17 -0400433}
434
Jan Kara4eff96d2012-11-26 16:29:51 -0800435/*
436 * Add inode to LRU if needed (inode is unused and clean).
437 *
438 * Needs inode->i_lock held.
439 */
440void inode_add_lru(struct inode *inode)
441{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500442 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
443 I_FREEING | I_WILL_FREE)) &&
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800444 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & SB_ACTIVE)
Jan Kara4eff96d2012-11-26 16:29:51 -0800445 inode_lru_list_add(inode);
446}
447
448
Nick Piggin9e38d862010-10-23 06:55:17 -0400449static void inode_lru_list_del(struct inode *inode)
450{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000451
452 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000453 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454}
455
Christoph Hellwig646ec462010-10-23 07:15:32 -0400456/**
457 * inode_sb_list_add - add inode to the superblock list of inodes
458 * @inode: inode to add
459 */
460void inode_sb_list_add(struct inode *inode)
461{
Dave Chinner74278da2015-03-04 12:37:22 -0500462 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100463 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500464 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400465}
466EXPORT_SYMBOL_GPL(inode_sb_list_add);
467
Dave Chinner55fa6092011-03-22 22:23:40 +1100468static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400469{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200470 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500471 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200472 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500473 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200474 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400475}
476
Dave Chinner4c51acb2010-10-23 06:58:09 -0400477static unsigned long hash(struct super_block *sb, unsigned long hashval)
478{
479 unsigned long tmp;
480
481 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
482 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400483 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
484 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400485}
486
487/**
488 * __insert_inode_hash - hash an inode
489 * @inode: unhashed inode
490 * @hashval: unsigned long value used to locate this object in the
491 * inode_hashtable.
492 *
493 * Add an inode to the inode hash for this superblock.
494 */
495void __insert_inode_hash(struct inode *inode, unsigned long hashval)
496{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400497 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
498
Dave Chinner67a23c42011-03-22 22:23:42 +1100499 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100500 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000501 hlist_add_head_rcu(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100502 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100503 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400504}
505EXPORT_SYMBOL(__insert_inode_hash);
506
507/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200508 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400509 * @inode: inode to unhash
510 *
511 * Remove an inode from the superblock.
512 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200513void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400514{
Dave Chinner67a23c42011-03-22 22:23:42 +1100515 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100516 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000517 hlist_del_init_rcu(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100518 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100519 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400520}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200521EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400522
Jan Karadbd57682012-05-03 14:48:02 +0200523void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400524{
Jan Kara08142572011-06-27 16:18:10 -0700525 /*
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700526 * We have to cycle the i_pages lock here because reclaim can be in the
Jan Kara08142572011-06-27 16:18:10 -0700527 * process of removing the last page (in __delete_from_page_cache())
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700528 * and we must not free the mapping under it.
Jan Kara08142572011-06-27 16:18:10 -0700529 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700530 xa_lock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400531 BUG_ON(inode->i_data.nrpages);
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800532 BUG_ON(inode->i_data.nrexceptional);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700533 xa_unlock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400534 BUG_ON(!list_empty(&inode->i_data.private_list));
535 BUG_ON(!(inode->i_state & I_FREEING));
536 BUG_ON(inode->i_state & I_CLEAR);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700537 BUG_ON(!list_empty(&inode->i_wb_list));
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100538 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400539 inode->i_state = I_FREEING | I_CLEAR;
540}
Jan Karadbd57682012-05-03 14:48:02 +0200541EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400542
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100543/*
544 * Free the inode passed in, removing it from the lists it is still connected
545 * to. We remove any pages still attached to the inode and wait for any IO that
546 * is still in progress before finally destroying the inode.
547 *
548 * An inode must already be marked I_FREEING so that we avoid the inode being
549 * moved back onto lists if we race with other code that manipulates the lists
550 * (e.g. writeback_single_inode). The caller is responsible for setting this.
551 *
552 * An inode must already be removed from the LRU list before being evicted from
553 * the cache. This should occur atomically with setting the I_FREEING state
554 * flag, so no inodes here should ever be on the LRU when being evicted.
555 */
Al Viro644da592010-06-07 13:21:05 -0400556static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400557{
558 const struct super_operations *op = inode->i_sb->s_op;
559
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100560 BUG_ON(!(inode->i_state & I_FREEING));
561 BUG_ON(!list_empty(&inode->i_lru));
562
Dave Chinnerc7f54082015-03-04 14:07:22 -0500563 if (!list_empty(&inode->i_io_list))
564 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200565
Dave Chinner55fa6092011-03-22 22:23:40 +1100566 inode_sb_list_del(inode);
567
Jan Kara169ebd92012-05-03 14:48:03 +0200568 /*
569 * Wait for flusher thread to be done with the inode so that filesystem
570 * does not start destroying it while writeback is still running. Since
571 * the inode has I_FREEING set, flusher thread won't start new work on
572 * the inode. We just have to wait for running writeback to finish.
573 */
574 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200575
Al Virobe7ce412010-06-04 19:40:39 -0400576 if (op->evict_inode) {
577 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400578 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700579 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200580 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400581 }
Al Viro661074e2010-06-04 20:19:55 -0400582 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
583 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100584
585 remove_inode_hash(inode);
586
587 spin_lock(&inode->i_lock);
588 wake_up_bit(&inode->i_state, __I_NEW);
589 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
590 spin_unlock(&inode->i_lock);
591
592 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400593}
594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595/*
596 * dispose_list - dispose of the contents of a local list
597 * @head: the head of the list to free
598 *
599 * Dispose-list gets a local list with local inodes in it, so it doesn't
600 * need to worry about list corruption and SMP locks.
601 */
602static void dispose_list(struct list_head *head)
603{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 while (!list_empty(head)) {
605 struct inode *inode;
606
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100607 inode = list_first_entry(head, struct inode, i_lru);
608 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Al Viro644da592010-06-07 13:21:05 -0400610 evict(inode);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500611 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613}
614
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615/**
Al Viro63997e92010-10-25 20:49:35 -0400616 * evict_inodes - evict all evictable inodes for a superblock
617 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 *
Al Viro63997e92010-10-25 20:49:35 -0400619 * Make sure that no inodes with zero refcount are retained. This is
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800620 * called by superblock shutdown after having SB_ACTIVE flag removed,
Al Viro63997e92010-10-25 20:49:35 -0400621 * so any inode reaching zero refcount during or after that call will
622 * be immediately evicted.
623 */
624void evict_inodes(struct super_block *sb)
625{
626 struct inode *inode, *next;
627 LIST_HEAD(dispose);
628
Josef Bacikac05fbb2015-03-04 16:52:52 -0500629again:
Dave Chinner74278da2015-03-04 12:37:22 -0500630 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400631 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
632 if (atomic_read(&inode->i_count))
633 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100634
635 spin_lock(&inode->i_lock);
636 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
637 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400638 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100639 }
Al Viro63997e92010-10-25 20:49:35 -0400640
641 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100642 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100643 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100644 list_add(&inode->i_lru, &dispose);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500645
646 /*
647 * We can have a ton of inodes to evict at unmount time given
648 * enough memory, check to see if we need to go to sleep for a
649 * bit so we don't livelock.
650 */
651 if (need_resched()) {
652 spin_unlock(&sb->s_inode_list_lock);
653 cond_resched();
654 dispose_list(&dispose);
655 goto again;
656 }
Al Viro63997e92010-10-25 20:49:35 -0400657 }
Dave Chinner74278da2015-03-04 12:37:22 -0500658 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400659
660 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400661}
Darrick J. Wong799ea9e2017-08-18 18:08:25 -0700662EXPORT_SYMBOL_GPL(evict_inodes);
Al Viro63997e92010-10-25 20:49:35 -0400663
664/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200665 * invalidate_inodes - attempt to free all inodes on a superblock
666 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100667 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200668 *
669 * Attempts to free all inodes for a given superblock. If there were any
670 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100671 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
672 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 */
NeilBrown93b270f2011-02-24 17:25:47 +1100674int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400676 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200677 struct inode *inode, *next;
678 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Eric Sandeen04646ae2019-12-06 10:54:23 -0600680again:
Dave Chinner74278da2015-03-04 12:37:22 -0500681 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200682 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100683 spin_lock(&inode->i_lock);
684 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
685 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100687 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500688 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100689 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100690 busy = 1;
691 continue;
692 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200693 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100694 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200695 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 continue;
697 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200698
Christoph Hellwig99a38912010-10-23 19:07:20 +0200699 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100700 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100701 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100702 list_add(&inode->i_lru, &dispose);
Eric Sandeen04646ae2019-12-06 10:54:23 -0600703 if (need_resched()) {
704 spin_unlock(&sb->s_inode_list_lock);
705 cond_resched();
706 dispose_list(&dispose);
707 goto again;
708 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 }
Dave Chinner74278da2015-03-04 12:37:22 -0500710 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Christoph Hellwiga0318782010-10-24 19:40:33 +0200712 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714 return busy;
715}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000718 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 *
720 * Any inodes which are pinned purely because of attached pagecache have their
Nick Piggin9e38d862010-10-23 06:55:17 -0400721 * pagecache removed. If the inode has metadata buffers attached to
722 * mapping->private_list then try to remove them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400724 * If the inode has the I_REFERENCED flag set, then it means that it has been
725 * used recently - the flag is set in iput_final(). When we encounter such an
726 * inode, clear the flag and move it to the back of the LRU so it gets another
727 * pass through the LRU before it gets reclaimed. This is necessary because of
728 * the fact we are doing lazy LRU updates to minimise lock contention so the
729 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
730 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800732static enum lru_status inode_lru_isolate(struct list_head *item,
733 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000734{
735 struct list_head *freeable = arg;
736 struct inode *inode = container_of(item, struct inode, i_lru);
737
738 /*
739 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
740 * If we fail to get the lock, just skip it.
741 */
742 if (!spin_trylock(&inode->i_lock))
743 return LRU_SKIP;
744
745 /*
746 * Referenced or dirty inodes are still in use. Give them another pass
747 * through the LRU as we canot reclaim them now.
748 */
749 if (atomic_read(&inode->i_count) ||
750 (inode->i_state & ~I_REFERENCED)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800751 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000752 spin_unlock(&inode->i_lock);
753 this_cpu_dec(nr_unused);
754 return LRU_REMOVED;
755 }
756
Dave Chinner69056ee2019-02-12 15:35:51 -0800757 /* recently referenced inodes get one more pass */
758 if (inode->i_state & I_REFERENCED) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000759 inode->i_state &= ~I_REFERENCED;
760 spin_unlock(&inode->i_lock);
761 return LRU_ROTATE;
762 }
763
764 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
765 __iget(inode);
766 spin_unlock(&inode->i_lock);
767 spin_unlock(lru_lock);
768 if (remove_inode_buffers(inode)) {
769 unsigned long reap;
770 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
771 if (current_is_kswapd())
772 __count_vm_events(KSWAPD_INODESTEAL, reap);
773 else
774 __count_vm_events(PGINODESTEAL, reap);
775 if (current->reclaim_state)
776 current->reclaim_state->reclaimed_slab += reap;
777 }
778 iput(inode);
779 spin_lock(lru_lock);
780 return LRU_RETRY;
781 }
782
783 WARN_ON(inode->i_state & I_NEW);
784 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800785 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000786 spin_unlock(&inode->i_lock);
787
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000788 this_cpu_dec(nr_unused);
789 return LRU_REMOVED;
790}
791
792/*
793 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
794 * This is called from the superblock shrinker function with a number of inodes
795 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
796 * then are freed outside inode_lock by dispose_list().
797 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800798long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
800 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000801 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Vladimir Davydov503c3582015-02-12 14:58:47 -0800803 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
804 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000806 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807}
808
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809static void __wait_on_freeing_inode(struct inode *inode);
810/*
811 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530813static struct inode *find_inode(struct super_block *sb,
814 struct hlist_head *head,
815 int (*test)(struct inode *, void *),
816 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530818 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
820repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800821 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500822 if (inode->i_sb != sb)
823 continue;
824 if (!test(inode, data))
825 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100826 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400827 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 __wait_on_freeing_inode(inode);
829 goto repeat;
830 }
Al Viroc2b6d622018-06-28 15:53:17 -0400831 if (unlikely(inode->i_state & I_CREATING)) {
832 spin_unlock(&inode->i_lock);
833 return ERR_PTR(-ESTALE);
834 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400835 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100836 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400837 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400839 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840}
841
842/*
843 * find_inode_fast is the fast path version of find_inode, see the comment at
844 * iget_locked for details.
845 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530846static struct inode *find_inode_fast(struct super_block *sb,
847 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530849 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
851repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800852 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500853 if (inode->i_ino != ino)
854 continue;
855 if (inode->i_sb != sb)
856 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100857 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400858 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 __wait_on_freeing_inode(inode);
860 goto repeat;
861 }
Al Viroc2b6d622018-06-28 15:53:17 -0400862 if (unlikely(inode->i_state & I_CREATING)) {
863 spin_unlock(&inode->i_lock);
864 return ERR_PTR(-ESTALE);
865 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400866 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100867 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400868 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400870 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871}
872
Eric Dumazetf991bd22010-10-23 11:18:01 -0400873/*
874 * Each cpu owns a range of LAST_INO_BATCH numbers.
875 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
876 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100877 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400878 * This does not significantly increase overflow rate because every CPU can
879 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
880 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
881 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
882 * overflow rate by 2x, which does not seem too significant.
883 *
884 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
885 * error if st_ino won't fit in target struct field. Use 32bit counter
886 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100887 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400888#define LAST_INO_BATCH 1024
889static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100890
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400891unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400892{
893 unsigned int *p = &get_cpu_var(last_ino);
894 unsigned int res = *p;
895
896#ifdef CONFIG_SMP
897 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
898 static atomic_t shared_last_ino;
899 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
900
901 res = next - LAST_INO_BATCH;
902 }
903#endif
904
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300905 res++;
906 /* get_next_ino should not provide a 0 inode number */
907 if (unlikely(!res))
908 res++;
909 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400910 put_cpu_var(last_ino);
911 return res;
David Chinner8290c352008-10-30 17:35:24 +1100912}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400913EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100914
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200916 * new_inode_pseudo - obtain an inode
917 * @sb: superblock
918 *
919 * Allocates a new inode for given superblock.
920 * Inode wont be chained in superblock s_inodes list
921 * This means :
922 * - fs can't be unmount
923 * - quotas, fsnotify, writeback can't work
924 */
925struct inode *new_inode_pseudo(struct super_block *sb)
926{
927 struct inode *inode = alloc_inode(sb);
928
929 if (inode) {
930 spin_lock(&inode->i_lock);
931 inode->i_state = 0;
932 spin_unlock(&inode->i_lock);
933 INIT_LIST_HEAD(&inode->i_sb_list);
934 }
935 return inode;
936}
937
938/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 * new_inode - obtain an inode
940 * @sb: superblock
941 *
Mel Gorman769848c2007-07-17 04:03:05 -0700942 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800943 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700944 * If HIGHMEM pages are unsuitable or it is known that pages allocated
945 * for the page cache are not reclaimable or migratable,
946 * mapping_set_gfp_mask() must be called with suitable flags on the
947 * newly created inode's mapping
948 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 */
950struct inode *new_inode(struct super_block *sb)
951{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530952 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953
Dave Chinner74278da2015-03-04 12:37:22 -0500954 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530955
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200956 inode = new_inode_pseudo(sb);
957 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100958 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 return inode;
960}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961EXPORT_SYMBOL(new_inode);
962
Peter Zijlstra14358e62007-10-14 01:38:33 +0200963#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400964void lockdep_annotate_inode_mutex_key(struct inode *inode)
965{
Namhyung Kima3314a02010-10-11 22:38:00 +0900966 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200967 struct file_system_type *type = inode->i_sb->s_type;
968
Jan Kara9a7aa122009-06-04 15:26:49 +0200969 /* Set new key only if filesystem hasn't already changed it */
Al Viro9902af72016-04-15 15:08:36 -0400970 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200971 /*
972 * ensure nobody is actually holding i_mutex
973 */
Al Viro9902af72016-04-15 15:08:36 -0400974 // mutex_destroy(&inode->i_mutex);
975 init_rwsem(&inode->i_rwsem);
976 lockdep_set_class(&inode->i_rwsem,
Jan Kara9a7aa122009-06-04 15:26:49 +0200977 &type->i_mutex_dir_key);
978 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200979 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400980}
981EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200982#endif
Josh Boyere096d0c2011-08-25 07:48:12 -0400983
984/**
985 * unlock_new_inode - clear the I_NEW state and wake up any waiters
986 * @inode: new inode to unlock
987 *
988 * Called when the inode is fully initialised to clear the new state of the
989 * inode and wake up anyone waiting for the inode to finish initialisation.
990 */
991void unlock_new_inode(struct inode *inode)
992{
993 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100994 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100995 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -0400996 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro310fa7a2012-03-10 17:07:28 -0500997 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +1100998 wake_up_bit(&inode->i_state, __I_NEW);
999 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001EXPORT_SYMBOL(unlock_new_inode);
1002
Al Viroc2b6d622018-06-28 15:53:17 -04001003void discard_new_inode(struct inode *inode)
1004{
1005 lockdep_annotate_inode_mutex_key(inode);
1006 spin_lock(&inode->i_lock);
1007 WARN_ON(!(inode->i_state & I_NEW));
1008 inode->i_state &= ~I_NEW;
1009 smp_mb();
1010 wake_up_bit(&inode->i_state, __I_NEW);
1011 spin_unlock(&inode->i_lock);
1012 iput(inode);
1013}
1014EXPORT_SYMBOL(discard_new_inode);
1015
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001016/**
J. Bruce Fields375e2892012-04-18 15:16:33 -04001017 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001018 *
1019 * Lock any non-NULL argument that is not a directory.
1020 * Zero, one or two objects may be locked by this function.
1021 *
J. Bruce Fields375e2892012-04-18 15:16:33 -04001022 * @inode1: first inode to lock
1023 * @inode2: second inode to lock
1024 */
1025void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1026{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001027 if (inode1 > inode2)
1028 swap(inode1, inode2);
1029
1030 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001031 inode_lock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001032 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001033 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001034}
1035EXPORT_SYMBOL(lock_two_nondirectories);
1036
1037/**
1038 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
1039 * @inode1: first inode to unlock
1040 * @inode2: second inode to unlock
1041 */
1042void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1043{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001044 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001045 inode_unlock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001046 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001047 inode_unlock(inode2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001048}
1049EXPORT_SYMBOL(unlock_two_nondirectories);
1050
1051/**
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001052 * inode_insert5 - obtain an inode from a mounted file system
1053 * @inode: pre-allocated inode to use for insert to cache
1054 * @hashval: hash value (usually inode number) to get
1055 * @test: callback used for comparisons between inodes
1056 * @set: callback used to initialize a new struct inode
1057 * @data: opaque data pointer to pass to @test and @set
1058 *
1059 * Search for the inode specified by @hashval and @data in the inode cache,
1060 * and if present it is return it with an increased reference count. This is
1061 * a variant of iget5_locked() for callers that don't want to fail on memory
1062 * allocation of inode.
1063 *
1064 * If the inode is not in cache, insert the pre-allocated inode to cache and
1065 * return it locked, hashed, and with the I_NEW flag set. The file system gets
1066 * to fill it in before unlocking it via unlock_new_inode().
1067 *
1068 * Note both @test and @set are called with the inode_hash_lock held, so can't
1069 * sleep.
1070 */
1071struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
1072 int (*test)(struct inode *, void *),
1073 int (*set)(struct inode *, void *), void *data)
1074{
1075 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1076 struct inode *old;
Miklos Szeredie9505642018-07-24 15:01:55 +02001077 bool creating = inode->i_state & I_CREATING;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001078
1079again:
1080 spin_lock(&inode_hash_lock);
1081 old = find_inode(inode->i_sb, head, test, data);
1082 if (unlikely(old)) {
1083 /*
1084 * Uhhuh, somebody else created the same inode under us.
1085 * Use the old inode instead of the preallocated one.
1086 */
1087 spin_unlock(&inode_hash_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001088 if (IS_ERR(old))
1089 return NULL;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001090 wait_on_inode(old);
1091 if (unlikely(inode_unhashed(old))) {
1092 iput(old);
1093 goto again;
1094 }
1095 return old;
1096 }
1097
1098 if (set && unlikely(set(inode, data))) {
1099 inode = NULL;
1100 goto unlock;
1101 }
1102
1103 /*
1104 * Return the locked inode with I_NEW set, the
1105 * caller is responsible for filling in the contents
1106 */
1107 spin_lock(&inode->i_lock);
1108 inode->i_state |= I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001109 hlist_add_head_rcu(&inode->i_hash, head);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001110 spin_unlock(&inode->i_lock);
Miklos Szeredie9505642018-07-24 15:01:55 +02001111 if (!creating)
1112 inode_sb_list_add(inode);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001113unlock:
1114 spin_unlock(&inode_hash_lock);
1115
1116 return inode;
1117}
1118EXPORT_SYMBOL(inode_insert5);
1119
1120/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001121 * iget5_locked - obtain an inode from a mounted file system
1122 * @sb: super block of file system
1123 * @hashval: hash value (usually inode number) to get
1124 * @test: callback used for comparisons between inodes
1125 * @set: callback used to initialize a new struct inode
1126 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001128 * Search for the inode specified by @hashval and @data in the inode cache,
1129 * and if present it is return it with an increased reference count. This is
1130 * a generalized version of iget_locked() for file systems where the inode
1131 * number is not sufficient for unique identification of an inode.
1132 *
1133 * If the inode is not in cache, allocate a new inode and return it locked,
1134 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1135 * before unlocking it via unlock_new_inode().
1136 *
1137 * Note both @test and @set are called with the inode_hash_lock held, so can't
1138 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001140struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1141 int (*test)(struct inode *, void *),
1142 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143{
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001144 struct inode *inode = ilookup5(sb, hashval, test, data);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001145
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001146 if (!inode) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001147 struct inode *new = alloc_inode(sb);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001148
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001149 if (new) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001150 new->i_state = 0;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001151 inode = inode_insert5(new, hashval, test, set, data);
1152 if (unlikely(inode != new))
Miklos Szeredie9505642018-07-24 15:01:55 +02001153 destroy_inode(new);
Al Viro2864f302016-07-03 23:15:21 -04001154 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 }
1156 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001158EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001160/**
1161 * iget_locked - obtain an inode from a mounted file system
1162 * @sb: super block of file system
1163 * @ino: inode number to get
1164 *
1165 * Search for the inode specified by @ino in the inode cache and if present
1166 * return it with an increased reference count. This is for file systems
1167 * where the inode number is sufficient for unique identification of an inode.
1168 *
1169 * If the inode is not in cache, allocate a new inode and return it locked,
1170 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1171 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001173struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001175 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301176 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001177again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001178 spin_lock(&inode_hash_lock);
1179 inode = find_inode_fast(sb, head, ino);
1180 spin_unlock(&inode_hash_lock);
1181 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001182 if (IS_ERR(inode))
1183 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001184 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001185 if (unlikely(inode_unhashed(inode))) {
1186 iput(inode);
1187 goto again;
1188 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001189 return inode;
1190 }
1191
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 inode = alloc_inode(sb);
1193 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301194 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
Dave Chinner67a23c42011-03-22 22:23:42 +11001196 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 /* We released the lock, so.. */
1198 old = find_inode_fast(sb, head, ino);
1199 if (!old) {
1200 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001201 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001202 inode->i_state = I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001203 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001204 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001205 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001206 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207
1208 /* Return the locked inode with I_NEW set, the
1209 * caller is responsible for filling in the contents
1210 */
1211 return inode;
1212 }
1213
1214 /*
1215 * Uhhuh, somebody else created the same inode under
1216 * us. Use the old inode instead of the one we just
1217 * allocated.
1218 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001219 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 destroy_inode(inode);
Al Viroc2b6d622018-06-28 15:53:17 -04001221 if (IS_ERR(old))
1222 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 inode = old;
1224 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001225 if (unlikely(inode_unhashed(inode))) {
1226 iput(inode);
1227 goto again;
1228 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 }
1230 return inode;
1231}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001232EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001234/*
1235 * search the inode cache for a matching inode number.
1236 * If we find one, then the inode number we are trying to
1237 * allocate is not unique and so we should not use it.
1238 *
1239 * Returns 1 if the inode number is unique, 0 if it is not.
1240 */
1241static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1242{
1243 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001244 struct inode *inode;
1245
David Howells3f19b2a2017-12-01 11:40:16 +00001246 hlist_for_each_entry_rcu(inode, b, i_hash) {
1247 if (inode->i_ino == ino && inode->i_sb == sb)
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001248 return 0;
1249 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001250 return 1;
1251}
1252
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253/**
1254 * iunique - get a unique inode number
1255 * @sb: superblock
1256 * @max_reserved: highest reserved inode number
1257 *
1258 * Obtain an inode number that is unique on the system for a given
1259 * superblock. This is used by file systems that have no natural
1260 * permanent inode numbering system. An inode number is returned that
1261 * is higher than the reserved limit but unique.
1262 *
1263 * BUGS:
1264 * With a large number of inodes live on the file system this function
1265 * currently becomes quite slow.
1266 */
1267ino_t iunique(struct super_block *sb, ino_t max_reserved)
1268{
Jeff Layton866b04f2007-05-08 00:32:29 -07001269 /*
1270 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1271 * error if st_ino won't fit in target struct field. Use 32bit counter
1272 * here to attempt to avoid that.
1273 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001274 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001275 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
David Howells3f19b2a2017-12-01 11:40:16 +00001278 rcu_read_lock();
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001279 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001280 do {
1281 if (counter <= max_reserved)
1282 counter = max_reserved + 1;
1283 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001284 } while (!test_inode_iunique(sb, res));
1285 spin_unlock(&iunique_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001286 rcu_read_unlock();
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001287
1288 return res;
1289}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290EXPORT_SYMBOL(iunique);
1291
1292struct inode *igrab(struct inode *inode)
1293{
Dave Chinner250df6e2011-03-22 22:23:36 +11001294 spin_lock(&inode->i_lock);
1295 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001297 spin_unlock(&inode->i_lock);
1298 } else {
1299 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 /*
1301 * Handle the case where s_op->clear_inode is not been
1302 * called yet, and somebody is calling igrab
1303 * while the inode is getting freed.
1304 */
1305 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001306 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 return inode;
1308}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309EXPORT_SYMBOL(igrab);
1310
1311/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001312 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 * @sb: super block of file system to search
1314 * @hashval: hash value (usually inode number) to search for
1315 * @test: callback used for comparisons between inodes
1316 * @data: opaque data pointer to pass to @test
1317 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001318 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001320 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001321 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001322 * Note: I_NEW is not waited upon so you have to be very careful what you do
1323 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001324 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001325 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001326 */
1327struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1328 int (*test)(struct inode *, void *), void *data)
1329{
1330 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001331 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001332
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001333 spin_lock(&inode_hash_lock);
1334 inode = find_inode(sb, head, test, data);
1335 spin_unlock(&inode_hash_lock);
1336
Al Viroc2b6d622018-06-28 15:53:17 -04001337 return IS_ERR(inode) ? NULL : inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001338}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001339EXPORT_SYMBOL(ilookup5_nowait);
1340
1341/**
1342 * ilookup5 - search for an inode in the inode cache
1343 * @sb: super block of file system to search
1344 * @hashval: hash value (usually inode number) to search for
1345 * @test: callback used for comparisons between inodes
1346 * @data: opaque data pointer to pass to @test
1347 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001348 * Search for the inode specified by @hashval and @data in the inode cache,
1349 * and if the inode is in the cache, return the inode with an incremented
1350 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001351 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001353 * This is a generalized version of ilookup() for file systems where the
1354 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001356 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 */
1358struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1359 int (*test)(struct inode *, void *), void *data)
1360{
Al Viro2864f302016-07-03 23:15:21 -04001361 struct inode *inode;
1362again:
1363 inode = ilookup5_nowait(sb, hashval, test, data);
1364 if (inode) {
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001365 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001366 if (unlikely(inode_unhashed(inode))) {
1367 iput(inode);
1368 goto again;
1369 }
1370 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001371 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373EXPORT_SYMBOL(ilookup5);
1374
1375/**
1376 * ilookup - search for an inode in the inode cache
1377 * @sb: super block of file system to search
1378 * @ino: inode number to search for
1379 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001380 * Search for the inode @ino in the inode cache, and if the inode is in the
1381 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 */
1383struct inode *ilookup(struct super_block *sb, unsigned long ino)
1384{
1385 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001386 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001387again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001388 spin_lock(&inode_hash_lock);
1389 inode = find_inode_fast(sb, head, ino);
1390 spin_unlock(&inode_hash_lock);
1391
Al Viro2864f302016-07-03 23:15:21 -04001392 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001393 if (IS_ERR(inode))
1394 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001395 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001396 if (unlikely(inode_unhashed(inode))) {
1397 iput(inode);
1398 goto again;
1399 }
1400 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001401 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403EXPORT_SYMBOL(ilookup);
1404
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001405/**
1406 * find_inode_nowait - find an inode in the inode cache
1407 * @sb: super block of file system to search
1408 * @hashval: hash value (usually inode number) to search for
1409 * @match: callback used for comparisons between inodes
1410 * @data: opaque data pointer to pass to @match
1411 *
1412 * Search for the inode specified by @hashval and @data in the inode
1413 * cache, where the helper function @match will return 0 if the inode
1414 * does not match, 1 if the inode does match, and -1 if the search
1415 * should be stopped. The @match function must be responsible for
1416 * taking the i_lock spin_lock and checking i_state for an inode being
1417 * freed or being initialized, and incrementing the reference count
1418 * before returning 1. It also must not sleep, since it is called with
1419 * the inode_hash_lock spinlock held.
1420 *
1421 * This is a even more generalized version of ilookup5() when the
1422 * function must never block --- find_inode() can block in
1423 * __wait_on_freeing_inode() --- or when the caller can not increment
1424 * the reference count because the resulting iput() might cause an
1425 * inode eviction. The tradeoff is that the @match funtion must be
1426 * very carefully implemented.
1427 */
1428struct inode *find_inode_nowait(struct super_block *sb,
1429 unsigned long hashval,
1430 int (*match)(struct inode *, unsigned long,
1431 void *),
1432 void *data)
1433{
1434 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1435 struct inode *inode, *ret_inode = NULL;
1436 int mval;
1437
1438 spin_lock(&inode_hash_lock);
1439 hlist_for_each_entry(inode, head, i_hash) {
1440 if (inode->i_sb != sb)
1441 continue;
1442 mval = match(inode, hashval, data);
1443 if (mval == 0)
1444 continue;
1445 if (mval == 1)
1446 ret_inode = inode;
1447 goto out;
1448 }
1449out:
1450 spin_unlock(&inode_hash_lock);
1451 return ret_inode;
1452}
1453EXPORT_SYMBOL(find_inode_nowait);
1454
David Howells3f19b2a2017-12-01 11:40:16 +00001455/**
1456 * find_inode_rcu - find an inode in the inode cache
1457 * @sb: Super block of file system to search
1458 * @hashval: Key to hash
1459 * @test: Function to test match on an inode
1460 * @data: Data for test function
1461 *
1462 * Search for the inode specified by @hashval and @data in the inode cache,
1463 * where the helper function @test will return 0 if the inode does not match
1464 * and 1 if it does. The @test function must be responsible for taking the
1465 * i_lock spin_lock and checking i_state for an inode being freed or being
1466 * initialized.
1467 *
1468 * If successful, this will return the inode for which the @test function
1469 * returned 1 and NULL otherwise.
1470 *
1471 * The @test function is not permitted to take a ref on any inode presented.
1472 * It is also not permitted to sleep.
1473 *
1474 * The caller must hold the RCU read lock.
1475 */
1476struct inode *find_inode_rcu(struct super_block *sb, unsigned long hashval,
1477 int (*test)(struct inode *, void *), void *data)
1478{
1479 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1480 struct inode *inode;
1481
1482 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1483 "suspicious find_inode_rcu() usage");
1484
1485 hlist_for_each_entry_rcu(inode, head, i_hash) {
1486 if (inode->i_sb == sb &&
1487 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)) &&
1488 test(inode, data))
1489 return inode;
1490 }
1491 return NULL;
1492}
1493EXPORT_SYMBOL(find_inode_rcu);
1494
1495/**
1496 * find_inode_by_rcu - Find an inode in the inode cache
1497 * @sb: Super block of file system to search
1498 * @ino: The inode number to match
1499 *
1500 * Search for the inode specified by @hashval and @data in the inode cache,
1501 * where the helper function @test will return 0 if the inode does not match
1502 * and 1 if it does. The @test function must be responsible for taking the
1503 * i_lock spin_lock and checking i_state for an inode being freed or being
1504 * initialized.
1505 *
1506 * If successful, this will return the inode for which the @test function
1507 * returned 1 and NULL otherwise.
1508 *
1509 * The @test function is not permitted to take a ref on any inode presented.
1510 * It is also not permitted to sleep.
1511 *
1512 * The caller must hold the RCU read lock.
1513 */
1514struct inode *find_inode_by_ino_rcu(struct super_block *sb,
1515 unsigned long ino)
1516{
1517 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1518 struct inode *inode;
1519
1520 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1521 "suspicious find_inode_by_ino_rcu() usage");
1522
1523 hlist_for_each_entry_rcu(inode, head, i_hash) {
1524 if (inode->i_ino == ino &&
1525 inode->i_sb == sb &&
1526 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)))
1527 return inode;
1528 }
1529 return NULL;
1530}
1531EXPORT_SYMBOL(find_inode_by_ino_rcu);
1532
Al Viro261bca82008-12-30 01:48:21 -05001533int insert_inode_locked(struct inode *inode)
1534{
1535 struct super_block *sb = inode->i_sb;
1536 ino_t ino = inode->i_ino;
1537 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001538
Al Viro261bca82008-12-30 01:48:21 -05001539 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001540 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001541 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001542 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001543 if (old->i_ino != ino)
1544 continue;
1545 if (old->i_sb != sb)
1546 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001547 spin_lock(&old->i_lock);
1548 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1549 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001550 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001551 }
Al Viro72a43d62009-05-13 19:13:40 +01001552 break;
1553 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001554 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001555 spin_lock(&inode->i_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001556 inode->i_state |= I_NEW | I_CREATING;
David Howells3f19b2a2017-12-01 11:40:16 +00001557 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001558 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001559 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001560 return 0;
1561 }
Al Viroc2b6d622018-06-28 15:53:17 -04001562 if (unlikely(old->i_state & I_CREATING)) {
1563 spin_unlock(&old->i_lock);
1564 spin_unlock(&inode_hash_lock);
1565 return -EBUSY;
1566 }
Al Viro261bca82008-12-30 01:48:21 -05001567 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001568 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001569 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001570 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001571 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001572 iput(old);
1573 return -EBUSY;
1574 }
1575 iput(old);
1576 }
1577}
Al Viro261bca82008-12-30 01:48:21 -05001578EXPORT_SYMBOL(insert_inode_locked);
1579
1580int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1581 int (*test)(struct inode *, void *), void *data)
1582{
Al Viroc2b6d622018-06-28 15:53:17 -04001583 struct inode *old;
1584
1585 inode->i_state |= I_CREATING;
1586 old = inode_insert5(inode, hashval, test, NULL, data);
Al Viro261bca82008-12-30 01:48:21 -05001587
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001588 if (old != inode) {
Al Viro261bca82008-12-30 01:48:21 -05001589 iput(old);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001590 return -EBUSY;
Al Viro261bca82008-12-30 01:48:21 -05001591 }
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001592 return 0;
Al Viro261bca82008-12-30 01:48:21 -05001593}
Al Viro261bca82008-12-30 01:48:21 -05001594EXPORT_SYMBOL(insert_inode_locked4);
1595
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596
Al Viro45321ac2010-06-07 13:43:19 -04001597int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598{
Al Viro45321ac2010-06-07 13:43:19 -04001599 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601EXPORT_SYMBOL(generic_delete_inode);
1602
Al Viro45321ac2010-06-07 13:43:19 -04001603/*
Al Viro45321ac2010-06-07 13:43:19 -04001604 * Called when we're dropping the last reference
1605 * to an inode.
1606 *
1607 * Call the FS "drop_inode()" function, defaulting to
1608 * the legacy UNIX filesystem behaviour. If it tells
1609 * us to evict inode, do so. Otherwise, retain inode
1610 * in cache if fs is alive, sync and evict if fs is
1611 * shutting down.
1612 */
1613static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614{
1615 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001616 const struct super_operations *op = inode->i_sb->s_op;
David Howells3f19b2a2017-12-01 11:40:16 +00001617 unsigned long state;
Al Viro45321ac2010-06-07 13:43:19 -04001618 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619
Dave Chinner250df6e2011-03-22 22:23:36 +11001620 WARN_ON(inode->i_state & I_NEW);
1621
Al Viroe7f59092011-07-07 15:45:59 -04001622 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001623 drop = op->drop_inode(inode);
1624 else
1625 drop = generic_drop_inode(inode);
1626
Hao Li88149082020-12-08 10:08:43 +08001627 if (!drop &&
1628 !(inode->i_state & I_DONTCACHE) &&
1629 (sb->s_flags & SB_ACTIVE)) {
Jan Kara4eff96d2012-11-26 16:29:51 -08001630 inode_add_lru(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001631 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001632 return;
1633 }
1634
David Howells3f19b2a2017-12-01 11:40:16 +00001635 state = inode->i_state;
Al Viro45321ac2010-06-07 13:43:19 -04001636 if (!drop) {
David Howells3f19b2a2017-12-01 11:40:16 +00001637 WRITE_ONCE(inode->i_state, state | I_WILL_FREE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001638 spin_unlock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001639
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 write_inode_now(inode, 1);
David Howells3f19b2a2017-12-01 11:40:16 +00001641
Dave Chinner250df6e2011-03-22 22:23:36 +11001642 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001643 state = inode->i_state;
1644 WARN_ON(state & I_NEW);
1645 state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001647
David Howells3f19b2a2017-12-01 11:40:16 +00001648 WRITE_ONCE(inode->i_state, state | I_FREEING);
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001649 if (!list_empty(&inode->i_lru))
1650 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001651 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001652
1653 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654}
1655
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301657 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 * @inode: inode to put
1659 *
1660 * Puts an inode, dropping its usage count. If the inode use count hits
1661 * zero, the inode is then freed and may also be destroyed.
1662 *
1663 * Consequently, iput() can sleep.
1664 */
1665void iput(struct inode *inode)
1666{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001667 if (!inode)
1668 return;
1669 BUG_ON(inode->i_state & I_CLEAR);
1670retry:
1671 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1672 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1673 atomic_inc(&inode->i_count);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001674 spin_unlock(&inode->i_lock);
1675 trace_writeback_lazytime_iput(inode);
1676 mark_inode_dirty_sync(inode);
1677 goto retry;
1678 }
1679 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 }
1681}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682EXPORT_SYMBOL(iput);
1683
Carlos Maiolino30460e12020-01-09 14:30:41 +01001684#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685/**
1686 * bmap - find a block number in a file
Carlos Maiolino30460e12020-01-09 14:30:41 +01001687 * @inode: inode owning the block number being requested
1688 * @block: pointer containing the block to find
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 *
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001690 * Replaces the value in ``*block`` with the block number on the device holding
Carlos Maiolino30460e12020-01-09 14:30:41 +01001691 * corresponding to the requested block number in the file.
1692 * That is, asked for block 4 of inode 1 the function will replace the
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001693 * 4 in ``*block``, with disk block relative to the disk start that holds that
Carlos Maiolino30460e12020-01-09 14:30:41 +01001694 * block of the file.
1695 *
1696 * Returns -EINVAL in case of error, 0 otherwise. If mapping falls into a
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001697 * hole, returns 0 and ``*block`` is also set to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 */
Carlos Maiolino30460e12020-01-09 14:30:41 +01001699int bmap(struct inode *inode, sector_t *block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700{
Carlos Maiolino30460e12020-01-09 14:30:41 +01001701 if (!inode->i_mapping->a_ops->bmap)
1702 return -EINVAL;
1703
1704 *block = inode->i_mapping->a_ops->bmap(inode->i_mapping, *block);
1705 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707EXPORT_SYMBOL(bmap);
Carlos Maiolino30460e12020-01-09 14:30:41 +01001708#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001710/*
1711 * With relative atime, only update atime if the previous atime is
1712 * earlier than either the ctime or mtime or if at least a day has
1713 * passed since the last atime update.
1714 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001715static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001716 struct timespec64 now)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001717{
1718
Miklos Szeredic6718542018-07-18 15:44:43 +02001719 if (!(mnt->mnt_flags & MNT_RELATIME))
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001720 return 1;
1721 /*
1722 * Is mtime younger than atime? If yes, update atime:
1723 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001724 if (timespec64_compare(&inode->i_mtime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001725 return 1;
1726 /*
1727 * Is ctime younger than atime? If yes, update atime:
1728 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001729 if (timespec64_compare(&inode->i_ctime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001730 return 1;
1731
1732 /*
1733 * Is the previous atime value older than a day? If yes,
1734 * update atime:
1735 */
1736 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1737 return 1;
1738 /*
1739 * Good, we can skip the atime update:
1740 */
1741 return 0;
1742}
1743
Deepa Dinamani95582b02018-05-08 19:36:02 -07001744int generic_update_time(struct inode *inode, struct timespec64 *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001745{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001746 int iflags = I_DIRTY_TIME;
Jeff Laytone38cf302017-12-11 06:35:22 -05001747 bool dirty = false;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001748
1749 if (flags & S_ATIME)
1750 inode->i_atime = *time;
1751 if (flags & S_VERSION)
Jeff Laytone38cf302017-12-11 06:35:22 -05001752 dirty = inode_maybe_inc_iversion(inode, false);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001753 if (flags & S_CTIME)
1754 inode->i_ctime = *time;
1755 if (flags & S_MTIME)
1756 inode->i_mtime = *time;
Jeff Laytone38cf302017-12-11 06:35:22 -05001757 if ((flags & (S_ATIME | S_CTIME | S_MTIME)) &&
1758 !(inode->i_sb->s_flags & SB_LAZYTIME))
1759 dirty = true;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001760
Jeff Laytone38cf302017-12-11 06:35:22 -05001761 if (dirty)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001762 iflags |= I_DIRTY_SYNC;
1763 __mark_inode_dirty(inode, iflags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001764 return 0;
1765}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001766EXPORT_SYMBOL(generic_update_time);
1767
1768/*
1769 * This does the actual work of updating an inodes time or version. Must have
1770 * had called mnt_want_write() before calling this.
1771 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001772static int update_time(struct inode *inode, struct timespec64 *time, int flags)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001773{
Deepa Dinamani23b424d2019-12-02 21:19:45 -08001774 if (inode->i_op->update_time)
1775 return inode->i_op->update_time(inode, time, flags);
1776 return generic_update_time(inode, time, flags);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001777}
Josef Bacikc3b2da32012-03-26 09:59:21 -04001778
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779/**
Christoph Hellwig869243a2006-01-09 20:52:03 -08001780 * touch_atime - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001781 * @path: the &struct path to update
Randy Dunlap30fdc8e2015-11-09 14:57:58 -08001782 * @inode: inode to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 *
1784 * Update the accessed time on an inode and mark it for writeback.
1785 * This function automatically handles read only file systems and media,
1786 * as well as the "noatime" flag and inode specific "noatime" markers.
1787 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001788bool atime_needs_update(const struct path *path, struct inode *inode)
NeilBrown8fa9dd22015-03-23 13:37:40 +11001789{
1790 struct vfsmount *mnt = path->mnt;
Deepa Dinamani95582b02018-05-08 19:36:02 -07001791 struct timespec64 now;
NeilBrown8fa9dd22015-03-23 13:37:40 +11001792
1793 if (inode->i_flags & S_NOATIME)
1794 return false;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001795
1796 /* Atime updates will likely cause i_uid and i_gid to be written
1797 * back improprely if their true value is unknown to the vfs.
1798 */
1799 if (HAS_UNMAPPED_ID(inode))
1800 return false;
1801
NeilBrown8fa9dd22015-03-23 13:37:40 +11001802 if (IS_NOATIME(inode))
1803 return false;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001804 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001805 return false;
1806
1807 if (mnt->mnt_flags & MNT_NOATIME)
1808 return false;
1809 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1810 return false;
1811
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001812 now = current_time(inode);
NeilBrown8fa9dd22015-03-23 13:37:40 +11001813
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001814 if (!relatime_need_update(mnt, inode, now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001815 return false;
1816
Deepa Dinamani95582b02018-05-08 19:36:02 -07001817 if (timespec64_equal(&inode->i_atime, &now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001818 return false;
1819
1820 return true;
1821}
1822
Al Virobadcf2b2013-07-16 18:15:46 +04001823void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824{
Al Viro68ac1232012-03-15 08:21:57 -04001825 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001826 struct inode *inode = d_inode(path->dentry);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001827 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828
Miklos Szeredic6718542018-07-18 15:44:43 +02001829 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001830 return;
1831
Jan Kara5d37e9e2012-06-12 16:20:36 +02001832 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001833 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001834
NeilBrown8fa9dd22015-03-23 13:37:40 +11001835 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001836 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001837 /*
1838 * File systems can error out when updating inodes if they need to
1839 * allocate new space to modify an inode (such is the case for
1840 * Btrfs), but since we touch atime while walking down the path we
1841 * really don't care if we failed to update the atime of the file,
1842 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001843 * We may also fail on filesystems that have the ability to make parts
1844 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001845 */
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001846 now = current_time(inode);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001847 update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001848 __mnt_drop_write(mnt);
1849skip_update:
1850 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001852EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
Cong Wang3ed37642012-05-15 14:57:33 +08001854/*
1855 * The logic we want is
1856 *
1857 * if suid or (sgid and xgrp)
1858 * remove privs
1859 */
1860int should_remove_suid(struct dentry *dentry)
1861{
David Howellsdf2b1af2015-03-17 22:26:15 +00001862 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001863 int kill = 0;
1864
1865 /* suid always must be killed */
1866 if (unlikely(mode & S_ISUID))
1867 kill = ATTR_KILL_SUID;
1868
1869 /*
1870 * sgid without any exec bits is just a mandatory locking mark; leave
1871 * it alone. If some exec bits are set, it's a real sgid; kill it.
1872 */
1873 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1874 kill |= ATTR_KILL_SGID;
1875
1876 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1877 return kill;
1878
1879 return 0;
1880}
1881EXPORT_SYMBOL(should_remove_suid);
1882
Jan Karadbfae0c2015-05-21 16:05:54 +02001883/*
1884 * Return mask of changes for notify_change() that need to be done as a
1885 * response to write or truncate. Return 0 if nothing has to be changed.
1886 * Negative value on error (change should be denied).
1887 */
Jan Kara45f147a2015-05-21 16:05:55 +02001888int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001889{
Jan Karadbfae0c2015-05-21 16:05:54 +02001890 struct inode *inode = d_inode(dentry);
1891 int mask = 0;
1892 int ret;
1893
1894 if (IS_NOSEC(inode))
1895 return 0;
1896
1897 mask = should_remove_suid(dentry);
1898 ret = security_inode_need_killpriv(dentry);
1899 if (ret < 0)
1900 return ret;
1901 if (ret)
1902 mask |= ATTR_KILL_PRIV;
1903 return mask;
1904}
Jan Karadbfae0c2015-05-21 16:05:54 +02001905
1906static int __remove_privs(struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001907{
1908 struct iattr newattrs;
1909
1910 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001911 /*
1912 * Note we call this on write, so notify_change will not
1913 * encounter any conflicting delegations:
1914 */
1915 return notify_change(dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001916}
1917
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001918/*
1919 * Remove special file priviledges (suid, capabilities) when file is written
1920 * to or truncated.
1921 */
1922int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001923{
Miklos Szeredic1892c32016-08-03 13:44:27 +02001924 struct dentry *dentry = file_dentry(file);
1925 struct inode *inode = file_inode(file);
Jan Karadbfae0c2015-05-21 16:05:54 +02001926 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001927 int error = 0;
1928
Alexander Lochmannf69e7492018-12-14 11:55:52 +01001929 /*
1930 * Fast path for nothing security related.
1931 * As well for non-regular files, e.g. blkdev inodes.
1932 * For example, blkdev_write_iter() might get here
1933 * trying to remove privs which it is not allowed to.
1934 */
1935 if (IS_NOSEC(inode) || !S_ISREG(inode->i_mode))
Cong Wang3ed37642012-05-15 14:57:33 +08001936 return 0;
1937
Miklos Szeredic1892c32016-08-03 13:44:27 +02001938 kill = dentry_needs_remove_privs(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001939 if (kill < 0)
1940 return kill;
1941 if (kill)
1942 error = __remove_privs(dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001943 if (!error)
1944 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001945
1946 return error;
1947}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001948EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001949
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001951 * file_update_time - update mtime and ctime time
1952 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001954 * Update the mtime and ctime members of an inode and mark the inode
1955 * for writeback. Note that this function is meant exclusively for
1956 * usage in the file write path of filesystems, and filesystems may
1957 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001958 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001959 * timestamps are handled by the server. This can return an error for
1960 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 */
1962
Josef Bacikc3b2da32012-03-26 09:59:21 -04001963int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964{
Al Viro496ad9a2013-01-23 17:07:38 -05001965 struct inode *inode = file_inode(file);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001966 struct timespec64 now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001967 int sync_it = 0;
1968 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
Andi Kleence06e0b2009-09-18 13:05:48 -07001970 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001972 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001973
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001974 now = current_time(inode);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001975 if (!timespec64_equal(&inode->i_mtime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001976 sync_it = S_MTIME;
1977
Deepa Dinamani95582b02018-05-08 19:36:02 -07001978 if (!timespec64_equal(&inode->i_ctime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001979 sync_it |= S_CTIME;
1980
Jeff Laytone38cf302017-12-11 06:35:22 -05001981 if (IS_I_VERSION(inode) && inode_iversion_need_inc(inode))
Andi Kleence06e0b2009-09-18 13:05:48 -07001982 sync_it |= S_VERSION;
1983
1984 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001985 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986
Andi Kleence06e0b2009-09-18 13:05:48 -07001987 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02001988 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001989 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990
Josef Bacikc3b2da32012-03-26 09:59:21 -04001991 ret = update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02001992 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001993
1994 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995}
Christoph Hellwig870f4812006-01-09 20:52:01 -08001996EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997
Amir Goldsteine38f7f52019-06-05 08:04:49 -07001998/* Caller must hold the file's inode lock */
1999int file_modified(struct file *file)
2000{
2001 int err;
2002
2003 /*
2004 * Clear the security bits if the process is not being run by root.
2005 * This keeps people from modifying setuid and setgid binaries.
2006 */
2007 err = file_remove_privs(file);
2008 if (err)
2009 return err;
2010
2011 if (unlikely(file->f_mode & FMODE_NOCMTIME))
2012 return 0;
2013
2014 return file_update_time(file);
2015}
2016EXPORT_SYMBOL(file_modified);
2017
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018int inode_needs_sync(struct inode *inode)
2019{
2020 if (IS_SYNC(inode))
2021 return 1;
2022 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
2023 return 1;
2024 return 0;
2025}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026EXPORT_SYMBOL(inode_needs_sync);
2027
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07002029 * If we try to find an inode in the inode hash while it is being
2030 * deleted, we have to wait until the filesystem completes its
2031 * deletion before reporting that it isn't found. This function waits
2032 * until the deletion _might_ have completed. Callers are responsible
2033 * to recheck inode state.
2034 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002035 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11002036 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
2037 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 */
2039static void __wait_on_freeing_inode(struct inode *inode)
2040{
2041 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002042 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
2043 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Ingo Molnar21417132017-03-05 11:25:39 +01002044 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11002045 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11002046 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 schedule();
Ingo Molnar21417132017-03-05 11:25:39 +01002048 finish_wait(wq, &wait.wq_entry);
Dave Chinner67a23c42011-03-22 22:23:42 +11002049 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050}
2051
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052static __initdata unsigned long ihash_entries;
2053static int __init set_ihash_entries(char *str)
2054{
2055 if (!str)
2056 return 0;
2057 ihash_entries = simple_strtoul(str, &str, 0);
2058 return 1;
2059}
2060__setup("ihash_entries=", set_ihash_entries);
2061
2062/*
2063 * Initialize the waitqueues and inode hash table.
2064 */
2065void __init inode_init_early(void)
2066{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 /* If hashes are distributed across NUMA nodes, defer
2068 * hash allocation until vmalloc space is available.
2069 */
2070 if (hashdist)
2071 return;
2072
2073 inode_hashtable =
2074 alloc_large_system_hash("Inode-cache",
2075 sizeof(struct hlist_head),
2076 ihash_entries,
2077 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002078 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 &i_hash_shift,
2080 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002081 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083}
2084
Denis Cheng74bf17c2007-10-16 23:26:30 -07002085void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08002088 inode_cachep = kmem_cache_create("inode_cache",
2089 sizeof(struct inode),
2090 0,
2091 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
Vladimir Davydov5d097052016-01-14 15:18:21 -08002092 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
Paul Mundt20c2df82007-07-20 10:11:58 +09002093 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094
2095 /* Hash may have been set up in inode_init_early */
2096 if (!hashdist)
2097 return;
2098
2099 inode_hashtable =
2100 alloc_large_system_hash("Inode-cache",
2101 sizeof(struct hlist_head),
2102 ihash_entries,
2103 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002104 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 &i_hash_shift,
2106 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002107 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109}
2110
2111void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
2112{
2113 inode->i_mode = mode;
2114 if (S_ISCHR(mode)) {
2115 inode->i_fop = &def_chr_fops;
2116 inode->i_rdev = rdev;
2117 } else if (S_ISBLK(mode)) {
2118 inode->i_fop = &def_blk_fops;
2119 inode->i_rdev = rdev;
2120 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04002121 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05002123 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07002125 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
2126 " inode %s:%lu\n", mode, inode->i_sb->s_id,
2127 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128}
2129EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002130
2131/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00002132 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002133 * @inode: New inode
2134 * @dir: Directory inode
2135 * @mode: mode of the new inode
2136 */
2137void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04002138 umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002139{
2140 inode->i_uid = current_fsuid();
2141 if (dir && dir->i_mode & S_ISGID) {
2142 inode->i_gid = dir->i_gid;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002143
2144 /* Directories are special, and always inherit S_ISGID */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002145 if (S_ISDIR(mode))
2146 mode |= S_ISGID;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002147 else if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP) &&
2148 !in_group_p(inode->i_gid) &&
2149 !capable_wrt_inode_uidgid(dir, CAP_FSETID))
2150 mode &= ~S_ISGID;
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002151 } else
2152 inode->i_gid = current_fsgid();
2153 inode->i_mode = mode;
2154}
2155EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07002156
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002157/**
2158 * inode_owner_or_capable - check current task permissions to inode
2159 * @inode: inode being checked
2160 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002161 * Return true if current either has CAP_FOWNER in a namespace with the
2162 * inode owner uid mapped, or owns the file.
Serge E. Hallyne795b712011-03-23 16:43:25 -07002163 */
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002164bool inode_owner_or_capable(const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07002165{
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002166 struct user_namespace *ns;
2167
Eric W. Biederman92361632012-02-08 07:07:50 -08002168 if (uid_eq(current_fsuid(), inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002169 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002170
2171 ns = current_user_ns();
Kees Cookcc658db2017-06-21 09:53:06 -07002172 if (kuid_has_mapping(ns, inode->i_uid) && ns_capable(ns, CAP_FOWNER))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002173 return true;
2174 return false;
2175}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002176EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002177
2178/*
2179 * Direct i/o helper functions
2180 */
2181static void __inode_dio_wait(struct inode *inode)
2182{
2183 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2184 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2185
2186 do {
Ingo Molnar21417132017-03-05 11:25:39 +01002187 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002188 if (atomic_read(&inode->i_dio_count))
2189 schedule();
2190 } while (atomic_read(&inode->i_dio_count));
Ingo Molnar21417132017-03-05 11:25:39 +01002191 finish_wait(wq, &q.wq_entry);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002192}
2193
2194/**
2195 * inode_dio_wait - wait for outstanding DIO requests to finish
2196 * @inode: inode to wait for
2197 *
2198 * Waits for all pending direct I/O requests to finish so that we can
2199 * proceed with a truncate or equivalent operation.
2200 *
2201 * Must be called under a lock that serializes taking new references
2202 * to i_dio_count, usually by inode->i_mutex.
2203 */
2204void inode_dio_wait(struct inode *inode)
2205{
2206 if (atomic_read(&inode->i_dio_count))
2207 __inode_dio_wait(inode);
2208}
2209EXPORT_SYMBOL(inode_dio_wait);
2210
2211/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002212 * inode_set_flags - atomically set some inode flags
2213 *
2214 * Note: the caller should be holding i_mutex, or else be sure that
2215 * they have exclusive access to the inode structure (i.e., while the
2216 * inode is being instantiated). The reason for the cmpxchg() loop
2217 * --- which wouldn't be necessary if all code paths which modify
2218 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002219 * code path which doesn't today so we use cmpxchg() out of an abundance
2220 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002221 *
2222 * In the long run, i_mutex is overkill, and we should probably look
2223 * at using the i_lock spinlock to protect i_flags, and then make sure
2224 * it is so documented in include/linux/fs.h and that all code follows
2225 * the locking convention!!
2226 */
2227void inode_set_flags(struct inode *inode, unsigned int flags,
2228 unsigned int mask)
2229{
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002230 WARN_ON_ONCE(flags & ~mask);
Vineet Guptaa9057372019-03-05 15:41:52 -08002231 set_mask_bits(&inode->i_flags, mask, flags);
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002232}
2233EXPORT_SYMBOL(inode_set_flags);
Al Viro21fc61c2015-11-17 01:07:57 -05002234
2235void inode_nohighmem(struct inode *inode)
2236{
2237 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2238}
2239EXPORT_SYMBOL(inode_nohighmem);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002240
2241/**
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002242 * timestamp_truncate - Truncate timespec to a granularity
2243 * @t: Timespec
2244 * @inode: inode being updated
2245 *
2246 * Truncate a timespec to the granularity supported by the fs
2247 * containing the inode. Always rounds down. gran must
2248 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2249 */
2250struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode)
2251{
2252 struct super_block *sb = inode->i_sb;
2253 unsigned int gran = sb->s_time_gran;
2254
2255 t.tv_sec = clamp(t.tv_sec, sb->s_time_min, sb->s_time_max);
2256 if (unlikely(t.tv_sec == sb->s_time_max || t.tv_sec == sb->s_time_min))
2257 t.tv_nsec = 0;
2258
2259 /* Avoid division in the common cases 1 ns and 1 s. */
2260 if (gran == 1)
2261 ; /* nothing */
2262 else if (gran == NSEC_PER_SEC)
2263 t.tv_nsec = 0;
2264 else if (gran > 1 && gran < NSEC_PER_SEC)
2265 t.tv_nsec -= t.tv_nsec % gran;
2266 else
2267 WARN(1, "invalid file time granularity: %u", gran);
2268 return t;
2269}
2270EXPORT_SYMBOL(timestamp_truncate);
2271
2272/**
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002273 * current_time - Return FS time
2274 * @inode: inode.
2275 *
2276 * Return the current time truncated to the time granularity supported by
2277 * the fs.
2278 *
2279 * Note that inode and inode->sb cannot be NULL.
2280 * Otherwise, the function warns and returns time without truncation.
2281 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07002282struct timespec64 current_time(struct inode *inode)
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002283{
Arnd Bergmannd651d162018-12-05 11:14:27 +11002284 struct timespec64 now;
2285
2286 ktime_get_coarse_real_ts64(&now);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002287
2288 if (unlikely(!inode->i_sb)) {
2289 WARN(1, "current_time() called with uninitialized super_block in the inode");
2290 return now;
2291 }
2292
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002293 return timestamp_truncate(now, inode);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002294}
2295EXPORT_SYMBOL(current_time);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002296
2297/*
2298 * Generic function to check FS_IOC_SETFLAGS values and reject any invalid
2299 * configurations.
2300 *
2301 * Note: the caller should be holding i_mutex, or else be sure that they have
2302 * exclusive access to the inode structure.
2303 */
2304int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
2305 unsigned int flags)
2306{
2307 /*
2308 * The IMMUTABLE and APPEND_ONLY flags can only be changed by
2309 * the relevant capability.
2310 *
2311 * This test looks nicer. Thanks to Pauline Middelink
2312 */
2313 if ((flags ^ oldflags) & (FS_APPEND_FL | FS_IMMUTABLE_FL) &&
2314 !capable(CAP_LINUX_IMMUTABLE))
2315 return -EPERM;
2316
Daniel Rosenberg6e1918c2020-01-20 14:31:56 -08002317 return fscrypt_prepare_setflags(inode, oldflags, flags);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002318}
2319EXPORT_SYMBOL(vfs_ioc_setflags_prepare);
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002320
2321/*
2322 * Generic function to check FS_IOC_FSSETXATTR values and reject any invalid
2323 * configurations.
2324 *
2325 * Note: the caller should be holding i_mutex, or else be sure that they have
2326 * exclusive access to the inode structure.
2327 */
2328int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
2329 struct fsxattr *fa)
2330{
2331 /*
2332 * Can't modify an immutable/append-only file unless we have
2333 * appropriate permission.
2334 */
2335 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2336 (FS_XFLAG_IMMUTABLE | FS_XFLAG_APPEND) &&
2337 !capable(CAP_LINUX_IMMUTABLE))
2338 return -EPERM;
2339
Darrick J. Wongf9914922019-07-01 08:25:35 -07002340 /*
2341 * Project Quota ID state is only allowed to change from within the init
2342 * namespace. Enforce that restriction only if we are trying to change
2343 * the quota ID state. Everything else is allowed in user namespaces.
2344 */
2345 if (current_user_ns() != &init_user_ns) {
2346 if (old_fa->fsx_projid != fa->fsx_projid)
2347 return -EINVAL;
2348 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2349 FS_XFLAG_PROJINHERIT)
2350 return -EINVAL;
2351 }
2352
Darrick J. Wongca29be72019-07-01 08:25:36 -07002353 /* Check extent size hints. */
2354 if ((fa->fsx_xflags & FS_XFLAG_EXTSIZE) && !S_ISREG(inode->i_mode))
2355 return -EINVAL;
2356
2357 if ((fa->fsx_xflags & FS_XFLAG_EXTSZINHERIT) &&
2358 !S_ISDIR(inode->i_mode))
2359 return -EINVAL;
2360
2361 if ((fa->fsx_xflags & FS_XFLAG_COWEXTSIZE) &&
2362 !S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
2363 return -EINVAL;
2364
Darrick J. Wongdbc77f32019-07-01 08:25:36 -07002365 /*
2366 * It is only valid to set the DAX flag on regular files and
2367 * directories on filesystems.
2368 */
2369 if ((fa->fsx_xflags & FS_XFLAG_DAX) &&
2370 !(S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode)))
2371 return -EINVAL;
2372
Darrick J. Wongca29be72019-07-01 08:25:36 -07002373 /* Extent size hints of zero turn off the flags. */
2374 if (fa->fsx_extsize == 0)
2375 fa->fsx_xflags &= ~(FS_XFLAG_EXTSIZE | FS_XFLAG_EXTSZINHERIT);
2376 if (fa->fsx_cowextsize == 0)
2377 fa->fsx_xflags &= ~FS_XFLAG_COWEXTSIZE;
2378
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002379 return 0;
2380}
2381EXPORT_SYMBOL(vfs_ioc_fssetxattr_check);