blob: c7f8465a0493b15af1686030b0bbe2933043af7d [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * (C) 1997 Linus Torvalds
Christoph Hellwig4b4563d2011-05-27 09:28:01 -04004 * (C) 1999 Andrea Arcangeli <andrea@suse.de> (dynamic inode allocation)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 */
Al Viroe59cc472011-12-07 13:17:19 -05006#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/fs.h>
8#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/hash.h>
11#include <linux/swap.h>
12#include <linux/security.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/cdev.h>
Mike Rapoport57c8a662018-10-30 15:09:49 -070014#include <linux/memblock.h>
Eric Paris3be25f42009-05-21 17:01:26 -040015#include <linux/fsnotify.h>
Christoph Hellwigfc33a7b2006-01-09 20:52:17 -080016#include <linux/mount.h>
Al Virof19d4a82009-06-08 19:50:45 -040017#include <linux/posix_acl.h>
Heiko Carstens9ce6e0b2011-05-22 18:54:21 +020018#include <linux/prefetch.h>
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040019#include <linux/buffer_head.h> /* for inode_has_buffers */
Miklos Szeredi7ada4db2011-11-21 12:11:32 +010020#include <linux/ratelimit.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100021#include <linux/list_lru.h>
Jeff Laytonae5e1652018-01-29 06:41:30 -050022#include <linux/iversion.h>
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050023#include <trace/events/writeback.h>
Dave Chinnera66979a2011-03-22 22:23:41 +110024#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26/*
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040027 * Inode locking rules:
Dave Chinner250df6e2011-03-22 22:23:36 +110028 *
29 * inode->i_lock protects:
Jchao Sunbafbc132022-05-24 08:05:40 -070030 * inode->i_state, inode->i_hash, __iget(), inode->i_io_list
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100031 * Inode LRU list locks protect:
Dave Chinner98b745c2011-07-08 14:14:39 +100032 * inode->i_sb->s_inode_lru, inode->i_lru
Dave Chinner74278da2015-03-04 12:37:22 -050033 * inode->i_sb->s_inode_list_lock protects:
34 * inode->i_sb->s_inodes, inode->i_sb_list
Christoph Hellwigf758eea2011-04-21 18:19:44 -060035 * bdi->wb.list_lock protects:
Dave Chinnerc7f54082015-03-04 14:07:22 -050036 * bdi->wb.b_{dirty,io,more_io,dirty_time}, inode->i_io_list
Dave Chinner67a23c42011-03-22 22:23:42 +110037 * inode_hash_lock protects:
38 * inode_hashtable, inode->i_hash
Dave Chinner250df6e2011-03-22 22:23:36 +110039 *
40 * Lock ordering:
Dave Chinner55fa6092011-03-22 22:23:40 +110041 *
Dave Chinner74278da2015-03-04 12:37:22 -050042 * inode->i_sb->s_inode_list_lock
Dave Chinner55fa6092011-03-22 22:23:40 +110043 * inode->i_lock
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100044 * Inode LRU list locks
Dave Chinnera66979a2011-03-22 22:23:41 +110045 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060046 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110047 * inode->i_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110048 *
49 * inode_hash_lock
Dave Chinner74278da2015-03-04 12:37:22 -050050 * inode->i_sb->s_inode_list_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110051 * inode->i_lock
52 *
53 * iunique_lock
54 * inode_hash_lock
Dave Chinner250df6e2011-03-22 22:23:36 +110055 */
56
Eric Dumazetfa3536c2006-03-26 01:37:24 -080057static unsigned int i_hash_mask __read_mostly;
58static unsigned int i_hash_shift __read_mostly;
Dave Chinner67a23c42011-03-22 22:23:42 +110059static struct hlist_head *inode_hashtable __read_mostly;
60static __cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Linus Torvalds1da177e2005-04-16 15:20:36 -070062/*
Jens Axboe7dcda1c2011-04-05 23:51:48 +020063 * Empty aops. Can be used for the cases where the user does not
64 * define any of the address_space operations.
65 */
66const struct address_space_operations empty_aops = {
67};
68EXPORT_SYMBOL(empty_aops);
69
70/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 * Statistics gathering..
72 */
73struct inodes_stat_t inodes_stat;
74
Glauber Costa3942c072013-08-28 10:17:53 +100075static DEFINE_PER_CPU(unsigned long, nr_inodes);
76static DEFINE_PER_CPU(unsigned long, nr_unused);
Dave Chinnercffbc8a2010-10-23 05:03:02 -040077
Manish Katiyar6b3304b2009-03-31 19:35:54 +053078static struct kmem_cache *inode_cachep __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Glauber Costa3942c072013-08-28 10:17:53 +100080static long get_nr_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040081{
Nick Piggin3e880fb2011-01-07 17:49:19 +110082 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100083 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +110084 for_each_possible_cpu(i)
85 sum += per_cpu(nr_inodes, i);
86 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040087}
88
Glauber Costa3942c072013-08-28 10:17:53 +100089static inline long get_nr_inodes_unused(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040090{
Dave Chinnerfcb94f72011-07-08 14:14:38 +100091 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100092 long sum = 0;
Dave Chinnerfcb94f72011-07-08 14:14:38 +100093 for_each_possible_cpu(i)
94 sum += per_cpu(nr_unused, i);
95 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040096}
97
Glauber Costa3942c072013-08-28 10:17:53 +100098long get_nr_dirty_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040099{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100100 /* not actually dirty inodes, but a wild approximation */
Glauber Costa3942c072013-08-28 10:17:53 +1000101 long nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400102 return nr_dirty > 0 ? nr_dirty : 0;
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400103}
104
105/*
106 * Handle nr_inode sysctl
107 */
108#ifdef CONFIG_SYSCTL
Joe Perches1f7e0612014-06-06 14:38:05 -0700109int proc_nr_inodes(struct ctl_table *table, int write,
Christoph Hellwig32927392020-04-24 08:43:38 +0200110 void *buffer, size_t *lenp, loff_t *ppos)
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400111{
112 inodes_stat.nr_inodes = get_nr_inodes();
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000113 inodes_stat.nr_unused = get_nr_inodes_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000114 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400115}
116#endif
117
Al Virobd9b51e2014-11-18 23:38:21 -0500118static int no_open(struct inode *inode, struct file *file)
119{
120 return -ENXIO;
121}
122
David Chinner2cb15992008-10-30 17:32:23 +1100123/**
Masahiro Yamada6e7c2b42017-05-08 15:57:53 -0700124 * inode_init_always - perform inode structure initialisation
Randy Dunlap0bc02f32009-01-06 14:41:13 -0800125 * @sb: superblock inode belongs to
126 * @inode: inode to initialise
David Chinner2cb15992008-10-30 17:32:23 +1100127 *
128 * These are initializations that need to be done on every inode
129 * allocation as the fields are not initialised by slab allocation.
130 */
Christoph Hellwig54e34622009-08-07 14:38:25 -0300131int inode_init_always(struct super_block *sb, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
Alexey Dobriyan6e1d5dc2009-09-21 17:01:11 -0700133 static const struct inode_operations empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500134 static const struct file_operations no_open_fops = {.open = no_open};
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530135 struct address_space *const mapping = &inode->i_data;
David Chinner2cb15992008-10-30 17:32:23 +1100136
137 inode->i_sb = sb;
138 inode->i_blkbits = sb->s_blocksize_bits;
139 inode->i_flags = 0;
Peter Zijlstra8019ad12020-03-04 11:28:31 +0100140 atomic64_set(&inode->i_sequence, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100141 atomic_set(&inode->i_count, 1);
142 inode->i_op = &empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500143 inode->i_fop = &no_open_fops;
Eric Biggersedbb35c2020-10-30 17:44:20 -0700144 inode->i_ino = 0;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200145 inode->__i_nlink = 1;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700146 inode->i_opflags = 0;
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200147 if (sb->s_xattr)
148 inode->i_opflags |= IOP_XATTR;
Eric W. Biederman92361632012-02-08 07:07:50 -0800149 i_uid_write(inode, 0);
150 i_gid_write(inode, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100151 atomic_set(&inode->i_writecount, 0);
152 inode->i_size = 0;
Jens Axboec75b1d92017-06-27 11:47:04 -0600153 inode->i_write_hint = WRITE_LIFE_NOT_SET;
David Chinner2cb15992008-10-30 17:32:23 +1100154 inode->i_blocks = 0;
155 inode->i_bytes = 0;
156 inode->i_generation = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100157 inode->i_pipe = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100158 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400159 inode->i_link = NULL;
Al Viro84e710d2016-04-15 00:58:55 -0400160 inode->i_dir_seq = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100161 inode->i_rdev = 0;
162 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500163
Tahsin Erdogan3d65ae42016-02-16 13:34:39 -0800164#ifdef CONFIG_CGROUP_WRITEBACK
165 inode->i_wb_frn_winner = 0;
166 inode->i_wb_frn_avg_time = 0;
167 inode->i_wb_frn_history = 0;
168#endif
169
David Chinner2cb15992008-10-30 17:32:23 +1100170 spin_lock_init(&inode->i_lock);
171 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
172
Al Viro9902af72016-04-15 15:08:36 -0400173 init_rwsem(&inode->i_rwsem);
174 lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
David Chinner2cb15992008-10-30 17:32:23 +1100175
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400176 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100177
178 mapping->a_ops = &empty_aops;
179 mapping->host = inode;
180 mapping->flags = 0;
Matthew Wilcox (Oracle)01c70262020-10-15 20:06:00 -0700181 if (sb->s_type->fs_flags & FS_THP_SUPPORT)
182 __set_bit(AS_THP_SUPPORT, &mapping->flags);
Darrick J. Wong829bc7872018-05-30 19:43:53 -0700183 mapping->wb_err = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700184 atomic_set(&mapping->i_mmap_writable, 0);
Song Liu09d91cd2019-09-23 15:38:03 -0700185#ifdef CONFIG_READ_ONLY_THP_FOR_FS
186 atomic_set(&mapping->nr_thps, 0);
187#endif
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800188 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800189 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100190 mapping->writeback_index = 0;
Sebastian Andrzej Siewior23ca0672021-09-01 10:44:03 +0200191 init_rwsem(&mapping->invalidate_lock);
192 lockdep_set_class_and_name(&mapping->invalidate_lock,
193 &sb->s_type->invalidate_lock_key,
194 "mapping.invalidate_lock");
David Chinner2cb15992008-10-30 17:32:23 +1100195 inode->i_private = NULL;
196 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400197 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400198#ifdef CONFIG_FS_POSIX_ACL
199 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
200#endif
David Chinner2cb15992008-10-30 17:32:23 +1100201
Eric Paris3be25f42009-05-21 17:01:26 -0400202#ifdef CONFIG_FSNOTIFY
203 inode->i_fsnotify_mask = 0;
204#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500205 inode->i_flctx = NULL;
Dongliang Mu64b79e62022-08-16 12:08:58 +0800206
207 if (unlikely(security_inode_alloc(inode)))
208 return -ENOMEM;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100209 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400210
Christoph Hellwig54e34622009-08-07 14:38:25 -0300211 return 0;
David Chinner2cb15992008-10-30 17:32:23 +1100212}
213EXPORT_SYMBOL(inode_init_always);
214
Al Virofdb0da82019-04-10 14:43:44 -0400215void free_inode_nonrcu(struct inode *inode)
216{
217 kmem_cache_free(inode_cachep, inode);
218}
219EXPORT_SYMBOL(free_inode_nonrcu);
220
221static void i_callback(struct rcu_head *head)
222{
223 struct inode *inode = container_of(head, struct inode, i_rcu);
224 if (inode->free_inode)
225 inode->free_inode(inode);
226 else
227 free_inode_nonrcu(inode);
228}
229
David Chinner2cb15992008-10-30 17:32:23 +1100230static struct inode *alloc_inode(struct super_block *sb)
231{
Al Virofdb0da82019-04-10 14:43:44 -0400232 const struct super_operations *ops = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 struct inode *inode;
234
Al Virofdb0da82019-04-10 14:43:44 -0400235 if (ops->alloc_inode)
236 inode = ops->alloc_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 else
David Chinner2cb15992008-10-30 17:32:23 +1100238 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Christoph Hellwig54e34622009-08-07 14:38:25 -0300240 if (!inode)
241 return NULL;
242
243 if (unlikely(inode_init_always(sb, inode))) {
Al Virofdb0da82019-04-10 14:43:44 -0400244 if (ops->destroy_inode) {
245 ops->destroy_inode(inode);
246 if (!ops->free_inode)
247 return NULL;
248 }
249 inode->free_inode = ops->free_inode;
250 i_callback(&inode->i_rcu);
Christoph Hellwig54e34622009-08-07 14:38:25 -0300251 return NULL;
252 }
253
254 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255}
256
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300257void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200259 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400260 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400262 fsnotify_inode_delete(inode);
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500263 locks_free_lock_context(inode);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100264 if (!inode->i_nlink) {
265 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
266 atomic_long_dec(&inode->i_sb->s_remove_count);
267 }
268
Al Virof19d4a82009-06-08 19:50:45 -0400269#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100270 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400271 posix_acl_release(inode->i_acl);
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100272 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400273 posix_acl_release(inode->i_default_acl);
274#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100275 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300276}
277EXPORT_SYMBOL(__destroy_inode);
278
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200279static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300280{
Al Virofdb0da82019-04-10 14:43:44 -0400281 const struct super_operations *ops = inode->i_sb->s_op;
282
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100283 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300284 __destroy_inode(inode);
Al Virofdb0da82019-04-10 14:43:44 -0400285 if (ops->destroy_inode) {
286 ops->destroy_inode(inode);
287 if (!ops->free_inode)
288 return;
289 }
290 inode->free_inode = ops->free_inode;
291 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100294/**
295 * drop_nlink - directly drop an inode's link count
296 * @inode: inode
297 *
298 * This is a low-level filesystem helper to replace any
299 * direct filesystem manipulation of i_nlink. In cases
300 * where we are attempting to track writes to the
301 * filesystem, a decrement to zero means an imminent
302 * write when the file is truncated and actually unlinked
303 * on the filesystem.
304 */
305void drop_nlink(struct inode *inode)
306{
307 WARN_ON(inode->i_nlink == 0);
308 inode->__i_nlink--;
309 if (!inode->i_nlink)
310 atomic_long_inc(&inode->i_sb->s_remove_count);
311}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +0200312EXPORT_SYMBOL_NS(drop_nlink, ANDROID_GKI_VFS_EXPORT_ONLY);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100313
314/**
315 * clear_nlink - directly zero an inode's link count
316 * @inode: inode
317 *
318 * This is a low-level filesystem helper to replace any
319 * direct filesystem manipulation of i_nlink. See
320 * drop_nlink() for why we care about i_nlink hitting zero.
321 */
322void clear_nlink(struct inode *inode)
323{
324 if (inode->i_nlink) {
325 inode->__i_nlink = 0;
326 atomic_long_inc(&inode->i_sb->s_remove_count);
327 }
328}
329EXPORT_SYMBOL(clear_nlink);
330
331/**
332 * set_nlink - directly set an inode's link count
333 * @inode: inode
334 * @nlink: new nlink (should be non-zero)
335 *
336 * This is a low-level filesystem helper to replace any
337 * direct filesystem manipulation of i_nlink.
338 */
339void set_nlink(struct inode *inode, unsigned int nlink)
340{
341 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100342 clear_nlink(inode);
343 } else {
344 /* Yes, some filesystems do change nlink from zero to one */
345 if (inode->i_nlink == 0)
346 atomic_long_dec(&inode->i_sb->s_remove_count);
347
348 inode->__i_nlink = nlink;
349 }
350}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +0200351EXPORT_SYMBOL_NS(set_nlink, ANDROID_GKI_VFS_EXPORT_ONLY);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100352
353/**
354 * inc_nlink - directly increment an inode's link count
355 * @inode: inode
356 *
357 * This is a low-level filesystem helper to replace any
358 * direct filesystem manipulation of i_nlink. Currently,
359 * it is only here for parity with dec_nlink().
360 */
361void inc_nlink(struct inode *inode)
362{
Al Virof4e0c302013-06-11 08:34:36 +0400363 if (unlikely(inode->i_nlink == 0)) {
364 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100365 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400366 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100367
368 inode->__i_nlink++;
369}
370EXPORT_SYMBOL(inc_nlink);
371
Dave Chinnerae233952018-03-06 17:30:34 -0800372static void __address_space_init_once(struct address_space *mapping)
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100373{
Johannes Weiner7b785642019-05-24 10:12:46 -0400374 xa_init_flags(&mapping->i_pages, XA_FLAGS_LOCK_IRQ | XA_FLAGS_ACCOUNT);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800375 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100376 INIT_LIST_HEAD(&mapping->private_list);
377 spin_lock_init(&mapping->private_lock);
Davidlohr Buesof808c132017-09-08 16:15:08 -0700378 mapping->i_mmap = RB_ROOT_CACHED;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100379}
Dave Chinnerae233952018-03-06 17:30:34 -0800380
381void address_space_init_once(struct address_space *mapping)
382{
383 memset(mapping, 0, sizeof(*mapping));
384 __address_space_init_once(mapping);
385}
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100386EXPORT_SYMBOL(address_space_init_once);
387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388/*
389 * These are initializations that only need to be done
390 * once, because the fields are idempotent across use
391 * of the inode, so let the slab aware of that.
392 */
393void inode_init_once(struct inode *inode)
394{
395 memset(inode, 0, sizeof(*inode));
396 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500398 INIT_LIST_HEAD(&inode->i_io_list);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700399 INIT_LIST_HEAD(&inode->i_wb_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100400 INIT_LIST_HEAD(&inode->i_lru);
Dave Chinnerae233952018-03-06 17:30:34 -0800401 __address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 i_size_ordered_init(inode);
403}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +0200404EXPORT_SYMBOL_NS(inode_init_once, ANDROID_GKI_VFS_EXPORT_ONLY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700406static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530408 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Christoph Lametera35afb82007-05-16 22:10:57 -0700410 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411}
412
413/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100414 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530416void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417{
Nick Piggin9e38d862010-10-23 06:55:17 -0400418 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419}
420
Al Viro7de9c6ee2010-10-23 11:11:40 -0400421/*
422 * get additional reference to inode; caller must already hold one.
423 */
424void ihold(struct inode *inode)
425{
426 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
427}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +0200428EXPORT_SYMBOL_NS(ihold, ANDROID_GKI_VFS_EXPORT_ONLY);
Al Viro7de9c6ee2010-10-23 11:11:40 -0400429
Nick Piggin9e38d862010-10-23 06:55:17 -0400430static void inode_lru_list_add(struct inode *inode)
431{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000432 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000433 this_cpu_inc(nr_unused);
Josef Bacik563f4002017-04-18 16:04:17 -0400434 else
435 inode->i_state |= I_REFERENCED;
Nick Piggin9e38d862010-10-23 06:55:17 -0400436}
437
Jan Kara4eff96d2012-11-26 16:29:51 -0800438/*
439 * Add inode to LRU if needed (inode is unused and clean).
440 *
441 * Needs inode->i_lock held.
442 */
443void inode_add_lru(struct inode *inode)
444{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500445 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
446 I_FREEING | I_WILL_FREE)) &&
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800447 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & SB_ACTIVE)
Jan Kara4eff96d2012-11-26 16:29:51 -0800448 inode_lru_list_add(inode);
449}
450
451
Nick Piggin9e38d862010-10-23 06:55:17 -0400452static void inode_lru_list_del(struct inode *inode)
453{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000454
455 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000456 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457}
458
Christoph Hellwig646ec462010-10-23 07:15:32 -0400459/**
460 * inode_sb_list_add - add inode to the superblock list of inodes
461 * @inode: inode to add
462 */
463void inode_sb_list_add(struct inode *inode)
464{
Dave Chinner74278da2015-03-04 12:37:22 -0500465 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100466 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500467 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400468}
469EXPORT_SYMBOL_GPL(inode_sb_list_add);
470
Dave Chinner55fa6092011-03-22 22:23:40 +1100471static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400472{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200473 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500474 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200475 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500476 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200477 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400478}
479
Dave Chinner4c51acb2010-10-23 06:58:09 -0400480static unsigned long hash(struct super_block *sb, unsigned long hashval)
481{
482 unsigned long tmp;
483
484 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
485 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400486 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
487 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400488}
489
490/**
491 * __insert_inode_hash - hash an inode
492 * @inode: unhashed inode
493 * @hashval: unsigned long value used to locate this object in the
494 * inode_hashtable.
495 *
496 * Add an inode to the inode hash for this superblock.
497 */
498void __insert_inode_hash(struct inode *inode, unsigned long hashval)
499{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400500 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
501
Dave Chinner67a23c42011-03-22 22:23:42 +1100502 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100503 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000504 hlist_add_head_rcu(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100505 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100506 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400507}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +0200508EXPORT_SYMBOL_NS(__insert_inode_hash, ANDROID_GKI_VFS_EXPORT_ONLY);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400509
510/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200511 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400512 * @inode: inode to unhash
513 *
514 * Remove an inode from the superblock.
515 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200516void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400517{
Dave Chinner67a23c42011-03-22 22:23:42 +1100518 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100519 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +0000520 hlist_del_init_rcu(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100521 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100522 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400523}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +0200524EXPORT_SYMBOL_NS(__remove_inode_hash, ANDROID_GKI_VFS_EXPORT_ONLY);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400525
Jan Karadbd57682012-05-03 14:48:02 +0200526void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400527{
Jan Kara08142572011-06-27 16:18:10 -0700528 /*
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700529 * We have to cycle the i_pages lock here because reclaim can be in the
Jan Kara08142572011-06-27 16:18:10 -0700530 * process of removing the last page (in __delete_from_page_cache())
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700531 * and we must not free the mapping under it.
Jan Kara08142572011-06-27 16:18:10 -0700532 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700533 xa_lock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400534 BUG_ON(inode->i_data.nrpages);
Hugh Dickins786b3112021-05-04 18:32:57 -0700535 /*
536 * Almost always, mapping_empty(&inode->i_data) here; but there are
537 * two known and long-standing ways in which nodes may get left behind
538 * (when deep radix-tree node allocation failed partway; or when THP
539 * collapse_file() failed). Until those two known cases are cleaned up,
540 * or a cleanup function is called here, do not BUG_ON(!mapping_empty),
541 * nor even WARN_ON(!mapping_empty).
542 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700543 xa_unlock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400544 BUG_ON(!list_empty(&inode->i_data.private_list));
545 BUG_ON(!(inode->i_state & I_FREEING));
546 BUG_ON(inode->i_state & I_CLEAR);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700547 BUG_ON(!list_empty(&inode->i_wb_list));
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100548 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400549 inode->i_state = I_FREEING | I_CLEAR;
550}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +0200551EXPORT_SYMBOL_NS(clear_inode, ANDROID_GKI_VFS_EXPORT_ONLY);
Al Virob0683aa2010-06-04 20:55:25 -0400552
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100553/*
554 * Free the inode passed in, removing it from the lists it is still connected
555 * to. We remove any pages still attached to the inode and wait for any IO that
556 * is still in progress before finally destroying the inode.
557 *
558 * An inode must already be marked I_FREEING so that we avoid the inode being
559 * moved back onto lists if we race with other code that manipulates the lists
560 * (e.g. writeback_single_inode). The caller is responsible for setting this.
561 *
562 * An inode must already be removed from the LRU list before being evicted from
563 * the cache. This should occur atomically with setting the I_FREEING state
564 * flag, so no inodes here should ever be on the LRU when being evicted.
565 */
Al Viro644da592010-06-07 13:21:05 -0400566static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400567{
568 const struct super_operations *op = inode->i_sb->s_op;
569
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100570 BUG_ON(!(inode->i_state & I_FREEING));
571 BUG_ON(!list_empty(&inode->i_lru));
572
Dave Chinnerc7f54082015-03-04 14:07:22 -0500573 if (!list_empty(&inode->i_io_list))
574 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200575
Dave Chinner55fa6092011-03-22 22:23:40 +1100576 inode_sb_list_del(inode);
577
Jan Kara169ebd92012-05-03 14:48:03 +0200578 /*
579 * Wait for flusher thread to be done with the inode so that filesystem
580 * does not start destroying it while writeback is still running. Since
581 * the inode has I_FREEING set, flusher thread won't start new work on
582 * the inode. We just have to wait for running writeback to finish.
583 */
584 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200585
Al Virobe7ce412010-06-04 19:40:39 -0400586 if (op->evict_inode) {
587 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400588 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700589 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200590 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400591 }
Al Viro661074e2010-06-04 20:19:55 -0400592 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
593 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100594
595 remove_inode_hash(inode);
596
597 spin_lock(&inode->i_lock);
598 wake_up_bit(&inode->i_state, __I_NEW);
599 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
600 spin_unlock(&inode->i_lock);
601
602 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400603}
604
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605/*
606 * dispose_list - dispose of the contents of a local list
607 * @head: the head of the list to free
608 *
609 * Dispose-list gets a local list with local inodes in it, so it doesn't
610 * need to worry about list corruption and SMP locks.
611 */
612static void dispose_list(struct list_head *head)
613{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 while (!list_empty(head)) {
615 struct inode *inode;
616
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100617 inode = list_first_entry(head, struct inode, i_lru);
618 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Al Viro644da592010-06-07 13:21:05 -0400620 evict(inode);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500621 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623}
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625/**
Al Viro63997e92010-10-25 20:49:35 -0400626 * evict_inodes - evict all evictable inodes for a superblock
627 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 *
Al Viro63997e92010-10-25 20:49:35 -0400629 * Make sure that no inodes with zero refcount are retained. This is
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800630 * called by superblock shutdown after having SB_ACTIVE flag removed,
Al Viro63997e92010-10-25 20:49:35 -0400631 * so any inode reaching zero refcount during or after that call will
632 * be immediately evicted.
633 */
634void evict_inodes(struct super_block *sb)
635{
636 struct inode *inode, *next;
637 LIST_HEAD(dispose);
638
Josef Bacikac05fbb2015-03-04 16:52:52 -0500639again:
Dave Chinner74278da2015-03-04 12:37:22 -0500640 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400641 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
642 if (atomic_read(&inode->i_count))
643 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100644
645 spin_lock(&inode->i_lock);
646 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
647 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400648 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100649 }
Al Viro63997e92010-10-25 20:49:35 -0400650
651 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100652 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100653 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100654 list_add(&inode->i_lru, &dispose);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500655
656 /*
657 * We can have a ton of inodes to evict at unmount time given
658 * enough memory, check to see if we need to go to sleep for a
659 * bit so we don't livelock.
660 */
661 if (need_resched()) {
662 spin_unlock(&sb->s_inode_list_lock);
663 cond_resched();
664 dispose_list(&dispose);
665 goto again;
666 }
Al Viro63997e92010-10-25 20:49:35 -0400667 }
Dave Chinner74278da2015-03-04 12:37:22 -0500668 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400669
670 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400671}
Darrick J. Wong799ea9e2017-08-18 18:08:25 -0700672EXPORT_SYMBOL_GPL(evict_inodes);
Al Viro63997e92010-10-25 20:49:35 -0400673
674/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200675 * invalidate_inodes - attempt to free all inodes on a superblock
676 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100677 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200678 *
679 * Attempts to free all inodes for a given superblock. If there were any
680 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100681 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
682 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 */
NeilBrown93b270f2011-02-24 17:25:47 +1100684int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400686 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200687 struct inode *inode, *next;
688 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
Eric Sandeen04646ae2019-12-06 10:54:23 -0600690again:
Dave Chinner74278da2015-03-04 12:37:22 -0500691 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200692 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100693 spin_lock(&inode->i_lock);
694 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
695 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100697 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500698 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100699 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100700 busy = 1;
701 continue;
702 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200703 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100704 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200705 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 continue;
707 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200708
Christoph Hellwig99a38912010-10-23 19:07:20 +0200709 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100710 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100711 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100712 list_add(&inode->i_lru, &dispose);
Eric Sandeen04646ae2019-12-06 10:54:23 -0600713 if (need_resched()) {
714 spin_unlock(&sb->s_inode_list_lock);
715 cond_resched();
716 dispose_list(&dispose);
717 goto again;
718 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 }
Dave Chinner74278da2015-03-04 12:37:22 -0500720 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
Christoph Hellwiga0318782010-10-24 19:40:33 +0200722 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724 return busy;
725}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000728 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 *
730 * Any inodes which are pinned purely because of attached pagecache have their
Nick Piggin9e38d862010-10-23 06:55:17 -0400731 * pagecache removed. If the inode has metadata buffers attached to
732 * mapping->private_list then try to remove them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400734 * If the inode has the I_REFERENCED flag set, then it means that it has been
735 * used recently - the flag is set in iput_final(). When we encounter such an
736 * inode, clear the flag and move it to the back of the LRU so it gets another
737 * pass through the LRU before it gets reclaimed. This is necessary because of
738 * the fact we are doing lazy LRU updates to minimise lock contention so the
739 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
740 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800742static enum lru_status inode_lru_isolate(struct list_head *item,
743 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000744{
745 struct list_head *freeable = arg;
746 struct inode *inode = container_of(item, struct inode, i_lru);
747
748 /*
749 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
750 * If we fail to get the lock, just skip it.
751 */
752 if (!spin_trylock(&inode->i_lock))
753 return LRU_SKIP;
754
755 /*
756 * Referenced or dirty inodes are still in use. Give them another pass
757 * through the LRU as we canot reclaim them now.
758 */
759 if (atomic_read(&inode->i_count) ||
760 (inode->i_state & ~I_REFERENCED)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800761 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000762 spin_unlock(&inode->i_lock);
763 this_cpu_dec(nr_unused);
764 return LRU_REMOVED;
765 }
766
Dave Chinner69056ee2019-02-12 15:35:51 -0800767 /* recently referenced inodes get one more pass */
768 if (inode->i_state & I_REFERENCED) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000769 inode->i_state &= ~I_REFERENCED;
770 spin_unlock(&inode->i_lock);
771 return LRU_ROTATE;
772 }
773
Johannes Weiner7ae12c82021-09-02 14:53:24 -0700774 if (inode_has_buffers(inode) || !mapping_empty(&inode->i_data)) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000775 __iget(inode);
776 spin_unlock(&inode->i_lock);
777 spin_unlock(lru_lock);
778 if (remove_inode_buffers(inode)) {
779 unsigned long reap;
780 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
781 if (current_is_kswapd())
782 __count_vm_events(KSWAPD_INODESTEAL, reap);
783 else
784 __count_vm_events(PGINODESTEAL, reap);
785 if (current->reclaim_state)
786 current->reclaim_state->reclaimed_slab += reap;
787 }
788 iput(inode);
789 spin_lock(lru_lock);
790 return LRU_RETRY;
791 }
792
793 WARN_ON(inode->i_state & I_NEW);
794 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800795 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000796 spin_unlock(&inode->i_lock);
797
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000798 this_cpu_dec(nr_unused);
799 return LRU_REMOVED;
800}
801
802/*
803 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
804 * This is called from the superblock shrinker function with a number of inodes
805 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
806 * then are freed outside inode_lock by dispose_list().
807 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800808long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809{
810 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000811 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
Vladimir Davydov503c3582015-02-12 14:58:47 -0800813 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
814 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000816 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817}
818
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819static void __wait_on_freeing_inode(struct inode *inode);
820/*
821 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530823static struct inode *find_inode(struct super_block *sb,
824 struct hlist_head *head,
825 int (*test)(struct inode *, void *),
826 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530828 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
830repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800831 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500832 if (inode->i_sb != sb)
833 continue;
834 if (!test(inode, data))
835 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100836 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400837 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 __wait_on_freeing_inode(inode);
839 goto repeat;
840 }
Al Viroc2b6d622018-06-28 15:53:17 -0400841 if (unlikely(inode->i_state & I_CREATING)) {
842 spin_unlock(&inode->i_lock);
843 return ERR_PTR(-ESTALE);
844 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400845 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100846 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400847 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400849 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850}
851
852/*
853 * find_inode_fast is the fast path version of find_inode, see the comment at
854 * iget_locked for details.
855 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530856static struct inode *find_inode_fast(struct super_block *sb,
857 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530859 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860
861repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800862 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500863 if (inode->i_ino != ino)
864 continue;
865 if (inode->i_sb != sb)
866 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100867 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400868 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 __wait_on_freeing_inode(inode);
870 goto repeat;
871 }
Al Viroc2b6d622018-06-28 15:53:17 -0400872 if (unlikely(inode->i_state & I_CREATING)) {
873 spin_unlock(&inode->i_lock);
874 return ERR_PTR(-ESTALE);
875 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400876 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100877 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400878 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400880 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881}
882
Eric Dumazetf991bd22010-10-23 11:18:01 -0400883/*
884 * Each cpu owns a range of LAST_INO_BATCH numbers.
885 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
886 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100887 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400888 * This does not significantly increase overflow rate because every CPU can
889 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
890 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
891 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
892 * overflow rate by 2x, which does not seem too significant.
893 *
894 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
895 * error if st_ino won't fit in target struct field. Use 32bit counter
896 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100897 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400898#define LAST_INO_BATCH 1024
899static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100900
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400901unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400902{
903 unsigned int *p = &get_cpu_var(last_ino);
904 unsigned int res = *p;
905
906#ifdef CONFIG_SMP
907 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
908 static atomic_t shared_last_ino;
909 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
910
911 res = next - LAST_INO_BATCH;
912 }
913#endif
914
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300915 res++;
916 /* get_next_ino should not provide a 0 inode number */
917 if (unlikely(!res))
918 res++;
919 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400920 put_cpu_var(last_ino);
921 return res;
David Chinner8290c352008-10-30 17:35:24 +1100922}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400923EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100924
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200926 * new_inode_pseudo - obtain an inode
927 * @sb: superblock
928 *
929 * Allocates a new inode for given superblock.
930 * Inode wont be chained in superblock s_inodes list
931 * This means :
932 * - fs can't be unmount
933 * - quotas, fsnotify, writeback can't work
934 */
935struct inode *new_inode_pseudo(struct super_block *sb)
936{
937 struct inode *inode = alloc_inode(sb);
938
939 if (inode) {
940 spin_lock(&inode->i_lock);
941 inode->i_state = 0;
942 spin_unlock(&inode->i_lock);
943 INIT_LIST_HEAD(&inode->i_sb_list);
944 }
945 return inode;
946}
947
948/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 * new_inode - obtain an inode
950 * @sb: superblock
951 *
Mel Gorman769848c2007-07-17 04:03:05 -0700952 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800953 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700954 * If HIGHMEM pages are unsuitable or it is known that pages allocated
955 * for the page cache are not reclaimable or migratable,
956 * mapping_set_gfp_mask() must be called with suitable flags on the
957 * newly created inode's mapping
958 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 */
960struct inode *new_inode(struct super_block *sb)
961{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530962 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963
Dave Chinner74278da2015-03-04 12:37:22 -0500964 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530965
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200966 inode = new_inode_pseudo(sb);
967 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100968 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 return inode;
970}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971EXPORT_SYMBOL(new_inode);
972
Peter Zijlstra14358e62007-10-14 01:38:33 +0200973#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400974void lockdep_annotate_inode_mutex_key(struct inode *inode)
975{
Namhyung Kima3314a02010-10-11 22:38:00 +0900976 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200977 struct file_system_type *type = inode->i_sb->s_type;
978
Jan Kara9a7aa122009-06-04 15:26:49 +0200979 /* Set new key only if filesystem hasn't already changed it */
Al Viro9902af72016-04-15 15:08:36 -0400980 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200981 /*
982 * ensure nobody is actually holding i_mutex
983 */
Al Viro9902af72016-04-15 15:08:36 -0400984 // mutex_destroy(&inode->i_mutex);
985 init_rwsem(&inode->i_rwsem);
986 lockdep_set_class(&inode->i_rwsem,
Jan Kara9a7aa122009-06-04 15:26:49 +0200987 &type->i_mutex_dir_key);
988 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200989 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400990}
991EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200992#endif
Josh Boyere096d0c2011-08-25 07:48:12 -0400993
994/**
995 * unlock_new_inode - clear the I_NEW state and wake up any waiters
996 * @inode: new inode to unlock
997 *
998 * Called when the inode is fully initialised to clear the new state of the
999 * inode and wake up anyone waiting for the inode to finish initialisation.
1000 */
1001void unlock_new_inode(struct inode *inode)
1002{
1003 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001004 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001005 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -04001006 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro310fa7a2012-03-10 17:07:28 -05001007 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +11001008 wake_up_bit(&inode->i_state, __I_NEW);
1009 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02001011EXPORT_SYMBOL_NS(unlock_new_inode, ANDROID_GKI_VFS_EXPORT_ONLY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
Al Viroc2b6d622018-06-28 15:53:17 -04001013void discard_new_inode(struct inode *inode)
1014{
1015 lockdep_annotate_inode_mutex_key(inode);
1016 spin_lock(&inode->i_lock);
1017 WARN_ON(!(inode->i_state & I_NEW));
1018 inode->i_state &= ~I_NEW;
1019 smp_mb();
1020 wake_up_bit(&inode->i_state, __I_NEW);
1021 spin_unlock(&inode->i_lock);
1022 iput(inode);
1023}
1024EXPORT_SYMBOL(discard_new_inode);
1025
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001026/**
Jan Kara40f99ad2023-06-01 12:58:24 +02001027 * lock_two_inodes - lock two inodes (may be regular files but also dirs)
1028 *
1029 * Lock any non-NULL argument. The caller must make sure that if he is passing
1030 * in two directories, one is not ancestor of the other. Zero, one or two
1031 * objects may be locked by this function.
1032 *
1033 * @inode1: first inode to lock
1034 * @inode2: second inode to lock
1035 * @subclass1: inode lock subclass for the first lock obtained
1036 * @subclass2: inode lock subclass for the second lock obtained
1037 */
1038void lock_two_inodes(struct inode *inode1, struct inode *inode2,
1039 unsigned subclass1, unsigned subclass2)
1040{
1041 if (!inode1 || !inode2) {
1042 /*
1043 * Make sure @subclass1 will be used for the acquired lock.
1044 * This is not strictly necessary (no current caller cares) but
1045 * let's keep things consistent.
1046 */
1047 if (!inode1)
1048 swap(inode1, inode2);
1049 goto lock;
1050 }
1051
1052 /*
1053 * If one object is directory and the other is not, we must make sure
1054 * to lock directory first as the other object may be its child.
1055 */
1056 if (S_ISDIR(inode2->i_mode) == S_ISDIR(inode1->i_mode)) {
1057 if (inode1 > inode2)
1058 swap(inode1, inode2);
1059 } else if (!S_ISDIR(inode1->i_mode))
1060 swap(inode1, inode2);
1061lock:
1062 if (inode1)
1063 inode_lock_nested(inode1, subclass1);
1064 if (inode2 && inode2 != inode1)
1065 inode_lock_nested(inode2, subclass2);
1066}
1067
1068/**
J. Bruce Fields375e2892012-04-18 15:16:33 -04001069 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001070 *
1071 * Lock any non-NULL argument that is not a directory.
1072 * Zero, one or two objects may be locked by this function.
1073 *
J. Bruce Fields375e2892012-04-18 15:16:33 -04001074 * @inode1: first inode to lock
1075 * @inode2: second inode to lock
1076 */
1077void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1078{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001079 if (inode1 > inode2)
1080 swap(inode1, inode2);
1081
1082 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001083 inode_lock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001084 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001085 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001086}
1087EXPORT_SYMBOL(lock_two_nondirectories);
1088
1089/**
1090 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
1091 * @inode1: first inode to unlock
1092 * @inode2: second inode to unlock
1093 */
1094void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1095{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001096 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001097 inode_unlock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001098 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001099 inode_unlock(inode2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001100}
1101EXPORT_SYMBOL(unlock_two_nondirectories);
1102
1103/**
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001104 * inode_insert5 - obtain an inode from a mounted file system
1105 * @inode: pre-allocated inode to use for insert to cache
1106 * @hashval: hash value (usually inode number) to get
1107 * @test: callback used for comparisons between inodes
1108 * @set: callback used to initialize a new struct inode
1109 * @data: opaque data pointer to pass to @test and @set
1110 *
1111 * Search for the inode specified by @hashval and @data in the inode cache,
1112 * and if present it is return it with an increased reference count. This is
1113 * a variant of iget5_locked() for callers that don't want to fail on memory
1114 * allocation of inode.
1115 *
1116 * If the inode is not in cache, insert the pre-allocated inode to cache and
1117 * return it locked, hashed, and with the I_NEW flag set. The file system gets
1118 * to fill it in before unlocking it via unlock_new_inode().
1119 *
1120 * Note both @test and @set are called with the inode_hash_lock held, so can't
1121 * sleep.
1122 */
1123struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
1124 int (*test)(struct inode *, void *),
1125 int (*set)(struct inode *, void *), void *data)
1126{
1127 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1128 struct inode *old;
Miklos Szeredie9505642018-07-24 15:01:55 +02001129 bool creating = inode->i_state & I_CREATING;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001130
1131again:
1132 spin_lock(&inode_hash_lock);
1133 old = find_inode(inode->i_sb, head, test, data);
1134 if (unlikely(old)) {
1135 /*
1136 * Uhhuh, somebody else created the same inode under us.
1137 * Use the old inode instead of the preallocated one.
1138 */
1139 spin_unlock(&inode_hash_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001140 if (IS_ERR(old))
1141 return NULL;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001142 wait_on_inode(old);
1143 if (unlikely(inode_unhashed(old))) {
1144 iput(old);
1145 goto again;
1146 }
1147 return old;
1148 }
1149
1150 if (set && unlikely(set(inode, data))) {
1151 inode = NULL;
1152 goto unlock;
1153 }
1154
1155 /*
1156 * Return the locked inode with I_NEW set, the
1157 * caller is responsible for filling in the contents
1158 */
1159 spin_lock(&inode->i_lock);
1160 inode->i_state |= I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001161 hlist_add_head_rcu(&inode->i_hash, head);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001162 spin_unlock(&inode->i_lock);
Miklos Szeredie9505642018-07-24 15:01:55 +02001163 if (!creating)
1164 inode_sb_list_add(inode);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001165unlock:
1166 spin_unlock(&inode_hash_lock);
1167
1168 return inode;
1169}
1170EXPORT_SYMBOL(inode_insert5);
1171
1172/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001173 * iget5_locked - obtain an inode from a mounted file system
1174 * @sb: super block of file system
1175 * @hashval: hash value (usually inode number) to get
1176 * @test: callback used for comparisons between inodes
1177 * @set: callback used to initialize a new struct inode
1178 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001180 * Search for the inode specified by @hashval and @data in the inode cache,
1181 * and if present it is return it with an increased reference count. This is
1182 * a generalized version of iget_locked() for file systems where the inode
1183 * number is not sufficient for unique identification of an inode.
1184 *
1185 * If the inode is not in cache, allocate a new inode and return it locked,
1186 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1187 * before unlocking it via unlock_new_inode().
1188 *
1189 * Note both @test and @set are called with the inode_hash_lock held, so can't
1190 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001192struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1193 int (*test)(struct inode *, void *),
1194 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195{
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001196 struct inode *inode = ilookup5(sb, hashval, test, data);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001197
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001198 if (!inode) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001199 struct inode *new = alloc_inode(sb);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001200
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001201 if (new) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001202 new->i_state = 0;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001203 inode = inode_insert5(new, hashval, test, set, data);
1204 if (unlikely(inode != new))
Miklos Szeredie9505642018-07-24 15:01:55 +02001205 destroy_inode(new);
Al Viro2864f302016-07-03 23:15:21 -04001206 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 }
1208 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02001210EXPORT_SYMBOL_NS(iget5_locked, ANDROID_GKI_VFS_EXPORT_ONLY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001212/**
1213 * iget_locked - obtain an inode from a mounted file system
1214 * @sb: super block of file system
1215 * @ino: inode number to get
1216 *
1217 * Search for the inode specified by @ino in the inode cache and if present
1218 * return it with an increased reference count. This is for file systems
1219 * where the inode number is sufficient for unique identification of an inode.
1220 *
1221 * If the inode is not in cache, allocate a new inode and return it locked,
1222 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1223 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001225struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001227 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301228 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001229again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001230 spin_lock(&inode_hash_lock);
1231 inode = find_inode_fast(sb, head, ino);
1232 spin_unlock(&inode_hash_lock);
1233 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001234 if (IS_ERR(inode))
1235 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001236 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001237 if (unlikely(inode_unhashed(inode))) {
1238 iput(inode);
1239 goto again;
1240 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001241 return inode;
1242 }
1243
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 inode = alloc_inode(sb);
1245 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301246 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247
Dave Chinner67a23c42011-03-22 22:23:42 +11001248 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 /* We released the lock, so.. */
1250 old = find_inode_fast(sb, head, ino);
1251 if (!old) {
1252 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001253 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001254 inode->i_state = I_NEW;
David Howells3f19b2a2017-12-01 11:40:16 +00001255 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001256 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001257 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001258 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259
1260 /* Return the locked inode with I_NEW set, the
1261 * caller is responsible for filling in the contents
1262 */
1263 return inode;
1264 }
1265
1266 /*
1267 * Uhhuh, somebody else created the same inode under
1268 * us. Use the old inode instead of the one we just
1269 * allocated.
1270 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001271 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 destroy_inode(inode);
Al Viroc2b6d622018-06-28 15:53:17 -04001273 if (IS_ERR(old))
1274 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 inode = old;
1276 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001277 if (unlikely(inode_unhashed(inode))) {
1278 iput(inode);
1279 goto again;
1280 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 }
1282 return inode;
1283}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001284EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001286/*
1287 * search the inode cache for a matching inode number.
1288 * If we find one, then the inode number we are trying to
1289 * allocate is not unique and so we should not use it.
1290 *
1291 * Returns 1 if the inode number is unique, 0 if it is not.
1292 */
1293static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1294{
1295 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001296 struct inode *inode;
1297
David Howells3f19b2a2017-12-01 11:40:16 +00001298 hlist_for_each_entry_rcu(inode, b, i_hash) {
1299 if (inode->i_ino == ino && inode->i_sb == sb)
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001300 return 0;
1301 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001302 return 1;
1303}
1304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305/**
1306 * iunique - get a unique inode number
1307 * @sb: superblock
1308 * @max_reserved: highest reserved inode number
1309 *
1310 * Obtain an inode number that is unique on the system for a given
1311 * superblock. This is used by file systems that have no natural
1312 * permanent inode numbering system. An inode number is returned that
1313 * is higher than the reserved limit but unique.
1314 *
1315 * BUGS:
1316 * With a large number of inodes live on the file system this function
1317 * currently becomes quite slow.
1318 */
1319ino_t iunique(struct super_block *sb, ino_t max_reserved)
1320{
Jeff Layton866b04f2007-05-08 00:32:29 -07001321 /*
1322 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1323 * error if st_ino won't fit in target struct field. Use 32bit counter
1324 * here to attempt to avoid that.
1325 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001326 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001327 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329
David Howells3f19b2a2017-12-01 11:40:16 +00001330 rcu_read_lock();
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001331 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001332 do {
1333 if (counter <= max_reserved)
1334 counter = max_reserved + 1;
1335 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001336 } while (!test_inode_iunique(sb, res));
1337 spin_unlock(&iunique_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001338 rcu_read_unlock();
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001339
1340 return res;
1341}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02001342EXPORT_SYMBOL_NS(iunique, ANDROID_GKI_VFS_EXPORT_ONLY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343
1344struct inode *igrab(struct inode *inode)
1345{
Dave Chinner250df6e2011-03-22 22:23:36 +11001346 spin_lock(&inode->i_lock);
1347 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001349 spin_unlock(&inode->i_lock);
1350 } else {
1351 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 /*
1353 * Handle the case where s_op->clear_inode is not been
1354 * called yet, and somebody is calling igrab
1355 * while the inode is getting freed.
1356 */
1357 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001358 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 return inode;
1360}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361EXPORT_SYMBOL(igrab);
1362
1363/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001364 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 * @sb: super block of file system to search
1366 * @hashval: hash value (usually inode number) to search for
1367 * @test: callback used for comparisons between inodes
1368 * @data: opaque data pointer to pass to @test
1369 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001370 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001372 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001373 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001374 * Note: I_NEW is not waited upon so you have to be very careful what you do
1375 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001376 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001377 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001378 */
1379struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1380 int (*test)(struct inode *, void *), void *data)
1381{
1382 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001383 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001384
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001385 spin_lock(&inode_hash_lock);
1386 inode = find_inode(sb, head, test, data);
1387 spin_unlock(&inode_hash_lock);
1388
Al Viroc2b6d622018-06-28 15:53:17 -04001389 return IS_ERR(inode) ? NULL : inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001390}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001391EXPORT_SYMBOL(ilookup5_nowait);
1392
1393/**
1394 * ilookup5 - search for an inode in the inode cache
1395 * @sb: super block of file system to search
1396 * @hashval: hash value (usually inode number) to search for
1397 * @test: callback used for comparisons between inodes
1398 * @data: opaque data pointer to pass to @test
1399 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001400 * Search for the inode specified by @hashval and @data in the inode cache,
1401 * and if the inode is in the cache, return the inode with an incremented
1402 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001403 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001405 * This is a generalized version of ilookup() for file systems where the
1406 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001408 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 */
1410struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1411 int (*test)(struct inode *, void *), void *data)
1412{
Al Viro2864f302016-07-03 23:15:21 -04001413 struct inode *inode;
1414again:
1415 inode = ilookup5_nowait(sb, hashval, test, data);
1416 if (inode) {
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001417 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001418 if (unlikely(inode_unhashed(inode))) {
1419 iput(inode);
1420 goto again;
1421 }
1422 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001423 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02001425EXPORT_SYMBOL_NS(ilookup5, ANDROID_GKI_VFS_EXPORT_ONLY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
1427/**
1428 * ilookup - search for an inode in the inode cache
1429 * @sb: super block of file system to search
1430 * @ino: inode number to search for
1431 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001432 * Search for the inode @ino in the inode cache, and if the inode is in the
1433 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 */
1435struct inode *ilookup(struct super_block *sb, unsigned long ino)
1436{
1437 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001438 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001439again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001440 spin_lock(&inode_hash_lock);
1441 inode = find_inode_fast(sb, head, ino);
1442 spin_unlock(&inode_hash_lock);
1443
Al Viro2864f302016-07-03 23:15:21 -04001444 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001445 if (IS_ERR(inode))
1446 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001447 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001448 if (unlikely(inode_unhashed(inode))) {
1449 iput(inode);
1450 goto again;
1451 }
1452 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001453 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455EXPORT_SYMBOL(ilookup);
1456
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001457/**
1458 * find_inode_nowait - find an inode in the inode cache
1459 * @sb: super block of file system to search
1460 * @hashval: hash value (usually inode number) to search for
1461 * @match: callback used for comparisons between inodes
1462 * @data: opaque data pointer to pass to @match
1463 *
1464 * Search for the inode specified by @hashval and @data in the inode
1465 * cache, where the helper function @match will return 0 if the inode
1466 * does not match, 1 if the inode does match, and -1 if the search
1467 * should be stopped. The @match function must be responsible for
1468 * taking the i_lock spin_lock and checking i_state for an inode being
1469 * freed or being initialized, and incrementing the reference count
1470 * before returning 1. It also must not sleep, since it is called with
1471 * the inode_hash_lock spinlock held.
1472 *
1473 * This is a even more generalized version of ilookup5() when the
1474 * function must never block --- find_inode() can block in
1475 * __wait_on_freeing_inode() --- or when the caller can not increment
1476 * the reference count because the resulting iput() might cause an
1477 * inode eviction. The tradeoff is that the @match funtion must be
1478 * very carefully implemented.
1479 */
1480struct inode *find_inode_nowait(struct super_block *sb,
1481 unsigned long hashval,
1482 int (*match)(struct inode *, unsigned long,
1483 void *),
1484 void *data)
1485{
1486 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1487 struct inode *inode, *ret_inode = NULL;
1488 int mval;
1489
1490 spin_lock(&inode_hash_lock);
1491 hlist_for_each_entry(inode, head, i_hash) {
1492 if (inode->i_sb != sb)
1493 continue;
1494 mval = match(inode, hashval, data);
1495 if (mval == 0)
1496 continue;
1497 if (mval == 1)
1498 ret_inode = inode;
1499 goto out;
1500 }
1501out:
1502 spin_unlock(&inode_hash_lock);
1503 return ret_inode;
1504}
1505EXPORT_SYMBOL(find_inode_nowait);
1506
David Howells3f19b2a2017-12-01 11:40:16 +00001507/**
1508 * find_inode_rcu - find an inode in the inode cache
1509 * @sb: Super block of file system to search
1510 * @hashval: Key to hash
1511 * @test: Function to test match on an inode
1512 * @data: Data for test function
1513 *
1514 * Search for the inode specified by @hashval and @data in the inode cache,
1515 * where the helper function @test will return 0 if the inode does not match
1516 * and 1 if it does. The @test function must be responsible for taking the
1517 * i_lock spin_lock and checking i_state for an inode being freed or being
1518 * initialized.
1519 *
1520 * If successful, this will return the inode for which the @test function
1521 * returned 1 and NULL otherwise.
1522 *
1523 * The @test function is not permitted to take a ref on any inode presented.
1524 * It is also not permitted to sleep.
1525 *
1526 * The caller must hold the RCU read lock.
1527 */
1528struct inode *find_inode_rcu(struct super_block *sb, unsigned long hashval,
1529 int (*test)(struct inode *, void *), void *data)
1530{
1531 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1532 struct inode *inode;
1533
1534 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1535 "suspicious find_inode_rcu() usage");
1536
1537 hlist_for_each_entry_rcu(inode, head, i_hash) {
1538 if (inode->i_sb == sb &&
1539 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)) &&
1540 test(inode, data))
1541 return inode;
1542 }
1543 return NULL;
1544}
1545EXPORT_SYMBOL(find_inode_rcu);
1546
1547/**
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001548 * find_inode_by_ino_rcu - Find an inode in the inode cache
David Howells3f19b2a2017-12-01 11:40:16 +00001549 * @sb: Super block of file system to search
1550 * @ino: The inode number to match
1551 *
1552 * Search for the inode specified by @hashval and @data in the inode cache,
1553 * where the helper function @test will return 0 if the inode does not match
1554 * and 1 if it does. The @test function must be responsible for taking the
1555 * i_lock spin_lock and checking i_state for an inode being freed or being
1556 * initialized.
1557 *
1558 * If successful, this will return the inode for which the @test function
1559 * returned 1 and NULL otherwise.
1560 *
1561 * The @test function is not permitted to take a ref on any inode presented.
1562 * It is also not permitted to sleep.
1563 *
1564 * The caller must hold the RCU read lock.
1565 */
1566struct inode *find_inode_by_ino_rcu(struct super_block *sb,
1567 unsigned long ino)
1568{
1569 struct hlist_head *head = inode_hashtable + hash(sb, ino);
1570 struct inode *inode;
1571
1572 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
1573 "suspicious find_inode_by_ino_rcu() usage");
1574
1575 hlist_for_each_entry_rcu(inode, head, i_hash) {
1576 if (inode->i_ino == ino &&
1577 inode->i_sb == sb &&
1578 !(READ_ONCE(inode->i_state) & (I_FREEING | I_WILL_FREE)))
1579 return inode;
1580 }
1581 return NULL;
1582}
1583EXPORT_SYMBOL(find_inode_by_ino_rcu);
1584
Al Viro261bca82008-12-30 01:48:21 -05001585int insert_inode_locked(struct inode *inode)
1586{
1587 struct super_block *sb = inode->i_sb;
1588 ino_t ino = inode->i_ino;
1589 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001590
Al Viro261bca82008-12-30 01:48:21 -05001591 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001592 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001593 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001594 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001595 if (old->i_ino != ino)
1596 continue;
1597 if (old->i_sb != sb)
1598 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001599 spin_lock(&old->i_lock);
1600 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1601 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001602 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001603 }
Al Viro72a43d62009-05-13 19:13:40 +01001604 break;
1605 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001606 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001607 spin_lock(&inode->i_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001608 inode->i_state |= I_NEW | I_CREATING;
David Howells3f19b2a2017-12-01 11:40:16 +00001609 hlist_add_head_rcu(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001610 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001611 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001612 return 0;
1613 }
Al Viroc2b6d622018-06-28 15:53:17 -04001614 if (unlikely(old->i_state & I_CREATING)) {
1615 spin_unlock(&old->i_lock);
1616 spin_unlock(&inode_hash_lock);
1617 return -EBUSY;
1618 }
Al Viro261bca82008-12-30 01:48:21 -05001619 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001620 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001621 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001622 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001623 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001624 iput(old);
1625 return -EBUSY;
1626 }
1627 iput(old);
1628 }
1629}
Al Viro261bca82008-12-30 01:48:21 -05001630EXPORT_SYMBOL(insert_inode_locked);
1631
1632int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1633 int (*test)(struct inode *, void *), void *data)
1634{
Al Viroc2b6d622018-06-28 15:53:17 -04001635 struct inode *old;
1636
1637 inode->i_state |= I_CREATING;
1638 old = inode_insert5(inode, hashval, test, NULL, data);
Al Viro261bca82008-12-30 01:48:21 -05001639
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001640 if (old != inode) {
Al Viro261bca82008-12-30 01:48:21 -05001641 iput(old);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001642 return -EBUSY;
Al Viro261bca82008-12-30 01:48:21 -05001643 }
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001644 return 0;
Al Viro261bca82008-12-30 01:48:21 -05001645}
Al Viro261bca82008-12-30 01:48:21 -05001646EXPORT_SYMBOL(insert_inode_locked4);
1647
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
Al Viro45321ac2010-06-07 13:43:19 -04001649int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{
Al Viro45321ac2010-06-07 13:43:19 -04001651 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653EXPORT_SYMBOL(generic_delete_inode);
1654
Al Viro45321ac2010-06-07 13:43:19 -04001655/*
Al Viro45321ac2010-06-07 13:43:19 -04001656 * Called when we're dropping the last reference
1657 * to an inode.
1658 *
1659 * Call the FS "drop_inode()" function, defaulting to
1660 * the legacy UNIX filesystem behaviour. If it tells
1661 * us to evict inode, do so. Otherwise, retain inode
1662 * in cache if fs is alive, sync and evict if fs is
1663 * shutting down.
1664 */
1665static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666{
1667 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001668 const struct super_operations *op = inode->i_sb->s_op;
David Howells3f19b2a2017-12-01 11:40:16 +00001669 unsigned long state;
Al Viro45321ac2010-06-07 13:43:19 -04001670 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671
Dave Chinner250df6e2011-03-22 22:23:36 +11001672 WARN_ON(inode->i_state & I_NEW);
1673
Al Viroe7f59092011-07-07 15:45:59 -04001674 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001675 drop = op->drop_inode(inode);
1676 else
1677 drop = generic_drop_inode(inode);
1678
Hao Li88149082020-12-08 10:08:43 +08001679 if (!drop &&
1680 !(inode->i_state & I_DONTCACHE) &&
1681 (sb->s_flags & SB_ACTIVE)) {
Jan Kara4eff96d2012-11-26 16:29:51 -08001682 inode_add_lru(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001683 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001684 return;
1685 }
1686
David Howells3f19b2a2017-12-01 11:40:16 +00001687 state = inode->i_state;
Al Viro45321ac2010-06-07 13:43:19 -04001688 if (!drop) {
David Howells3f19b2a2017-12-01 11:40:16 +00001689 WRITE_ONCE(inode->i_state, state | I_WILL_FREE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001690 spin_unlock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001691
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 write_inode_now(inode, 1);
David Howells3f19b2a2017-12-01 11:40:16 +00001693
Dave Chinner250df6e2011-03-22 22:23:36 +11001694 spin_lock(&inode->i_lock);
David Howells3f19b2a2017-12-01 11:40:16 +00001695 state = inode->i_state;
1696 WARN_ON(state & I_NEW);
1697 state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001699
David Howells3f19b2a2017-12-01 11:40:16 +00001700 WRITE_ONCE(inode->i_state, state | I_FREEING);
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001701 if (!list_empty(&inode->i_lru))
1702 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001703 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001704
1705 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706}
1707
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301709 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 * @inode: inode to put
1711 *
1712 * Puts an inode, dropping its usage count. If the inode use count hits
1713 * zero, the inode is then freed and may also be destroyed.
1714 *
1715 * Consequently, iput() can sleep.
1716 */
1717void iput(struct inode *inode)
1718{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001719 if (!inode)
1720 return;
1721 BUG_ON(inode->i_state & I_CLEAR);
1722retry:
1723 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1724 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1725 atomic_inc(&inode->i_count);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001726 spin_unlock(&inode->i_lock);
1727 trace_writeback_lazytime_iput(inode);
1728 mark_inode_dirty_sync(inode);
1729 goto retry;
1730 }
1731 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 }
1733}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734EXPORT_SYMBOL(iput);
1735
Carlos Maiolino30460e12020-01-09 14:30:41 +01001736#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737/**
1738 * bmap - find a block number in a file
Carlos Maiolino30460e12020-01-09 14:30:41 +01001739 * @inode: inode owning the block number being requested
1740 * @block: pointer containing the block to find
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 *
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001742 * Replaces the value in ``*block`` with the block number on the device holding
Carlos Maiolino30460e12020-01-09 14:30:41 +01001743 * corresponding to the requested block number in the file.
1744 * That is, asked for block 4 of inode 1 the function will replace the
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001745 * 4 in ``*block``, with disk block relative to the disk start that holds that
Carlos Maiolino30460e12020-01-09 14:30:41 +01001746 * block of the file.
1747 *
1748 * Returns -EINVAL in case of error, 0 otherwise. If mapping falls into a
Mauro Carvalho Chehab2b8e8b52020-04-14 18:48:57 +02001749 * hole, returns 0 and ``*block`` is also set to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 */
Carlos Maiolino30460e12020-01-09 14:30:41 +01001751int bmap(struct inode *inode, sector_t *block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752{
Carlos Maiolino30460e12020-01-09 14:30:41 +01001753 if (!inode->i_mapping->a_ops->bmap)
1754 return -EINVAL;
1755
1756 *block = inode->i_mapping->a_ops->bmap(inode->i_mapping, *block);
1757 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759EXPORT_SYMBOL(bmap);
Carlos Maiolino30460e12020-01-09 14:30:41 +01001760#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001762/*
1763 * With relative atime, only update atime if the previous atime is
1764 * earlier than either the ctime or mtime or if at least a day has
1765 * passed since the last atime update.
1766 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001767static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001768 struct timespec64 now)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001769{
1770
Miklos Szeredic6718542018-07-18 15:44:43 +02001771 if (!(mnt->mnt_flags & MNT_RELATIME))
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001772 return 1;
1773 /*
1774 * Is mtime younger than atime? If yes, update atime:
1775 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001776 if (timespec64_compare(&inode->i_mtime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001777 return 1;
1778 /*
1779 * Is ctime younger than atime? If yes, update atime:
1780 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001781 if (timespec64_compare(&inode->i_ctime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001782 return 1;
1783
1784 /*
1785 * Is the previous atime value older than a day? If yes,
1786 * update atime:
1787 */
1788 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1789 return 1;
1790 /*
1791 * Good, we can skip the atime update:
1792 */
1793 return 0;
1794}
1795
Deepa Dinamani95582b02018-05-08 19:36:02 -07001796int generic_update_time(struct inode *inode, struct timespec64 *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001797{
Eric Biggerse20b14d2021-01-12 11:02:45 -08001798 int dirty_flags = 0;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001799
Eric Biggerse20b14d2021-01-12 11:02:45 -08001800 if (flags & (S_ATIME | S_CTIME | S_MTIME)) {
1801 if (flags & S_ATIME)
1802 inode->i_atime = *time;
1803 if (flags & S_CTIME)
1804 inode->i_ctime = *time;
1805 if (flags & S_MTIME)
1806 inode->i_mtime = *time;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001807
Eric Biggerse20b14d2021-01-12 11:02:45 -08001808 if (inode->i_sb->s_flags & SB_LAZYTIME)
1809 dirty_flags |= I_DIRTY_TIME;
1810 else
1811 dirty_flags |= I_DIRTY_SYNC;
1812 }
1813
1814 if ((flags & S_VERSION) && inode_maybe_inc_iversion(inode, false))
1815 dirty_flags |= I_DIRTY_SYNC;
1816
1817 __mark_inode_dirty(inode, dirty_flags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001818 return 0;
1819}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001820EXPORT_SYMBOL(generic_update_time);
1821
1822/*
1823 * This does the actual work of updating an inodes time or version. Must have
1824 * had called mnt_want_write() before calling this.
1825 */
Josef Bacik22efa062021-10-14 13:11:00 -04001826int inode_update_time(struct inode *inode, struct timespec64 *time, int flags)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001827{
Deepa Dinamani23b424d2019-12-02 21:19:45 -08001828 if (inode->i_op->update_time)
1829 return inode->i_op->update_time(inode, time, flags);
1830 return generic_update_time(inode, time, flags);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001831}
Josef Bacik22efa062021-10-14 13:11:00 -04001832EXPORT_SYMBOL(inode_update_time);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001833
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834/**
Mauro Carvalho Chehab961f3c82021-01-14 09:04:39 +01001835 * atime_needs_update - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001836 * @path: the &struct path to update
Randy Dunlap30fdc8e2015-11-09 14:57:58 -08001837 * @inode: inode to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 *
1839 * Update the accessed time on an inode and mark it for writeback.
1840 * This function automatically handles read only file systems and media,
1841 * as well as the "noatime" flag and inode specific "noatime" markers.
1842 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001843bool atime_needs_update(const struct path *path, struct inode *inode)
NeilBrown8fa9dd22015-03-23 13:37:40 +11001844{
1845 struct vfsmount *mnt = path->mnt;
Deepa Dinamani95582b02018-05-08 19:36:02 -07001846 struct timespec64 now;
NeilBrown8fa9dd22015-03-23 13:37:40 +11001847
1848 if (inode->i_flags & S_NOATIME)
1849 return false;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001850
1851 /* Atime updates will likely cause i_uid and i_gid to be written
1852 * back improprely if their true value is unknown to the vfs.
1853 */
Christian Braunerba73d982021-01-21 14:19:31 +01001854 if (HAS_UNMAPPED_ID(mnt_user_ns(mnt), inode))
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001855 return false;
1856
NeilBrown8fa9dd22015-03-23 13:37:40 +11001857 if (IS_NOATIME(inode))
1858 return false;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001859 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001860 return false;
1861
1862 if (mnt->mnt_flags & MNT_NOATIME)
1863 return false;
1864 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1865 return false;
1866
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001867 now = current_time(inode);
NeilBrown8fa9dd22015-03-23 13:37:40 +11001868
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001869 if (!relatime_need_update(mnt, inode, now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001870 return false;
1871
Deepa Dinamani95582b02018-05-08 19:36:02 -07001872 if (timespec64_equal(&inode->i_atime, &now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001873 return false;
1874
1875 return true;
1876}
1877
Al Virobadcf2b2013-07-16 18:15:46 +04001878void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879{
Al Viro68ac1232012-03-15 08:21:57 -04001880 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001881 struct inode *inode = d_inode(path->dentry);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001882 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883
Miklos Szeredic6718542018-07-18 15:44:43 +02001884 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001885 return;
1886
Jan Kara5d37e9e2012-06-12 16:20:36 +02001887 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001888 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001889
NeilBrown8fa9dd22015-03-23 13:37:40 +11001890 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001891 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001892 /*
1893 * File systems can error out when updating inodes if they need to
1894 * allocate new space to modify an inode (such is the case for
1895 * Btrfs), but since we touch atime while walking down the path we
1896 * really don't care if we failed to update the atime of the file,
1897 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001898 * We may also fail on filesystems that have the ability to make parts
1899 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001900 */
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001901 now = current_time(inode);
Josef Bacik22efa062021-10-14 13:11:00 -04001902 inode_update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001903 __mnt_drop_write(mnt);
1904skip_update:
1905 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02001907EXPORT_SYMBOL_NS(touch_atime, ANDROID_GKI_VFS_EXPORT_ONLY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908
Cong Wang3ed37642012-05-15 14:57:33 +08001909/*
Jan Karadbfae0c2015-05-21 16:05:54 +02001910 * Return mask of changes for notify_change() that need to be done as a
1911 * response to write or truncate. Return 0 if nothing has to be changed.
1912 * Negative value on error (change should be denied).
1913 */
Christian Brauner78eecf22023-03-07 10:59:21 -08001914int dentry_needs_remove_privs(struct user_namespace *mnt_userns,
1915 struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001916{
Jan Karadbfae0c2015-05-21 16:05:54 +02001917 struct inode *inode = d_inode(dentry);
1918 int mask = 0;
1919 int ret;
1920
1921 if (IS_NOSEC(inode))
1922 return 0;
1923
Christian Brauner78eecf22023-03-07 10:59:21 -08001924 mask = setattr_should_drop_suidgid(mnt_userns, inode);
Jan Karadbfae0c2015-05-21 16:05:54 +02001925 ret = security_inode_need_killpriv(dentry);
1926 if (ret < 0)
1927 return ret;
1928 if (ret)
1929 mask |= ATTR_KILL_PRIV;
1930 return mask;
1931}
Jan Karadbfae0c2015-05-21 16:05:54 +02001932
Christian Brauner643fe552021-01-21 14:19:34 +01001933static int __remove_privs(struct user_namespace *mnt_userns,
1934 struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001935{
1936 struct iattr newattrs;
1937
1938 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001939 /*
1940 * Note we call this on write, so notify_change will not
1941 * encounter any conflicting delegations:
1942 */
Christian Brauner643fe552021-01-21 14:19:34 +01001943 return notify_change(mnt_userns, dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001944}
1945
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001946/*
1947 * Remove special file priviledges (suid, capabilities) when file is written
1948 * to or truncated.
1949 */
1950int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001951{
Miklos Szeredic1892c32016-08-03 13:44:27 +02001952 struct dentry *dentry = file_dentry(file);
1953 struct inode *inode = file_inode(file);
Jan Karadbfae0c2015-05-21 16:05:54 +02001954 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001955 int error = 0;
1956
Alexander Lochmannf69e7492018-12-14 11:55:52 +01001957 /*
1958 * Fast path for nothing security related.
1959 * As well for non-regular files, e.g. blkdev inodes.
1960 * For example, blkdev_write_iter() might get here
1961 * trying to remove privs which it is not allowed to.
1962 */
1963 if (IS_NOSEC(inode) || !S_ISREG(inode->i_mode))
Cong Wang3ed37642012-05-15 14:57:33 +08001964 return 0;
1965
Christian Brauner78eecf22023-03-07 10:59:21 -08001966 kill = dentry_needs_remove_privs(file_mnt_user_ns(file), dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001967 if (kill < 0)
1968 return kill;
1969 if (kill)
Christian Brauner643fe552021-01-21 14:19:34 +01001970 error = __remove_privs(file_mnt_user_ns(file), dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001971 if (!error)
1972 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001973
1974 return error;
1975}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02001976EXPORT_SYMBOL_NS(file_remove_privs, ANDROID_GKI_VFS_EXPORT_ONLY);
Cong Wang3ed37642012-05-15 14:57:33 +08001977
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001979 * file_update_time - update mtime and ctime time
1980 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001982 * Update the mtime and ctime members of an inode and mark the inode
1983 * for writeback. Note that this function is meant exclusively for
1984 * usage in the file write path of filesystems, and filesystems may
1985 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001986 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001987 * timestamps are handled by the server. This can return an error for
1988 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 */
1990
Josef Bacikc3b2da32012-03-26 09:59:21 -04001991int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992{
Al Viro496ad9a2013-01-23 17:07:38 -05001993 struct inode *inode = file_inode(file);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001994 struct timespec64 now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001995 int sync_it = 0;
1996 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997
Andi Kleence06e0b2009-09-18 13:05:48 -07001998 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04002000 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08002001
Deepa Dinamanic2050a42016-09-14 07:48:06 -07002002 now = current_time(inode);
Deepa Dinamani95582b02018-05-08 19:36:02 -07002003 if (!timespec64_equal(&inode->i_mtime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07002004 sync_it = S_MTIME;
2005
Deepa Dinamani95582b02018-05-08 19:36:02 -07002006 if (!timespec64_equal(&inode->i_ctime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07002007 sync_it |= S_CTIME;
2008
Jeff Laytone38cf302017-12-11 06:35:22 -05002009 if (IS_I_VERSION(inode) && inode_iversion_need_inc(inode))
Andi Kleence06e0b2009-09-18 13:05:48 -07002010 sync_it |= S_VERSION;
2011
2012 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04002013 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014
Andi Kleence06e0b2009-09-18 13:05:48 -07002015 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02002016 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04002017 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018
Josef Bacik22efa062021-10-14 13:11:00 -04002019 ret = inode_update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02002020 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04002021
2022 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023}
Christoph Hellwig870f4812006-01-09 20:52:01 -08002024EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025
Amir Goldsteine38f7f52019-06-05 08:04:49 -07002026/* Caller must hold the file's inode lock */
2027int file_modified(struct file *file)
2028{
2029 int err;
2030
2031 /*
2032 * Clear the security bits if the process is not being run by root.
2033 * This keeps people from modifying setuid and setgid binaries.
2034 */
2035 err = file_remove_privs(file);
2036 if (err)
2037 return err;
2038
2039 if (unlikely(file->f_mode & FMODE_NOCMTIME))
2040 return 0;
2041
2042 return file_update_time(file);
2043}
2044EXPORT_SYMBOL(file_modified);
2045
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046int inode_needs_sync(struct inode *inode)
2047{
2048 if (IS_SYNC(inode))
2049 return 1;
2050 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
2051 return 1;
2052 return 0;
2053}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054EXPORT_SYMBOL(inode_needs_sync);
2055
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07002057 * If we try to find an inode in the inode hash while it is being
2058 * deleted, we have to wait until the filesystem completes its
2059 * deletion before reporting that it isn't found. This function waits
2060 * until the deletion _might_ have completed. Callers are responsible
2061 * to recheck inode state.
2062 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002063 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11002064 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
2065 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 */
2067static void __wait_on_freeing_inode(struct inode *inode)
2068{
2069 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002070 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
2071 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Ingo Molnar21417132017-03-05 11:25:39 +01002072 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11002073 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11002074 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 schedule();
Ingo Molnar21417132017-03-05 11:25:39 +01002076 finish_wait(wq, &wait.wq_entry);
Dave Chinner67a23c42011-03-22 22:23:42 +11002077 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078}
2079
Jianxiong Pan710268f2022-02-24 19:30:46 +08002080#ifdef CONFIG_AMLOGIC_MEMORY_OPT
2081static unsigned long ihash_entries __initdata = 32768;
2082#else
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083static __initdata unsigned long ihash_entries;
Jianxiong Pan710268f2022-02-24 19:30:46 +08002084#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085static int __init set_ihash_entries(char *str)
2086{
2087 if (!str)
2088 return 0;
2089 ihash_entries = simple_strtoul(str, &str, 0);
2090 return 1;
2091}
2092__setup("ihash_entries=", set_ihash_entries);
2093
2094/*
2095 * Initialize the waitqueues and inode hash table.
2096 */
2097void __init inode_init_early(void)
2098{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 /* If hashes are distributed across NUMA nodes, defer
2100 * hash allocation until vmalloc space is available.
2101 */
2102 if (hashdist)
2103 return;
2104
2105 inode_hashtable =
2106 alloc_large_system_hash("Inode-cache",
2107 sizeof(struct hlist_head),
2108 ihash_entries,
2109 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002110 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 &i_hash_shift,
2112 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002113 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115}
2116
Denis Cheng74bf17c2007-10-16 23:26:30 -07002117void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08002120 inode_cachep = kmem_cache_create("inode_cache",
2121 sizeof(struct inode),
2122 0,
2123 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
Vladimir Davydov5d097052016-01-14 15:18:21 -08002124 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
Paul Mundt20c2df82007-07-20 10:11:58 +09002125 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126
2127 /* Hash may have been set up in inode_init_early */
2128 if (!hashdist)
2129 return;
2130
2131 inode_hashtable =
2132 alloc_large_system_hash("Inode-cache",
2133 sizeof(struct hlist_head),
2134 ihash_entries,
2135 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002136 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 &i_hash_shift,
2138 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002139 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141}
2142
2143void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
2144{
2145 inode->i_mode = mode;
2146 if (S_ISCHR(mode)) {
2147 inode->i_fop = &def_chr_fops;
2148 inode->i_rdev = rdev;
2149 } else if (S_ISBLK(mode)) {
2150 inode->i_fop = &def_blk_fops;
2151 inode->i_rdev = rdev;
2152 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04002153 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05002155 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07002157 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
2158 " inode %s:%lu\n", mode, inode->i_sb->s_id,
2159 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02002161EXPORT_SYMBOL_NS(init_special_inode, ANDROID_GKI_VFS_EXPORT_ONLY);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002162
2163/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00002164 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Christian Brauner21cb47b2021-01-21 14:19:25 +01002165 * @mnt_userns: User namespace of the mount the inode was created from
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002166 * @inode: New inode
2167 * @dir: Directory inode
2168 * @mode: mode of the new inode
Christian Brauner21cb47b2021-01-21 14:19:25 +01002169 *
2170 * If the inode has been created through an idmapped mount the user namespace of
2171 * the vfsmount must be passed through @mnt_userns. This function will then take
2172 * care to map the inode according to @mnt_userns before checking permissions
2173 * and initializing i_uid and i_gid. On non-idmapped mounts or if permission
2174 * checking is to be performed on the raw inode simply passs init_user_ns.
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002175 */
Christian Brauner21cb47b2021-01-21 14:19:25 +01002176void inode_init_owner(struct user_namespace *mnt_userns, struct inode *inode,
2177 const struct inode *dir, umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002178{
Christian Braunerdb998552021-03-20 13:26:24 +01002179 inode_fsuid_set(inode, mnt_userns);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002180 if (dir && dir->i_mode & S_ISGID) {
2181 inode->i_gid = dir->i_gid;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002182
2183 /* Directories are special, and always inherit S_ISGID */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002184 if (S_ISDIR(mode))
2185 mode |= S_ISGID;
2186 } else
Christian Braunerdb998552021-03-20 13:26:24 +01002187 inode_fsgid_set(inode, mnt_userns);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002188 inode->i_mode = mode;
2189}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02002190EXPORT_SYMBOL_NS(inode_init_owner, ANDROID_GKI_VFS_EXPORT_ONLY);
Serge E. Hallyne795b712011-03-23 16:43:25 -07002191
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002192/**
2193 * inode_owner_or_capable - check current task permissions to inode
Christian Brauner21cb47b2021-01-21 14:19:25 +01002194 * @mnt_userns: user namespace of the mount the inode was found from
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002195 * @inode: inode being checked
2196 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002197 * Return true if current either has CAP_FOWNER in a namespace with the
2198 * inode owner uid mapped, or owns the file.
Christian Brauner21cb47b2021-01-21 14:19:25 +01002199 *
2200 * If the inode has been found through an idmapped mount the user namespace of
2201 * the vfsmount must be passed through @mnt_userns. This function will then take
2202 * care to map the inode according to @mnt_userns before checking permissions.
2203 * On non-idmapped mounts or if permission checking is to be performed on the
2204 * raw inode simply passs init_user_ns.
Serge E. Hallyne795b712011-03-23 16:43:25 -07002205 */
Christian Brauner21cb47b2021-01-21 14:19:25 +01002206bool inode_owner_or_capable(struct user_namespace *mnt_userns,
2207 const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07002208{
Christian Brauner21cb47b2021-01-21 14:19:25 +01002209 kuid_t i_uid;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002210 struct user_namespace *ns;
2211
Christian Brauner21cb47b2021-01-21 14:19:25 +01002212 i_uid = i_uid_into_mnt(mnt_userns, inode);
2213 if (uid_eq(current_fsuid(), i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002214 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002215
2216 ns = current_user_ns();
Christian Brauner21cb47b2021-01-21 14:19:25 +01002217 if (kuid_has_mapping(ns, i_uid) && ns_capable(ns, CAP_FOWNER))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002218 return true;
2219 return false;
2220}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002221EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002222
2223/*
2224 * Direct i/o helper functions
2225 */
2226static void __inode_dio_wait(struct inode *inode)
2227{
2228 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2229 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2230
2231 do {
Ingo Molnar21417132017-03-05 11:25:39 +01002232 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002233 if (atomic_read(&inode->i_dio_count))
2234 schedule();
2235 } while (atomic_read(&inode->i_dio_count));
Ingo Molnar21417132017-03-05 11:25:39 +01002236 finish_wait(wq, &q.wq_entry);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002237}
2238
2239/**
2240 * inode_dio_wait - wait for outstanding DIO requests to finish
2241 * @inode: inode to wait for
2242 *
2243 * Waits for all pending direct I/O requests to finish so that we can
2244 * proceed with a truncate or equivalent operation.
2245 *
2246 * Must be called under a lock that serializes taking new references
2247 * to i_dio_count, usually by inode->i_mutex.
2248 */
2249void inode_dio_wait(struct inode *inode)
2250{
2251 if (atomic_read(&inode->i_dio_count))
2252 __inode_dio_wait(inode);
2253}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02002254EXPORT_SYMBOL_NS(inode_dio_wait, ANDROID_GKI_VFS_EXPORT_ONLY);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002255
2256/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002257 * inode_set_flags - atomically set some inode flags
2258 *
2259 * Note: the caller should be holding i_mutex, or else be sure that
2260 * they have exclusive access to the inode structure (i.e., while the
2261 * inode is being instantiated). The reason for the cmpxchg() loop
2262 * --- which wouldn't be necessary if all code paths which modify
2263 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002264 * code path which doesn't today so we use cmpxchg() out of an abundance
2265 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002266 *
2267 * In the long run, i_mutex is overkill, and we should probably look
2268 * at using the i_lock spinlock to protect i_flags, and then make sure
2269 * it is so documented in include/linux/fs.h and that all code follows
2270 * the locking convention!!
2271 */
2272void inode_set_flags(struct inode *inode, unsigned int flags,
2273 unsigned int mask)
2274{
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002275 WARN_ON_ONCE(flags & ~mask);
Vineet Guptaa9057372019-03-05 15:41:52 -08002276 set_mask_bits(&inode->i_flags, mask, flags);
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002277}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02002278EXPORT_SYMBOL_NS(inode_set_flags, ANDROID_GKI_VFS_EXPORT_ONLY);
Al Viro21fc61c2015-11-17 01:07:57 -05002279
2280void inode_nohighmem(struct inode *inode)
2281{
2282 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2283}
2284EXPORT_SYMBOL(inode_nohighmem);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002285
2286/**
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002287 * timestamp_truncate - Truncate timespec to a granularity
2288 * @t: Timespec
2289 * @inode: inode being updated
2290 *
2291 * Truncate a timespec to the granularity supported by the fs
2292 * containing the inode. Always rounds down. gran must
2293 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2294 */
2295struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode)
2296{
2297 struct super_block *sb = inode->i_sb;
2298 unsigned int gran = sb->s_time_gran;
2299
2300 t.tv_sec = clamp(t.tv_sec, sb->s_time_min, sb->s_time_max);
2301 if (unlikely(t.tv_sec == sb->s_time_max || t.tv_sec == sb->s_time_min))
2302 t.tv_nsec = 0;
2303
2304 /* Avoid division in the common cases 1 ns and 1 s. */
2305 if (gran == 1)
2306 ; /* nothing */
2307 else if (gran == NSEC_PER_SEC)
2308 t.tv_nsec = 0;
2309 else if (gran > 1 && gran < NSEC_PER_SEC)
2310 t.tv_nsec -= t.tv_nsec % gran;
2311 else
2312 WARN(1, "invalid file time granularity: %u", gran);
2313 return t;
2314}
Greg Kroah-Hartman0a77fca2020-07-02 12:51:03 +02002315EXPORT_SYMBOL_NS(timestamp_truncate, ANDROID_GKI_VFS_EXPORT_ONLY);
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002316
2317/**
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002318 * current_time - Return FS time
2319 * @inode: inode.
2320 *
2321 * Return the current time truncated to the time granularity supported by
2322 * the fs.
2323 *
2324 * Note that inode and inode->sb cannot be NULL.
2325 * Otherwise, the function warns and returns time without truncation.
2326 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07002327struct timespec64 current_time(struct inode *inode)
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002328{
Arnd Bergmannd651d162018-12-05 11:14:27 +11002329 struct timespec64 now;
2330
2331 ktime_get_coarse_real_ts64(&now);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002332
2333 if (unlikely(!inode->i_sb)) {
2334 WARN(1, "current_time() called with uninitialized super_block in the inode");
2335 return now;
2336 }
2337
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002338 return timestamp_truncate(now, inode);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002339}
2340EXPORT_SYMBOL(current_time);
Yang Xu9c3a6202023-03-07 10:59:16 -08002341
2342/**
Jeff Layton15b41582023-07-05 14:58:10 -04002343 * inode_set_ctime_current - set the ctime to current_time
2344 * @inode: inode
2345 *
2346 * Set the inode->i_ctime to the current value for the inode. Returns
2347 * the current value that was assigned to i_ctime.
2348 */
2349struct timespec64 inode_set_ctime_current(struct inode *inode)
2350{
2351 struct timespec64 now = current_time(inode);
2352
2353 inode_set_ctime(inode, now.tv_sec, now.tv_nsec);
2354 return now;
2355}
2356EXPORT_SYMBOL(inode_set_ctime_current);
2357
2358/**
Christian Brauner93395e12023-03-07 10:59:18 -08002359 * in_group_or_capable - check whether caller is CAP_FSETID privileged
2360 * @mnt_userns: user namespace of the mount @inode was found from
2361 * @inode: inode to check
2362 * @gid: the new/current gid of @inode
2363 *
2364 * Check wether @gid is in the caller's group list or if the caller is
2365 * privileged with CAP_FSETID over @inode. This can be used to determine
2366 * whether the setgid bit can be kept or must be dropped.
2367 *
2368 * Return: true if the caller is sufficiently privileged, false if not.
2369 */
2370bool in_group_or_capable(struct user_namespace *mnt_userns,
2371 const struct inode *inode, kgid_t gid)
2372{
2373 if (in_group_p(gid))
2374 return true;
2375 if (capable_wrt_inode_uidgid(mnt_userns, inode, CAP_FSETID))
2376 return true;
2377 return false;
2378}
2379
2380/**
Yang Xu9c3a6202023-03-07 10:59:16 -08002381 * mode_strip_sgid - handle the sgid bit for non-directories
2382 * @mnt_userns: User namespace of the mount the inode was created from
2383 * @dir: parent directory inode
2384 * @mode: mode of the file to be created in @dir
2385 *
2386 * If the @mode of the new file has both the S_ISGID and S_IXGRP bit
2387 * raised and @dir has the S_ISGID bit raised ensure that the caller is
2388 * either in the group of the parent directory or they have CAP_FSETID
2389 * in their user namespace and are privileged over the parent directory.
2390 * In all other cases, strip the S_ISGID bit from @mode.
2391 *
2392 * Return: the new mode to use for the file
2393 */
2394umode_t mode_strip_sgid(struct user_namespace *mnt_userns,
2395 const struct inode *dir, umode_t mode)
2396{
2397 if ((mode & (S_ISGID | S_IXGRP)) != (S_ISGID | S_IXGRP))
2398 return mode;
2399 if (S_ISDIR(mode) || !dir || !(dir->i_mode & S_ISGID))
2400 return mode;
Christian Brauner93395e12023-03-07 10:59:18 -08002401 if (in_group_or_capable(mnt_userns, dir,
2402 i_gid_into_mnt(mnt_userns, dir)))
Yang Xu9c3a6202023-03-07 10:59:16 -08002403 return mode;
Yang Xu9c3a6202023-03-07 10:59:16 -08002404 return mode & ~S_ISGID;
2405}
2406EXPORT_SYMBOL(mode_strip_sgid);