Skip to contentSkip to conversation

userfaultfd: Add test using UFFDIO_POISON

PATCH Superseded Ricardo Branco 3 participants 10 messages Feb 18 – Feb 19

v3 of 8 Superseded Latest is v8 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 userfaultfd: Add test using UFFDIO_POISON

---
 configure.ac                                  |   1 +
 include/lapi/userfaultfd.h                    |  13 ++
 .../kernel/syscalls/userfaultfd/.gitignore    |   1 +
 .../kernel/syscalls/userfaultfd/Makefile      |   1 +
 .../syscalls/userfaultfd/userfaultfd06.c      | 134 ++++++++++++++++++
 5 files changed, 150 insertions(+)
 create mode 100644 testcases/kernel/syscalls/userfaultfd/userfaultfd06.c
configure.ac +1 -0
index 7fa614dcb..94bcbcc98 100644
@@ -278,6 +278,7 @@ AC_CHECK_TYPES([struct sockaddr_vm],,,[
 ])
 
 AC_CHECK_TYPES([struct uffdio_move],,,[#include <linux/userfaultfd.h>])
+AC_CHECK_TYPES([struct uffdio_poison],,,[#include <linux/userfaultfd.h>])
 AC_CHECK_TYPES([struct uffdio_writeprotect],,,[#include <linux/userfaultfd.h>])
 
 # Tools knobs
include/lapi/userfaultfd.h +13 -0
index 0c9e34c84..aab3890b7 100644
@@ -233,6 +233,19 @@ struct uffdio_writeprotect {
 };
 #endif	/* HAVE_STRUCT_UFFDIO_WRITEPROTECT */
 
+#ifndef HAVE_STRUCT_UFFDIO_POISON
+#define UFFD_FEATURE_POISON			(1<<14)
+#define _UFFDIO_POISON				(0x08)
+#define UFFDIO_POISON		_IOWR(UFFDIO, _UFFDIO_POISON, \
+				      struct uffdio_poison)
+struct uffdio_poison {
+        struct uffdio_range range;
+#define UFFDIO_POISON_MODE_DONTWAKE		((__u64)1<<0)
+        __u64 mode;
+        __s64 updated;
+};
+#endif	/* HAVE_STRUCT_UFFDIO_POISON */
+
 #define SAFE_USERFAULTFD(flags, retry) \
 	safe_userfaultfd(__FILE__, __LINE__, (flags), (retry))
 
testcases/kernel/syscalls/userfaultfd/.gitignore +1 -0
index fb2ae243b..bc32fdf3b 100644
@@ -3,3 +3,4 @@
 /userfaultfd03
 /userfaultfd04
 /userfaultfd05
+/userfaultfd06
testcases/kernel/syscalls/userfaultfd/Makefile +1 -0
index 96650a65a..3252e47df 100644
@@ -16,3 +16,4 @@ userfaultfd02: CFLAGS += -pthread
 userfaultfd03: CFLAGS += -pthread
 userfaultfd04: CFLAGS += -pthread
 userfaultfd05: CFLAGS += -pthread
+userfaultfd06: CFLAGS += -pthread
testcases/kernel/syscalls/userfaultfd/userfaultfd06.c new file +134 -0

134 lines not on this page · raw message

Signature · 5 lines
2.53.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#1 lore raw

Hi!

Quoted 178 lines · Ricardo Branco
---
 configure.ac                                  |   1 +
 include/lapi/userfaultfd.h                    |  13 ++
 .../kernel/syscalls/userfaultfd/.gitignore    |   1 +
 .../kernel/syscalls/userfaultfd/Makefile      |   1 +
 .../syscalls/userfaultfd/userfaultfd06.c      | 134 ++++++++++++++++++
 5 files changed, 150 insertions(+)
 create mode 100644 testcases/kernel/syscalls/userfaultfd/userfaultfd06.c
configure.ac +1 -0
index 7fa614dcb..94bcbcc98 100644
@@ -278,6 +278,7 @@ AC_CHECK_TYPES([struct sockaddr_vm],,,[
 ])
 
 AC_CHECK_TYPES([struct uffdio_move],,,[#include <linux/userfaultfd.h>])
+AC_CHECK_TYPES([struct uffdio_poison],,,[#include <linux/userfaultfd.h>])
 AC_CHECK_TYPES([struct uffdio_writeprotect],,,[#include <linux/userfaultfd.h>])
 
 # Tools knobs
include/lapi/userfaultfd.h +13 -0
index 0c9e34c84..aab3890b7 100644
@@ -233,6 +233,19 @@ struct uffdio_writeprotect {
 };
 #endif	/* HAVE_STRUCT_UFFDIO_WRITEPROTECT */
 
+#ifndef HAVE_STRUCT_UFFDIO_POISON
+#define UFFD_FEATURE_POISON			(1<<14)
+#define _UFFDIO_POISON				(0x08)
+#define UFFDIO_POISON		_IOWR(UFFDIO, _UFFDIO_POISON, \
+				      struct uffdio_poison)
+struct uffdio_poison {
+        struct uffdio_range range;
+#define UFFDIO_POISON_MODE_DONTWAKE		((__u64)1<<0)
+        __u64 mode;
+        __s64 updated;
+};
+#endif	/* HAVE_STRUCT_UFFDIO_POISON */
+
 #define SAFE_USERFAULTFD(flags, retry) \
 	safe_userfaultfd(__FILE__, __LINE__, (flags), (retry))
 
testcases/kernel/syscalls/userfaultfd/.gitignore +1 -0
index fb2ae243b..bc32fdf3b 100644
@@ -3,3 +3,4 @@
 /userfaultfd03
 /userfaultfd04
 /userfaultfd05
+/userfaultfd06
testcases/kernel/syscalls/userfaultfd/Makefile +1 -0
index 96650a65a..3252e47df 100644
@@ -16,3 +16,4 @@ userfaultfd02: CFLAGS += -pthread
 userfaultfd03: CFLAGS += -pthread
 userfaultfd04: CFLAGS += -pthread
 userfaultfd05: CFLAGS += -pthread
+userfaultfd06: CFLAGS += -pthread
testcases/kernel/syscalls/userfaultfd/userfaultfd06.c new file +108 -0
new file mode 100644
index 000000000..c4546acce
@@ -0,0 +1,134 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (c) 2026 SUSE LLC
+ * Author: Ricardo Branco <[email protected]>
+ */
+
+/*\
+ * Force a pagefault event and handle it using :manpage:`userfaultfd(2)`
+ * from a different thread testing UFFDIO_POISON.
+ */
+
+#include "config.h"
+#include <poll.h>
+#include <setjmp.h>
+#include <signal.h>
+#include <unistd.h>
+#include "tst_test.h"
+#include "tst_safe_macros.h"
+#include "tst_safe_pthread.h"
+#include "lapi/userfaultfd.h"
+
+static int page_size;
+static char *page;
+static int uffd;
+static volatile int poison_fault_seen;
+static volatile int sigbus_seen;
+static sigjmp_buf jmpbuf;
+
+static void sigbus_handler(int sig)
+{
+	if (sig == SIGBUS) {
+		sigbus_seen = 1;
+		siglongjmp(jmpbuf, 1);
+	}
+}
+
+static void set_pages(void)
+{
+	page_size = sysconf(_SC_PAGE_SIZE);
+	page = SAFE_MMAP(NULL, page_size, PROT_READ | PROT_WRITE,
+			MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
+}
+
+static void reset_pages(void)
+{
+	if (page) {
+		SAFE_MUNMAP(page, page_size);
+		page = NULL;
+	}
+}
+
+static void *handle_thread(void)
+{
+	static struct uffd_msg msg;
+	struct uffdio_poison uffdio_poison = {};
+	struct pollfd pollfd;
+	int nready;
+
+	pollfd.fd = uffd;
+	pollfd.events = POLLIN;
+	nready = poll(&pollfd, 1, -1);
+	if (nready == -1)
+		tst_brk(TBROK | TERRNO, "Error on poll");
+
+	SAFE_READ(1, uffd, &msg, sizeof(msg));
+
+	if (msg.event != UFFD_EVENT_PAGEFAULT)
+		tst_brk(TFAIL, "Received unexpected UFFD_EVENT %d", msg.event);
+
+	poison_fault_seen = 1;
+
+	/* Poison the page that triggered the fault */
+	uffdio_poison.range.start = msg.arg.pagefault.address & ~(page_size - 1);
+	uffdio_poison.range.len = page_size;
+
+	SAFE_IOCTL(uffd, UFFDIO_POISON, &uffdio_poison);
+
+	close(uffd);
+	return NULL;
+}
+
+static void run(void)
+{
+	pthread_t thr;
+	struct uffdio_api uffdio_api = {};
+	struct uffdio_register uffdio_register;
+	struct sigaction sa = {};
+	volatile char dummy;
+
+	sa.sa_handler = sigbus_handler;
+	sigemptyset(&sa.sa_mask);
+	SAFE_SIGACTION(SIGBUS, &sa, NULL);
+
+	set_pages();
+
+	uffd = SAFE_USERFAULTFD(O_CLOEXEC | O_NONBLOCK, false);
+
+	uffdio_api.api = UFFD_API;
+	uffdio_api.features = UFFD_FEATURE_POISON;
+
+	SAFE_IOCTL(uffd, UFFDIO_API, &uffdio_api);
+
+	uffdio_register.range.start = (unsigned long) page;
+	uffdio_register.range.len = page_size;
+	uffdio_register.mode = UFFDIO_REGISTER_MODE_MISSING;
+
+	SAFE_IOCTL(uffd, UFFDIO_REGISTER, &uffdio_register);
+

testcases/kernel/syscalls/userfaultfd/userfaultfd06.c line 118

Quoted 10 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd06.c new file +10 -0
+	SAFE_PTHREAD_CREATE(&thr, NULL, (void *) handle_thread, NULL);
+
+	/* Try to read from the page: should trigger fault, get poisoned, then SIGBUS */
+	if (sigsetjmp(jmpbuf, 1) == 0) {
+		dummy = page[0];
+		(void)dummy;
+	}
+
+	SAFE_PTHREAD_JOIN(thr, NULL);
+	reset_pages();

This should also go into a cleanup(), otherwise if other syscalls will fail (ioctl for instance), memory will be lost.

Quoted 5 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd06.c new file +5 -0
+
+	if (poison_fault_seen && sigbus_seen) {
+		tst_res(TPASS, "POISON successfully triggered SIGBUS");
+	} else if (poison_fault_seen && !sigbus_seen) {
+		tst_res(TFAIL, "POISON fault seen but no SIGBUS received");

testcases/kernel/syscalls/userfaultfd/userfaultfd06.c line 133

Quoted 10 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd06.c new file +10 -0
+	} else if (!poison_fault_seen && sigbus_seen) {
+		tst_res(TFAIL, "SIGBUS received but no poison fault seen");
+	} else {
+		tst_res(TFAIL, "No poison fault or SIGBUS observed");
+	}
+}
+
+static struct tst_test test = {
+	.test_all = run,
+	.min_kver = "6.6",

This is not needed, we should use UFFDIO_API instead, in order to verify that UFFD_FEATURE_POISON is present and eventually TCONF.

Also, if I run checkpatch.pl on the code I get:

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #25: FILE: userfaultfd06.c:25:
+static volatile int poison_fault_seen;

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #26: FILE: userfaultfd06.c:26:
+static volatile int sigbus_seen;

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #88: FILE: userfaultfd06.c:88:
+ volatile char dummy;

WARNING: braces {} are not necessary for any arm of this statement #120: FILE: userfaultfd06.c:120:
+ if (poison_fault_seen && sigbus_seen) {
[...]
+ } else if (poison_fault_seen && !sigbus_seen) {
[...]
+ } else if (!poison_fault_seen && sigbus_seen) {
[...]
+ } else {
[...]

total: 0 errors, 4 warnings, 134 lines checked

NOTE: For some of the reported defects, checkpatch may be able to
mechanically convert to the typical style using --fix or --fix-inplace.

userfaultfd06.c has style problems, please review.

NOTE: If any of the errors are false positives, please report
them to the maintainer, see CHECKPATCH in MAINTAINERS.

If you have b4, please run b4 prep --check before sending the patch.

Signature · 7 lines
Andrea Cervesato
SUSE QE Automation Engineer Linux
[email protected]


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#2 lore raw
Quoted 4 lines · Andrea Cervesato

testcases/kernel/syscalls/userfaultfd/userfaultfd06.c line 118

Quoted 2 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd06.c new file +2 -0
+	SAFE_PTHREAD_JOIN(thr, NULL);
+	reset_pages();

This should also go into a cleanup(), otherwise if other syscalls will fail (ioctl for instance), memory will be lost.

Will fix this in userfaultfd06.c and then submit another to fix it in the rest.

Quoted 6 lines

Also, if I run checkpatch.pl on the code I get:

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #25: FILE: userfaultfd06.c:25:
+static volatile int poison_fault_seen;

Quoted 7 lines

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #26: FILE: userfaultfd06.c:26:
+static volatile int sigbus_seen;

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #88: FILE: userfaultfd06.c:88:
+ volatile char dummy;

I've seen volatile being used in tests. There are legitimate uses for this, in signal handlers.

Quoted 1 line

If you have b4, please run b4 prep --check before sending the patch.

I'm getting:
CRITICAL: This is not a prep-managed branch.

Best,
R.

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#3 lore raw
Quoted 2 lines

CRITICAL: This is not a prep-managed branch.

That's because you didn't start to develop this feature in a b4 branch. The tool requires b4 prep -n <my starting branch> command before starting the implementation.

But this (of course) requires b4 knowledge :-) I'm planning to create a small section inside documentation for b4 usage.

Kind regards,

Signature · 7 lines
Andrea Cervesato
SUSE QE Automation Engineer Linux
[email protected]


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#4 lore raw
In reply to Andrea Cervesato via ltp

Hi!

Quoted 5 lines

testcases/kernel/syscalls/userfaultfd/userfaultfd06.c line 118

Quoted 2 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd06.c new file +2 -0
+	SAFE_PTHREAD_JOIN(thr, NULL);
+	reset_pages();

This should also go into a cleanup(), otherwise if other syscalls will fail (ioctl for instance), memory will be lost.

Technically all memory is released when last reference to it is removed, which happens on process exit. So no mmaped() memory is not going to leak.

Quoted 19 lines
Quoted 4 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd06.c new file +4 -0
+	if (poison_fault_seen && sigbus_seen) {
+		tst_res(TPASS, "POISON successfully triggered SIGBUS");
+	} else if (poison_fault_seen && !sigbus_seen) {
+		tst_res(TFAIL, "POISON fault seen but no SIGBUS received");

testcases/kernel/syscalls/userfaultfd/userfaultfd06.c line 133

Quoted 10 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd06.c new file +10 -0
+	} else if (!poison_fault_seen && sigbus_seen) {
+		tst_res(TFAIL, "SIGBUS received but no poison fault seen");
+	} else {
+		tst_res(TFAIL, "No poison fault or SIGBUS observed");
+	}
+}
+
+static struct tst_test test = {
+	.test_all = run,
+	.min_kver = "6.6",

This is not needed, we should use UFFDIO_API instead, in order to verify that UFFD_FEATURE_POISON is present and eventually TCONF.

Quoted 5 lines

Also, if I run checkpatch.pl on the code I get:

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #25: FILE: userfaultfd06.c:25:
+static volatile int poison_fault_seen;

For variables changed from a different thread atomic operation are better than volatile, i.e. tst_atomic_load() and tst_atomic_store().

Quoted 3 lines

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #26: FILE: userfaultfd06.c:26:
+static volatile int sigbus_seen;

This one is wrong, volatile is correct for variables changed for syscall handlers.

Quoted 3 lines

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #88: FILE: userfaultfd06.c:88:
+ volatile char dummy;

I do not think that volatile is needed here.

Quoted 31 lines

WARNING: braces {} are not necessary for any arm of this statement #120: FILE: userfaultfd06.c:120:

testcases/kernel/syscalls/userfaultfd/userfaultfd06.c new file +4 -0
+       if (poison_fault_seen && sigbus_seen) {
[...]
+       } else if (poison_fault_seen && !sigbus_seen) {
[...]
+       } else if (!poison_fault_seen && sigbus_seen) {
[...]
+       } else {
[...]

total: 0 errors, 4 warnings, 134 lines checked

NOTE: For some of the reported defects, checkpatch may be able to
mechanically convert to the typical style using --fix or --fix-inplace.

userfaultfd06.c has style problems, please review.

NOTE: If any of the errors are false positives, please report
them to the maintainer, see CHECKPATCH in MAINTAINERS.

If you have b4, please run b4 prep --check before sending the patch.

Signature · 7 lines
Andrea Cervesato
SUSE QE Automation Engineer Linux
[email protected]


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#5 lore raw
Quoted 3 lines

This one is wrong, volatile is correct for variables changed for syscall handlers.

If this is wrong, we should verify checkpatch.pl configuration.

Signature · 7 lines
Andrea Cervesato
SUSE QE Automation Engineer Linux
[email protected]


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#6 lore raw

Hi!

Quoted 4 lines
Quoted 2 lines

This one is wrong, volatile is correct for variables changed for syscall handlers.

If this is wrong, we should verify checkpatch.pl configuration.

It's only correct in very special situations such as signal handlers. I do not think that we can catch that with checkpatch.

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#7 lore raw
In reply to Cyril Hrubis
Quoted 4 lines

Technically all memory is released when last reference to it is removed, which happens on process exit. So no mmaped() memory is not going to leak.

Yes, still, we should make sure that it's released at the end of the test. Same for for malloc() memory allocation.

Signature · 7 lines
Andrea Cervesato
SUSE QE Automation Engineer Linux
[email protected]


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#8 lore raw
In reply to Cyril Hrubis
Quoted 4 lines · Cyril Hrubis
Quoted 3 lines

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #88: FILE: userfaultfd06.c:88:
+ volatile char dummy;

I do not think that volatile is needed here.

This is needed.  Without it, the test hangs.

Best,
R

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#9 lore raw

Hi!

Quoted 6 lines
Quoted 4 lines
Quoted 3 lines

WARNING: Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst #88: FILE: userfaultfd06.c:88:
+ volatile char dummy;

I do not think that volatile is needed here.

This is needed.  Without it, the test hangs.

I suppose that the compiler optimizes out the read because we are not using the value. We do have a maybe a bit more descriptive macro for these cases called LTP_VAR_USED().

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp