[PATCH v2 1/2] fstests: Add more sanity to seek_sanity_test

[PATCH v2 1/2] fstests: Add more sanity to seek_sanity_test

[Amir Goldstein]

seek_sanity_test checks for one of several SEEK_DATA/HOLE
behaviors and allows for the default behavior of filesystems,
where SEEK_HOLE always returns EOF.

This means that if filesystem has a regression in finding
holes, the sanity test won't catch it. And indeed this regression
happened in overlayfs on kernel v4.19 and went unnoticed.

To improve test coverage, add a flag -f to seek_sanity_test to
indicate that the default behavior is not acceptable.
Whitelist all filesystem types that are expected to detect holes
and use wrapper when invoking seek_sanity_test to add the -f flag
to those filesystems.

Overlayfs inherits expected behavior from base fs type.

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
---

Eryu,

After this change, the generic/seek group tests will start
failing with overlayfs over base fs with true SEEK_HOLE support
on upstream kernel.

We had missing coverage of SEEK_HOLE, so we missed a regression
in kernel v4.19 when overlayfs SEEK_HOLE stopped finding holes
in sparse files.

Thanks,
Amir.

Changes since v1:
- Use whitelist of filesystems types that support true SEEK_HOLE
  instead of inferring SEEK_HOLE support from PUNCH_HOLE support
- Split from patch of new PUNCH_HOLE+SEEK_HOLE test

 common/rc              | 46 ++++++++++++++++++++++++++++++++++++++++++
 src/seek_sanity_test.c | 14 +++++++++++--
 tests/generic/285      |  2 +-
 tests/generic/436      |  2 +-
 tests/generic/445      |  2 +-
 tests/generic/448      |  2 +-
 tests/generic/490      |  2 +-
 7 files changed, 63 insertions(+), 7 deletions(-)

diff --git a/common/rc b/common/rc
index c88c304c..d2482c20 100644
--- a/common/rc
+++ b/common/rc
@@ -2298,6 +2298,52 @@ _ext4_disable_extent_zeroout()
 		echo 0 >/sys/fs/ext4/$sdev/extent_max_zeroout_kb
 }
 
+# Is this filesystem type expected to support seeking and finding holes?
+# filesystems without SEEK_HOLE support, accept the SEEK_HOLE argument,
+# but always return EOF offset for SEEK_HOLE.
+# We use this whitelist FSTYP, to set expectation and avoid silent
+# regression of filesystem seek hole behavior.
+#
+# Return 0 for true
+_fstyp_support_seek_data_hole()
+{
+	if [ -z $1 ]; then
+		local fstyp=$FSTYP
+	else
+		local fstyp=$1
+	fi
+
+	case "$fstyp" in
+	btrfs|ext4|xfs|ceph|cifs|f2fs|gfs2|nfs*|ocfs2|tmpfs)
+		return 0
+		;;
+	overlay)
+		if [ ! -z $OVL_BASE_FSTYP -a $OVL_BASE_FSTYP != "overlay" ]; then
+			_fstyp_support_seek_data_hole $OVL_BASE_FSTYP
+			return $?
+		else
+			# Do not assume that base fs supports SEEK_HOLE
+			return 1
+		fi
+		;;
+	*)
+		# by default fstyp does not support SEEK_HOLE;
+		# if your fs does support SEEK_HOLE, add it to whitelist above!
+		return 1
+		;;
+	esac
+}
+
+# Run seek sanity test with predefined expectation for SEEK_DATA/HOLE behavior
+_run_seek_sanity_test()
+{
+	local testseekargs
+	if _fstyp_support_seek_data_hole; then
+		testseekargs+="-f"
+	fi
+	$here/src/seek_sanity_test $testseekargs $*
+}
+
 # Check if the file system supports seek_data/hole
 _require_seek_data_hole()
 {
diff --git a/src/seek_sanity_test.c b/src/seek_sanity_test.c
index e9938d1b..1eefc74d 100644
--- a/src/seek_sanity_test.c
+++ b/src/seek_sanity_test.c
@@ -23,6 +23,7 @@
 #endif
 
 static blksize_t alloc_size;
+int allow_default_behavior = 1;
 int default_behavior = 0;
 int unwritten_extents = 0;
 char *base_file_path;
@@ -1115,6 +1116,12 @@ static int test_basic_support(void)
 	}
 
 	if (pos == filsz) {
+		if (!allow_default_behavior) {
+			fprintf(stderr, "File syste does not support llseek(2) extension "
+				"SEEK_HOLE. Aborting.\n");
+			ret = -1;
+			goto out;
+		}
 		default_behavior = 1;
 		fprintf(stderr, "File system supports the default behavior.\n");
 	}
@@ -1148,7 +1155,7 @@ out:
 
 void usage(char *cmd)
 {
-	fprintf(stdout, "Usage: %s [-t] [-s <starttest>] [-e <endtest>] base_file_path\n", cmd);
+	fprintf(stdout, "Usage: %s [-tf] [-s <starttest>] [-e <endtest>] base_file_path\n", cmd);
 	exit(1);
 }
 
@@ -1169,11 +1176,14 @@ int main(int argc, char **argv)
 	teststart = 1;
 	testend = 12;
 
-	while ((opt = getopt(argc, argv, "ts:e:")) != -1) {
+	while ((opt = getopt(argc, argv, "tfs:e:")) != -1) {
 		switch (opt) {
 		case 't':
 			check_support++;
 			break;
+		case 'f':
+			allow_default_behavior = 0;
+			break;
 		case 's':
 			teststart = strtol(optarg, NULL, 10);
 			if (teststart <= 0 || teststart > numtests) {
diff --git a/tests/generic/285 b/tests/generic/285
index b53b3acc..20e89e5b 100755
--- a/tests/generic/285
+++ b/tests/generic/285
@@ -37,7 +37,7 @@ _cleanup()
 	eval "rm -f $BASE_TEST_FILE.*"
 }
 
-$here/src/seek_sanity_test $BASE_TEST_FILE > $seqres.full 2>&1 ||
+_run_seek_sanity_test $BASE_TEST_FILE > $seqres.full 2>&1 ||
 	_fail "seek sanity check failed!"
 
 # success, all done
diff --git a/tests/generic/436 b/tests/generic/436
index a3ef70e5..ada60b2e 100755
--- a/tests/generic/436
+++ b/tests/generic/436
@@ -36,7 +36,7 @@ _cleanup()
 	rm -f $tmp.* $BASE_TEST_FILE.*
 }
 
-$here/src/seek_sanity_test -s 13 -e 16 $BASE_TEST_FILE > $seqres.full 2>&1 ||
+_run_seek_sanity_test -s 13 -e 16 $BASE_TEST_FILE > $seqres.full 2>&1 ||
 	_fail "seek sanity check failed!"
 
 # success, all done
diff --git a/tests/generic/445 b/tests/generic/445
index 694913ae..248f321b 100755
--- a/tests/generic/445
+++ b/tests/generic/445
@@ -36,7 +36,7 @@ _cleanup()
 	rm -f $tmp.* $BASE_TEST_FILE.*
 }
 
-$here/src/seek_sanity_test -s 17 -e 17 $BASE_TEST_FILE > $seqres.full 2>&1 ||
+_run_seek_sanity_test -s 17 -e 17 $BASE_TEST_FILE > $seqres.full 2>&1 ||
 	_fail "seek sanity check failed!"
 
 # success, all done
diff --git a/tests/generic/448 b/tests/generic/448
index d3ec5528..dada499b 100755
--- a/tests/generic/448
+++ b/tests/generic/448
@@ -34,7 +34,7 @@ BASE_TEST_FILE=$TEST_DIR/seek_sanity_testfile_$seq
 
 _require_test_program "seek_sanity_test"
 
-$here/src/seek_sanity_test -s 18 -e 18 $BASE_TEST_FILE > $seqres.full 2>&1 ||
+_run_seek_sanity_test -s 18 -e 18 $BASE_TEST_FILE > $seqres.full 2>&1 ||
 	_fail "seek sanity check failed!"
 
 _check_dmesg
diff --git a/tests/generic/490 b/tests/generic/490
index 330c2b60..07b08939 100755
--- a/tests/generic/490
+++ b/tests/generic/490
@@ -39,7 +39,7 @@ _cleanup()
 	rm -f $base_test_file*
 }
 
-$here/src/seek_sanity_test -s 19 -e 20 $base_test_file > $seqres.full 2>&1 ||
+_run_seek_sanity_test -s 19 -e 20 $base_test_file > $seqres.full 2>&1 ||
 	_fail "seek sanity check failed!"
 
 # success, all done
-- 
2.17.1

[PATCH v2 2/2] generic: Test that SEEK_HOLE can find a punched hole

[Amir Goldstein]

Added a test case to seek_sanity_test and a test to run it.

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
---

Changes since v1:
- Punch hole requirement independent of SEEK_HOLE behavior.

 src/seek_sanity_test.c | 58 +++++++++++++++++++++++++++++++++++++++---
 tests/generic/999      | 44 ++++++++++++++++++++++++++++++++
 tests/generic/999.out  |  1 +
 tests/generic/group    |  1 +
 4 files changed, 100 insertions(+), 4 deletions(-)
 create mode 100755 tests/generic/999
 create mode 100644 tests/generic/999.out

diff --git a/src/seek_sanity_test.c b/src/seek_sanity_test.c
index 1eefc74d..7da4448f 100644
--- a/src/seek_sanity_test.c
+++ b/src/seek_sanity_test.c
@@ -16,6 +16,7 @@
 #include <unistd.h>
 #include <stdlib.h>
 #include <assert.h>
+#include "global.h"
 
 #ifndef SEEK_DATA
 #define SEEK_DATA      3
@@ -26,6 +27,7 @@ static blksize_t alloc_size;
 int allow_default_behavior = 1;
 int default_behavior = 0;
 int unwritten_extents = 0;
+int punch_hole = 0;
 char *base_file_path;
 
 static void get_file_system(int fd)
@@ -118,8 +120,9 @@ static int do_fallocate(int fd, off_t offset, off_t length, int mode)
 
 	ret = fallocate(fd, mode, offset, length);
 	if (ret)
-		fprintf(stderr, "  ERROR %d: Failed to preallocate "
-			"space to %ld bytes\n", errno, (long) length);
+		fprintf(stderr, "  ERROR %d: Failed to %s of %ld bytes\n",
+			errno, (mode & FALLOC_FL_PUNCH_HOLE) ? "punch hole" :
+			"preallocate space", (long) length);
 
 	return ret;
 }
@@ -262,6 +265,47 @@ out:
 	return ret;
 }
 
+/*
+ * Make sure hole size is properly reported when punched in the middle of a file
+ */
+static int test21(int fd, int testnum)
+{
+	char *buf = NULL;
+	int bufsz, filsz;
+	int ret = 0;
+
+	if (!punch_hole) {
+		fprintf(stdout, "Test skipped as fs doesn't support punch hole.\n");
+		goto out;
+	}
+
+	bufsz = alloc_size * 3;
+	buf = do_malloc(bufsz);
+	if (!buf) {
+		ret = -1;
+		goto out;
+	}
+	memset(buf, 'a', bufsz);
+
+	ret = do_pwrite(fd, buf, bufsz, 0);
+	if (ret)
+		goto out;
+
+	filsz = bufsz;
+	ret = do_fallocate(fd, alloc_size, alloc_size,
+			   FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE);
+	if (ret < 0)
+		goto out;
+
+	ret += do_lseek(testnum, 1, fd, filsz, SEEK_DATA, 0, 0);
+	ret += do_lseek(testnum, 2, fd, filsz, SEEK_HOLE, 0, alloc_size);
+	ret += do_lseek(testnum, 3, fd, filsz, SEEK_DATA, alloc_size, alloc_size * 2);
+out:
+	if (buf)
+		free(buf);
+	return ret;
+}
+
 /*
  * Make sure hole size is properly reported when starting in the middle of a
  * hole in ext? doubly indirect tree
@@ -1050,6 +1094,7 @@ struct testrec seek_tests[] = {
        { 18, test18, "Test file with negative SEEK_{HOLE,DATA} offsets" },
        { 19, test19, "Test file SEEK_DATA from middle of a large hole" },
        { 20, test20, "Test file SEEK_DATA from middle of a huge hole" },
+       { 21, test21, "Test file SEEK_HOLE that was created by PUNCH_HOLE" },
 };
 
 static int run_test(struct testrec *tr)
@@ -1127,15 +1172,20 @@ static int test_basic_support(void)
 	}
 
 	ftruncate(fd, 0);
-	if (fallocate(fd, 0, 0, alloc_size) == -1) {
+	if (fallocate(fd, 0, 0, alloc_size * 2) == -1) {
 		if (errno == EOPNOTSUPP)
-			fprintf(stderr, "File system does not support fallocate.");
+			fprintf(stderr, "File system does not support fallocate.\n");
 		else {
 			fprintf(stderr, "ERROR %d: Failed to preallocate "
 				"space to %ld bytes. Aborting.\n", errno, (long) alloc_size);
 			ret = -1;
 		}
 		goto out;
+	} else if (fallocate(fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
+			     0, alloc_size) == -1) {
+		fprintf(stderr, "File system does not support punch hole.\n");
+	} else {
+		punch_hole = 1;
 	}
 
 	pos = lseek(fd, 0, SEEK_DATA);
diff --git a/tests/generic/999 b/tests/generic/999
new file mode 100755
index 00000000..d8565041
--- /dev/null
+++ b/tests/generic/999
@@ -0,0 +1,44 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (C) 2019, CTERA Networks.  All Rights Reserved.
+#
+# FS QA Test No. 999
+#
+# Check that SEEK_HOLE can find a punched hole.
+#
+seq=`basename $0`
+seqres=$RESULT_DIR/$seq
+echo "QA output created by $seq"
+
+here=`pwd`
+tmp=/tmp/$$
+status=1	# failure is the default!
+trap "_cleanup; exit \$status" 0 1 2 3 15
+
+# get standard environment, filters and checks
+. ./common/rc
+
+_supported_fs generic
+_supported_os Linux
+
+_require_test
+_require_seek_data_hole
+_require_xfs_io_command "fpunch"
+
+base_test_file=$TEST_DIR/seek_sanity_testfile.$seq
+
+_require_test_program "seek_sanity_test"
+
+_cleanup()
+{
+	cd /
+	rm -f $tmp.*
+	rm -f $base_test_file*
+}
+
+_run_seek_sanity_test -s 21 -e 21 $base_test_file > $seqres.full 2>&1 ||
+	_fail "seek sanity check failed!"
+
+# success, all done
+status=0
+exit
diff --git a/tests/generic/999.out b/tests/generic/999.out
new file mode 100644
index 00000000..7fbc6768
--- /dev/null
+++ b/tests/generic/999.out
@@ -0,0 +1 @@
+QA output created by 999
diff --git a/tests/generic/group b/tests/generic/group
index 15227b67..14ac9b2c 100644
--- a/tests/generic/group
+++ b/tests/generic/group
@@ -534,3 +534,4 @@
 529 auto quick attr
 530 auto quick unlink
 531 auto quick unlink
+999 auto quick punch seek
-- 
2.17.1

Re: [PATCH v2 1/2] fstests: Add more sanity to seek_sanity_test

[Eryu Guan]

On Sun, Mar 03, 2019 at 05:09:39PM +0200, Amir Goldstein wrote:
> seek_sanity_test checks for one of several SEEK_DATA/HOLE
> behaviors and allows for the default behavior of filesystems,
> where SEEK_HOLE always returns EOF.
> 
> This means that if filesystem has a regression in finding
> holes, the sanity test won't catch it. And indeed this regression
> happened in overlayfs on kernel v4.19 and went unnoticed.
> 
> To improve test coverage, add a flag -f to seek_sanity_test to
> indicate that the default behavior is not acceptable.
> Whitelist all filesystem types that are expected to detect holes
> and use wrapper when invoking seek_sanity_test to add the -f flag
> to those filesystems.
> 
> Overlayfs inherits expected behavior from base fs type.
> 
> Signed-off-by: Amir Goldstein <amir73il@gmail.com>
> ---
> 
> Eryu,
> 
> After this change, the generic/seek group tests will start
> failing with overlayfs over base fs with true SEEK_HOLE support
> on upstream kernel.
> 
> We had missing coverage of SEEK_HOLE, so we missed a regression
> in kernel v4.19 when overlayfs SEEK_HOLE stopped finding holes
> in sparse files.
> 
> Thanks,
> Amir.
> 
> Changes since v1:
> - Use whitelist of filesystems types that support true SEEK_HOLE
>   instead of inferring SEEK_HOLE support from PUNCH_HOLE support
> - Split from patch of new PUNCH_HOLE+SEEK_HOLE test
> 
>  common/rc              | 46 ++++++++++++++++++++++++++++++++++++++++++
>  src/seek_sanity_test.c | 14 +++++++++++--
>  tests/generic/285      |  2 +-
>  tests/generic/436      |  2 +-
>  tests/generic/445      |  2 +-
>  tests/generic/448      |  2 +-
>  tests/generic/490      |  2 +-
>  7 files changed, 63 insertions(+), 7 deletions(-)
> 
> diff --git a/common/rc b/common/rc
> index c88c304c..d2482c20 100644
> --- a/common/rc
> +++ b/common/rc
> @@ -2298,6 +2298,52 @@ _ext4_disable_extent_zeroout()
>  		echo 0 >/sys/fs/ext4/$sdev/extent_max_zeroout_kb
>  }
>  
> +# Is this filesystem type expected to support seeking and finding holes?
> +# filesystems without SEEK_HOLE support, accept the SEEK_HOLE argument,
> +# but always return EOF offset for SEEK_HOLE.
> +# We use this whitelist FSTYP, to set expectation and avoid silent
> +# regression of filesystem seek hole behavior.

I don't think this description is that accurate, we're not checking if
the fs supports SEEK_HOLE or not, but checking if it supports
non-default behavior of SEEK_HOLE, where SEEK_HOLE always returns EOF.

> +#
> +# Return 0 for true
> +_fstyp_support_seek_data_hole()

So I think the function should be renamed too, but I couldn't come up
with a better name.. _fstyp_has_non_default_seek_data_hole ?

> +{
> +	if [ -z $1 ]; then
> +		local fstyp=$FSTYP
> +	else
> +		local fstyp=$1
> +	fi
> +
> +	case "$fstyp" in
> +	btrfs|ext4|xfs|ceph|cifs|f2fs|gfs2|nfs*|ocfs2|tmpfs)
> +		return 0
> +		;;
> +	overlay)
> +		if [ ! -z $OVL_BASE_FSTYP -a $OVL_BASE_FSTYP != "overlay" ]; then
> +			_fstyp_support_seek_data_hole $OVL_BASE_FSTYP
> +			return $?
> +		else
> +			# Do not assume that base fs supports SEEK_HOLE
> +			return 1
> +		fi
> +		;;
> +	*)
> +		# by default fstyp does not support SEEK_HOLE;
> +		# if your fs does support SEEK_HOLE, add it to whitelist above!
> +		return 1
> +		;;
> +	esac
> +}
> +
> +# Run seek sanity test with predefined expectation for SEEK_DATA/HOLE behavior
> +_run_seek_sanity_test()
> +{
> +	local testseekargs
> +	if _fstyp_support_seek_data_hole; then
> +		testseekargs+="-f"
> +	fi
> +	$here/src/seek_sanity_test $testseekargs $*
> +}
> +
>  # Check if the file system supports seek_data/hole
>  _require_seek_data_hole()
>  {
> diff --git a/src/seek_sanity_test.c b/src/seek_sanity_test.c
> index e9938d1b..1eefc74d 100644
> --- a/src/seek_sanity_test.c
> +++ b/src/seek_sanity_test.c
> @@ -23,6 +23,7 @@
>  #endif
>  
>  static blksize_t alloc_size;
> +int allow_default_behavior = 1;
>  int default_behavior = 0;
>  int unwritten_extents = 0;
>  char *base_file_path;
> @@ -1115,6 +1116,12 @@ static int test_basic_support(void)
>  	}
>  
>  	if (pos == filsz) {
> +		if (!allow_default_behavior) {
> +			fprintf(stderr, "File syste does not support llseek(2) extension "
                                              ^^^^^ system
> +				"SEEK_HOLE. Aborting.\n");
> +			ret = -1;
> +			goto out;
> +		}

I'd prefer putting this check after the checking 'default_behavior'
block.

>  		default_behavior = 1;
>  		fprintf(stderr, "File system supports the default behavior.\n");
>  	}

i.e. here:

	if (default_behavior && !allow_default_behavior) {
		fprintf(stderr, "Default behavior is not allowed. Aborting.\n");
		ret = -1;
		got out;
	}

Thanks,
Eryu

> @@ -1148,7 +1155,7 @@ out:
>  
>  void usage(char *cmd)
>  {
> -	fprintf(stdout, "Usage: %s [-t] [-s <starttest>] [-e <endtest>] base_file_path\n", cmd);
> +	fprintf(stdout, "Usage: %s [-tf] [-s <starttest>] [-e <endtest>] base_file_path\n", cmd);
>  	exit(1);
>  }
>  
> @@ -1169,11 +1176,14 @@ int main(int argc, char **argv)
>  	teststart = 1;
>  	testend = 12;
>  
> -	while ((opt = getopt(argc, argv, "ts:e:")) != -1) {
> +	while ((opt = getopt(argc, argv, "tfs:e:")) != -1) {
>  		switch (opt) {
>  		case 't':
>  			check_support++;
>  			break;
> +		case 'f':
> +			allow_default_behavior = 0;
> +			break;
>  		case 's':
>  			teststart = strtol(optarg, NULL, 10);
>  			if (teststart <= 0 || teststart > numtests) {
> diff --git a/tests/generic/285 b/tests/generic/285
> index b53b3acc..20e89e5b 100755
> --- a/tests/generic/285
> +++ b/tests/generic/285
> @@ -37,7 +37,7 @@ _cleanup()
>  	eval "rm -f $BASE_TEST_FILE.*"
>  }
>  
> -$here/src/seek_sanity_test $BASE_TEST_FILE > $seqres.full 2>&1 ||
> +_run_seek_sanity_test $BASE_TEST_FILE > $seqres.full 2>&1 ||
>  	_fail "seek sanity check failed!"
>  
>  # success, all done
> diff --git a/tests/generic/436 b/tests/generic/436
> index a3ef70e5..ada60b2e 100755
> --- a/tests/generic/436
> +++ b/tests/generic/436
> @@ -36,7 +36,7 @@ _cleanup()
>  	rm -f $tmp.* $BASE_TEST_FILE.*
>  }
>  
> -$here/src/seek_sanity_test -s 13 -e 16 $BASE_TEST_FILE > $seqres.full 2>&1 ||
> +_run_seek_sanity_test -s 13 -e 16 $BASE_TEST_FILE > $seqres.full 2>&1 ||
>  	_fail "seek sanity check failed!"
>  
>  # success, all done
> diff --git a/tests/generic/445 b/tests/generic/445
> index 694913ae..248f321b 100755
> --- a/tests/generic/445
> +++ b/tests/generic/445
> @@ -36,7 +36,7 @@ _cleanup()
>  	rm -f $tmp.* $BASE_TEST_FILE.*
>  }
>  
> -$here/src/seek_sanity_test -s 17 -e 17 $BASE_TEST_FILE > $seqres.full 2>&1 ||
> +_run_seek_sanity_test -s 17 -e 17 $BASE_TEST_FILE > $seqres.full 2>&1 ||
>  	_fail "seek sanity check failed!"
>  
>  # success, all done
> diff --git a/tests/generic/448 b/tests/generic/448
> index d3ec5528..dada499b 100755
> --- a/tests/generic/448
> +++ b/tests/generic/448
> @@ -34,7 +34,7 @@ BASE_TEST_FILE=$TEST_DIR/seek_sanity_testfile_$seq
>  
>  _require_test_program "seek_sanity_test"
>  
> -$here/src/seek_sanity_test -s 18 -e 18 $BASE_TEST_FILE > $seqres.full 2>&1 ||
> +_run_seek_sanity_test -s 18 -e 18 $BASE_TEST_FILE > $seqres.full 2>&1 ||
>  	_fail "seek sanity check failed!"
>  
>  _check_dmesg
> diff --git a/tests/generic/490 b/tests/generic/490
> index 330c2b60..07b08939 100755
> --- a/tests/generic/490
> +++ b/tests/generic/490
> @@ -39,7 +39,7 @@ _cleanup()
>  	rm -f $base_test_file*
>  }
>  
> -$here/src/seek_sanity_test -s 19 -e 20 $base_test_file > $seqres.full 2>&1 ||
> +_run_seek_sanity_test -s 19 -e 20 $base_test_file > $seqres.full 2>&1 ||
>  	_fail "seek sanity check failed!"
>  
>  # success, all done
> -- 
> 2.17.1
> 

Re: [PATCH v2 2/2] generic: Test that SEEK_HOLE can find a punched hole

[Eryu Guan]

On Sun, Mar 03, 2019 at 05:09:40PM +0200, Amir Goldstein wrote:
> Added a test case to seek_sanity_test and a test to run it.
> 
> Signed-off-by: Amir Goldstein <amir73il@gmail.com>
> ---
> 
> Changes since v1:
> - Punch hole requirement independent of SEEK_HOLE behavior.
> 
>  src/seek_sanity_test.c | 58 +++++++++++++++++++++++++++++++++++++++---
>  tests/generic/999      | 44 ++++++++++++++++++++++++++++++++
>  tests/generic/999.out  |  1 +
>  tests/generic/group    |  1 +
>  4 files changed, 100 insertions(+), 4 deletions(-)
>  create mode 100755 tests/generic/999
>  create mode 100644 tests/generic/999.out
> 
> diff --git a/src/seek_sanity_test.c b/src/seek_sanity_test.c
> index 1eefc74d..7da4448f 100644
> --- a/src/seek_sanity_test.c
> +++ b/src/seek_sanity_test.c
> @@ -16,6 +16,7 @@
>  #include <unistd.h>
>  #include <stdlib.h>
>  #include <assert.h>
> +#include "global.h"
>  
>  #ifndef SEEK_DATA
>  #define SEEK_DATA      3
> @@ -26,6 +27,7 @@ static blksize_t alloc_size;
>  int allow_default_behavior = 1;
>  int default_behavior = 0;
>  int unwritten_extents = 0;
> +int punch_hole = 0;
>  char *base_file_path;
>  
>  static void get_file_system(int fd)
> @@ -118,8 +120,9 @@ static int do_fallocate(int fd, off_t offset, off_t length, int mode)
>  
>  	ret = fallocate(fd, mode, offset, length);
>  	if (ret)
> -		fprintf(stderr, "  ERROR %d: Failed to preallocate "
> -			"space to %ld bytes\n", errno, (long) length);
> +		fprintf(stderr, "  ERROR %d: Failed to %s of %ld bytes\n",
> +			errno, (mode & FALLOC_FL_PUNCH_HOLE) ? "punch hole" :
> +			"preallocate space", (long) length);
>  
>  	return ret;
>  }
> @@ -262,6 +265,47 @@ out:
>  	return ret;
>  }
>  
> +/*
> + * Make sure hole size is properly reported when punched in the middle of a file
> + */
> +static int test21(int fd, int testnum)
> +{
> +	char *buf = NULL;
> +	int bufsz, filsz;
> +	int ret = 0;
> +
> +	if (!punch_hole) {
> +		fprintf(stdout, "Test skipped as fs doesn't support punch hole.\n");
> +		goto out;
> +	}

Skip test if default_behavior is true? It's not necessary, but I think
it makes the test more clear about testing non-default behavior.

Thanks,
Eryu

> +
> +	bufsz = alloc_size * 3;
> +	buf = do_malloc(bufsz);
> +	if (!buf) {
> +		ret = -1;
> +		goto out;
> +	}
> +	memset(buf, 'a', bufsz);
> +
> +	ret = do_pwrite(fd, buf, bufsz, 0);
> +	if (ret)
> +		goto out;
> +
> +	filsz = bufsz;
> +	ret = do_fallocate(fd, alloc_size, alloc_size,
> +			   FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE);
> +	if (ret < 0)
> +		goto out;
> +
> +	ret += do_lseek(testnum, 1, fd, filsz, SEEK_DATA, 0, 0);
> +	ret += do_lseek(testnum, 2, fd, filsz, SEEK_HOLE, 0, alloc_size);
> +	ret += do_lseek(testnum, 3, fd, filsz, SEEK_DATA, alloc_size, alloc_size * 2);
> +out:
> +	if (buf)
> +		free(buf);
> +	return ret;
> +}
> +
>  /*
>   * Make sure hole size is properly reported when starting in the middle of a
>   * hole in ext? doubly indirect tree
> @@ -1050,6 +1094,7 @@ struct testrec seek_tests[] = {
>         { 18, test18, "Test file with negative SEEK_{HOLE,DATA} offsets" },
>         { 19, test19, "Test file SEEK_DATA from middle of a large hole" },
>         { 20, test20, "Test file SEEK_DATA from middle of a huge hole" },
> +       { 21, test21, "Test file SEEK_HOLE that was created by PUNCH_HOLE" },
>  };
>  
>  static int run_test(struct testrec *tr)
> @@ -1127,15 +1172,20 @@ static int test_basic_support(void)
>  	}
>  
>  	ftruncate(fd, 0);
> -	if (fallocate(fd, 0, 0, alloc_size) == -1) {
> +	if (fallocate(fd, 0, 0, alloc_size * 2) == -1) {
>  		if (errno == EOPNOTSUPP)
> -			fprintf(stderr, "File system does not support fallocate.");
> +			fprintf(stderr, "File system does not support fallocate.\n");
>  		else {
>  			fprintf(stderr, "ERROR %d: Failed to preallocate "
>  				"space to %ld bytes. Aborting.\n", errno, (long) alloc_size);
>  			ret = -1;
>  		}
>  		goto out;
> +	} else if (fallocate(fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
> +			     0, alloc_size) == -1) {
> +		fprintf(stderr, "File system does not support punch hole.\n");
> +	} else {
> +		punch_hole = 1;
>  	}
>  
>  	pos = lseek(fd, 0, SEEK_DATA);
> diff --git a/tests/generic/999 b/tests/generic/999
> new file mode 100755
> index 00000000..d8565041
> --- /dev/null
> +++ b/tests/generic/999
> @@ -0,0 +1,44 @@
> +#! /bin/bash
> +# SPDX-License-Identifier: GPL-2.0
> +# Copyright (C) 2019, CTERA Networks.  All Rights Reserved.
> +#
> +# FS QA Test No. 999
> +#
> +# Check that SEEK_HOLE can find a punched hole.
> +#
> +seq=`basename $0`
> +seqres=$RESULT_DIR/$seq
> +echo "QA output created by $seq"
> +
> +here=`pwd`
> +tmp=/tmp/$$
> +status=1	# failure is the default!
> +trap "_cleanup; exit \$status" 0 1 2 3 15
> +
> +# get standard environment, filters and checks
> +. ./common/rc
> +
> +_supported_fs generic
> +_supported_os Linux
> +
> +_require_test
> +_require_seek_data_hole
> +_require_xfs_io_command "fpunch"
> +
> +base_test_file=$TEST_DIR/seek_sanity_testfile.$seq
> +
> +_require_test_program "seek_sanity_test"
> +
> +_cleanup()
> +{
> +	cd /
> +	rm -f $tmp.*
> +	rm -f $base_test_file*
> +}
> +
> +_run_seek_sanity_test -s 21 -e 21 $base_test_file > $seqres.full 2>&1 ||
> +	_fail "seek sanity check failed!"
> +
> +# success, all done
> +status=0
> +exit
> diff --git a/tests/generic/999.out b/tests/generic/999.out
> new file mode 100644
> index 00000000..7fbc6768
> --- /dev/null
> +++ b/tests/generic/999.out
> @@ -0,0 +1 @@
> +QA output created by 999
> diff --git a/tests/generic/group b/tests/generic/group
> index 15227b67..14ac9b2c 100644
> --- a/tests/generic/group
> +++ b/tests/generic/group
> @@ -534,3 +534,4 @@
>  529 auto quick attr
>  530 auto quick unlink
>  531 auto quick unlink
> +999 auto quick punch seek
> -- 
> 2.17.1
>