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