xfstests: btrfs: test for orphan item cleanup
This test tests three conditions where orphan items need to be cleaned up:
1) Default subvolume is fs tree root (mkfs default)
2) Default subvolume has been set explicitly to another subvolume (set-default)
3) Looking up a subvolume during a traversal
In the kernel, these three cases use separate mechanisms to look up the subvolumes. There was a bug in the kernel where case #2 wasn't getting handled and so orphan items would never be cleaned up if the default subvolume was explicitly set. This issue was fixed with the upstream commit:
btrfs: cleanup orphans while looking up default subvolume
Signed-off-by Jeff Mahoney <[email protected]>
--- tests/btrfs/083 | 155 ++++++++++++++++++++++++++++++++++++++++++++++++++++ tests/btrfs/083.out | 5 ++ tests/btrfs/group | 1 + 3 files changed, 161 insertions(+) create mode 100755 tests/btrfs/083 create mode 100644 tests/btrfs/083.out
tests/btrfs/083 new file +155 -0
@@ -0,0 +1,155 @@ +#!/bin/bash +# FS QA Test No. btrfs/083 +# +# Tests to ensure that orphan items are properly created and cleaned up +# on next mount. +# +# There are three cases where orphan items may be cleaned up: +# 1) Default subvolume is fs tree root (mkfs default) +# 2) Default subvolume is explicitly created subvolume +# (i.e. btrfs subvol set-default) +# 3) Non-default subvolume lookup +# +#----------------------------------------------------------------------- +# Copyright (c) 2015 SUSE. All Rights Reserved. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it would be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write the Free Software Foundation, +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +# +#----------------------------------------------------------------------- +# + +seq=`basename $0` +seqres=$RESULT_DIR/$seq +echo "QA output created by $seq" + +here=`pwd` +tmp=/tmp/$$ +status=1 # failure is the default! + +_cleanup() +{ + _cleanup_flakey + rm -f $tmp.* +} + +trap "_cleanup ; exit \$status" 0 1 2 3 15 + +# get standard environment, filters and checks +. ./common/rc +. ./common/filter +. ./common/dmflakey + +# real QA test starts here +_supported_fs btrfs +_supported_os Linux +_require_scratch +_require_dm_flakey +_need_to_be_root + +rm -f $seqres.full + +has_orphan_item() { + INO=$1 + if btrfs-debug-tree $SCRATCH_DEV | \ + grep -q "key (ORPHAN ORPHAN_ITEM $INO)"; then + return 0 + fi + return 1 +} + +test_orphan() { + PRECMD=$1 + SUB=0 + + _scratch_mkfs >> $seqres.full 2>&1 + _init_flakey + + _mount_flakey + + $PRECMD + + TESTPATH=$SCRATCH_MNT/testdir/testfile + DIR=$(dirname $TESTPATH) + + [ -d "$DIR" ] || mkdir -p $DIR + + SIZE=$(( 1024 * 1024 )) + run_check dd if=/dev/zero of=$TESTPATH bs=$SIZE count=1 + + INO=$(stat -c %i $TESTPATH) + + # Orphan item won't be created if the file doesn't make it to disk + sync + + # Open and delete the file + exec 27<$TESTPATH + rm -f $TESTPATH + + # Ensure the unlink (and orphan item creation) hits the disk + sync + + # Turn off writes before closing so the orphan item will be left behind + _load_flakey_table $FLAKEY_DROP_WRITES + + # Close the file so we can umount + exec 27>&- + + # Orphan item should be on disk if operating correctly + _unmount_flakey + _load_flakey_table $FLAKEY_ALLOW_WRITES + if ! has_orphan_item $INO; then + echo "ERROR: No orphan item found after umount." + return + fi + _mount_flakey + + # If $DIR is a subvolume, this will cause a lookup and orphan cleanup + (cd $DIR; true) + + # Orphan item will be cleaned up during mount but won't be on + # disk until there's a sync. + sync + + _unmount_flakey + if has_orphan_item $INO; then + echo "ERROR: Orphan item found after successful mount/sync." + fi + _cleanup_flakey +} + +new_subvolume() { + _run_btrfs_util_prog subvol create $SCRATCH_MNT/testdir +} + +new_default() { + new_subvolume + SUB=$(btrfs subvol list $SCRATCH_MNT |awk '{print $2}') + _run_btrfs_util_prog subvol set-default $SUB $SCRATCH_MNT + + _unmount_flakey + _mount_flakey +} + +echo "Testing with fs root as default subvolume" +test_orphan true + +echo "Testing with explicit default subvolume" +test_orphan new_default + +echo "Testing with orphan on non-default subvolume" +test_orphan new_subvolume + +echo "Silence is golden" +status=0 +exit
tests/btrfs/083.out new file +5 -0
@@ -0,0 +1,5 @@ +QA output created by 083 +Testing with fs root as default subvolume +Testing with explicit default subvolume +Testing with orphan on non-default subvolume +Silence is golden
tests/btrfs/group +1 -0
@@ -85,3 +85,4 @@ 080 auto snapshot 081 auto quick clone 082 auto quick remount +083 auto quick metadata subvol
Signature · 6 lines
1.8.5.2 -- Jeff Mahoney SUSE Labs
Quoted 5 lines · Jeff Mahoney
This test tests three conditions where orphan items need to be cleaned up:
1) Default subvolume is fs tree root (mkfs default)
2) Default subvolume has been set explicitly to another subvolume (set-default)
3) Looking up a subvolume during a traversal
Quoted 7 lines
In the kernel, these three cases use separate mechanisms to look up the subvolumes. There was a bug in the kernel where case #2 wasn't getting handled and so orphan items would never be cleaned up if the default subvolume was explicitly set. This issue was fixed with the upstream commit:
btrfs: cleanup orphans while looking up default subvolumeSigned-off-by Jeff Mahoney <[email protected]>
Reviewed-by Filipe Manana <[email protected]>
Tested-by Filipe Manana <[email protected]>
Verified it fails without the btrfs fix applied and it passes with that fix applied.
Just a couple minor comments below.
Quoted 66 lines
--- tests/btrfs/083 | 155 ++++++++++++++++++++++++++++++++++++++++++++++++++++ tests/btrfs/083.out | 5 ++ tests/btrfs/group | 1 + 3 files changed, 161 insertions(+) create mode 100755 tests/btrfs/083 create mode 100644 tests/btrfs/083.outtests/btrfs/083 new file +52
-0@@ -0,0 +1,155 @@ +#!/bin/bash +# FS QA Test No. btrfs/083 +# +# Tests to ensure that orphan items are properly created and cleaned up +# on next mount. +# +# There are three cases where orphan items may be cleaned up: +# 1) Default subvolume is fs tree root (mkfs default) +# 2) Default subvolume is explicitly created subvolume +# (i.e. btrfs subvol set-default) +# 3) Non-default subvolume lookup +# +#----------------------------------------------------------------------- +# Copyright (c) 2015 SUSE. All Rights Reserved. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it would be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write the Free Software Foundation, +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +# +#----------------------------------------------------------------------- +# + +seq=`basename $0` +seqres=$RESULT_DIR/$seq +echo "QA output created by $seq" + +here=`pwd` +tmp=/tmp/$$ +status=1 # failure is the default! + +_cleanup() +{ + _cleanup_flakey + rm -f $tmp.* +} + +trap "_cleanup ; exit \$status" 0 1 2 3 15 + +# get standard environment, filters and checks +. ./common/rc +. ./common/filter +. ./common/dmflakey +
tests/btrfs/083 line 62
Quoted 10 lines
tests/btrfs/083 new file +10
-0+# real QA test starts here +_supported_fs btrfs +_supported_os Linux +_require_scratch +_require_dm_flakey +_need_to_be_root + +rm -f $seqres.full + +has_orphan_item() {
The general style used in fstests is to put the curly brace in its own line:
has_orphan_item()
{
....
}tests/btrfs/083 line 67
Quoted 5 lines
tests/btrfs/083 new file +5
-0+ INO=$1 + if btrfs-debug-tree $SCRATCH_DEV | \ + grep -q "key (ORPHAN ORPHAN_ITEM $INO)"; then + return 0 + fi
It would be nicer to have the test skipped with a useful message if btrfs-debug-tree is not available instead of failing.
So like the test btrfs/012 does for btrfs-convert for example, would be like:
BTRFS_DEBUG_TREE_PROG="set_prog_path btrfs-debug-tree" _require_command "$BTRFS_DEBUG_TREE_PROG" btrfs-debug-tree
Quoted 76 lines
tests/btrfs/083 new file +76
-0+ return 1 +} + +test_orphan() { + PRECMD=$1 + SUB=0 + + _scratch_mkfs >> $seqres.full 2>&1 + _init_flakey + + _mount_flakey + + $PRECMD + + TESTPATH=$SCRATCH_MNT/testdir/testfile + DIR=$(dirname $TESTPATH) + + [ -d "$DIR" ] || mkdir -p $DIR + + SIZE=$(( 1024 * 1024 )) + run_check dd if=/dev/zero of=$TESTPATH bs=$SIZE count=1 + + INO=$(stat -c %i $TESTPATH) + + # Orphan item won't be created if the file doesn't make it to disk + sync + + # Open and delete the file + exec 27<$TESTPATH + rm -f $TESTPATH + + # Ensure the unlink (and orphan item creation) hits the disk + sync + + # Turn off writes before closing so the orphan item will be left behind + _load_flakey_table $FLAKEY_DROP_WRITES + + # Close the file so we can umount + exec 27>&- + + # Orphan item should be on disk if operating correctly + _unmount_flakey + _load_flakey_table $FLAKEY_ALLOW_WRITES + if ! has_orphan_item $INO; then + echo "ERROR: No orphan item found after umount." + return + fi + _mount_flakey + + # If $DIR is a subvolume, this will cause a lookup and orphan cleanup + (cd $DIR; true) + + # Orphan item will be cleaned up during mount but won't be on + # disk until there's a sync. + sync + + _unmount_flakey + if has_orphan_item $INO; then + echo "ERROR: Orphan item found after successful mount/sync." + fi + _cleanup_flakey +} + +new_subvolume() { + _run_btrfs_util_prog subvol create $SCRATCH_MNT/testdir +} + +new_default() { + new_subvolume + SUB=$(btrfs subvol list $SCRATCH_MNT |awk '{print $2}') + _run_btrfs_util_prog subvol set-default $SUB $SCRATCH_MNT + + _unmount_flakey + _mount_flakey +} +
tests/btrfs/083 line 153
Quoted 10 lines
tests/btrfs/083 new file +10
-0+echo "Testing with fs root as default subvolume" +test_orphan true + +echo "Testing with explicit default subvolume" +test_orphan new_default + +echo "Testing with orphan on non-default subvolume" +test_orphan new_subvolume + +echo "Silence is golden"
Not needed because the test already echoes 3 messages before.
Quoted 33 lines
tests/btrfs/083 new file +2
-0+status=0 +exittests/btrfs/083.out new file +5
-0@@ -0,0 +1,5 @@ +QA output created by 083 +Testing with fs root as default subvolume +Testing with explicit default subvolume +Testing with orphan on non-default subvolume +Silence is goldentests/btrfs/group +1
-1@@ -85,3 +85,4 @@ 080 auto snapshot 081 auto quick clone 082 auto quick remount +083 auto quick metadata subvol --1.8.5.2
--
Jeff Mahoney
SUSE Labs
--
To unsubscribe from this list: send the line "unsubscribe fstests" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Signature · 5 lines
Filipe David Manana, "Reasonable men adapt themselves to the world. Unreasonable men adapt the world to themselves. That's why all progress depends on unreasonable men."
PATCH v2 1/1 xfstests: btrfs: test for orphan item cleanup
In reply to Jeff MahoneyThis test tests three conditions where orphan items need to be cleaned up:
1) Default subvolume is fs tree root (mkfs default)
2) Default subvolume has been set explicitly to another subvolume (set-default)
3) Looking up a subvolume during a traversal
In the kernel, these three cases use separate mechanisms to look up the subvolumes. There was a bug in the kernel where case #2 wasn't getting handled and so orphan items would never be cleaned up if the default subvolume was explicitly set. This issue was fixed with the upstream commit:
btrfs: cleanup orphans while looking up default subvolume.
Reviewed-by Filipe Manana <[email protected]>
Signed-off-by Jeff Mahoney <[email protected]>
--- tests/btrfs/083 | 161 ++++++++++++++++++++++++++++++++++++++++++++++++++++ tests/btrfs/083.out | 4 ++ tests/btrfs/group | 1 + 3 files changed, 166 insertions(+) create mode 100755 tests/btrfs/083 create mode 100644 tests/btrfs/083.out
tests/btrfs/083 new file +161 -0
@@ -0,0 +1,161 @@ +#!/bin/bash +# FS QA Test No. btrfs/083 +# +# Tests to ensure that orphan items are properly created and cleaned up +# on next mount. +# +# There are three cases where orphan items may be cleaned up: +# 1) Default subvolume is fs tree root (mkfs default) +# 2) Default subvolume is explicitly created subvolume +# (i.e. btrfs subvol set-default) +# 3) Non-default subvolume lookup +# +#----------------------------------------------------------------------- +# Copyright (c) 2015 SUSE. All Rights Reserved. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it would be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write the Free Software Foundation, +# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +# +#----------------------------------------------------------------------- +# + +seq=`basename $0` +seqres=$RESULT_DIR/$seq +echo "QA output created by $seq" + +here=`pwd` +tmp=/tmp/$$ +status=1 # failure is the default! + +_cleanup() +{ + _cleanup_flakey + rm -f $tmp.* +} + +trap "_cleanup ; exit \$status" 0 1 2 3 15 + +# get standard environment, filters and checks +. ./common/rc +. ./common/filter +. ./common/dmflakey + +# real QA test starts here +_supported_fs btrfs +_supported_os Linux +_require_scratch +_require_dm_flakey +_need_to_be_root + +BTRFS_DEBUG_TREE_PROG="`set_prog_path btrfs-debug-tree`" +_require_command "$BTRFS_DEBUG_TREE_PROG" btrfs-debug-tree + +rm -f $seqres.full + +has_orphan_item() +{ + INO=$1 + if $BTRFS_DEBUG_TREE_PROG $SCRATCH_DEV | \ + grep -q "key (ORPHAN ORPHAN_ITEM $INO)"; then + return 0 + fi + return 1 +} + +test_orphan() +{ + PRECMD=$1 + SUB=0 + + _scratch_mkfs >> $seqres.full 2>&1 + _init_flakey + + _mount_flakey + + $PRECMD + + TESTPATH=$SCRATCH_MNT/testdir/testfile + DIR=$(dirname $TESTPATH) + + [ -d "$DIR" ] || mkdir -p $DIR + + SIZE=$(( 1024 * 1024 )) + run_check dd if=/dev/zero of=$TESTPATH bs=$SIZE count=1 + + INO=$(stat -c %i $TESTPATH) + + # Orphan item won't be created if the file doesn't make it to disk + sync + + # Open and delete the file + exec 27<$TESTPATH + rm -f $TESTPATH + + # Ensure the unlink (and orphan item creation) hits the disk + sync + + # Turn off writes before closing so the orphan item will be left behind + _load_flakey_table $FLAKEY_DROP_WRITES + + # Close the file so we can umount + exec 27>&- + + # Orphan item should be on disk if operating correctly + _unmount_flakey + _load_flakey_table $FLAKEY_ALLOW_WRITES + if ! has_orphan_item $INO; then + echo "ERROR: No orphan item found after umount." + return + fi + _mount_flakey + + # If $DIR is a subvolume, this will cause a lookup and orphan cleanup + (cd $DIR; true) + + # Orphan item will be cleaned up during mount but won't be on + # disk until there's a sync. + sync + + _unmount_flakey + if has_orphan_item $INO; then + echo "ERROR: Orphan item found after successful mount/sync." + fi + _cleanup_flakey +} + +new_subvolume() +{ + _run_btrfs_util_prog subvol create $SCRATCH_MNT/testdir +} + +new_default() +{ + new_subvolume + SUB=$($BTRFS_UTIL_PROG subvol list $SCRATCH_MNT |awk '{print $2}') + _run_btrfs_util_prog subvol set-default $SUB $SCRATCH_MNT + + _unmount_flakey + _mount_flakey +} + +echo "Testing with fs root as default subvolume" +test_orphan true + +echo "Testing with explicit default subvolume" +test_orphan new_default + +echo "Testing with orphan on non-default subvolume" +test_orphan new_subvolume + +status=0 +exit
tests/btrfs/083.out new file +4 -0
@@ -0,0 +1,4 @@ +QA output created by 083 +Testing with fs root as default subvolume +Testing with explicit default subvolume +Testing with orphan on non-default subvolume
tests/btrfs/group +1 -0
@@ -85,3 +85,4 @@ 080 auto snapshot 081 auto quick clone 082 auto quick remount +083 auto quick metadata subvol
Signature · 1 line
1.8.5.6