Skip to contentSkip to conversation

watchqueue testing suite

PATCH New Andrea Cervesato via ltp 1 participant 11 messages Jan 7, 2022

lore
Share & tools
lore
#0 lore raw

v2 cover watchqueue testing suite

This patch-set add a new testing suite for the watch queue kernel feature described in https://www.kernel.org/doc/html/latest/watch_queue.html

Andrea Cervesato (10):
Add lapi/watch_queue.h header fallback
Add wqueue01 test
Add wqueue02 test
Add wqueue03 test
Add wqueue04 test
Add wqueue05 test
Add wqueue06 test
Add wqueue07 test
Add wqueue08 test
Add wqueue09 test

 include/lapi/watch_queue.h             | 112 +++++++++++++++++++++
 runtest/watchqueue                     |   9 ++
 scenario_groups/default                |   1 +
 testcases/kernel/Makefile              |   1 +
 testcases/kernel/watchqueue/.gitignore |   9 ++
 testcases/kernel/watchqueue/Makefile   |   8 ++
 testcases/kernel/watchqueue/common.h   | 132 +++++++++++++++++++++++++
 testcases/kernel/watchqueue/wqueue01.c |  41 ++++++++
 testcases/kernel/watchqueue/wqueue02.c |  41 ++++++++
 testcases/kernel/watchqueue/wqueue03.c |  41 ++++++++
 testcases/kernel/watchqueue/wqueue04.c |  41 ++++++++
 testcases/kernel/watchqueue/wqueue05.c |  41 ++++++++
 testcases/kernel/watchqueue/wqueue06.c |  40 ++++++++
 testcases/kernel/watchqueue/wqueue07.c |  41 ++++++++
 testcases/kernel/watchqueue/wqueue08.c |  45 +++++++++
 testcases/kernel/watchqueue/wqueue09.c |  53 ++++++++++
 16 files changed, 656 insertions(+)
 create mode 100644 include/lapi/watch_queue.h
 create mode 100644 runtest/watchqueue
 create mode 100644 testcases/kernel/watchqueue/.gitignore
 create mode 100644 testcases/kernel/watchqueue/Makefile
 create mode 100644 testcases/kernel/watchqueue/common.h
 create mode 100644 testcases/kernel/watchqueue/wqueue01.c
 create mode 100644 testcases/kernel/watchqueue/wqueue02.c
 create mode 100644 testcases/kernel/watchqueue/wqueue03.c
 create mode 100644 testcases/kernel/watchqueue/wqueue04.c
 create mode 100644 testcases/kernel/watchqueue/wqueue05.c
 create mode 100644 testcases/kernel/watchqueue/wqueue06.c
 create mode 100644 testcases/kernel/watchqueue/wqueue07.c
 create mode 100644 testcases/kernel/watchqueue/wqueue08.c
 create mode 100644 testcases/kernel/watchqueue/wqueue09.c
Signature · 5 lines
2.34.1


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

PATCH v2 1/10 Add lapi/watch_queue.h header fallback

---
 include/lapi/watch_queue.h | 112 +++++++++++++++++++++++++++++++++++++
 1 file changed, 112 insertions(+)
 create mode 100644 include/lapi/watch_queue.h
include/lapi/watch_queue.h new file +112 -0
new file mode 100644
index 000000000..438e62239
@@ -0,0 +1,112 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (C) 2021 SUSE LLC Andrea Cervesato <[email protected]>
+ *
+ * This file is created to resolve conflicts between user space and kernel
+ * space fctnl.h declaration. linux/watch_queue.h is not handled, since
+ * user space fcntl.h redefines kernel space structures.
+ */
+
+#ifndef LAPI_WATCH_QUEUE_H__
+#define LAPI_WATCH_QUEUE_H__
+
+#include <stdint.h>
+#include "lapi/ioctl.h"
+#include "lapi/fcntl.h"
+
+#define O_NOTIFICATION_PIPE	O_EXCL	/* Parameter to pipe2() selecting notification pipe */
+
+#define IOC_WATCH_QUEUE_SET_SIZE	_IO('W', 0x60)	/* Set the size in pages */
+#define IOC_WATCH_QUEUE_SET_FILTER	_IO('W', 0x61)	/* Set the filter */
+
+enum watch_notification_type {
+	WATCH_TYPE_META		= 0,	/* Special record */
+	WATCH_TYPE_KEY_NOTIFY	= 1,	/* Key change event notification */
+	WATCH_TYPE__NR		= 2
+};
+
+enum watch_meta_notification_subtype {
+	WATCH_META_REMOVAL_NOTIFICATION	= 0,	/* Watched object was removed */
+	WATCH_META_LOSS_NOTIFICATION	= 1,	/* Data loss occurred */
+};
+
+/*
+ * Notification record header.  This is aligned to 64-bits so that subclasses
+ * can contain __u64 fields.
+ */
+struct watch_notification {
+	uint32_t			type:24;	/* enum watch_notification_type */
+	uint32_t			subtype:8;	/* Type-specific subtype (filterable) */
+	uint32_t			info;
+#define WATCH_INFO_LENGTH	0x0000007f	/* Length of record */
+#define WATCH_INFO_LENGTH__SHIFT 0
+#define WATCH_INFO_ID		0x0000ff00	/* ID of watchpoint */
+#define WATCH_INFO_ID__SHIFT	8
+#define WATCH_INFO_TYPE_INFO	0xffff0000	/* Type-specific info */
+#define WATCH_INFO_TYPE_INFO__SHIFT 16
+#define WATCH_INFO_FLAG_0	0x00010000	/* Type-specific info, flag bit 0 */
+#define WATCH_INFO_FLAG_1	0x00020000	/* ... */
+#define WATCH_INFO_FLAG_2	0x00040000
+#define WATCH_INFO_FLAG_3	0x00080000
+#define WATCH_INFO_FLAG_4	0x00100000
+#define WATCH_INFO_FLAG_5	0x00200000
+#define WATCH_INFO_FLAG_6	0x00400000
+#define WATCH_INFO_FLAG_7	0x00800000
+};
+
+/*
+ * Notification filtering rules (IOC_WATCH_QUEUE_SET_FILTER).
+ */
+struct watch_notification_type_filter {
+	uint32_t	type;			/* Type to apply filter to */
+	uint32_t	info_filter;		/* Filter on watch_notification::info */
+	uint32_t	info_mask;		/* Mask of relevant bits in info_filter */
+	uint32_t	subtype_filter[8];	/* Bitmask of subtypes to filter on */
+};
+
+struct watch_notification_filter {
+	uint32_t	nr_filters;		/* Number of filters */
+	uint32_t	__reserved;		/* Must be 0 */
+	struct watch_notification_type_filter filters[];
+};
+
+
+/*
+ * Extended watch removal notification.  This is used optionally if the type
+ * wants to indicate an identifier for the object being watched, if there is
+ * such.  This can be distinguished by the length.
+ *
+ * type -> WATCH_TYPE_META
+ * subtype -> WATCH_META_REMOVAL_NOTIFICATION
+ */
+struct watch_notification_removal {
+	struct watch_notification watch;
+	uint64_t	id;		/* Type-dependent identifier */
+};
+
+/*
+ * Type of key/keyring change notification.
+ */
+enum key_notification_subtype {
+	NOTIFY_KEY_INSTANTIATED	= 0, /* Key was instantiated (aux is error code) */
+	NOTIFY_KEY_UPDATED	= 1, /* Key was updated */
+	NOTIFY_KEY_LINKED	= 2, /* Key (aux) was added to watched keyring */
+	NOTIFY_KEY_UNLINKED	= 3, /* Key (aux) was removed from watched keyring */
+	NOTIFY_KEY_CLEARED	= 4, /* Keyring was cleared */
+	NOTIFY_KEY_REVOKED	= 5, /* Key was revoked */
+	NOTIFY_KEY_INVALIDATED	= 6, /* Key was invalidated */
+	NOTIFY_KEY_SETATTR	= 7, /* Key's attributes got changed */
+};
+
+/*
+ * Key/keyring notification record.
+ * - watch.type = WATCH_TYPE_KEY_NOTIFY
+ * - watch.subtype = enum key_notification_type
+ */
+struct key_notification {
+	struct watch_notification watch;
+	uint32_t	key_id;		/* The key/keyring affected */
+	uint32_t	aux;		/* Per-type auxiliary data */
+};
+
+#endif /* LAPI_WATCH_QUEUE_H__ */
Signature · 5 lines
2.34.1


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

PATCH v2 2/10 Add wqueue01 test

In reply to Andrea Cervesato via ltp

This test is testing NOTIFY_KEY_UPDATED event

---
 runtest/watchqueue                     |   1 +
 scenario_groups/default                |   1 +
 testcases/kernel/Makefile              |   1 +
 testcases/kernel/watchqueue/.gitignore |   1 +
 testcases/kernel/watchqueue/Makefile   |   8 ++
 testcases/kernel/watchqueue/common.h   | 132 +++++++++++++++++++++++++
 testcases/kernel/watchqueue/wqueue01.c |  41 ++++++++
 7 files changed, 185 insertions(+)
 create mode 100644 runtest/watchqueue
 create mode 100644 testcases/kernel/watchqueue/.gitignore
 create mode 100644 testcases/kernel/watchqueue/Makefile
 create mode 100644 testcases/kernel/watchqueue/common.h
 create mode 100644 testcases/kernel/watchqueue/wqueue01.c
runtest/watchqueue new file +1 -0
new file mode 100644
index 000000000..782577d6d
@@ -0,0 +1 @@
+wqueue01 wqueue01
scenario_groups/default +1 -0
index 1dc2987d5..68bd5300d 100644
@@ -30,3 +30,4 @@ cve
 crypto
 kernel_misc
 uevent
+watchqueue
testcases/kernel/Makefile +1 -0
index 4604f1f38..d44856c57 100644
@@ -38,6 +38,7 @@ SUBDIRS			+= connectors \
 			   sound \
 			   tracing \
 			   uevents \
+			   watchqueue \
 
 ifeq ($(WITH_POWER_MANAGEMENT_TESTSUITE),yes)
 SUBDIRS			+= power_management
testcases/kernel/watchqueue/.gitignore new file +1 -0
new file mode 100644
index 000000000..c61ac6165
@@ -0,0 +1 @@
+wqueue01
testcases/kernel/watchqueue/Makefile new file +8 -0
new file mode 100644
index 000000000..0008b8cc4
@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+top_srcdir			?= ../../..
+
+LDLIBS += $(KEYUTILS_LIBS)
+
+include $(top_srcdir)/include/mk/testcases.mk
+include $(top_srcdir)/include/mk/generic_leaf_target.mk
testcases/kernel/watchqueue/common.h new file +132 -0

132 lines not on this page · raw message

testcases/kernel/watchqueue/wqueue01.c new file +41 -0

41 lines not on this page · raw message

Signature · 5 lines
2.34.1


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

PATCH v2 3/10 Add wqueue02 test

In reply to Andrea Cervesato via ltp

This test is testing NOTIFY_KEY_UNLINKED event

---
 runtest/watchqueue                     |  1 +
 testcases/kernel/watchqueue/.gitignore |  1 +
 testcases/kernel/watchqueue/wqueue02.c | 41 ++++++++++++++++++++++++++
 3 files changed, 43 insertions(+)
 create mode 100644 testcases/kernel/watchqueue/wqueue02.c
runtest/watchqueue +1 -0
index 782577d6d..0d442ff01 100644
@@ -1 +1,2 @@
 wqueue01 wqueue01
+wqueue02 wqueue02
testcases/kernel/watchqueue/.gitignore +1 -0
index c61ac6165..4f8695201 100644
@@ -1 +1,2 @@
 wqueue01
+wqueue02
testcases/kernel/watchqueue/wqueue02.c new file +41 -0

41 lines not on this page · raw message

Signature · 5 lines
2.34.1


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

PATCH v2 4/10 Add wqueue03 test

In reply to Andrea Cervesato via ltp

This test is testing NOTIFY_KEY_REVOKED event

---
 runtest/watchqueue                     |  1 +
 testcases/kernel/watchqueue/.gitignore |  1 +
 testcases/kernel/watchqueue/wqueue03.c | 41 ++++++++++++++++++++++++++
 3 files changed, 43 insertions(+)
 create mode 100644 testcases/kernel/watchqueue/wqueue03.c
runtest/watchqueue +1 -0
index 0d442ff01..0606db1e0 100644
@@ -1,2 +1,3 @@
 wqueue01 wqueue01
 wqueue02 wqueue02
+wqueue03 wqueue03
testcases/kernel/watchqueue/.gitignore +1 -0
index 4f8695201..36a7473d8 100644
@@ -1,2 +1,3 @@
 wqueue01
 wqueue02
+wqueue03
testcases/kernel/watchqueue/wqueue03.c new file +41 -0

41 lines not on this page · raw message

Signature · 5 lines
2.34.1


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

PATCH v2 5/10 Add wqueue04 test

In reply to Andrea Cervesato via ltp

This test is testing NOTIFY_KEY_LINKED event

---
 runtest/watchqueue                     |  1 +
 testcases/kernel/watchqueue/.gitignore |  1 +
 testcases/kernel/watchqueue/wqueue04.c | 41 ++++++++++++++++++++++++++
 3 files changed, 43 insertions(+)
 create mode 100644 testcases/kernel/watchqueue/wqueue04.c
runtest/watchqueue +1 -0
index 0606db1e0..cd897f4b4 100644
@@ -1,3 +1,4 @@
 wqueue01 wqueue01
 wqueue02 wqueue02
 wqueue03 wqueue03
+wqueue04 wqueue04
testcases/kernel/watchqueue/.gitignore +1 -0
index 36a7473d8..469efd595 100644
@@ -1,3 +1,4 @@
 wqueue01
 wqueue02
 wqueue03
+wqueue04
\ No newline at end of file
testcases/kernel/watchqueue/wqueue04.c new file +41 -0

41 lines not on this page · raw message

Signature · 5 lines
2.34.1


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

PATCH v2 6/10 Add wqueue05 test

In reply to Andrea Cervesato via ltp

This test is testing NOTIFY_KEY_INVALIDATED event

---
 runtest/watchqueue                     |  1 +
 testcases/kernel/watchqueue/.gitignore |  3 +-
 testcases/kernel/watchqueue/wqueue05.c | 41 ++++++++++++++++++++++++++
 3 files changed, 44 insertions(+), 1 deletion(-)
 create mode 100644 testcases/kernel/watchqueue/wqueue05.c
runtest/watchqueue +1 -0
index cd897f4b4..596d45154 100644
@@ -2,3 +2,4 @@ wqueue01 wqueue01
 wqueue02 wqueue02
 wqueue03 wqueue03
 wqueue04 wqueue04
+wqueue05 wqueue05
testcases/kernel/watchqueue/.gitignore +2 -1
index 469efd595..d3e563a04 100644
@@ -1,4 +1,5 @@
 wqueue01
 wqueue02
 wqueue03
-wqueue04
\ No newline at end of file
+wqueue04
+wqueue05
\ No newline at end of file
testcases/kernel/watchqueue/wqueue05.c new file +41 -0

41 lines not on this page · raw message

Signature · 5 lines
2.34.1


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

PATCH v2 7/10 Add wqueue06 test

In reply to Andrea Cervesato via ltp

This test is testing NOTIFY_KEY_CLEARED event

---
 runtest/watchqueue                     |  1 +
 testcases/kernel/watchqueue/.gitignore |  3 +-
 testcases/kernel/watchqueue/wqueue06.c | 40 ++++++++++++++++++++++++++
 3 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 testcases/kernel/watchqueue/wqueue06.c
runtest/watchqueue +1 -0
index 596d45154..de086b6a7 100644
@@ -3,3 +3,4 @@ wqueue02 wqueue02
 wqueue03 wqueue03
 wqueue04 wqueue04
 wqueue05 wqueue05
+wqueue06 wqueue06
testcases/kernel/watchqueue/.gitignore +2 -1
index d3e563a04..c3253f684 100644
@@ -2,4 +2,5 @@ wqueue01
 wqueue02
 wqueue03
 wqueue04
-wqueue05
\ No newline at end of file
+wqueue05
+wqueue06
\ No newline at end of file
testcases/kernel/watchqueue/wqueue06.c new file +40 -0
new file mode 100644
index 000000000..5b3a72b87
@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (C) 2021 SUSE LLC Andrea Cervesato <[email protected]>
+ */
+
+/*\
+ * [Description]
+ *
+ * Test if keyctl clear is correctly recognized by watch queue.
+ */
+
+#include "tst_test.h"
+#include "lapi/keyctl.h"
+#include "common.h"
+
+static void saw_key_cleared(struct watch_notification *n, size_t len, unsigned int wtype)
+{
+	if (wqueue_key_event(n, len, wtype, NOTIFY_KEY_CLEARED))
+		tst_res(TPASS, "keyctl clear has been recognized");
+	else
+		tst_res(TFAIL, "keyctl clear has not been recognized");
+}
+
+static void run(void)
+{
+	int fd;
+
+	fd = wqueue_watch(256, &wqueue_filter);
+	wqueue_add_key(fd);
+
+	keyctl(KEYCTL_CLEAR, KEY_SPEC_SESSION_KEYRING);
+	wqueue_consumer(fd, saw_key_cleared);
+
+	SAFE_CLOSE(fd);
+}
+
+static struct tst_test test = {
+	.test_all = run,
+	.needs_root = 1,
+};
Signature · 5 lines
2.34.1


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

PATCH v2 8/10 Add wqueue07 test

In reply to Andrea Cervesato via ltp

This test is testing NOTIFY_KEY_SETATTR event

---
 runtest/watchqueue                     |  1 +
 testcases/kernel/watchqueue/.gitignore |  3 +-
 testcases/kernel/watchqueue/wqueue07.c | 41 ++++++++++++++++++++++++++
 3 files changed, 44 insertions(+), 1 deletion(-)
 create mode 100644 testcases/kernel/watchqueue/wqueue07.c
runtest/watchqueue +1 -0
index de086b6a7..bdb461018 100644
@@ -4,3 +4,4 @@ wqueue03 wqueue03
 wqueue04 wqueue04
 wqueue05 wqueue05
 wqueue06 wqueue06
+wqueue07 wqueue07
testcases/kernel/watchqueue/.gitignore +2 -1
index c3253f684..0d64c110c 100644
@@ -3,4 +3,5 @@ wqueue02
 wqueue03
 wqueue04
 wqueue05
-wqueue06
\ No newline at end of file
+wqueue06
+wqueue07
\ No newline at end of file
testcases/kernel/watchqueue/wqueue07.c new file +41 -0

41 lines not on this page · raw message

Signature · 5 lines
2.34.1


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

PATCH v2 9/10 Add wqueue08 test

In reply to Andrea Cervesato via ltp

This test is testing WATCH_META_REMOVAL_NOTIFICATION event

---
 runtest/watchqueue                     |  1 +
 testcases/kernel/watchqueue/.gitignore |  3 +-
 testcases/kernel/watchqueue/wqueue08.c | 45 ++++++++++++++++++++++++++
 3 files changed, 48 insertions(+), 1 deletion(-)
 create mode 100644 testcases/kernel/watchqueue/wqueue08.c
runtest/watchqueue +1 -0
index bdb461018..badf7afb0 100644
@@ -5,3 +5,4 @@ wqueue04 wqueue04
 wqueue05 wqueue05
 wqueue06 wqueue06
 wqueue07 wqueue07
+wqueue08 wqueue08
testcases/kernel/watchqueue/.gitignore +2 -1
index 0d64c110c..56ede9fc5 100644
@@ -4,4 +4,5 @@ wqueue03
 wqueue04
 wqueue05
 wqueue06
-wqueue07
\ No newline at end of file
+wqueue07
+wqueue08
\ No newline at end of file
testcases/kernel/watchqueue/wqueue08.c new file +45 -0

45 lines not on this page · raw message

Signature · 5 lines
2.34.1


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

PATCH v2 10/10 Add wqueue09 test

In reply to Andrea Cervesato via ltp

This test is testing WATCH_META_LOSS_NOTIFICATION event

---
 runtest/watchqueue                     |  1 +
 testcases/kernel/watchqueue/.gitignore |  3 +-
 testcases/kernel/watchqueue/wqueue09.c | 53 ++++++++++++++++++++++++++
 3 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100644 testcases/kernel/watchqueue/wqueue09.c
runtest/watchqueue +1 -0
index badf7afb0..bd6b0a423 100644
@@ -6,3 +6,4 @@ wqueue05 wqueue05
 wqueue06 wqueue06
 wqueue07 wqueue07
 wqueue08 wqueue08
+wqueue09 wqueue09
testcases/kernel/watchqueue/.gitignore +2 -1
index 56ede9fc5..9ea33b701 100644
@@ -5,4 +5,5 @@ wqueue04
 wqueue05
 wqueue06
 wqueue07
-wqueue08
\ No newline at end of file
+wqueue08
+wqueue09
\ No newline at end of file
testcases/kernel/watchqueue/wqueue09.c new file +53 -0

53 lines not on this page · raw message

Signature · 5 lines
2.34.1


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