blob: 93d9252a00ab4b2ed0fbb274b28e1df468aa71ca [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * (C) 1997 Linus Torvalds
Christoph Hellwig4b4563d2011-05-27 09:28:01 -04004 * (C) 1999 Andrea Arcangeli <andrea@suse.de> (dynamic inode allocation)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 */
Al Viroe59cc472011-12-07 13:17:19 -05006#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/fs.h>
8#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/hash.h>
11#include <linux/swap.h>
12#include <linux/security.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/cdev.h>
Mike Rapoport57c8a662018-10-30 15:09:49 -070014#include <linux/memblock.h>
Daniel Rosenberg6e1918c2020-01-20 14:31:56 -080015#include <linux/fscrypt.h>
Eric Paris3be25f42009-05-21 17:01:26 -040016#include <linux/fsnotify.h>
Christoph Hellwigfc33a7b2006-01-09 20:52:17 -080017#include <linux/mount.h>
Al Virof19d4a82009-06-08 19:50:45 -040018#include <linux/posix_acl.h>
Heiko Carstens9ce6e0b2011-05-22 18:54:21 +020019#include <linux/prefetch.h>
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040020#include <linux/buffer_head.h> /* for inode_has_buffers */
Miklos Szeredi7ada4db2011-11-21 12:11:32 +010021#include <linux/ratelimit.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100022#include <linux/list_lru.h>
Jeff Laytonae5e1652018-01-29 06:41:30 -050023#include <linux/iversion.h>
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050024#include <trace/events/writeback.h>
Dave Chinnera66979a2011-03-22 22:23:41 +110025#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27/*
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040028 * Inode locking rules:
Dave Chinner250df6e2011-03-22 22:23:36 +110029 *
30 * inode->i_lock protects:
31 * inode->i_state, inode->i_hash, __iget()
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100032 * Inode LRU list locks protect:
Dave Chinner98b745c2011-07-08 14:14:39 +100033 * inode->i_sb->s_inode_lru, inode->i_lru
Dave Chinner74278da2015-03-04 12:37:22 -050034 * inode->i_sb->s_inode_list_lock protects:
35 * inode->i_sb->s_inodes, inode->i_sb_list
Christoph Hellwigf758eea2011-04-21 18:19:44 -060036 * bdi->wb.list_lock protects:
Dave Chinnerc7f54082015-03-04 14:07:22 -050037 * bdi->wb.b_{dirty,io,more_io,dirty_time}, inode->i_io_list
Dave Chinner67a23c42011-03-22 22:23:42 +110038 * inode_hash_lock protects:
39 * inode_hashtable, inode->i_hash
Dave Chinner250df6e2011-03-22 22:23:36 +110040 *
41 * Lock ordering:
Dave Chinner55fa6092011-03-22 22:23:40 +110042 *
Dave Chinner74278da2015-03-04 12:37:22 -050043 * inode->i_sb->s_inode_list_lock
Dave Chinner55fa6092011-03-22 22:23:40 +110044 * inode->i_lock
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100045 * Inode LRU list locks
Dave Chinnera66979a2011-03-22 22:23:41 +110046 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060047 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110048 * inode->i_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110049 *
50 * inode_hash_lock
Dave Chinner74278da2015-03-04 12:37:22 -050051 * inode->i_sb->s_inode_list_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110052 * inode->i_lock
53 *
54 * iunique_lock
55 * inode_hash_lock
Dave Chinner250df6e2011-03-22 22:23:36 +110056 */
57
Eric Dumazetfa3536c2006-03-26 01:37:24 -080058static unsigned int i_hash_mask __read_mostly;
59static unsigned int i_hash_shift __read_mostly;
Dave Chinner67a23c42011-03-22 22:23:42 +110060static struct hlist_head *inode_hashtable __read_mostly;
61static __cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Linus Torvalds1da177e2005-04-16 15:20:36 -070063/*
Jens Axboe7dcda1c2011-04-05 23:51:48 +020064 * Empty aops. Can be used for the cases where the user does not
65 * define any of the address_space operations.
66 */
67const struct address_space_operations empty_aops = {
68};
69EXPORT_SYMBOL(empty_aops);
70
71/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * Statistics gathering..
73 */
74struct inodes_stat_t inodes_stat;
75
Glauber Costa3942c072013-08-28 10:17:53 +100076static DEFINE_PER_CPU(unsigned long, nr_inodes);
77static DEFINE_PER_CPU(unsigned long, nr_unused);
Dave Chinnercffbc8a2010-10-23 05:03:02 -040078
Manish Katiyar6b3304b2009-03-31 19:35:54 +053079static struct kmem_cache *inode_cachep __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Glauber Costa3942c072013-08-28 10:17:53 +100081static long get_nr_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040082{
Nick Piggin3e880fb2011-01-07 17:49:19 +110083 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100084 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +110085 for_each_possible_cpu(i)
86 sum += per_cpu(nr_inodes, i);
87 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040088}
89
Glauber Costa3942c072013-08-28 10:17:53 +100090static inline long get_nr_inodes_unused(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040091{
Dave Chinnerfcb94f72011-07-08 14:14:38 +100092 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100093 long sum = 0;
Dave Chinnerfcb94f72011-07-08 14:14:38 +100094 for_each_possible_cpu(i)
95 sum += per_cpu(nr_unused, i);
96 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040097}
98
Glauber Costa3942c072013-08-28 10:17:53 +100099long get_nr_dirty_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400100{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100101 /* not actually dirty inodes, but a wild approximation */
Glauber Costa3942c072013-08-28 10:17:53 +1000102 long nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400103 return nr_dirty > 0 ? nr_dirty : 0;
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400104}
105
106/*
107 * Handle nr_inode sysctl
108 */
109#ifdef CONFIG_SYSCTL
Joe Perches1f7e0612014-06-06 14:38:05 -0700110int proc_nr_inodes(struct ctl_table *table, int write,
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400111 void __user *buffer, size_t *lenp, loff_t *ppos)
112{
113 inodes_stat.nr_inodes = get_nr_inodes();
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000114 inodes_stat.nr_unused = get_nr_inodes_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000115 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400116}
117#endif
118
Al Virobd9b51e2014-11-18 23:38:21 -0500119static int no_open(struct inode *inode, struct file *file)
120{
121 return -ENXIO;
122}
123
David Chinner2cb15992008-10-30 17:32:23 +1100124/**
Masahiro Yamada6e7c2b42017-05-08 15:57:53 -0700125 * inode_init_always - perform inode structure initialisation
Randy Dunlap0bc02f32009-01-06 14:41:13 -0800126 * @sb: superblock inode belongs to
127 * @inode: inode to initialise
David Chinner2cb15992008-10-30 17:32:23 +1100128 *
129 * These are initializations that need to be done on every inode
130 * allocation as the fields are not initialised by slab allocation.
131 */
Christoph Hellwig54e34622009-08-07 14:38:25 -0300132int inode_init_always(struct super_block *sb, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
Alexey Dobriyan6e1d5dc2009-09-21 17:01:11 -0700134 static const struct inode_operations empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500135 static const struct file_operations no_open_fops = {.open = no_open};
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530136 struct address_space *const mapping = &inode->i_data;
David Chinner2cb15992008-10-30 17:32:23 +1100137
138 inode->i_sb = sb;
139 inode->i_blkbits = sb->s_blocksize_bits;
140 inode->i_flags = 0;
Peter Zijlstra8019ad12020-03-04 11:28:31 +0100141 atomic64_set(&inode->i_sequence, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100142 atomic_set(&inode->i_count, 1);
143 inode->i_op = &empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500144 inode->i_fop = &no_open_fops;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200145 inode->__i_nlink = 1;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700146 inode->i_opflags = 0;
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200147 if (sb->s_xattr)
148 inode->i_opflags |= IOP_XATTR;
Eric W. Biederman92361632012-02-08 07:07:50 -0800149 i_uid_write(inode, 0);
150 i_gid_write(inode, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100151 atomic_set(&inode->i_writecount, 0);
152 inode->i_size = 0;
Jens Axboec75b1d92017-06-27 11:47:04 -0600153 inode->i_write_hint = WRITE_LIFE_NOT_SET;
David Chinner2cb15992008-10-30 17:32:23 +1100154 inode->i_blocks = 0;
155 inode->i_bytes = 0;
156 inode->i_generation = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100157 inode->i_pipe = NULL;
158 inode->i_bdev = NULL;
159 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400160 inode->i_link = NULL;
Al Viro84e710d2016-04-15 00:58:55 -0400161 inode->i_dir_seq = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100162 inode->i_rdev = 0;
163 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500164
Tahsin Erdogan3d65ae42016-02-16 13:34:39 -0800165#ifdef CONFIG_CGROUP_WRITEBACK
166 inode->i_wb_frn_winner = 0;
167 inode->i_wb_frn_avg_time = 0;
168 inode->i_wb_frn_history = 0;
169#endif
170
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500171 if (security_inode_alloc(inode))
Christoph Hellwig54e34622009-08-07 14:38:25 -0300172 goto out;
David Chinner2cb15992008-10-30 17:32:23 +1100173 spin_lock_init(&inode->i_lock);
174 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
175
Al Viro9902af72016-04-15 15:08:36 -0400176 init_rwsem(&inode->i_rwsem);
177 lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
David Chinner2cb15992008-10-30 17:32:23 +1100178
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400179 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100180
181 mapping->a_ops = &empty_aops;
182 mapping->host = inode;
183 mapping->flags = 0;
Darrick J. Wong829bc7872018-05-30 19:43:53 -0700184 mapping->wb_err = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700185 atomic_set(&mapping->i_mmap_writable, 0);
Song Liu09d91cd2019-09-23 15:38:03 -0700186#ifdef CONFIG_READ_ONLY_THP_FOR_FS
187 atomic_set(&mapping->nr_thps, 0);
188#endif
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800189 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800190 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100191 mapping->writeback_index = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100192 inode->i_private = NULL;
193 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400194 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400195#ifdef CONFIG_FS_POSIX_ACL
196 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
197#endif
David Chinner2cb15992008-10-30 17:32:23 +1100198
Eric Paris3be25f42009-05-21 17:01:26 -0400199#ifdef CONFIG_FSNOTIFY
200 inode->i_fsnotify_mask = 0;
201#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500202 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100203 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400204
Christoph Hellwig54e34622009-08-07 14:38:25 -0300205 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300206out:
207 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100208}
209EXPORT_SYMBOL(inode_init_always);
210
Al Virofdb0da82019-04-10 14:43:44 -0400211void free_inode_nonrcu(struct inode *inode)
212{
213 kmem_cache_free(inode_cachep, inode);
214}
215EXPORT_SYMBOL(free_inode_nonrcu);
216
217static void i_callback(struct rcu_head *head)
218{
219 struct inode *inode = container_of(head, struct inode, i_rcu);
220 if (inode->free_inode)
221 inode->free_inode(inode);
222 else
223 free_inode_nonrcu(inode);
224}
225
David Chinner2cb15992008-10-30 17:32:23 +1100226static struct inode *alloc_inode(struct super_block *sb)
227{
Al Virofdb0da82019-04-10 14:43:44 -0400228 const struct super_operations *ops = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 struct inode *inode;
230
Al Virofdb0da82019-04-10 14:43:44 -0400231 if (ops->alloc_inode)
232 inode = ops->alloc_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 else
David Chinner2cb15992008-10-30 17:32:23 +1100234 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Christoph Hellwig54e34622009-08-07 14:38:25 -0300236 if (!inode)
237 return NULL;
238
239 if (unlikely(inode_init_always(sb, inode))) {
Al Virofdb0da82019-04-10 14:43:44 -0400240 if (ops->destroy_inode) {
241 ops->destroy_inode(inode);
242 if (!ops->free_inode)
243 return NULL;
244 }
245 inode->free_inode = ops->free_inode;
246 i_callback(&inode->i_rcu);
Christoph Hellwig54e34622009-08-07 14:38:25 -0300247 return NULL;
248 }
249
250 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251}
252
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300253void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200255 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400256 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400258 fsnotify_inode_delete(inode);
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500259 locks_free_lock_context(inode);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100260 if (!inode->i_nlink) {
261 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
262 atomic_long_dec(&inode->i_sb->s_remove_count);
263 }
264
Al Virof19d4a82009-06-08 19:50:45 -0400265#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100266 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400267 posix_acl_release(inode->i_acl);
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100268 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400269 posix_acl_release(inode->i_default_acl);
270#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100271 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300272}
273EXPORT_SYMBOL(__destroy_inode);
274
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200275static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300276{
Al Virofdb0da82019-04-10 14:43:44 -0400277 const struct super_operations *ops = inode->i_sb->s_op;
278
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100279 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300280 __destroy_inode(inode);
Al Virofdb0da82019-04-10 14:43:44 -0400281 if (ops->destroy_inode) {
282 ops->destroy_inode(inode);
283 if (!ops->free_inode)
284 return;
285 }
286 inode->free_inode = ops->free_inode;
287 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100290/**
291 * drop_nlink - directly drop an inode's link count
292 * @inode: inode
293 *
294 * This is a low-level filesystem helper to replace any
295 * direct filesystem manipulation of i_nlink. In cases
296 * where we are attempting to track writes to the
297 * filesystem, a decrement to zero means an imminent
298 * write when the file is truncated and actually unlinked
299 * on the filesystem.
300 */
301void drop_nlink(struct inode *inode)
302{
303 WARN_ON(inode->i_nlink == 0);
304 inode->__i_nlink--;
305 if (!inode->i_nlink)
306 atomic_long_inc(&inode->i_sb->s_remove_count);
307}
308EXPORT_SYMBOL(drop_nlink);
309
310/**
311 * clear_nlink - directly zero an inode's link count
312 * @inode: inode
313 *
314 * This is a low-level filesystem helper to replace any
315 * direct filesystem manipulation of i_nlink. See
316 * drop_nlink() for why we care about i_nlink hitting zero.
317 */
318void clear_nlink(struct inode *inode)
319{
320 if (inode->i_nlink) {
321 inode->__i_nlink = 0;
322 atomic_long_inc(&inode->i_sb->s_remove_count);
323 }
324}
325EXPORT_SYMBOL(clear_nlink);
326
327/**
328 * set_nlink - directly set an inode's link count
329 * @inode: inode
330 * @nlink: new nlink (should be non-zero)
331 *
332 * This is a low-level filesystem helper to replace any
333 * direct filesystem manipulation of i_nlink.
334 */
335void set_nlink(struct inode *inode, unsigned int nlink)
336{
337 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100338 clear_nlink(inode);
339 } else {
340 /* Yes, some filesystems do change nlink from zero to one */
341 if (inode->i_nlink == 0)
342 atomic_long_dec(&inode->i_sb->s_remove_count);
343
344 inode->__i_nlink = nlink;
345 }
346}
347EXPORT_SYMBOL(set_nlink);
348
349/**
350 * inc_nlink - directly increment an inode's link count
351 * @inode: inode
352 *
353 * This is a low-level filesystem helper to replace any
354 * direct filesystem manipulation of i_nlink. Currently,
355 * it is only here for parity with dec_nlink().
356 */
357void inc_nlink(struct inode *inode)
358{
Al Virof4e0c302013-06-11 08:34:36 +0400359 if (unlikely(inode->i_nlink == 0)) {
360 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100361 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400362 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100363
364 inode->__i_nlink++;
365}
366EXPORT_SYMBOL(inc_nlink);
367
Dave Chinnerae233952018-03-06 17:30:34 -0800368static void __address_space_init_once(struct address_space *mapping)
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100369{
Johannes Weiner7b785642019-05-24 10:12:46 -0400370 xa_init_flags(&mapping->i_pages, XA_FLAGS_LOCK_IRQ | XA_FLAGS_ACCOUNT);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800371 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100372 INIT_LIST_HEAD(&mapping->private_list);
373 spin_lock_init(&mapping->private_lock);
Davidlohr Buesof808c132017-09-08 16:15:08 -0700374 mapping->i_mmap = RB_ROOT_CACHED;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100375}
Dave Chinnerae233952018-03-06 17:30:34 -0800376
377void address_space_init_once(struct address_space *mapping)
378{
379 memset(mapping, 0, sizeof(*mapping));
380 __address_space_init_once(mapping);
381}
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100382EXPORT_SYMBOL(address_space_init_once);
383
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384/*
385 * These are initializations that only need to be done
386 * once, because the fields are idempotent across use
387 * of the inode, so let the slab aware of that.
388 */
389void inode_init_once(struct inode *inode)
390{
391 memset(inode, 0, sizeof(*inode));
392 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500394 INIT_LIST_HEAD(&inode->i_io_list);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700395 INIT_LIST_HEAD(&inode->i_wb_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100396 INIT_LIST_HEAD(&inode->i_lru);
Dave Chinnerae233952018-03-06 17:30:34 -0800397 __address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 i_size_ordered_init(inode);
399}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400EXPORT_SYMBOL(inode_init_once);
401
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700402static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530404 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
Christoph Lametera35afb82007-05-16 22:10:57 -0700406 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407}
408
409/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100410 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530412void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413{
Nick Piggin9e38d862010-10-23 06:55:17 -0400414 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415}
416
Al Viro7de9c6ee2010-10-23 11:11:40 -0400417/*
418 * get additional reference to inode; caller must already hold one.
419 */
420void ihold(struct inode *inode)
421{
422 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
423}
424EXPORT_SYMBOL(ihold);
425
Nick Piggin9e38d862010-10-23 06:55:17 -0400426static void inode_lru_list_add(struct inode *inode)
427{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000428 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000429 this_cpu_inc(nr_unused);
Josef Bacik563f4002017-04-18 16:04:17 -0400430 else
431 inode->i_state |= I_REFERENCED;
Nick Piggin9e38d862010-10-23 06:55:17 -0400432}
433
Jan Kara4eff96d2012-11-26 16:29:51 -0800434/*
435 * Add inode to LRU if needed (inode is unused and clean).
436 *
437 * Needs inode->i_lock held.
438 */
439void inode_add_lru(struct inode *inode)
440{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500441 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
442 I_FREEING | I_WILL_FREE)) &&
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800443 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & SB_ACTIVE)
Jan Kara4eff96d2012-11-26 16:29:51 -0800444 inode_lru_list_add(inode);
445}
446
447
Nick Piggin9e38d862010-10-23 06:55:17 -0400448static void inode_lru_list_del(struct inode *inode)
449{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000450
451 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000452 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453}
454
Christoph Hellwig646ec462010-10-23 07:15:32 -0400455/**
456 * inode_sb_list_add - add inode to the superblock list of inodes
457 * @inode: inode to add
458 */
459void inode_sb_list_add(struct inode *inode)
460{
Dave Chinner74278da2015-03-04 12:37:22 -0500461 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100462 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500463 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400464}
465EXPORT_SYMBOL_GPL(inode_sb_list_add);
466
Dave Chinner55fa6092011-03-22 22:23:40 +1100467static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400468{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200469 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500470 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200471 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500472 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200473 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400474}
475
Dave Chinner4c51acb2010-10-23 06:58:09 -0400476static unsigned long hash(struct super_block *sb, unsigned long hashval)
477{
478 unsigned long tmp;
479
480 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
481 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400482 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
483 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400484}
485
486/**
487 * __insert_inode_hash - hash an inode
488 * @inode: unhashed inode
489 * @hashval: unsigned long value used to locate this object in the
490 * inode_hashtable.
491 *
492 * Add an inode to the inode hash for this superblock.
493 */
494void __insert_inode_hash(struct inode *inode, unsigned long hashval)
495{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400496 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
497
Dave Chinner67a23c42011-03-22 22:23:42 +1100498 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100499 spin_lock(&inode->i_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400500 hlist_add_head(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100501 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100502 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400503}
504EXPORT_SYMBOL(__insert_inode_hash);
505
506/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200507 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400508 * @inode: inode to unhash
509 *
510 * Remove an inode from the superblock.
511 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200512void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400513{
Dave Chinner67a23c42011-03-22 22:23:42 +1100514 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100515 spin_lock(&inode->i_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400516 hlist_del_init(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100517 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100518 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400519}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200520EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400521
Jan Karadbd57682012-05-03 14:48:02 +0200522void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400523{
Jan Kara08142572011-06-27 16:18:10 -0700524 /*
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700525 * We have to cycle the i_pages lock here because reclaim can be in the
Jan Kara08142572011-06-27 16:18:10 -0700526 * process of removing the last page (in __delete_from_page_cache())
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700527 * and we must not free the mapping under it.
Jan Kara08142572011-06-27 16:18:10 -0700528 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700529 xa_lock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400530 BUG_ON(inode->i_data.nrpages);
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800531 BUG_ON(inode->i_data.nrexceptional);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700532 xa_unlock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400533 BUG_ON(!list_empty(&inode->i_data.private_list));
534 BUG_ON(!(inode->i_state & I_FREEING));
535 BUG_ON(inode->i_state & I_CLEAR);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700536 BUG_ON(!list_empty(&inode->i_wb_list));
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100537 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400538 inode->i_state = I_FREEING | I_CLEAR;
539}
Jan Karadbd57682012-05-03 14:48:02 +0200540EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400541
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100542/*
543 * Free the inode passed in, removing it from the lists it is still connected
544 * to. We remove any pages still attached to the inode and wait for any IO that
545 * is still in progress before finally destroying the inode.
546 *
547 * An inode must already be marked I_FREEING so that we avoid the inode being
548 * moved back onto lists if we race with other code that manipulates the lists
549 * (e.g. writeback_single_inode). The caller is responsible for setting this.
550 *
551 * An inode must already be removed from the LRU list before being evicted from
552 * the cache. This should occur atomically with setting the I_FREEING state
553 * flag, so no inodes here should ever be on the LRU when being evicted.
554 */
Al Viro644da592010-06-07 13:21:05 -0400555static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400556{
557 const struct super_operations *op = inode->i_sb->s_op;
558
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100559 BUG_ON(!(inode->i_state & I_FREEING));
560 BUG_ON(!list_empty(&inode->i_lru));
561
Dave Chinnerc7f54082015-03-04 14:07:22 -0500562 if (!list_empty(&inode->i_io_list))
563 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200564
Dave Chinner55fa6092011-03-22 22:23:40 +1100565 inode_sb_list_del(inode);
566
Jan Kara169ebd92012-05-03 14:48:03 +0200567 /*
568 * Wait for flusher thread to be done with the inode so that filesystem
569 * does not start destroying it while writeback is still running. Since
570 * the inode has I_FREEING set, flusher thread won't start new work on
571 * the inode. We just have to wait for running writeback to finish.
572 */
573 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200574
Al Virobe7ce412010-06-04 19:40:39 -0400575 if (op->evict_inode) {
576 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400577 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700578 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200579 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400580 }
Al Viro661074e2010-06-04 20:19:55 -0400581 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
582 bd_forget(inode);
583 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
584 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100585
586 remove_inode_hash(inode);
587
588 spin_lock(&inode->i_lock);
589 wake_up_bit(&inode->i_state, __I_NEW);
590 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
591 spin_unlock(&inode->i_lock);
592
593 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400594}
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596/*
597 * dispose_list - dispose of the contents of a local list
598 * @head: the head of the list to free
599 *
600 * Dispose-list gets a local list with local inodes in it, so it doesn't
601 * need to worry about list corruption and SMP locks.
602 */
603static void dispose_list(struct list_head *head)
604{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 while (!list_empty(head)) {
606 struct inode *inode;
607
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100608 inode = list_first_entry(head, struct inode, i_lru);
609 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Al Viro644da592010-06-07 13:21:05 -0400611 evict(inode);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500612 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614}
615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616/**
Al Viro63997e92010-10-25 20:49:35 -0400617 * evict_inodes - evict all evictable inodes for a superblock
618 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 *
Al Viro63997e92010-10-25 20:49:35 -0400620 * Make sure that no inodes with zero refcount are retained. This is
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800621 * called by superblock shutdown after having SB_ACTIVE flag removed,
Al Viro63997e92010-10-25 20:49:35 -0400622 * so any inode reaching zero refcount during or after that call will
623 * be immediately evicted.
624 */
625void evict_inodes(struct super_block *sb)
626{
627 struct inode *inode, *next;
628 LIST_HEAD(dispose);
629
Josef Bacikac05fbb2015-03-04 16:52:52 -0500630again:
Dave Chinner74278da2015-03-04 12:37:22 -0500631 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400632 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
633 if (atomic_read(&inode->i_count))
634 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100635
636 spin_lock(&inode->i_lock);
637 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
638 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400639 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100640 }
Al Viro63997e92010-10-25 20:49:35 -0400641
642 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100643 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100644 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100645 list_add(&inode->i_lru, &dispose);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500646
647 /*
648 * We can have a ton of inodes to evict at unmount time given
649 * enough memory, check to see if we need to go to sleep for a
650 * bit so we don't livelock.
651 */
652 if (need_resched()) {
653 spin_unlock(&sb->s_inode_list_lock);
654 cond_resched();
655 dispose_list(&dispose);
656 goto again;
657 }
Al Viro63997e92010-10-25 20:49:35 -0400658 }
Dave Chinner74278da2015-03-04 12:37:22 -0500659 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400660
661 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400662}
Darrick J. Wong799ea9e2017-08-18 18:08:25 -0700663EXPORT_SYMBOL_GPL(evict_inodes);
Al Viro63997e92010-10-25 20:49:35 -0400664
665/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200666 * invalidate_inodes - attempt to free all inodes on a superblock
667 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100668 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200669 *
670 * Attempts to free all inodes for a given superblock. If there were any
671 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100672 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
673 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 */
NeilBrown93b270f2011-02-24 17:25:47 +1100675int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400677 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200678 struct inode *inode, *next;
679 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Eric Sandeen04646ae2019-12-06 10:54:23 -0600681again:
Dave Chinner74278da2015-03-04 12:37:22 -0500682 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200683 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100684 spin_lock(&inode->i_lock);
685 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
686 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100688 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500689 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100690 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100691 busy = 1;
692 continue;
693 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200694 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100695 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200696 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 continue;
698 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200699
Christoph Hellwig99a38912010-10-23 19:07:20 +0200700 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100701 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100702 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100703 list_add(&inode->i_lru, &dispose);
Eric Sandeen04646ae2019-12-06 10:54:23 -0600704 if (need_resched()) {
705 spin_unlock(&sb->s_inode_list_lock);
706 cond_resched();
707 dispose_list(&dispose);
708 goto again;
709 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 }
Dave Chinner74278da2015-03-04 12:37:22 -0500711 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
Christoph Hellwiga0318782010-10-24 19:40:33 +0200713 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 return busy;
716}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000719 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 *
721 * Any inodes which are pinned purely because of attached pagecache have their
Nick Piggin9e38d862010-10-23 06:55:17 -0400722 * pagecache removed. If the inode has metadata buffers attached to
723 * mapping->private_list then try to remove them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400725 * If the inode has the I_REFERENCED flag set, then it means that it has been
726 * used recently - the flag is set in iput_final(). When we encounter such an
727 * inode, clear the flag and move it to the back of the LRU so it gets another
728 * pass through the LRU before it gets reclaimed. This is necessary because of
729 * the fact we are doing lazy LRU updates to minimise lock contention so the
730 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
731 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800733static enum lru_status inode_lru_isolate(struct list_head *item,
734 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000735{
736 struct list_head *freeable = arg;
737 struct inode *inode = container_of(item, struct inode, i_lru);
738
739 /*
740 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
741 * If we fail to get the lock, just skip it.
742 */
743 if (!spin_trylock(&inode->i_lock))
744 return LRU_SKIP;
745
746 /*
747 * Referenced or dirty inodes are still in use. Give them another pass
748 * through the LRU as we canot reclaim them now.
749 */
750 if (atomic_read(&inode->i_count) ||
751 (inode->i_state & ~I_REFERENCED)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800752 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000753 spin_unlock(&inode->i_lock);
754 this_cpu_dec(nr_unused);
755 return LRU_REMOVED;
756 }
757
Dave Chinner69056ee2019-02-12 15:35:51 -0800758 /* recently referenced inodes get one more pass */
759 if (inode->i_state & I_REFERENCED) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000760 inode->i_state &= ~I_REFERENCED;
761 spin_unlock(&inode->i_lock);
762 return LRU_ROTATE;
763 }
764
765 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
766 __iget(inode);
767 spin_unlock(&inode->i_lock);
768 spin_unlock(lru_lock);
769 if (remove_inode_buffers(inode)) {
770 unsigned long reap;
771 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
772 if (current_is_kswapd())
773 __count_vm_events(KSWAPD_INODESTEAL, reap);
774 else
775 __count_vm_events(PGINODESTEAL, reap);
776 if (current->reclaim_state)
777 current->reclaim_state->reclaimed_slab += reap;
778 }
779 iput(inode);
780 spin_lock(lru_lock);
781 return LRU_RETRY;
782 }
783
784 WARN_ON(inode->i_state & I_NEW);
785 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800786 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000787 spin_unlock(&inode->i_lock);
788
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000789 this_cpu_dec(nr_unused);
790 return LRU_REMOVED;
791}
792
793/*
794 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
795 * This is called from the superblock shrinker function with a number of inodes
796 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
797 * then are freed outside inode_lock by dispose_list().
798 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800799long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800{
801 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000802 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Vladimir Davydov503c3582015-02-12 14:58:47 -0800804 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
805 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000807 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808}
809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810static void __wait_on_freeing_inode(struct inode *inode);
811/*
812 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530814static struct inode *find_inode(struct super_block *sb,
815 struct hlist_head *head,
816 int (*test)(struct inode *, void *),
817 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530819 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800822 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500823 if (inode->i_sb != sb)
824 continue;
825 if (!test(inode, data))
826 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100827 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400828 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 __wait_on_freeing_inode(inode);
830 goto repeat;
831 }
Al Viroc2b6d622018-06-28 15:53:17 -0400832 if (unlikely(inode->i_state & I_CREATING)) {
833 spin_unlock(&inode->i_lock);
834 return ERR_PTR(-ESTALE);
835 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400836 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100837 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400838 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400840 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841}
842
843/*
844 * find_inode_fast is the fast path version of find_inode, see the comment at
845 * iget_locked for details.
846 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530847static struct inode *find_inode_fast(struct super_block *sb,
848 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530850 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
852repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800853 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500854 if (inode->i_ino != ino)
855 continue;
856 if (inode->i_sb != sb)
857 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100858 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400859 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 __wait_on_freeing_inode(inode);
861 goto repeat;
862 }
Al Viroc2b6d622018-06-28 15:53:17 -0400863 if (unlikely(inode->i_state & I_CREATING)) {
864 spin_unlock(&inode->i_lock);
865 return ERR_PTR(-ESTALE);
866 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400867 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100868 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400869 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400871 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872}
873
Eric Dumazetf991bd22010-10-23 11:18:01 -0400874/*
875 * Each cpu owns a range of LAST_INO_BATCH numbers.
876 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
877 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100878 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400879 * This does not significantly increase overflow rate because every CPU can
880 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
881 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
882 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
883 * overflow rate by 2x, which does not seem too significant.
884 *
885 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
886 * error if st_ino won't fit in target struct field. Use 32bit counter
887 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100888 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400889#define LAST_INO_BATCH 1024
890static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100891
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400892unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400893{
894 unsigned int *p = &get_cpu_var(last_ino);
895 unsigned int res = *p;
896
897#ifdef CONFIG_SMP
898 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
899 static atomic_t shared_last_ino;
900 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
901
902 res = next - LAST_INO_BATCH;
903 }
904#endif
905
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300906 res++;
907 /* get_next_ino should not provide a 0 inode number */
908 if (unlikely(!res))
909 res++;
910 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400911 put_cpu_var(last_ino);
912 return res;
David Chinner8290c352008-10-30 17:35:24 +1100913}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400914EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100915
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200917 * new_inode_pseudo - obtain an inode
918 * @sb: superblock
919 *
920 * Allocates a new inode for given superblock.
921 * Inode wont be chained in superblock s_inodes list
922 * This means :
923 * - fs can't be unmount
924 * - quotas, fsnotify, writeback can't work
925 */
926struct inode *new_inode_pseudo(struct super_block *sb)
927{
928 struct inode *inode = alloc_inode(sb);
929
930 if (inode) {
931 spin_lock(&inode->i_lock);
932 inode->i_state = 0;
933 spin_unlock(&inode->i_lock);
934 INIT_LIST_HEAD(&inode->i_sb_list);
935 }
936 return inode;
937}
938
939/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 * new_inode - obtain an inode
941 * @sb: superblock
942 *
Mel Gorman769848c2007-07-17 04:03:05 -0700943 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800944 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700945 * If HIGHMEM pages are unsuitable or it is known that pages allocated
946 * for the page cache are not reclaimable or migratable,
947 * mapping_set_gfp_mask() must be called with suitable flags on the
948 * newly created inode's mapping
949 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 */
951struct inode *new_inode(struct super_block *sb)
952{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530953 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
Dave Chinner74278da2015-03-04 12:37:22 -0500955 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530956
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200957 inode = new_inode_pseudo(sb);
958 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100959 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 return inode;
961}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962EXPORT_SYMBOL(new_inode);
963
Peter Zijlstra14358e62007-10-14 01:38:33 +0200964#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400965void lockdep_annotate_inode_mutex_key(struct inode *inode)
966{
Namhyung Kima3314a02010-10-11 22:38:00 +0900967 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200968 struct file_system_type *type = inode->i_sb->s_type;
969
Jan Kara9a7aa122009-06-04 15:26:49 +0200970 /* Set new key only if filesystem hasn't already changed it */
Al Viro9902af72016-04-15 15:08:36 -0400971 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200972 /*
973 * ensure nobody is actually holding i_mutex
974 */
Al Viro9902af72016-04-15 15:08:36 -0400975 // mutex_destroy(&inode->i_mutex);
976 init_rwsem(&inode->i_rwsem);
977 lockdep_set_class(&inode->i_rwsem,
Jan Kara9a7aa122009-06-04 15:26:49 +0200978 &type->i_mutex_dir_key);
979 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200980 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400981}
982EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200983#endif
Josh Boyere096d0c2011-08-25 07:48:12 -0400984
985/**
986 * unlock_new_inode - clear the I_NEW state and wake up any waiters
987 * @inode: new inode to unlock
988 *
989 * Called when the inode is fully initialised to clear the new state of the
990 * inode and wake up anyone waiting for the inode to finish initialisation.
991 */
992void unlock_new_inode(struct inode *inode)
993{
994 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100995 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100996 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -0400997 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro310fa7a2012-03-10 17:07:28 -0500998 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +1100999 wake_up_bit(&inode->i_state, __I_NEW);
1000 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002EXPORT_SYMBOL(unlock_new_inode);
1003
Al Viroc2b6d622018-06-28 15:53:17 -04001004void discard_new_inode(struct inode *inode)
1005{
1006 lockdep_annotate_inode_mutex_key(inode);
1007 spin_lock(&inode->i_lock);
1008 WARN_ON(!(inode->i_state & I_NEW));
1009 inode->i_state &= ~I_NEW;
1010 smp_mb();
1011 wake_up_bit(&inode->i_state, __I_NEW);
1012 spin_unlock(&inode->i_lock);
1013 iput(inode);
1014}
1015EXPORT_SYMBOL(discard_new_inode);
1016
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001017/**
J. Bruce Fields375e2892012-04-18 15:16:33 -04001018 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001019 *
1020 * Lock any non-NULL argument that is not a directory.
1021 * Zero, one or two objects may be locked by this function.
1022 *
J. Bruce Fields375e2892012-04-18 15:16:33 -04001023 * @inode1: first inode to lock
1024 * @inode2: second inode to lock
1025 */
1026void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1027{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001028 if (inode1 > inode2)
1029 swap(inode1, inode2);
1030
1031 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001032 inode_lock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001033 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001034 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001035}
1036EXPORT_SYMBOL(lock_two_nondirectories);
1037
1038/**
1039 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
1040 * @inode1: first inode to unlock
1041 * @inode2: second inode to unlock
1042 */
1043void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1044{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001045 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001046 inode_unlock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001047 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001048 inode_unlock(inode2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001049}
1050EXPORT_SYMBOL(unlock_two_nondirectories);
1051
1052/**
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001053 * inode_insert5 - obtain an inode from a mounted file system
1054 * @inode: pre-allocated inode to use for insert to cache
1055 * @hashval: hash value (usually inode number) to get
1056 * @test: callback used for comparisons between inodes
1057 * @set: callback used to initialize a new struct inode
1058 * @data: opaque data pointer to pass to @test and @set
1059 *
1060 * Search for the inode specified by @hashval and @data in the inode cache,
1061 * and if present it is return it with an increased reference count. This is
1062 * a variant of iget5_locked() for callers that don't want to fail on memory
1063 * allocation of inode.
1064 *
1065 * If the inode is not in cache, insert the pre-allocated inode to cache and
1066 * return it locked, hashed, and with the I_NEW flag set. The file system gets
1067 * to fill it in before unlocking it via unlock_new_inode().
1068 *
1069 * Note both @test and @set are called with the inode_hash_lock held, so can't
1070 * sleep.
1071 */
1072struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
1073 int (*test)(struct inode *, void *),
1074 int (*set)(struct inode *, void *), void *data)
1075{
1076 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1077 struct inode *old;
Miklos Szeredie9505642018-07-24 15:01:55 +02001078 bool creating = inode->i_state & I_CREATING;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001079
1080again:
1081 spin_lock(&inode_hash_lock);
1082 old = find_inode(inode->i_sb, head, test, data);
1083 if (unlikely(old)) {
1084 /*
1085 * Uhhuh, somebody else created the same inode under us.
1086 * Use the old inode instead of the preallocated one.
1087 */
1088 spin_unlock(&inode_hash_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001089 if (IS_ERR(old))
1090 return NULL;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001091 wait_on_inode(old);
1092 if (unlikely(inode_unhashed(old))) {
1093 iput(old);
1094 goto again;
1095 }
1096 return old;
1097 }
1098
1099 if (set && unlikely(set(inode, data))) {
1100 inode = NULL;
1101 goto unlock;
1102 }
1103
1104 /*
1105 * Return the locked inode with I_NEW set, the
1106 * caller is responsible for filling in the contents
1107 */
1108 spin_lock(&inode->i_lock);
1109 inode->i_state |= I_NEW;
1110 hlist_add_head(&inode->i_hash, head);
1111 spin_unlock(&inode->i_lock);
Miklos Szeredie9505642018-07-24 15:01:55 +02001112 if (!creating)
1113 inode_sb_list_add(inode);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001114unlock:
1115 spin_unlock(&inode_hash_lock);
1116
1117 return inode;
1118}
1119EXPORT_SYMBOL(inode_insert5);
1120
1121/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001122 * iget5_locked - obtain an inode from a mounted file system
1123 * @sb: super block of file system
1124 * @hashval: hash value (usually inode number) to get
1125 * @test: callback used for comparisons between inodes
1126 * @set: callback used to initialize a new struct inode
1127 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001129 * Search for the inode specified by @hashval and @data in the inode cache,
1130 * and if present it is return it with an increased reference count. This is
1131 * a generalized version of iget_locked() for file systems where the inode
1132 * number is not sufficient for unique identification of an inode.
1133 *
1134 * If the inode is not in cache, allocate a new inode and return it locked,
1135 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1136 * before unlocking it via unlock_new_inode().
1137 *
1138 * Note both @test and @set are called with the inode_hash_lock held, so can't
1139 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001141struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1142 int (*test)(struct inode *, void *),
1143 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144{
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001145 struct inode *inode = ilookup5(sb, hashval, test, data);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001146
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001147 if (!inode) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001148 struct inode *new = alloc_inode(sb);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001149
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001150 if (new) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001151 new->i_state = 0;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001152 inode = inode_insert5(new, hashval, test, set, data);
1153 if (unlikely(inode != new))
Miklos Szeredie9505642018-07-24 15:01:55 +02001154 destroy_inode(new);
Al Viro2864f302016-07-03 23:15:21 -04001155 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 }
1157 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001159EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001161/**
1162 * iget_locked - obtain an inode from a mounted file system
1163 * @sb: super block of file system
1164 * @ino: inode number to get
1165 *
1166 * Search for the inode specified by @ino in the inode cache and if present
1167 * return it with an increased reference count. This is for file systems
1168 * where the inode number is sufficient for unique identification of an inode.
1169 *
1170 * If the inode is not in cache, allocate a new inode and return it locked,
1171 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1172 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001174struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001176 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301177 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001178again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001179 spin_lock(&inode_hash_lock);
1180 inode = find_inode_fast(sb, head, ino);
1181 spin_unlock(&inode_hash_lock);
1182 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001183 if (IS_ERR(inode))
1184 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001185 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001186 if (unlikely(inode_unhashed(inode))) {
1187 iput(inode);
1188 goto again;
1189 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001190 return inode;
1191 }
1192
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 inode = alloc_inode(sb);
1194 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301195 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196
Dave Chinner67a23c42011-03-22 22:23:42 +11001197 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 /* We released the lock, so.. */
1199 old = find_inode_fast(sb, head, ino);
1200 if (!old) {
1201 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001202 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001203 inode->i_state = I_NEW;
Dave Chinner250df6e2011-03-22 22:23:36 +11001204 hlist_add_head(&inode->i_hash, head);
1205 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001206 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001207 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
1209 /* Return the locked inode with I_NEW set, the
1210 * caller is responsible for filling in the contents
1211 */
1212 return inode;
1213 }
1214
1215 /*
1216 * Uhhuh, somebody else created the same inode under
1217 * us. Use the old inode instead of the one we just
1218 * allocated.
1219 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001220 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 destroy_inode(inode);
Al Viroc2b6d622018-06-28 15:53:17 -04001222 if (IS_ERR(old))
1223 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 inode = old;
1225 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001226 if (unlikely(inode_unhashed(inode))) {
1227 iput(inode);
1228 goto again;
1229 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 }
1231 return inode;
1232}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001233EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001235/*
1236 * search the inode cache for a matching inode number.
1237 * If we find one, then the inode number we are trying to
1238 * allocate is not unique and so we should not use it.
1239 *
1240 * Returns 1 if the inode number is unique, 0 if it is not.
1241 */
1242static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1243{
1244 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001245 struct inode *inode;
1246
Dave Chinner67a23c42011-03-22 22:23:42 +11001247 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001248 hlist_for_each_entry(inode, b, i_hash) {
Dave Chinner67a23c42011-03-22 22:23:42 +11001249 if (inode->i_ino == ino && inode->i_sb == sb) {
1250 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001251 return 0;
Dave Chinner67a23c42011-03-22 22:23:42 +11001252 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001253 }
Dave Chinner67a23c42011-03-22 22:23:42 +11001254 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001255
1256 return 1;
1257}
1258
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259/**
1260 * iunique - get a unique inode number
1261 * @sb: superblock
1262 * @max_reserved: highest reserved inode number
1263 *
1264 * Obtain an inode number that is unique on the system for a given
1265 * superblock. This is used by file systems that have no natural
1266 * permanent inode numbering system. An inode number is returned that
1267 * is higher than the reserved limit but unique.
1268 *
1269 * BUGS:
1270 * With a large number of inodes live on the file system this function
1271 * currently becomes quite slow.
1272 */
1273ino_t iunique(struct super_block *sb, ino_t max_reserved)
1274{
Jeff Layton866b04f2007-05-08 00:32:29 -07001275 /*
1276 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1277 * error if st_ino won't fit in target struct field. Use 32bit counter
1278 * here to attempt to avoid that.
1279 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001280 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001281 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001284 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001285 do {
1286 if (counter <= max_reserved)
1287 counter = max_reserved + 1;
1288 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001289 } while (!test_inode_iunique(sb, res));
1290 spin_unlock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001291
1292 return res;
1293}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294EXPORT_SYMBOL(iunique);
1295
1296struct inode *igrab(struct inode *inode)
1297{
Dave Chinner250df6e2011-03-22 22:23:36 +11001298 spin_lock(&inode->i_lock);
1299 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001301 spin_unlock(&inode->i_lock);
1302 } else {
1303 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 /*
1305 * Handle the case where s_op->clear_inode is not been
1306 * called yet, and somebody is calling igrab
1307 * while the inode is getting freed.
1308 */
1309 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001310 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 return inode;
1312}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313EXPORT_SYMBOL(igrab);
1314
1315/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001316 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 * @sb: super block of file system to search
1318 * @hashval: hash value (usually inode number) to search for
1319 * @test: callback used for comparisons between inodes
1320 * @data: opaque data pointer to pass to @test
1321 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001322 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001324 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001325 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001326 * Note: I_NEW is not waited upon so you have to be very careful what you do
1327 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001328 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001329 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001330 */
1331struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1332 int (*test)(struct inode *, void *), void *data)
1333{
1334 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001335 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001336
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001337 spin_lock(&inode_hash_lock);
1338 inode = find_inode(sb, head, test, data);
1339 spin_unlock(&inode_hash_lock);
1340
Al Viroc2b6d622018-06-28 15:53:17 -04001341 return IS_ERR(inode) ? NULL : inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001342}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001343EXPORT_SYMBOL(ilookup5_nowait);
1344
1345/**
1346 * ilookup5 - search for an inode in the inode cache
1347 * @sb: super block of file system to search
1348 * @hashval: hash value (usually inode number) to search for
1349 * @test: callback used for comparisons between inodes
1350 * @data: opaque data pointer to pass to @test
1351 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001352 * Search for the inode specified by @hashval and @data in the inode cache,
1353 * and if the inode is in the cache, return the inode with an incremented
1354 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001355 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001357 * This is a generalized version of ilookup() for file systems where the
1358 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001360 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 */
1362struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1363 int (*test)(struct inode *, void *), void *data)
1364{
Al Viro2864f302016-07-03 23:15:21 -04001365 struct inode *inode;
1366again:
1367 inode = ilookup5_nowait(sb, hashval, test, data);
1368 if (inode) {
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001369 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001370 if (unlikely(inode_unhashed(inode))) {
1371 iput(inode);
1372 goto again;
1373 }
1374 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001375 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377EXPORT_SYMBOL(ilookup5);
1378
1379/**
1380 * ilookup - search for an inode in the inode cache
1381 * @sb: super block of file system to search
1382 * @ino: inode number to search for
1383 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001384 * Search for the inode @ino in the inode cache, and if the inode is in the
1385 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 */
1387struct inode *ilookup(struct super_block *sb, unsigned long ino)
1388{
1389 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001390 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001391again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001392 spin_lock(&inode_hash_lock);
1393 inode = find_inode_fast(sb, head, ino);
1394 spin_unlock(&inode_hash_lock);
1395
Al Viro2864f302016-07-03 23:15:21 -04001396 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001397 if (IS_ERR(inode))
1398 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001399 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001400 if (unlikely(inode_unhashed(inode))) {
1401 iput(inode);
1402 goto again;
1403 }
1404 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001405 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407EXPORT_SYMBOL(ilookup);
1408
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001409/**
1410 * find_inode_nowait - find an inode in the inode cache
1411 * @sb: super block of file system to search
1412 * @hashval: hash value (usually inode number) to search for
1413 * @match: callback used for comparisons between inodes
1414 * @data: opaque data pointer to pass to @match
1415 *
1416 * Search for the inode specified by @hashval and @data in the inode
1417 * cache, where the helper function @match will return 0 if the inode
1418 * does not match, 1 if the inode does match, and -1 if the search
1419 * should be stopped. The @match function must be responsible for
1420 * taking the i_lock spin_lock and checking i_state for an inode being
1421 * freed or being initialized, and incrementing the reference count
1422 * before returning 1. It also must not sleep, since it is called with
1423 * the inode_hash_lock spinlock held.
1424 *
1425 * This is a even more generalized version of ilookup5() when the
1426 * function must never block --- find_inode() can block in
1427 * __wait_on_freeing_inode() --- or when the caller can not increment
1428 * the reference count because the resulting iput() might cause an
1429 * inode eviction. The tradeoff is that the @match funtion must be
1430 * very carefully implemented.
1431 */
1432struct inode *find_inode_nowait(struct super_block *sb,
1433 unsigned long hashval,
1434 int (*match)(struct inode *, unsigned long,
1435 void *),
1436 void *data)
1437{
1438 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1439 struct inode *inode, *ret_inode = NULL;
1440 int mval;
1441
1442 spin_lock(&inode_hash_lock);
1443 hlist_for_each_entry(inode, head, i_hash) {
1444 if (inode->i_sb != sb)
1445 continue;
1446 mval = match(inode, hashval, data);
1447 if (mval == 0)
1448 continue;
1449 if (mval == 1)
1450 ret_inode = inode;
1451 goto out;
1452 }
1453out:
1454 spin_unlock(&inode_hash_lock);
1455 return ret_inode;
1456}
1457EXPORT_SYMBOL(find_inode_nowait);
1458
Al Viro261bca82008-12-30 01:48:21 -05001459int insert_inode_locked(struct inode *inode)
1460{
1461 struct super_block *sb = inode->i_sb;
1462 ino_t ino = inode->i_ino;
1463 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001464
Al Viro261bca82008-12-30 01:48:21 -05001465 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001466 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001467 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001468 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001469 if (old->i_ino != ino)
1470 continue;
1471 if (old->i_sb != sb)
1472 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001473 spin_lock(&old->i_lock);
1474 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1475 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001476 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001477 }
Al Viro72a43d62009-05-13 19:13:40 +01001478 break;
1479 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001480 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001481 spin_lock(&inode->i_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001482 inode->i_state |= I_NEW | I_CREATING;
Al Viro261bca82008-12-30 01:48:21 -05001483 hlist_add_head(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001484 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001485 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001486 return 0;
1487 }
Al Viroc2b6d622018-06-28 15:53:17 -04001488 if (unlikely(old->i_state & I_CREATING)) {
1489 spin_unlock(&old->i_lock);
1490 spin_unlock(&inode_hash_lock);
1491 return -EBUSY;
1492 }
Al Viro261bca82008-12-30 01:48:21 -05001493 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001494 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001495 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001496 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001497 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001498 iput(old);
1499 return -EBUSY;
1500 }
1501 iput(old);
1502 }
1503}
Al Viro261bca82008-12-30 01:48:21 -05001504EXPORT_SYMBOL(insert_inode_locked);
1505
1506int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1507 int (*test)(struct inode *, void *), void *data)
1508{
Al Viroc2b6d622018-06-28 15:53:17 -04001509 struct inode *old;
1510
1511 inode->i_state |= I_CREATING;
1512 old = inode_insert5(inode, hashval, test, NULL, data);
Al Viro261bca82008-12-30 01:48:21 -05001513
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001514 if (old != inode) {
Al Viro261bca82008-12-30 01:48:21 -05001515 iput(old);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001516 return -EBUSY;
Al Viro261bca82008-12-30 01:48:21 -05001517 }
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001518 return 0;
Al Viro261bca82008-12-30 01:48:21 -05001519}
Al Viro261bca82008-12-30 01:48:21 -05001520EXPORT_SYMBOL(insert_inode_locked4);
1521
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
Al Viro45321ac2010-06-07 13:43:19 -04001523int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524{
Al Viro45321ac2010-06-07 13:43:19 -04001525 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527EXPORT_SYMBOL(generic_delete_inode);
1528
Al Viro45321ac2010-06-07 13:43:19 -04001529/*
Al Viro45321ac2010-06-07 13:43:19 -04001530 * Called when we're dropping the last reference
1531 * to an inode.
1532 *
1533 * Call the FS "drop_inode()" function, defaulting to
1534 * the legacy UNIX filesystem behaviour. If it tells
1535 * us to evict inode, do so. Otherwise, retain inode
1536 * in cache if fs is alive, sync and evict if fs is
1537 * shutting down.
1538 */
1539static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540{
1541 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001542 const struct super_operations *op = inode->i_sb->s_op;
1543 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544
Dave Chinner250df6e2011-03-22 22:23:36 +11001545 WARN_ON(inode->i_state & I_NEW);
1546
Al Viroe7f59092011-07-07 15:45:59 -04001547 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001548 drop = op->drop_inode(inode);
1549 else
1550 drop = generic_drop_inode(inode);
1551
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001552 if (!drop && (sb->s_flags & SB_ACTIVE)) {
Jan Kara4eff96d2012-11-26 16:29:51 -08001553 inode_add_lru(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001554 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001555 return;
1556 }
1557
Al Viro45321ac2010-06-07 13:43:19 -04001558 if (!drop) {
Alexander Viro991114c2005-06-23 00:09:01 -07001559 inode->i_state |= I_WILL_FREE;
Dave Chinner250df6e2011-03-22 22:23:36 +11001560 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 write_inode_now(inode, 1);
Dave Chinner250df6e2011-03-22 22:23:36 +11001562 spin_lock(&inode->i_lock);
Nick Piggin7ef0d732009-03-12 14:31:38 -07001563 WARN_ON(inode->i_state & I_NEW);
Alexander Viro991114c2005-06-23 00:09:01 -07001564 inode->i_state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001566
Alexander Viro991114c2005-06-23 00:09:01 -07001567 inode->i_state |= I_FREEING;
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001568 if (!list_empty(&inode->i_lru))
1569 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001570 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001571
1572 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573}
1574
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301576 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 * @inode: inode to put
1578 *
1579 * Puts an inode, dropping its usage count. If the inode use count hits
1580 * zero, the inode is then freed and may also be destroyed.
1581 *
1582 * Consequently, iput() can sleep.
1583 */
1584void iput(struct inode *inode)
1585{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001586 if (!inode)
1587 return;
1588 BUG_ON(inode->i_state & I_CLEAR);
1589retry:
1590 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1591 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1592 atomic_inc(&inode->i_count);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001593 spin_unlock(&inode->i_lock);
1594 trace_writeback_lazytime_iput(inode);
1595 mark_inode_dirty_sync(inode);
1596 goto retry;
1597 }
1598 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 }
1600}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601EXPORT_SYMBOL(iput);
1602
Carlos Maiolino30460e12020-01-09 14:30:41 +01001603#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604/**
1605 * bmap - find a block number in a file
Carlos Maiolino30460e12020-01-09 14:30:41 +01001606 * @inode: inode owning the block number being requested
1607 * @block: pointer containing the block to find
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 *
Carlos Maiolino30460e12020-01-09 14:30:41 +01001609 * Replaces the value in *block with the block number on the device holding
1610 * corresponding to the requested block number in the file.
1611 * That is, asked for block 4 of inode 1 the function will replace the
1612 * 4 in *block, with disk block relative to the disk start that holds that
1613 * block of the file.
1614 *
1615 * Returns -EINVAL in case of error, 0 otherwise. If mapping falls into a
1616 * hole, returns 0 and *block is also set to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 */
Carlos Maiolino30460e12020-01-09 14:30:41 +01001618int bmap(struct inode *inode, sector_t *block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619{
Carlos Maiolino30460e12020-01-09 14:30:41 +01001620 if (!inode->i_mapping->a_ops->bmap)
1621 return -EINVAL;
1622
1623 *block = inode->i_mapping->a_ops->bmap(inode->i_mapping, *block);
1624 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626EXPORT_SYMBOL(bmap);
Carlos Maiolino30460e12020-01-09 14:30:41 +01001627#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001629/*
1630 * With relative atime, only update atime if the previous atime is
1631 * earlier than either the ctime or mtime or if at least a day has
1632 * passed since the last atime update.
1633 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001634static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001635 struct timespec64 now)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001636{
1637
Miklos Szeredic6718542018-07-18 15:44:43 +02001638 if (!(mnt->mnt_flags & MNT_RELATIME))
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001639 return 1;
1640 /*
1641 * Is mtime younger than atime? If yes, update atime:
1642 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001643 if (timespec64_compare(&inode->i_mtime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001644 return 1;
1645 /*
1646 * Is ctime younger than atime? If yes, update atime:
1647 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001648 if (timespec64_compare(&inode->i_ctime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001649 return 1;
1650
1651 /*
1652 * Is the previous atime value older than a day? If yes,
1653 * update atime:
1654 */
1655 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1656 return 1;
1657 /*
1658 * Good, we can skip the atime update:
1659 */
1660 return 0;
1661}
1662
Deepa Dinamani95582b02018-05-08 19:36:02 -07001663int generic_update_time(struct inode *inode, struct timespec64 *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001664{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001665 int iflags = I_DIRTY_TIME;
Jeff Laytone38cf302017-12-11 06:35:22 -05001666 bool dirty = false;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001667
1668 if (flags & S_ATIME)
1669 inode->i_atime = *time;
1670 if (flags & S_VERSION)
Jeff Laytone38cf302017-12-11 06:35:22 -05001671 dirty = inode_maybe_inc_iversion(inode, false);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001672 if (flags & S_CTIME)
1673 inode->i_ctime = *time;
1674 if (flags & S_MTIME)
1675 inode->i_mtime = *time;
Jeff Laytone38cf302017-12-11 06:35:22 -05001676 if ((flags & (S_ATIME | S_CTIME | S_MTIME)) &&
1677 !(inode->i_sb->s_flags & SB_LAZYTIME))
1678 dirty = true;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001679
Jeff Laytone38cf302017-12-11 06:35:22 -05001680 if (dirty)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001681 iflags |= I_DIRTY_SYNC;
1682 __mark_inode_dirty(inode, iflags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001683 return 0;
1684}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001685EXPORT_SYMBOL(generic_update_time);
1686
1687/*
1688 * This does the actual work of updating an inodes time or version. Must have
1689 * had called mnt_want_write() before calling this.
1690 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001691static int update_time(struct inode *inode, struct timespec64 *time, int flags)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001692{
Deepa Dinamani23b424d2019-12-02 21:19:45 -08001693 if (inode->i_op->update_time)
1694 return inode->i_op->update_time(inode, time, flags);
1695 return generic_update_time(inode, time, flags);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001696}
Josef Bacikc3b2da32012-03-26 09:59:21 -04001697
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698/**
Christoph Hellwig869243a2006-01-09 20:52:03 -08001699 * touch_atime - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001700 * @path: the &struct path to update
Randy Dunlap30fdc8e2015-11-09 14:57:58 -08001701 * @inode: inode to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 *
1703 * Update the accessed time on an inode and mark it for writeback.
1704 * This function automatically handles read only file systems and media,
1705 * as well as the "noatime" flag and inode specific "noatime" markers.
1706 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001707bool atime_needs_update(const struct path *path, struct inode *inode)
NeilBrown8fa9dd22015-03-23 13:37:40 +11001708{
1709 struct vfsmount *mnt = path->mnt;
Deepa Dinamani95582b02018-05-08 19:36:02 -07001710 struct timespec64 now;
NeilBrown8fa9dd22015-03-23 13:37:40 +11001711
1712 if (inode->i_flags & S_NOATIME)
1713 return false;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001714
1715 /* Atime updates will likely cause i_uid and i_gid to be written
1716 * back improprely if their true value is unknown to the vfs.
1717 */
1718 if (HAS_UNMAPPED_ID(inode))
1719 return false;
1720
NeilBrown8fa9dd22015-03-23 13:37:40 +11001721 if (IS_NOATIME(inode))
1722 return false;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001723 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001724 return false;
1725
1726 if (mnt->mnt_flags & MNT_NOATIME)
1727 return false;
1728 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1729 return false;
1730
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001731 now = current_time(inode);
NeilBrown8fa9dd22015-03-23 13:37:40 +11001732
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001733 if (!relatime_need_update(mnt, inode, now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001734 return false;
1735
Deepa Dinamani95582b02018-05-08 19:36:02 -07001736 if (timespec64_equal(&inode->i_atime, &now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001737 return false;
1738
1739 return true;
1740}
1741
Al Virobadcf2b2013-07-16 18:15:46 +04001742void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743{
Al Viro68ac1232012-03-15 08:21:57 -04001744 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001745 struct inode *inode = d_inode(path->dentry);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001746 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747
Miklos Szeredic6718542018-07-18 15:44:43 +02001748 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001749 return;
1750
Jan Kara5d37e9e2012-06-12 16:20:36 +02001751 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001752 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001753
NeilBrown8fa9dd22015-03-23 13:37:40 +11001754 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001755 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001756 /*
1757 * File systems can error out when updating inodes if they need to
1758 * allocate new space to modify an inode (such is the case for
1759 * Btrfs), but since we touch atime while walking down the path we
1760 * really don't care if we failed to update the atime of the file,
1761 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001762 * We may also fail on filesystems that have the ability to make parts
1763 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001764 */
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001765 now = current_time(inode);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001766 update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001767 __mnt_drop_write(mnt);
1768skip_update:
1769 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001771EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
Cong Wang3ed37642012-05-15 14:57:33 +08001773/*
1774 * The logic we want is
1775 *
1776 * if suid or (sgid and xgrp)
1777 * remove privs
1778 */
1779int should_remove_suid(struct dentry *dentry)
1780{
David Howellsdf2b1af2015-03-17 22:26:15 +00001781 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001782 int kill = 0;
1783
1784 /* suid always must be killed */
1785 if (unlikely(mode & S_ISUID))
1786 kill = ATTR_KILL_SUID;
1787
1788 /*
1789 * sgid without any exec bits is just a mandatory locking mark; leave
1790 * it alone. If some exec bits are set, it's a real sgid; kill it.
1791 */
1792 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1793 kill |= ATTR_KILL_SGID;
1794
1795 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1796 return kill;
1797
1798 return 0;
1799}
1800EXPORT_SYMBOL(should_remove_suid);
1801
Jan Karadbfae0c2015-05-21 16:05:54 +02001802/*
1803 * Return mask of changes for notify_change() that need to be done as a
1804 * response to write or truncate. Return 0 if nothing has to be changed.
1805 * Negative value on error (change should be denied).
1806 */
Jan Kara45f147a2015-05-21 16:05:55 +02001807int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001808{
Jan Karadbfae0c2015-05-21 16:05:54 +02001809 struct inode *inode = d_inode(dentry);
1810 int mask = 0;
1811 int ret;
1812
1813 if (IS_NOSEC(inode))
1814 return 0;
1815
1816 mask = should_remove_suid(dentry);
1817 ret = security_inode_need_killpriv(dentry);
1818 if (ret < 0)
1819 return ret;
1820 if (ret)
1821 mask |= ATTR_KILL_PRIV;
1822 return mask;
1823}
Jan Karadbfae0c2015-05-21 16:05:54 +02001824
1825static int __remove_privs(struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001826{
1827 struct iattr newattrs;
1828
1829 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001830 /*
1831 * Note we call this on write, so notify_change will not
1832 * encounter any conflicting delegations:
1833 */
1834 return notify_change(dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001835}
1836
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001837/*
1838 * Remove special file priviledges (suid, capabilities) when file is written
1839 * to or truncated.
1840 */
1841int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001842{
Miklos Szeredic1892c32016-08-03 13:44:27 +02001843 struct dentry *dentry = file_dentry(file);
1844 struct inode *inode = file_inode(file);
Jan Karadbfae0c2015-05-21 16:05:54 +02001845 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001846 int error = 0;
1847
Alexander Lochmannf69e7492018-12-14 11:55:52 +01001848 /*
1849 * Fast path for nothing security related.
1850 * As well for non-regular files, e.g. blkdev inodes.
1851 * For example, blkdev_write_iter() might get here
1852 * trying to remove privs which it is not allowed to.
1853 */
1854 if (IS_NOSEC(inode) || !S_ISREG(inode->i_mode))
Cong Wang3ed37642012-05-15 14:57:33 +08001855 return 0;
1856
Miklos Szeredic1892c32016-08-03 13:44:27 +02001857 kill = dentry_needs_remove_privs(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001858 if (kill < 0)
1859 return kill;
1860 if (kill)
1861 error = __remove_privs(dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001862 if (!error)
1863 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001864
1865 return error;
1866}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001867EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001868
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001870 * file_update_time - update mtime and ctime time
1871 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001873 * Update the mtime and ctime members of an inode and mark the inode
1874 * for writeback. Note that this function is meant exclusively for
1875 * usage in the file write path of filesystems, and filesystems may
1876 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001877 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001878 * timestamps are handled by the server. This can return an error for
1879 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 */
1881
Josef Bacikc3b2da32012-03-26 09:59:21 -04001882int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883{
Al Viro496ad9a2013-01-23 17:07:38 -05001884 struct inode *inode = file_inode(file);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001885 struct timespec64 now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001886 int sync_it = 0;
1887 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888
Andi Kleence06e0b2009-09-18 13:05:48 -07001889 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001891 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001892
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001893 now = current_time(inode);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001894 if (!timespec64_equal(&inode->i_mtime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001895 sync_it = S_MTIME;
1896
Deepa Dinamani95582b02018-05-08 19:36:02 -07001897 if (!timespec64_equal(&inode->i_ctime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001898 sync_it |= S_CTIME;
1899
Jeff Laytone38cf302017-12-11 06:35:22 -05001900 if (IS_I_VERSION(inode) && inode_iversion_need_inc(inode))
Andi Kleence06e0b2009-09-18 13:05:48 -07001901 sync_it |= S_VERSION;
1902
1903 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001904 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905
Andi Kleence06e0b2009-09-18 13:05:48 -07001906 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02001907 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001908 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909
Josef Bacikc3b2da32012-03-26 09:59:21 -04001910 ret = update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02001911 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001912
1913 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914}
Christoph Hellwig870f4812006-01-09 20:52:01 -08001915EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916
Amir Goldsteine38f7f52019-06-05 08:04:49 -07001917/* Caller must hold the file's inode lock */
1918int file_modified(struct file *file)
1919{
1920 int err;
1921
1922 /*
1923 * Clear the security bits if the process is not being run by root.
1924 * This keeps people from modifying setuid and setgid binaries.
1925 */
1926 err = file_remove_privs(file);
1927 if (err)
1928 return err;
1929
1930 if (unlikely(file->f_mode & FMODE_NOCMTIME))
1931 return 0;
1932
1933 return file_update_time(file);
1934}
1935EXPORT_SYMBOL(file_modified);
1936
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937int inode_needs_sync(struct inode *inode)
1938{
1939 if (IS_SYNC(inode))
1940 return 1;
1941 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1942 return 1;
1943 return 0;
1944}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945EXPORT_SYMBOL(inode_needs_sync);
1946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07001948 * If we try to find an inode in the inode hash while it is being
1949 * deleted, we have to wait until the filesystem completes its
1950 * deletion before reporting that it isn't found. This function waits
1951 * until the deletion _might_ have completed. Callers are responsible
1952 * to recheck inode state.
1953 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001954 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11001955 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
1956 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 */
1958static void __wait_on_freeing_inode(struct inode *inode)
1959{
1960 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001961 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1962 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Ingo Molnar21417132017-03-05 11:25:39 +01001963 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001964 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001965 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 schedule();
Ingo Molnar21417132017-03-05 11:25:39 +01001967 finish_wait(wq, &wait.wq_entry);
Dave Chinner67a23c42011-03-22 22:23:42 +11001968 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969}
1970
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971static __initdata unsigned long ihash_entries;
1972static int __init set_ihash_entries(char *str)
1973{
1974 if (!str)
1975 return 0;
1976 ihash_entries = simple_strtoul(str, &str, 0);
1977 return 1;
1978}
1979__setup("ihash_entries=", set_ihash_entries);
1980
1981/*
1982 * Initialize the waitqueues and inode hash table.
1983 */
1984void __init inode_init_early(void)
1985{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 /* If hashes are distributed across NUMA nodes, defer
1987 * hash allocation until vmalloc space is available.
1988 */
1989 if (hashdist)
1990 return;
1991
1992 inode_hashtable =
1993 alloc_large_system_hash("Inode-cache",
1994 sizeof(struct hlist_head),
1995 ihash_entries,
1996 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07001997 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998 &i_hash_shift,
1999 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002000 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002}
2003
Denis Cheng74bf17c2007-10-16 23:26:30 -07002004void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08002007 inode_cachep = kmem_cache_create("inode_cache",
2008 sizeof(struct inode),
2009 0,
2010 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
Vladimir Davydov5d097052016-01-14 15:18:21 -08002011 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
Paul Mundt20c2df82007-07-20 10:11:58 +09002012 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013
2014 /* Hash may have been set up in inode_init_early */
2015 if (!hashdist)
2016 return;
2017
2018 inode_hashtable =
2019 alloc_large_system_hash("Inode-cache",
2020 sizeof(struct hlist_head),
2021 ihash_entries,
2022 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002023 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 &i_hash_shift,
2025 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002026 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028}
2029
2030void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
2031{
2032 inode->i_mode = mode;
2033 if (S_ISCHR(mode)) {
2034 inode->i_fop = &def_chr_fops;
2035 inode->i_rdev = rdev;
2036 } else if (S_ISBLK(mode)) {
2037 inode->i_fop = &def_blk_fops;
2038 inode->i_rdev = rdev;
2039 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04002040 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05002042 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07002044 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
2045 " inode %s:%lu\n", mode, inode->i_sb->s_id,
2046 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047}
2048EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002049
2050/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00002051 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002052 * @inode: New inode
2053 * @dir: Directory inode
2054 * @mode: mode of the new inode
2055 */
2056void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04002057 umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002058{
2059 inode->i_uid = current_fsuid();
2060 if (dir && dir->i_mode & S_ISGID) {
2061 inode->i_gid = dir->i_gid;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002062
2063 /* Directories are special, and always inherit S_ISGID */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002064 if (S_ISDIR(mode))
2065 mode |= S_ISGID;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002066 else if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP) &&
2067 !in_group_p(inode->i_gid) &&
2068 !capable_wrt_inode_uidgid(dir, CAP_FSETID))
2069 mode &= ~S_ISGID;
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002070 } else
2071 inode->i_gid = current_fsgid();
2072 inode->i_mode = mode;
2073}
2074EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07002075
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002076/**
2077 * inode_owner_or_capable - check current task permissions to inode
2078 * @inode: inode being checked
2079 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002080 * Return true if current either has CAP_FOWNER in a namespace with the
2081 * inode owner uid mapped, or owns the file.
Serge E. Hallyne795b712011-03-23 16:43:25 -07002082 */
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002083bool inode_owner_or_capable(const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07002084{
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002085 struct user_namespace *ns;
2086
Eric W. Biederman92361632012-02-08 07:07:50 -08002087 if (uid_eq(current_fsuid(), inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002088 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002089
2090 ns = current_user_ns();
Kees Cookcc658db2017-06-21 09:53:06 -07002091 if (kuid_has_mapping(ns, inode->i_uid) && ns_capable(ns, CAP_FOWNER))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002092 return true;
2093 return false;
2094}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002095EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002096
2097/*
2098 * Direct i/o helper functions
2099 */
2100static void __inode_dio_wait(struct inode *inode)
2101{
2102 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2103 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2104
2105 do {
Ingo Molnar21417132017-03-05 11:25:39 +01002106 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002107 if (atomic_read(&inode->i_dio_count))
2108 schedule();
2109 } while (atomic_read(&inode->i_dio_count));
Ingo Molnar21417132017-03-05 11:25:39 +01002110 finish_wait(wq, &q.wq_entry);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002111}
2112
2113/**
2114 * inode_dio_wait - wait for outstanding DIO requests to finish
2115 * @inode: inode to wait for
2116 *
2117 * Waits for all pending direct I/O requests to finish so that we can
2118 * proceed with a truncate or equivalent operation.
2119 *
2120 * Must be called under a lock that serializes taking new references
2121 * to i_dio_count, usually by inode->i_mutex.
2122 */
2123void inode_dio_wait(struct inode *inode)
2124{
2125 if (atomic_read(&inode->i_dio_count))
2126 __inode_dio_wait(inode);
2127}
2128EXPORT_SYMBOL(inode_dio_wait);
2129
2130/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002131 * inode_set_flags - atomically set some inode flags
2132 *
2133 * Note: the caller should be holding i_mutex, or else be sure that
2134 * they have exclusive access to the inode structure (i.e., while the
2135 * inode is being instantiated). The reason for the cmpxchg() loop
2136 * --- which wouldn't be necessary if all code paths which modify
2137 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002138 * code path which doesn't today so we use cmpxchg() out of an abundance
2139 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002140 *
2141 * In the long run, i_mutex is overkill, and we should probably look
2142 * at using the i_lock spinlock to protect i_flags, and then make sure
2143 * it is so documented in include/linux/fs.h and that all code follows
2144 * the locking convention!!
2145 */
2146void inode_set_flags(struct inode *inode, unsigned int flags,
2147 unsigned int mask)
2148{
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002149 WARN_ON_ONCE(flags & ~mask);
Vineet Guptaa9057372019-03-05 15:41:52 -08002150 set_mask_bits(&inode->i_flags, mask, flags);
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002151}
2152EXPORT_SYMBOL(inode_set_flags);
Al Viro21fc61c2015-11-17 01:07:57 -05002153
2154void inode_nohighmem(struct inode *inode)
2155{
2156 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2157}
2158EXPORT_SYMBOL(inode_nohighmem);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002159
2160/**
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002161 * timestamp_truncate - Truncate timespec to a granularity
2162 * @t: Timespec
2163 * @inode: inode being updated
2164 *
2165 * Truncate a timespec to the granularity supported by the fs
2166 * containing the inode. Always rounds down. gran must
2167 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2168 */
2169struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode)
2170{
2171 struct super_block *sb = inode->i_sb;
2172 unsigned int gran = sb->s_time_gran;
2173
2174 t.tv_sec = clamp(t.tv_sec, sb->s_time_min, sb->s_time_max);
2175 if (unlikely(t.tv_sec == sb->s_time_max || t.tv_sec == sb->s_time_min))
2176 t.tv_nsec = 0;
2177
2178 /* Avoid division in the common cases 1 ns and 1 s. */
2179 if (gran == 1)
2180 ; /* nothing */
2181 else if (gran == NSEC_PER_SEC)
2182 t.tv_nsec = 0;
2183 else if (gran > 1 && gran < NSEC_PER_SEC)
2184 t.tv_nsec -= t.tv_nsec % gran;
2185 else
2186 WARN(1, "invalid file time granularity: %u", gran);
2187 return t;
2188}
2189EXPORT_SYMBOL(timestamp_truncate);
2190
2191/**
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002192 * current_time - Return FS time
2193 * @inode: inode.
2194 *
2195 * Return the current time truncated to the time granularity supported by
2196 * the fs.
2197 *
2198 * Note that inode and inode->sb cannot be NULL.
2199 * Otherwise, the function warns and returns time without truncation.
2200 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07002201struct timespec64 current_time(struct inode *inode)
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002202{
Arnd Bergmannd651d162018-12-05 11:14:27 +11002203 struct timespec64 now;
2204
2205 ktime_get_coarse_real_ts64(&now);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002206
2207 if (unlikely(!inode->i_sb)) {
2208 WARN(1, "current_time() called with uninitialized super_block in the inode");
2209 return now;
2210 }
2211
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002212 return timestamp_truncate(now, inode);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002213}
2214EXPORT_SYMBOL(current_time);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002215
2216/*
2217 * Generic function to check FS_IOC_SETFLAGS values and reject any invalid
2218 * configurations.
2219 *
2220 * Note: the caller should be holding i_mutex, or else be sure that they have
2221 * exclusive access to the inode structure.
2222 */
2223int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
2224 unsigned int flags)
2225{
2226 /*
2227 * The IMMUTABLE and APPEND_ONLY flags can only be changed by
2228 * the relevant capability.
2229 *
2230 * This test looks nicer. Thanks to Pauline Middelink
2231 */
2232 if ((flags ^ oldflags) & (FS_APPEND_FL | FS_IMMUTABLE_FL) &&
2233 !capable(CAP_LINUX_IMMUTABLE))
2234 return -EPERM;
2235
Daniel Rosenberg6e1918c2020-01-20 14:31:56 -08002236 return fscrypt_prepare_setflags(inode, oldflags, flags);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002237}
2238EXPORT_SYMBOL(vfs_ioc_setflags_prepare);
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002239
2240/*
2241 * Generic function to check FS_IOC_FSSETXATTR values and reject any invalid
2242 * configurations.
2243 *
2244 * Note: the caller should be holding i_mutex, or else be sure that they have
2245 * exclusive access to the inode structure.
2246 */
2247int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
2248 struct fsxattr *fa)
2249{
2250 /*
2251 * Can't modify an immutable/append-only file unless we have
2252 * appropriate permission.
2253 */
2254 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2255 (FS_XFLAG_IMMUTABLE | FS_XFLAG_APPEND) &&
2256 !capable(CAP_LINUX_IMMUTABLE))
2257 return -EPERM;
2258
Darrick J. Wongf9914922019-07-01 08:25:35 -07002259 /*
2260 * Project Quota ID state is only allowed to change from within the init
2261 * namespace. Enforce that restriction only if we are trying to change
2262 * the quota ID state. Everything else is allowed in user namespaces.
2263 */
2264 if (current_user_ns() != &init_user_ns) {
2265 if (old_fa->fsx_projid != fa->fsx_projid)
2266 return -EINVAL;
2267 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2268 FS_XFLAG_PROJINHERIT)
2269 return -EINVAL;
2270 }
2271
Darrick J. Wongca29be72019-07-01 08:25:36 -07002272 /* Check extent size hints. */
2273 if ((fa->fsx_xflags & FS_XFLAG_EXTSIZE) && !S_ISREG(inode->i_mode))
2274 return -EINVAL;
2275
2276 if ((fa->fsx_xflags & FS_XFLAG_EXTSZINHERIT) &&
2277 !S_ISDIR(inode->i_mode))
2278 return -EINVAL;
2279
2280 if ((fa->fsx_xflags & FS_XFLAG_COWEXTSIZE) &&
2281 !S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
2282 return -EINVAL;
2283
Darrick J. Wongdbc77f32019-07-01 08:25:36 -07002284 /*
2285 * It is only valid to set the DAX flag on regular files and
2286 * directories on filesystems.
2287 */
2288 if ((fa->fsx_xflags & FS_XFLAG_DAX) &&
2289 !(S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode)))
2290 return -EINVAL;
2291
Darrick J. Wongca29be72019-07-01 08:25:36 -07002292 /* Extent size hints of zero turn off the flags. */
2293 if (fa->fsx_extsize == 0)
2294 fa->fsx_xflags &= ~(FS_XFLAG_EXTSIZE | FS_XFLAG_EXTSZINHERIT);
2295 if (fa->fsx_cowextsize == 0)
2296 fa->fsx_xflags &= ~FS_XFLAG_COWEXTSIZE;
2297
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002298 return 0;
2299}
2300EXPORT_SYMBOL(vfs_ioc_fssetxattr_check);