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