blob: 648e71ce6ec216358e6733c2d6e0141c3d90c6f6 [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));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 security_inode_free(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400228 fsnotify_inode_delete(inode);
Jeff Layton4a075e32015-01-16 15:05:54 -0500229 locks_free_lock_context(inode->i_flctx);
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100230 if (!inode->i_nlink) {
231 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
232 atomic_long_dec(&inode->i_sb->s_remove_count);
233 }
234
Al Virof19d4a82009-06-08 19:50:45 -0400235#ifdef CONFIG_FS_POSIX_ACL
236 if (inode->i_acl && inode->i_acl != ACL_NOT_CACHED)
237 posix_acl_release(inode->i_acl);
238 if (inode->i_default_acl && inode->i_default_acl != ACL_NOT_CACHED)
239 posix_acl_release(inode->i_default_acl);
240#endif
Nick Piggin3e880fb2011-01-07 17:49:19 +1100241 this_cpu_dec(nr_inodes);
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300242}
243EXPORT_SYMBOL(__destroy_inode);
244
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100245static void i_callback(struct rcu_head *head)
246{
247 struct inode *inode = container_of(head, struct inode, i_rcu);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100248 kmem_cache_free(inode_cachep, inode);
249}
250
Christoph Hellwig56b0dac2010-10-06 10:48:55 +0200251static void destroy_inode(struct inode *inode)
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300252{
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100253 BUG_ON(!list_empty(&inode->i_lru));
Christoph Hellwig2e00c972009-08-07 14:38:29 -0300254 __destroy_inode(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 if (inode->i_sb->s_op->destroy_inode)
256 inode->i_sb->s_op->destroy_inode(inode);
257 else
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100258 call_rcu(&inode->i_rcu, i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100261/**
262 * drop_nlink - directly drop an inode's link count
263 * @inode: inode
264 *
265 * This is a low-level filesystem helper to replace any
266 * direct filesystem manipulation of i_nlink. In cases
267 * where we are attempting to track writes to the
268 * filesystem, a decrement to zero means an imminent
269 * write when the file is truncated and actually unlinked
270 * on the filesystem.
271 */
272void drop_nlink(struct inode *inode)
273{
274 WARN_ON(inode->i_nlink == 0);
275 inode->__i_nlink--;
276 if (!inode->i_nlink)
277 atomic_long_inc(&inode->i_sb->s_remove_count);
278}
279EXPORT_SYMBOL(drop_nlink);
280
281/**
282 * clear_nlink - directly zero an inode's link count
283 * @inode: inode
284 *
285 * This is a low-level filesystem helper to replace any
286 * direct filesystem manipulation of i_nlink. See
287 * drop_nlink() for why we care about i_nlink hitting zero.
288 */
289void clear_nlink(struct inode *inode)
290{
291 if (inode->i_nlink) {
292 inode->__i_nlink = 0;
293 atomic_long_inc(&inode->i_sb->s_remove_count);
294 }
295}
296EXPORT_SYMBOL(clear_nlink);
297
298/**
299 * set_nlink - directly set an inode's link count
300 * @inode: inode
301 * @nlink: new nlink (should be non-zero)
302 *
303 * This is a low-level filesystem helper to replace any
304 * direct filesystem manipulation of i_nlink.
305 */
306void set_nlink(struct inode *inode, unsigned int nlink)
307{
308 if (!nlink) {
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100309 clear_nlink(inode);
310 } else {
311 /* Yes, some filesystems do change nlink from zero to one */
312 if (inode->i_nlink == 0)
313 atomic_long_dec(&inode->i_sb->s_remove_count);
314
315 inode->__i_nlink = nlink;
316 }
317}
318EXPORT_SYMBOL(set_nlink);
319
320/**
321 * inc_nlink - directly increment an inode's link count
322 * @inode: inode
323 *
324 * This is a low-level filesystem helper to replace any
325 * direct filesystem manipulation of i_nlink. Currently,
326 * it is only here for parity with dec_nlink().
327 */
328void inc_nlink(struct inode *inode)
329{
Al Virof4e0c302013-06-11 08:34:36 +0400330 if (unlikely(inode->i_nlink == 0)) {
331 WARN_ON(!(inode->i_state & I_LINKABLE));
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100332 atomic_long_dec(&inode->i_sb->s_remove_count);
Al Virof4e0c302013-06-11 08:34:36 +0400333 }
Miklos Szeredi7ada4db2011-11-21 12:11:32 +0100334
335 inode->__i_nlink++;
336}
337EXPORT_SYMBOL(inc_nlink);
338
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100339void address_space_init_once(struct address_space *mapping)
340{
341 memset(mapping, 0, sizeof(*mapping));
342 INIT_RADIX_TREE(&mapping->page_tree, GFP_ATOMIC);
343 spin_lock_init(&mapping->tree_lock);
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800344 init_rwsem(&mapping->i_mmap_rwsem);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100345 INIT_LIST_HEAD(&mapping->private_list);
346 spin_lock_init(&mapping->private_lock);
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -0700347 mapping->i_mmap = RB_ROOT;
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100348}
349EXPORT_SYMBOL(address_space_init_once);
350
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351/*
352 * These are initializations that only need to be done
353 * once, because the fields are idempotent across use
354 * of the inode, so let the slab aware of that.
355 */
356void inode_init_once(struct inode *inode)
357{
358 memset(inode, 0, sizeof(*inode));
359 INIT_HLIST_NODE(&inode->i_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 INIT_LIST_HEAD(&inode->i_devices);
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100361 INIT_LIST_HEAD(&inode->i_wb_list);
362 INIT_LIST_HEAD(&inode->i_lru);
Miklos Szeredi2aa15892011-02-23 13:49:47 +0100363 address_space_init_once(&inode->i_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 i_size_ordered_init(inode);
Eric Paris3be25f42009-05-21 17:01:26 -0400365#ifdef CONFIG_FSNOTIFY
Eric Parise61ce862009-12-17 21:24:24 -0500366 INIT_HLIST_HEAD(&inode->i_fsnotify_marks);
Eric Paris3be25f42009-05-21 17:01:26 -0400367#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369EXPORT_SYMBOL(inode_init_once);
370
Alexey Dobriyan51cc5062008-07-25 19:45:34 -0700371static void init_once(void *foo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530373 struct inode *inode = (struct inode *) foo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Christoph Lametera35afb82007-05-16 22:10:57 -0700375 inode_init_once(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376}
377
378/*
Dave Chinner250df6e2011-03-22 22:23:36 +1100379 * inode->i_lock must be held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530381void __iget(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382{
Nick Piggin9e38d862010-10-23 06:55:17 -0400383 atomic_inc(&inode->i_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384}
385
Al Viro7de9c6ee2010-10-23 11:11:40 -0400386/*
387 * get additional reference to inode; caller must already hold one.
388 */
389void ihold(struct inode *inode)
390{
391 WARN_ON(atomic_inc_return(&inode->i_count) < 2);
392}
393EXPORT_SYMBOL(ihold);
394
Nick Piggin9e38d862010-10-23 06:55:17 -0400395static void inode_lru_list_add(struct inode *inode)
396{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000397 if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000398 this_cpu_inc(nr_unused);
Nick Piggin9e38d862010-10-23 06:55:17 -0400399}
400
Jan Kara4eff96d2012-11-26 16:29:51 -0800401/*
402 * Add inode to LRU if needed (inode is unused and clean).
403 *
404 * Needs inode->i_lock held.
405 */
406void inode_add_lru(struct inode *inode)
407{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500408 if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
409 I_FREEING | I_WILL_FREE)) &&
Jan Kara4eff96d2012-11-26 16:29:51 -0800410 !atomic_read(&inode->i_count) && inode->i_sb->s_flags & MS_ACTIVE)
411 inode_lru_list_add(inode);
412}
413
414
Nick Piggin9e38d862010-10-23 06:55:17 -0400415static void inode_lru_list_del(struct inode *inode)
416{
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000417
418 if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
Dave Chinnerfcb94f72011-07-08 14:14:38 +1000419 this_cpu_dec(nr_unused);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420}
421
Christoph Hellwig646ec462010-10-23 07:15:32 -0400422/**
423 * inode_sb_list_add - add inode to the superblock list of inodes
424 * @inode: inode to add
425 */
426void inode_sb_list_add(struct inode *inode)
427{
Dave Chinner55fa6092011-03-22 22:23:40 +1100428 spin_lock(&inode_sb_list_lock);
429 list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
430 spin_unlock(&inode_sb_list_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400431}
432EXPORT_SYMBOL_GPL(inode_sb_list_add);
433
Dave Chinner55fa6092011-03-22 22:23:40 +1100434static inline void inode_sb_list_del(struct inode *inode)
Christoph Hellwig646ec462010-10-23 07:15:32 -0400435{
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200436 if (!list_empty(&inode->i_sb_list)) {
437 spin_lock(&inode_sb_list_lock);
438 list_del_init(&inode->i_sb_list);
439 spin_unlock(&inode_sb_list_lock);
440 }
Christoph Hellwig646ec462010-10-23 07:15:32 -0400441}
442
Dave Chinner4c51acb2010-10-23 06:58:09 -0400443static unsigned long hash(struct super_block *sb, unsigned long hashval)
444{
445 unsigned long tmp;
446
447 tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
448 L1_CACHE_BYTES;
Christoph Hellwig4b4563d2011-05-27 09:28:01 -0400449 tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
450 return tmp & i_hash_mask;
Dave Chinner4c51acb2010-10-23 06:58:09 -0400451}
452
453/**
454 * __insert_inode_hash - hash an inode
455 * @inode: unhashed inode
456 * @hashval: unsigned long value used to locate this object in the
457 * inode_hashtable.
458 *
459 * Add an inode to the inode hash for this superblock.
460 */
461void __insert_inode_hash(struct inode *inode, unsigned long hashval)
462{
Christoph Hellwig646ec462010-10-23 07:15:32 -0400463 struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
464
Dave Chinner67a23c42011-03-22 22:23:42 +1100465 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100466 spin_lock(&inode->i_lock);
Christoph Hellwig646ec462010-10-23 07:15:32 -0400467 hlist_add_head(&inode->i_hash, b);
Dave Chinner250df6e2011-03-22 22:23:36 +1100468 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100469 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400470}
471EXPORT_SYMBOL(__insert_inode_hash);
472
473/**
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200474 * __remove_inode_hash - remove an inode from the hash
Dave Chinner4c51acb2010-10-23 06:58:09 -0400475 * @inode: inode to unhash
476 *
477 * Remove an inode from the superblock.
478 */
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200479void __remove_inode_hash(struct inode *inode)
Dave Chinner4c51acb2010-10-23 06:58:09 -0400480{
Dave Chinner67a23c42011-03-22 22:23:42 +1100481 spin_lock(&inode_hash_lock);
Dave Chinner250df6e2011-03-22 22:23:36 +1100482 spin_lock(&inode->i_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400483 hlist_del_init(&inode->i_hash);
Dave Chinner250df6e2011-03-22 22:23:36 +1100484 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +1100485 spin_unlock(&inode_hash_lock);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400486}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +0200487EXPORT_SYMBOL(__remove_inode_hash);
Dave Chinner4c51acb2010-10-23 06:58:09 -0400488
Jan Karadbd57682012-05-03 14:48:02 +0200489void clear_inode(struct inode *inode)
Al Virob0683aa2010-06-04 20:55:25 -0400490{
491 might_sleep();
Jan Kara08142572011-06-27 16:18:10 -0700492 /*
493 * We have to cycle tree_lock here because reclaim can be still in the
494 * process of removing the last page (in __delete_from_page_cache())
495 * and we must not free mapping under it.
496 */
497 spin_lock_irq(&inode->i_data.tree_lock);
Al Virob0683aa2010-06-04 20:55:25 -0400498 BUG_ON(inode->i_data.nrpages);
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700499 BUG_ON(inode->i_data.nrshadows);
Jan Kara08142572011-06-27 16:18:10 -0700500 spin_unlock_irq(&inode->i_data.tree_lock);
Al Virob0683aa2010-06-04 20:55:25 -0400501 BUG_ON(!list_empty(&inode->i_data.private_list));
502 BUG_ON(!(inode->i_state & I_FREEING));
503 BUG_ON(inode->i_state & I_CLEAR);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100504 /* don't need i_lock here, no concurrent mods to i_state */
Al Virob0683aa2010-06-04 20:55:25 -0400505 inode->i_state = I_FREEING | I_CLEAR;
506}
Jan Karadbd57682012-05-03 14:48:02 +0200507EXPORT_SYMBOL(clear_inode);
Al Virob0683aa2010-06-04 20:55:25 -0400508
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100509/*
510 * Free the inode passed in, removing it from the lists it is still connected
511 * to. We remove any pages still attached to the inode and wait for any IO that
512 * is still in progress before finally destroying the inode.
513 *
514 * An inode must already be marked I_FREEING so that we avoid the inode being
515 * moved back onto lists if we race with other code that manipulates the lists
516 * (e.g. writeback_single_inode). The caller is responsible for setting this.
517 *
518 * An inode must already be removed from the LRU list before being evicted from
519 * the cache. This should occur atomically with setting the I_FREEING state
520 * flag, so no inodes here should ever be on the LRU when being evicted.
521 */
Al Viro644da592010-06-07 13:21:05 -0400522static void evict(struct inode *inode)
Al Virob4272d42010-06-04 19:33:20 -0400523{
524 const struct super_operations *op = inode->i_sb->s_op;
525
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100526 BUG_ON(!(inode->i_state & I_FREEING));
527 BUG_ON(!list_empty(&inode->i_lru));
528
Eric Dumazetb12362b2011-07-28 06:11:47 +0200529 if (!list_empty(&inode->i_wb_list))
530 inode_wb_list_del(inode);
531
Dave Chinner55fa6092011-03-22 22:23:40 +1100532 inode_sb_list_del(inode);
533
Jan Kara169ebd92012-05-03 14:48:03 +0200534 /*
535 * Wait for flusher thread to be done with the inode so that filesystem
536 * does not start destroying it while writeback is still running. Since
537 * the inode has I_FREEING set, flusher thread won't start new work on
538 * the inode. We just have to wait for running writeback to finish.
539 */
540 inode_wait_for_writeback(inode);
Jan Kara7994e6f2012-05-03 14:48:01 +0200541
Al Virobe7ce412010-06-04 19:40:39 -0400542 if (op->evict_inode) {
543 op->evict_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400544 } else {
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700545 truncate_inode_pages_final(&inode->i_data);
Jan Karadbd57682012-05-03 14:48:02 +0200546 clear_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400547 }
Al Viro661074e2010-06-04 20:19:55 -0400548 if (S_ISBLK(inode->i_mode) && inode->i_bdev)
549 bd_forget(inode);
550 if (S_ISCHR(inode->i_mode) && inode->i_cdev)
551 cd_forget(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +1100552
553 remove_inode_hash(inode);
554
555 spin_lock(&inode->i_lock);
556 wake_up_bit(&inode->i_state, __I_NEW);
557 BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
558 spin_unlock(&inode->i_lock);
559
560 destroy_inode(inode);
Al Virob4272d42010-06-04 19:33:20 -0400561}
562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563/*
564 * dispose_list - dispose of the contents of a local list
565 * @head: the head of the list to free
566 *
567 * Dispose-list gets a local list with local inodes in it, so it doesn't
568 * need to worry about list corruption and SMP locks.
569 */
570static void dispose_list(struct list_head *head)
571{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 while (!list_empty(head)) {
573 struct inode *inode;
574
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100575 inode = list_first_entry(head, struct inode, i_lru);
576 list_del_init(&inode->i_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
Al Viro644da592010-06-07 13:21:05 -0400578 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580}
581
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582/**
Al Viro63997e92010-10-25 20:49:35 -0400583 * evict_inodes - evict all evictable inodes for a superblock
584 * @sb: superblock to operate on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 *
Al Viro63997e92010-10-25 20:49:35 -0400586 * Make sure that no inodes with zero refcount are retained. This is
587 * called by superblock shutdown after having MS_ACTIVE flag removed,
588 * so any inode reaching zero refcount during or after that call will
589 * be immediately evicted.
590 */
591void evict_inodes(struct super_block *sb)
592{
593 struct inode *inode, *next;
594 LIST_HEAD(dispose);
595
Dave Chinner55fa6092011-03-22 22:23:40 +1100596 spin_lock(&inode_sb_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400597 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
598 if (atomic_read(&inode->i_count))
599 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100600
601 spin_lock(&inode->i_lock);
602 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
603 spin_unlock(&inode->i_lock);
Al Viro63997e92010-10-25 20:49:35 -0400604 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100605 }
Al Viro63997e92010-10-25 20:49:35 -0400606
607 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100608 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100609 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100610 list_add(&inode->i_lru, &dispose);
Al Viro63997e92010-10-25 20:49:35 -0400611 }
Dave Chinner55fa6092011-03-22 22:23:40 +1100612 spin_unlock(&inode_sb_list_lock);
Al Viro63997e92010-10-25 20:49:35 -0400613
614 dispose_list(&dispose);
Al Viro63997e92010-10-25 20:49:35 -0400615}
616
617/**
Christoph Hellwiga0318782010-10-24 19:40:33 +0200618 * invalidate_inodes - attempt to free all inodes on a superblock
619 * @sb: superblock to operate on
NeilBrown93b270f2011-02-24 17:25:47 +1100620 * @kill_dirty: flag to guide handling of dirty inodes
Christoph Hellwiga0318782010-10-24 19:40:33 +0200621 *
622 * Attempts to free all inodes for a given superblock. If there were any
623 * busy inodes return a non-zero value, else zero.
NeilBrown93b270f2011-02-24 17:25:47 +1100624 * If @kill_dirty is set, discard dirty inodes too, otherwise treat
625 * them as busy.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 */
NeilBrown93b270f2011-02-24 17:25:47 +1100627int invalidate_inodes(struct super_block *sb, bool kill_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
Dave Chinnercffbc8a2010-10-23 05:03:02 -0400629 int busy = 0;
Christoph Hellwiga0318782010-10-24 19:40:33 +0200630 struct inode *inode, *next;
631 LIST_HEAD(dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
Dave Chinner55fa6092011-03-22 22:23:40 +1100633 spin_lock(&inode_sb_list_lock);
Christoph Hellwiga0318782010-10-24 19:40:33 +0200634 list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100635 spin_lock(&inode->i_lock);
636 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
637 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100639 }
Theodore Ts'o0ae45f62015-02-02 00:37:00 -0500640 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100641 spin_unlock(&inode->i_lock);
NeilBrown93b270f2011-02-24 17:25:47 +1100642 busy = 1;
643 continue;
644 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200645 if (atomic_read(&inode->i_count)) {
Dave Chinner250df6e2011-03-22 22:23:36 +1100646 spin_unlock(&inode->i_lock);
Christoph Hellwig99a38912010-10-23 19:07:20 +0200647 busy = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 continue;
649 }
Christoph Hellwig99a38912010-10-23 19:07:20 +0200650
Christoph Hellwig99a38912010-10-23 19:07:20 +0200651 inode->i_state |= I_FREEING;
Dave Chinner02afc412011-03-22 22:23:38 +1100652 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100653 spin_unlock(&inode->i_lock);
Dave Chinner02afc412011-03-22 22:23:38 +1100654 list_add(&inode->i_lru, &dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 }
Dave Chinner55fa6092011-03-22 22:23:40 +1100656 spin_unlock(&inode_sb_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Christoph Hellwiga0318782010-10-24 19:40:33 +0200658 dispose_list(&dispose);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
660 return busy;
661}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663/*
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000664 * Isolate the inode from the LRU in preparation for freeing it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 *
666 * Any inodes which are pinned purely because of attached pagecache have their
Nick Piggin9e38d862010-10-23 06:55:17 -0400667 * pagecache removed. If the inode has metadata buffers attached to
668 * mapping->private_list then try to remove them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 *
Nick Piggin9e38d862010-10-23 06:55:17 -0400670 * If the inode has the I_REFERENCED flag set, then it means that it has been
671 * used recently - the flag is set in iput_final(). When we encounter such an
672 * inode, clear the flag and move it to the back of the LRU so it gets another
673 * pass through the LRU before it gets reclaimed. This is necessary because of
674 * the fact we are doing lazy LRU updates to minimise lock contention so the
675 * LRU does not have strict ordering. Hence we don't want to reclaim inodes
676 * with this flag set because they are the inodes that are out of order.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800678static enum lru_status inode_lru_isolate(struct list_head *item,
679 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000680{
681 struct list_head *freeable = arg;
682 struct inode *inode = container_of(item, struct inode, i_lru);
683
684 /*
685 * we are inverting the lru lock/inode->i_lock here, so use a trylock.
686 * If we fail to get the lock, just skip it.
687 */
688 if (!spin_trylock(&inode->i_lock))
689 return LRU_SKIP;
690
691 /*
692 * Referenced or dirty inodes are still in use. Give them another pass
693 * through the LRU as we canot reclaim them now.
694 */
695 if (atomic_read(&inode->i_count) ||
696 (inode->i_state & ~I_REFERENCED)) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800697 list_lru_isolate(lru, &inode->i_lru);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000698 spin_unlock(&inode->i_lock);
699 this_cpu_dec(nr_unused);
700 return LRU_REMOVED;
701 }
702
703 /* recently referenced inodes get one more pass */
704 if (inode->i_state & I_REFERENCED) {
705 inode->i_state &= ~I_REFERENCED;
706 spin_unlock(&inode->i_lock);
707 return LRU_ROTATE;
708 }
709
710 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
711 __iget(inode);
712 spin_unlock(&inode->i_lock);
713 spin_unlock(lru_lock);
714 if (remove_inode_buffers(inode)) {
715 unsigned long reap;
716 reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
717 if (current_is_kswapd())
718 __count_vm_events(KSWAPD_INODESTEAL, reap);
719 else
720 __count_vm_events(PGINODESTEAL, reap);
721 if (current->reclaim_state)
722 current->reclaim_state->reclaimed_slab += reap;
723 }
724 iput(inode);
725 spin_lock(lru_lock);
726 return LRU_RETRY;
727 }
728
729 WARN_ON(inode->i_state & I_NEW);
730 inode->i_state |= I_FREEING;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800731 list_lru_isolate_move(lru, &inode->i_lru, freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000732 spin_unlock(&inode->i_lock);
733
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000734 this_cpu_dec(nr_unused);
735 return LRU_REMOVED;
736}
737
738/*
739 * Walk the superblock inode LRU for freeable inodes and attempt to free them.
740 * This is called from the superblock shrinker function with a number of inodes
741 * to trim from the LRU. Inodes to be freed are moved to a temporary list and
742 * then are freed outside inode_lock by dispose_list().
743 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800744long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745{
746 LIST_HEAD(freeable);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +1000747 long freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Vladimir Davydov503c3582015-02-12 14:58:47 -0800749 freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
750 inode_lru_isolate, &freeable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 dispose_list(&freeable);
Dave Chinner0a234c62013-08-28 10:17:57 +1000752 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753}
754
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755static void __wait_on_freeing_inode(struct inode *inode);
756/*
757 * Called with the inode lock held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530759static struct inode *find_inode(struct super_block *sb,
760 struct hlist_head *head,
761 int (*test)(struct inode *, void *),
762 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530764 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
766repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800767 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500768 if (inode->i_sb != sb)
769 continue;
770 if (!test(inode, data))
771 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100772 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400773 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 __wait_on_freeing_inode(inode);
775 goto repeat;
776 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400777 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100778 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400779 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400781 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782}
783
784/*
785 * find_inode_fast is the fast path version of find_inode, see the comment at
786 * iget_locked for details.
787 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530788static struct inode *find_inode_fast(struct super_block *sb,
789 struct hlist_head *head, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530791 struct inode *inode = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
793repeat:
Sasha Levinb67bfe02013-02-27 17:06:00 -0800794 hlist_for_each_entry(inode, head, i_hash) {
Al Viro5a3cd99282013-11-06 09:54:52 -0500795 if (inode->i_ino != ino)
796 continue;
797 if (inode->i_sb != sb)
798 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +1100799 spin_lock(&inode->i_lock);
Al Viroa4ffdde2010-06-02 17:38:30 -0400800 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 __wait_on_freeing_inode(inode);
802 goto repeat;
803 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400804 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100805 spin_unlock(&inode->i_lock);
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400806 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 }
Christoph Hellwigf7899bd2010-10-23 07:09:06 -0400808 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809}
810
Eric Dumazetf991bd22010-10-23 11:18:01 -0400811/*
812 * Each cpu owns a range of LAST_INO_BATCH numbers.
813 * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
814 * to renew the exhausted range.
David Chinner8290c352008-10-30 17:35:24 +1100815 *
Eric Dumazetf991bd22010-10-23 11:18:01 -0400816 * This does not significantly increase overflow rate because every CPU can
817 * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
818 * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
819 * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
820 * overflow rate by 2x, which does not seem too significant.
821 *
822 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
823 * error if st_ino won't fit in target struct field. Use 32bit counter
824 * here to attempt to avoid that.
David Chinner8290c352008-10-30 17:35:24 +1100825 */
Eric Dumazetf991bd22010-10-23 11:18:01 -0400826#define LAST_INO_BATCH 1024
827static DEFINE_PER_CPU(unsigned int, last_ino);
David Chinner8290c352008-10-30 17:35:24 +1100828
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400829unsigned int get_next_ino(void)
Eric Dumazetf991bd22010-10-23 11:18:01 -0400830{
831 unsigned int *p = &get_cpu_var(last_ino);
832 unsigned int res = *p;
833
834#ifdef CONFIG_SMP
835 if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
836 static atomic_t shared_last_ino;
837 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
838
839 res = next - LAST_INO_BATCH;
840 }
841#endif
842
Carlos Maiolino2adc3762015-06-25 12:25:58 -0300843 res++;
844 /* get_next_ino should not provide a 0 inode number */
845 if (unlikely(!res))
846 res++;
847 *p = res;
Eric Dumazetf991bd22010-10-23 11:18:01 -0400848 put_cpu_var(last_ino);
849 return res;
David Chinner8290c352008-10-30 17:35:24 +1100850}
Christoph Hellwig85fe4022010-10-23 11:19:54 -0400851EXPORT_SYMBOL(get_next_ino);
David Chinner8290c352008-10-30 17:35:24 +1100852
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853/**
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200854 * new_inode_pseudo - obtain an inode
855 * @sb: superblock
856 *
857 * Allocates a new inode for given superblock.
858 * Inode wont be chained in superblock s_inodes list
859 * This means :
860 * - fs can't be unmount
861 * - quotas, fsnotify, writeback can't work
862 */
863struct inode *new_inode_pseudo(struct super_block *sb)
864{
865 struct inode *inode = alloc_inode(sb);
866
867 if (inode) {
868 spin_lock(&inode->i_lock);
869 inode->i_state = 0;
870 spin_unlock(&inode->i_lock);
871 INIT_LIST_HEAD(&inode->i_sb_list);
872 }
873 return inode;
874}
875
876/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 * new_inode - obtain an inode
878 * @sb: superblock
879 *
Mel Gorman769848c2007-07-17 04:03:05 -0700880 * Allocates a new inode for given superblock. The default gfp_mask
Hugh Dickins3c1d4372009-01-06 14:39:23 -0800881 * for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
Mel Gorman769848c2007-07-17 04:03:05 -0700882 * If HIGHMEM pages are unsuitable or it is known that pages allocated
883 * for the page cache are not reclaimable or migratable,
884 * mapping_set_gfp_mask() must be called with suitable flags on the
885 * newly created inode's mapping
886 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 */
888struct inode *new_inode(struct super_block *sb)
889{
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530890 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
Dave Chinner55fa6092011-03-22 22:23:40 +1100892 spin_lock_prefetch(&inode_sb_list_lock);
Manish Katiyar6b3304b2009-03-31 19:35:54 +0530893
Eric Dumazeta209dfc2011-07-26 11:36:34 +0200894 inode = new_inode_pseudo(sb);
895 if (inode)
Dave Chinner55fa6092011-03-22 22:23:40 +1100896 inode_sb_list_add(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 return inode;
898}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899EXPORT_SYMBOL(new_inode);
900
Peter Zijlstra14358e62007-10-14 01:38:33 +0200901#ifdef CONFIG_DEBUG_LOCK_ALLOC
Josh Boyere096d0c2011-08-25 07:48:12 -0400902void lockdep_annotate_inode_mutex_key(struct inode *inode)
903{
Namhyung Kima3314a02010-10-11 22:38:00 +0900904 if (S_ISDIR(inode->i_mode)) {
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200905 struct file_system_type *type = inode->i_sb->s_type;
906
Jan Kara9a7aa122009-06-04 15:26:49 +0200907 /* Set new key only if filesystem hasn't already changed it */
Tyler Hicks978d6d82011-12-12 10:02:30 -0600908 if (lockdep_match_class(&inode->i_mutex, &type->i_mutex_key)) {
Jan Kara9a7aa122009-06-04 15:26:49 +0200909 /*
910 * ensure nobody is actually holding i_mutex
911 */
912 mutex_destroy(&inode->i_mutex);
913 mutex_init(&inode->i_mutex);
914 lockdep_set_class(&inode->i_mutex,
915 &type->i_mutex_dir_key);
916 }
Peter Zijlstra1e89a5e2007-10-16 06:47:54 +0200917 }
Josh Boyere096d0c2011-08-25 07:48:12 -0400918}
919EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
Peter Zijlstra14358e62007-10-14 01:38:33 +0200920#endif
Josh Boyere096d0c2011-08-25 07:48:12 -0400921
922/**
923 * unlock_new_inode - clear the I_NEW state and wake up any waiters
924 * @inode: new inode to unlock
925 *
926 * Called when the inode is fully initialised to clear the new state of the
927 * inode and wake up anyone waiting for the inode to finish initialisation.
928 */
929void unlock_new_inode(struct inode *inode)
930{
931 lockdep_annotate_inode_mutex_key(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +1100932 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100933 WARN_ON(!(inode->i_state & I_NEW));
934 inode->i_state &= ~I_NEW;
Al Viro310fa7a2012-03-10 17:07:28 -0500935 smp_mb();
Dave Chinner250df6e2011-03-22 22:23:36 +1100936 wake_up_bit(&inode->i_state, __I_NEW);
937 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939EXPORT_SYMBOL(unlock_new_inode);
940
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400941/**
J. Bruce Fields375e2892012-04-18 15:16:33 -0400942 * lock_two_nondirectories - take two i_mutexes on non-directory objects
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200943 *
944 * Lock any non-NULL argument that is not a directory.
945 * Zero, one or two objects may be locked by this function.
946 *
J. Bruce Fields375e2892012-04-18 15:16:33 -0400947 * @inode1: first inode to lock
948 * @inode2: second inode to lock
949 */
950void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
951{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200952 if (inode1 > inode2)
953 swap(inode1, inode2);
954
955 if (inode1 && !S_ISDIR(inode1->i_mode))
J. Bruce Fields275555162012-04-25 07:19:52 -0400956 mutex_lock(&inode1->i_mutex);
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200957 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400958 mutex_lock_nested(&inode2->i_mutex, I_MUTEX_NONDIR2);
J. Bruce Fields375e2892012-04-18 15:16:33 -0400959}
960EXPORT_SYMBOL(lock_two_nondirectories);
961
962/**
963 * unlock_two_nondirectories - release locks from lock_two_nondirectories()
964 * @inode1: first inode to unlock
965 * @inode2: second inode to unlock
966 */
967void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
968{
J. Bruce Fields4fd699a2014-04-01 17:08:43 +0200969 if (inode1 && !S_ISDIR(inode1->i_mode))
970 mutex_unlock(&inode1->i_mutex);
971 if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
J. Bruce Fields375e2892012-04-18 15:16:33 -0400972 mutex_unlock(&inode2->i_mutex);
973}
974EXPORT_SYMBOL(unlock_two_nondirectories);
975
976/**
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400977 * iget5_locked - obtain an inode from a mounted file system
978 * @sb: super block of file system
979 * @hashval: hash value (usually inode number) to get
980 * @test: callback used for comparisons between inodes
981 * @set: callback used to initialize a new struct inode
982 * @data: opaque data pointer to pass to @test and @set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400984 * Search for the inode specified by @hashval and @data in the inode cache,
985 * and if present it is return it with an increased reference count. This is
986 * a generalized version of iget_locked() for file systems where the inode
987 * number is not sufficient for unique identification of an inode.
988 *
989 * If the inode is not in cache, allocate a new inode and return it locked,
990 * hashed, and with the I_NEW flag set. The file system gets to fill it in
991 * before unlocking it via unlock_new_inode().
992 *
993 * Note both @test and @set are called with the inode_hash_lock held, so can't
994 * sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -0400996struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
997 int (*test)(struct inode *, void *),
998 int (*set)(struct inode *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001000 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301001 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001003 spin_lock(&inode_hash_lock);
1004 inode = find_inode(sb, head, test, data);
1005 spin_unlock(&inode_hash_lock);
1006
1007 if (inode) {
1008 wait_on_inode(inode);
1009 return inode;
1010 }
1011
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 inode = alloc_inode(sb);
1013 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301014 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015
Dave Chinner67a23c42011-03-22 22:23:42 +11001016 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 /* We released the lock, so.. */
1018 old = find_inode(sb, head, test, data);
1019 if (!old) {
1020 if (set(inode, data))
1021 goto set_failed;
1022
Dave Chinner250df6e2011-03-22 22:23:36 +11001023 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001024 inode->i_state = I_NEW;
Dave Chinner250df6e2011-03-22 22:23:36 +11001025 hlist_add_head(&inode->i_hash, head);
1026 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001027 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001028 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
1030 /* Return the locked inode with I_NEW set, the
1031 * caller is responsible for filling in the contents
1032 */
1033 return inode;
1034 }
1035
1036 /*
1037 * Uhhuh, somebody else created the same inode under
1038 * us. Use the old inode instead of the one we just
1039 * allocated.
1040 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001041 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 destroy_inode(inode);
1043 inode = old;
1044 wait_on_inode(inode);
1045 }
1046 return inode;
1047
1048set_failed:
Dave Chinner67a23c42011-03-22 22:23:42 +11001049 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 destroy_inode(inode);
1051 return NULL;
1052}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001053EXPORT_SYMBOL(iget5_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001055/**
1056 * iget_locked - obtain an inode from a mounted file system
1057 * @sb: super block of file system
1058 * @ino: inode number to get
1059 *
1060 * Search for the inode specified by @ino in the inode cache and if present
1061 * return it with an increased reference count. This is for file systems
1062 * where the inode number is sufficient for unique identification of an inode.
1063 *
1064 * If the inode is not in cache, allocate a new inode and return it locked,
1065 * hashed, and with the I_NEW flag set. The file system gets to fill it in
1066 * before unlocking it via unlock_new_inode().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 */
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001068struct inode *iget_locked(struct super_block *sb, unsigned long ino)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001070 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301071 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001073 spin_lock(&inode_hash_lock);
1074 inode = find_inode_fast(sb, head, ino);
1075 spin_unlock(&inode_hash_lock);
1076 if (inode) {
1077 wait_on_inode(inode);
1078 return inode;
1079 }
1080
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 inode = alloc_inode(sb);
1082 if (inode) {
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301083 struct inode *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084
Dave Chinner67a23c42011-03-22 22:23:42 +11001085 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 /* We released the lock, so.. */
1087 old = find_inode_fast(sb, head, ino);
1088 if (!old) {
1089 inode->i_ino = ino;
Dave Chinner250df6e2011-03-22 22:23:36 +11001090 spin_lock(&inode->i_lock);
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001091 inode->i_state = I_NEW;
Dave Chinner250df6e2011-03-22 22:23:36 +11001092 hlist_add_head(&inode->i_hash, head);
1093 spin_unlock(&inode->i_lock);
Dave Chinner55fa6092011-03-22 22:23:40 +11001094 inode_sb_list_add(inode);
Dave Chinner67a23c42011-03-22 22:23:42 +11001095 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096
1097 /* Return the locked inode with I_NEW set, the
1098 * caller is responsible for filling in the contents
1099 */
1100 return inode;
1101 }
1102
1103 /*
1104 * Uhhuh, somebody else created the same inode under
1105 * us. Use the old inode instead of the one we just
1106 * allocated.
1107 */
Dave Chinner67a23c42011-03-22 22:23:42 +11001108 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 destroy_inode(inode);
1110 inode = old;
1111 wait_on_inode(inode);
1112 }
1113 return inode;
1114}
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001115EXPORT_SYMBOL(iget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001117/*
1118 * search the inode cache for a matching inode number.
1119 * If we find one, then the inode number we are trying to
1120 * allocate is not unique and so we should not use it.
1121 *
1122 * Returns 1 if the inode number is unique, 0 if it is not.
1123 */
1124static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1125{
1126 struct hlist_head *b = inode_hashtable + hash(sb, ino);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001127 struct inode *inode;
1128
Dave Chinner67a23c42011-03-22 22:23:42 +11001129 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001130 hlist_for_each_entry(inode, b, i_hash) {
Dave Chinner67a23c42011-03-22 22:23:42 +11001131 if (inode->i_ino == ino && inode->i_sb == sb) {
1132 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001133 return 0;
Dave Chinner67a23c42011-03-22 22:23:42 +11001134 }
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001135 }
Dave Chinner67a23c42011-03-22 22:23:42 +11001136 spin_unlock(&inode_hash_lock);
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001137
1138 return 1;
1139}
1140
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141/**
1142 * iunique - get a unique inode number
1143 * @sb: superblock
1144 * @max_reserved: highest reserved inode number
1145 *
1146 * Obtain an inode number that is unique on the system for a given
1147 * superblock. This is used by file systems that have no natural
1148 * permanent inode numbering system. An inode number is returned that
1149 * is higher than the reserved limit but unique.
1150 *
1151 * BUGS:
1152 * With a large number of inodes live on the file system this function
1153 * currently becomes quite slow.
1154 */
1155ino_t iunique(struct super_block *sb, ino_t max_reserved)
1156{
Jeff Layton866b04f2007-05-08 00:32:29 -07001157 /*
1158 * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1159 * error if st_ino won't fit in target struct field. Use 32bit counter
1160 * here to attempt to avoid that.
1161 */
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001162 static DEFINE_SPINLOCK(iunique_lock);
Jeff Layton866b04f2007-05-08 00:32:29 -07001163 static unsigned int counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 ino_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001166 spin_lock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001167 do {
1168 if (counter <= max_reserved)
1169 counter = max_reserved + 1;
1170 res = counter++;
Christoph Hellwigad5e1952010-10-23 07:00:16 -04001171 } while (!test_inode_iunique(sb, res));
1172 spin_unlock(&iunique_lock);
Jeffrey Layton3361c7b2007-05-08 00:29:48 -07001173
1174 return res;
1175}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176EXPORT_SYMBOL(iunique);
1177
1178struct inode *igrab(struct inode *inode)
1179{
Dave Chinner250df6e2011-03-22 22:23:36 +11001180 spin_lock(&inode->i_lock);
1181 if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 __iget(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001183 spin_unlock(&inode->i_lock);
1184 } else {
1185 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 /*
1187 * Handle the case where s_op->clear_inode is not been
1188 * called yet, and somebody is calling igrab
1189 * while the inode is getting freed.
1190 */
1191 inode = NULL;
Dave Chinner250df6e2011-03-22 22:23:36 +11001192 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 return inode;
1194}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195EXPORT_SYMBOL(igrab);
1196
1197/**
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001198 * ilookup5_nowait - search for an inode in the inode cache
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 * @sb: super block of file system to search
1200 * @hashval: hash value (usually inode number) to search for
1201 * @test: callback used for comparisons between inodes
1202 * @data: opaque data pointer to pass to @test
1203 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001204 * Search for the inode specified by @hashval and @data in the inode cache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 * If the inode is in the cache, the inode is returned with an incremented
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001206 * reference count.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001207 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001208 * Note: I_NEW is not waited upon so you have to be very careful what you do
1209 * with the returned inode. You probably should be using ilookup5() instead.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001210 *
Randy Dunlapb6d0ad62011-03-26 13:27:47 -07001211 * Note2: @test is called with the inode_hash_lock held, so can't sleep.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001212 */
1213struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1214 int (*test)(struct inode *, void *), void *data)
1215{
1216 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001217 struct inode *inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001218
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001219 spin_lock(&inode_hash_lock);
1220 inode = find_inode(sb, head, test, data);
1221 spin_unlock(&inode_hash_lock);
1222
1223 return inode;
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001224}
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001225EXPORT_SYMBOL(ilookup5_nowait);
1226
1227/**
1228 * ilookup5 - search for an inode in the inode cache
1229 * @sb: super block of file system to search
1230 * @hashval: hash value (usually inode number) to search for
1231 * @test: callback used for comparisons between inodes
1232 * @data: opaque data pointer to pass to @test
1233 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001234 * Search for the inode specified by @hashval and @data in the inode cache,
1235 * and if the inode is in the cache, return the inode with an incremented
1236 * reference count. Waits on I_NEW before returning the inode.
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07001237 * returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001239 * This is a generalized version of ilookup() for file systems where the
1240 * inode number is not sufficient for unique identification of an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001242 * Note: @test is called with the inode_hash_lock held, so can't sleep.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 */
1244struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1245 int (*test)(struct inode *, void *), void *data)
1246{
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001247 struct inode *inode = ilookup5_nowait(sb, hashval, test, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001249 if (inode)
1250 wait_on_inode(inode);
1251 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253EXPORT_SYMBOL(ilookup5);
1254
1255/**
1256 * ilookup - search for an inode in the inode cache
1257 * @sb: super block of file system to search
1258 * @ino: inode number to search for
1259 *
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001260 * Search for the inode @ino in the inode cache, and if the inode is in the
1261 * cache, the inode is returned with an incremented reference count.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 */
1263struct inode *ilookup(struct super_block *sb, unsigned long ino)
1264{
1265 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001266 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Christoph Hellwig0b2d0722011-03-23 15:03:28 -04001268 spin_lock(&inode_hash_lock);
1269 inode = find_inode_fast(sb, head, ino);
1270 spin_unlock(&inode_hash_lock);
1271
1272 if (inode)
1273 wait_on_inode(inode);
1274 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276EXPORT_SYMBOL(ilookup);
1277
Theodore Ts'ofe032c42015-02-02 00:37:01 -05001278/**
1279 * find_inode_nowait - find an inode in the inode cache
1280 * @sb: super block of file system to search
1281 * @hashval: hash value (usually inode number) to search for
1282 * @match: callback used for comparisons between inodes
1283 * @data: opaque data pointer to pass to @match
1284 *
1285 * Search for the inode specified by @hashval and @data in the inode
1286 * cache, where the helper function @match will return 0 if the inode
1287 * does not match, 1 if the inode does match, and -1 if the search
1288 * should be stopped. The @match function must be responsible for
1289 * taking the i_lock spin_lock and checking i_state for an inode being
1290 * freed or being initialized, and incrementing the reference count
1291 * before returning 1. It also must not sleep, since it is called with
1292 * the inode_hash_lock spinlock held.
1293 *
1294 * This is a even more generalized version of ilookup5() when the
1295 * function must never block --- find_inode() can block in
1296 * __wait_on_freeing_inode() --- or when the caller can not increment
1297 * the reference count because the resulting iput() might cause an
1298 * inode eviction. The tradeoff is that the @match funtion must be
1299 * very carefully implemented.
1300 */
1301struct inode *find_inode_nowait(struct super_block *sb,
1302 unsigned long hashval,
1303 int (*match)(struct inode *, unsigned long,
1304 void *),
1305 void *data)
1306{
1307 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1308 struct inode *inode, *ret_inode = NULL;
1309 int mval;
1310
1311 spin_lock(&inode_hash_lock);
1312 hlist_for_each_entry(inode, head, i_hash) {
1313 if (inode->i_sb != sb)
1314 continue;
1315 mval = match(inode, hashval, data);
1316 if (mval == 0)
1317 continue;
1318 if (mval == 1)
1319 ret_inode = inode;
1320 goto out;
1321 }
1322out:
1323 spin_unlock(&inode_hash_lock);
1324 return ret_inode;
1325}
1326EXPORT_SYMBOL(find_inode_nowait);
1327
Al Viro261bca82008-12-30 01:48:21 -05001328int insert_inode_locked(struct inode *inode)
1329{
1330 struct super_block *sb = inode->i_sb;
1331 ino_t ino = inode->i_ino;
1332 struct hlist_head *head = inode_hashtable + hash(sb, ino);
Al Viro261bca82008-12-30 01:48:21 -05001333
Al Viro261bca82008-12-30 01:48:21 -05001334 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001335 struct inode *old = NULL;
Dave Chinner67a23c42011-03-22 22:23:42 +11001336 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001337 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001338 if (old->i_ino != ino)
1339 continue;
1340 if (old->i_sb != sb)
1341 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001342 spin_lock(&old->i_lock);
1343 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1344 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001345 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001346 }
Al Viro72a43d62009-05-13 19:13:40 +01001347 break;
1348 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001349 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001350 spin_lock(&inode->i_lock);
1351 inode->i_state |= I_NEW;
Al Viro261bca82008-12-30 01:48:21 -05001352 hlist_add_head(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001353 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001354 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001355 return 0;
1356 }
1357 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001358 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001359 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001360 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001361 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001362 iput(old);
1363 return -EBUSY;
1364 }
1365 iput(old);
1366 }
1367}
Al Viro261bca82008-12-30 01:48:21 -05001368EXPORT_SYMBOL(insert_inode_locked);
1369
1370int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1371 int (*test)(struct inode *, void *), void *data)
1372{
1373 struct super_block *sb = inode->i_sb;
1374 struct hlist_head *head = inode_hashtable + hash(sb, hashval);
Al Viro261bca82008-12-30 01:48:21 -05001375
Al Viro261bca82008-12-30 01:48:21 -05001376 while (1) {
Al Viro72a43d62009-05-13 19:13:40 +01001377 struct inode *old = NULL;
1378
Dave Chinner67a23c42011-03-22 22:23:42 +11001379 spin_lock(&inode_hash_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001380 hlist_for_each_entry(old, head, i_hash) {
Al Viro72a43d62009-05-13 19:13:40 +01001381 if (old->i_sb != sb)
1382 continue;
1383 if (!test(old, data))
1384 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001385 spin_lock(&old->i_lock);
1386 if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1387 spin_unlock(&old->i_lock);
Al Viro72a43d62009-05-13 19:13:40 +01001388 continue;
Dave Chinner250df6e2011-03-22 22:23:36 +11001389 }
Al Viro72a43d62009-05-13 19:13:40 +01001390 break;
1391 }
Sasha Levinb67bfe02013-02-27 17:06:00 -08001392 if (likely(!old)) {
Dave Chinner250df6e2011-03-22 22:23:36 +11001393 spin_lock(&inode->i_lock);
1394 inode->i_state |= I_NEW;
Al Viro261bca82008-12-30 01:48:21 -05001395 hlist_add_head(&inode->i_hash, head);
Dave Chinner250df6e2011-03-22 22:23:36 +11001396 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001397 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001398 return 0;
1399 }
1400 __iget(old);
Dave Chinner250df6e2011-03-22 22:23:36 +11001401 spin_unlock(&old->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001402 spin_unlock(&inode_hash_lock);
Al Viro261bca82008-12-30 01:48:21 -05001403 wait_on_inode(old);
Al Viro1d3382cb2010-10-23 15:19:20 -04001404 if (unlikely(!inode_unhashed(old))) {
Al Viro261bca82008-12-30 01:48:21 -05001405 iput(old);
1406 return -EBUSY;
1407 }
1408 iput(old);
1409 }
1410}
Al Viro261bca82008-12-30 01:48:21 -05001411EXPORT_SYMBOL(insert_inode_locked4);
1412
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
Al Viro45321ac2010-06-07 13:43:19 -04001414int generic_delete_inode(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415{
Al Viro45321ac2010-06-07 13:43:19 -04001416 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418EXPORT_SYMBOL(generic_delete_inode);
1419
Al Viro45321ac2010-06-07 13:43:19 -04001420/*
Al Viro45321ac2010-06-07 13:43:19 -04001421 * Called when we're dropping the last reference
1422 * to an inode.
1423 *
1424 * Call the FS "drop_inode()" function, defaulting to
1425 * the legacy UNIX filesystem behaviour. If it tells
1426 * us to evict inode, do so. Otherwise, retain inode
1427 * in cache if fs is alive, sync and evict if fs is
1428 * shutting down.
1429 */
1430static void iput_final(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431{
1432 struct super_block *sb = inode->i_sb;
Al Viro45321ac2010-06-07 13:43:19 -04001433 const struct super_operations *op = inode->i_sb->s_op;
1434 int drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
Dave Chinner250df6e2011-03-22 22:23:36 +11001436 WARN_ON(inode->i_state & I_NEW);
1437
Al Viroe7f59092011-07-07 15:45:59 -04001438 if (op->drop_inode)
Al Viro45321ac2010-06-07 13:43:19 -04001439 drop = op->drop_inode(inode);
1440 else
1441 drop = generic_drop_inode(inode);
1442
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001443 if (!drop && (sb->s_flags & MS_ACTIVE)) {
1444 inode->i_state |= I_REFERENCED;
Jan Kara4eff96d2012-11-26 16:29:51 -08001445 inode_add_lru(inode);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001446 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001447 return;
1448 }
1449
Al Viro45321ac2010-06-07 13:43:19 -04001450 if (!drop) {
Alexander Viro991114c2005-06-23 00:09:01 -07001451 inode->i_state |= I_WILL_FREE;
Dave Chinner250df6e2011-03-22 22:23:36 +11001452 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 write_inode_now(inode, 1);
Dave Chinner250df6e2011-03-22 22:23:36 +11001454 spin_lock(&inode->i_lock);
Nick Piggin7ef0d732009-03-12 14:31:38 -07001455 WARN_ON(inode->i_state & I_NEW);
Alexander Viro991114c2005-06-23 00:09:01 -07001456 inode->i_state &= ~I_WILL_FREE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 }
Nick Piggin7ccf19a2010-10-21 11:49:30 +11001458
Alexander Viro991114c2005-06-23 00:09:01 -07001459 inode->i_state |= I_FREEING;
Eric Dumazetc4ae0c62011-07-28 06:55:13 +02001460 if (!list_empty(&inode->i_lru))
1461 inode_lru_list_del(inode);
Dave Chinner250df6e2011-03-22 22:23:36 +11001462 spin_unlock(&inode->i_lock);
Dave Chinnerb2b2af82011-03-22 22:23:37 +11001463
1464 evict(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465}
1466
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467/**
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301468 * iput - put an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 * @inode: inode to put
1470 *
1471 * Puts an inode, dropping its usage count. If the inode use count hits
1472 * zero, the inode is then freed and may also be destroyed.
1473 *
1474 * Consequently, iput() can sleep.
1475 */
1476void iput(struct inode *inode)
1477{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001478 if (!inode)
1479 return;
1480 BUG_ON(inode->i_state & I_CLEAR);
1481retry:
1482 if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1483 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1484 atomic_inc(&inode->i_count);
1485 inode->i_state &= ~I_DIRTY_TIME;
1486 spin_unlock(&inode->i_lock);
1487 trace_writeback_lazytime_iput(inode);
1488 mark_inode_dirty_sync(inode);
1489 goto retry;
1490 }
1491 iput_final(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 }
1493}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494EXPORT_SYMBOL(iput);
1495
1496/**
1497 * bmap - find a block number in a file
1498 * @inode: inode of file
1499 * @block: block to find
1500 *
1501 * Returns the block number on the device holding the inode that
1502 * is the disk block number for the block of the file requested.
1503 * That is, asked for block 4 of inode 1 the function will return the
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301504 * disk block relative to the disk start that holds that block of the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 * file.
1506 */
Manish Katiyar6b3304b2009-03-31 19:35:54 +05301507sector_t bmap(struct inode *inode, sector_t block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508{
1509 sector_t res = 0;
1510 if (inode->i_mapping->a_ops->bmap)
1511 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1512 return res;
1513}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514EXPORT_SYMBOL(bmap);
1515
Matthew Garrett11ff6f052009-03-26 17:32:14 +00001516/*
1517 * With relative atime, only update atime if the previous atime is
1518 * earlier than either the ctime or mtime or if at least a day has
1519 * passed since the last atime update.
1520 */
1521static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
1522 struct timespec now)
1523{
1524
1525 if (!(mnt->mnt_flags & MNT_RELATIME))
1526 return 1;
1527 /*
1528 * Is mtime younger than atime? If yes, update atime:
1529 */
1530 if (timespec_compare(&inode->i_mtime, &inode->i_atime) >= 0)
1531 return 1;
1532 /*
1533 * Is ctime younger than atime? If yes, update atime:
1534 */
1535 if (timespec_compare(&inode->i_ctime, &inode->i_atime) >= 0)
1536 return 1;
1537
1538 /*
1539 * Is the previous atime value older than a day? If yes,
1540 * update atime:
1541 */
1542 if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1543 return 1;
1544 /*
1545 * Good, we can skip the atime update:
1546 */
1547 return 0;
1548}
1549
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001550int generic_update_time(struct inode *inode, struct timespec *time, int flags)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001551{
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001552 int iflags = I_DIRTY_TIME;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001553
1554 if (flags & S_ATIME)
1555 inode->i_atime = *time;
1556 if (flags & S_VERSION)
1557 inode_inc_iversion(inode);
1558 if (flags & S_CTIME)
1559 inode->i_ctime = *time;
1560 if (flags & S_MTIME)
1561 inode->i_mtime = *time;
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001562
1563 if (!(inode->i_sb->s_flags & MS_LAZYTIME) || (flags & S_VERSION))
1564 iflags |= I_DIRTY_SYNC;
1565 __mark_inode_dirty(inode, iflags);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001566 return 0;
1567}
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001568EXPORT_SYMBOL(generic_update_time);
1569
1570/*
1571 * This does the actual work of updating an inodes time or version. Must have
1572 * had called mnt_want_write() before calling this.
1573 */
1574static int update_time(struct inode *inode, struct timespec *time, int flags)
1575{
1576 int (*update_time)(struct inode *, struct timespec *, int);
1577
1578 update_time = inode->i_op->update_time ? inode->i_op->update_time :
1579 generic_update_time;
1580
1581 return update_time(inode, time, flags);
1582}
Josef Bacikc3b2da32012-03-26 09:59:21 -04001583
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584/**
Christoph Hellwig869243a2006-01-09 20:52:03 -08001585 * touch_atime - update the access time
Randy Dunlap185553b2012-04-17 17:03:25 -07001586 * @path: the &struct path to update
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 *
1588 * Update the accessed time on an inode and mark it for writeback.
1589 * This function automatically handles read only file systems and media,
1590 * as well as the "noatime" flag and inode specific "noatime" markers.
1591 */
NeilBrown8fa9dd22015-03-23 13:37:40 +11001592bool atime_needs_update(const struct path *path, struct inode *inode)
1593{
1594 struct vfsmount *mnt = path->mnt;
1595 struct timespec now;
1596
1597 if (inode->i_flags & S_NOATIME)
1598 return false;
1599 if (IS_NOATIME(inode))
1600 return false;
1601 if ((inode->i_sb->s_flags & MS_NODIRATIME) && S_ISDIR(inode->i_mode))
1602 return false;
1603
1604 if (mnt->mnt_flags & MNT_NOATIME)
1605 return false;
1606 if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1607 return false;
1608
1609 now = current_fs_time(inode->i_sb);
1610
1611 if (!relatime_need_update(mnt, inode, now))
1612 return false;
1613
1614 if (timespec_equal(&inode->i_atime, &now))
1615 return false;
1616
1617 return true;
1618}
1619
Al Virobadcf2b2013-07-16 18:15:46 +04001620void touch_atime(const struct path *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621{
Al Viro68ac1232012-03-15 08:21:57 -04001622 struct vfsmount *mnt = path->mnt;
David Howellsdf2b1af2015-03-17 22:26:15 +00001623 struct inode *inode = d_inode(path->dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 struct timespec now;
1625
NeilBrown8fa9dd22015-03-23 13:37:40 +11001626 if (!atime_needs_update(path, inode))
Andi Kleenb12536c2009-09-18 13:05:47 -07001627 return;
1628
Jan Kara5d37e9e2012-06-12 16:20:36 +02001629 if (!sb_start_write_trylock(inode->i_sb))
Andi Kleenb12536c2009-09-18 13:05:47 -07001630 return;
Valerie Henson47ae32d2006-12-13 00:34:34 -08001631
NeilBrown8fa9dd22015-03-23 13:37:40 +11001632 if (__mnt_want_write(mnt) != 0)
Jan Kara5d37e9e2012-06-12 16:20:36 +02001633 goto skip_update;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001634 /*
1635 * File systems can error out when updating inodes if they need to
1636 * allocate new space to modify an inode (such is the case for
1637 * Btrfs), but since we touch atime while walking down the path we
1638 * really don't care if we failed to update the atime of the file,
1639 * so just ignore the return value.
Alexander Block2bc5565282012-06-15 09:49:33 +02001640 * We may also fail on filesystems that have the ability to make parts
1641 * of the fs read only, e.g. subvolumes in Btrfs.
Josef Bacikc3b2da32012-03-26 09:59:21 -04001642 */
NeilBrown8fa9dd22015-03-23 13:37:40 +11001643 now = current_fs_time(inode->i_sb);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001644 update_time(inode, &now, S_ATIME);
Jan Kara5d37e9e2012-06-12 16:20:36 +02001645 __mnt_drop_write(mnt);
1646skip_update:
1647 sb_end_write(inode->i_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648}
Christoph Hellwig869243a2006-01-09 20:52:03 -08001649EXPORT_SYMBOL(touch_atime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Cong Wang3ed37642012-05-15 14:57:33 +08001651/*
1652 * The logic we want is
1653 *
1654 * if suid or (sgid and xgrp)
1655 * remove privs
1656 */
1657int should_remove_suid(struct dentry *dentry)
1658{
David Howellsdf2b1af2015-03-17 22:26:15 +00001659 umode_t mode = d_inode(dentry)->i_mode;
Cong Wang3ed37642012-05-15 14:57:33 +08001660 int kill = 0;
1661
1662 /* suid always must be killed */
1663 if (unlikely(mode & S_ISUID))
1664 kill = ATTR_KILL_SUID;
1665
1666 /*
1667 * sgid without any exec bits is just a mandatory locking mark; leave
1668 * it alone. If some exec bits are set, it's a real sgid; kill it.
1669 */
1670 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1671 kill |= ATTR_KILL_SGID;
1672
1673 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1674 return kill;
1675
1676 return 0;
1677}
1678EXPORT_SYMBOL(should_remove_suid);
1679
Jan Karadbfae0c2015-05-21 16:05:54 +02001680/*
1681 * Return mask of changes for notify_change() that need to be done as a
1682 * response to write or truncate. Return 0 if nothing has to be changed.
1683 * Negative value on error (change should be denied).
1684 */
Jan Kara45f147a2015-05-21 16:05:55 +02001685int dentry_needs_remove_privs(struct dentry *dentry)
Jan Karadbfae0c2015-05-21 16:05:54 +02001686{
Jan Karadbfae0c2015-05-21 16:05:54 +02001687 struct inode *inode = d_inode(dentry);
1688 int mask = 0;
1689 int ret;
1690
1691 if (IS_NOSEC(inode))
1692 return 0;
1693
1694 mask = should_remove_suid(dentry);
1695 ret = security_inode_need_killpriv(dentry);
1696 if (ret < 0)
1697 return ret;
1698 if (ret)
1699 mask |= ATTR_KILL_PRIV;
1700 return mask;
1701}
Jan Kara45f147a2015-05-21 16:05:55 +02001702EXPORT_SYMBOL(dentry_needs_remove_privs);
Jan Karadbfae0c2015-05-21 16:05:54 +02001703
1704static int __remove_privs(struct dentry *dentry, int kill)
Cong Wang3ed37642012-05-15 14:57:33 +08001705{
1706 struct iattr newattrs;
1707
1708 newattrs.ia_valid = ATTR_FORCE | kill;
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04001709 /*
1710 * Note we call this on write, so notify_change will not
1711 * encounter any conflicting delegations:
1712 */
1713 return notify_change(dentry, &newattrs, NULL);
Cong Wang3ed37642012-05-15 14:57:33 +08001714}
1715
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001716/*
1717 * Remove special file priviledges (suid, capabilities) when file is written
1718 * to or truncated.
1719 */
1720int file_remove_privs(struct file *file)
Cong Wang3ed37642012-05-15 14:57:33 +08001721{
1722 struct dentry *dentry = file->f_path.dentry;
David Howellsdf2b1af2015-03-17 22:26:15 +00001723 struct inode *inode = d_inode(dentry);
Jan Karadbfae0c2015-05-21 16:05:54 +02001724 int kill;
Cong Wang3ed37642012-05-15 14:57:33 +08001725 int error = 0;
1726
1727 /* Fast path for nothing security related */
1728 if (IS_NOSEC(inode))
1729 return 0;
1730
Jan Karadbfae0c2015-05-21 16:05:54 +02001731 kill = file_needs_remove_privs(file);
1732 if (kill < 0)
1733 return kill;
1734 if (kill)
1735 error = __remove_privs(dentry, kill);
Jan Kara2426f392015-05-21 16:05:52 +02001736 if (!error)
1737 inode_has_no_xattr(inode);
Cong Wang3ed37642012-05-15 14:57:33 +08001738
1739 return error;
1740}
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001741EXPORT_SYMBOL(file_remove_privs);
Cong Wang3ed37642012-05-15 14:57:33 +08001742
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743/**
Christoph Hellwig870f4812006-01-09 20:52:01 -08001744 * file_update_time - update mtime and ctime time
1745 * @file: file accessed
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 *
Christoph Hellwig870f4812006-01-09 20:52:01 -08001747 * Update the mtime and ctime members of an inode and mark the inode
1748 * for writeback. Note that this function is meant exclusively for
1749 * usage in the file write path of filesystems, and filesystems may
1750 * choose to explicitly ignore update via this function with the
Wolfram Sang2eadfc02009-04-02 15:23:37 +02001751 * S_NOCMTIME inode flag, e.g. for network filesystem where these
Josef Bacikc3b2da32012-03-26 09:59:21 -04001752 * timestamps are handled by the server. This can return an error for
1753 * file systems who need to allocate space in order to update an inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 */
1755
Josef Bacikc3b2da32012-03-26 09:59:21 -04001756int file_update_time(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757{
Al Viro496ad9a2013-01-23 17:07:38 -05001758 struct inode *inode = file_inode(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 struct timespec now;
Josef Bacikc3b2da32012-03-26 09:59:21 -04001760 int sync_it = 0;
1761 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762
Andi Kleence06e0b2009-09-18 13:05:48 -07001763 /* First try to exhaust all avenues to not sync */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 if (IS_NOCMTIME(inode))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001765 return 0;
Dave Hansen20ddee22008-02-15 14:37:43 -08001766
Andi Kleence06e0b2009-09-18 13:05:48 -07001767 now = current_fs_time(inode->i_sb);
1768 if (!timespec_equal(&inode->i_mtime, &now))
1769 sync_it = S_MTIME;
1770
1771 if (!timespec_equal(&inode->i_ctime, &now))
1772 sync_it |= S_CTIME;
1773
1774 if (IS_I_VERSION(inode))
1775 sync_it |= S_VERSION;
1776
1777 if (!sync_it)
Josef Bacikc3b2da32012-03-26 09:59:21 -04001778 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
Andi Kleence06e0b2009-09-18 13:05:48 -07001780 /* Finally allowed to write? Takes lock. */
Jan Karaeb04c282012-06-12 16:20:35 +02001781 if (__mnt_want_write_file(file))
Josef Bacikc3b2da32012-03-26 09:59:21 -04001782 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Josef Bacikc3b2da32012-03-26 09:59:21 -04001784 ret = update_time(inode, &now, sync_it);
Jan Karaeb04c282012-06-12 16:20:35 +02001785 __mnt_drop_write_file(file);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001786
1787 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788}
Christoph Hellwig870f4812006-01-09 20:52:01 -08001789EXPORT_SYMBOL(file_update_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790
1791int inode_needs_sync(struct inode *inode)
1792{
1793 if (IS_SYNC(inode))
1794 return 1;
1795 if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1796 return 1;
1797 return 0;
1798}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799EXPORT_SYMBOL(inode_needs_sync);
1800
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801/*
Miklos Szeredi168a9fd2005-07-12 13:58:10 -07001802 * If we try to find an inode in the inode hash while it is being
1803 * deleted, we have to wait until the filesystem completes its
1804 * deletion before reporting that it isn't found. This function waits
1805 * until the deletion _might_ have completed. Callers are responsible
1806 * to recheck inode state.
1807 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001808 * It doesn't matter if I_NEW is not set initially, a call to
Dave Chinner250df6e2011-03-22 22:23:36 +11001809 * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
1810 * will DTRT.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 */
1812static void __wait_on_freeing_inode(struct inode *inode)
1813{
1814 wait_queue_head_t *wq;
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001815 DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1816 wq = bit_waitqueue(&inode->i_state, __I_NEW);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
Dave Chinner250df6e2011-03-22 22:23:36 +11001818 spin_unlock(&inode->i_lock);
Dave Chinner67a23c42011-03-22 22:23:42 +11001819 spin_unlock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 schedule();
1821 finish_wait(wq, &wait.wait);
Dave Chinner67a23c42011-03-22 22:23:42 +11001822 spin_lock(&inode_hash_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823}
1824
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825static __initdata unsigned long ihash_entries;
1826static int __init set_ihash_entries(char *str)
1827{
1828 if (!str)
1829 return 0;
1830 ihash_entries = simple_strtoul(str, &str, 0);
1831 return 1;
1832}
1833__setup("ihash_entries=", set_ihash_entries);
1834
1835/*
1836 * Initialize the waitqueues and inode hash table.
1837 */
1838void __init inode_init_early(void)
1839{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001840 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841
1842 /* If hashes are distributed across NUMA nodes, defer
1843 * hash allocation until vmalloc space is available.
1844 */
1845 if (hashdist)
1846 return;
1847
1848 inode_hashtable =
1849 alloc_large_system_hash("Inode-cache",
1850 sizeof(struct hlist_head),
1851 ihash_entries,
1852 14,
1853 HASH_EARLY,
1854 &i_hash_shift,
1855 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00001856 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 0);
1858
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001859 for (loop = 0; loop < (1U << i_hash_shift); loop++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1861}
1862
Denis Cheng74bf17c2007-10-16 23:26:30 -07001863void __init inode_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001865 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866
1867 /* inode slab cache */
Paul Jacksonb0196002006-03-24 03:16:09 -08001868 inode_cachep = kmem_cache_create("inode_cache",
1869 sizeof(struct inode),
1870 0,
1871 (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
1872 SLAB_MEM_SPREAD),
Paul Mundt20c2df82007-07-20 10:11:58 +09001873 init_once);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874
1875 /* Hash may have been set up in inode_init_early */
1876 if (!hashdist)
1877 return;
1878
1879 inode_hashtable =
1880 alloc_large_system_hash("Inode-cache",
1881 sizeof(struct hlist_head),
1882 ihash_entries,
1883 14,
1884 0,
1885 &i_hash_shift,
1886 &i_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00001887 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 0);
1889
Dimitri Sivanich074b8512012-02-08 12:39:07 -08001890 for (loop = 0; loop < (1U << i_hash_shift); loop++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1892}
1893
1894void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
1895{
1896 inode->i_mode = mode;
1897 if (S_ISCHR(mode)) {
1898 inode->i_fop = &def_chr_fops;
1899 inode->i_rdev = rdev;
1900 } else if (S_ISBLK(mode)) {
1901 inode->i_fop = &def_blk_fops;
1902 inode->i_rdev = rdev;
1903 } else if (S_ISFIFO(mode))
Al Viro599a0ac2013-03-12 09:58:10 -04001904 inode->i_fop = &pipefifo_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 else if (S_ISSOCK(mode))
Al Virobd9b51e2014-11-18 23:38:21 -05001906 ; /* leave it no_open_fops */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 else
Manish Katiyaraf0d9ae2009-09-18 13:05:43 -07001908 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
1909 " inode %s:%lu\n", mode, inode->i_sb->s_id,
1910 inode->i_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911}
1912EXPORT_SYMBOL(init_special_inode);
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001913
1914/**
Ben Hutchingseaae668d2011-02-15 12:48:09 +00001915 * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001916 * @inode: New inode
1917 * @dir: Directory inode
1918 * @mode: mode of the new inode
1919 */
1920void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001921 umode_t mode)
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001922{
1923 inode->i_uid = current_fsuid();
1924 if (dir && dir->i_mode & S_ISGID) {
1925 inode->i_gid = dir->i_gid;
1926 if (S_ISDIR(mode))
1927 mode |= S_ISGID;
1928 } else
1929 inode->i_gid = current_fsgid();
1930 inode->i_mode = mode;
1931}
1932EXPORT_SYMBOL(inode_init_owner);
Serge E. Hallyne795b712011-03-23 16:43:25 -07001933
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001934/**
1935 * inode_owner_or_capable - check current task permissions to inode
1936 * @inode: inode being checked
1937 *
Andy Lutomirski23adbe12014-06-10 12:45:42 -07001938 * Return true if current either has CAP_FOWNER in a namespace with the
1939 * inode owner uid mapped, or owns the file.
Serge E. Hallyne795b712011-03-23 16:43:25 -07001940 */
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001941bool inode_owner_or_capable(const struct inode *inode)
Serge E. Hallyne795b712011-03-23 16:43:25 -07001942{
Andy Lutomirski23adbe12014-06-10 12:45:42 -07001943 struct user_namespace *ns;
1944
Eric W. Biederman92361632012-02-08 07:07:50 -08001945 if (uid_eq(current_fsuid(), inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07001946 return true;
Andy Lutomirski23adbe12014-06-10 12:45:42 -07001947
1948 ns = current_user_ns();
1949 if (ns_capable(ns, CAP_FOWNER) && kuid_has_mapping(ns, inode->i_uid))
Serge E. Hallyne795b712011-03-23 16:43:25 -07001950 return true;
1951 return false;
1952}
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001953EXPORT_SYMBOL(inode_owner_or_capable);
Trond Myklebust1d59d612012-05-31 12:22:33 -04001954
1955/*
1956 * Direct i/o helper functions
1957 */
1958static void __inode_dio_wait(struct inode *inode)
1959{
1960 wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
1961 DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
1962
1963 do {
1964 prepare_to_wait(wq, &q.wait, TASK_UNINTERRUPTIBLE);
1965 if (atomic_read(&inode->i_dio_count))
1966 schedule();
1967 } while (atomic_read(&inode->i_dio_count));
1968 finish_wait(wq, &q.wait);
1969}
1970
1971/**
1972 * inode_dio_wait - wait for outstanding DIO requests to finish
1973 * @inode: inode to wait for
1974 *
1975 * Waits for all pending direct I/O requests to finish so that we can
1976 * proceed with a truncate or equivalent operation.
1977 *
1978 * Must be called under a lock that serializes taking new references
1979 * to i_dio_count, usually by inode->i_mutex.
1980 */
1981void inode_dio_wait(struct inode *inode)
1982{
1983 if (atomic_read(&inode->i_dio_count))
1984 __inode_dio_wait(inode);
1985}
1986EXPORT_SYMBOL(inode_dio_wait);
1987
1988/*
Theodore Ts'o5f16f322014-03-24 14:43:12 -04001989 * inode_set_flags - atomically set some inode flags
1990 *
1991 * Note: the caller should be holding i_mutex, or else be sure that
1992 * they have exclusive access to the inode structure (i.e., while the
1993 * inode is being instantiated). The reason for the cmpxchg() loop
1994 * --- which wouldn't be necessary if all code paths which modify
1995 * i_flags actually followed this rule, is that there is at least one
Jan Kara5fa8e0a2015-05-21 16:05:53 +02001996 * code path which doesn't today so we use cmpxchg() out of an abundance
1997 * of caution.
Theodore Ts'o5f16f322014-03-24 14:43:12 -04001998 *
1999 * In the long run, i_mutex is overkill, and we should probably look
2000 * at using the i_lock spinlock to protect i_flags, and then make sure
2001 * it is so documented in include/linux/fs.h and that all code follows
2002 * the locking convention!!
2003 */
2004void inode_set_flags(struct inode *inode, unsigned int flags,
2005 unsigned int mask)
2006{
2007 unsigned int old_flags, new_flags;
2008
2009 WARN_ON_ONCE(flags & ~mask);
2010 do {
2011 old_flags = ACCESS_ONCE(inode->i_flags);
2012 new_flags = (old_flags & ~mask) | flags;
2013 } while (unlikely(cmpxchg(&inode->i_flags, old_flags,
2014 new_flags) != old_flags));
2015}
2016EXPORT_SYMBOL(inode_set_flags);