blob: 9d78c37b00b817d0f4061441806e4d0aa5400f4b [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;
158 inode->i_bdev = NULL;
159 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400160 inode->i_link = NULL;
Al Viro84e710d2016-04-15 00:58:55 -0400161 inode->i_dir_seq = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100162 inode->i_rdev = 0;
163 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500164
Tahsin Erdogan3d65ae42016-02-16 13:34:39 -0800165#ifdef CONFIG_CGROUP_WRITEBACK
166 inode->i_wb_frn_winner = 0;
167 inode->i_wb_frn_avg_time = 0;
168 inode->i_wb_frn_history = 0;
169#endif
170
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500171 if (security_inode_alloc(inode))
Christoph Hellwig54e34622009-08-07 14:38:25 -0300172 goto out;
David Chinner2cb15992008-10-30 17:32:23 +1100173 spin_lock_init(&inode->i_lock);
174 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
175
Al Viro9902af72016-04-15 15:08:36 -0400176 init_rwsem(&inode->i_rwsem);
177 lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
David Chinner2cb15992008-10-30 17:32:23 +1100178
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400179 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100180
181 mapping->a_ops = &empty_aops;
182 mapping->host = inode;
183 mapping->flags = 0;
Matthew Wilcox (Oracle)01c70262020-10-15 20:06:00 -0700184 if (sb->s_type->fs_flags & FS_THP_SUPPORT)
185 __set_bit(AS_THP_SUPPORT, &mapping->flags);
Darrick J. Wong829bc7872018-05-30 19:43:53 -0700186 mapping->wb_err = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700187 atomic_set(&mapping->i_mmap_writable, 0);
Song Liu09d91cd2019-09-23 15:38:03 -0700188#ifdef CONFIG_READ_ONLY_THP_FOR_FS
189 atomic_set(&mapping->nr_thps, 0);
190#endif
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800191 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800192 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100193 mapping->writeback_index = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100194 inode->i_private = NULL;
195 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400196 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400197#ifdef CONFIG_FS_POSIX_ACL
198 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
199#endif
David Chinner2cb15992008-10-30 17:32:23 +1100200
Eric Paris3be25f42009-05-21 17:01:26 -0400201#ifdef CONFIG_FSNOTIFY
202 inode->i_fsnotify_mask = 0;
203#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500204 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100205 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400206
Christoph Hellwig54e34622009-08-07 14:38:25 -0300207 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300208out:
209 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100210}
211EXPORT_SYMBOL(inode_init_always);
212
Al Virofdb0da82019-04-10 14:43:44 -0400213void free_inode_nonrcu(struct inode *inode)
214{
215 kmem_cache_free(inode_cachep, inode);
216}
217EXPORT_SYMBOL(free_inode_nonrcu);
218
219static void i_callback(struct rcu_head *head)
220{
221 struct inode *inode = container_of(head, struct inode, i_rcu);
222 if (inode->free_inode)
223 inode->free_inode(inode);
224 else
225 free_inode_nonrcu(inode);
226}
227
David Chinner2cb15992008-10-30 17:32:23 +1100228static struct inode *alloc_inode(struct super_block *sb)
229{
Al Virofdb0da82019-04-10 14:43:44 -0400230 const struct super_operations *ops = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 struct inode *inode;
232
Al Virofdb0da82019-04-10 14:43:44 -0400233 if (ops->alloc_inode)
234 inode = ops->alloc_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 else
David Chinner2cb15992008-10-30 17:32:23 +1100236 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Christoph Hellwig54e34622009-08-07 14:38:25 -0300238 if (!inode)
239 return NULL;
240
241 if (unlikely(inode_init_always(sb, inode))) {
Al Virofdb0da82019-04-10 14:43:44 -0400242 if (ops->destroy_inode) {
243 ops->destroy_inode(inode);
244 if (!ops->free_inode)
245 return NULL;
246 }
247 inode->free_inode = ops->free_inode;
248 i_callback(&inode->i_rcu);
Christoph Hellwig54e34622009-08-07 14:38:25 -0300249 return NULL;
250 }
251
252 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253}
254
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300255void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200257 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400258 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400260 fsnotify_inode_delete(inode);
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500261 locks_free_lock_context(inode);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100262 if (!inode->i_nlink) {
263 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
264 atomic_long_dec(&inode->i_sb->s_remove_count);
265 }
266
Al Virof19d4a82009-06-08 19:50:45 -0400267#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100268 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400269 posix_acl_release(inode->i_acl);
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100270 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400271 posix_acl_release(inode->i_default_acl);
272#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100273 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300274}
275EXPORT_SYMBOL(__destroy_inode);
276
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200277static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300278{
Al Virofdb0da82019-04-10 14:43:44 -0400279 const struct super_operations *ops = inode->i_sb->s_op;
280
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100281 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300282 __destroy_inode(inode);
Al Virofdb0da82019-04-10 14:43:44 -0400283 if (ops->destroy_inode) {
284 ops->destroy_inode(inode);
285 if (!ops->free_inode)
286 return;
287 }
288 inode->free_inode = ops->free_inode;
289 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100292/**
293 * drop_nlink - directly drop an inode's link count
294 * @inode: inode
295 *
296 * This is a low-level filesystem helper to replace any
297 * direct filesystem manipulation of i_nlink. In cases
298 * where we are attempting to track writes to the
299 * filesystem, a decrement to zero means an imminent
300 * write when the file is truncated and actually unlinked
301 * on the filesystem.
302 */
303void drop_nlink(struct inode *inode)
304{
305 WARN_ON(inode->i_nlink == 0);
306 inode->__i_nlink--;
307 if (!inode->i_nlink)
308 atomic_long_inc(&inode->i_sb->s_remove_count);
309}
310EXPORT_SYMBOL(drop_nlink);
311
312/**
313 * clear_nlink - directly zero an inode's link count
314 * @inode: inode
315 *
316 * This is a low-level filesystem helper to replace any
317 * direct filesystem manipulation of i_nlink. See
318 * drop_nlink() for why we care about i_nlink hitting zero.
319 */
320void clear_nlink(struct inode *inode)
321{
322 if (inode->i_nlink) {
323 inode->__i_nlink = 0;
324 atomic_long_inc(&inode->i_sb->s_remove_count);
325 }
326}
327EXPORT_SYMBOL(clear_nlink);
328
329/**
330 * set_nlink - directly set an inode's link count
331 * @inode: inode
332 * @nlink: new nlink (should be non-zero)
333 *
334 * This is a low-level filesystem helper to replace any
335 * direct filesystem manipulation of i_nlink.
336 */
337void set_nlink(struct inode *inode, unsigned int nlink)
338{
339 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100340 clear_nlink(inode);
341 } else {
342 /* Yes, some filesystems do change nlink from zero to one */
343 if (inode->i_nlink == 0)
344 atomic_long_dec(&inode->i_sb->s_remove_count);
345
346 inode->__i_nlink = nlink;
347 }
348}
349EXPORT_SYMBOL(set_nlink);
350
351/**
352 * inc_nlink - directly increment an inode's link count
353 * @inode: inode
354 *
355 * This is a low-level filesystem helper to replace any
356 * direct filesystem manipulation of i_nlink. Currently,
357 * it is only here for parity with dec_nlink().
358 */
359void inc_nlink(struct inode *inode)
360{
Al Virof4e0c302013-06-11 08:34:36 +0400361 if (unlikely(inode->i_nlink == 0)) {
362 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100363 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400364 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100365
366 inode->__i_nlink++;
367}
368EXPORT_SYMBOL(inc_nlink);
369
Dave Chinnerae233952018-03-06 17:30:34 -0800370static void __address_space_init_once(struct address_space *mapping)
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100371{
Johannes Weiner7b785642019-05-24 10:12:46 -0400372 xa_init_flags(&mapping->i_pages, XA_FLAGS_LOCK_IRQ | XA_FLAGS_ACCOUNT);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800373 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100374 INIT_LIST_HEAD(&mapping->private_list);
375 spin_lock_init(&mapping->private_lock);
Davidlohr Buesof808c132017-09-08 16:15:08 -0700376 mapping->i_mmap = RB_ROOT_CACHED;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100377}
Dave Chinnerae233952018-03-06 17:30:34 -0800378
379void address_space_init_once(struct address_space *mapping)
380{
381 memset(mapping, 0, sizeof(*mapping));
382 __address_space_init_once(mapping);
383}
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100384EXPORT_SYMBOL(address_space_init_once);
385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386/*
387 * These are initializations that only need to be done
388 * once, because the fields are idempotent across use
389 * of the inode, so let the slab aware of that.
390 */
391void inode_init_once(struct inode *inode)
392{
393 memset(inode, 0, sizeof(*inode));
394 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500396 INIT_LIST_HEAD(&inode->i_io_list);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700397 INIT_LIST_HEAD(&inode->i_wb_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100398 INIT_LIST_HEAD(&inode->i_lru);
Dave Chinnerae233952018-03-06 17:30:34 -0800399 __address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 i_size_ordered_init(inode);
401}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402EXPORT_SYMBOL(inode_init_once);
403
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700404static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530406 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
Christoph Lametera35afb82007-05-16 22:10:57 -0700408 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409}
410
411/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100412 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530414void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415{
Nick Piggin9e38d862010-10-23 06:55:17 -0400416 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417}
418
Al Viro7de9c6ee2010-10-23 11:11:40 -0400419/*
420 * get additional reference to inode; caller must already hold one.
421 */
422void ihold(struct inode *inode)
423{
424 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
425}
426EXPORT_SYMBOL(ihold);
427
Nick Piggin9e38d862010-10-23 06:55:17 -0400428static void inode_lru_list_add(struct inode *inode)
429{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000430 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000431 this_cpu_inc(nr_unused);
Josef Bacik563f4002017-04-18 16:04:17 -0400432 else
433 inode->i_state |= I_REFERENCED;
Nick Piggin9e38d862010-10-23 06:55:17 -0400434}
435
Jan Kara4eff96d2012-11-26 16:29:51 -0800436/*
437 * Add inode to LRU if needed (inode is unused and clean).
438 *
439 * Needs inode->i_lock held.
440 */
441void inode_add_lru(struct inode *inode)
442{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500443 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
444 I_FREEING | I_WILL_FREE)) &&
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800445 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & SB_ACTIVE)
Jan Kara4eff96d2012-11-26 16:29:51 -0800446 inode_lru_list_add(inode);
447}
448
449
Nick Piggin9e38d862010-10-23 06:55:17 -0400450static void inode_lru_list_del(struct inode *inode)
451{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000452
453 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000454 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455}
456
Christoph Hellwig646ec462010-10-23 07:15:32 -0400457/**
458 * inode_sb_list_add - add inode to the superblock list of inodes
459 * @inode: inode to add
460 */
461void inode_sb_list_add(struct inode *inode)
462{
Dave Chinner74278da2015-03-04 12:37:22 -0500463 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100464 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500465 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400466}
467EXPORT_SYMBOL_GPL(inode_sb_list_add);
468
Dave Chinner55fa6092011-03-22 22:23:40 +1100469static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400470{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200471 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500472 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200473 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500474 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200475 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400476}
477
Dave Chinner4c51acb2010-10-23 06:58:09 -0400478static unsigned long hash(struct super_block *sb, unsigned long hashval)
479{
480 unsigned long tmp;
481
482 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
483 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400484 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
485 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400486}
487
488/**
489 * __insert_inode_hash - hash an inode
490 * @inode: unhashed inode
491 * @hashval: unsigned long value used to locate this object in the
492 * inode_hashtable.
493 *
494 * Add an inode to the inode hash for this superblock.
495 */
496void __insert_inode_hash(struct inode *inode, unsigned long hashval)
497{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400498 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
499
Dave Chinner67a23c42011-03-22 22:23:42 +1100500 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100501 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000502 hlist_add_head_rcu(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100503 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100504 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400505}
506EXPORT_SYMBOL(__insert_inode_hash);
507
508/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200509 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400510 * @inode: inode to unhash
511 *
512 * Remove an inode from the superblock.
513 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200514void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400515{
Dave Chinner67a23c42011-03-22 22:23:42 +1100516 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100517 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000518 hlist_del_init_rcu(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100519 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100520 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400521}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200522EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400523
Jan Karadbd57682012-05-03 14:48:02 +0200524void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400525{
Jan Kara08142572011-06-27 16:18:10 -0700526 /*
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700527 * We have to cycle the i_pages lock here because reclaim can be in the
Jan Kara08142572011-06-27 16:18:10 -0700528 * process of removing the last page (in __delete_from_page_cache())
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700529 * and we must not free the mapping under it.
Jan Kara08142572011-06-27 16:18:10 -0700530 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700531 xa_lock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400532 BUG_ON(inode->i_data.nrpages);
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800533 BUG_ON(inode->i_data.nrexceptional);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700534 xa_unlock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400535 BUG_ON(!list_empty(&inode->i_data.private_list));
536 BUG_ON(!(inode->i_state & I_FREEING));
537 BUG_ON(inode->i_state & I_CLEAR);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700538 BUG_ON(!list_empty(&inode->i_wb_list));
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100539 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400540 inode->i_state = I_FREEING | I_CLEAR;
541}
Jan Karadbd57682012-05-03 14:48:02 +0200542EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400543
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100544/*
545 * Free the inode passed in, removing it from the lists it is still connected
546 * to. We remove any pages still attached to the inode and wait for any IO that
547 * is still in progress before finally destroying the inode.
548 *
549 * An inode must already be marked I_FREEING so that we avoid the inode being
550 * moved back onto lists if we race with other code that manipulates the lists
551 * (e.g. writeback_single_inode). The caller is responsible for setting this.
552 *
553 * An inode must already be removed from the LRU list before being evicted from
554 * the cache. This should occur atomically with setting the I_FREEING state
555 * flag, so no inodes here should ever be on the LRU when being evicted.
556 */
Al Viro644da592010-06-07 13:21:05 -0400557static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400558{
559 const struct super_operations *op = inode->i_sb->s_op;
560
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100561 BUG_ON(!(inode->i_state & I_FREEING));
562 BUG_ON(!list_empty(&inode->i_lru));
563
Dave Chinnerc7f54082015-03-04 14:07:22 -0500564 if (!list_empty(&inode->i_io_list))
565 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200566
Dave Chinner55fa6092011-03-22 22:23:40 +1100567 inode_sb_list_del(inode);
568
Jan Kara169ebd92012-05-03 14:48:03 +0200569 /*
570 * Wait for flusher thread to be done with the inode so that filesystem
571 * does not start destroying it while writeback is still running. Since
572 * the inode has I_FREEING set, flusher thread won't start new work on
573 * the inode. We just have to wait for running writeback to finish.
574 */
575 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200576
Al Virobe7ce412010-06-04 19:40:39 -0400577 if (op->evict_inode) {
578 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400579 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700580 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200581 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400582 }
Al Viro661074e2010-06-04 20:19:55 -0400583 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
584 bd_forget(inode);
585 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
586 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100587
588 remove_inode_hash(inode);
589
590 spin_lock(&inode->i_lock);
591 wake_up_bit(&inode->i_state, __I_NEW);
592 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
593 spin_unlock(&inode->i_lock);
594
595 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400596}
597
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598/*
599 * dispose_list - dispose of the contents of a local list
600 * @head: the head of the list to free
601 *
602 * Dispose-list gets a local list with local inodes in it, so it doesn't
603 * need to worry about list corruption and SMP locks.
604 */
605static void dispose_list(struct list_head *head)
606{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 while (!list_empty(head)) {
608 struct inode *inode;
609
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100610 inode = list_first_entry(head, struct inode, i_lru);
611 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
Al Viro644da592010-06-07 13:21:05 -0400613 evict(inode);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500614 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616}
617
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618/**
Al Viro63997e92010-10-25 20:49:35 -0400619 * evict_inodes - evict all evictable inodes for a superblock
620 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 *
Al Viro63997e92010-10-25 20:49:35 -0400622 * Make sure that no inodes with zero refcount are retained. This is
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800623 * called by superblock shutdown after having SB_ACTIVE flag removed,
Al Viro63997e92010-10-25 20:49:35 -0400624 * so any inode reaching zero refcount during or after that call will
625 * be immediately evicted.
626 */
627void evict_inodes(struct super_block *sb)
628{
629 struct inode *inode, *next;
630 LIST_HEAD(dispose);
631
Josef Bacikac05fbb2015-03-04 16:52:52 -0500632again:
Dave Chinner74278da2015-03-04 12:37:22 -0500633 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400634 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
635 if (atomic_read(&inode->i_count))
636 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100637
638 spin_lock(&inode->i_lock);
639 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
640 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400641 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100642 }
Al Viro63997e92010-10-25 20:49:35 -0400643
644 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100645 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100646 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100647 list_add(&inode->i_lru, &dispose);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500648
649 /*
650 * We can have a ton of inodes to evict at unmount time given
651 * enough memory, check to see if we need to go to sleep for a
652 * bit so we don't livelock.
653 */
654 if (need_resched()) {
655 spin_unlock(&sb->s_inode_list_lock);
656 cond_resched();
657 dispose_list(&dispose);
658 goto again;
659 }
Al Viro63997e92010-10-25 20:49:35 -0400660 }
Dave Chinner74278da2015-03-04 12:37:22 -0500661 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400662
663 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400664}
Darrick J. Wong799ea9e2017-08-18 18:08:25 -0700665EXPORT_SYMBOL_GPL(evict_inodes);
Al Viro63997e92010-10-25 20:49:35 -0400666
667/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200668 * invalidate_inodes - attempt to free all inodes on a superblock
669 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100670 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200671 *
672 * Attempts to free all inodes for a given superblock. If there were any
673 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100674 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
675 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 */
NeilBrown93b270f2011-02-24 17:25:47 +1100677int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400679 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200680 struct inode *inode, *next;
681 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Eric Sandeen04646ae2019-12-06 10:54:23 -0600683again:
Dave Chinner74278da2015-03-04 12:37:22 -0500684 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200685 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100686 spin_lock(&inode->i_lock);
687 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
688 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100690 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500691 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100692 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100693 busy = 1;
694 continue;
695 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200696 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100697 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200698 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 continue;
700 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200701
Christoph Hellwig99a38912010-10-23 19:07:20 +0200702 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100703 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100704 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100705 list_add(&inode->i_lru, &dispose);
Eric Sandeen04646ae2019-12-06 10:54:23 -0600706 if (need_resched()) {
707 spin_unlock(&sb->s_inode_list_lock);
708 cond_resched();
709 dispose_list(&dispose);
710 goto again;
711 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 }
Dave Chinner74278da2015-03-04 12:37:22 -0500713 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
Christoph Hellwiga0318782010-10-24 19:40:33 +0200715 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
717 return busy;
718}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000721 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 *
723 * Any inodes which are pinned purely because of attached pagecache have their
Nick Piggin9e38d862010-10-23 06:55:17 -0400724 * pagecache removed. If the inode has metadata buffers attached to
725 * mapping->private_list then try to remove them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400727 * If the inode has the I_REFERENCED flag set, then it means that it has been
728 * used recently - the flag is set in iput_final(). When we encounter such an
729 * inode, clear the flag and move it to the back of the LRU so it gets another
730 * pass through the LRU before it gets reclaimed. This is necessary because of
731 * the fact we are doing lazy LRU updates to minimise lock contention so the
732 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
733 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800735static enum lru_status inode_lru_isolate(struct list_head *item,
736 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000737{
738 struct list_head *freeable = arg;
739 struct inode *inode = container_of(item, struct inode, i_lru);
740
741 /*
742 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
743 * If we fail to get the lock, just skip it.
744 */
745 if (!spin_trylock(&inode->i_lock))
746 return LRU_SKIP;
747
748 /*
749 * Referenced or dirty inodes are still in use. Give them another pass
750 * through the LRU as we canot reclaim them now.
751 */
752 if (atomic_read(&inode->i_count) ||
753 (inode->i_state & ~I_REFERENCED)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800754 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000755 spin_unlock(&inode->i_lock);
756 this_cpu_dec(nr_unused);
757 return LRU_REMOVED;
758 }
759
Dave Chinner69056ee2019-02-12 15:35:51 -0800760 /* recently referenced inodes get one more pass */
761 if (inode->i_state & I_REFERENCED) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000762 inode->i_state &= ~I_REFERENCED;
763 spin_unlock(&inode->i_lock);
764 return LRU_ROTATE;
765 }
766
767 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
768 __iget(inode);
769 spin_unlock(&inode->i_lock);
770 spin_unlock(lru_lock);
771 if (remove_inode_buffers(inode)) {
772 unsigned long reap;
773 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
774 if (current_is_kswapd())
775 __count_vm_events(KSWAPD_INODESTEAL, reap);
776 else
777 __count_vm_events(PGINODESTEAL, reap);
778 if (current->reclaim_state)
779 current->reclaim_state->reclaimed_slab += reap;
780 }
781 iput(inode);
782 spin_lock(lru_lock);
783 return LRU_RETRY;
784 }
785
786 WARN_ON(inode->i_state & I_NEW);
787 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800788 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000789 spin_unlock(&inode->i_lock);
790
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000791 this_cpu_dec(nr_unused);
792 return LRU_REMOVED;
793}
794
795/*
796 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
797 * This is called from the superblock shrinker function with a number of inodes
798 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
799 * then are freed outside inode_lock by dispose_list().
800 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800801long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802{
803 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000804 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Vladimir Davydov503c3582015-02-12 14:58:47 -0800806 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
807 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000809 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810}
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812static void __wait_on_freeing_inode(struct inode *inode);
813/*
814 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530816static struct inode *find_inode(struct super_block *sb,
817 struct hlist_head *head,
818 int (*test)(struct inode *, void *),
819 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530821 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
823repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800824 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500825 if (inode->i_sb != sb)
826 continue;
827 if (!test(inode, data))
828 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100829 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400830 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 __wait_on_freeing_inode(inode);
832 goto repeat;
833 }
Al Viroc2b6d622018-06-28 15:53:17 -0400834 if (unlikely(inode->i_state & I_CREATING)) {
835 spin_unlock(&inode->i_lock);
836 return ERR_PTR(-ESTALE);
837 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400838 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100839 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400840 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400842 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843}
844
845/*
846 * find_inode_fast is the fast path version of find_inode, see the comment at
847 * iget_locked for details.
848 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530849static struct inode *find_inode_fast(struct super_block *sb,
850 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530852 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
854repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800855 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500856 if (inode->i_ino != ino)
857 continue;
858 if (inode->i_sb != sb)
859 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100860 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400861 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 __wait_on_freeing_inode(inode);
863 goto repeat;
864 }
Al Viroc2b6d622018-06-28 15:53:17 -0400865 if (unlikely(inode->i_state & I_CREATING)) {
866 spin_unlock(&inode->i_lock);
867 return ERR_PTR(-ESTALE);
868 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400869 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100870 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400871 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400873 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874}
875
Eric Dumazetf991bd22010-10-23 11:18:01 -0400876/*
877 * Each cpu owns a range of LAST_INO_BATCH numbers.
878 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
879 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100880 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400881 * This does not significantly increase overflow rate because every CPU can
882 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
883 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
884 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
885 * overflow rate by 2x, which does not seem too significant.
886 *
887 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
888 * error if st_ino won't fit in target struct field. Use 32bit counter
889 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100890 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400891#define LAST_INO_BATCH 1024
892static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100893
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400894unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400895{
896 unsigned int *p = &get_cpu_var(last_ino);
897 unsigned int res = *p;
898
899#ifdef CONFIG_SMP
900 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
901 static atomic_t shared_last_ino;
902 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
903
904 res = next - LAST_INO_BATCH;
905 }
906#endif
907
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300908 res++;
909 /* get_next_ino should not provide a 0 inode number */
910 if (unlikely(!res))
911 res++;
912 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400913 put_cpu_var(last_ino);
914 return res;
David Chinner8290c352008-10-30 17:35:24 +1100915}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400916EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100917
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200919 * new_inode_pseudo - obtain an inode
920 * @sb: superblock
921 *
922 * Allocates a new inode for given superblock.
923 * Inode wont be chained in superblock s_inodes list
924 * This means :
925 * - fs can't be unmount
926 * - quotas, fsnotify, writeback can't work
927 */
928struct inode *new_inode_pseudo(struct super_block *sb)
929{
930 struct inode *inode = alloc_inode(sb);
931
932 if (inode) {
933 spin_lock(&inode->i_lock);
934 inode->i_state = 0;
935 spin_unlock(&inode->i_lock);
936 INIT_LIST_HEAD(&inode->i_sb_list);
937 }
938 return inode;
939}
940
941/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 * new_inode - obtain an inode
943 * @sb: superblock
944 *
Mel Gorman769848c2007-07-17 04:03:05 -0700945 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800946 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700947 * If HIGHMEM pages are unsuitable or it is known that pages allocated
948 * for the page cache are not reclaimable or migratable,
949 * mapping_set_gfp_mask() must be called with suitable flags on the
950 * newly created inode's mapping
951 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 */
953struct inode *new_inode(struct super_block *sb)
954{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530955 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956
Dave Chinner74278da2015-03-04 12:37:22 -0500957 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530958
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200959 inode = new_inode_pseudo(sb);
960 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100961 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 return inode;
963}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964EXPORT_SYMBOL(new_inode);
965
Peter Zijlstra14358e62007-10-14 01:38:33 +0200966#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400967void lockdep_annotate_inode_mutex_key(struct inode *inode)
968{
Namhyung Kima3314a02010-10-11 22:38:00 +0900969 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200970 struct file_system_type *type = inode->i_sb->s_type;
971
Jan Kara9a7aa122009-06-04 15:26:49 +0200972 /* Set new key only if filesystem hasn't already changed it */
Al Viro9902af72016-04-15 15:08:36 -0400973 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200974 /*
975 * ensure nobody is actually holding i_mutex
976 */
Al Viro9902af72016-04-15 15:08:36 -0400977 // mutex_destroy(&inode->i_mutex);
978 init_rwsem(&inode->i_rwsem);
979 lockdep_set_class(&inode->i_rwsem,
Jan Kara9a7aa122009-06-04 15:26:49 +0200980 &type->i_mutex_dir_key);
981 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200982 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400983}
984EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200985#endif
Josh Boyere096d0c2011-08-25 07:48:12 -0400986
987/**
988 * unlock_new_inode - clear the I_NEW state and wake up any waiters
989 * @inode: new inode to unlock
990 *
991 * Called when the inode is fully initialised to clear the new state of the
992 * inode and wake up anyone waiting for the inode to finish initialisation.
993 */
994void unlock_new_inode(struct inode *inode)
995{
996 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100997 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100998 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -0400999 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro310fa7a2012-03-10 17:07:28 -05001000 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +11001001 wake_up_bit(&inode->i_state, __I_NEW);
1002 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004EXPORT_SYMBOL(unlock_new_inode);
1005
Al Viroc2b6d622018-06-28 15:53:17 -04001006void discard_new_inode(struct inode *inode)
1007{
1008 lockdep_annotate_inode_mutex_key(inode);
1009 spin_lock(&inode->i_lock);
1010 WARN_ON(!(inode->i_state & I_NEW));
1011 inode->i_state &= ~I_NEW;
1012 smp_mb();
1013 wake_up_bit(&inode->i_state, __I_NEW);
1014 spin_unlock(&inode->i_lock);
1015 iput(inode);
1016}
1017EXPORT_SYMBOL(discard_new_inode);
1018
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001019/**
J. Bruce Fields375e2892012-04-18 15:16:33 -04001020 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001021 *
1022 * Lock any non-NULL argument that is not a directory.
1023 * Zero, one or two objects may be locked by this function.
1024 *
J. Bruce Fields375e2892012-04-18 15:16:33 -04001025 * @inode1: first inode to lock
1026 * @inode2: second inode to lock
1027 */
1028void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1029{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001030 if (inode1 > inode2)
1031 swap(inode1, inode2);
1032
1033 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001034 inode_lock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001035 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001036 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001037}
1038EXPORT_SYMBOL(lock_two_nondirectories);
1039
1040/**
1041 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
1042 * @inode1: first inode to unlock
1043 * @inode2: second inode to unlock
1044 */
1045void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1046{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001047 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001048 inode_unlock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001049 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001050 inode_unlock(inode2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001051}
1052EXPORT_SYMBOL(unlock_two_nondirectories);
1053
1054/**
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001055 * inode_insert5 - obtain an inode from a mounted file system
1056 * @inode: pre-allocated inode to use for insert to cache
1057 * @hashval: hash value (usually inode number) to get
1058 * @test: callback used for comparisons between inodes
1059 * @set: callback used to initialize a new struct inode
1060 * @data: opaque data pointer to pass to @test and @set
1061 *
1062 * Search for the inode specified by @hashval and @data in the inode cache,
1063 * and if present it is return it with an increased reference count. This is
1064 * a variant of iget5_locked() for callers that don't want to fail on memory
1065 * allocation of inode.
1066 *
1067 * If the inode is not in cache, insert the pre-allocated inode to cache and
1068 * return it locked, hashed, and with the I_NEW flag set. The file system gets
1069 * to fill it in before unlocking it via unlock_new_inode().
1070 *
1071 * Note both @test and @set are called with the inode_hash_lock held, so can't
1072 * sleep.
1073 */
1074struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
1075 int (*test)(struct inode *, void *),
1076 int (*set)(struct inode *, void *), void *data)
1077{
1078 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1079 struct inode *old;
Miklos Szeredie9505642018-07-24 15:01:55 +02001080 bool creating = inode->i_state & I_CREATING;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001081
1082again:
1083 spin_lock(&inode_hash_lock);
1084 old = find_inode(inode->i_sb, head, test, data);
1085 if (unlikely(old)) {
1086 /*
1087 * Uhhuh, somebody else created the same inode under us.
1088 * Use the old inode instead of the preallocated one.
1089 */
1090 spin_unlock(&inode_hash_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001091 if (IS_ERR(old))
1092 return NULL;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001093 wait_on_inode(old);
1094 if (unlikely(inode_unhashed(old))) {
1095 iput(old);
1096 goto again;
1097 }
1098 return old;
1099 }
1100
1101 if (set && unlikely(set(inode, data))) {
1102 inode = NULL;
1103 goto unlock;
1104 }
1105
1106 /*
1107 * Return the locked inode with I_NEW set, the
1108 * caller is responsible for filling in the contents
1109 */
1110 spin_lock(&inode->i_lock);
1111 inode->i_state |= I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001112 hlist_add_head_rcu(&inode->i_hash, head);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001113 spin_unlock(&inode->i_lock);
Miklos Szeredie9505642018-07-24 15:01:55 +02001114 if (!creating)
1115 inode_sb_list_add(inode);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001116unlock:
1117 spin_unlock(&inode_hash_lock);
1118
1119 return inode;
1120}
1121EXPORT_SYMBOL(inode_insert5);
1122
1123/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001124 * iget5_locked - obtain an inode from a mounted file system
1125 * @sb: super block of file system
1126 * @hashval: hash value (usually inode number) to get
1127 * @test: callback used for comparisons between inodes
1128 * @set: callback used to initialize a new struct inode
1129 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001131 * Search for the inode specified by @hashval and @data in the inode cache,
1132 * and if present it is return it with an increased reference count. This is
1133 * a generalized version of iget_locked() for file systems where the inode
1134 * number is not sufficient for unique identification of an inode.
1135 *
1136 * If the inode is not in cache, allocate a new inode and return it locked,
1137 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1138 * before unlocking it via unlock_new_inode().
1139 *
1140 * Note both @test and @set are called with the inode_hash_lock held, so can't
1141 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001143struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1144 int (*test)(struct inode *, void *),
1145 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146{
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001147 struct inode *inode = ilookup5(sb, hashval, test, data);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001148
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001149 if (!inode) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001150 struct inode *new = alloc_inode(sb);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001151
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001152 if (new) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001153 new->i_state = 0;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001154 inode = inode_insert5(new, hashval, test, set, data);
1155 if (unlikely(inode != new))
Miklos Szeredie9505642018-07-24 15:01:55 +02001156 destroy_inode(new);
Al Viro2864f302016-07-03 23:15:21 -04001157 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 }
1159 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001161EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001163/**
1164 * iget_locked - obtain an inode from a mounted file system
1165 * @sb: super block of file system
1166 * @ino: inode number to get
1167 *
1168 * Search for the inode specified by @ino in the inode cache and if present
1169 * return it with an increased reference count. This is for file systems
1170 * where the inode number is sufficient for unique identification of an inode.
1171 *
1172 * If the inode is not in cache, allocate a new inode and return it locked,
1173 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1174 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001176struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001178 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301179 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001180again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001181 spin_lock(&inode_hash_lock);
1182 inode = find_inode_fast(sb, head, ino);
1183 spin_unlock(&inode_hash_lock);
1184 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001185 if (IS_ERR(inode))
1186 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001187 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001188 if (unlikely(inode_unhashed(inode))) {
1189 iput(inode);
1190 goto again;
1191 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001192 return inode;
1193 }
1194
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 inode = alloc_inode(sb);
1196 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301197 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198
Dave Chinner67a23c42011-03-22 22:23:42 +11001199 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 /* We released the lock, so.. */
1201 old = find_inode_fast(sb, head, ino);
1202 if (!old) {
1203 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001204 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001205 inode->i_state = I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001206 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001207 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001208 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001209 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210
1211 /* Return the locked inode with I_NEW set, the
1212 * caller is responsible for filling in the contents
1213 */
1214 return inode;
1215 }
1216
1217 /*
1218 * Uhhuh, somebody else created the same inode under
1219 * us. Use the old inode instead of the one we just
1220 * allocated.
1221 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001222 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 destroy_inode(inode);
Al Viroc2b6d622018-06-28 15:53:17 -04001224 if (IS_ERR(old))
1225 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 inode = old;
1227 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001228 if (unlikely(inode_unhashed(inode))) {
1229 iput(inode);
1230 goto again;
1231 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 }
1233 return inode;
1234}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001235EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001237/*
1238 * search the inode cache for a matching inode number.
1239 * If we find one, then the inode number we are trying to
1240 * allocate is not unique and so we should not use it.
1241 *
1242 * Returns 1 if the inode number is unique, 0 if it is not.
1243 */
1244static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1245{
1246 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001247 struct inode *inode;
1248
David Howells3f19b2a2017-12-01 11:40:16 +00001249 hlist_for_each_entry_rcu(inode, b, i_hash) {
1250 if (inode->i_ino == ino && inode->i_sb == sb)
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001251 return 0;
1252 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001253 return 1;
1254}
1255
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256/**
1257 * iunique - get a unique inode number
1258 * @sb: superblock
1259 * @max_reserved: highest reserved inode number
1260 *
1261 * Obtain an inode number that is unique on the system for a given
1262 * superblock. This is used by file systems that have no natural
1263 * permanent inode numbering system. An inode number is returned that
1264 * is higher than the reserved limit but unique.
1265 *
1266 * BUGS:
1267 * With a large number of inodes live on the file system this function
1268 * currently becomes quite slow.
1269 */
1270ino_t iunique(struct super_block *sb, ino_t max_reserved)
1271{
Jeff Layton866b04f2007-05-08 00:32:29 -07001272 /*
1273 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1274 * error if st_ino won't fit in target struct field. Use 32bit counter
1275 * here to attempt to avoid that.
1276 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001277 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001278 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
David Howells3f19b2a2017-12-01 11:40:16 +00001281 rcu_read_lock();
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001282 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001283 do {
1284 if (counter <= max_reserved)
1285 counter = max_reserved + 1;
1286 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001287 } while (!test_inode_iunique(sb, res));
1288 spin_unlock(&iunique_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001289 rcu_read_unlock();
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001290
1291 return res;
1292}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293EXPORT_SYMBOL(iunique);
1294
1295struct inode *igrab(struct inode *inode)
1296{
Dave Chinner250df6e2011-03-22 22:23:36 +11001297 spin_lock(&inode->i_lock);
1298 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001300 spin_unlock(&inode->i_lock);
1301 } else {
1302 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 /*
1304 * Handle the case where s_op->clear_inode is not been
1305 * called yet, and somebody is calling igrab
1306 * while the inode is getting freed.
1307 */
1308 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001309 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 return inode;
1311}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312EXPORT_SYMBOL(igrab);
1313
1314/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001315 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 * @sb: super block of file system to search
1317 * @hashval: hash value (usually inode number) to search for
1318 * @test: callback used for comparisons between inodes
1319 * @data: opaque data pointer to pass to @test
1320 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001321 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001323 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001324 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001325 * Note: I_NEW is not waited upon so you have to be very careful what you do
1326 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001327 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001328 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001329 */
1330struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1331 int (*test)(struct inode *, void *), void *data)
1332{
1333 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001334 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001335
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001336 spin_lock(&inode_hash_lock);
1337 inode = find_inode(sb, head, test, data);
1338 spin_unlock(&inode_hash_lock);
1339
Al Viroc2b6d622018-06-28 15:53:17 -04001340 return IS_ERR(inode) ? NULL : inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001341}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001342EXPORT_SYMBOL(ilookup5_nowait);
1343
1344/**
1345 * ilookup5 - search for an inode in the inode cache
1346 * @sb: super block of file system to search
1347 * @hashval: hash value (usually inode number) to search for
1348 * @test: callback used for comparisons between inodes
1349 * @data: opaque data pointer to pass to @test
1350 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001351 * Search for the inode specified by @hashval and @data in the inode cache,
1352 * and if the inode is in the cache, return the inode with an incremented
1353 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001354 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001356 * This is a generalized version of ilookup() for file systems where the
1357 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001359 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 */
1361struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1362 int (*test)(struct inode *, void *), void *data)
1363{
Al Viro2864f302016-07-03 23:15:21 -04001364 struct inode *inode;
1365again:
1366 inode = ilookup5_nowait(sb, hashval, test, data);
1367 if (inode) {
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001368 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001369 if (unlikely(inode_unhashed(inode))) {
1370 iput(inode);
1371 goto again;
1372 }
1373 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001374 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376EXPORT_SYMBOL(ilookup5);
1377
1378/**
1379 * ilookup - search for an inode in the inode cache
1380 * @sb: super block of file system to search
1381 * @ino: inode number to search for
1382 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001383 * Search for the inode @ino in the inode cache, and if the inode is in the
1384 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 */
1386struct inode *ilookup(struct super_block *sb, unsigned long ino)
1387{
1388 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001389 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001390again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001391 spin_lock(&inode_hash_lock);
1392 inode = find_inode_fast(sb, head, ino);
1393 spin_unlock(&inode_hash_lock);
1394
Al Viro2864f302016-07-03 23:15:21 -04001395 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001396 if (IS_ERR(inode))
1397 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001398 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001399 if (unlikely(inode_unhashed(inode))) {
1400 iput(inode);
1401 goto again;
1402 }
1403 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001404 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406EXPORT_SYMBOL(ilookup);
1407
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001408/**
1409 * find_inode_nowait - find an inode in the inode cache
1410 * @sb: super block of file system to search
1411 * @hashval: hash value (usually inode number) to search for
1412 * @match: callback used for comparisons between inodes
1413 * @data: opaque data pointer to pass to @match
1414 *
1415 * Search for the inode specified by @hashval and @data in the inode
1416 * cache, where the helper function @match will return 0 if the inode
1417 * does not match, 1 if the inode does match, and -1 if the search
1418 * should be stopped. The @match function must be responsible for
1419 * taking the i_lock spin_lock and checking i_state for an inode being
1420 * freed or being initialized, and incrementing the reference count
1421 * before returning 1. It also must not sleep, since it is called with
1422 * the inode_hash_lock spinlock held.
1423 *
1424 * This is a even more generalized version of ilookup5() when the
1425 * function must never block --- find_inode() can block in
1426 * __wait_on_freeing_inode() --- or when the caller can not increment
1427 * the reference count because the resulting iput() might cause an
1428 * inode eviction. The tradeoff is that the @match funtion must be
1429 * very carefully implemented.
1430 */
1431struct inode *find_inode_nowait(struct super_block *sb,
1432 unsigned long hashval,
1433 int (*match)(struct inode *, unsigned long,
1434 void *),
1435 void *data)
1436{
1437 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1438 struct inode *inode, *ret_inode = NULL;
1439 int mval;
1440
1441 spin_lock(&inode_hash_lock);
1442 hlist_for_each_entry(inode, head, i_hash) {
1443 if (inode->i_sb != sb)
1444 continue;
1445 mval = match(inode, hashval, data);
1446 if (mval == 0)
1447 continue;
1448 if (mval == 1)
1449 ret_inode = inode;
1450 goto out;
1451 }
1452out:
1453 spin_unlock(&inode_hash_lock);
1454 return ret_inode;
1455}
1456EXPORT_SYMBOL(find_inode_nowait);
1457
David Howells3f19b2a2017-12-01 11:40:16 +00001458/**
1459 * find_inode_rcu - find an inode in the inode cache
1460 * @sb: Super block of file system to search
1461 * @hashval: Key to hash
1462 * @test: Function to test match on an inode
1463 * @data: Data for test function
1464 *
1465 * Search for the inode specified by @hashval and @data in the inode cache,
1466 * where the helper function @test will return 0 if the inode does not match
1467 * and 1 if it does. The @test function must be responsible for taking the
1468 * i_lock spin_lock and checking i_state for an inode being freed or being
1469 * initialized.
1470 *
1471 * If successful, this will return the inode for which the @test function
1472 * returned 1 and NULL otherwise.
1473 *
1474 * The @test function is not permitted to take a ref on any inode presented.
1475 * It is also not permitted to sleep.
1476 *
1477 * The caller must hold the RCU read lock.
1478 */
1479struct inode *find_inode_rcu(struct super_block *sb, unsigned long hashval,
1480 int (*test)(struct inode *, void *), void *data)
1481{
1482 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1483 struct inode *inode;
1484
1485 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1486 "suspicious find_inode_rcu() usage");
1487
1488 hlist_for_each_entry_rcu(inode, head, i_hash) {
1489 if (inode->i_sb == sb &&
1490 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)) &&
1491 test(inode, data))
1492 return inode;
1493 }
1494 return NULL;
1495}
1496EXPORT_SYMBOL(find_inode_rcu);
1497
1498/**
1499 * find_inode_by_rcu - Find an inode in the inode cache
1500 * @sb: Super block of file system to search
1501 * @ino: The inode number to match
1502 *
1503 * Search for the inode specified by @hashval and @data in the inode cache,
1504 * where the helper function @test will return 0 if the inode does not match
1505 * and 1 if it does. The @test function must be responsible for taking the
1506 * i_lock spin_lock and checking i_state for an inode being freed or being
1507 * initialized.
1508 *
1509 * If successful, this will return the inode for which the @test function
1510 * returned 1 and NULL otherwise.
1511 *
1512 * The @test function is not permitted to take a ref on any inode presented.
1513 * It is also not permitted to sleep.
1514 *
1515 * The caller must hold the RCU read lock.
1516 */
1517struct inode *find_inode_by_ino_rcu(struct super_block *sb,
1518 unsigned long ino)
1519{
1520 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1521 struct inode *inode;
1522
1523 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1524 "suspicious find_inode_by_ino_rcu() usage");
1525
1526 hlist_for_each_entry_rcu(inode, head, i_hash) {
1527 if (inode->i_ino == ino &&
1528 inode->i_sb == sb &&
1529 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)))
1530 return inode;
1531 }
1532 return NULL;
1533}
1534EXPORT_SYMBOL(find_inode_by_ino_rcu);
1535
Al Viro261bca82008-12-30 01:48:21 -05001536int insert_inode_locked(struct inode *inode)
1537{
1538 struct super_block *sb = inode->i_sb;
1539 ino_t ino = inode->i_ino;
1540 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001541
Al Viro261bca82008-12-30 01:48:21 -05001542 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001543 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001544 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001545 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001546 if (old->i_ino != ino)
1547 continue;
1548 if (old->i_sb != sb)
1549 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001550 spin_lock(&old->i_lock);
1551 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1552 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001553 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001554 }
Al Viro72a43d62009-05-13 19:13:40 +01001555 break;
1556 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001557 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001558 spin_lock(&inode->i_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001559 inode->i_state |= I_NEW | I_CREATING;
David Howells3f19b2a2017-12-01 11:40:16 +00001560 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001561 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001562 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001563 return 0;
1564 }
Al Viroc2b6d622018-06-28 15:53:17 -04001565 if (unlikely(old->i_state & I_CREATING)) {
1566 spin_unlock(&old->i_lock);
1567 spin_unlock(&inode_hash_lock);
1568 return -EBUSY;
1569 }
Al Viro261bca82008-12-30 01:48:21 -05001570 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001571 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001572 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001573 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001574 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001575 iput(old);
1576 return -EBUSY;
1577 }
1578 iput(old);
1579 }
1580}
Al Viro261bca82008-12-30 01:48:21 -05001581EXPORT_SYMBOL(insert_inode_locked);
1582
1583int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1584 int (*test)(struct inode *, void *), void *data)
1585{
Al Viroc2b6d622018-06-28 15:53:17 -04001586 struct inode *old;
1587
1588 inode->i_state |= I_CREATING;
1589 old = inode_insert5(inode, hashval, test, NULL, data);
Al Viro261bca82008-12-30 01:48:21 -05001590
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001591 if (old != inode) {
Al Viro261bca82008-12-30 01:48:21 -05001592 iput(old);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001593 return -EBUSY;
Al Viro261bca82008-12-30 01:48:21 -05001594 }
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001595 return 0;
Al Viro261bca82008-12-30 01:48:21 -05001596}
Al Viro261bca82008-12-30 01:48:21 -05001597EXPORT_SYMBOL(insert_inode_locked4);
1598
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Al Viro45321ac2010-06-07 13:43:19 -04001600int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601{
Al Viro45321ac2010-06-07 13:43:19 -04001602 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604EXPORT_SYMBOL(generic_delete_inode);
1605
Al Viro45321ac2010-06-07 13:43:19 -04001606/*
Al Viro45321ac2010-06-07 13:43:19 -04001607 * Called when we're dropping the last reference
1608 * to an inode.
1609 *
1610 * Call the FS "drop_inode()" function, defaulting to
1611 * the legacy UNIX filesystem behaviour. If it tells
1612 * us to evict inode, do so. Otherwise, retain inode
1613 * in cache if fs is alive, sync and evict if fs is
1614 * shutting down.
1615 */
1616static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617{
1618 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001619 const struct super_operations *op = inode->i_sb->s_op;
David Howells3f19b2a2017-12-01 11:40:16 +00001620 unsigned long state;
Al Viro45321ac2010-06-07 13:43:19 -04001621 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
Dave Chinner250df6e2011-03-22 22:23:36 +11001623 WARN_ON(inode->i_state & I_NEW);
1624
Al Viroe7f59092011-07-07 15:45:59 -04001625 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001626 drop = op->drop_inode(inode);
1627 else
1628 drop = generic_drop_inode(inode);
1629
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001630 if (!drop && (sb->s_flags & SB_ACTIVE)) {
Jan Kara4eff96d2012-11-26 16:29:51 -08001631 inode_add_lru(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001632 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001633 return;
1634 }
1635
David Howells3f19b2a2017-12-01 11:40:16 +00001636 state = inode->i_state;
Al Viro45321ac2010-06-07 13:43:19 -04001637 if (!drop) {
David Howells3f19b2a2017-12-01 11:40:16 +00001638 WRITE_ONCE(inode->i_state, state | I_WILL_FREE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001639 spin_unlock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001640
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 write_inode_now(inode, 1);
David Howells3f19b2a2017-12-01 11:40:16 +00001642
Dave Chinner250df6e2011-03-22 22:23:36 +11001643 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001644 state = inode->i_state;
1645 WARN_ON(state & I_NEW);
1646 state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001648
David Howells3f19b2a2017-12-01 11:40:16 +00001649 WRITE_ONCE(inode->i_state, state | I_FREEING);
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001650 if (!list_empty(&inode->i_lru))
1651 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001652 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001653
1654 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655}
1656
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301658 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 * @inode: inode to put
1660 *
1661 * Puts an inode, dropping its usage count. If the inode use count hits
1662 * zero, the inode is then freed and may also be destroyed.
1663 *
1664 * Consequently, iput() can sleep.
1665 */
1666void iput(struct inode *inode)
1667{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001668 if (!inode)
1669 return;
1670 BUG_ON(inode->i_state & I_CLEAR);
1671retry:
1672 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1673 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1674 atomic_inc(&inode->i_count);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001675 spin_unlock(&inode->i_lock);
1676 trace_writeback_lazytime_iput(inode);
1677 mark_inode_dirty_sync(inode);
1678 goto retry;
1679 }
1680 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 }
1682}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683EXPORT_SYMBOL(iput);
1684
Carlos Maiolino30460e12020-01-09 14:30:41 +01001685#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686/**
1687 * bmap - find a block number in a file
Carlos Maiolino30460e12020-01-09 14:30:41 +01001688 * @inode: inode owning the block number being requested
1689 * @block: pointer containing the block to find
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 *
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001691 * Replaces the value in ``*block`` with the block number on the device holding
Carlos Maiolino30460e12020-01-09 14:30:41 +01001692 * corresponding to the requested block number in the file.
1693 * That is, asked for block 4 of inode 1 the function will replace the
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001694 * 4 in ``*block``, with disk block relative to the disk start that holds that
Carlos Maiolino30460e12020-01-09 14:30:41 +01001695 * block of the file.
1696 *
1697 * Returns -EINVAL in case of error, 0 otherwise. If mapping falls into a
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001698 * hole, returns 0 and ``*block`` is also set to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 */
Carlos Maiolino30460e12020-01-09 14:30:41 +01001700int bmap(struct inode *inode, sector_t *block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701{
Carlos Maiolino30460e12020-01-09 14:30:41 +01001702 if (!inode->i_mapping->a_ops->bmap)
1703 return -EINVAL;
1704
1705 *block = inode->i_mapping->a_ops->bmap(inode->i_mapping, *block);
1706 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708EXPORT_SYMBOL(bmap);
Carlos Maiolino30460e12020-01-09 14:30:41 +01001709#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001711/*
1712 * With relative atime, only update atime if the previous atime is
1713 * earlier than either the ctime or mtime or if at least a day has
1714 * passed since the last atime update.
1715 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001716static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001717 struct timespec64 now)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001718{
1719
Miklos Szeredic6718542018-07-18 15:44:43 +02001720 if (!(mnt->mnt_flags & MNT_RELATIME))
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001721 return 1;
1722 /*
1723 * Is mtime younger than atime? If yes, update atime:
1724 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001725 if (timespec64_compare(&inode->i_mtime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001726 return 1;
1727 /*
1728 * Is ctime younger than atime? If yes, update atime:
1729 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001730 if (timespec64_compare(&inode->i_ctime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001731 return 1;
1732
1733 /*
1734 * Is the previous atime value older than a day? If yes,
1735 * update atime:
1736 */
1737 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1738 return 1;
1739 /*
1740 * Good, we can skip the atime update:
1741 */
1742 return 0;
1743}
1744
Deepa Dinamani95582b02018-05-08 19:36:02 -07001745int generic_update_time(struct inode *inode, struct timespec64 *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001746{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001747 int iflags = I_DIRTY_TIME;
Jeff Laytone38cf302017-12-11 06:35:22 -05001748 bool dirty = false;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001749
1750 if (flags & S_ATIME)
1751 inode->i_atime = *time;
1752 if (flags & S_VERSION)
Jeff Laytone38cf302017-12-11 06:35:22 -05001753 dirty = inode_maybe_inc_iversion(inode, false);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001754 if (flags & S_CTIME)
1755 inode->i_ctime = *time;
1756 if (flags & S_MTIME)
1757 inode->i_mtime = *time;
Jeff Laytone38cf302017-12-11 06:35:22 -05001758 if ((flags & (S_ATIME | S_CTIME | S_MTIME)) &&
1759 !(inode->i_sb->s_flags & SB_LAZYTIME))
1760 dirty = true;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001761
Jeff Laytone38cf302017-12-11 06:35:22 -05001762 if (dirty)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001763 iflags |= I_DIRTY_SYNC;
1764 __mark_inode_dirty(inode, iflags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001765 return 0;
1766}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001767EXPORT_SYMBOL(generic_update_time);
1768
1769/*
1770 * This does the actual work of updating an inodes time or version. Must have
1771 * had called mnt_want_write() before calling this.
1772 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001773static int update_time(struct inode *inode, struct timespec64 *time, int flags)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001774{
Deepa Dinamani23b424d2019-12-02 21:19:45 -08001775 if (inode->i_op->update_time)
1776 return inode->i_op->update_time(inode, time, flags);
1777 return generic_update_time(inode, time, flags);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001778}
Josef Bacikc3b2da32012-03-26 09:59:21 -04001779
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780/**
Christoph Hellwig869243a2006-01-09 20:52:03 -08001781 * touch_atime - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001782 * @path: the &struct path to update
Randy Dunlap30fdc8e2015-11-09 14:57:58 -08001783 * @inode: inode to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 *
1785 * Update the accessed time on an inode and mark it for writeback.
1786 * This function automatically handles read only file systems and media,
1787 * as well as the "noatime" flag and inode specific "noatime" markers.
1788 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001789bool atime_needs_update(const struct path *path, struct inode *inode)
NeilBrown8fa9dd22015-03-23 13:37:40 +11001790{
1791 struct vfsmount *mnt = path->mnt;
Deepa Dinamani95582b02018-05-08 19:36:02 -07001792 struct timespec64 now;
NeilBrown8fa9dd22015-03-23 13:37:40 +11001793
1794 if (inode->i_flags & S_NOATIME)
1795 return false;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001796
1797 /* Atime updates will likely cause i_uid and i_gid to be written
1798 * back improprely if their true value is unknown to the vfs.
1799 */
1800 if (HAS_UNMAPPED_ID(inode))
1801 return false;
1802
NeilBrown8fa9dd22015-03-23 13:37:40 +11001803 if (IS_NOATIME(inode))
1804 return false;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001805 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001806 return false;
1807
1808 if (mnt->mnt_flags & MNT_NOATIME)
1809 return false;
1810 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1811 return false;
1812
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001813 now = current_time(inode);
NeilBrown8fa9dd22015-03-23 13:37:40 +11001814
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001815 if (!relatime_need_update(mnt, inode, now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001816 return false;
1817
Deepa Dinamani95582b02018-05-08 19:36:02 -07001818 if (timespec64_equal(&inode->i_atime, &now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001819 return false;
1820
1821 return true;
1822}
1823
Al Virobadcf2b2013-07-16 18:15:46 +04001824void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825{
Al Viro68ac1232012-03-15 08:21:57 -04001826 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001827 struct inode *inode = d_inode(path->dentry);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001828 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829
Miklos Szeredic6718542018-07-18 15:44:43 +02001830 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001831 return;
1832
Jan Kara5d37e9e2012-06-12 16:20:36 +02001833 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001834 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001835
NeilBrown8fa9dd22015-03-23 13:37:40 +11001836 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001837 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001838 /*
1839 * File systems can error out when updating inodes if they need to
1840 * allocate new space to modify an inode (such is the case for
1841 * Btrfs), but since we touch atime while walking down the path we
1842 * really don't care if we failed to update the atime of the file,
1843 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001844 * We may also fail on filesystems that have the ability to make parts
1845 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001846 */
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001847 now = current_time(inode);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001848 update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001849 __mnt_drop_write(mnt);
1850skip_update:
1851 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001853EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854
Cong Wang3ed37642012-05-15 14:57:33 +08001855/*
1856 * The logic we want is
1857 *
1858 * if suid or (sgid and xgrp)
1859 * remove privs
1860 */
1861int should_remove_suid(struct dentry *dentry)
1862{
David Howellsdf2b1af2015-03-17 22:26:15 +00001863 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001864 int kill = 0;
1865
1866 /* suid always must be killed */
1867 if (unlikely(mode & S_ISUID))
1868 kill = ATTR_KILL_SUID;
1869
1870 /*
1871 * sgid without any exec bits is just a mandatory locking mark; leave
1872 * it alone. If some exec bits are set, it's a real sgid; kill it.
1873 */
1874 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1875 kill |= ATTR_KILL_SGID;
1876
1877 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1878 return kill;
1879
1880 return 0;
1881}
1882EXPORT_SYMBOL(should_remove_suid);
1883
Jan Karadbfae0c2015-05-21 16:05:54 +02001884/*
1885 * Return mask of changes for notify_change() that need to be done as a
1886 * response to write or truncate. Return 0 if nothing has to be changed.
1887 * Negative value on error (change should be denied).
1888 */
Jan Kara45f147a2015-05-21 16:05:55 +02001889int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001890{
Jan Karadbfae0c2015-05-21 16:05:54 +02001891 struct inode *inode = d_inode(dentry);
1892 int mask = 0;
1893 int ret;
1894
1895 if (IS_NOSEC(inode))
1896 return 0;
1897
1898 mask = should_remove_suid(dentry);
1899 ret = security_inode_need_killpriv(dentry);
1900 if (ret < 0)
1901 return ret;
1902 if (ret)
1903 mask |= ATTR_KILL_PRIV;
1904 return mask;
1905}
Jan Karadbfae0c2015-05-21 16:05:54 +02001906
1907static int __remove_privs(struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001908{
1909 struct iattr newattrs;
1910
1911 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001912 /*
1913 * Note we call this on write, so notify_change will not
1914 * encounter any conflicting delegations:
1915 */
1916 return notify_change(dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001917}
1918
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001919/*
1920 * Remove special file priviledges (suid, capabilities) when file is written
1921 * to or truncated.
1922 */
1923int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001924{
Miklos Szeredic1892c32016-08-03 13:44:27 +02001925 struct dentry *dentry = file_dentry(file);
1926 struct inode *inode = file_inode(file);
Jan Karadbfae0c2015-05-21 16:05:54 +02001927 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001928 int error = 0;
1929
Alexander Lochmannf69e7492018-12-14 11:55:52 +01001930 /*
1931 * Fast path for nothing security related.
1932 * As well for non-regular files, e.g. blkdev inodes.
1933 * For example, blkdev_write_iter() might get here
1934 * trying to remove privs which it is not allowed to.
1935 */
1936 if (IS_NOSEC(inode) || !S_ISREG(inode->i_mode))
Cong Wang3ed37642012-05-15 14:57:33 +08001937 return 0;
1938
Miklos Szeredic1892c32016-08-03 13:44:27 +02001939 kill = dentry_needs_remove_privs(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001940 if (kill < 0)
1941 return kill;
1942 if (kill)
1943 error = __remove_privs(dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001944 if (!error)
1945 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001946
1947 return error;
1948}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001949EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001950
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001952 * file_update_time - update mtime and ctime time
1953 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001955 * Update the mtime and ctime members of an inode and mark the inode
1956 * for writeback. Note that this function is meant exclusively for
1957 * usage in the file write path of filesystems, and filesystems may
1958 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001959 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001960 * timestamps are handled by the server. This can return an error for
1961 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 */
1963
Josef Bacikc3b2da32012-03-26 09:59:21 -04001964int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965{
Al Viro496ad9a2013-01-23 17:07:38 -05001966 struct inode *inode = file_inode(file);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001967 struct timespec64 now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001968 int sync_it = 0;
1969 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970
Andi Kleence06e0b2009-09-18 13:05:48 -07001971 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001973 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001974
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001975 now = current_time(inode);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001976 if (!timespec64_equal(&inode->i_mtime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001977 sync_it = S_MTIME;
1978
Deepa Dinamani95582b02018-05-08 19:36:02 -07001979 if (!timespec64_equal(&inode->i_ctime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001980 sync_it |= S_CTIME;
1981
Jeff Laytone38cf302017-12-11 06:35:22 -05001982 if (IS_I_VERSION(inode) && inode_iversion_need_inc(inode))
Andi Kleence06e0b2009-09-18 13:05:48 -07001983 sync_it |= S_VERSION;
1984
1985 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001986 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987
Andi Kleence06e0b2009-09-18 13:05:48 -07001988 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02001989 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001990 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991
Josef Bacikc3b2da32012-03-26 09:59:21 -04001992 ret = update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02001993 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001994
1995 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996}
Christoph Hellwig870f4812006-01-09 20:52:01 -08001997EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998
Amir Goldsteine38f7f52019-06-05 08:04:49 -07001999/* Caller must hold the file's inode lock */
2000int file_modified(struct file *file)
2001{
2002 int err;
2003
2004 /*
2005 * Clear the security bits if the process is not being run by root.
2006 * This keeps people from modifying setuid and setgid binaries.
2007 */
2008 err = file_remove_privs(file);
2009 if (err)
2010 return err;
2011
2012 if (unlikely(file->f_mode & FMODE_NOCMTIME))
2013 return 0;
2014
2015 return file_update_time(file);
2016}
2017EXPORT_SYMBOL(file_modified);
2018
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019int inode_needs_sync(struct inode *inode)
2020{
2021 if (IS_SYNC(inode))
2022 return 1;
2023 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
2024 return 1;
2025 return 0;
2026}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027EXPORT_SYMBOL(inode_needs_sync);
2028
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07002030 * If we try to find an inode in the inode hash while it is being
2031 * deleted, we have to wait until the filesystem completes its
2032 * deletion before reporting that it isn't found. This function waits
2033 * until the deletion _might_ have completed. Callers are responsible
2034 * to recheck inode state.
2035 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002036 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11002037 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
2038 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 */
2040static void __wait_on_freeing_inode(struct inode *inode)
2041{
2042 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002043 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
2044 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Ingo Molnar21417132017-03-05 11:25:39 +01002045 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11002046 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11002047 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 schedule();
Ingo Molnar21417132017-03-05 11:25:39 +01002049 finish_wait(wq, &wait.wq_entry);
Dave Chinner67a23c42011-03-22 22:23:42 +11002050 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051}
2052
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053static __initdata unsigned long ihash_entries;
2054static int __init set_ihash_entries(char *str)
2055{
2056 if (!str)
2057 return 0;
2058 ihash_entries = simple_strtoul(str, &str, 0);
2059 return 1;
2060}
2061__setup("ihash_entries=", set_ihash_entries);
2062
2063/*
2064 * Initialize the waitqueues and inode hash table.
2065 */
2066void __init inode_init_early(void)
2067{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 /* If hashes are distributed across NUMA nodes, defer
2069 * hash allocation until vmalloc space is available.
2070 */
2071 if (hashdist)
2072 return;
2073
2074 inode_hashtable =
2075 alloc_large_system_hash("Inode-cache",
2076 sizeof(struct hlist_head),
2077 ihash_entries,
2078 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002079 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 &i_hash_shift,
2081 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002082 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084}
2085
Denis Cheng74bf17c2007-10-16 23:26:30 -07002086void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08002089 inode_cachep = kmem_cache_create("inode_cache",
2090 sizeof(struct inode),
2091 0,
2092 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
Vladimir Davydov5d097052016-01-14 15:18:21 -08002093 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
Paul Mundt20c2df82007-07-20 10:11:58 +09002094 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095
2096 /* Hash may have been set up in inode_init_early */
2097 if (!hashdist)
2098 return;
2099
2100 inode_hashtable =
2101 alloc_large_system_hash("Inode-cache",
2102 sizeof(struct hlist_head),
2103 ihash_entries,
2104 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002105 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 &i_hash_shift,
2107 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002108 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110}
2111
2112void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
2113{
2114 inode->i_mode = mode;
2115 if (S_ISCHR(mode)) {
2116 inode->i_fop = &def_chr_fops;
2117 inode->i_rdev = rdev;
2118 } else if (S_ISBLK(mode)) {
2119 inode->i_fop = &def_blk_fops;
2120 inode->i_rdev = rdev;
2121 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04002122 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05002124 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07002126 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
2127 " inode %s:%lu\n", mode, inode->i_sb->s_id,
2128 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129}
2130EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002131
2132/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00002133 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002134 * @inode: New inode
2135 * @dir: Directory inode
2136 * @mode: mode of the new inode
2137 */
2138void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04002139 umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002140{
2141 inode->i_uid = current_fsuid();
2142 if (dir && dir->i_mode & S_ISGID) {
2143 inode->i_gid = dir->i_gid;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002144
2145 /* Directories are special, and always inherit S_ISGID */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002146 if (S_ISDIR(mode))
2147 mode |= S_ISGID;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002148 else if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP) &&
2149 !in_group_p(inode->i_gid) &&
2150 !capable_wrt_inode_uidgid(dir, CAP_FSETID))
2151 mode &= ~S_ISGID;
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002152 } else
2153 inode->i_gid = current_fsgid();
2154 inode->i_mode = mode;
2155}
2156EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07002157
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002158/**
2159 * inode_owner_or_capable - check current task permissions to inode
2160 * @inode: inode being checked
2161 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002162 * Return true if current either has CAP_FOWNER in a namespace with the
2163 * inode owner uid mapped, or owns the file.
Serge E. Hallyne795b712011-03-23 16:43:25 -07002164 */
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002165bool inode_owner_or_capable(const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07002166{
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002167 struct user_namespace *ns;
2168
Eric W. Biederman92361632012-02-08 07:07:50 -08002169 if (uid_eq(current_fsuid(), inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002170 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002171
2172 ns = current_user_ns();
Kees Cookcc658db2017-06-21 09:53:06 -07002173 if (kuid_has_mapping(ns, inode->i_uid) && ns_capable(ns, CAP_FOWNER))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002174 return true;
2175 return false;
2176}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002177EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002178
2179/*
2180 * Direct i/o helper functions
2181 */
2182static void __inode_dio_wait(struct inode *inode)
2183{
2184 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2185 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2186
2187 do {
Ingo Molnar21417132017-03-05 11:25:39 +01002188 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002189 if (atomic_read(&inode->i_dio_count))
2190 schedule();
2191 } while (atomic_read(&inode->i_dio_count));
Ingo Molnar21417132017-03-05 11:25:39 +01002192 finish_wait(wq, &q.wq_entry);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002193}
2194
2195/**
2196 * inode_dio_wait - wait for outstanding DIO requests to finish
2197 * @inode: inode to wait for
2198 *
2199 * Waits for all pending direct I/O requests to finish so that we can
2200 * proceed with a truncate or equivalent operation.
2201 *
2202 * Must be called under a lock that serializes taking new references
2203 * to i_dio_count, usually by inode->i_mutex.
2204 */
2205void inode_dio_wait(struct inode *inode)
2206{
2207 if (atomic_read(&inode->i_dio_count))
2208 __inode_dio_wait(inode);
2209}
2210EXPORT_SYMBOL(inode_dio_wait);
2211
2212/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002213 * inode_set_flags - atomically set some inode flags
2214 *
2215 * Note: the caller should be holding i_mutex, or else be sure that
2216 * they have exclusive access to the inode structure (i.e., while the
2217 * inode is being instantiated). The reason for the cmpxchg() loop
2218 * --- which wouldn't be necessary if all code paths which modify
2219 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002220 * code path which doesn't today so we use cmpxchg() out of an abundance
2221 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002222 *
2223 * In the long run, i_mutex is overkill, and we should probably look
2224 * at using the i_lock spinlock to protect i_flags, and then make sure
2225 * it is so documented in include/linux/fs.h and that all code follows
2226 * the locking convention!!
2227 */
2228void inode_set_flags(struct inode *inode, unsigned int flags,
2229 unsigned int mask)
2230{
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002231 WARN_ON_ONCE(flags & ~mask);
Vineet Guptaa9057372019-03-05 15:41:52 -08002232 set_mask_bits(&inode->i_flags, mask, flags);
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002233}
2234EXPORT_SYMBOL(inode_set_flags);
Al Viro21fc61c2015-11-17 01:07:57 -05002235
2236void inode_nohighmem(struct inode *inode)
2237{
2238 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2239}
2240EXPORT_SYMBOL(inode_nohighmem);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002241
2242/**
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002243 * timestamp_truncate - Truncate timespec to a granularity
2244 * @t: Timespec
2245 * @inode: inode being updated
2246 *
2247 * Truncate a timespec to the granularity supported by the fs
2248 * containing the inode. Always rounds down. gran must
2249 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2250 */
2251struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode)
2252{
2253 struct super_block *sb = inode->i_sb;
2254 unsigned int gran = sb->s_time_gran;
2255
2256 t.tv_sec = clamp(t.tv_sec, sb->s_time_min, sb->s_time_max);
2257 if (unlikely(t.tv_sec == sb->s_time_max || t.tv_sec == sb->s_time_min))
2258 t.tv_nsec = 0;
2259
2260 /* Avoid division in the common cases 1 ns and 1 s. */
2261 if (gran == 1)
2262 ; /* nothing */
2263 else if (gran == NSEC_PER_SEC)
2264 t.tv_nsec = 0;
2265 else if (gran > 1 && gran < NSEC_PER_SEC)
2266 t.tv_nsec -= t.tv_nsec % gran;
2267 else
2268 WARN(1, "invalid file time granularity: %u", gran);
2269 return t;
2270}
2271EXPORT_SYMBOL(timestamp_truncate);
2272
2273/**
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002274 * current_time - Return FS time
2275 * @inode: inode.
2276 *
2277 * Return the current time truncated to the time granularity supported by
2278 * the fs.
2279 *
2280 * Note that inode and inode->sb cannot be NULL.
2281 * Otherwise, the function warns and returns time without truncation.
2282 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07002283struct timespec64 current_time(struct inode *inode)
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002284{
Arnd Bergmannd651d162018-12-05 11:14:27 +11002285 struct timespec64 now;
2286
2287 ktime_get_coarse_real_ts64(&now);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002288
2289 if (unlikely(!inode->i_sb)) {
2290 WARN(1, "current_time() called with uninitialized super_block in the inode");
2291 return now;
2292 }
2293
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002294 return timestamp_truncate(now, inode);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002295}
2296EXPORT_SYMBOL(current_time);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002297
2298/*
2299 * Generic function to check FS_IOC_SETFLAGS values and reject any invalid
2300 * configurations.
2301 *
2302 * Note: the caller should be holding i_mutex, or else be sure that they have
2303 * exclusive access to the inode structure.
2304 */
2305int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
2306 unsigned int flags)
2307{
2308 /*
2309 * The IMMUTABLE and APPEND_ONLY flags can only be changed by
2310 * the relevant capability.
2311 *
2312 * This test looks nicer. Thanks to Pauline Middelink
2313 */
2314 if ((flags ^ oldflags) & (FS_APPEND_FL | FS_IMMUTABLE_FL) &&
2315 !capable(CAP_LINUX_IMMUTABLE))
2316 return -EPERM;
2317
Daniel Rosenberg6e1918c2020-01-20 14:31:56 -08002318 return fscrypt_prepare_setflags(inode, oldflags, flags);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002319}
2320EXPORT_SYMBOL(vfs_ioc_setflags_prepare);
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002321
2322/*
2323 * Generic function to check FS_IOC_FSSETXATTR values and reject any invalid
2324 * configurations.
2325 *
2326 * Note: the caller should be holding i_mutex, or else be sure that they have
2327 * exclusive access to the inode structure.
2328 */
2329int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
2330 struct fsxattr *fa)
2331{
2332 /*
2333 * Can't modify an immutable/append-only file unless we have
2334 * appropriate permission.
2335 */
2336 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2337 (FS_XFLAG_IMMUTABLE | FS_XFLAG_APPEND) &&
2338 !capable(CAP_LINUX_IMMUTABLE))
2339 return -EPERM;
2340
Darrick J. Wongf9914922019-07-01 08:25:35 -07002341 /*
2342 * Project Quota ID state is only allowed to change from within the init
2343 * namespace. Enforce that restriction only if we are trying to change
2344 * the quota ID state. Everything else is allowed in user namespaces.
2345 */
2346 if (current_user_ns() != &init_user_ns) {
2347 if (old_fa->fsx_projid != fa->fsx_projid)
2348 return -EINVAL;
2349 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2350 FS_XFLAG_PROJINHERIT)
2351 return -EINVAL;
2352 }
2353
Darrick J. Wongca29be72019-07-01 08:25:36 -07002354 /* Check extent size hints. */
2355 if ((fa->fsx_xflags & FS_XFLAG_EXTSIZE) && !S_ISREG(inode->i_mode))
2356 return -EINVAL;
2357
2358 if ((fa->fsx_xflags & FS_XFLAG_EXTSZINHERIT) &&
2359 !S_ISDIR(inode->i_mode))
2360 return -EINVAL;
2361
2362 if ((fa->fsx_xflags & FS_XFLAG_COWEXTSIZE) &&
2363 !S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
2364 return -EINVAL;
2365
Darrick J. Wongdbc77f32019-07-01 08:25:36 -07002366 /*
2367 * It is only valid to set the DAX flag on regular files and
2368 * directories on filesystems.
2369 */
2370 if ((fa->fsx_xflags & FS_XFLAG_DAX) &&
2371 !(S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode)))
2372 return -EINVAL;
2373
Darrick J. Wongca29be72019-07-01 08:25:36 -07002374 /* Extent size hints of zero turn off the flags. */
2375 if (fa->fsx_extsize == 0)
2376 fa->fsx_xflags &= ~(FS_XFLAG_EXTSIZE | FS_XFLAG_EXTSZINHERIT);
2377 if (fa->fsx_cowextsize == 0)
2378 fa->fsx_xflags &= ~FS_XFLAG_COWEXTSIZE;
2379
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002380 return 0;
2381}
2382EXPORT_SYMBOL(vfs_ioc_fssetxattr_check);