705f8609fdb8c878adf3dc5728ee58808f6f0924
[cascardo/linux.git] / fs / inode.c
1 /*
2  * (C) 1997 Linus Torvalds
3  * (C) 1999 Andrea Arcangeli <andrea@suse.de> (dynamic inode allocation)
4  */
5 #include <linux/export.h>
6 #include <linux/fs.h>
7 #include <linux/mm.h>
8 #include <linux/backing-dev.h>
9 #include <linux/hash.h>
10 #include <linux/swap.h>
11 #include <linux/security.h>
12 #include <linux/cdev.h>
13 #include <linux/bootmem.h>
14 #include <linux/fsnotify.h>
15 #include <linux/mount.h>
16 #include <linux/posix_acl.h>
17 #include <linux/prefetch.h>
18 #include <linux/buffer_head.h> /* for inode_has_buffers */
19 #include <linux/ratelimit.h>
20 #include <linux/list_lru.h>
21 #include <trace/events/writeback.h>
22 #include "internal.h"
23
24 /*
25  * Inode locking rules:
26  *
27  * inode->i_lock protects:
28  *   inode->i_state, inode->i_hash, __iget()
29  * Inode LRU list locks protect:
30  *   inode->i_sb->s_inode_lru, inode->i_lru
31  * inode->i_sb->s_inode_list_lock protects:
32  *   inode->i_sb->s_inodes, inode->i_sb_list
33  * bdi->wb.list_lock protects:
34  *   bdi->wb.b_{dirty,io,more_io,dirty_time}, inode->i_io_list
35  * inode_hash_lock protects:
36  *   inode_hashtable, inode->i_hash
37  *
38  * Lock ordering:
39  *
40  * inode->i_sb->s_inode_list_lock
41  *   inode->i_lock
42  *     Inode LRU list locks
43  *
44  * bdi->wb.list_lock
45  *   inode->i_lock
46  *
47  * inode_hash_lock
48  *   inode->i_sb->s_inode_list_lock
49  *   inode->i_lock
50  *
51  * iunique_lock
52  *   inode_hash_lock
53  */
54
55 static unsigned int i_hash_mask __read_mostly;
56 static unsigned int i_hash_shift __read_mostly;
57 static struct hlist_head *inode_hashtable __read_mostly;
58 static __cacheline_aligned_in_smp DEFINE_SPINLOCK(inode_hash_lock);
59
60 /*
61  * Empty aops. Can be used for the cases where the user does not
62  * define any of the address_space operations.
63  */
64 const struct address_space_operations empty_aops = {
65 };
66 EXPORT_SYMBOL(empty_aops);
67
68 /*
69  * Statistics gathering..
70  */
71 struct inodes_stat_t inodes_stat;
72
73 static DEFINE_PER_CPU(unsigned long, nr_inodes);
74 static DEFINE_PER_CPU(unsigned long, nr_unused);
75
76 static struct kmem_cache *inode_cachep __read_mostly;
77
78 static long get_nr_inodes(void)
79 {
80         int i;
81         long sum = 0;
82         for_each_possible_cpu(i)
83                 sum += per_cpu(nr_inodes, i);
84         return sum < 0 ? 0 : sum;
85 }
86
87 static inline long get_nr_inodes_unused(void)
88 {
89         int i;
90         long sum = 0;
91         for_each_possible_cpu(i)
92                 sum += per_cpu(nr_unused, i);
93         return sum < 0 ? 0 : sum;
94 }
95
96 long get_nr_dirty_inodes(void)
97 {
98         /* not actually dirty inodes, but a wild approximation */
99         long nr_dirty = get_nr_inodes() - get_nr_inodes_unused();
100         return nr_dirty > 0 ? nr_dirty : 0;
101 }
102
103 /*
104  * Handle nr_inode sysctl
105  */
106 #ifdef CONFIG_SYSCTL
107 int proc_nr_inodes(struct ctl_table *table, int write,
108                    void __user *buffer, size_t *lenp, loff_t *ppos)
109 {
110         inodes_stat.nr_inodes = get_nr_inodes();
111         inodes_stat.nr_unused = get_nr_inodes_unused();
112         return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
113 }
114 #endif
115
116 static int no_open(struct inode *inode, struct file *file)
117 {
118         return -ENXIO;
119 }
120
121 /**
122  * inode_init_always - perform inode structure intialisation
123  * @sb: superblock inode belongs to
124  * @inode: inode to initialise
125  *
126  * These are initializations that need to be done on every inode
127  * allocation as the fields are not initialised by slab allocation.
128  */
129 int inode_init_always(struct super_block *sb, struct inode *inode)
130 {
131         static const struct inode_operations empty_iops;
132         static const struct file_operations no_open_fops = {.open = no_open};
133         struct address_space *const mapping = &inode->i_data;
134
135         inode->i_sb = sb;
136         inode->i_blkbits = sb->s_blocksize_bits;
137         inode->i_flags = 0;
138         atomic_set(&inode->i_count, 1);
139         inode->i_op = &empty_iops;
140         inode->i_fop = &no_open_fops;
141         inode->__i_nlink = 1;
142         inode->i_opflags = 0;
143         if (sb->s_xattr)
144                 inode->i_opflags |= IOP_XATTR;
145         i_uid_write(inode, 0);
146         i_gid_write(inode, 0);
147         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;
152         inode->i_pipe = NULL;
153         inode->i_bdev = NULL;
154         inode->i_cdev = NULL;
155         inode->i_link = NULL;
156         inode->i_dir_seq = 0;
157         inode->i_rdev = 0;
158         inode->dirtied_when = 0;
159
160 #ifdef CONFIG_CGROUP_WRITEBACK
161         inode->i_wb_frn_winner = 0;
162         inode->i_wb_frn_avg_time = 0;
163         inode->i_wb_frn_history = 0;
164 #endif
165
166         if (security_inode_alloc(inode))
167                 goto out;
168         spin_lock_init(&inode->i_lock);
169         lockdep_set_class(&inode->i_lock, &sb->s_type->i_lock_key);
170
171         init_rwsem(&inode->i_rwsem);
172         lockdep_set_class(&inode->i_rwsem, &sb->s_type->i_mutex_key);
173
174         atomic_set(&inode->i_dio_count, 0);
175
176         mapping->a_ops = &empty_aops;
177         mapping->host = inode;
178         mapping->flags = 0;
179         atomic_set(&mapping->i_mmap_writable, 0);
180         mapping_set_gfp_mask(mapping, GFP_HIGHUSER_MOVABLE);
181         mapping->private_data = NULL;
182         mapping->writeback_index = 0;
183         inode->i_private = NULL;
184         inode->i_mapping = mapping;
185         INIT_HLIST_HEAD(&inode->i_dentry);      /* buggered by rcu freeing */
186 #ifdef CONFIG_FS_POSIX_ACL
187         inode->i_acl = inode->i_default_acl = ACL_NOT_CACHED;
188 #endif
189
190 #ifdef CONFIG_FSNOTIFY
191         inode->i_fsnotify_mask = 0;
192 #endif
193         inode->i_flctx = NULL;
194         this_cpu_inc(nr_inodes);
195
196         return 0;
197 out:
198         return -ENOMEM;
199 }
200 EXPORT_SYMBOL(inode_init_always);
201
202 static struct inode *alloc_inode(struct super_block *sb)
203 {
204         struct inode *inode;
205
206         if (sb->s_op->alloc_inode)
207                 inode = sb->s_op->alloc_inode(sb);
208         else
209                 inode = kmem_cache_alloc(inode_cachep, GFP_KERNEL);
210
211         if (!inode)
212                 return NULL;
213
214         if (unlikely(inode_init_always(sb, inode))) {
215                 if (inode->i_sb->s_op->destroy_inode)
216                         inode->i_sb->s_op->destroy_inode(inode);
217                 else
218                         kmem_cache_free(inode_cachep, inode);
219                 return NULL;
220         }
221
222         return inode;
223 }
224
225 void free_inode_nonrcu(struct inode *inode)
226 {
227         kmem_cache_free(inode_cachep, inode);
228 }
229 EXPORT_SYMBOL(free_inode_nonrcu);
230
231 void __destroy_inode(struct inode *inode)
232 {
233         BUG_ON(inode_has_buffers(inode));
234         inode_detach_wb(inode);
235         security_inode_free(inode);
236         fsnotify_inode_delete(inode);
237         locks_free_lock_context(inode);
238         if (!inode->i_nlink) {
239                 WARN_ON(atomic_long_read(&inode->i_sb->s_remove_count) == 0);
240                 atomic_long_dec(&inode->i_sb->s_remove_count);
241         }
242
243 #ifdef CONFIG_FS_POSIX_ACL
244         if (inode->i_acl && !is_uncached_acl(inode->i_acl))
245                 posix_acl_release(inode->i_acl);
246         if (inode->i_default_acl && !is_uncached_acl(inode->i_default_acl))
247                 posix_acl_release(inode->i_default_acl);
248 #endif
249         this_cpu_dec(nr_inodes);
250 }
251 EXPORT_SYMBOL(__destroy_inode);
252
253 static void i_callback(struct rcu_head *head)
254 {
255         struct inode *inode = container_of(head, struct inode, i_rcu);
256         kmem_cache_free(inode_cachep, inode);
257 }
258
259 static void destroy_inode(struct inode *inode)
260 {
261         BUG_ON(!list_empty(&inode->i_lru));
262         __destroy_inode(inode);
263         if (inode->i_sb->s_op->destroy_inode)
264                 inode->i_sb->s_op->destroy_inode(inode);
265         else
266                 call_rcu(&inode->i_rcu, i_callback);
267 }
268
269 /**
270  * drop_nlink - directly drop an inode's link count
271  * @inode: inode
272  *
273  * This is a low-level filesystem helper to replace any
274  * direct filesystem manipulation of i_nlink.  In cases
275  * where we are attempting to track writes to the
276  * filesystem, a decrement to zero means an imminent
277  * write when the file is truncated and actually unlinked
278  * on the filesystem.
279  */
280 void drop_nlink(struct inode *inode)
281 {
282         WARN_ON(inode->i_nlink == 0);
283         inode->__i_nlink--;
284         if (!inode->i_nlink)
285                 atomic_long_inc(&inode->i_sb->s_remove_count);
286 }
287 EXPORT_SYMBOL(drop_nlink);
288
289 /**
290  * clear_nlink - directly zero an inode's link count
291  * @inode: inode
292  *
293  * This is a low-level filesystem helper to replace any
294  * direct filesystem manipulation of i_nlink.  See
295  * drop_nlink() for why we care about i_nlink hitting zero.
296  */
297 void clear_nlink(struct inode *inode)
298 {
299         if (inode->i_nlink) {
300                 inode->__i_nlink = 0;
301                 atomic_long_inc(&inode->i_sb->s_remove_count);
302         }
303 }
304 EXPORT_SYMBOL(clear_nlink);
305
306 /**
307  * set_nlink - directly set an inode's link count
308  * @inode: inode
309  * @nlink: new nlink (should be non-zero)
310  *
311  * This is a low-level filesystem helper to replace any
312  * direct filesystem manipulation of i_nlink.
313  */
314 void set_nlink(struct inode *inode, unsigned int nlink)
315 {
316         if (!nlink) {
317                 clear_nlink(inode);
318         } else {
319                 /* Yes, some filesystems do change nlink from zero to one */
320                 if (inode->i_nlink == 0)
321                         atomic_long_dec(&inode->i_sb->s_remove_count);
322
323                 inode->__i_nlink = nlink;
324         }
325 }
326 EXPORT_SYMBOL(set_nlink);
327
328 /**
329  * inc_nlink - directly increment an inode's link count
330  * @inode: inode
331  *
332  * This is a low-level filesystem helper to replace any
333  * direct filesystem manipulation of i_nlink.  Currently,
334  * it is only here for parity with dec_nlink().
335  */
336 void inc_nlink(struct inode *inode)
337 {
338         if (unlikely(inode->i_nlink == 0)) {
339                 WARN_ON(!(inode->i_state & I_LINKABLE));
340                 atomic_long_dec(&inode->i_sb->s_remove_count);
341         }
342
343         inode->__i_nlink++;
344 }
345 EXPORT_SYMBOL(inc_nlink);
346
347 void address_space_init_once(struct address_space *mapping)
348 {
349         memset(mapping, 0, sizeof(*mapping));
350         INIT_RADIX_TREE(&mapping->page_tree, GFP_ATOMIC | __GFP_ACCOUNT);
351         spin_lock_init(&mapping->tree_lock);
352         init_rwsem(&mapping->i_mmap_rwsem);
353         INIT_LIST_HEAD(&mapping->private_list);
354         spin_lock_init(&mapping->private_lock);
355         mapping->i_mmap = RB_ROOT;
356 }
357 EXPORT_SYMBOL(address_space_init_once);
358
359 /*
360  * These are initializations that only need to be done
361  * once, because the fields are idempotent across use
362  * of the inode, so let the slab aware of that.
363  */
364 void inode_init_once(struct inode *inode)
365 {
366         memset(inode, 0, sizeof(*inode));
367         INIT_HLIST_NODE(&inode->i_hash);
368         INIT_LIST_HEAD(&inode->i_devices);
369         INIT_LIST_HEAD(&inode->i_io_list);
370         INIT_LIST_HEAD(&inode->i_wb_list);
371         INIT_LIST_HEAD(&inode->i_lru);
372         address_space_init_once(&inode->i_data);
373         i_size_ordered_init(inode);
374 #ifdef CONFIG_FSNOTIFY
375         INIT_HLIST_HEAD(&inode->i_fsnotify_marks);
376 #endif
377 }
378 EXPORT_SYMBOL(inode_init_once);
379
380 static void init_once(void *foo)
381 {
382         struct inode *inode = (struct inode *) foo;
383
384         inode_init_once(inode);
385 }
386
387 /*
388  * inode->i_lock must be held
389  */
390 void __iget(struct inode *inode)
391 {
392         atomic_inc(&inode->i_count);
393 }
394
395 /*
396  * get additional reference to inode; caller must already hold one.
397  */
398 void ihold(struct inode *inode)
399 {
400         WARN_ON(atomic_inc_return(&inode->i_count) < 2);
401 }
402 EXPORT_SYMBOL(ihold);
403
404 static void inode_lru_list_add(struct inode *inode)
405 {
406         if (list_lru_add(&inode->i_sb->s_inode_lru, &inode->i_lru))
407                 this_cpu_inc(nr_unused);
408 }
409
410 /*
411  * Add inode to LRU if needed (inode is unused and clean).
412  *
413  * Needs inode->i_lock held.
414  */
415 void inode_add_lru(struct inode *inode)
416 {
417         if (!(inode->i_state & (I_DIRTY_ALL | I_SYNC |
418                                 I_FREEING | I_WILL_FREE)) &&
419             !atomic_read(&inode->i_count) && inode->i_sb->s_flags & MS_ACTIVE)
420                 inode_lru_list_add(inode);
421 }
422
423
424 static void inode_lru_list_del(struct inode *inode)
425 {
426
427         if (list_lru_del(&inode->i_sb->s_inode_lru, &inode->i_lru))
428                 this_cpu_dec(nr_unused);
429 }
430
431 /**
432  * inode_sb_list_add - add inode to the superblock list of inodes
433  * @inode: inode to add
434  */
435 void inode_sb_list_add(struct inode *inode)
436 {
437         spin_lock(&inode->i_sb->s_inode_list_lock);
438         list_add(&inode->i_sb_list, &inode->i_sb->s_inodes);
439         spin_unlock(&inode->i_sb->s_inode_list_lock);
440 }
441 EXPORT_SYMBOL_GPL(inode_sb_list_add);
442
443 static inline void inode_sb_list_del(struct inode *inode)
444 {
445         if (!list_empty(&inode->i_sb_list)) {
446                 spin_lock(&inode->i_sb->s_inode_list_lock);
447                 list_del_init(&inode->i_sb_list);
448                 spin_unlock(&inode->i_sb->s_inode_list_lock);
449         }
450 }
451
452 static unsigned long hash(struct super_block *sb, unsigned long hashval)
453 {
454         unsigned long tmp;
455
456         tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
457                         L1_CACHE_BYTES;
458         tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> i_hash_shift);
459         return tmp & i_hash_mask;
460 }
461
462 /**
463  *      __insert_inode_hash - hash an inode
464  *      @inode: unhashed inode
465  *      @hashval: unsigned long value used to locate this object in the
466  *              inode_hashtable.
467  *
468  *      Add an inode to the inode hash for this superblock.
469  */
470 void __insert_inode_hash(struct inode *inode, unsigned long hashval)
471 {
472         struct hlist_head *b = inode_hashtable + hash(inode->i_sb, hashval);
473
474         spin_lock(&inode_hash_lock);
475         spin_lock(&inode->i_lock);
476         hlist_add_head(&inode->i_hash, b);
477         spin_unlock(&inode->i_lock);
478         spin_unlock(&inode_hash_lock);
479 }
480 EXPORT_SYMBOL(__insert_inode_hash);
481
482 /**
483  *      __remove_inode_hash - remove an inode from the hash
484  *      @inode: inode to unhash
485  *
486  *      Remove an inode from the superblock.
487  */
488 void __remove_inode_hash(struct inode *inode)
489 {
490         spin_lock(&inode_hash_lock);
491         spin_lock(&inode->i_lock);
492         hlist_del_init(&inode->i_hash);
493         spin_unlock(&inode->i_lock);
494         spin_unlock(&inode_hash_lock);
495 }
496 EXPORT_SYMBOL(__remove_inode_hash);
497
498 void clear_inode(struct inode *inode)
499 {
500         might_sleep();
501         /*
502          * We have to cycle tree_lock here because reclaim can be still in the
503          * process of removing the last page (in __delete_from_page_cache())
504          * and we must not free mapping under it.
505          */
506         spin_lock_irq(&inode->i_data.tree_lock);
507         BUG_ON(inode->i_data.nrpages);
508         BUG_ON(inode->i_data.nrexceptional);
509         spin_unlock_irq(&inode->i_data.tree_lock);
510         BUG_ON(!list_empty(&inode->i_data.private_list));
511         BUG_ON(!(inode->i_state & I_FREEING));
512         BUG_ON(inode->i_state & I_CLEAR);
513         BUG_ON(!list_empty(&inode->i_wb_list));
514         /* don't need i_lock here, no concurrent mods to i_state */
515         inode->i_state = I_FREEING | I_CLEAR;
516 }
517 EXPORT_SYMBOL(clear_inode);
518
519 /*
520  * Free the inode passed in, removing it from the lists it is still connected
521  * to. We remove any pages still attached to the inode and wait for any IO that
522  * is still in progress before finally destroying the inode.
523  *
524  * An inode must already be marked I_FREEING so that we avoid the inode being
525  * moved back onto lists if we race with other code that manipulates the lists
526  * (e.g. writeback_single_inode). The caller is responsible for setting this.
527  *
528  * An inode must already be removed from the LRU list before being evicted from
529  * the cache. This should occur atomically with setting the I_FREEING state
530  * flag, so no inodes here should ever be on the LRU when being evicted.
531  */
532 static void evict(struct inode *inode)
533 {
534         const struct super_operations *op = inode->i_sb->s_op;
535
536         BUG_ON(!(inode->i_state & I_FREEING));
537         BUG_ON(!list_empty(&inode->i_lru));
538
539         if (!list_empty(&inode->i_io_list))
540                 inode_io_list_del(inode);
541
542         inode_sb_list_del(inode);
543
544         /*
545          * Wait for flusher thread to be done with the inode so that filesystem
546          * does not start destroying it while writeback is still running. Since
547          * the inode has I_FREEING set, flusher thread won't start new work on
548          * the inode.  We just have to wait for running writeback to finish.
549          */
550         inode_wait_for_writeback(inode);
551
552         if (op->evict_inode) {
553                 op->evict_inode(inode);
554         } else {
555                 truncate_inode_pages_final(&inode->i_data);
556                 clear_inode(inode);
557         }
558         if (S_ISBLK(inode->i_mode) && inode->i_bdev)
559                 bd_forget(inode);
560         if (S_ISCHR(inode->i_mode) && inode->i_cdev)
561                 cd_forget(inode);
562
563         remove_inode_hash(inode);
564
565         spin_lock(&inode->i_lock);
566         wake_up_bit(&inode->i_state, __I_NEW);
567         BUG_ON(inode->i_state != (I_FREEING | I_CLEAR));
568         spin_unlock(&inode->i_lock);
569
570         destroy_inode(inode);
571 }
572
573 /*
574  * dispose_list - dispose of the contents of a local list
575  * @head: the head of the list to free
576  *
577  * Dispose-list gets a local list with local inodes in it, so it doesn't
578  * need to worry about list corruption and SMP locks.
579  */
580 static void dispose_list(struct list_head *head)
581 {
582         while (!list_empty(head)) {
583                 struct inode *inode;
584
585                 inode = list_first_entry(head, struct inode, i_lru);
586                 list_del_init(&inode->i_lru);
587
588                 evict(inode);
589                 cond_resched();
590         }
591 }
592
593 /**
594  * evict_inodes - evict all evictable inodes for a superblock
595  * @sb:         superblock to operate on
596  *
597  * Make sure that no inodes with zero refcount are retained.  This is
598  * called by superblock shutdown after having MS_ACTIVE flag removed,
599  * so any inode reaching zero refcount during or after that call will
600  * be immediately evicted.
601  */
602 void evict_inodes(struct super_block *sb)
603 {
604         struct inode *inode, *next;
605         LIST_HEAD(dispose);
606
607 again:
608         spin_lock(&sb->s_inode_list_lock);
609         list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
610                 if (atomic_read(&inode->i_count))
611                         continue;
612
613                 spin_lock(&inode->i_lock);
614                 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
615                         spin_unlock(&inode->i_lock);
616                         continue;
617                 }
618
619                 inode->i_state |= I_FREEING;
620                 inode_lru_list_del(inode);
621                 spin_unlock(&inode->i_lock);
622                 list_add(&inode->i_lru, &dispose);
623
624                 /*
625                  * We can have a ton of inodes to evict at unmount time given
626                  * enough memory, check to see if we need to go to sleep for a
627                  * bit so we don't livelock.
628                  */
629                 if (need_resched()) {
630                         spin_unlock(&sb->s_inode_list_lock);
631                         cond_resched();
632                         dispose_list(&dispose);
633                         goto again;
634                 }
635         }
636         spin_unlock(&sb->s_inode_list_lock);
637
638         dispose_list(&dispose);
639 }
640
641 /**
642  * invalidate_inodes    - attempt to free all inodes on a superblock
643  * @sb:         superblock to operate on
644  * @kill_dirty: flag to guide handling of dirty inodes
645  *
646  * Attempts to free all inodes for a given superblock.  If there were any
647  * busy inodes return a non-zero value, else zero.
648  * If @kill_dirty is set, discard dirty inodes too, otherwise treat
649  * them as busy.
650  */
651 int invalidate_inodes(struct super_block *sb, bool kill_dirty)
652 {
653         int busy = 0;
654         struct inode *inode, *next;
655         LIST_HEAD(dispose);
656
657         spin_lock(&sb->s_inode_list_lock);
658         list_for_each_entry_safe(inode, next, &sb->s_inodes, i_sb_list) {
659                 spin_lock(&inode->i_lock);
660                 if (inode->i_state & (I_NEW | I_FREEING | I_WILL_FREE)) {
661                         spin_unlock(&inode->i_lock);
662                         continue;
663                 }
664                 if (inode->i_state & I_DIRTY_ALL && !kill_dirty) {
665                         spin_unlock(&inode->i_lock);
666                         busy = 1;
667                         continue;
668                 }
669                 if (atomic_read(&inode->i_count)) {
670                         spin_unlock(&inode->i_lock);
671                         busy = 1;
672                         continue;
673                 }
674
675                 inode->i_state |= I_FREEING;
676                 inode_lru_list_del(inode);
677                 spin_unlock(&inode->i_lock);
678                 list_add(&inode->i_lru, &dispose);
679         }
680         spin_unlock(&sb->s_inode_list_lock);
681
682         dispose_list(&dispose);
683
684         return busy;
685 }
686
687 /*
688  * Isolate the inode from the LRU in preparation for freeing it.
689  *
690  * Any inodes which are pinned purely because of attached pagecache have their
691  * pagecache removed.  If the inode has metadata buffers attached to
692  * mapping->private_list then try to remove them.
693  *
694  * If the inode has the I_REFERENCED flag set, then it means that it has been
695  * used recently - the flag is set in iput_final(). When we encounter such an
696  * inode, clear the flag and move it to the back of the LRU so it gets another
697  * pass through the LRU before it gets reclaimed. This is necessary because of
698  * the fact we are doing lazy LRU updates to minimise lock contention so the
699  * LRU does not have strict ordering. Hence we don't want to reclaim inodes
700  * with this flag set because they are the inodes that are out of order.
701  */
702 static enum lru_status inode_lru_isolate(struct list_head *item,
703                 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
704 {
705         struct list_head *freeable = arg;
706         struct inode    *inode = container_of(item, struct inode, i_lru);
707
708         /*
709          * we are inverting the lru lock/inode->i_lock here, so use a trylock.
710          * If we fail to get the lock, just skip it.
711          */
712         if (!spin_trylock(&inode->i_lock))
713                 return LRU_SKIP;
714
715         /*
716          * Referenced or dirty inodes are still in use. Give them another pass
717          * through the LRU as we canot reclaim them now.
718          */
719         if (atomic_read(&inode->i_count) ||
720             (inode->i_state & ~I_REFERENCED)) {
721                 list_lru_isolate(lru, &inode->i_lru);
722                 spin_unlock(&inode->i_lock);
723                 this_cpu_dec(nr_unused);
724                 return LRU_REMOVED;
725         }
726
727         /* recently referenced inodes get one more pass */
728         if (inode->i_state & I_REFERENCED) {
729                 inode->i_state &= ~I_REFERENCED;
730                 spin_unlock(&inode->i_lock);
731                 return LRU_ROTATE;
732         }
733
734         if (inode_has_buffers(inode) || inode->i_data.nrpages) {
735                 __iget(inode);
736                 spin_unlock(&inode->i_lock);
737                 spin_unlock(lru_lock);
738                 if (remove_inode_buffers(inode)) {
739                         unsigned long reap;
740                         reap = invalidate_mapping_pages(&inode->i_data, 0, -1);
741                         if (current_is_kswapd())
742                                 __count_vm_events(KSWAPD_INODESTEAL, reap);
743                         else
744                                 __count_vm_events(PGINODESTEAL, reap);
745                         if (current->reclaim_state)
746                                 current->reclaim_state->reclaimed_slab += reap;
747                 }
748                 iput(inode);
749                 spin_lock(lru_lock);
750                 return LRU_RETRY;
751         }
752
753         WARN_ON(inode->i_state & I_NEW);
754         inode->i_state |= I_FREEING;
755         list_lru_isolate_move(lru, &inode->i_lru, freeable);
756         spin_unlock(&inode->i_lock);
757
758         this_cpu_dec(nr_unused);
759         return LRU_REMOVED;
760 }
761
762 /*
763  * Walk the superblock inode LRU for freeable inodes and attempt to free them.
764  * This is called from the superblock shrinker function with a number of inodes
765  * to trim from the LRU. Inodes to be freed are moved to a temporary list and
766  * then are freed outside inode_lock by dispose_list().
767  */
768 long prune_icache_sb(struct super_block *sb, struct shrink_control *sc)
769 {
770         LIST_HEAD(freeable);
771         long freed;
772
773         freed = list_lru_shrink_walk(&sb->s_inode_lru, sc,
774                                      inode_lru_isolate, &freeable);
775         dispose_list(&freeable);
776         return freed;
777 }
778
779 static void __wait_on_freeing_inode(struct inode *inode);
780 /*
781  * Called with the inode lock held.
782  */
783 static struct inode *find_inode(struct super_block *sb,
784                                 struct hlist_head *head,
785                                 int (*test)(struct inode *, void *),
786                                 void *data)
787 {
788         struct inode *inode = NULL;
789
790 repeat:
791         hlist_for_each_entry(inode, head, i_hash) {
792                 if (inode->i_sb != sb)
793                         continue;
794                 if (!test(inode, data))
795                         continue;
796                 spin_lock(&inode->i_lock);
797                 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
798                         __wait_on_freeing_inode(inode);
799                         goto repeat;
800                 }
801                 __iget(inode);
802                 spin_unlock(&inode->i_lock);
803                 return inode;
804         }
805         return NULL;
806 }
807
808 /*
809  * find_inode_fast is the fast path version of find_inode, see the comment at
810  * iget_locked for details.
811  */
812 static struct inode *find_inode_fast(struct super_block *sb,
813                                 struct hlist_head *head, unsigned long ino)
814 {
815         struct inode *inode = NULL;
816
817 repeat:
818         hlist_for_each_entry(inode, head, i_hash) {
819                 if (inode->i_ino != ino)
820                         continue;
821                 if (inode->i_sb != sb)
822                         continue;
823                 spin_lock(&inode->i_lock);
824                 if (inode->i_state & (I_FREEING|I_WILL_FREE)) {
825                         __wait_on_freeing_inode(inode);
826                         goto repeat;
827                 }
828                 __iget(inode);
829                 spin_unlock(&inode->i_lock);
830                 return inode;
831         }
832         return NULL;
833 }
834
835 /*
836  * Each cpu owns a range of LAST_INO_BATCH numbers.
837  * 'shared_last_ino' is dirtied only once out of LAST_INO_BATCH allocations,
838  * to renew the exhausted range.
839  *
840  * This does not significantly increase overflow rate because every CPU can
841  * consume at most LAST_INO_BATCH-1 unused inode numbers. So there is
842  * NR_CPUS*(LAST_INO_BATCH-1) wastage. At 4096 and 1024, this is ~0.1% of the
843  * 2^32 range, and is a worst-case. Even a 50% wastage would only increase
844  * overflow rate by 2x, which does not seem too significant.
845  *
846  * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
847  * error if st_ino won't fit in target struct field. Use 32bit counter
848  * here to attempt to avoid that.
849  */
850 #define LAST_INO_BATCH 1024
851 static DEFINE_PER_CPU(unsigned int, last_ino);
852
853 unsigned int get_next_ino(void)
854 {
855         unsigned int *p = &get_cpu_var(last_ino);
856         unsigned int res = *p;
857
858 #ifdef CONFIG_SMP
859         if (unlikely((res & (LAST_INO_BATCH-1)) == 0)) {
860                 static atomic_t shared_last_ino;
861                 int next = atomic_add_return(LAST_INO_BATCH, &shared_last_ino);
862
863                 res = next - LAST_INO_BATCH;
864         }
865 #endif
866
867         res++;
868         /* get_next_ino should not provide a 0 inode number */
869         if (unlikely(!res))
870                 res++;
871         *p = res;
872         put_cpu_var(last_ino);
873         return res;
874 }
875 EXPORT_SYMBOL(get_next_ino);
876
877 /**
878  *      new_inode_pseudo        - obtain an inode
879  *      @sb: superblock
880  *
881  *      Allocates a new inode for given superblock.
882  *      Inode wont be chained in superblock s_inodes list
883  *      This means :
884  *      - fs can't be unmount
885  *      - quotas, fsnotify, writeback can't work
886  */
887 struct inode *new_inode_pseudo(struct super_block *sb)
888 {
889         struct inode *inode = alloc_inode(sb);
890
891         if (inode) {
892                 spin_lock(&inode->i_lock);
893                 inode->i_state = 0;
894                 spin_unlock(&inode->i_lock);
895                 INIT_LIST_HEAD(&inode->i_sb_list);
896         }
897         return inode;
898 }
899
900 /**
901  *      new_inode       - obtain an inode
902  *      @sb: superblock
903  *
904  *      Allocates a new inode for given superblock. The default gfp_mask
905  *      for allocations related to inode->i_mapping is GFP_HIGHUSER_MOVABLE.
906  *      If HIGHMEM pages are unsuitable or it is known that pages allocated
907  *      for the page cache are not reclaimable or migratable,
908  *      mapping_set_gfp_mask() must be called with suitable flags on the
909  *      newly created inode's mapping
910  *
911  */
912 struct inode *new_inode(struct super_block *sb)
913 {
914         struct inode *inode;
915
916         spin_lock_prefetch(&sb->s_inode_list_lock);
917
918         inode = new_inode_pseudo(sb);
919         if (inode)
920                 inode_sb_list_add(inode);
921         return inode;
922 }
923 EXPORT_SYMBOL(new_inode);
924
925 #ifdef CONFIG_DEBUG_LOCK_ALLOC
926 void lockdep_annotate_inode_mutex_key(struct inode *inode)
927 {
928         if (S_ISDIR(inode->i_mode)) {
929                 struct file_system_type *type = inode->i_sb->s_type;
930
931                 /* Set new key only if filesystem hasn't already changed it */
932                 if (lockdep_match_class(&inode->i_rwsem, &type->i_mutex_key)) {
933                         /*
934                          * ensure nobody is actually holding i_mutex
935                          */
936                         // mutex_destroy(&inode->i_mutex);
937                         init_rwsem(&inode->i_rwsem);
938                         lockdep_set_class(&inode->i_rwsem,
939                                           &type->i_mutex_dir_key);
940                 }
941         }
942 }
943 EXPORT_SYMBOL(lockdep_annotate_inode_mutex_key);
944 #endif
945
946 /**
947  * unlock_new_inode - clear the I_NEW state and wake up any waiters
948  * @inode:      new inode to unlock
949  *
950  * Called when the inode is fully initialised to clear the new state of the
951  * inode and wake up anyone waiting for the inode to finish initialisation.
952  */
953 void unlock_new_inode(struct inode *inode)
954 {
955         lockdep_annotate_inode_mutex_key(inode);
956         spin_lock(&inode->i_lock);
957         WARN_ON(!(inode->i_state & I_NEW));
958         inode->i_state &= ~I_NEW;
959         smp_mb();
960         wake_up_bit(&inode->i_state, __I_NEW);
961         spin_unlock(&inode->i_lock);
962 }
963 EXPORT_SYMBOL(unlock_new_inode);
964
965 /**
966  * lock_two_nondirectories - take two i_mutexes on non-directory objects
967  *
968  * Lock any non-NULL argument that is not a directory.
969  * Zero, one or two objects may be locked by this function.
970  *
971  * @inode1: first inode to lock
972  * @inode2: second inode to lock
973  */
974 void lock_two_nondirectories(struct inode *inode1, struct inode *inode2)
975 {
976         if (inode1 > inode2)
977                 swap(inode1, inode2);
978
979         if (inode1 && !S_ISDIR(inode1->i_mode))
980                 inode_lock(inode1);
981         if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
982                 inode_lock_nested(inode2, I_MUTEX_NONDIR2);
983 }
984 EXPORT_SYMBOL(lock_two_nondirectories);
985
986 /**
987  * unlock_two_nondirectories - release locks from lock_two_nondirectories()
988  * @inode1: first inode to unlock
989  * @inode2: second inode to unlock
990  */
991 void unlock_two_nondirectories(struct inode *inode1, struct inode *inode2)
992 {
993         if (inode1 && !S_ISDIR(inode1->i_mode))
994                 inode_unlock(inode1);
995         if (inode2 && !S_ISDIR(inode2->i_mode) && inode2 != inode1)
996                 inode_unlock(inode2);
997 }
998 EXPORT_SYMBOL(unlock_two_nondirectories);
999
1000 /**
1001  * iget5_locked - obtain an inode from a mounted file system
1002  * @sb:         super block of file system
1003  * @hashval:    hash value (usually inode number) to get
1004  * @test:       callback used for comparisons between inodes
1005  * @set:        callback used to initialize a new struct inode
1006  * @data:       opaque data pointer to pass to @test and @set
1007  *
1008  * Search for the inode specified by @hashval and @data in the inode cache,
1009  * and if present it is return it with an increased reference count. This is
1010  * a generalized version of iget_locked() for file systems where the inode
1011  * number is not sufficient for unique identification of an inode.
1012  *
1013  * If the inode is not in cache, allocate a new inode and return it locked,
1014  * hashed, and with the I_NEW flag set. The file system gets to fill it in
1015  * before unlocking it via unlock_new_inode().
1016  *
1017  * Note both @test and @set are called with the inode_hash_lock held, so can't
1018  * sleep.
1019  */
1020 struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
1021                 int (*test)(struct inode *, void *),
1022                 int (*set)(struct inode *, void *), void *data)
1023 {
1024         struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1025         struct inode *inode;
1026
1027         spin_lock(&inode_hash_lock);
1028         inode = find_inode(sb, head, test, data);
1029         spin_unlock(&inode_hash_lock);
1030
1031         if (inode) {
1032                 wait_on_inode(inode);
1033                 return inode;
1034         }
1035
1036         inode = alloc_inode(sb);
1037         if (inode) {
1038                 struct inode *old;
1039
1040                 spin_lock(&inode_hash_lock);
1041                 /* We released the lock, so.. */
1042                 old = find_inode(sb, head, test, data);
1043                 if (!old) {
1044                         if (set(inode, data))
1045                                 goto set_failed;
1046
1047                         spin_lock(&inode->i_lock);
1048                         inode->i_state = I_NEW;
1049                         hlist_add_head(&inode->i_hash, head);
1050                         spin_unlock(&inode->i_lock);
1051                         inode_sb_list_add(inode);
1052                         spin_unlock(&inode_hash_lock);
1053
1054                         /* Return the locked inode with I_NEW set, the
1055                          * caller is responsible for filling in the contents
1056                          */
1057                         return inode;
1058                 }
1059
1060                 /*
1061                  * Uhhuh, somebody else created the same inode under
1062                  * us. Use the old inode instead of the one we just
1063                  * allocated.
1064                  */
1065                 spin_unlock(&inode_hash_lock);
1066                 destroy_inode(inode);
1067                 inode = old;
1068                 wait_on_inode(inode);
1069         }
1070         return inode;
1071
1072 set_failed:
1073         spin_unlock(&inode_hash_lock);
1074         destroy_inode(inode);
1075         return NULL;
1076 }
1077 EXPORT_SYMBOL(iget5_locked);
1078
1079 /**
1080  * iget_locked - obtain an inode from a mounted file system
1081  * @sb:         super block of file system
1082  * @ino:        inode number to get
1083  *
1084  * Search for the inode specified by @ino in the inode cache and if present
1085  * return it with an increased reference count. This is for file systems
1086  * where the inode number is sufficient for unique identification of an inode.
1087  *
1088  * If the inode is not in cache, allocate a new inode and return it locked,
1089  * hashed, and with the I_NEW flag set.  The file system gets to fill it in
1090  * before unlocking it via unlock_new_inode().
1091  */
1092 struct inode *iget_locked(struct super_block *sb, unsigned long ino)
1093 {
1094         struct hlist_head *head = inode_hashtable + hash(sb, ino);
1095         struct inode *inode;
1096
1097         spin_lock(&inode_hash_lock);
1098         inode = find_inode_fast(sb, head, ino);
1099         spin_unlock(&inode_hash_lock);
1100         if (inode) {
1101                 wait_on_inode(inode);
1102                 return inode;
1103         }
1104
1105         inode = alloc_inode(sb);
1106         if (inode) {
1107                 struct inode *old;
1108
1109                 spin_lock(&inode_hash_lock);
1110                 /* We released the lock, so.. */
1111                 old = find_inode_fast(sb, head, ino);
1112                 if (!old) {
1113                         inode->i_ino = ino;
1114                         spin_lock(&inode->i_lock);
1115                         inode->i_state = I_NEW;
1116                         hlist_add_head(&inode->i_hash, head);
1117                         spin_unlock(&inode->i_lock);
1118                         inode_sb_list_add(inode);
1119                         spin_unlock(&inode_hash_lock);
1120
1121                         /* Return the locked inode with I_NEW set, the
1122                          * caller is responsible for filling in the contents
1123                          */
1124                         return inode;
1125                 }
1126
1127                 /*
1128                  * Uhhuh, somebody else created the same inode under
1129                  * us. Use the old inode instead of the one we just
1130                  * allocated.
1131                  */
1132                 spin_unlock(&inode_hash_lock);
1133                 destroy_inode(inode);
1134                 inode = old;
1135                 wait_on_inode(inode);
1136         }
1137         return inode;
1138 }
1139 EXPORT_SYMBOL(iget_locked);
1140
1141 /*
1142  * search the inode cache for a matching inode number.
1143  * If we find one, then the inode number we are trying to
1144  * allocate is not unique and so we should not use it.
1145  *
1146  * Returns 1 if the inode number is unique, 0 if it is not.
1147  */
1148 static int test_inode_iunique(struct super_block *sb, unsigned long ino)
1149 {
1150         struct hlist_head *b = inode_hashtable + hash(sb, ino);
1151         struct inode *inode;
1152
1153         spin_lock(&inode_hash_lock);
1154         hlist_for_each_entry(inode, b, i_hash) {
1155                 if (inode->i_ino == ino && inode->i_sb == sb) {
1156                         spin_unlock(&inode_hash_lock);
1157                         return 0;
1158                 }
1159         }
1160         spin_unlock(&inode_hash_lock);
1161
1162         return 1;
1163 }
1164
1165 /**
1166  *      iunique - get a unique inode number
1167  *      @sb: superblock
1168  *      @max_reserved: highest reserved inode number
1169  *
1170  *      Obtain an inode number that is unique on the system for a given
1171  *      superblock. This is used by file systems that have no natural
1172  *      permanent inode numbering system. An inode number is returned that
1173  *      is higher than the reserved limit but unique.
1174  *
1175  *      BUGS:
1176  *      With a large number of inodes live on the file system this function
1177  *      currently becomes quite slow.
1178  */
1179 ino_t iunique(struct super_block *sb, ino_t max_reserved)
1180 {
1181         /*
1182          * On a 32bit, non LFS stat() call, glibc will generate an EOVERFLOW
1183          * error if st_ino won't fit in target struct field. Use 32bit counter
1184          * here to attempt to avoid that.
1185          */
1186         static DEFINE_SPINLOCK(iunique_lock);
1187         static unsigned int counter;
1188         ino_t res;
1189
1190         spin_lock(&iunique_lock);
1191         do {
1192                 if (counter <= max_reserved)
1193                         counter = max_reserved + 1;
1194                 res = counter++;
1195         } while (!test_inode_iunique(sb, res));
1196         spin_unlock(&iunique_lock);
1197
1198         return res;
1199 }
1200 EXPORT_SYMBOL(iunique);
1201
1202 struct inode *igrab(struct inode *inode)
1203 {
1204         spin_lock(&inode->i_lock);
1205         if (!(inode->i_state & (I_FREEING|I_WILL_FREE))) {
1206                 __iget(inode);
1207                 spin_unlock(&inode->i_lock);
1208         } else {
1209                 spin_unlock(&inode->i_lock);
1210                 /*
1211                  * Handle the case where s_op->clear_inode is not been
1212                  * called yet, and somebody is calling igrab
1213                  * while the inode is getting freed.
1214                  */
1215                 inode = NULL;
1216         }
1217         return inode;
1218 }
1219 EXPORT_SYMBOL(igrab);
1220
1221 /**
1222  * ilookup5_nowait - search for an inode in the inode cache
1223  * @sb:         super block of file system to search
1224  * @hashval:    hash value (usually inode number) to search for
1225  * @test:       callback used for comparisons between inodes
1226  * @data:       opaque data pointer to pass to @test
1227  *
1228  * Search for the inode specified by @hashval and @data in the inode cache.
1229  * If the inode is in the cache, the inode is returned with an incremented
1230  * reference count.
1231  *
1232  * Note: I_NEW is not waited upon so you have to be very careful what you do
1233  * with the returned inode.  You probably should be using ilookup5() instead.
1234  *
1235  * Note2: @test is called with the inode_hash_lock held, so can't sleep.
1236  */
1237 struct inode *ilookup5_nowait(struct super_block *sb, unsigned long hashval,
1238                 int (*test)(struct inode *, void *), void *data)
1239 {
1240         struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1241         struct inode *inode;
1242
1243         spin_lock(&inode_hash_lock);
1244         inode = find_inode(sb, head, test, data);
1245         spin_unlock(&inode_hash_lock);
1246
1247         return inode;
1248 }
1249 EXPORT_SYMBOL(ilookup5_nowait);
1250
1251 /**
1252  * ilookup5 - search for an inode in the inode cache
1253  * @sb:         super block of file system to search
1254  * @hashval:    hash value (usually inode number) to search for
1255  * @test:       callback used for comparisons between inodes
1256  * @data:       opaque data pointer to pass to @test
1257  *
1258  * Search for the inode specified by @hashval and @data in the inode cache,
1259  * and if the inode is in the cache, return the inode with an incremented
1260  * reference count.  Waits on I_NEW before returning the inode.
1261  * returned with an incremented reference count.
1262  *
1263  * This is a generalized version of ilookup() for file systems where the
1264  * inode number is not sufficient for unique identification of an inode.
1265  *
1266  * Note: @test is called with the inode_hash_lock held, so can't sleep.
1267  */
1268 struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1269                 int (*test)(struct inode *, void *), void *data)
1270 {
1271         struct inode *inode = ilookup5_nowait(sb, hashval, test, data);
1272
1273         if (inode)
1274                 wait_on_inode(inode);
1275         return inode;
1276 }
1277 EXPORT_SYMBOL(ilookup5);
1278
1279 /**
1280  * ilookup - search for an inode in the inode cache
1281  * @sb:         super block of file system to search
1282  * @ino:        inode number to search for
1283  *
1284  * Search for the inode @ino in the inode cache, and if the inode is in the
1285  * cache, the inode is returned with an incremented reference count.
1286  */
1287 struct inode *ilookup(struct super_block *sb, unsigned long ino)
1288 {
1289         struct hlist_head *head = inode_hashtable + hash(sb, ino);
1290         struct inode *inode;
1291
1292         spin_lock(&inode_hash_lock);
1293         inode = find_inode_fast(sb, head, ino);
1294         spin_unlock(&inode_hash_lock);
1295
1296         if (inode)
1297                 wait_on_inode(inode);
1298         return inode;
1299 }
1300 EXPORT_SYMBOL(ilookup);
1301
1302 /**
1303  * find_inode_nowait - find an inode in the inode cache
1304  * @sb:         super block of file system to search
1305  * @hashval:    hash value (usually inode number) to search for
1306  * @match:      callback used for comparisons between inodes
1307  * @data:       opaque data pointer to pass to @match
1308  *
1309  * Search for the inode specified by @hashval and @data in the inode
1310  * cache, where the helper function @match will return 0 if the inode
1311  * does not match, 1 if the inode does match, and -1 if the search
1312  * should be stopped.  The @match function must be responsible for
1313  * taking the i_lock spin_lock and checking i_state for an inode being
1314  * freed or being initialized, and incrementing the reference count
1315  * before returning 1.  It also must not sleep, since it is called with
1316  * the inode_hash_lock spinlock held.
1317  *
1318  * This is a even more generalized version of ilookup5() when the
1319  * function must never block --- find_inode() can block in
1320  * __wait_on_freeing_inode() --- or when the caller can not increment
1321  * the reference count because the resulting iput() might cause an
1322  * inode eviction.  The tradeoff is that the @match funtion must be
1323  * very carefully implemented.
1324  */
1325 struct inode *find_inode_nowait(struct super_block *sb,
1326                                 unsigned long hashval,
1327                                 int (*match)(struct inode *, unsigned long,
1328                                              void *),
1329                                 void *data)
1330 {
1331         struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1332         struct inode *inode, *ret_inode = NULL;
1333         int mval;
1334
1335         spin_lock(&inode_hash_lock);
1336         hlist_for_each_entry(inode, head, i_hash) {
1337                 if (inode->i_sb != sb)
1338                         continue;
1339                 mval = match(inode, hashval, data);
1340                 if (mval == 0)
1341                         continue;
1342                 if (mval == 1)
1343                         ret_inode = inode;
1344                 goto out;
1345         }
1346 out:
1347         spin_unlock(&inode_hash_lock);
1348         return ret_inode;
1349 }
1350 EXPORT_SYMBOL(find_inode_nowait);
1351
1352 int insert_inode_locked(struct inode *inode)
1353 {
1354         struct super_block *sb = inode->i_sb;
1355         ino_t ino = inode->i_ino;
1356         struct hlist_head *head = inode_hashtable + hash(sb, ino);
1357
1358         while (1) {
1359                 struct inode *old = NULL;
1360                 spin_lock(&inode_hash_lock);
1361                 hlist_for_each_entry(old, head, i_hash) {
1362                         if (old->i_ino != ino)
1363                                 continue;
1364                         if (old->i_sb != sb)
1365                                 continue;
1366                         spin_lock(&old->i_lock);
1367                         if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1368                                 spin_unlock(&old->i_lock);
1369                                 continue;
1370                         }
1371                         break;
1372                 }
1373                 if (likely(!old)) {
1374                         spin_lock(&inode->i_lock);
1375                         inode->i_state |= I_NEW;
1376                         hlist_add_head(&inode->i_hash, head);
1377                         spin_unlock(&inode->i_lock);
1378                         spin_unlock(&inode_hash_lock);
1379                         return 0;
1380                 }
1381                 __iget(old);
1382                 spin_unlock(&old->i_lock);
1383                 spin_unlock(&inode_hash_lock);
1384                 wait_on_inode(old);
1385                 if (unlikely(!inode_unhashed(old))) {
1386                         iput(old);
1387                         return -EBUSY;
1388                 }
1389                 iput(old);
1390         }
1391 }
1392 EXPORT_SYMBOL(insert_inode_locked);
1393
1394 int insert_inode_locked4(struct inode *inode, unsigned long hashval,
1395                 int (*test)(struct inode *, void *), void *data)
1396 {
1397         struct super_block *sb = inode->i_sb;
1398         struct hlist_head *head = inode_hashtable + hash(sb, hashval);
1399
1400         while (1) {
1401                 struct inode *old = NULL;
1402
1403                 spin_lock(&inode_hash_lock);
1404                 hlist_for_each_entry(old, head, i_hash) {
1405                         if (old->i_sb != sb)
1406                                 continue;
1407                         if (!test(old, data))
1408                                 continue;
1409                         spin_lock(&old->i_lock);
1410                         if (old->i_state & (I_FREEING|I_WILL_FREE)) {
1411                                 spin_unlock(&old->i_lock);
1412                                 continue;
1413                         }
1414                         break;
1415                 }
1416                 if (likely(!old)) {
1417                         spin_lock(&inode->i_lock);
1418                         inode->i_state |= I_NEW;
1419                         hlist_add_head(&inode->i_hash, head);
1420                         spin_unlock(&inode->i_lock);
1421                         spin_unlock(&inode_hash_lock);
1422                         return 0;
1423                 }
1424                 __iget(old);
1425                 spin_unlock(&old->i_lock);
1426                 spin_unlock(&inode_hash_lock);
1427                 wait_on_inode(old);
1428                 if (unlikely(!inode_unhashed(old))) {
1429                         iput(old);
1430                         return -EBUSY;
1431                 }
1432                 iput(old);
1433         }
1434 }
1435 EXPORT_SYMBOL(insert_inode_locked4);
1436
1437
1438 int generic_delete_inode(struct inode *inode)
1439 {
1440         return 1;
1441 }
1442 EXPORT_SYMBOL(generic_delete_inode);
1443
1444 /*
1445  * Called when we're dropping the last reference
1446  * to an inode.
1447  *
1448  * Call the FS "drop_inode()" function, defaulting to
1449  * the legacy UNIX filesystem behaviour.  If it tells
1450  * us to evict inode, do so.  Otherwise, retain inode
1451  * in cache if fs is alive, sync and evict if fs is
1452  * shutting down.
1453  */
1454 static void iput_final(struct inode *inode)
1455 {
1456         struct super_block *sb = inode->i_sb;
1457         const struct super_operations *op = inode->i_sb->s_op;
1458         int drop;
1459
1460         WARN_ON(inode->i_state & I_NEW);
1461
1462         if (op->drop_inode)
1463                 drop = op->drop_inode(inode);
1464         else
1465                 drop = generic_drop_inode(inode);
1466
1467         if (!drop && (sb->s_flags & MS_ACTIVE)) {
1468                 inode->i_state |= I_REFERENCED;
1469                 inode_add_lru(inode);
1470                 spin_unlock(&inode->i_lock);
1471                 return;
1472         }
1473
1474         if (!drop) {
1475                 inode->i_state |= I_WILL_FREE;
1476                 spin_unlock(&inode->i_lock);
1477                 write_inode_now(inode, 1);
1478                 spin_lock(&inode->i_lock);
1479                 WARN_ON(inode->i_state & I_NEW);
1480                 inode->i_state &= ~I_WILL_FREE;
1481         }
1482
1483         inode->i_state |= I_FREEING;
1484         if (!list_empty(&inode->i_lru))
1485                 inode_lru_list_del(inode);
1486         spin_unlock(&inode->i_lock);
1487
1488         evict(inode);
1489 }
1490
1491 /**
1492  *      iput    - put an inode
1493  *      @inode: inode to put
1494  *
1495  *      Puts an inode, dropping its usage count. If the inode use count hits
1496  *      zero, the inode is then freed and may also be destroyed.
1497  *
1498  *      Consequently, iput() can sleep.
1499  */
1500 void iput(struct inode *inode)
1501 {
1502         if (!inode)
1503                 return;
1504         BUG_ON(inode->i_state & I_CLEAR);
1505 retry:
1506         if (atomic_dec_and_lock(&inode->i_count, &inode->i_lock)) {
1507                 if (inode->i_nlink && (inode->i_state & I_DIRTY_TIME)) {
1508                         atomic_inc(&inode->i_count);
1509                         inode->i_state &= ~I_DIRTY_TIME;
1510                         spin_unlock(&inode->i_lock);
1511                         trace_writeback_lazytime_iput(inode);
1512                         mark_inode_dirty_sync(inode);
1513                         goto retry;
1514                 }
1515                 iput_final(inode);
1516         }
1517 }
1518 EXPORT_SYMBOL(iput);
1519
1520 /**
1521  *      bmap    - find a block number in a file
1522  *      @inode: inode of file
1523  *      @block: block to find
1524  *
1525  *      Returns the block number on the device holding the inode that
1526  *      is the disk block number for the block of the file requested.
1527  *      That is, asked for block 4 of inode 1 the function will return the
1528  *      disk block relative to the disk start that holds that block of the
1529  *      file.
1530  */
1531 sector_t bmap(struct inode *inode, sector_t block)
1532 {
1533         sector_t res = 0;
1534         if (inode->i_mapping->a_ops->bmap)
1535                 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1536         return res;
1537 }
1538 EXPORT_SYMBOL(bmap);
1539
1540 /*
1541  * With relative atime, only update atime if the previous atime is
1542  * earlier than either the ctime or mtime or if at least a day has
1543  * passed since the last atime update.
1544  */
1545 static int relatime_need_update(struct vfsmount *mnt, struct inode *inode,
1546                              struct timespec now)
1547 {
1548
1549         if (!(mnt->mnt_flags & MNT_RELATIME))
1550                 return 1;
1551         /*
1552          * Is mtime younger than atime? If yes, update atime:
1553          */
1554         if (timespec_compare(&inode->i_mtime, &inode->i_atime) >= 0)
1555                 return 1;
1556         /*
1557          * Is ctime younger than atime? If yes, update atime:
1558          */
1559         if (timespec_compare(&inode->i_ctime, &inode->i_atime) >= 0)
1560                 return 1;
1561
1562         /*
1563          * Is the previous atime value older than a day? If yes,
1564          * update atime:
1565          */
1566         if ((long)(now.tv_sec - inode->i_atime.tv_sec) >= 24*60*60)
1567                 return 1;
1568         /*
1569          * Good, we can skip the atime update:
1570          */
1571         return 0;
1572 }
1573
1574 int generic_update_time(struct inode *inode, struct timespec *time, int flags)
1575 {
1576         int iflags = I_DIRTY_TIME;
1577
1578         if (flags & S_ATIME)
1579                 inode->i_atime = *time;
1580         if (flags & S_VERSION)
1581                 inode_inc_iversion(inode);
1582         if (flags & S_CTIME)
1583                 inode->i_ctime = *time;
1584         if (flags & S_MTIME)
1585                 inode->i_mtime = *time;
1586
1587         if (!(inode->i_sb->s_flags & MS_LAZYTIME) || (flags & S_VERSION))
1588                 iflags |= I_DIRTY_SYNC;
1589         __mark_inode_dirty(inode, iflags);
1590         return 0;
1591 }
1592 EXPORT_SYMBOL(generic_update_time);
1593
1594 /*
1595  * This does the actual work of updating an inodes time or version.  Must have
1596  * had called mnt_want_write() before calling this.
1597  */
1598 static int update_time(struct inode *inode, struct timespec *time, int flags)
1599 {
1600         int (*update_time)(struct inode *, struct timespec *, int);
1601
1602         update_time = inode->i_op->update_time ? inode->i_op->update_time :
1603                 generic_update_time;
1604
1605         return update_time(inode, time, flags);
1606 }
1607
1608 /**
1609  *      touch_atime     -       update the access time
1610  *      @path: the &struct path to update
1611  *      @inode: inode to update
1612  *
1613  *      Update the accessed time on an inode and mark it for writeback.
1614  *      This function automatically handles read only file systems and media,
1615  *      as well as the "noatime" flag and inode specific "noatime" markers.
1616  */
1617 bool atime_needs_update(const struct path *path, struct inode *inode)
1618 {
1619         struct vfsmount *mnt = path->mnt;
1620         struct timespec now;
1621
1622         if (inode->i_flags & S_NOATIME)
1623                 return false;
1624
1625         /* Atime updates will likely cause i_uid and i_gid to be written
1626          * back improprely if their true value is unknown to the vfs.
1627          */
1628         if (HAS_UNMAPPED_ID(inode))
1629                 return false;
1630
1631         if (IS_NOATIME(inode))
1632                 return false;
1633         if ((inode->i_sb->s_flags & MS_NODIRATIME) && S_ISDIR(inode->i_mode))
1634                 return false;
1635
1636         if (mnt->mnt_flags & MNT_NOATIME)
1637                 return false;
1638         if ((mnt->mnt_flags & MNT_NODIRATIME) && S_ISDIR(inode->i_mode))
1639                 return false;
1640
1641         now = current_fs_time(inode->i_sb);
1642
1643         if (!relatime_need_update(mnt, inode, now))
1644                 return false;
1645
1646         if (timespec_equal(&inode->i_atime, &now))
1647                 return false;
1648
1649         return true;
1650 }
1651
1652 void touch_atime(const struct path *path)
1653 {
1654         struct vfsmount *mnt = path->mnt;
1655         struct inode *inode = d_inode(path->dentry);
1656         struct timespec now;
1657
1658         if (!atime_needs_update(path, inode))
1659                 return;
1660
1661         if (!sb_start_write_trylock(inode->i_sb))
1662                 return;
1663
1664         if (__mnt_want_write(mnt) != 0)
1665                 goto skip_update;
1666         /*
1667          * File systems can error out when updating inodes if they need to
1668          * allocate new space to modify an inode (such is the case for
1669          * Btrfs), but since we touch atime while walking down the path we
1670          * really don't care if we failed to update the atime of the file,
1671          * so just ignore the return value.
1672          * We may also fail on filesystems that have the ability to make parts
1673          * of the fs read only, e.g. subvolumes in Btrfs.
1674          */
1675         now = current_fs_time(inode->i_sb);
1676         update_time(inode, &now, S_ATIME);
1677         __mnt_drop_write(mnt);
1678 skip_update:
1679         sb_end_write(inode->i_sb);
1680 }
1681 EXPORT_SYMBOL(touch_atime);
1682
1683 /*
1684  * The logic we want is
1685  *
1686  *      if suid or (sgid and xgrp)
1687  *              remove privs
1688  */
1689 int should_remove_suid(struct dentry *dentry)
1690 {
1691         umode_t mode = d_inode(dentry)->i_mode;
1692         int kill = 0;
1693
1694         /* suid always must be killed */
1695         if (unlikely(mode & S_ISUID))
1696                 kill = ATTR_KILL_SUID;
1697
1698         /*
1699          * sgid without any exec bits is just a mandatory locking mark; leave
1700          * it alone.  If some exec bits are set, it's a real sgid; kill it.
1701          */
1702         if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1703                 kill |= ATTR_KILL_SGID;
1704
1705         if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
1706                 return kill;
1707
1708         return 0;
1709 }
1710 EXPORT_SYMBOL(should_remove_suid);
1711
1712 /*
1713  * Return mask of changes for notify_change() that need to be done as a
1714  * response to write or truncate. Return 0 if nothing has to be changed.
1715  * Negative value on error (change should be denied).
1716  */
1717 int dentry_needs_remove_privs(struct dentry *dentry)
1718 {
1719         struct inode *inode = d_inode(dentry);
1720         int mask = 0;
1721         int ret;
1722
1723         if (IS_NOSEC(inode))
1724                 return 0;
1725
1726         mask = should_remove_suid(dentry);
1727         ret = security_inode_need_killpriv(dentry);
1728         if (ret < 0)
1729                 return ret;
1730         if (ret)
1731                 mask |= ATTR_KILL_PRIV;
1732         return mask;
1733 }
1734
1735 static int __remove_privs(struct dentry *dentry, int kill)
1736 {
1737         struct iattr newattrs;
1738
1739         newattrs.ia_valid = ATTR_FORCE | kill;
1740         /*
1741          * Note we call this on write, so notify_change will not
1742          * encounter any conflicting delegations:
1743          */
1744         return notify_change(dentry, &newattrs, NULL);
1745 }
1746
1747 /*
1748  * Remove special file priviledges (suid, capabilities) when file is written
1749  * to or truncated.
1750  */
1751 int file_remove_privs(struct file *file)
1752 {
1753         struct dentry *dentry = file_dentry(file);
1754         struct inode *inode = file_inode(file);
1755         int kill;
1756         int error = 0;
1757
1758         /* Fast path for nothing security related */
1759         if (IS_NOSEC(inode))
1760                 return 0;
1761
1762         kill = dentry_needs_remove_privs(dentry);
1763         if (kill < 0)
1764                 return kill;
1765         if (kill)
1766                 error = __remove_privs(dentry, kill);
1767         if (!error)
1768                 inode_has_no_xattr(inode);
1769
1770         return error;
1771 }
1772 EXPORT_SYMBOL(file_remove_privs);
1773
1774 /**
1775  *      file_update_time        -       update mtime and ctime time
1776  *      @file: file accessed
1777  *
1778  *      Update the mtime and ctime members of an inode and mark the inode
1779  *      for writeback.  Note that this function is meant exclusively for
1780  *      usage in the file write path of filesystems, and filesystems may
1781  *      choose to explicitly ignore update via this function with the
1782  *      S_NOCMTIME inode flag, e.g. for network filesystem where these
1783  *      timestamps are handled by the server.  This can return an error for
1784  *      file systems who need to allocate space in order to update an inode.
1785  */
1786
1787 int file_update_time(struct file *file)
1788 {
1789         struct inode *inode = file_inode(file);
1790         struct timespec now;
1791         int sync_it = 0;
1792         int ret;
1793
1794         /* First try to exhaust all avenues to not sync */
1795         if (IS_NOCMTIME(inode))
1796                 return 0;
1797
1798         now = current_fs_time(inode->i_sb);
1799         if (!timespec_equal(&inode->i_mtime, &now))
1800                 sync_it = S_MTIME;
1801
1802         if (!timespec_equal(&inode->i_ctime, &now))
1803                 sync_it |= S_CTIME;
1804
1805         if (IS_I_VERSION(inode))
1806                 sync_it |= S_VERSION;
1807
1808         if (!sync_it)
1809                 return 0;
1810
1811         /* Finally allowed to write? Takes lock. */
1812         if (__mnt_want_write_file(file))
1813                 return 0;
1814
1815         ret = update_time(inode, &now, sync_it);
1816         __mnt_drop_write_file(file);
1817
1818         return ret;
1819 }
1820 EXPORT_SYMBOL(file_update_time);
1821
1822 int inode_needs_sync(struct inode *inode)
1823 {
1824         if (IS_SYNC(inode))
1825                 return 1;
1826         if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1827                 return 1;
1828         return 0;
1829 }
1830 EXPORT_SYMBOL(inode_needs_sync);
1831
1832 /*
1833  * If we try to find an inode in the inode hash while it is being
1834  * deleted, we have to wait until the filesystem completes its
1835  * deletion before reporting that it isn't found.  This function waits
1836  * until the deletion _might_ have completed.  Callers are responsible
1837  * to recheck inode state.
1838  *
1839  * It doesn't matter if I_NEW is not set initially, a call to
1840  * wake_up_bit(&inode->i_state, __I_NEW) after removing from the hash list
1841  * will DTRT.
1842  */
1843 static void __wait_on_freeing_inode(struct inode *inode)
1844 {
1845         wait_queue_head_t *wq;
1846         DEFINE_WAIT_BIT(wait, &inode->i_state, __I_NEW);
1847         wq = bit_waitqueue(&inode->i_state, __I_NEW);
1848         prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
1849         spin_unlock(&inode->i_lock);
1850         spin_unlock(&inode_hash_lock);
1851         schedule();
1852         finish_wait(wq, &wait.wait);
1853         spin_lock(&inode_hash_lock);
1854 }
1855
1856 static __initdata unsigned long ihash_entries;
1857 static int __init set_ihash_entries(char *str)
1858 {
1859         if (!str)
1860                 return 0;
1861         ihash_entries = simple_strtoul(str, &str, 0);
1862         return 1;
1863 }
1864 __setup("ihash_entries=", set_ihash_entries);
1865
1866 /*
1867  * Initialize the waitqueues and inode hash table.
1868  */
1869 void __init inode_init_early(void)
1870 {
1871         unsigned int loop;
1872
1873         /* If hashes are distributed across NUMA nodes, defer
1874          * hash allocation until vmalloc space is available.
1875          */
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                                         HASH_EARLY,
1885                                         &i_hash_shift,
1886                                         &i_hash_mask,
1887                                         0,
1888                                         0);
1889
1890         for (loop = 0; loop < (1U << i_hash_shift); loop++)
1891                 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1892 }
1893
1894 void __init inode_init(void)
1895 {
1896         unsigned int loop;
1897
1898         /* inode slab cache */
1899         inode_cachep = kmem_cache_create("inode_cache",
1900                                          sizeof(struct inode),
1901                                          0,
1902                                          (SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|
1903                                          SLAB_MEM_SPREAD|SLAB_ACCOUNT),
1904                                          init_once);
1905
1906         /* Hash may have been set up in inode_init_early */
1907         if (!hashdist)
1908                 return;
1909
1910         inode_hashtable =
1911                 alloc_large_system_hash("Inode-cache",
1912                                         sizeof(struct hlist_head),
1913                                         ihash_entries,
1914                                         14,
1915                                         0,
1916                                         &i_hash_shift,
1917                                         &i_hash_mask,
1918                                         0,
1919                                         0);
1920
1921         for (loop = 0; loop < (1U << i_hash_shift); loop++)
1922                 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1923 }
1924
1925 void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
1926 {
1927         inode->i_mode = mode;
1928         if (S_ISCHR(mode)) {
1929                 inode->i_fop = &def_chr_fops;
1930                 inode->i_rdev = rdev;
1931         } else if (S_ISBLK(mode)) {
1932                 inode->i_fop = &def_blk_fops;
1933                 inode->i_rdev = rdev;
1934         } else if (S_ISFIFO(mode))
1935                 inode->i_fop = &pipefifo_fops;
1936         else if (S_ISSOCK(mode))
1937                 ;       /* leave it no_open_fops */
1938         else
1939                 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o) for"
1940                                   " inode %s:%lu\n", mode, inode->i_sb->s_id,
1941                                   inode->i_ino);
1942 }
1943 EXPORT_SYMBOL(init_special_inode);
1944
1945 /**
1946  * inode_init_owner - Init uid,gid,mode for new inode according to posix standards
1947  * @inode: New inode
1948  * @dir: Directory inode
1949  * @mode: mode of the new inode
1950  */
1951 void inode_init_owner(struct inode *inode, const struct inode *dir,
1952                         umode_t mode)
1953 {
1954         inode->i_uid = current_fsuid();
1955         if (dir && dir->i_mode & S_ISGID) {
1956                 inode->i_gid = dir->i_gid;
1957                 if (S_ISDIR(mode))
1958                         mode |= S_ISGID;
1959         } else
1960                 inode->i_gid = current_fsgid();
1961         inode->i_mode = mode;
1962 }
1963 EXPORT_SYMBOL(inode_init_owner);
1964
1965 /**
1966  * inode_owner_or_capable - check current task permissions to inode
1967  * @inode: inode being checked
1968  *
1969  * Return true if current either has CAP_FOWNER in a namespace with the
1970  * inode owner uid mapped, or owns the file.
1971  */
1972 bool inode_owner_or_capable(const struct inode *inode)
1973 {
1974         struct user_namespace *ns;
1975
1976         if (uid_eq(current_fsuid(), inode->i_uid))
1977                 return true;
1978
1979         ns = current_user_ns();
1980         if (ns_capable(ns, CAP_FOWNER) && kuid_has_mapping(ns, inode->i_uid))
1981                 return true;
1982         return false;
1983 }
1984 EXPORT_SYMBOL(inode_owner_or_capable);
1985
1986 /*
1987  * Direct i/o helper functions
1988  */
1989 static void __inode_dio_wait(struct inode *inode)
1990 {
1991         wait_queue_head_t *wq = bit_waitqueue(&inode->i_state, __I_DIO_WAKEUP);
1992         DEFINE_WAIT_BIT(q, &inode->i_state, __I_DIO_WAKEUP);
1993
1994         do {
1995                 prepare_to_wait(wq, &q.wait, TASK_UNINTERRUPTIBLE);
1996                 if (atomic_read(&inode->i_dio_count))
1997                         schedule();
1998         } while (atomic_read(&inode->i_dio_count));
1999         finish_wait(wq, &q.wait);
2000 }
2001
2002 /**
2003  * inode_dio_wait - wait for outstanding DIO requests to finish
2004  * @inode: inode to wait for
2005  *
2006  * Waits for all pending direct I/O requests to finish so that we can
2007  * proceed with a truncate or equivalent operation.
2008  *
2009  * Must be called under a lock that serializes taking new references
2010  * to i_dio_count, usually by inode->i_mutex.
2011  */
2012 void inode_dio_wait(struct inode *inode)
2013 {
2014         if (atomic_read(&inode->i_dio_count))
2015                 __inode_dio_wait(inode);
2016 }
2017 EXPORT_SYMBOL(inode_dio_wait);
2018
2019 /*
2020  * inode_set_flags - atomically set some inode flags
2021  *
2022  * Note: the caller should be holding i_mutex, or else be sure that
2023  * they have exclusive access to the inode structure (i.e., while the
2024  * inode is being instantiated).  The reason for the cmpxchg() loop
2025  * --- which wouldn't be necessary if all code paths which modify
2026  * i_flags actually followed this rule, is that there is at least one
2027  * code path which doesn't today so we use cmpxchg() out of an abundance
2028  * of caution.
2029  *
2030  * In the long run, i_mutex is overkill, and we should probably look
2031  * at using the i_lock spinlock to protect i_flags, and then make sure
2032  * it is so documented in include/linux/fs.h and that all code follows
2033  * the locking convention!!
2034  */
2035 void inode_set_flags(struct inode *inode, unsigned int flags,
2036                      unsigned int mask)
2037 {
2038         unsigned int old_flags, new_flags;
2039
2040         WARN_ON_ONCE(flags & ~mask);
2041         do {
2042                 old_flags = ACCESS_ONCE(inode->i_flags);
2043                 new_flags = (old_flags & ~mask) | flags;
2044         } while (unlikely(cmpxchg(&inode->i_flags, old_flags,
2045                                   new_flags) != old_flags));
2046 }
2047 EXPORT_SYMBOL(inode_set_flags);
2048
2049 void inode_nohighmem(struct inode *inode)
2050 {
2051         mapping_set_gfp_mask(inode->i_mapping, GFP_USER);
2052 }
2053 EXPORT_SYMBOL(inode_nohighmem);