Skip to contentSkip to conversation

fstests: btrfs/244: add test case to make sure kernel won't crash when deleting non-existing device

PATCH In review Qu Wenruo 3 participants 3 messages Aug 6, 2021 Btrfs file system

lore
Share & tools
lore

Qu Wenruo

author
#0 lore raw

PATCH 1/1 fstests: btrfs/244: add test case to make sure kernel won't crash when deleting non-existing device

There is a kernel regression for btrfs, that when passing non-existing devid to "btrfs device remove" command, kernel will crash due to NULL pointer dereference.

The test case is for such regression, it will:

- Create and mount an empty single-device btrfs
- Try to remove devid 3, which doesn't exist for above fs

The fix is titled "btrfs: fix NULL pointer dereference when deleting device by invalid id".

---
 tests/btrfs/244     | 42 ++++++++++++++++++++++++++++++++++++++++++
 tests/btrfs/244.out |  2 ++
 2 files changed, 44 insertions(+)
 create mode 100755 tests/btrfs/244
 create mode 100644 tests/btrfs/244.out
tests/btrfs/244 new file +42 -0
new file mode 100755
index 00000000..56eb9e8c
@@ -0,0 +1,42 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2021 SUSE Linux Products GmbH.  All Rights Reserved.
+#
+# FS QA Test 244
+#
+# Make sure "btrfs device remove" won't crash when non-existing devid
+# is provided
+#
+. ./common/preamble
+_begin_fstest auto quick volume dangerous
+
+# Override the default cleanup function.
+# _cleanup()
+# {
+# 	cd /
+# 	rm -r -f $tmp.*
+# }
+
+# Import common functions.
+# . ./common/filter
+
+# real QA test starts here
+
+# Modify as appropriate.
+_supported_fs btrfs
+_require_scratch
+
+_scratch_mkfs >> $seqres.full 2>&1
+_scratch_mount
+
+# Above created fs only contains one device with devid 1, device remove 3
+# should just fail.
+# We don't care about the failure itself, but care whether this would cause
+# kernel crash.
+$BTRFS_UTIL_PROG device remove 3 $SCRATCH_MNT >> $seqres.full 2>&1
+
+echo "Silence is golden"
+
+# success, all done
+status=0
+exit
tests/btrfs/244.out new file +2 -0
new file mode 100644
index 00000000..440da1f2
@@ -0,0 +1,2 @@
+QA output created by 244
+Silence is golden
Signature · 1 line
2.31.1
#1 lore raw
Quoted 53 lines · Qu Wenruo

There is a kernel regression for btrfs, that when passing non-existing devid to "btrfs device remove" command, kernel will crash due to NULL pointer dereference.

The test case is for such regression, it will:

- Create and mount an empty single-device btrfs
- Try to remove devid 3, which doesn't exist for above fs

The fix is titled "btrfs: fix NULL pointer dereference when deleting device by invalid id".

---
 tests/btrfs/244     | 42 ++++++++++++++++++++++++++++++++++++++++++
 tests/btrfs/244.out |  2 ++
 2 files changed, 44 insertions(+)
 create mode 100755 tests/btrfs/244
 create mode 100644 tests/btrfs/244.out
tests/btrfs/244 new file +26 -0
new file mode 100755
index 00000000..56eb9e8c
@@ -0,0 +1,42 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2021 SUSE Linux Products GmbH.  All Rights Reserved.
+#
+# FS QA Test 244
+#
+# Make sure "btrfs device remove" won't crash when non-existing devid
+# is provided
+#
+. ./common/preamble
+_begin_fstest auto quick volume dangerous
+
+# Override the default cleanup function.
+# _cleanup()
+# {
+#      cd /
+#      rm -r -f $tmp.*
+# }
+
+# Import common functions.
+# . ./common/filter
+
+# real QA test starts here
+
+# Modify as appropriate.
+_supported_fs btrfs

tests/btrfs/244 line 36

Quoted 10 lines
tests/btrfs/244 new file +10 -0
+_require_scratch
+
+_scratch_mkfs >> $seqres.full 2>&1
+_scratch_mount
+
+# Above created fs only contains one device with devid 1, device remove 3
+# should just fail.
+# We don't care about the failure itself, but care whether this would cause
+# kernel crash.
+$BTRFS_UTIL_PROG device remove 3 $SCRATCH_MNT >> $seqres.full 2>&1

While here we could also check that the operation fails. That avoids adding yet another test case if one day we have a regression where the operation returns success instead of an error.

In fact the test subject and goal should be to verify that removing a non-existing device fails and does not cause any harm (kernel crash, metadata corruption, etc).

Thanks.

Quoted 17 lines
tests/btrfs/244 new file +6 -0
+
+echo "Silence is golden"
+
+# success, all done
+status=0
+exit
tests/btrfs/244.out new file +2 -1
new file mode 100644
index 00000000..440da1f2
@@ -0,0 +1,2 @@
+QA output created by 244
+Silence is golden
--

2.31.1

Signature · 3 lines
Filipe David Manana,

“Whether you think you can, or you think you can't — you're right.”
#2 lore raw
Quoted 60 lines · Filipe Manana
Quoted 59 lines · Qu Wenruo

There is a kernel regression for btrfs, that when passing non-existing devid to "btrfs device remove" command, kernel will crash due to NULL pointer dereference.

The test case is for such regression, it will:

- Create and mount an empty single-device btrfs
- Try to remove devid 3, which doesn't exist for above fs

The fix is titled "btrfs: fix NULL pointer dereference when deleting device by invalid id".

---
  tests/btrfs/244     | 42 ++++++++++++++++++++++++++++++++++++++++++
  tests/btrfs/244.out |  2 ++
  2 files changed, 44 insertions(+)

create mode 100755 tests/btrfs/244
create mode 100644 tests/btrfs/244.out

tests/btrfs/244 new file +32 -0
new file mode 100755
index 00000000..56eb9e8c
@@ -0,0 +1,42 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2021 SUSE Linux Products GmbH.  All Rights Reserved.
+#
+# FS QA Test 244
+#
+# Make sure "btrfs device remove" won't crash when non-existing devid
+# is provided
+#
+. ./common/preamble
+_begin_fstest auto quick volume dangerous
+
+# Override the default cleanup function.
+# _cleanup()
+# {
+#      cd /
+#      rm -r -f $tmp.*
+# }
+
+# Import common functions.
+# . ./common/filter
+
+# real QA test starts here
+
+# Modify as appropriate.
+_supported_fs btrfs
+_require_scratch
+
+_scratch_mkfs >> $seqres.full 2>&1
+_scratch_mount
+
+# Above created fs only contains one device with devid 1, device remove 3
Quoted 8 lines

tests/btrfs/244 line 36

Quoted 4 lines
tests/btrfs/244 new file +4 -0
+# should just fail.
+# We don't care about the failure itself, but care whether this would cause
+# kernel crash.
+$BTRFS_UTIL_PROG device remove 3 $SCRATCH_MNT >> $seqres.full 2>&1

While here we could also check that the operation fails. That avoids adding yet another test case if one day we have a regression where the operation returns success instead of an error.

That's exactly what I also thought.

But there comes a small problem, the output format may change, thus in the future the test case may cause false alert.

Quoted 4 lines

In fact the test subject and goal should be to verify that removing a non-existing device fails and does not cause any harm (kernel crash, metadata corruption, etc).

Right, I'll just include the error output into the golden output, so that we can verify everything, including the expected failure.

For the possible future format change, let the future guys to add a filter to handle it then.

Thanks,
Qu

Quoted 22 lines

Thanks.

Quoted 17 lines
tests/btrfs/244 new file +6 -0
+
+echo "Silence is golden"
+
+# success, all done
+status=0
+exit
tests/btrfs/244.out new file +2 -1
new file mode 100644
index 00000000..440da1f2
@@ -0,0 +1,2 @@
+QA output created by 244
+Silence is golden
--

2.31.1