tests: testcases for the offset handling in e2undo and undo_io.c

The testcase "u_offset" tests/defines e2undo's new UI and offset
handling code. The testcase "u_mke2fs_opt_offset" documents some
issues with undo_io.c's old offset handling code (e.g., backup of
fs block 0, key extension (tdb_data_size != block_size) etc.).

Signed-off-by: Marcus Huewe <suse-tux@gmx.de>
Signed-off-by: Theodore Ts'o <tytso@mit.edu>

diff --git a/tests/u_mke2fs_opt_offset/script b/tests/u_mke2fs_opt_offset/script
new file mode 100644 (file)
index 0000000..036b7b4
--- /dev/null
+++ b/tests/u_mke2fs_opt_offset/script
@@ -0,0 +1,104 @@
+test_description="e2undo and mke2fs with offset option"
+OUT="$test_name.log"
+TDB_FILE="$TMPFILE.e2undo"
+
+E2UNDO_FEATURE_COMPAT_OFFSET=1
+
+trap "rm -f $TDB_FILE" EXIT INT QUIT
+
+test_e2undo_mke2fs_off() {
+       OFF=$1
+
+       rm -f "$TDB_FILE"
+       echo "testing e2undo and mke2fs with the -E offset=$OFF option" >> "$OUT"
+       # prepare $TMPFILE
+       yes a | dd of="$TMPFILE" bs="$OFF" count=1 iflag=fullblock \
+               > /dev/null 2>>"$OUT"
+       yes b | dd bs=1k count=1024 iflag=fullblock >> "$TMPFILE" 2>>"$OUT"
+       yes c | dd bs=1k count=3 iflag=fullblock >> "$TMPFILE" 2>>"$OUT"
+
+       crc_exp=`$CRCSUM "$TMPFILE"`
+       $MKE2FS -F -z "$TDB_FILE" -b 1024 -E offset="$OFF" "$TMPFILE" 1024 \
+               >> "$OUT" 2>&1
+
+       # supplement test with offset specific data
+       supplement_test_$OFF
+
+       # dump undo header (just to ease debugging in case of a failure)
+       echo "undo header:" >> "$OUT"
+       $E2UNDO -h "$TDB_FILE" "$TMPFILE" >> "$OUT" 2>&1
+
+       # offset is stored in the undo header
+       $E2UNDO "$TDB_FILE" "$TMPFILE" >> "$OUT" 2>&1
+       crc_act=`$CRCSUM "$TMPFILE"`
+
+       # also test the key extension code path: the key for the fs block 960
+       # (tdb block 30) is extended by the fs block 992 (tdb block 31)
+       # => we have exactly 3 key blocks instead of 4
+       num_keys_exp=3
+       num_keys_act=`$E2UNDO -h "$TDB_FILE" "$TMPFILE" | grep "^nr keys:" \
+               | cut -f2`
+
+       offset_exp=$OFF
+       offset_act=`$E2UNDO -h "$TDB_FILE" "$TMPFILE" | grep "^fs offset:" \
+               | cut -f2`
+       compat_exp=$E2UNDO_FEATURE_COMPAT_OFFSET
+       compat_act=`$E2UNDO -h "$TDB_FILE" "$TMPFILE" | grep "^compat:" | cut -f3`
+
+       if [ "$crc_exp" != "$crc_act" -o \
+                "$num_keys_exp" != "$num_keys_act" -o \
+                "$offset_exp" != "$offset_act" -o \
+                $(($compat_act & $E2UNDO_FEATURE_COMPAT_OFFSET)) -ne $compat_exp ]
+                then
+               echo "mke2fs called with offset: $OFF" >> "$test_name.failed"
+               echo "crc_exp: $crc_exp" >> "$test_name.failed"
+               echo "crc_act: $crc_act" >> "$test_name.failed"
+               echo "num_keys_exp: $num_keys_exp" >> "$test_name.failed"
+               echo "num_keys_act: $num_keys_act" >> "$test_name.failed"
+               echo "offset_exp: $offset_exp" >> "$test_name.failed"
+               echo "offset_act: $offset_act" >> "$test_name.failed"
+               echo "compat_exp: $compat_exp" >> "$test_name.failed"
+               echo "compat_act: $compat_act" >> "$test_name.failed"
+               echo >> "$test_name.failed"
+       fi
+}
+
+supplement_test_2048() {
+       # modify the two subsequent 1k blocks (1026 and 1027) after the fs end:
+       # e2undo will overwrite these modified blocks with the old
+       # data again (this might be considered as a bug (for now,
+       # this testcase just documents this behavior))
+       SEEK_BLOCKS=$(((2048 + 1024 * 1024) / 1024))
+       yes d | dd of="$TMPFILE" bs=1k count=2 seek="$SEEK_BLOCKS" \
+               iflag=fullblock > /dev/null 2>>"$OUT"
+}
+
+supplement_test_96255() {
+       # nothing to supplement
+       :
+}
+
+# test even offset < tdb_data_size
+# with an offset of 2048 the old code wrote an incorrect undo file,
+# for example, the computations for fs block 0 were wrong:
+# * backing_blk_num was set to ULLONG_MAX - 1 instead of 0
+# * data was read from the beginning of the file instead of offset 2048
+# * data_ptr was set to read_ptr - 2048
+# for details, see the old undo_write_tdb code in undo_io.c
+test_e2undo_mke2fs_off 2048
+
+# test odd offset > tdb_data_size: 32768 * 3 - 2 * 1024 - 1
+# a somewhat arbitrary value, for example, during the backup of
+# fs block 0 such an offset resulted in:
+# * the largest "in fs block offset" (96255 % 1024 == 1023)
+# * a wrong value for data_size (actual bytes read: 31745)
+# * an invalid address for data_ptr
+# for details, see the old undo_write_tdb code in undo_io.c
+test_e2undo_mke2fs_off 96255
+
+if [ -e "$test_name.failed" ]; then
+       echo "$test_name: $test_description: failed"
+else
+       echo "$test_name: $test_description: ok"
+       touch "$test_name.ok"
+fi

diff --git a/tests/u_offset/script b/tests/u_offset/script
new file mode 100644 (file)
index 0000000..c3e03b7
--- /dev/null
+++ b/tests/u_offset/script
@@ -0,0 +1,138 @@
+test_description="e2undo with the offset option (-o offset)"
+OUT="$test_name.log"
+TMPFILE2="${TMPFILE}_2"
+TDB_FILE="$TMPFILE.e2undo"
+
+E2UNDO_FEATURE_COMPAT_OFFSET=1
+
+trap "rm -f $TMPFILE2 $TDB_FILE" EXIT INT QUIT
+
+read_header_entry() {
+       # $2 is just used as a dummy - it is never used by e2undo
+       # when dumping the header
+       $E2UNDO -h "$1" "$2" | grep "^$3:"
+}
+
+read_header_offset() {
+       read_header_entry "$TDB_FILE" "$TMPFILE" "fs offset" | cut -f2
+}
+
+read_header_compat() {
+       read_header_entry "$TDB_FILE" "$TMPFILE" "compat" | cut -f3
+}
+
+e2undo_offset_assert() {
+       if [ "$crc_exp" != "$crc_act" -o \
+                "$offset_exp" != "$offset_act" -o \
+                $(($compat_act & $E2UNDO_FEATURE_COMPAT_OFFSET)) -ne $compat_exp ]
+               then
+               echo "$1" >> "$test_name.failed"
+               echo "crc_exp: $crc_exp" >> "$test_name.failed"
+               echo "crc_act: $crc_act" >> "$test_name.failed"
+               echo "offset_exp: $offset_exp" >> "$test_name.failed"
+               echo "offset_act: $offset_act" >> "$test_name.failed"
+               echo "compat_exp: $compat_exp" >> "$test_name.failed"
+               echo "compat_act: $compat_act" >> "$test_name.failed"
+       fi
+}
+
+init_fs() {
+       echo "#" >> "$OUT"
+       echo "# init fs for $1" >> "$OUT"
+       echo "#" >> "$OUT"
+       rm -f "$TDB_FILE"
+       dd if=/dev/zero of="$TMPFILE" bs=1k count=1024 > /dev/null 2>&1
+       $MKE2FS -F -z "$TDB_FILE" -b 1024 -E offset=524288 "$TMPFILE" 512 \
+               >> "$OUT" 2>&1
+}
+
+#
+# test absence of the "-o N" option
+#
+test_e2undo_offset_no_option() {
+       init_fs "test_e2undo_offset_no_option"
+
+       $E2UNDO "$TDB_FILE" "$TMPFILE" >> "$OUT" 2>&1
+
+       crc_exp=`dd if=/dev/zero bs=1k count=1024 2>/dev/null | $CRCSUM`
+       crc_act=`$CRCSUM "$TMPFILE"`
+       offset_exp=524288
+       offset_act=`read_header_offset`
+       compat_exp=$E2UNDO_FEATURE_COMPAT_OFFSET
+       compat_act=`read_header_compat`
+       e2undo_offset_assert "test_e2undo_offset_no_option"
+}
+
+#
+# test removal of the offset feature in the undo header
+#
+test_e2undo_offset_no_option_remove_offset_header() {
+       init_fs "test_e2undo_offset_no_option_remove_offset_header"
+       dd if="$TMPFILE" of="$TMPFILE2" bs=1k count=512 skip=512 \
+               > /dev/null 2>&1
+       # offset feature will be removed from the undo header
+       $TUNE2FS -z "$TDB_FILE" -C 42 "$TMPFILE2" >> "$OUT" 2>&1
+
+       $E2UNDO "$TDB_FILE" "$TMPFILE2" >> "$OUT" 2>&1
+
+       crc_exp=`dd if=/dev/zero bs=1k count=512 2>/dev/null | $CRCSUM`
+       crc_act=`$CRCSUM "$TMPFILE2"`
+       offset_exp=
+       offset_act=`read_header_offset`
+       compat_exp=0
+       compat_act=`read_header_compat`
+       e2undo_offset_assert "test_e2undo_offset_no_option_remove_offset_header"
+}
+
+#
+# test "-o 4096"
+#
+test_e2undo_offset_4096() {
+       init_fs "test_e2undo_offset_4096"
+       dd if=/dev/zero of="$TMPFILE2" bs=1k count=4 > /dev/null 2>&1
+       dd if="$TMPFILE" of="$TMPFILE2" bs=1k count=512 skip=512 seek=4 \
+               > /dev/null 2>&1
+
+       $E2UNDO -o 4096 "$TDB_FILE" "$TMPFILE2" >> "$OUT" 2>&1
+
+       crc_exp=`dd if=/dev/zero bs=1k count=516 2>/dev/null | $CRCSUM`
+       crc_act=`$CRCSUM "$TMPFILE2"`
+       # the same as in test_e2undo_offset_no_option
+       offset_exp=524288
+       offset_act=`read_header_offset`
+       compat_exp=$E2UNDO_FEATURE_COMPAT_OFFSET
+       compat_act=`read_header_compat`
+       e2undo_offset_assert "test_e2undo_offset_4096"
+}
+
+#
+# test "-o 0"
+#
+test_e2undo_offset_0() {
+       init_fs "test_e2undo_offset_0"
+       dd if="$TMPFILE" of="$TMPFILE2" bs=1k count=512 skip=512 \
+               > /dev/null 2>&1
+
+       $E2UNDO -o 0 "$TDB_FILE" "$TMPFILE2" >> "$OUT" 2>&1
+
+       crc_exp=`dd if=/dev/zero bs=1k count=512 2>/dev/null | $CRCSUM`
+       crc_act=`$CRCSUM "$TMPFILE2"`
+       # the same as in test_e2undo_offset_no_option
+       offset_exp=524288
+       offset_act=`read_header_offset`
+       compat_exp=$E2UNDO_FEATURE_COMPAT_OFFSET
+       compat_act=`read_header_compat`
+       e2undo_offset_assert "test_e2undo_offset_0"
+}
+
+test_e2undo_offset_no_option
+test_e2undo_offset_no_option_remove_offset_header
+test_e2undo_offset_4096
+test_e2undo_offset_0
+
+if [ -e "$test_name.failed" ]; then
+       echo "$test_name: $test_description: failed"
+else
+       echo "$test_name: $test_description: ok"
+       touch "$test_name.ok"
+fi