btrfs: make sure btrfs can handle full fs trim correctly
authorQu Wenruo <>
Wed, 29 Nov 2017 06:14:19 +0000 (14:14 +0800)
committerEryu Guan <>
Fri, 1 Dec 2017 08:51:00 +0000 (16:51 +0800)
Ancient commit f4c697e6406d ("btrfs: return EINVAL if start >
total_bytes in fitrim ioctl") introduced a regression where btrfs
may fail to trim any free space in existing block groups.

It's caused by confusion with btrfs_super_block->total_bytes and
btrfs logical address space.

Unlike physical address, any aligned bytenr in range [0, U64_MAX) is
valid in btrfs logical address space, and it's chunk mapping
mechanism of btrfs to handle the logical<->physical mapping.

The test case will craft a btrfs with the following features:
0) Single data/meta profile
   Make trimmed bytes reporting and chunk allocation more predictable.

1) All chunks start beyond super_block->total_bytes (1G)
   By relocating these blocks several times.

2) Unallocated space is less than 50% of the whole fs

3) Fragmented data chunks
   Data chunks will be full of fragments, 50% of data chunks will be
   free space.

So in theory fstrim should be able to trim over 50% space of the fs.
(after fix, 64% of the fs can be trimmed)

While the regression makes btrfs only able to trim unallocated
space, which is less than 50% of the total space.
(without fix, it's only 31%)

Fixed by patch named "btrfs: Ensure btrfs_trim_fs can trim the whole

Signed-off-by: Qu Wenruo <>
Reviewed-by: Eryu Guan <>
Signed-off-by: Eryu Guan <>
tests/btrfs/156 [new file with mode: 0755]
tests/btrfs/156.out [new file with mode: 0644]

diff --git a/tests/btrfs/156 b/tests/btrfs/156
new file mode 100755 (executable)
index 0000000..1d38e95
--- /dev/null
@@ -0,0 +1,120 @@
+#! /bin/bash
+# FS QA Test 156
+# Check if btrfs can correctly trim free space in block groups
+# An ancient regression prevent btrfs from trimming free space inside
+# existing block groups, if bytenr of block group starts beyond
+# btrfs_super_block->total_bytes.
+# However all bytenr in btrfs is in btrfs logical address space,
+# where any bytenr in range [0, U64_MAX] is valid.
+# Fixed by patch named "btrfs: Ensure btrfs_trim_fs can trim the whole fs".
+# Copyright (c) 2017 SUSE Linux Products GmbH.  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
+# 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`
+echo "QA output created by $seq"
+status=1       # failure is the default!
+trap "_cleanup; exit \$status" 0 1 2 3 15
+       cd /
+       rm -f $tmp.*
+# get standard environment, filters and checks
+. ./common/rc
+. ./common/filter
+# remove previous $seqres.full before test
+rm -f $seqres.full
+# real QA test starts here
+# Modify as appropriate.
+_supported_fs btrfs
+_supported_os Linux
+# 1024fs size
+fs_size=$((1024 * 1024 * 1024))
+# Use small files to fill half of the fs
+file_size=$(( 1024 * 1024 ))
+nr_files=$(( $fs_size / $file_size / 2))
+# Force to use single data and meta profile.
+# Since the test relies on fstrim output, which will differ for different
+# profiles
+_scratch_mkfs -b $fs_size -m single -d single > /dev/null
+_require_batched_discard "$SCRATCH_MNT"
+for n in $(seq -w 0 $(( $nr_files - 1))); do
+       $XFS_IO_PROG -f -c "pwrite 0 $file_size" "$SCRATCH_MNT/file_$n" \
+               > /dev/null
+# Flush all buffer data into disk, to trigger chunk allocation
+# Now we have take at least 50% of the filesystem, relocate all chunks twice
+# so all chunks will start after 1G in logical space.
+# (Btrfs chunk allocation will not rewind to reuse lower space)
+_run_btrfs_util_prog balance start --full-balance "$SCRATCH_MNT"
+# To avoid possible false ENOSPC alert on v4.15-rc1, seems to be a
+# reserved space related bug (maybe related to outstanding space rework?),
+# but that's another story.
+_run_btrfs_util_prog balance start --full-balance "$SCRATCH_MNT"
+# Now remove half of the files to make some holes for later trim.
+# While still keep the chunk space fragmented, so no chunk will be freed
+rm $SCRATCH_MNT/file_*[13579] -f
+# Make sure space is freed
+trimmed=$($FSTRIM_PROG -v "$SCRATCH_MNT" | _filter_fstrim)
+echo "Trimmed=$trimmed total_size=$fs_size ratio=$(($trimmed * 100 / $fs_size))%" \
+       >> $seqres.full
+# For correct full fs trim, both unallocated space (less than 50%)
+# and free space in existing block groups (about 25%) should be trimmed.
+# If less than 50% is trimmed, then only unallocated space is trimmed.
+# BTW, without fix only 31% can be trimmed, while after fix it's 64%.
+if [ $trimmed -lt $(( $fs_size / 2)) ]; then
+       echo "Free space in block groups not trimmed"
+       echo "Trimmed=$trimmed total_size=$fs_size ratio=$(($trimmed * 100 / $fs_size))%"
+echo "Silence is golden"
+# success, all done
diff --git a/tests/btrfs/156.out b/tests/btrfs/156.out
new file mode 100644 (file)
index 0000000..51cda2f
--- /dev/null
@@ -0,0 +1,2 @@
+QA output created by 156
+Silence is golden
index b9879e6a4e2f1be014f65c9c2befe369a9ff0677..ff070d188e1c3466686460535ac5e8faeb59cfb4 100644 (file)
 153 auto quick qgroup
 154 auto quick
 155 auto quick send
+156 auto quick trim