blob: 96d62d97694ef333e14ab35060084c6f486339ff [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * (C) 1997 Linus Torvalds
Christoph Hellwig4b4563d2011-05-27 09:28:01 -04004 * (C) 1999 Andrea Arcangeli <andrea@suse.de> (dynamic inode allocation)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 */
Al Viroe59cc472011-12-07 13:17:19 -05006#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/fs.h>
8#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/hash.h>
11#include <linux/swap.h>
12#include <linux/security.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/cdev.h>
Mike Rapoport57c8a662018-10-30 15:09:49 -070014#include <linux/memblock.h>
Eric Paris3be25f42009-05-21 17:01:26 -040015#include <linux/fsnotify.h>
Christoph Hellwigfc33a7b2006-01-09 20:52:17 -080016#include <linux/mount.h>
Al Virof19d4a82009-06-08 19:50:45 -040017#include <linux/posix_acl.h>
Heiko Carstens9ce6e0b2011-05-22 18:54:21 +020018#include <linux/prefetch.h>
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040019#include <linux/buffer_head.h> /* for inode_has_buffers */
Miklos Szeredi7ada4db2011-11-21 12:11:32 +010020#include <linux/ratelimit.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100021#include <linux/list_lru.h>
Jeff Laytonae5e1652018-01-29 06:41:30 -050022#include <linux/iversion.h>
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050023#include <trace/events/writeback.h>
Dave Chinnera66979a2011-03-22 22:23:41 +110024#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26/*
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040027 * Inode locking rules:
Dave Chinner250df6e2011-03-22 22:23:36 +110028 *
29 * inode->i_lock protects:
30 * inode->i_state, inode->i_hash, __iget()
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100031 * Inode LRU list locks protect:
Dave Chinner98b745c2011-07-08 14:14:39 +100032 * inode->i_sb->s_inode_lru, inode->i_lru
Dave Chinner74278da2015-03-04 12:37:22 -050033 * inode->i_sb->s_inode_list_lock protects:
34 * inode->i_sb->s_inodes, inode->i_sb_list
Christoph Hellwigf758eea2011-04-21 18:19:44 -060035 * bdi->wb.list_lock protects:
Dave Chinnerc7f54082015-03-04 14:07:22 -050036 * bdi->wb.b_{dirty,io,more_io,dirty_time}, inode->i_io_list
Dave Chinner67a23c42011-03-22 22:23:42 +110037 * inode_hash_lock protects:
38 * inode_hashtable, inode->i_hash
Dave Chinner250df6e2011-03-22 22:23:36 +110039 *
40 * Lock ordering:
Dave Chinner55fa6092011-03-22 22:23:40 +110041 *
Dave Chinner74278da2015-03-04 12:37:22 -050042 * inode->i_sb->s_inode_list_lock
Dave Chinner55fa6092011-03-22 22:23:40 +110043 * inode->i_lock
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100044 * Inode LRU list locks
Dave Chinnera66979a2011-03-22 22:23:41 +110045 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060046 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110047 * inode->i_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110048 *
49 * inode_hash_lock
Dave Chinner74278da2015-03-04 12:37:22 -050050 * inode->i_sb->s_inode_list_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110051 * inode->i_lock
52 *
53 * iunique_lock
54 * inode_hash_lock
Dave Chinner250df6e2011-03-22 22:23:36 +110055 */
56
Eric Dumazetfa3536c2006-03-26 01:37:24 -080057static unsigned int i_hash_mask __read_mostly;
58static unsigned int i_hash_shift __read_mostly;
Dave Chinner67a23c42011-03-22 22:23:42 +110059static struct hlist_head *inode_hashtable __read_mostly;
60static __cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Linus Torvalds1da177e2005-04-16 15:20:36 -070062/*
Jens Axboe7dcda1c2011-04-05 23:51:48 +020063 * Empty aops. Can be used for the cases where the user does not
64 * define any of the address_space operations.
65 */
66const struct address_space_operations empty_aops = {
67};
68EXPORT_SYMBOL(empty_aops);
69
70/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 * Statistics gathering..
72 */
73struct inodes_stat_t inodes_stat;
74
Glauber Costa3942c072013-08-28 10:17:53 +100075static DEFINE_PER_CPU(unsigned long, nr_inodes);
76static DEFINE_PER_CPU(unsigned long, nr_unused);
Dave Chinnercffbc8a2010-10-23 05:03:02 -040077
Manish Katiyar6b3304b2009-03-31 19:35:54 +053078static struct kmem_cache *inode_cachep __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Glauber Costa3942c072013-08-28 10:17:53 +100080static long get_nr_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040081{
Nick Piggin3e880fb2011-01-07 17:49:19 +110082 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100083 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +110084 for_each_possible_cpu(i)
85 sum += per_cpu(nr_inodes, i);
86 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040087}
88
Glauber Costa3942c072013-08-28 10:17:53 +100089static inline long get_nr_inodes_unused(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040090{
Dave Chinnerfcb94f72011-07-08 14:14:38 +100091 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100092 long sum = 0;
Dave Chinnerfcb94f72011-07-08 14:14:38 +100093 for_each_possible_cpu(i)
94 sum += per_cpu(nr_unused, i);
95 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040096}
97
Glauber Costa3942c072013-08-28 10:17:53 +100098long get_nr_dirty_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040099{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100100 /* not actually dirty inodes, but a wild approximation */
Glauber Costa3942c072013-08-28 10:17:53 +1000101 long nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400102 return nr_dirty > 0 ? nr_dirty : 0;
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400103}
104
105/*
106 * Handle nr_inode sysctl
107 */
108#ifdef CONFIG_SYSCTL
Joe Perches1f7e0612014-06-06 14:38:05 -0700109int proc_nr_inodes(struct ctl_table *table, int write,
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400110 void __user *buffer, size_t *lenp, loff_t *ppos)
111{
112 inodes_stat.nr_inodes = get_nr_inodes();
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000113 inodes_stat.nr_unused = get_nr_inodes_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000114 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400115}
116#endif
117
Al Virobd9b51e2014-11-18 23:38:21 -0500118static int no_open(struct inode *inode, struct file *file)
119{
120 return -ENXIO;
121}
122
David Chinner2cb15992008-10-30 17:32:23 +1100123/**
Masahiro Yamada6e7c2b42017-05-08 15:57:53 -0700124 * inode_init_always - perform inode structure initialisation
Randy Dunlap0bc02f32009-01-06 14:41:13 -0800125 * @sb: superblock inode belongs to
126 * @inode: inode to initialise
David Chinner2cb15992008-10-30 17:32:23 +1100127 *
128 * These are initializations that need to be done on every inode
129 * allocation as the fields are not initialised by slab allocation.
130 */
Christoph Hellwig54e34622009-08-07 14:38:25 -0300131int inode_init_always(struct super_block *sb, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
Alexey Dobriyan6e1d5dc2009-09-21 17:01:11 -0700133 static const struct inode_operations empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500134 static const struct file_operations no_open_fops = {.open = no_open};
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530135 struct address_space *const mapping = &inode->i_data;
David Chinner2cb15992008-10-30 17:32:23 +1100136
137 inode->i_sb = sb;
138 inode->i_blkbits = sb->s_blocksize_bits;
139 inode->i_flags = 0;
140 atomic_set(&inode->i_count, 1);
141 inode->i_op = &empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500142 inode->i_fop = &no_open_fops;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200143 inode->__i_nlink = 1;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700144 inode->i_opflags = 0;
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200145 if (sb->s_xattr)
146 inode->i_opflags |= IOP_XATTR;
Eric W. Biederman92361632012-02-08 07:07:50 -0800147 i_uid_write(inode, 0);
148 i_gid_write(inode, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100149 atomic_set(&inode->i_writecount, 0);
150 inode->i_size = 0;
Jens Axboec75b1d92017-06-27 11:47:04 -0600151 inode->i_write_hint = WRITE_LIFE_NOT_SET;
David Chinner2cb15992008-10-30 17:32:23 +1100152 inode->i_blocks = 0;
153 inode->i_bytes = 0;
154 inode->i_generation = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100155 inode->i_pipe = NULL;
156 inode->i_bdev = NULL;
157 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400158 inode->i_link = NULL;
Al Viro84e710d2016-04-15 00:58:55 -0400159 inode->i_dir_seq = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100160 inode->i_rdev = 0;
161 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500162
Tahsin Erdogan3d65ae42016-02-16 13:34:39 -0800163#ifdef CONFIG_CGROUP_WRITEBACK
164 inode->i_wb_frn_winner = 0;
165 inode->i_wb_frn_avg_time = 0;
166 inode->i_wb_frn_history = 0;
167#endif
168
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500169 if (security_inode_alloc(inode))
Christoph Hellwig54e34622009-08-07 14:38:25 -0300170 goto out;
David Chinner2cb15992008-10-30 17:32:23 +1100171 spin_lock_init(&inode->i_lock);
172 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
173
Al Viro9902af72016-04-15 15:08:36 -0400174 init_rwsem(&inode->i_rwsem);
175 lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
David Chinner2cb15992008-10-30 17:32:23 +1100176
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400177 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100178
179 mapping->a_ops = &empty_aops;
180 mapping->host = inode;
181 mapping->flags = 0;
Darrick J. Wong829bc7872018-05-30 19:43:53 -0700182 mapping->wb_err = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700183 atomic_set(&mapping->i_mmap_writable, 0);
Song Liu09d91cd2019-09-23 15:38:03 -0700184#ifdef CONFIG_READ_ONLY_THP_FOR_FS
185 atomic_set(&mapping->nr_thps, 0);
186#endif
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800187 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800188 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100189 mapping->writeback_index = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100190 inode->i_private = NULL;
191 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400192 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400193#ifdef CONFIG_FS_POSIX_ACL
194 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
195#endif
David Chinner2cb15992008-10-30 17:32:23 +1100196
Eric Paris3be25f42009-05-21 17:01:26 -0400197#ifdef CONFIG_FSNOTIFY
198 inode->i_fsnotify_mask = 0;
199#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500200 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100201 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400202
Christoph Hellwig54e34622009-08-07 14:38:25 -0300203 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300204out:
205 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100206}
207EXPORT_SYMBOL(inode_init_always);
208
Al Virofdb0da82019-04-10 14:43:44 -0400209void free_inode_nonrcu(struct inode *inode)
210{
211 kmem_cache_free(inode_cachep, inode);
212}
213EXPORT_SYMBOL(free_inode_nonrcu);
214
215static void i_callback(struct rcu_head *head)
216{
217 struct inode *inode = container_of(head, struct inode, i_rcu);
218 if (inode->free_inode)
219 inode->free_inode(inode);
220 else
221 free_inode_nonrcu(inode);
222}
223
David Chinner2cb15992008-10-30 17:32:23 +1100224static struct inode *alloc_inode(struct super_block *sb)
225{
Al Virofdb0da82019-04-10 14:43:44 -0400226 const struct super_operations *ops = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 struct inode *inode;
228
Al Virofdb0da82019-04-10 14:43:44 -0400229 if (ops->alloc_inode)
230 inode = ops->alloc_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 else
David Chinner2cb15992008-10-30 17:32:23 +1100232 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Christoph Hellwig54e34622009-08-07 14:38:25 -0300234 if (!inode)
235 return NULL;
236
237 if (unlikely(inode_init_always(sb, inode))) {
Al Virofdb0da82019-04-10 14:43:44 -0400238 if (ops->destroy_inode) {
239 ops->destroy_inode(inode);
240 if (!ops->free_inode)
241 return NULL;
242 }
243 inode->free_inode = ops->free_inode;
244 i_callback(&inode->i_rcu);
Christoph Hellwig54e34622009-08-07 14:38:25 -0300245 return NULL;
246 }
247
248 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249}
250
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300251void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200253 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400254 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400256 fsnotify_inode_delete(inode);
Jeff Laytonf27a0fe2016-01-07 15:08:51 -0500257 locks_free_lock_context(inode);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100258 if (!inode->i_nlink) {
259 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
260 atomic_long_dec(&inode->i_sb->s_remove_count);
261 }
262
Al Virof19d4a82009-06-08 19:50:45 -0400263#ifdef CONFIG_FS_POSIX_ACL
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100264 if (inode->i_acl && !is_uncached_acl(inode->i_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400265 posix_acl_release(inode->i_acl);
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100266 if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
Al Virof19d4a82009-06-08 19:50:45 -0400267 posix_acl_release(inode->i_default_acl);
268#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100269 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300270}
271EXPORT_SYMBOL(__destroy_inode);
272
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200273static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300274{
Al Virofdb0da82019-04-10 14:43:44 -0400275 const struct super_operations *ops = inode->i_sb->s_op;
276
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100277 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300278 __destroy_inode(inode);
Al Virofdb0da82019-04-10 14:43:44 -0400279 if (ops->destroy_inode) {
280 ops->destroy_inode(inode);
281 if (!ops->free_inode)
282 return;
283 }
284 inode->free_inode = ops->free_inode;
285 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100288/**
289 * drop_nlink - directly drop an inode's link count
290 * @inode: inode
291 *
292 * This is a low-level filesystem helper to replace any
293 * direct filesystem manipulation of i_nlink. In cases
294 * where we are attempting to track writes to the
295 * filesystem, a decrement to zero means an imminent
296 * write when the file is truncated and actually unlinked
297 * on the filesystem.
298 */
299void drop_nlink(struct inode *inode)
300{
301 WARN_ON(inode->i_nlink == 0);
302 inode->__i_nlink--;
303 if (!inode->i_nlink)
304 atomic_long_inc(&inode->i_sb->s_remove_count);
305}
306EXPORT_SYMBOL(drop_nlink);
307
308/**
309 * clear_nlink - directly zero an inode's link count
310 * @inode: inode
311 *
312 * This is a low-level filesystem helper to replace any
313 * direct filesystem manipulation of i_nlink. See
314 * drop_nlink() for why we care about i_nlink hitting zero.
315 */
316void clear_nlink(struct inode *inode)
317{
318 if (inode->i_nlink) {
319 inode->__i_nlink = 0;
320 atomic_long_inc(&inode->i_sb->s_remove_count);
321 }
322}
323EXPORT_SYMBOL(clear_nlink);
324
325/**
326 * set_nlink - directly set an inode's link count
327 * @inode: inode
328 * @nlink: new nlink (should be non-zero)
329 *
330 * This is a low-level filesystem helper to replace any
331 * direct filesystem manipulation of i_nlink.
332 */
333void set_nlink(struct inode *inode, unsigned int nlink)
334{
335 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100336 clear_nlink(inode);
337 } else {
338 /* Yes, some filesystems do change nlink from zero to one */
339 if (inode->i_nlink == 0)
340 atomic_long_dec(&inode->i_sb->s_remove_count);
341
342 inode->__i_nlink = nlink;
343 }
344}
345EXPORT_SYMBOL(set_nlink);
346
347/**
348 * inc_nlink - directly increment an inode's link count
349 * @inode: inode
350 *
351 * This is a low-level filesystem helper to replace any
352 * direct filesystem manipulation of i_nlink. Currently,
353 * it is only here for parity with dec_nlink().
354 */
355void inc_nlink(struct inode *inode)
356{
Al Virof4e0c302013-06-11 08:34:36 +0400357 if (unlikely(inode->i_nlink == 0)) {
358 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100359 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400360 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100361
362 inode->__i_nlink++;
363}
364EXPORT_SYMBOL(inc_nlink);
365
Dave Chinnerae233952018-03-06 17:30:34 -0800366static void __address_space_init_once(struct address_space *mapping)
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100367{
Johannes Weiner7b785642019-05-24 10:12:46 -0400368 xa_init_flags(&mapping->i_pages, XA_FLAGS_LOCK_IRQ | XA_FLAGS_ACCOUNT);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800369 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100370 INIT_LIST_HEAD(&mapping->private_list);
371 spin_lock_init(&mapping->private_lock);
Davidlohr Buesof808c132017-09-08 16:15:08 -0700372 mapping->i_mmap = RB_ROOT_CACHED;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100373}
Dave Chinnerae233952018-03-06 17:30:34 -0800374
375void address_space_init_once(struct address_space *mapping)
376{
377 memset(mapping, 0, sizeof(*mapping));
378 __address_space_init_once(mapping);
379}
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100380EXPORT_SYMBOL(address_space_init_once);
381
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382/*
383 * These are initializations that only need to be done
384 * once, because the fields are idempotent across use
385 * of the inode, so let the slab aware of that.
386 */
387void inode_init_once(struct inode *inode)
388{
389 memset(inode, 0, sizeof(*inode));
390 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500392 INIT_LIST_HEAD(&inode->i_io_list);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700393 INIT_LIST_HEAD(&inode->i_wb_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100394 INIT_LIST_HEAD(&inode->i_lru);
Dave Chinnerae233952018-03-06 17:30:34 -0800395 __address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 i_size_ordered_init(inode);
397}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398EXPORT_SYMBOL(inode_init_once);
399
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700400static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530402 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Christoph Lametera35afb82007-05-16 22:10:57 -0700404 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405}
406
407/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100408 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530410void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411{
Nick Piggin9e38d862010-10-23 06:55:17 -0400412 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413}
414
Al Viro7de9c6ee2010-10-23 11:11:40 -0400415/*
416 * get additional reference to inode; caller must already hold one.
417 */
418void ihold(struct inode *inode)
419{
420 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
421}
422EXPORT_SYMBOL(ihold);
423
Nick Piggin9e38d862010-10-23 06:55:17 -0400424static void inode_lru_list_add(struct inode *inode)
425{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000426 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000427 this_cpu_inc(nr_unused);
Josef Bacik563f4002017-04-18 16:04:17 -0400428 else
429 inode->i_state |= I_REFERENCED;
Nick Piggin9e38d862010-10-23 06:55:17 -0400430}
431
Jan Kara4eff96d2012-11-26 16:29:51 -0800432/*
433 * Add inode to LRU if needed (inode is unused and clean).
434 *
435 * Needs inode->i_lock held.
436 */
437void inode_add_lru(struct inode *inode)
438{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500439 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
440 I_FREEING | I_WILL_FREE)) &&
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800441 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & SB_ACTIVE)
Jan Kara4eff96d2012-11-26 16:29:51 -0800442 inode_lru_list_add(inode);
443}
444
445
Nick Piggin9e38d862010-10-23 06:55:17 -0400446static void inode_lru_list_del(struct inode *inode)
447{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000448
449 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000450 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451}
452
Christoph Hellwig646ec462010-10-23 07:15:32 -0400453/**
454 * inode_sb_list_add - add inode to the superblock list of inodes
455 * @inode: inode to add
456 */
457void inode_sb_list_add(struct inode *inode)
458{
Dave Chinner74278da2015-03-04 12:37:22 -0500459 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100460 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500461 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400462}
463EXPORT_SYMBOL_GPL(inode_sb_list_add);
464
Dave Chinner55fa6092011-03-22 22:23:40 +1100465static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400466{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200467 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500468 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200469 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500470 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200471 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400472}
473
Dave Chinner4c51acb2010-10-23 06:58:09 -0400474static unsigned long hash(struct super_block *sb, unsigned long hashval)
475{
476 unsigned long tmp;
477
478 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
479 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400480 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
481 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400482}
483
484/**
485 * __insert_inode_hash - hash an inode
486 * @inode: unhashed inode
487 * @hashval: unsigned long value used to locate this object in the
488 * inode_hashtable.
489 *
490 * Add an inode to the inode hash for this superblock.
491 */
492void __insert_inode_hash(struct inode *inode, unsigned long hashval)
493{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400494 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
495
Dave Chinner67a23c42011-03-22 22:23:42 +1100496 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100497 spin_lock(&inode->i_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400498 hlist_add_head(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100499 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100500 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400501}
502EXPORT_SYMBOL(__insert_inode_hash);
503
504/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200505 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400506 * @inode: inode to unhash
507 *
508 * Remove an inode from the superblock.
509 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200510void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400511{
Dave Chinner67a23c42011-03-22 22:23:42 +1100512 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100513 spin_lock(&inode->i_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400514 hlist_del_init(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100515 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100516 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400517}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200518EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400519
Jan Karadbd57682012-05-03 14:48:02 +0200520void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400521{
Jan Kara08142572011-06-27 16:18:10 -0700522 /*
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700523 * We have to cycle the i_pages lock here because reclaim can be in the
Jan Kara08142572011-06-27 16:18:10 -0700524 * process of removing the last page (in __delete_from_page_cache())
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700525 * and we must not free the mapping under it.
Jan Kara08142572011-06-27 16:18:10 -0700526 */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700527 xa_lock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400528 BUG_ON(inode->i_data.nrpages);
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800529 BUG_ON(inode->i_data.nrexceptional);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700530 xa_unlock_irq(&inode->i_data.i_pages);
Al Virob0683aa2010-06-04 20:55:25 -0400531 BUG_ON(!list_empty(&inode->i_data.private_list));
532 BUG_ON(!(inode->i_state & I_FREEING));
533 BUG_ON(inode->i_state & I_CLEAR);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700534 BUG_ON(!list_empty(&inode->i_wb_list));
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100535 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400536 inode->i_state = I_FREEING | I_CLEAR;
537}
Jan Karadbd57682012-05-03 14:48:02 +0200538EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400539
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100540/*
541 * Free the inode passed in, removing it from the lists it is still connected
542 * to. We remove any pages still attached to the inode and wait for any IO that
543 * is still in progress before finally destroying the inode.
544 *
545 * An inode must already be marked I_FREEING so that we avoid the inode being
546 * moved back onto lists if we race with other code that manipulates the lists
547 * (e.g. writeback_single_inode). The caller is responsible for setting this.
548 *
549 * An inode must already be removed from the LRU list before being evicted from
550 * the cache. This should occur atomically with setting the I_FREEING state
551 * flag, so no inodes here should ever be on the LRU when being evicted.
552 */
Al Viro644da592010-06-07 13:21:05 -0400553static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400554{
555 const struct super_operations *op = inode->i_sb->s_op;
556
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100557 BUG_ON(!(inode->i_state & I_FREEING));
558 BUG_ON(!list_empty(&inode->i_lru));
559
Dave Chinnerc7f54082015-03-04 14:07:22 -0500560 if (!list_empty(&inode->i_io_list))
561 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200562
Dave Chinner55fa6092011-03-22 22:23:40 +1100563 inode_sb_list_del(inode);
564
Jan Kara169ebd92012-05-03 14:48:03 +0200565 /*
566 * Wait for flusher thread to be done with the inode so that filesystem
567 * does not start destroying it while writeback is still running. Since
568 * the inode has I_FREEING set, flusher thread won't start new work on
569 * the inode. We just have to wait for running writeback to finish.
570 */
571 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200572
Al Virobe7ce412010-06-04 19:40:39 -0400573 if (op->evict_inode) {
574 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400575 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700576 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200577 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400578 }
Al Viro661074e2010-06-04 20:19:55 -0400579 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
580 bd_forget(inode);
581 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
582 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100583
584 remove_inode_hash(inode);
585
586 spin_lock(&inode->i_lock);
587 wake_up_bit(&inode->i_state, __I_NEW);
588 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
589 spin_unlock(&inode->i_lock);
590
591 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400592}
593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594/*
595 * dispose_list - dispose of the contents of a local list
596 * @head: the head of the list to free
597 *
598 * Dispose-list gets a local list with local inodes in it, so it doesn't
599 * need to worry about list corruption and SMP locks.
600 */
601static void dispose_list(struct list_head *head)
602{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 while (!list_empty(head)) {
604 struct inode *inode;
605
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100606 inode = list_first_entry(head, struct inode, i_lru);
607 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Al Viro644da592010-06-07 13:21:05 -0400609 evict(inode);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500610 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612}
613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614/**
Al Viro63997e92010-10-25 20:49:35 -0400615 * evict_inodes - evict all evictable inodes for a superblock
616 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 *
Al Viro63997e92010-10-25 20:49:35 -0400618 * Make sure that no inodes with zero refcount are retained. This is
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800619 * called by superblock shutdown after having SB_ACTIVE flag removed,
Al Viro63997e92010-10-25 20:49:35 -0400620 * so any inode reaching zero refcount during or after that call will
621 * be immediately evicted.
622 */
623void evict_inodes(struct super_block *sb)
624{
625 struct inode *inode, *next;
626 LIST_HEAD(dispose);
627
Josef Bacikac05fbb2015-03-04 16:52:52 -0500628again:
Dave Chinner74278da2015-03-04 12:37:22 -0500629 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400630 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
631 if (atomic_read(&inode->i_count))
632 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100633
634 spin_lock(&inode->i_lock);
635 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
636 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400637 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100638 }
Al Viro63997e92010-10-25 20:49:35 -0400639
640 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100641 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100642 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100643 list_add(&inode->i_lru, &dispose);
Josef Bacikac05fbb2015-03-04 16:52:52 -0500644
645 /*
646 * We can have a ton of inodes to evict at unmount time given
647 * enough memory, check to see if we need to go to sleep for a
648 * bit so we don't livelock.
649 */
650 if (need_resched()) {
651 spin_unlock(&sb->s_inode_list_lock);
652 cond_resched();
653 dispose_list(&dispose);
654 goto again;
655 }
Al Viro63997e92010-10-25 20:49:35 -0400656 }
Dave Chinner74278da2015-03-04 12:37:22 -0500657 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400658
659 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400660}
Darrick J. Wong799ea9e2017-08-18 18:08:25 -0700661EXPORT_SYMBOL_GPL(evict_inodes);
Al Viro63997e92010-10-25 20:49:35 -0400662
663/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200664 * invalidate_inodes - attempt to free all inodes on a superblock
665 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100666 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200667 *
668 * Attempts to free all inodes for a given superblock. If there were any
669 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100670 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
671 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 */
NeilBrown93b270f2011-02-24 17:25:47 +1100673int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400675 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200676 struct inode *inode, *next;
677 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
Eric Sandeen04646ae2019-12-06 10:54:23 -0600679again:
Dave Chinner74278da2015-03-04 12:37:22 -0500680 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200681 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100682 spin_lock(&inode->i_lock);
683 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
684 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100686 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500687 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100688 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100689 busy = 1;
690 continue;
691 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200692 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100693 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200694 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 continue;
696 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200697
Christoph Hellwig99a38912010-10-23 19:07:20 +0200698 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100699 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100700 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100701 list_add(&inode->i_lru, &dispose);
Eric Sandeen04646ae2019-12-06 10:54:23 -0600702 if (need_resched()) {
703 spin_unlock(&sb->s_inode_list_lock);
704 cond_resched();
705 dispose_list(&dispose);
706 goto again;
707 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 }
Dave Chinner74278da2015-03-04 12:37:22 -0500709 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Christoph Hellwiga0318782010-10-24 19:40:33 +0200711 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
713 return busy;
714}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000717 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 *
719 * Any inodes which are pinned purely because of attached pagecache have their
Nick Piggin9e38d862010-10-23 06:55:17 -0400720 * pagecache removed. If the inode has metadata buffers attached to
721 * mapping->private_list then try to remove them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400723 * If the inode has the I_REFERENCED flag set, then it means that it has been
724 * used recently - the flag is set in iput_final(). When we encounter such an
725 * inode, clear the flag and move it to the back of the LRU so it gets another
726 * pass through the LRU before it gets reclaimed. This is necessary because of
727 * the fact we are doing lazy LRU updates to minimise lock contention so the
728 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
729 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800731static enum lru_status inode_lru_isolate(struct list_head *item,
732 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000733{
734 struct list_head *freeable = arg;
735 struct inode *inode = container_of(item, struct inode, i_lru);
736
737 /*
738 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
739 * If we fail to get the lock, just skip it.
740 */
741 if (!spin_trylock(&inode->i_lock))
742 return LRU_SKIP;
743
744 /*
745 * Referenced or dirty inodes are still in use. Give them another pass
746 * through the LRU as we canot reclaim them now.
747 */
748 if (atomic_read(&inode->i_count) ||
749 (inode->i_state & ~I_REFERENCED)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800750 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000751 spin_unlock(&inode->i_lock);
752 this_cpu_dec(nr_unused);
753 return LRU_REMOVED;
754 }
755
Dave Chinner69056ee2019-02-12 15:35:51 -0800756 /* recently referenced inodes get one more pass */
757 if (inode->i_state & I_REFERENCED) {
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000758 inode->i_state &= ~I_REFERENCED;
759 spin_unlock(&inode->i_lock);
760 return LRU_ROTATE;
761 }
762
763 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
764 __iget(inode);
765 spin_unlock(&inode->i_lock);
766 spin_unlock(lru_lock);
767 if (remove_inode_buffers(inode)) {
768 unsigned long reap;
769 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
770 if (current_is_kswapd())
771 __count_vm_events(KSWAPD_INODESTEAL, reap);
772 else
773 __count_vm_events(PGINODESTEAL, reap);
774 if (current->reclaim_state)
775 current->reclaim_state->reclaimed_slab += reap;
776 }
777 iput(inode);
778 spin_lock(lru_lock);
779 return LRU_RETRY;
780 }
781
782 WARN_ON(inode->i_state & I_NEW);
783 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800784 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000785 spin_unlock(&inode->i_lock);
786
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000787 this_cpu_dec(nr_unused);
788 return LRU_REMOVED;
789}
790
791/*
792 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
793 * This is called from the superblock shrinker function with a number of inodes
794 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
795 * then are freed outside inode_lock by dispose_list().
796 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800797long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798{
799 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000800 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Vladimir Davydov503c3582015-02-12 14:58:47 -0800802 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
803 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000805 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806}
807
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808static void __wait_on_freeing_inode(struct inode *inode);
809/*
810 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530812static struct inode *find_inode(struct super_block *sb,
813 struct hlist_head *head,
814 int (*test)(struct inode *, void *),
815 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530817 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
819repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800820 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500821 if (inode->i_sb != sb)
822 continue;
823 if (!test(inode, data))
824 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100825 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400826 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 __wait_on_freeing_inode(inode);
828 goto repeat;
829 }
Al Viroc2b6d622018-06-28 15:53:17 -0400830 if (unlikely(inode->i_state & I_CREATING)) {
831 spin_unlock(&inode->i_lock);
832 return ERR_PTR(-ESTALE);
833 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400834 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100835 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400836 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400838 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839}
840
841/*
842 * find_inode_fast is the fast path version of find_inode, see the comment at
843 * iget_locked for details.
844 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530845static struct inode *find_inode_fast(struct super_block *sb,
846 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530848 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
850repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800851 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500852 if (inode->i_ino != ino)
853 continue;
854 if (inode->i_sb != sb)
855 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100856 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400857 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 __wait_on_freeing_inode(inode);
859 goto repeat;
860 }
Al Viroc2b6d622018-06-28 15:53:17 -0400861 if (unlikely(inode->i_state & I_CREATING)) {
862 spin_unlock(&inode->i_lock);
863 return ERR_PTR(-ESTALE);
864 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400865 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100866 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400867 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400869 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870}
871
Eric Dumazetf991bd22010-10-23 11:18:01 -0400872/*
873 * Each cpu owns a range of LAST_INO_BATCH numbers.
874 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
875 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100876 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400877 * This does not significantly increase overflow rate because every CPU can
878 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
879 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
880 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
881 * overflow rate by 2x, which does not seem too significant.
882 *
883 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
884 * error if st_ino won't fit in target struct field. Use 32bit counter
885 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100886 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400887#define LAST_INO_BATCH 1024
888static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100889
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400890unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400891{
892 unsigned int *p = &get_cpu_var(last_ino);
893 unsigned int res = *p;
894
895#ifdef CONFIG_SMP
896 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
897 static atomic_t shared_last_ino;
898 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
899
900 res = next - LAST_INO_BATCH;
901 }
902#endif
903
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300904 res++;
905 /* get_next_ino should not provide a 0 inode number */
906 if (unlikely(!res))
907 res++;
908 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400909 put_cpu_var(last_ino);
910 return res;
David Chinner8290c352008-10-30 17:35:24 +1100911}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400912EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100913
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200915 * new_inode_pseudo - obtain an inode
916 * @sb: superblock
917 *
918 * Allocates a new inode for given superblock.
919 * Inode wont be chained in superblock s_inodes list
920 * This means :
921 * - fs can't be unmount
922 * - quotas, fsnotify, writeback can't work
923 */
924struct inode *new_inode_pseudo(struct super_block *sb)
925{
926 struct inode *inode = alloc_inode(sb);
927
928 if (inode) {
929 spin_lock(&inode->i_lock);
930 inode->i_state = 0;
931 spin_unlock(&inode->i_lock);
932 INIT_LIST_HEAD(&inode->i_sb_list);
933 }
934 return inode;
935}
936
937/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 * new_inode - obtain an inode
939 * @sb: superblock
940 *
Mel Gorman769848c2007-07-17 04:03:05 -0700941 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800942 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700943 * If HIGHMEM pages are unsuitable or it is known that pages allocated
944 * for the page cache are not reclaimable or migratable,
945 * mapping_set_gfp_mask() must be called with suitable flags on the
946 * newly created inode's mapping
947 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 */
949struct inode *new_inode(struct super_block *sb)
950{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530951 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Dave Chinner74278da2015-03-04 12:37:22 -0500953 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530954
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200955 inode = new_inode_pseudo(sb);
956 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100957 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 return inode;
959}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960EXPORT_SYMBOL(new_inode);
961
Peter Zijlstra14358e62007-10-14 01:38:33 +0200962#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400963void lockdep_annotate_inode_mutex_key(struct inode *inode)
964{
Namhyung Kima3314a02010-10-11 22:38:00 +0900965 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200966 struct file_system_type *type = inode->i_sb->s_type;
967
Jan Kara9a7aa122009-06-04 15:26:49 +0200968 /* Set new key only if filesystem hasn't already changed it */
Al Viro9902af72016-04-15 15:08:36 -0400969 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200970 /*
971 * ensure nobody is actually holding i_mutex
972 */
Al Viro9902af72016-04-15 15:08:36 -0400973 // mutex_destroy(&inode->i_mutex);
974 init_rwsem(&inode->i_rwsem);
975 lockdep_set_class(&inode->i_rwsem,
Jan Kara9a7aa122009-06-04 15:26:49 +0200976 &type->i_mutex_dir_key);
977 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200978 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400979}
980EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200981#endif
Josh Boyere096d0c2011-08-25 07:48:12 -0400982
983/**
984 * unlock_new_inode - clear the I_NEW state and wake up any waiters
985 * @inode: new inode to unlock
986 *
987 * Called when the inode is fully initialised to clear the new state of the
988 * inode and wake up anyone waiting for the inode to finish initialisation.
989 */
990void unlock_new_inode(struct inode *inode)
991{
992 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100993 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100994 WARN_ON(!(inode->i_state & I_NEW));
Al Viroc2b6d622018-06-28 15:53:17 -0400995 inode->i_state &= ~I_NEW & ~I_CREATING;
Al Viro310fa7a2012-03-10 17:07:28 -0500996 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +1100997 wake_up_bit(&inode->i_state, __I_NEW);
998 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000EXPORT_SYMBOL(unlock_new_inode);
1001
Al Viroc2b6d622018-06-28 15:53:17 -04001002void discard_new_inode(struct inode *inode)
1003{
1004 lockdep_annotate_inode_mutex_key(inode);
1005 spin_lock(&inode->i_lock);
1006 WARN_ON(!(inode->i_state & I_NEW));
1007 inode->i_state &= ~I_NEW;
1008 smp_mb();
1009 wake_up_bit(&inode->i_state, __I_NEW);
1010 spin_unlock(&inode->i_lock);
1011 iput(inode);
1012}
1013EXPORT_SYMBOL(discard_new_inode);
1014
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001015/**
J. Bruce Fields375e2892012-04-18 15:16:33 -04001016 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001017 *
1018 * Lock any non-NULL argument that is not a directory.
1019 * Zero, one or two objects may be locked by this function.
1020 *
J. Bruce Fields375e2892012-04-18 15:16:33 -04001021 * @inode1: first inode to lock
1022 * @inode2: second inode to lock
1023 */
1024void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1025{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001026 if (inode1 > inode2)
1027 swap(inode1, inode2);
1028
1029 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001030 inode_lock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001031 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001032 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001033}
1034EXPORT_SYMBOL(lock_two_nondirectories);
1035
1036/**
1037 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
1038 * @inode1: first inode to unlock
1039 * @inode2: second inode to unlock
1040 */
1041void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
1042{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001043 if (inode1 && !S_ISDIR(inode1->i_mode))
Al Viro59551022016-01-22 15:40:57 -05001044 inode_unlock(inode1);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +02001045 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
Al Viro59551022016-01-22 15:40:57 -05001046 inode_unlock(inode2);
J. Bruce Fields375e2892012-04-18 15:16:33 -04001047}
1048EXPORT_SYMBOL(unlock_two_nondirectories);
1049
1050/**
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001051 * inode_insert5 - obtain an inode from a mounted file system
1052 * @inode: pre-allocated inode to use for insert to cache
1053 * @hashval: hash value (usually inode number) to get
1054 * @test: callback used for comparisons between inodes
1055 * @set: callback used to initialize a new struct inode
1056 * @data: opaque data pointer to pass to @test and @set
1057 *
1058 * Search for the inode specified by @hashval and @data in the inode cache,
1059 * and if present it is return it with an increased reference count. This is
1060 * a variant of iget5_locked() for callers that don't want to fail on memory
1061 * allocation of inode.
1062 *
1063 * If the inode is not in cache, insert the pre-allocated inode to cache and
1064 * return it locked, hashed, and with the I_NEW flag set. The file system gets
1065 * to fill it in before unlocking it via unlock_new_inode().
1066 *
1067 * Note both @test and @set are called with the inode_hash_lock held, so can't
1068 * sleep.
1069 */
1070struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
1071 int (*test)(struct inode *, void *),
1072 int (*set)(struct inode *, void *), void *data)
1073{
1074 struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
1075 struct inode *old;
Miklos Szeredie9505642018-07-24 15:01:55 +02001076 bool creating = inode->i_state & I_CREATING;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001077
1078again:
1079 spin_lock(&inode_hash_lock);
1080 old = find_inode(inode->i_sb, head, test, data);
1081 if (unlikely(old)) {
1082 /*
1083 * Uhhuh, somebody else created the same inode under us.
1084 * Use the old inode instead of the preallocated one.
1085 */
1086 spin_unlock(&inode_hash_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001087 if (IS_ERR(old))
1088 return NULL;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001089 wait_on_inode(old);
1090 if (unlikely(inode_unhashed(old))) {
1091 iput(old);
1092 goto again;
1093 }
1094 return old;
1095 }
1096
1097 if (set && unlikely(set(inode, data))) {
1098 inode = NULL;
1099 goto unlock;
1100 }
1101
1102 /*
1103 * Return the locked inode with I_NEW set, the
1104 * caller is responsible for filling in the contents
1105 */
1106 spin_lock(&inode->i_lock);
1107 inode->i_state |= I_NEW;
1108 hlist_add_head(&inode->i_hash, head);
1109 spin_unlock(&inode->i_lock);
Miklos Szeredie9505642018-07-24 15:01:55 +02001110 if (!creating)
1111 inode_sb_list_add(inode);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001112unlock:
1113 spin_unlock(&inode_hash_lock);
1114
1115 return inode;
1116}
1117EXPORT_SYMBOL(inode_insert5);
1118
1119/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001120 * iget5_locked - obtain an inode from a mounted file system
1121 * @sb: super block of file system
1122 * @hashval: hash value (usually inode number) to get
1123 * @test: callback used for comparisons between inodes
1124 * @set: callback used to initialize a new struct inode
1125 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001127 * Search for the inode specified by @hashval and @data in the inode cache,
1128 * and if present it is return it with an increased reference count. This is
1129 * a generalized version of iget_locked() for file systems where the inode
1130 * number is not sufficient for unique identification of an inode.
1131 *
1132 * If the inode is not in cache, allocate a new inode and return it locked,
1133 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1134 * before unlocking it via unlock_new_inode().
1135 *
1136 * Note both @test and @set are called with the inode_hash_lock held, so can't
1137 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001139struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1140 int (*test)(struct inode *, void *),
1141 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142{
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001143 struct inode *inode = ilookup5(sb, hashval, test, data);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001144
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001145 if (!inode) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001146 struct inode *new = alloc_inode(sb);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001147
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001148 if (new) {
Miklos Szeredie9505642018-07-24 15:01:55 +02001149 new->i_state = 0;
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001150 inode = inode_insert5(new, hashval, test, set, data);
1151 if (unlikely(inode != new))
Miklos Szeredie9505642018-07-24 15:01:55 +02001152 destroy_inode(new);
Al Viro2864f302016-07-03 23:15:21 -04001153 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 }
1155 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001157EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001159/**
1160 * iget_locked - obtain an inode from a mounted file system
1161 * @sb: super block of file system
1162 * @ino: inode number to get
1163 *
1164 * Search for the inode specified by @ino in the inode cache and if present
1165 * return it with an increased reference count. This is for file systems
1166 * where the inode number is sufficient for unique identification of an inode.
1167 *
1168 * If the inode is not in cache, allocate a new inode and return it locked,
1169 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1170 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001172struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001174 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301175 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001176again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001177 spin_lock(&inode_hash_lock);
1178 inode = find_inode_fast(sb, head, ino);
1179 spin_unlock(&inode_hash_lock);
1180 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001181 if (IS_ERR(inode))
1182 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001183 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001184 if (unlikely(inode_unhashed(inode))) {
1185 iput(inode);
1186 goto again;
1187 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001188 return inode;
1189 }
1190
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 inode = alloc_inode(sb);
1192 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301193 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194
Dave Chinner67a23c42011-03-22 22:23:42 +11001195 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 /* We released the lock, so.. */
1197 old = find_inode_fast(sb, head, ino);
1198 if (!old) {
1199 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001200 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001201 inode->i_state = I_NEW;
Dave Chinner250df6e2011-03-22 22:23:36 +11001202 hlist_add_head(&inode->i_hash, head);
1203 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001204 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001205 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
1207 /* Return the locked inode with I_NEW set, the
1208 * caller is responsible for filling in the contents
1209 */
1210 return inode;
1211 }
1212
1213 /*
1214 * Uhhuh, somebody else created the same inode under
1215 * us. Use the old inode instead of the one we just
1216 * allocated.
1217 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001218 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 destroy_inode(inode);
Al Viroc2b6d622018-06-28 15:53:17 -04001220 if (IS_ERR(old))
1221 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 inode = old;
1223 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001224 if (unlikely(inode_unhashed(inode))) {
1225 iput(inode);
1226 goto again;
1227 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 }
1229 return inode;
1230}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001231EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001233/*
1234 * search the inode cache for a matching inode number.
1235 * If we find one, then the inode number we are trying to
1236 * allocate is not unique and so we should not use it.
1237 *
1238 * Returns 1 if the inode number is unique, 0 if it is not.
1239 */
1240static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1241{
1242 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001243 struct inode *inode;
1244
Dave Chinner67a23c42011-03-22 22:23:42 +11001245 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001246 hlist_for_each_entry(inode, b, i_hash) {
Dave Chinner67a23c42011-03-22 22:23:42 +11001247 if (inode->i_ino == ino && inode->i_sb == sb) {
1248 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001249 return 0;
Dave Chinner67a23c42011-03-22 22:23:42 +11001250 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001251 }
Dave Chinner67a23c42011-03-22 22:23:42 +11001252 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001253
1254 return 1;
1255}
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257/**
1258 * iunique - get a unique inode number
1259 * @sb: superblock
1260 * @max_reserved: highest reserved inode number
1261 *
1262 * Obtain an inode number that is unique on the system for a given
1263 * superblock. This is used by file systems that have no natural
1264 * permanent inode numbering system. An inode number is returned that
1265 * is higher than the reserved limit but unique.
1266 *
1267 * BUGS:
1268 * With a large number of inodes live on the file system this function
1269 * currently becomes quite slow.
1270 */
1271ino_t iunique(struct super_block *sb, ino_t max_reserved)
1272{
Jeff Layton866b04f2007-05-08 00:32:29 -07001273 /*
1274 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1275 * error if st_ino won't fit in target struct field. Use 32bit counter
1276 * here to attempt to avoid that.
1277 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001278 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001279 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001282 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001283 do {
1284 if (counter <= max_reserved)
1285 counter = max_reserved + 1;
1286 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001287 } while (!test_inode_iunique(sb, res));
1288 spin_unlock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001289
1290 return res;
1291}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292EXPORT_SYMBOL(iunique);
1293
1294struct inode *igrab(struct inode *inode)
1295{
Dave Chinner250df6e2011-03-22 22:23:36 +11001296 spin_lock(&inode->i_lock);
1297 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001299 spin_unlock(&inode->i_lock);
1300 } else {
1301 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 /*
1303 * Handle the case where s_op->clear_inode is not been
1304 * called yet, and somebody is calling igrab
1305 * while the inode is getting freed.
1306 */
1307 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001308 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 return inode;
1310}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311EXPORT_SYMBOL(igrab);
1312
1313/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001314 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 * @sb: super block of file system to search
1316 * @hashval: hash value (usually inode number) to search for
1317 * @test: callback used for comparisons between inodes
1318 * @data: opaque data pointer to pass to @test
1319 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001320 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001322 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001323 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001324 * Note: I_NEW is not waited upon so you have to be very careful what you do
1325 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001326 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001327 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001328 */
1329struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1330 int (*test)(struct inode *, void *), void *data)
1331{
1332 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001333 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001334
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001335 spin_lock(&inode_hash_lock);
1336 inode = find_inode(sb, head, test, data);
1337 spin_unlock(&inode_hash_lock);
1338
Al Viroc2b6d622018-06-28 15:53:17 -04001339 return IS_ERR(inode) ? NULL : inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001340}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001341EXPORT_SYMBOL(ilookup5_nowait);
1342
1343/**
1344 * ilookup5 - search for an inode in the inode cache
1345 * @sb: super block of file system to search
1346 * @hashval: hash value (usually inode number) to search for
1347 * @test: callback used for comparisons between inodes
1348 * @data: opaque data pointer to pass to @test
1349 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001350 * Search for the inode specified by @hashval and @data in the inode cache,
1351 * and if the inode is in the cache, return the inode with an incremented
1352 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001353 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001355 * This is a generalized version of ilookup() for file systems where the
1356 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001358 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 */
1360struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1361 int (*test)(struct inode *, void *), void *data)
1362{
Al Viro2864f302016-07-03 23:15:21 -04001363 struct inode *inode;
1364again:
1365 inode = ilookup5_nowait(sb, hashval, test, data);
1366 if (inode) {
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001367 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001368 if (unlikely(inode_unhashed(inode))) {
1369 iput(inode);
1370 goto again;
1371 }
1372 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001373 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375EXPORT_SYMBOL(ilookup5);
1376
1377/**
1378 * ilookup - search for an inode in the inode cache
1379 * @sb: super block of file system to search
1380 * @ino: inode number to search for
1381 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001382 * Search for the inode @ino in the inode cache, and if the inode is in the
1383 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 */
1385struct inode *ilookup(struct super_block *sb, unsigned long ino)
1386{
1387 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001388 struct inode *inode;
Al Viro2864f302016-07-03 23:15:21 -04001389again:
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001390 spin_lock(&inode_hash_lock);
1391 inode = find_inode_fast(sb, head, ino);
1392 spin_unlock(&inode_hash_lock);
1393
Al Viro2864f302016-07-03 23:15:21 -04001394 if (inode) {
Al Viroc2b6d622018-06-28 15:53:17 -04001395 if (IS_ERR(inode))
1396 return NULL;
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001397 wait_on_inode(inode);
Al Viro2864f302016-07-03 23:15:21 -04001398 if (unlikely(inode_unhashed(inode))) {
1399 iput(inode);
1400 goto again;
1401 }
1402 }
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001403 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405EXPORT_SYMBOL(ilookup);
1406
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001407/**
1408 * find_inode_nowait - find an inode in the inode cache
1409 * @sb: super block of file system to search
1410 * @hashval: hash value (usually inode number) to search for
1411 * @match: callback used for comparisons between inodes
1412 * @data: opaque data pointer to pass to @match
1413 *
1414 * Search for the inode specified by @hashval and @data in the inode
1415 * cache, where the helper function @match will return 0 if the inode
1416 * does not match, 1 if the inode does match, and -1 if the search
1417 * should be stopped. The @match function must be responsible for
1418 * taking the i_lock spin_lock and checking i_state for an inode being
1419 * freed or being initialized, and incrementing the reference count
1420 * before returning 1. It also must not sleep, since it is called with
1421 * the inode_hash_lock spinlock held.
1422 *
1423 * This is a even more generalized version of ilookup5() when the
1424 * function must never block --- find_inode() can block in
1425 * __wait_on_freeing_inode() --- or when the caller can not increment
1426 * the reference count because the resulting iput() might cause an
1427 * inode eviction. The tradeoff is that the @match funtion must be
1428 * very carefully implemented.
1429 */
1430struct inode *find_inode_nowait(struct super_block *sb,
1431 unsigned long hashval,
1432 int (*match)(struct inode *, unsigned long,
1433 void *),
1434 void *data)
1435{
1436 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1437 struct inode *inode, *ret_inode = NULL;
1438 int mval;
1439
1440 spin_lock(&inode_hash_lock);
1441 hlist_for_each_entry(inode, head, i_hash) {
1442 if (inode->i_sb != sb)
1443 continue;
1444 mval = match(inode, hashval, data);
1445 if (mval == 0)
1446 continue;
1447 if (mval == 1)
1448 ret_inode = inode;
1449 goto out;
1450 }
1451out:
1452 spin_unlock(&inode_hash_lock);
1453 return ret_inode;
1454}
1455EXPORT_SYMBOL(find_inode_nowait);
1456
Al Viro261bca82008-12-30 01:48:21 -05001457int insert_inode_locked(struct inode *inode)
1458{
1459 struct super_block *sb = inode->i_sb;
1460 ino_t ino = inode->i_ino;
1461 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001462
Al Viro261bca82008-12-30 01:48:21 -05001463 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001464 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001465 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001466 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001467 if (old->i_ino != ino)
1468 continue;
1469 if (old->i_sb != sb)
1470 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001471 spin_lock(&old->i_lock);
1472 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1473 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001474 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001475 }
Al Viro72a43d62009-05-13 19:13:40 +01001476 break;
1477 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001478 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001479 spin_lock(&inode->i_lock);
Al Viroc2b6d622018-06-28 15:53:17 -04001480 inode->i_state |= I_NEW | I_CREATING;
Al Viro261bca82008-12-30 01:48:21 -05001481 hlist_add_head(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001482 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001483 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001484 return 0;
1485 }
Al Viroc2b6d622018-06-28 15:53:17 -04001486 if (unlikely(old->i_state & I_CREATING)) {
1487 spin_unlock(&old->i_lock);
1488 spin_unlock(&inode_hash_lock);
1489 return -EBUSY;
1490 }
Al Viro261bca82008-12-30 01:48:21 -05001491 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001492 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001493 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001494 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001495 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001496 iput(old);
1497 return -EBUSY;
1498 }
1499 iput(old);
1500 }
1501}
Al Viro261bca82008-12-30 01:48:21 -05001502EXPORT_SYMBOL(insert_inode_locked);
1503
1504int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1505 int (*test)(struct inode *, void *), void *data)
1506{
Al Viroc2b6d622018-06-28 15:53:17 -04001507 struct inode *old;
1508
1509 inode->i_state |= I_CREATING;
1510 old = inode_insert5(inode, hashval, test, NULL, data);
Al Viro261bca82008-12-30 01:48:21 -05001511
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001512 if (old != inode) {
Al Viro261bca82008-12-30 01:48:21 -05001513 iput(old);
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001514 return -EBUSY;
Al Viro261bca82008-12-30 01:48:21 -05001515 }
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02001516 return 0;
Al Viro261bca82008-12-30 01:48:21 -05001517}
Al Viro261bca82008-12-30 01:48:21 -05001518EXPORT_SYMBOL(insert_inode_locked4);
1519
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Al Viro45321ac2010-06-07 13:43:19 -04001521int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522{
Al Viro45321ac2010-06-07 13:43:19 -04001523 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525EXPORT_SYMBOL(generic_delete_inode);
1526
Al Viro45321ac2010-06-07 13:43:19 -04001527/*
Al Viro45321ac2010-06-07 13:43:19 -04001528 * Called when we're dropping the last reference
1529 * to an inode.
1530 *
1531 * Call the FS "drop_inode()" function, defaulting to
1532 * the legacy UNIX filesystem behaviour. If it tells
1533 * us to evict inode, do so. Otherwise, retain inode
1534 * in cache if fs is alive, sync and evict if fs is
1535 * shutting down.
1536 */
1537static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538{
1539 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001540 const struct super_operations *op = inode->i_sb->s_op;
1541 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Dave Chinner250df6e2011-03-22 22:23:36 +11001543 WARN_ON(inode->i_state & I_NEW);
1544
Al Viroe7f59092011-07-07 15:45:59 -04001545 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001546 drop = op->drop_inode(inode);
1547 else
1548 drop = generic_drop_inode(inode);
1549
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001550 if (!drop && (sb->s_flags & SB_ACTIVE)) {
Jan Kara4eff96d2012-11-26 16:29:51 -08001551 inode_add_lru(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001552 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001553 return;
1554 }
1555
Al Viro45321ac2010-06-07 13:43:19 -04001556 if (!drop) {
Alexander Viro991114c2005-06-23 00:09:01 -07001557 inode->i_state |= I_WILL_FREE;
Dave Chinner250df6e2011-03-22 22:23:36 +11001558 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 write_inode_now(inode, 1);
Dave Chinner250df6e2011-03-22 22:23:36 +11001560 spin_lock(&inode->i_lock);
Nick Piggin7ef0d732009-03-12 14:31:38 -07001561 WARN_ON(inode->i_state & I_NEW);
Alexander Viro991114c2005-06-23 00:09:01 -07001562 inode->i_state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001564
Alexander Viro991114c2005-06-23 00:09:01 -07001565 inode->i_state |= I_FREEING;
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001566 if (!list_empty(&inode->i_lru))
1567 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001568 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001569
1570 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571}
1572
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301574 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 * @inode: inode to put
1576 *
1577 * Puts an inode, dropping its usage count. If the inode use count hits
1578 * zero, the inode is then freed and may also be destroyed.
1579 *
1580 * Consequently, iput() can sleep.
1581 */
1582void iput(struct inode *inode)
1583{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001584 if (!inode)
1585 return;
1586 BUG_ON(inode->i_state & I_CLEAR);
1587retry:
1588 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1589 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1590 atomic_inc(&inode->i_count);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001591 spin_unlock(&inode->i_lock);
1592 trace_writeback_lazytime_iput(inode);
1593 mark_inode_dirty_sync(inode);
1594 goto retry;
1595 }
1596 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 }
1598}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599EXPORT_SYMBOL(iput);
1600
1601/**
1602 * bmap - find a block number in a file
1603 * @inode: inode of file
1604 * @block: block to find
1605 *
1606 * Returns the block number on the device holding the inode that
1607 * is the disk block number for the block of the file requested.
1608 * That is, asked for block 4 of inode 1 the function will return the
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301609 * disk block relative to the disk start that holds that block of the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 * file.
1611 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301612sector_t bmap(struct inode *inode, sector_t block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613{
1614 sector_t res = 0;
1615 if (inode->i_mapping->a_ops->bmap)
1616 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1617 return res;
1618}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619EXPORT_SYMBOL(bmap);
1620
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001621/*
1622 * With relative atime, only update atime if the previous atime is
1623 * earlier than either the ctime or mtime or if at least a day has
1624 * passed since the last atime update.
1625 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001626static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001627 struct timespec64 now)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001628{
1629
Miklos Szeredic6718542018-07-18 15:44:43 +02001630 if (!(mnt->mnt_flags & MNT_RELATIME))
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001631 return 1;
1632 /*
1633 * Is mtime younger than atime? If yes, update atime:
1634 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001635 if (timespec64_compare(&inode->i_mtime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001636 return 1;
1637 /*
1638 * Is ctime younger than atime? If yes, update atime:
1639 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001640 if (timespec64_compare(&inode->i_ctime, &inode->i_atime) >= 0)
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001641 return 1;
1642
1643 /*
1644 * Is the previous atime value older than a day? If yes,
1645 * update atime:
1646 */
1647 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1648 return 1;
1649 /*
1650 * Good, we can skip the atime update:
1651 */
1652 return 0;
1653}
1654
Deepa Dinamani95582b02018-05-08 19:36:02 -07001655int generic_update_time(struct inode *inode, struct timespec64 *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001656{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001657 int iflags = I_DIRTY_TIME;
Jeff Laytone38cf302017-12-11 06:35:22 -05001658 bool dirty = false;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001659
1660 if (flags & S_ATIME)
1661 inode->i_atime = *time;
1662 if (flags & S_VERSION)
Jeff Laytone38cf302017-12-11 06:35:22 -05001663 dirty = inode_maybe_inc_iversion(inode, false);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001664 if (flags & S_CTIME)
1665 inode->i_ctime = *time;
1666 if (flags & S_MTIME)
1667 inode->i_mtime = *time;
Jeff Laytone38cf302017-12-11 06:35:22 -05001668 if ((flags & (S_ATIME | S_CTIME | S_MTIME)) &&
1669 !(inode->i_sb->s_flags & SB_LAZYTIME))
1670 dirty = true;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001671
Jeff Laytone38cf302017-12-11 06:35:22 -05001672 if (dirty)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001673 iflags |= I_DIRTY_SYNC;
1674 __mark_inode_dirty(inode, iflags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001675 return 0;
1676}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001677EXPORT_SYMBOL(generic_update_time);
1678
1679/*
1680 * This does the actual work of updating an inodes time or version. Must have
1681 * had called mnt_want_write() before calling this.
1682 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07001683static int update_time(struct inode *inode, struct timespec64 *time, int flags)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001684{
Deepa Dinamani95582b02018-05-08 19:36:02 -07001685 int (*update_time)(struct inode *, struct timespec64 *, int);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001686
1687 update_time = inode->i_op->update_time ? inode->i_op->update_time :
1688 generic_update_time;
1689
1690 return update_time(inode, time, flags);
1691}
Josef Bacikc3b2da32012-03-26 09:59:21 -04001692
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693/**
Christoph Hellwig869243a2006-01-09 20:52:03 -08001694 * touch_atime - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001695 * @path: the &struct path to update
Randy Dunlap30fdc8e2015-11-09 14:57:58 -08001696 * @inode: inode to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 *
1698 * Update the accessed time on an inode and mark it for writeback.
1699 * This function automatically handles read only file systems and media,
1700 * as well as the "noatime" flag and inode specific "noatime" markers.
1701 */
Miklos Szeredic6718542018-07-18 15:44:43 +02001702bool atime_needs_update(const struct path *path, struct inode *inode)
NeilBrown8fa9dd22015-03-23 13:37:40 +11001703{
1704 struct vfsmount *mnt = path->mnt;
Deepa Dinamani95582b02018-05-08 19:36:02 -07001705 struct timespec64 now;
NeilBrown8fa9dd22015-03-23 13:37:40 +11001706
1707 if (inode->i_flags & S_NOATIME)
1708 return false;
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001709
1710 /* Atime updates will likely cause i_uid and i_gid to be written
1711 * back improprely if their true value is unknown to the vfs.
1712 */
1713 if (HAS_UNMAPPED_ID(inode))
1714 return false;
1715
NeilBrown8fa9dd22015-03-23 13:37:40 +11001716 if (IS_NOATIME(inode))
1717 return false;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001718 if ((inode->i_sb->s_flags & SB_NODIRATIME) && S_ISDIR(inode->i_mode))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001719 return false;
1720
1721 if (mnt->mnt_flags & MNT_NOATIME)
1722 return false;
1723 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1724 return false;
1725
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001726 now = current_time(inode);
NeilBrown8fa9dd22015-03-23 13:37:40 +11001727
Arnd Bergmann6f22b662019-04-26 16:50:41 +02001728 if (!relatime_need_update(mnt, inode, now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001729 return false;
1730
Deepa Dinamani95582b02018-05-08 19:36:02 -07001731 if (timespec64_equal(&inode->i_atime, &now))
NeilBrown8fa9dd22015-03-23 13:37:40 +11001732 return false;
1733
1734 return true;
1735}
1736
Al Virobadcf2b2013-07-16 18:15:46 +04001737void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738{
Al Viro68ac1232012-03-15 08:21:57 -04001739 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001740 struct inode *inode = d_inode(path->dentry);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001741 struct timespec64 now;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742
Miklos Szeredic6718542018-07-18 15:44:43 +02001743 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001744 return;
1745
Jan Kara5d37e9e2012-06-12 16:20:36 +02001746 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001747 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001748
NeilBrown8fa9dd22015-03-23 13:37:40 +11001749 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001750 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001751 /*
1752 * File systems can error out when updating inodes if they need to
1753 * allocate new space to modify an inode (such is the case for
1754 * Btrfs), but since we touch atime while walking down the path we
1755 * really don't care if we failed to update the atime of the file,
1756 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001757 * We may also fail on filesystems that have the ability to make parts
1758 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001759 */
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001760 now = current_time(inode);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001761 update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001762 __mnt_drop_write(mnt);
1763skip_update:
1764 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001766EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767
Cong Wang3ed37642012-05-15 14:57:33 +08001768/*
1769 * The logic we want is
1770 *
1771 * if suid or (sgid and xgrp)
1772 * remove privs
1773 */
1774int should_remove_suid(struct dentry *dentry)
1775{
David Howellsdf2b1af2015-03-17 22:26:15 +00001776 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001777 int kill = 0;
1778
1779 /* suid always must be killed */
1780 if (unlikely(mode & S_ISUID))
1781 kill = ATTR_KILL_SUID;
1782
1783 /*
1784 * sgid without any exec bits is just a mandatory locking mark; leave
1785 * it alone. If some exec bits are set, it's a real sgid; kill it.
1786 */
1787 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1788 kill |= ATTR_KILL_SGID;
1789
1790 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1791 return kill;
1792
1793 return 0;
1794}
1795EXPORT_SYMBOL(should_remove_suid);
1796
Jan Karadbfae0c2015-05-21 16:05:54 +02001797/*
1798 * Return mask of changes for notify_change() that need to be done as a
1799 * response to write or truncate. Return 0 if nothing has to be changed.
1800 * Negative value on error (change should be denied).
1801 */
Jan Kara45f147a2015-05-21 16:05:55 +02001802int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001803{
Jan Karadbfae0c2015-05-21 16:05:54 +02001804 struct inode *inode = d_inode(dentry);
1805 int mask = 0;
1806 int ret;
1807
1808 if (IS_NOSEC(inode))
1809 return 0;
1810
1811 mask = should_remove_suid(dentry);
1812 ret = security_inode_need_killpriv(dentry);
1813 if (ret < 0)
1814 return ret;
1815 if (ret)
1816 mask |= ATTR_KILL_PRIV;
1817 return mask;
1818}
Jan Karadbfae0c2015-05-21 16:05:54 +02001819
1820static int __remove_privs(struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001821{
1822 struct iattr newattrs;
1823
1824 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001825 /*
1826 * Note we call this on write, so notify_change will not
1827 * encounter any conflicting delegations:
1828 */
1829 return notify_change(dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001830}
1831
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001832/*
1833 * Remove special file priviledges (suid, capabilities) when file is written
1834 * to or truncated.
1835 */
1836int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001837{
Miklos Szeredic1892c32016-08-03 13:44:27 +02001838 struct dentry *dentry = file_dentry(file);
1839 struct inode *inode = file_inode(file);
Jan Karadbfae0c2015-05-21 16:05:54 +02001840 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001841 int error = 0;
1842
Alexander Lochmannf69e7492018-12-14 11:55:52 +01001843 /*
1844 * Fast path for nothing security related.
1845 * As well for non-regular files, e.g. blkdev inodes.
1846 * For example, blkdev_write_iter() might get here
1847 * trying to remove privs which it is not allowed to.
1848 */
1849 if (IS_NOSEC(inode) || !S_ISREG(inode->i_mode))
Cong Wang3ed37642012-05-15 14:57:33 +08001850 return 0;
1851
Miklos Szeredic1892c32016-08-03 13:44:27 +02001852 kill = dentry_needs_remove_privs(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001853 if (kill < 0)
1854 return kill;
1855 if (kill)
1856 error = __remove_privs(dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001857 if (!error)
1858 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001859
1860 return error;
1861}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001862EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001863
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001865 * file_update_time - update mtime and ctime time
1866 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001868 * Update the mtime and ctime members of an inode and mark the inode
1869 * for writeback. Note that this function is meant exclusively for
1870 * usage in the file write path of filesystems, and filesystems may
1871 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001872 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001873 * timestamps are handled by the server. This can return an error for
1874 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 */
1876
Josef Bacikc3b2da32012-03-26 09:59:21 -04001877int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878{
Al Viro496ad9a2013-01-23 17:07:38 -05001879 struct inode *inode = file_inode(file);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001880 struct timespec64 now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001881 int sync_it = 0;
1882 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883
Andi Kleence06e0b2009-09-18 13:05:48 -07001884 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001886 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001887
Deepa Dinamanic2050a42016-09-14 07:48:06 -07001888 now = current_time(inode);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001889 if (!timespec64_equal(&inode->i_mtime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001890 sync_it = S_MTIME;
1891
Deepa Dinamani95582b02018-05-08 19:36:02 -07001892 if (!timespec64_equal(&inode->i_ctime, &now))
Andi Kleence06e0b2009-09-18 13:05:48 -07001893 sync_it |= S_CTIME;
1894
Jeff Laytone38cf302017-12-11 06:35:22 -05001895 if (IS_I_VERSION(inode) && inode_iversion_need_inc(inode))
Andi Kleence06e0b2009-09-18 13:05:48 -07001896 sync_it |= S_VERSION;
1897
1898 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001899 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900
Andi Kleence06e0b2009-09-18 13:05:48 -07001901 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02001902 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001903 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904
Josef Bacikc3b2da32012-03-26 09:59:21 -04001905 ret = update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02001906 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001907
1908 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909}
Christoph Hellwig870f4812006-01-09 20:52:01 -08001910EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911
Amir Goldsteine38f7f52019-06-05 08:04:49 -07001912/* Caller must hold the file's inode lock */
1913int file_modified(struct file *file)
1914{
1915 int err;
1916
1917 /*
1918 * Clear the security bits if the process is not being run by root.
1919 * This keeps people from modifying setuid and setgid binaries.
1920 */
1921 err = file_remove_privs(file);
1922 if (err)
1923 return err;
1924
1925 if (unlikely(file->f_mode & FMODE_NOCMTIME))
1926 return 0;
1927
1928 return file_update_time(file);
1929}
1930EXPORT_SYMBOL(file_modified);
1931
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932int inode_needs_sync(struct inode *inode)
1933{
1934 if (IS_SYNC(inode))
1935 return 1;
1936 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1937 return 1;
1938 return 0;
1939}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940EXPORT_SYMBOL(inode_needs_sync);
1941
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07001943 * If we try to find an inode in the inode hash while it is being
1944 * deleted, we have to wait until the filesystem completes its
1945 * deletion before reporting that it isn't found. This function waits
1946 * until the deletion _might_ have completed. Callers are responsible
1947 * to recheck inode state.
1948 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001949 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11001950 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
1951 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 */
1953static void __wait_on_freeing_inode(struct inode *inode)
1954{
1955 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001956 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1957 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Ingo Molnar21417132017-03-05 11:25:39 +01001958 prepare_to_wait(wq, &wait.wq_entry, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001959 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001960 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 schedule();
Ingo Molnar21417132017-03-05 11:25:39 +01001962 finish_wait(wq, &wait.wq_entry);
Dave Chinner67a23c42011-03-22 22:23:42 +11001963 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964}
1965
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966static __initdata unsigned long ihash_entries;
1967static int __init set_ihash_entries(char *str)
1968{
1969 if (!str)
1970 return 0;
1971 ihash_entries = simple_strtoul(str, &str, 0);
1972 return 1;
1973}
1974__setup("ihash_entries=", set_ihash_entries);
1975
1976/*
1977 * Initialize the waitqueues and inode hash table.
1978 */
1979void __init inode_init_early(void)
1980{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 /* If hashes are distributed across NUMA nodes, defer
1982 * hash allocation until vmalloc space is available.
1983 */
1984 if (hashdist)
1985 return;
1986
1987 inode_hashtable =
1988 alloc_large_system_hash("Inode-cache",
1989 sizeof(struct hlist_head),
1990 ihash_entries,
1991 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07001992 HASH_EARLY | HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 &i_hash_shift,
1994 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00001995 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997}
1998
Denis Cheng74bf17c2007-10-16 23:26:30 -07001999void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08002002 inode_cachep = kmem_cache_create("inode_cache",
2003 sizeof(struct inode),
2004 0,
2005 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
Vladimir Davydov5d097052016-01-14 15:18:21 -08002006 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
Paul Mundt20c2df82007-07-20 10:11:58 +09002007 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008
2009 /* Hash may have been set up in inode_init_early */
2010 if (!hashdist)
2011 return;
2012
2013 inode_hashtable =
2014 alloc_large_system_hash("Inode-cache",
2015 sizeof(struct hlist_head),
2016 ihash_entries,
2017 14,
Pavel Tatashin3d375d72017-07-06 15:39:11 -07002018 HASH_ZERO,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 &i_hash_shift,
2020 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00002021 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023}
2024
2025void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
2026{
2027 inode->i_mode = mode;
2028 if (S_ISCHR(mode)) {
2029 inode->i_fop = &def_chr_fops;
2030 inode->i_rdev = rdev;
2031 } else if (S_ISBLK(mode)) {
2032 inode->i_fop = &def_blk_fops;
2033 inode->i_rdev = rdev;
2034 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04002035 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05002037 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07002039 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
2040 " inode %s:%lu\n", mode, inode->i_sb->s_id,
2041 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042}
2043EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002044
2045/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00002046 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002047 * @inode: New inode
2048 * @dir: Directory inode
2049 * @mode: mode of the new inode
2050 */
2051void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04002052 umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002053{
2054 inode->i_uid = current_fsuid();
2055 if (dir && dir->i_mode & S_ISGID) {
2056 inode->i_gid = dir->i_gid;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002057
2058 /* Directories are special, and always inherit S_ISGID */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002059 if (S_ISDIR(mode))
2060 mode |= S_ISGID;
Linus Torvalds0fa3ecd2018-07-03 17:10:19 -07002061 else if ((mode & (S_ISGID | S_IXGRP)) == (S_ISGID | S_IXGRP) &&
2062 !in_group_p(inode->i_gid) &&
2063 !capable_wrt_inode_uidgid(dir, CAP_FSETID))
2064 mode &= ~S_ISGID;
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03002065 } else
2066 inode->i_gid = current_fsgid();
2067 inode->i_mode = mode;
2068}
2069EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07002070
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002071/**
2072 * inode_owner_or_capable - check current task permissions to inode
2073 * @inode: inode being checked
2074 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002075 * Return true if current either has CAP_FOWNER in a namespace with the
2076 * inode owner uid mapped, or owns the file.
Serge E. Hallyne795b712011-03-23 16:43:25 -07002077 */
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002078bool inode_owner_or_capable(const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07002079{
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002080 struct user_namespace *ns;
2081
Eric W. Biederman92361632012-02-08 07:07:50 -08002082 if (uid_eq(current_fsuid(), inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002083 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07002084
2085 ns = current_user_ns();
Kees Cookcc658db2017-06-21 09:53:06 -07002086 if (kuid_has_mapping(ns, inode->i_uid) && ns_capable(ns, CAP_FOWNER))
Serge E. Hallyne795b712011-03-23 16:43:25 -07002087 return true;
2088 return false;
2089}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07002090EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002091
2092/*
2093 * Direct i/o helper functions
2094 */
2095static void __inode_dio_wait(struct inode *inode)
2096{
2097 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
2098 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
2099
2100 do {
Ingo Molnar21417132017-03-05 11:25:39 +01002101 prepare_to_wait(wq, &q.wq_entry, TASK_UNINTERRUPTIBLE);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002102 if (atomic_read(&inode->i_dio_count))
2103 schedule();
2104 } while (atomic_read(&inode->i_dio_count));
Ingo Molnar21417132017-03-05 11:25:39 +01002105 finish_wait(wq, &q.wq_entry);
Trond Myklebust1d59d612012-05-31 12:22:33 -04002106}
2107
2108/**
2109 * inode_dio_wait - wait for outstanding DIO requests to finish
2110 * @inode: inode to wait for
2111 *
2112 * Waits for all pending direct I/O requests to finish so that we can
2113 * proceed with a truncate or equivalent operation.
2114 *
2115 * Must be called under a lock that serializes taking new references
2116 * to i_dio_count, usually by inode->i_mutex.
2117 */
2118void inode_dio_wait(struct inode *inode)
2119{
2120 if (atomic_read(&inode->i_dio_count))
2121 __inode_dio_wait(inode);
2122}
2123EXPORT_SYMBOL(inode_dio_wait);
2124
2125/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002126 * inode_set_flags - atomically set some inode flags
2127 *
2128 * Note: the caller should be holding i_mutex, or else be sure that
2129 * they have exclusive access to the inode structure (i.e., while the
2130 * inode is being instantiated). The reason for the cmpxchg() loop
2131 * --- which wouldn't be necessary if all code paths which modify
2132 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002133 * code path which doesn't today so we use cmpxchg() out of an abundance
2134 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002135 *
2136 * In the long run, i_mutex is overkill, and we should probably look
2137 * at using the i_lock spinlock to protect i_flags, and then make sure
2138 * it is so documented in include/linux/fs.h and that all code follows
2139 * the locking convention!!
2140 */
2141void inode_set_flags(struct inode *inode, unsigned int flags,
2142 unsigned int mask)
2143{
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002144 WARN_ON_ONCE(flags & ~mask);
Vineet Guptaa9057372019-03-05 15:41:52 -08002145 set_mask_bits(&inode->i_flags, mask, flags);
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002146}
2147EXPORT_SYMBOL(inode_set_flags);
Al Viro21fc61c2015-11-17 01:07:57 -05002148
2149void inode_nohighmem(struct inode *inode)
2150{
2151 mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2152}
2153EXPORT_SYMBOL(inode_nohighmem);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002154
2155/**
Deepa Dinamani8efd6892018-04-22 20:18:46 -07002156 * timespec64_trunc - Truncate timespec64 to a granularity
2157 * @t: Timespec64
2158 * @gran: Granularity in ns.
2159 *
2160 * Truncate a timespec64 to a granularity. Always rounds down. gran must
2161 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2162 */
2163struct timespec64 timespec64_trunc(struct timespec64 t, unsigned gran)
2164{
2165 /* Avoid division in the common cases 1 ns and 1 s. */
2166 if (gran == 1) {
2167 /* nothing */
2168 } else if (gran == NSEC_PER_SEC) {
2169 t.tv_nsec = 0;
2170 } else if (gran > 1 && gran < NSEC_PER_SEC) {
2171 t.tv_nsec -= t.tv_nsec % gran;
2172 } else {
2173 WARN(1, "illegal file time granularity: %u", gran);
2174 }
2175 return t;
2176}
2177EXPORT_SYMBOL(timespec64_trunc);
2178
2179/**
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002180 * timestamp_truncate - Truncate timespec to a granularity
2181 * @t: Timespec
2182 * @inode: inode being updated
2183 *
2184 * Truncate a timespec to the granularity supported by the fs
2185 * containing the inode. Always rounds down. gran must
2186 * not be 0 nor greater than a second (NSEC_PER_SEC, or 10^9 ns).
2187 */
2188struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode)
2189{
2190 struct super_block *sb = inode->i_sb;
2191 unsigned int gran = sb->s_time_gran;
2192
2193 t.tv_sec = clamp(t.tv_sec, sb->s_time_min, sb->s_time_max);
2194 if (unlikely(t.tv_sec == sb->s_time_max || t.tv_sec == sb->s_time_min))
2195 t.tv_nsec = 0;
2196
2197 /* Avoid division in the common cases 1 ns and 1 s. */
2198 if (gran == 1)
2199 ; /* nothing */
2200 else if (gran == NSEC_PER_SEC)
2201 t.tv_nsec = 0;
2202 else if (gran > 1 && gran < NSEC_PER_SEC)
2203 t.tv_nsec -= t.tv_nsec % gran;
2204 else
2205 WARN(1, "invalid file time granularity: %u", gran);
2206 return t;
2207}
2208EXPORT_SYMBOL(timestamp_truncate);
2209
2210/**
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002211 * current_time - Return FS time
2212 * @inode: inode.
2213 *
2214 * Return the current time truncated to the time granularity supported by
2215 * the fs.
2216 *
2217 * Note that inode and inode->sb cannot be NULL.
2218 * Otherwise, the function warns and returns time without truncation.
2219 */
Deepa Dinamani95582b02018-05-08 19:36:02 -07002220struct timespec64 current_time(struct inode *inode)
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002221{
Arnd Bergmannd651d162018-12-05 11:14:27 +11002222 struct timespec64 now;
2223
2224 ktime_get_coarse_real_ts64(&now);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002225
2226 if (unlikely(!inode->i_sb)) {
2227 WARN(1, "current_time() called with uninitialized super_block in the inode");
2228 return now;
2229 }
2230
Deepa Dinamani50e17c002018-01-21 18:04:25 -08002231 return timestamp_truncate(now, inode);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07002232}
2233EXPORT_SYMBOL(current_time);
Darrick J. Wong5aca2842019-07-01 08:25:34 -07002234
2235/*
2236 * Generic function to check FS_IOC_SETFLAGS values and reject any invalid
2237 * configurations.
2238 *
2239 * Note: the caller should be holding i_mutex, or else be sure that they have
2240 * exclusive access to the inode structure.
2241 */
2242int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
2243 unsigned int flags)
2244{
2245 /*
2246 * The IMMUTABLE and APPEND_ONLY flags can only be changed by
2247 * the relevant capability.
2248 *
2249 * This test looks nicer. Thanks to Pauline Middelink
2250 */
2251 if ((flags ^ oldflags) & (FS_APPEND_FL | FS_IMMUTABLE_FL) &&
2252 !capable(CAP_LINUX_IMMUTABLE))
2253 return -EPERM;
2254
2255 return 0;
2256}
2257EXPORT_SYMBOL(vfs_ioc_setflags_prepare);
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002258
2259/*
2260 * Generic function to check FS_IOC_FSSETXATTR values and reject any invalid
2261 * configurations.
2262 *
2263 * Note: the caller should be holding i_mutex, or else be sure that they have
2264 * exclusive access to the inode structure.
2265 */
2266int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
2267 struct fsxattr *fa)
2268{
2269 /*
2270 * Can't modify an immutable/append-only file unless we have
2271 * appropriate permission.
2272 */
2273 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2274 (FS_XFLAG_IMMUTABLE | FS_XFLAG_APPEND) &&
2275 !capable(CAP_LINUX_IMMUTABLE))
2276 return -EPERM;
2277
Darrick J. Wongf9914922019-07-01 08:25:35 -07002278 /*
2279 * Project Quota ID state is only allowed to change from within the init
2280 * namespace. Enforce that restriction only if we are trying to change
2281 * the quota ID state. Everything else is allowed in user namespaces.
2282 */
2283 if (current_user_ns() != &init_user_ns) {
2284 if (old_fa->fsx_projid != fa->fsx_projid)
2285 return -EINVAL;
2286 if ((old_fa->fsx_xflags ^ fa->fsx_xflags) &
2287 FS_XFLAG_PROJINHERIT)
2288 return -EINVAL;
2289 }
2290
Darrick J. Wongca29be72019-07-01 08:25:36 -07002291 /* Check extent size hints. */
2292 if ((fa->fsx_xflags & FS_XFLAG_EXTSIZE) && !S_ISREG(inode->i_mode))
2293 return -EINVAL;
2294
2295 if ((fa->fsx_xflags & FS_XFLAG_EXTSZINHERIT) &&
2296 !S_ISDIR(inode->i_mode))
2297 return -EINVAL;
2298
2299 if ((fa->fsx_xflags & FS_XFLAG_COWEXTSIZE) &&
2300 !S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
2301 return -EINVAL;
2302
Darrick J. Wongdbc77f32019-07-01 08:25:36 -07002303 /*
2304 * It is only valid to set the DAX flag on regular files and
2305 * directories on filesystems.
2306 */
2307 if ((fa->fsx_xflags & FS_XFLAG_DAX) &&
2308 !(S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode)))
2309 return -EINVAL;
2310
Darrick J. Wongca29be72019-07-01 08:25:36 -07002311 /* Extent size hints of zero turn off the flags. */
2312 if (fa->fsx_extsize == 0)
2313 fa->fsx_xflags &= ~(FS_XFLAG_EXTSIZE | FS_XFLAG_EXTSZINHERIT);
2314 if (fa->fsx_cowextsize == 0)
2315 fa->fsx_xflags &= ~FS_XFLAG_COWEXTSIZE;
2316
Darrick J. Wong7b0e4922019-07-01 08:25:35 -07002317 return 0;
2318}
2319EXPORT_SYMBOL(vfs_ioc_fssetxattr_check);