Skip to contentSkip to conversation

syscall: Add userfaultfd testcase

PATCH Superseded Christian Amann 3 participants 5 messages Mar 14, 2019 – Mar 15, 2019

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 syscall: Add userfaultfd testcase

This tests the userfaultfd syscall to handle pagefault events. It does so by registering a userfaultfd object to the address of a memory page. In a second thread it handles the event and writes data in the monitored memory page to indicate success.

---
 include/lapi/syscalls/aarch64.in                   |   1 +
 include/lapi/syscalls/arm.in                       |   1 +
 include/lapi/syscalls/i386.in                      |   1 +
 include/lapi/syscalls/ia64.in                      |   1 +
 include/lapi/syscalls/powerpc.in                   |   1 +
 include/lapi/syscalls/powerpc64.in                 |   1 +
 include/lapi/syscalls/s390.in                      |   1 +
 include/lapi/syscalls/s390x.in                     |   1 +
 include/lapi/syscalls/sparc.in                     |   1 +
 include/lapi/syscalls/sparc64.in                   |   1 +
 include/lapi/syscalls/x86_64.in                    |   1 +
 runtest/syscalls                                   |   2 +
 testcases/kernel/syscalls/userfaultfd/.gitignore   |   1 +
 testcases/kernel/syscalls/userfaultfd/Makefile     |  23 ++++
 .../kernel/syscalls/userfaultfd/userfaultfd01.c    | 142 +++++++++++++++++++++
 15 files changed, 179 insertions(+)
 create mode 100644 testcases/kernel/syscalls/userfaultfd/.gitignore
 create mode 100644 testcases/kernel/syscalls/userfaultfd/Makefile
 create mode 100644 testcases/kernel/syscalls/userfaultfd/userfaultfd01.c
include/lapi/syscalls/aarch64.in +1 -0
index 7ce148524..177dd0115 100644
@@ -258,6 +258,7 @@ process_vm_writev 271
 kcmp 272
 getrandom 278
 memfd_create 279
+userfaultfd 282
 membarrier 283
 execveat 281
 mlock2 284
include/lapi/syscalls/arm.in +1 -0
index 22c76d4f0..f4adedb2c 100644
@@ -343,6 +343,7 @@ renameat2 (__NR_SYSCALL_BASE+382)
 getrandom (__NR_SYSCALL_BASE+384)
 memfd_create (__NR_SYSCALL_BASE+385)
 execveat (__NR_SYSCALL_BASE+387)
+userfaultfd (__NR_SYSCALL_BASE+388)
 membarrier (__NR_SYSCALL_BASE+389)
 mlock2 (__NR_SYSCALL_BASE+390)
 copy_file_range (__NR_SYSCALL_BASE+391)
include/lapi/syscalls/i386.in +1 -0
index 7e485aebf..af5254f77 100644
@@ -341,6 +341,7 @@ renameat2 354
 getrandom 355
 memfd_create 356
 execveat 358
+userfaultfd 374
 membarrier 375
 mlock2 376
 copy_file_range 377
include/lapi/syscalls/ia64.in +1 -0
index 7c9a0ead6..c0aeed08b 100644
@@ -298,6 +298,7 @@ process_vm_writev 1333
 renameat2 1338
 getrandom 1339
 memfd_create 1340
+userfaultfd 1343
 membarrier 1344
 execveat 1342
 mlock2 1346
include/lapi/syscalls/powerpc.in +1 -0
index fc1f89945..6b6be58a7 100644
@@ -347,6 +347,7 @@ sched_getattr 356
 renameat2 357
 getrandom 359
 memfd_create 360
+userfaultfd 364
 membarrier 365
 execveat 362
 mlock2 378
include/lapi/syscalls/powerpc64.in +1 -0
index fc1f89945..6b6be58a7 100644
@@ -347,6 +347,7 @@ sched_getattr 356
 renameat2 357
 getrandom 359
 memfd_create 360
+userfaultfd 364
 membarrier 365
 execveat 362
 mlock2 378
include/lapi/syscalls/s390.in +1 -0
index 6d0c895fa..2a2ffe223 100644
@@ -331,6 +331,7 @@ sched_getattr 346
 renameat2 347
 getrandom 349
 memfd_create 350
+userfaultfd 355
 membarrier 356
 execveat 354
 mlock2 374
include/lapi/syscalls/s390x.in +1 -0
index 8105b5598..4c36ce17c 100644
@@ -330,6 +330,7 @@ sched_getattr 346
 renameat2 347
 getrandom 349
 memfd_create 350
+userfaultfd 355
 membarrier 356
 execveat 354
 mlock2 374
include/lapi/syscalls/sparc.in +1 -0
index 20a21a9ce..20dc37b01 100644
@@ -337,6 +337,7 @@ renameat2 345
 getrandom 347
 memfd_create 348
 membarrier 351
+userfaultfd 352
 execveat 350
 mlock2 356
 copy_file_range 357
include/lapi/syscalls/sparc64.in +1 -0
index 36ab39420..c100b8e3e 100644
@@ -313,6 +313,7 @@ renameat2 345
 getrandom 347
 memfd_create 348
 membarrier 351
+userfaultfd 352
 execveat 350
 mlock2 356
 copy_file_range 357
include/lapi/syscalls/x86_64.in +1 -0
index 6aa9d12a8..87849e5c0 100644
@@ -308,6 +308,7 @@ renameat2 316
 getrandom 318
 memfd_create 319
 execveat 322
+userfaultfd 323
 membarrier 324
 mlock2 325
 copy_file_range 326
runtest/syscalls +2 -0
index d752dba33..ebb4d69a5 100644
@@ -1464,6 +1464,8 @@ umount2_01 umount2_01
 umount2_02 umount2_02
 umount2_03 umount2_03
 
+userfaultfd01 userfaultfd01
+
 ustat01 ustat01
 ustat02 ustat02
 
testcases/kernel/syscalls/userfaultfd/.gitignore new file +1 -0
new file mode 100644
index 000000000..d819a2a7c
@@ -0,0 +1 @@
+/userfaultfd01
testcases/kernel/syscalls/userfaultfd/Makefile new file +23 -0
new file mode 100644
index 000000000..55930ad92
@@ -0,0 +1,23 @@
+# Copyright (c) 2019 SUSE LLC
+#
+# 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; either version 2 of
+# the License, or (at your option) any later version.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+
+top_srcdir		?= ../../../..
+
+include $(top_srcdir)/include/mk/testcases.mk
+
+include $(top_srcdir)/include/mk/generic_leaf_target.mk
+
+userfaultfd01: CFLAGS += -pthread
+
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +142 -0

142 lines not on this page · raw message

Signature · 1 line
2.16.4
#1 lore raw

PATCH v2 1/1 syscall: Add userfaultfd testcase

----- Original Message -----

Quoted 6 lines

This tests the userfaultfd syscall to handle pagefault events. It does so by registering a userfaultfd object to the address of a memory page. In a second thread it handles the event and writes data in the monitored memory page to indicate success.

Hi,

my main concern is that direct include of linux header.

Other than that it looks ok, but you could use more SAFE_ macros which do the common checks and print error messages for you.

<snip>

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 29

Quoted 12 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +12 -0
+
+/*
+ * Test userfaultfd
+ *
+ * Force a pagefault event and handle it using userfaultfd
+ * from a different thread
+ *
+ */
+
+#include "tst_test.h"
+#include "lapi/syscalls.h"
+#include <linux/userfaultfd.h>

This doesn't look like it will compile on older kernels.

Quoted 9 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +9 -0
+#include <pthread.h>
+#include <poll.h>
+
+static int page_size;
+static char *page;
+static void *copy_page;
+
+static int sys_userfaultfd(int flags)
+{

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 48

Quoted 10 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +10 -0
+	return tst_syscall(__NR_userfaultfd, flags);
+}
+
+static void set_pages(void)
+{
+	page_size = sysconf(_SC_PAGE_SIZE);
+	page = mmap(NULL, page_size, PROT_READ | PROT_WRITE,
+			MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
+	copy_page = mmap(NULL, page_size, PROT_READ | PROT_WRITE,
+			MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);

Please use SAFE_MMAP

Quoted 7 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +7 -0
+}
+
+static void *handle_thread(void *arg)
+{
+	static struct uffd_msg msg;
+	long uffd;
+	struct uffdio_copy uffdio_copy;

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 65

Quoted 10 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +10 -0
+	ssize_t nread;
+
+	uffd = (long) arg;
+
+	struct pollfd pollfd;
+	int nready;
+
+	pollfd.fd = uffd;
+	pollfd.events = POLLIN;
+	nready = poll(&pollfd, 1, -1);

SAFE_POLL

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 70

Quoted 5 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +5 -0
+	if (nready == -1)
+		tst_brk(TBROK | TERRNO,
+				"Error on poll");
+
+	nread = read(uffd, &msg, sizeof(msg));

SAFE_READ should work here too if you pass len_strict=1

Quoted 9 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +9 -0
+	if (nread <= 0)
+		tst_brk(TBROK | TERRNO, "Error on read");
+
+	if (msg.event != UFFD_EVENT_PAGEFAULT)
+		tst_brk(TBROK | TERRNO,
+				"Received unexpected UFFD_EVENT");
+
+	memset(copy_page, 'X', page_size);
+

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 89

Quoted 10 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +10 -0
+	uffdio_copy.src = (unsigned long) copy_page;
+
+	uffdio_copy.dst = (unsigned long) msg.arg.pagefault.address
+			& ~(page_size - 1);
+	uffdio_copy.len = page_size;
+	uffdio_copy.mode = 0;
+	uffdio_copy.copy = 0;
+	if (ioctl(uffd, UFFDIO_COPY, &uffdio_copy) == -1)
+		tst_brk(TBROK | TERRNO,
+				"ioctl returned error for UFFDIO_COPY");

SAFE_IOCTL

Quoted 12 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +12 -0
+	close(uffd);
+}
+
+static void run(void)
+{
+	long uffd;
+	pthread_t thr;
+	struct uffdio_api uffdio_api;
+	struct uffdio_register uffdio_register;
+	int thread_ret;
+
+	set_pages();

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 111

Quoted 10 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +10 -0
+
+	uffd = sys_userfaultfd(O_CLOEXEC | O_NONBLOCK);
+	if (uffd == -1)
+		tst_brk(TBROK | TERRNO,
+			"Could not create userfault file descriptor");
+
+	uffdio_api.api = UFFD_API;
+	uffdio_api.features = 0;
+	if (ioctl(uffd, UFFDIO_API, &uffdio_api) == -1)
+		tst_brk(TBROK | TERRNO, "ioctl returned error for UFFDIO_API");

SAFE_IOCTL

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 119

Quoted 8 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +8 -0
+
+	uffdio_register.range.start = (unsigned long) page;
+	uffdio_register.range.len = page_size;
+	uffdio_register.mode = UFFDIO_REGISTER_MODE_MISSING;
+
+	if (ioctl(uffd, UFFDIO_REGISTER, &uffdio_register) == -1)
+		tst_brk(TBROK | TERRNO,
+			"ioctl returned error for UFFDIO_REGISTER");

SAFE_IOCTL

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 122

Quoted 3 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +3 -0
+
+	thread_ret = pthread_create(&thr, NULL,
+			handle_thread, (void *) uffd);

SAFE_PTHREAD_CREATE

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 135

Quoted 13 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +13 -0
+	if (thread_ret != 0) {
+		errno = thread_ret;
+		tst_brk(TBROK | TERRNO, "Could not create pthread");
+	}
+
+	char c = page[0xf];
+
+	if (c == 'X')
+		tst_res(TPASS, "Pagefault handled!");
+	else
+		tst_res(TFAIL, "Pagefault not handled!");
+
+	pthread_join(thr, NULL);

SAFE_PTHREAD_JOIN

Regards,
Jan

Quoted 14 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +7 -1
+}
+
+static struct tst_test test = {
+	.test_all = run,
+	.min_kver = "4.3",
+	.timeout = 20
+};
--

2.16.4

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

#2 lore raw

PATCH v2 1/1 syscall: Add userfaultfd testcase

Hi Christian,

some explanation below.

Quoted 7 lines

Hi,

my main concern is that direct include of linux header.

Other than that it looks ok, but you could use more SAFE_ macros which do the common checks and print error messages for you.

Quoted 7 lines

<snip>

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 29

Quoted 3 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +3 -0
+#include "tst_test.h"
+#include "lapi/syscalls.h"
+#include <linux/userfaultfd.h>

This doesn't look like it will compile on older kernels.

Please add linux/userfaultfd.h to AC_CHECK_HEADERS in configure.ac and use #ifdef HAVE_LINUX_USERFAULTFD_H guard and TST_TEST_TCONF with error message.

...

Quoted 9 lines

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 48

Quoted 7 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +7 -0
+static void set_pages(void)
+{
+	page_size = sysconf(_SC_PAGE_SIZE);
+	page = mmap(NULL, page_size, PROT_READ | PROT_WRITE,
+			MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
+	copy_page = mmap(NULL, page_size, PROT_READ | PROT_WRITE,
+			MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);

Please use SAFE_MMAP

There are many of SAFE_*() macro helpers, which are supposed to be used (see include/tst_safe_*.h and doc [1])

Kind regards,
Petr

[1] https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c

#3 lore raw

PATCH v2 1/1 syscall: Add userfaultfd testcase

In reply to Jan Stancek

Hi Jan,

Quoted 6 lines

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 65

Quoted 4 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +4 -0
+
+	pollfd.fd = uffd;
+	pollfd.events = POLLIN;
+	nready = poll(&pollfd, 1, -1);

SAFE_POLL

We don't have SAFE_POLL() (yet).

Kind regards,
Petr

#4 lore raw

PATCH v2 1/1 syscall: Add userfaultfd testcase

----- Original Message -----

Quoted 10 lines

Hi Jan,

Quoted 6 lines

testcases/kernel/syscalls/userfaultfd/userfaultfd01.c line 65

Quoted 4 lines
testcases/kernel/syscalls/userfaultfd/userfaultfd01.c new file +4 -0
+
+	pollfd.fd = uffd;
+	pollfd.events = POLLIN;
+	nready = poll(&pollfd, 1, -1);

SAFE_POLL

We don't have SAFE_POLL() (yet).

You're right, ignore this comment.

Quoted 5 lines

Kind regards,
Petr