xfstests: generic swap file tests

From: Omar Sandoval <[email protected]>

Swap files cannot have holes, and they must at least two pages. swapon(8) and mkswap(8) have stricter restrictions, so add versions of those commands without any restrictions.

Signed-off-by Omar Sandoval <[email protected]>

---
 .gitignore            |  2 ++
 src/Makefile          |  2 +-
 src/mkswap.c          | 83 +++++++++++++++++++++++++++++++++++++++++++
 src/swapon.c          | 24 +++++++++++++
 tests/generic/490     | 77 +++++++++++++++++++++++++++++++++++++++
 tests/generic/490.out |  5 +++
 tests/generic/group   |  1 +
 7 files changed, 193 insertions(+), 1 deletion(-)
 create mode 100644 src/mkswap.c
 create mode 100644 src/swapon.c
 create mode 100755 tests/generic/490
 create mode 100644 tests/generic/490.out

.gitignore +2 -0

index 53029e24..efc73a7c 100644
@@ -92,6 +92,7 @@
 /src/lstat64
 /src/makeextents
 /src/metaperf
+/src/mkswap
 /src/mmapcat
 /src/multi_open_unlink
 /src/nametest

@@ -111,6 +112,7 @@
 /src/seek_sanity_test
 /src/stale_handle
 /src/stat_test
+/src/swapon
 /src/t_access_root
 /src/t_dir_offset
 /src/t_dir_offset2

src/Makefile +1 -1

index c42d3bb1..01fe99ef 100644
@@ -26,7 +26,7 @@ LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	renameat2 t_getcwd e4compact test-nextquota punch-alternating \
 	attr-list-by-handle-cursor-test listxattr dio-interleaved t_dir_type \
 	dio-invalidate-cache stat_test t_encrypted_d_revalidate \
-	attr_replace_test
+	attr_replace_test swapon mkswap
 
 SUBDIRS = log-writes perf
 

src/mkswap.c new file +83 -0

new file mode 100644
index 00000000..d0bce2bd
@@ -0,0 +1,83 @@
+/* mkswap(8) without any sanity checks */
+
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+
+struct swap_header {
+	char		bootbits[1024];
+	uint32_t	version;
+	uint32_t	last_page;
+	uint32_t	nr_badpages;
+	unsigned char	sws_uuid[16];
+	unsigned char	sws_volume[16];
+	uint32_t	padding[117];
+	uint32_t	badpages[1];
+};
+
+int main(int argc, char **argv)
+{
+	struct swap_header *hdr;
+	FILE *file;
+	struct stat st;
+	long page_size;
+	int ret;
+
+	if (argc != 2) {
+		fprintf(stderr, "usage: %s PATH\n", argv[0]);
+		return EXIT_FAILURE;
+	}
+
+	page_size = sysconf(_SC_PAGESIZE);
+	if (page_size == -1) {
+		perror("sysconf");
+		return EXIT_FAILURE;
+	}
+
+	hdr = calloc(1, page_size);
+	if (!hdr) {
+		perror("calloc");
+		return EXIT_FAILURE;
+	}
+
+	file = fopen(argv[1], "r+");
+	if (!file) {
+		perror("fopen");
+		free(hdr);
+		return EXIT_FAILURE;
+	}
+
+	ret = fstat(fileno(file), &st);
+	if (ret) {
+		perror("fstat");
+		free(hdr);
+		fclose(file);
+		return EXIT_FAILURE;
+	}
+
+	hdr->version = 1;
+	hdr->last_page = st.st_size / page_size - 1;
+	memset(&hdr->sws_uuid, 0x99, sizeof(hdr->sws_uuid));
+	memcpy((char *)hdr + page_size - 10, "SWAPSPACE2", 10);
+
+	if (fwrite(hdr, page_size, 1, file) != 1) {
+		perror("fwrite");
+		free(hdr);
+		fclose(file);
+		return EXIT_FAILURE;
+	}
+
+	if (fclose(file) == EOF) {
+		perror("fwrite");
+		free(hdr);
+		return EXIT_FAILURE;
+	}
+
+	free(hdr);
+
+	return EXIT_SUCCESS;
+}

src/swapon.c new file +24 -0

new file mode 100644
index 00000000..0cb7108a
@@ -0,0 +1,24 @@
+/* swapon(8) without any sanity checks; simply calls swapon(2) directly. */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <sys/swap.h>
+
+int main(int argc, char **argv)
+{
+	int ret;
+
+	if (argc != 2) {
+		fprintf(stderr, "usage: %s PATH\n", argv[0]);
+		return EXIT_FAILURE;
+	}
+
+	ret = swapon(argv[1], 0);
+	if (ret) {
+		perror("swapon");
+		return EXIT_FAILURE;
+	}
+
+	return EXIT_SUCCESS;
+}

tests/generic/490 new file +49 -0

new file mode 100755
index 00000000..6ba2ecb3
@@ -0,0 +1,77 @@
+#! /bin/bash
+# FS QA Test 490
+#
+# Test invalid swap files.
+#
+#-----------------------------------------------------------------------
+# Copyright (c) 2018 Facebook.  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
+#-----------------------------------------------------------------------
+#
+
+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
+
+_cleanup()
+{
+	cd /
+	rm -f $tmp.*
+}
+
+# get standard environment, filters and checks
+. ./common/rc
+. ./common/filter
+
+# remove previous $seqres.full before test
+rm -f $seqres.full
+
+_supported_fs generic
+_supported_os Linux
+_require_scratch_swapfile
+_require_test_program mkswap

tests/generic/490 new file +18 -0

+chmod 0600 "$SCRATCH_MNT/swap"
+$XFS_IO_PROG -c "truncate $(($(get_page_size) * 10))" "$SCRATCH_MNT/swap"
+"$here/src/mkswap" "$SCRATCH_MNT/swap"
+"$here/src/swapon" "$SCRATCH_MNT/swap"
+swapoff "$SCRATCH_MNT/swap" >/dev/null 2>&1
+
+echo "Empty swap file (only swap header)"
+rm -f "$SCRATCH_MNT/swap"
+touch "$SCRATCH_MNT/swap"
+$CHATTR_PROG +C "$SCRATCH_MNT/swap"
+chmod 0600 "$SCRATCH_MNT/swap"
+_pwrite_byte 0x61 0 $(get_page_size) "$SCRATCH_MNT/swap" >> $seqres.full
+"$here/src/mkswap" "$SCRATCH_MNT/swap"
+"$here/src/swapon" "$SCRATCH_MNT/swap"
+swapoff "$SCRATCH_MNT/swap" >/dev/null 2>&1
+
+status=0
+exit

tests/generic/490.out new file +5 -0

new file mode 100644
index 00000000..96226c64
@@ -0,0 +1,5 @@
+QA output created by 490
+File with holes
+swapon: Invalid argument
+Empty swap file (only swap header)
+swapon: Invalid argument

tests/generic/group +1 -0

index a5252aeb..422e21e2 100644
@@ -492,3 +492,4 @@
 487 auto quick
 488 auto quick swap
 489 auto quick swap
+490 auto quick swap

Signature · 6 lines

2.17.0

--
To unsubscribe from this list: send the line "unsubscribe fstests" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

From: Omar Sandoval <[email protected]>

Commit 8c96cfbfe530 ("generic/35[67]: disable swapfile tests on Btrfs") disabled the swapfile tests on Btrfs because it did not support swapfiles at the time. Now that we're adding support, we want these

tests to run, but they don't. _require_scratch_swapfile always fails for Btrfs because swapfiles on Btrfs must be set to nocow. After fixing that, generic/356 and generic/357 fail for the same reason. After fixing _that_, both tests still fail because we don't allow reflinking a non-checksummed extent (which nocow implies) to a checksummed extent. Add a helper for formatting a swap file which does the chattr, and chattr the second file, which gets these tests running on kernels supporting Btrfs swapfiles.

Signed-off-by Omar Sandoval <[email protected]>

---
 common/rc         | 15 ++++++++++++---
 tests/generic/356 |  7 ++++---
 tests/generic/357 |  6 +++---
 3 files changed, 19 insertions(+), 9 deletions(-)

common/rc +0 -0

index ffe53236..814b8b5c 100644

common/rc +3 -3

+}
+
 # Check that the filesystem supports swapfiles
 _require_scratch_swapfile()
 {

@@ -2231,10 +2242,8 @@ _require_scratch_swapfile()
 	_scratch_mount
 
 	# Minimum size for mkswap is 10 pages
-	local size=$(($(get_page_size) * 10))
+	_format_swapfile "$SCRATCH_MNT/swap" $(($(get_page_size) * 10))
 
-	_pwrite_byte 0x61 0 "$size" "$SCRATCH_MNT/swap" >/dev/null 2>&1
-	mkswap "$SCRATCH_MNT/swap" >/dev/null 2>&1
 	if ! swapon "$SCRATCH_MNT/swap" >/dev/null 2>&1; then
 		_scratch_unmount
 		_notrun "swapfiles are not supported"

tests/generic/356 +4 -3

index 51eeb652..b4a38f84 100755
@@ -59,11 +59,12 @@ blocks=160
 blksz=65536
 
 echo "Initialize file"
-echo >> $seqres.full
-_pwrite_byte 0x61 0 $((blocks * blksz)) $testdir/file1 >> $seqres.full
-mkswap -U 27376b42-ff65-42ca-919f-6c9b62292a5c $testdir/file1 >> $seqres.full
+_format_swapfile "$testdir/file1" $((blocks * blksz))
 swapon $testdir/file1
 
+touch "$testdir/file2"
+$CHATTR_PROG +C "$testdir/file2" >/dev/null 2>&1
+
 echo "Try to reflink"
 _cp_reflink $testdir/file1 $testdir/file2 2>&1 | _filter_scratch
 

tests/generic/357 +3 -3

index 0dd0c10f..9a83a283 100755
@@ -59,9 +59,9 @@ blocks=160
 blksz=65536
 
 echo "Initialize file"
-echo >> $seqres.full
-_pwrite_byte 0x61 0 $((blocks * blksz)) $testdir/file1 >> $seqres.full
-mkswap -U 27376b42-ff65-42ca-919f-6c9b62292a5c $testdir/file1 >> $seqres.full
+_format_swapfile "$testdir/file1" $((blocks * blksz))
+touch "$testdir/file2"
+$CHATTR_PROG +C "$testdir/file2" >/dev/null 2>&1
 _cp_reflink $testdir/file1 $testdir/file2 2>&1 | _filter_scratch
 
 echo "Try to swapon"

Signature · 1 line

2.17.0

From: Omar Sandoval <[email protected]>

Similar to generic/356 that makes sure we can't reflink an active

Quoted 228 lines · Omar Sandoval

From: Omar Sandoval <[email protected]>

Swap files cannot have holes, and they must at least two pages. swapon(8) and mkswap(8) have stricter restrictions, so add versions of those commands without any restrictions.

Signed-off-by Omar Sandoval <[email protected]>

---
 .gitignore            |  2 ++
 src/Makefile          |  2 +-
 src/mkswap.c          | 83 +++++++++++++++++++++++++++++++++++++++++++
 src/swapon.c          | 24 +++++++++++++
 tests/generic/490     | 77 +++++++++++++++++++++++++++++++++++++++
 tests/generic/490.out |  5 +++
 tests/generic/group   |  1 +
 7 files changed, 193 insertions(+), 1 deletion(-)
 create mode 100644 src/mkswap.c
 create mode 100644 src/swapon.c
 create mode 100755 tests/generic/490
 create mode 100644 tests/generic/490.out

.gitignore +2 -0

index 53029e24..efc73a7c 100644
@@ -92,6 +92,7 @@
 /src/lstat64
 /src/makeextents
 /src/metaperf
+/src/mkswap
 /src/mmapcat
 /src/multi_open_unlink
 /src/nametest

@@ -111,6 +112,7 @@
 /src/seek_sanity_test
 /src/stale_handle
 /src/stat_test
+/src/swapon
 /src/t_access_root
 /src/t_dir_offset
 /src/t_dir_offset2

src/Makefile +1 -1

index c42d3bb1..01fe99ef 100644
@@ -26,7 +26,7 @@ LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	renameat2 t_getcwd e4compact test-nextquota punch-alternating \
 	attr-list-by-handle-cursor-test listxattr dio-interleaved t_dir_type \
 	dio-invalidate-cache stat_test t_encrypted_d_revalidate \
-	attr_replace_test
+	attr_replace_test swapon mkswap
 
 SUBDIRS = log-writes perf
 

src/mkswap.c new file +83 -0

new file mode 100644
index 00000000..d0bce2bd
@@ -0,0 +1,83 @@
+/* mkswap(8) without any sanity checks */
+
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+
+struct swap_header {
+	char		bootbits[1024];
+	uint32_t	version;
+	uint32_t	last_page;
+	uint32_t	nr_badpages;
+	unsigned char	sws_uuid[16];
+	unsigned char	sws_volume[16];
+	uint32_t	padding[117];
+	uint32_t	badpages[1];
+};
+
+int main(int argc, char **argv)
+{
+	struct swap_header *hdr;
+	FILE *file;
+	struct stat st;
+	long page_size;
+	int ret;
+
+	if (argc != 2) {
+		fprintf(stderr, "usage: %s PATH\n", argv[0]);
+		return EXIT_FAILURE;
+	}
+
+	page_size = sysconf(_SC_PAGESIZE);
+	if (page_size == -1) {
+		perror("sysconf");
+		return EXIT_FAILURE;
+	}
+
+	hdr = calloc(1, page_size);
+	if (!hdr) {
+		perror("calloc");
+		return EXIT_FAILURE;
+	}
+
+	file = fopen(argv[1], "r+");
+	if (!file) {
+		perror("fopen");
+		free(hdr);
+		return EXIT_FAILURE;
+	}
+
+	ret = fstat(fileno(file), &st);
+	if (ret) {
+		perror("fstat");
+		free(hdr);
+		fclose(file);
+		return EXIT_FAILURE;
+	}
+
+	hdr->version = 1;
+	hdr->last_page = st.st_size / page_size - 1;
+	memset(&hdr->sws_uuid, 0x99, sizeof(hdr->sws_uuid));
+	memcpy((char *)hdr + page_size - 10, "SWAPSPACE2", 10);
+
+	if (fwrite(hdr, page_size, 1, file) != 1) {
+		perror("fwrite");
+		free(hdr);
+		fclose(file);
+		return EXIT_FAILURE;
+	}
+
+	if (fclose(file) == EOF) {
+		perror("fwrite");
+		free(hdr);
+		return EXIT_FAILURE;
+	}
+
+	free(hdr);
+
+	return EXIT_SUCCESS;
+}

src/swapon.c new file +24 -0

new file mode 100644
index 00000000..0cb7108a
@@ -0,0 +1,24 @@
+/* swapon(8) without any sanity checks; simply calls swapon(2) directly. */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <sys/swap.h>
+
+int main(int argc, char **argv)
+{
+	int ret;
+
+	if (argc != 2) {
+		fprintf(stderr, "usage: %s PATH\n", argv[0]);
+		return EXIT_FAILURE;
+	}
+
+	ret = swapon(argv[1], 0);
+	if (ret) {
+		perror("swapon");
+		return EXIT_FAILURE;
+	}
+
+	return EXIT_SUCCESS;
+}

tests/generic/490 new file +49 -0

new file mode 100755
index 00000000..6ba2ecb3
@@ -0,0 +1,77 @@
+#! /bin/bash
+# FS QA Test 490
+#
+# Test invalid swap files.
+#
+#-----------------------------------------------------------------------
+# Copyright (c) 2018 Facebook.  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
+#-----------------------------------------------------------------------
+#
+
+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
+
+_cleanup()
+{
+	cd /
+	rm -f $tmp.*
+}
+
+# get standard environment, filters and checks
+. ./common/rc
+. ./common/filter
+
+# remove previous $seqres.full before test
+rm -f $seqres.full
+
+_supported_fs generic
+_supported_os Linux
+_require_scratch_swapfile
+_require_test_program mkswap

tests/generic/490 line 59

Quoted 10 lines

tests/generic/490 new file +10 -0

+_require_test_program swapon
+
+_scratch_mkfs >> $seqres.full 2>&1
+_scratch_mount
+
+echo "File with holes"
+# We can't use _format_swapfile because we're using our custom mkswap and
+# swapon.
+touch "$SCRATCH_MNT/swap"
+$CHATTR_PROG +C "$SCRATCH_MNT/swap"

FWIW I see:

/djwong/e2fsprogs/build-x64/misc/chattr: Operation not supported while setting flags on /opt/swap

on XFS (we don't support the nocow flag), so the stdout/stderr need to be redirected elsewhere.

--D

Quoted 45 lines

tests/generic/490 new file +18 -0

+chmod 0600 "$SCRATCH_MNT/swap"
+$XFS_IO_PROG -c "truncate $(($(get_page_size) * 10))" "$SCRATCH_MNT/swap"
+"$here/src/mkswap" "$SCRATCH_MNT/swap"
+"$here/src/swapon" "$SCRATCH_MNT/swap"
+swapoff "$SCRATCH_MNT/swap" >/dev/null 2>&1
+
+echo "Empty swap file (only swap header)"
+rm -f "$SCRATCH_MNT/swap"
+touch "$SCRATCH_MNT/swap"
+$CHATTR_PROG +C "$SCRATCH_MNT/swap"
+chmod 0600 "$SCRATCH_MNT/swap"
+_pwrite_byte 0x61 0 $(get_page_size) "$SCRATCH_MNT/swap" >> $seqres.full
+"$here/src/mkswap" "$SCRATCH_MNT/swap"
+"$here/src/swapon" "$SCRATCH_MNT/swap"
+swapoff "$SCRATCH_MNT/swap" >/dev/null 2>&1
+
+status=0
+exit

tests/generic/490.out new file +5 -0

new file mode 100644
index 00000000..96226c64
@@ -0,0 +1,5 @@
+QA output created by 490
+File with holes
+swapon: Invalid argument
+Empty swap file (only swap header)
+swapon: Invalid argument

tests/generic/group +1 -0

index a5252aeb..422e21e2 100644
@@ -492,3 +492,4 @@
 487 auto quick
 488 auto quick swap
 489 auto quick swap
+490 auto quick swap

Signature · 6 lines

2.17.0

--
To unsubscribe from this list: send the line "unsubscribe fstests" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Quoted 5 lines · Omar Sandoval

From: Omar Sandoval <[email protected]>

Commit 8c96cfbfe530 ("generic/35[67]: disable swapfile tests on Btrfs") disabled the swapfile tests on Btrfs because it did not support swapfiles at the time. Now that we're adding support, we want these

So currently btrfs has no swapfile support yet, and tests still _notrun with current v4.17-rc5 kernel? Just want to make sure that's expected.

Quoted 21 lines

tests to run, but they don't. _require_scratch_swapfile always fails for Btrfs because swapfiles on Btrfs must be set to nocow. After fixing that, generic/356 and generic/357 fail for the same reason. After fixing _that_, both tests still fail because we don't allow reflinking a non-checksummed extent (which nocow implies) to a checksummed extent. Add a helper for formatting a swap file which does the chattr, and chattr the second file, which gets these tests running on kernels supporting Btrfs swapfiles.

Signed-off-by Omar Sandoval <[email protected]>

---
 common/rc         | 15 ++++++++++++---
 tests/generic/356 |  7 ++++---
 tests/generic/357 |  6 +++---
 3 files changed, 19 insertions(+), 9 deletions(-)

common/rc +0 -0

index ffe53236..814b8b5c 100644

common/rc _require_odirect() · line 2229

Quoted 8 lines

common/rc +5 -0

@@ -2222,6 +2222,17 @@ _require_odirect()
 	rm -f $testfile 2>&1 > /dev/null
 }
 
+_format_swapfile() {
+	local fname="$1"
+	local sz="$2"
+
+	touch "$fname"

Better to remove $fname first, just in case it's an existing file with some blocks allocated, as chattr(1) says

"Note: For btrfs, the 'C' flag should be set on new or empty files. If it is set on a file which already has data blocks, it is undefined when the blocks assigned to the file will be fully stable"

common/rc _require_odirect() · line 2231

Quoted 2 lines

common/rc +2 -0

+	chmod 0600 "$fname"
+	$CHATTR_PROG +C "$fname" > /dev/null 2>&1

It'd be good to have some comments on this chattr +C.

common/rc _require_odirect() · line 2233

Quoted 2 lines

common/rc +2 -0

+	_pwrite_byte 0x61 0 "$sz" "$fname" >> $seqres.full
+	mkswap -U 27376b42-ff65-42ca-919f-6c9b62292a5c "$fname" >> $seqres.full

Is the label really needed?