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