fstests: add support for working with dm-log-writes target

Cherry-picked the relevant common bits from commit 70d41e17164b
in Josef Bacik's fstests tree (https://github.com/josefbacik/fstests).
Quoting from Josef's commit message:

  This patch adds the supporting code for using the dm-log-writes
  target.  The dmlogwrites code is similar to the dmflakey code, it just
  gives us functions to build and tear down a dm-log-writes target.  We
  add a new LOGWRITES_DEV variable to take in the device we will use as
  the log and add checks for that.

[Amir:]
- Removed unneeded _test_falloc_support
- Moved _require_log_writes to dmlogwrites
- Document _require_log_writes
- Address review comments by Eryu Guan

Cc: Josef Bacik <jbacik@fb.com>
Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Reviewed-by: Eryu Guan <eguan@redhat.com>
Signed-off-by: Eryu Guan <eguan@redhat.com>

diff --git a/README b/README
index 9456fa76560bafaf03f50e7f5376b5131ee01a9a..4963d28d1aab08da6ac90392ae1ce382c75aefee 100644 (file)
--- a/README
+++ b/README
@@ -91,6 +91,8 @@ Preparing system for tests:
              - set TEST_XFS_SCRUB=1 to have _check_xfs_filesystem run
                xfs_scrub -vd to scrub the filesystem metadata online before
                unmounting to run the offline check.
              - set TEST_XFS_SCRUB=1 to have _check_xfs_filesystem run
                xfs_scrub -vd to scrub the filesystem metadata online before
                unmounting to run the offline check.

+             - setenv LOGWRITES_DEV to a block device to use for power fail
+               testing.

 
         - or add a case to the switch in common/config assigning
           these variables based on the hostname of your test
 
         - or add a case to the switch in common/config assigning
           these variables based on the hostname of your test

diff --git a/common/dmlogwrites b/common/dmlogwrites
new file mode 100644 (file)
index 0000000..247c744
--- /dev/null
+++ b/common/dmlogwrites
@@ -0,0 +1,90 @@
+##/bin/bash
+#
+# Copyright (c) 2015 Facebook, Inc.  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
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# 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
+#
+#
+# common functions for setting up and tearing down a dm log-writes device
+
+_require_log_writes()
+{
+       [ -z "$LOGWRITES_DEV" -o ! -b "$LOGWRITES_DEV" ] && \
+               _notrun "This test requires a valid \$LOGWRITES_DEV"
+
+       _exclude_scratch_mount_option dax
+       _require_dm_target log-writes
+       _require_test_program "log-writes/replay-log"
+}
+
+_log_writes_init()
+{
+       local BLK_DEV_SIZE=`blockdev --getsz $SCRATCH_DEV`
+       LOGWRITES_NAME=logwrites-test
+       LOGWRITES_DMDEV=/dev/mapper/$LOGWRITES_NAME
+       LOGWRITES_TABLE="0 $BLK_DEV_SIZE log-writes $SCRATCH_DEV $LOGWRITES_DEV"
+       $DMSETUP_PROG create $LOGWRITES_NAME --table "$LOGWRITES_TABLE" || \
+               _fail "failed to create log-writes device"
+       $DMSETUP_PROG mknodes > /dev/null 2>&1
+}
+
+_log_writes_mark()
+{
+       [ $# -ne 1 ] && _fail "_log_writes_mark takes one argument"
+       $DMSETUP_PROG message $LOGWRITES_NAME 0 mark $1
+}
+
+_log_writes_mkfs()
+{
+       _scratch_options mkfs
+       _mkfs_dev $SCRATCH_OPTIONS $LOGWRITES_DMDEV
+       _log_writes_mark mkfs
+}
+
+_log_writes_mount()
+{
+       _scratch_options mount
+       $MOUNT_PROG -t $FSTYP `_common_dev_mount_options $*` $SCRATCH_OPTIONS \
+               $LOGWRITES_DMDEV $SCRATCH_MNT
+}
+
+_log_writes_unmount()
+{
+       $UMOUNT_PROG $SCRATCH_MNT
+}
+
+# _log_writes_replay_log <mark>
+#
+# This replays the log contained on $LOGWRITES_DEV onto $SCRATCH_DEV upto the
+# mark passed in.
+_log_writes_replay_log()
+{
+       _mark=$1
+
+       $here/src/log-writes/replay-log --log $LOGWRITES_DEV --replay $SCRATCH_DEV \
+               --end-mark $_mark >> $seqres.full 2>&1
+       [ $? -ne 0 ] && _fail "replay failed"
+}
+
+_log_writes_remove()
+{
+       $DMSETUP_PROG remove $LOGWRITES_NAME > /dev/null 2>&1
+       $DMSETUP_PROG mknodes > /dev/null 2>&1
+}
+
+_log_writes_cleanup()
+{
+       $UMOUNT_PROG $SCRATCH_MNT > /dev/null 2>&1
+       _log_writes_remove
+}

diff --git a/doc/requirement-checking.txt b/doc/requirement-checking.txt
index 95d10e64495ec430a8ee8464111f4039271772fc..4e01b1f137848397e0972ab1369cb8b6f25a9fe1 100644 (file)
--- a/doc/requirement-checking.txt
+++ b/doc/requirement-checking.txt
@@ -21,6 +21,10 @@ they have.  This is done with _require_<xxx> macros, which may take parameters.
 
        _require_statx
 
 
        _require_statx
 

+ (4) Device mapper requirement.
+
+       _require_dm_target
+       _require_log_writes

 
 ====================
 GENERAL REQUIREMENTS
 
 ====================
 GENERAL REQUIREMENTS


@@ -102,3 +106,19 @@ _require_statx
 
      The test requires the use of the statx() system call and will be skipped
      if it isn't available in the kernel.
 
      The test requires the use of the statx() system call and will be skipped
      if it isn't available in the kernel.

+
+
+==========================
+DEVICE MAPPER REQUIREMENTS
+==========================
+
+_require_dm_target <name>
+
+     The test requires the use of the device mapper target and will be skipped
+     if it isn't available in the kernel.
+
+_require_log_writes
+
+     The test requires the use of the device mapper target log-writes.
+     The test also requires the test program log-writes/replay-log is built
+     and will be skipped if either isn't available.