blob: 7d57068b6b7aedbc3ddde2b91179853b7e8c6f43 [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;
141 atomic_set(&inode->i_count, 1);
142 inode->i_op = &empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500143 inode->i_fop = &no_open_fops;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200144 inode->__i_nlink = 1;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700145 inode->i_opflags = 0;
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200146 if (sb->s_xattr)
147 inode->i_opflags |= IOP_XATTR;
Eric W. Biederman92361632012-02-08 07:07:50 -0800148 i_uid_write(inode, 0);
149 i_gid_write(inode, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100150 atomic_set(&inode->i_writecount, 0);
151 inode->i_size = 0;
Jens Axboec75b1d92017-06-27 11:47:04 -0600152 inode->i_write_hint = WRITE_LIFE_NOT_SET;
David Chinner2cb15992008-10-30 17:32:23 +1100153 inode->i_blocks = 0;
154 inode->i_bytes = 0;
155 inode->i_generation = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100156 inode->i_pipe = NULL;
157 inode->i_bdev = NULL;
158 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400159 inode->i_link = NULL;
Al Viro84e710d2016-04-15 00:58:55 -0400160 inode->i_dir_seq = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100161 inode->i_rdev = 0;
162 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500163
Tahsin Erdogan3d65ae42016-02-16 13:34:39 -0800164#ifdef CONFIG_CGROUP_WRITEBACK
165 inode->i_wb_frn_winner = 0;
166 inode->i_wb_frn_avg_time = 0;
167 inode->i_wb_frn_history = 0;
168#endif
169
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500170 if (security_inode_alloc(inode))
Christoph Hellwig54e34622009-08-07 14:38:25 -0300171 goto out;
David Chinner2cb15992008-10-30 17:32:23 +1100172 spin_lock_init(&inode->i_lock);
173 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
174
Al Viro9902af72016-04-15 15:08:36 -0400175 init_rwsem(&inode->i_rwsem);
176 lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
David Chinner2cb15992008-10-30 17:32:23 +1100177
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400178 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100179
180 mapping->a_ops = &empty_aops;
181 mapping->host = inode;
182 mapping->flags = 0;
Darrick J. Wong829bc7872018-05-30 19:43:53 -0700183 mapping->wb_err = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700184 atomic_set(&mapping->i_mmap_writable, 0);
Song Liu09d91cd2019-09-23 15:38:03 -0700185#ifdef CONFIG_READ_ONLY_THP_FOR_FS
186 atomic_set(&mapping->nr_thps, 0);
187#endif
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800188 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800189 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100190 mapping->writeback_index = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100191 inode->i_private = NULL;
192 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400193 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400194#ifdef CONFIG_FS_POSIX_ACL
195 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
196#endif
David Chinner2cb15992008-10-30 17:32:23 +1100197
Eric Paris3be25f42009-05-21 17:01:26 -0400198#ifdef CONFIG_FSNOTIFY
199 inode->i_fsnotify_mask = 0;
200#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500201 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100202 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400203
Christoph Hellwig54e34622009-08-07 14:38:25 -0300204 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300205out:
206 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100207}
208EXPORT_SYMBOL(inode_init_always);
209
Al Virofdb0da82019-04-10 14:43:44 -0400210void free_inode_nonrcu(struct inode *inode)
211{
212 kmem_cache_free(inode_cachep, inode);
213}
214EXPORT_SYMBOL(free_inode_nonrcu);
215
216static void i_callback(struct rcu_head *head)
217{
218 struct inode *inode = container_of(head, struct inode, i_rcu);
219 if (inode->free_inode)
220 inode->free_inode(inode);
221 else
222 free_inode_nonrcu(inode);
223}
224
David Chinner2cb15992008-10-30 17:32:23 +1100225static struct inode *alloc_inode(struct super_block *sb)
226{
Al Virofdb0da82019-04-10 14:43:44 -0400227 const struct super_operations *ops = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 struct inode *inode;
229
Al Virofdb0da82019-04-10 14:43:44 -0400230 if (ops->alloc_inode)
231 inode = ops->alloc_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 else
David Chinner2cb15992008-10-30 17:32:23 +1100233 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Christoph Hellwig54e34622009-08-07 14:38:25 -0300235 if (!inode)
236 return NULL;
237
238 if (unlikely(inode_init_always(sb, inode))) {
Al Virofdb0da82019-04-10 14:43:44 -0400239 if (ops->destroy_inode) {
240 ops->destroy_inode(inode);
241 if (!ops->free_inode)
242 return NULL;
243 }
244 inode->free_inode = ops->free_inode;
245 i_callback(&inode->i_rcu);
Christoph Hellwig54e34622009-08-07 14:38:25 -0300246 return NULL;
247 }
248
249 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250}
251
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300252void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200254 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400255 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400257 fsnotify_inode_delete(inode);
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500258 locks_free_lock_context(inode);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100259 if (!inode->i_nlink) {
260 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
261 atomic_long_dec(&inode->i_sb->s_remove_count);
262 }
263
Al Virof19d4a82009-06-08 19:50:45 -0400264#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100265 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400266 posix_acl_release(inode->i_acl);
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100267 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400268 posix_acl_release(inode->i_default_acl);
269#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100270 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300271}
272EXPORT_SYMBOL(__destroy_inode);
273
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200274static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300275{
Al Virofdb0da82019-04-10 14:43:44 -0400276 const struct super_operations *ops = inode->i_sb->s_op;
277
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100278 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300279 __destroy_inode(inode);
Al Virofdb0da82019-04-10 14:43:44 -0400280 if (ops->destroy_inode) {
281 ops->destroy_inode(inode);
282 if (!ops->free_inode)
283 return;
284 }
285 inode->free_inode = ops->free_inode;
286 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100289/**
290 * drop_nlink - directly drop an inode's link count
291 * @inode: inode
292 *
293 * This is a low-level filesystem helper to replace any
294 * direct filesystem manipulation of i_nlink. In cases
295 * where we are attempting to track writes to the
296 * filesystem, a decrement to zero means an imminent
297 * write when the file is truncated and actually unlinked
298 * on the filesystem.
299 */
300void drop_nlink(struct inode *inode)
301{
302 WARN_ON(inode->i_nlink == 0);
303 inode->__i_nlink--;
304 if (!inode->i_nlink)
305 atomic_long_inc(&inode->i_sb->s_remove_count);
306}
307EXPORT_SYMBOL(drop_nlink);
308
309/**
310 * clear_nlink - directly zero an inode's link count
311 * @inode: inode
312 *
313 * This is a low-level filesystem helper to replace any
314 * direct filesystem manipulation of i_nlink. See
315 * drop_nlink() for why we care about i_nlink hitting zero.
316 */
317void clear_nlink(struct inode *inode)
318{
319 if (inode->i_nlink) {
320 inode->__i_nlink = 0;
321 atomic_long_inc(&inode->i_sb->s_remove_count);
322 }
323}
324EXPORT_SYMBOL(clear_nlink);
325
326/**
327 * set_nlink - directly set an inode's link count
328 * @inode: inode
329 * @nlink: new nlink (should be non-zero)
330 *
331 * This is a low-level filesystem helper to replace any
332 * direct filesystem manipulation of i_nlink.
333 */
334void set_nlink(struct inode *inode, unsigned int nlink)
335{
336 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100337 clear_nlink(inode);
338 } else {
339 /* Yes, some filesystems do change nlink from zero to one */
340 if (inode->i_nlink == 0)
341 atomic_long_dec(&inode->i_sb->s_remove_count);
342
343 inode->__i_nlink = nlink;
344 }
345}
346EXPORT_SYMBOL(set_nlink);
347
348/**
349 * inc_nlink - directly increment an inode's link count
350 * @inode: inode
351 *
352 * This is a low-level filesystem helper to replace any
353 * direct filesystem manipulation of i_nlink. Currently,
354 * it is only here for parity with dec_nlink().
355 */
356void inc_nlink(struct inode *inode)
357{
Al Virof4e0c302013-06-11 08:34:36 +0400358 if (unlikely(inode->i_nlink == 0)) {
359 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100360 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400361 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100362
363 inode->__i_nlink++;
364}
365EXPORT_SYMBOL(inc_nlink);
366
Dave Chinnerae233952018-03-06 17:30:34 -0800367static void __address_space_init_once(struct address_space *mapping)
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100368{
Johannes Weiner7b785642019-05-24 10:12:46 -0400369 xa_init_flags(&mapping->i_pages, XA_FLAGS_LOCK_IRQ | XA_FLAGS_ACCOUNT);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800370 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100371 INIT_LIST_HEAD(&mapping->private_list);
372 spin_lock_init(&mapping->private_lock);
Davidlohr Buesof808c132017-09-08 16:15:08 -0700373 mapping->i_mmap = RB_ROOT_CACHED;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100374}
Dave Chinnerae233952018-03-06 17:30:34 -0800375
376void address_space_init_once(struct address_space *mapping)
377{
378 memset(mapping, 0, sizeof(*mapping));
379 __address_space_init_once(mapping);
380}
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100381EXPORT_SYMBOL(address_space_init_once);
382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383/*
384 * These are initializations that only need to be done
385 * once, because the fields are idempotent across use
386 * of the inode, so let the slab aware of that.
387 */
388void inode_init_once(struct inode *inode)
389{
390 memset(inode, 0, sizeof(*inode));
391 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500393 INIT_LIST_HEAD(&inode->i_io_list);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700394 INIT_LIST_HEAD(&inode->i_wb_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100395 INIT_LIST_HEAD(&inode->i_lru);
Dave Chinnerae233952018-03-06 17:30:34 -0800396 __address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 i_size_ordered_init(inode);
398}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399EXPORT_SYMBOL(inode_init_once);
400
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700401static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530403 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
Christoph Lametera35afb82007-05-16 22:10:57 -0700405 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406}
407
408/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100409 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530411void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412{
Nick Piggin9e38d862010-10-23 06:55:17 -0400413 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414}
415
Al Viro7de9c6ee2010-10-23 11:11:40 -0400416/*
417 * get additional reference to inode; caller must already hold one.
418 */
419void ihold(struct inode *inode)
420{
421 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
422}
423EXPORT_SYMBOL(ihold);
424
Nick Piggin9e38d862010-10-23 06:55:17 -0400425static void inode_lru_list_add(struct inode *inode)
426{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000427 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000428 this_cpu_inc(nr_unused);
Josef Bacik563f4002017-04-18 16:04:17 -0400429 else
430 inode->i_state |= I_REFERENCED;
Nick Piggin9e38d862010-10-23 06:55:17 -0400431}
432
Jan Kara4eff96d2012-11-26 16:29:51 -0800433/*
434 * Add inode to LRU if needed (inode is unused and clean).
435 *
436 * Needs inode->i_lock held.
437 */
438void inode_add_lru(struct inode *inode)
439{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500440 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
441 I_FREEING | I_WILL_FREE)) &&
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800442 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & SB_ACTIVE)
Jan Kara4eff96d2012-11-26 16:29:51 -0800443 inode_lru_list_add(inode);
444}
445
446
Nick Piggin9e38d862010-10-23 06:55:17 -0400447static void inode_lru_list_del(struct inode *inode)
448{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000449
450 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000451 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452}
453
Christoph Hellwig646ec462010-10-23 07:15:32 -0400454/**
455 * inode_sb_list_add - add inode to the superblock list of inodes
456 * @inode: inode to add
457 */
458void inode_sb_list_add(struct inode *inode)
459{
Dave Chinner74278da2015-03-04 12:37:22 -0500460 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100461 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500462 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400463}
464EXPORT_SYMBOL_GPL(inode_sb_list_add);
465
Dave Chinner55fa6092011-03-22 22:23:40 +1100466static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400467{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200468 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500469 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200470 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500471 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200472 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400473}
474
Dave Chinner4c51acb2010-10-23 06:58:09 -0400475static unsigned long hash(struct super_block *sb, unsigned long hashval)
476{
477 unsigned long tmp;
478
479 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
480 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400481 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
482 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400483}
484
485/**
486 * __insert_inode_hash - hash an inode
487 * @inode: unhashed inode
488 * @hashval: unsigned long value used to locate this object in the
489 * inode_hashtable.
490 *
491 * Add an inode to the inode hash for this superblock.
492 */
493void __insert_inode_hash(struct inode *inode, unsigned long hashval)
494{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400495 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
496
Dave Chinner67a23c42011-03-22 22:23:42 +1100497 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100498 spin_lock(&inode->i_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400499 hlist_add_head(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100500 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100501 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400502}
503EXPORT_SYMBOL(__insert_inode_hash);
504
505/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200506 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400507 * @inode: inode to unhash
508 *
509 * Remove an inode from the superblock.
510 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200511void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400512{
Dave Chinner67a23c42011-03-22 22:23:42 +1100513 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100514 spin_lock(&inode->i_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400515 hlist_del_init(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100516 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100517 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400518}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200519EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400520
Jan Karadbd57682012-05-03 14:48:02 +0200521void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400522{
Jan Kara08142572011-06-27 16:18:10 -0700523 /*
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700524 * We have to cycle the i_pages lock here because reclaim can be in the
Jan Kara08142572011-06-27 16:18:10 -0700525 * process of removing the last page (in __delete_from_page_cache())
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700526 * and we must not free the mapping under it.
Jan Kara08142572011-06-27 16:18:10 -0700527 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700528 xa_lock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400529 BUG_ON(inode->i_data.nrpages);
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800530 BUG_ON(inode->i_data.nrexceptional);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700531 xa_unlock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400532 BUG_ON(!list_empty(&inode->i_data.private_list));
533 BUG_ON(!(inode->i_state & I_FREEING));
534 BUG_ON(inode->i_state & I_CLEAR);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700535 BUG_ON(!list_empty(&inode->i_wb_list));
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100536 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400537 inode->i_state = I_FREEING | I_CLEAR;
538}
Jan Karadbd57682012-05-03 14:48:02 +0200539EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400540
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100541/*
542 * Free the inode passed in, removing it from the lists it is still connected
543 * to. We remove any pages still attached to the inode and wait for any IO that
544 * is still in progress before finally destroying the inode.
545 *
546 * An inode must already be marked I_FREEING so that we avoid the inode being
547 * moved back onto lists if we race with other code that manipulates the lists
548 * (e.g. writeback_single_inode). The caller is responsible for setting this.
549 *
550 * An inode must already be removed from the LRU list before being evicted from
551 * the cache. This should occur atomically with setting the I_FREEING state
552 * flag, so no inodes here should ever be on the LRU when being evicted.
553 */
Al Viro644da592010-06-07 13:21:05 -0400554static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400555{
556 const struct super_operations *op = inode->i_sb->s_op;
557
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100558 BUG_ON(!(inode->i_state & I_FREEING));
559 BUG_ON(!list_empty(&inode->i_lru));
560
Dave Chinnerc7f54082015-03-04 14:07:22 -0500561 if (!list_empty(&inode->i_io_list))
562 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200563
Dave Chinner55fa6092011-03-22 22:23:40 +1100564 inode_sb_list_del(inode);
565
Jan Kara169ebd92012-05-03 14:48:03 +0200566 /*
567 * Wait for flusher thread to be done with the inode so that filesystem
568 * does not start destroying it while writeback is still running. Since
569 * the inode has I_FREEING set, flusher thread won't start new work on
570 * the inode. We just have to wait for running writeback to finish.
571 */
572 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200573
Al Virobe7ce412010-06-04 19:40:39 -0400574 if (op->evict_inode) {
575 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400576 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700577 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200578 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400579 }
Al Viro661074e2010-06-04 20:19:55 -0400580 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
581 bd_forget(inode);
582 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
583 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100584
585 remove_inode_hash(inode);
586
587 spin_lock(&inode->i_lock);
588 wake_up_bit(&inode->i_state, __I_NEW);
589 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
590 spin_unlock(&inode->i_lock);
591
592 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400593}
594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595/*
596 * dispose_list - dispose of the contents of a local list
597 * @head: the head of the list to free
598 *
599 * Dispose-list gets a local list with local inodes in it, so it doesn't
600 * need to worry about list corruption and SMP locks.
601 */
602static void dispose_list(struct list_head *head)
603{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 while (!list_empty(head)) {
605 struct inode *inode;
606
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100607 inode = list_first_entry(head, struct inode, i_lru);
608 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Al Viro644da592010-06-07 13:21:05 -0400610 evict(inode);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500611 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613}
614
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615/**
Al Viro63997e92010-10-25 20:49:35 -0400616 * evict_inodes - evict all evictable inodes for a superblock
617 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 *
Al Viro63997e92010-10-25 20:49:35 -0400619 * Make sure that no inodes with zero refcount are retained. This is
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800620 * called by superblock shutdown after having SB_ACTIVE flag removed,
Al Viro63997e92010-10-25 20:49:35 -0400621 * so any inode reaching zero refcount during or after that call will
622 * be immediately evicted.
623 */
624void evict_inodes(struct super_block *sb)
625{
626 struct inode *inode, *next;
627 LIST_HEAD(dispose);
628
Josef Bacikac05fbb2015-03-04 16:52:52 -0500629again:
Dave Chinner74278da2015-03-04 12:37:22 -0500630 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400631 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
632 if (atomic_read(&inode->i_count))
633 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100634
635 spin_lock(&inode->i_lock);
636 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
637 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400638 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100639 }
Al Viro63997e92010-10-25 20:49:35 -0400640
641 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100642 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100643 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100644 list_add(&inode->i_lru, &dispose);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500645
646 /*
647 * We can have a ton of inodes to evict at unmount time given
648 * enough memory, check to see if we need to go to sleep for a
649 * bit so we don't livelock.
650 */
651 if (need_resched()) {
652 spin_unlock(&sb->s_inode_list_lock);
653 cond_resched();
654 dispose_list(&dispose);
655 goto again;
656 }
Al Viro63997e92010-10-25 20:49:35 -0400657 }
Dave Chinner74278da2015-03-04 12:37:22 -0500658 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400659
660 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400661}
Darrick J. Wong799ea9e2017-08-18 18:08:25 -0700662EXPORT_SYMBOL_GPL(evict_inodes);
Al Viro63997e92010-10-25 20:49:35 -0400663
664/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200665 * invalidate_inodes - attempt to free all inodes on a superblock
666 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100667 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200668 *
669 * Attempts to free all inodes for a given superblock. If there were any
670 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100671 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
672 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 */
NeilBrown93b270f2011-02-24 17:25:47 +1100674int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400676 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200677 struct inode *inode, *next;
678 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Eric Sandeen04646ae2019-12-06 10:54:23 -0600680again:
Dave Chinner74278da2015-03-04 12:37:22 -0500681 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200682 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100683 spin_lock(&inode->i_lock);
684 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
685 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100687 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500688 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100689 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100690 busy = 1;
691 continue;
692 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200693 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100694 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200695 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 continue;
697 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200698
Christoph Hellwig99a38912010-10-23 19:07:20 +0200699 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100700 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100701 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100702 list_add(&inode->i_lru, &dispose);
Eric Sandeen04646ae2019-12-06 10:54:23 -0600703 if (need_resched()) {
704 spin_unlock(&sb->s_inode_list_lock);
705 cond_resched();
706 dispose_list(&dispose);
707 goto again;
708 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 }
Dave Chinner74278da2015-03-04 12:37:22 -0500710 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Christoph Hellwiga0318782010-10-24 19:40:33 +0200712 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714 return busy;
715}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000718 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 *
720 * Any inodes which are pinned purely because of attached pagecache have their
Nick Piggin9e38d862010-10-23 06:55:17 -0400721 * pagecache removed. If the inode has metadata buffers attached to
722 * mapping->private_list then try to remove them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400724 * If the inode has the I_REFERENCED flag set, then it means that it has been
725 * used recently - the flag is set in iput_final(). When we encounter such an
726 * inode, clear the flag and move it to the back of the LRU so it gets another
727 * pass through the LRU before it gets reclaimed. This is necessary because of
728 * the fact we are doing lazy LRU updates to minimise lock contention so the
729 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
730 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800732static enum lru_status inode_lru_isolate(struct list_head *item,
733 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000734{
735 struct list_head *freeable = arg;
736 struct inode *inode = container_of(item, struct inode, i_lru);
737
738 /*
739 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
740 * If we fail to get the lock, just skip it.
741 */
742 if (!spin_trylock(&inode->i_lock))
743 return LRU_SKIP;
744
745 /*
746 * Referenced or dirty inodes are still in use. Give them another pass
747 * through the LRU as we canot reclaim them now.
748 */
749 if (atomic_read(&inode->i_count) ||
750 (inode->i_state & ~I_REFERENCED)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800751 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000752 spin_unlock(&inode->i_lock);
753 this_cpu_dec(nr_unused);
754 return LRU_REMOVED;
755 }
756
Dave Chinner69056ee2019-02-12 15:35:51 -0800757 /* recently referenced inodes get one more pass */
758 if (inode->i_state & I_REFERENCED) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000759 inode->i_state &= ~I_REFERENCED;
760 spin_unlock(&inode->i_lock);
761 return LRU_ROTATE;
762 }
763
764 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
765 __iget(inode);
766 spin_unlock(&inode->i_lock);
767 spin_unlock(lru_lock);
768 if (remove_inode_buffers(inode)) {
769 unsigned long reap;
770 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
771 if (current_is_kswapd())
772 __count_vm_events(KSWAPD_INODESTEAL, reap);
773 else
774 __count_vm_events(PGINODESTEAL, reap);
775 if (current->reclaim_state)
776 current->reclaim_state->reclaimed_slab += reap;
777 }
778 iput(inode);
779 spin_lock(lru_lock);
780 return LRU_RETRY;
781 }
782
783 WARN_ON(inode->i_state & I_NEW);
784 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800785 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000786 spin_unlock(&inode->i_lock);
787
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000788 this_cpu_dec(nr_unused);
789 return LRU_REMOVED;
790}
791
792/*
793 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
794 * This is called from the superblock shrinker function with a number of inodes
795 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
796 * then are freed outside inode_lock by dispose_list().
797 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800798long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
800 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000801 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Vladimir Davydov503c3582015-02-12 14:58:47 -0800803 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
804 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000806 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807}
808
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809static void __wait_on_freeing_inode(struct inode *inode);
810/*
811 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530813static struct inode *find_inode(struct super_block *sb,
814 struct hlist_head *head,
815 int (*test)(struct inode *, void *),
816 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530818 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
820repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800821 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500822 if (inode->i_sb != sb)
823 continue;
824 if (!test(inode, data))
825 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100826 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400827 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 __wait_on_freeing_inode(inode);
829 goto repeat;
830 }
Al Viroc2b6d622018-06-28 15:53:17 -0400831 if (unlikely(inode->i_state & I_CREATING)) {
832 spin_unlock(&inode->i_lock);
833 return ERR_PTR(-ESTALE);
834 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400835 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100836 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400837 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400839 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840}
841
842/*
843 * find_inode_fast is the fast path version of find_inode, see the comment at
844 * iget_locked for details.
845 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530846static struct inode *find_inode_fast(struct super_block *sb,
847 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530849 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
851repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800852 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500853 if (inode->i_ino != ino)
854 continue;
855 if (inode->i_sb != sb)
856 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100857 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400858 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 __wait_on_freeing_inode(inode);
860 goto repeat;
861 }
Al Viroc2b6d622018-06-28 15:53:17 -0400862 if (unlikely(inode->i_state & I_CREATING)) {
863 spin_unlock(&inode->i_lock);
864 return ERR_PTR(-ESTALE);
865 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400866 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100867 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400868 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400870 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871}
872
Eric Dumazetf991bd22010-10-23 11:18:01 -0400873/*
874 * Each cpu owns a range of LAST_INO_BATCH numbers.
875 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
876 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100877 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400878 * This does not significantly increase overflow rate because every CPU can
879 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
880 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
881 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
882 * overflow rate by 2x, which does not seem too significant.
883 *
884 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
885 * error if st_ino won't fit in target struct field. Use 32bit counter
886 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100887 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400888#define LAST_INO_BATCH 1024
889static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100890
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400891unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400892{
893 unsigned int *p = &get_cpu_var(last_ino);
894 unsigned int res = *p;
895
896#ifdef CONFIG_SMP
897 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
898 static atomic_t shared_last_ino;
899 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
900
901 res = next - LAST_INO_BATCH;
902 }
903#endif
904
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300905 res++;
906 /* get_next_ino should not provide a 0 inode number */
907 if (unlikely(!res))
908 res++;
909 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400910 put_cpu_var(last_ino);
911 return res;
David Chinner8290c352008-10-30 17:35:24 +1100912}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400913EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100914
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200916 * new_inode_pseudo - obtain an inode
917 * @sb: superblock
918 *
919 * Allocates a new inode for given superblock.
920 * Inode wont be chained in superblock s_inodes list
921 * This means :
922 * - fs can't be unmount
923 * - quotas, fsnotify, writeback can't work
924 */
925struct inode *new_inode_pseudo(struct super_block *sb)
926{
927 struct inode *inode = alloc_inode(sb);
928
929 if (inode) {
930 spin_lock(&inode->i_lock);
931 inode->i_state = 0;
932 spin_unlock(&inode->i_lock);
933 INIT_LIST_HEAD(&inode->i_sb_list);
934 }
935 return inode;
936}
937
938/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 * new_inode - obtain an inode
940 * @sb: superblock
941 *
Mel Gorman769848c2007-07-17 04:03:05 -0700942 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800943 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700944 * If HIGHMEM pages are unsuitable or it is known that pages allocated
945 * for the page cache are not reclaimable or migratable,
946 * mapping_set_gfp_mask() must be called with suitable flags on the
947 * newly created inode's mapping
948 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 */
950struct inode *new_inode(struct super_block *sb)
951{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530952 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953
Dave Chinner74278da2015-03-04 12:37:22 -0500954 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530955
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200956 inode = new_inode_pseudo(sb);
957 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100958 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 return inode;
960}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961EXPORT_SYMBOL(new_inode);
962
Peter Zijlstra14358e62007-10-14 01:38:33 +0200963#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400964void lockdep_annotate_inode_mutex_key(struct inode *inode)
965{
Namhyung Kima3314a02010-10-11 22:38:00 +0900966 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200967 struct file_system_type *type = inode->i_sb->s_type;
968
Jan Kara9a7aa122009-06-04 15:26:49 +0200969 /* Set new key only if filesystem hasn't already changed it */
Al Viro9902af72016-04-15 15:08:36 -0400970 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200971 /*
972 * ensure nobody is actually holding i_mutex
973 */
Al Viro9902af72016-04-15 15:08:36 -0400974 // mutex_destroy(&inode->i_mutex);
975 init_rwsem(&inode->i_rwsem);
976 lockdep_set_class(&inode->i_rwsem,
Jan Kara9a7aa122009-06-04 15:26:49 +0200977 &type->i_mutex_dir_key);
978 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200979 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400980}
981EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200982#endif
Josh Boyere096d0c2011-08-25 07:48:12 -0400983
984/**
985 * unlock_new_inode - clear the I_NEW state and wake up any waiters
986 * @inode: new inode to unlock
987 *
988 * Called when the inode is fully initialised to clear the new state of the
989 * inode and wake up anyone waiting for the inode to finish initialisation.
990 */
991void unlock_new_inode(struct inode *inode)
992{
993 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100994 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100995 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -0400996 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro310fa7a2012-03-10 17:07:28 -0500997 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +1100998 wake_up_bit(&inode->i_state, __I_NEW);
999 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001EXPORT_SYMBOL(unlock_new_inode);
1002
Al Viroc2b6d622018-06-28 15:53:17 -04001003void discard_new_inode(struct inode *inode)
1004{
1005 lockdep_annotate_inode_mutex_key(inode);
1006 spin_lock(&inode->i_lock);
1007 WARN_ON(!(inode->i_state & I_NEW));
1008 inode->i_state &= ~I_NEW;
1009 smp_mb();
1010 wake_up_bit(&inode->i_state, __I_NEW);
1011 spin_unlock(&inode->i_lock);
1012 iput(inode);
1013}
1014EXPORT_SYMBOL(discard_new_inode);
1015
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001016/**
J. Bruce Fields375e2892012-04-18 15:16:33 -04001017 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001018 *
1019 * Lock any non-NULL argument that is not a directory.
1020 * Zero, one or two objects may be locked by this function.
1021 *
J. Bruce Fields375e2892012-04-18 15:16:33 -04001022 * @inode1: first inode to lock
1023 * @inode2: second inode to lock
1024 */
1025void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1026{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001027 if (inode1 > inode2)
1028 swap(inode1, inode2);
1029
1030 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001031 inode_lock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001032 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001033 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001034}
1035EXPORT_SYMBOL(lock_two_nondirectories);
1036
1037/**
1038 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
1039 * @inode1: first inode to unlock
1040 * @inode2: second inode to unlock
1041 */
1042void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1043{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001044 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001045 inode_unlock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001046 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001047 inode_unlock(inode2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001048}
1049EXPORT_SYMBOL(unlock_two_nondirectories);
1050
1051/**
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001052 * inode_insert5 - obtain an inode from a mounted file system
1053 * @inode: pre-allocated inode to use for insert to cache
1054 * @hashval: hash value (usually inode number) to get
1055 * @test: callback used for comparisons between inodes
1056 * @set: callback used to initialize a new struct inode
1057 * @data: opaque data pointer to pass to @test and @set
1058 *
1059 * Search for the inode specified by @hashval and @data in the inode cache,
1060 * and if present it is return it with an increased reference count. This is
1061 * a variant of iget5_locked() for callers that don't want to fail on memory
1062 * allocation of inode.
1063 *
1064 * If the inode is not in cache, insert the pre-allocated inode to cache and
1065 * return it locked, hashed, and with the I_NEW flag set. The file system gets
1066 * to fill it in before unlocking it via unlock_new_inode().
1067 *
1068 * Note both @test and @set are called with the inode_hash_lock held, so can't
1069 * sleep.
1070 */
1071struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
1072 int (*test)(struct inode *, void *),
1073 int (*set)(struct inode *, void *), void *data)
1074{
1075 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1076 struct inode *old;
Miklos Szeredie9505642018-07-24 15:01:55 +02001077 bool creating = inode->i_state & I_CREATING;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001078
1079again:
1080 spin_lock(&inode_hash_lock);
1081 old = find_inode(inode->i_sb, head, test, data);
1082 if (unlikely(old)) {
1083 /*
1084 * Uhhuh, somebody else created the same inode under us.
1085 * Use the old inode instead of the preallocated one.
1086 */
1087 spin_unlock(&inode_hash_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001088 if (IS_ERR(old))
1089 return NULL;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001090 wait_on_inode(old);
1091 if (unlikely(inode_unhashed(old))) {
1092 iput(old);
1093 goto again;
1094 }
1095 return old;
1096 }
1097
1098 if (set && unlikely(set(inode, data))) {
1099 inode = NULL;
1100 goto unlock;
1101 }
1102
1103 /*
1104 * Return the locked inode with I_NEW set, the
1105 * caller is responsible for filling in the contents
1106 */
1107 spin_lock(&inode->i_lock);
1108 inode->i_state |= I_NEW;
1109 hlist_add_head(&inode->i_hash, head);
1110 spin_unlock(&inode->i_lock);
Miklos Szeredie9505642018-07-24 15:01:55 +02001111 if (!creating)
1112 inode_sb_list_add(inode);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001113unlock:
1114 spin_unlock(&inode_hash_lock);
1115
1116 return inode;
1117}
1118EXPORT_SYMBOL(inode_insert5);
1119
1120/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001121 * iget5_locked - obtain an inode from a mounted file system
1122 * @sb: super block of file system
1123 * @hashval: hash value (usually inode number) to get
1124 * @test: callback used for comparisons between inodes
1125 * @set: callback used to initialize a new struct inode
1126 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001128 * Search for the inode specified by @hashval and @data in the inode cache,
1129 * and if present it is return it with an increased reference count. This is
1130 * a generalized version of iget_locked() for file systems where the inode
1131 * number is not sufficient for unique identification of an inode.
1132 *
1133 * If the inode is not in cache, allocate a new inode and return it locked,
1134 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1135 * before unlocking it via unlock_new_inode().
1136 *
1137 * Note both @test and @set are called with the inode_hash_lock held, so can't
1138 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001140struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1141 int (*test)(struct inode *, void *),
1142 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143{
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001144 struct inode *inode = ilookup5(sb, hashval, test, data);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001145
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001146 if (!inode) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001147 struct inode *new = alloc_inode(sb);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001148
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001149 if (new) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001150 new->i_state = 0;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001151 inode = inode_insert5(new, hashval, test, set, data);
1152 if (unlikely(inode != new))
Miklos Szeredie9505642018-07-24 15:01:55 +02001153 destroy_inode(new);
Al Viro2864f302016-07-03 23:15:21 -04001154 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 }
1156 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001158EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001160/**
1161 * iget_locked - obtain an inode from a mounted file system
1162 * @sb: super block of file system
1163 * @ino: inode number to get
1164 *
1165 * Search for the inode specified by @ino in the inode cache and if present
1166 * return it with an increased reference count. This is for file systems
1167 * where the inode number is sufficient for unique identification of an inode.
1168 *
1169 * If the inode is not in cache, allocate a new inode and return it locked,
1170 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1171 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001173struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001175 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301176 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001177again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001178 spin_lock(&inode_hash_lock);
1179 inode = find_inode_fast(sb, head, ino);
1180 spin_unlock(&inode_hash_lock);
1181 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001182 if (IS_ERR(inode))
1183 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001184 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001185 if (unlikely(inode_unhashed(inode))) {
1186 iput(inode);
1187 goto again;
1188 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001189 return inode;
1190 }
1191
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 inode = alloc_inode(sb);
1193 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301194 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
Dave Chinner67a23c42011-03-22 22:23:42 +11001196 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 /* We released the lock, so.. */
1198 old = find_inode_fast(sb, head, ino);
1199 if (!old) {
1200 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001201 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001202 inode->i_state = I_NEW;
Dave Chinner250df6e2011-03-22 22:23:36 +11001203 hlist_add_head(&inode->i_hash, head);
1204 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001205 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001206 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207
1208 /* Return the locked inode with I_NEW set, the
1209 * caller is responsible for filling in the contents
1210 */
1211 return inode;
1212 }
1213
1214 /*
1215 * Uhhuh, somebody else created the same inode under
1216 * us. Use the old inode instead of the one we just
1217 * allocated.
1218 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001219 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 destroy_inode(inode);
Al Viroc2b6d622018-06-28 15:53:17 -04001221 if (IS_ERR(old))
1222 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 inode = old;
1224 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001225 if (unlikely(inode_unhashed(inode))) {
1226 iput(inode);
1227 goto again;
1228 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 }
1230 return inode;
1231}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001232EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001234/*
1235 * search the inode cache for a matching inode number.
1236 * If we find one, then the inode number we are trying to
1237 * allocate is not unique and so we should not use it.
1238 *
1239 * Returns 1 if the inode number is unique, 0 if it is not.
1240 */
1241static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1242{
1243 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001244 struct inode *inode;
1245
Dave Chinner67a23c42011-03-22 22:23:42 +11001246 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001247 hlist_for_each_entry(inode, b, i_hash) {
Dave Chinner67a23c42011-03-22 22:23:42 +11001248 if (inode->i_ino == ino && inode->i_sb == sb) {
1249 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001250 return 0;
Dave Chinner67a23c42011-03-22 22:23:42 +11001251 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001252 }
Dave Chinner67a23c42011-03-22 22:23:42 +11001253 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001254
1255 return 1;
1256}
1257
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258/**
1259 * iunique - get a unique inode number
1260 * @sb: superblock
1261 * @max_reserved: highest reserved inode number
1262 *
1263 * Obtain an inode number that is unique on the system for a given
1264 * superblock. This is used by file systems that have no natural
1265 * permanent inode numbering system. An inode number is returned that
1266 * is higher than the reserved limit but unique.
1267 *
1268 * BUGS:
1269 * With a large number of inodes live on the file system this function
1270 * currently becomes quite slow.
1271 */
1272ino_t iunique(struct super_block *sb, ino_t max_reserved)
1273{
Jeff Layton866b04f2007-05-08 00:32:29 -07001274 /*
1275 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1276 * error if st_ino won't fit in target struct field. Use 32bit counter
1277 * here to attempt to avoid that.
1278 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001279 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001280 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001283 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001284 do {
1285 if (counter <= max_reserved)
1286 counter = max_reserved + 1;
1287 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001288 } while (!test_inode_iunique(sb, res));
1289 spin_unlock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001290
1291 return res;
1292}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293EXPORT_SYMBOL(iunique);
1294
1295struct inode *igrab(struct inode *inode)
1296{
Dave Chinner250df6e2011-03-22 22:23:36 +11001297 spin_lock(&inode->i_lock);
1298 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001300 spin_unlock(&inode->i_lock);
1301 } else {
1302 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 /*
1304 * Handle the case where s_op->clear_inode is not been
1305 * called yet, and somebody is calling igrab
1306 * while the inode is getting freed.
1307 */
1308 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001309 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 return inode;
1311}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312EXPORT_SYMBOL(igrab);
1313
1314/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001315 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 * @sb: super block of file system to search
1317 * @hashval: hash value (usually inode number) to search for
1318 * @test: callback used for comparisons between inodes
1319 * @data: opaque data pointer to pass to @test
1320 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001321 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001323 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001324 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001325 * Note: I_NEW is not waited upon so you have to be very careful what you do
1326 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001327 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001328 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001329 */
1330struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1331 int (*test)(struct inode *, void *), void *data)
1332{
1333 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001334 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001335
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001336 spin_lock(&inode_hash_lock);
1337 inode = find_inode(sb, head, test, data);
1338 spin_unlock(&inode_hash_lock);
1339
Al Viroc2b6d622018-06-28 15:53:17 -04001340 return IS_ERR(inode) ? NULL : inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001341}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001342EXPORT_SYMBOL(ilookup5_nowait);
1343
1344/**
1345 * ilookup5 - search for an inode in the inode cache
1346 * @sb: super block of file system to search
1347 * @hashval: hash value (usually inode number) to search for
1348 * @test: callback used for comparisons between inodes
1349 * @data: opaque data pointer to pass to @test
1350 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001351 * Search for the inode specified by @hashval and @data in the inode cache,
1352 * and if the inode is in the cache, return the inode with an incremented
1353 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001354 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001356 * This is a generalized version of ilookup() for file systems where the
1357 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001359 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 */
1361struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1362 int (*test)(struct inode *, void *), void *data)
1363{
Al Viro2864f302016-07-03 23:15:21 -04001364 struct inode *inode;
1365again:
1366 inode = ilookup5_nowait(sb, hashval, test, data);
1367 if (inode) {
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001368 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001369 if (unlikely(inode_unhashed(inode))) {
1370 iput(inode);
1371 goto again;
1372 }
1373 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001374 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376EXPORT_SYMBOL(ilookup5);
1377
1378/**
1379 * ilookup - search for an inode in the inode cache
1380 * @sb: super block of file system to search
1381 * @ino: inode number to search for
1382 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001383 * Search for the inode @ino in the inode cache, and if the inode is in the
1384 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 */
1386struct inode *ilookup(struct super_block *sb, unsigned long ino)
1387{
1388 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001389 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001390again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001391 spin_lock(&inode_hash_lock);
1392 inode = find_inode_fast(sb, head, ino);
1393 spin_unlock(&inode_hash_lock);
1394
Al Viro2864f302016-07-03 23:15:21 -04001395 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001396 if (IS_ERR(inode))
1397 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001398 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001399 if (unlikely(inode_unhashed(inode))) {
1400 iput(inode);
1401 goto again;
1402 }
1403 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001404 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406EXPORT_SYMBOL(ilookup);
1407
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001408/**
1409 * find_inode_nowait - find an inode in the inode cache
1410 * @sb: super block of file system to search
1411 * @hashval: hash value (usually inode number) to search for
1412 * @match: callback used for comparisons between inodes
1413 * @data: opaque data pointer to pass to @match
1414 *
1415 * Search for the inode specified by @hashval and @data in the inode
1416 * cache, where the helper function @match will return 0 if the inode
1417 * does not match, 1 if the inode does match, and -1 if the search
1418 * should be stopped. The @match function must be responsible for
1419 * taking the i_lock spin_lock and checking i_state for an inode being
1420 * freed or being initialized, and incrementing the reference count
1421 * before returning 1. It also must not sleep, since it is called with
1422 * the inode_hash_lock spinlock held.
1423 *
1424 * This is a even more generalized version of ilookup5() when the
1425 * function must never block --- find_inode() can block in
1426 * __wait_on_freeing_inode() --- or when the caller can not increment
1427 * the reference count because the resulting iput() might cause an
1428 * inode eviction. The tradeoff is that the @match funtion must be
1429 * very carefully implemented.
1430 */
1431struct inode *find_inode_nowait(struct super_block *sb,
1432 unsigned long hashval,
1433 int (*match)(struct inode *, unsigned long,
1434 void *),
1435 void *data)
1436{
1437 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1438 struct inode *inode, *ret_inode = NULL;
1439 int mval;
1440
1441 spin_lock(&inode_hash_lock);
1442 hlist_for_each_entry(inode, head, i_hash) {
1443 if (inode->i_sb != sb)
1444 continue;
1445 mval = match(inode, hashval, data);
1446 if (mval == 0)
1447 continue;
1448 if (mval == 1)
1449 ret_inode = inode;
1450 goto out;
1451 }
1452out:
1453 spin_unlock(&inode_hash_lock);
1454 return ret_inode;
1455}
1456EXPORT_SYMBOL(find_inode_nowait);
1457
Al Viro261bca82008-12-30 01:48:21 -05001458int insert_inode_locked(struct inode *inode)
1459{
1460 struct super_block *sb = inode->i_sb;
1461 ino_t ino = inode->i_ino;
1462 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001463
Al Viro261bca82008-12-30 01:48:21 -05001464 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001465 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001466 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001467 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001468 if (old->i_ino != ino)
1469 continue;
1470 if (old->i_sb != sb)
1471 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001472 spin_lock(&old->i_lock);
1473 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1474 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001475 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001476 }
Al Viro72a43d62009-05-13 19:13:40 +01001477 break;
1478 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001479 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001480 spin_lock(&inode->i_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001481 inode->i_state |= I_NEW | I_CREATING;
Al Viro261bca82008-12-30 01:48:21 -05001482 hlist_add_head(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001483 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001484 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001485 return 0;
1486 }
Al Viroc2b6d622018-06-28 15:53:17 -04001487 if (unlikely(old->i_state & I_CREATING)) {
1488 spin_unlock(&old->i_lock);
1489 spin_unlock(&inode_hash_lock);
1490 return -EBUSY;
1491 }
Al Viro261bca82008-12-30 01:48:21 -05001492 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001493 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001494 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001495 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001496 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001497 iput(old);
1498 return -EBUSY;
1499 }
1500 iput(old);
1501 }
1502}
Al Viro261bca82008-12-30 01:48:21 -05001503EXPORT_SYMBOL(insert_inode_locked);
1504
1505int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1506 int (*test)(struct inode *, void *), void *data)
1507{
Al Viroc2b6d622018-06-28 15:53:17 -04001508 struct inode *old;
1509
1510 inode->i_state |= I_CREATING;
1511 old = inode_insert5(inode, hashval, test, NULL, data);
Al Viro261bca82008-12-30 01:48:21 -05001512
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001513 if (old != inode) {
Al Viro261bca82008-12-30 01:48:21 -05001514 iput(old);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001515 return -EBUSY;
Al Viro261bca82008-12-30 01:48:21 -05001516 }
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001517 return 0;
Al Viro261bca82008-12-30 01:48:21 -05001518}
Al Viro261bca82008-12-30 01:48:21 -05001519EXPORT_SYMBOL(insert_inode_locked4);
1520
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
Al Viro45321ac2010-06-07 13:43:19 -04001522int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523{
Al Viro45321ac2010-06-07 13:43:19 -04001524 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526EXPORT_SYMBOL(generic_delete_inode);
1527
Al Viro45321ac2010-06-07 13:43:19 -04001528/*
Al Viro45321ac2010-06-07 13:43:19 -04001529 * Called when we're dropping the last reference
1530 * to an inode.
1531 *
1532 * Call the FS "drop_inode()" function, defaulting to
1533 * the legacy UNIX filesystem behaviour. If it tells
1534 * us to evict inode, do so. Otherwise, retain inode
1535 * in cache if fs is alive, sync and evict if fs is
1536 * shutting down.
1537 */
1538static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539{
1540 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001541 const struct super_operations *op = inode->i_sb->s_op;
1542 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543
Dave Chinner250df6e2011-03-22 22:23:36 +11001544 WARN_ON(inode->i_state & I_NEW);
1545
Al Viroe7f59092011-07-07 15:45:59 -04001546 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001547 drop = op->drop_inode(inode);
1548 else
1549 drop = generic_drop_inode(inode);
1550
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001551 if (!drop && (sb->s_flags & SB_ACTIVE)) {
Jan Kara4eff96d2012-11-26 16:29:51 -08001552 inode_add_lru(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001553 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001554 return;
1555 }
1556
Al Viro45321ac2010-06-07 13:43:19 -04001557 if (!drop) {
Alexander Viro991114c2005-06-23 00:09:01 -07001558 inode->i_state |= I_WILL_FREE;
Dave Chinner250df6e2011-03-22 22:23:36 +11001559 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 write_inode_now(inode, 1);
Dave Chinner250df6e2011-03-22 22:23:36 +11001561 spin_lock(&inode->i_lock);
Nick Piggin7ef0d732009-03-12 14:31:38 -07001562 WARN_ON(inode->i_state & I_NEW);
Alexander Viro991114c2005-06-23 00:09:01 -07001563 inode->i_state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001565
Alexander Viro991114c2005-06-23 00:09:01 -07001566 inode->i_state |= I_FREEING;
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001567 if (!list_empty(&inode->i_lru))
1568 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001569 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001570
1571 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572}
1573
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301575 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 * @inode: inode to put
1577 *
1578 * Puts an inode, dropping its usage count. If the inode use count hits
1579 * zero, the inode is then freed and may also be destroyed.
1580 *
1581 * Consequently, iput() can sleep.
1582 */
1583void iput(struct inode *inode)
1584{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001585 if (!inode)
1586 return;
1587 BUG_ON(inode->i_state & I_CLEAR);
1588retry:
1589 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1590 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1591 atomic_inc(&inode->i_count);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001592 spin_unlock(&inode->i_lock);
1593 trace_writeback_lazytime_iput(inode);
1594 mark_inode_dirty_sync(inode);
1595 goto retry;
1596 }
1597 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 }
1599}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600EXPORT_SYMBOL(iput);
1601
Carlos Maiolino30460e12020-01-09 14:30:41 +01001602#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603/**
1604 * bmap - find a block number in a file
Carlos Maiolino30460e12020-01-09 14:30:41 +01001605 * @inode: inode owning the block number being requested
1606 * @block: pointer containing the block to find
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 *
Carlos Maiolino30460e12020-01-09 14:30:41 +01001608 * Replaces the value in *block with the block number on the device holding
1609 * corresponding to the requested block number in the file.
1610 * That is, asked for block 4 of inode 1 the function will replace the
1611 * 4 in *block, with disk block relative to the disk start that holds that
1612 * block of the file.
1613 *
1614 * Returns -EINVAL in case of error, 0 otherwise. If mapping falls into a
1615 * hole, returns 0 and *block is also set to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 */
Carlos Maiolino30460e12020-01-09 14:30:41 +01001617int bmap(struct inode *inode, sector_t *block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618{
Carlos Maiolino30460e12020-01-09 14:30:41 +01001619 if (!inode->i_mapping->a_ops->bmap)
1620 return -EINVAL;
1621
1622 *block = inode->i_mapping->a_ops->bmap(inode->i_mapping, *block);
1623 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625EXPORT_SYMBOL(bmap);
Carlos Maiolino30460e12020-01-09 14:30:41 +01001626#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001628/*
1629 * With relative atime, only update atime if the previous atime is
1630 * earlier than either the ctime or mtime or if at least a day has
1631 * passed since the last atime update.
1632 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001633static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001634 struct timespec64 now)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001635{
1636
Miklos Szeredic6718542018-07-18 15:44:43 +02001637 if (!(mnt->mnt_flags & MNT_RELATIME))
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001638 return 1;
1639 /*
1640 * Is mtime younger than atime? If yes, update atime:
1641 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001642 if (timespec64_compare(&inode->i_mtime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001643 return 1;
1644 /*
1645 * Is ctime younger than atime? If yes, update atime:
1646 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001647 if (timespec64_compare(&inode->i_ctime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001648 return 1;
1649
1650 /*
1651 * Is the previous atime value older than a day? If yes,
1652 * update atime:
1653 */
1654 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1655 return 1;
1656 /*
1657 * Good, we can skip the atime update:
1658 */
1659 return 0;
1660}
1661
Deepa Dinamani95582b02018-05-08 19:36:02 -07001662int generic_update_time(struct inode *inode, struct timespec64 *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001663{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001664 int iflags = I_DIRTY_TIME;
Jeff Laytone38cf302017-12-11 06:35:22 -05001665 bool dirty = false;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001666
1667 if (flags & S_ATIME)
1668 inode->i_atime = *time;
1669 if (flags & S_VERSION)
Jeff Laytone38cf302017-12-11 06:35:22 -05001670 dirty = inode_maybe_inc_iversion(inode, false);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001671 if (flags & S_CTIME)
1672 inode->i_ctime = *time;
1673 if (flags & S_MTIME)
1674 inode->i_mtime = *time;
Jeff Laytone38cf302017-12-11 06:35:22 -05001675 if ((flags & (S_ATIME | S_CTIME | S_MTIME)) &&
1676 !(inode->i_sb->s_flags & SB_LAZYTIME))
1677 dirty = true;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001678
Jeff Laytone38cf302017-12-11 06:35:22 -05001679 if (dirty)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001680 iflags |= I_DIRTY_SYNC;
1681 __mark_inode_dirty(inode, iflags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001682 return 0;
1683}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001684EXPORT_SYMBOL(generic_update_time);
1685
1686/*
1687 * This does the actual work of updating an inodes time or version. Must have
1688 * had called mnt_want_write() before calling this.
1689 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001690static int update_time(struct inode *inode, struct timespec64 *time, int flags)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001691{
Deepa Dinamani23b424d2019-12-02 21:19:45 -08001692 if (inode->i_op->update_time)
1693 return inode->i_op->update_time(inode, time, flags);
1694 return generic_update_time(inode, time, flags);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001695}
Josef Bacikc3b2da32012-03-26 09:59:21 -04001696
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697/**
Christoph Hellwig869243a2006-01-09 20:52:03 -08001698 * touch_atime - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001699 * @path: the &struct path to update
Randy Dunlap30fdc8e2015-11-09 14:57:58 -08001700 * @inode: inode to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 *
1702 * Update the accessed time on an inode and mark it for writeback.
1703 * This function automatically handles read only file systems and media,
1704 * as well as the "noatime" flag and inode specific "noatime" markers.
1705 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001706bool atime_needs_update(const struct path *path, struct inode *inode)
NeilBrown8fa9dd22015-03-23 13:37:40 +11001707{
1708 struct vfsmount *mnt = path->mnt;
Deepa Dinamani95582b02018-05-08 19:36:02 -07001709 struct timespec64 now;
NeilBrown8fa9dd22015-03-23 13:37:40 +11001710
1711 if (inode->i_flags & S_NOATIME)
1712 return false;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001713
1714 /* Atime updates will likely cause i_uid and i_gid to be written
1715 * back improprely if their true value is unknown to the vfs.
1716 */
1717 if (HAS_UNMAPPED_ID(inode))
1718 return false;
1719
NeilBrown8fa9dd22015-03-23 13:37:40 +11001720 if (IS_NOATIME(inode))
1721 return false;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001722 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001723 return false;
1724
1725 if (mnt->mnt_flags & MNT_NOATIME)
1726 return false;
1727 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1728 return false;
1729
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001730 now = current_time(inode);
NeilBrown8fa9dd22015-03-23 13:37:40 +11001731
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001732 if (!relatime_need_update(mnt, inode, now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001733 return false;
1734
Deepa Dinamani95582b02018-05-08 19:36:02 -07001735 if (timespec64_equal(&inode->i_atime, &now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001736 return false;
1737
1738 return true;
1739}
1740
Al Virobadcf2b2013-07-16 18:15:46 +04001741void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742{
Al Viro68ac1232012-03-15 08:21:57 -04001743 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001744 struct inode *inode = d_inode(path->dentry);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001745 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746
Miklos Szeredic6718542018-07-18 15:44:43 +02001747 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001748 return;
1749
Jan Kara5d37e9e2012-06-12 16:20:36 +02001750 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001751 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001752
NeilBrown8fa9dd22015-03-23 13:37:40 +11001753 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001754 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001755 /*
1756 * File systems can error out when updating inodes if they need to
1757 * allocate new space to modify an inode (such is the case for
1758 * Btrfs), but since we touch atime while walking down the path we
1759 * really don't care if we failed to update the atime of the file,
1760 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001761 * We may also fail on filesystems that have the ability to make parts
1762 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001763 */
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001764 now = current_time(inode);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001765 update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001766 __mnt_drop_write(mnt);
1767skip_update:
1768 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001770EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
Cong Wang3ed37642012-05-15 14:57:33 +08001772/*
1773 * The logic we want is
1774 *
1775 * if suid or (sgid and xgrp)
1776 * remove privs
1777 */
1778int should_remove_suid(struct dentry *dentry)
1779{
David Howellsdf2b1af2015-03-17 22:26:15 +00001780 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001781 int kill = 0;
1782
1783 /* suid always must be killed */
1784 if (unlikely(mode & S_ISUID))
1785 kill = ATTR_KILL_SUID;
1786
1787 /*
1788 * sgid without any exec bits is just a mandatory locking mark; leave
1789 * it alone. If some exec bits are set, it's a real sgid; kill it.
1790 */
1791 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1792 kill |= ATTR_KILL_SGID;
1793
1794 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1795 return kill;
1796
1797 return 0;
1798}
1799EXPORT_SYMBOL(should_remove_suid);
1800
Jan Karadbfae0c2015-05-21 16:05:54 +02001801/*
1802 * Return mask of changes for notify_change() that need to be done as a
1803 * response to write or truncate. Return 0 if nothing has to be changed.
1804 * Negative value on error (change should be denied).
1805 */
Jan Kara45f147a2015-05-21 16:05:55 +02001806int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001807{
Jan Karadbfae0c2015-05-21 16:05:54 +02001808 struct inode *inode = d_inode(dentry);
1809 int mask = 0;
1810 int ret;
1811
1812 if (IS_NOSEC(inode))
1813 return 0;
1814
1815 mask = should_remove_suid(dentry);
1816 ret = security_inode_need_killpriv(dentry);
1817 if (ret < 0)
1818 return ret;
1819 if (ret)
1820 mask |= ATTR_KILL_PRIV;
1821 return mask;
1822}
Jan Karadbfae0c2015-05-21 16:05:54 +02001823
1824static int __remove_privs(struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001825{
1826 struct iattr newattrs;
1827
1828 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001829 /*
1830 * Note we call this on write, so notify_change will not
1831 * encounter any conflicting delegations:
1832 */
1833 return notify_change(dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001834}
1835
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001836/*
1837 * Remove special file priviledges (suid, capabilities) when file is written
1838 * to or truncated.
1839 */
1840int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001841{
Miklos Szeredic1892c32016-08-03 13:44:27 +02001842 struct dentry *dentry = file_dentry(file);
1843 struct inode *inode = file_inode(file);
Jan Karadbfae0c2015-05-21 16:05:54 +02001844 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001845 int error = 0;
1846
Alexander Lochmannf69e7492018-12-14 11:55:52 +01001847 /*
1848 * Fast path for nothing security related.
1849 * As well for non-regular files, e.g. blkdev inodes.
1850 * For example, blkdev_write_iter() might get here
1851 * trying to remove privs which it is not allowed to.
1852 */
1853 if (IS_NOSEC(inode) || !S_ISREG(inode->i_mode))
Cong Wang3ed37642012-05-15 14:57:33 +08001854 return 0;
1855
Miklos Szeredic1892c32016-08-03 13:44:27 +02001856 kill = dentry_needs_remove_privs(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001857 if (kill < 0)
1858 return kill;
1859 if (kill)
1860 error = __remove_privs(dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001861 if (!error)
1862 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001863
1864 return error;
1865}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001866EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001867
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001869 * file_update_time - update mtime and ctime time
1870 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001872 * Update the mtime and ctime members of an inode and mark the inode
1873 * for writeback. Note that this function is meant exclusively for
1874 * usage in the file write path of filesystems, and filesystems may
1875 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001876 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001877 * timestamps are handled by the server. This can return an error for
1878 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 */
1880
Josef Bacikc3b2da32012-03-26 09:59:21 -04001881int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882{
Al Viro496ad9a2013-01-23 17:07:38 -05001883 struct inode *inode = file_inode(file);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001884 struct timespec64 now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001885 int sync_it = 0;
1886 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887
Andi Kleence06e0b2009-09-18 13:05:48 -07001888 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001890 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001891
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001892 now = current_time(inode);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001893 if (!timespec64_equal(&inode->i_mtime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001894 sync_it = S_MTIME;
1895
Deepa Dinamani95582b02018-05-08 19:36:02 -07001896 if (!timespec64_equal(&inode->i_ctime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001897 sync_it |= S_CTIME;
1898
Jeff Laytone38cf302017-12-11 06:35:22 -05001899 if (IS_I_VERSION(inode) && inode_iversion_need_inc(inode))
Andi Kleence06e0b2009-09-18 13:05:48 -07001900 sync_it |= S_VERSION;
1901
1902 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001903 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904
Andi Kleence06e0b2009-09-18 13:05:48 -07001905 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02001906 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001907 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908
Josef Bacikc3b2da32012-03-26 09:59:21 -04001909 ret = update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02001910 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001911
1912 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913}
Christoph Hellwig870f4812006-01-09 20:52:01 -08001914EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915
Amir Goldsteine38f7f52019-06-05 08:04:49 -07001916/* Caller must hold the file's inode lock */
1917int file_modified(struct file *file)
1918{
1919 int err;
1920
1921 /*
1922 * Clear the security bits if the process is not being run by root.
1923 * This keeps people from modifying setuid and setgid binaries.
1924 */
1925 err = file_remove_privs(file);
1926 if (err)
1927 return err;
1928
1929 if (unlikely(file->f_mode & FMODE_NOCMTIME))
1930 return 0;
1931
1932 return file_update_time(file);
1933}
1934EXPORT_SYMBOL(file_modified);
1935
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936int inode_needs_sync(struct inode *inode)
1937{
1938 if (IS_SYNC(inode))
1939 return 1;
1940 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1941 return 1;
1942 return 0;
1943}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944EXPORT_SYMBOL(inode_needs_sync);
1945
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07001947 * If we try to find an inode in the inode hash while it is being
1948 * deleted, we have to wait until the filesystem completes its
1949 * deletion before reporting that it isn't found. This function waits
1950 * until the deletion _might_ have completed. Callers are responsible
1951 * to recheck inode state.
1952 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001953 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11001954 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
1955 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 */
1957static void __wait_on_freeing_inode(struct inode *inode)
1958{
1959 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001960 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1961 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Ingo Molnar21417132017-03-05 11:25:39 +01001962 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001963 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001964 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 schedule();
Ingo Molnar21417132017-03-05 11:25:39 +01001966 finish_wait(wq, &wait.wq_entry);
Dave Chinner67a23c42011-03-22 22:23:42 +11001967 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968}
1969
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970static __initdata unsigned long ihash_entries;
1971static int __init set_ihash_entries(char *str)
1972{
1973 if (!str)
1974 return 0;
1975 ihash_entries = simple_strtoul(str, &str, 0);
1976 return 1;
1977}
1978__setup("ihash_entries=", set_ihash_entries);
1979
1980/*
1981 * Initialize the waitqueues and inode hash table.
1982 */
1983void __init inode_init_early(void)
1984{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 /* If hashes are distributed across NUMA nodes, defer
1986 * hash allocation until vmalloc space is available.
1987 */
1988 if (hashdist)
1989 return;
1990
1991 inode_hashtable =
1992 alloc_large_system_hash("Inode-cache",
1993 sizeof(struct hlist_head),
1994 ihash_entries,
1995 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07001996 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 &i_hash_shift,
1998 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00001999 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001}
2002
Denis Cheng74bf17c2007-10-16 23:26:30 -07002003void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08002006 inode_cachep = kmem_cache_create("inode_cache",
2007 sizeof(struct inode),
2008 0,
2009 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
Vladimir Davydov5d097052016-01-14 15:18:21 -08002010 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
Paul Mundt20c2df82007-07-20 10:11:58 +09002011 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
2013 /* Hash may have been set up in inode_init_early */
2014 if (!hashdist)
2015 return;
2016
2017 inode_hashtable =
2018 alloc_large_system_hash("Inode-cache",
2019 sizeof(struct hlist_head),
2020 ihash_entries,
2021 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002022 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 &i_hash_shift,
2024 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002025 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027}
2028
2029void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
2030{
2031 inode->i_mode = mode;
2032 if (S_ISCHR(mode)) {
2033 inode->i_fop = &def_chr_fops;
2034 inode->i_rdev = rdev;
2035 } else if (S_ISBLK(mode)) {
2036 inode->i_fop = &def_blk_fops;
2037 inode->i_rdev = rdev;
2038 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04002039 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05002041 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07002043 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
2044 " inode %s:%lu\n", mode, inode->i_sb->s_id,
2045 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046}
2047EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002048
2049/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00002050 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002051 * @inode: New inode
2052 * @dir: Directory inode
2053 * @mode: mode of the new inode
2054 */
2055void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04002056 umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002057{
2058 inode->i_uid = current_fsuid();
2059 if (dir && dir->i_mode & S_ISGID) {
2060 inode->i_gid = dir->i_gid;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002061
2062 /* Directories are special, and always inherit S_ISGID */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002063 if (S_ISDIR(mode))
2064 mode |= S_ISGID;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002065 else if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP) &&
2066 !in_group_p(inode->i_gid) &&
2067 !capable_wrt_inode_uidgid(dir, CAP_FSETID))
2068 mode &= ~S_ISGID;
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002069 } else
2070 inode->i_gid = current_fsgid();
2071 inode->i_mode = mode;
2072}
2073EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07002074
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002075/**
2076 * inode_owner_or_capable - check current task permissions to inode
2077 * @inode: inode being checked
2078 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002079 * Return true if current either has CAP_FOWNER in a namespace with the
2080 * inode owner uid mapped, or owns the file.
Serge E. Hallyne795b712011-03-23 16:43:25 -07002081 */
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002082bool inode_owner_or_capable(const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07002083{
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002084 struct user_namespace *ns;
2085
Eric W. Biederman92361632012-02-08 07:07:50 -08002086 if (uid_eq(current_fsuid(), inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002087 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002088
2089 ns = current_user_ns();
Kees Cookcc658db2017-06-21 09:53:06 -07002090 if (kuid_has_mapping(ns, inode->i_uid) && ns_capable(ns, CAP_FOWNER))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002091 return true;
2092 return false;
2093}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002094EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002095
2096/*
2097 * Direct i/o helper functions
2098 */
2099static void __inode_dio_wait(struct inode *inode)
2100{
2101 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2102 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2103
2104 do {
Ingo Molnar21417132017-03-05 11:25:39 +01002105 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002106 if (atomic_read(&inode->i_dio_count))
2107 schedule();
2108 } while (atomic_read(&inode->i_dio_count));
Ingo Molnar21417132017-03-05 11:25:39 +01002109 finish_wait(wq, &q.wq_entry);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002110}
2111
2112/**
2113 * inode_dio_wait - wait for outstanding DIO requests to finish
2114 * @inode: inode to wait for
2115 *
2116 * Waits for all pending direct I/O requests to finish so that we can
2117 * proceed with a truncate or equivalent operation.
2118 *
2119 * Must be called under a lock that serializes taking new references
2120 * to i_dio_count, usually by inode->i_mutex.
2121 */
2122void inode_dio_wait(struct inode *inode)
2123{
2124 if (atomic_read(&inode->i_dio_count))
2125 __inode_dio_wait(inode);
2126}
2127EXPORT_SYMBOL(inode_dio_wait);
2128
2129/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002130 * inode_set_flags - atomically set some inode flags
2131 *
2132 * Note: the caller should be holding i_mutex, or else be sure that
2133 * they have exclusive access to the inode structure (i.e., while the
2134 * inode is being instantiated). The reason for the cmpxchg() loop
2135 * --- which wouldn't be necessary if all code paths which modify
2136 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002137 * code path which doesn't today so we use cmpxchg() out of an abundance
2138 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002139 *
2140 * In the long run, i_mutex is overkill, and we should probably look
2141 * at using the i_lock spinlock to protect i_flags, and then make sure
2142 * it is so documented in include/linux/fs.h and that all code follows
2143 * the locking convention!!
2144 */
2145void inode_set_flags(struct inode *inode, unsigned int flags,
2146 unsigned int mask)
2147{
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002148 WARN_ON_ONCE(flags & ~mask);
Vineet Guptaa9057372019-03-05 15:41:52 -08002149 set_mask_bits(&inode->i_flags, mask, flags);
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002150}
2151EXPORT_SYMBOL(inode_set_flags);
Al Viro21fc61c2015-11-17 01:07:57 -05002152
2153void inode_nohighmem(struct inode *inode)
2154{
2155 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2156}
2157EXPORT_SYMBOL(inode_nohighmem);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002158
2159/**
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002160 * timestamp_truncate - Truncate timespec to a granularity
2161 * @t: Timespec
2162 * @inode: inode being updated
2163 *
2164 * Truncate a timespec to the granularity supported by the fs
2165 * containing the inode. Always rounds down. gran must
2166 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2167 */
2168struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode)
2169{
2170 struct super_block *sb = inode->i_sb;
2171 unsigned int gran = sb->s_time_gran;
2172
2173 t.tv_sec = clamp(t.tv_sec, sb->s_time_min, sb->s_time_max);
2174 if (unlikely(t.tv_sec == sb->s_time_max || t.tv_sec == sb->s_time_min))
2175 t.tv_nsec = 0;
2176
2177 /* Avoid division in the common cases 1 ns and 1 s. */
2178 if (gran == 1)
2179 ; /* nothing */
2180 else if (gran == NSEC_PER_SEC)
2181 t.tv_nsec = 0;
2182 else if (gran > 1 && gran < NSEC_PER_SEC)
2183 t.tv_nsec -= t.tv_nsec % gran;
2184 else
2185 WARN(1, "invalid file time granularity: %u", gran);
2186 return t;
2187}
2188EXPORT_SYMBOL(timestamp_truncate);
2189
2190/**
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002191 * current_time - Return FS time
2192 * @inode: inode.
2193 *
2194 * Return the current time truncated to the time granularity supported by
2195 * the fs.
2196 *
2197 * Note that inode and inode->sb cannot be NULL.
2198 * Otherwise, the function warns and returns time without truncation.
2199 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07002200struct timespec64 current_time(struct inode *inode)
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002201{
Arnd Bergmannd651d162018-12-05 11:14:27 +11002202 struct timespec64 now;
2203
2204 ktime_get_coarse_real_ts64(&now);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002205
2206 if (unlikely(!inode->i_sb)) {
2207 WARN(1, "current_time() called with uninitialized super_block in the inode");
2208 return now;
2209 }
2210
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002211 return timestamp_truncate(now, inode);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002212}
2213EXPORT_SYMBOL(current_time);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002214
2215/*
2216 * Generic function to check FS_IOC_SETFLAGS values and reject any invalid
2217 * configurations.
2218 *
2219 * Note: the caller should be holding i_mutex, or else be sure that they have
2220 * exclusive access to the inode structure.
2221 */
2222int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
2223 unsigned int flags)
2224{
2225 /*
2226 * The IMMUTABLE and APPEND_ONLY flags can only be changed by
2227 * the relevant capability.
2228 *
2229 * This test looks nicer. Thanks to Pauline Middelink
2230 */
2231 if ((flags ^ oldflags) & (FS_APPEND_FL | FS_IMMUTABLE_FL) &&
2232 !capable(CAP_LINUX_IMMUTABLE))
2233 return -EPERM;
2234
Daniel Rosenberg6e1918c2020-01-20 14:31:56 -08002235 return fscrypt_prepare_setflags(inode, oldflags, flags);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002236}
2237EXPORT_SYMBOL(vfs_ioc_setflags_prepare);
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002238
2239/*
2240 * Generic function to check FS_IOC_FSSETXATTR values and reject any invalid
2241 * configurations.
2242 *
2243 * Note: the caller should be holding i_mutex, or else be sure that they have
2244 * exclusive access to the inode structure.
2245 */
2246int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
2247 struct fsxattr *fa)
2248{
2249 /*
2250 * Can't modify an immutable/append-only file unless we have
2251 * appropriate permission.
2252 */
2253 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2254 (FS_XFLAG_IMMUTABLE | FS_XFLAG_APPEND) &&
2255 !capable(CAP_LINUX_IMMUTABLE))
2256 return -EPERM;
2257
Darrick J. Wongf9914922019-07-01 08:25:35 -07002258 /*
2259 * Project Quota ID state is only allowed to change from within the init
2260 * namespace. Enforce that restriction only if we are trying to change
2261 * the quota ID state. Everything else is allowed in user namespaces.
2262 */
2263 if (current_user_ns() != &init_user_ns) {
2264 if (old_fa->fsx_projid != fa->fsx_projid)
2265 return -EINVAL;
2266 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2267 FS_XFLAG_PROJINHERIT)
2268 return -EINVAL;
2269 }
2270
Darrick J. Wongca29be72019-07-01 08:25:36 -07002271 /* Check extent size hints. */
2272 if ((fa->fsx_xflags & FS_XFLAG_EXTSIZE) && !S_ISREG(inode->i_mode))
2273 return -EINVAL;
2274
2275 if ((fa->fsx_xflags & FS_XFLAG_EXTSZINHERIT) &&
2276 !S_ISDIR(inode->i_mode))
2277 return -EINVAL;
2278
2279 if ((fa->fsx_xflags & FS_XFLAG_COWEXTSIZE) &&
2280 !S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
2281 return -EINVAL;
2282
Darrick J. Wongdbc77f32019-07-01 08:25:36 -07002283 /*
2284 * It is only valid to set the DAX flag on regular files and
2285 * directories on filesystems.
2286 */
2287 if ((fa->fsx_xflags & FS_XFLAG_DAX) &&
2288 !(S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode)))
2289 return -EINVAL;
2290
Darrick J. Wongca29be72019-07-01 08:25:36 -07002291 /* Extent size hints of zero turn off the flags. */
2292 if (fa->fsx_extsize == 0)
2293 fa->fsx_xflags &= ~(FS_XFLAG_EXTSIZE | FS_XFLAG_EXTSZINHERIT);
2294 if (fa->fsx_cowextsize == 0)
2295 fa->fsx_xflags &= ~FS_XFLAG_COWEXTSIZE;
2296
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002297 return 0;
2298}
2299EXPORT_SYMBOL(vfs_ioc_fssetxattr_check);