2 * Copyright (C) 2007 Oracle. All rights reserved.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public
6 * License v2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write to the
15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 * Boston, MA 021110-1307, USA.
19 #include <linux/blkdev.h>
20 #include <linux/module.h>
21 #include <linux/buffer_head.h>
23 #include <linux/pagemap.h>
24 #include <linux/highmem.h>
25 #include <linux/time.h>
26 #include <linux/init.h>
27 #include <linux/seq_file.h>
28 #include <linux/string.h>
29 #include <linux/backing-dev.h>
30 #include <linux/mount.h>
31 #include <linux/mpage.h>
32 #include <linux/swap.h>
33 #include <linux/writeback.h>
34 #include <linux/statfs.h>
35 #include <linux/compat.h>
36 #include <linux/parser.h>
37 #include <linux/ctype.h>
38 #include <linux/namei.h>
39 #include <linux/miscdevice.h>
40 #include <linux/magic.h>
41 #include <linux/slab.h>
42 #include <linux/cleancache.h>
43 #include <linux/ratelimit.h>
45 #include "delayed-inode.h"
48 #include "transaction.h"
49 #include "btrfs_inode.h"
51 #include "print-tree.h"
56 #include "compression.h"
57 #include "rcu-string.h"
59 #define CREATE_TRACE_POINTS
60 #include <trace/events/btrfs.h>
62 static const struct super_operations btrfs_super_ops;
63 static struct file_system_type btrfs_fs_type;
65 static const char *btrfs_decode_error(struct btrfs_fs_info *fs_info, int errno,
72 errstr = "IO failure";
75 errstr = "Out of memory";
78 errstr = "Readonly filesystem";
81 errstr = "Object already exists";
85 if (snprintf(nbuf, 16, "error %d", -errno) >= 0)
94 static void __save_error_info(struct btrfs_fs_info *fs_info)
97 * today we only save the error info into ram. Long term we'll
98 * also send it down to the disk
100 fs_info->fs_state = BTRFS_SUPER_FLAG_ERROR;
103 static void save_error_info(struct btrfs_fs_info *fs_info)
105 __save_error_info(fs_info);
108 /* btrfs handle error by forcing the filesystem readonly */
109 static void btrfs_handle_error(struct btrfs_fs_info *fs_info)
111 struct super_block *sb = fs_info->sb;
113 if (sb->s_flags & MS_RDONLY)
116 if (fs_info->fs_state & BTRFS_SUPER_FLAG_ERROR) {
117 sb->s_flags |= MS_RDONLY;
118 printk(KERN_INFO "btrfs is forced readonly\n");
119 __btrfs_scrub_cancel(fs_info);
126 * __btrfs_std_error decodes expected errors from the caller and
127 * invokes the approciate error response.
129 void __btrfs_std_error(struct btrfs_fs_info *fs_info, const char *function,
130 unsigned int line, int errno, const char *fmt, ...)
132 struct super_block *sb = fs_info->sb;
139 * Special case: if the error is EROFS, and we're already
140 * under MS_RDONLY, then it is safe here.
142 if (errno == -EROFS && (sb->s_flags & MS_RDONLY))
145 errstr = btrfs_decode_error(fs_info, errno, nbuf);
147 struct va_format vaf = {
152 printk(KERN_CRIT "BTRFS error (device %s) in %s:%d: %s (%pV)\n",
153 sb->s_id, function, line, errstr, &vaf);
155 printk(KERN_CRIT "BTRFS error (device %s) in %s:%d: %s\n",
156 sb->s_id, function, line, errstr);
159 /* Don't go through full error handling during mount */
160 if (sb->s_flags & MS_BORN) {
161 save_error_info(fs_info);
162 btrfs_handle_error(fs_info);
167 static const char * const logtypes[] = {
178 void btrfs_printk(struct btrfs_fs_info *fs_info, const char *fmt, ...)
180 struct super_block *sb = fs_info->sb;
182 struct va_format vaf;
184 const char *type = logtypes[4];
189 kern_level = printk_get_level(fmt);
191 size_t size = printk_skip_level(fmt) - fmt;
192 memcpy(lvl, fmt, size);
195 type = logtypes[kern_level - '0'];
202 printk("%sBTRFS %s (device %s): %pV", lvl, type, sb->s_id, &vaf);
209 void __btrfs_std_error(struct btrfs_fs_info *fs_info, const char *function,
210 unsigned int line, int errno, const char *fmt, ...)
212 struct super_block *sb = fs_info->sb;
215 * Special case: if the error is EROFS, and we're already
216 * under MS_RDONLY, then it is safe here.
218 if (errno == -EROFS && (sb->s_flags & MS_RDONLY))
221 /* Don't go through full error handling during mount */
222 if (sb->s_flags & MS_BORN) {
223 save_error_info(fs_info);
224 btrfs_handle_error(fs_info);
230 * We only mark the transaction aborted and then set the file system read-only.
231 * This will prevent new transactions from starting or trying to join this
234 * This means that error recovery at the call site is limited to freeing
235 * any local memory allocations and passing the error code up without
236 * further cleanup. The transaction should complete as it normally would
237 * in the call path but will return -EIO.
239 * We'll complete the cleanup in btrfs_end_transaction and
240 * btrfs_commit_transaction.
242 void __btrfs_abort_transaction(struct btrfs_trans_handle *trans,
243 struct btrfs_root *root, const char *function,
244 unsigned int line, int errno)
246 WARN_ONCE(1, KERN_DEBUG "btrfs: Transaction aborted");
247 trans->aborted = errno;
248 /* Nothing used. The other threads that have joined this
249 * transaction may be able to continue. */
250 if (!trans->blocks_used) {
254 errstr = btrfs_decode_error(root->fs_info, errno, nbuf);
255 btrfs_printk(root->fs_info,
256 "%s:%d: Aborting unused transaction(%s).\n",
257 function, line, errstr);
260 trans->transaction->aborted = errno;
261 __btrfs_std_error(root->fs_info, function, line, errno, NULL);
264 * __btrfs_panic decodes unexpected, fatal errors from the caller,
265 * issues an alert, and either panics or BUGs, depending on mount options.
267 void __btrfs_panic(struct btrfs_fs_info *fs_info, const char *function,
268 unsigned int line, int errno, const char *fmt, ...)
271 char *s_id = "<unknown>";
273 struct va_format vaf = { .fmt = fmt };
277 s_id = fs_info->sb->s_id;
282 errstr = btrfs_decode_error(fs_info, errno, nbuf);
283 if (fs_info->mount_opt & BTRFS_MOUNT_PANIC_ON_FATAL_ERROR)
284 panic(KERN_CRIT "BTRFS panic (device %s) in %s:%d: %pV (%s)\n",
285 s_id, function, line, &vaf, errstr);
287 printk(KERN_CRIT "BTRFS panic (device %s) in %s:%d: %pV (%s)\n",
288 s_id, function, line, &vaf, errstr);
290 /* Caller calls BUG() */
293 static void btrfs_put_super(struct super_block *sb)
295 (void)close_ctree(btrfs_sb(sb)->tree_root);
296 /* FIXME: need to fix VFS to return error? */
297 /* AV: return it _where_? ->put_super() can be triggered by any number
298 * of async events, up to and including delivery of SIGKILL to the
299 * last process that kept it busy. Or segfault in the aforementioned
300 * process... Whom would you report that to?
305 Opt_degraded, Opt_subvol, Opt_subvolid, Opt_device, Opt_nodatasum,
306 Opt_nodatacow, Opt_max_inline, Opt_alloc_start, Opt_nobarrier, Opt_ssd,
307 Opt_nossd, Opt_ssd_spread, Opt_thread_pool, Opt_noacl, Opt_compress,
308 Opt_compress_type, Opt_compress_force, Opt_compress_force_type,
309 Opt_notreelog, Opt_ratio, Opt_flushoncommit, Opt_discard,
310 Opt_space_cache, Opt_clear_cache, Opt_user_subvol_rm_allowed,
311 Opt_enospc_debug, Opt_subvolrootid, Opt_defrag, Opt_inode_cache,
312 Opt_no_space_cache, Opt_recovery, Opt_skip_balance,
313 Opt_check_integrity, Opt_check_integrity_including_extent_data,
314 Opt_check_integrity_print_mask, Opt_fatal_errors,
318 static match_table_t tokens = {
319 {Opt_degraded, "degraded"},
320 {Opt_subvol, "subvol=%s"},
321 {Opt_subvolid, "subvolid=%d"},
322 {Opt_device, "device=%s"},
323 {Opt_nodatasum, "nodatasum"},
324 {Opt_nodatacow, "nodatacow"},
325 {Opt_nobarrier, "nobarrier"},
326 {Opt_max_inline, "max_inline=%s"},
327 {Opt_alloc_start, "alloc_start=%s"},
328 {Opt_thread_pool, "thread_pool=%d"},
329 {Opt_compress, "compress"},
330 {Opt_compress_type, "compress=%s"},
331 {Opt_compress_force, "compress-force"},
332 {Opt_compress_force_type, "compress-force=%s"},
334 {Opt_ssd_spread, "ssd_spread"},
335 {Opt_nossd, "nossd"},
336 {Opt_noacl, "noacl"},
337 {Opt_notreelog, "notreelog"},
338 {Opt_flushoncommit, "flushoncommit"},
339 {Opt_ratio, "metadata_ratio=%d"},
340 {Opt_discard, "discard"},
341 {Opt_space_cache, "space_cache"},
342 {Opt_clear_cache, "clear_cache"},
343 {Opt_user_subvol_rm_allowed, "user_subvol_rm_allowed"},
344 {Opt_enospc_debug, "enospc_debug"},
345 {Opt_subvolrootid, "subvolrootid=%d"},
346 {Opt_defrag, "autodefrag"},
347 {Opt_inode_cache, "inode_cache"},
348 {Opt_no_space_cache, "nospace_cache"},
349 {Opt_recovery, "recovery"},
350 {Opt_skip_balance, "skip_balance"},
351 {Opt_check_integrity, "check_int"},
352 {Opt_check_integrity_including_extent_data, "check_int_data"},
353 {Opt_check_integrity_print_mask, "check_int_print_mask=%d"},
354 {Opt_fatal_errors, "fatal_errors=%s"},
359 * Regular mount options parser. Everything that is needed only when
360 * reading in a new superblock is parsed here.
361 * XXX JDM: This needs to be cleaned up for remount.
363 int btrfs_parse_options(struct btrfs_root *root, char *options)
365 struct btrfs_fs_info *info = root->fs_info;
366 substring_t args[MAX_OPT_ARGS];
367 char *p, *num, *orig = NULL;
372 bool compress_force = false;
374 cache_gen = btrfs_super_cache_generation(root->fs_info->super_copy);
376 btrfs_set_opt(info->mount_opt, SPACE_CACHE);
382 * strsep changes the string, duplicate it because parse_options
385 options = kstrdup(options, GFP_NOFS);
391 while ((p = strsep(&options, ",")) != NULL) {
396 token = match_token(p, tokens, args);
399 printk(KERN_INFO "btrfs: allowing degraded mounts\n");
400 btrfs_set_opt(info->mount_opt, DEGRADED);
404 case Opt_subvolrootid:
407 * These are parsed by btrfs_parse_early_options
408 * and can be happily ignored here.
412 printk(KERN_INFO "btrfs: setting nodatasum\n");
413 btrfs_set_opt(info->mount_opt, NODATASUM);
416 printk(KERN_INFO "btrfs: setting nodatacow\n");
417 btrfs_set_opt(info->mount_opt, NODATACOW);
418 btrfs_set_opt(info->mount_opt, NODATASUM);
420 case Opt_compress_force:
421 case Opt_compress_force_type:
422 compress_force = true;
424 case Opt_compress_type:
425 if (token == Opt_compress ||
426 token == Opt_compress_force ||
427 strcmp(args[0].from, "zlib") == 0) {
428 compress_type = "zlib";
429 info->compress_type = BTRFS_COMPRESS_ZLIB;
430 btrfs_set_opt(info->mount_opt, COMPRESS);
431 } else if (strcmp(args[0].from, "lzo") == 0) {
432 compress_type = "lzo";
433 info->compress_type = BTRFS_COMPRESS_LZO;
434 btrfs_set_opt(info->mount_opt, COMPRESS);
435 btrfs_set_fs_incompat(info, COMPRESS_LZO);
436 } else if (strncmp(args[0].from, "no", 2) == 0) {
437 compress_type = "no";
438 info->compress_type = BTRFS_COMPRESS_NONE;
439 btrfs_clear_opt(info->mount_opt, COMPRESS);
440 btrfs_clear_opt(info->mount_opt, FORCE_COMPRESS);
441 compress_force = false;
447 if (compress_force) {
448 btrfs_set_opt(info->mount_opt, FORCE_COMPRESS);
449 pr_info("btrfs: force %s compression\n",
452 pr_info("btrfs: use %s compression\n",
456 printk(KERN_INFO "btrfs: use ssd allocation scheme\n");
457 btrfs_set_opt(info->mount_opt, SSD);
460 printk(KERN_INFO "btrfs: use spread ssd "
461 "allocation scheme\n");
462 btrfs_set_opt(info->mount_opt, SSD);
463 btrfs_set_opt(info->mount_opt, SSD_SPREAD);
466 printk(KERN_INFO "btrfs: not using ssd allocation "
468 btrfs_set_opt(info->mount_opt, NOSSD);
469 btrfs_clear_opt(info->mount_opt, SSD);
470 btrfs_clear_opt(info->mount_opt, SSD_SPREAD);
473 printk(KERN_INFO "btrfs: turning off barriers\n");
474 btrfs_set_opt(info->mount_opt, NOBARRIER);
476 case Opt_thread_pool:
478 match_int(&args[0], &intarg);
480 info->thread_pool_size = intarg;
483 num = match_strdup(&args[0]);
485 info->max_inline = memparse(num, NULL);
488 if (info->max_inline) {
489 info->max_inline = max_t(u64,
493 printk(KERN_INFO "btrfs: max_inline at %llu\n",
494 (unsigned long long)info->max_inline);
497 case Opt_alloc_start:
498 num = match_strdup(&args[0]);
500 info->alloc_start = memparse(num, NULL);
503 "btrfs: allocations start at %llu\n",
504 (unsigned long long)info->alloc_start);
508 root->fs_info->sb->s_flags &= ~MS_POSIXACL;
511 printk(KERN_INFO "btrfs: disabling tree log\n");
512 btrfs_set_opt(info->mount_opt, NOTREELOG);
514 case Opt_flushoncommit:
515 printk(KERN_INFO "btrfs: turning on flush-on-commit\n");
516 btrfs_set_opt(info->mount_opt, FLUSHONCOMMIT);
520 match_int(&args[0], &intarg);
522 info->metadata_ratio = intarg;
523 printk(KERN_INFO "btrfs: metadata ratio %d\n",
524 info->metadata_ratio);
528 btrfs_set_opt(info->mount_opt, DISCARD);
530 case Opt_space_cache:
531 btrfs_set_opt(info->mount_opt, SPACE_CACHE);
533 case Opt_no_space_cache:
534 printk(KERN_INFO "btrfs: disabling disk space caching\n");
535 btrfs_clear_opt(info->mount_opt, SPACE_CACHE);
537 case Opt_inode_cache:
538 printk(KERN_INFO "btrfs: enabling inode map caching\n");
539 btrfs_set_opt(info->mount_opt, INODE_MAP_CACHE);
541 case Opt_clear_cache:
542 printk(KERN_INFO "btrfs: force clearing of disk cache\n");
543 btrfs_set_opt(info->mount_opt, CLEAR_CACHE);
545 case Opt_user_subvol_rm_allowed:
546 btrfs_set_opt(info->mount_opt, USER_SUBVOL_RM_ALLOWED);
548 case Opt_enospc_debug:
549 btrfs_set_opt(info->mount_opt, ENOSPC_DEBUG);
552 printk(KERN_INFO "btrfs: enabling auto defrag");
553 btrfs_set_opt(info->mount_opt, AUTO_DEFRAG);
556 printk(KERN_INFO "btrfs: enabling auto recovery");
557 btrfs_set_opt(info->mount_opt, RECOVERY);
559 case Opt_skip_balance:
560 btrfs_set_opt(info->mount_opt, SKIP_BALANCE);
562 #ifdef CONFIG_BTRFS_FS_CHECK_INTEGRITY
563 case Opt_check_integrity_including_extent_data:
564 printk(KERN_INFO "btrfs: enabling check integrity"
565 " including extent data\n");
566 btrfs_set_opt(info->mount_opt,
567 CHECK_INTEGRITY_INCLUDING_EXTENT_DATA);
568 btrfs_set_opt(info->mount_opt, CHECK_INTEGRITY);
570 case Opt_check_integrity:
571 printk(KERN_INFO "btrfs: enabling check integrity\n");
572 btrfs_set_opt(info->mount_opt, CHECK_INTEGRITY);
574 case Opt_check_integrity_print_mask:
576 match_int(&args[0], &intarg);
578 info->check_integrity_print_mask = intarg;
579 printk(KERN_INFO "btrfs:"
580 " check_integrity_print_mask 0x%x\n",
581 info->check_integrity_print_mask);
585 case Opt_check_integrity_including_extent_data:
586 case Opt_check_integrity:
587 case Opt_check_integrity_print_mask:
588 printk(KERN_ERR "btrfs: support for check_integrity*"
589 " not compiled in!\n");
593 case Opt_fatal_errors:
594 if (strcmp(args[0].from, "panic") == 0)
595 btrfs_set_opt(info->mount_opt,
596 PANIC_ON_FATAL_ERROR);
597 else if (strcmp(args[0].from, "bug") == 0)
598 btrfs_clear_opt(info->mount_opt,
599 PANIC_ON_FATAL_ERROR);
606 printk(KERN_INFO "btrfs: unrecognized mount option "
615 if (!ret && btrfs_test_opt(root, SPACE_CACHE))
616 printk(KERN_INFO "btrfs: disk space caching is enabled\n");
622 * Parse mount options that are required early in the mount process.
624 * All other options will be parsed on much later in the mount process and
625 * only when we need to allocate a new super block.
627 static int btrfs_parse_early_options(const char *options, fmode_t flags,
628 void *holder, char **subvol_name, u64 *subvol_objectid,
629 u64 *subvol_rootid, struct btrfs_fs_devices **fs_devices)
631 substring_t args[MAX_OPT_ARGS];
632 char *device_name, *opts, *orig, *p;
640 * strsep changes the string, duplicate it because parse_options
643 opts = kstrdup(options, GFP_KERNEL);
648 while ((p = strsep(&opts, ",")) != NULL) {
653 token = match_token(p, tokens, args);
657 *subvol_name = match_strdup(&args[0]);
661 error = match_int(&args[0], &intarg);
663 /* we want the original fs_tree */
666 BTRFS_FS_TREE_OBJECTID;
668 *subvol_objectid = intarg;
671 case Opt_subvolrootid:
673 error = match_int(&args[0], &intarg);
675 /* we want the original fs_tree */
678 BTRFS_FS_TREE_OBJECTID;
680 *subvol_rootid = intarg;
684 device_name = match_strdup(&args[0]);
689 error = btrfs_scan_one_device(device_name,
690 flags, holder, fs_devices);
705 static struct dentry *get_default_root(struct super_block *sb,
708 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
709 struct btrfs_root *root = fs_info->tree_root;
710 struct btrfs_root *new_root;
711 struct btrfs_dir_item *di;
712 struct btrfs_path *path;
713 struct btrfs_key location;
719 * We have a specific subvol we want to mount, just setup location and
720 * go look up the root.
722 if (subvol_objectid) {
723 location.objectid = subvol_objectid;
724 location.type = BTRFS_ROOT_ITEM_KEY;
725 location.offset = (u64)-1;
729 path = btrfs_alloc_path();
731 return ERR_PTR(-ENOMEM);
732 path->leave_spinning = 1;
735 * Find the "default" dir item which points to the root item that we
736 * will mount by default if we haven't been given a specific subvolume
739 dir_id = btrfs_super_root_dir(fs_info->super_copy);
740 di = btrfs_lookup_dir_item(NULL, root, path, dir_id, "default", 7, 0);
742 btrfs_free_path(path);
747 * Ok the default dir item isn't there. This is weird since
748 * it's always been there, but don't freak out, just try and
749 * mount to root most subvolume.
751 btrfs_free_path(path);
752 dir_id = BTRFS_FIRST_FREE_OBJECTID;
753 new_root = fs_info->fs_root;
757 btrfs_dir_item_key_to_cpu(path->nodes[0], di, &location);
758 btrfs_free_path(path);
761 new_root = btrfs_read_fs_root_no_name(fs_info, &location);
762 if (IS_ERR(new_root))
763 return ERR_CAST(new_root);
765 if (btrfs_root_refs(&new_root->root_item) == 0)
766 return ERR_PTR(-ENOENT);
768 dir_id = btrfs_root_dirid(&new_root->root_item);
770 location.objectid = dir_id;
771 location.type = BTRFS_INODE_ITEM_KEY;
774 inode = btrfs_iget(sb, &location, new_root, &new);
776 return ERR_CAST(inode);
779 * If we're just mounting the root most subvol put the inode and return
780 * a reference to the dentry. We will have already gotten a reference
781 * to the inode in btrfs_fill_super so we're good to go.
783 if (!new && sb->s_root->d_inode == inode) {
785 return dget(sb->s_root);
788 return d_obtain_alias(inode);
791 static int btrfs_fill_super(struct super_block *sb,
792 struct btrfs_fs_devices *fs_devices,
793 void *data, int silent)
796 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
797 struct btrfs_key key;
800 sb->s_maxbytes = MAX_LFS_FILESIZE;
801 sb->s_magic = BTRFS_SUPER_MAGIC;
802 sb->s_op = &btrfs_super_ops;
803 sb->s_d_op = &btrfs_dentry_operations;
804 sb->s_export_op = &btrfs_export_ops;
805 sb->s_xattr = btrfs_xattr_handlers;
807 #ifdef CONFIG_BTRFS_FS_POSIX_ACL
808 sb->s_flags |= MS_POSIXACL;
810 sb->s_flags |= MS_I_VERSION;
811 err = open_ctree(sb, fs_devices, (char *)data);
813 printk("btrfs: open_ctree failed\n");
817 key.objectid = BTRFS_FIRST_FREE_OBJECTID;
818 key.type = BTRFS_INODE_ITEM_KEY;
820 inode = btrfs_iget(sb, &key, fs_info->fs_root, NULL);
822 err = PTR_ERR(inode);
826 sb->s_root = d_make_root(inode);
832 save_mount_options(sb, data);
833 cleancache_init_fs(sb);
834 sb->s_flags |= MS_ACTIVE;
838 close_ctree(fs_info->tree_root);
842 int btrfs_sync_fs(struct super_block *sb, int wait)
844 struct btrfs_trans_handle *trans;
845 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
846 struct btrfs_root *root = fs_info->tree_root;
848 trace_btrfs_sync_fs(wait);
851 filemap_flush(fs_info->btree_inode->i_mapping);
855 btrfs_wait_ordered_extents(root, 0, 0);
857 spin_lock(&fs_info->trans_lock);
858 if (!fs_info->running_transaction) {
859 spin_unlock(&fs_info->trans_lock);
862 spin_unlock(&fs_info->trans_lock);
864 trans = btrfs_join_transaction(root);
866 return PTR_ERR(trans);
867 return btrfs_commit_transaction(trans, root);
870 static int btrfs_show_options(struct seq_file *seq, struct dentry *dentry)
872 struct btrfs_fs_info *info = btrfs_sb(dentry->d_sb);
873 struct btrfs_root *root = info->tree_root;
876 if (btrfs_test_opt(root, DEGRADED))
877 seq_puts(seq, ",degraded");
878 if (btrfs_test_opt(root, NODATASUM))
879 seq_puts(seq, ",nodatasum");
880 if (btrfs_test_opt(root, NODATACOW))
881 seq_puts(seq, ",nodatacow");
882 if (btrfs_test_opt(root, NOBARRIER))
883 seq_puts(seq, ",nobarrier");
884 if (info->max_inline != 8192 * 1024)
885 seq_printf(seq, ",max_inline=%llu",
886 (unsigned long long)info->max_inline);
887 if (info->alloc_start != 0)
888 seq_printf(seq, ",alloc_start=%llu",
889 (unsigned long long)info->alloc_start);
890 if (info->thread_pool_size != min_t(unsigned long,
891 num_online_cpus() + 2, 8))
892 seq_printf(seq, ",thread_pool=%d", info->thread_pool_size);
893 if (btrfs_test_opt(root, COMPRESS)) {
894 if (info->compress_type == BTRFS_COMPRESS_ZLIB)
895 compress_type = "zlib";
897 compress_type = "lzo";
898 if (btrfs_test_opt(root, FORCE_COMPRESS))
899 seq_printf(seq, ",compress-force=%s", compress_type);
901 seq_printf(seq, ",compress=%s", compress_type);
903 if (btrfs_test_opt(root, NOSSD))
904 seq_puts(seq, ",nossd");
905 if (btrfs_test_opt(root, SSD_SPREAD))
906 seq_puts(seq, ",ssd_spread");
907 else if (btrfs_test_opt(root, SSD))
908 seq_puts(seq, ",ssd");
909 if (btrfs_test_opt(root, NOTREELOG))
910 seq_puts(seq, ",notreelog");
911 if (btrfs_test_opt(root, FLUSHONCOMMIT))
912 seq_puts(seq, ",flushoncommit");
913 if (btrfs_test_opt(root, DISCARD))
914 seq_puts(seq, ",discard");
915 if (!(root->fs_info->sb->s_flags & MS_POSIXACL))
916 seq_puts(seq, ",noacl");
917 if (btrfs_test_opt(root, SPACE_CACHE))
918 seq_puts(seq, ",space_cache");
920 seq_puts(seq, ",nospace_cache");
921 if (btrfs_test_opt(root, CLEAR_CACHE))
922 seq_puts(seq, ",clear_cache");
923 if (btrfs_test_opt(root, USER_SUBVOL_RM_ALLOWED))
924 seq_puts(seq, ",user_subvol_rm_allowed");
925 if (btrfs_test_opt(root, ENOSPC_DEBUG))
926 seq_puts(seq, ",enospc_debug");
927 if (btrfs_test_opt(root, AUTO_DEFRAG))
928 seq_puts(seq, ",autodefrag");
929 if (btrfs_test_opt(root, INODE_MAP_CACHE))
930 seq_puts(seq, ",inode_cache");
931 if (btrfs_test_opt(root, SKIP_BALANCE))
932 seq_puts(seq, ",skip_balance");
933 if (btrfs_test_opt(root, PANIC_ON_FATAL_ERROR))
934 seq_puts(seq, ",fatal_errors=panic");
938 static int btrfs_test_super(struct super_block *s, void *data)
940 struct btrfs_fs_info *p = data;
941 struct btrfs_fs_info *fs_info = btrfs_sb(s);
943 return fs_info->fs_devices == p->fs_devices;
946 static int btrfs_set_super(struct super_block *s, void *data)
948 int err = set_anon_super(s, data);
955 * subvolumes are identified by ino 256
957 static inline int is_subvolume_inode(struct inode *inode)
959 if (inode && inode->i_ino == BTRFS_FIRST_FREE_OBJECTID)
965 * This will strip out the subvol=%s argument for an argument string and add
966 * subvolid=0 to make sure we get the actual tree root for path walking to the
969 static char *setup_root_args(char *args)
971 unsigned len = strlen(args) + 2 + 1;
972 char *src, *dst, *buf;
975 * We need the same args as before, but with this substitution:
976 * s!subvol=[^,]+!subvolid=0!
978 * Since the replacement string is up to 2 bytes longer than the
979 * original, allocate strlen(args) + 2 + 1 bytes.
982 src = strstr(args, "subvol=");
983 /* This shouldn't happen, but just in case.. */
987 buf = dst = kmalloc(len, GFP_NOFS);
992 * If the subvol= arg is not at the start of the string,
993 * copy whatever precedes it into buf.
1001 strcpy(dst, "subvolid=0");
1002 dst += strlen("subvolid=0");
1005 * If there is a "," after the original subvol=... string,
1006 * copy that suffix into our buffer. Otherwise, we're done.
1008 src = strchr(src, ',');
1015 static struct dentry *mount_subvol(const char *subvol_name, int flags,
1016 const char *device_name, char *data)
1018 struct dentry *root;
1019 struct vfsmount *mnt;
1022 newargs = setup_root_args(data);
1024 return ERR_PTR(-ENOMEM);
1025 mnt = vfs_kern_mount(&btrfs_fs_type, flags, device_name,
1029 return ERR_CAST(mnt);
1031 root = mount_subtree(mnt, subvol_name);
1033 if (!IS_ERR(root) && !is_subvolume_inode(root->d_inode)) {
1034 struct super_block *s = root->d_sb;
1036 root = ERR_PTR(-EINVAL);
1037 deactivate_locked_super(s);
1038 printk(KERN_ERR "btrfs: '%s' is not a valid subvolume\n",
1046 * Find a superblock for the given device / mount point.
1048 * Note: This is based on get_sb_bdev from fs/super.c with a few additions
1049 * for multiple device setup. Make sure to keep it in sync.
1051 static struct dentry *btrfs_mount(struct file_system_type *fs_type, int flags,
1052 const char *device_name, void *data)
1054 struct block_device *bdev = NULL;
1055 struct super_block *s;
1056 struct dentry *root;
1057 struct btrfs_fs_devices *fs_devices = NULL;
1058 struct btrfs_fs_info *fs_info = NULL;
1059 fmode_t mode = FMODE_READ;
1060 char *subvol_name = NULL;
1061 u64 subvol_objectid = 0;
1062 u64 subvol_rootid = 0;
1065 if (!(flags & MS_RDONLY))
1066 mode |= FMODE_WRITE;
1068 error = btrfs_parse_early_options(data, mode, fs_type,
1069 &subvol_name, &subvol_objectid,
1070 &subvol_rootid, &fs_devices);
1073 return ERR_PTR(error);
1077 root = mount_subvol(subvol_name, flags, device_name, data);
1082 error = btrfs_scan_one_device(device_name, mode, fs_type, &fs_devices);
1084 return ERR_PTR(error);
1087 * Setup a dummy root and fs_info for test/set super. This is because
1088 * we don't actually fill this stuff out until open_ctree, but we need
1089 * it for searching for existing supers, so this lets us do that and
1090 * then open_ctree will properly initialize everything later.
1092 fs_info = kzalloc(sizeof(struct btrfs_fs_info), GFP_NOFS);
1094 return ERR_PTR(-ENOMEM);
1096 fs_info->fs_devices = fs_devices;
1098 fs_info->super_copy = kzalloc(BTRFS_SUPER_INFO_SIZE, GFP_NOFS);
1099 fs_info->super_for_commit = kzalloc(BTRFS_SUPER_INFO_SIZE, GFP_NOFS);
1100 if (!fs_info->super_copy || !fs_info->super_for_commit) {
1105 error = btrfs_open_devices(fs_devices, mode, fs_type);
1109 if (!(flags & MS_RDONLY) && fs_devices->rw_devices == 0) {
1111 goto error_close_devices;
1114 bdev = fs_devices->latest_bdev;
1115 s = sget(fs_type, btrfs_test_super, btrfs_set_super, flags | MS_NOSEC,
1119 goto error_close_devices;
1123 btrfs_close_devices(fs_devices);
1124 free_fs_info(fs_info);
1125 if ((flags ^ s->s_flags) & MS_RDONLY)
1128 char b[BDEVNAME_SIZE];
1130 strlcpy(s->s_id, bdevname(bdev, b), sizeof(s->s_id));
1131 btrfs_sb(s)->bdev_holder = fs_type;
1132 error = btrfs_fill_super(s, fs_devices, data,
1133 flags & MS_SILENT ? 1 : 0);
1136 root = !error ? get_default_root(s, subvol_objectid) : ERR_PTR(error);
1138 deactivate_locked_super(s);
1142 error_close_devices:
1143 btrfs_close_devices(fs_devices);
1145 free_fs_info(fs_info);
1146 return ERR_PTR(error);
1149 static void btrfs_set_max_workers(struct btrfs_workers *workers, int new_limit)
1151 spin_lock_irq(&workers->lock);
1152 workers->max_workers = new_limit;
1153 spin_unlock_irq(&workers->lock);
1156 static void btrfs_resize_thread_pool(struct btrfs_fs_info *fs_info,
1157 int new_pool_size, int old_pool_size)
1159 if (new_pool_size == old_pool_size)
1162 fs_info->thread_pool_size = new_pool_size;
1164 printk(KERN_INFO "btrfs: resize thread pool %d -> %d\n",
1165 old_pool_size, new_pool_size);
1167 btrfs_set_max_workers(&fs_info->generic_worker, new_pool_size);
1168 btrfs_set_max_workers(&fs_info->workers, new_pool_size);
1169 btrfs_set_max_workers(&fs_info->delalloc_workers, new_pool_size);
1170 btrfs_set_max_workers(&fs_info->submit_workers, new_pool_size);
1171 btrfs_set_max_workers(&fs_info->caching_workers, new_pool_size);
1172 btrfs_set_max_workers(&fs_info->fixup_workers, new_pool_size);
1173 btrfs_set_max_workers(&fs_info->endio_workers, new_pool_size);
1174 btrfs_set_max_workers(&fs_info->endio_meta_workers, new_pool_size);
1175 btrfs_set_max_workers(&fs_info->endio_meta_write_workers, new_pool_size);
1176 btrfs_set_max_workers(&fs_info->endio_write_workers, new_pool_size);
1177 btrfs_set_max_workers(&fs_info->endio_freespace_worker, new_pool_size);
1178 btrfs_set_max_workers(&fs_info->delayed_workers, new_pool_size);
1179 btrfs_set_max_workers(&fs_info->readahead_workers, new_pool_size);
1180 btrfs_set_max_workers(&fs_info->scrub_workers, new_pool_size);
1183 static int btrfs_remount(struct super_block *sb, int *flags, char *data)
1185 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
1186 struct btrfs_root *root = fs_info->tree_root;
1187 unsigned old_flags = sb->s_flags;
1188 unsigned long old_opts = fs_info->mount_opt;
1189 unsigned long old_compress_type = fs_info->compress_type;
1190 u64 old_max_inline = fs_info->max_inline;
1191 u64 old_alloc_start = fs_info->alloc_start;
1192 int old_thread_pool_size = fs_info->thread_pool_size;
1193 unsigned int old_metadata_ratio = fs_info->metadata_ratio;
1196 ret = btrfs_parse_options(root, data);
1202 btrfs_resize_thread_pool(fs_info,
1203 fs_info->thread_pool_size, old_thread_pool_size);
1205 if ((*flags & MS_RDONLY) == (sb->s_flags & MS_RDONLY))
1208 if (*flags & MS_RDONLY) {
1209 sb->s_flags |= MS_RDONLY;
1211 ret = btrfs_commit_super(root);
1215 if (fs_info->fs_devices->rw_devices == 0) {
1220 if (btrfs_super_log_root(fs_info->super_copy) != 0) {
1225 ret = btrfs_cleanup_fs_roots(fs_info);
1229 /* recover relocation */
1230 ret = btrfs_recover_relocation(root);
1234 ret = btrfs_resume_balance_async(fs_info);
1238 sb->s_flags &= ~MS_RDONLY;
1244 /* We've hit an error - don't reset MS_RDONLY */
1245 if (sb->s_flags & MS_RDONLY)
1246 old_flags |= MS_RDONLY;
1247 sb->s_flags = old_flags;
1248 fs_info->mount_opt = old_opts;
1249 fs_info->compress_type = old_compress_type;
1250 fs_info->max_inline = old_max_inline;
1251 fs_info->alloc_start = old_alloc_start;
1252 btrfs_resize_thread_pool(fs_info,
1253 old_thread_pool_size, fs_info->thread_pool_size);
1254 fs_info->metadata_ratio = old_metadata_ratio;
1258 /* Used to sort the devices by max_avail(descending sort) */
1259 static int btrfs_cmp_device_free_bytes(const void *dev_info1,
1260 const void *dev_info2)
1262 if (((struct btrfs_device_info *)dev_info1)->max_avail >
1263 ((struct btrfs_device_info *)dev_info2)->max_avail)
1265 else if (((struct btrfs_device_info *)dev_info1)->max_avail <
1266 ((struct btrfs_device_info *)dev_info2)->max_avail)
1273 * sort the devices by max_avail, in which max free extent size of each device
1274 * is stored.(Descending Sort)
1276 static inline void btrfs_descending_sort_devices(
1277 struct btrfs_device_info *devices,
1280 sort(devices, nr_devices, sizeof(struct btrfs_device_info),
1281 btrfs_cmp_device_free_bytes, NULL);
1285 * The helper to calc the free space on the devices that can be used to store
1288 static int btrfs_calc_avail_data_space(struct btrfs_root *root, u64 *free_bytes)
1290 struct btrfs_fs_info *fs_info = root->fs_info;
1291 struct btrfs_device_info *devices_info;
1292 struct btrfs_fs_devices *fs_devices = fs_info->fs_devices;
1293 struct btrfs_device *device;
1298 u64 min_stripe_size;
1299 int min_stripes = 1, num_stripes = 1;
1300 int i = 0, nr_devices;
1303 nr_devices = fs_info->fs_devices->open_devices;
1304 BUG_ON(!nr_devices);
1306 devices_info = kmalloc(sizeof(*devices_info) * nr_devices,
1311 /* calc min stripe number for data space alloction */
1312 type = btrfs_get_alloc_profile(root, 1);
1313 if (type & BTRFS_BLOCK_GROUP_RAID0) {
1315 num_stripes = nr_devices;
1316 } else if (type & BTRFS_BLOCK_GROUP_RAID1) {
1319 } else if (type & BTRFS_BLOCK_GROUP_RAID10) {
1324 if (type & BTRFS_BLOCK_GROUP_DUP)
1325 min_stripe_size = 2 * BTRFS_STRIPE_LEN;
1327 min_stripe_size = BTRFS_STRIPE_LEN;
1329 list_for_each_entry(device, &fs_devices->devices, dev_list) {
1330 if (!device->in_fs_metadata || !device->bdev)
1333 avail_space = device->total_bytes - device->bytes_used;
1335 /* align with stripe_len */
1336 do_div(avail_space, BTRFS_STRIPE_LEN);
1337 avail_space *= BTRFS_STRIPE_LEN;
1340 * In order to avoid overwritting the superblock on the drive,
1341 * btrfs starts at an offset of at least 1MB when doing chunk
1344 skip_space = 1024 * 1024;
1346 /* user can set the offset in fs_info->alloc_start. */
1347 if (fs_info->alloc_start + BTRFS_STRIPE_LEN <=
1348 device->total_bytes)
1349 skip_space = max(fs_info->alloc_start, skip_space);
1352 * btrfs can not use the free space in [0, skip_space - 1],
1353 * we must subtract it from the total. In order to implement
1354 * it, we account the used space in this range first.
1356 ret = btrfs_account_dev_extents_size(device, 0, skip_space - 1,
1359 kfree(devices_info);
1363 /* calc the free space in [0, skip_space - 1] */
1364 skip_space -= used_space;
1367 * we can use the free space in [0, skip_space - 1], subtract
1368 * it from the total.
1370 if (avail_space && avail_space >= skip_space)
1371 avail_space -= skip_space;
1375 if (avail_space < min_stripe_size)
1378 devices_info[i].dev = device;
1379 devices_info[i].max_avail = avail_space;
1386 btrfs_descending_sort_devices(devices_info, nr_devices);
1390 while (nr_devices >= min_stripes) {
1391 if (num_stripes > nr_devices)
1392 num_stripes = nr_devices;
1394 if (devices_info[i].max_avail >= min_stripe_size) {
1398 avail_space += devices_info[i].max_avail * num_stripes;
1399 alloc_size = devices_info[i].max_avail;
1400 for (j = i + 1 - num_stripes; j <= i; j++)
1401 devices_info[j].max_avail -= alloc_size;
1407 kfree(devices_info);
1408 *free_bytes = avail_space;
1412 static int btrfs_statfs(struct dentry *dentry, struct kstatfs *buf)
1414 struct btrfs_fs_info *fs_info = btrfs_sb(dentry->d_sb);
1415 struct btrfs_super_block *disk_super = fs_info->super_copy;
1416 struct list_head *head = &fs_info->space_info;
1417 struct btrfs_space_info *found;
1419 u64 total_free_data = 0;
1420 int bits = dentry->d_sb->s_blocksize_bits;
1421 __be32 *fsid = (__be32 *)fs_info->fsid;
1424 /* holding chunk_muext to avoid allocating new chunks */
1425 mutex_lock(&fs_info->chunk_mutex);
1427 list_for_each_entry_rcu(found, head, list) {
1428 if (found->flags & BTRFS_BLOCK_GROUP_DATA) {
1429 total_free_data += found->disk_total - found->disk_used;
1431 btrfs_account_ro_block_groups_free_space(found);
1434 total_used += found->disk_used;
1438 buf->f_namelen = BTRFS_NAME_LEN;
1439 buf->f_blocks = btrfs_super_total_bytes(disk_super) >> bits;
1440 buf->f_bfree = buf->f_blocks - (total_used >> bits);
1441 buf->f_bsize = dentry->d_sb->s_blocksize;
1442 buf->f_type = BTRFS_SUPER_MAGIC;
1443 buf->f_bavail = total_free_data;
1444 ret = btrfs_calc_avail_data_space(fs_info->tree_root, &total_free_data);
1446 mutex_unlock(&fs_info->chunk_mutex);
1449 buf->f_bavail += total_free_data;
1450 buf->f_bavail = buf->f_bavail >> bits;
1451 mutex_unlock(&fs_info->chunk_mutex);
1453 /* We treat it as constant endianness (it doesn't matter _which_)
1454 because we want the fsid to come out the same whether mounted
1455 on a big-endian or little-endian host */
1456 buf->f_fsid.val[0] = be32_to_cpu(fsid[0]) ^ be32_to_cpu(fsid[2]);
1457 buf->f_fsid.val[1] = be32_to_cpu(fsid[1]) ^ be32_to_cpu(fsid[3]);
1458 /* Mask in the root object ID too, to disambiguate subvols */
1459 buf->f_fsid.val[0] ^= BTRFS_I(dentry->d_inode)->root->objectid >> 32;
1460 buf->f_fsid.val[1] ^= BTRFS_I(dentry->d_inode)->root->objectid;
1465 static void btrfs_kill_super(struct super_block *sb)
1467 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
1468 kill_anon_super(sb);
1469 free_fs_info(fs_info);
1472 static struct file_system_type btrfs_fs_type = {
1473 .owner = THIS_MODULE,
1475 .mount = btrfs_mount,
1476 .kill_sb = btrfs_kill_super,
1477 .fs_flags = FS_REQUIRES_DEV,
1481 * used by btrfsctl to scan devices when no FS is mounted
1483 static long btrfs_control_ioctl(struct file *file, unsigned int cmd,
1486 struct btrfs_ioctl_vol_args *vol;
1487 struct btrfs_fs_devices *fs_devices;
1490 if (!capable(CAP_SYS_ADMIN))
1493 vol = memdup_user((void __user *)arg, sizeof(*vol));
1495 return PTR_ERR(vol);
1498 case BTRFS_IOC_SCAN_DEV:
1499 ret = btrfs_scan_one_device(vol->name, FMODE_READ,
1500 &btrfs_fs_type, &fs_devices);
1502 case BTRFS_IOC_DEVICES_READY:
1503 ret = btrfs_scan_one_device(vol->name, FMODE_READ,
1504 &btrfs_fs_type, &fs_devices);
1507 ret = !(fs_devices->num_devices == fs_devices->total_devices);
1515 static int btrfs_freeze(struct super_block *sb)
1517 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
1518 mutex_lock(&fs_info->transaction_kthread_mutex);
1519 mutex_lock(&fs_info->cleaner_mutex);
1523 static int btrfs_unfreeze(struct super_block *sb)
1525 struct btrfs_fs_info *fs_info = btrfs_sb(sb);
1526 mutex_unlock(&fs_info->cleaner_mutex);
1527 mutex_unlock(&fs_info->transaction_kthread_mutex);
1531 static int btrfs_show_devname(struct seq_file *m, struct dentry *root)
1533 struct btrfs_fs_info *fs_info = btrfs_sb(root->d_sb);
1534 struct btrfs_fs_devices *cur_devices;
1535 struct btrfs_device *dev, *first_dev = NULL;
1536 struct list_head *head;
1537 struct rcu_string *name;
1539 mutex_lock(&fs_info->fs_devices->device_list_mutex);
1540 cur_devices = fs_info->fs_devices;
1541 while (cur_devices) {
1542 head = &cur_devices->devices;
1543 list_for_each_entry(dev, head, dev_list) {
1546 if (!first_dev || dev->devid < first_dev->devid)
1549 cur_devices = cur_devices->seed;
1554 name = rcu_dereference(first_dev->name);
1555 seq_escape(m, name->str, " \t\n\\");
1560 mutex_unlock(&fs_info->fs_devices->device_list_mutex);
1564 static const struct super_operations btrfs_super_ops = {
1565 .drop_inode = btrfs_drop_inode,
1566 .evict_inode = btrfs_evict_inode,
1567 .put_super = btrfs_put_super,
1568 .sync_fs = btrfs_sync_fs,
1569 .show_options = btrfs_show_options,
1570 .show_devname = btrfs_show_devname,
1571 .write_inode = btrfs_write_inode,
1572 .alloc_inode = btrfs_alloc_inode,
1573 .destroy_inode = btrfs_destroy_inode,
1574 .statfs = btrfs_statfs,
1575 .remount_fs = btrfs_remount,
1576 .freeze_fs = btrfs_freeze,
1577 .unfreeze_fs = btrfs_unfreeze,
1580 static const struct file_operations btrfs_ctl_fops = {
1581 .unlocked_ioctl = btrfs_control_ioctl,
1582 .compat_ioctl = btrfs_control_ioctl,
1583 .owner = THIS_MODULE,
1584 .llseek = noop_llseek,
1587 static struct miscdevice btrfs_misc = {
1588 .minor = BTRFS_MINOR,
1589 .name = "btrfs-control",
1590 .fops = &btrfs_ctl_fops
1593 MODULE_ALIAS_MISCDEV(BTRFS_MINOR);
1594 MODULE_ALIAS("devname:btrfs-control");
1596 static int btrfs_interface_init(void)
1598 return misc_register(&btrfs_misc);
1601 static void btrfs_interface_exit(void)
1603 if (misc_deregister(&btrfs_misc) < 0)
1604 printk(KERN_INFO "misc_deregister failed for control device");
1607 static int __init init_btrfs_fs(void)
1611 err = btrfs_init_sysfs();
1615 btrfs_init_compress();
1617 err = btrfs_init_cachep();
1621 err = extent_io_init();
1625 err = extent_map_init();
1627 goto free_extent_io;
1629 err = ordered_data_init();
1631 goto free_extent_map;
1633 err = btrfs_delayed_inode_init();
1635 goto free_ordered_data;
1637 err = btrfs_interface_init();
1639 goto free_delayed_inode;
1641 err = register_filesystem(&btrfs_fs_type);
1643 goto unregister_ioctl;
1645 btrfs_init_lockdep();
1647 printk(KERN_INFO "%s loaded\n", BTRFS_BUILD_VERSION);
1651 btrfs_interface_exit();
1653 btrfs_delayed_inode_exit();
1655 ordered_data_exit();
1661 btrfs_destroy_cachep();
1663 btrfs_exit_compress();
1668 static void __exit exit_btrfs_fs(void)
1670 btrfs_destroy_cachep();
1671 btrfs_delayed_inode_exit();
1672 ordered_data_exit();
1675 btrfs_interface_exit();
1676 unregister_filesystem(&btrfs_fs_type);
1678 btrfs_cleanup_fs_uuids();
1679 btrfs_exit_compress();
1682 module_init(init_btrfs_fs)
1683 module_exit(exit_btrfs_fs)
1685 MODULE_LICENSE("GPL");