blob: f09148e071983a2901302fe1bfd63b367f93dc1d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * (C) 1997 Linus Torvalds
Christoph Hellwig4b4563d2011-05-27 09:28:01 -04003 * (C) 1999 Andrea Arcangeli <andrea@suse.de> (dynamic inode allocation)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 */
Al Viroe59cc472011-12-07 13:17:19 -05005#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/fs.h>
7#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/hash.h>
10#include <linux/swap.h>
11#include <linux/security.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/cdev.h>
13#include <linux/bootmem.h>
Eric Paris3be25f42009-05-21 17:01:26 -040014#include <linux/fsnotify.h>
Christoph Hellwigfc33a7b2006-01-09 20:52:17 -080015#include <linux/mount.h>
Al Virof19d4a82009-06-08 19:50:45 -040016#include <linux/posix_acl.h>
Heiko Carstens9ce6e0b2011-05-22 18:54:21 +020017#include <linux/prefetch.h>
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040018#include <linux/buffer_head.h> /* for inode_has_buffers */
Miklos Szeredi7ada4db2011-11-21 12:11:32 +010019#include <linux/ratelimit.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100020#include <linux/list_lru.h>
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050021#include <trace/events/writeback.h>
Dave Chinnera66979a2011-03-22 22:23:41 +110022#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24/*
Christoph Hellwig4b4563d2011-05-27 09:28:01 -040025 * Inode locking rules:
Dave Chinner250df6e2011-03-22 22:23:36 +110026 *
27 * inode->i_lock protects:
28 * inode->i_state, inode->i_hash, __iget()
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100029 * Inode LRU list locks protect:
Dave Chinner98b745c2011-07-08 14:14:39 +100030 * inode->i_sb->s_inode_lru, inode->i_lru
Dave Chinner74278da2015-03-04 12:37:22 -050031 * inode->i_sb->s_inode_list_lock protects:
32 * inode->i_sb->s_inodes, inode->i_sb_list
Christoph Hellwigf758eea2011-04-21 18:19:44 -060033 * bdi->wb.list_lock protects:
Dave Chinnerc7f54082015-03-04 14:07:22 -050034 * bdi->wb.b_{dirty,io,more_io,dirty_time}, inode->i_io_list
Dave Chinner67a23c42011-03-22 22:23:42 +110035 * inode_hash_lock protects:
36 * inode_hashtable, inode->i_hash
Dave Chinner250df6e2011-03-22 22:23:36 +110037 *
38 * Lock ordering:
Dave Chinner55fa6092011-03-22 22:23:40 +110039 *
Dave Chinner74278da2015-03-04 12:37:22 -050040 * inode->i_sb->s_inode_list_lock
Dave Chinner55fa6092011-03-22 22:23:40 +110041 * inode->i_lock
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100042 * Inode LRU list locks
Dave Chinnera66979a2011-03-22 22:23:41 +110043 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060044 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110045 * inode->i_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110046 *
47 * inode_hash_lock
Dave Chinner74278da2015-03-04 12:37:22 -050048 * inode->i_sb->s_inode_list_lock
Dave Chinner67a23c42011-03-22 22:23:42 +110049 * inode->i_lock
50 *
51 * iunique_lock
52 * inode_hash_lock
Dave Chinner250df6e2011-03-22 22:23:36 +110053 */
54
Eric Dumazetfa3536c2006-03-26 01:37:24 -080055static unsigned int i_hash_mask __read_mostly;
56static unsigned int i_hash_shift __read_mostly;
Dave Chinner67a23c42011-03-22 22:23:42 +110057static struct hlist_head *inode_hashtable __read_mostly;
58static __cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Linus Torvalds1da177e2005-04-16 15:20:36 -070060/*
Jens Axboe7dcda1c2011-04-05 23:51:48 +020061 * Empty aops. Can be used for the cases where the user does not
62 * define any of the address_space operations.
63 */
64const struct address_space_operations empty_aops = {
65};
66EXPORT_SYMBOL(empty_aops);
67
68/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 * Statistics gathering..
70 */
71struct inodes_stat_t inodes_stat;
72
Glauber Costa3942c072013-08-28 10:17:53 +100073static DEFINE_PER_CPU(unsigned long, nr_inodes);
74static DEFINE_PER_CPU(unsigned long, nr_unused);
Dave Chinnercffbc8a2010-10-23 05:03:02 -040075
Manish Katiyar6b3304b2009-03-31 19:35:54 +053076static struct kmem_cache *inode_cachep __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
Glauber Costa3942c072013-08-28 10:17:53 +100078static long get_nr_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040079{
Nick Piggin3e880fb2011-01-07 17:49:19 +110080 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100081 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +110082 for_each_possible_cpu(i)
83 sum += per_cpu(nr_inodes, i);
84 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040085}
86
Glauber Costa3942c072013-08-28 10:17:53 +100087static inline long get_nr_inodes_unused(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040088{
Dave Chinnerfcb94f72011-07-08 14:14:38 +100089 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100090 long sum = 0;
Dave Chinnerfcb94f72011-07-08 14:14:38 +100091 for_each_possible_cpu(i)
92 sum += per_cpu(nr_unused, i);
93 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040094}
95
Glauber Costa3942c072013-08-28 10:17:53 +100096long get_nr_dirty_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040097{
Nick Piggin3e880fb2011-01-07 17:49:19 +110098 /* not actually dirty inodes, but a wild approximation */
Glauber Costa3942c072013-08-28 10:17:53 +100099 long nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400100 return nr_dirty > 0 ? nr_dirty : 0;
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400101}
102
103/*
104 * Handle nr_inode sysctl
105 */
106#ifdef CONFIG_SYSCTL
Joe Perches1f7e0612014-06-06 14:38:05 -0700107int proc_nr_inodes(struct ctl_table *table, int write,
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400108 void __user *buffer, size_t *lenp, loff_t *ppos)
109{
110 inodes_stat.nr_inodes = get_nr_inodes();
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000111 inodes_stat.nr_unused = get_nr_inodes_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000112 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400113}
114#endif
115
Al Virobd9b51e2014-11-18 23:38:21 -0500116static int no_open(struct inode *inode, struct file *file)
117{
118 return -ENXIO;
119}
120
David Chinner2cb15992008-10-30 17:32:23 +1100121/**
122 * inode_init_always - perform inode structure intialisation
Randy Dunlap0bc02f32009-01-06 14:41:13 -0800123 * @sb: superblock inode belongs to
124 * @inode: inode to initialise
David Chinner2cb15992008-10-30 17:32:23 +1100125 *
126 * These are initializations that need to be done on every inode
127 * allocation as the fields are not initialised by slab allocation.
128 */
Christoph Hellwig54e34622009-08-07 14:38:25 -0300129int inode_init_always(struct super_block *sb, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
Alexey Dobriyan6e1d5dc2009-09-21 17:01:11 -0700131 static const struct inode_operations empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500132 static const struct file_operations no_open_fops = {.open = no_open};
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530133 struct address_space *const mapping = &inode->i_data;
David Chinner2cb15992008-10-30 17:32:23 +1100134
135 inode->i_sb = sb;
136 inode->i_blkbits = sb->s_blocksize_bits;
137 inode->i_flags = 0;
138 atomic_set(&inode->i_count, 1);
139 inode->i_op = &empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500140 inode->i_fop = &no_open_fops;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200141 inode->__i_nlink = 1;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700142 inode->i_opflags = 0;
Eric W. Biederman92361632012-02-08 07:07:50 -0800143 i_uid_write(inode, 0);
144 i_gid_write(inode, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100145 atomic_set(&inode->i_writecount, 0);
146 inode->i_size = 0;
147 inode->i_blocks = 0;
148 inode->i_bytes = 0;
149 inode->i_generation = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100150 inode->i_pipe = NULL;
151 inode->i_bdev = NULL;
152 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400153 inode->i_link = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100154 inode->i_rdev = 0;
155 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500156
157 if (security_inode_alloc(inode))
Christoph Hellwig54e34622009-08-07 14:38:25 -0300158 goto out;
David Chinner2cb15992008-10-30 17:32:23 +1100159 spin_lock_init(&inode->i_lock);
160 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
161
162 mutex_init(&inode->i_mutex);
163 lockdep_set_class(&inode->i_mutex, &sb->s_type->i_mutex_key);
164
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400165 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100166
167 mapping->a_ops = &empty_aops;
168 mapping->host = inode;
169 mapping->flags = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700170 atomic_set(&mapping->i_mmap_writable, 0);
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800171 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800172 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100173 mapping->writeback_index = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100174 inode->i_private = NULL;
175 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400176 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400177#ifdef CONFIG_FS_POSIX_ACL
178 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
179#endif
David Chinner2cb15992008-10-30 17:32:23 +1100180
Eric Paris3be25f42009-05-21 17:01:26 -0400181#ifdef CONFIG_FSNOTIFY
182 inode->i_fsnotify_mask = 0;
183#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500184 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100185 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400186
Christoph Hellwig54e34622009-08-07 14:38:25 -0300187 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300188out:
189 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100190}
191EXPORT_SYMBOL(inode_init_always);
192
193static struct inode *alloc_inode(struct super_block *sb)
194{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 struct inode *inode;
196
197 if (sb->s_op->alloc_inode)
198 inode = sb->s_op->alloc_inode(sb);
199 else
David Chinner2cb15992008-10-30 17:32:23 +1100200 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Christoph Hellwig54e34622009-08-07 14:38:25 -0300202 if (!inode)
203 return NULL;
204
205 if (unlikely(inode_init_always(sb, inode))) {
206 if (inode->i_sb->s_op->destroy_inode)
207 inode->i_sb->s_op->destroy_inode(inode);
208 else
209 kmem_cache_free(inode_cachep, inode);
210 return NULL;
211 }
212
213 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214}
215
Nick Pigginff0c7d12011-01-07 17:49:50 +1100216void free_inode_nonrcu(struct inode *inode)
217{
218 kmem_cache_free(inode_cachep, inode);
219}
220EXPORT_SYMBOL(free_inode_nonrcu);
221
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300222void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200224 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400225 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400227 fsnotify_inode_delete(inode);
Jeff Layton4a075e32015-01-16 15:05:54 -0500228 locks_free_lock_context(inode->i_flctx);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100229 if (!inode->i_nlink) {
230 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
231 atomic_long_dec(&inode->i_sb->s_remove_count);
232 }
233
Al Virof19d4a82009-06-08 19:50:45 -0400234#ifdef CONFIG_FS_POSIX_ACL
235 if (inode->i_acl && inode->i_acl != ACL_NOT_CACHED)
236 posix_acl_release(inode->i_acl);
237 if (inode->i_default_acl && inode->i_default_acl != ACL_NOT_CACHED)
238 posix_acl_release(inode->i_default_acl);
239#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100240 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300241}
242EXPORT_SYMBOL(__destroy_inode);
243
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100244static void i_callback(struct rcu_head *head)
245{
246 struct inode *inode = container_of(head, struct inode, i_rcu);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100247 kmem_cache_free(inode_cachep, inode);
248}
249
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200250static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300251{
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100252 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300253 __destroy_inode(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 if (inode->i_sb->s_op->destroy_inode)
255 inode->i_sb->s_op->destroy_inode(inode);
256 else
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100257 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100260/**
261 * drop_nlink - directly drop an inode's link count
262 * @inode: inode
263 *
264 * This is a low-level filesystem helper to replace any
265 * direct filesystem manipulation of i_nlink. In cases
266 * where we are attempting to track writes to the
267 * filesystem, a decrement to zero means an imminent
268 * write when the file is truncated and actually unlinked
269 * on the filesystem.
270 */
271void drop_nlink(struct inode *inode)
272{
273 WARN_ON(inode->i_nlink == 0);
274 inode->__i_nlink--;
275 if (!inode->i_nlink)
276 atomic_long_inc(&inode->i_sb->s_remove_count);
277}
278EXPORT_SYMBOL(drop_nlink);
279
280/**
281 * clear_nlink - directly zero an inode's link count
282 * @inode: inode
283 *
284 * This is a low-level filesystem helper to replace any
285 * direct filesystem manipulation of i_nlink. See
286 * drop_nlink() for why we care about i_nlink hitting zero.
287 */
288void clear_nlink(struct inode *inode)
289{
290 if (inode->i_nlink) {
291 inode->__i_nlink = 0;
292 atomic_long_inc(&inode->i_sb->s_remove_count);
293 }
294}
295EXPORT_SYMBOL(clear_nlink);
296
297/**
298 * set_nlink - directly set an inode's link count
299 * @inode: inode
300 * @nlink: new nlink (should be non-zero)
301 *
302 * This is a low-level filesystem helper to replace any
303 * direct filesystem manipulation of i_nlink.
304 */
305void set_nlink(struct inode *inode, unsigned int nlink)
306{
307 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100308 clear_nlink(inode);
309 } else {
310 /* Yes, some filesystems do change nlink from zero to one */
311 if (inode->i_nlink == 0)
312 atomic_long_dec(&inode->i_sb->s_remove_count);
313
314 inode->__i_nlink = nlink;
315 }
316}
317EXPORT_SYMBOL(set_nlink);
318
319/**
320 * inc_nlink - directly increment an inode's link count
321 * @inode: inode
322 *
323 * This is a low-level filesystem helper to replace any
324 * direct filesystem manipulation of i_nlink. Currently,
325 * it is only here for parity with dec_nlink().
326 */
327void inc_nlink(struct inode *inode)
328{
Al Virof4e0c302013-06-11 08:34:36 +0400329 if (unlikely(inode->i_nlink == 0)) {
330 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100331 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400332 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100333
334 inode->__i_nlink++;
335}
336EXPORT_SYMBOL(inc_nlink);
337
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100338void address_space_init_once(struct address_space *mapping)
339{
340 memset(mapping, 0, sizeof(*mapping));
341 INIT_RADIX_TREE(&mapping->page_tree, GFP_ATOMIC);
342 spin_lock_init(&mapping->tree_lock);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800343 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100344 INIT_LIST_HEAD(&mapping->private_list);
345 spin_lock_init(&mapping->private_lock);
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -0700346 mapping->i_mmap = RB_ROOT;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100347}
348EXPORT_SYMBOL(address_space_init_once);
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350/*
351 * These are initializations that only need to be done
352 * once, because the fields are idempotent across use
353 * of the inode, so let the slab aware of that.
354 */
355void inode_init_once(struct inode *inode)
356{
357 memset(inode, 0, sizeof(*inode));
358 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 INIT_LIST_HEAD(&inode->i_devices);
Dave Chinnerc7f54082015-03-04 14:07:22 -0500360 INIT_LIST_HEAD(&inode->i_io_list);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100361 INIT_LIST_HEAD(&inode->i_lru);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100362 address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 i_size_ordered_init(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400364#ifdef CONFIG_FSNOTIFY
Eric Parise61ce862009-12-17 21:24:24 -0500365 INIT_HLIST_HEAD(&inode->i_fsnotify_marks);
Eric Paris3be25f42009-05-21 17:01:26 -0400366#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368EXPORT_SYMBOL(inode_init_once);
369
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700370static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530372 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
Christoph Lametera35afb82007-05-16 22:10:57 -0700374 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375}
376
377/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100378 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530380void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381{
Nick Piggin9e38d862010-10-23 06:55:17 -0400382 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383}
384
Al Viro7de9c6ee2010-10-23 11:11:40 -0400385/*
386 * get additional reference to inode; caller must already hold one.
387 */
388void ihold(struct inode *inode)
389{
390 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
391}
392EXPORT_SYMBOL(ihold);
393
Nick Piggin9e38d862010-10-23 06:55:17 -0400394static void inode_lru_list_add(struct inode *inode)
395{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000396 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000397 this_cpu_inc(nr_unused);
Nick Piggin9e38d862010-10-23 06:55:17 -0400398}
399
Jan Kara4eff96d2012-11-26 16:29:51 -0800400/*
401 * Add inode to LRU if needed (inode is unused and clean).
402 *
403 * Needs inode->i_lock held.
404 */
405void inode_add_lru(struct inode *inode)
406{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500407 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
408 I_FREEING | I_WILL_FREE)) &&
Jan Kara4eff96d2012-11-26 16:29:51 -0800409 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & MS_ACTIVE)
410 inode_lru_list_add(inode);
411}
412
413
Nick Piggin9e38d862010-10-23 06:55:17 -0400414static void inode_lru_list_del(struct inode *inode)
415{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000416
417 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000418 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419}
420
Christoph Hellwig646ec462010-10-23 07:15:32 -0400421/**
422 * inode_sb_list_add - add inode to the superblock list of inodes
423 * @inode: inode to add
424 */
425void inode_sb_list_add(struct inode *inode)
426{
Dave Chinner74278da2015-03-04 12:37:22 -0500427 spin_lock(&inode->i_sb->s_inode_list_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +1100428 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500429 spin_unlock(&inode->i_sb->s_inode_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400430}
431EXPORT_SYMBOL_GPL(inode_sb_list_add);
432
Dave Chinner55fa6092011-03-22 22:23:40 +1100433static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400434{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200435 if (!list_empty(&inode->i_sb_list)) {
Dave Chinner74278da2015-03-04 12:37:22 -0500436 spin_lock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200437 list_del_init(&inode->i_sb_list);
Dave Chinner74278da2015-03-04 12:37:22 -0500438 spin_unlock(&inode->i_sb->s_inode_list_lock);
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200439 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400440}
441
Dave Chinner4c51acb2010-10-23 06:58:09 -0400442static unsigned long hash(struct super_block *sb, unsigned long hashval)
443{
444 unsigned long tmp;
445
446 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
447 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400448 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
449 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400450}
451
452/**
453 * __insert_inode_hash - hash an inode
454 * @inode: unhashed inode
455 * @hashval: unsigned long value used to locate this object in the
456 * inode_hashtable.
457 *
458 * Add an inode to the inode hash for this superblock.
459 */
460void __insert_inode_hash(struct inode *inode, unsigned long hashval)
461{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400462 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
463
Dave Chinner67a23c42011-03-22 22:23:42 +1100464 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100465 spin_lock(&inode->i_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400466 hlist_add_head(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100467 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100468 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400469}
470EXPORT_SYMBOL(__insert_inode_hash);
471
472/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200473 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400474 * @inode: inode to unhash
475 *
476 * Remove an inode from the superblock.
477 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200478void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400479{
Dave Chinner67a23c42011-03-22 22:23:42 +1100480 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100481 spin_lock(&inode->i_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400482 hlist_del_init(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100483 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100484 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400485}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200486EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400487
Jan Karadbd57682012-05-03 14:48:02 +0200488void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400489{
490 might_sleep();
Jan Kara08142572011-06-27 16:18:10 -0700491 /*
492 * We have to cycle tree_lock here because reclaim can be still in the
493 * process of removing the last page (in __delete_from_page_cache())
494 * and we must not free mapping under it.
495 */
496 spin_lock_irq(&inode->i_data.tree_lock);
Al Virob0683aa2010-06-04 20:55:25 -0400497 BUG_ON(inode->i_data.nrpages);
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700498 BUG_ON(inode->i_data.nrshadows);
Jan Kara08142572011-06-27 16:18:10 -0700499 spin_unlock_irq(&inode->i_data.tree_lock);
Al Virob0683aa2010-06-04 20:55:25 -0400500 BUG_ON(!list_empty(&inode->i_data.private_list));
501 BUG_ON(!(inode->i_state & I_FREEING));
502 BUG_ON(inode->i_state & I_CLEAR);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100503 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400504 inode->i_state = I_FREEING | I_CLEAR;
505}
Jan Karadbd57682012-05-03 14:48:02 +0200506EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400507
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100508/*
509 * Free the inode passed in, removing it from the lists it is still connected
510 * to. We remove any pages still attached to the inode and wait for any IO that
511 * is still in progress before finally destroying the inode.
512 *
513 * An inode must already be marked I_FREEING so that we avoid the inode being
514 * moved back onto lists if we race with other code that manipulates the lists
515 * (e.g. writeback_single_inode). The caller is responsible for setting this.
516 *
517 * An inode must already be removed from the LRU list before being evicted from
518 * the cache. This should occur atomically with setting the I_FREEING state
519 * flag, so no inodes here should ever be on the LRU when being evicted.
520 */
Al Viro644da592010-06-07 13:21:05 -0400521static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400522{
523 const struct super_operations *op = inode->i_sb->s_op;
524
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100525 BUG_ON(!(inode->i_state & I_FREEING));
526 BUG_ON(!list_empty(&inode->i_lru));
527
Dave Chinnerc7f54082015-03-04 14:07:22 -0500528 if (!list_empty(&inode->i_io_list))
529 inode_io_list_del(inode);
Eric Dumazetb12362b2011-07-28 06:11:47 +0200530
Dave Chinner55fa6092011-03-22 22:23:40 +1100531 inode_sb_list_del(inode);
532
Jan Kara169ebd92012-05-03 14:48:03 +0200533 /*
534 * Wait for flusher thread to be done with the inode so that filesystem
535 * does not start destroying it while writeback is still running. Since
536 * the inode has I_FREEING set, flusher thread won't start new work on
537 * the inode. We just have to wait for running writeback to finish.
538 */
539 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200540
Al Virobe7ce412010-06-04 19:40:39 -0400541 if (op->evict_inode) {
542 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400543 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700544 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200545 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400546 }
Al Viro661074e2010-06-04 20:19:55 -0400547 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
548 bd_forget(inode);
549 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
550 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100551
552 remove_inode_hash(inode);
553
554 spin_lock(&inode->i_lock);
555 wake_up_bit(&inode->i_state, __I_NEW);
556 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
557 spin_unlock(&inode->i_lock);
558
559 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400560}
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562/*
563 * dispose_list - dispose of the contents of a local list
564 * @head: the head of the list to free
565 *
566 * Dispose-list gets a local list with local inodes in it, so it doesn't
567 * need to worry about list corruption and SMP locks.
568 */
569static void dispose_list(struct list_head *head)
570{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 while (!list_empty(head)) {
572 struct inode *inode;
573
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100574 inode = list_first_entry(head, struct inode, i_lru);
575 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Al Viro644da592010-06-07 13:21:05 -0400577 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579}
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581/**
Al Viro63997e92010-10-25 20:49:35 -0400582 * evict_inodes - evict all evictable inodes for a superblock
583 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 *
Al Viro63997e92010-10-25 20:49:35 -0400585 * Make sure that no inodes with zero refcount are retained. This is
586 * called by superblock shutdown after having MS_ACTIVE flag removed,
587 * so any inode reaching zero refcount during or after that call will
588 * be immediately evicted.
589 */
590void evict_inodes(struct super_block *sb)
591{
592 struct inode *inode, *next;
593 LIST_HEAD(dispose);
594
Dave Chinner74278da2015-03-04 12:37:22 -0500595 spin_lock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400596 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
597 if (atomic_read(&inode->i_count))
598 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100599
600 spin_lock(&inode->i_lock);
601 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
602 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400603 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100604 }
Al Viro63997e92010-10-25 20:49:35 -0400605
606 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100607 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100608 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100609 list_add(&inode->i_lru, &dispose);
Al Viro63997e92010-10-25 20:49:35 -0400610 }
Dave Chinner74278da2015-03-04 12:37:22 -0500611 spin_unlock(&sb->s_inode_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400612
613 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400614}
615
616/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200617 * invalidate_inodes - attempt to free all inodes on a superblock
618 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100619 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200620 *
621 * Attempts to free all inodes for a given superblock. If there were any
622 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100623 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
624 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 */
NeilBrown93b270f2011-02-24 17:25:47 +1100626int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400628 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200629 struct inode *inode, *next;
630 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Dave Chinner74278da2015-03-04 12:37:22 -0500632 spin_lock(&sb->s_inode_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200633 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100634 spin_lock(&inode->i_lock);
635 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
636 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100638 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500639 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100640 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100641 busy = 1;
642 continue;
643 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200644 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100645 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200646 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 continue;
648 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200649
Christoph Hellwig99a38912010-10-23 19:07:20 +0200650 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100651 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100652 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100653 list_add(&inode->i_lru, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 }
Dave Chinner74278da2015-03-04 12:37:22 -0500655 spin_unlock(&sb->s_inode_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
Christoph Hellwiga0318782010-10-24 19:40:33 +0200657 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
659 return busy;
660}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000663 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 *
665 * Any inodes which are pinned purely because of attached pagecache have their
Nick Piggin9e38d862010-10-23 06:55:17 -0400666 * pagecache removed. If the inode has metadata buffers attached to
667 * mapping->private_list then try to remove them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400669 * If the inode has the I_REFERENCED flag set, then it means that it has been
670 * used recently - the flag is set in iput_final(). When we encounter such an
671 * inode, clear the flag and move it to the back of the LRU so it gets another
672 * pass through the LRU before it gets reclaimed. This is necessary because of
673 * the fact we are doing lazy LRU updates to minimise lock contention so the
674 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
675 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800677static enum lru_status inode_lru_isolate(struct list_head *item,
678 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000679{
680 struct list_head *freeable = arg;
681 struct inode *inode = container_of(item, struct inode, i_lru);
682
683 /*
684 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
685 * If we fail to get the lock, just skip it.
686 */
687 if (!spin_trylock(&inode->i_lock))
688 return LRU_SKIP;
689
690 /*
691 * Referenced or dirty inodes are still in use. Give them another pass
692 * through the LRU as we canot reclaim them now.
693 */
694 if (atomic_read(&inode->i_count) ||
695 (inode->i_state & ~I_REFERENCED)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800696 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000697 spin_unlock(&inode->i_lock);
698 this_cpu_dec(nr_unused);
699 return LRU_REMOVED;
700 }
701
702 /* recently referenced inodes get one more pass */
703 if (inode->i_state & I_REFERENCED) {
704 inode->i_state &= ~I_REFERENCED;
705 spin_unlock(&inode->i_lock);
706 return LRU_ROTATE;
707 }
708
709 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
710 __iget(inode);
711 spin_unlock(&inode->i_lock);
712 spin_unlock(lru_lock);
713 if (remove_inode_buffers(inode)) {
714 unsigned long reap;
715 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
716 if (current_is_kswapd())
717 __count_vm_events(KSWAPD_INODESTEAL, reap);
718 else
719 __count_vm_events(PGINODESTEAL, reap);
720 if (current->reclaim_state)
721 current->reclaim_state->reclaimed_slab += reap;
722 }
723 iput(inode);
724 spin_lock(lru_lock);
725 return LRU_RETRY;
726 }
727
728 WARN_ON(inode->i_state & I_NEW);
729 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800730 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000731 spin_unlock(&inode->i_lock);
732
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000733 this_cpu_dec(nr_unused);
734 return LRU_REMOVED;
735}
736
737/*
738 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
739 * This is called from the superblock shrinker function with a number of inodes
740 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
741 * then are freed outside inode_lock by dispose_list().
742 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800743long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
745 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000746 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
Vladimir Davydov503c3582015-02-12 14:58:47 -0800748 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
749 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000751 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752}
753
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754static void __wait_on_freeing_inode(struct inode *inode);
755/*
756 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530758static struct inode *find_inode(struct super_block *sb,
759 struct hlist_head *head,
760 int (*test)(struct inode *, void *),
761 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530763 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
765repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800766 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500767 if (inode->i_sb != sb)
768 continue;
769 if (!test(inode, data))
770 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100771 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400772 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 __wait_on_freeing_inode(inode);
774 goto repeat;
775 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400776 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100777 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400778 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400780 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781}
782
783/*
784 * find_inode_fast is the fast path version of find_inode, see the comment at
785 * iget_locked for details.
786 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530787static struct inode *find_inode_fast(struct super_block *sb,
788 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530790 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
792repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800793 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500794 if (inode->i_ino != ino)
795 continue;
796 if (inode->i_sb != sb)
797 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100798 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400799 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 __wait_on_freeing_inode(inode);
801 goto repeat;
802 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400803 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100804 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400805 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400807 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808}
809
Eric Dumazetf991bd22010-10-23 11:18:01 -0400810/*
811 * Each cpu owns a range of LAST_INO_BATCH numbers.
812 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
813 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100814 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400815 * This does not significantly increase overflow rate because every CPU can
816 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
817 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
818 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
819 * overflow rate by 2x, which does not seem too significant.
820 *
821 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
822 * error if st_ino won't fit in target struct field. Use 32bit counter
823 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100824 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400825#define LAST_INO_BATCH 1024
826static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100827
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400828unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400829{
830 unsigned int *p = &get_cpu_var(last_ino);
831 unsigned int res = *p;
832
833#ifdef CONFIG_SMP
834 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
835 static atomic_t shared_last_ino;
836 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
837
838 res = next - LAST_INO_BATCH;
839 }
840#endif
841
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300842 res++;
843 /* get_next_ino should not provide a 0 inode number */
844 if (unlikely(!res))
845 res++;
846 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400847 put_cpu_var(last_ino);
848 return res;
David Chinner8290c352008-10-30 17:35:24 +1100849}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400850EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100851
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200853 * new_inode_pseudo - obtain an inode
854 * @sb: superblock
855 *
856 * Allocates a new inode for given superblock.
857 * Inode wont be chained in superblock s_inodes list
858 * This means :
859 * - fs can't be unmount
860 * - quotas, fsnotify, writeback can't work
861 */
862struct inode *new_inode_pseudo(struct super_block *sb)
863{
864 struct inode *inode = alloc_inode(sb);
865
866 if (inode) {
867 spin_lock(&inode->i_lock);
868 inode->i_state = 0;
869 spin_unlock(&inode->i_lock);
870 INIT_LIST_HEAD(&inode->i_sb_list);
871 }
872 return inode;
873}
874
875/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 * new_inode - obtain an inode
877 * @sb: superblock
878 *
Mel Gorman769848c2007-07-17 04:03:05 -0700879 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800880 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700881 * If HIGHMEM pages are unsuitable or it is known that pages allocated
882 * for the page cache are not reclaimable or migratable,
883 * mapping_set_gfp_mask() must be called with suitable flags on the
884 * newly created inode's mapping
885 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 */
887struct inode *new_inode(struct super_block *sb)
888{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530889 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890
Dave Chinner74278da2015-03-04 12:37:22 -0500891 spin_lock_prefetch(&sb->s_inode_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530892
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200893 inode = new_inode_pseudo(sb);
894 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100895 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 return inode;
897}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898EXPORT_SYMBOL(new_inode);
899
Peter Zijlstra14358e62007-10-14 01:38:33 +0200900#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400901void lockdep_annotate_inode_mutex_key(struct inode *inode)
902{
Namhyung Kima3314a02010-10-11 22:38:00 +0900903 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200904 struct file_system_type *type = inode->i_sb->s_type;
905
Jan Kara9a7aa122009-06-04 15:26:49 +0200906 /* Set new key only if filesystem hasn't already changed it */
Tyler Hicks978d6d82011-12-12 10:02:30 -0600907 if (lockdep_match_class(&inode->i_mutex, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200908 /*
909 * ensure nobody is actually holding i_mutex
910 */
911 mutex_destroy(&inode->i_mutex);
912 mutex_init(&inode->i_mutex);
913 lockdep_set_class(&inode->i_mutex,
914 &type->i_mutex_dir_key);
915 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200916 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400917}
918EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200919#endif
Josh Boyere096d0c2011-08-25 07:48:12 -0400920
921/**
922 * unlock_new_inode - clear the I_NEW state and wake up any waiters
923 * @inode: new inode to unlock
924 *
925 * Called when the inode is fully initialised to clear the new state of the
926 * inode and wake up anyone waiting for the inode to finish initialisation.
927 */
928void unlock_new_inode(struct inode *inode)
929{
930 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100931 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100932 WARN_ON(!(inode->i_state & I_NEW));
933 inode->i_state &= ~I_NEW;
Al Viro310fa7a2012-03-10 17:07:28 -0500934 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +1100935 wake_up_bit(&inode->i_state, __I_NEW);
936 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938EXPORT_SYMBOL(unlock_new_inode);
939
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400940/**
J. Bruce Fields375e2892012-04-18 15:16:33 -0400941 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200942 *
943 * Lock any non-NULL argument that is not a directory.
944 * Zero, one or two objects may be locked by this function.
945 *
J. Bruce Fields375e2892012-04-18 15:16:33 -0400946 * @inode1: first inode to lock
947 * @inode2: second inode to lock
948 */
949void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
950{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200951 if (inode1 > inode2)
952 swap(inode1, inode2);
953
954 if (inode1 && !S_ISDIR(inode1->i_mode))
J. Bruce Fields275555162012-04-25 07:19:52 -0400955 mutex_lock(&inode1->i_mutex);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200956 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400957 mutex_lock_nested(&inode2->i_mutex, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -0400958}
959EXPORT_SYMBOL(lock_two_nondirectories);
960
961/**
962 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
963 * @inode1: first inode to unlock
964 * @inode2: second inode to unlock
965 */
966void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
967{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200968 if (inode1 && !S_ISDIR(inode1->i_mode))
969 mutex_unlock(&inode1->i_mutex);
970 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
J. Bruce Fields375e2892012-04-18 15:16:33 -0400971 mutex_unlock(&inode2->i_mutex);
972}
973EXPORT_SYMBOL(unlock_two_nondirectories);
974
975/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400976 * iget5_locked - obtain an inode from a mounted file system
977 * @sb: super block of file system
978 * @hashval: hash value (usually inode number) to get
979 * @test: callback used for comparisons between inodes
980 * @set: callback used to initialize a new struct inode
981 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400983 * Search for the inode specified by @hashval and @data in the inode cache,
984 * and if present it is return it with an increased reference count. This is
985 * a generalized version of iget_locked() for file systems where the inode
986 * number is not sufficient for unique identification of an inode.
987 *
988 * If the inode is not in cache, allocate a new inode and return it locked,
989 * hashed, and with the I_NEW flag set. The file system gets to fill it in
990 * before unlocking it via unlock_new_inode().
991 *
992 * Note both @test and @set are called with the inode_hash_lock held, so can't
993 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400995struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
996 int (*test)(struct inode *, void *),
997 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400999 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301000 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001002 spin_lock(&inode_hash_lock);
1003 inode = find_inode(sb, head, test, data);
1004 spin_unlock(&inode_hash_lock);
1005
1006 if (inode) {
1007 wait_on_inode(inode);
1008 return inode;
1009 }
1010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 inode = alloc_inode(sb);
1012 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301013 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
Dave Chinner67a23c42011-03-22 22:23:42 +11001015 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 /* We released the lock, so.. */
1017 old = find_inode(sb, head, test, data);
1018 if (!old) {
1019 if (set(inode, data))
1020 goto set_failed;
1021
Dave Chinner250df6e2011-03-22 22:23:36 +11001022 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001023 inode->i_state = I_NEW;
Dave Chinner250df6e2011-03-22 22:23:36 +11001024 hlist_add_head(&inode->i_hash, head);
1025 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001026 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001027 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028
1029 /* Return the locked inode with I_NEW set, the
1030 * caller is responsible for filling in the contents
1031 */
1032 return inode;
1033 }
1034
1035 /*
1036 * Uhhuh, somebody else created the same inode under
1037 * us. Use the old inode instead of the one we just
1038 * allocated.
1039 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001040 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 destroy_inode(inode);
1042 inode = old;
1043 wait_on_inode(inode);
1044 }
1045 return inode;
1046
1047set_failed:
Dave Chinner67a23c42011-03-22 22:23:42 +11001048 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 destroy_inode(inode);
1050 return NULL;
1051}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001052EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001054/**
1055 * iget_locked - obtain an inode from a mounted file system
1056 * @sb: super block of file system
1057 * @ino: inode number to get
1058 *
1059 * Search for the inode specified by @ino in the inode cache and if present
1060 * return it with an increased reference count. This is for file systems
1061 * where the inode number is sufficient for unique identification of an inode.
1062 *
1063 * If the inode is not in cache, allocate a new inode and return it locked,
1064 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1065 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001067struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001069 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301070 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001072 spin_lock(&inode_hash_lock);
1073 inode = find_inode_fast(sb, head, ino);
1074 spin_unlock(&inode_hash_lock);
1075 if (inode) {
1076 wait_on_inode(inode);
1077 return inode;
1078 }
1079
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 inode = alloc_inode(sb);
1081 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301082 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083
Dave Chinner67a23c42011-03-22 22:23:42 +11001084 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 /* We released the lock, so.. */
1086 old = find_inode_fast(sb, head, ino);
1087 if (!old) {
1088 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001089 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001090 inode->i_state = I_NEW;
Dave Chinner250df6e2011-03-22 22:23:36 +11001091 hlist_add_head(&inode->i_hash, head);
1092 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001093 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001094 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
1096 /* Return the locked inode with I_NEW set, the
1097 * caller is responsible for filling in the contents
1098 */
1099 return inode;
1100 }
1101
1102 /*
1103 * Uhhuh, somebody else created the same inode under
1104 * us. Use the old inode instead of the one we just
1105 * allocated.
1106 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001107 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 destroy_inode(inode);
1109 inode = old;
1110 wait_on_inode(inode);
1111 }
1112 return inode;
1113}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001114EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001116/*
1117 * search the inode cache for a matching inode number.
1118 * If we find one, then the inode number we are trying to
1119 * allocate is not unique and so we should not use it.
1120 *
1121 * Returns 1 if the inode number is unique, 0 if it is not.
1122 */
1123static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1124{
1125 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001126 struct inode *inode;
1127
Dave Chinner67a23c42011-03-22 22:23:42 +11001128 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001129 hlist_for_each_entry(inode, b, i_hash) {
Dave Chinner67a23c42011-03-22 22:23:42 +11001130 if (inode->i_ino == ino && inode->i_sb == sb) {
1131 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001132 return 0;
Dave Chinner67a23c42011-03-22 22:23:42 +11001133 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001134 }
Dave Chinner67a23c42011-03-22 22:23:42 +11001135 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001136
1137 return 1;
1138}
1139
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140/**
1141 * iunique - get a unique inode number
1142 * @sb: superblock
1143 * @max_reserved: highest reserved inode number
1144 *
1145 * Obtain an inode number that is unique on the system for a given
1146 * superblock. This is used by file systems that have no natural
1147 * permanent inode numbering system. An inode number is returned that
1148 * is higher than the reserved limit but unique.
1149 *
1150 * BUGS:
1151 * With a large number of inodes live on the file system this function
1152 * currently becomes quite slow.
1153 */
1154ino_t iunique(struct super_block *sb, ino_t max_reserved)
1155{
Jeff Layton866b04f2007-05-08 00:32:29 -07001156 /*
1157 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1158 * error if st_ino won't fit in target struct field. Use 32bit counter
1159 * here to attempt to avoid that.
1160 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001161 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001162 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001165 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001166 do {
1167 if (counter <= max_reserved)
1168 counter = max_reserved + 1;
1169 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001170 } while (!test_inode_iunique(sb, res));
1171 spin_unlock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001172
1173 return res;
1174}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175EXPORT_SYMBOL(iunique);
1176
1177struct inode *igrab(struct inode *inode)
1178{
Dave Chinner250df6e2011-03-22 22:23:36 +11001179 spin_lock(&inode->i_lock);
1180 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001182 spin_unlock(&inode->i_lock);
1183 } else {
1184 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 /*
1186 * Handle the case where s_op->clear_inode is not been
1187 * called yet, and somebody is calling igrab
1188 * while the inode is getting freed.
1189 */
1190 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001191 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 return inode;
1193}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194EXPORT_SYMBOL(igrab);
1195
1196/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001197 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 * @sb: super block of file system to search
1199 * @hashval: hash value (usually inode number) to search for
1200 * @test: callback used for comparisons between inodes
1201 * @data: opaque data pointer to pass to @test
1202 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001203 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001205 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001206 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001207 * Note: I_NEW is not waited upon so you have to be very careful what you do
1208 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001209 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001210 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001211 */
1212struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1213 int (*test)(struct inode *, void *), void *data)
1214{
1215 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001216 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001217
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001218 spin_lock(&inode_hash_lock);
1219 inode = find_inode(sb, head, test, data);
1220 spin_unlock(&inode_hash_lock);
1221
1222 return inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001223}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001224EXPORT_SYMBOL(ilookup5_nowait);
1225
1226/**
1227 * ilookup5 - search for an inode in the inode cache
1228 * @sb: super block of file system to search
1229 * @hashval: hash value (usually inode number) to search for
1230 * @test: callback used for comparisons between inodes
1231 * @data: opaque data pointer to pass to @test
1232 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001233 * Search for the inode specified by @hashval and @data in the inode cache,
1234 * and if the inode is in the cache, return the inode with an incremented
1235 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001236 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001238 * This is a generalized version of ilookup() for file systems where the
1239 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001241 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 */
1243struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1244 int (*test)(struct inode *, void *), void *data)
1245{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001246 struct inode *inode = ilookup5_nowait(sb, hashval, test, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001248 if (inode)
1249 wait_on_inode(inode);
1250 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252EXPORT_SYMBOL(ilookup5);
1253
1254/**
1255 * ilookup - search for an inode in the inode cache
1256 * @sb: super block of file system to search
1257 * @ino: inode number to search for
1258 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001259 * Search for the inode @ino in the inode cache, and if the inode is in the
1260 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 */
1262struct inode *ilookup(struct super_block *sb, unsigned long ino)
1263{
1264 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001265 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001267 spin_lock(&inode_hash_lock);
1268 inode = find_inode_fast(sb, head, ino);
1269 spin_unlock(&inode_hash_lock);
1270
1271 if (inode)
1272 wait_on_inode(inode);
1273 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275EXPORT_SYMBOL(ilookup);
1276
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001277/**
1278 * find_inode_nowait - find an inode in the inode cache
1279 * @sb: super block of file system to search
1280 * @hashval: hash value (usually inode number) to search for
1281 * @match: callback used for comparisons between inodes
1282 * @data: opaque data pointer to pass to @match
1283 *
1284 * Search for the inode specified by @hashval and @data in the inode
1285 * cache, where the helper function @match will return 0 if the inode
1286 * does not match, 1 if the inode does match, and -1 if the search
1287 * should be stopped. The @match function must be responsible for
1288 * taking the i_lock spin_lock and checking i_state for an inode being
1289 * freed or being initialized, and incrementing the reference count
1290 * before returning 1. It also must not sleep, since it is called with
1291 * the inode_hash_lock spinlock held.
1292 *
1293 * This is a even more generalized version of ilookup5() when the
1294 * function must never block --- find_inode() can block in
1295 * __wait_on_freeing_inode() --- or when the caller can not increment
1296 * the reference count because the resulting iput() might cause an
1297 * inode eviction. The tradeoff is that the @match funtion must be
1298 * very carefully implemented.
1299 */
1300struct inode *find_inode_nowait(struct super_block *sb,
1301 unsigned long hashval,
1302 int (*match)(struct inode *, unsigned long,
1303 void *),
1304 void *data)
1305{
1306 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1307 struct inode *inode, *ret_inode = NULL;
1308 int mval;
1309
1310 spin_lock(&inode_hash_lock);
1311 hlist_for_each_entry(inode, head, i_hash) {
1312 if (inode->i_sb != sb)
1313 continue;
1314 mval = match(inode, hashval, data);
1315 if (mval == 0)
1316 continue;
1317 if (mval == 1)
1318 ret_inode = inode;
1319 goto out;
1320 }
1321out:
1322 spin_unlock(&inode_hash_lock);
1323 return ret_inode;
1324}
1325EXPORT_SYMBOL(find_inode_nowait);
1326
Al Viro261bca82008-12-30 01:48:21 -05001327int insert_inode_locked(struct inode *inode)
1328{
1329 struct super_block *sb = inode->i_sb;
1330 ino_t ino = inode->i_ino;
1331 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001332
Al Viro261bca82008-12-30 01:48:21 -05001333 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001334 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001335 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001336 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001337 if (old->i_ino != ino)
1338 continue;
1339 if (old->i_sb != sb)
1340 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001341 spin_lock(&old->i_lock);
1342 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1343 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001344 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001345 }
Al Viro72a43d62009-05-13 19:13:40 +01001346 break;
1347 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001348 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001349 spin_lock(&inode->i_lock);
1350 inode->i_state |= I_NEW;
Al Viro261bca82008-12-30 01:48:21 -05001351 hlist_add_head(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001352 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001353 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001354 return 0;
1355 }
1356 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001357 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001358 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001359 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001360 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001361 iput(old);
1362 return -EBUSY;
1363 }
1364 iput(old);
1365 }
1366}
Al Viro261bca82008-12-30 01:48:21 -05001367EXPORT_SYMBOL(insert_inode_locked);
1368
1369int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1370 int (*test)(struct inode *, void *), void *data)
1371{
1372 struct super_block *sb = inode->i_sb;
1373 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Al Viro261bca82008-12-30 01:48:21 -05001374
Al Viro261bca82008-12-30 01:48:21 -05001375 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001376 struct inode *old = NULL;
1377
Dave Chinner67a23c42011-03-22 22:23:42 +11001378 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001379 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001380 if (old->i_sb != sb)
1381 continue;
1382 if (!test(old, data))
1383 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001384 spin_lock(&old->i_lock);
1385 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1386 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001387 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001388 }
Al Viro72a43d62009-05-13 19:13:40 +01001389 break;
1390 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001391 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001392 spin_lock(&inode->i_lock);
1393 inode->i_state |= I_NEW;
Al Viro261bca82008-12-30 01:48:21 -05001394 hlist_add_head(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001395 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001396 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001397 return 0;
1398 }
1399 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001400 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001401 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001402 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001403 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001404 iput(old);
1405 return -EBUSY;
1406 }
1407 iput(old);
1408 }
1409}
Al Viro261bca82008-12-30 01:48:21 -05001410EXPORT_SYMBOL(insert_inode_locked4);
1411
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
Al Viro45321ac2010-06-07 13:43:19 -04001413int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414{
Al Viro45321ac2010-06-07 13:43:19 -04001415 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417EXPORT_SYMBOL(generic_delete_inode);
1418
Al Viro45321ac2010-06-07 13:43:19 -04001419/*
Al Viro45321ac2010-06-07 13:43:19 -04001420 * Called when we're dropping the last reference
1421 * to an inode.
1422 *
1423 * Call the FS "drop_inode()" function, defaulting to
1424 * the legacy UNIX filesystem behaviour. If it tells
1425 * us to evict inode, do so. Otherwise, retain inode
1426 * in cache if fs is alive, sync and evict if fs is
1427 * shutting down.
1428 */
1429static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430{
1431 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001432 const struct super_operations *op = inode->i_sb->s_op;
1433 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434
Dave Chinner250df6e2011-03-22 22:23:36 +11001435 WARN_ON(inode->i_state & I_NEW);
1436
Al Viroe7f59092011-07-07 15:45:59 -04001437 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001438 drop = op->drop_inode(inode);
1439 else
1440 drop = generic_drop_inode(inode);
1441
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001442 if (!drop && (sb->s_flags & MS_ACTIVE)) {
1443 inode->i_state |= I_REFERENCED;
Jan Kara4eff96d2012-11-26 16:29:51 -08001444 inode_add_lru(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001445 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001446 return;
1447 }
1448
Al Viro45321ac2010-06-07 13:43:19 -04001449 if (!drop) {
Alexander Viro991114c2005-06-23 00:09:01 -07001450 inode->i_state |= I_WILL_FREE;
Dave Chinner250df6e2011-03-22 22:23:36 +11001451 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 write_inode_now(inode, 1);
Dave Chinner250df6e2011-03-22 22:23:36 +11001453 spin_lock(&inode->i_lock);
Nick Piggin7ef0d732009-03-12 14:31:38 -07001454 WARN_ON(inode->i_state & I_NEW);
Alexander Viro991114c2005-06-23 00:09:01 -07001455 inode->i_state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001457
Alexander Viro991114c2005-06-23 00:09:01 -07001458 inode->i_state |= I_FREEING;
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001459 if (!list_empty(&inode->i_lru))
1460 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001461 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001462
1463 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464}
1465
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301467 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 * @inode: inode to put
1469 *
1470 * Puts an inode, dropping its usage count. If the inode use count hits
1471 * zero, the inode is then freed and may also be destroyed.
1472 *
1473 * Consequently, iput() can sleep.
1474 */
1475void iput(struct inode *inode)
1476{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001477 if (!inode)
1478 return;
1479 BUG_ON(inode->i_state & I_CLEAR);
1480retry:
1481 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1482 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1483 atomic_inc(&inode->i_count);
1484 inode->i_state &= ~I_DIRTY_TIME;
1485 spin_unlock(&inode->i_lock);
1486 trace_writeback_lazytime_iput(inode);
1487 mark_inode_dirty_sync(inode);
1488 goto retry;
1489 }
1490 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 }
1492}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493EXPORT_SYMBOL(iput);
1494
1495/**
1496 * bmap - find a block number in a file
1497 * @inode: inode of file
1498 * @block: block to find
1499 *
1500 * Returns the block number on the device holding the inode that
1501 * is the disk block number for the block of the file requested.
1502 * That is, asked for block 4 of inode 1 the function will return the
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301503 * disk block relative to the disk start that holds that block of the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 * file.
1505 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301506sector_t bmap(struct inode *inode, sector_t block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507{
1508 sector_t res = 0;
1509 if (inode->i_mapping->a_ops->bmap)
1510 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1511 return res;
1512}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513EXPORT_SYMBOL(bmap);
1514
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001515/*
1516 * With relative atime, only update atime if the previous atime is
1517 * earlier than either the ctime or mtime or if at least a day has
1518 * passed since the last atime update.
1519 */
1520static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
1521 struct timespec now)
1522{
1523
1524 if (!(mnt->mnt_flags & MNT_RELATIME))
1525 return 1;
1526 /*
1527 * Is mtime younger than atime? If yes, update atime:
1528 */
1529 if (timespec_compare(&inode->i_mtime, &inode->i_atime) >= 0)
1530 return 1;
1531 /*
1532 * Is ctime younger than atime? If yes, update atime:
1533 */
1534 if (timespec_compare(&inode->i_ctime, &inode->i_atime) >= 0)
1535 return 1;
1536
1537 /*
1538 * Is the previous atime value older than a day? If yes,
1539 * update atime:
1540 */
1541 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1542 return 1;
1543 /*
1544 * Good, we can skip the atime update:
1545 */
1546 return 0;
1547}
1548
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001549int generic_update_time(struct inode *inode, struct timespec *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001550{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001551 int iflags = I_DIRTY_TIME;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001552
1553 if (flags & S_ATIME)
1554 inode->i_atime = *time;
1555 if (flags & S_VERSION)
1556 inode_inc_iversion(inode);
1557 if (flags & S_CTIME)
1558 inode->i_ctime = *time;
1559 if (flags & S_MTIME)
1560 inode->i_mtime = *time;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001561
1562 if (!(inode->i_sb->s_flags & MS_LAZYTIME) || (flags & S_VERSION))
1563 iflags |= I_DIRTY_SYNC;
1564 __mark_inode_dirty(inode, iflags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001565 return 0;
1566}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001567EXPORT_SYMBOL(generic_update_time);
1568
1569/*
1570 * This does the actual work of updating an inodes time or version. Must have
1571 * had called mnt_want_write() before calling this.
1572 */
1573static int update_time(struct inode *inode, struct timespec *time, int flags)
1574{
1575 int (*update_time)(struct inode *, struct timespec *, int);
1576
1577 update_time = inode->i_op->update_time ? inode->i_op->update_time :
1578 generic_update_time;
1579
1580 return update_time(inode, time, flags);
1581}
Josef Bacikc3b2da32012-03-26 09:59:21 -04001582
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583/**
Christoph Hellwig869243a2006-01-09 20:52:03 -08001584 * touch_atime - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001585 * @path: the &struct path to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 *
1587 * Update the accessed time on an inode and mark it for writeback.
1588 * This function automatically handles read only file systems and media,
1589 * as well as the "noatime" flag and inode specific "noatime" markers.
1590 */
NeilBrown8fa9dd22015-03-23 13:37:40 +11001591bool atime_needs_update(const struct path *path, struct inode *inode)
1592{
1593 struct vfsmount *mnt = path->mnt;
1594 struct timespec now;
1595
1596 if (inode->i_flags & S_NOATIME)
1597 return false;
1598 if (IS_NOATIME(inode))
1599 return false;
1600 if ((inode->i_sb->s_flags & MS_NODIRATIME) && S_ISDIR(inode->i_mode))
1601 return false;
1602
1603 if (mnt->mnt_flags & MNT_NOATIME)
1604 return false;
1605 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1606 return false;
1607
1608 now = current_fs_time(inode->i_sb);
1609
1610 if (!relatime_need_update(mnt, inode, now))
1611 return false;
1612
1613 if (timespec_equal(&inode->i_atime, &now))
1614 return false;
1615
1616 return true;
1617}
1618
Al Virobadcf2b2013-07-16 18:15:46 +04001619void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620{
Al Viro68ac1232012-03-15 08:21:57 -04001621 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001622 struct inode *inode = d_inode(path->dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 struct timespec now;
1624
NeilBrown8fa9dd22015-03-23 13:37:40 +11001625 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001626 return;
1627
Jan Kara5d37e9e2012-06-12 16:20:36 +02001628 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001629 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001630
NeilBrown8fa9dd22015-03-23 13:37:40 +11001631 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001632 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001633 /*
1634 * File systems can error out when updating inodes if they need to
1635 * allocate new space to modify an inode (such is the case for
1636 * Btrfs), but since we touch atime while walking down the path we
1637 * really don't care if we failed to update the atime of the file,
1638 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001639 * We may also fail on filesystems that have the ability to make parts
1640 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001641 */
NeilBrown8fa9dd22015-03-23 13:37:40 +11001642 now = current_fs_time(inode->i_sb);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001643 update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001644 __mnt_drop_write(mnt);
1645skip_update:
1646 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001648EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649
Cong Wang3ed37642012-05-15 14:57:33 +08001650/*
1651 * The logic we want is
1652 *
1653 * if suid or (sgid and xgrp)
1654 * remove privs
1655 */
1656int should_remove_suid(struct dentry *dentry)
1657{
David Howellsdf2b1af2015-03-17 22:26:15 +00001658 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001659 int kill = 0;
1660
1661 /* suid always must be killed */
1662 if (unlikely(mode & S_ISUID))
1663 kill = ATTR_KILL_SUID;
1664
1665 /*
1666 * sgid without any exec bits is just a mandatory locking mark; leave
1667 * it alone. If some exec bits are set, it's a real sgid; kill it.
1668 */
1669 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1670 kill |= ATTR_KILL_SGID;
1671
1672 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1673 return kill;
1674
1675 return 0;
1676}
1677EXPORT_SYMBOL(should_remove_suid);
1678
Jan Karadbfae0c2015-05-21 16:05:54 +02001679/*
1680 * Return mask of changes for notify_change() that need to be done as a
1681 * response to write or truncate. Return 0 if nothing has to be changed.
1682 * Negative value on error (change should be denied).
1683 */
Jan Kara45f147a2015-05-21 16:05:55 +02001684int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001685{
Jan Karadbfae0c2015-05-21 16:05:54 +02001686 struct inode *inode = d_inode(dentry);
1687 int mask = 0;
1688 int ret;
1689
1690 if (IS_NOSEC(inode))
1691 return 0;
1692
1693 mask = should_remove_suid(dentry);
1694 ret = security_inode_need_killpriv(dentry);
1695 if (ret < 0)
1696 return ret;
1697 if (ret)
1698 mask |= ATTR_KILL_PRIV;
1699 return mask;
1700}
Jan Kara45f147a2015-05-21 16:05:55 +02001701EXPORT_SYMBOL(dentry_needs_remove_privs);
Jan Karadbfae0c2015-05-21 16:05:54 +02001702
1703static int __remove_privs(struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001704{
1705 struct iattr newattrs;
1706
1707 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001708 /*
1709 * Note we call this on write, so notify_change will not
1710 * encounter any conflicting delegations:
1711 */
1712 return notify_change(dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001713}
1714
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001715/*
1716 * Remove special file priviledges (suid, capabilities) when file is written
1717 * to or truncated.
1718 */
1719int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001720{
1721 struct dentry *dentry = file->f_path.dentry;
David Howellsdf2b1af2015-03-17 22:26:15 +00001722 struct inode *inode = d_inode(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001723 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001724 int error = 0;
1725
1726 /* Fast path for nothing security related */
1727 if (IS_NOSEC(inode))
1728 return 0;
1729
Jan Karadbfae0c2015-05-21 16:05:54 +02001730 kill = file_needs_remove_privs(file);
1731 if (kill < 0)
1732 return kill;
1733 if (kill)
1734 error = __remove_privs(dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001735 if (!error)
1736 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001737
1738 return error;
1739}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001740EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001741
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001743 * file_update_time - update mtime and ctime time
1744 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001746 * Update the mtime and ctime members of an inode and mark the inode
1747 * for writeback. Note that this function is meant exclusively for
1748 * usage in the file write path of filesystems, and filesystems may
1749 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001750 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001751 * timestamps are handled by the server. This can return an error for
1752 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 */
1754
Josef Bacikc3b2da32012-03-26 09:59:21 -04001755int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756{
Al Viro496ad9a2013-01-23 17:07:38 -05001757 struct inode *inode = file_inode(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 struct timespec now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001759 int sync_it = 0;
1760 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761
Andi Kleence06e0b2009-09-18 13:05:48 -07001762 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001764 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001765
Andi Kleence06e0b2009-09-18 13:05:48 -07001766 now = current_fs_time(inode->i_sb);
1767 if (!timespec_equal(&inode->i_mtime, &now))
1768 sync_it = S_MTIME;
1769
1770 if (!timespec_equal(&inode->i_ctime, &now))
1771 sync_it |= S_CTIME;
1772
1773 if (IS_I_VERSION(inode))
1774 sync_it |= S_VERSION;
1775
1776 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001777 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778
Andi Kleence06e0b2009-09-18 13:05:48 -07001779 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02001780 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001781 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782
Josef Bacikc3b2da32012-03-26 09:59:21 -04001783 ret = update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02001784 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001785
1786 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787}
Christoph Hellwig870f4812006-01-09 20:52:01 -08001788EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789
1790int inode_needs_sync(struct inode *inode)
1791{
1792 if (IS_SYNC(inode))
1793 return 1;
1794 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1795 return 1;
1796 return 0;
1797}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798EXPORT_SYMBOL(inode_needs_sync);
1799
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07001801 * If we try to find an inode in the inode hash while it is being
1802 * deleted, we have to wait until the filesystem completes its
1803 * deletion before reporting that it isn't found. This function waits
1804 * until the deletion _might_ have completed. Callers are responsible
1805 * to recheck inode state.
1806 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001807 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11001808 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
1809 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 */
1811static void __wait_on_freeing_inode(struct inode *inode)
1812{
1813 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001814 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1815 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001817 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001818 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 schedule();
1820 finish_wait(wq, &wait.wait);
Dave Chinner67a23c42011-03-22 22:23:42 +11001821 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822}
1823
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824static __initdata unsigned long ihash_entries;
1825static int __init set_ihash_entries(char *str)
1826{
1827 if (!str)
1828 return 0;
1829 ihash_entries = simple_strtoul(str, &str, 0);
1830 return 1;
1831}
1832__setup("ihash_entries=", set_ihash_entries);
1833
1834/*
1835 * Initialize the waitqueues and inode hash table.
1836 */
1837void __init inode_init_early(void)
1838{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001839 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840
1841 /* If hashes are distributed across NUMA nodes, defer
1842 * hash allocation until vmalloc space is available.
1843 */
1844 if (hashdist)
1845 return;
1846
1847 inode_hashtable =
1848 alloc_large_system_hash("Inode-cache",
1849 sizeof(struct hlist_head),
1850 ihash_entries,
1851 14,
1852 HASH_EARLY,
1853 &i_hash_shift,
1854 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00001855 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 0);
1857
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001858 for (loop = 0; loop < (1U << i_hash_shift); loop++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1860}
1861
Denis Cheng74bf17c2007-10-16 23:26:30 -07001862void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001864 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865
1866 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08001867 inode_cachep = kmem_cache_create("inode_cache",
1868 sizeof(struct inode),
1869 0,
1870 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
1871 SLAB_MEM_SPREAD),
Paul Mundt20c2df82007-07-20 10:11:58 +09001872 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873
1874 /* Hash may have been set up in inode_init_early */
1875 if (!hashdist)
1876 return;
1877
1878 inode_hashtable =
1879 alloc_large_system_hash("Inode-cache",
1880 sizeof(struct hlist_head),
1881 ihash_entries,
1882 14,
1883 0,
1884 &i_hash_shift,
1885 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00001886 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 0);
1888
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001889 for (loop = 0; loop < (1U << i_hash_shift); loop++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1891}
1892
1893void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
1894{
1895 inode->i_mode = mode;
1896 if (S_ISCHR(mode)) {
1897 inode->i_fop = &def_chr_fops;
1898 inode->i_rdev = rdev;
1899 } else if (S_ISBLK(mode)) {
1900 inode->i_fop = &def_blk_fops;
1901 inode->i_rdev = rdev;
1902 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04001903 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05001905 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07001907 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
1908 " inode %s:%lu\n", mode, inode->i_sb->s_id,
1909 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910}
1911EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001912
1913/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00001914 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001915 * @inode: New inode
1916 * @dir: Directory inode
1917 * @mode: mode of the new inode
1918 */
1919void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001920 umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001921{
1922 inode->i_uid = current_fsuid();
1923 if (dir && dir->i_mode & S_ISGID) {
1924 inode->i_gid = dir->i_gid;
1925 if (S_ISDIR(mode))
1926 mode |= S_ISGID;
1927 } else
1928 inode->i_gid = current_fsgid();
1929 inode->i_mode = mode;
1930}
1931EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07001932
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001933/**
1934 * inode_owner_or_capable - check current task permissions to inode
1935 * @inode: inode being checked
1936 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07001937 * Return true if current either has CAP_FOWNER in a namespace with the
1938 * inode owner uid mapped, or owns the file.
Serge E. Hallyne795b712011-03-23 16:43:25 -07001939 */
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001940bool inode_owner_or_capable(const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07001941{
Andy Lutomirski23adbe12014-06-10 12:45:42 -07001942 struct user_namespace *ns;
1943
Eric W. Biederman92361632012-02-08 07:07:50 -08001944 if (uid_eq(current_fsuid(), inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07001945 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07001946
1947 ns = current_user_ns();
1948 if (ns_capable(ns, CAP_FOWNER) && kuid_has_mapping(ns, inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07001949 return true;
1950 return false;
1951}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001952EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04001953
1954/*
1955 * Direct i/o helper functions
1956 */
1957static void __inode_dio_wait(struct inode *inode)
1958{
1959 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
1960 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
1961
1962 do {
1963 prepare_to_wait(wq, &q.wait, TASK_UNINTERRUPTIBLE);
1964 if (atomic_read(&inode->i_dio_count))
1965 schedule();
1966 } while (atomic_read(&inode->i_dio_count));
1967 finish_wait(wq, &q.wait);
1968}
1969
1970/**
1971 * inode_dio_wait - wait for outstanding DIO requests to finish
1972 * @inode: inode to wait for
1973 *
1974 * Waits for all pending direct I/O requests to finish so that we can
1975 * proceed with a truncate or equivalent operation.
1976 *
1977 * Must be called under a lock that serializes taking new references
1978 * to i_dio_count, usually by inode->i_mutex.
1979 */
1980void inode_dio_wait(struct inode *inode)
1981{
1982 if (atomic_read(&inode->i_dio_count))
1983 __inode_dio_wait(inode);
1984}
1985EXPORT_SYMBOL(inode_dio_wait);
1986
1987/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04001988 * inode_set_flags - atomically set some inode flags
1989 *
1990 * Note: the caller should be holding i_mutex, or else be sure that
1991 * they have exclusive access to the inode structure (i.e., while the
1992 * inode is being instantiated). The reason for the cmpxchg() loop
1993 * --- which wouldn't be necessary if all code paths which modify
1994 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001995 * code path which doesn't today so we use cmpxchg() out of an abundance
1996 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04001997 *
1998 * In the long run, i_mutex is overkill, and we should probably look
1999 * at using the i_lock spinlock to protect i_flags, and then make sure
2000 * it is so documented in include/linux/fs.h and that all code follows
2001 * the locking convention!!
2002 */
2003void inode_set_flags(struct inode *inode, unsigned int flags,
2004 unsigned int mask)
2005{
2006 unsigned int old_flags, new_flags;
2007
2008 WARN_ON_ONCE(flags & ~mask);
2009 do {
2010 old_flags = ACCESS_ONCE(inode->i_flags);
2011 new_flags = (old_flags & ~mask) | flags;
2012 } while (unlikely(cmpxchg(&inode->i_flags, old_flags,
2013 new_flags) != old_flags));
2014}
2015EXPORT_SYMBOL(inode_set_flags);