Skip to contentSkip to conversation

fstests: add a dio-read-into-mmap and sync race test case

PATCH In review Qu Wenruo 2 participants 2 messages Aug 3 – Aug 10 Btrfs file system

lore
Share & tools
lore

Qu Wenruo

author
#0 lore raw

PATCH v2 1/1 fstests: add a dio-read-into-mmap and sync race test case

There is a report that on btrfs, if the following workload are running, btrfs can fail:

- A dio read into a mmaped range
Only the mmap range needs to be on btrfs.
The dio read source makes no difference.

- Sync_range on the mapped range

The btrfs errors include:

- Hang during data writeback
- Filesystem flips RO

The mmap range is dirtied but written back by the sync_range process, then dio read finished and found that the folios are no longer dirty, so dio endio will mark those folios dirty again so that the fs can write them back again.

However for non-experimental btrfs with 4K block size and 4K page size, there is a regression in v7.2 that such case is no longer handled properly, due to the enablement of large folios and removal of cow fixup.
And btrfs can never handle it for bs < ps from day 1.

Add a regression test for it.

---
Changelog:
v2:
- Rebased to the latest patches-in-queue branch
The old number is taken by another test case, now this one got the number 800.

- Fix a bug when the direct read failed short, the read buffer is not advanced

- Add _require_odirect

- Add _require_xfs_io_command sync_range

- Add missing tmp files cleanup

- Remove unneessary trap command for the main process

- Fix the unset command

---
 .gitignore               |  1 +
 src/Makefile             |  2 +-
 src/dio-read-into-mmap.c | 81 ++++++++++++++++++++++++++++++++++++++++
 tests/generic/800        | 79 +++++++++++++++++++++++++++++++++++++++
 tests/generic/800.out    |  2 +
 5 files changed, 164 insertions(+), 1 deletion(-)
 create mode 100644 src/dio-read-into-mmap.c
 create mode 100755 tests/generic/800
 create mode 100644 tests/generic/800.out
.gitignore +1 -0
index 0b6b9452..d52ba4ad 100644
@@ -216,6 +216,7 @@ tags
 /src/truncate
 /src/t_btrfs_received_uuid_ioctl
 /src/btrfs_ioctl
+/src/dio-read-into-mmap
 
 # Symlinked files
 /tests/generic/035.out
src/Makefile +1 -1
index e8da2636..ea3d77b2 100644
@@ -21,7 +21,7 @@ TARGETS = dirstress fill fill2 getpagesize holes lstat64 \
 	t_mmap_writev_overlap checkpoint_journal mmap-rw-fault allocstale \
 	t_mmap_cow_memory_failure fake-dump-rootino dio-buf-fault rewinddir-test \
 	readdir-while-renames dio-append-buf-fault dio-write-fsync-same-fd \
-	dio-writeback-race unlink-fsync truncate
+	dio-writeback-race unlink-fsync truncate dio-read-into-mmap
 
 LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	preallo_rw_pattern_writer ftrunc trunc fs_perms testx looptest \
src/dio-read-into-mmap.c new file +81 -0

81 lines not on this page · raw message

tests/generic/800 new file +79 -0

79 lines not on this page · raw message

tests/generic/800.out new file +2 -0
new file mode 100644
index 00000000..bdfaa2ce
@@ -0,0 +1,2 @@
+QA output created by 800
+Silence is golden
Signature · 1 line
2.51.2
Reviewed-by on v2 1/1
#1 lore raw
Quoted 195 lines · Qu Wenruo

There is a report that on btrfs, if the following workload are running, btrfs can fail:

- A dio read into a mmaped range
Only the mmap range needs to be on btrfs.
The dio read source makes no difference.

- Sync_range on the mapped range

The btrfs errors include:

- Hang during data writeback
- Filesystem flips RO

The mmap range is dirtied but written back by the sync_range process, then dio read finished and found that the folios are no longer dirty, so dio endio will mark those folios dirty again so that the fs can write them back again.

However for non-experimental btrfs with 4K block size and 4K page size, there is a regression in v7.2 that such case is no longer handled properly, due to the enablement of large folios and removal of cow fixup.
And btrfs can never handle it for bs < ps from day 1.

Add a regression test for it.

---
Changelog:
v2:
- Rebased to the latest patches-in-queue branch
The old number is taken by another test case, now this one got the number 800.

- Fix a bug when the direct read failed short, the read buffer is not advanced

- Add _require_odirect

- Add _require_xfs_io_command sync_range

- Add missing tmp files cleanup

- Remove unneessary trap command for the main process

- Fix the unset command

---
 .gitignore               |  1 +
 src/Makefile             |  2 +-
 src/dio-read-into-mmap.c | 81 ++++++++++++++++++++++++++++++++++++++++
 tests/generic/800        | 79 +++++++++++++++++++++++++++++++++++++++
 tests/generic/800.out    |  2 +
 5 files changed, 164 insertions(+), 1 deletion(-)
 create mode 100644 src/dio-read-into-mmap.c
 create mode 100755 tests/generic/800
 create mode 100644 tests/generic/800.out
.gitignore +1 -0
index 0b6b9452..d52ba4ad 100644
@@ -216,6 +216,7 @@ tags
 /src/truncate
 /src/t_btrfs_received_uuid_ioctl
 /src/btrfs_ioctl
+/src/dio-read-into-mmap
 
 # Symlinked files
 /tests/generic/035.out
src/Makefile +0 -1
--- a/src/Makefile

index e8da2636..ea3d77b2 100644
+++ b/src/Makefile

src/Makefile +1 -1
@@ -21,7 +21,7 @@ TARGETS = dirstress fill fill2 getpagesize holes lstat64 \
 	t_mmap_writev_overlap checkpoint_journal mmap-rw-fault allocstale \
 	t_mmap_cow_memory_failure fake-dump-rootino dio-buf-fault rewinddir-test \
 	readdir-while-renames dio-append-buf-fault dio-write-fsync-same-fd \
-	dio-writeback-race unlink-fsync truncate
+	dio-writeback-race unlink-fsync truncate dio-read-into-mmap
 
 LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	preallo_rw_pattern_writer ftrunc trunc fs_perms testx looptest \
src/dio-read-into-mmap.c new file +81 -0
new file mode 100644
index 00000000..2a5ad085
@@ -0,0 +1,81 @@
+// SPDX-License-Identifier: GPL-2.0
+// Copyright (c) SUSE S.A.
+
+#include <fcntl.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <string.h>
+#include <errno.h>
+#include <sys/mman.h>
+#include <sys/stat.h>
+#include <err.h>
+
+static int read_source_fd = -1;
+static int mmap_dest_fd = -1;
+static void *buf = NULL;
+static int iosize = 4 * 1024 * 1024;
+
+static void usage()
+{
+	fprintf(stderr,
+	"Usage: dio-read-into-mmap <read_source> <mmap_dest>\n");
+}
+
+int main(int argc, char **argv)
+{
+	int ret = -EINVAL;
+	const int pagesize = sysconf(_SC_PAGESIZE);
+	unsigned int cur = 0;
+
+	if (argc != 3) {
+		usage();
+		goto error;
+	}
+	if (iosize < pagesize) {
+		ret = -EINVAL;
+		fprintf(stderr, "blocksize smaller than pagesize\n");
+		goto error;
+	}
+
+	read_source_fd = open(argv[1], O_RDONLY | O_DIRECT, 0600);
+	if (read_source_fd < 0) {
+		ret = -errno;
+		fprintf(stderr, "failed to open '%s': %m", argv[1]);
+		goto error;
+	}
+	mmap_dest_fd = open(argv[2], O_RDWR, 0600);
+	if (mmap_dest_fd < 0) {
+		ret = -errno;
+		fprintf(stderr, "failed to open '%s': %m", argv[2]);
+		goto error;
+	}
+	buf = mmap(NULL, iosize, PROT_WRITE, MAP_SHARED, mmap_dest_fd, 0);
+	if (buf == MAP_FAILED) {
+		buf = NULL;
+		fprintf(stderr, "failed to mmap: %m");
+		return -errno;
+	}
+	while (cur < iosize) {
+		ret = pread(read_source_fd, buf + cur, iosize - cur, cur);
+		if (ret == 0) {
+			ret = -EINVAL;
+			fprintf(stderr, "reached EOF");
+			goto error;
+		}
+		if (ret < 0) {
+			ret = -errno;
+			fprintf(stderr, "failed to read: %m");
+			goto error;
+		}
+		cur += ret;
+	}
+error:
+	close(read_source_fd);
+	close(mmap_dest_fd);
+	if (buf)
+		munmap(buf, iosize);
+	if (ret < 0)
+		return EXIT_FAILURE;
+	return EXIT_SUCCESS;
+}
tests/generic/800 new file +17 -0
new file mode 100755
index 00000000..980d1734
@@ -0,0 +1,79 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2026 SUSE S.A.  All Rights Reserved.
+#
+# FS QA Test 800
+#
+# Test direct read into a mmaped range meanwhile doing data sync for the mmaped
+# range.
+# Such racy workload should cause direct endio function to mark the folio
+# dirty without going through buffered write nor page_mkwrite().
+#
+# Make sure the fs can handle such ->dirty_folio() callback correctly.
+#
+. ./common/preamble
+_begin_fstest auto rw mmap
+
+_require_test_program dio-read-into-mmap

tests/generic/800 line 27

Quoted 10 lines
tests/generic/800 new file +10 -0
+_require_scratch
+_require_test
+_require_odirect
+_require_xfs_io_command sync_range
+
+_cleanup()
+{
+	cd /
+	[ -n "$mount_pid" ] && kill $mount_pid &> /dev/null
+	[ -n "$remount_pid" ] && kill $remount_pid &> /dev/null

I think you mean "read_pid" and "sync_pid" here :)

Others look good to me, I'll help to fix above typo problems when I merge it, if there's not more review points from btrfs list.

Quoted 64 lines
tests/generic/800 new file +52 -0
+	wait
+	rm -r -f $tmp.*
+}
+
+_scratch_mkfs >> $seqres.full
+_scratch_mount
+
+# Create the 4MiB target file on TEST_MNT as the read source.
+$XFS_IO_PROG -f -c "pwrite -i /dev/urandom 0 4M" "$TEST_MNT/dio-read-source" >> $seqres.full
+
+# Another 4MiB target file on SCRATCH_MNT as the mmap dest
+$XFS_IO_PROG -f -c "pwrite 0 4M" "$SCRATCH_MNT/mmap-dest" >> $seqres.full
+
+read_workload()
+{
+	_register_cleanup "wait"
+	while true; do
+		$here/src/dio-read-into-mmap "$TEST_MNT/dio-read-source" \
+			"$SCRATCH_MNT/mmap-dest" &> /dev/null
+		if [ $? -ne 0 ]; then
+			echo "dio read failed"
+			break;
+		fi
+	done
+}
+
+sync_workload()
+{
+	_register_cleanup "wait"
+	while true; do
+		$XFS_IO_PROG -c "sync_range 0 4m" "$SCRATCH_MNT/mmap-dest"
+		if [ $? -ne 0 ]; then
+			echo "sync_range failed"
+			break;
+		fi
+	done
+}
+
+read_workload &
+read_pid=$!
+
+sync_workload &
+sync_pid=$!
+
+sleep $((15 * $TIME_FACTOR))
+
+kill "$read_pid" "$sync_pid" &> /dev/null
+unset read_pid sync_pid
+wait
+
+echo "Silence is golden"
+_exit 0
tests/generic/800.out new file +2 -0
new file mode 100644
index 00000000..bdfaa2ce
@@ -0,0 +1,2 @@
+QA output created by 800
+Silence is golden
Signature · 1 line
2.51.2