generic: Add sudden shutdown tests for multi block atomic writes

This test is intended to ensure that multi blocks atomic writes
maintain atomic guarantees across sudden FS shutdowns.

The way we work is that we lay out a file with random mix of written,
unwritten and hole extents. Then we start performing atomic writes
sequentially on the file while we parallelly shutdown the FS. Then we
note the last offset where the atomic write happened just before shut
down and then make sure blocks around it either have completely old
data or completely new data, ie the write was not torn during shutdown.

We repeat the same with completely written, completely unwritten and completely
empty file to ensure these cases are not torn either.  Finally, we have a
similar test for append atomic writes

Suggested-by: Ritesh Harjani (IBM) <ritesh.list@gmail.com>
Reviewed-by: Darrick J. Wong <djwong@kernel.org>
Reviewed-by: John Garry <john.g.garry@oracle.com>
Signed-off-by: Ojaswin Mujoo <ojaswin@linux.ibm.com>
Signed-off-by: Zorro Lang <zlang@kernel.org>

diff --git a/tests/generic/778 b/tests/generic/778
new file mode 100755 (executable)
index 0000000..8cb1d8d
--- /dev/null
+++ b/tests/generic/778
@@ -0,0 +1,368 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2025 IBM Corporation. All Rights Reserved.
+#
+# FS QA Test No. 778
+#
+# Test multi block atomic writes with sudden FS shutdowns to ensure
+# the FS is not tearing the write operation
+. ./common/preamble
+. ./common/atomicwrites
+_begin_fstest auto atomicwrites
+
+_require_scratch_write_atomic_multi_fsblock
+_require_atomic_write_test_commands
+_require_scratch_shutdown
+_require_xfs_io_command "truncate"
+
+_scratch_mkfs >> $seqres.full 2>&1
+_scratch_mount >> $seqres.full
+
+testfile=$SCRATCH_MNT/testfile
+touch $testfile
+
+awu_max=$(_get_atomic_write_unit_max $testfile)
+blksz=$(_get_block_size $SCRATCH_MNT)
+echo "Awu max: $awu_max" >> $seqres.full
+
+num_blocks=$((awu_max / blksz))
+# keep initial value high for dry run. This will be
+# tweaked in dry_run() based on device write speed.
+filesize=$(( 10 * 1024 * 1024 * 1024 ))
+
+_cleanup() {
+       [ -n "$awloop_pid" ] && kill $awloop_pid &> /dev/null
+       wait
+}
+
+atomic_write_loop() {
+       local off=0
+       local size=$awu_max
+       for ((i=0; i<$((filesize / $size )); i++)); do
+               # Due to sudden shutdown this can produce errors so just
+               # redirect them to seqres.full
+               $XFS_IO_PROG -c "open -fsd $testfile" -c "pwrite -S 0x61 -DA -V1 -b $size $off $size" >> /dev/null 2>>$seqres.full
+               echo "Written to offset: $off" >> $tmp.aw
+               off=$((off + $size))
+       done
+}
+
+start_atomic_write_and_shutdown() {
+       atomic_write_loop &
+       awloop_pid=$!
+
+       local i=0
+       # Wait for at least first write to be recorded or 10s
+       while [ ! -f "$tmp.aw" -a $i -le 50 ]; do i=$((i + 1)); sleep 0.2; done
+
+       if [[ $i -gt 50 ]]
+       then
+               _fail "atomic write process took too long to start"
+       fi
+
+       echo >> $seqres.full
+       echo "# Shutting down filesystem while write is running" >> $seqres.full
+       _scratch_shutdown
+
+       kill $awloop_pid 2>/dev/null  # the process might have finished already
+       wait $awloop_pid
+       unset $awloop_pid
+}
+
+# This test has the following flow:
+# 1. Start doing sequential atomic writes in background, upto $filesize
+# 2. Sleep for 0.2s and shutdown the FS
+# 3. kill the atomic write process
+# 4. verify the writes were not torn
+#
+# We ideally want the shutdown to happen while an atomic write is ongoing
+# but this gets tricky since faster devices can actually finish the whole
+# atomic write loop before sleep 0.2s completes, resulting in the shutdown
+# happening after the write loop which is not what we want. A simple solution
+# to this is to increase $filesize so step 1 takes long enough but a big
+# $filesize leads to create_mixed_mappings() taking very long, which is not
+# ideal.
+#
+# Hence, use the dry_run function to figure out the rough device speed and set
+# $filesize accordingly.
+dry_run() {
+       echo >> $seqres.full
+       echo "# Estimating ideal filesize..." >> $seqres.full
+
+       start_atomic_write_and_shutdown
+
+       bytes_written=$(tail -n 1 $tmp.aw | cut -d" " -f4)
+       echo "# Bytes written in 0.2s: $bytes_written" >> $seqres.full
+
+       filesize=$((bytes_written * 3))
+       echo "# Setting \$filesize=$filesize" >> $seqres.full
+
+       rm $tmp.aw
+       sleep 0.5
+
+       _scratch_cycle_mount
+
+}
+
+create_mixed_mappings() {
+       local file=$1
+       local size_bytes=$2
+
+       echo "# Filling file $file with alternate mappings till size $size_bytes" >> $seqres.full
+       #Fill the file with alternate written and unwritten blocks
+       local off=0
+       local operations=("W" "U")
+
+       for ((i=0; i<$((size_bytes / blksz )); i++)); do
+               index=$(($i % ${#operations[@]}))
+               map="${operations[$index]}"
+
+               case "$map" in
+                   "W")
+                       $XFS_IO_PROG -fc "pwrite -b $blksz $off $blksz" $file  >> /dev/null
+                       ;;
+                   "U")
+                       $XFS_IO_PROG -fc "falloc $off $blksz" $file >> /dev/null
+                       ;;
+               esac
+               off=$((off + blksz))
+       done
+
+       sync $file
+}
+
+populate_expected_data() {
+       # create a dummy file with expected old data for different cases
+       create_mixed_mappings $testfile.exp_old_mixed $awu_max
+       expected_data_old_mixed=$(od -An -t x1 -j 0 -N $awu_max $testfile.exp_old_mixed)
+
+       $XFS_IO_PROG -fc "falloc 0 $awu_max" $testfile.exp_old_zeroes >> $seqres.full
+       expected_data_old_zeroes=$(od -An -t x1 -j 0 -N $awu_max $testfile.exp_old_zeroes)
+
+       $XFS_IO_PROG -fc "pwrite -b $awu_max 0 $awu_max" $testfile.exp_old_mapped >> $seqres.full
+       expected_data_old_mapped=$(od -An -t x1 -j 0 -N $awu_max $testfile.exp_old_mapped)
+
+       # create a dummy file with expected new data
+       $XFS_IO_PROG -fc "pwrite -S 0x61 -b $awu_max 0 $awu_max" $testfile.exp_new >> $seqres.full
+       expected_data_new=$(od -An -t x1 -j 0 -N $awu_max $testfile.exp_new)
+}
+
+verify_data_blocks() {
+       local verify_start=$1
+       local verify_end=$2
+       local expected_data_old="$3"
+       local expected_data_new="$4"
+
+       echo >> $seqres.full
+       echo "# Checking for torn write from $verify_start to $verify_end" >> $seqres.full
+
+       # After an atomic write, for every chunk we ensure that the underlying
+       # data is either the old data or new data as writes shouldn't get torn.
+       local off=$verify_start
+       while [[ "$off" -lt "$verify_end" ]]
+       do
+               #actual_data=$(xxd -s $off -l $awu_max -p $testfile)
+               actual_data=$(od -An -t x1 -j $off -N $awu_max $testfile)
+               if [[ "$actual_data" != "$expected_data_new" ]] && [[ "$actual_data" != "$expected_data_old" ]]
+               then
+                       echo "Checksum match failed at off: $off size: $awu_max"
+                       echo "Expected contents: (Either of the 2 below):"
+                       echo
+                       echo "Old: "
+                       echo "$expected_data_old"
+                       echo
+                       echo "New: "
+                       echo "$expected_data_new"
+                       echo
+                       echo "Actual contents: "
+                       echo "$actual_data"
+
+                       _fail
+               fi
+               echo -n "Check at offset $off succeeded! " >> $seqres.full
+               if [[ "$actual_data" == "$expected_data_new" ]]
+               then
+                       echo "matched new" >> $seqres.full
+               elif [[ "$actual_data" == "$expected_data_old" ]]
+               then
+                       echo "matched old" >> $seqres.full
+               fi
+               off=$(( off + awu_max ))
+       done
+}
+
+# test torn write for file by shutting down in between atomic writes
+test_torn_write() {
+       echo >> $seqres.full
+       echo "# Writing atomically to file in background" >> $seqres.full
+
+       start_atomic_write_and_shutdown
+
+       last_offset=$(tail -n 1 $tmp.aw | cut -d" " -f4)
+       if [[ -z $last_offset ]]
+       then
+               last_offset=0
+       fi
+
+       echo >> $seqres.full
+       echo "# Last offset of atomic write: $last_offset" >> $seqres.full
+
+       rm $tmp.aw
+       sleep 0.5
+
+       _scratch_cycle_mount
+
+       # we want to verify all blocks around which the shutdown happened
+       verify_start=$(( last_offset - (awu_max * 5)))
+       if [[ $verify_start < 0 ]]
+       then
+               verify_start=0
+       fi
+
+       verify_end=$(( last_offset + (awu_max * 5)))
+       if [[ "$verify_end" -gt "$filesize" ]]
+       then
+               verify_end=$filesize
+       fi
+}
+
+# test torn write for file with written and unwritten mappings
+test_torn_write_mixed() {
+       $XFS_IO_PROG -fc "truncate 0" $testfile >> $seqres.full
+
+       echo >> $seqres.full
+       echo "# Creating testfile with mixed mappings" >> $seqres.full
+       create_mixed_mappings $testfile $filesize
+
+       test_torn_write
+
+       verify_data_blocks $verify_start $verify_end "$expected_data_old_mixed" "$expected_data_new"
+}
+
+# test torn write for file with completely written mappings
+test_torn_write_written() {
+       $XFS_IO_PROG -fc "truncate 0" $testfile >> $seqres.full
+
+       echo >> $seqres.full
+       echo "# Creating testfile with fully written mapping" >> $seqres.full
+       $XFS_IO_PROG -c "pwrite -b $filesize 0 $filesize" $testfile >> $seqres.full
+       sync $testfile
+
+       test_torn_write
+
+       verify_data_blocks $verify_start $verify_end "$expected_data_old_mapped" "$expected_data_new"
+}
+
+# test torn write for file with completely unwritten mappings
+test_torn_write_unwritten() {
+       $XFS_IO_PROG -fc "truncate 0" $testfile >> $seqres.full
+
+       echo >> $seqres.full
+       echo "# Creating testfile with fully unwritten mappings" >> $seqres.full
+       $XFS_IO_PROG -c "falloc 0 $filesize" $testfile >> $seqres.full
+       sync $testfile
+
+       test_torn_write
+
+       verify_data_blocks $verify_start $verify_end "$expected_data_old_zeroes" "$expected_data_new"
+}
+
+# test torn write for file with no mappings
+test_torn_write_hole() {
+       $XFS_IO_PROG -fc "truncate 0" $testfile >> $seqres.full
+
+       echo >> $seqres.full
+       echo "# Creating testfile with no mappings" >> $seqres.full
+       $XFS_IO_PROG -c "truncate $filesize" $testfile >> $seqres.full
+       sync $testfile
+
+       test_torn_write
+
+       verify_data_blocks $verify_start $verify_end "$expected_data_old_zeroes" "$expected_data_new"
+}
+
+test_append_torn_write() {
+       $XFS_IO_PROG -c "truncate 0" $testfile >> $seqres.full
+
+       echo >> $seqres.full
+       echo "# Performing append atomic writes over file in background" >> $seqres.full
+
+       start_atomic_write_and_shutdown
+
+       local last_offset=$(tail -n 1 $tmp.aw | cut -d" " -f4)
+       if [[ -z $last_offset ]]
+       then
+               last_offset=0
+       fi
+
+       echo >> $seqres.full
+       echo "# Last offset of atomic write: $last_offset" >> $seqres.full
+       rm $tmp.aw
+       sleep 0.5
+
+       _scratch_cycle_mount
+       local filesize=$(_get_filesize $testfile)
+       echo >> $seqres.full
+       echo "# Filesize after shutdown: $filesize" >> $seqres.full
+
+       # To confirm that the write went atomically, we check:
+       # 1. The last block should be a multiple of awu_max
+       # 2. The last block should be the completely new data
+
+       if (( $filesize % $awu_max ))
+       then
+               echo "Filesize after shutdown ($filesize) not a multiple of atomic write unit ($awu_max)"
+       fi
+
+       verify_start=$(( filesize - (awu_max * 5)))
+       if [[ $verify_start < 0 ]]
+       then
+               verify_start=0
+       fi
+
+       local verify_end=$filesize
+
+       # Here the blocks should always match new data hence, for simplicity of
+       # code, just corrupt the $expected_data_old buffer so it never matches
+       local expected_data_old="POISON"
+       verify_data_blocks $verify_start $verify_end "$expected_data_old" "$expected_data_new"
+}
+
+$XFS_IO_PROG -fc "truncate 0" $testfile >> $seqres.full
+
+dry_run
+
+echo >> $seqres.full
+echo "# Populating expected data buffers" >> $seqres.full
+populate_expected_data
+
+# Loop 20 times to shake out any races due to shutdown
+for ((iter=0; iter<20; iter++))
+do
+       echo >> $seqres.full
+       echo "------ Iteration $iter ------" >> $seqres.full
+
+       echo >> $seqres.full
+       echo "# Starting torn write test for atomic writes over mixed mapping" >> $seqres.full
+       test_torn_write_mixed
+
+       echo >> $seqres.full
+       echo "# Starting torn write test for atomic writes over fully written mapping" >> $seqres.full
+       test_torn_write_written
+
+       echo >> $seqres.full
+       echo "# Starting torn write test for atomic writes over fully unwritten mapping" >> $seqres.full
+       test_torn_write_unwritten
+
+       echo >> $seqres.full
+       echo "# Starting torn write test for atomic writes over holes" >> $seqres.full
+       test_torn_write_hole
+
+       echo >> $seqres.full
+       echo "# Starting shutdown torn write test for append atomic writes" >> $seqres.full
+       test_append_torn_write
+done
+
+echo "Silence is golden"
+status=0
+exit

diff --git a/tests/generic/778.out b/tests/generic/778.out
new file mode 100644 (file)
index 0000000..e80f72a
--- /dev/null
+++ b/tests/generic/778.out
@@ -0,0 +1,2 @@
+QA output created by 778
+Silence is golden