From 1e74582b76baf5b584e2b9085e4957b4dec62fd5 Mon Sep 17 00:00:00 2001
From: Mateusz Kozlowski <mateusz.kozlowski@intel.com>
Date: Fri, 31 May 2019 13:35:12 +0200
Subject: [PATCH] lib/ftl: Add dirty shutdown test

Add test which causes dirty shutdown of ftl and attempts to restore
it. Without persistent cache it expects partial recovery of data
and zeroed out blocks in found open bands.

Signed-off-by: Mateusz Kozlowski <mateusz.kozlowski@intel.com>
Change-Id: I316cbbb47d0d03b2c20247df43ba789f2fd018db
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/456470
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
---
 test/ftl/dirty_shutdown.sh | 84 ++++++++++++++++++++++++++++++++++++++
 test/ftl/ftl.sh            |  4 ++
 2 files changed, 88 insertions(+)
 create mode 100755 test/ftl/dirty_shutdown.sh

diff --git a/test/ftl/dirty_shutdown.sh b/test/ftl/dirty_shutdown.sh
new file mode 100755
index 000000000..bd64a542c
--- /dev/null
+++ b/test/ftl/dirty_shutdown.sh
@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+testdir=$(readlink -f $(dirname $0))
+rootdir=$(readlink -f $testdir/../..)
+source $rootdir/test/common/autotest_common.sh
+
+rpc_py=$rootdir/scripts/rpc.py
+pu_start=0
+pu_end=3
+additional_blocks=16
+
+device=$1
+uuid=$2
+
+restore_kill() {
+	rm -f $testdir/config/ftl.json
+	rm -f $testdir/empty
+	rm -f $testdir/testblock
+	rm -f $testdir/testfile.md5
+
+	$rpc_py delete_ftl_bdev -b nvme0 || true
+	killprocess $svcpid || true
+	rmmod nbd || true
+}
+
+trap "restore_kill; exit 1" SIGINT SIGTERM EXIT
+
+# Extract chunk size
+chunk_size=$($rootdir/examples/nvme/identify/identify -r "trtype:PCIe traddr:$device" |
+grep 'Logical blks per chunk' | sed 's/[^0-9]//g')
+
+band_size=$(($chunk_size*($pu_end-$pu_start+1)))
+
+$rootdir/app/spdk_tgt/spdk_tgt & svcpid=$!
+# Wait until spdk_tgt starts
+waitforlisten $svcpid
+
+if [ -n "$uuid" ]; then
+	$rpc_py construct_ftl_bdev -b nvme0 -a $device -l $pu_start-$pu_end -u $uuid -o
+else
+	$rpc_py construct_ftl_bdev -b nvme0 -a $device -l $pu_start-$pu_end -o
+fi
+
+# Load the nbd driver
+modprobe nbd
+$rpc_py start_nbd_disk nvme0 /dev/nbd0
+waitfornbd nbd0
+
+$rpc_py save_config > $testdir/config/ftl.json
+
+# Send band worth of data in 2 steps (some data should be written to 2nd band due to metadata overhead)
+dd if=/dev/urandom of=/dev/nbd0 bs=4K count=$(($band_size - $chunk_size)) oflag=dsync
+dd if=/dev/urandom of=/dev/nbd0 bs=4K count=$chunk_size seek=$(($band_size - $chunk_size)) oflag=dsync
+# Save md5 data of first batch (which should be fully on a closed band and recoverable)
+dd if=/dev/nbd0 bs=4K count=$(($band_size - $chunk_size)) | md5sum > $testdir/testfile.md5
+
+# Make sure the third batch of written data is fully on the second band
+dd if=/dev/urandom of=/dev/nbd0 bs=4K count=$additional_blocks seek=$band_size oflag=dsync
+$rpc_py stop_nbd_disk /dev/nbd0
+
+# Force kill bdev service (dirty shutdown) and start it again
+kill -9 $svcpid
+rm -f /dev/shm/spdk_tgt_trace.pid$svcpid
+# TODO Adapt this after waitforlisten is expanded
+sleep 5
+
+$rootdir/app/spdk_tgt/spdk_tgt & svcpid=$!
+# Wait until spdk_tgt starts
+waitforlisten $svcpid
+
+# Ftl should recover, though with a loss of data (-o config option)
+$rpc_py load_config < $testdir/config/ftl.json
+
+# Without persistent cache, first batch of data should be recoverable
+dd if=/dev/nbd0 bs=4K count=$(($band_size - $chunk_size)) | md5sum -c $testdir/testfile.md5
+dd if=/dev/nbd0 of=$testdir/testblock bs=4k count=$additional_blocks skip=$band_size
+# Last 4k blocks should be on second band, and return as 0s
+dd if=/dev/zero of=$testdir/empty bs=4k count=$additional_blocks
+cmp $testdir/empty $testdir/testblock
+
+report_test_completion ftl_dirty_shutdown
+
+trap - SIGINT SIGTERM EXIT
+restore_kill
diff --git a/test/ftl/ftl.sh b/test/ftl/ftl.sh
index 3a8579406..1723d269e 100755
--- a/test/ftl/ftl.sh
+++ b/test/ftl/ftl.sh
@@ -39,6 +39,10 @@ timing_enter restore
 run_test suite $testdir/restore.sh $device
 timing_exit restore
 
+timing_enter dirty_shutdown
+run_test suite $testdir/dirty_shutdown.sh $device
+timing_exit dirty_shutdown
+
 timing_enter json
 run_test suite $testdir/json.sh $device
 timing_exit json