Skip to contentSkip to conversation

futex: Add error coverage tests for wait, wake and cmp_requeue

PATCH Superseded Michael Menasherov via ltp 2 participants 2 messages Apr 12 – Apr 13

v1 of 17 Superseded Latest is v17 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 futex: Add error coverage tests for wait, wake and cmp_requeue

Improve error handling coverage for futex syscalls by adding tests for missing error conditions that were previously untested.

futex_wait06 verifies EFAULT is returned when uaddr or timeout points to unmapped memory.

futex_wait07 verifies EINTR is returned when futex_wait() is interrupted by a signal.

futex_wake05 verifies EFAULT is returned when uaddr points to unmapped or PROT_NONE memory.

futex_cmp_requeue03 verifies EFAULT is returned when uaddr or uaddr2 points to unmapped memory, and EACCES or EFAULT when uaddr points to memory without read permission (PROT_NONE). The EACCES behavior was introduced in kernel 5.9.

---
 runtest/syscalls                              |   4 +
 testcases/kernel/syscalls/futex/.gitignore    |   4 +
 .../syscalls/futex/futex_cmp_requeue03.c      | 102 ++++++++++++++++
 .../kernel/syscalls/futex/futex_wait06.c      |  81 +++++++++++++
 .../kernel/syscalls/futex/futex_wait07.c      | 114 ++++++++++++++++++
 .../kernel/syscalls/futex/futex_wake05.c      |  85 +++++++++++++
 6 files changed, 390 insertions(+)
 create mode 100644 testcases/kernel/syscalls/futex/futex_cmp_requeue03.c
 create mode 100644 testcases/kernel/syscalls/futex/futex_wait06.c
 create mode 100644 testcases/kernel/syscalls/futex/futex_wait07.c
 create mode 100644 testcases/kernel/syscalls/futex/futex_wake05.c
runtest/syscalls +4 -0
index 6ba0227a8..6c12dc225 100644
@@ -1859,11 +1859,14 @@ perf_event_open02 perf_event_open02
 
 futex_cmp_requeue01 futex_cmp_requeue01
 futex_cmp_requeue02 futex_cmp_requeue02
+futex_cmp_requeue03 futex_cmp_requeue03
 futex_wait01 futex_wait01
 futex_wait02 futex_wait02
 futex_wait03 futex_wait03
 futex_wait04 futex_wait04
 futex_wait05 futex_wait05
+futex_wait06 futex_wait06
+futex_wait07 futex_wait07
 futex_waitv01 futex_waitv01
 futex_waitv02 futex_waitv02
 futex_waitv03 futex_waitv03
@@ -1871,6 +1874,7 @@ futex_wake01 futex_wake01
 futex_wake02 futex_wake02
 futex_wake03 futex_wake03
 futex_wake04 futex_wake04
+futex_wake05 futex_wake05
 futex_wait_bitset01 futex_wait_bitset01
 
 memfd_create01 memfd_create01
testcases/kernel/syscalls/futex/.gitignore +4 -0
index 9d08ba7d3..c47d39b5b 100644
@@ -1,15 +1,19 @@
 /futex_cmp_requeue01
 /futex_cmp_requeue02
+/futex_cmp_requeue03
 /futex_wait01
 /futex_wait02
 /futex_wait03
 /futex_wait04
 /futex_wait05
+/futex_wait06
+/futex_wait07
 /futex_wait_bitset01
 /futex_wake01
 /futex_wake02
 /futex_wake03
 /futex_wake04
+/futex_wake05
 /futex_waitv01
 /futex_waitv02
 /futex_waitv03
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +102 -0

102 lines not on this page · raw message

testcases/kernel/syscalls/futex/futex_wait06.c new file +81 -0

81 lines not on this page · raw message

testcases/kernel/syscalls/futex/futex_wait07.c new file +114 -0

114 lines not on this page · raw message

testcases/kernel/syscalls/futex/futex_wake05.c new file +85 -0

85 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 Michael,

Quoted 11 lines

Improve error handling coverage for futex syscalls by adding tests for missing error conditions that were previously untested.

futex_wait06 verifies EFAULT is returned when uaddr or timeout points to unmapped memory.

futex_wait07 verifies EINTR is returned when futex_wait() is interrupted by a signal.

futex_wake05 verifies EFAULT is returned when uaddr points to unmapped or PROT_NONE memory.

Thanks for sending this on ML (instead of continuing in GitHub PR). It would help if you looked into some recently converted tests to new LTP API to avoid common errors.

You should add your SOB:

(or whatever email address you prefer)
https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin
(That is even in .github/pull_request_template.md, which content you have seen when opening your previous effort https://github.com/linux-test-project/ltp/pull/1301.)

Quoted 16 lines

futex_cmp_requeue03 verifies EFAULT is returned when uaddr or uaddr2 points to unmapped memory, and EACCES or EFAULT when uaddr points to memory without read permission (PROT_NONE). The EACCES behavior was introduced in kernel 5.9.

---
 runtest/syscalls                              |   4 +
 testcases/kernel/syscalls/futex/.gitignore    |   4 +
 .../syscalls/futex/futex_cmp_requeue03.c      | 102 ++++++++++++++++
 .../kernel/syscalls/futex/futex_wait06.c      |  81 +++++++++++++
 .../kernel/syscalls/futex/futex_wait07.c      | 114 ++++++++++++++++++
 .../kernel/syscalls/futex/futex_wake05.c      |  85 +++++++++++++
 6 files changed, 390 insertions(+)
 create mode 100644 testcases/kernel/syscalls/futex/futex_cmp_requeue03.c
 create mode 100644 testcases/kernel/syscalls/futex/futex_wait06.c
 create mode 100644 testcases/kernel/syscalls/futex/futex_wait07.c
 create mode 100644 testcases/kernel/syscalls/futex/futex_wake05.c

...

testcases/kernel/syscalls/futex/futex_cmp_requeue03.c line 3

Quoted 9 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +3 -0
new file mode 100644
index 000000000..66b18614d
@@ -0,0 +1,102 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (C) 2024 Red Hat, Inc.

nit: Not sure why 2024, maybe you base it on older code. But there should be 2026 as it's also new code, right?

testcases/kernel/syscalls/futex/futex_cmp_requeue03.c line 4

Quoted 1 line
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +1 -0
+ *

Please use this to start comment:

/*\

That helps to add the test in test catalog.
https://linux-test-project.readthedocs.io/en/latest/users/test_catalog.html

testcases/kernel/syscalls/futex/futex_cmp_requeue03.c line 7

Quoted 3 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +3 -0
+ * Check that futex(FUTEX_CMP_REQUEUE) returns EFAULT when uaddr or
+ * uaddr2 points to unmapped memory, and EACCES when uaddr points to
+ * memory without read permission (PROT_NONE).

NOTE: we always want to match error to exact errno, even on a different kernel version.

Quoted 17 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +17 -0
+ */
+
+#include <errno.h>
+#include <sys/mman.h>
+
+#include "futextest.h"
+
+static futex_t futex = FUTEX_INITIALIZER;
+static void *unmapped_addr;
+static void *prot_none_addr;
+
+static struct futex_test_variants variants[] = {
+#if (__NR_futex != __LTP__NR_INVALID_SYSCALL)
+	{ .fntype = FUTEX_FN_FUTEX, .desc = "syscall with old kernel spec"},
+#endif
+
+#if (__NR_futex_time64 != __LTP__NR_INVALID_SYSCALL)

testcases/kernel/syscalls/futex/futex_cmp_requeue03.c line 34

Quoted 10 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +10 -0
+	{ .fntype = FUTEX_FN_FUTEX64, .desc = "syscall time64 with kernel spec"},
+#endif
+};
+
+static struct testcase {
+	const char *desc;
+	/* 1 = uaddr is bad, 0 = uaddr2 is bad */
+	int bad_uaddr;
+	/* 1 = PROT_NONE address, 0 = unmapped address */
+	int use_prot_none;

Why don't define directly pointers to futex_t andd assign static address to it?

static struct testcase {
	const char *desc;
	futex_t *uaddr;
	futex_t *uaddr2;
	int exp_errno;
} testcases[] = {

{ .desc = "uaddr unmapped", .uaddr = (futex_t *)&unmapped_addr, .uaddr2 = &futex, .exp_errno = EFAULT }, { .desc = "uaddr2 unmapped", .uaddr = &futex, .uaddr2 = (futex_t *)&unmapped_addr, .exp_errno = EFAULT }, { .desc = "uaddr PROT_NONE", .uaddr = (futex_t *)&prot_none_addr, .uaddr2 = &futex, .exp_errno = EACCES },
}

You specify in the commit message that EACCES behavior changed for kernel 5.9 from EFAULT to EACCES. Therefore in setup() you should check for a kernel versions, have look at testcases/kernel/syscalls/listmount/listmount04.c.

testcases/kernel/syscalls/futex/futex_cmp_requeue03.c line 38

Quoted 4 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +4 -0
+} testcases[] = {
+	{ "uaddr unmapped", 1, 0 },
+	{ "uaddr2 unmapped", 0, 0 },
+	{ "uaddr PROT_NONE", 1, 1 },

Please use designated initializers, that allows avoid having to specify 0 or NULL.

Quoted 13 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +13 -0
+};
+
+static void run(unsigned int n)
+{
+	struct futex_test_variants *tv = &variants[tst_variant];
+	struct testcase *tc = &testcases[n];
+	futex_t *bad;
+	futex_t *uaddr, *uaddr2;
+	int res;
+
+	if (tc->use_prot_none)
+		bad = (futex_t *)prot_none_addr;
+	else

testcases/kernel/syscalls/futex/futex_cmp_requeue03.c line 61

Quoted 10 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +10 -0
+		bad = (futex_t *)unmapped_addr;
+
+	/* Assign bad address to uaddr or uaddr2, keep the other valid. */
+	if (tc->bad_uaddr) {
+		uaddr = bad;
+		uaddr2 = &futex;
+	} else {
+		uaddr = &futex;
+		uaddr2 = bad;
+	}

All this will not be needed once you just pass the pointers in test struct.

testcases/kernel/syscalls/futex/futex_cmp_requeue03.c line 72

Quoted 11 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +11 -0
+
+	res = futex_cmp_requeue(tv->fntype, uaddr, futex, uaddr2, 1, 1, 0);
+	if (res != -1) {
+		tst_res(TFAIL, "futex_cmp_requeue() succeeded unexpectedly for '%s'", tc->desc);
+		return;
+	}
+	if (errno != EFAULT && errno != EACCES) {
+		tst_res(TFAIL | TERRNO, "futex_cmp_requeue() failed with unexpected error for '%s', expected EFAULT or EACCES",tc->desc);
+		return;
+	}
+	tst_res(TPASS | TERRNO, "futex_cmp_requeue() failed as expected for '%s'", tc->desc);

This should be shortened by using TST_EXP_FAIL().
https://linux-test-project.readthedocs.io/en/latest/developers/api_c_tests.html#macro-tst-exp-fail

We want to specify single errno, but FYI we have also TST_EXP_FAIL_ARR().
https://linux-test-project.readthedocs.io/en/latest/developers/api_c_tests.html#macro-tst-exp-fail-arr

Quoted 11 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +11 -0
+}
+
+static void setup(void)
+{
+	struct futex_test_variants *tv = &variants[tst_variant];
+	size_t pagesize = getpagesize();
+
+	tst_res(TINFO, "Testing variant: %s", tv->desc);
+	futex_supported_by_kernel(tv->fntype);
+
+	unmapped_addr = SAFE_MMAP(NULL, pagesize, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);

testcases/kernel/syscalls/futex/futex_cmp_requeue03.c line 93

Quoted 10 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +10 -0
+	SAFE_MUNMAP(unmapped_addr, pagesize);
+	/* PROT_NONE = mapped but no read permission, triggers EACCES or EFAULT */
+	prot_none_addr = SAFE_MMAP(NULL, pagesize, PROT_NONE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
+}
+
+static void cleanup(void)
+{
+	if (prot_none_addr) {
+		SAFE_MUNMAP(prot_none_addr, getpagesize());
+	}

You probably used make check for errors.
Please run it on rebased master, it will ask you to remove { }.

testcases/kernel/syscalls/futex/futex_wait06.c

Quoted 14 lines
testcases/kernel/syscalls/futex/futex_cmp_requeue03.c new file +9 -0
+}
+
+static struct tst_test test = {
+	.setup = setup,
+	.cleanup = cleanup,
+	.test = run,
+	.tcnt = ARRAY_SIZE(testcases),
+	.test_variants = ARRAY_SIZE(variants),
+};
testcases/kernel/syscalls/futex/futex_wait06.c new file +0 -0
new file mode 100644
index 000000000..1b9db0241

Most of previous comments apply to other tests as well.

testcases/kernel/syscalls/futex/futex_wait06.c line 5

Quoted 6 lines
testcases/kernel/syscalls/futex/futex_wait06.c new file +5 -0
@@ -0,0 +1,81 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (C) 2024 Red Hat, Inc.
+ *
+ * Check that futex(FUTEX_WAIT) returns EFAULT when:

You need to add blank space here to fix formatting of the doc.

To test generated doc you can:

$ make -C doc/ setup # creates doc/.venv/
$ make -C doc/
=> see doc/html/users/test_catalog.html

Unfortunately we don't any CI check for it (yet).

Quoted 17 lines
testcases/kernel/syscalls/futex/futex_wait06.c new file +16 -0
+ * 1) uaddr points to unmapped memory
+ * 2) timeout points to unmapped memory
+ */
 
+#include <errno.h>
+#include <sys/mman.h>
+
+#include "futextest.h"
+
+static futex_t futex = FUTEX_INITIALIZER;
+static void *bad_addr;
+
+static struct futex_test_variants variants[] = {
+#if (__NR_futex != __LTP__NR_INVALID_SYSCALL)
+	{ .fntype = FUTEX_FN_FUTEX, .tstype = TST_KERN_OLD_TIMESPEC, .desc = "syscall with old kernel spec"},
+#endif
+

testcases/kernel/syscalls/futex/futex_wait06.c line 31

Quoted 10 lines
testcases/kernel/syscalls/futex/futex_wait06.c new file +10 -0
+#if (__NR_futex_time64 != __LTP__NR_INVALID_SYSCALL)
+	{ .fntype = FUTEX_FN_FUTEX64, .tstype = TST_KERN_TIMESPEC, .desc = "syscall time64 with kernel spec"},
+#endif
+};
+
+static struct testcase {
+	const char *desc;
+} testcases[] = {
+	{ "uaddr points to unmapped memory" },
+	{ "timeout points to unmapped memory" },

If only desc was needed, it could be printed directly (no need for struct).

Kind regards,
Petr

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