fs/super.c

   1 /*
   2  *  linux/fs/super.c
   3  *
   4  *  Copyright (C) 1991, 1992  Linus Torvalds
   5  *
   6  *  super.c contains code to handle: - mount structures
   7  *                                   - super-block tables
   8  *                                   - filesystem drivers list
   9  *                                   - mount system call
  10  *                                   - umount system call
  11  *                                   - ustat system call
  12  *
  13  * GK 2/5/95  -  Changed to support mounting the root fs via NFS
  14  *
  15  *  Added kerneld support: Jacques Gelinas and Bjorn Ekwall
  16  *  Added change_root: Werner Almesberger & Hans Lermen, Feb '96
  17  *  Added options to /proc/mounts:
  18  *    Torbjörn Lindh (torbjorn.lindh@gopta.se), April 14, 1996.
  19  *  Added devfs support: Richard Gooch <rgooch@atnf.csiro.au>, 13-JAN-1998
  20  *  Heavily rewritten for 'one fs - one tree' dcache architecture. AV, Mar 2000
  21  */
  22
  23 #include <linux/export.h>
  24 #include <linux/slab.h>
  25 #include <linux/blkdev.h>
  26 #include <linux/mount.h>
  27 #include <linux/security.h>
  28 #include <linux/writeback.h>            /* for the emergency remount stuff */
  29 #include <linux/idr.h>
  30 #include <linux/mutex.h>
  31 #include <linux/backing-dev.h>
  32 #include <linux/rculist_bl.h>
  33 #include <linux/cleancache.h>
  34 #include <linux/fsnotify.h>
  35 #include <linux/lockdep.h>
  36 #include <linux/user_namespace.h>
  37 #include "internal.h"
  38
  39
  40 static LIST_HEAD(super_blocks);
  41 static DEFINE_SPINLOCK(sb_lock);
  42
  43 static char *sb_writers_name[SB_FREEZE_LEVELS] = {
  44         "sb_writers",
  45         "sb_pagefaults",
  46         "sb_internal",
  47 };
  48
  49 /*
  50  * One thing we have to be careful of with a per-sb shrinker is that we don't
  51  * drop the last active reference to the superblock from within the shrinker.
  52  * If that happens we could trigger unregistering the shrinker from within the
  53  * shrinker path and that leads to deadlock on the shrinker_rwsem. Hence we
  54  * take a passive reference to the superblock to avoid this from occurring.
  55  */
  56 static unsigned long super_cache_scan(struct shrinker *shrink,
  57                                       struct shrink_control *sc)
  58 {
  59         struct super_block *sb;
  60         long    fs_objects = 0;
  61         long    total_objects;
  62         long    freed = 0;
  63         long    dentries;
  64         long    inodes;
  65
  66         sb = container_of(shrink, struct super_block, s_shrink);
  67
  68         /*
  69          * Deadlock avoidance.  We may hold various FS locks, and we don't want
  70          * to recurse into the FS that called us in clear_inode() and friends..
  71          */
  72         if (!(sc->gfp_mask & __GFP_FS))
  73                 return SHRINK_STOP;
  74
  75         if (!trylock_super(sb))
  76                 return SHRINK_STOP;
  77
  78         if (sb->s_op->nr_cached_objects)
  79                 fs_objects = sb->s_op->nr_cached_objects(sb, sc);
  80
  81         inodes = list_lru_shrink_count(&sb->s_inode_lru, sc);
  82         dentries = list_lru_shrink_count(&sb->s_dentry_lru, sc);
  83         total_objects = dentries + inodes + fs_objects + 1;
  84         if (!total_objects)
  85                 total_objects = 1;
  86
  87         /* proportion the scan between the caches */
  88         dentries = mult_frac(sc->nr_to_scan, dentries, total_objects);
  89         inodes = mult_frac(sc->nr_to_scan, inodes, total_objects);
  90         fs_objects = mult_frac(sc->nr_to_scan, fs_objects, total_objects);
  91
  92         /*
  93          * prune the dcache first as the icache is pinned by it, then
  94          * prune the icache, followed by the filesystem specific caches
  95          *
  96          * Ensure that we always scan at least one object - memcg kmem
  97          * accounting uses this to fully empty the caches.
  98          */
  99         sc->nr_to_scan = dentries + 1;
 100         freed = prune_dcache_sb(sb, sc);
 101         sc->nr_to_scan = inodes + 1;
 102         freed += prune_icache_sb(sb, sc);
 103
 104         if (fs_objects) {
 105                 sc->nr_to_scan = fs_objects + 1;
 106                 freed += sb->s_op->free_cached_objects(sb, sc);
 107         }
 108
 109         up_read(&sb->s_umount);
 110         return freed;
 111 }
 112
 113 static unsigned long super_cache_count(struct shrinker *shrink,
 114                                        struct shrink_control *sc)
 115 {
 116         struct super_block *sb;
 117         long    total_objects = 0;
 118
 119         sb = container_of(shrink, struct super_block, s_shrink);
 120
 121         /*
 122          * Don't call trylock_super as it is a potential
 123          * scalability bottleneck. The counts could get updated
 124          * between super_cache_count and super_cache_scan anyway.
 125          * Call to super_cache_count with shrinker_rwsem held
 126          * ensures the safety of call to list_lru_shrink_count() and
 127          * s_op->nr_cached_objects().
 128          */
 129         if (sb->s_op && sb->s_op->nr_cached_objects)
 130                 total_objects = sb->s_op->nr_cached_objects(sb, sc);
 131
 132         total_objects += list_lru_shrink_count(&sb->s_dentry_lru, sc);
 133         total_objects += list_lru_shrink_count(&sb->s_inode_lru, sc);
 134
 135         total_objects = vfs_pressure_ratio(total_objects);
 136         return total_objects;
 137 }
 138
 139 static void destroy_super_work(struct work_struct *work)
 140 {
 141         struct super_block *s = container_of(work, struct super_block,
 142                                                         destroy_work);
 143         int i;
 144
 145         for (i = 0; i < SB_FREEZE_LEVELS; i++)
 146                 percpu_free_rwsem(&s->s_writers.rw_sem[i]);
 147         kfree(s);
 148 }
 149
 150 static void destroy_super_rcu(struct rcu_head *head)
 151 {
 152         struct super_block *s = container_of(head, struct super_block, rcu);
 153         INIT_WORK(&s->destroy_work, destroy_super_work);
 154         schedule_work(&s->destroy_work);
 155 }
 156
 157 /**
 158  *      destroy_super   -       frees a superblock
 159  *      @s: superblock to free
 160  *
 161  *      Frees a superblock.
 162  */
 163 static void destroy_super(struct super_block *s)
 164 {
 165         list_lru_destroy(&s->s_dentry_lru);
 166         list_lru_destroy(&s->s_inode_lru);
 167         security_sb_free(s);
 168         WARN_ON(!list_empty(&s->s_mounts));
 169         put_user_ns(s->s_user_ns);
 170         kfree(s->s_subtype);
 171         kfree(s->s_options);
 172         call_rcu(&s->rcu, destroy_super_rcu);
 173 }
 174
 175 /**
 176  *      alloc_super     -       create new superblock
 177  *      @type:  filesystem type superblock should belong to
 178  *      @flags: the mount flags
 179  *      @user_ns: User namespace for the super_block
 180  *
 181  *      Allocates and initializes a new &struct super_block.  alloc_super()
 182  *      returns a pointer new superblock or %NULL if allocation had failed.
 183  */
 184 static struct super_block *alloc_super(struct file_system_type *type, int flags,
 185                                        struct user_namespace *user_ns)
 186 {
 187         struct super_block *s = kzalloc(sizeof(struct super_block),  GFP_USER);
 188         static const struct super_operations default_op;
 189         int i;
 190
 191         if (!s)
 192                 return NULL;
 193
 194         INIT_LIST_HEAD(&s->s_mounts);
 195         s->s_user_ns = get_user_ns(user_ns);
 196
 197         if (security_sb_alloc(s))
 198                 goto fail;
 199
 200         for (i = 0; i < SB_FREEZE_LEVELS; i++) {
 201                 if (__percpu_init_rwsem(&s->s_writers.rw_sem[i],
 202                                         sb_writers_name[i],
 203                                         &type->s_writers_key[i]))
 204                         goto fail;
 205         }
 206         init_waitqueue_head(&s->s_writers.wait_unfrozen);
 207         s->s_bdi = &noop_backing_dev_info;
 208         s->s_flags = flags;
 209         if (s->s_user_ns != &init_user_ns)
 210                 s->s_iflags |= SB_I_NODEV;
 211         INIT_HLIST_NODE(&s->s_instances);
 212         INIT_HLIST_BL_HEAD(&s->s_anon);
 213         mutex_init(&s->s_sync_lock);
 214         INIT_LIST_HEAD(&s->s_inodes);
 215         spin_lock_init(&s->s_inode_list_lock);
 216         INIT_LIST_HEAD(&s->s_inodes_wb);
 217         spin_lock_init(&s->s_inode_wblist_lock);
 218
 219         if (list_lru_init_memcg(&s->s_dentry_lru))
 220                 goto fail;
 221         if (list_lru_init_memcg(&s->s_inode_lru))
 222                 goto fail;
 223
 224         init_rwsem(&s->s_umount);
 225         lockdep_set_class(&s->s_umount, &type->s_umount_key);
 226         /*
 227          * sget() can have s_umount recursion.
 228          *
 229          * When it cannot find a suitable sb, it allocates a new
 230          * one (this one), and tries again to find a suitable old
 231          * one.
 232          *
 233          * In case that succeeds, it will acquire the s_umount
 234          * lock of the old one. Since these are clearly distrinct
 235          * locks, and this object isn't exposed yet, there's no
 236          * risk of deadlocks.
 237          *
 238          * Annotate this by putting this lock in a different
 239          * subclass.
 240          */
 241         down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
 242         s->s_count = 1;
 243         atomic_set(&s->s_active, 1);
 244         mutex_init(&s->s_vfs_rename_mutex);
 245         lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
 246         mutex_init(&s->s_dquot.dqio_mutex);
 247         mutex_init(&s->s_dquot.dqonoff_mutex);
 248         s->s_maxbytes = MAX_NON_LFS;
 249         s->s_op = &default_op;
 250         s->s_time_gran = 1000000000;
 251         s->cleancache_poolid = CLEANCACHE_NO_POOL;
 252
 253         s->s_shrink.seeks = DEFAULT_SEEKS;
 254         s->s_shrink.scan_objects = super_cache_scan;
 255         s->s_shrink.count_objects = super_cache_count;
 256         s->s_shrink.batch = 1024;
 257         s->s_shrink.flags = SHRINKER_NUMA_AWARE | SHRINKER_MEMCG_AWARE;
 258         return s;
 259
 260 fail:
 261         destroy_super(s);
 262         return NULL;
 263 }
 264
 265 /* Superblock refcounting  */
 266
 267 /*
 268  * Drop a superblock's refcount.  The caller must hold sb_lock.
 269  */
 270 static void __put_super(struct super_block *sb)
 271 {
 272         if (!--sb->s_count) {
 273                 list_del_init(&sb->s_list);
 274                 destroy_super(sb);
 275         }
 276 }
 277
 278 /**
 279  *      put_super       -       drop a temporary reference to superblock
 280  *      @sb: superblock in question
 281  *
 282  *      Drops a temporary reference, frees superblock if there's no
 283  *      references left.
 284  */
 285 static void put_super(struct super_block *sb)
 286 {
 287         spin_lock(&sb_lock);
 288         __put_super(sb);
 289         spin_unlock(&sb_lock);
 290 }
 291
 292
 293 /**
 294  *      deactivate_locked_super -       drop an active reference to superblock
 295  *      @s: superblock to deactivate
 296  *
 297  *      Drops an active reference to superblock, converting it into a temporary
 298  *      one if there is no other active references left.  In that case we
 299  *      tell fs driver to shut it down and drop the temporary reference we
 300  *      had just acquired.
 301  *
 302  *      Caller holds exclusive lock on superblock; that lock is released.
 303  */
 304 void deactivate_locked_super(struct super_block *s)
 305 {
 306         struct file_system_type *fs = s->s_type;
 307         if (atomic_dec_and_test(&s->s_active)) {
 308                 cleancache_invalidate_fs(s);
 309                 unregister_shrinker(&s->s_shrink);
 310                 fs->kill_sb(s);
 311
 312                 /*
 313                  * Since list_lru_destroy() may sleep, we cannot call it from
 314                  * put_super(), where we hold the sb_lock. Therefore we destroy
 315                  * the lru lists right now.
 316                  */
 317                 list_lru_destroy(&s->s_dentry_lru);
 318                 list_lru_destroy(&s->s_inode_lru);
 319
 320                 put_filesystem(fs);
 321                 put_super(s);
 322         } else {
 323                 up_write(&s->s_umount);
 324         }
 325 }
 326
 327 EXPORT_SYMBOL(deactivate_locked_super);
 328
 329 /**
 330  *      deactivate_super        -       drop an active reference to superblock
 331  *      @s: superblock to deactivate
 332  *
 333  *      Variant of deactivate_locked_super(), except that superblock is *not*
 334  *      locked by caller.  If we are going to drop the final active reference,
 335  *      lock will be acquired prior to that.
 336  */
 337 void deactivate_super(struct super_block *s)
 338 {
 339         if (!atomic_add_unless(&s->s_active, -1, 1)) {
 340                 down_write(&s->s_umount);
 341                 deactivate_locked_super(s);
 342         }
 343 }
 344
 345 EXPORT_SYMBOL(deactivate_super);
 346
 347 /**
 348  *      grab_super - acquire an active reference
 349  *      @s: reference we are trying to make active
 350  *
 351  *      Tries to acquire an active reference.  grab_super() is used when we
 352  *      had just found a superblock in super_blocks or fs_type->fs_supers
 353  *      and want to turn it into a full-blown active reference.  grab_super()
 354  *      is called with sb_lock held and drops it.  Returns 1 in case of
 355  *      success, 0 if we had failed (superblock contents was already dead or
 356  *      dying when grab_super() had been called).  Note that this is only
 357  *      called for superblocks not in rundown mode (== ones still on ->fs_supers
 358  *      of their type), so increment of ->s_count is OK here.
 359  */
 360 static int grab_super(struct super_block *s) __releases(sb_lock)
 361 {
 362         s->s_count++;
 363         spin_unlock(&sb_lock);
 364         down_write(&s->s_umount);
 365         if ((s->s_flags & MS_BORN) && atomic_inc_not_zero(&s->s_active)) {
 366                 put_super(s);
 367                 return 1;
 368         }
 369         up_write(&s->s_umount);
 370         put_super(s);
 371         return 0;
 372 }
 373
 374 /*
 375  *      trylock_super - try to grab ->s_umount shared
 376  *      @sb: reference we are trying to grab
 377  *
 378  *      Try to prevent fs shutdown.  This is used in places where we
 379  *      cannot take an active reference but we need to ensure that the
 380  *      filesystem is not shut down while we are working on it. It returns
 381  *      false if we cannot acquire s_umount or if we lose the race and
 382  *      filesystem already got into shutdown, and returns true with the s_umount
 383  *      lock held in read mode in case of success. On successful return,
 384  *      the caller must drop the s_umount lock when done.
 385  *
 386  *      Note that unlike get_super() et.al. this one does *not* bump ->s_count.
 387  *      The reason why it's safe is that we are OK with doing trylock instead
 388  *      of down_read().  There's a couple of places that are OK with that, but
 389  *      it's very much not a general-purpose interface.
 390  */
 391 bool trylock_super(struct super_block *sb)
 392 {
 393         if (down_read_trylock(&sb->s_umount)) {
 394                 if (!hlist_unhashed(&sb->s_instances) &&
 395                     sb->s_root && (sb->s_flags & MS_BORN))
 396                         return true;
 397                 up_read(&sb->s_umount);
 398         }
 399
 400         return false;
 401 }
 402
 403 /**
 404  *      generic_shutdown_super  -       common helper for ->kill_sb()
 405  *      @sb: superblock to kill
 406  *
 407  *      generic_shutdown_super() does all fs-independent work on superblock
 408  *      shutdown.  Typical ->kill_sb() should pick all fs-specific objects
 409  *      that need destruction out of superblock, call generic_shutdown_super()
 410  *      and release aforementioned objects.  Note: dentries and inodes _are_
 411  *      taken care of and do not need specific handling.
 412  *
 413  *      Upon calling this function, the filesystem may no longer alter or
 414  *      rearrange the set of dentries belonging to this super_block, nor may it
 415  *      change the attachments of dentries to inodes.
 416  */
 417 void generic_shutdown_super(struct super_block *sb)
 418 {
 419         const struct super_operations *sop = sb->s_op;
 420
 421         if (sb->s_root) {
 422                 shrink_dcache_for_umount(sb);
 423                 sync_filesystem(sb);
 424                 sb->s_flags &= ~MS_ACTIVE;
 425
 426                 fsnotify_unmount_inodes(sb);
 427                 cgroup_writeback_umount();
 428
 429                 evict_inodes(sb);
 430
 431                 if (sb->s_dio_done_wq) {
 432                         destroy_workqueue(sb->s_dio_done_wq);
 433                         sb->s_dio_done_wq = NULL;
 434                 }
 435
 436                 if (sop->put_super)
 437                         sop->put_super(sb);
 438
 439                 if (!list_empty(&sb->s_inodes)) {
 440                         printk("VFS: Busy inodes after unmount of %s. "
 441                            "Self-destruct in 5 seconds.  Have a nice day...\n",
 442                            sb->s_id);
 443                 }
 444         }
 445         spin_lock(&sb_lock);
 446         /* should be initialized for __put_super_and_need_restart() */
 447         hlist_del_init(&sb->s_instances);
 448         spin_unlock(&sb_lock);
 449         up_write(&sb->s_umount);
 450 }
 451
 452 EXPORT_SYMBOL(generic_shutdown_super);
 453
 454 /**
 455  *      sget_userns -   find or create a superblock
 456  *      @type:  filesystem type superblock should belong to
 457  *      @test:  comparison callback
 458  *      @set:   setup callback
 459  *      @flags: mount flags
 460  *      @user_ns: User namespace for the super_block
 461  *      @data:  argument to each of them
 462  */
 463 struct super_block *sget_userns(struct file_system_type *type,
 464                         int (*test)(struct super_block *,void *),
 465                         int (*set)(struct super_block *,void *),
 466                         int flags, struct user_namespace *user_ns,
 467                         void *data)
 468 {
 469         struct super_block *s = NULL;
 470         struct super_block *old;
 471         int err;
 472
 473         if (!(flags & MS_KERNMOUNT) &&
 474             !(type->fs_flags & FS_USERNS_MOUNT) &&
 475             !capable(CAP_SYS_ADMIN))
 476                 return ERR_PTR(-EPERM);
 477 retry:
 478         spin_lock(&sb_lock);
 479         if (test) {
 480                 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
 481                         if (!test(old, data))
 482                                 continue;
 483                         if (user_ns != old->s_user_ns) {
 484                                 spin_unlock(&sb_lock);
 485                                 if (s) {
 486                                         up_write(&s->s_umount);
 487                                         destroy_super(s);
 488                                 }
 489                                 return ERR_PTR(-EBUSY);
 490                         }
 491                         if (!grab_super(old))
 492                                 goto retry;
 493                         if (s) {
 494                                 up_write(&s->s_umount);
 495                                 destroy_super(s);
 496                                 s = NULL;
 497                         }
 498                         return old;
 499                 }
 500         }
 501         if (!s) {
 502                 spin_unlock(&sb_lock);
 503                 s = alloc_super(type, flags, user_ns);
 504                 if (!s)
 505                         return ERR_PTR(-ENOMEM);
 506                 goto retry;
 507         }
 508
 509         err = set(s, data);
 510         if (err) {
 511                 spin_unlock(&sb_lock);
 512                 up_write(&s->s_umount);
 513                 destroy_super(s);
 514                 return ERR_PTR(err);
 515         }
 516         s->s_type = type;
 517         strlcpy(s->s_id, type->name, sizeof(s->s_id));
 518         list_add_tail(&s->s_list, &super_blocks);
 519         hlist_add_head(&s->s_instances, &type->fs_supers);
 520         spin_unlock(&sb_lock);
 521         get_filesystem(type);
 522         register_shrinker(&s->s_shrink);
 523         return s;
 524 }
 525
 526 EXPORT_SYMBOL(sget_userns);
 527
 528 /**
 529  *      sget    -       find or create a superblock
 530  *      @type:    filesystem type superblock should belong to
 531  *      @test:    comparison callback
 532  *      @set:     setup callback
 533  *      @flags:   mount flags
 534  *      @data:    argument to each of them
 535  */
 536 struct super_block *sget(struct file_system_type *type,
 537                         int (*test)(struct super_block *,void *),
 538                         int (*set)(struct super_block *,void *),
 539                         int flags,
 540                         void *data)
 541 {
 542         struct user_namespace *user_ns = current_user_ns();
 543
 544         /* Ensure the requestor has permissions over the target filesystem */
 545         if (!(flags & MS_KERNMOUNT) && !ns_capable(user_ns, CAP_SYS_ADMIN))
 546                 return ERR_PTR(-EPERM);
 547
 548         return sget_userns(type, test, set, flags, user_ns, data);
 549 }
 550
 551 EXPORT_SYMBOL(sget);
 552
 553 void drop_super(struct super_block *sb)
 554 {
 555         up_read(&sb->s_umount);
 556         put_super(sb);
 557 }
 558
 559 EXPORT_SYMBOL(drop_super);
 560
 561 void drop_super_exclusive(struct super_block *sb)
 562 {
 563         up_write(&sb->s_umount);
 564         put_super(sb);
 565 }
 566 EXPORT_SYMBOL(drop_super_exclusive);
 567
 568 /**
 569  *      iterate_supers - call function for all active superblocks
 570  *      @f: function to call
 571  *      @arg: argument to pass to it
 572  *
 573  *      Scans the superblock list and calls given function, passing it
 574  *      locked superblock and given argument.
 575  */
 576 void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
 577 {
 578         struct super_block *sb, *p = NULL;
 579
 580         spin_lock(&sb_lock);
 581         list_for_each_entry(sb, &super_blocks, s_list) {
 582                 if (hlist_unhashed(&sb->s_instances))
 583                         continue;
 584                 sb->s_count++;
 585                 spin_unlock(&sb_lock);
 586
 587                 down_read(&sb->s_umount);
 588                 if (sb->s_root && (sb->s_flags & MS_BORN))
 589                         f(sb, arg);
 590                 up_read(&sb->s_umount);
 591
 592                 spin_lock(&sb_lock);
 593                 if (p)
 594                         __put_super(p);
 595                 p = sb;
 596         }
 597         if (p)
 598                 __put_super(p);
 599         spin_unlock(&sb_lock);
 600 }
 601
 602 /**
 603  *      iterate_supers_type - call function for superblocks of given type
 604  *      @type: fs type
 605  *      @f: function to call
 606  *      @arg: argument to pass to it
 607  *
 608  *      Scans the superblock list and calls given function, passing it
 609  *      locked superblock and given argument.
 610  */
 611 void iterate_supers_type(struct file_system_type *type,
 612         void (*f)(struct super_block *, void *), void *arg)
 613 {
 614         struct super_block *sb, *p = NULL;
 615
 616         spin_lock(&sb_lock);
 617         hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
 618                 sb->s_count++;
 619                 spin_unlock(&sb_lock);
 620
 621                 down_read(&sb->s_umount);
 622                 if (sb->s_root && (sb->s_flags & MS_BORN))
 623                         f(sb, arg);
 624                 up_read(&sb->s_umount);
 625
 626                 spin_lock(&sb_lock);
 627                 if (p)
 628                         __put_super(p);
 629                 p = sb;
 630         }
 631         if (p)
 632                 __put_super(p);
 633         spin_unlock(&sb_lock);
 634 }
 635
 636 EXPORT_SYMBOL(iterate_supers_type);
 637
 638 static struct super_block *__get_super(struct block_device *bdev, bool excl)
 639 {
 640         struct super_block *sb;
 641
 642         if (!bdev)
 643                 return NULL;
 644
 645         spin_lock(&sb_lock);
 646 rescan:
 647         list_for_each_entry(sb, &super_blocks, s_list) {
 648                 if (hlist_unhashed(&sb->s_instances))
 649                         continue;
 650                 if (sb->s_bdev == bdev) {
 651                         sb->s_count++;
 652                         spin_unlock(&sb_lock);
 653                         if (!excl)
 654                                 down_read(&sb->s_umount);
 655                         else
 656                                 down_write(&sb->s_umount);
 657                         /* still alive? */
 658                         if (sb->s_root && (sb->s_flags & MS_BORN))
 659                                 return sb;
 660                         if (!excl)
 661                                 up_read(&sb->s_umount);
 662                         else
 663                                 up_write(&sb->s_umount);
 664                         /* nope, got unmounted */
 665                         spin_lock(&sb_lock);
 666                         __put_super(sb);
 667                         goto rescan;
 668                 }
 669         }
 670         spin_unlock(&sb_lock);
 671         return NULL;
 672 }
 673
 674 /**
 675  *      get_super - get the superblock of a device
 676  *      @bdev: device to get the superblock for
 677  *
 678  *      Scans the superblock list and finds the superblock of the file system
 679  *      mounted on the device given. %NULL is returned if no match is found.
 680  */
 681 struct super_block *get_super(struct block_device *bdev)
 682 {
 683         return __get_super(bdev, false);
 684 }
 685 EXPORT_SYMBOL(get_super);
 686
 687 static struct super_block *__get_super_thawed(struct block_device *bdev,
 688                                               bool excl)
 689 {
 690         while (1) {
 691                 struct super_block *s = __get_super(bdev, excl);
 692                 if (!s || s->s_writers.frozen == SB_UNFROZEN)
 693                         return s;
 694                 if (!excl)
 695                         up_read(&s->s_umount);
 696                 else
 697                         up_write(&s->s_umount);
 698                 wait_event(s->s_writers.wait_unfrozen,
 699                            s->s_writers.frozen == SB_UNFROZEN);
 700                 put_super(s);
 701         }
 702 }
 703
 704 /**
 705  *      get_super_thawed - get thawed superblock of a device
 706  *      @bdev: device to get the superblock for
 707  *
 708  *      Scans the superblock list and finds the superblock of the file system
 709  *      mounted on the device. The superblock is returned once it is thawed
 710  *      (or immediately if it was not frozen). %NULL is returned if no match
 711  *      is found.
 712  */
 713 struct super_block *get_super_thawed(struct block_device *bdev)
 714 {
 715         return __get_super_thawed(bdev, false);
 716 }
 717 EXPORT_SYMBOL(get_super_thawed);
 718
 719 /**
 720  *      get_super_exclusive_thawed - get thawed superblock of a device
 721  *      @bdev: device to get the superblock for
 722  *
 723  *      Scans the superblock list and finds the superblock of the file system
 724  *      mounted on the device. The superblock is returned once it is thawed
 725  *      (or immediately if it was not frozen) and s_umount semaphore is held
 726  *      in exclusive mode. %NULL is returned if no match is found.
 727  */
 728 struct super_block *get_super_exclusive_thawed(struct block_device *bdev)
 729 {
 730         return __get_super_thawed(bdev, true);
 731 }
 732 EXPORT_SYMBOL(get_super_exclusive_thawed);
 733
 734 /**
 735  * get_active_super - get an active reference to the superblock of a device
 736  * @bdev: device to get the superblock for
 737  *
 738  * Scans the superblock list and finds the superblock of the file system
 739  * mounted on the device given.  Returns the superblock with an active
 740  * reference or %NULL if none was found.
 741  */
 742 struct super_block *get_active_super(struct block_device *bdev)
 743 {
 744         struct super_block *sb;
 745
 746         if (!bdev)
 747                 return NULL;
 748
 749 restart:
 750         spin_lock(&sb_lock);
 751         list_for_each_entry(sb, &super_blocks, s_list) {
 752                 if (hlist_unhashed(&sb->s_instances))
 753                         continue;
 754                 if (sb->s_bdev == bdev) {
 755                         if (!grab_super(sb))
 756                                 goto restart;
 757                         up_write(&sb->s_umount);
 758                         return sb;
 759                 }
 760         }
 761         spin_unlock(&sb_lock);
 762         return NULL;
 763 }
 764
 765 struct super_block *user_get_super(dev_t dev)
 766 {
 767         struct super_block *sb;
 768
 769         spin_lock(&sb_lock);
 770 rescan:
 771         list_for_each_entry(sb, &super_blocks, s_list) {
 772                 if (hlist_unhashed(&sb->s_instances))
 773                         continue;
 774                 if (sb->s_dev ==  dev) {
 775                         sb->s_count++;
 776                         spin_unlock(&sb_lock);
 777                         down_read(&sb->s_umount);
 778                         /* still alive? */
 779                         if (sb->s_root && (sb->s_flags & MS_BORN))
 780                                 return sb;
 781                         up_read(&sb->s_umount);
 782                         /* nope, got unmounted */
 783                         spin_lock(&sb_lock);
 784                         __put_super(sb);
 785                         goto rescan;
 786                 }
 787         }
 788         spin_unlock(&sb_lock);
 789         return NULL;
 790 }
 791
 792 /**
 793  *      do_remount_sb - asks filesystem to change mount options.
 794  *      @sb:    superblock in question
 795  *      @flags: numeric part of options
 796  *      @data:  the rest of options
 797  *      @force: whether or not to force the change
 798  *
 799  *      Alters the mount options of a mounted file system.
 800  */
 801 int do_remount_sb(struct super_block *sb, int flags, void *data, int force)
 802 {
 803         int retval;
 804         int remount_ro;
 805
 806         if (sb->s_writers.frozen != SB_UNFROZEN)
 807                 return -EBUSY;
 808
 809 #ifdef CONFIG_BLOCK
 810         if (!(flags & MS_RDONLY) && bdev_read_only(sb->s_bdev))
 811                 return -EACCES;
 812 #endif
 813
 814         remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
 815
 816         if (remount_ro) {
 817                 if (!hlist_empty(&sb->s_pins)) {
 818                         up_write(&sb->s_umount);
 819                         group_pin_kill(&sb->s_pins);
 820                         down_write(&sb->s_umount);
 821                         if (!sb->s_root)
 822                                 return 0;
 823                         if (sb->s_writers.frozen != SB_UNFROZEN)
 824                                 return -EBUSY;
 825                         remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
 826                 }
 827         }
 828         shrink_dcache_sb(sb);
 829
 830         /* If we are remounting RDONLY and current sb is read/write,
 831            make sure there are no rw files opened */
 832         if (remount_ro) {
 833                 if (force) {
 834                         sb->s_readonly_remount = 1;
 835                         smp_wmb();
 836                 } else {
 837                         retval = sb_prepare_remount_readonly(sb);
 838                         if (retval)
 839                                 return retval;
 840                 }
 841         }
 842
 843         if (sb->s_op->remount_fs) {
 844                 retval = sb->s_op->remount_fs(sb, &flags, data);
 845                 if (retval) {
 846                         if (!force)
 847                                 goto cancel_readonly;
 848                         /* If forced remount, go ahead despite any errors */
 849                         WARN(1, "forced remount of a %s fs returned %i\n",
 850                              sb->s_type->name, retval);
 851                 }
 852         }
 853         sb->s_flags = (sb->s_flags & ~MS_RMT_MASK) | (flags & MS_RMT_MASK);
 854         /* Needs to be ordered wrt mnt_is_readonly() */
 855         smp_wmb();
 856         sb->s_readonly_remount = 0;
 857
 858         /*
 859          * Some filesystems modify their metadata via some other path than the
 860          * bdev buffer cache (eg. use a private mapping, or directories in
 861          * pagecache, etc). Also file data modifications go via their own
 862          * mappings. So If we try to mount readonly then copy the filesystem
 863          * from bdev, we could get stale data, so invalidate it to give a best
 864          * effort at coherency.
 865          */
 866         if (remount_ro && sb->s_bdev)
 867                 invalidate_bdev(sb->s_bdev);
 868         return 0;
 869
 870 cancel_readonly:
 871         sb->s_readonly_remount = 0;
 872         return retval;
 873 }
 874
 875 static void do_emergency_remount(struct work_struct *work)
 876 {
 877         struct super_block *sb, *p = NULL;
 878
 879         spin_lock(&sb_lock);
 880         list_for_each_entry(sb, &super_blocks, s_list) {
 881                 if (hlist_unhashed(&sb->s_instances))
 882                         continue;
 883                 sb->s_count++;
 884                 spin_unlock(&sb_lock);
 885                 down_write(&sb->s_umount);
 886                 if (sb->s_root && sb->s_bdev && (sb->s_flags & MS_BORN) &&
 887                     !(sb->s_flags & MS_RDONLY)) {
 888                         /*
 889                          * What lock protects sb->s_flags??
 890                          */
 891                         do_remount_sb(sb, MS_RDONLY, NULL, 1);
 892                 }
 893                 up_write(&sb->s_umount);
 894                 spin_lock(&sb_lock);
 895                 if (p)
 896                         __put_super(p);
 897                 p = sb;
 898         }
 899         if (p)
 900                 __put_super(p);
 901         spin_unlock(&sb_lock);
 902         kfree(work);
 903         printk("Emergency Remount complete\n");
 904 }
 905
 906 void emergency_remount(void)
 907 {
 908         struct work_struct *work;
 909
 910         work = kmalloc(sizeof(*work), GFP_ATOMIC);
 911         if (work) {
 912                 INIT_WORK(work, do_emergency_remount);
 913                 schedule_work(work);
 914         }
 915 }
 916
 917 /*
 918  * Unnamed block devices are dummy devices used by virtual
 919  * filesystems which don't use real block-devices.  -- jrs
 920  */
 921
 922 static DEFINE_IDA(unnamed_dev_ida);
 923 static DEFINE_SPINLOCK(unnamed_dev_lock);/* protects the above */
 924 /* Many userspace utilities consider an FSID of 0 invalid.
 925  * Always return at least 1 from get_anon_bdev.
 926  */
 927 static int unnamed_dev_start = 1;
 928
 929 int get_anon_bdev(dev_t *p)
 930 {
 931         int dev;
 932         int error;
 933
 934  retry:
 935         if (ida_pre_get(&unnamed_dev_ida, GFP_ATOMIC) == 0)
 936                 return -ENOMEM;
 937         spin_lock(&unnamed_dev_lock);
 938         error = ida_get_new_above(&unnamed_dev_ida, unnamed_dev_start, &dev);
 939         if (!error)
 940                 unnamed_dev_start = dev + 1;
 941         spin_unlock(&unnamed_dev_lock);
 942         if (error == -EAGAIN)
 943                 /* We raced and lost with another CPU. */
 944                 goto retry;
 945         else if (error)
 946                 return -EAGAIN;
 947
 948         if (dev >= (1 << MINORBITS)) {
 949                 spin_lock(&unnamed_dev_lock);
 950                 ida_remove(&unnamed_dev_ida, dev);
 951                 if (unnamed_dev_start > dev)
 952                         unnamed_dev_start = dev;
 953                 spin_unlock(&unnamed_dev_lock);
 954                 return -EMFILE;
 955         }
 956         *p = MKDEV(0, dev & MINORMASK);
 957         return 0;
 958 }
 959 EXPORT_SYMBOL(get_anon_bdev);
 960
 961 void free_anon_bdev(dev_t dev)
 962 {
 963         int slot = MINOR(dev);
 964         spin_lock(&unnamed_dev_lock);
 965         ida_remove(&unnamed_dev_ida, slot);
 966         if (slot < unnamed_dev_start)
 967                 unnamed_dev_start = slot;
 968         spin_unlock(&unnamed_dev_lock);
 969 }
 970 EXPORT_SYMBOL(free_anon_bdev);
 971
 972 int set_anon_super(struct super_block *s, void *data)
 973 {
 974         return get_anon_bdev(&s->s_dev);
 975 }
 976
 977 EXPORT_SYMBOL(set_anon_super);
 978
 979 void kill_anon_super(struct super_block *sb)
 980 {
 981         dev_t dev = sb->s_dev;
 982         generic_shutdown_super(sb);
 983         free_anon_bdev(dev);
 984 }
 985
 986 EXPORT_SYMBOL(kill_anon_super);
 987
 988 void kill_litter_super(struct super_block *sb)
 989 {
 990         if (sb->s_root)
 991                 d_genocide(sb->s_root);
 992         kill_anon_super(sb);
 993 }
 994
 995 EXPORT_SYMBOL(kill_litter_super);
 996
 997 static int ns_test_super(struct super_block *sb, void *data)
 998 {
 999         return sb->s_fs_info == data;
1000 }
1001
1002 static int ns_set_super(struct super_block *sb, void *data)
1003 {
1004         sb->s_fs_info = data;
1005         return set_anon_super(sb, NULL);
1006 }
1007
1008 struct dentry *mount_ns(struct file_system_type *fs_type,
1009         int flags, void *data, void *ns, struct user_namespace *user_ns,
1010         int (*fill_super)(struct super_block *, void *, int))
1011 {
1012         struct super_block *sb;
1013
1014         /* Don't allow mounting unless the caller has CAP_SYS_ADMIN
1015          * over the namespace.
1016          */
1017         if (!(flags & MS_KERNMOUNT) && !ns_capable(user_ns, CAP_SYS_ADMIN))
1018                 return ERR_PTR(-EPERM);
1019
1020         sb = sget_userns(fs_type, ns_test_super, ns_set_super, flags,
1021                          user_ns, ns);
1022         if (IS_ERR(sb))
1023                 return ERR_CAST(sb);
1024
1025         if (!sb->s_root) {
1026                 int err;
1027                 err = fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
1028                 if (err) {
1029                         deactivate_locked_super(sb);
1030                         return ERR_PTR(err);
1031                 }
1032
1033                 sb->s_flags |= MS_ACTIVE;
1034         }
1035
1036         return dget(sb->s_root);
1037 }
1038
1039 EXPORT_SYMBOL(mount_ns);
1040
1041 #ifdef CONFIG_BLOCK
1042 static int set_bdev_super(struct super_block *s, void *data)
1043 {
1044         s->s_bdev = data;
1045         s->s_dev = s->s_bdev->bd_dev;
1046
1047         /*
1048          * We set the bdi here to the queue backing, file systems can
1049          * overwrite this in ->fill_super()
1050          */
1051         s->s_bdi = &bdev_get_queue(s->s_bdev)->backing_dev_info;
1052         return 0;
1053 }
1054
1055 static int test_bdev_super(struct super_block *s, void *data)
1056 {
1057         return (void *)s->s_bdev == data;
1058 }
1059
1060 struct dentry *mount_bdev(struct file_system_type *fs_type,
1061         int flags, const char *dev_name, void *data,
1062         int (*fill_super)(struct super_block *, void *, int))
1063 {
1064         struct block_device *bdev;
1065         struct super_block *s;
1066         fmode_t mode = FMODE_READ | FMODE_EXCL;
1067         int error = 0;
1068
1069         if (!(flags & MS_RDONLY))
1070                 mode |= FMODE_WRITE;
1071
1072         bdev = blkdev_get_by_path(dev_name, mode, fs_type);
1073         if (IS_ERR(bdev))
1074                 return ERR_CAST(bdev);
1075
1076         /*
1077          * once the super is inserted into the list by sget, s_umount
1078          * will protect the lockfs code from trying to start a snapshot
1079          * while we are mounting
1080          */
1081         mutex_lock(&bdev->bd_fsfreeze_mutex);
1082         if (bdev->bd_fsfreeze_count > 0) {
1083                 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1084                 error = -EBUSY;
1085                 goto error_bdev;
1086         }
1087         s = sget(fs_type, test_bdev_super, set_bdev_super, flags | MS_NOSEC,
1088                  bdev);
1089         mutex_unlock(&bdev->bd_fsfreeze_mutex);
1090         if (IS_ERR(s))
1091                 goto error_s;
1092
1093         if (s->s_root) {
1094                 if ((flags ^ s->s_flags) & MS_RDONLY) {
1095                         deactivate_locked_super(s);
1096                         error = -EBUSY;
1097                         goto error_bdev;
1098                 }
1099
1100                 /*
1101                  * s_umount nests inside bd_mutex during
1102                  * __invalidate_device().  blkdev_put() acquires
1103                  * bd_mutex and can't be called under s_umount.  Drop
1104                  * s_umount temporarily.  This is safe as we're
1105                  * holding an active reference.
1106                  */
1107                 up_write(&s->s_umount);
1108                 blkdev_put(bdev, mode);
1109                 down_write(&s->s_umount);
1110         } else {
1111                 s->s_mode = mode;
1112                 snprintf(s->s_id, sizeof(s->s_id), "%pg", bdev);
1113                 sb_set_blocksize(s, block_size(bdev));
1114                 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
1115                 if (error) {
1116                         deactivate_locked_super(s);
1117                         goto error;
1118                 }
1119
1120                 s->s_flags |= MS_ACTIVE;
1121                 bdev->bd_super = s;
1122         }
1123
1124         return dget(s->s_root);
1125
1126 error_s:
1127         error = PTR_ERR(s);
1128 error_bdev:
1129         blkdev_put(bdev, mode);
1130 error:
1131         return ERR_PTR(error);
1132 }
1133 EXPORT_SYMBOL(mount_bdev);
1134
1135 void kill_block_super(struct super_block *sb)
1136 {
1137         struct block_device *bdev = sb->s_bdev;
1138         fmode_t mode = sb->s_mode;
1139
1140         bdev->bd_super = NULL;
1141         generic_shutdown_super(sb);
1142         sync_blockdev(bdev);
1143         WARN_ON_ONCE(!(mode & FMODE_EXCL));
1144         blkdev_put(bdev, mode | FMODE_EXCL);
1145 }
1146
1147 EXPORT_SYMBOL(kill_block_super);
1148 #endif
1149
1150 struct dentry *mount_nodev(struct file_system_type *fs_type,
1151         int flags, void *data,
1152         int (*fill_super)(struct super_block *, void *, int))
1153 {
1154         int error;
1155         struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
1156
1157         if (IS_ERR(s))
1158                 return ERR_CAST(s);
1159
1160         error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
1161         if (error) {
1162                 deactivate_locked_super(s);
1163                 return ERR_PTR(error);
1164         }
1165         s->s_flags |= MS_ACTIVE;
1166         return dget(s->s_root);
1167 }
1168 EXPORT_SYMBOL(mount_nodev);
1169
1170 static int compare_single(struct super_block *s, void *p)
1171 {
1172         return 1;
1173 }
1174
1175 struct dentry *mount_single(struct file_system_type *fs_type,
1176         int flags, void *data,
1177         int (*fill_super)(struct super_block *, void *, int))
1178 {
1179         struct super_block *s;
1180         int error;
1181
1182         s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
1183         if (IS_ERR(s))
1184                 return ERR_CAST(s);
1185         if (!s->s_root) {
1186                 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
1187                 if (error) {
1188                         deactivate_locked_super(s);
1189                         return ERR_PTR(error);
1190                 }
1191                 s->s_flags |= MS_ACTIVE;
1192         } else {
1193                 do_remount_sb(s, flags, data, 0);
1194         }
1195         return dget(s->s_root);
1196 }
1197 EXPORT_SYMBOL(mount_single);
1198
1199 struct dentry *
1200 mount_fs(struct file_system_type *type, int flags, const char *name, void *data)
1201 {
1202         struct dentry *root;
1203         struct super_block *sb;
1204         char *secdata = NULL;
1205         int error = -ENOMEM;
1206
1207         if (data && !(type->fs_flags & FS_BINARY_MOUNTDATA)) {
1208                 secdata = alloc_secdata();
1209                 if (!secdata)
1210                         goto out;
1211
1212                 error = security_sb_copy_data(data, secdata);
1213                 if (error)
1214                         goto out_free_secdata;
1215         }
1216
1217         root = type->mount(type, flags, name, data);
1218         if (IS_ERR(root)) {
1219                 error = PTR_ERR(root);
1220                 goto out_free_secdata;
1221         }
1222         sb = root->d_sb;
1223         BUG_ON(!sb);
1224         WARN_ON(!sb->s_bdi);
1225         sb->s_flags |= MS_BORN;
1226
1227         error = security_sb_kern_mount(sb, flags, secdata);
1228         if (error)
1229                 goto out_sb;
1230
1231         /*
1232          * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1233          * but s_maxbytes was an unsigned long long for many releases. Throw
1234          * this warning for a little while to try and catch filesystems that
1235          * violate this rule.
1236          */
1237         WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
1238                 "negative value (%lld)\n", type->name, sb->s_maxbytes);
1239
1240         up_write(&sb->s_umount);
1241         free_secdata(secdata);
1242         return root;
1243 out_sb:
1244         dput(root);
1245         deactivate_locked_super(sb);
1246 out_free_secdata:
1247         free_secdata(secdata);
1248 out:
1249         return ERR_PTR(error);
1250 }
1251
1252 /*
1253  * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1254  * instead.
1255  */
1256 void __sb_end_write(struct super_block *sb, int level)
1257 {
1258         percpu_up_read(sb->s_writers.rw_sem + level-1);
1259 }
1260 EXPORT_SYMBOL(__sb_end_write);
1261
1262 /*
1263  * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1264  * instead.
1265  */
1266 int __sb_start_write(struct super_block *sb, int level, bool wait)
1267 {
1268         bool force_trylock = false;
1269         int ret = 1;
1270
1271 #ifdef CONFIG_LOCKDEP
1272         /*
1273          * We want lockdep to tell us about possible deadlocks with freezing
1274          * but it's it bit tricky to properly instrument it. Getting a freeze
1275          * protection works as getting a read lock but there are subtle
1276          * problems. XFS for example gets freeze protection on internal level
1277          * twice in some cases, which is OK only because we already hold a
1278          * freeze protection also on higher level. Due to these cases we have
1279          * to use wait == F (trylock mode) which must not fail.
1280          */
1281         if (wait) {
1282                 int i;
1283
1284                 for (i = 0; i < level - 1; i++)
1285                         if (percpu_rwsem_is_held(sb->s_writers.rw_sem + i)) {
1286                                 force_trylock = true;
1287                                 break;
1288                         }
1289         }
1290 #endif
1291         if (wait && !force_trylock)
1292                 percpu_down_read(sb->s_writers.rw_sem + level-1);
1293         else
1294                 ret = percpu_down_read_trylock(sb->s_writers.rw_sem + level-1);
1295
1296         WARN_ON(force_trylock && !ret);
1297         return ret;
1298 }
1299 EXPORT_SYMBOL(__sb_start_write);
1300
1301 /**
1302  * sb_wait_write - wait until all writers to given file system finish
1303  * @sb: the super for which we wait
1304  * @level: type of writers we wait for (normal vs page fault)
1305  *
1306  * This function waits until there are no writers of given type to given file
1307  * system.
1308  */
1309 static void sb_wait_write(struct super_block *sb, int level)
1310 {
1311         percpu_down_write(sb->s_writers.rw_sem + level-1);
1312 }
1313
1314 /*
1315  * We are going to return to userspace and forget about these locks, the
1316  * ownership goes to the caller of thaw_super() which does unlock().
1317  */
1318 static void lockdep_sb_freeze_release(struct super_block *sb)
1319 {
1320         int level;
1321
1322         for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1323                 percpu_rwsem_release(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
1324 }
1325
1326 /*
1327  * Tell lockdep we are holding these locks before we call ->unfreeze_fs(sb).
1328  */
1329 static void lockdep_sb_freeze_acquire(struct super_block *sb)
1330 {
1331         int level;
1332
1333         for (level = 0; level < SB_FREEZE_LEVELS; ++level)
1334                 percpu_rwsem_acquire(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
1335 }
1336
1337 static void sb_freeze_unlock(struct super_block *sb)
1338 {
1339         int level;
1340
1341         for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1342                 percpu_up_write(sb->s_writers.rw_sem + level);
1343 }
1344
1345 /**
1346  * freeze_super - lock the filesystem and force it into a consistent state
1347  * @sb: the super to lock
1348  *
1349  * Syncs the super to make sure the filesystem is consistent and calls the fs's
1350  * freeze_fs.  Subsequent calls to this without first thawing the fs will return
1351  * -EBUSY.
1352  *
1353  * During this function, sb->s_writers.frozen goes through these values:
1354  *
1355  * SB_UNFROZEN: File system is normal, all writes progress as usual.
1356  *
1357  * SB_FREEZE_WRITE: The file system is in the process of being frozen.  New
1358  * writes should be blocked, though page faults are still allowed. We wait for
1359  * all writes to complete and then proceed to the next stage.
1360  *
1361  * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1362  * but internal fs threads can still modify the filesystem (although they
1363  * should not dirty new pages or inodes), writeback can run etc. After waiting
1364  * for all running page faults we sync the filesystem which will clean all
1365  * dirty pages and inodes (no new dirty pages or inodes can be created when
1366  * sync is running).
1367  *
1368  * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1369  * modification are blocked (e.g. XFS preallocation truncation on inode
1370  * reclaim). This is usually implemented by blocking new transactions for
1371  * filesystems that have them and need this additional guard. After all
1372  * internal writers are finished we call ->freeze_fs() to finish filesystem
1373  * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1374  * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1375  *
1376  * sb->s_writers.frozen is protected by sb->s_umount.
1377  */
1378 int freeze_super(struct super_block *sb)
1379 {
1380         int ret;
1381
1382         atomic_inc(&sb->s_active);
1383         down_write(&sb->s_umount);
1384         if (sb->s_writers.frozen != SB_UNFROZEN) {
1385                 deactivate_locked_super(sb);
1386                 return -EBUSY;
1387         }
1388
1389         if (!(sb->s_flags & MS_BORN)) {
1390                 up_write(&sb->s_umount);
1391                 return 0;       /* sic - it's "nothing to do" */
1392         }
1393
1394         if (sb->s_flags & MS_RDONLY) {
1395                 /* Nothing to do really... */
1396                 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
1397                 up_write(&sb->s_umount);
1398                 return 0;
1399         }
1400
1401         sb->s_writers.frozen = SB_FREEZE_WRITE;
1402         /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1403         up_write(&sb->s_umount);
1404         sb_wait_write(sb, SB_FREEZE_WRITE);
1405         down_write(&sb->s_umount);
1406
1407         /* Now we go and block page faults... */
1408         sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
1409         sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1410
1411         /* All writers are done so after syncing there won't be dirty data */
1412         sync_filesystem(sb);
1413
1414         /* Now wait for internal filesystem counter */
1415         sb->s_writers.frozen = SB_FREEZE_FS;
1416         sb_wait_write(sb, SB_FREEZE_FS);
1417
1418         if (sb->s_op->freeze_fs) {
1419                 ret = sb->s_op->freeze_fs(sb);
1420                 if (ret) {
1421                         printk(KERN_ERR
1422                                 "VFS:Filesystem freeze failed\n");
1423                         sb->s_writers.frozen = SB_UNFROZEN;
1424                         sb_freeze_unlock(sb);
1425                         wake_up(&sb->s_writers.wait_unfrozen);
1426                         deactivate_locked_super(sb);
1427                         return ret;
1428                 }
1429         }
1430         /*
1431          * For debugging purposes so that fs can warn if it sees write activity
1432          * when frozen is set to SB_FREEZE_COMPLETE, and for thaw_super().
1433          */
1434         sb->s_writers.frozen = SB_FREEZE_COMPLETE;
1435         lockdep_sb_freeze_release(sb);
1436         up_write(&sb->s_umount);
1437         return 0;
1438 }
1439 EXPORT_SYMBOL(freeze_super);
1440
1441 /**
1442  * thaw_super -- unlock filesystem
1443  * @sb: the super to thaw
1444  *
1445  * Unlocks the filesystem and marks it writeable again after freeze_super().
1446  */
1447 int thaw_super(struct super_block *sb)
1448 {
1449         int error;
1450
1451         down_write(&sb->s_umount);
1452         if (sb->s_writers.frozen != SB_FREEZE_COMPLETE) {
1453                 up_write(&sb->s_umount);
1454                 return -EINVAL;
1455         }
1456
1457         if (sb->s_flags & MS_RDONLY) {
1458                 sb->s_writers.frozen = SB_UNFROZEN;
1459                 goto out;
1460         }
1461
1462         lockdep_sb_freeze_acquire(sb);
1463
1464         if (sb->s_op->unfreeze_fs) {
1465                 error = sb->s_op->unfreeze_fs(sb);
1466                 if (error) {
1467                         printk(KERN_ERR
1468                                 "VFS:Filesystem thaw failed\n");
1469                         lockdep_sb_freeze_release(sb);
1470                         up_write(&sb->s_umount);
1471                         return error;
1472                 }
1473         }
1474
1475         sb->s_writers.frozen = SB_UNFROZEN;
1476         sb_freeze_unlock(sb);
1477 out:
1478         wake_up(&sb->s_writers.wait_unfrozen);
1479         deactivate_locked_super(sb);
1480         return 0;
1481 }
1482 EXPORT_SYMBOL(thaw_super);