fs/inode.c

   1 /*
   2  * linux/fs/inode.c
   3  *
   4  * (C) 1997 Linus Torvalds
   5  */
   6
   7 #include <linux/config.h>
   8 #include <linux/fs.h>
   9 #include <linux/mm.h>
  10 #include <linux/dcache.h>
  11 #include <linux/init.h>
  12 #include <linux/quotaops.h>
  13 #include <linux/slab.h>
  14 #include <linux/writeback.h>
  15 #include <linux/module.h>
  16 #include <linux/backing-dev.h>
  17 #include <linux/wait.h>
  18 #include <linux/hash.h>
  19 #include <linux/swap.h>
  20 #include <linux/security.h>
  21 #include <linux/pagemap.h>
  22 #include <linux/cdev.h>
  23 #include <linux/bootmem.h>
  24
  25 /*
  26  * This is needed for the following functions:
  27  *  - inode_has_buffers
  28  *  - invalidate_inode_buffers
  29  *  - fsync_bdev
  30  *  - invalidate_bdev
  31  *
  32  * FIXME: remove all knowledge of the buffer layer from this file
  33  */
  34 #include <linux/buffer_head.h>
  35
  36 /*
  37  * New inode.c implementation.
  38  *
  39  * This implementation has the basic premise of trying
  40  * to be extremely low-overhead and SMP-safe, yet be
  41  * simple enough to be "obviously correct".
  42  *
  43  * Famous last words.
  44  */
  45
  46 /* inode dynamic allocation 1999, Andrea Arcangeli <andrea@suse.de> */
  47
  48 /* #define INODE_PARANOIA 1 */
  49 /* #define INODE_DEBUG 1 */
  50
  51 /*
  52  * Inode lookup is no longer as critical as it used to be:
  53  * most of the lookups are going to be through the dcache.
  54  */
  55 #define I_HASHBITS      i_hash_shift
  56 #define I_HASHMASK      i_hash_mask
  57
  58 static unsigned int i_hash_mask;
  59 static unsigned int i_hash_shift;
  60
  61 /*
  62  * Each inode can be on two separate lists. One is
  63  * the hash list of the inode, used for lookups. The
  64  * other linked list is the "type" list:
  65  *  "in_use" - valid inode, i_count > 0, i_nlink > 0
  66  *  "dirty"  - as "in_use" but also dirty
  67  *  "unused" - valid inode, i_count = 0
  68  *
  69  * A "dirty" list is maintained for each super block,
  70  * allowing for low-overhead inode sync() operations.
  71  */
  72
  73 LIST_HEAD(inode_in_use);
  74 LIST_HEAD(inode_unused);
  75 static struct hlist_head *inode_hashtable;
  76
  77 /*
  78  * A simple spinlock to protect the list manipulations.
  79  *
  80  * NOTE! You also have to own the lock if you change
  81  * the i_state of an inode while it is in use..
  82  */
  83 DEFINE_SPINLOCK(inode_lock);
  84
  85 /*
  86  * iprune_sem provides exclusion between the kswapd or try_to_free_pages
  87  * icache shrinking path, and the umount path.  Without this exclusion,
  88  * by the time prune_icache calls iput for the inode whose pages it has
  89  * been invalidating, or by the time it calls clear_inode & destroy_inode
  90  * from its final dispose_list, the struct super_block they refer to
  91  * (for inode->i_sb->s_op) may already have been freed and reused.
  92  */
  93 DECLARE_MUTEX(iprune_sem);
  94
  95 /*
  96  * Statistics gathering..
  97  */
  98 struct inodes_stat_t inodes_stat;
  99
 100 static kmem_cache_t * inode_cachep;
 101
 102 static struct inode *alloc_inode(struct super_block *sb)
 103 {
 104         static struct address_space_operations empty_aops;
 105         static struct inode_operations empty_iops;
 106         static struct file_operations empty_fops;
 107         struct inode *inode;
 108
 109         if (sb->s_op->alloc_inode)
 110                 inode = sb->s_op->alloc_inode(sb);
 111         else
 112                 inode = (struct inode *) kmem_cache_alloc(inode_cachep, SLAB_KERNEL);
 113
 114         if (inode) {
 115                 struct address_space * const mapping = &inode->i_data;
 116
 117                 inode->i_sb = sb;
 118                 // inode->i_dqh = dqhget(sb->s_dqh);
 119
 120                 /* essential because of inode slab reuse */
 121                 inode->i_xid = 0;
 122                 inode->i_blkbits = sb->s_blocksize_bits;
 123                 inode->i_flags = 0;
 124                 atomic_set(&inode->i_count, 1);
 125                 inode->i_sock = 0;
 126                 inode->i_op = &empty_iops;
 127                 inode->i_fop = &empty_fops;
 128                 inode->i_nlink = 1;
 129                 atomic_set(&inode->i_writecount, 0);
 130                 inode->i_size = 0;
 131                 inode->i_blocks = 0;
 132                 inode->i_bytes = 0;
 133                 inode->i_generation = 0;
 134 #ifdef CONFIG_QUOTA
 135                 memset(&inode->i_dquot, 0, sizeof(inode->i_dquot));
 136 #endif
 137                 inode->i_pipe = NULL;
 138                 inode->i_bdev = NULL;
 139                 inode->i_cdev = NULL;
 140                 inode->i_rdev = 0;
 141                 inode->i_security = NULL;
 142                 inode->dirtied_when = 0;
 143                 if (security_inode_alloc(inode)) {
 144                         if (inode->i_sb->s_op->destroy_inode)
 145                                 inode->i_sb->s_op->destroy_inode(inode);
 146                         else
 147                                 kmem_cache_free(inode_cachep, (inode));
 148                         return NULL;
 149                 }
 150
 151                 mapping->a_ops = &empty_aops;
 152                 mapping->host = inode;
 153                 mapping->flags = 0;
 154                 mapping_set_gfp_mask(mapping, GFP_HIGHUSER);
 155                 mapping->assoc_mapping = NULL;
 156                 mapping->backing_dev_info = &default_backing_dev_info;
 157
 158                 /*
 159                  * If the block_device provides a backing_dev_info for client
 160                  * inodes then use that.  Otherwise the inode share the bdev's
 161                  * backing_dev_info.
 162                  */
 163                 if (sb->s_bdev) {
 164                         struct backing_dev_info *bdi;
 165
 166                         bdi = sb->s_bdev->bd_inode_backing_dev_info;
 167                         if (!bdi)
 168                                 bdi = sb->s_bdev->bd_inode->i_mapping->backing_dev_info;
 169                         mapping->backing_dev_info = bdi;
 170                 }
 171                 memset(&inode->u, 0, sizeof(inode->u));
 172                 inode->i_mapping = mapping;
 173         }
 174         return inode;
 175 }
 176
 177 void destroy_inode(struct inode *inode)
 178 {
 179         if (inode_has_buffers(inode))
 180                 BUG();
 181         security_inode_free(inode);
 182         if (inode->i_sb->s_op->destroy_inode)
 183                 inode->i_sb->s_op->destroy_inode(inode);
 184         else
 185                 kmem_cache_free(inode_cachep, (inode));
 186 }
 187
 188
 189 /*
 190  * These are initializations that only need to be done
 191  * once, because the fields are idempotent across use
 192  * of the inode, so let the slab aware of that.
 193  */
 194 void inode_init_once(struct inode *inode)
 195 {
 196         memset(inode, 0, sizeof(*inode));
 197         INIT_HLIST_NODE(&inode->i_hash);
 198         INIT_LIST_HEAD(&inode->i_dentry);
 199         INIT_LIST_HEAD(&inode->i_devices);
 200         sema_init(&inode->i_sem, 1);
 201         init_rwsem(&inode->i_alloc_sem);
 202         INIT_RADIX_TREE(&inode->i_data.page_tree, GFP_ATOMIC);
 203         spin_lock_init(&inode->i_data.tree_lock);
 204         spin_lock_init(&inode->i_data.i_mmap_lock);
 205         INIT_LIST_HEAD(&inode->i_data.private_list);
 206         spin_lock_init(&inode->i_data.private_lock);
 207         INIT_RAW_PRIO_TREE_ROOT(&inode->i_data.i_mmap);
 208         INIT_LIST_HEAD(&inode->i_data.i_mmap_nonlinear);
 209         spin_lock_init(&inode->i_lock);
 210         i_size_ordered_init(inode);
 211 }
 212
 213 EXPORT_SYMBOL(inode_init_once);
 214
 215 static void init_once(void * foo, kmem_cache_t * cachep, unsigned long flags)
 216 {
 217         struct inode * inode = (struct inode *) foo;
 218
 219         if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) ==
 220             SLAB_CTOR_CONSTRUCTOR)
 221                 inode_init_once(inode);
 222 }
 223
 224 /*
 225  * inode_lock must be held
 226  */
 227 void __iget(struct inode * inode)
 228 {
 229         if (atomic_read(&inode->i_count)) {
 230                 atomic_inc(&inode->i_count);
 231                 return;
 232         }
 233         atomic_inc(&inode->i_count);
 234         if (!(inode->i_state & (I_DIRTY|I_LOCK)))
 235                 list_move(&inode->i_list, &inode_in_use);
 236         inodes_stat.nr_unused--;
 237 }
 238
 239 /**
 240  * clear_inode - clear an inode
 241  * @inode: inode to clear
 242  *
 243  * This is called by the filesystem to tell us
 244  * that the inode is no longer useful. We just
 245  * terminate it with extreme prejudice.
 246  */
 247 void clear_inode(struct inode *inode)
 248 {
 249         might_sleep();
 250         invalidate_inode_buffers(inode);
 251
 252         if (inode->i_data.nrpages)
 253                 BUG();
 254         if (!(inode->i_state & I_FREEING))
 255                 BUG();
 256         if (inode->i_state & I_CLEAR)
 257                 BUG();
 258         wait_on_inode(inode);
 259         DQUOT_DROP(inode);
 260         if (inode->i_sb && inode->i_sb->s_op->clear_inode)
 261                 inode->i_sb->s_op->clear_inode(inode);
 262         if (inode->i_bdev)
 263                 bd_forget(inode);
 264         if (inode->i_cdev)
 265                 cd_forget(inode);
 266         inode->i_state = I_CLEAR;
 267 }
 268
 269 EXPORT_SYMBOL(clear_inode);
 270
 271 /*
 272  * dispose_list - dispose of the contents of a local list
 273  * @head: the head of the list to free
 274  *
 275  * Dispose-list gets a local list with local inodes in it, so it doesn't
 276  * need to worry about list corruption and SMP locks.
 277  */
 278 static void dispose_list(struct list_head *head)
 279 {
 280         int nr_disposed = 0;
 281
 282         while (!list_empty(head)) {
 283                 struct inode *inode;
 284
 285                 inode = list_entry(head->next, struct inode, i_list);
 286                 list_del(&inode->i_list);
 287
 288                 if (inode->i_data.nrpages)
 289                         truncate_inode_pages(&inode->i_data, 0);
 290                 clear_inode(inode);
 291                 destroy_inode(inode);
 292                 nr_disposed++;
 293         }
 294         spin_lock(&inode_lock);
 295         inodes_stat.nr_inodes -= nr_disposed;
 296         spin_unlock(&inode_lock);
 297 }
 298
 299 /*
 300  * Invalidate all inodes for a device.
 301  */
 302 static int invalidate_list(struct list_head *head, struct list_head *dispose)
 303 {
 304         struct list_head *next;
 305         int busy = 0, count = 0;
 306
 307         next = head->next;
 308         for (;;) {
 309                 struct list_head * tmp = next;
 310                 struct inode * inode;
 311
 312                 /*
 313                  * We can reschedule here without worrying about the list's
 314                  * consistency because the per-sb list of inodes must not
 315                  * change during umount anymore, and because iprune_sem keeps
 316                  * shrink_icache_memory() away.
 317                  */
 318                 cond_resched_lock(&inode_lock);
 319
 320                 next = next->next;
 321                 if (tmp == head)
 322                         break;
 323                 inode = list_entry(tmp, struct inode, i_sb_list);
 324                 invalidate_inode_buffers(inode);
 325                 if (!atomic_read(&inode->i_count)) {
 326                         hlist_del_init(&inode->i_hash);
 327                         list_del(&inode->i_sb_list);
 328                         list_move(&inode->i_list, dispose);
 329                         inode->i_state |= I_FREEING;
 330                         count++;
 331                         continue;
 332                 }
 333                 busy = 1;
 334         }
 335         /* only unused inodes may be cached with i_count zero */
 336         inodes_stat.nr_unused -= count;
 337         return busy;
 338 }
 339
 340 /*
 341  * This is a two-stage process. First we collect all
 342  * offending inodes onto the throw-away list, and in
 343  * the second stage we actually dispose of them. This
 344  * is because we don't want to sleep while messing
 345  * with the global lists..
 346  */
 347
 348 /**
 349  *      invalidate_inodes       - discard the inodes on a device
 350  *      @sb: superblock
 351  *
 352  *      Discard all of the inodes for a given superblock. If the discard
 353  *      fails because there are busy inodes then a non zero value is returned.
 354  *      If the discard is successful all the inodes have been discarded.
 355  */
 356 int invalidate_inodes(struct super_block * sb)
 357 {
 358         int busy;
 359         LIST_HEAD(throw_away);
 360
 361         down(&iprune_sem);
 362         spin_lock(&inode_lock);
 363         busy = invalidate_list(&sb->s_inodes, &throw_away);
 364         spin_unlock(&inode_lock);
 365
 366         dispose_list(&throw_away);
 367         up(&iprune_sem);
 368
 369         return busy;
 370 }
 371
 372 EXPORT_SYMBOL(invalidate_inodes);
 373
 374 int __invalidate_device(struct block_device *bdev, int do_sync)
 375 {
 376         struct super_block *sb;
 377         int res;
 378
 379         if (do_sync)
 380                 fsync_bdev(bdev);
 381
 382         res = 0;
 383         sb = get_super(bdev);
 384         if (sb) {
 385                 /*
 386                  * no need to lock the super, get_super holds the
 387                  * read semaphore so the filesystem cannot go away
 388                  * under us (->put_super runs with the write lock
 389                  * hold).
 390                  */
 391                 shrink_dcache_sb(sb);
 392                 res = invalidate_inodes(sb);
 393                 drop_super(sb);
 394         }
 395         invalidate_bdev(bdev, 0);
 396         return res;
 397 }
 398
 399 EXPORT_SYMBOL(__invalidate_device);
 400
 401 static int can_unuse(struct inode *inode)
 402 {
 403         if (inode->i_state)
 404                 return 0;
 405         if (inode_has_buffers(inode))
 406                 return 0;
 407         if (atomic_read(&inode->i_count))
 408                 return 0;
 409         if (inode->i_data.nrpages)
 410                 return 0;
 411         return 1;
 412 }
 413
 414 /*
 415  * Scan `goal' inodes on the unused list for freeable ones. They are moved to
 416  * a temporary list and then are freed outside inode_lock by dispose_list().
 417  *
 418  * Any inodes which are pinned purely because of attached pagecache have their
 419  * pagecache removed.  We expect the final iput() on that inode to add it to
 420  * the front of the inode_unused list.  So look for it there and if the
 421  * inode is still freeable, proceed.  The right inode is found 99.9% of the
 422  * time in testing on a 4-way.
 423  *
 424  * If the inode has metadata buffers attached to mapping->private_list then
 425  * try to remove them.
 426  */
 427 static void prune_icache(int nr_to_scan)
 428 {
 429         LIST_HEAD(freeable);
 430         int nr_pruned = 0;
 431         int nr_scanned;
 432         unsigned long reap = 0;
 433
 434         down(&iprune_sem);
 435         spin_lock(&inode_lock);
 436         for (nr_scanned = 0; nr_scanned < nr_to_scan; nr_scanned++) {
 437                 struct inode *inode;
 438
 439                 if (list_empty(&inode_unused))
 440                         break;
 441
 442                 inode = list_entry(inode_unused.prev, struct inode, i_list);
 443
 444                 if (inode->i_state || atomic_read(&inode->i_count)) {
 445                         list_move(&inode->i_list, &inode_unused);
 446                         continue;
 447                 }
 448                 if (inode_has_buffers(inode) || inode->i_data.nrpages) {
 449                         __iget(inode);
 450                         spin_unlock(&inode_lock);
 451                         if (remove_inode_buffers(inode))
 452                                 reap += invalidate_inode_pages(&inode->i_data);
 453                         iput(inode);
 454                         spin_lock(&inode_lock);
 455
 456                         if (inode != list_entry(inode_unused.next,
 457                                                 struct inode, i_list))
 458                                 continue;       /* wrong inode or list_empty */
 459                         if (!can_unuse(inode))
 460                                 continue;
 461                 }
 462                 hlist_del_init(&inode->i_hash);
 463                 list_del_init(&inode->i_sb_list);
 464                 list_move(&inode->i_list, &freeable);
 465                 inode->i_state |= I_FREEING;
 466                 nr_pruned++;
 467         }
 468         inodes_stat.nr_unused -= nr_pruned;
 469         spin_unlock(&inode_lock);
 470
 471         dispose_list(&freeable);
 472         up(&iprune_sem);
 473
 474         if (current_is_kswapd())
 475                 mod_page_state(kswapd_inodesteal, reap);
 476         else
 477                 mod_page_state(pginodesteal, reap);
 478 }
 479
 480 /*
 481  * shrink_icache_memory() will attempt to reclaim some unused inodes.  Here,
 482  * "unused" means that no dentries are referring to the inodes: the files are
 483  * not open and the dcache references to those inodes have already been
 484  * reclaimed.
 485  *
 486  * This function is passed the number of inodes to scan, and it returns the
 487  * total number of remaining possibly-reclaimable inodes.
 488  */
 489 static int shrink_icache_memory(int nr, unsigned int gfp_mask)
 490 {
 491         if (nr) {
 492                 /*
 493                  * Nasty deadlock avoidance.  We may hold various FS locks,
 494                  * and we don't want to recurse into the FS that called us
 495                  * in clear_inode() and friends..
 496                  */
 497                 if (!(gfp_mask & __GFP_FS))
 498                         return -1;
 499                 prune_icache(nr);
 500         }
 501         return (inodes_stat.nr_unused / 100) * sysctl_vfs_cache_pressure;
 502 }
 503
 504 static void __wait_on_freeing_inode(struct inode *inode);
 505 /*
 506  * Called with the inode lock held.
 507  * NOTE: we are not increasing the inode-refcount, you must call __iget()
 508  * by hand after calling find_inode now! This simplifies iunique and won't
 509  * add any additional branch in the common code.
 510  */
 511 static struct inode * find_inode(struct super_block * sb, struct hlist_head *head, int (*test)(struct inode *, void *), void *data)
 512 {
 513         struct hlist_node *node;
 514         struct inode * inode = NULL;
 515
 516 repeat:
 517         hlist_for_each (node, head) {
 518                 inode = hlist_entry(node, struct inode, i_hash);
 519                 if (inode->i_sb != sb)
 520                         continue;
 521                 if (!test(inode, data))
 522                         continue;
 523                 if (inode->i_state & (I_FREEING|I_CLEAR)) {
 524                         __wait_on_freeing_inode(inode);
 525                         goto repeat;
 526                 }
 527                 break;
 528         }
 529         return node ? inode : NULL;
 530 }
 531
 532 /*
 533  * find_inode_fast is the fast path version of find_inode, see the comment at
 534  * iget_locked for details.
 535  */
 536 static struct inode * find_inode_fast(struct super_block * sb, struct hlist_head *head, unsigned long ino)
 537 {
 538         struct hlist_node *node;
 539         struct inode * inode = NULL;
 540
 541 repeat:
 542         hlist_for_each (node, head) {
 543                 inode = hlist_entry(node, struct inode, i_hash);
 544                 if (inode->i_ino != ino)
 545                         continue;
 546                 if (inode->i_sb != sb)
 547                         continue;
 548                 if (inode->i_state & (I_FREEING|I_CLEAR)) {
 549                         __wait_on_freeing_inode(inode);
 550                         goto repeat;
 551                 }
 552                 break;
 553         }
 554         return node ? inode : NULL;
 555 }
 556
 557 /**
 558  *      new_inode       - obtain an inode
 559  *      @sb: superblock
 560  *
 561  *      Allocates a new inode for given superblock.
 562  */
 563 struct inode *new_inode(struct super_block *sb)
 564 {
 565         static unsigned long last_ino;
 566         struct inode * inode;
 567
 568         spin_lock_prefetch(&inode_lock);
 569
 570         inode = alloc_inode(sb);
 571         if (inode) {
 572                 spin_lock(&inode_lock);
 573                 inodes_stat.nr_inodes++;
 574                 list_add(&inode->i_list, &inode_in_use);
 575                 list_add(&inode->i_sb_list, &sb->s_inodes);
 576                 inode->i_ino = ++last_ino;
 577                 inode->i_state = 0;
 578                 spin_unlock(&inode_lock);
 579         }
 580         return inode;
 581 }
 582
 583 EXPORT_SYMBOL(new_inode);
 584
 585 void unlock_new_inode(struct inode *inode)
 586 {
 587         /*
 588          * This is special!  We do not need the spinlock
 589          * when clearing I_LOCK, because we're guaranteed
 590          * that nobody else tries to do anything about the
 591          * state of the inode when it is locked, as we
 592          * just created it (so there can be no old holders
 593          * that haven't tested I_LOCK).
 594          */
 595         inode->i_state &= ~(I_LOCK|I_NEW);
 596         wake_up_inode(inode);
 597 }
 598
 599 EXPORT_SYMBOL(unlock_new_inode);
 600
 601 /*
 602  * This is called without the inode lock held.. Be careful.
 603  *
 604  * We no longer cache the sb_flags in i_flags - see fs.h
 605  *      -- rmk@arm.uk.linux.org
 606  */
 607 static struct inode * get_new_inode(struct super_block *sb, struct hlist_head *head, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *data)
 608 {
 609         struct inode * inode;
 610
 611         inode = alloc_inode(sb);
 612         if (inode) {
 613                 struct inode * old;
 614
 615                 spin_lock(&inode_lock);
 616                 /* We released the lock, so.. */
 617                 old = find_inode(sb, head, test, data);
 618                 if (!old) {
 619                         if (set(inode, data))
 620                                 goto set_failed;
 621
 622                         inodes_stat.nr_inodes++;
 623                         list_add(&inode->i_list, &inode_in_use);
 624                         list_add(&inode->i_sb_list, &sb->s_inodes);
 625                         hlist_add_head(&inode->i_hash, head);
 626                         inode->i_state = I_LOCK|I_NEW;
 627                         spin_unlock(&inode_lock);
 628
 629                         /* Return the locked inode with I_NEW set, the
 630                          * caller is responsible for filling in the contents
 631                          */
 632                         return inode;
 633                 }
 634
 635                 /*
 636                  * Uhhuh, somebody else created the same inode under
 637                  * us. Use the old inode instead of the one we just
 638                  * allocated.
 639                  */
 640                 __iget(old);
 641                 spin_unlock(&inode_lock);
 642                 destroy_inode(inode);
 643                 inode = old;
 644                 wait_on_inode(inode);
 645         }
 646         return inode;
 647
 648 set_failed:
 649         spin_unlock(&inode_lock);
 650         destroy_inode(inode);
 651         return NULL;
 652 }
 653
 654 /*
 655  * get_new_inode_fast is the fast path version of get_new_inode, see the
 656  * comment at iget_locked for details.
 657  */
 658 static struct inode * get_new_inode_fast(struct super_block *sb, struct hlist_head *head, unsigned long ino)
 659 {
 660         struct inode * inode;
 661
 662         inode = alloc_inode(sb);
 663         if (inode) {
 664                 struct inode * old;
 665
 666                 spin_lock(&inode_lock);
 667                 /* We released the lock, so.. */
 668                 old = find_inode_fast(sb, head, ino);
 669                 if (!old) {
 670                         inode->i_ino = ino;
 671                         inodes_stat.nr_inodes++;
 672                         list_add(&inode->i_list, &inode_in_use);
 673                         list_add(&inode->i_sb_list, &sb->s_inodes);
 674                         hlist_add_head(&inode->i_hash, head);
 675                         inode->i_state = I_LOCK|I_NEW;
 676                         spin_unlock(&inode_lock);
 677
 678                         /* Return the locked inode with I_NEW set, the
 679                          * caller is responsible for filling in the contents
 680                          */
 681                         return inode;
 682                 }
 683
 684                 /*
 685                  * Uhhuh, somebody else created the same inode under
 686                  * us. Use the old inode instead of the one we just
 687                  * allocated.
 688                  */
 689                 __iget(old);
 690                 spin_unlock(&inode_lock);
 691                 destroy_inode(inode);
 692                 inode = old;
 693                 wait_on_inode(inode);
 694         }
 695         return inode;
 696 }
 697
 698 static inline unsigned long hash(struct super_block *sb, unsigned long hashval)
 699 {
 700         unsigned long tmp;
 701
 702         tmp = (hashval * (unsigned long)sb) ^ (GOLDEN_RATIO_PRIME + hashval) /
 703                         L1_CACHE_BYTES;
 704         tmp = tmp ^ ((tmp ^ GOLDEN_RATIO_PRIME) >> I_HASHBITS);
 705         return tmp & I_HASHMASK;
 706 }
 707
 708 /**
 709  *      iunique - get a unique inode number
 710  *      @sb: superblock
 711  *      @max_reserved: highest reserved inode number
 712  *
 713  *      Obtain an inode number that is unique on the system for a given
 714  *      superblock. This is used by file systems that have no natural
 715  *      permanent inode numbering system. An inode number is returned that
 716  *      is higher than the reserved limit but unique.
 717  *
 718  *      BUGS:
 719  *      With a large number of inodes live on the file system this function
 720  *      currently becomes quite slow.
 721  */
 722 ino_t iunique(struct super_block *sb, ino_t max_reserved)
 723 {
 724         static ino_t counter;
 725         struct inode *inode;
 726         struct hlist_head * head;
 727         ino_t res;
 728         spin_lock(&inode_lock);
 729 retry:
 730         if (counter > max_reserved) {
 731                 head = inode_hashtable + hash(sb,counter);
 732                 res = counter++;
 733                 inode = find_inode_fast(sb, head, res);
 734                 if (!inode) {
 735                         spin_unlock(&inode_lock);
 736                         return res;
 737                 }
 738         } else {
 739                 counter = max_reserved + 1;
 740         }
 741         goto retry;
 742
 743 }
 744
 745 EXPORT_SYMBOL(iunique);
 746
 747 struct inode *igrab(struct inode *inode)
 748 {
 749         spin_lock(&inode_lock);
 750         if (!(inode->i_state & I_FREEING))
 751                 __iget(inode);
 752         else
 753                 /*
 754                  * Handle the case where s_op->clear_inode is not been
 755                  * called yet, and somebody is calling igrab
 756                  * while the inode is getting freed.
 757                  */
 758                 inode = NULL;
 759         spin_unlock(&inode_lock);
 760         return inode;
 761 }
 762
 763 EXPORT_SYMBOL(igrab);
 764
 765 /**
 766  * ifind - internal function, you want ilookup5() or iget5().
 767  * @sb:         super block of file system to search
 768  * @head:       the head of the list to search
 769  * @test:       callback used for comparisons between inodes
 770  * @data:       opaque data pointer to pass to @test
 771  *
 772  * ifind() searches for the inode specified by @data in the inode
 773  * cache. This is a generalized version of ifind_fast() for file systems where
 774  * the inode number is not sufficient for unique identification of an inode.
 775  *
 776  * If the inode is in the cache, the inode is returned with an incremented
 777  * reference count.
 778  *
 779  * Otherwise NULL is returned.
 780  *
 781  * Note, @test is called with the inode_lock held, so can't sleep.
 782  */
 783 static inline struct inode *ifind(struct super_block *sb,
 784                 struct hlist_head *head, int (*test)(struct inode *, void *),
 785                 void *data)
 786 {
 787         struct inode *inode;
 788
 789         spin_lock(&inode_lock);
 790         inode = find_inode(sb, head, test, data);
 791         if (inode) {
 792                 __iget(inode);
 793                 spin_unlock(&inode_lock);
 794                 wait_on_inode(inode);
 795                 return inode;
 796         }
 797         spin_unlock(&inode_lock);
 798         return NULL;
 799 }
 800
 801 /**
 802  * ifind_fast - internal function, you want ilookup() or iget().
 803  * @sb:         super block of file system to search
 804  * @head:       head of the list to search
 805  * @ino:        inode number to search for
 806  *
 807  * ifind_fast() searches for the inode @ino in the inode cache. This is for
 808  * file systems where the inode number is sufficient for unique identification
 809  * of an inode.
 810  *
 811  * If the inode is in the cache, the inode is returned with an incremented
 812  * reference count.
 813  *
 814  * Otherwise NULL is returned.
 815  */
 816 static inline struct inode *ifind_fast(struct super_block *sb,
 817                 struct hlist_head *head, unsigned long ino)
 818 {
 819         struct inode *inode;
 820
 821         spin_lock(&inode_lock);
 822         inode = find_inode_fast(sb, head, ino);
 823         if (inode) {
 824                 __iget(inode);
 825                 spin_unlock(&inode_lock);
 826                 wait_on_inode(inode);
 827                 return inode;
 828         }
 829         spin_unlock(&inode_lock);
 830         return NULL;
 831 }
 832
 833 /**
 834  * ilookup5 - search for an inode in the inode cache
 835  * @sb:         super block of file system to search
 836  * @hashval:    hash value (usually inode number) to search for
 837  * @test:       callback used for comparisons between inodes
 838  * @data:       opaque data pointer to pass to @test
 839  *
 840  * ilookup5() uses ifind() to search for the inode specified by @hashval and
 841  * @data in the inode cache. This is a generalized version of ilookup() for
 842  * file systems where the inode number is not sufficient for unique
 843  * identification of an inode.
 844  *
 845  * If the inode is in the cache, the inode is returned with an incremented
 846  * reference count.
 847  *
 848  * Otherwise NULL is returned.
 849  *
 850  * Note, @test is called with the inode_lock held, so can't sleep.
 851  */
 852 struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
 853                 int (*test)(struct inode *, void *), void *data)
 854 {
 855         struct hlist_head *head = inode_hashtable + hash(sb, hashval);
 856
 857         return ifind(sb, head, test, data);
 858 }
 859
 860 EXPORT_SYMBOL(ilookup5);
 861
 862 /**
 863  * ilookup - search for an inode in the inode cache
 864  * @sb:         super block of file system to search
 865  * @ino:        inode number to search for
 866  *
 867  * ilookup() uses ifind_fast() to search for the inode @ino in the inode cache.
 868  * This is for file systems where the inode number is sufficient for unique
 869  * identification of an inode.
 870  *
 871  * If the inode is in the cache, the inode is returned with an incremented
 872  * reference count.
 873  *
 874  * Otherwise NULL is returned.
 875  */
 876 struct inode *ilookup(struct super_block *sb, unsigned long ino)
 877 {
 878         struct hlist_head *head = inode_hashtable + hash(sb, ino);
 879
 880         return ifind_fast(sb, head, ino);
 881 }
 882
 883 EXPORT_SYMBOL(ilookup);
 884
 885 /**
 886  * iget5_locked - obtain an inode from a mounted file system
 887  * @sb:         super block of file system
 888  * @hashval:    hash value (usually inode number) to get
 889  * @test:       callback used for comparisons between inodes
 890  * @set:        callback used to initialize a new struct inode
 891  * @data:       opaque data pointer to pass to @test and @set
 892  *
 893  * This is iget() without the read_inode() portion of get_new_inode().
 894  *
 895  * iget5_locked() uses ifind() to search for the inode specified by @hashval
 896  * and @data in the inode cache and if present it is returned with an increased
 897  * reference count. This is a generalized version of iget_locked() for file
 898  * systems where the inode number is not sufficient for unique identification
 899  * of an inode.
 900  *
 901  * If the inode is not in cache, get_new_inode() is called to allocate a new
 902  * inode and this is returned locked, hashed, and with the I_NEW flag set. The
 903  * file system gets to fill it in before unlocking it via unlock_new_inode().
 904  *
 905  * Note both @test and @set are called with the inode_lock held, so can't sleep.
 906  */
 907 struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
 908                 int (*test)(struct inode *, void *),
 909                 int (*set)(struct inode *, void *), void *data)
 910 {
 911         struct hlist_head *head = inode_hashtable + hash(sb, hashval);
 912         struct inode *inode;
 913
 914         inode = ifind(sb, head, test, data);
 915         if (inode)
 916                 return inode;
 917         /*
 918          * get_new_inode() will do the right thing, re-trying the search
 919          * in case it had to block at any point.
 920          */
 921         return get_new_inode(sb, head, test, set, data);
 922 }
 923
 924 EXPORT_SYMBOL(iget5_locked);
 925
 926 /**
 927  * iget_locked - obtain an inode from a mounted file system
 928  * @sb:         super block of file system
 929  * @ino:        inode number to get
 930  *
 931  * This is iget() without the read_inode() portion of get_new_inode_fast().
 932  *
 933  * iget_locked() uses ifind_fast() to search for the inode specified by @ino in
 934  * the inode cache and if present it is returned with an increased reference
 935  * count. This is for file systems where the inode number is sufficient for
 936  * unique identification of an inode.
 937  *
 938  * If the inode is not in cache, get_new_inode_fast() is called to allocate a
 939  * new inode and this is returned locked, hashed, and with the I_NEW flag set.
 940  * The file system gets to fill it in before unlocking it via
 941  * unlock_new_inode().
 942  */
 943 struct inode *iget_locked(struct super_block *sb, unsigned long ino)
 944 {
 945         struct hlist_head *head = inode_hashtable + hash(sb, ino);
 946         struct inode *inode;
 947
 948         inode = ifind_fast(sb, head, ino);
 949         if (inode)
 950                 return inode;
 951         /*
 952          * get_new_inode_fast() will do the right thing, re-trying the search
 953          * in case it had to block at any point.
 954          */
 955         return get_new_inode_fast(sb, head, ino);
 956 }
 957
 958 EXPORT_SYMBOL(iget_locked);
 959
 960 /**
 961  *      __insert_inode_hash - hash an inode
 962  *      @inode: unhashed inode
 963  *      @hashval: unsigned long value used to locate this object in the
 964  *              inode_hashtable.
 965  *
 966  *      Add an inode to the inode hash for this superblock.
 967  */
 968 void __insert_inode_hash(struct inode *inode, unsigned long hashval)
 969 {
 970         struct hlist_head *head = inode_hashtable + hash(inode->i_sb, hashval);
 971         spin_lock(&inode_lock);
 972         hlist_add_head(&inode->i_hash, head);
 973         spin_unlock(&inode_lock);
 974 }
 975
 976 EXPORT_SYMBOL(__insert_inode_hash);
 977
 978 /**
 979  *      remove_inode_hash - remove an inode from the hash
 980  *      @inode: inode to unhash
 981  *
 982  *      Remove an inode from the superblock.
 983  */
 984 void remove_inode_hash(struct inode *inode)
 985 {
 986         spin_lock(&inode_lock);
 987         hlist_del_init(&inode->i_hash);
 988         spin_unlock(&inode_lock);
 989 }
 990
 991 EXPORT_SYMBOL(remove_inode_hash);
 992
 993 /*
 994  * Tell the filesystem that this inode is no longer of any interest and should
 995  * be completely destroyed.
 996  *
 997  * We leave the inode in the inode hash table until *after* the filesystem's
 998  * ->delete_inode completes.  This ensures that an iget (such as nfsd might
 999  * instigate) will always find up-to-date information either in the hash or on
1000  * disk.
1001  *
1002  * I_FREEING is set so that no-one will take a new reference to the inode while
1003  * it is being deleted.
1004  */
1005 void generic_delete_inode(struct inode *inode)
1006 {
1007         struct super_operations *op = inode->i_sb->s_op;
1008
1009         list_del_init(&inode->i_list);
1010         list_del_init(&inode->i_sb_list);
1011         inode->i_state|=I_FREEING;
1012         inodes_stat.nr_inodes--;
1013         spin_unlock(&inode_lock);
1014
1015         if (inode->i_data.nrpages)
1016                 truncate_inode_pages(&inode->i_data, 0);
1017
1018         security_inode_delete(inode);
1019
1020         if (op->delete_inode) {
1021                 void (*delete)(struct inode *) = op->delete_inode;
1022                 if (!is_bad_inode(inode))
1023                         DQUOT_INIT(inode);
1024                 /* s_op->delete_inode internally recalls clear_inode() */
1025                 delete(inode);
1026         } else
1027                 clear_inode(inode);
1028         spin_lock(&inode_lock);
1029         hlist_del_init(&inode->i_hash);
1030         spin_unlock(&inode_lock);
1031         wake_up_inode(inode);
1032         if (inode->i_state != I_CLEAR)
1033                 BUG();
1034         destroy_inode(inode);
1035 }
1036
1037 EXPORT_SYMBOL(generic_delete_inode);
1038
1039 static void generic_forget_inode(struct inode *inode)
1040 {
1041         struct super_block *sb = inode->i_sb;
1042
1043         if (!hlist_unhashed(&inode->i_hash)) {
1044                 if (!(inode->i_state & (I_DIRTY|I_LOCK)))
1045                         list_move(&inode->i_list, &inode_unused);
1046                 inodes_stat.nr_unused++;
1047                 spin_unlock(&inode_lock);
1048                 if (!sb || (sb->s_flags & MS_ACTIVE))
1049                         return;
1050                 write_inode_now(inode, 1);
1051                 spin_lock(&inode_lock);
1052                 inodes_stat.nr_unused--;
1053                 hlist_del_init(&inode->i_hash);
1054         }
1055         list_del_init(&inode->i_list);
1056         list_del_init(&inode->i_sb_list);
1057         inode->i_state|=I_FREEING;
1058         inodes_stat.nr_inodes--;
1059         spin_unlock(&inode_lock);
1060         if (inode->i_data.nrpages)
1061                 truncate_inode_pages(&inode->i_data, 0);
1062         clear_inode(inode);
1063         destroy_inode(inode);
1064 }
1065
1066 /*
1067  * Normal UNIX filesystem behaviour: delete the
1068  * inode when the usage count drops to zero, and
1069  * i_nlink is zero.
1070  */
1071 static void generic_drop_inode(struct inode *inode)
1072 {
1073         if (!inode->i_nlink)
1074                 generic_delete_inode(inode);
1075         else
1076                 generic_forget_inode(inode);
1077 }
1078
1079 /*
1080  * Called when we're dropping the last reference
1081  * to an inode.
1082  *
1083  * Call the FS "drop()" function, defaulting to
1084  * the legacy UNIX filesystem behaviour..
1085  *
1086  * NOTE! NOTE! NOTE! We're called with the inode lock
1087  * held, and the drop function is supposed to release
1088  * the lock!
1089  */
1090 static inline void iput_final(struct inode *inode)
1091 {
1092         struct super_operations *op = inode->i_sb->s_op;
1093         void (*drop)(struct inode *) = generic_drop_inode;
1094
1095         if (op && op->drop_inode)
1096                 drop = op->drop_inode;
1097         drop(inode);
1098 }
1099
1100 /**
1101  *      iput    - put an inode
1102  *      @inode: inode to put
1103  *
1104  *      Puts an inode, dropping its usage count. If the inode use count hits
1105  *      zero the inode is also then freed and may be destroyed.
1106  */
1107 void iput(struct inode *inode)
1108 {
1109         if (inode) {
1110                 struct super_operations *op = inode->i_sb->s_op;
1111
1112                 if (inode->i_state == I_CLEAR)
1113                         BUG();
1114
1115                 if (op && op->put_inode)
1116                         op->put_inode(inode);
1117
1118                 if (atomic_dec_and_lock(&inode->i_count, &inode_lock))
1119                         iput_final(inode);
1120         }
1121 }
1122
1123 EXPORT_SYMBOL(iput);
1124
1125 /**
1126  *      bmap    - find a block number in a file
1127  *      @inode: inode of file
1128  *      @block: block to find
1129  *
1130  *      Returns the block number on the device holding the inode that
1131  *      is the disk block number for the block of the file requested.
1132  *      That is, asked for block 4 of inode 1 the function will return the
1133  *      disk block relative to the disk start that holds that block of the
1134  *      file.
1135  */
1136 sector_t bmap(struct inode * inode, sector_t block)
1137 {
1138         sector_t res = 0;
1139         if (inode->i_mapping->a_ops->bmap)
1140                 res = inode->i_mapping->a_ops->bmap(inode->i_mapping, block);
1141         return res;
1142 }
1143
1144 EXPORT_SYMBOL(bmap);
1145
1146 /**
1147  *      update_atime    -       update the access time
1148  *      @inode: inode accessed
1149  *
1150  *      Update the accessed time on an inode and mark it for writeback.
1151  *      This function automatically handles read only file systems and media,
1152  *      as well as the "noatime" flag and inode specific "noatime" markers.
1153  */
1154 void update_atime(struct inode *inode)
1155 {
1156         struct timespec now;
1157
1158         if (IS_NOATIME(inode))
1159                 return;
1160         if (IS_NODIRATIME(inode) && S_ISDIR(inode->i_mode))
1161                 return;
1162         if (IS_RDONLY(inode))
1163                 return;
1164
1165         now = current_fs_time(inode->i_sb);
1166         if (!timespec_equal(&inode->i_atime, &now)) {
1167                 inode->i_atime = now;
1168                 mark_inode_dirty_sync(inode);
1169         } else {
1170                 if (!timespec_equal(&inode->i_atime, &now))
1171                         inode->i_atime = now;
1172         }
1173 }
1174
1175 EXPORT_SYMBOL(update_atime);
1176
1177 /**
1178  *      inode_update_time       -       update mtime and ctime time
1179  *      @inode: inode accessed
1180  *      @ctime_too: update ctime too
1181  *
1182  *      Update the mtime time on an inode and mark it for writeback.
1183  *      When ctime_too is specified update the ctime too.
1184  */
1185
1186 void inode_update_time(struct inode *inode, int ctime_too)
1187 {
1188         struct timespec now;
1189         int sync_it = 0;
1190
1191         if (IS_NOCMTIME(inode))
1192                 return;
1193         if (IS_RDONLY(inode))
1194                 return;
1195
1196         now = current_fs_time(inode->i_sb);
1197         if (!timespec_equal(&inode->i_mtime, &now))
1198                 sync_it = 1;
1199         inode->i_mtime = now;
1200
1201         if (ctime_too) {
1202                 if (!timespec_equal(&inode->i_ctime, &now))
1203                         sync_it = 1;
1204                 inode->i_ctime = now;
1205         }
1206         if (sync_it)
1207                 mark_inode_dirty_sync(inode);
1208 }
1209
1210 EXPORT_SYMBOL(inode_update_time);
1211
1212 int inode_needs_sync(struct inode *inode)
1213 {
1214         if (IS_SYNC(inode))
1215                 return 1;
1216         if (S_ISDIR(inode->i_mode) && IS_DIRSYNC(inode))
1217                 return 1;
1218         return 0;
1219 }
1220
1221 EXPORT_SYMBOL(inode_needs_sync);
1222
1223 /*
1224  *      Quota functions that want to walk the inode lists..
1225  */
1226 #ifdef CONFIG_QUOTA
1227
1228 /* Function back in dquot.c */
1229 int remove_inode_dquot_ref(struct inode *, int, struct list_head *);
1230
1231 void remove_dquot_ref(struct super_block *sb, int type,
1232                         struct list_head *tofree_head)
1233 {
1234         struct inode *inode;
1235
1236         if (!sb->dq_op)
1237                 return; /* nothing to do */
1238         spin_lock(&inode_lock); /* This lock is for inodes code */
1239
1240         /*
1241          * We don't have to lock against quota code - test IS_QUOTAINIT is
1242          * just for speedup...
1243          */
1244         list_for_each_entry(inode, &sb->s_inodes, i_sb_list)
1245                 if (!IS_NOQUOTA(inode))
1246                         remove_inode_dquot_ref(inode, type, tofree_head);
1247
1248         spin_unlock(&inode_lock);
1249 }
1250
1251 #endif
1252
1253 int inode_wait(void *word)
1254 {
1255         schedule();
1256         return 0;
1257 }
1258
1259 /*
1260  * If we try to find an inode in the inode hash while it is being deleted, we
1261  * have to wait until the filesystem completes its deletion before reporting
1262  * that it isn't found.  This is because iget will immediately call
1263  * ->read_inode, and we want to be sure that evidence of the deletion is found
1264  * by ->read_inode.
1265  * This is called with inode_lock held.
1266  */
1267 static void __wait_on_freeing_inode(struct inode *inode)
1268 {
1269         wait_queue_head_t *wq;
1270         DEFINE_WAIT_BIT(wait, &inode->i_state, __I_LOCK);
1271
1272         /*
1273          * I_FREEING and I_CLEAR are cleared in process context under
1274          * inode_lock, so we have to give the tasks who would clear them
1275          * a chance to run and acquire inode_lock.
1276          */
1277         if (!(inode->i_state & I_LOCK)) {
1278                 spin_unlock(&inode_lock);
1279                 yield();
1280                 spin_lock(&inode_lock);
1281                 return;
1282         }
1283         wq = bit_waitqueue(&inode->i_state, __I_LOCK);
1284         prepare_to_wait(wq, &wait.wait, TASK_UNINTERRUPTIBLE);
1285         spin_unlock(&inode_lock);
1286         schedule();
1287         finish_wait(wq, &wait.wait);
1288         spin_lock(&inode_lock);
1289 }
1290
1291 void wake_up_inode(struct inode *inode)
1292 {
1293         /*
1294          * Prevent speculative execution through spin_unlock(&inode_lock);
1295          */
1296         smp_mb();
1297         wake_up_bit(&inode->i_state, __I_LOCK);
1298 }
1299
1300 static __initdata unsigned long ihash_entries;
1301 static int __init set_ihash_entries(char *str)
1302 {
1303         if (!str)
1304                 return 0;
1305         ihash_entries = simple_strtoul(str, &str, 0);
1306         return 1;
1307 }
1308 __setup("ihash_entries=", set_ihash_entries);
1309
1310 /*
1311  * Initialize the waitqueues and inode hash table.
1312  */
1313 void __init inode_init_early(void)
1314 {
1315         int loop;
1316
1317         /* If hashes are distributed across NUMA nodes, defer
1318          * hash allocation until vmalloc space is available.
1319          */
1320         if (hashdist)
1321                 return;
1322
1323         inode_hashtable =
1324                 alloc_large_system_hash("Inode-cache",
1325                                         sizeof(struct hlist_head),
1326                                         ihash_entries,
1327                                         14,
1328                                         HASH_EARLY,
1329                                         &i_hash_shift,
1330                                         &i_hash_mask,
1331                                         0);
1332
1333         for (loop = 0; loop < (1 << i_hash_shift); loop++)
1334                 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1335 }
1336
1337 void __init inode_init(unsigned long mempages)
1338 {
1339         int loop;
1340
1341         /* inode slab cache */
1342         inode_cachep = kmem_cache_create("inode_cache", sizeof(struct inode),
1343                                 0, SLAB_PANIC, init_once, NULL);
1344         set_shrinker(DEFAULT_SEEKS, shrink_icache_memory);
1345
1346         /* Hash may have been set up in inode_init_early */
1347         if (!hashdist)
1348                 return;
1349
1350         inode_hashtable =
1351                 alloc_large_system_hash("Inode-cache",
1352                                         sizeof(struct hlist_head),
1353                                         ihash_entries,
1354                                         14,
1355                                         0,
1356                                         &i_hash_shift,
1357                                         &i_hash_mask,
1358                                         0);
1359
1360         for (loop = 0; loop < (1 << i_hash_shift); loop++)
1361                 INIT_HLIST_HEAD(&inode_hashtable[loop]);
1362 }
1363
1364 void init_special_inode(struct inode *inode, umode_t mode, dev_t rdev)
1365 {
1366         inode->i_mode = mode;
1367         if (S_ISCHR(mode)) {
1368                 inode->i_fop = &def_chr_fops;
1369                 inode->i_rdev = rdev;
1370         } else if (S_ISBLK(mode)) {
1371                 inode->i_fop = &def_blk_fops;
1372                 inode->i_rdev = rdev;
1373         } else if (S_ISFIFO(mode))
1374                 inode->i_fop = &def_fifo_fops;
1375         else if (S_ISSOCK(mode))
1376                 inode->i_fop = &bad_sock_fops;
1377         else
1378                 printk(KERN_DEBUG "init_special_inode: bogus i_mode (%o)\n",
1379                        mode);
1380 }
1381 EXPORT_SYMBOL(init_special_inode);