blob: d30640f7a193879d07f4ff2c12efe3b817a386f3 [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 Chinner55fa6092011-03-22 22:23:40 +110031 * inode_sb_list_lock protects:
32 * sb->s_inodes, inode->i_sb_list
Christoph Hellwigf758eea2011-04-21 18:19:44 -060033 * bdi->wb.list_lock protects:
Theodore Ts'o0ae45f62015-02-02 00:37:00 -050034 * bdi->wb.b_{dirty,io,more_io,dirty_time}, inode->i_wb_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 *
40 * inode_sb_list_lock
41 * 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
48 * inode_sb_list_lock
49 * 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
Dave Chinner55fa6092011-03-22 22:23:40 +110060__cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_sb_list_lock);
61
Linus Torvalds1da177e2005-04-16 15:20:36 -070062/*
Jens Axboe7dcda1c2011-04-05 23:51:48 +020063 * Empty aops. Can be used for the cases where the user does not
64 * define any of the address_space operations.
65 */
66const struct address_space_operations empty_aops = {
67};
68EXPORT_SYMBOL(empty_aops);
69
70/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 * Statistics gathering..
72 */
73struct inodes_stat_t inodes_stat;
74
Glauber Costa3942c072013-08-28 10:17:53 +100075static DEFINE_PER_CPU(unsigned long, nr_inodes);
76static DEFINE_PER_CPU(unsigned long, nr_unused);
Dave Chinnercffbc8a2010-10-23 05:03:02 -040077
Manish Katiyar6b3304b2009-03-31 19:35:54 +053078static struct kmem_cache *inode_cachep __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Glauber Costa3942c072013-08-28 10:17:53 +100080static long get_nr_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040081{
Nick Piggin3e880fb2011-01-07 17:49:19 +110082 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100083 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +110084 for_each_possible_cpu(i)
85 sum += per_cpu(nr_inodes, i);
86 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040087}
88
Glauber Costa3942c072013-08-28 10:17:53 +100089static inline long get_nr_inodes_unused(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040090{
Dave Chinnerfcb94f72011-07-08 14:14:38 +100091 int i;
Glauber Costa3942c072013-08-28 10:17:53 +100092 long sum = 0;
Dave Chinnerfcb94f72011-07-08 14:14:38 +100093 for_each_possible_cpu(i)
94 sum += per_cpu(nr_unused, i);
95 return sum < 0 ? 0 : sum;
Dave Chinnercffbc8a2010-10-23 05:03:02 -040096}
97
Glauber Costa3942c072013-08-28 10:17:53 +100098long get_nr_dirty_inodes(void)
Dave Chinnercffbc8a2010-10-23 05:03:02 -040099{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100100 /* not actually dirty inodes, but a wild approximation */
Glauber Costa3942c072013-08-28 10:17:53 +1000101 long nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400102 return nr_dirty > 0 ? nr_dirty : 0;
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400103}
104
105/*
106 * Handle nr_inode sysctl
107 */
108#ifdef CONFIG_SYSCTL
Joe Perches1f7e0612014-06-06 14:38:05 -0700109int proc_nr_inodes(struct ctl_table *table, int write,
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400110 void __user *buffer, size_t *lenp, loff_t *ppos)
111{
112 inodes_stat.nr_inodes = get_nr_inodes();
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000113 inodes_stat.nr_unused = get_nr_inodes_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000114 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400115}
116#endif
117
Al Virobd9b51e2014-11-18 23:38:21 -0500118static int no_open(struct inode *inode, struct file *file)
119{
120 return -ENXIO;
121}
122
David Chinner2cb15992008-10-30 17:32:23 +1100123/**
124 * inode_init_always - perform inode structure intialisation
Randy Dunlap0bc02f32009-01-06 14:41:13 -0800125 * @sb: superblock inode belongs to
126 * @inode: inode to initialise
David Chinner2cb15992008-10-30 17:32:23 +1100127 *
128 * These are initializations that need to be done on every inode
129 * allocation as the fields are not initialised by slab allocation.
130 */
Christoph Hellwig54e34622009-08-07 14:38:25 -0300131int inode_init_always(struct super_block *sb, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
Alexey Dobriyan6e1d5dc2009-09-21 17:01:11 -0700133 static const struct inode_operations empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500134 static const struct file_operations no_open_fops = {.open = no_open};
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530135 struct address_space *const mapping = &inode->i_data;
David Chinner2cb15992008-10-30 17:32:23 +1100136
137 inode->i_sb = sb;
138 inode->i_blkbits = sb->s_blocksize_bits;
139 inode->i_flags = 0;
140 atomic_set(&inode->i_count, 1);
141 inode->i_op = &empty_iops;
Al Virobd9b51e2014-11-18 23:38:21 -0500142 inode->i_fop = &no_open_fops;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200143 inode->__i_nlink = 1;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700144 inode->i_opflags = 0;
Eric W. Biederman92361632012-02-08 07:07:50 -0800145 i_uid_write(inode, 0);
146 i_gid_write(inode, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100147 atomic_set(&inode->i_writecount, 0);
148 inode->i_size = 0;
149 inode->i_blocks = 0;
150 inode->i_bytes = 0;
151 inode->i_generation = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100152 inode->i_pipe = NULL;
153 inode->i_bdev = NULL;
154 inode->i_cdev = NULL;
Al Viro61ba64f2015-05-02 09:54:06 -0400155 inode->i_link = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100156 inode->i_rdev = 0;
157 inode->dirtied_when = 0;
Mimi Zohar6146f0d2009-02-04 09:06:57 -0500158
159 if (security_inode_alloc(inode))
Christoph Hellwig54e34622009-08-07 14:38:25 -0300160 goto out;
David Chinner2cb15992008-10-30 17:32:23 +1100161 spin_lock_init(&inode->i_lock);
162 lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
163
164 mutex_init(&inode->i_mutex);
165 lockdep_set_class(&inode->i_mutex, &sb->s_type->i_mutex_key);
166
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400167 atomic_set(&inode->i_dio_count, 0);
David Chinner2cb15992008-10-30 17:32:23 +1100168
169 mapping->a_ops = &empty_aops;
170 mapping->host = inode;
171 mapping->flags = 0;
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700172 atomic_set(&mapping->i_mmap_writable, 0);
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800173 mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800174 mapping->private_data = NULL;
David Chinner2cb15992008-10-30 17:32:23 +1100175 mapping->writeback_index = 0;
David Chinner2cb15992008-10-30 17:32:23 +1100176 inode->i_private = NULL;
177 inode->i_mapping = mapping;
Al Virob3d9b7a2012-06-09 13:51:19 -0400178 INIT_HLIST_HEAD(&inode->i_dentry); /* buggered by rcu freeing */
Al Virof19d4a82009-06-08 19:50:45 -0400179#ifdef CONFIG_FS_POSIX_ACL
180 inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
181#endif
David Chinner2cb15992008-10-30 17:32:23 +1100182
Eric Paris3be25f42009-05-21 17:01:26 -0400183#ifdef CONFIG_FSNOTIFY
184 inode->i_fsnotify_mask = 0;
185#endif
Jeff Layton4a075e32015-01-16 15:05:54 -0500186 inode->i_flctx = NULL;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100187 this_cpu_inc(nr_inodes);
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400188
Christoph Hellwig54e34622009-08-07 14:38:25 -0300189 return 0;
Christoph Hellwig54e34622009-08-07 14:38:25 -0300190out:
191 return -ENOMEM;
David Chinner2cb15992008-10-30 17:32:23 +1100192}
193EXPORT_SYMBOL(inode_init_always);
194
195static struct inode *alloc_inode(struct super_block *sb)
196{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 struct inode *inode;
198
199 if (sb->s_op->alloc_inode)
200 inode = sb->s_op->alloc_inode(sb);
201 else
David Chinner2cb15992008-10-30 17:32:23 +1100202 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Christoph Hellwig54e34622009-08-07 14:38:25 -0300204 if (!inode)
205 return NULL;
206
207 if (unlikely(inode_init_always(sb, inode))) {
208 if (inode->i_sb->s_op->destroy_inode)
209 inode->i_sb->s_op->destroy_inode(inode);
210 else
211 kmem_cache_free(inode_cachep, inode);
212 return NULL;
213 }
214
215 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216}
217
Nick Pigginff0c7d12011-01-07 17:49:50 +1100218void free_inode_nonrcu(struct inode *inode)
219{
220 kmem_cache_free(inode_cachep, inode);
221}
222EXPORT_SYMBOL(free_inode_nonrcu);
223
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300224void __destroy_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
Eric Sesterhennb7542f82006-04-02 13:38:18 +0200226 BUG_ON(inode_has_buffers(inode));
Tejun Heo52ebea72015-05-22 17:13:37 -0400227 inode_detach_wb(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400229 fsnotify_inode_delete(inode);
Jeff Layton4a075e32015-01-16 15:05:54 -0500230 locks_free_lock_context(inode->i_flctx);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100231 if (!inode->i_nlink) {
232 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
233 atomic_long_dec(&inode->i_sb->s_remove_count);
234 }
235
Al Virof19d4a82009-06-08 19:50:45 -0400236#ifdef CONFIG_FS_POSIX_ACL
237 if (inode->i_acl && inode->i_acl != ACL_NOT_CACHED)
238 posix_acl_release(inode->i_acl);
239 if (inode->i_default_acl && inode->i_default_acl != ACL_NOT_CACHED)
240 posix_acl_release(inode->i_default_acl);
241#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100242 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300243}
244EXPORT_SYMBOL(__destroy_inode);
245
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100246static void i_callback(struct rcu_head *head)
247{
248 struct inode *inode = container_of(head, struct inode, i_rcu);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100249 kmem_cache_free(inode_cachep, inode);
250}
251
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200252static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300253{
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100254 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300255 __destroy_inode(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 if (inode->i_sb->s_op->destroy_inode)
257 inode->i_sb->s_op->destroy_inode(inode);
258 else
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100259 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100262/**
263 * drop_nlink - directly drop an inode's link count
264 * @inode: inode
265 *
266 * This is a low-level filesystem helper to replace any
267 * direct filesystem manipulation of i_nlink. In cases
268 * where we are attempting to track writes to the
269 * filesystem, a decrement to zero means an imminent
270 * write when the file is truncated and actually unlinked
271 * on the filesystem.
272 */
273void drop_nlink(struct inode *inode)
274{
275 WARN_ON(inode->i_nlink == 0);
276 inode->__i_nlink--;
277 if (!inode->i_nlink)
278 atomic_long_inc(&inode->i_sb->s_remove_count);
279}
280EXPORT_SYMBOL(drop_nlink);
281
282/**
283 * clear_nlink - directly zero an inode's link count
284 * @inode: inode
285 *
286 * This is a low-level filesystem helper to replace any
287 * direct filesystem manipulation of i_nlink. See
288 * drop_nlink() for why we care about i_nlink hitting zero.
289 */
290void clear_nlink(struct inode *inode)
291{
292 if (inode->i_nlink) {
293 inode->__i_nlink = 0;
294 atomic_long_inc(&inode->i_sb->s_remove_count);
295 }
296}
297EXPORT_SYMBOL(clear_nlink);
298
299/**
300 * set_nlink - directly set an inode's link count
301 * @inode: inode
302 * @nlink: new nlink (should be non-zero)
303 *
304 * This is a low-level filesystem helper to replace any
305 * direct filesystem manipulation of i_nlink.
306 */
307void set_nlink(struct inode *inode, unsigned int nlink)
308{
309 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100310 clear_nlink(inode);
311 } else {
312 /* Yes, some filesystems do change nlink from zero to one */
313 if (inode->i_nlink == 0)
314 atomic_long_dec(&inode->i_sb->s_remove_count);
315
316 inode->__i_nlink = nlink;
317 }
318}
319EXPORT_SYMBOL(set_nlink);
320
321/**
322 * inc_nlink - directly increment an inode's link count
323 * @inode: inode
324 *
325 * This is a low-level filesystem helper to replace any
326 * direct filesystem manipulation of i_nlink. Currently,
327 * it is only here for parity with dec_nlink().
328 */
329void inc_nlink(struct inode *inode)
330{
Al Virof4e0c302013-06-11 08:34:36 +0400331 if (unlikely(inode->i_nlink == 0)) {
332 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100333 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400334 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100335
336 inode->__i_nlink++;
337}
338EXPORT_SYMBOL(inc_nlink);
339
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100340void address_space_init_once(struct address_space *mapping)
341{
342 memset(mapping, 0, sizeof(*mapping));
343 INIT_RADIX_TREE(&mapping->page_tree, GFP_ATOMIC);
344 spin_lock_init(&mapping->tree_lock);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800345 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100346 INIT_LIST_HEAD(&mapping->private_list);
347 spin_lock_init(&mapping->private_lock);
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -0700348 mapping->i_mmap = RB_ROOT;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100349}
350EXPORT_SYMBOL(address_space_init_once);
351
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352/*
353 * These are initializations that only need to be done
354 * once, because the fields are idempotent across use
355 * of the inode, so let the slab aware of that.
356 */
357void inode_init_once(struct inode *inode)
358{
359 memset(inode, 0, sizeof(*inode));
360 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 INIT_LIST_HEAD(&inode->i_devices);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100362 INIT_LIST_HEAD(&inode->i_wb_list);
363 INIT_LIST_HEAD(&inode->i_lru);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100364 address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 i_size_ordered_init(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400366#ifdef CONFIG_FSNOTIFY
Eric Parise61ce862009-12-17 21:24:24 -0500367 INIT_HLIST_HEAD(&inode->i_fsnotify_marks);
Eric Paris3be25f42009-05-21 17:01:26 -0400368#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370EXPORT_SYMBOL(inode_init_once);
371
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700372static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530374 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Christoph Lametera35afb82007-05-16 22:10:57 -0700376 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377}
378
379/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100380 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530382void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
Nick Piggin9e38d862010-10-23 06:55:17 -0400384 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385}
386
Al Viro7de9c6ee2010-10-23 11:11:40 -0400387/*
388 * get additional reference to inode; caller must already hold one.
389 */
390void ihold(struct inode *inode)
391{
392 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
393}
394EXPORT_SYMBOL(ihold);
395
Nick Piggin9e38d862010-10-23 06:55:17 -0400396static void inode_lru_list_add(struct inode *inode)
397{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000398 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000399 this_cpu_inc(nr_unused);
Nick Piggin9e38d862010-10-23 06:55:17 -0400400}
401
Jan Kara4eff96d2012-11-26 16:29:51 -0800402/*
403 * Add inode to LRU if needed (inode is unused and clean).
404 *
405 * Needs inode->i_lock held.
406 */
407void inode_add_lru(struct inode *inode)
408{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500409 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
410 I_FREEING | I_WILL_FREE)) &&
Jan Kara4eff96d2012-11-26 16:29:51 -0800411 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & MS_ACTIVE)
412 inode_lru_list_add(inode);
413}
414
415
Nick Piggin9e38d862010-10-23 06:55:17 -0400416static void inode_lru_list_del(struct inode *inode)
417{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000418
419 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000420 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421}
422
Christoph Hellwig646ec462010-10-23 07:15:32 -0400423/**
424 * inode_sb_list_add - add inode to the superblock list of inodes
425 * @inode: inode to add
426 */
427void inode_sb_list_add(struct inode *inode)
428{
Dave Chinner55fa6092011-03-22 22:23:40 +1100429 spin_lock(&inode_sb_list_lock);
430 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
431 spin_unlock(&inode_sb_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400432}
433EXPORT_SYMBOL_GPL(inode_sb_list_add);
434
Dave Chinner55fa6092011-03-22 22:23:40 +1100435static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400436{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200437 if (!list_empty(&inode->i_sb_list)) {
438 spin_lock(&inode_sb_list_lock);
439 list_del_init(&inode->i_sb_list);
440 spin_unlock(&inode_sb_list_lock);
441 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400442}
443
Dave Chinner4c51acb2010-10-23 06:58:09 -0400444static unsigned long hash(struct super_block *sb, unsigned long hashval)
445{
446 unsigned long tmp;
447
448 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
449 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400450 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
451 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400452}
453
454/**
455 * __insert_inode_hash - hash an inode
456 * @inode: unhashed inode
457 * @hashval: unsigned long value used to locate this object in the
458 * inode_hashtable.
459 *
460 * Add an inode to the inode hash for this superblock.
461 */
462void __insert_inode_hash(struct inode *inode, unsigned long hashval)
463{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400464 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
465
Dave Chinner67a23c42011-03-22 22:23:42 +1100466 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100467 spin_lock(&inode->i_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400468 hlist_add_head(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100469 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100470 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400471}
472EXPORT_SYMBOL(__insert_inode_hash);
473
474/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200475 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400476 * @inode: inode to unhash
477 *
478 * Remove an inode from the superblock.
479 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200480void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400481{
Dave Chinner67a23c42011-03-22 22:23:42 +1100482 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100483 spin_lock(&inode->i_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400484 hlist_del_init(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100485 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100486 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400487}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200488EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400489
Jan Karadbd57682012-05-03 14:48:02 +0200490void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400491{
492 might_sleep();
Jan Kara08142572011-06-27 16:18:10 -0700493 /*
494 * We have to cycle tree_lock here because reclaim can be still in the
495 * process of removing the last page (in __delete_from_page_cache())
496 * and we must not free mapping under it.
497 */
498 spin_lock_irq(&inode->i_data.tree_lock);
Al Virob0683aa2010-06-04 20:55:25 -0400499 BUG_ON(inode->i_data.nrpages);
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700500 BUG_ON(inode->i_data.nrshadows);
Jan Kara08142572011-06-27 16:18:10 -0700501 spin_unlock_irq(&inode->i_data.tree_lock);
Al Virob0683aa2010-06-04 20:55:25 -0400502 BUG_ON(!list_empty(&inode->i_data.private_list));
503 BUG_ON(!(inode->i_state & I_FREEING));
504 BUG_ON(inode->i_state & I_CLEAR);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100505 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400506 inode->i_state = I_FREEING | I_CLEAR;
507}
Jan Karadbd57682012-05-03 14:48:02 +0200508EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400509
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100510/*
511 * Free the inode passed in, removing it from the lists it is still connected
512 * to. We remove any pages still attached to the inode and wait for any IO that
513 * is still in progress before finally destroying the inode.
514 *
515 * An inode must already be marked I_FREEING so that we avoid the inode being
516 * moved back onto lists if we race with other code that manipulates the lists
517 * (e.g. writeback_single_inode). The caller is responsible for setting this.
518 *
519 * An inode must already be removed from the LRU list before being evicted from
520 * the cache. This should occur atomically with setting the I_FREEING state
521 * flag, so no inodes here should ever be on the LRU when being evicted.
522 */
Al Viro644da592010-06-07 13:21:05 -0400523static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400524{
525 const struct super_operations *op = inode->i_sb->s_op;
526
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100527 BUG_ON(!(inode->i_state & I_FREEING));
528 BUG_ON(!list_empty(&inode->i_lru));
529
Eric Dumazetb12362b2011-07-28 06:11:47 +0200530 if (!list_empty(&inode->i_wb_list))
531 inode_wb_list_del(inode);
532
Dave Chinner55fa6092011-03-22 22:23:40 +1100533 inode_sb_list_del(inode);
534
Jan Kara169ebd92012-05-03 14:48:03 +0200535 /*
536 * Wait for flusher thread to be done with the inode so that filesystem
537 * does not start destroying it while writeback is still running. Since
538 * the inode has I_FREEING set, flusher thread won't start new work on
539 * the inode. We just have to wait for running writeback to finish.
540 */
541 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200542
Al Virobe7ce412010-06-04 19:40:39 -0400543 if (op->evict_inode) {
544 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400545 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700546 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200547 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400548 }
Al Viro661074e2010-06-04 20:19:55 -0400549 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
550 bd_forget(inode);
551 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
552 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100553
554 remove_inode_hash(inode);
555
556 spin_lock(&inode->i_lock);
557 wake_up_bit(&inode->i_state, __I_NEW);
558 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
559 spin_unlock(&inode->i_lock);
560
561 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400562}
563
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564/*
565 * dispose_list - dispose of the contents of a local list
566 * @head: the head of the list to free
567 *
568 * Dispose-list gets a local list with local inodes in it, so it doesn't
569 * need to worry about list corruption and SMP locks.
570 */
571static void dispose_list(struct list_head *head)
572{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 while (!list_empty(head)) {
574 struct inode *inode;
575
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100576 inode = list_first_entry(head, struct inode, i_lru);
577 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
Al Viro644da592010-06-07 13:21:05 -0400579 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581}
582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583/**
Al Viro63997e92010-10-25 20:49:35 -0400584 * evict_inodes - evict all evictable inodes for a superblock
585 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 *
Al Viro63997e92010-10-25 20:49:35 -0400587 * Make sure that no inodes with zero refcount are retained. This is
588 * called by superblock shutdown after having MS_ACTIVE flag removed,
589 * so any inode reaching zero refcount during or after that call will
590 * be immediately evicted.
591 */
592void evict_inodes(struct super_block *sb)
593{
594 struct inode *inode, *next;
595 LIST_HEAD(dispose);
596
Dave Chinner55fa6092011-03-22 22:23:40 +1100597 spin_lock(&inode_sb_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400598 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
599 if (atomic_read(&inode->i_count))
600 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100601
602 spin_lock(&inode->i_lock);
603 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
604 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400605 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100606 }
Al Viro63997e92010-10-25 20:49:35 -0400607
608 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100609 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100610 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100611 list_add(&inode->i_lru, &dispose);
Al Viro63997e92010-10-25 20:49:35 -0400612 }
Dave Chinner55fa6092011-03-22 22:23:40 +1100613 spin_unlock(&inode_sb_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400614
615 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400616}
617
618/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200619 * invalidate_inodes - attempt to free all inodes on a superblock
620 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100621 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200622 *
623 * Attempts to free all inodes for a given superblock. If there were any
624 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100625 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
626 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 */
NeilBrown93b270f2011-02-24 17:25:47 +1100628int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400630 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200631 struct inode *inode, *next;
632 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
Dave Chinner55fa6092011-03-22 22:23:40 +1100634 spin_lock(&inode_sb_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200635 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100636 spin_lock(&inode->i_lock);
637 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
638 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100640 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500641 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100642 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100643 busy = 1;
644 continue;
645 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200646 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100647 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200648 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 continue;
650 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200651
Christoph Hellwig99a38912010-10-23 19:07:20 +0200652 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100653 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100654 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100655 list_add(&inode->i_lru, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 }
Dave Chinner55fa6092011-03-22 22:23:40 +1100657 spin_unlock(&inode_sb_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
Christoph Hellwiga0318782010-10-24 19:40:33 +0200659 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
661 return busy;
662}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000665 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 *
667 * Any inodes which are pinned purely because of attached pagecache have their
Nick Piggin9e38d862010-10-23 06:55:17 -0400668 * pagecache removed. If the inode has metadata buffers attached to
669 * mapping->private_list then try to remove them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400671 * If the inode has the I_REFERENCED flag set, then it means that it has been
672 * used recently - the flag is set in iput_final(). When we encounter such an
673 * inode, clear the flag and move it to the back of the LRU so it gets another
674 * pass through the LRU before it gets reclaimed. This is necessary because of
675 * the fact we are doing lazy LRU updates to minimise lock contention so the
676 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
677 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800679static enum lru_status inode_lru_isolate(struct list_head *item,
680 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000681{
682 struct list_head *freeable = arg;
683 struct inode *inode = container_of(item, struct inode, i_lru);
684
685 /*
686 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
687 * If we fail to get the lock, just skip it.
688 */
689 if (!spin_trylock(&inode->i_lock))
690 return LRU_SKIP;
691
692 /*
693 * Referenced or dirty inodes are still in use. Give them another pass
694 * through the LRU as we canot reclaim them now.
695 */
696 if (atomic_read(&inode->i_count) ||
697 (inode->i_state & ~I_REFERENCED)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800698 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000699 spin_unlock(&inode->i_lock);
700 this_cpu_dec(nr_unused);
701 return LRU_REMOVED;
702 }
703
704 /* recently referenced inodes get one more pass */
705 if (inode->i_state & I_REFERENCED) {
706 inode->i_state &= ~I_REFERENCED;
707 spin_unlock(&inode->i_lock);
708 return LRU_ROTATE;
709 }
710
711 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
712 __iget(inode);
713 spin_unlock(&inode->i_lock);
714 spin_unlock(lru_lock);
715 if (remove_inode_buffers(inode)) {
716 unsigned long reap;
717 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
718 if (current_is_kswapd())
719 __count_vm_events(KSWAPD_INODESTEAL, reap);
720 else
721 __count_vm_events(PGINODESTEAL, reap);
722 if (current->reclaim_state)
723 current->reclaim_state->reclaimed_slab += reap;
724 }
725 iput(inode);
726 spin_lock(lru_lock);
727 return LRU_RETRY;
728 }
729
730 WARN_ON(inode->i_state & I_NEW);
731 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800732 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000733 spin_unlock(&inode->i_lock);
734
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000735 this_cpu_dec(nr_unused);
736 return LRU_REMOVED;
737}
738
739/*
740 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
741 * This is called from the superblock shrinker function with a number of inodes
742 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
743 * then are freed outside inode_lock by dispose_list().
744 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800745long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746{
747 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000748 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Vladimir Davydov503c3582015-02-12 14:58:47 -0800750 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
751 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000753 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754}
755
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756static void __wait_on_freeing_inode(struct inode *inode);
757/*
758 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530760static struct inode *find_inode(struct super_block *sb,
761 struct hlist_head *head,
762 int (*test)(struct inode *, void *),
763 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530765 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
767repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800768 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500769 if (inode->i_sb != sb)
770 continue;
771 if (!test(inode, data))
772 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100773 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400774 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 __wait_on_freeing_inode(inode);
776 goto repeat;
777 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400778 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100779 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400780 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400782 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783}
784
785/*
786 * find_inode_fast is the fast path version of find_inode, see the comment at
787 * iget_locked for details.
788 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530789static struct inode *find_inode_fast(struct super_block *sb,
790 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530792 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
794repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800795 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500796 if (inode->i_ino != ino)
797 continue;
798 if (inode->i_sb != sb)
799 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100800 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400801 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 __wait_on_freeing_inode(inode);
803 goto repeat;
804 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400805 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100806 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400807 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400809 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810}
811
Eric Dumazetf991bd22010-10-23 11:18:01 -0400812/*
813 * Each cpu owns a range of LAST_INO_BATCH numbers.
814 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
815 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100816 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400817 * This does not significantly increase overflow rate because every CPU can
818 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
819 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
820 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
821 * overflow rate by 2x, which does not seem too significant.
822 *
823 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
824 * error if st_ino won't fit in target struct field. Use 32bit counter
825 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100826 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400827#define LAST_INO_BATCH 1024
828static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100829
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400830unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400831{
832 unsigned int *p = &get_cpu_var(last_ino);
833 unsigned int res = *p;
834
835#ifdef CONFIG_SMP
836 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
837 static atomic_t shared_last_ino;
838 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
839
840 res = next - LAST_INO_BATCH;
841 }
842#endif
843
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300844 res++;
845 /* get_next_ino should not provide a 0 inode number */
846 if (unlikely(!res))
847 res++;
848 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400849 put_cpu_var(last_ino);
850 return res;
David Chinner8290c352008-10-30 17:35:24 +1100851}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400852EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200855 * new_inode_pseudo - obtain an inode
856 * @sb: superblock
857 *
858 * Allocates a new inode for given superblock.
859 * Inode wont be chained in superblock s_inodes list
860 * This means :
861 * - fs can't be unmount
862 * - quotas, fsnotify, writeback can't work
863 */
864struct inode *new_inode_pseudo(struct super_block *sb)
865{
866 struct inode *inode = alloc_inode(sb);
867
868 if (inode) {
869 spin_lock(&inode->i_lock);
870 inode->i_state = 0;
871 spin_unlock(&inode->i_lock);
872 INIT_LIST_HEAD(&inode->i_sb_list);
873 }
874 return inode;
875}
876
877/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 * new_inode - obtain an inode
879 * @sb: superblock
880 *
Mel Gorman769848c2007-07-17 04:03:05 -0700881 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800882 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700883 * If HIGHMEM pages are unsuitable or it is known that pages allocated
884 * for the page cache are not reclaimable or migratable,
885 * mapping_set_gfp_mask() must be called with suitable flags on the
886 * newly created inode's mapping
887 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 */
889struct inode *new_inode(struct super_block *sb)
890{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530891 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
Dave Chinner55fa6092011-03-22 22:23:40 +1100893 spin_lock_prefetch(&inode_sb_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530894
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200895 inode = new_inode_pseudo(sb);
896 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100897 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 return inode;
899}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900EXPORT_SYMBOL(new_inode);
901
Peter Zijlstra14358e62007-10-14 01:38:33 +0200902#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400903void lockdep_annotate_inode_mutex_key(struct inode *inode)
904{
Namhyung Kima3314a02010-10-11 22:38:00 +0900905 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200906 struct file_system_type *type = inode->i_sb->s_type;
907
Jan Kara9a7aa122009-06-04 15:26:49 +0200908 /* Set new key only if filesystem hasn't already changed it */
Tyler Hicks978d6d82011-12-12 10:02:30 -0600909 if (lockdep_match_class(&inode->i_mutex, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200910 /*
911 * ensure nobody is actually holding i_mutex
912 */
913 mutex_destroy(&inode->i_mutex);
914 mutex_init(&inode->i_mutex);
915 lockdep_set_class(&inode->i_mutex,
916 &type->i_mutex_dir_key);
917 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200918 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400919}
920EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200921#endif
Josh Boyere096d0c2011-08-25 07:48:12 -0400922
923/**
924 * unlock_new_inode - clear the I_NEW state and wake up any waiters
925 * @inode: new inode to unlock
926 *
927 * Called when the inode is fully initialised to clear the new state of the
928 * inode and wake up anyone waiting for the inode to finish initialisation.
929 */
930void unlock_new_inode(struct inode *inode)
931{
932 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100933 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100934 WARN_ON(!(inode->i_state & I_NEW));
935 inode->i_state &= ~I_NEW;
Al Viro310fa7a2012-03-10 17:07:28 -0500936 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +1100937 wake_up_bit(&inode->i_state, __I_NEW);
938 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940EXPORT_SYMBOL(unlock_new_inode);
941
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400942/**
J. Bruce Fields375e2892012-04-18 15:16:33 -0400943 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200944 *
945 * Lock any non-NULL argument that is not a directory.
946 * Zero, one or two objects may be locked by this function.
947 *
J. Bruce Fields375e2892012-04-18 15:16:33 -0400948 * @inode1: first inode to lock
949 * @inode2: second inode to lock
950 */
951void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
952{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200953 if (inode1 > inode2)
954 swap(inode1, inode2);
955
956 if (inode1 && !S_ISDIR(inode1->i_mode))
J. Bruce Fields275555162012-04-25 07:19:52 -0400957 mutex_lock(&inode1->i_mutex);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200958 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400959 mutex_lock_nested(&inode2->i_mutex, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -0400960}
961EXPORT_SYMBOL(lock_two_nondirectories);
962
963/**
964 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
965 * @inode1: first inode to unlock
966 * @inode2: second inode to unlock
967 */
968void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
969{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200970 if (inode1 && !S_ISDIR(inode1->i_mode))
971 mutex_unlock(&inode1->i_mutex);
972 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
J. Bruce Fields375e2892012-04-18 15:16:33 -0400973 mutex_unlock(&inode2->i_mutex);
974}
975EXPORT_SYMBOL(unlock_two_nondirectories);
976
977/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400978 * iget5_locked - obtain an inode from a mounted file system
979 * @sb: super block of file system
980 * @hashval: hash value (usually inode number) to get
981 * @test: callback used for comparisons between inodes
982 * @set: callback used to initialize a new struct inode
983 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400985 * Search for the inode specified by @hashval and @data in the inode cache,
986 * and if present it is return it with an increased reference count. This is
987 * a generalized version of iget_locked() for file systems where the inode
988 * number is not sufficient for unique identification of an inode.
989 *
990 * If the inode is not in cache, allocate a new inode and return it locked,
991 * hashed, and with the I_NEW flag set. The file system gets to fill it in
992 * before unlocking it via unlock_new_inode().
993 *
994 * Note both @test and @set are called with the inode_hash_lock held, so can't
995 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400997struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
998 int (*test)(struct inode *, void *),
999 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001001 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301002 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001004 spin_lock(&inode_hash_lock);
1005 inode = find_inode(sb, head, test, data);
1006 spin_unlock(&inode_hash_lock);
1007
1008 if (inode) {
1009 wait_on_inode(inode);
1010 return inode;
1011 }
1012
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 inode = alloc_inode(sb);
1014 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301015 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
Dave Chinner67a23c42011-03-22 22:23:42 +11001017 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 /* We released the lock, so.. */
1019 old = find_inode(sb, head, test, data);
1020 if (!old) {
1021 if (set(inode, data))
1022 goto set_failed;
1023
Dave Chinner250df6e2011-03-22 22:23:36 +11001024 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001025 inode->i_state = I_NEW;
Dave Chinner250df6e2011-03-22 22:23:36 +11001026 hlist_add_head(&inode->i_hash, head);
1027 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001028 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001029 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030
1031 /* Return the locked inode with I_NEW set, the
1032 * caller is responsible for filling in the contents
1033 */
1034 return inode;
1035 }
1036
1037 /*
1038 * Uhhuh, somebody else created the same inode under
1039 * us. Use the old inode instead of the one we just
1040 * allocated.
1041 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001042 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 destroy_inode(inode);
1044 inode = old;
1045 wait_on_inode(inode);
1046 }
1047 return inode;
1048
1049set_failed:
Dave Chinner67a23c42011-03-22 22:23:42 +11001050 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 destroy_inode(inode);
1052 return NULL;
1053}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001054EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001056/**
1057 * iget_locked - obtain an inode from a mounted file system
1058 * @sb: super block of file system
1059 * @ino: inode number to get
1060 *
1061 * Search for the inode specified by @ino in the inode cache and if present
1062 * return it with an increased reference count. This is for file systems
1063 * where the inode number is sufficient for unique identification of an inode.
1064 *
1065 * If the inode is not in cache, allocate a new inode and return it locked,
1066 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1067 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001069struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001071 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301072 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001074 spin_lock(&inode_hash_lock);
1075 inode = find_inode_fast(sb, head, ino);
1076 spin_unlock(&inode_hash_lock);
1077 if (inode) {
1078 wait_on_inode(inode);
1079 return inode;
1080 }
1081
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 inode = alloc_inode(sb);
1083 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301084 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085
Dave Chinner67a23c42011-03-22 22:23:42 +11001086 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 /* We released the lock, so.. */
1088 old = find_inode_fast(sb, head, ino);
1089 if (!old) {
1090 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001091 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001092 inode->i_state = I_NEW;
Dave Chinner250df6e2011-03-22 22:23:36 +11001093 hlist_add_head(&inode->i_hash, head);
1094 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001095 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001096 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097
1098 /* Return the locked inode with I_NEW set, the
1099 * caller is responsible for filling in the contents
1100 */
1101 return inode;
1102 }
1103
1104 /*
1105 * Uhhuh, somebody else created the same inode under
1106 * us. Use the old inode instead of the one we just
1107 * allocated.
1108 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001109 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 destroy_inode(inode);
1111 inode = old;
1112 wait_on_inode(inode);
1113 }
1114 return inode;
1115}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001116EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001118/*
1119 * search the inode cache for a matching inode number.
1120 * If we find one, then the inode number we are trying to
1121 * allocate is not unique and so we should not use it.
1122 *
1123 * Returns 1 if the inode number is unique, 0 if it is not.
1124 */
1125static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1126{
1127 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001128 struct inode *inode;
1129
Dave Chinner67a23c42011-03-22 22:23:42 +11001130 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001131 hlist_for_each_entry(inode, b, i_hash) {
Dave Chinner67a23c42011-03-22 22:23:42 +11001132 if (inode->i_ino == ino && inode->i_sb == sb) {
1133 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001134 return 0;
Dave Chinner67a23c42011-03-22 22:23:42 +11001135 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001136 }
Dave Chinner67a23c42011-03-22 22:23:42 +11001137 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001138
1139 return 1;
1140}
1141
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142/**
1143 * iunique - get a unique inode number
1144 * @sb: superblock
1145 * @max_reserved: highest reserved inode number
1146 *
1147 * Obtain an inode number that is unique on the system for a given
1148 * superblock. This is used by file systems that have no natural
1149 * permanent inode numbering system. An inode number is returned that
1150 * is higher than the reserved limit but unique.
1151 *
1152 * BUGS:
1153 * With a large number of inodes live on the file system this function
1154 * currently becomes quite slow.
1155 */
1156ino_t iunique(struct super_block *sb, ino_t max_reserved)
1157{
Jeff Layton866b04f2007-05-08 00:32:29 -07001158 /*
1159 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1160 * error if st_ino won't fit in target struct field. Use 32bit counter
1161 * here to attempt to avoid that.
1162 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001163 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001164 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001167 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001168 do {
1169 if (counter <= max_reserved)
1170 counter = max_reserved + 1;
1171 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001172 } while (!test_inode_iunique(sb, res));
1173 spin_unlock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001174
1175 return res;
1176}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177EXPORT_SYMBOL(iunique);
1178
1179struct inode *igrab(struct inode *inode)
1180{
Dave Chinner250df6e2011-03-22 22:23:36 +11001181 spin_lock(&inode->i_lock);
1182 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001184 spin_unlock(&inode->i_lock);
1185 } else {
1186 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 /*
1188 * Handle the case where s_op->clear_inode is not been
1189 * called yet, and somebody is calling igrab
1190 * while the inode is getting freed.
1191 */
1192 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001193 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 return inode;
1195}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196EXPORT_SYMBOL(igrab);
1197
1198/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001199 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 * @sb: super block of file system to search
1201 * @hashval: hash value (usually inode number) to search for
1202 * @test: callback used for comparisons between inodes
1203 * @data: opaque data pointer to pass to @test
1204 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001205 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001207 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001208 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001209 * Note: I_NEW is not waited upon so you have to be very careful what you do
1210 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001211 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001212 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001213 */
1214struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1215 int (*test)(struct inode *, void *), void *data)
1216{
1217 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001218 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001219
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001220 spin_lock(&inode_hash_lock);
1221 inode = find_inode(sb, head, test, data);
1222 spin_unlock(&inode_hash_lock);
1223
1224 return inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001225}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001226EXPORT_SYMBOL(ilookup5_nowait);
1227
1228/**
1229 * ilookup5 - search for an inode in the inode cache
1230 * @sb: super block of file system to search
1231 * @hashval: hash value (usually inode number) to search for
1232 * @test: callback used for comparisons between inodes
1233 * @data: opaque data pointer to pass to @test
1234 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001235 * Search for the inode specified by @hashval and @data in the inode cache,
1236 * and if the inode is in the cache, return the inode with an incremented
1237 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001238 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001240 * This is a generalized version of ilookup() for file systems where the
1241 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001243 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 */
1245struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1246 int (*test)(struct inode *, void *), void *data)
1247{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001248 struct inode *inode = ilookup5_nowait(sb, hashval, test, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001250 if (inode)
1251 wait_on_inode(inode);
1252 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254EXPORT_SYMBOL(ilookup5);
1255
1256/**
1257 * ilookup - search for an inode in the inode cache
1258 * @sb: super block of file system to search
1259 * @ino: inode number to search for
1260 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001261 * Search for the inode @ino in the inode cache, and if the inode is in the
1262 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 */
1264struct inode *ilookup(struct super_block *sb, unsigned long ino)
1265{
1266 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001267 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001269 spin_lock(&inode_hash_lock);
1270 inode = find_inode_fast(sb, head, ino);
1271 spin_unlock(&inode_hash_lock);
1272
1273 if (inode)
1274 wait_on_inode(inode);
1275 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277EXPORT_SYMBOL(ilookup);
1278
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001279/**
1280 * find_inode_nowait - find an inode in the inode cache
1281 * @sb: super block of file system to search
1282 * @hashval: hash value (usually inode number) to search for
1283 * @match: callback used for comparisons between inodes
1284 * @data: opaque data pointer to pass to @match
1285 *
1286 * Search for the inode specified by @hashval and @data in the inode
1287 * cache, where the helper function @match will return 0 if the inode
1288 * does not match, 1 if the inode does match, and -1 if the search
1289 * should be stopped. The @match function must be responsible for
1290 * taking the i_lock spin_lock and checking i_state for an inode being
1291 * freed or being initialized, and incrementing the reference count
1292 * before returning 1. It also must not sleep, since it is called with
1293 * the inode_hash_lock spinlock held.
1294 *
1295 * This is a even more generalized version of ilookup5() when the
1296 * function must never block --- find_inode() can block in
1297 * __wait_on_freeing_inode() --- or when the caller can not increment
1298 * the reference count because the resulting iput() might cause an
1299 * inode eviction. The tradeoff is that the @match funtion must be
1300 * very carefully implemented.
1301 */
1302struct inode *find_inode_nowait(struct super_block *sb,
1303 unsigned long hashval,
1304 int (*match)(struct inode *, unsigned long,
1305 void *),
1306 void *data)
1307{
1308 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1309 struct inode *inode, *ret_inode = NULL;
1310 int mval;
1311
1312 spin_lock(&inode_hash_lock);
1313 hlist_for_each_entry(inode, head, i_hash) {
1314 if (inode->i_sb != sb)
1315 continue;
1316 mval = match(inode, hashval, data);
1317 if (mval == 0)
1318 continue;
1319 if (mval == 1)
1320 ret_inode = inode;
1321 goto out;
1322 }
1323out:
1324 spin_unlock(&inode_hash_lock);
1325 return ret_inode;
1326}
1327EXPORT_SYMBOL(find_inode_nowait);
1328
Al Viro261bca82008-12-30 01:48:21 -05001329int insert_inode_locked(struct inode *inode)
1330{
1331 struct super_block *sb = inode->i_sb;
1332 ino_t ino = inode->i_ino;
1333 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001334
Al Viro261bca82008-12-30 01:48:21 -05001335 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001336 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001337 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001338 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001339 if (old->i_ino != ino)
1340 continue;
1341 if (old->i_sb != sb)
1342 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001343 spin_lock(&old->i_lock);
1344 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1345 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001346 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001347 }
Al Viro72a43d62009-05-13 19:13:40 +01001348 break;
1349 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001350 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001351 spin_lock(&inode->i_lock);
1352 inode->i_state |= I_NEW;
Al Viro261bca82008-12-30 01:48:21 -05001353 hlist_add_head(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001354 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001355 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001356 return 0;
1357 }
1358 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001359 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001360 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001361 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001362 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001363 iput(old);
1364 return -EBUSY;
1365 }
1366 iput(old);
1367 }
1368}
Al Viro261bca82008-12-30 01:48:21 -05001369EXPORT_SYMBOL(insert_inode_locked);
1370
1371int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1372 int (*test)(struct inode *, void *), void *data)
1373{
1374 struct super_block *sb = inode->i_sb;
1375 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Al Viro261bca82008-12-30 01:48:21 -05001376
Al Viro261bca82008-12-30 01:48:21 -05001377 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001378 struct inode *old = NULL;
1379
Dave Chinner67a23c42011-03-22 22:23:42 +11001380 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001381 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001382 if (old->i_sb != sb)
1383 continue;
1384 if (!test(old, data))
1385 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001386 spin_lock(&old->i_lock);
1387 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1388 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001389 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001390 }
Al Viro72a43d62009-05-13 19:13:40 +01001391 break;
1392 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001393 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001394 spin_lock(&inode->i_lock);
1395 inode->i_state |= I_NEW;
Al Viro261bca82008-12-30 01:48:21 -05001396 hlist_add_head(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001397 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001398 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001399 return 0;
1400 }
1401 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001402 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001403 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001404 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001405 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001406 iput(old);
1407 return -EBUSY;
1408 }
1409 iput(old);
1410 }
1411}
Al Viro261bca82008-12-30 01:48:21 -05001412EXPORT_SYMBOL(insert_inode_locked4);
1413
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Al Viro45321ac2010-06-07 13:43:19 -04001415int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416{
Al Viro45321ac2010-06-07 13:43:19 -04001417 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419EXPORT_SYMBOL(generic_delete_inode);
1420
Al Viro45321ac2010-06-07 13:43:19 -04001421/*
Al Viro45321ac2010-06-07 13:43:19 -04001422 * Called when we're dropping the last reference
1423 * to an inode.
1424 *
1425 * Call the FS "drop_inode()" function, defaulting to
1426 * the legacy UNIX filesystem behaviour. If it tells
1427 * us to evict inode, do so. Otherwise, retain inode
1428 * in cache if fs is alive, sync and evict if fs is
1429 * shutting down.
1430 */
1431static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432{
1433 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001434 const struct super_operations *op = inode->i_sb->s_op;
1435 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
Dave Chinner250df6e2011-03-22 22:23:36 +11001437 WARN_ON(inode->i_state & I_NEW);
1438
Al Viroe7f59092011-07-07 15:45:59 -04001439 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001440 drop = op->drop_inode(inode);
1441 else
1442 drop = generic_drop_inode(inode);
1443
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001444 if (!drop && (sb->s_flags & MS_ACTIVE)) {
1445 inode->i_state |= I_REFERENCED;
Jan Kara4eff96d2012-11-26 16:29:51 -08001446 inode_add_lru(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001447 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001448 return;
1449 }
1450
Al Viro45321ac2010-06-07 13:43:19 -04001451 if (!drop) {
Alexander Viro991114c2005-06-23 00:09:01 -07001452 inode->i_state |= I_WILL_FREE;
Dave Chinner250df6e2011-03-22 22:23:36 +11001453 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 write_inode_now(inode, 1);
Dave Chinner250df6e2011-03-22 22:23:36 +11001455 spin_lock(&inode->i_lock);
Nick Piggin7ef0d732009-03-12 14:31:38 -07001456 WARN_ON(inode->i_state & I_NEW);
Alexander Viro991114c2005-06-23 00:09:01 -07001457 inode->i_state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001459
Alexander Viro991114c2005-06-23 00:09:01 -07001460 inode->i_state |= I_FREEING;
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001461 if (!list_empty(&inode->i_lru))
1462 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001463 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001464
1465 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466}
1467
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301469 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 * @inode: inode to put
1471 *
1472 * Puts an inode, dropping its usage count. If the inode use count hits
1473 * zero, the inode is then freed and may also be destroyed.
1474 *
1475 * Consequently, iput() can sleep.
1476 */
1477void iput(struct inode *inode)
1478{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001479 if (!inode)
1480 return;
1481 BUG_ON(inode->i_state & I_CLEAR);
1482retry:
1483 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1484 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1485 atomic_inc(&inode->i_count);
1486 inode->i_state &= ~I_DIRTY_TIME;
1487 spin_unlock(&inode->i_lock);
1488 trace_writeback_lazytime_iput(inode);
1489 mark_inode_dirty_sync(inode);
1490 goto retry;
1491 }
1492 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 }
1494}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495EXPORT_SYMBOL(iput);
1496
1497/**
1498 * bmap - find a block number in a file
1499 * @inode: inode of file
1500 * @block: block to find
1501 *
1502 * Returns the block number on the device holding the inode that
1503 * is the disk block number for the block of the file requested.
1504 * That is, asked for block 4 of inode 1 the function will return the
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301505 * disk block relative to the disk start that holds that block of the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 * file.
1507 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301508sector_t bmap(struct inode *inode, sector_t block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509{
1510 sector_t res = 0;
1511 if (inode->i_mapping->a_ops->bmap)
1512 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1513 return res;
1514}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515EXPORT_SYMBOL(bmap);
1516
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001517/*
1518 * With relative atime, only update atime if the previous atime is
1519 * earlier than either the ctime or mtime or if at least a day has
1520 * passed since the last atime update.
1521 */
1522static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
1523 struct timespec now)
1524{
1525
1526 if (!(mnt->mnt_flags & MNT_RELATIME))
1527 return 1;
1528 /*
1529 * Is mtime younger than atime? If yes, update atime:
1530 */
1531 if (timespec_compare(&inode->i_mtime, &inode->i_atime) >= 0)
1532 return 1;
1533 /*
1534 * Is ctime younger than atime? If yes, update atime:
1535 */
1536 if (timespec_compare(&inode->i_ctime, &inode->i_atime) >= 0)
1537 return 1;
1538
1539 /*
1540 * Is the previous atime value older than a day? If yes,
1541 * update atime:
1542 */
1543 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1544 return 1;
1545 /*
1546 * Good, we can skip the atime update:
1547 */
1548 return 0;
1549}
1550
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001551int generic_update_time(struct inode *inode, struct timespec *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001552{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001553 int iflags = I_DIRTY_TIME;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001554
1555 if (flags & S_ATIME)
1556 inode->i_atime = *time;
1557 if (flags & S_VERSION)
1558 inode_inc_iversion(inode);
1559 if (flags & S_CTIME)
1560 inode->i_ctime = *time;
1561 if (flags & S_MTIME)
1562 inode->i_mtime = *time;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001563
1564 if (!(inode->i_sb->s_flags & MS_LAZYTIME) || (flags & S_VERSION))
1565 iflags |= I_DIRTY_SYNC;
1566 __mark_inode_dirty(inode, iflags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001567 return 0;
1568}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001569EXPORT_SYMBOL(generic_update_time);
1570
1571/*
1572 * This does the actual work of updating an inodes time or version. Must have
1573 * had called mnt_want_write() before calling this.
1574 */
1575static int update_time(struct inode *inode, struct timespec *time, int flags)
1576{
1577 int (*update_time)(struct inode *, struct timespec *, int);
1578
1579 update_time = inode->i_op->update_time ? inode->i_op->update_time :
1580 generic_update_time;
1581
1582 return update_time(inode, time, flags);
1583}
Josef Bacikc3b2da32012-03-26 09:59:21 -04001584
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585/**
Christoph Hellwig869243a2006-01-09 20:52:03 -08001586 * touch_atime - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001587 * @path: the &struct path to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 *
1589 * Update the accessed time on an inode and mark it for writeback.
1590 * This function automatically handles read only file systems and media,
1591 * as well as the "noatime" flag and inode specific "noatime" markers.
1592 */
NeilBrown8fa9dd22015-03-23 13:37:40 +11001593bool atime_needs_update(const struct path *path, struct inode *inode)
1594{
1595 struct vfsmount *mnt = path->mnt;
1596 struct timespec now;
1597
1598 if (inode->i_flags & S_NOATIME)
1599 return false;
1600 if (IS_NOATIME(inode))
1601 return false;
1602 if ((inode->i_sb->s_flags & MS_NODIRATIME) && S_ISDIR(inode->i_mode))
1603 return false;
1604
1605 if (mnt->mnt_flags & MNT_NOATIME)
1606 return false;
1607 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1608 return false;
1609
1610 now = current_fs_time(inode->i_sb);
1611
1612 if (!relatime_need_update(mnt, inode, now))
1613 return false;
1614
1615 if (timespec_equal(&inode->i_atime, &now))
1616 return false;
1617
1618 return true;
1619}
1620
Al Virobadcf2b2013-07-16 18:15:46 +04001621void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622{
Al Viro68ac1232012-03-15 08:21:57 -04001623 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001624 struct inode *inode = d_inode(path->dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 struct timespec now;
1626
NeilBrown8fa9dd22015-03-23 13:37:40 +11001627 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001628 return;
1629
Jan Kara5d37e9e2012-06-12 16:20:36 +02001630 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001631 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001632
NeilBrown8fa9dd22015-03-23 13:37:40 +11001633 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001634 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001635 /*
1636 * File systems can error out when updating inodes if they need to
1637 * allocate new space to modify an inode (such is the case for
1638 * Btrfs), but since we touch atime while walking down the path we
1639 * really don't care if we failed to update the atime of the file,
1640 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001641 * We may also fail on filesystems that have the ability to make parts
1642 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001643 */
NeilBrown8fa9dd22015-03-23 13:37:40 +11001644 now = current_fs_time(inode->i_sb);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001645 update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001646 __mnt_drop_write(mnt);
1647skip_update:
1648 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001650EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
Cong Wang3ed37642012-05-15 14:57:33 +08001652/*
1653 * The logic we want is
1654 *
1655 * if suid or (sgid and xgrp)
1656 * remove privs
1657 */
1658int should_remove_suid(struct dentry *dentry)
1659{
David Howellsdf2b1af2015-03-17 22:26:15 +00001660 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001661 int kill = 0;
1662
1663 /* suid always must be killed */
1664 if (unlikely(mode & S_ISUID))
1665 kill = ATTR_KILL_SUID;
1666
1667 /*
1668 * sgid without any exec bits is just a mandatory locking mark; leave
1669 * it alone. If some exec bits are set, it's a real sgid; kill it.
1670 */
1671 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1672 kill |= ATTR_KILL_SGID;
1673
1674 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1675 return kill;
1676
1677 return 0;
1678}
1679EXPORT_SYMBOL(should_remove_suid);
1680
Jan Karadbfae0c2015-05-21 16:05:54 +02001681/*
1682 * Return mask of changes for notify_change() that need to be done as a
1683 * response to write or truncate. Return 0 if nothing has to be changed.
1684 * Negative value on error (change should be denied).
1685 */
Jan Kara45f147a2015-05-21 16:05:55 +02001686int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001687{
Jan Karadbfae0c2015-05-21 16:05:54 +02001688 struct inode *inode = d_inode(dentry);
1689 int mask = 0;
1690 int ret;
1691
1692 if (IS_NOSEC(inode))
1693 return 0;
1694
1695 mask = should_remove_suid(dentry);
1696 ret = security_inode_need_killpriv(dentry);
1697 if (ret < 0)
1698 return ret;
1699 if (ret)
1700 mask |= ATTR_KILL_PRIV;
1701 return mask;
1702}
Jan Kara45f147a2015-05-21 16:05:55 +02001703EXPORT_SYMBOL(dentry_needs_remove_privs);
Jan Karadbfae0c2015-05-21 16:05:54 +02001704
1705static int __remove_privs(struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001706{
1707 struct iattr newattrs;
1708
1709 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001710 /*
1711 * Note we call this on write, so notify_change will not
1712 * encounter any conflicting delegations:
1713 */
1714 return notify_change(dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001715}
1716
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001717/*
1718 * Remove special file priviledges (suid, capabilities) when file is written
1719 * to or truncated.
1720 */
1721int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001722{
1723 struct dentry *dentry = file->f_path.dentry;
David Howellsdf2b1af2015-03-17 22:26:15 +00001724 struct inode *inode = d_inode(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001725 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001726 int error = 0;
1727
1728 /* Fast path for nothing security related */
1729 if (IS_NOSEC(inode))
1730 return 0;
1731
Jan Karadbfae0c2015-05-21 16:05:54 +02001732 kill = file_needs_remove_privs(file);
1733 if (kill < 0)
1734 return kill;
1735 if (kill)
1736 error = __remove_privs(dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001737 if (!error)
1738 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001739
1740 return error;
1741}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001742EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001743
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001745 * file_update_time - update mtime and ctime time
1746 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001748 * Update the mtime and ctime members of an inode and mark the inode
1749 * for writeback. Note that this function is meant exclusively for
1750 * usage in the file write path of filesystems, and filesystems may
1751 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001752 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001753 * timestamps are handled by the server. This can return an error for
1754 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 */
1756
Josef Bacikc3b2da32012-03-26 09:59:21 -04001757int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758{
Al Viro496ad9a2013-01-23 17:07:38 -05001759 struct inode *inode = file_inode(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 struct timespec now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001761 int sync_it = 0;
1762 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
Andi Kleence06e0b2009-09-18 13:05:48 -07001764 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001766 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001767
Andi Kleence06e0b2009-09-18 13:05:48 -07001768 now = current_fs_time(inode->i_sb);
1769 if (!timespec_equal(&inode->i_mtime, &now))
1770 sync_it = S_MTIME;
1771
1772 if (!timespec_equal(&inode->i_ctime, &now))
1773 sync_it |= S_CTIME;
1774
1775 if (IS_I_VERSION(inode))
1776 sync_it |= S_VERSION;
1777
1778 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001779 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780
Andi Kleence06e0b2009-09-18 13:05:48 -07001781 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02001782 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001783 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784
Josef Bacikc3b2da32012-03-26 09:59:21 -04001785 ret = update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02001786 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001787
1788 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789}
Christoph Hellwig870f4812006-01-09 20:52:01 -08001790EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791
1792int inode_needs_sync(struct inode *inode)
1793{
1794 if (IS_SYNC(inode))
1795 return 1;
1796 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1797 return 1;
1798 return 0;
1799}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800EXPORT_SYMBOL(inode_needs_sync);
1801
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07001803 * If we try to find an inode in the inode hash while it is being
1804 * deleted, we have to wait until the filesystem completes its
1805 * deletion before reporting that it isn't found. This function waits
1806 * until the deletion _might_ have completed. Callers are responsible
1807 * to recheck inode state.
1808 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001809 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11001810 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
1811 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 */
1813static void __wait_on_freeing_inode(struct inode *inode)
1814{
1815 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001816 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1817 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001819 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001820 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 schedule();
1822 finish_wait(wq, &wait.wait);
Dave Chinner67a23c42011-03-22 22:23:42 +11001823 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824}
1825
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826static __initdata unsigned long ihash_entries;
1827static int __init set_ihash_entries(char *str)
1828{
1829 if (!str)
1830 return 0;
1831 ihash_entries = simple_strtoul(str, &str, 0);
1832 return 1;
1833}
1834__setup("ihash_entries=", set_ihash_entries);
1835
1836/*
1837 * Initialize the waitqueues and inode hash table.
1838 */
1839void __init inode_init_early(void)
1840{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001841 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842
1843 /* If hashes are distributed across NUMA nodes, defer
1844 * hash allocation until vmalloc space is available.
1845 */
1846 if (hashdist)
1847 return;
1848
1849 inode_hashtable =
1850 alloc_large_system_hash("Inode-cache",
1851 sizeof(struct hlist_head),
1852 ihash_entries,
1853 14,
1854 HASH_EARLY,
1855 &i_hash_shift,
1856 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00001857 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 0);
1859
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001860 for (loop = 0; loop < (1U << i_hash_shift); loop++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1862}
1863
Denis Cheng74bf17c2007-10-16 23:26:30 -07001864void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001866 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867
1868 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08001869 inode_cachep = kmem_cache_create("inode_cache",
1870 sizeof(struct inode),
1871 0,
1872 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
1873 SLAB_MEM_SPREAD),
Paul Mundt20c2df82007-07-20 10:11:58 +09001874 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875
1876 /* Hash may have been set up in inode_init_early */
1877 if (!hashdist)
1878 return;
1879
1880 inode_hashtable =
1881 alloc_large_system_hash("Inode-cache",
1882 sizeof(struct hlist_head),
1883 ihash_entries,
1884 14,
1885 0,
1886 &i_hash_shift,
1887 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00001888 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 0);
1890
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001891 for (loop = 0; loop < (1U << i_hash_shift); loop++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1893}
1894
1895void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
1896{
1897 inode->i_mode = mode;
1898 if (S_ISCHR(mode)) {
1899 inode->i_fop = &def_chr_fops;
1900 inode->i_rdev = rdev;
1901 } else if (S_ISBLK(mode)) {
1902 inode->i_fop = &def_blk_fops;
1903 inode->i_rdev = rdev;
1904 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04001905 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05001907 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07001909 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
1910 " inode %s:%lu\n", mode, inode->i_sb->s_id,
1911 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912}
1913EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001914
1915/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00001916 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001917 * @inode: New inode
1918 * @dir: Directory inode
1919 * @mode: mode of the new inode
1920 */
1921void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001922 umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001923{
1924 inode->i_uid = current_fsuid();
1925 if (dir && dir->i_mode & S_ISGID) {
1926 inode->i_gid = dir->i_gid;
1927 if (S_ISDIR(mode))
1928 mode |= S_ISGID;
1929 } else
1930 inode->i_gid = current_fsgid();
1931 inode->i_mode = mode;
1932}
1933EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07001934
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001935/**
1936 * inode_owner_or_capable - check current task permissions to inode
1937 * @inode: inode being checked
1938 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07001939 * Return true if current either has CAP_FOWNER in a namespace with the
1940 * inode owner uid mapped, or owns the file.
Serge E. Hallyne795b712011-03-23 16:43:25 -07001941 */
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001942bool inode_owner_or_capable(const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07001943{
Andy Lutomirski23adbe12014-06-10 12:45:42 -07001944 struct user_namespace *ns;
1945
Eric W. Biederman92361632012-02-08 07:07:50 -08001946 if (uid_eq(current_fsuid(), inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07001947 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07001948
1949 ns = current_user_ns();
1950 if (ns_capable(ns, CAP_FOWNER) && kuid_has_mapping(ns, inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07001951 return true;
1952 return false;
1953}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001954EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04001955
1956/*
1957 * Direct i/o helper functions
1958 */
1959static void __inode_dio_wait(struct inode *inode)
1960{
1961 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
1962 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
1963
1964 do {
1965 prepare_to_wait(wq, &q.wait, TASK_UNINTERRUPTIBLE);
1966 if (atomic_read(&inode->i_dio_count))
1967 schedule();
1968 } while (atomic_read(&inode->i_dio_count));
1969 finish_wait(wq, &q.wait);
1970}
1971
1972/**
1973 * inode_dio_wait - wait for outstanding DIO requests to finish
1974 * @inode: inode to wait for
1975 *
1976 * Waits for all pending direct I/O requests to finish so that we can
1977 * proceed with a truncate or equivalent operation.
1978 *
1979 * Must be called under a lock that serializes taking new references
1980 * to i_dio_count, usually by inode->i_mutex.
1981 */
1982void inode_dio_wait(struct inode *inode)
1983{
1984 if (atomic_read(&inode->i_dio_count))
1985 __inode_dio_wait(inode);
1986}
1987EXPORT_SYMBOL(inode_dio_wait);
1988
1989/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04001990 * inode_set_flags - atomically set some inode flags
1991 *
1992 * Note: the caller should be holding i_mutex, or else be sure that
1993 * they have exclusive access to the inode structure (i.e., while the
1994 * inode is being instantiated). The reason for the cmpxchg() loop
1995 * --- which wouldn't be necessary if all code paths which modify
1996 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001997 * code path which doesn't today so we use cmpxchg() out of an abundance
1998 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04001999 *
2000 * In the long run, i_mutex is overkill, and we should probably look
2001 * at using the i_lock spinlock to protect i_flags, and then make sure
2002 * it is so documented in include/linux/fs.h and that all code follows
2003 * the locking convention!!
2004 */
2005void inode_set_flags(struct inode *inode, unsigned int flags,
2006 unsigned int mask)
2007{
2008 unsigned int old_flags, new_flags;
2009
2010 WARN_ON_ONCE(flags & ~mask);
2011 do {
2012 old_flags = ACCESS_ONCE(inode->i_flags);
2013 new_flags = (old_flags & ~mask) | flags;
2014 } while (unlikely(cmpxchg(&inode->i_flags, old_flags,
2015 new_flags) != old_flags));
2016}
2017EXPORT_SYMBOL(inode_set_flags);