2 # SPDX-License-Identifier: GPL-2.0
3 # Copyright (c) 2014 Filipe Manana. All Rights Reserved.
5 # FS QA Test No. btrfs/055
7 # Regression test for the btrfs ioctl clone operation when the source range
8 # contains hole(s) and the FS has the NO_HOLES feature enabled (file holes
9 # don't need file extent items in the btree to represent them).
11 # This issue is fixed by the following linux kernel btrfs patch:
13 # Btrfs: fix clone to deal with holes when NO_HOLES feature is enabled
16 seqres=$RESULT_DIR/$seq
17 echo "QA output created by $seq"
20 status=1 # failure is the default!
21 trap "_cleanup; exit \$status" 0 1 2 3 15
28 # get standard environment, filters and checks
32 # real QA test starts here
36 _require_btrfs_fs_feature "no_holes"
37 _require_btrfs_mkfs_feature "no-holes"
41 test_btrfs_clone_with_holes()
43 _scratch_mkfs "$1" >/dev/null 2>&1
46 BLOCK_SIZE=$(_get_block_size $SCRATCH_MNT)
48 EXTENT_SIZE=$((2 * $BLOCK_SIZE))
52 # Create a file with 4 extents and 1 hole, all with 2 blocks each.
53 # The hole is in the block range [4, 5[.
54 $XFS_IO_PROG -s -f -c "pwrite -S 0x01 -b $EXTENT_SIZE $OFFSET $EXTENT_SIZE" \
55 $SCRATCH_MNT/foo | _filter_xfs_io_blocks_modified
57 OFFSET=$(($OFFSET + $EXTENT_SIZE))
58 $XFS_IO_PROG -s -f -c "pwrite -S 0x02 -b $EXTENT_SIZE $OFFSET $EXTENT_SIZE" \
59 $SCRATCH_MNT/foo | _filter_xfs_io_blocks_modified
61 OFFSET=$(($OFFSET + 2 * $EXTENT_SIZE))
62 $XFS_IO_PROG -s -f -c "pwrite -S 0x04 -b $EXTENT_SIZE $OFFSET $EXTENT_SIZE" \
63 $SCRATCH_MNT/foo | _filter_xfs_io_blocks_modified
65 OFFSET=$(($OFFSET + $EXTENT_SIZE))
66 $XFS_IO_PROG -s -f -c "pwrite -S 0x05 -b $EXTENT_SIZE $OFFSET $EXTENT_SIZE" \
67 $SCRATCH_MNT/foo | _filter_xfs_io_blocks_modified
69 # Clone destination file, 1 extent of 24 blocks.
70 EXTENT_SIZE=$((24 * $BLOCK_SIZE))
71 $XFS_IO_PROG -s -f -c "pwrite -S 0xff -b $EXTENT_SIZE 0 $EXTENT_SIZE" \
72 $SCRATCH_MNT/bar | _filter_xfs_io_blocks_modified
74 # Clone 2nd extent, 2-blocks sized hole and 3rd extent of foo into bar.
75 $CLONER_PROG -s $((2 * $BLOCK_SIZE)) -d 0 -l $((6 * $BLOCK_SIZE)) \
76 $SCRATCH_MNT/foo $SCRATCH_MNT/bar
78 # Verify both extents and the hole were cloned.
79 echo "1) Check both extents and the hole were cloned"
80 od -t x1 $SCRATCH_MNT/bar | _filter_od
82 # Cloning range starts at the middle of a hole.
83 $CLONER_PROG -s $((5 * $BLOCK_SIZE)) -d $((8 * $BLOCK_SIZE)) \
84 -l $((3 * $BLOCK_SIZE)) $SCRATCH_MNT/foo $SCRATCH_MNT/bar
86 # Verify that half of the hole and the following 2 block extent were cloned.
87 echo "2) Check half hole and the following 2 block extent were cloned"
88 od -t x1 $SCRATCH_MNT/bar | _filter_od
90 # Cloning range ends at the middle of a hole.
91 $CLONER_PROG -s 0 -d $((16 * $BLOCK_SIZE)) -l $((5 * $BLOCK_SIZE)) \
92 $SCRATCH_MNT/foo $SCRATCH_MNT/bar
94 # Verify that 2 extents of 2 blocks size and a 1-block hole were cloned.
95 echo "3) Check that 2 extents of 2 blocks each and a hole of 1 block were cloned"
96 od -t x1 $SCRATCH_MNT/bar | _filter_od
98 # Create a 6-block hole at the end of the source file (foo).
99 $XFS_IO_PROG -c "truncate $((16 * $BLOCK_SIZE))" $SCRATCH_MNT/foo \
100 | _filter_xfs_io_blocks_modified
103 # Now clone a range that overlaps that hole at the end of the foo file.
104 # It should clone the 10th block and the first two blocks of the hole
106 $CLONER_PROG -s $((9 * $BLOCK_SIZE)) -d $((21 * $BLOCK_SIZE)) \
107 -l $((3 * $BLOCK_SIZE)) $SCRATCH_MNT/foo $SCRATCH_MNT/bar
109 # Verify that the 9th block of foo and the first 2 blocks of the
110 # 6-block hole of foo were cloned into bar.
111 echo "4) Check that a block of 1 extent and 2 blocks of a hole were cloned"
112 od -t x1 $SCRATCH_MNT/bar | _filter_od
114 # Clone the same range as before, but clone it into a different offset
115 # of the target (bar) such that it increases the size of the target
117 $CLONER_PROG -s $((9 * $BLOCK_SIZE)) -d $((23 * $BLOCK_SIZE)) \
118 -l $((3 * $BLOCK_SIZE)) $SCRATCH_MNT/foo $SCRATCH_MNT/bar
120 # Verify that the 9th block of foo and the first 2 blocks of the 6-block
121 # hole of foo were cloned into bar at bar's 23rd block and that bar's
122 # size increased by 2 blocks.
123 echo "5) Check that a block of 1 extent and 2 blocks of a hole were" \
124 "cloned and file size increased"
125 od -t x1 $SCRATCH_MNT/bar | _filter_od
127 # Create a new completely sparse file (no extents, it's a big hole).
128 $XFS_IO_PROG -f -c "truncate $((25 * $BLOCK_SIZE))" $SCRATCH_MNT/qwerty \
129 | _filter_xfs_io_blocks_modified
132 # Test cloning a range from the sparse file to the bar file without
133 # increasing bar's size.
134 $CLONER_PROG -s $((1 * $BLOCK_SIZE)) -d 0 -l $((2 * $BLOCK_SIZE)) \
135 $SCRATCH_MNT/qwerty $SCRATCH_MNT/bar
137 # First 2 blocks of bar should now be zeroes.
138 echo "6) Check that 2 blocks of the hole were cloned"
139 od -t x1 $SCRATCH_MNT/bar | _filter_od
141 # Test cloning a range from the sparse file to the end of the bar file.
142 # The bar file currently has 26 blocks.
143 $CLONER_PROG -s 0 -d $((26 * $BLOCK_SIZE)) -l $((8 * $BLOCK_SIZE)) $SCRATCH_MNT/qwerty \
146 # Verify bar's size increased to 26 + 8 blocks, and its
147 # last 8 blocks are all zeroes.
148 echo "7) Check that 8 blocks of the hole were cloned and the file size increased"
149 od -t x1 $SCRATCH_MNT/bar | _filter_od
151 # Verify that there are no consistency errors.
155 # Regardless of the NO_HOLES feature being enabled or not, the test results
156 # should be exactly the same for both cases.
158 echo "Testing without the NO_HOLES feature"
159 # As of btrfs-progs 3.14.x, the no-holes feature isn't enabled by default.
160 # But explicitly disable it at mkfs time as it might be enabled by default
161 # in future versions.
162 test_btrfs_clone_with_holes "-O ^no-holes"
166 echo "Testing with the NO_HOLES feature enabled"
167 test_btrfs_clone_with_holes "-O no-holes"