Skip to contentSkip to conversation

btrfs: small changes to "usebackuproot" mount option

PATCH In review Qu Wenruo 3 participants 7 messages Jul 3 Btrfs file system

lore
Share & tools
lore

Qu Wenruo

author
#0 lore raw

v3 cover btrfs: small changes to "usebackuproot" mount option

[CHANGELOG]
v3:
- Add "rescue=usebackuproot" into full RO mount options
- Minor grammar updates

v2:
- Also include "rescue=usebackuproot" into "rescue=all" shortcut

"rescue=usebackuproot" mount option is not requiring a read-only mount, which is different from all the other options in the "rescue=" group. Address that in the first patch.

Then also include "rescue=usebackuproot" into "rescue=all" group, done in the second patch.

Standalone "usebackuproot" mount option is already marked deprecated since v5.9, I see no practical reason to keep supporting it in 2026. Just remove it in the last patch.

Qu Wenruo (3):
btrfs: add "rescue=usebackuproot" into forced read-only options
btrfs: add "rescue=usebackuproot" into "rescue=all" shortcut
btrfs: remove "usebackuproot" mount option

 fs/btrfs/fs.h    |  3 ++-
 fs/btrfs/super.c | 16 +++-------------
 2 files changed, 5 insertions(+), 14 deletions(-)
Signature · 1 line
2.54.0
author
#1 lore raw

PATCH v3 1/3 btrfs: add "rescue=usebackuproot" into forced read-only options

According to btrfs(5) man page, all rescue options should require a read-only mount.

But that read-only check is only introduced for newer rescue options, not for the pre-existing "usebackuproot" one.

Furthermore, a filesystem that requires "rescue=" mount option already means it's corrupted, even if "rescue=usebackuproot" allowed the fs to be mounted RW, one should not trust such fs anymore until a comprehensive btrfs-check run and proper evaluation.

Change the behavior to match the document, and since "rescue=usebackuproot" is now a full RO mount option, it is no longer a one-shot option, therefore remove it from btrfs_clear_oneshot_options().

---
 fs/btrfs/fs.h    | 3 ++-
 fs/btrfs/super.c | 4 ++--
 2 files changed, 4 insertions(+), 3 deletions(-)
fs/btrfs/fs.h +2 -1
index ab5ed7b4f639..cffb9197a1ab 100644
@@ -289,7 +289,8 @@ enum {
 	 BTRFS_MOUNT_IGNOREBADROOTS |		\
 	 BTRFS_MOUNT_IGNOREDATACSUMS |		\
 	 BTRFS_MOUNT_IGNOREMETACSUMS |		\
-	 BTRFS_MOUNT_IGNORESUPERFLAGS)
+	 BTRFS_MOUNT_IGNORESUPERFLAGS |		\
+	 BTRFS_MOUNT_USEBACKUPROOT)
 
 /*
  * Compat flags that we support.  If any incompat flags are set other than the
fs/btrfs/super.c +2 -2
index 0a6ce6c19d8c..e561c8811d6d 100644
@@ -668,7 +668,6 @@ static int btrfs_parse_param(struct fs_context *fc, struct fs_parameter *param)
  */
 static void btrfs_clear_oneshot_options(struct btrfs_fs_info *fs_info)
 {
-	btrfs_clear_opt(fs_info->mount_opt, USEBACKUPROOT);
 	btrfs_clear_opt(fs_info->mount_opt, CLEAR_CACHE);
 	btrfs_clear_opt(fs_info->mount_opt, NOSPACECACHE);
 }
@@ -692,7 +691,8 @@ bool btrfs_check_options(const struct btrfs_fs_info *info,
 	bool ret = true;
 
 	if (!(flags & SB_RDONLY) &&
-	    (check_ro_option(info, *mount_opt, BTRFS_MOUNT_NOLOGREPLAY, "nologreplay") ||
+	    (check_ro_option(info, *mount_opt, BTRFS_MOUNT_USEBACKUPROOT, "usebackuproot") ||
+	     check_ro_option(info, *mount_opt, BTRFS_MOUNT_NOLOGREPLAY, "nologreplay") ||
 	     check_ro_option(info, *mount_opt, BTRFS_MOUNT_IGNOREBADROOTS, "ignorebadroots") ||
 	     check_ro_option(info, *mount_opt, BTRFS_MOUNT_IGNOREDATACSUMS, "ignoredatacsums") ||
 	     check_ro_option(info, *mount_opt, BTRFS_MOUNT_IGNOREMETACSUMS, "ignoremetacsums") ||
Signature · 1 line
2.54.0
author
#3 lore raw

PATCH v3 3/3 btrfs: remove "usebackuproot" mount option

In reply to Qu Wenruo

This mount option is marked deprecated since the introduction of "rescue=" mount option group, in v5.9.

That's already a long time ago, and it should be safe to completely remove the old "usebackuproot" mount option now.

---
 fs/btrfs/super.c | 11 -----------
 1 file changed, 11 deletions(-)
fs/btrfs/super.c +0 -11
index e52e80fd9e1f..a8c55f7571d0 100644
@@ -128,7 +128,6 @@ enum {
 
 	/* Rescue options */
 	Opt_rescue,
-	Opt_usebackuproot,
 
 	/* Debugging options */
 	Opt_enospc_debug,
@@ -248,8 +247,6 @@ static const struct fs_parameter_spec btrfs_fs_parameters[] = {
 
 	/* Rescue options. */
 	fsparam_enum("rescue", Opt_rescue, btrfs_parameter_rescue),
-	/* Deprecated, with alias rescue=usebackuproot */
-	__fsparam(NULL, "usebackuproot", Opt_usebackuproot, fs_param_deprecated, NULL),
 	/* For compatibility only, alias for "rescue=nologreplay". */
 	fsparam_flag("norecovery", Opt_norecovery),
 
@@ -560,14 +557,6 @@ static int btrfs_parse_param(struct fs_context *fc, struct fs_parameter *param)
 		else
 			btrfs_set_opt(ctx->mount_opt, AUTO_DEFRAG);
 		break;
-	case Opt_usebackuproot:
-		btrfs_warn(NULL,
-			   "'usebackuproot' is deprecated, use 'rescue=usebackuproot' instead");
-		btrfs_set_opt(ctx->mount_opt, USEBACKUPROOT);
-
-		/* If we're loading the backup roots we can't trust the space cache. */
-		btrfs_set_opt(ctx->mount_opt, CLEAR_CACHE);
-		break;
 	case Opt_skip_balance:
 		btrfs_set_opt(ctx->mount_opt, SKIP_BALANCE);
 		break;
Signature · 1 line
2.54.0
author
#2 lore raw

PATCH v3 2/3 btrfs: add "rescue=usebackuproot" into "rescue=all" shortcut

In reply to Qu Wenruo

The mount option "rescue=all" should be a shortcut to include all "rescue=" mount options. But unfortunately "rescue=usebackuproot" is not included.

Include that option so "rescue=all" has a better chance to mount a corrupted fs.

---
 fs/btrfs/super.c | 1 +
 1 file changed, 1 insertion(+)
fs/btrfs/super.c +1 -0
index e561c8811d6d..e52e80fd9e1f 100644
@@ -620,6 +620,7 @@ static int btrfs_parse_param(struct fs_context *fc, struct fs_parameter *param)
 			btrfs_set_opt(ctx->mount_opt, IGNORESUPERFLAGS);
 			btrfs_set_opt(ctx->mount_opt, IGNOREBADROOTS);
 			btrfs_set_opt(ctx->mount_opt, NOLOGREPLAY);
+			btrfs_set_opt(ctx->mount_opt, USEBACKUPROOT);
 			break;
 		default:
 			btrfs_info(NULL, "unrecognized rescue option '%s'",
Signature · 1 line
2.54.0
#4 lore raw

Re: [PATCH v3 3/3] btrfs: remove "usebackuproot" mount option

In reply to Qu Wenruo
Quoted 7 lines · Qu Wenruo

This mount option is marked deprecated since the introduction of "rescue=" mount option group, in v5.9.

That's already a long time ago, and it should be safe to completely remove the old "usebackuproot" mount option now.

Note, this has to be removed from the man page as well.

Reviewed-by on the v3 series
#6 lore raw
In reply to Qu Wenruo
Quoted 25 lines · Qu Wenruo

[CHANGELOG]
v3:
- Add "rescue=usebackuproot" into full RO mount options
- Minor grammar updates

v2:
- Also include "rescue=usebackuproot" into "rescue=all" shortcut

"rescue=usebackuproot" mount option is not requiring a read-only mount, which is different from all the other options in the "rescue=" group. Address that in the first patch.

Then also include "rescue=usebackuproot" into "rescue=all" group, done in the second patch.

Standalone "usebackuproot" mount option is already marked deprecated since v5.9, I see no practical reason to keep supporting it in 2026. Just remove it in the last patch.

Qu Wenruo (3):
btrfs: add "rescue=usebackuproot" into forced read-only options
btrfs: add "rescue=usebackuproot" into "rescue=all" shortcut
btrfs: remove "usebackuproot" mount option

Quoted 8 lines
 fs/btrfs/fs.h    |  3 ++-
 fs/btrfs/super.c | 16 +++-------------
 2 files changed, 5 insertions(+), 14 deletions(-)

--
2.54.0

LGTM.

Signature · 1 line
真実はいつも一つ!/ Always, there's only one truth!