Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) 2007 Oracle. All rights reserved.
4 */
5
6#include <linux/blkdev.h>
7#include <linux/module.h>
8#include <linux/fs.h>
9#include <linux/pagemap.h>
10#include <linux/highmem.h>
11#include <linux/time.h>
12#include <linux/init.h>
13#include <linux/seq_file.h>
14#include <linux/string.h>
15#include <linux/backing-dev.h>
16#include <linux/mount.h>
17#include <linux/writeback.h>
18#include <linux/statfs.h>
19#include <linux/compat.h>
20#include <linux/parser.h>
21#include <linux/ctype.h>
22#include <linux/namei.h>
23#include <linux/miscdevice.h>
24#include <linux/magic.h>
25#include <linux/slab.h>
26#include <linux/ratelimit.h>
27#include <linux/crc32c.h>
28#include <linux/btrfs.h>
29#include <linux/security.h>
30#include <linux/fs_parser.h>
31#include "messages.h"
32#include "delayed-inode.h"
33#include "ctree.h"
34#include "disk-io.h"
35#include "transaction.h"
36#include "btrfs_inode.h"
37#include "print-tree.h"
38#include "props.h"
39#include "xattr.h"
40#include "bio.h"
41#include "export.h"
42#include "compression.h"
43#include "rcu-string.h"
44#include "dev-replace.h"
45#include "free-space-cache.h"
46#include "backref.h"
47#include "space-info.h"
48#include "sysfs.h"
49#include "zoned.h"
50#include "tests/btrfs-tests.h"
51#include "block-group.h"
52#include "discard.h"
53#include "qgroup.h"
54#include "raid56.h"
55#include "fs.h"
56#include "accessors.h"
57#include "defrag.h"
58#include "dir-item.h"
59#include "ioctl.h"
60#include "scrub.h"
61#include "verity.h"
62#include "super.h"
63#include "extent-tree.h"
64#define CREATE_TRACE_POINTS
65#include <trace/events/btrfs.h>
66
67static const struct super_operations btrfs_super_ops;
68static struct file_system_type btrfs_fs_type;
69
70static void btrfs_put_super(struct super_block *sb)
71{
72 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
73
74 btrfs_info(fs_info, "last unmount of filesystem %pU", fs_info->fs_devices->fsid);
75 close_ctree(fs_info);
76}
77
78/* Store the mount options related information. */
79struct btrfs_fs_context {
80 char *subvol_name;
81 u64 subvol_objectid;
82 u64 max_inline;
83 u32 commit_interval;
84 u32 metadata_ratio;
85 u32 thread_pool_size;
86 unsigned long mount_opt;
87 unsigned long compress_type:4;
88 unsigned int compress_level;
89 refcount_t refs;
90};
91
92enum {
93 Opt_acl,
94 Opt_clear_cache,
95 Opt_commit_interval,
96 Opt_compress,
97 Opt_compress_force,
98 Opt_compress_force_type,
99 Opt_compress_type,
100 Opt_degraded,
101 Opt_device,
102 Opt_fatal_errors,
103 Opt_flushoncommit,
104 Opt_max_inline,
105 Opt_barrier,
106 Opt_datacow,
107 Opt_datasum,
108 Opt_defrag,
109 Opt_discard,
110 Opt_discard_mode,
111 Opt_ratio,
112 Opt_rescan_uuid_tree,
113 Opt_skip_balance,
114 Opt_space_cache,
115 Opt_space_cache_version,
116 Opt_ssd,
117 Opt_ssd_spread,
118 Opt_subvol,
119 Opt_subvol_empty,
120 Opt_subvolid,
121 Opt_thread_pool,
122 Opt_treelog,
123 Opt_user_subvol_rm_allowed,
124
125 /* Rescue options */
126 Opt_rescue,
127 Opt_usebackuproot,
128 Opt_nologreplay,
129 Opt_ignorebadroots,
130 Opt_ignoredatacsums,
131 Opt_rescue_all,
132
133 /* Debugging options */
134 Opt_enospc_debug,
135#ifdef CONFIG_BTRFS_DEBUG
136 Opt_fragment, Opt_fragment_data, Opt_fragment_metadata, Opt_fragment_all,
137#endif
138#ifdef CONFIG_BTRFS_FS_REF_VERIFY
139 Opt_ref_verify,
140#endif
141 Opt_err,
142};
143
144enum {
145 Opt_fatal_errors_panic,
146 Opt_fatal_errors_bug,
147};
148
149static const struct constant_table btrfs_parameter_fatal_errors[] = {
150 { "panic", Opt_fatal_errors_panic },
151 { "bug", Opt_fatal_errors_bug },
152 {}
153};
154
155enum {
156 Opt_discard_sync,
157 Opt_discard_async,
158};
159
160static const struct constant_table btrfs_parameter_discard[] = {
161 { "sync", Opt_discard_sync },
162 { "async", Opt_discard_async },
163 {}
164};
165
166enum {
167 Opt_space_cache_v1,
168 Opt_space_cache_v2,
169};
170
171static const struct constant_table btrfs_parameter_space_cache[] = {
172 { "v1", Opt_space_cache_v1 },
173 { "v2", Opt_space_cache_v2 },
174 {}
175};
176
177enum {
178 Opt_rescue_usebackuproot,
179 Opt_rescue_nologreplay,
180 Opt_rescue_ignorebadroots,
181 Opt_rescue_ignoredatacsums,
182 Opt_rescue_parameter_all,
183};
184
185static const struct constant_table btrfs_parameter_rescue[] = {
186 { "usebackuproot", Opt_rescue_usebackuproot },
187 { "nologreplay", Opt_rescue_nologreplay },
188 { "ignorebadroots", Opt_rescue_ignorebadroots },
189 { "ibadroots", Opt_rescue_ignorebadroots },
190 { "ignoredatacsums", Opt_rescue_ignoredatacsums },
191 { "idatacsums", Opt_rescue_ignoredatacsums },
192 { "all", Opt_rescue_parameter_all },
193 {}
194};
195
196#ifdef CONFIG_BTRFS_DEBUG
197enum {
198 Opt_fragment_parameter_data,
199 Opt_fragment_parameter_metadata,
200 Opt_fragment_parameter_all,
201};
202
203static const struct constant_table btrfs_parameter_fragment[] = {
204 { "data", Opt_fragment_parameter_data },
205 { "metadata", Opt_fragment_parameter_metadata },
206 { "all", Opt_fragment_parameter_all },
207 {}
208};
209#endif
210
211static const struct fs_parameter_spec btrfs_fs_parameters[] = {
212 fsparam_flag_no("acl", Opt_acl),
213 fsparam_flag_no("autodefrag", Opt_defrag),
214 fsparam_flag_no("barrier", Opt_barrier),
215 fsparam_flag("clear_cache", Opt_clear_cache),
216 fsparam_u32("commit", Opt_commit_interval),
217 fsparam_flag("compress", Opt_compress),
218 fsparam_string("compress", Opt_compress_type),
219 fsparam_flag("compress-force", Opt_compress_force),
220 fsparam_string("compress-force", Opt_compress_force_type),
221 fsparam_flag_no("datacow", Opt_datacow),
222 fsparam_flag_no("datasum", Opt_datasum),
223 fsparam_flag("degraded", Opt_degraded),
224 fsparam_string("device", Opt_device),
225 fsparam_flag_no("discard", Opt_discard),
226 fsparam_enum("discard", Opt_discard_mode, btrfs_parameter_discard),
227 fsparam_enum("fatal_errors", Opt_fatal_errors, btrfs_parameter_fatal_errors),
228 fsparam_flag_no("flushoncommit", Opt_flushoncommit),
229 fsparam_string("max_inline", Opt_max_inline),
230 fsparam_u32("metadata_ratio", Opt_ratio),
231 fsparam_flag("rescan_uuid_tree", Opt_rescan_uuid_tree),
232 fsparam_flag("skip_balance", Opt_skip_balance),
233 fsparam_flag_no("space_cache", Opt_space_cache),
234 fsparam_enum("space_cache", Opt_space_cache_version, btrfs_parameter_space_cache),
235 fsparam_flag_no("ssd", Opt_ssd),
236 fsparam_flag_no("ssd_spread", Opt_ssd_spread),
237 fsparam_string("subvol", Opt_subvol),
238 fsparam_flag("subvol=", Opt_subvol_empty),
239 fsparam_u64("subvolid", Opt_subvolid),
240 fsparam_u32("thread_pool", Opt_thread_pool),
241 fsparam_flag_no("treelog", Opt_treelog),
242 fsparam_flag("user_subvol_rm_allowed", Opt_user_subvol_rm_allowed),
243
244 /* Rescue options. */
245 fsparam_enum("rescue", Opt_rescue, btrfs_parameter_rescue),
246 /* Deprecated, with alias rescue=nologreplay */
247 __fsparam(NULL, "nologreplay", Opt_nologreplay, fs_param_deprecated, NULL),
248 /* Deprecated, with alias rescue=usebackuproot */
249 __fsparam(NULL, "usebackuproot", Opt_usebackuproot, fs_param_deprecated, NULL),
250
251 /* Debugging options. */
252 fsparam_flag_no("enospc_debug", Opt_enospc_debug),
253#ifdef CONFIG_BTRFS_DEBUG
254 fsparam_enum("fragment", Opt_fragment, btrfs_parameter_fragment),
255#endif
256#ifdef CONFIG_BTRFS_FS_REF_VERIFY
257 fsparam_flag("ref_verify", Opt_ref_verify),
258#endif
259 {}
260};
261
262/* No support for restricting writes to btrfs devices yet... */
263static inline blk_mode_t btrfs_open_mode(struct fs_context *fc)
264{
265 return sb_open_mode(fc->sb_flags) & ~BLK_OPEN_RESTRICT_WRITES;
266}
267
268static int btrfs_parse_param(struct fs_context *fc, struct fs_parameter *param)
269{
270 struct btrfs_fs_context *ctx = fc->fs_private;
271 struct fs_parse_result result;
272 int opt;
273
274 opt = fs_parse(fc, btrfs_fs_parameters, param, &result);
275 if (opt < 0)
276 return opt;
277
278 switch (opt) {
279 case Opt_degraded:
280 btrfs_set_opt(ctx->mount_opt, DEGRADED);
281 break;
282 case Opt_subvol_empty:
283 /*
284 * This exists because we used to allow it on accident, so we're
285 * keeping it to maintain ABI. See 37becec95ac3 ("Btrfs: allow
286 * empty subvol= again").
287 */
288 break;
289 case Opt_subvol:
290 kfree(ctx->subvol_name);
291 ctx->subvol_name = kstrdup(param->string, GFP_KERNEL);
292 if (!ctx->subvol_name)
293 return -ENOMEM;
294 break;
295 case Opt_subvolid:
296 ctx->subvol_objectid = result.uint_64;
297
298 /* subvolid=0 means give me the original fs_tree. */
299 if (!ctx->subvol_objectid)
300 ctx->subvol_objectid = BTRFS_FS_TREE_OBJECTID;
301 break;
302 case Opt_device: {
303 struct btrfs_device *device;
304 blk_mode_t mode = btrfs_open_mode(fc);
305
306 mutex_lock(&uuid_mutex);
307 device = btrfs_scan_one_device(param->string, mode, false);
308 mutex_unlock(&uuid_mutex);
309 if (IS_ERR(device))
310 return PTR_ERR(device);
311 break;
312 }
313 case Opt_datasum:
314 if (result.negated) {
315 btrfs_set_opt(ctx->mount_opt, NODATASUM);
316 } else {
317 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
318 btrfs_clear_opt(ctx->mount_opt, NODATASUM);
319 }
320 break;
321 case Opt_datacow:
322 if (result.negated) {
323 btrfs_clear_opt(ctx->mount_opt, COMPRESS);
324 btrfs_clear_opt(ctx->mount_opt, FORCE_COMPRESS);
325 btrfs_set_opt(ctx->mount_opt, NODATACOW);
326 btrfs_set_opt(ctx->mount_opt, NODATASUM);
327 } else {
328 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
329 }
330 break;
331 case Opt_compress_force:
332 case Opt_compress_force_type:
333 btrfs_set_opt(ctx->mount_opt, FORCE_COMPRESS);
334 fallthrough;
335 case Opt_compress:
336 case Opt_compress_type:
337 if (opt == Opt_compress || opt == Opt_compress_force) {
338 ctx->compress_type = BTRFS_COMPRESS_ZLIB;
339 ctx->compress_level = BTRFS_ZLIB_DEFAULT_LEVEL;
340 btrfs_set_opt(ctx->mount_opt, COMPRESS);
341 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
342 btrfs_clear_opt(ctx->mount_opt, NODATASUM);
343 } else if (strncmp(param->string, "zlib", 4) == 0) {
344 ctx->compress_type = BTRFS_COMPRESS_ZLIB;
345 ctx->compress_level =
346 btrfs_compress_str2level(BTRFS_COMPRESS_ZLIB,
347 param->string + 4);
348 btrfs_set_opt(ctx->mount_opt, COMPRESS);
349 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
350 btrfs_clear_opt(ctx->mount_opt, NODATASUM);
351 } else if (strncmp(param->string, "lzo", 3) == 0) {
352 ctx->compress_type = BTRFS_COMPRESS_LZO;
353 ctx->compress_level = 0;
354 btrfs_set_opt(ctx->mount_opt, COMPRESS);
355 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
356 btrfs_clear_opt(ctx->mount_opt, NODATASUM);
357 } else if (strncmp(param->string, "zstd", 4) == 0) {
358 ctx->compress_type = BTRFS_COMPRESS_ZSTD;
359 ctx->compress_level =
360 btrfs_compress_str2level(BTRFS_COMPRESS_ZSTD,
361 param->string + 4);
362 btrfs_set_opt(ctx->mount_opt, COMPRESS);
363 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
364 btrfs_clear_opt(ctx->mount_opt, NODATASUM);
365 } else if (strncmp(param->string, "no", 2) == 0) {
366 ctx->compress_level = 0;
367 ctx->compress_type = 0;
368 btrfs_clear_opt(ctx->mount_opt, COMPRESS);
369 btrfs_clear_opt(ctx->mount_opt, FORCE_COMPRESS);
370 } else {
371 btrfs_err(NULL, "unrecognized compression value %s",
372 param->string);
373 return -EINVAL;
374 }
375 break;
376 case Opt_ssd:
377 if (result.negated) {
378 btrfs_set_opt(ctx->mount_opt, NOSSD);
379 btrfs_clear_opt(ctx->mount_opt, SSD);
380 btrfs_clear_opt(ctx->mount_opt, SSD_SPREAD);
381 } else {
382 btrfs_set_opt(ctx->mount_opt, SSD);
383 btrfs_clear_opt(ctx->mount_opt, NOSSD);
384 }
385 break;
386 case Opt_ssd_spread:
387 if (result.negated) {
388 btrfs_clear_opt(ctx->mount_opt, SSD_SPREAD);
389 } else {
390 btrfs_set_opt(ctx->mount_opt, SSD);
391 btrfs_set_opt(ctx->mount_opt, SSD_SPREAD);
392 btrfs_clear_opt(ctx->mount_opt, NOSSD);
393 }
394 break;
395 case Opt_barrier:
396 if (result.negated)
397 btrfs_set_opt(ctx->mount_opt, NOBARRIER);
398 else
399 btrfs_clear_opt(ctx->mount_opt, NOBARRIER);
400 break;
401 case Opt_thread_pool:
402 if (result.uint_32 == 0) {
403 btrfs_err(NULL, "invalid value 0 for thread_pool");
404 return -EINVAL;
405 }
406 ctx->thread_pool_size = result.uint_32;
407 break;
408 case Opt_max_inline:
409 ctx->max_inline = memparse(param->string, NULL);
410 break;
411 case Opt_acl:
412 if (result.negated) {
413 fc->sb_flags &= ~SB_POSIXACL;
414 } else {
415#ifdef CONFIG_BTRFS_FS_POSIX_ACL
416 fc->sb_flags |= SB_POSIXACL;
417#else
418 btrfs_err(NULL, "support for ACL not compiled in");
419 return -EINVAL;
420#endif
421 }
422 /*
423 * VFS limits the ability to toggle ACL on and off via remount,
424 * despite every file system allowing this. This seems to be
425 * an oversight since we all do, but it'll fail if we're
426 * remounting. So don't set the mask here, we'll check it in
427 * btrfs_reconfigure and do the toggling ourselves.
428 */
429 if (fc->purpose != FS_CONTEXT_FOR_RECONFIGURE)
430 fc->sb_flags_mask |= SB_POSIXACL;
431 break;
432 case Opt_treelog:
433 if (result.negated)
434 btrfs_set_opt(ctx->mount_opt, NOTREELOG);
435 else
436 btrfs_clear_opt(ctx->mount_opt, NOTREELOG);
437 break;
438 case Opt_nologreplay:
439 btrfs_warn(NULL,
440 "'nologreplay' is deprecated, use 'rescue=nologreplay' instead");
441 btrfs_set_opt(ctx->mount_opt, NOLOGREPLAY);
442 break;
443 case Opt_flushoncommit:
444 if (result.negated)
445 btrfs_clear_opt(ctx->mount_opt, FLUSHONCOMMIT);
446 else
447 btrfs_set_opt(ctx->mount_opt, FLUSHONCOMMIT);
448 break;
449 case Opt_ratio:
450 ctx->metadata_ratio = result.uint_32;
451 break;
452 case Opt_discard:
453 if (result.negated) {
454 btrfs_clear_opt(ctx->mount_opt, DISCARD_SYNC);
455 btrfs_clear_opt(ctx->mount_opt, DISCARD_ASYNC);
456 btrfs_set_opt(ctx->mount_opt, NODISCARD);
457 } else {
458 btrfs_set_opt(ctx->mount_opt, DISCARD_SYNC);
459 btrfs_clear_opt(ctx->mount_opt, DISCARD_ASYNC);
460 }
461 break;
462 case Opt_discard_mode:
463 switch (result.uint_32) {
464 case Opt_discard_sync:
465 btrfs_clear_opt(ctx->mount_opt, DISCARD_ASYNC);
466 btrfs_set_opt(ctx->mount_opt, DISCARD_SYNC);
467 break;
468 case Opt_discard_async:
469 btrfs_clear_opt(ctx->mount_opt, DISCARD_SYNC);
470 btrfs_set_opt(ctx->mount_opt, DISCARD_ASYNC);
471 break;
472 default:
473 btrfs_err(NULL, "unrecognized discard mode value %s",
474 param->key);
475 return -EINVAL;
476 }
477 btrfs_clear_opt(ctx->mount_opt, NODISCARD);
478 break;
479 case Opt_space_cache:
480 if (result.negated) {
481 btrfs_set_opt(ctx->mount_opt, NOSPACECACHE);
482 btrfs_clear_opt(ctx->mount_opt, SPACE_CACHE);
483 btrfs_clear_opt(ctx->mount_opt, FREE_SPACE_TREE);
484 } else {
485 btrfs_clear_opt(ctx->mount_opt, FREE_SPACE_TREE);
486 btrfs_set_opt(ctx->mount_opt, SPACE_CACHE);
487 }
488 break;
489 case Opt_space_cache_version:
490 switch (result.uint_32) {
491 case Opt_space_cache_v1:
492 btrfs_set_opt(ctx->mount_opt, SPACE_CACHE);
493 btrfs_clear_opt(ctx->mount_opt, FREE_SPACE_TREE);
494 break;
495 case Opt_space_cache_v2:
496 btrfs_clear_opt(ctx->mount_opt, SPACE_CACHE);
497 btrfs_set_opt(ctx->mount_opt, FREE_SPACE_TREE);
498 break;
499 default:
500 btrfs_err(NULL, "unrecognized space_cache value %s",
501 param->key);
502 return -EINVAL;
503 }
504 break;
505 case Opt_rescan_uuid_tree:
506 btrfs_set_opt(ctx->mount_opt, RESCAN_UUID_TREE);
507 break;
508 case Opt_clear_cache:
509 btrfs_set_opt(ctx->mount_opt, CLEAR_CACHE);
510 break;
511 case Opt_user_subvol_rm_allowed:
512 btrfs_set_opt(ctx->mount_opt, USER_SUBVOL_RM_ALLOWED);
513 break;
514 case Opt_enospc_debug:
515 if (result.negated)
516 btrfs_clear_opt(ctx->mount_opt, ENOSPC_DEBUG);
517 else
518 btrfs_set_opt(ctx->mount_opt, ENOSPC_DEBUG);
519 break;
520 case Opt_defrag:
521 if (result.negated)
522 btrfs_clear_opt(ctx->mount_opt, AUTO_DEFRAG);
523 else
524 btrfs_set_opt(ctx->mount_opt, AUTO_DEFRAG);
525 break;
526 case Opt_usebackuproot:
527 btrfs_warn(NULL,
528 "'usebackuproot' is deprecated, use 'rescue=usebackuproot' instead");
529 btrfs_set_opt(ctx->mount_opt, USEBACKUPROOT);
530
531 /* If we're loading the backup roots we can't trust the space cache. */
532 btrfs_set_opt(ctx->mount_opt, CLEAR_CACHE);
533 break;
534 case Opt_skip_balance:
535 btrfs_set_opt(ctx->mount_opt, SKIP_BALANCE);
536 break;
537 case Opt_fatal_errors:
538 switch (result.uint_32) {
539 case Opt_fatal_errors_panic:
540 btrfs_set_opt(ctx->mount_opt, PANIC_ON_FATAL_ERROR);
541 break;
542 case Opt_fatal_errors_bug:
543 btrfs_clear_opt(ctx->mount_opt, PANIC_ON_FATAL_ERROR);
544 break;
545 default:
546 btrfs_err(NULL, "unrecognized fatal_errors value %s",
547 param->key);
548 return -EINVAL;
549 }
550 break;
551 case Opt_commit_interval:
552 ctx->commit_interval = result.uint_32;
553 if (ctx->commit_interval == 0)
554 ctx->commit_interval = BTRFS_DEFAULT_COMMIT_INTERVAL;
555 break;
556 case Opt_rescue:
557 switch (result.uint_32) {
558 case Opt_rescue_usebackuproot:
559 btrfs_set_opt(ctx->mount_opt, USEBACKUPROOT);
560 break;
561 case Opt_rescue_nologreplay:
562 btrfs_set_opt(ctx->mount_opt, NOLOGREPLAY);
563 break;
564 case Opt_rescue_ignorebadroots:
565 btrfs_set_opt(ctx->mount_opt, IGNOREBADROOTS);
566 break;
567 case Opt_rescue_ignoredatacsums:
568 btrfs_set_opt(ctx->mount_opt, IGNOREDATACSUMS);
569 break;
570 case Opt_rescue_parameter_all:
571 btrfs_set_opt(ctx->mount_opt, IGNOREDATACSUMS);
572 btrfs_set_opt(ctx->mount_opt, IGNOREBADROOTS);
573 btrfs_set_opt(ctx->mount_opt, NOLOGREPLAY);
574 break;
575 default:
576 btrfs_info(NULL, "unrecognized rescue option '%s'",
577 param->key);
578 return -EINVAL;
579 }
580 break;
581#ifdef CONFIG_BTRFS_DEBUG
582 case Opt_fragment:
583 switch (result.uint_32) {
584 case Opt_fragment_parameter_all:
585 btrfs_set_opt(ctx->mount_opt, FRAGMENT_DATA);
586 btrfs_set_opt(ctx->mount_opt, FRAGMENT_METADATA);
587 break;
588 case Opt_fragment_parameter_metadata:
589 btrfs_set_opt(ctx->mount_opt, FRAGMENT_METADATA);
590 break;
591 case Opt_fragment_parameter_data:
592 btrfs_set_opt(ctx->mount_opt, FRAGMENT_DATA);
593 break;
594 default:
595 btrfs_info(NULL, "unrecognized fragment option '%s'",
596 param->key);
597 return -EINVAL;
598 }
599 break;
600#endif
601#ifdef CONFIG_BTRFS_FS_REF_VERIFY
602 case Opt_ref_verify:
603 btrfs_set_opt(ctx->mount_opt, REF_VERIFY);
604 break;
605#endif
606 default:
607 btrfs_err(NULL, "unrecognized mount option '%s'", param->key);
608 return -EINVAL;
609 }
610
611 return 0;
612}
613
614/*
615 * Some options only have meaning at mount time and shouldn't persist across
616 * remounts, or be displayed. Clear these at the end of mount and remount code
617 * paths.
618 */
619static void btrfs_clear_oneshot_options(struct btrfs_fs_info *fs_info)
620{
621 btrfs_clear_opt(fs_info->mount_opt, USEBACKUPROOT);
622 btrfs_clear_opt(fs_info->mount_opt, CLEAR_CACHE);
623 btrfs_clear_opt(fs_info->mount_opt, NOSPACECACHE);
624}
625
626static bool check_ro_option(struct btrfs_fs_info *fs_info,
627 unsigned long mount_opt, unsigned long opt,
628 const char *opt_name)
629{
630 if (mount_opt & opt) {
631 btrfs_err(fs_info, "%s must be used with ro mount option",
632 opt_name);
633 return true;
634 }
635 return false;
636}
637
638bool btrfs_check_options(struct btrfs_fs_info *info, unsigned long *mount_opt,
639 unsigned long flags)
640{
641 bool ret = true;
642
643 if (!(flags & SB_RDONLY) &&
644 (check_ro_option(info, *mount_opt, BTRFS_MOUNT_NOLOGREPLAY, "nologreplay") ||
645 check_ro_option(info, *mount_opt, BTRFS_MOUNT_IGNOREBADROOTS, "ignorebadroots") ||
646 check_ro_option(info, *mount_opt, BTRFS_MOUNT_IGNOREDATACSUMS, "ignoredatacsums")))
647 ret = false;
648
649 if (btrfs_fs_compat_ro(info, FREE_SPACE_TREE) &&
650 !btrfs_raw_test_opt(*mount_opt, FREE_SPACE_TREE) &&
651 !btrfs_raw_test_opt(*mount_opt, CLEAR_CACHE)) {
652 btrfs_err(info, "cannot disable free-space-tree");
653 ret = false;
654 }
655 if (btrfs_fs_compat_ro(info, BLOCK_GROUP_TREE) &&
656 !btrfs_raw_test_opt(*mount_opt, FREE_SPACE_TREE)) {
657 btrfs_err(info, "cannot disable free-space-tree with block-group-tree feature");
658 ret = false;
659 }
660
661 if (btrfs_check_mountopts_zoned(info, mount_opt))
662 ret = false;
663
664 if (!test_bit(BTRFS_FS_STATE_REMOUNTING, &info->fs_state)) {
665 if (btrfs_raw_test_opt(*mount_opt, SPACE_CACHE))
666 btrfs_info(info, "disk space caching is enabled");
667 if (btrfs_raw_test_opt(*mount_opt, FREE_SPACE_TREE))
668 btrfs_info(info, "using free-space-tree");
669 }
670
671 return ret;
672}
673
674/*
675 * This is subtle, we only call this during open_ctree(). We need to pre-load
676 * the mount options with the on-disk settings. Before the new mount API took
677 * effect we would do this on mount and remount. With the new mount API we'll
678 * only do this on the initial mount.
679 *
680 * This isn't a change in behavior, because we're using the current state of the
681 * file system to set the current mount options. If you mounted with special
682 * options to disable these features and then remounted we wouldn't revert the
683 * settings, because mounting without these features cleared the on-disk
684 * settings, so this being called on re-mount is not needed.
685 */
686void btrfs_set_free_space_cache_settings(struct btrfs_fs_info *fs_info)
687{
688 if (fs_info->sectorsize < PAGE_SIZE) {
689 btrfs_clear_opt(fs_info->mount_opt, SPACE_CACHE);
690 if (!btrfs_test_opt(fs_info, FREE_SPACE_TREE)) {
691 btrfs_info(fs_info,
692 "forcing free space tree for sector size %u with page size %lu",
693 fs_info->sectorsize, PAGE_SIZE);
694 btrfs_set_opt(fs_info->mount_opt, FREE_SPACE_TREE);
695 }
696 }
697
698 /*
699 * At this point our mount options are populated, so we only mess with
700 * these settings if we don't have any settings already.
701 */
702 if (btrfs_test_opt(fs_info, FREE_SPACE_TREE))
703 return;
704
705 if (btrfs_is_zoned(fs_info) &&
706 btrfs_free_space_cache_v1_active(fs_info)) {
707 btrfs_info(fs_info, "zoned: clearing existing space cache");
708 btrfs_set_super_cache_generation(fs_info->super_copy, 0);
709 return;
710 }
711
712 if (btrfs_test_opt(fs_info, SPACE_CACHE))
713 return;
714
715 if (btrfs_test_opt(fs_info, NOSPACECACHE))
716 return;
717
718 /*
719 * At this point we don't have explicit options set by the user, set
720 * them ourselves based on the state of the file system.
721 */
722 if (btrfs_fs_compat_ro(fs_info, FREE_SPACE_TREE))
723 btrfs_set_opt(fs_info->mount_opt, FREE_SPACE_TREE);
724 else if (btrfs_free_space_cache_v1_active(fs_info))
725 btrfs_set_opt(fs_info->mount_opt, SPACE_CACHE);
726}
727
728static void set_device_specific_options(struct btrfs_fs_info *fs_info)
729{
730 if (!btrfs_test_opt(fs_info, NOSSD) &&
731 !fs_info->fs_devices->rotating)
732 btrfs_set_opt(fs_info->mount_opt, SSD);
733
734 /*
735 * For devices supporting discard turn on discard=async automatically,
736 * unless it's already set or disabled. This could be turned off by
737 * nodiscard for the same mount.
738 *
739 * The zoned mode piggy backs on the discard functionality for
740 * resetting a zone. There is no reason to delay the zone reset as it is
741 * fast enough. So, do not enable async discard for zoned mode.
742 */
743 if (!(btrfs_test_opt(fs_info, DISCARD_SYNC) ||
744 btrfs_test_opt(fs_info, DISCARD_ASYNC) ||
745 btrfs_test_opt(fs_info, NODISCARD)) &&
746 fs_info->fs_devices->discardable &&
747 !btrfs_is_zoned(fs_info))
748 btrfs_set_opt(fs_info->mount_opt, DISCARD_ASYNC);
749}
750
751char *btrfs_get_subvol_name_from_objectid(struct btrfs_fs_info *fs_info,
752 u64 subvol_objectid)
753{
754 struct btrfs_root *root = fs_info->tree_root;
755 struct btrfs_root *fs_root = NULL;
756 struct btrfs_root_ref *root_ref;
757 struct btrfs_inode_ref *inode_ref;
758 struct btrfs_key key;
759 struct btrfs_path *path = NULL;
760 char *name = NULL, *ptr;
761 u64 dirid;
762 int len;
763 int ret;
764
765 path = btrfs_alloc_path();
766 if (!path) {
767 ret = -ENOMEM;
768 goto err;
769 }
770
771 name = kmalloc(PATH_MAX, GFP_KERNEL);
772 if (!name) {
773 ret = -ENOMEM;
774 goto err;
775 }
776 ptr = name + PATH_MAX - 1;
777 ptr[0] = '\0';
778
779 /*
780 * Walk up the subvolume trees in the tree of tree roots by root
781 * backrefs until we hit the top-level subvolume.
782 */
783 while (subvol_objectid != BTRFS_FS_TREE_OBJECTID) {
784 key.objectid = subvol_objectid;
785 key.type = BTRFS_ROOT_BACKREF_KEY;
786 key.offset = (u64)-1;
787
788 ret = btrfs_search_backwards(root, &key, path);
789 if (ret < 0) {
790 goto err;
791 } else if (ret > 0) {
792 ret = -ENOENT;
793 goto err;
794 }
795
796 subvol_objectid = key.offset;
797
798 root_ref = btrfs_item_ptr(path->nodes[0], path->slots[0],
799 struct btrfs_root_ref);
800 len = btrfs_root_ref_name_len(path->nodes[0], root_ref);
801 ptr -= len + 1;
802 if (ptr < name) {
803 ret = -ENAMETOOLONG;
804 goto err;
805 }
806 read_extent_buffer(path->nodes[0], ptr + 1,
807 (unsigned long)(root_ref + 1), len);
808 ptr[0] = '/';
809 dirid = btrfs_root_ref_dirid(path->nodes[0], root_ref);
810 btrfs_release_path(path);
811
812 fs_root = btrfs_get_fs_root(fs_info, subvol_objectid, true);
813 if (IS_ERR(fs_root)) {
814 ret = PTR_ERR(fs_root);
815 fs_root = NULL;
816 goto err;
817 }
818
819 /*
820 * Walk up the filesystem tree by inode refs until we hit the
821 * root directory.
822 */
823 while (dirid != BTRFS_FIRST_FREE_OBJECTID) {
824 key.objectid = dirid;
825 key.type = BTRFS_INODE_REF_KEY;
826 key.offset = (u64)-1;
827
828 ret = btrfs_search_backwards(fs_root, &key, path);
829 if (ret < 0) {
830 goto err;
831 } else if (ret > 0) {
832 ret = -ENOENT;
833 goto err;
834 }
835
836 dirid = key.offset;
837
838 inode_ref = btrfs_item_ptr(path->nodes[0],
839 path->slots[0],
840 struct btrfs_inode_ref);
841 len = btrfs_inode_ref_name_len(path->nodes[0],
842 inode_ref);
843 ptr -= len + 1;
844 if (ptr < name) {
845 ret = -ENAMETOOLONG;
846 goto err;
847 }
848 read_extent_buffer(path->nodes[0], ptr + 1,
849 (unsigned long)(inode_ref + 1), len);
850 ptr[0] = '/';
851 btrfs_release_path(path);
852 }
853 btrfs_put_root(fs_root);
854 fs_root = NULL;
855 }
856
857 btrfs_free_path(path);
858 if (ptr == name + PATH_MAX - 1) {
859 name[0] = '/';
860 name[1] = '\0';
861 } else {
862 memmove(name, ptr, name + PATH_MAX - ptr);
863 }
864 return name;
865
866err:
867 btrfs_put_root(fs_root);
868 btrfs_free_path(path);
869 kfree(name);
870 return ERR_PTR(ret);
871}
872
873static int get_default_subvol_objectid(struct btrfs_fs_info *fs_info, u64 *objectid)
874{
875 struct btrfs_root *root = fs_info->tree_root;
876 struct btrfs_dir_item *di;
877 struct btrfs_path *path;
878 struct btrfs_key location;
879 struct fscrypt_str name = FSTR_INIT("default", 7);
880 u64 dir_id;
881
882 path = btrfs_alloc_path();
883 if (!path)
884 return -ENOMEM;
885
886 /*
887 * Find the "default" dir item which points to the root item that we
888 * will mount by default if we haven't been given a specific subvolume
889 * to mount.
890 */
891 dir_id = btrfs_super_root_dir(fs_info->super_copy);
892 di = btrfs_lookup_dir_item(NULL, root, path, dir_id, &name, 0);
893 if (IS_ERR(di)) {
894 btrfs_free_path(path);
895 return PTR_ERR(di);
896 }
897 if (!di) {
898 /*
899 * Ok the default dir item isn't there. This is weird since
900 * it's always been there, but don't freak out, just try and
901 * mount the top-level subvolume.
902 */
903 btrfs_free_path(path);
904 *objectid = BTRFS_FS_TREE_OBJECTID;
905 return 0;
906 }
907
908 btrfs_dir_item_key_to_cpu(path->nodes[0], di, &location);
909 btrfs_free_path(path);
910 *objectid = location.objectid;
911 return 0;
912}
913
914static int btrfs_fill_super(struct super_block *sb,
915 struct btrfs_fs_devices *fs_devices,
916 void *data)
917{
918 struct inode *inode;
919 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
920 int err;
921
922 sb->s_maxbytes = MAX_LFS_FILESIZE;
923 sb->s_magic = BTRFS_SUPER_MAGIC;
924 sb->s_op = &btrfs_super_ops;
925 sb->s_d_op = &btrfs_dentry_operations;
926 sb->s_export_op = &btrfs_export_ops;
927#ifdef CONFIG_FS_VERITY
928 sb->s_vop = &btrfs_verityops;
929#endif
930 sb->s_xattr = btrfs_xattr_handlers;
931 sb->s_time_gran = 1;
932 sb->s_iflags |= SB_I_CGROUPWB;
933
934 err = super_setup_bdi(sb);
935 if (err) {
936 btrfs_err(fs_info, "super_setup_bdi failed");
937 return err;
938 }
939
940 err = open_ctree(sb, fs_devices, (char *)data);
941 if (err) {
942 btrfs_err(fs_info, "open_ctree failed");
943 return err;
944 }
945
946 inode = btrfs_iget(sb, BTRFS_FIRST_FREE_OBJECTID, fs_info->fs_root);
947 if (IS_ERR(inode)) {
948 err = PTR_ERR(inode);
949 btrfs_handle_fs_error(fs_info, err, NULL);
950 goto fail_close;
951 }
952
953 sb->s_root = d_make_root(inode);
954 if (!sb->s_root) {
955 err = -ENOMEM;
956 goto fail_close;
957 }
958
959 sb->s_flags |= SB_ACTIVE;
960 return 0;
961
962fail_close:
963 close_ctree(fs_info);
964 return err;
965}
966
967int btrfs_sync_fs(struct super_block *sb, int wait)
968{
969 struct btrfs_trans_handle *trans;
970 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
971 struct btrfs_root *root = fs_info->tree_root;
972
973 trace_btrfs_sync_fs(fs_info, wait);
974
975 if (!wait) {
976 filemap_flush(fs_info->btree_inode->i_mapping);
977 return 0;
978 }
979
980 btrfs_wait_ordered_roots(fs_info, U64_MAX, 0, (u64)-1);
981
982 trans = btrfs_attach_transaction_barrier(root);
983 if (IS_ERR(trans)) {
984 /* no transaction, don't bother */
985 if (PTR_ERR(trans) == -ENOENT) {
986 /*
987 * Exit unless we have some pending changes
988 * that need to go through commit
989 */
990 if (!test_bit(BTRFS_FS_NEED_TRANS_COMMIT,
991 &fs_info->flags))
992 return 0;
993 /*
994 * A non-blocking test if the fs is frozen. We must not
995 * start a new transaction here otherwise a deadlock
996 * happens. The pending operations are delayed to the
997 * next commit after thawing.
998 */
999 if (sb_start_write_trylock(sb))
1000 sb_end_write(sb);
1001 else
1002 return 0;
1003 trans = btrfs_start_transaction(root, 0);
1004 }
1005 if (IS_ERR(trans))
1006 return PTR_ERR(trans);
1007 }
1008 return btrfs_commit_transaction(trans);
1009}
1010
1011static void print_rescue_option(struct seq_file *seq, const char *s, bool *printed)
1012{
1013 seq_printf(seq, "%s%s", (*printed) ? ":" : ",rescue=", s);
1014 *printed = true;
1015}
1016
1017static int btrfs_show_options(struct seq_file *seq, struct dentry *dentry)
1018{
1019 struct btrfs_fs_info *info = btrfs_sb(dentry->d_sb);
1020 const char *compress_type;
1021 const char *subvol_name;
1022 bool printed = false;
1023
1024 if (btrfs_test_opt(info, DEGRADED))
1025 seq_puts(seq, ",degraded");
1026 if (btrfs_test_opt(info, NODATASUM))
1027 seq_puts(seq, ",nodatasum");
1028 if (btrfs_test_opt(info, NODATACOW))
1029 seq_puts(seq, ",nodatacow");
1030 if (btrfs_test_opt(info, NOBARRIER))
1031 seq_puts(seq, ",nobarrier");
1032 if (info->max_inline != BTRFS_DEFAULT_MAX_INLINE)
1033 seq_printf(seq, ",max_inline=%llu", info->max_inline);
1034 if (info->thread_pool_size != min_t(unsigned long,
1035 num_online_cpus() + 2, 8))
1036 seq_printf(seq, ",thread_pool=%u", info->thread_pool_size);
1037 if (btrfs_test_opt(info, COMPRESS)) {
1038 compress_type = btrfs_compress_type2str(info->compress_type);
1039 if (btrfs_test_opt(info, FORCE_COMPRESS))
1040 seq_printf(seq, ",compress-force=%s", compress_type);
1041 else
1042 seq_printf(seq, ",compress=%s", compress_type);
1043 if (info->compress_level)
1044 seq_printf(seq, ":%d", info->compress_level);
1045 }
1046 if (btrfs_test_opt(info, NOSSD))
1047 seq_puts(seq, ",nossd");
1048 if (btrfs_test_opt(info, SSD_SPREAD))
1049 seq_puts(seq, ",ssd_spread");
1050 else if (btrfs_test_opt(info, SSD))
1051 seq_puts(seq, ",ssd");
1052 if (btrfs_test_opt(info, NOTREELOG))
1053 seq_puts(seq, ",notreelog");
1054 if (btrfs_test_opt(info, NOLOGREPLAY))
1055 print_rescue_option(seq, "nologreplay", &printed);
1056 if (btrfs_test_opt(info, USEBACKUPROOT))
1057 print_rescue_option(seq, "usebackuproot", &printed);
1058 if (btrfs_test_opt(info, IGNOREBADROOTS))
1059 print_rescue_option(seq, "ignorebadroots", &printed);
1060 if (btrfs_test_opt(info, IGNOREDATACSUMS))
1061 print_rescue_option(seq, "ignoredatacsums", &printed);
1062 if (btrfs_test_opt(info, FLUSHONCOMMIT))
1063 seq_puts(seq, ",flushoncommit");
1064 if (btrfs_test_opt(info, DISCARD_SYNC))
1065 seq_puts(seq, ",discard");
1066 if (btrfs_test_opt(info, DISCARD_ASYNC))
1067 seq_puts(seq, ",discard=async");
1068 if (!(info->sb->s_flags & SB_POSIXACL))
1069 seq_puts(seq, ",noacl");
1070 if (btrfs_free_space_cache_v1_active(info))
1071 seq_puts(seq, ",space_cache");
1072 else if (btrfs_fs_compat_ro(info, FREE_SPACE_TREE))
1073 seq_puts(seq, ",space_cache=v2");
1074 else
1075 seq_puts(seq, ",nospace_cache");
1076 if (btrfs_test_opt(info, RESCAN_UUID_TREE))
1077 seq_puts(seq, ",rescan_uuid_tree");
1078 if (btrfs_test_opt(info, CLEAR_CACHE))
1079 seq_puts(seq, ",clear_cache");
1080 if (btrfs_test_opt(info, USER_SUBVOL_RM_ALLOWED))
1081 seq_puts(seq, ",user_subvol_rm_allowed");
1082 if (btrfs_test_opt(info, ENOSPC_DEBUG))
1083 seq_puts(seq, ",enospc_debug");
1084 if (btrfs_test_opt(info, AUTO_DEFRAG))
1085 seq_puts(seq, ",autodefrag");
1086 if (btrfs_test_opt(info, SKIP_BALANCE))
1087 seq_puts(seq, ",skip_balance");
1088 if (info->metadata_ratio)
1089 seq_printf(seq, ",metadata_ratio=%u", info->metadata_ratio);
1090 if (btrfs_test_opt(info, PANIC_ON_FATAL_ERROR))
1091 seq_puts(seq, ",fatal_errors=panic");
1092 if (info->commit_interval != BTRFS_DEFAULT_COMMIT_INTERVAL)
1093 seq_printf(seq, ",commit=%u", info->commit_interval);
1094#ifdef CONFIG_BTRFS_DEBUG
1095 if (btrfs_test_opt(info, FRAGMENT_DATA))
1096 seq_puts(seq, ",fragment=data");
1097 if (btrfs_test_opt(info, FRAGMENT_METADATA))
1098 seq_puts(seq, ",fragment=metadata");
1099#endif
1100 if (btrfs_test_opt(info, REF_VERIFY))
1101 seq_puts(seq, ",ref_verify");
1102 seq_printf(seq, ",subvolid=%llu",
1103 BTRFS_I(d_inode(dentry))->root->root_key.objectid);
1104 subvol_name = btrfs_get_subvol_name_from_objectid(info,
1105 BTRFS_I(d_inode(dentry))->root->root_key.objectid);
1106 if (!IS_ERR(subvol_name)) {
1107 seq_puts(seq, ",subvol=");
1108 seq_escape(seq, subvol_name, " \t\n\\");
1109 kfree(subvol_name);
1110 }
1111 return 0;
1112}
1113
1114/*
1115 * subvolumes are identified by ino 256
1116 */
1117static inline int is_subvolume_inode(struct inode *inode)
1118{
1119 if (inode && inode->i_ino == BTRFS_FIRST_FREE_OBJECTID)
1120 return 1;
1121 return 0;
1122}
1123
1124static struct dentry *mount_subvol(const char *subvol_name, u64 subvol_objectid,
1125 struct vfsmount *mnt)
1126{
1127 struct dentry *root;
1128 int ret;
1129
1130 if (!subvol_name) {
1131 if (!subvol_objectid) {
1132 ret = get_default_subvol_objectid(btrfs_sb(mnt->mnt_sb),
1133 &subvol_objectid);
1134 if (ret) {
1135 root = ERR_PTR(ret);
1136 goto out;
1137 }
1138 }
1139 subvol_name = btrfs_get_subvol_name_from_objectid(
1140 btrfs_sb(mnt->mnt_sb), subvol_objectid);
1141 if (IS_ERR(subvol_name)) {
1142 root = ERR_CAST(subvol_name);
1143 subvol_name = NULL;
1144 goto out;
1145 }
1146
1147 }
1148
1149 root = mount_subtree(mnt, subvol_name);
1150 /* mount_subtree() drops our reference on the vfsmount. */
1151 mnt = NULL;
1152
1153 if (!IS_ERR(root)) {
1154 struct super_block *s = root->d_sb;
1155 struct btrfs_fs_info *fs_info = btrfs_sb(s);
1156 struct inode *root_inode = d_inode(root);
1157 u64 root_objectid = BTRFS_I(root_inode)->root->root_key.objectid;
1158
1159 ret = 0;
1160 if (!is_subvolume_inode(root_inode)) {
1161 btrfs_err(fs_info, "'%s' is not a valid subvolume",
1162 subvol_name);
1163 ret = -EINVAL;
1164 }
1165 if (subvol_objectid && root_objectid != subvol_objectid) {
1166 /*
1167 * This will also catch a race condition where a
1168 * subvolume which was passed by ID is renamed and
1169 * another subvolume is renamed over the old location.
1170 */
1171 btrfs_err(fs_info,
1172 "subvol '%s' does not match subvolid %llu",
1173 subvol_name, subvol_objectid);
1174 ret = -EINVAL;
1175 }
1176 if (ret) {
1177 dput(root);
1178 root = ERR_PTR(ret);
1179 deactivate_locked_super(s);
1180 }
1181 }
1182
1183out:
1184 mntput(mnt);
1185 kfree(subvol_name);
1186 return root;
1187}
1188
1189static void btrfs_resize_thread_pool(struct btrfs_fs_info *fs_info,
1190 u32 new_pool_size, u32 old_pool_size)
1191{
1192 if (new_pool_size == old_pool_size)
1193 return;
1194
1195 fs_info->thread_pool_size = new_pool_size;
1196
1197 btrfs_info(fs_info, "resize thread pool %d -> %d",
1198 old_pool_size, new_pool_size);
1199
1200 btrfs_workqueue_set_max(fs_info->workers, new_pool_size);
1201 btrfs_workqueue_set_max(fs_info->delalloc_workers, new_pool_size);
1202 btrfs_workqueue_set_max(fs_info->caching_workers, new_pool_size);
1203 workqueue_set_max_active(fs_info->endio_workers, new_pool_size);
1204 workqueue_set_max_active(fs_info->endio_meta_workers, new_pool_size);
1205 btrfs_workqueue_set_max(fs_info->endio_write_workers, new_pool_size);
1206 btrfs_workqueue_set_max(fs_info->endio_freespace_worker, new_pool_size);
1207 btrfs_workqueue_set_max(fs_info->delayed_workers, new_pool_size);
1208}
1209
1210static inline void btrfs_remount_begin(struct btrfs_fs_info *fs_info,
1211 unsigned long old_opts, int flags)
1212{
1213 if (btrfs_raw_test_opt(old_opts, AUTO_DEFRAG) &&
1214 (!btrfs_raw_test_opt(fs_info->mount_opt, AUTO_DEFRAG) ||
1215 (flags & SB_RDONLY))) {
1216 /* wait for any defraggers to finish */
1217 wait_event(fs_info->transaction_wait,
1218 (atomic_read(&fs_info->defrag_running) == 0));
1219 if (flags & SB_RDONLY)
1220 sync_filesystem(fs_info->sb);
1221 }
1222}
1223
1224static inline void btrfs_remount_cleanup(struct btrfs_fs_info *fs_info,
1225 unsigned long old_opts)
1226{
1227 const bool cache_opt = btrfs_test_opt(fs_info, SPACE_CACHE);
1228
1229 /*
1230 * We need to cleanup all defragable inodes if the autodefragment is
1231 * close or the filesystem is read only.
1232 */
1233 if (btrfs_raw_test_opt(old_opts, AUTO_DEFRAG) &&
1234 (!btrfs_raw_test_opt(fs_info->mount_opt, AUTO_DEFRAG) || sb_rdonly(fs_info->sb))) {
1235 btrfs_cleanup_defrag_inodes(fs_info);
1236 }
1237
1238 /* If we toggled discard async */
1239 if (!btrfs_raw_test_opt(old_opts, DISCARD_ASYNC) &&
1240 btrfs_test_opt(fs_info, DISCARD_ASYNC))
1241 btrfs_discard_resume(fs_info);
1242 else if (btrfs_raw_test_opt(old_opts, DISCARD_ASYNC) &&
1243 !btrfs_test_opt(fs_info, DISCARD_ASYNC))
1244 btrfs_discard_cleanup(fs_info);
1245
1246 /* If we toggled space cache */
1247 if (cache_opt != btrfs_free_space_cache_v1_active(fs_info))
1248 btrfs_set_free_space_cache_v1_active(fs_info, cache_opt);
1249}
1250
1251static int btrfs_remount_rw(struct btrfs_fs_info *fs_info)
1252{
1253 int ret;
1254
1255 if (BTRFS_FS_ERROR(fs_info)) {
1256 btrfs_err(fs_info,
1257 "remounting read-write after error is not allowed");
1258 return -EINVAL;
1259 }
1260
1261 if (fs_info->fs_devices->rw_devices == 0)
1262 return -EACCES;
1263
1264 if (!btrfs_check_rw_degradable(fs_info, NULL)) {
1265 btrfs_warn(fs_info,
1266 "too many missing devices, writable remount is not allowed");
1267 return -EACCES;
1268 }
1269
1270 if (btrfs_super_log_root(fs_info->super_copy) != 0) {
1271 btrfs_warn(fs_info,
1272 "mount required to replay tree-log, cannot remount read-write");
1273 return -EINVAL;
1274 }
1275
1276 /*
1277 * NOTE: when remounting with a change that does writes, don't put it
1278 * anywhere above this point, as we are not sure to be safe to write
1279 * until we pass the above checks.
1280 */
1281 ret = btrfs_start_pre_rw_mount(fs_info);
1282 if (ret)
1283 return ret;
1284
1285 btrfs_clear_sb_rdonly(fs_info->sb);
1286
1287 set_bit(BTRFS_FS_OPEN, &fs_info->flags);
1288
1289 /*
1290 * If we've gone from readonly -> read-write, we need to get our
1291 * sync/async discard lists in the right state.
1292 */
1293 btrfs_discard_resume(fs_info);
1294
1295 return 0;
1296}
1297
1298static int btrfs_remount_ro(struct btrfs_fs_info *fs_info)
1299{
1300 /*
1301 * This also happens on 'umount -rf' or on shutdown, when the
1302 * filesystem is busy.
1303 */
1304 cancel_work_sync(&fs_info->async_reclaim_work);
1305 cancel_work_sync(&fs_info->async_data_reclaim_work);
1306
1307 btrfs_discard_cleanup(fs_info);
1308
1309 /* Wait for the uuid_scan task to finish */
1310 down(&fs_info->uuid_tree_rescan_sem);
1311 /* Avoid complains from lockdep et al. */
1312 up(&fs_info->uuid_tree_rescan_sem);
1313
1314 btrfs_set_sb_rdonly(fs_info->sb);
1315
1316 /*
1317 * Setting SB_RDONLY will put the cleaner thread to sleep at the next
1318 * loop if it's already active. If it's already asleep, we'll leave
1319 * unused block groups on disk until we're mounted read-write again
1320 * unless we clean them up here.
1321 */
1322 btrfs_delete_unused_bgs(fs_info);
1323
1324 /*
1325 * The cleaner task could be already running before we set the flag
1326 * BTRFS_FS_STATE_RO (and SB_RDONLY in the superblock). We must make
1327 * sure that after we finish the remount, i.e. after we call
1328 * btrfs_commit_super(), the cleaner can no longer start a transaction
1329 * - either because it was dropping a dead root, running delayed iputs
1330 * or deleting an unused block group (the cleaner picked a block
1331 * group from the list of unused block groups before we were able to
1332 * in the previous call to btrfs_delete_unused_bgs()).
1333 */
1334 wait_on_bit(&fs_info->flags, BTRFS_FS_CLEANER_RUNNING, TASK_UNINTERRUPTIBLE);
1335
1336 /*
1337 * We've set the superblock to RO mode, so we might have made the
1338 * cleaner task sleep without running all pending delayed iputs. Go
1339 * through all the delayed iputs here, so that if an unmount happens
1340 * without remounting RW we don't end up at finishing close_ctree()
1341 * with a non-empty list of delayed iputs.
1342 */
1343 btrfs_run_delayed_iputs(fs_info);
1344
1345 btrfs_dev_replace_suspend_for_unmount(fs_info);
1346 btrfs_scrub_cancel(fs_info);
1347 btrfs_pause_balance(fs_info);
1348
1349 /*
1350 * Pause the qgroup rescan worker if it is running. We don't want it to
1351 * be still running after we are in RO mode, as after that, by the time
1352 * we unmount, it might have left a transaction open, so we would leak
1353 * the transaction and/or crash.
1354 */
1355 btrfs_qgroup_wait_for_completion(fs_info, false);
1356
1357 return btrfs_commit_super(fs_info);
1358}
1359
1360static void btrfs_ctx_to_info(struct btrfs_fs_info *fs_info, struct btrfs_fs_context *ctx)
1361{
1362 fs_info->max_inline = ctx->max_inline;
1363 fs_info->commit_interval = ctx->commit_interval;
1364 fs_info->metadata_ratio = ctx->metadata_ratio;
1365 fs_info->thread_pool_size = ctx->thread_pool_size;
1366 fs_info->mount_opt = ctx->mount_opt;
1367 fs_info->compress_type = ctx->compress_type;
1368 fs_info->compress_level = ctx->compress_level;
1369}
1370
1371static void btrfs_info_to_ctx(struct btrfs_fs_info *fs_info, struct btrfs_fs_context *ctx)
1372{
1373 ctx->max_inline = fs_info->max_inline;
1374 ctx->commit_interval = fs_info->commit_interval;
1375 ctx->metadata_ratio = fs_info->metadata_ratio;
1376 ctx->thread_pool_size = fs_info->thread_pool_size;
1377 ctx->mount_opt = fs_info->mount_opt;
1378 ctx->compress_type = fs_info->compress_type;
1379 ctx->compress_level = fs_info->compress_level;
1380}
1381
1382#define btrfs_info_if_set(fs_info, old_ctx, opt, fmt, args...) \
1383do { \
1384 if ((!old_ctx || !btrfs_raw_test_opt(old_ctx->mount_opt, opt)) && \
1385 btrfs_raw_test_opt(fs_info->mount_opt, opt)) \
1386 btrfs_info(fs_info, fmt, ##args); \
1387} while (0)
1388
1389#define btrfs_info_if_unset(fs_info, old_ctx, opt, fmt, args...) \
1390do { \
1391 if ((old_ctx && btrfs_raw_test_opt(old_ctx->mount_opt, opt)) && \
1392 !btrfs_raw_test_opt(fs_info->mount_opt, opt)) \
1393 btrfs_info(fs_info, fmt, ##args); \
1394} while (0)
1395
1396static void btrfs_emit_options(struct btrfs_fs_info *info,
1397 struct btrfs_fs_context *old)
1398{
1399 btrfs_info_if_set(info, old, NODATASUM, "setting nodatasum");
1400 btrfs_info_if_set(info, old, DEGRADED, "allowing degraded mounts");
1401 btrfs_info_if_set(info, old, NODATASUM, "setting nodatasum");
1402 btrfs_info_if_set(info, old, SSD, "enabling ssd optimizations");
1403 btrfs_info_if_set(info, old, SSD_SPREAD, "using spread ssd allocation scheme");
1404 btrfs_info_if_set(info, old, NOBARRIER, "turning off barriers");
1405 btrfs_info_if_set(info, old, NOTREELOG, "disabling tree log");
1406 btrfs_info_if_set(info, old, NOLOGREPLAY, "disabling log replay at mount time");
1407 btrfs_info_if_set(info, old, FLUSHONCOMMIT, "turning on flush-on-commit");
1408 btrfs_info_if_set(info, old, DISCARD_SYNC, "turning on sync discard");
1409 btrfs_info_if_set(info, old, DISCARD_ASYNC, "turning on async discard");
1410 btrfs_info_if_set(info, old, FREE_SPACE_TREE, "enabling free space tree");
1411 btrfs_info_if_set(info, old, SPACE_CACHE, "enabling disk space caching");
1412 btrfs_info_if_set(info, old, CLEAR_CACHE, "force clearing of disk cache");
1413 btrfs_info_if_set(info, old, AUTO_DEFRAG, "enabling auto defrag");
1414 btrfs_info_if_set(info, old, FRAGMENT_DATA, "fragmenting data");
1415 btrfs_info_if_set(info, old, FRAGMENT_METADATA, "fragmenting metadata");
1416 btrfs_info_if_set(info, old, REF_VERIFY, "doing ref verification");
1417 btrfs_info_if_set(info, old, USEBACKUPROOT, "trying to use backup root at mount time");
1418 btrfs_info_if_set(info, old, IGNOREBADROOTS, "ignoring bad roots");
1419 btrfs_info_if_set(info, old, IGNOREDATACSUMS, "ignoring data csums");
1420
1421 btrfs_info_if_unset(info, old, NODATACOW, "setting datacow");
1422 btrfs_info_if_unset(info, old, SSD, "not using ssd optimizations");
1423 btrfs_info_if_unset(info, old, SSD_SPREAD, "not using spread ssd allocation scheme");
1424 btrfs_info_if_unset(info, old, NOBARRIER, "turning off barriers");
1425 btrfs_info_if_unset(info, old, NOTREELOG, "enabling tree log");
1426 btrfs_info_if_unset(info, old, SPACE_CACHE, "disabling disk space caching");
1427 btrfs_info_if_unset(info, old, FREE_SPACE_TREE, "disabling free space tree");
1428 btrfs_info_if_unset(info, old, AUTO_DEFRAG, "disabling auto defrag");
1429 btrfs_info_if_unset(info, old, COMPRESS, "use no compression");
1430
1431 /* Did the compression settings change? */
1432 if (btrfs_test_opt(info, COMPRESS) &&
1433 (!old ||
1434 old->compress_type != info->compress_type ||
1435 old->compress_level != info->compress_level ||
1436 (!btrfs_raw_test_opt(old->mount_opt, FORCE_COMPRESS) &&
1437 btrfs_raw_test_opt(info->mount_opt, FORCE_COMPRESS)))) {
1438 const char *compress_type = btrfs_compress_type2str(info->compress_type);
1439
1440 btrfs_info(info, "%s %s compression, level %d",
1441 btrfs_test_opt(info, FORCE_COMPRESS) ? "force" : "use",
1442 compress_type, info->compress_level);
1443 }
1444
1445 if (info->max_inline != BTRFS_DEFAULT_MAX_INLINE)
1446 btrfs_info(info, "max_inline set to %llu", info->max_inline);
1447}
1448
1449static int btrfs_reconfigure(struct fs_context *fc)
1450{
1451 struct super_block *sb = fc->root->d_sb;
1452 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
1453 struct btrfs_fs_context *ctx = fc->fs_private;
1454 struct btrfs_fs_context old_ctx;
1455 int ret = 0;
1456 bool mount_reconfigure = (fc->s_fs_info != NULL);
1457
1458 btrfs_info_to_ctx(fs_info, &old_ctx);
1459
1460 /*
1461 * This is our "bind mount" trick, we don't want to allow the user to do
1462 * anything other than mount a different ro/rw and a different subvol,
1463 * all of the mount options should be maintained.
1464 */
1465 if (mount_reconfigure)
1466 ctx->mount_opt = old_ctx.mount_opt;
1467
1468 sync_filesystem(sb);
1469 set_bit(BTRFS_FS_STATE_REMOUNTING, &fs_info->fs_state);
1470
1471 if (!mount_reconfigure &&
1472 !btrfs_check_options(fs_info, &ctx->mount_opt, fc->sb_flags))
1473 return -EINVAL;
1474
1475 ret = btrfs_check_features(fs_info, !(fc->sb_flags & SB_RDONLY));
1476 if (ret < 0)
1477 return ret;
1478
1479 btrfs_ctx_to_info(fs_info, ctx);
1480 btrfs_remount_begin(fs_info, old_ctx.mount_opt, fc->sb_flags);
1481 btrfs_resize_thread_pool(fs_info, fs_info->thread_pool_size,
1482 old_ctx.thread_pool_size);
1483
1484 if ((bool)btrfs_test_opt(fs_info, FREE_SPACE_TREE) !=
1485 (bool)btrfs_fs_compat_ro(fs_info, FREE_SPACE_TREE) &&
1486 (!sb_rdonly(sb) || (fc->sb_flags & SB_RDONLY))) {
1487 btrfs_warn(fs_info,
1488 "remount supports changing free space tree only from RO to RW");
1489 /* Make sure free space cache options match the state on disk. */
1490 if (btrfs_fs_compat_ro(fs_info, FREE_SPACE_TREE)) {
1491 btrfs_set_opt(fs_info->mount_opt, FREE_SPACE_TREE);
1492 btrfs_clear_opt(fs_info->mount_opt, SPACE_CACHE);
1493 }
1494 if (btrfs_free_space_cache_v1_active(fs_info)) {
1495 btrfs_clear_opt(fs_info->mount_opt, FREE_SPACE_TREE);
1496 btrfs_set_opt(fs_info->mount_opt, SPACE_CACHE);
1497 }
1498 }
1499
1500 ret = 0;
1501 if (!sb_rdonly(sb) && (fc->sb_flags & SB_RDONLY))
1502 ret = btrfs_remount_ro(fs_info);
1503 else if (sb_rdonly(sb) && !(fc->sb_flags & SB_RDONLY))
1504 ret = btrfs_remount_rw(fs_info);
1505 if (ret)
1506 goto restore;
1507
1508 /*
1509 * If we set the mask during the parameter parsing VFS would reject the
1510 * remount. Here we can set the mask and the value will be updated
1511 * appropriately.
1512 */
1513 if ((fc->sb_flags & SB_POSIXACL) != (sb->s_flags & SB_POSIXACL))
1514 fc->sb_flags_mask |= SB_POSIXACL;
1515
1516 btrfs_emit_options(fs_info, &old_ctx);
1517 wake_up_process(fs_info->transaction_kthread);
1518 btrfs_remount_cleanup(fs_info, old_ctx.mount_opt);
1519 btrfs_clear_oneshot_options(fs_info);
1520 clear_bit(BTRFS_FS_STATE_REMOUNTING, &fs_info->fs_state);
1521
1522 return 0;
1523restore:
1524 btrfs_ctx_to_info(fs_info, &old_ctx);
1525 btrfs_remount_cleanup(fs_info, old_ctx.mount_opt);
1526 clear_bit(BTRFS_FS_STATE_REMOUNTING, &fs_info->fs_state);
1527 return ret;
1528}
1529
1530/* Used to sort the devices by max_avail(descending sort) */
1531static int btrfs_cmp_device_free_bytes(const void *a, const void *b)
1532{
1533 const struct btrfs_device_info *dev_info1 = a;
1534 const struct btrfs_device_info *dev_info2 = b;
1535
1536 if (dev_info1->max_avail > dev_info2->max_avail)
1537 return -1;
1538 else if (dev_info1->max_avail < dev_info2->max_avail)
1539 return 1;
1540 return 0;
1541}
1542
1543/*
1544 * sort the devices by max_avail, in which max free extent size of each device
1545 * is stored.(Descending Sort)
1546 */
1547static inline void btrfs_descending_sort_devices(
1548 struct btrfs_device_info *devices,
1549 size_t nr_devices)
1550{
1551 sort(devices, nr_devices, sizeof(struct btrfs_device_info),
1552 btrfs_cmp_device_free_bytes, NULL);
1553}
1554
1555/*
1556 * The helper to calc the free space on the devices that can be used to store
1557 * file data.
1558 */
1559static inline int btrfs_calc_avail_data_space(struct btrfs_fs_info *fs_info,
1560 u64 *free_bytes)
1561{
1562 struct btrfs_device_info *devices_info;
1563 struct btrfs_fs_devices *fs_devices = fs_info->fs_devices;
1564 struct btrfs_device *device;
1565 u64 type;
1566 u64 avail_space;
1567 u64 min_stripe_size;
1568 int num_stripes = 1;
1569 int i = 0, nr_devices;
1570 const struct btrfs_raid_attr *rattr;
1571
1572 /*
1573 * We aren't under the device list lock, so this is racy-ish, but good
1574 * enough for our purposes.
1575 */
1576 nr_devices = fs_info->fs_devices->open_devices;
1577 if (!nr_devices) {
1578 smp_mb();
1579 nr_devices = fs_info->fs_devices->open_devices;
1580 ASSERT(nr_devices);
1581 if (!nr_devices) {
1582 *free_bytes = 0;
1583 return 0;
1584 }
1585 }
1586
1587 devices_info = kmalloc_array(nr_devices, sizeof(*devices_info),
1588 GFP_KERNEL);
1589 if (!devices_info)
1590 return -ENOMEM;
1591
1592 /* calc min stripe number for data space allocation */
1593 type = btrfs_data_alloc_profile(fs_info);
1594 rattr = &btrfs_raid_array[btrfs_bg_flags_to_raid_index(type)];
1595
1596 if (type & BTRFS_BLOCK_GROUP_RAID0)
1597 num_stripes = nr_devices;
1598 else if (type & BTRFS_BLOCK_GROUP_RAID1_MASK)
1599 num_stripes = rattr->ncopies;
1600 else if (type & BTRFS_BLOCK_GROUP_RAID10)
1601 num_stripes = 4;
1602
1603 /* Adjust for more than 1 stripe per device */
1604 min_stripe_size = rattr->dev_stripes * BTRFS_STRIPE_LEN;
1605
1606 rcu_read_lock();
1607 list_for_each_entry_rcu(device, &fs_devices->devices, dev_list) {
1608 if (!test_bit(BTRFS_DEV_STATE_IN_FS_METADATA,
1609 &device->dev_state) ||
1610 !device->bdev ||
1611 test_bit(BTRFS_DEV_STATE_REPLACE_TGT, &device->dev_state))
1612 continue;
1613
1614 if (i >= nr_devices)
1615 break;
1616
1617 avail_space = device->total_bytes - device->bytes_used;
1618
1619 /* align with stripe_len */
1620 avail_space = rounddown(avail_space, BTRFS_STRIPE_LEN);
1621
1622 /*
1623 * Ensure we have at least min_stripe_size on top of the
1624 * reserved space on the device.
1625 */
1626 if (avail_space <= BTRFS_DEVICE_RANGE_RESERVED + min_stripe_size)
1627 continue;
1628
1629 avail_space -= BTRFS_DEVICE_RANGE_RESERVED;
1630
1631 devices_info[i].dev = device;
1632 devices_info[i].max_avail = avail_space;
1633
1634 i++;
1635 }
1636 rcu_read_unlock();
1637
1638 nr_devices = i;
1639
1640 btrfs_descending_sort_devices(devices_info, nr_devices);
1641
1642 i = nr_devices - 1;
1643 avail_space = 0;
1644 while (nr_devices >= rattr->devs_min) {
1645 num_stripes = min(num_stripes, nr_devices);
1646
1647 if (devices_info[i].max_avail >= min_stripe_size) {
1648 int j;
1649 u64 alloc_size;
1650
1651 avail_space += devices_info[i].max_avail * num_stripes;
1652 alloc_size = devices_info[i].max_avail;
1653 for (j = i + 1 - num_stripes; j <= i; j++)
1654 devices_info[j].max_avail -= alloc_size;
1655 }
1656 i--;
1657 nr_devices--;
1658 }
1659
1660 kfree(devices_info);
1661 *free_bytes = avail_space;
1662 return 0;
1663}
1664
1665/*
1666 * Calculate numbers for 'df', pessimistic in case of mixed raid profiles.
1667 *
1668 * If there's a redundant raid level at DATA block groups, use the respective
1669 * multiplier to scale the sizes.
1670 *
1671 * Unused device space usage is based on simulating the chunk allocator
1672 * algorithm that respects the device sizes and order of allocations. This is
1673 * a close approximation of the actual use but there are other factors that may
1674 * change the result (like a new metadata chunk).
1675 *
1676 * If metadata is exhausted, f_bavail will be 0.
1677 */
1678static int btrfs_statfs(struct dentry *dentry, struct kstatfs *buf)
1679{
1680 struct btrfs_fs_info *fs_info = btrfs_sb(dentry->d_sb);
1681 struct btrfs_super_block *disk_super = fs_info->super_copy;
1682 struct btrfs_space_info *found;
1683 u64 total_used = 0;
1684 u64 total_free_data = 0;
1685 u64 total_free_meta = 0;
1686 u32 bits = fs_info->sectorsize_bits;
1687 __be32 *fsid = (__be32 *)fs_info->fs_devices->fsid;
1688 unsigned factor = 1;
1689 struct btrfs_block_rsv *block_rsv = &fs_info->global_block_rsv;
1690 int ret;
1691 u64 thresh = 0;
1692 int mixed = 0;
1693
1694 list_for_each_entry(found, &fs_info->space_info, list) {
1695 if (found->flags & BTRFS_BLOCK_GROUP_DATA) {
1696 int i;
1697
1698 total_free_data += found->disk_total - found->disk_used;
1699 total_free_data -=
1700 btrfs_account_ro_block_groups_free_space(found);
1701
1702 for (i = 0; i < BTRFS_NR_RAID_TYPES; i++) {
1703 if (!list_empty(&found->block_groups[i]))
1704 factor = btrfs_bg_type_to_factor(
1705 btrfs_raid_array[i].bg_flag);
1706 }
1707 }
1708
1709 /*
1710 * Metadata in mixed block group profiles are accounted in data
1711 */
1712 if (!mixed && found->flags & BTRFS_BLOCK_GROUP_METADATA) {
1713 if (found->flags & BTRFS_BLOCK_GROUP_DATA)
1714 mixed = 1;
1715 else
1716 total_free_meta += found->disk_total -
1717 found->disk_used;
1718 }
1719
1720 total_used += found->disk_used;
1721 }
1722
1723 buf->f_blocks = div_u64(btrfs_super_total_bytes(disk_super), factor);
1724 buf->f_blocks >>= bits;
1725 buf->f_bfree = buf->f_blocks - (div_u64(total_used, factor) >> bits);
1726
1727 /* Account global block reserve as used, it's in logical size already */
1728 spin_lock(&block_rsv->lock);
1729 /* Mixed block groups accounting is not byte-accurate, avoid overflow */
1730 if (buf->f_bfree >= block_rsv->size >> bits)
1731 buf->f_bfree -= block_rsv->size >> bits;
1732 else
1733 buf->f_bfree = 0;
1734 spin_unlock(&block_rsv->lock);
1735
1736 buf->f_bavail = div_u64(total_free_data, factor);
1737 ret = btrfs_calc_avail_data_space(fs_info, &total_free_data);
1738 if (ret)
1739 return ret;
1740 buf->f_bavail += div_u64(total_free_data, factor);
1741 buf->f_bavail = buf->f_bavail >> bits;
1742
1743 /*
1744 * We calculate the remaining metadata space minus global reserve. If
1745 * this is (supposedly) smaller than zero, there's no space. But this
1746 * does not hold in practice, the exhausted state happens where's still
1747 * some positive delta. So we apply some guesswork and compare the
1748 * delta to a 4M threshold. (Practically observed delta was ~2M.)
1749 *
1750 * We probably cannot calculate the exact threshold value because this
1751 * depends on the internal reservations requested by various
1752 * operations, so some operations that consume a few metadata will
1753 * succeed even if the Avail is zero. But this is better than the other
1754 * way around.
1755 */
1756 thresh = SZ_4M;
1757
1758 /*
1759 * We only want to claim there's no available space if we can no longer
1760 * allocate chunks for our metadata profile and our global reserve will
1761 * not fit in the free metadata space. If we aren't ->full then we
1762 * still can allocate chunks and thus are fine using the currently
1763 * calculated f_bavail.
1764 */
1765 if (!mixed && block_rsv->space_info->full &&
1766 (total_free_meta < thresh || total_free_meta - thresh < block_rsv->size))
1767 buf->f_bavail = 0;
1768
1769 buf->f_type = BTRFS_SUPER_MAGIC;
1770 buf->f_bsize = dentry->d_sb->s_blocksize;
1771 buf->f_namelen = BTRFS_NAME_LEN;
1772
1773 /* We treat it as constant endianness (it doesn't matter _which_)
1774 because we want the fsid to come out the same whether mounted
1775 on a big-endian or little-endian host */
1776 buf->f_fsid.val[0] = be32_to_cpu(fsid[0]) ^ be32_to_cpu(fsid[2]);
1777 buf->f_fsid.val[1] = be32_to_cpu(fsid[1]) ^ be32_to_cpu(fsid[3]);
1778 /* Mask in the root object ID too, to disambiguate subvols */
1779 buf->f_fsid.val[0] ^=
1780 BTRFS_I(d_inode(dentry))->root->root_key.objectid >> 32;
1781 buf->f_fsid.val[1] ^=
1782 BTRFS_I(d_inode(dentry))->root->root_key.objectid;
1783
1784 return 0;
1785}
1786
1787static int btrfs_fc_test_super(struct super_block *sb, struct fs_context *fc)
1788{
1789 struct btrfs_fs_info *p = fc->s_fs_info;
1790 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
1791
1792 return fs_info->fs_devices == p->fs_devices;
1793}
1794
1795static int btrfs_get_tree_super(struct fs_context *fc)
1796{
1797 struct btrfs_fs_info *fs_info = fc->s_fs_info;
1798 struct btrfs_fs_context *ctx = fc->fs_private;
1799 struct btrfs_fs_devices *fs_devices = NULL;
1800 struct block_device *bdev;
1801 struct btrfs_device *device;
1802 struct super_block *sb;
1803 blk_mode_t mode = btrfs_open_mode(fc);
1804 int ret;
1805
1806 btrfs_ctx_to_info(fs_info, ctx);
1807 mutex_lock(&uuid_mutex);
1808
1809 /*
1810 * With 'true' passed to btrfs_scan_one_device() (mount time) we expect
1811 * either a valid device or an error.
1812 */
1813 device = btrfs_scan_one_device(fc->source, mode, true);
1814 ASSERT(device != NULL);
1815 if (IS_ERR(device)) {
1816 mutex_unlock(&uuid_mutex);
1817 return PTR_ERR(device);
1818 }
1819
1820 fs_devices = device->fs_devices;
1821 fs_info->fs_devices = fs_devices;
1822
1823 ret = btrfs_open_devices(fs_devices, mode, &btrfs_fs_type);
1824 mutex_unlock(&uuid_mutex);
1825 if (ret)
1826 return ret;
1827
1828 if (!(fc->sb_flags & SB_RDONLY) && fs_devices->rw_devices == 0) {
1829 ret = -EACCES;
1830 goto error;
1831 }
1832
1833 bdev = fs_devices->latest_dev->bdev;
1834
1835 /*
1836 * From now on the error handling is not straightforward.
1837 *
1838 * If successful, this will transfer the fs_info into the super block,
1839 * and fc->s_fs_info will be NULL. However if there's an existing
1840 * super, we'll still have fc->s_fs_info populated. If we error
1841 * completely out it'll be cleaned up when we drop the fs_context,
1842 * otherwise it's tied to the lifetime of the super_block.
1843 */
1844 sb = sget_fc(fc, btrfs_fc_test_super, set_anon_super_fc);
1845 if (IS_ERR(sb)) {
1846 ret = PTR_ERR(sb);
1847 goto error;
1848 }
1849
1850 set_device_specific_options(fs_info);
1851
1852 if (sb->s_root) {
1853 btrfs_close_devices(fs_devices);
1854 if ((fc->sb_flags ^ sb->s_flags) & SB_RDONLY)
1855 ret = -EBUSY;
1856 } else {
1857 snprintf(sb->s_id, sizeof(sb->s_id), "%pg", bdev);
1858 shrinker_debugfs_rename(sb->s_shrink, "sb-btrfs:%s", sb->s_id);
1859 btrfs_sb(sb)->bdev_holder = &btrfs_fs_type;
1860 ret = btrfs_fill_super(sb, fs_devices, NULL);
1861 }
1862
1863 if (ret) {
1864 deactivate_locked_super(sb);
1865 return ret;
1866 }
1867
1868 btrfs_clear_oneshot_options(fs_info);
1869
1870 fc->root = dget(sb->s_root);
1871 return 0;
1872
1873error:
1874 btrfs_close_devices(fs_devices);
1875 return ret;
1876}
1877
1878/*
1879 * Ever since commit 0723a0473fb4 ("btrfs: allow mounting btrfs subvolumes
1880 * with different ro/rw options") the following works:
1881 *
1882 * (i) mount /dev/sda3 -o subvol=foo,ro /mnt/foo
1883 * (ii) mount /dev/sda3 -o subvol=bar,rw /mnt/bar
1884 *
1885 * which looks nice and innocent but is actually pretty intricate and deserves
1886 * a long comment.
1887 *
1888 * On another filesystem a subvolume mount is close to something like:
1889 *
1890 * (iii) # create rw superblock + initial mount
1891 * mount -t xfs /dev/sdb /opt/
1892 *
1893 * # create ro bind mount
1894 * mount --bind -o ro /opt/foo /mnt/foo
1895 *
1896 * # unmount initial mount
1897 * umount /opt
1898 *
1899 * Of course, there's some special subvolume sauce and there's the fact that the
1900 * sb->s_root dentry is really swapped after mount_subtree(). But conceptually
1901 * it's very close and will help us understand the issue.
1902 *
1903 * The old mount API didn't cleanly distinguish between a mount being made ro
1904 * and a superblock being made ro. The only way to change the ro state of
1905 * either object was by passing ms_rdonly. If a new mount was created via
1906 * mount(2) such as:
1907 *
1908 * mount("/dev/sdb", "/mnt", "xfs", ms_rdonly, null);
1909 *
1910 * the MS_RDONLY flag being specified had two effects:
1911 *
1912 * (1) MNT_READONLY was raised -> the resulting mount got
1913 * @mnt->mnt_flags |= MNT_READONLY raised.
1914 *
1915 * (2) MS_RDONLY was passed to the filesystem's mount method and the filesystems
1916 * made the superblock ro. Note, how SB_RDONLY has the same value as
1917 * ms_rdonly and is raised whenever MS_RDONLY is passed through mount(2).
1918 *
1919 * Creating a subtree mount via (iii) ends up leaving a rw superblock with a
1920 * subtree mounted ro.
1921 *
1922 * But consider the effect on the old mount API on btrfs subvolume mounting
1923 * which combines the distinct step in (iii) into a single step.
1924 *
1925 * By issuing (i) both the mount and the superblock are turned ro. Now when (ii)
1926 * is issued the superblock is ro and thus even if the mount created for (ii) is
1927 * rw it wouldn't help. Hence, btrfs needed to transition the superblock from ro
1928 * to rw for (ii) which it did using an internal remount call.
1929 *
1930 * IOW, subvolume mounting was inherently complicated due to the ambiguity of
1931 * MS_RDONLY in mount(2). Note, this ambiguity has mount(8) always translate
1932 * "ro" to MS_RDONLY. IOW, in both (i) and (ii) "ro" becomes MS_RDONLY when
1933 * passed by mount(8) to mount(2).
1934 *
1935 * Enter the new mount API. The new mount API disambiguates making a mount ro
1936 * and making a superblock ro.
1937 *
1938 * (3) To turn a mount ro the MOUNT_ATTR_ONLY flag can be used with either
1939 * fsmount() or mount_setattr() this is a pure VFS level change for a
1940 * specific mount or mount tree that is never seen by the filesystem itself.
1941 *
1942 * (4) To turn a superblock ro the "ro" flag must be used with
1943 * fsconfig(FSCONFIG_SET_FLAG, "ro"). This option is seen by the filesystem
1944 * in fc->sb_flags.
1945 *
1946 * This disambiguation has rather positive consequences. Mounting a subvolume
1947 * ro will not also turn the superblock ro. Only the mount for the subvolume
1948 * will become ro.
1949 *
1950 * So, if the superblock creation request comes from the new mount API the
1951 * caller must have explicitly done:
1952 *
1953 * fsconfig(FSCONFIG_SET_FLAG, "ro")
1954 * fsmount/mount_setattr(MOUNT_ATTR_RDONLY)
1955 *
1956 * IOW, at some point the caller must have explicitly turned the whole
1957 * superblock ro and we shouldn't just undo it like we did for the old mount
1958 * API. In any case, it lets us avoid the hack in the new mount API.
1959 *
1960 * Consequently, the remounting hack must only be used for requests originating
1961 * from the old mount API and should be marked for full deprecation so it can be
1962 * turned off in a couple of years.
1963 *
1964 * The new mount API has no reason to support this hack.
1965 */
1966static struct vfsmount *btrfs_reconfigure_for_mount(struct fs_context *fc)
1967{
1968 struct vfsmount *mnt;
1969 int ret;
1970 const bool ro2rw = !(fc->sb_flags & SB_RDONLY);
1971
1972 /*
1973 * We got an EBUSY because our SB_RDONLY flag didn't match the existing
1974 * super block, so invert our setting here and retry the mount so we
1975 * can get our vfsmount.
1976 */
1977 if (ro2rw)
1978 fc->sb_flags |= SB_RDONLY;
1979 else
1980 fc->sb_flags &= ~SB_RDONLY;
1981
1982 mnt = fc_mount(fc);
1983 if (IS_ERR(mnt))
1984 return mnt;
1985
1986 if (!fc->oldapi || !ro2rw)
1987 return mnt;
1988
1989 /* We need to convert to rw, call reconfigure. */
1990 fc->sb_flags &= ~SB_RDONLY;
1991 down_write(&mnt->mnt_sb->s_umount);
1992 ret = btrfs_reconfigure(fc);
1993 up_write(&mnt->mnt_sb->s_umount);
1994 if (ret) {
1995 mntput(mnt);
1996 return ERR_PTR(ret);
1997 }
1998 return mnt;
1999}
2000
2001static int btrfs_get_tree_subvol(struct fs_context *fc)
2002{
2003 struct btrfs_fs_info *fs_info = NULL;
2004 struct btrfs_fs_context *ctx = fc->fs_private;
2005 struct fs_context *dup_fc;
2006 struct dentry *dentry;
2007 struct vfsmount *mnt;
2008
2009 /*
2010 * Setup a dummy root and fs_info for test/set super. This is because
2011 * we don't actually fill this stuff out until open_ctree, but we need
2012 * then open_ctree will properly initialize the file system specific
2013 * settings later. btrfs_init_fs_info initializes the static elements
2014 * of the fs_info (locks and such) to make cleanup easier if we find a
2015 * superblock with our given fs_devices later on at sget() time.
2016 */
2017 fs_info = kvzalloc(sizeof(struct btrfs_fs_info), GFP_KERNEL);
2018 if (!fs_info)
2019 return -ENOMEM;
2020
2021 fs_info->super_copy = kzalloc(BTRFS_SUPER_INFO_SIZE, GFP_KERNEL);
2022 fs_info->super_for_commit = kzalloc(BTRFS_SUPER_INFO_SIZE, GFP_KERNEL);
2023 if (!fs_info->super_copy || !fs_info->super_for_commit) {
2024 btrfs_free_fs_info(fs_info);
2025 return -ENOMEM;
2026 }
2027 btrfs_init_fs_info(fs_info);
2028
2029 dup_fc = vfs_dup_fs_context(fc);
2030 if (IS_ERR(dup_fc)) {
2031 btrfs_free_fs_info(fs_info);
2032 return PTR_ERR(dup_fc);
2033 }
2034
2035 /*
2036 * When we do the sget_fc this gets transferred to the sb, so we only
2037 * need to set it on the dup_fc as this is what creates the super block.
2038 */
2039 dup_fc->s_fs_info = fs_info;
2040
2041 /*
2042 * We'll do the security settings in our btrfs_get_tree_super() mount
2043 * loop, they were duplicated into dup_fc, we can drop the originals
2044 * here.
2045 */
2046 security_free_mnt_opts(&fc->security);
2047 fc->security = NULL;
2048
2049 mnt = fc_mount(dup_fc);
2050 if (PTR_ERR_OR_ZERO(mnt) == -EBUSY)
2051 mnt = btrfs_reconfigure_for_mount(dup_fc);
2052 put_fs_context(dup_fc);
2053 if (IS_ERR(mnt))
2054 return PTR_ERR(mnt);
2055
2056 /*
2057 * This free's ->subvol_name, because if it isn't set we have to
2058 * allocate a buffer to hold the subvol_name, so we just drop our
2059 * reference to it here.
2060 */
2061 dentry = mount_subvol(ctx->subvol_name, ctx->subvol_objectid, mnt);
2062 ctx->subvol_name = NULL;
2063 if (IS_ERR(dentry))
2064 return PTR_ERR(dentry);
2065
2066 fc->root = dentry;
2067 return 0;
2068}
2069
2070static int btrfs_get_tree(struct fs_context *fc)
2071{
2072 /*
2073 * Since we use mount_subtree to mount the default/specified subvol, we
2074 * have to do mounts in two steps.
2075 *
2076 * First pass through we call btrfs_get_tree_subvol(), this is just a
2077 * wrapper around fc_mount() to call back into here again, and this time
2078 * we'll call btrfs_get_tree_super(). This will do the open_ctree() and
2079 * everything to open the devices and file system. Then we return back
2080 * with a fully constructed vfsmount in btrfs_get_tree_subvol(), and
2081 * from there we can do our mount_subvol() call, which will lookup
2082 * whichever subvol we're mounting and setup this fc with the
2083 * appropriate dentry for the subvol.
2084 */
2085 if (fc->s_fs_info)
2086 return btrfs_get_tree_super(fc);
2087 return btrfs_get_tree_subvol(fc);
2088}
2089
2090static void btrfs_kill_super(struct super_block *sb)
2091{
2092 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
2093 kill_anon_super(sb);
2094 btrfs_free_fs_info(fs_info);
2095}
2096
2097static void btrfs_free_fs_context(struct fs_context *fc)
2098{
2099 struct btrfs_fs_context *ctx = fc->fs_private;
2100 struct btrfs_fs_info *fs_info = fc->s_fs_info;
2101
2102 if (fs_info)
2103 btrfs_free_fs_info(fs_info);
2104
2105 if (ctx && refcount_dec_and_test(&ctx->refs)) {
2106 kfree(ctx->subvol_name);
2107 kfree(ctx);
2108 }
2109}
2110
2111static int btrfs_dup_fs_context(struct fs_context *fc, struct fs_context *src_fc)
2112{
2113 struct btrfs_fs_context *ctx = src_fc->fs_private;
2114
2115 /*
2116 * Give a ref to our ctx to this dup, as we want to keep it around for
2117 * our original fc so we can have the subvolume name or objectid.
2118 *
2119 * We unset ->source in the original fc because the dup needs it for
2120 * mounting, and then once we free the dup it'll free ->source, so we
2121 * need to make sure we're only pointing to it in one fc.
2122 */
2123 refcount_inc(&ctx->refs);
2124 fc->fs_private = ctx;
2125 fc->source = src_fc->source;
2126 src_fc->source = NULL;
2127 return 0;
2128}
2129
2130static const struct fs_context_operations btrfs_fs_context_ops = {
2131 .parse_param = btrfs_parse_param,
2132 .reconfigure = btrfs_reconfigure,
2133 .get_tree = btrfs_get_tree,
2134 .dup = btrfs_dup_fs_context,
2135 .free = btrfs_free_fs_context,
2136};
2137
2138static int btrfs_init_fs_context(struct fs_context *fc)
2139{
2140 struct btrfs_fs_context *ctx;
2141
2142 ctx = kzalloc(sizeof(struct btrfs_fs_context), GFP_KERNEL);
2143 if (!ctx)
2144 return -ENOMEM;
2145
2146 refcount_set(&ctx->refs, 1);
2147 fc->fs_private = ctx;
2148 fc->ops = &btrfs_fs_context_ops;
2149
2150 if (fc->purpose == FS_CONTEXT_FOR_RECONFIGURE) {
2151 btrfs_info_to_ctx(btrfs_sb(fc->root->d_sb), ctx);
2152 } else {
2153 ctx->thread_pool_size =
2154 min_t(unsigned long, num_online_cpus() + 2, 8);
2155 ctx->max_inline = BTRFS_DEFAULT_MAX_INLINE;
2156 ctx->commit_interval = BTRFS_DEFAULT_COMMIT_INTERVAL;
2157 }
2158
2159#ifdef CONFIG_BTRFS_FS_POSIX_ACL
2160 fc->sb_flags |= SB_POSIXACL;
2161#endif
2162 fc->sb_flags |= SB_I_VERSION;
2163
2164 return 0;
2165}
2166
2167static struct file_system_type btrfs_fs_type = {
2168 .owner = THIS_MODULE,
2169 .name = "btrfs",
2170 .init_fs_context = btrfs_init_fs_context,
2171 .parameters = btrfs_fs_parameters,
2172 .kill_sb = btrfs_kill_super,
2173 .fs_flags = FS_REQUIRES_DEV | FS_BINARY_MOUNTDATA | FS_ALLOW_IDMAP,
2174 };
2175
2176MODULE_ALIAS_FS("btrfs");
2177
2178static int btrfs_control_open(struct inode *inode, struct file *file)
2179{
2180 /*
2181 * The control file's private_data is used to hold the
2182 * transaction when it is started and is used to keep
2183 * track of whether a transaction is already in progress.
2184 */
2185 file->private_data = NULL;
2186 return 0;
2187}
2188
2189/*
2190 * Used by /dev/btrfs-control for devices ioctls.
2191 */
2192static long btrfs_control_ioctl(struct file *file, unsigned int cmd,
2193 unsigned long arg)
2194{
2195 struct btrfs_ioctl_vol_args *vol;
2196 struct btrfs_device *device = NULL;
2197 dev_t devt = 0;
2198 int ret = -ENOTTY;
2199
2200 if (!capable(CAP_SYS_ADMIN))
2201 return -EPERM;
2202
2203 vol = memdup_user((void __user *)arg, sizeof(*vol));
2204 if (IS_ERR(vol))
2205 return PTR_ERR(vol);
2206 vol->name[BTRFS_PATH_NAME_MAX] = '\0';
2207
2208 switch (cmd) {
2209 case BTRFS_IOC_SCAN_DEV:
2210 mutex_lock(&uuid_mutex);
2211 /*
2212 * Scanning outside of mount can return NULL which would turn
2213 * into 0 error code.
2214 */
2215 device = btrfs_scan_one_device(vol->name, BLK_OPEN_READ, false);
2216 ret = PTR_ERR_OR_ZERO(device);
2217 mutex_unlock(&uuid_mutex);
2218 break;
2219 case BTRFS_IOC_FORGET_DEV:
2220 if (vol->name[0] != 0) {
2221 ret = lookup_bdev(vol->name, &devt);
2222 if (ret)
2223 break;
2224 }
2225 ret = btrfs_forget_devices(devt);
2226 break;
2227 case BTRFS_IOC_DEVICES_READY:
2228 mutex_lock(&uuid_mutex);
2229 /*
2230 * Scanning outside of mount can return NULL which would turn
2231 * into 0 error code.
2232 */
2233 device = btrfs_scan_one_device(vol->name, BLK_OPEN_READ, false);
2234 if (IS_ERR_OR_NULL(device)) {
2235 mutex_unlock(&uuid_mutex);
2236 ret = PTR_ERR(device);
2237 break;
2238 }
2239 ret = !(device->fs_devices->num_devices ==
2240 device->fs_devices->total_devices);
2241 mutex_unlock(&uuid_mutex);
2242 break;
2243 case BTRFS_IOC_GET_SUPPORTED_FEATURES:
2244 ret = btrfs_ioctl_get_supported_features((void __user*)arg);
2245 break;
2246 }
2247
2248 kfree(vol);
2249 return ret;
2250}
2251
2252static int btrfs_freeze(struct super_block *sb)
2253{
2254 struct btrfs_trans_handle *trans;
2255 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
2256 struct btrfs_root *root = fs_info->tree_root;
2257
2258 set_bit(BTRFS_FS_FROZEN, &fs_info->flags);
2259 /*
2260 * We don't need a barrier here, we'll wait for any transaction that
2261 * could be in progress on other threads (and do delayed iputs that
2262 * we want to avoid on a frozen filesystem), or do the commit
2263 * ourselves.
2264 */
2265 trans = btrfs_attach_transaction_barrier(root);
2266 if (IS_ERR(trans)) {
2267 /* no transaction, don't bother */
2268 if (PTR_ERR(trans) == -ENOENT)
2269 return 0;
2270 return PTR_ERR(trans);
2271 }
2272 return btrfs_commit_transaction(trans);
2273}
2274
2275static int check_dev_super(struct btrfs_device *dev)
2276{
2277 struct btrfs_fs_info *fs_info = dev->fs_info;
2278 struct btrfs_super_block *sb;
2279 u64 last_trans;
2280 u16 csum_type;
2281 int ret = 0;
2282
2283 /* This should be called with fs still frozen. */
2284 ASSERT(test_bit(BTRFS_FS_FROZEN, &fs_info->flags));
2285
2286 /* Missing dev, no need to check. */
2287 if (!dev->bdev)
2288 return 0;
2289
2290 /* Only need to check the primary super block. */
2291 sb = btrfs_read_dev_one_super(dev->bdev, 0, true);
2292 if (IS_ERR(sb))
2293 return PTR_ERR(sb);
2294
2295 /* Verify the checksum. */
2296 csum_type = btrfs_super_csum_type(sb);
2297 if (csum_type != btrfs_super_csum_type(fs_info->super_copy)) {
2298 btrfs_err(fs_info, "csum type changed, has %u expect %u",
2299 csum_type, btrfs_super_csum_type(fs_info->super_copy));
2300 ret = -EUCLEAN;
2301 goto out;
2302 }
2303
2304 if (btrfs_check_super_csum(fs_info, sb)) {
2305 btrfs_err(fs_info, "csum for on-disk super block no longer matches");
2306 ret = -EUCLEAN;
2307 goto out;
2308 }
2309
2310 /* Btrfs_validate_super() includes fsid check against super->fsid. */
2311 ret = btrfs_validate_super(fs_info, sb, 0);
2312 if (ret < 0)
2313 goto out;
2314
2315 last_trans = btrfs_get_last_trans_committed(fs_info);
2316 if (btrfs_super_generation(sb) != last_trans) {
2317 btrfs_err(fs_info, "transid mismatch, has %llu expect %llu",
2318 btrfs_super_generation(sb), last_trans);
2319 ret = -EUCLEAN;
2320 goto out;
2321 }
2322out:
2323 btrfs_release_disk_super(sb);
2324 return ret;
2325}
2326
2327static int btrfs_unfreeze(struct super_block *sb)
2328{
2329 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
2330 struct btrfs_device *device;
2331 int ret = 0;
2332
2333 /*
2334 * Make sure the fs is not changed by accident (like hibernation then
2335 * modified by other OS).
2336 * If we found anything wrong, we mark the fs error immediately.
2337 *
2338 * And since the fs is frozen, no one can modify the fs yet, thus
2339 * we don't need to hold device_list_mutex.
2340 */
2341 list_for_each_entry(device, &fs_info->fs_devices->devices, dev_list) {
2342 ret = check_dev_super(device);
2343 if (ret < 0) {
2344 btrfs_handle_fs_error(fs_info, ret,
2345 "super block on devid %llu got modified unexpectedly",
2346 device->devid);
2347 break;
2348 }
2349 }
2350 clear_bit(BTRFS_FS_FROZEN, &fs_info->flags);
2351
2352 /*
2353 * We still return 0, to allow VFS layer to unfreeze the fs even the
2354 * above checks failed. Since the fs is either fine or read-only, we're
2355 * safe to continue, without causing further damage.
2356 */
2357 return 0;
2358}
2359
2360static int btrfs_show_devname(struct seq_file *m, struct dentry *root)
2361{
2362 struct btrfs_fs_info *fs_info = btrfs_sb(root->d_sb);
2363
2364 /*
2365 * There should be always a valid pointer in latest_dev, it may be stale
2366 * for a short moment in case it's being deleted but still valid until
2367 * the end of RCU grace period.
2368 */
2369 rcu_read_lock();
2370 seq_escape(m, btrfs_dev_name(fs_info->fs_devices->latest_dev), " \t\n\\");
2371 rcu_read_unlock();
2372
2373 return 0;
2374}
2375
2376static const struct super_operations btrfs_super_ops = {
2377 .drop_inode = btrfs_drop_inode,
2378 .evict_inode = btrfs_evict_inode,
2379 .put_super = btrfs_put_super,
2380 .sync_fs = btrfs_sync_fs,
2381 .show_options = btrfs_show_options,
2382 .show_devname = btrfs_show_devname,
2383 .alloc_inode = btrfs_alloc_inode,
2384 .destroy_inode = btrfs_destroy_inode,
2385 .free_inode = btrfs_free_inode,
2386 .statfs = btrfs_statfs,
2387 .freeze_fs = btrfs_freeze,
2388 .unfreeze_fs = btrfs_unfreeze,
2389};
2390
2391static const struct file_operations btrfs_ctl_fops = {
2392 .open = btrfs_control_open,
2393 .unlocked_ioctl = btrfs_control_ioctl,
2394 .compat_ioctl = compat_ptr_ioctl,
2395 .owner = THIS_MODULE,
2396 .llseek = noop_llseek,
2397};
2398
2399static struct miscdevice btrfs_misc = {
2400 .minor = BTRFS_MINOR,
2401 .name = "btrfs-control",
2402 .fops = &btrfs_ctl_fops
2403};
2404
2405MODULE_ALIAS_MISCDEV(BTRFS_MINOR);
2406MODULE_ALIAS("devname:btrfs-control");
2407
2408static int __init btrfs_interface_init(void)
2409{
2410 return misc_register(&btrfs_misc);
2411}
2412
2413static __cold void btrfs_interface_exit(void)
2414{
2415 misc_deregister(&btrfs_misc);
2416}
2417
2418static int __init btrfs_print_mod_info(void)
2419{
2420 static const char options[] = ""
2421#ifdef CONFIG_BTRFS_DEBUG
2422 ", debug=on"
2423#endif
2424#ifdef CONFIG_BTRFS_ASSERT
2425 ", assert=on"
2426#endif
2427#ifdef CONFIG_BTRFS_FS_REF_VERIFY
2428 ", ref-verify=on"
2429#endif
2430#ifdef CONFIG_BLK_DEV_ZONED
2431 ", zoned=yes"
2432#else
2433 ", zoned=no"
2434#endif
2435#ifdef CONFIG_FS_VERITY
2436 ", fsverity=yes"
2437#else
2438 ", fsverity=no"
2439#endif
2440 ;
2441 pr_info("Btrfs loaded%s\n", options);
2442 return 0;
2443}
2444
2445static int register_btrfs(void)
2446{
2447 return register_filesystem(&btrfs_fs_type);
2448}
2449
2450static void unregister_btrfs(void)
2451{
2452 unregister_filesystem(&btrfs_fs_type);
2453}
2454
2455/* Helper structure for long init/exit functions. */
2456struct init_sequence {
2457 int (*init_func)(void);
2458 /* Can be NULL if the init_func doesn't need cleanup. */
2459 void (*exit_func)(void);
2460};
2461
2462static const struct init_sequence mod_init_seq[] = {
2463 {
2464 .init_func = btrfs_props_init,
2465 .exit_func = NULL,
2466 }, {
2467 .init_func = btrfs_init_sysfs,
2468 .exit_func = btrfs_exit_sysfs,
2469 }, {
2470 .init_func = btrfs_init_compress,
2471 .exit_func = btrfs_exit_compress,
2472 }, {
2473 .init_func = btrfs_init_cachep,
2474 .exit_func = btrfs_destroy_cachep,
2475 }, {
2476 .init_func = btrfs_transaction_init,
2477 .exit_func = btrfs_transaction_exit,
2478 }, {
2479 .init_func = btrfs_ctree_init,
2480 .exit_func = btrfs_ctree_exit,
2481 }, {
2482 .init_func = btrfs_free_space_init,
2483 .exit_func = btrfs_free_space_exit,
2484 }, {
2485 .init_func = extent_state_init_cachep,
2486 .exit_func = extent_state_free_cachep,
2487 }, {
2488 .init_func = extent_buffer_init_cachep,
2489 .exit_func = extent_buffer_free_cachep,
2490 }, {
2491 .init_func = btrfs_bioset_init,
2492 .exit_func = btrfs_bioset_exit,
2493 }, {
2494 .init_func = extent_map_init,
2495 .exit_func = extent_map_exit,
2496 }, {
2497 .init_func = ordered_data_init,
2498 .exit_func = ordered_data_exit,
2499 }, {
2500 .init_func = btrfs_delayed_inode_init,
2501 .exit_func = btrfs_delayed_inode_exit,
2502 }, {
2503 .init_func = btrfs_auto_defrag_init,
2504 .exit_func = btrfs_auto_defrag_exit,
2505 }, {
2506 .init_func = btrfs_delayed_ref_init,
2507 .exit_func = btrfs_delayed_ref_exit,
2508 }, {
2509 .init_func = btrfs_prelim_ref_init,
2510 .exit_func = btrfs_prelim_ref_exit,
2511 }, {
2512 .init_func = btrfs_interface_init,
2513 .exit_func = btrfs_interface_exit,
2514 }, {
2515 .init_func = btrfs_print_mod_info,
2516 .exit_func = NULL,
2517 }, {
2518 .init_func = btrfs_run_sanity_tests,
2519 .exit_func = NULL,
2520 }, {
2521 .init_func = register_btrfs,
2522 .exit_func = unregister_btrfs,
2523 }
2524};
2525
2526static bool mod_init_result[ARRAY_SIZE(mod_init_seq)];
2527
2528static __always_inline void btrfs_exit_btrfs_fs(void)
2529{
2530 int i;
2531
2532 for (i = ARRAY_SIZE(mod_init_seq) - 1; i >= 0; i--) {
2533 if (!mod_init_result[i])
2534 continue;
2535 if (mod_init_seq[i].exit_func)
2536 mod_init_seq[i].exit_func();
2537 mod_init_result[i] = false;
2538 }
2539}
2540
2541static void __exit exit_btrfs_fs(void)
2542{
2543 btrfs_exit_btrfs_fs();
2544 btrfs_cleanup_fs_uuids();
2545}
2546
2547static int __init init_btrfs_fs(void)
2548{
2549 int ret;
2550 int i;
2551
2552 for (i = 0; i < ARRAY_SIZE(mod_init_seq); i++) {
2553 ASSERT(!mod_init_result[i]);
2554 ret = mod_init_seq[i].init_func();
2555 if (ret < 0) {
2556 btrfs_exit_btrfs_fs();
2557 return ret;
2558 }
2559 mod_init_result[i] = true;
2560 }
2561 return 0;
2562}
2563
2564late_initcall(init_btrfs_fs);
2565module_exit(exit_btrfs_fs)
2566
2567MODULE_LICENSE("GPL");
2568MODULE_SOFTDEP("pre: crc32c");
2569MODULE_SOFTDEP("pre: xxhash64");
2570MODULE_SOFTDEP("pre: sha256");
2571MODULE_SOFTDEP("pre: blake2b-256");
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) 2007 Oracle. All rights reserved.
4 */
5
6#include <linux/blkdev.h>
7#include <linux/module.h>
8#include <linux/fs.h>
9#include <linux/pagemap.h>
10#include <linux/highmem.h>
11#include <linux/time.h>
12#include <linux/init.h>
13#include <linux/seq_file.h>
14#include <linux/string.h>
15#include <linux/backing-dev.h>
16#include <linux/mount.h>
17#include <linux/writeback.h>
18#include <linux/statfs.h>
19#include <linux/compat.h>
20#include <linux/parser.h>
21#include <linux/ctype.h>
22#include <linux/namei.h>
23#include <linux/miscdevice.h>
24#include <linux/magic.h>
25#include <linux/slab.h>
26#include <linux/ratelimit.h>
27#include <linux/crc32c.h>
28#include <linux/btrfs.h>
29#include <linux/security.h>
30#include <linux/fs_parser.h>
31#include "messages.h"
32#include "delayed-inode.h"
33#include "ctree.h"
34#include "disk-io.h"
35#include "transaction.h"
36#include "btrfs_inode.h"
37#include "direct-io.h"
38#include "props.h"
39#include "xattr.h"
40#include "bio.h"
41#include "export.h"
42#include "compression.h"
43#include "dev-replace.h"
44#include "free-space-cache.h"
45#include "backref.h"
46#include "space-info.h"
47#include "sysfs.h"
48#include "zoned.h"
49#include "tests/btrfs-tests.h"
50#include "block-group.h"
51#include "discard.h"
52#include "qgroup.h"
53#include "raid56.h"
54#include "fs.h"
55#include "accessors.h"
56#include "defrag.h"
57#include "dir-item.h"
58#include "ioctl.h"
59#include "scrub.h"
60#include "verity.h"
61#include "super.h"
62#include "extent-tree.h"
63#define CREATE_TRACE_POINTS
64#include <trace/events/btrfs.h>
65
66static const struct super_operations btrfs_super_ops;
67static struct file_system_type btrfs_fs_type;
68
69static void btrfs_put_super(struct super_block *sb)
70{
71 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
72
73 btrfs_info(fs_info, "last unmount of filesystem %pU", fs_info->fs_devices->fsid);
74 close_ctree(fs_info);
75}
76
77/* Store the mount options related information. */
78struct btrfs_fs_context {
79 char *subvol_name;
80 u64 subvol_objectid;
81 u64 max_inline;
82 u32 commit_interval;
83 u32 metadata_ratio;
84 u32 thread_pool_size;
85 unsigned long long mount_opt;
86 unsigned long compress_type:4;
87 unsigned int compress_level;
88 refcount_t refs;
89};
90
91enum {
92 Opt_acl,
93 Opt_clear_cache,
94 Opt_commit_interval,
95 Opt_compress,
96 Opt_compress_force,
97 Opt_compress_force_type,
98 Opt_compress_type,
99 Opt_degraded,
100 Opt_device,
101 Opt_fatal_errors,
102 Opt_flushoncommit,
103 Opt_max_inline,
104 Opt_barrier,
105 Opt_datacow,
106 Opt_datasum,
107 Opt_defrag,
108 Opt_discard,
109 Opt_discard_mode,
110 Opt_ratio,
111 Opt_rescan_uuid_tree,
112 Opt_skip_balance,
113 Opt_space_cache,
114 Opt_space_cache_version,
115 Opt_ssd,
116 Opt_ssd_spread,
117 Opt_subvol,
118 Opt_subvol_empty,
119 Opt_subvolid,
120 Opt_thread_pool,
121 Opt_treelog,
122 Opt_user_subvol_rm_allowed,
123 Opt_norecovery,
124
125 /* Rescue options */
126 Opt_rescue,
127 Opt_usebackuproot,
128 Opt_nologreplay,
129
130 /* Debugging options */
131 Opt_enospc_debug,
132#ifdef CONFIG_BTRFS_DEBUG
133 Opt_fragment, Opt_fragment_data, Opt_fragment_metadata, Opt_fragment_all,
134#endif
135#ifdef CONFIG_BTRFS_FS_REF_VERIFY
136 Opt_ref_verify,
137#endif
138 Opt_err,
139};
140
141enum {
142 Opt_fatal_errors_panic,
143 Opt_fatal_errors_bug,
144};
145
146static const struct constant_table btrfs_parameter_fatal_errors[] = {
147 { "panic", Opt_fatal_errors_panic },
148 { "bug", Opt_fatal_errors_bug },
149 {}
150};
151
152enum {
153 Opt_discard_sync,
154 Opt_discard_async,
155};
156
157static const struct constant_table btrfs_parameter_discard[] = {
158 { "sync", Opt_discard_sync },
159 { "async", Opt_discard_async },
160 {}
161};
162
163enum {
164 Opt_space_cache_v1,
165 Opt_space_cache_v2,
166};
167
168static const struct constant_table btrfs_parameter_space_cache[] = {
169 { "v1", Opt_space_cache_v1 },
170 { "v2", Opt_space_cache_v2 },
171 {}
172};
173
174enum {
175 Opt_rescue_usebackuproot,
176 Opt_rescue_nologreplay,
177 Opt_rescue_ignorebadroots,
178 Opt_rescue_ignoredatacsums,
179 Opt_rescue_ignoremetacsums,
180 Opt_rescue_ignoresuperflags,
181 Opt_rescue_parameter_all,
182};
183
184static const struct constant_table btrfs_parameter_rescue[] = {
185 { "usebackuproot", Opt_rescue_usebackuproot },
186 { "nologreplay", Opt_rescue_nologreplay },
187 { "ignorebadroots", Opt_rescue_ignorebadroots },
188 { "ibadroots", Opt_rescue_ignorebadroots },
189 { "ignoredatacsums", Opt_rescue_ignoredatacsums },
190 { "ignoremetacsums", Opt_rescue_ignoremetacsums},
191 { "ignoresuperflags", Opt_rescue_ignoresuperflags},
192 { "idatacsums", Opt_rescue_ignoredatacsums },
193 { "imetacsums", Opt_rescue_ignoremetacsums},
194 { "isuperflags", Opt_rescue_ignoresuperflags},
195 { "all", Opt_rescue_parameter_all },
196 {}
197};
198
199#ifdef CONFIG_BTRFS_DEBUG
200enum {
201 Opt_fragment_parameter_data,
202 Opt_fragment_parameter_metadata,
203 Opt_fragment_parameter_all,
204};
205
206static const struct constant_table btrfs_parameter_fragment[] = {
207 { "data", Opt_fragment_parameter_data },
208 { "metadata", Opt_fragment_parameter_metadata },
209 { "all", Opt_fragment_parameter_all },
210 {}
211};
212#endif
213
214static const struct fs_parameter_spec btrfs_fs_parameters[] = {
215 fsparam_flag_no("acl", Opt_acl),
216 fsparam_flag_no("autodefrag", Opt_defrag),
217 fsparam_flag_no("barrier", Opt_barrier),
218 fsparam_flag("clear_cache", Opt_clear_cache),
219 fsparam_u32("commit", Opt_commit_interval),
220 fsparam_flag("compress", Opt_compress),
221 fsparam_string("compress", Opt_compress_type),
222 fsparam_flag("compress-force", Opt_compress_force),
223 fsparam_string("compress-force", Opt_compress_force_type),
224 fsparam_flag_no("datacow", Opt_datacow),
225 fsparam_flag_no("datasum", Opt_datasum),
226 fsparam_flag("degraded", Opt_degraded),
227 fsparam_string("device", Opt_device),
228 fsparam_flag_no("discard", Opt_discard),
229 fsparam_enum("discard", Opt_discard_mode, btrfs_parameter_discard),
230 fsparam_enum("fatal_errors", Opt_fatal_errors, btrfs_parameter_fatal_errors),
231 fsparam_flag_no("flushoncommit", Opt_flushoncommit),
232 fsparam_string("max_inline", Opt_max_inline),
233 fsparam_u32("metadata_ratio", Opt_ratio),
234 fsparam_flag("rescan_uuid_tree", Opt_rescan_uuid_tree),
235 fsparam_flag("skip_balance", Opt_skip_balance),
236 fsparam_flag_no("space_cache", Opt_space_cache),
237 fsparam_enum("space_cache", Opt_space_cache_version, btrfs_parameter_space_cache),
238 fsparam_flag_no("ssd", Opt_ssd),
239 fsparam_flag_no("ssd_spread", Opt_ssd_spread),
240 fsparam_string("subvol", Opt_subvol),
241 fsparam_flag("subvol=", Opt_subvol_empty),
242 fsparam_u64("subvolid", Opt_subvolid),
243 fsparam_u32("thread_pool", Opt_thread_pool),
244 fsparam_flag_no("treelog", Opt_treelog),
245 fsparam_flag("user_subvol_rm_allowed", Opt_user_subvol_rm_allowed),
246
247 /* Rescue options. */
248 fsparam_enum("rescue", Opt_rescue, btrfs_parameter_rescue),
249 /* Deprecated, with alias rescue=nologreplay */
250 __fsparam(NULL, "nologreplay", Opt_nologreplay, fs_param_deprecated, NULL),
251 /* Deprecated, with alias rescue=usebackuproot */
252 __fsparam(NULL, "usebackuproot", Opt_usebackuproot, fs_param_deprecated, NULL),
253 /* For compatibility only, alias for "rescue=nologreplay". */
254 fsparam_flag("norecovery", Opt_norecovery),
255
256 /* Debugging options. */
257 fsparam_flag_no("enospc_debug", Opt_enospc_debug),
258#ifdef CONFIG_BTRFS_DEBUG
259 fsparam_enum("fragment", Opt_fragment, btrfs_parameter_fragment),
260#endif
261#ifdef CONFIG_BTRFS_FS_REF_VERIFY
262 fsparam_flag("ref_verify", Opt_ref_verify),
263#endif
264 {}
265};
266
267/* No support for restricting writes to btrfs devices yet... */
268static inline blk_mode_t btrfs_open_mode(struct fs_context *fc)
269{
270 return sb_open_mode(fc->sb_flags) & ~BLK_OPEN_RESTRICT_WRITES;
271}
272
273static int btrfs_parse_param(struct fs_context *fc, struct fs_parameter *param)
274{
275 struct btrfs_fs_context *ctx = fc->fs_private;
276 struct fs_parse_result result;
277 int opt;
278
279 opt = fs_parse(fc, btrfs_fs_parameters, param, &result);
280 if (opt < 0)
281 return opt;
282
283 switch (opt) {
284 case Opt_degraded:
285 btrfs_set_opt(ctx->mount_opt, DEGRADED);
286 break;
287 case Opt_subvol_empty:
288 /*
289 * This exists because we used to allow it on accident, so we're
290 * keeping it to maintain ABI. See 37becec95ac3 ("Btrfs: allow
291 * empty subvol= again").
292 */
293 break;
294 case Opt_subvol:
295 kfree(ctx->subvol_name);
296 ctx->subvol_name = kstrdup(param->string, GFP_KERNEL);
297 if (!ctx->subvol_name)
298 return -ENOMEM;
299 break;
300 case Opt_subvolid:
301 ctx->subvol_objectid = result.uint_64;
302
303 /* subvolid=0 means give me the original fs_tree. */
304 if (!ctx->subvol_objectid)
305 ctx->subvol_objectid = BTRFS_FS_TREE_OBJECTID;
306 break;
307 case Opt_device: {
308 struct btrfs_device *device;
309 blk_mode_t mode = btrfs_open_mode(fc);
310
311 mutex_lock(&uuid_mutex);
312 device = btrfs_scan_one_device(param->string, mode, false);
313 mutex_unlock(&uuid_mutex);
314 if (IS_ERR(device))
315 return PTR_ERR(device);
316 break;
317 }
318 case Opt_datasum:
319 if (result.negated) {
320 btrfs_set_opt(ctx->mount_opt, NODATASUM);
321 } else {
322 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
323 btrfs_clear_opt(ctx->mount_opt, NODATASUM);
324 }
325 break;
326 case Opt_datacow:
327 if (result.negated) {
328 btrfs_clear_opt(ctx->mount_opt, COMPRESS);
329 btrfs_clear_opt(ctx->mount_opt, FORCE_COMPRESS);
330 btrfs_set_opt(ctx->mount_opt, NODATACOW);
331 btrfs_set_opt(ctx->mount_opt, NODATASUM);
332 } else {
333 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
334 }
335 break;
336 case Opt_compress_force:
337 case Opt_compress_force_type:
338 btrfs_set_opt(ctx->mount_opt, FORCE_COMPRESS);
339 fallthrough;
340 case Opt_compress:
341 case Opt_compress_type:
342 /*
343 * Provide the same semantics as older kernels that don't use fs
344 * context, specifying the "compress" option clears
345 * "force-compress" without the need to pass
346 * "compress-force=[no|none]" before specifying "compress".
347 */
348 if (opt != Opt_compress_force && opt != Opt_compress_force_type)
349 btrfs_clear_opt(ctx->mount_opt, FORCE_COMPRESS);
350
351 if (opt == Opt_compress || opt == Opt_compress_force) {
352 ctx->compress_type = BTRFS_COMPRESS_ZLIB;
353 ctx->compress_level = BTRFS_ZLIB_DEFAULT_LEVEL;
354 btrfs_set_opt(ctx->mount_opt, COMPRESS);
355 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
356 btrfs_clear_opt(ctx->mount_opt, NODATASUM);
357 } else if (strncmp(param->string, "zlib", 4) == 0) {
358 ctx->compress_type = BTRFS_COMPRESS_ZLIB;
359 ctx->compress_level =
360 btrfs_compress_str2level(BTRFS_COMPRESS_ZLIB,
361 param->string + 4);
362 btrfs_set_opt(ctx->mount_opt, COMPRESS);
363 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
364 btrfs_clear_opt(ctx->mount_opt, NODATASUM);
365 } else if (strncmp(param->string, "lzo", 3) == 0) {
366 ctx->compress_type = BTRFS_COMPRESS_LZO;
367 ctx->compress_level = 0;
368 btrfs_set_opt(ctx->mount_opt, COMPRESS);
369 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
370 btrfs_clear_opt(ctx->mount_opt, NODATASUM);
371 } else if (strncmp(param->string, "zstd", 4) == 0) {
372 ctx->compress_type = BTRFS_COMPRESS_ZSTD;
373 ctx->compress_level =
374 btrfs_compress_str2level(BTRFS_COMPRESS_ZSTD,
375 param->string + 4);
376 btrfs_set_opt(ctx->mount_opt, COMPRESS);
377 btrfs_clear_opt(ctx->mount_opt, NODATACOW);
378 btrfs_clear_opt(ctx->mount_opt, NODATASUM);
379 } else if (strncmp(param->string, "no", 2) == 0) {
380 ctx->compress_level = 0;
381 ctx->compress_type = 0;
382 btrfs_clear_opt(ctx->mount_opt, COMPRESS);
383 btrfs_clear_opt(ctx->mount_opt, FORCE_COMPRESS);
384 } else {
385 btrfs_err(NULL, "unrecognized compression value %s",
386 param->string);
387 return -EINVAL;
388 }
389 break;
390 case Opt_ssd:
391 if (result.negated) {
392 btrfs_set_opt(ctx->mount_opt, NOSSD);
393 btrfs_clear_opt(ctx->mount_opt, SSD);
394 btrfs_clear_opt(ctx->mount_opt, SSD_SPREAD);
395 } else {
396 btrfs_set_opt(ctx->mount_opt, SSD);
397 btrfs_clear_opt(ctx->mount_opt, NOSSD);
398 }
399 break;
400 case Opt_ssd_spread:
401 if (result.negated) {
402 btrfs_clear_opt(ctx->mount_opt, SSD_SPREAD);
403 } else {
404 btrfs_set_opt(ctx->mount_opt, SSD);
405 btrfs_set_opt(ctx->mount_opt, SSD_SPREAD);
406 btrfs_clear_opt(ctx->mount_opt, NOSSD);
407 }
408 break;
409 case Opt_barrier:
410 if (result.negated)
411 btrfs_set_opt(ctx->mount_opt, NOBARRIER);
412 else
413 btrfs_clear_opt(ctx->mount_opt, NOBARRIER);
414 break;
415 case Opt_thread_pool:
416 if (result.uint_32 == 0) {
417 btrfs_err(NULL, "invalid value 0 for thread_pool");
418 return -EINVAL;
419 }
420 ctx->thread_pool_size = result.uint_32;
421 break;
422 case Opt_max_inline:
423 ctx->max_inline = memparse(param->string, NULL);
424 break;
425 case Opt_acl:
426 if (result.negated) {
427 fc->sb_flags &= ~SB_POSIXACL;
428 } else {
429#ifdef CONFIG_BTRFS_FS_POSIX_ACL
430 fc->sb_flags |= SB_POSIXACL;
431#else
432 btrfs_err(NULL, "support for ACL not compiled in");
433 return -EINVAL;
434#endif
435 }
436 /*
437 * VFS limits the ability to toggle ACL on and off via remount,
438 * despite every file system allowing this. This seems to be
439 * an oversight since we all do, but it'll fail if we're
440 * remounting. So don't set the mask here, we'll check it in
441 * btrfs_reconfigure and do the toggling ourselves.
442 */
443 if (fc->purpose != FS_CONTEXT_FOR_RECONFIGURE)
444 fc->sb_flags_mask |= SB_POSIXACL;
445 break;
446 case Opt_treelog:
447 if (result.negated)
448 btrfs_set_opt(ctx->mount_opt, NOTREELOG);
449 else
450 btrfs_clear_opt(ctx->mount_opt, NOTREELOG);
451 break;
452 case Opt_nologreplay:
453 btrfs_warn(NULL,
454 "'nologreplay' is deprecated, use 'rescue=nologreplay' instead");
455 btrfs_set_opt(ctx->mount_opt, NOLOGREPLAY);
456 break;
457 case Opt_norecovery:
458 btrfs_info(NULL,
459"'norecovery' is for compatibility only, recommended to use 'rescue=nologreplay'");
460 btrfs_set_opt(ctx->mount_opt, NOLOGREPLAY);
461 break;
462 case Opt_flushoncommit:
463 if (result.negated)
464 btrfs_clear_opt(ctx->mount_opt, FLUSHONCOMMIT);
465 else
466 btrfs_set_opt(ctx->mount_opt, FLUSHONCOMMIT);
467 break;
468 case Opt_ratio:
469 ctx->metadata_ratio = result.uint_32;
470 break;
471 case Opt_discard:
472 if (result.negated) {
473 btrfs_clear_opt(ctx->mount_opt, DISCARD_SYNC);
474 btrfs_clear_opt(ctx->mount_opt, DISCARD_ASYNC);
475 btrfs_set_opt(ctx->mount_opt, NODISCARD);
476 } else {
477 btrfs_set_opt(ctx->mount_opt, DISCARD_SYNC);
478 btrfs_clear_opt(ctx->mount_opt, DISCARD_ASYNC);
479 }
480 break;
481 case Opt_discard_mode:
482 switch (result.uint_32) {
483 case Opt_discard_sync:
484 btrfs_clear_opt(ctx->mount_opt, DISCARD_ASYNC);
485 btrfs_set_opt(ctx->mount_opt, DISCARD_SYNC);
486 break;
487 case Opt_discard_async:
488 btrfs_clear_opt(ctx->mount_opt, DISCARD_SYNC);
489 btrfs_set_opt(ctx->mount_opt, DISCARD_ASYNC);
490 break;
491 default:
492 btrfs_err(NULL, "unrecognized discard mode value %s",
493 param->key);
494 return -EINVAL;
495 }
496 btrfs_clear_opt(ctx->mount_opt, NODISCARD);
497 break;
498 case Opt_space_cache:
499 if (result.negated) {
500 btrfs_set_opt(ctx->mount_opt, NOSPACECACHE);
501 btrfs_clear_opt(ctx->mount_opt, SPACE_CACHE);
502 btrfs_clear_opt(ctx->mount_opt, FREE_SPACE_TREE);
503 } else {
504 btrfs_clear_opt(ctx->mount_opt, FREE_SPACE_TREE);
505 btrfs_set_opt(ctx->mount_opt, SPACE_CACHE);
506 }
507 break;
508 case Opt_space_cache_version:
509 switch (result.uint_32) {
510 case Opt_space_cache_v1:
511 btrfs_set_opt(ctx->mount_opt, SPACE_CACHE);
512 btrfs_clear_opt(ctx->mount_opt, FREE_SPACE_TREE);
513 break;
514 case Opt_space_cache_v2:
515 btrfs_clear_opt(ctx->mount_opt, SPACE_CACHE);
516 btrfs_set_opt(ctx->mount_opt, FREE_SPACE_TREE);
517 break;
518 default:
519 btrfs_err(NULL, "unrecognized space_cache value %s",
520 param->key);
521 return -EINVAL;
522 }
523 break;
524 case Opt_rescan_uuid_tree:
525 btrfs_set_opt(ctx->mount_opt, RESCAN_UUID_TREE);
526 break;
527 case Opt_clear_cache:
528 btrfs_set_opt(ctx->mount_opt, CLEAR_CACHE);
529 break;
530 case Opt_user_subvol_rm_allowed:
531 btrfs_set_opt(ctx->mount_opt, USER_SUBVOL_RM_ALLOWED);
532 break;
533 case Opt_enospc_debug:
534 if (result.negated)
535 btrfs_clear_opt(ctx->mount_opt, ENOSPC_DEBUG);
536 else
537 btrfs_set_opt(ctx->mount_opt, ENOSPC_DEBUG);
538 break;
539 case Opt_defrag:
540 if (result.negated)
541 btrfs_clear_opt(ctx->mount_opt, AUTO_DEFRAG);
542 else
543 btrfs_set_opt(ctx->mount_opt, AUTO_DEFRAG);
544 break;
545 case Opt_usebackuproot:
546 btrfs_warn(NULL,
547 "'usebackuproot' is deprecated, use 'rescue=usebackuproot' instead");
548 btrfs_set_opt(ctx->mount_opt, USEBACKUPROOT);
549
550 /* If we're loading the backup roots we can't trust the space cache. */
551 btrfs_set_opt(ctx->mount_opt, CLEAR_CACHE);
552 break;
553 case Opt_skip_balance:
554 btrfs_set_opt(ctx->mount_opt, SKIP_BALANCE);
555 break;
556 case Opt_fatal_errors:
557 switch (result.uint_32) {
558 case Opt_fatal_errors_panic:
559 btrfs_set_opt(ctx->mount_opt, PANIC_ON_FATAL_ERROR);
560 break;
561 case Opt_fatal_errors_bug:
562 btrfs_clear_opt(ctx->mount_opt, PANIC_ON_FATAL_ERROR);
563 break;
564 default:
565 btrfs_err(NULL, "unrecognized fatal_errors value %s",
566 param->key);
567 return -EINVAL;
568 }
569 break;
570 case Opt_commit_interval:
571 ctx->commit_interval = result.uint_32;
572 if (ctx->commit_interval == 0)
573 ctx->commit_interval = BTRFS_DEFAULT_COMMIT_INTERVAL;
574 break;
575 case Opt_rescue:
576 switch (result.uint_32) {
577 case Opt_rescue_usebackuproot:
578 btrfs_set_opt(ctx->mount_opt, USEBACKUPROOT);
579 break;
580 case Opt_rescue_nologreplay:
581 btrfs_set_opt(ctx->mount_opt, NOLOGREPLAY);
582 break;
583 case Opt_rescue_ignorebadroots:
584 btrfs_set_opt(ctx->mount_opt, IGNOREBADROOTS);
585 break;
586 case Opt_rescue_ignoredatacsums:
587 btrfs_set_opt(ctx->mount_opt, IGNOREDATACSUMS);
588 break;
589 case Opt_rescue_ignoremetacsums:
590 btrfs_set_opt(ctx->mount_opt, IGNOREMETACSUMS);
591 break;
592 case Opt_rescue_ignoresuperflags:
593 btrfs_set_opt(ctx->mount_opt, IGNORESUPERFLAGS);
594 break;
595 case Opt_rescue_parameter_all:
596 btrfs_set_opt(ctx->mount_opt, IGNOREDATACSUMS);
597 btrfs_set_opt(ctx->mount_opt, IGNOREMETACSUMS);
598 btrfs_set_opt(ctx->mount_opt, IGNORESUPERFLAGS);
599 btrfs_set_opt(ctx->mount_opt, IGNOREBADROOTS);
600 btrfs_set_opt(ctx->mount_opt, NOLOGREPLAY);
601 break;
602 default:
603 btrfs_info(NULL, "unrecognized rescue option '%s'",
604 param->key);
605 return -EINVAL;
606 }
607 break;
608#ifdef CONFIG_BTRFS_DEBUG
609 case Opt_fragment:
610 switch (result.uint_32) {
611 case Opt_fragment_parameter_all:
612 btrfs_set_opt(ctx->mount_opt, FRAGMENT_DATA);
613 btrfs_set_opt(ctx->mount_opt, FRAGMENT_METADATA);
614 break;
615 case Opt_fragment_parameter_metadata:
616 btrfs_set_opt(ctx->mount_opt, FRAGMENT_METADATA);
617 break;
618 case Opt_fragment_parameter_data:
619 btrfs_set_opt(ctx->mount_opt, FRAGMENT_DATA);
620 break;
621 default:
622 btrfs_info(NULL, "unrecognized fragment option '%s'",
623 param->key);
624 return -EINVAL;
625 }
626 break;
627#endif
628#ifdef CONFIG_BTRFS_FS_REF_VERIFY
629 case Opt_ref_verify:
630 btrfs_set_opt(ctx->mount_opt, REF_VERIFY);
631 break;
632#endif
633 default:
634 btrfs_err(NULL, "unrecognized mount option '%s'", param->key);
635 return -EINVAL;
636 }
637
638 return 0;
639}
640
641/*
642 * Some options only have meaning at mount time and shouldn't persist across
643 * remounts, or be displayed. Clear these at the end of mount and remount code
644 * paths.
645 */
646static void btrfs_clear_oneshot_options(struct btrfs_fs_info *fs_info)
647{
648 btrfs_clear_opt(fs_info->mount_opt, USEBACKUPROOT);
649 btrfs_clear_opt(fs_info->mount_opt, CLEAR_CACHE);
650 btrfs_clear_opt(fs_info->mount_opt, NOSPACECACHE);
651}
652
653static bool check_ro_option(const struct btrfs_fs_info *fs_info,
654 unsigned long long mount_opt, unsigned long long opt,
655 const char *opt_name)
656{
657 if (mount_opt & opt) {
658 btrfs_err(fs_info, "%s must be used with ro mount option",
659 opt_name);
660 return true;
661 }
662 return false;
663}
664
665bool btrfs_check_options(const struct btrfs_fs_info *info,
666 unsigned long long *mount_opt,
667 unsigned long flags)
668{
669 bool ret = true;
670
671 if (!(flags & SB_RDONLY) &&
672 (check_ro_option(info, *mount_opt, BTRFS_MOUNT_NOLOGREPLAY, "nologreplay") ||
673 check_ro_option(info, *mount_opt, BTRFS_MOUNT_IGNOREBADROOTS, "ignorebadroots") ||
674 check_ro_option(info, *mount_opt, BTRFS_MOUNT_IGNOREDATACSUMS, "ignoredatacsums") ||
675 check_ro_option(info, *mount_opt, BTRFS_MOUNT_IGNOREMETACSUMS, "ignoremetacsums") ||
676 check_ro_option(info, *mount_opt, BTRFS_MOUNT_IGNORESUPERFLAGS, "ignoresuperflags")))
677 ret = false;
678
679 if (btrfs_fs_compat_ro(info, FREE_SPACE_TREE) &&
680 !btrfs_raw_test_opt(*mount_opt, FREE_SPACE_TREE) &&
681 !btrfs_raw_test_opt(*mount_opt, CLEAR_CACHE)) {
682 btrfs_err(info, "cannot disable free-space-tree");
683 ret = false;
684 }
685 if (btrfs_fs_compat_ro(info, BLOCK_GROUP_TREE) &&
686 !btrfs_raw_test_opt(*mount_opt, FREE_SPACE_TREE)) {
687 btrfs_err(info, "cannot disable free-space-tree with block-group-tree feature");
688 ret = false;
689 }
690
691 if (btrfs_check_mountopts_zoned(info, mount_opt))
692 ret = false;
693
694 if (!test_bit(BTRFS_FS_STATE_REMOUNTING, &info->fs_state)) {
695 if (btrfs_raw_test_opt(*mount_opt, SPACE_CACHE)) {
696 btrfs_info(info, "disk space caching is enabled");
697 btrfs_warn(info,
698"space cache v1 is being deprecated and will be removed in a future release, please use -o space_cache=v2");
699 }
700 if (btrfs_raw_test_opt(*mount_opt, FREE_SPACE_TREE))
701 btrfs_info(info, "using free-space-tree");
702 }
703
704 return ret;
705}
706
707/*
708 * This is subtle, we only call this during open_ctree(). We need to pre-load
709 * the mount options with the on-disk settings. Before the new mount API took
710 * effect we would do this on mount and remount. With the new mount API we'll
711 * only do this on the initial mount.
712 *
713 * This isn't a change in behavior, because we're using the current state of the
714 * file system to set the current mount options. If you mounted with special
715 * options to disable these features and then remounted we wouldn't revert the
716 * settings, because mounting without these features cleared the on-disk
717 * settings, so this being called on re-mount is not needed.
718 */
719void btrfs_set_free_space_cache_settings(struct btrfs_fs_info *fs_info)
720{
721 if (fs_info->sectorsize < PAGE_SIZE) {
722 btrfs_clear_opt(fs_info->mount_opt, SPACE_CACHE);
723 if (!btrfs_test_opt(fs_info, FREE_SPACE_TREE)) {
724 btrfs_info(fs_info,
725 "forcing free space tree for sector size %u with page size %lu",
726 fs_info->sectorsize, PAGE_SIZE);
727 btrfs_set_opt(fs_info->mount_opt, FREE_SPACE_TREE);
728 }
729 }
730
731 /*
732 * At this point our mount options are populated, so we only mess with
733 * these settings if we don't have any settings already.
734 */
735 if (btrfs_test_opt(fs_info, FREE_SPACE_TREE))
736 return;
737
738 if (btrfs_is_zoned(fs_info) &&
739 btrfs_free_space_cache_v1_active(fs_info)) {
740 btrfs_info(fs_info, "zoned: clearing existing space cache");
741 btrfs_set_super_cache_generation(fs_info->super_copy, 0);
742 return;
743 }
744
745 if (btrfs_test_opt(fs_info, SPACE_CACHE))
746 return;
747
748 if (btrfs_test_opt(fs_info, NOSPACECACHE))
749 return;
750
751 /*
752 * At this point we don't have explicit options set by the user, set
753 * them ourselves based on the state of the file system.
754 */
755 if (btrfs_fs_compat_ro(fs_info, FREE_SPACE_TREE))
756 btrfs_set_opt(fs_info->mount_opt, FREE_SPACE_TREE);
757 else if (btrfs_free_space_cache_v1_active(fs_info))
758 btrfs_set_opt(fs_info->mount_opt, SPACE_CACHE);
759}
760
761static void set_device_specific_options(struct btrfs_fs_info *fs_info)
762{
763 if (!btrfs_test_opt(fs_info, NOSSD) &&
764 !fs_info->fs_devices->rotating)
765 btrfs_set_opt(fs_info->mount_opt, SSD);
766
767 /*
768 * For devices supporting discard turn on discard=async automatically,
769 * unless it's already set or disabled. This could be turned off by
770 * nodiscard for the same mount.
771 *
772 * The zoned mode piggy backs on the discard functionality for
773 * resetting a zone. There is no reason to delay the zone reset as it is
774 * fast enough. So, do not enable async discard for zoned mode.
775 */
776 if (!(btrfs_test_opt(fs_info, DISCARD_SYNC) ||
777 btrfs_test_opt(fs_info, DISCARD_ASYNC) ||
778 btrfs_test_opt(fs_info, NODISCARD)) &&
779 fs_info->fs_devices->discardable &&
780 !btrfs_is_zoned(fs_info))
781 btrfs_set_opt(fs_info->mount_opt, DISCARD_ASYNC);
782}
783
784char *btrfs_get_subvol_name_from_objectid(struct btrfs_fs_info *fs_info,
785 u64 subvol_objectid)
786{
787 struct btrfs_root *root = fs_info->tree_root;
788 struct btrfs_root *fs_root = NULL;
789 struct btrfs_root_ref *root_ref;
790 struct btrfs_inode_ref *inode_ref;
791 struct btrfs_key key;
792 struct btrfs_path *path = NULL;
793 char *name = NULL, *ptr;
794 u64 dirid;
795 int len;
796 int ret;
797
798 path = btrfs_alloc_path();
799 if (!path) {
800 ret = -ENOMEM;
801 goto err;
802 }
803
804 name = kmalloc(PATH_MAX, GFP_KERNEL);
805 if (!name) {
806 ret = -ENOMEM;
807 goto err;
808 }
809 ptr = name + PATH_MAX - 1;
810 ptr[0] = '\0';
811
812 /*
813 * Walk up the subvolume trees in the tree of tree roots by root
814 * backrefs until we hit the top-level subvolume.
815 */
816 while (subvol_objectid != BTRFS_FS_TREE_OBJECTID) {
817 key.objectid = subvol_objectid;
818 key.type = BTRFS_ROOT_BACKREF_KEY;
819 key.offset = (u64)-1;
820
821 ret = btrfs_search_backwards(root, &key, path);
822 if (ret < 0) {
823 goto err;
824 } else if (ret > 0) {
825 ret = -ENOENT;
826 goto err;
827 }
828
829 subvol_objectid = key.offset;
830
831 root_ref = btrfs_item_ptr(path->nodes[0], path->slots[0],
832 struct btrfs_root_ref);
833 len = btrfs_root_ref_name_len(path->nodes[0], root_ref);
834 ptr -= len + 1;
835 if (ptr < name) {
836 ret = -ENAMETOOLONG;
837 goto err;
838 }
839 read_extent_buffer(path->nodes[0], ptr + 1,
840 (unsigned long)(root_ref + 1), len);
841 ptr[0] = '/';
842 dirid = btrfs_root_ref_dirid(path->nodes[0], root_ref);
843 btrfs_release_path(path);
844
845 fs_root = btrfs_get_fs_root(fs_info, subvol_objectid, true);
846 if (IS_ERR(fs_root)) {
847 ret = PTR_ERR(fs_root);
848 fs_root = NULL;
849 goto err;
850 }
851
852 /*
853 * Walk up the filesystem tree by inode refs until we hit the
854 * root directory.
855 */
856 while (dirid != BTRFS_FIRST_FREE_OBJECTID) {
857 key.objectid = dirid;
858 key.type = BTRFS_INODE_REF_KEY;
859 key.offset = (u64)-1;
860
861 ret = btrfs_search_backwards(fs_root, &key, path);
862 if (ret < 0) {
863 goto err;
864 } else if (ret > 0) {
865 ret = -ENOENT;
866 goto err;
867 }
868
869 dirid = key.offset;
870
871 inode_ref = btrfs_item_ptr(path->nodes[0],
872 path->slots[0],
873 struct btrfs_inode_ref);
874 len = btrfs_inode_ref_name_len(path->nodes[0],
875 inode_ref);
876 ptr -= len + 1;
877 if (ptr < name) {
878 ret = -ENAMETOOLONG;
879 goto err;
880 }
881 read_extent_buffer(path->nodes[0], ptr + 1,
882 (unsigned long)(inode_ref + 1), len);
883 ptr[0] = '/';
884 btrfs_release_path(path);
885 }
886 btrfs_put_root(fs_root);
887 fs_root = NULL;
888 }
889
890 btrfs_free_path(path);
891 if (ptr == name + PATH_MAX - 1) {
892 name[0] = '/';
893 name[1] = '\0';
894 } else {
895 memmove(name, ptr, name + PATH_MAX - ptr);
896 }
897 return name;
898
899err:
900 btrfs_put_root(fs_root);
901 btrfs_free_path(path);
902 kfree(name);
903 return ERR_PTR(ret);
904}
905
906static int get_default_subvol_objectid(struct btrfs_fs_info *fs_info, u64 *objectid)
907{
908 struct btrfs_root *root = fs_info->tree_root;
909 struct btrfs_dir_item *di;
910 struct btrfs_path *path;
911 struct btrfs_key location;
912 struct fscrypt_str name = FSTR_INIT("default", 7);
913 u64 dir_id;
914
915 path = btrfs_alloc_path();
916 if (!path)
917 return -ENOMEM;
918
919 /*
920 * Find the "default" dir item which points to the root item that we
921 * will mount by default if we haven't been given a specific subvolume
922 * to mount.
923 */
924 dir_id = btrfs_super_root_dir(fs_info->super_copy);
925 di = btrfs_lookup_dir_item(NULL, root, path, dir_id, &name, 0);
926 if (IS_ERR(di)) {
927 btrfs_free_path(path);
928 return PTR_ERR(di);
929 }
930 if (!di) {
931 /*
932 * Ok the default dir item isn't there. This is weird since
933 * it's always been there, but don't freak out, just try and
934 * mount the top-level subvolume.
935 */
936 btrfs_free_path(path);
937 *objectid = BTRFS_FS_TREE_OBJECTID;
938 return 0;
939 }
940
941 btrfs_dir_item_key_to_cpu(path->nodes[0], di, &location);
942 btrfs_free_path(path);
943 *objectid = location.objectid;
944 return 0;
945}
946
947static int btrfs_fill_super(struct super_block *sb,
948 struct btrfs_fs_devices *fs_devices)
949{
950 struct inode *inode;
951 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
952 int err;
953
954 sb->s_maxbytes = MAX_LFS_FILESIZE;
955 sb->s_magic = BTRFS_SUPER_MAGIC;
956 sb->s_op = &btrfs_super_ops;
957 sb->s_d_op = &btrfs_dentry_operations;
958 sb->s_export_op = &btrfs_export_ops;
959#ifdef CONFIG_FS_VERITY
960 sb->s_vop = &btrfs_verityops;
961#endif
962 sb->s_xattr = btrfs_xattr_handlers;
963 sb->s_time_gran = 1;
964 sb->s_iflags |= SB_I_CGROUPWB;
965
966 err = super_setup_bdi(sb);
967 if (err) {
968 btrfs_err(fs_info, "super_setup_bdi failed");
969 return err;
970 }
971
972 err = open_ctree(sb, fs_devices);
973 if (err) {
974 btrfs_err(fs_info, "open_ctree failed: %d", err);
975 return err;
976 }
977
978 inode = btrfs_iget(BTRFS_FIRST_FREE_OBJECTID, fs_info->fs_root);
979 if (IS_ERR(inode)) {
980 err = PTR_ERR(inode);
981 btrfs_handle_fs_error(fs_info, err, NULL);
982 goto fail_close;
983 }
984
985 sb->s_root = d_make_root(inode);
986 if (!sb->s_root) {
987 err = -ENOMEM;
988 goto fail_close;
989 }
990
991 sb->s_flags |= SB_ACTIVE;
992 return 0;
993
994fail_close:
995 close_ctree(fs_info);
996 return err;
997}
998
999int btrfs_sync_fs(struct super_block *sb, int wait)
1000{
1001 struct btrfs_trans_handle *trans;
1002 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
1003 struct btrfs_root *root = fs_info->tree_root;
1004
1005 trace_btrfs_sync_fs(fs_info, wait);
1006
1007 if (!wait) {
1008 filemap_flush(fs_info->btree_inode->i_mapping);
1009 return 0;
1010 }
1011
1012 btrfs_wait_ordered_roots(fs_info, U64_MAX, NULL);
1013
1014 trans = btrfs_attach_transaction_barrier(root);
1015 if (IS_ERR(trans)) {
1016 /* no transaction, don't bother */
1017 if (PTR_ERR(trans) == -ENOENT) {
1018 /*
1019 * Exit unless we have some pending changes
1020 * that need to go through commit
1021 */
1022 if (!test_bit(BTRFS_FS_NEED_TRANS_COMMIT,
1023 &fs_info->flags))
1024 return 0;
1025 /*
1026 * A non-blocking test if the fs is frozen. We must not
1027 * start a new transaction here otherwise a deadlock
1028 * happens. The pending operations are delayed to the
1029 * next commit after thawing.
1030 */
1031 if (sb_start_write_trylock(sb))
1032 sb_end_write(sb);
1033 else
1034 return 0;
1035 trans = btrfs_start_transaction(root, 0);
1036 }
1037 if (IS_ERR(trans))
1038 return PTR_ERR(trans);
1039 }
1040 return btrfs_commit_transaction(trans);
1041}
1042
1043static void print_rescue_option(struct seq_file *seq, const char *s, bool *printed)
1044{
1045 seq_printf(seq, "%s%s", (*printed) ? ":" : ",rescue=", s);
1046 *printed = true;
1047}
1048
1049static int btrfs_show_options(struct seq_file *seq, struct dentry *dentry)
1050{
1051 struct btrfs_fs_info *info = btrfs_sb(dentry->d_sb);
1052 const char *compress_type;
1053 const char *subvol_name;
1054 bool printed = false;
1055
1056 if (btrfs_test_opt(info, DEGRADED))
1057 seq_puts(seq, ",degraded");
1058 if (btrfs_test_opt(info, NODATASUM))
1059 seq_puts(seq, ",nodatasum");
1060 if (btrfs_test_opt(info, NODATACOW))
1061 seq_puts(seq, ",nodatacow");
1062 if (btrfs_test_opt(info, NOBARRIER))
1063 seq_puts(seq, ",nobarrier");
1064 if (info->max_inline != BTRFS_DEFAULT_MAX_INLINE)
1065 seq_printf(seq, ",max_inline=%llu", info->max_inline);
1066 if (info->thread_pool_size != min_t(unsigned long,
1067 num_online_cpus() + 2, 8))
1068 seq_printf(seq, ",thread_pool=%u", info->thread_pool_size);
1069 if (btrfs_test_opt(info, COMPRESS)) {
1070 compress_type = btrfs_compress_type2str(info->compress_type);
1071 if (btrfs_test_opt(info, FORCE_COMPRESS))
1072 seq_printf(seq, ",compress-force=%s", compress_type);
1073 else
1074 seq_printf(seq, ",compress=%s", compress_type);
1075 if (info->compress_level)
1076 seq_printf(seq, ":%d", info->compress_level);
1077 }
1078 if (btrfs_test_opt(info, NOSSD))
1079 seq_puts(seq, ",nossd");
1080 if (btrfs_test_opt(info, SSD_SPREAD))
1081 seq_puts(seq, ",ssd_spread");
1082 else if (btrfs_test_opt(info, SSD))
1083 seq_puts(seq, ",ssd");
1084 if (btrfs_test_opt(info, NOTREELOG))
1085 seq_puts(seq, ",notreelog");
1086 if (btrfs_test_opt(info, NOLOGREPLAY))
1087 print_rescue_option(seq, "nologreplay", &printed);
1088 if (btrfs_test_opt(info, USEBACKUPROOT))
1089 print_rescue_option(seq, "usebackuproot", &printed);
1090 if (btrfs_test_opt(info, IGNOREBADROOTS))
1091 print_rescue_option(seq, "ignorebadroots", &printed);
1092 if (btrfs_test_opt(info, IGNOREDATACSUMS))
1093 print_rescue_option(seq, "ignoredatacsums", &printed);
1094 if (btrfs_test_opt(info, IGNOREMETACSUMS))
1095 print_rescue_option(seq, "ignoremetacsums", &printed);
1096 if (btrfs_test_opt(info, IGNORESUPERFLAGS))
1097 print_rescue_option(seq, "ignoresuperflags", &printed);
1098 if (btrfs_test_opt(info, FLUSHONCOMMIT))
1099 seq_puts(seq, ",flushoncommit");
1100 if (btrfs_test_opt(info, DISCARD_SYNC))
1101 seq_puts(seq, ",discard");
1102 if (btrfs_test_opt(info, DISCARD_ASYNC))
1103 seq_puts(seq, ",discard=async");
1104 if (!(info->sb->s_flags & SB_POSIXACL))
1105 seq_puts(seq, ",noacl");
1106 if (btrfs_free_space_cache_v1_active(info))
1107 seq_puts(seq, ",space_cache");
1108 else if (btrfs_fs_compat_ro(info, FREE_SPACE_TREE))
1109 seq_puts(seq, ",space_cache=v2");
1110 else
1111 seq_puts(seq, ",nospace_cache");
1112 if (btrfs_test_opt(info, RESCAN_UUID_TREE))
1113 seq_puts(seq, ",rescan_uuid_tree");
1114 if (btrfs_test_opt(info, CLEAR_CACHE))
1115 seq_puts(seq, ",clear_cache");
1116 if (btrfs_test_opt(info, USER_SUBVOL_RM_ALLOWED))
1117 seq_puts(seq, ",user_subvol_rm_allowed");
1118 if (btrfs_test_opt(info, ENOSPC_DEBUG))
1119 seq_puts(seq, ",enospc_debug");
1120 if (btrfs_test_opt(info, AUTO_DEFRAG))
1121 seq_puts(seq, ",autodefrag");
1122 if (btrfs_test_opt(info, SKIP_BALANCE))
1123 seq_puts(seq, ",skip_balance");
1124 if (info->metadata_ratio)
1125 seq_printf(seq, ",metadata_ratio=%u", info->metadata_ratio);
1126 if (btrfs_test_opt(info, PANIC_ON_FATAL_ERROR))
1127 seq_puts(seq, ",fatal_errors=panic");
1128 if (info->commit_interval != BTRFS_DEFAULT_COMMIT_INTERVAL)
1129 seq_printf(seq, ",commit=%u", info->commit_interval);
1130#ifdef CONFIG_BTRFS_DEBUG
1131 if (btrfs_test_opt(info, FRAGMENT_DATA))
1132 seq_puts(seq, ",fragment=data");
1133 if (btrfs_test_opt(info, FRAGMENT_METADATA))
1134 seq_puts(seq, ",fragment=metadata");
1135#endif
1136 if (btrfs_test_opt(info, REF_VERIFY))
1137 seq_puts(seq, ",ref_verify");
1138 seq_printf(seq, ",subvolid=%llu", btrfs_root_id(BTRFS_I(d_inode(dentry))->root));
1139 subvol_name = btrfs_get_subvol_name_from_objectid(info,
1140 btrfs_root_id(BTRFS_I(d_inode(dentry))->root));
1141 if (!IS_ERR(subvol_name)) {
1142 seq_puts(seq, ",subvol=");
1143 seq_escape(seq, subvol_name, " \t\n\\");
1144 kfree(subvol_name);
1145 }
1146 return 0;
1147}
1148
1149/*
1150 * subvolumes are identified by ino 256
1151 */
1152static inline int is_subvolume_inode(struct inode *inode)
1153{
1154 if (inode && inode->i_ino == BTRFS_FIRST_FREE_OBJECTID)
1155 return 1;
1156 return 0;
1157}
1158
1159static struct dentry *mount_subvol(const char *subvol_name, u64 subvol_objectid,
1160 struct vfsmount *mnt)
1161{
1162 struct dentry *root;
1163 int ret;
1164
1165 if (!subvol_name) {
1166 if (!subvol_objectid) {
1167 ret = get_default_subvol_objectid(btrfs_sb(mnt->mnt_sb),
1168 &subvol_objectid);
1169 if (ret) {
1170 root = ERR_PTR(ret);
1171 goto out;
1172 }
1173 }
1174 subvol_name = btrfs_get_subvol_name_from_objectid(
1175 btrfs_sb(mnt->mnt_sb), subvol_objectid);
1176 if (IS_ERR(subvol_name)) {
1177 root = ERR_CAST(subvol_name);
1178 subvol_name = NULL;
1179 goto out;
1180 }
1181
1182 }
1183
1184 root = mount_subtree(mnt, subvol_name);
1185 /* mount_subtree() drops our reference on the vfsmount. */
1186 mnt = NULL;
1187
1188 if (!IS_ERR(root)) {
1189 struct super_block *s = root->d_sb;
1190 struct btrfs_fs_info *fs_info = btrfs_sb(s);
1191 struct inode *root_inode = d_inode(root);
1192 u64 root_objectid = btrfs_root_id(BTRFS_I(root_inode)->root);
1193
1194 ret = 0;
1195 if (!is_subvolume_inode(root_inode)) {
1196 btrfs_err(fs_info, "'%s' is not a valid subvolume",
1197 subvol_name);
1198 ret = -EINVAL;
1199 }
1200 if (subvol_objectid && root_objectid != subvol_objectid) {
1201 /*
1202 * This will also catch a race condition where a
1203 * subvolume which was passed by ID is renamed and
1204 * another subvolume is renamed over the old location.
1205 */
1206 btrfs_err(fs_info,
1207 "subvol '%s' does not match subvolid %llu",
1208 subvol_name, subvol_objectid);
1209 ret = -EINVAL;
1210 }
1211 if (ret) {
1212 dput(root);
1213 root = ERR_PTR(ret);
1214 deactivate_locked_super(s);
1215 }
1216 }
1217
1218out:
1219 mntput(mnt);
1220 kfree(subvol_name);
1221 return root;
1222}
1223
1224static void btrfs_resize_thread_pool(struct btrfs_fs_info *fs_info,
1225 u32 new_pool_size, u32 old_pool_size)
1226{
1227 if (new_pool_size == old_pool_size)
1228 return;
1229
1230 fs_info->thread_pool_size = new_pool_size;
1231
1232 btrfs_info(fs_info, "resize thread pool %d -> %d",
1233 old_pool_size, new_pool_size);
1234
1235 btrfs_workqueue_set_max(fs_info->workers, new_pool_size);
1236 btrfs_workqueue_set_max(fs_info->delalloc_workers, new_pool_size);
1237 btrfs_workqueue_set_max(fs_info->caching_workers, new_pool_size);
1238 workqueue_set_max_active(fs_info->endio_workers, new_pool_size);
1239 workqueue_set_max_active(fs_info->endio_meta_workers, new_pool_size);
1240 btrfs_workqueue_set_max(fs_info->endio_write_workers, new_pool_size);
1241 btrfs_workqueue_set_max(fs_info->endio_freespace_worker, new_pool_size);
1242 btrfs_workqueue_set_max(fs_info->delayed_workers, new_pool_size);
1243}
1244
1245static inline void btrfs_remount_begin(struct btrfs_fs_info *fs_info,
1246 unsigned long long old_opts, int flags)
1247{
1248 if (btrfs_raw_test_opt(old_opts, AUTO_DEFRAG) &&
1249 (!btrfs_raw_test_opt(fs_info->mount_opt, AUTO_DEFRAG) ||
1250 (flags & SB_RDONLY))) {
1251 /* wait for any defraggers to finish */
1252 wait_event(fs_info->transaction_wait,
1253 (atomic_read(&fs_info->defrag_running) == 0));
1254 if (flags & SB_RDONLY)
1255 sync_filesystem(fs_info->sb);
1256 }
1257}
1258
1259static inline void btrfs_remount_cleanup(struct btrfs_fs_info *fs_info,
1260 unsigned long long old_opts)
1261{
1262 const bool cache_opt = btrfs_test_opt(fs_info, SPACE_CACHE);
1263
1264 /*
1265 * We need to cleanup all defragable inodes if the autodefragment is
1266 * close or the filesystem is read only.
1267 */
1268 if (btrfs_raw_test_opt(old_opts, AUTO_DEFRAG) &&
1269 (!btrfs_raw_test_opt(fs_info->mount_opt, AUTO_DEFRAG) || sb_rdonly(fs_info->sb))) {
1270 btrfs_cleanup_defrag_inodes(fs_info);
1271 }
1272
1273 /* If we toggled discard async */
1274 if (!btrfs_raw_test_opt(old_opts, DISCARD_ASYNC) &&
1275 btrfs_test_opt(fs_info, DISCARD_ASYNC))
1276 btrfs_discard_resume(fs_info);
1277 else if (btrfs_raw_test_opt(old_opts, DISCARD_ASYNC) &&
1278 !btrfs_test_opt(fs_info, DISCARD_ASYNC))
1279 btrfs_discard_cleanup(fs_info);
1280
1281 /* If we toggled space cache */
1282 if (cache_opt != btrfs_free_space_cache_v1_active(fs_info))
1283 btrfs_set_free_space_cache_v1_active(fs_info, cache_opt);
1284}
1285
1286static int btrfs_remount_rw(struct btrfs_fs_info *fs_info)
1287{
1288 int ret;
1289
1290 if (BTRFS_FS_ERROR(fs_info)) {
1291 btrfs_err(fs_info,
1292 "remounting read-write after error is not allowed");
1293 return -EINVAL;
1294 }
1295
1296 if (fs_info->fs_devices->rw_devices == 0)
1297 return -EACCES;
1298
1299 if (!btrfs_check_rw_degradable(fs_info, NULL)) {
1300 btrfs_warn(fs_info,
1301 "too many missing devices, writable remount is not allowed");
1302 return -EACCES;
1303 }
1304
1305 if (btrfs_super_log_root(fs_info->super_copy) != 0) {
1306 btrfs_warn(fs_info,
1307 "mount required to replay tree-log, cannot remount read-write");
1308 return -EINVAL;
1309 }
1310
1311 /*
1312 * NOTE: when remounting with a change that does writes, don't put it
1313 * anywhere above this point, as we are not sure to be safe to write
1314 * until we pass the above checks.
1315 */
1316 ret = btrfs_start_pre_rw_mount(fs_info);
1317 if (ret)
1318 return ret;
1319
1320 btrfs_clear_sb_rdonly(fs_info->sb);
1321
1322 set_bit(BTRFS_FS_OPEN, &fs_info->flags);
1323
1324 /*
1325 * If we've gone from readonly -> read-write, we need to get our
1326 * sync/async discard lists in the right state.
1327 */
1328 btrfs_discard_resume(fs_info);
1329
1330 return 0;
1331}
1332
1333static int btrfs_remount_ro(struct btrfs_fs_info *fs_info)
1334{
1335 /*
1336 * This also happens on 'umount -rf' or on shutdown, when the
1337 * filesystem is busy.
1338 */
1339 cancel_work_sync(&fs_info->async_reclaim_work);
1340 cancel_work_sync(&fs_info->async_data_reclaim_work);
1341
1342 btrfs_discard_cleanup(fs_info);
1343
1344 /* Wait for the uuid_scan task to finish */
1345 down(&fs_info->uuid_tree_rescan_sem);
1346 /* Avoid complains from lockdep et al. */
1347 up(&fs_info->uuid_tree_rescan_sem);
1348
1349 btrfs_set_sb_rdonly(fs_info->sb);
1350
1351 /*
1352 * Setting SB_RDONLY will put the cleaner thread to sleep at the next
1353 * loop if it's already active. If it's already asleep, we'll leave
1354 * unused block groups on disk until we're mounted read-write again
1355 * unless we clean them up here.
1356 */
1357 btrfs_delete_unused_bgs(fs_info);
1358
1359 /*
1360 * The cleaner task could be already running before we set the flag
1361 * BTRFS_FS_STATE_RO (and SB_RDONLY in the superblock). We must make
1362 * sure that after we finish the remount, i.e. after we call
1363 * btrfs_commit_super(), the cleaner can no longer start a transaction
1364 * - either because it was dropping a dead root, running delayed iputs
1365 * or deleting an unused block group (the cleaner picked a block
1366 * group from the list of unused block groups before we were able to
1367 * in the previous call to btrfs_delete_unused_bgs()).
1368 */
1369 wait_on_bit(&fs_info->flags, BTRFS_FS_CLEANER_RUNNING, TASK_UNINTERRUPTIBLE);
1370
1371 /*
1372 * We've set the superblock to RO mode, so we might have made the
1373 * cleaner task sleep without running all pending delayed iputs. Go
1374 * through all the delayed iputs here, so that if an unmount happens
1375 * without remounting RW we don't end up at finishing close_ctree()
1376 * with a non-empty list of delayed iputs.
1377 */
1378 btrfs_run_delayed_iputs(fs_info);
1379
1380 btrfs_dev_replace_suspend_for_unmount(fs_info);
1381 btrfs_scrub_cancel(fs_info);
1382 btrfs_pause_balance(fs_info);
1383
1384 /*
1385 * Pause the qgroup rescan worker if it is running. We don't want it to
1386 * be still running after we are in RO mode, as after that, by the time
1387 * we unmount, it might have left a transaction open, so we would leak
1388 * the transaction and/or crash.
1389 */
1390 btrfs_qgroup_wait_for_completion(fs_info, false);
1391
1392 return btrfs_commit_super(fs_info);
1393}
1394
1395static void btrfs_ctx_to_info(struct btrfs_fs_info *fs_info, struct btrfs_fs_context *ctx)
1396{
1397 fs_info->max_inline = ctx->max_inline;
1398 fs_info->commit_interval = ctx->commit_interval;
1399 fs_info->metadata_ratio = ctx->metadata_ratio;
1400 fs_info->thread_pool_size = ctx->thread_pool_size;
1401 fs_info->mount_opt = ctx->mount_opt;
1402 fs_info->compress_type = ctx->compress_type;
1403 fs_info->compress_level = ctx->compress_level;
1404}
1405
1406static void btrfs_info_to_ctx(struct btrfs_fs_info *fs_info, struct btrfs_fs_context *ctx)
1407{
1408 ctx->max_inline = fs_info->max_inline;
1409 ctx->commit_interval = fs_info->commit_interval;
1410 ctx->metadata_ratio = fs_info->metadata_ratio;
1411 ctx->thread_pool_size = fs_info->thread_pool_size;
1412 ctx->mount_opt = fs_info->mount_opt;
1413 ctx->compress_type = fs_info->compress_type;
1414 ctx->compress_level = fs_info->compress_level;
1415}
1416
1417#define btrfs_info_if_set(fs_info, old_ctx, opt, fmt, args...) \
1418do { \
1419 if ((!old_ctx || !btrfs_raw_test_opt(old_ctx->mount_opt, opt)) && \
1420 btrfs_raw_test_opt(fs_info->mount_opt, opt)) \
1421 btrfs_info(fs_info, fmt, ##args); \
1422} while (0)
1423
1424#define btrfs_info_if_unset(fs_info, old_ctx, opt, fmt, args...) \
1425do { \
1426 if ((old_ctx && btrfs_raw_test_opt(old_ctx->mount_opt, opt)) && \
1427 !btrfs_raw_test_opt(fs_info->mount_opt, opt)) \
1428 btrfs_info(fs_info, fmt, ##args); \
1429} while (0)
1430
1431static void btrfs_emit_options(struct btrfs_fs_info *info,
1432 struct btrfs_fs_context *old)
1433{
1434 btrfs_info_if_set(info, old, NODATASUM, "setting nodatasum");
1435 btrfs_info_if_set(info, old, DEGRADED, "allowing degraded mounts");
1436 btrfs_info_if_set(info, old, NODATASUM, "setting nodatasum");
1437 btrfs_info_if_set(info, old, SSD, "enabling ssd optimizations");
1438 btrfs_info_if_set(info, old, SSD_SPREAD, "using spread ssd allocation scheme");
1439 btrfs_info_if_set(info, old, NOBARRIER, "turning off barriers");
1440 btrfs_info_if_set(info, old, NOTREELOG, "disabling tree log");
1441 btrfs_info_if_set(info, old, NOLOGREPLAY, "disabling log replay at mount time");
1442 btrfs_info_if_set(info, old, FLUSHONCOMMIT, "turning on flush-on-commit");
1443 btrfs_info_if_set(info, old, DISCARD_SYNC, "turning on sync discard");
1444 btrfs_info_if_set(info, old, DISCARD_ASYNC, "turning on async discard");
1445 btrfs_info_if_set(info, old, FREE_SPACE_TREE, "enabling free space tree");
1446 btrfs_info_if_set(info, old, SPACE_CACHE, "enabling disk space caching");
1447 btrfs_info_if_set(info, old, CLEAR_CACHE, "force clearing of disk cache");
1448 btrfs_info_if_set(info, old, AUTO_DEFRAG, "enabling auto defrag");
1449 btrfs_info_if_set(info, old, FRAGMENT_DATA, "fragmenting data");
1450 btrfs_info_if_set(info, old, FRAGMENT_METADATA, "fragmenting metadata");
1451 btrfs_info_if_set(info, old, REF_VERIFY, "doing ref verification");
1452 btrfs_info_if_set(info, old, USEBACKUPROOT, "trying to use backup root at mount time");
1453 btrfs_info_if_set(info, old, IGNOREBADROOTS, "ignoring bad roots");
1454 btrfs_info_if_set(info, old, IGNOREDATACSUMS, "ignoring data csums");
1455 btrfs_info_if_set(info, old, IGNOREMETACSUMS, "ignoring meta csums");
1456 btrfs_info_if_set(info, old, IGNORESUPERFLAGS, "ignoring unknown super block flags");
1457
1458 btrfs_info_if_unset(info, old, NODATACOW, "setting datacow");
1459 btrfs_info_if_unset(info, old, SSD, "not using ssd optimizations");
1460 btrfs_info_if_unset(info, old, SSD_SPREAD, "not using spread ssd allocation scheme");
1461 btrfs_info_if_unset(info, old, NOBARRIER, "turning off barriers");
1462 btrfs_info_if_unset(info, old, NOTREELOG, "enabling tree log");
1463 btrfs_info_if_unset(info, old, SPACE_CACHE, "disabling disk space caching");
1464 btrfs_info_if_unset(info, old, FREE_SPACE_TREE, "disabling free space tree");
1465 btrfs_info_if_unset(info, old, AUTO_DEFRAG, "disabling auto defrag");
1466 btrfs_info_if_unset(info, old, COMPRESS, "use no compression");
1467
1468 /* Did the compression settings change? */
1469 if (btrfs_test_opt(info, COMPRESS) &&
1470 (!old ||
1471 old->compress_type != info->compress_type ||
1472 old->compress_level != info->compress_level ||
1473 (!btrfs_raw_test_opt(old->mount_opt, FORCE_COMPRESS) &&
1474 btrfs_raw_test_opt(info->mount_opt, FORCE_COMPRESS)))) {
1475 const char *compress_type = btrfs_compress_type2str(info->compress_type);
1476
1477 btrfs_info(info, "%s %s compression, level %d",
1478 btrfs_test_opt(info, FORCE_COMPRESS) ? "force" : "use",
1479 compress_type, info->compress_level);
1480 }
1481
1482 if (info->max_inline != BTRFS_DEFAULT_MAX_INLINE)
1483 btrfs_info(info, "max_inline set to %llu", info->max_inline);
1484}
1485
1486static int btrfs_reconfigure(struct fs_context *fc)
1487{
1488 struct super_block *sb = fc->root->d_sb;
1489 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
1490 struct btrfs_fs_context *ctx = fc->fs_private;
1491 struct btrfs_fs_context old_ctx;
1492 int ret = 0;
1493 bool mount_reconfigure = (fc->s_fs_info != NULL);
1494
1495 btrfs_info_to_ctx(fs_info, &old_ctx);
1496
1497 /*
1498 * This is our "bind mount" trick, we don't want to allow the user to do
1499 * anything other than mount a different ro/rw and a different subvol,
1500 * all of the mount options should be maintained.
1501 */
1502 if (mount_reconfigure)
1503 ctx->mount_opt = old_ctx.mount_opt;
1504
1505 sync_filesystem(sb);
1506 set_bit(BTRFS_FS_STATE_REMOUNTING, &fs_info->fs_state);
1507
1508 if (!btrfs_check_options(fs_info, &ctx->mount_opt, fc->sb_flags))
1509 return -EINVAL;
1510
1511 ret = btrfs_check_features(fs_info, !(fc->sb_flags & SB_RDONLY));
1512 if (ret < 0)
1513 return ret;
1514
1515 btrfs_ctx_to_info(fs_info, ctx);
1516 btrfs_remount_begin(fs_info, old_ctx.mount_opt, fc->sb_flags);
1517 btrfs_resize_thread_pool(fs_info, fs_info->thread_pool_size,
1518 old_ctx.thread_pool_size);
1519
1520 if ((bool)btrfs_test_opt(fs_info, FREE_SPACE_TREE) !=
1521 (bool)btrfs_fs_compat_ro(fs_info, FREE_SPACE_TREE) &&
1522 (!sb_rdonly(sb) || (fc->sb_flags & SB_RDONLY))) {
1523 btrfs_warn(fs_info,
1524 "remount supports changing free space tree only from RO to RW");
1525 /* Make sure free space cache options match the state on disk. */
1526 if (btrfs_fs_compat_ro(fs_info, FREE_SPACE_TREE)) {
1527 btrfs_set_opt(fs_info->mount_opt, FREE_SPACE_TREE);
1528 btrfs_clear_opt(fs_info->mount_opt, SPACE_CACHE);
1529 }
1530 if (btrfs_free_space_cache_v1_active(fs_info)) {
1531 btrfs_clear_opt(fs_info->mount_opt, FREE_SPACE_TREE);
1532 btrfs_set_opt(fs_info->mount_opt, SPACE_CACHE);
1533 }
1534 }
1535
1536 ret = 0;
1537 if (!sb_rdonly(sb) && (fc->sb_flags & SB_RDONLY))
1538 ret = btrfs_remount_ro(fs_info);
1539 else if (sb_rdonly(sb) && !(fc->sb_flags & SB_RDONLY))
1540 ret = btrfs_remount_rw(fs_info);
1541 if (ret)
1542 goto restore;
1543
1544 /*
1545 * If we set the mask during the parameter parsing VFS would reject the
1546 * remount. Here we can set the mask and the value will be updated
1547 * appropriately.
1548 */
1549 if ((fc->sb_flags & SB_POSIXACL) != (sb->s_flags & SB_POSIXACL))
1550 fc->sb_flags_mask |= SB_POSIXACL;
1551
1552 btrfs_emit_options(fs_info, &old_ctx);
1553 wake_up_process(fs_info->transaction_kthread);
1554 btrfs_remount_cleanup(fs_info, old_ctx.mount_opt);
1555 btrfs_clear_oneshot_options(fs_info);
1556 clear_bit(BTRFS_FS_STATE_REMOUNTING, &fs_info->fs_state);
1557
1558 return 0;
1559restore:
1560 btrfs_ctx_to_info(fs_info, &old_ctx);
1561 btrfs_remount_cleanup(fs_info, old_ctx.mount_opt);
1562 clear_bit(BTRFS_FS_STATE_REMOUNTING, &fs_info->fs_state);
1563 return ret;
1564}
1565
1566/* Used to sort the devices by max_avail(descending sort) */
1567static int btrfs_cmp_device_free_bytes(const void *a, const void *b)
1568{
1569 const struct btrfs_device_info *dev_info1 = a;
1570 const struct btrfs_device_info *dev_info2 = b;
1571
1572 if (dev_info1->max_avail > dev_info2->max_avail)
1573 return -1;
1574 else if (dev_info1->max_avail < dev_info2->max_avail)
1575 return 1;
1576 return 0;
1577}
1578
1579/*
1580 * sort the devices by max_avail, in which max free extent size of each device
1581 * is stored.(Descending Sort)
1582 */
1583static inline void btrfs_descending_sort_devices(
1584 struct btrfs_device_info *devices,
1585 size_t nr_devices)
1586{
1587 sort(devices, nr_devices, sizeof(struct btrfs_device_info),
1588 btrfs_cmp_device_free_bytes, NULL);
1589}
1590
1591/*
1592 * The helper to calc the free space on the devices that can be used to store
1593 * file data.
1594 */
1595static inline int btrfs_calc_avail_data_space(struct btrfs_fs_info *fs_info,
1596 u64 *free_bytes)
1597{
1598 struct btrfs_device_info *devices_info;
1599 struct btrfs_fs_devices *fs_devices = fs_info->fs_devices;
1600 struct btrfs_device *device;
1601 u64 type;
1602 u64 avail_space;
1603 u64 min_stripe_size;
1604 int num_stripes = 1;
1605 int i = 0, nr_devices;
1606 const struct btrfs_raid_attr *rattr;
1607
1608 /*
1609 * We aren't under the device list lock, so this is racy-ish, but good
1610 * enough for our purposes.
1611 */
1612 nr_devices = fs_info->fs_devices->open_devices;
1613 if (!nr_devices) {
1614 smp_mb();
1615 nr_devices = fs_info->fs_devices->open_devices;
1616 ASSERT(nr_devices);
1617 if (!nr_devices) {
1618 *free_bytes = 0;
1619 return 0;
1620 }
1621 }
1622
1623 devices_info = kmalloc_array(nr_devices, sizeof(*devices_info),
1624 GFP_KERNEL);
1625 if (!devices_info)
1626 return -ENOMEM;
1627
1628 /* calc min stripe number for data space allocation */
1629 type = btrfs_data_alloc_profile(fs_info);
1630 rattr = &btrfs_raid_array[btrfs_bg_flags_to_raid_index(type)];
1631
1632 if (type & BTRFS_BLOCK_GROUP_RAID0)
1633 num_stripes = nr_devices;
1634 else if (type & BTRFS_BLOCK_GROUP_RAID1_MASK)
1635 num_stripes = rattr->ncopies;
1636 else if (type & BTRFS_BLOCK_GROUP_RAID10)
1637 num_stripes = 4;
1638
1639 /* Adjust for more than 1 stripe per device */
1640 min_stripe_size = rattr->dev_stripes * BTRFS_STRIPE_LEN;
1641
1642 rcu_read_lock();
1643 list_for_each_entry_rcu(device, &fs_devices->devices, dev_list) {
1644 if (!test_bit(BTRFS_DEV_STATE_IN_FS_METADATA,
1645 &device->dev_state) ||
1646 !device->bdev ||
1647 test_bit(BTRFS_DEV_STATE_REPLACE_TGT, &device->dev_state))
1648 continue;
1649
1650 if (i >= nr_devices)
1651 break;
1652
1653 avail_space = device->total_bytes - device->bytes_used;
1654
1655 /* align with stripe_len */
1656 avail_space = rounddown(avail_space, BTRFS_STRIPE_LEN);
1657
1658 /*
1659 * Ensure we have at least min_stripe_size on top of the
1660 * reserved space on the device.
1661 */
1662 if (avail_space <= BTRFS_DEVICE_RANGE_RESERVED + min_stripe_size)
1663 continue;
1664
1665 avail_space -= BTRFS_DEVICE_RANGE_RESERVED;
1666
1667 devices_info[i].dev = device;
1668 devices_info[i].max_avail = avail_space;
1669
1670 i++;
1671 }
1672 rcu_read_unlock();
1673
1674 nr_devices = i;
1675
1676 btrfs_descending_sort_devices(devices_info, nr_devices);
1677
1678 i = nr_devices - 1;
1679 avail_space = 0;
1680 while (nr_devices >= rattr->devs_min) {
1681 num_stripes = min(num_stripes, nr_devices);
1682
1683 if (devices_info[i].max_avail >= min_stripe_size) {
1684 int j;
1685 u64 alloc_size;
1686
1687 avail_space += devices_info[i].max_avail * num_stripes;
1688 alloc_size = devices_info[i].max_avail;
1689 for (j = i + 1 - num_stripes; j <= i; j++)
1690 devices_info[j].max_avail -= alloc_size;
1691 }
1692 i--;
1693 nr_devices--;
1694 }
1695
1696 kfree(devices_info);
1697 *free_bytes = avail_space;
1698 return 0;
1699}
1700
1701/*
1702 * Calculate numbers for 'df', pessimistic in case of mixed raid profiles.
1703 *
1704 * If there's a redundant raid level at DATA block groups, use the respective
1705 * multiplier to scale the sizes.
1706 *
1707 * Unused device space usage is based on simulating the chunk allocator
1708 * algorithm that respects the device sizes and order of allocations. This is
1709 * a close approximation of the actual use but there are other factors that may
1710 * change the result (like a new metadata chunk).
1711 *
1712 * If metadata is exhausted, f_bavail will be 0.
1713 */
1714static int btrfs_statfs(struct dentry *dentry, struct kstatfs *buf)
1715{
1716 struct btrfs_fs_info *fs_info = btrfs_sb(dentry->d_sb);
1717 struct btrfs_super_block *disk_super = fs_info->super_copy;
1718 struct btrfs_space_info *found;
1719 u64 total_used = 0;
1720 u64 total_free_data = 0;
1721 u64 total_free_meta = 0;
1722 u32 bits = fs_info->sectorsize_bits;
1723 __be32 *fsid = (__be32 *)fs_info->fs_devices->fsid;
1724 unsigned factor = 1;
1725 struct btrfs_block_rsv *block_rsv = &fs_info->global_block_rsv;
1726 int ret;
1727 u64 thresh = 0;
1728 int mixed = 0;
1729
1730 list_for_each_entry(found, &fs_info->space_info, list) {
1731 if (found->flags & BTRFS_BLOCK_GROUP_DATA) {
1732 int i;
1733
1734 total_free_data += found->disk_total - found->disk_used;
1735 total_free_data -=
1736 btrfs_account_ro_block_groups_free_space(found);
1737
1738 for (i = 0; i < BTRFS_NR_RAID_TYPES; i++) {
1739 if (!list_empty(&found->block_groups[i]))
1740 factor = btrfs_bg_type_to_factor(
1741 btrfs_raid_array[i].bg_flag);
1742 }
1743 }
1744
1745 /*
1746 * Metadata in mixed block group profiles are accounted in data
1747 */
1748 if (!mixed && found->flags & BTRFS_BLOCK_GROUP_METADATA) {
1749 if (found->flags & BTRFS_BLOCK_GROUP_DATA)
1750 mixed = 1;
1751 else
1752 total_free_meta += found->disk_total -
1753 found->disk_used;
1754 }
1755
1756 total_used += found->disk_used;
1757 }
1758
1759 buf->f_blocks = div_u64(btrfs_super_total_bytes(disk_super), factor);
1760 buf->f_blocks >>= bits;
1761 buf->f_bfree = buf->f_blocks - (div_u64(total_used, factor) >> bits);
1762
1763 /* Account global block reserve as used, it's in logical size already */
1764 spin_lock(&block_rsv->lock);
1765 /* Mixed block groups accounting is not byte-accurate, avoid overflow */
1766 if (buf->f_bfree >= block_rsv->size >> bits)
1767 buf->f_bfree -= block_rsv->size >> bits;
1768 else
1769 buf->f_bfree = 0;
1770 spin_unlock(&block_rsv->lock);
1771
1772 buf->f_bavail = div_u64(total_free_data, factor);
1773 ret = btrfs_calc_avail_data_space(fs_info, &total_free_data);
1774 if (ret)
1775 return ret;
1776 buf->f_bavail += div_u64(total_free_data, factor);
1777 buf->f_bavail = buf->f_bavail >> bits;
1778
1779 /*
1780 * We calculate the remaining metadata space minus global reserve. If
1781 * this is (supposedly) smaller than zero, there's no space. But this
1782 * does not hold in practice, the exhausted state happens where's still
1783 * some positive delta. So we apply some guesswork and compare the
1784 * delta to a 4M threshold. (Practically observed delta was ~2M.)
1785 *
1786 * We probably cannot calculate the exact threshold value because this
1787 * depends on the internal reservations requested by various
1788 * operations, so some operations that consume a few metadata will
1789 * succeed even if the Avail is zero. But this is better than the other
1790 * way around.
1791 */
1792 thresh = SZ_4M;
1793
1794 /*
1795 * We only want to claim there's no available space if we can no longer
1796 * allocate chunks for our metadata profile and our global reserve will
1797 * not fit in the free metadata space. If we aren't ->full then we
1798 * still can allocate chunks and thus are fine using the currently
1799 * calculated f_bavail.
1800 */
1801 if (!mixed && block_rsv->space_info->full &&
1802 (total_free_meta < thresh || total_free_meta - thresh < block_rsv->size))
1803 buf->f_bavail = 0;
1804
1805 buf->f_type = BTRFS_SUPER_MAGIC;
1806 buf->f_bsize = fs_info->sectorsize;
1807 buf->f_namelen = BTRFS_NAME_LEN;
1808
1809 /* We treat it as constant endianness (it doesn't matter _which_)
1810 because we want the fsid to come out the same whether mounted
1811 on a big-endian or little-endian host */
1812 buf->f_fsid.val[0] = be32_to_cpu(fsid[0]) ^ be32_to_cpu(fsid[2]);
1813 buf->f_fsid.val[1] = be32_to_cpu(fsid[1]) ^ be32_to_cpu(fsid[3]);
1814 /* Mask in the root object ID too, to disambiguate subvols */
1815 buf->f_fsid.val[0] ^= btrfs_root_id(BTRFS_I(d_inode(dentry))->root) >> 32;
1816 buf->f_fsid.val[1] ^= btrfs_root_id(BTRFS_I(d_inode(dentry))->root);
1817
1818 return 0;
1819}
1820
1821static int btrfs_fc_test_super(struct super_block *sb, struct fs_context *fc)
1822{
1823 struct btrfs_fs_info *p = fc->s_fs_info;
1824 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
1825
1826 return fs_info->fs_devices == p->fs_devices;
1827}
1828
1829static int btrfs_get_tree_super(struct fs_context *fc)
1830{
1831 struct btrfs_fs_info *fs_info = fc->s_fs_info;
1832 struct btrfs_fs_context *ctx = fc->fs_private;
1833 struct btrfs_fs_devices *fs_devices = NULL;
1834 struct block_device *bdev;
1835 struct btrfs_device *device;
1836 struct super_block *sb;
1837 blk_mode_t mode = btrfs_open_mode(fc);
1838 int ret;
1839
1840 btrfs_ctx_to_info(fs_info, ctx);
1841 mutex_lock(&uuid_mutex);
1842
1843 /*
1844 * With 'true' passed to btrfs_scan_one_device() (mount time) we expect
1845 * either a valid device or an error.
1846 */
1847 device = btrfs_scan_one_device(fc->source, mode, true);
1848 ASSERT(device != NULL);
1849 if (IS_ERR(device)) {
1850 mutex_unlock(&uuid_mutex);
1851 return PTR_ERR(device);
1852 }
1853
1854 fs_devices = device->fs_devices;
1855 fs_info->fs_devices = fs_devices;
1856
1857 ret = btrfs_open_devices(fs_devices, mode, &btrfs_fs_type);
1858 mutex_unlock(&uuid_mutex);
1859 if (ret)
1860 return ret;
1861
1862 if (!(fc->sb_flags & SB_RDONLY) && fs_devices->rw_devices == 0) {
1863 ret = -EACCES;
1864 goto error;
1865 }
1866
1867 bdev = fs_devices->latest_dev->bdev;
1868
1869 /*
1870 * From now on the error handling is not straightforward.
1871 *
1872 * If successful, this will transfer the fs_info into the super block,
1873 * and fc->s_fs_info will be NULL. However if there's an existing
1874 * super, we'll still have fc->s_fs_info populated. If we error
1875 * completely out it'll be cleaned up when we drop the fs_context,
1876 * otherwise it's tied to the lifetime of the super_block.
1877 */
1878 sb = sget_fc(fc, btrfs_fc_test_super, set_anon_super_fc);
1879 if (IS_ERR(sb)) {
1880 ret = PTR_ERR(sb);
1881 goto error;
1882 }
1883
1884 set_device_specific_options(fs_info);
1885
1886 if (sb->s_root) {
1887 btrfs_close_devices(fs_devices);
1888 /*
1889 * At this stage we may have RO flag mismatch between
1890 * fc->sb_flags and sb->s_flags. Caller should detect such
1891 * mismatch and reconfigure with sb->s_umount rwsem held if
1892 * needed.
1893 */
1894 } else {
1895 snprintf(sb->s_id, sizeof(sb->s_id), "%pg", bdev);
1896 shrinker_debugfs_rename(sb->s_shrink, "sb-btrfs:%s", sb->s_id);
1897 btrfs_sb(sb)->bdev_holder = &btrfs_fs_type;
1898 ret = btrfs_fill_super(sb, fs_devices);
1899 if (ret) {
1900 deactivate_locked_super(sb);
1901 return ret;
1902 }
1903 }
1904
1905 btrfs_clear_oneshot_options(fs_info);
1906
1907 fc->root = dget(sb->s_root);
1908 return 0;
1909
1910error:
1911 btrfs_close_devices(fs_devices);
1912 return ret;
1913}
1914
1915/*
1916 * Ever since commit 0723a0473fb4 ("btrfs: allow mounting btrfs subvolumes
1917 * with different ro/rw options") the following works:
1918 *
1919 * (i) mount /dev/sda3 -o subvol=foo,ro /mnt/foo
1920 * (ii) mount /dev/sda3 -o subvol=bar,rw /mnt/bar
1921 *
1922 * which looks nice and innocent but is actually pretty intricate and deserves
1923 * a long comment.
1924 *
1925 * On another filesystem a subvolume mount is close to something like:
1926 *
1927 * (iii) # create rw superblock + initial mount
1928 * mount -t xfs /dev/sdb /opt/
1929 *
1930 * # create ro bind mount
1931 * mount --bind -o ro /opt/foo /mnt/foo
1932 *
1933 * # unmount initial mount
1934 * umount /opt
1935 *
1936 * Of course, there's some special subvolume sauce and there's the fact that the
1937 * sb->s_root dentry is really swapped after mount_subtree(). But conceptually
1938 * it's very close and will help us understand the issue.
1939 *
1940 * The old mount API didn't cleanly distinguish between a mount being made ro
1941 * and a superblock being made ro. The only way to change the ro state of
1942 * either object was by passing ms_rdonly. If a new mount was created via
1943 * mount(2) such as:
1944 *
1945 * mount("/dev/sdb", "/mnt", "xfs", ms_rdonly, null);
1946 *
1947 * the MS_RDONLY flag being specified had two effects:
1948 *
1949 * (1) MNT_READONLY was raised -> the resulting mount got
1950 * @mnt->mnt_flags |= MNT_READONLY raised.
1951 *
1952 * (2) MS_RDONLY was passed to the filesystem's mount method and the filesystems
1953 * made the superblock ro. Note, how SB_RDONLY has the same value as
1954 * ms_rdonly and is raised whenever MS_RDONLY is passed through mount(2).
1955 *
1956 * Creating a subtree mount via (iii) ends up leaving a rw superblock with a
1957 * subtree mounted ro.
1958 *
1959 * But consider the effect on the old mount API on btrfs subvolume mounting
1960 * which combines the distinct step in (iii) into a single step.
1961 *
1962 * By issuing (i) both the mount and the superblock are turned ro. Now when (ii)
1963 * is issued the superblock is ro and thus even if the mount created for (ii) is
1964 * rw it wouldn't help. Hence, btrfs needed to transition the superblock from ro
1965 * to rw for (ii) which it did using an internal remount call.
1966 *
1967 * IOW, subvolume mounting was inherently complicated due to the ambiguity of
1968 * MS_RDONLY in mount(2). Note, this ambiguity has mount(8) always translate
1969 * "ro" to MS_RDONLY. IOW, in both (i) and (ii) "ro" becomes MS_RDONLY when
1970 * passed by mount(8) to mount(2).
1971 *
1972 * Enter the new mount API. The new mount API disambiguates making a mount ro
1973 * and making a superblock ro.
1974 *
1975 * (3) To turn a mount ro the MOUNT_ATTR_ONLY flag can be used with either
1976 * fsmount() or mount_setattr() this is a pure VFS level change for a
1977 * specific mount or mount tree that is never seen by the filesystem itself.
1978 *
1979 * (4) To turn a superblock ro the "ro" flag must be used with
1980 * fsconfig(FSCONFIG_SET_FLAG, "ro"). This option is seen by the filesystem
1981 * in fc->sb_flags.
1982 *
1983 * But, currently the util-linux mount command already utilizes the new mount
1984 * API and is still setting fsconfig(FSCONFIG_SET_FLAG, "ro") no matter if it's
1985 * btrfs or not, setting the whole super block RO. To make per-subvolume mounting
1986 * work with different options work we need to keep backward compatibility.
1987 */
1988static int btrfs_reconfigure_for_mount(struct fs_context *fc, struct vfsmount *mnt)
1989{
1990 int ret = 0;
1991
1992 if (fc->sb_flags & SB_RDONLY)
1993 return ret;
1994
1995 down_write(&mnt->mnt_sb->s_umount);
1996 if (!(fc->sb_flags & SB_RDONLY) && (mnt->mnt_sb->s_flags & SB_RDONLY))
1997 ret = btrfs_reconfigure(fc);
1998 up_write(&mnt->mnt_sb->s_umount);
1999 return ret;
2000}
2001
2002static int btrfs_get_tree_subvol(struct fs_context *fc)
2003{
2004 struct btrfs_fs_info *fs_info = NULL;
2005 struct btrfs_fs_context *ctx = fc->fs_private;
2006 struct fs_context *dup_fc;
2007 struct dentry *dentry;
2008 struct vfsmount *mnt;
2009 int ret = 0;
2010
2011 /*
2012 * Setup a dummy root and fs_info for test/set super. This is because
2013 * we don't actually fill this stuff out until open_ctree, but we need
2014 * then open_ctree will properly initialize the file system specific
2015 * settings later. btrfs_init_fs_info initializes the static elements
2016 * of the fs_info (locks and such) to make cleanup easier if we find a
2017 * superblock with our given fs_devices later on at sget() time.
2018 */
2019 fs_info = kvzalloc(sizeof(struct btrfs_fs_info), GFP_KERNEL);
2020 if (!fs_info)
2021 return -ENOMEM;
2022
2023 fs_info->super_copy = kzalloc(BTRFS_SUPER_INFO_SIZE, GFP_KERNEL);
2024 fs_info->super_for_commit = kzalloc(BTRFS_SUPER_INFO_SIZE, GFP_KERNEL);
2025 if (!fs_info->super_copy || !fs_info->super_for_commit) {
2026 btrfs_free_fs_info(fs_info);
2027 return -ENOMEM;
2028 }
2029 btrfs_init_fs_info(fs_info);
2030
2031 dup_fc = vfs_dup_fs_context(fc);
2032 if (IS_ERR(dup_fc)) {
2033 btrfs_free_fs_info(fs_info);
2034 return PTR_ERR(dup_fc);
2035 }
2036
2037 /*
2038 * When we do the sget_fc this gets transferred to the sb, so we only
2039 * need to set it on the dup_fc as this is what creates the super block.
2040 */
2041 dup_fc->s_fs_info = fs_info;
2042
2043 /*
2044 * We'll do the security settings in our btrfs_get_tree_super() mount
2045 * loop, they were duplicated into dup_fc, we can drop the originals
2046 * here.
2047 */
2048 security_free_mnt_opts(&fc->security);
2049 fc->security = NULL;
2050
2051 mnt = fc_mount(dup_fc);
2052 if (IS_ERR(mnt)) {
2053 put_fs_context(dup_fc);
2054 return PTR_ERR(mnt);
2055 }
2056 ret = btrfs_reconfigure_for_mount(dup_fc, mnt);
2057 put_fs_context(dup_fc);
2058 if (ret) {
2059 mntput(mnt);
2060 return ret;
2061 }
2062
2063 /*
2064 * This free's ->subvol_name, because if it isn't set we have to
2065 * allocate a buffer to hold the subvol_name, so we just drop our
2066 * reference to it here.
2067 */
2068 dentry = mount_subvol(ctx->subvol_name, ctx->subvol_objectid, mnt);
2069 ctx->subvol_name = NULL;
2070 if (IS_ERR(dentry))
2071 return PTR_ERR(dentry);
2072
2073 fc->root = dentry;
2074 return 0;
2075}
2076
2077static int btrfs_get_tree(struct fs_context *fc)
2078{
2079 /*
2080 * Since we use mount_subtree to mount the default/specified subvol, we
2081 * have to do mounts in two steps.
2082 *
2083 * First pass through we call btrfs_get_tree_subvol(), this is just a
2084 * wrapper around fc_mount() to call back into here again, and this time
2085 * we'll call btrfs_get_tree_super(). This will do the open_ctree() and
2086 * everything to open the devices and file system. Then we return back
2087 * with a fully constructed vfsmount in btrfs_get_tree_subvol(), and
2088 * from there we can do our mount_subvol() call, which will lookup
2089 * whichever subvol we're mounting and setup this fc with the
2090 * appropriate dentry for the subvol.
2091 */
2092 if (fc->s_fs_info)
2093 return btrfs_get_tree_super(fc);
2094 return btrfs_get_tree_subvol(fc);
2095}
2096
2097static void btrfs_kill_super(struct super_block *sb)
2098{
2099 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
2100 kill_anon_super(sb);
2101 btrfs_free_fs_info(fs_info);
2102}
2103
2104static void btrfs_free_fs_context(struct fs_context *fc)
2105{
2106 struct btrfs_fs_context *ctx = fc->fs_private;
2107 struct btrfs_fs_info *fs_info = fc->s_fs_info;
2108
2109 if (fs_info)
2110 btrfs_free_fs_info(fs_info);
2111
2112 if (ctx && refcount_dec_and_test(&ctx->refs)) {
2113 kfree(ctx->subvol_name);
2114 kfree(ctx);
2115 }
2116}
2117
2118static int btrfs_dup_fs_context(struct fs_context *fc, struct fs_context *src_fc)
2119{
2120 struct btrfs_fs_context *ctx = src_fc->fs_private;
2121
2122 /*
2123 * Give a ref to our ctx to this dup, as we want to keep it around for
2124 * our original fc so we can have the subvolume name or objectid.
2125 *
2126 * We unset ->source in the original fc because the dup needs it for
2127 * mounting, and then once we free the dup it'll free ->source, so we
2128 * need to make sure we're only pointing to it in one fc.
2129 */
2130 refcount_inc(&ctx->refs);
2131 fc->fs_private = ctx;
2132 fc->source = src_fc->source;
2133 src_fc->source = NULL;
2134 return 0;
2135}
2136
2137static const struct fs_context_operations btrfs_fs_context_ops = {
2138 .parse_param = btrfs_parse_param,
2139 .reconfigure = btrfs_reconfigure,
2140 .get_tree = btrfs_get_tree,
2141 .dup = btrfs_dup_fs_context,
2142 .free = btrfs_free_fs_context,
2143};
2144
2145static int btrfs_init_fs_context(struct fs_context *fc)
2146{
2147 struct btrfs_fs_context *ctx;
2148
2149 ctx = kzalloc(sizeof(struct btrfs_fs_context), GFP_KERNEL);
2150 if (!ctx)
2151 return -ENOMEM;
2152
2153 refcount_set(&ctx->refs, 1);
2154 fc->fs_private = ctx;
2155 fc->ops = &btrfs_fs_context_ops;
2156
2157 if (fc->purpose == FS_CONTEXT_FOR_RECONFIGURE) {
2158 btrfs_info_to_ctx(btrfs_sb(fc->root->d_sb), ctx);
2159 } else {
2160 ctx->thread_pool_size =
2161 min_t(unsigned long, num_online_cpus() + 2, 8);
2162 ctx->max_inline = BTRFS_DEFAULT_MAX_INLINE;
2163 ctx->commit_interval = BTRFS_DEFAULT_COMMIT_INTERVAL;
2164 }
2165
2166#ifdef CONFIG_BTRFS_FS_POSIX_ACL
2167 fc->sb_flags |= SB_POSIXACL;
2168#endif
2169 fc->sb_flags |= SB_I_VERSION;
2170
2171 return 0;
2172}
2173
2174static struct file_system_type btrfs_fs_type = {
2175 .owner = THIS_MODULE,
2176 .name = "btrfs",
2177 .init_fs_context = btrfs_init_fs_context,
2178 .parameters = btrfs_fs_parameters,
2179 .kill_sb = btrfs_kill_super,
2180 .fs_flags = FS_REQUIRES_DEV | FS_BINARY_MOUNTDATA |
2181 FS_ALLOW_IDMAP | FS_MGTIME,
2182 };
2183
2184MODULE_ALIAS_FS("btrfs");
2185
2186static int btrfs_control_open(struct inode *inode, struct file *file)
2187{
2188 /*
2189 * The control file's private_data is used to hold the
2190 * transaction when it is started and is used to keep
2191 * track of whether a transaction is already in progress.
2192 */
2193 file->private_data = NULL;
2194 return 0;
2195}
2196
2197/*
2198 * Used by /dev/btrfs-control for devices ioctls.
2199 */
2200static long btrfs_control_ioctl(struct file *file, unsigned int cmd,
2201 unsigned long arg)
2202{
2203 struct btrfs_ioctl_vol_args *vol;
2204 struct btrfs_device *device = NULL;
2205 dev_t devt = 0;
2206 int ret = -ENOTTY;
2207
2208 if (!capable(CAP_SYS_ADMIN))
2209 return -EPERM;
2210
2211 vol = memdup_user((void __user *)arg, sizeof(*vol));
2212 if (IS_ERR(vol))
2213 return PTR_ERR(vol);
2214 ret = btrfs_check_ioctl_vol_args_path(vol);
2215 if (ret < 0)
2216 goto out;
2217
2218 switch (cmd) {
2219 case BTRFS_IOC_SCAN_DEV:
2220 mutex_lock(&uuid_mutex);
2221 /*
2222 * Scanning outside of mount can return NULL which would turn
2223 * into 0 error code.
2224 */
2225 device = btrfs_scan_one_device(vol->name, BLK_OPEN_READ, false);
2226 ret = PTR_ERR_OR_ZERO(device);
2227 mutex_unlock(&uuid_mutex);
2228 break;
2229 case BTRFS_IOC_FORGET_DEV:
2230 if (vol->name[0] != 0) {
2231 ret = lookup_bdev(vol->name, &devt);
2232 if (ret)
2233 break;
2234 }
2235 ret = btrfs_forget_devices(devt);
2236 break;
2237 case BTRFS_IOC_DEVICES_READY:
2238 mutex_lock(&uuid_mutex);
2239 /*
2240 * Scanning outside of mount can return NULL which would turn
2241 * into 0 error code.
2242 */
2243 device = btrfs_scan_one_device(vol->name, BLK_OPEN_READ, false);
2244 if (IS_ERR_OR_NULL(device)) {
2245 mutex_unlock(&uuid_mutex);
2246 if (IS_ERR(device))
2247 ret = PTR_ERR(device);
2248 else
2249 ret = 0;
2250 break;
2251 }
2252 ret = !(device->fs_devices->num_devices ==
2253 device->fs_devices->total_devices);
2254 mutex_unlock(&uuid_mutex);
2255 break;
2256 case BTRFS_IOC_GET_SUPPORTED_FEATURES:
2257 ret = btrfs_ioctl_get_supported_features((void __user*)arg);
2258 break;
2259 }
2260
2261out:
2262 kfree(vol);
2263 return ret;
2264}
2265
2266static int btrfs_freeze(struct super_block *sb)
2267{
2268 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
2269
2270 set_bit(BTRFS_FS_FROZEN, &fs_info->flags);
2271 /*
2272 * We don't need a barrier here, we'll wait for any transaction that
2273 * could be in progress on other threads (and do delayed iputs that
2274 * we want to avoid on a frozen filesystem), or do the commit
2275 * ourselves.
2276 */
2277 return btrfs_commit_current_transaction(fs_info->tree_root);
2278}
2279
2280static int check_dev_super(struct btrfs_device *dev)
2281{
2282 struct btrfs_fs_info *fs_info = dev->fs_info;
2283 struct btrfs_super_block *sb;
2284 u64 last_trans;
2285 u16 csum_type;
2286 int ret = 0;
2287
2288 /* This should be called with fs still frozen. */
2289 ASSERT(test_bit(BTRFS_FS_FROZEN, &fs_info->flags));
2290
2291 /* Missing dev, no need to check. */
2292 if (!dev->bdev)
2293 return 0;
2294
2295 /* Only need to check the primary super block. */
2296 sb = btrfs_read_dev_one_super(dev->bdev, 0, true);
2297 if (IS_ERR(sb))
2298 return PTR_ERR(sb);
2299
2300 /* Verify the checksum. */
2301 csum_type = btrfs_super_csum_type(sb);
2302 if (csum_type != btrfs_super_csum_type(fs_info->super_copy)) {
2303 btrfs_err(fs_info, "csum type changed, has %u expect %u",
2304 csum_type, btrfs_super_csum_type(fs_info->super_copy));
2305 ret = -EUCLEAN;
2306 goto out;
2307 }
2308
2309 if (btrfs_check_super_csum(fs_info, sb)) {
2310 btrfs_err(fs_info, "csum for on-disk super block no longer matches");
2311 ret = -EUCLEAN;
2312 goto out;
2313 }
2314
2315 /* Btrfs_validate_super() includes fsid check against super->fsid. */
2316 ret = btrfs_validate_super(fs_info, sb, 0);
2317 if (ret < 0)
2318 goto out;
2319
2320 last_trans = btrfs_get_last_trans_committed(fs_info);
2321 if (btrfs_super_generation(sb) != last_trans) {
2322 btrfs_err(fs_info, "transid mismatch, has %llu expect %llu",
2323 btrfs_super_generation(sb), last_trans);
2324 ret = -EUCLEAN;
2325 goto out;
2326 }
2327out:
2328 btrfs_release_disk_super(sb);
2329 return ret;
2330}
2331
2332static int btrfs_unfreeze(struct super_block *sb)
2333{
2334 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
2335 struct btrfs_device *device;
2336 int ret = 0;
2337
2338 /*
2339 * Make sure the fs is not changed by accident (like hibernation then
2340 * modified by other OS).
2341 * If we found anything wrong, we mark the fs error immediately.
2342 *
2343 * And since the fs is frozen, no one can modify the fs yet, thus
2344 * we don't need to hold device_list_mutex.
2345 */
2346 list_for_each_entry(device, &fs_info->fs_devices->devices, dev_list) {
2347 ret = check_dev_super(device);
2348 if (ret < 0) {
2349 btrfs_handle_fs_error(fs_info, ret,
2350 "super block on devid %llu got modified unexpectedly",
2351 device->devid);
2352 break;
2353 }
2354 }
2355 clear_bit(BTRFS_FS_FROZEN, &fs_info->flags);
2356
2357 /*
2358 * We still return 0, to allow VFS layer to unfreeze the fs even the
2359 * above checks failed. Since the fs is either fine or read-only, we're
2360 * safe to continue, without causing further damage.
2361 */
2362 return 0;
2363}
2364
2365static int btrfs_show_devname(struct seq_file *m, struct dentry *root)
2366{
2367 struct btrfs_fs_info *fs_info = btrfs_sb(root->d_sb);
2368
2369 /*
2370 * There should be always a valid pointer in latest_dev, it may be stale
2371 * for a short moment in case it's being deleted but still valid until
2372 * the end of RCU grace period.
2373 */
2374 rcu_read_lock();
2375 seq_escape(m, btrfs_dev_name(fs_info->fs_devices->latest_dev), " \t\n\\");
2376 rcu_read_unlock();
2377
2378 return 0;
2379}
2380
2381static long btrfs_nr_cached_objects(struct super_block *sb, struct shrink_control *sc)
2382{
2383 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
2384 const s64 nr = percpu_counter_sum_positive(&fs_info->evictable_extent_maps);
2385
2386 trace_btrfs_extent_map_shrinker_count(fs_info, nr);
2387
2388 return nr;
2389}
2390
2391static long btrfs_free_cached_objects(struct super_block *sb, struct shrink_control *sc)
2392{
2393 const long nr_to_scan = min_t(unsigned long, LONG_MAX, sc->nr_to_scan);
2394 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
2395
2396 btrfs_free_extent_maps(fs_info, nr_to_scan);
2397
2398 /* The extent map shrinker runs asynchronously, so always return 0. */
2399 return 0;
2400}
2401
2402static const struct super_operations btrfs_super_ops = {
2403 .drop_inode = btrfs_drop_inode,
2404 .evict_inode = btrfs_evict_inode,
2405 .put_super = btrfs_put_super,
2406 .sync_fs = btrfs_sync_fs,
2407 .show_options = btrfs_show_options,
2408 .show_devname = btrfs_show_devname,
2409 .alloc_inode = btrfs_alloc_inode,
2410 .destroy_inode = btrfs_destroy_inode,
2411 .free_inode = btrfs_free_inode,
2412 .statfs = btrfs_statfs,
2413 .freeze_fs = btrfs_freeze,
2414 .unfreeze_fs = btrfs_unfreeze,
2415 .nr_cached_objects = btrfs_nr_cached_objects,
2416 .free_cached_objects = btrfs_free_cached_objects,
2417};
2418
2419static const struct file_operations btrfs_ctl_fops = {
2420 .open = btrfs_control_open,
2421 .unlocked_ioctl = btrfs_control_ioctl,
2422 .compat_ioctl = compat_ptr_ioctl,
2423 .owner = THIS_MODULE,
2424 .llseek = noop_llseek,
2425};
2426
2427static struct miscdevice btrfs_misc = {
2428 .minor = BTRFS_MINOR,
2429 .name = "btrfs-control",
2430 .fops = &btrfs_ctl_fops
2431};
2432
2433MODULE_ALIAS_MISCDEV(BTRFS_MINOR);
2434MODULE_ALIAS("devname:btrfs-control");
2435
2436static int __init btrfs_interface_init(void)
2437{
2438 return misc_register(&btrfs_misc);
2439}
2440
2441static __cold void btrfs_interface_exit(void)
2442{
2443 misc_deregister(&btrfs_misc);
2444}
2445
2446static int __init btrfs_print_mod_info(void)
2447{
2448 static const char options[] = ""
2449#ifdef CONFIG_BTRFS_DEBUG
2450 ", debug=on"
2451#endif
2452#ifdef CONFIG_BTRFS_ASSERT
2453 ", assert=on"
2454#endif
2455#ifdef CONFIG_BTRFS_FS_REF_VERIFY
2456 ", ref-verify=on"
2457#endif
2458#ifdef CONFIG_BLK_DEV_ZONED
2459 ", zoned=yes"
2460#else
2461 ", zoned=no"
2462#endif
2463#ifdef CONFIG_FS_VERITY
2464 ", fsverity=yes"
2465#else
2466 ", fsverity=no"
2467#endif
2468 ;
2469 pr_info("Btrfs loaded%s\n", options);
2470 return 0;
2471}
2472
2473static int register_btrfs(void)
2474{
2475 return register_filesystem(&btrfs_fs_type);
2476}
2477
2478static void unregister_btrfs(void)
2479{
2480 unregister_filesystem(&btrfs_fs_type);
2481}
2482
2483/* Helper structure for long init/exit functions. */
2484struct init_sequence {
2485 int (*init_func)(void);
2486 /* Can be NULL if the init_func doesn't need cleanup. */
2487 void (*exit_func)(void);
2488};
2489
2490static const struct init_sequence mod_init_seq[] = {
2491 {
2492 .init_func = btrfs_props_init,
2493 .exit_func = NULL,
2494 }, {
2495 .init_func = btrfs_init_sysfs,
2496 .exit_func = btrfs_exit_sysfs,
2497 }, {
2498 .init_func = btrfs_init_compress,
2499 .exit_func = btrfs_exit_compress,
2500 }, {
2501 .init_func = btrfs_init_cachep,
2502 .exit_func = btrfs_destroy_cachep,
2503 }, {
2504 .init_func = btrfs_init_dio,
2505 .exit_func = btrfs_destroy_dio,
2506 }, {
2507 .init_func = btrfs_transaction_init,
2508 .exit_func = btrfs_transaction_exit,
2509 }, {
2510 .init_func = btrfs_ctree_init,
2511 .exit_func = btrfs_ctree_exit,
2512 }, {
2513 .init_func = btrfs_free_space_init,
2514 .exit_func = btrfs_free_space_exit,
2515 }, {
2516 .init_func = extent_state_init_cachep,
2517 .exit_func = extent_state_free_cachep,
2518 }, {
2519 .init_func = extent_buffer_init_cachep,
2520 .exit_func = extent_buffer_free_cachep,
2521 }, {
2522 .init_func = btrfs_bioset_init,
2523 .exit_func = btrfs_bioset_exit,
2524 }, {
2525 .init_func = extent_map_init,
2526 .exit_func = extent_map_exit,
2527 }, {
2528 .init_func = ordered_data_init,
2529 .exit_func = ordered_data_exit,
2530 }, {
2531 .init_func = btrfs_delayed_inode_init,
2532 .exit_func = btrfs_delayed_inode_exit,
2533 }, {
2534 .init_func = btrfs_auto_defrag_init,
2535 .exit_func = btrfs_auto_defrag_exit,
2536 }, {
2537 .init_func = btrfs_delayed_ref_init,
2538 .exit_func = btrfs_delayed_ref_exit,
2539 }, {
2540 .init_func = btrfs_prelim_ref_init,
2541 .exit_func = btrfs_prelim_ref_exit,
2542 }, {
2543 .init_func = btrfs_interface_init,
2544 .exit_func = btrfs_interface_exit,
2545 }, {
2546 .init_func = btrfs_print_mod_info,
2547 .exit_func = NULL,
2548 }, {
2549 .init_func = btrfs_run_sanity_tests,
2550 .exit_func = NULL,
2551 }, {
2552 .init_func = register_btrfs,
2553 .exit_func = unregister_btrfs,
2554 }
2555};
2556
2557static bool mod_init_result[ARRAY_SIZE(mod_init_seq)];
2558
2559static __always_inline void btrfs_exit_btrfs_fs(void)
2560{
2561 int i;
2562
2563 for (i = ARRAY_SIZE(mod_init_seq) - 1; i >= 0; i--) {
2564 if (!mod_init_result[i])
2565 continue;
2566 if (mod_init_seq[i].exit_func)
2567 mod_init_seq[i].exit_func();
2568 mod_init_result[i] = false;
2569 }
2570}
2571
2572static void __exit exit_btrfs_fs(void)
2573{
2574 btrfs_exit_btrfs_fs();
2575 btrfs_cleanup_fs_uuids();
2576}
2577
2578static int __init init_btrfs_fs(void)
2579{
2580 int ret;
2581 int i;
2582
2583 for (i = 0; i < ARRAY_SIZE(mod_init_seq); i++) {
2584 ASSERT(!mod_init_result[i]);
2585 ret = mod_init_seq[i].init_func();
2586 if (ret < 0) {
2587 btrfs_exit_btrfs_fs();
2588 return ret;
2589 }
2590 mod_init_result[i] = true;
2591 }
2592 return 0;
2593}
2594
2595late_initcall(init_btrfs_fs);
2596module_exit(exit_btrfs_fs)
2597
2598MODULE_DESCRIPTION("B-Tree File System (BTRFS)");
2599MODULE_LICENSE("GPL");
2600MODULE_SOFTDEP("pre: crc32c");
2601MODULE_SOFTDEP("pre: xxhash64");
2602MODULE_SOFTDEP("pre: sha256");
2603MODULE_SOFTDEP("pre: blake2b-256");