Skip to contentSkip to conversation

generic: add a test for multigrain timestamps

PATCH In review Jeff Layton 2 participants 3 messages Jul 13, 2023 – Jul 17, 2023 VFS

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 generic: add a test for multigrain timestamps

Ensure that the mtime and ctime apparently change, even when there are multiple writes in quick succession. Older kernels didn't do this, but there are patches in flight that should help ensure it in the future.

---
 src/Makefile          |   2 +-
 src/mgctime.c         | 107 ++++++++++++++++++++++++++++++++++++++++++
 tests/generic/730     |  25 ++++++++++
 tests/generic/730.out |   1 +
 4 files changed, 134 insertions(+), 1 deletion(-)
 create mode 100644 src/mgctime.c
 create mode 100755 tests/generic/730
 create mode 100644 tests/generic/730.out

This patchset is intended to test the new multigrain timestamp feature:

    https://lore.kernel.org/linux-fsdevel/[email protected]/T/#t

I had originally attempted to write this as a shell script, but it was too slow, which made it falsely pass on unpatched kernels.

All current filesystems will fail this, so we may want to wait until we are closer to merging the kernel series.

src/Makefile +1 -1
index 24cd47479140..aff7d07466f0 100644
@@ -33,7 +33,7 @@ LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	attr_replace_test swapon mkswap t_attr_corruption t_open_tmpfiles \
 	fscrypt-crypt-util bulkstat_null_ocount splice-test chprojid_fail \
 	detached_mounts_propagation ext4_resize t_readdir_3 splice2pipe \
-	uuid_ioctl
+	uuid_ioctl mgctime
 
 EXTRA_EXECS = dmerror fill2attr fill2fs fill2fs_check scaleread.sh \
 	      btrfs_crc32c_forged_name.py popdir.pl popattr.py
src/mgctime.c new file +107 -0

107 lines not on this page · raw message

tests/generic/730 new file +25 -0
new file mode 100755
index 000000000000..c3f24aeb8534
@@ -0,0 +1,25 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2023, Jeff Layton <[email protected]>
+#
+# FS QA Test No. 730
+#
+# Multigrain time test
+#
+# Open a file, and do 1 byte writes to it, and statx the file for
+# the ctime and mtime after each write. Ensure that they have changed
+# since the previous write.
+#
+. ./common/preamble
+_begin_fstest auto quick
+
+# Override the default cleanup function.
+_require_test_program mgctime
+
+testfile="$TEST_DIR/test_mgtime_file.$$"
+
+$here/src/mgctime $testfile
+
+# success, all done
+status=0
+exit
tests/generic/730.out new file +1 -0
new file mode 100644
index 000000000000..5dbea532d60f
@@ -0,0 +1 @@
+QA output created by 730
Signature · 1 line
2.41.0
#1 lore raw
Quoted 17 lines · Jeff Layton

Ensure that the mtime and ctime apparently change, even when there are multiple writes in quick succession. Older kernels didn't do this, but there are patches in flight that should help ensure it in the future.

---
 src/Makefile          |   2 +-
 src/mgctime.c         | 107 ++++++++++++++++++++++++++++++++++++++++++
 tests/generic/730     |  25 ++++++++++
 tests/generic/730.out |   1 +
 4 files changed, 134 insertions(+), 1 deletion(-)
 create mode 100644 src/mgctime.c
 create mode 100755 tests/generic/730
 create mode 100644 tests/generic/730.out

This patchset is intended to test the new multigrain timestamp feature:

Quoted 7 lines
    https://lore.kernel.org/linux-fsdevel/[email protected]/T/#t

I had originally attempted to write this as a shell script, but it was too slow, which made it falsely pass on unpatched kernels.

All current filesystems will fail this, so we may want to wait until we are closer to merging the kernel series.

I wonder, /should/ there be a way to declare to userspace that small writes in rapid succession are supposed to result in separately observable mtimestamps?

That might be hard to define generally -- what happens if the filesystem doesn't support nanosecond precision, e.g. fat? Or if the system doesn't have any clocks with better precision than jiffies? The expected minimum timestamp change granularity could be exported too, but that's even more complexity... :(

Thoughts?

Quoted 19 lines
src/Makefile +1 -1
index 24cd47479140..aff7d07466f0 100644
@@ -33,7 +33,7 @@ LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	attr_replace_test swapon mkswap t_attr_corruption t_open_tmpfiles \
 	fscrypt-crypt-util bulkstat_null_ocount splice-test chprojid_fail \
 	detached_mounts_propagation ext4_resize t_readdir_3 splice2pipe \
-	uuid_ioctl
+	uuid_ioctl mgctime
 
 EXTRA_EXECS = dmerror fill2attr fill2fs fill2fs_check scaleread.sh \
 	      btrfs_crc32c_forged_name.py popdir.pl popattr.py
src/mgctime.c new file +0 -0
new file mode 100644
index 000000000000..38e22a8613ff

src/mgctime.c line 1

Quoted 1 line
src/mgctime.c new file +1 -0
@@ -0,0 +1,107 @@
+/*

Needs a SPDX header, I think.

The C program itself looks ok though.

--D

Quoted 147 lines
src/mgctime.c new file +106 -0
+ * Older Linux kernels always use coarse-grained timestamps, with a
+ * resolution of around 1 jiffy. Writes that are done in quick succession
+ * on those kernels apparent change to the ctime or mtime.
+ *
+ * Newer kernels attempt to ensure that fine-grained timestamps are used
+ * when the mtime or ctime are queried from userland.
+ *
+ * Open a file and do a 1 byte write to it and then statx the mtime and ctime.
+ * Do that in a loop 1000 times and ensure that the value is different from
+ * the last.
+ *
+ * Copyright (c) 2023: Jeff Layton <[email protected]>
+ */
+#define _GNU_SOURCE 1
+#include <stdio.h>
+#include <fcntl.h>
+#include <errno.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <stdint.h>
+#include <getopt.h>
+#include <stdbool.h>
+
+#define NUM_WRITES 1000
+
+static int64_t statx_ts_cmp(struct statx_timestamp *ts1, struct statx_timestamp *ts2)
+{
+	int64_t ret = ts2->tv_sec - ts1->tv_sec;
+
+	if (ret)
+		return ret;
+
+	ret = ts2->tv_nsec;
+	ret -= ts1->tv_nsec;
+
+	return ret;
+}
+
+int main(int argc, char **argv)
+{
+	int ret, fd, i;
+	struct statx stx = { };
+	struct statx_timestamp ctime, mtime;
+	bool verbose = false;
+
+	while ((i = getopt(argc, argv, "v")) != -1) {
+		switch (i) {
+		case 'v':
+			verbose = true;
+			break;
+		}
+	}
+
+	if (argc < 2) {
+		errno = -EINVAL;
+		perror("usage");
+	}
+
+	fd = open(argv[1], O_WRONLY|O_CREAT|O_TRUNC, 0644);
+	if (fd < 0) {
+		perror("open");
+		return 1;
+	}
+
+	ret = statx(fd, "", AT_EMPTY_PATH, STATX_MTIME|STATX_CTIME, &stx);
+	if (ret < 0) {
+		perror("stat");
+		return 1;
+	}
+
+	ctime = stx.stx_ctime;
+	mtime = stx.stx_mtime;
+
+	for (i = 0; i < NUM_WRITES; ++i) {
+		ssize_t written;
+
+		written = write(fd, "a", 1);
+		if (written < 0) {
+			perror("write");
+			return 1;
+		}
+
+		ret = statx(fd, "", AT_EMPTY_PATH, STATX_MTIME|STATX_CTIME, &stx);
+		if (ret < 0) {
+			perror("stat");
+			return 1;
+		}
+
+		if (verbose)
+			printf("%d: %llu.%u\n", i, stx.stx_ctime.tv_sec, stx.stx_ctime.tv_nsec);
+
+		if (!statx_ts_cmp(&ctime, &stx.stx_ctime)) {
+			printf("Duplicate ctime after write!\n");
+			return 1;
+		}
+
+		if (!statx_ts_cmp(&mtime, &stx.stx_mtime)) {
+			printf("Duplicate mtime after write!\n");
+			return 1;
+		}
+
+		ctime = stx.stx_ctime;
+		mtime = stx.stx_mtime;
+	}
+	return 0;
+}
tests/generic/730 new file +25 -0
new file mode 100755
index 000000000000..c3f24aeb8534
@@ -0,0 +1,25 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2023, Jeff Layton <[email protected]>
+#
+# FS QA Test No. 730
+#
+# Multigrain time test
+#
+# Open a file, and do 1 byte writes to it, and statx the file for
+# the ctime and mtime after each write. Ensure that they have changed
+# since the previous write.
+#
+. ./common/preamble
+_begin_fstest auto quick
+
+# Override the default cleanup function.
+_require_test_program mgctime
+
+testfile="$TEST_DIR/test_mgtime_file.$$"
+
+$here/src/mgctime $testfile
+
+# success, all done
+status=0
+exit
tests/generic/730.out new file +1 -0
new file mode 100644
index 000000000000..5dbea532d60f
@@ -0,0 +1 @@
+QA output created by 730
Signature · 1 line
2.41.0
#2 lore raw
Quoted 30 lines · Darrick J. Wong
Quoted 17 lines · Jeff Layton

Ensure that the mtime and ctime apparently change, even when there are multiple writes in quick succession. Older kernels didn't do this, but there are patches in flight that should help ensure it in the future.

---
 src/Makefile          |   2 +-
 src/mgctime.c         | 107 ++++++++++++++++++++++++++++++++++++++++++
 tests/generic/730     |  25 ++++++++++
 tests/generic/730.out |   1 +
 4 files changed, 134 insertions(+), 1 deletion(-)
 create mode 100644 src/mgctime.c
 create mode 100755 tests/generic/730
 create mode 100644 tests/generic/730.out

This patchset is intended to test the new multigrain timestamp feature:

Quoted 7 lines
    https://lore.kernel.org/linux-fsdevel/[email protected]/T/#t

I had originally attempted to write this as a shell script, but it was too slow, which made it falsely pass on unpatched kernels.

All current filesystems will fail this, so we may want to wait until we are closer to merging the kernel series.

I wonder, /should/ there be a way to declare to userspace that small writes in rapid succession are supposed to result in separately observable mtimestamps?

Quoted 8 lines

That might be hard to define generally -- what happens if the filesystem doesn't support nanosecond precision, e.g. fat? Or if the system doesn't have any clocks with better precision than jiffies? The expected minimum timestamp change granularity could be exported too, but that's even more complexity... :(

Thoughts?

Yeah, I couldn't come up with a good way to report and detect this behavior in userland.

In principle, I guess we could create a new STATX_ATTR_MGTS flag for this, but it sort of feels like we're trying expose the existence of an implementation detail to userland.

We could try to expose the sb->s_time_gran to userland via (e.g.) fsinfo(), but that's really sort of a different thing than the granularity we're dealing with here. That's all about how we mask off low-order bits before reporting the timestamps.

Most filesystems set that to 1ns anyway, even though they fill that out with a coarse-grained timestamp, so that wouldn't help us detect filesystems that are expected to fail this. At the end of the day, this may be the sort of test where we have specific filesystems that are known to pass opt-in to it somehow.

Quoted 23 lines
Quoted 19 lines
src/Makefile +1 -1
index 24cd47479140..aff7d07466f0 100644
@@ -33,7 +33,7 @@ LINUX_TARGETS = xfsctl bstat t_mtab getdevicesize preallo_rw_pattern_reader \
 	attr_replace_test swapon mkswap t_attr_corruption t_open_tmpfiles \
 	fscrypt-crypt-util bulkstat_null_ocount splice-test chprojid_fail \
 	detached_mounts_propagation ext4_resize t_readdir_3 splice2pipe \
-	uuid_ioctl
+	uuid_ioctl mgctime
 
 EXTRA_EXECS = dmerror fill2attr fill2fs fill2fs_check scaleread.sh \
 	      btrfs_crc32c_forged_name.py popdir.pl popattr.py
src/mgctime.c new file +0 -0
new file mode 100644
index 000000000000..38e22a8613ff

src/mgctime.c line 1

Quoted 1 line
src/mgctime.c new file +1 -0
@@ -0,0 +1,107 @@
+/*

Needs a SPDX header, I think.

Quoted 4 lines

The C program itself looks ok though.

--D

Thanks, I'll add that in!

Quoted 147 lines
Quoted 147 lines
src/mgctime.c new file +106 -0
+ * Older Linux kernels always use coarse-grained timestamps, with a
+ * resolution of around 1 jiffy. Writes that are done in quick succession
+ * on those kernels apparent change to the ctime or mtime.
+ *
+ * Newer kernels attempt to ensure that fine-grained timestamps are used
+ * when the mtime or ctime are queried from userland.
+ *
+ * Open a file and do a 1 byte write to it and then statx the mtime and ctime.
+ * Do that in a loop 1000 times and ensure that the value is different from
+ * the last.
+ *
+ * Copyright (c) 2023: Jeff Layton <[email protected]>
+ */
+#define _GNU_SOURCE 1
+#include <stdio.h>
+#include <fcntl.h>
+#include <errno.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <stdint.h>
+#include <getopt.h>
+#include <stdbool.h>
+
+#define NUM_WRITES 1000
+
+static int64_t statx_ts_cmp(struct statx_timestamp *ts1, struct statx_timestamp *ts2)
+{
+	int64_t ret = ts2->tv_sec - ts1->tv_sec;
+
+	if (ret)
+		return ret;
+
+	ret = ts2->tv_nsec;
+	ret -= ts1->tv_nsec;
+
+	return ret;
+}
+
+int main(int argc, char **argv)
+{
+	int ret, fd, i;
+	struct statx stx = { };
+	struct statx_timestamp ctime, mtime;
+	bool verbose = false;
+
+	while ((i = getopt(argc, argv, "v")) != -1) {
+		switch (i) {
+		case 'v':
+			verbose = true;
+			break;
+		}
+	}
+
+	if (argc < 2) {
+		errno = -EINVAL;
+		perror("usage");
+	}
+
+	fd = open(argv[1], O_WRONLY|O_CREAT|O_TRUNC, 0644);
+	if (fd < 0) {
+		perror("open");
+		return 1;
+	}
+
+	ret = statx(fd, "", AT_EMPTY_PATH, STATX_MTIME|STATX_CTIME, &stx);
+	if (ret < 0) {
+		perror("stat");
+		return 1;
+	}
+
+	ctime = stx.stx_ctime;
+	mtime = stx.stx_mtime;
+
+	for (i = 0; i < NUM_WRITES; ++i) {
+		ssize_t written;
+
+		written = write(fd, "a", 1);
+		if (written < 0) {
+			perror("write");
+			return 1;
+		}
+
+		ret = statx(fd, "", AT_EMPTY_PATH, STATX_MTIME|STATX_CTIME, &stx);
+		if (ret < 0) {
+			perror("stat");
+			return 1;
+		}
+
+		if (verbose)
+			printf("%d: %llu.%u\n", i, stx.stx_ctime.tv_sec, stx.stx_ctime.tv_nsec);
+
+		if (!statx_ts_cmp(&ctime, &stx.stx_ctime)) {
+			printf("Duplicate ctime after write!\n");
+			return 1;
+		}
+
+		if (!statx_ts_cmp(&mtime, &stx.stx_mtime)) {
+			printf("Duplicate mtime after write!\n");
+			return 1;
+		}
+
+		ctime = stx.stx_ctime;
+		mtime = stx.stx_mtime;
+	}
+	return 0;
+}
tests/generic/730 new file +25 -0
new file mode 100755
index 000000000000..c3f24aeb8534
@@ -0,0 +1,25 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (c) 2023, Jeff Layton <[email protected]>
+#
+# FS QA Test No. 730
+#
+# Multigrain time test
+#
+# Open a file, and do 1 byte writes to it, and statx the file for
+# the ctime and mtime after each write. Ensure that they have changed
+# since the previous write.
+#
+. ./common/preamble
+_begin_fstest auto quick
+
+# Override the default cleanup function.
+_require_test_program mgctime
+
+testfile="$TEST_DIR/test_mgtime_file.$$"
+
+$here/src/mgctime $testfile
+
+# success, all done
+status=0
+exit
tests/generic/730.out new file +1 -0
new file mode 100644
index 000000000000..5dbea532d60f
@@ -0,0 +1 @@
+QA output created by 730
Signature · 1 line
2.41.0
Signature · 1 line
Jeff Layton <[email protected]>