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