[v4,03/11] Add wqueue01 test

This test is testing NOTIFY_KEY_UPDATED event

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.de>
---
 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   | 149 +++++++++++++++++++++++++
 testcases/kernel/watchqueue/wqueue01.c |  40 +++++++
 7 files changed, 217 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

Hi!
> Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.de>
> ---
>  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   | 149 +++++++++++++++++++++++++
>  testcases/kernel/watchqueue/wqueue01.c |  40 +++++++
>  7 files changed, 217 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
> 
> diff --git a/runtest/watchqueue b/runtest/watchqueue
> new file mode 100644
> index 000000000..bd6b0a423
> --- /dev/null
> +++ b/runtest/watchqueue
> @@ -0,0 +1,9 @@
> +wqueue01 wqueue01
> +wqueue02 wqueue02
> +wqueue03 wqueue03
> +wqueue04 wqueue04
> +wqueue05 wqueue05
> +wqueue06 wqueue06
> +wqueue07 wqueue07
> +wqueue08 wqueue08
> +wqueue09 wqueue09

While this is minor, such entries should be added with each respective
test.

> diff --git a/scenario_groups/default b/scenario_groups/default
> index 1dc2987d5..68bd5300d 100644
> --- a/scenario_groups/default
> +++ b/scenario_groups/default
> @@ -30,3 +30,4 @@ cve
>  crypto
>  kernel_misc
>  uevent
> +watchqueue
> diff --git a/testcases/kernel/Makefile b/testcases/kernel/Makefile
> index 4604f1f38..d44856c57 100644
> --- a/testcases/kernel/Makefile
> +++ b/testcases/kernel/Makefile
> @@ -38,6 +38,7 @@ SUBDIRS			+= connectors \
>  			   sound \
>  			   tracing \
>  			   uevents \
> +			   watchqueue \
>  
>  ifeq ($(WITH_POWER_MANAGEMENT_TESTSUITE),yes)
>  SUBDIRS			+= power_management
> diff --git a/testcases/kernel/watchqueue/.gitignore b/testcases/kernel/watchqueue/.gitignore
> new file mode 100644
> index 000000000..dcfcd8272
> --- /dev/null
> +++ b/testcases/kernel/watchqueue/.gitignore
> @@ -0,0 +1,9 @@
> +wqueue01
> +wqueue02
> +wqueue03
> +wqueue04
> +wqueue05
> +wqueue06
> +wqueue07
> +wqueue08
> +wqueue09

Same here.

> diff --git a/testcases/kernel/watchqueue/Makefile b/testcases/kernel/watchqueue/Makefile
> new file mode 100644
> index 000000000..896d66d42
> --- /dev/null
> +++ b/testcases/kernel/watchqueue/Makefile
> @@ -0,0 +1,8 @@
> +# SPDX-License-Identifier: GPL-2.0-or-later
> +
> +top_srcdir			?= ../../..
> +
> +include $(top_srcdir)/include/mk/testcases.mk
> +include $(top_srcdir)/include/mk/generic_leaf_target.mk
> +
> +LDLIBS += $(KEYUTILS_LIBS)
> diff --git a/testcases/kernel/watchqueue/common.h b/testcases/kernel/watchqueue/common.h
> new file mode 100644
> index 000000000..00d19b5bc
> --- /dev/null
> +++ b/testcases/kernel/watchqueue/common.h
> @@ -0,0 +1,149 @@
> +// SPDX-License-Identifier: GPL-2.0-or-later
> +/*
> + * Copyright (C) 2021 SUSE LLC Andrea Cervesato <andrea.cervesato@suse.com>
> + */
> +
> +#ifndef WQUEUE_COMMON_H__
> +#define WQUEUE_COMMON_H__
> +
> +#include "tst_test.h"
> +#include "lapi/watch_queue.h"
> +#include "lapi/keyctl.h"
> +
> +static struct watch_notification_filter wqueue_filter = {
> +	.nr_filters	= 2,
> +	.filters = {
> +		[0]	= {
> +			.type			= WATCH_TYPE_META,
> +			.subtype_filter[0]	= UINT_MAX,
> +		},
> +		[1]	= {
> +			.type			= WATCH_TYPE_KEY_NOTIFY,
> +			.subtype_filter[0]	= UINT_MAX,
> +		},
> +	},
> +};
> +
> +static inline int wqueue_key_event(struct watch_notification *n, size_t len, unsigned int wtype, int type)
> +{
> +	struct key_notification *k;
> +	const char* msg;
> +
> +	if (wtype != WATCH_TYPE_KEY_NOTIFY)
> +		return 0;
> +
> +	if (len != sizeof(struct key_notification))
> +		tst_brk(TBROK, "Incorrect key message length");
> +
> +	switch (n->subtype) {
> +		case NOTIFY_KEY_INSTANTIATED:
> +			msg = "instantiated";
> +			break;
> +		case NOTIFY_KEY_UPDATED:
> +			msg = "updated";
> +			break;
> +		case NOTIFY_KEY_LINKED:
> +			msg = "linked";
> +			break;
> +		case NOTIFY_KEY_UNLINKED:
> +			msg = "unlinked";
> +			break;
> +		case NOTIFY_KEY_CLEARED:
> +			msg = "cleared";
> +			break;
> +		case NOTIFY_KEY_REVOKED:
> +			msg = "revoked";
> +			break;
> +		case NOTIFY_KEY_INVALIDATED:
> +			msg = "invalidated";
> +			break;
> +		case NOTIFY_KEY_SETATTR:
> +			msg = "setattr";
> +			break;
> +		default:
> +			msg = "Invalid notification";
> +			break;
> +	};
> +
> +	k = (struct key_notification *)n;
> +	tst_res(TINFO, "KEY %08x change=%u[%s] aux=%u",
> +		k->key_id, n->subtype, msg, k->aux);
> +
> +	if (n->subtype == type)
> +		return 1;
> +
> +	return 0;
> +}
> +
> +static inline key_serial_t wqueue_add_key(int fd)
> +{
> +	key_serial_t key;
> +
> +	key = add_key("user", "ltptestkey", "a", 1, KEY_SPEC_SESSION_KEYRING);
> +	if (key == -1)
> +		tst_brk(TBROK, "add_key error: %s", tst_strerrno(errno));
> +
> +	keyctl(KEYCTL_WATCH_KEY, key, fd, 0x01);
> +	keyctl(KEYCTL_WATCH_KEY, KEY_SPEC_SESSION_KEYRING, fd, 0x02);
> +
> +	return key;
> +}
> +
> +static inline int wqueue_watch(int buf_size, struct watch_notification_filter *filter)
> +{
> +	int pipefd[2];
> +	int fd;
> +
> +	SAFE_PIPE2(pipefd, O_NOTIFICATION_PIPE);

We can get two different errors here that should be translated to TCONF.

If you look at watch_queue.h in the linux kernel sources it looks like:

#ifdef CONFIG_WATCH_QUEUE
...
#else
static inline int watch_queue_init(struct pipe_inode_info *pipe)
{
        return -ENOPKG;
}
#endif

So in the case that CONFIG_WATCH_QUEUE is not set pipe2() with
O_NOTIFICATION_PIPE will fail with errno set to ENOPKG.


And on kernels that are older than the watch queue implementation we will
trip over:

	if (flags & ~(O_CLOEXEC | O_NONBLOCK | O_DIRECT))
                return -EINVAL;

In the __do_pipe_flags() function and the call will fail with EINVAL
instead.

So this code should look like:

	TEST(pipe2(pipefd, O_NOTIFICATION_PIPE));
	if (TST_RET) {
		switch (TST_ERR) {
		case ENOPKG:
			tst_brk(TCONF | TTERRNO, "CONFIG_WATCH_QUEUE is not set");
		break;
		case EINVAL:
			tst_brk(TCONF | TTERRNO, "O_NOTIFICATION_PIPE is not supported");
		break;
		default:
			tst_brk(TBROK | TTERRNO, "pipe2() returned %ld", TST_RET);
		}
	}

> +	fd = pipefd[0];
> +
> +	SAFE_IOCTL(fd, IOC_WATCH_QUEUE_SET_SIZE, buf_size);
> +	SAFE_IOCTL(fd, IOC_WATCH_QUEUE_SET_FILTER, filter);
> +
> +	return fd;
> +}
> +
> +typedef void (*wqueue_callback) (struct watch_notification *n, size_t len, unsigned int wtype);
> +
> +static void wqueue_consumer(int fd, wqueue_callback cb)
> +{
> +	unsigned char buffer[433], *p, *end;
> +	union {
> +		struct watch_notification n;
> +		unsigned char buf1[128];
> +	} n;
> +	ssize_t buf_len;
> +
> +	tst_res(TINFO, "Reading watch queue events");
> +
> +	buf_len = SAFE_READ(0, fd, buffer, sizeof(buffer));
> +
> +	p = buffer;
> +	end = buffer + buf_len;
> +	while (p < end) {
> +		size_t largest, len;
> +
> +		largest = end - p;
> +		if (largest > 128)
> +			largest = 128;
> +
> +		if (largest < sizeof(struct watch_notification))
> +			tst_brk(TBROK, "Short message header: %zu", largest);
> +
> +		memcpy(&n, p, largest);
> +
> +		tst_res(TINFO, "NOTIFY[%03zx]: ty=%06x sy=%02x i=%08x",
> +				p - buffer, n.n.type, n.n.subtype, n.n.info);
> +
> +		len = n.n.info & WATCH_INFO_LENGTH;
> +		if (len < sizeof(n.n) || len > largest)
> +			tst_brk(TBROK, "Bad message length: %zu/%zu", len, largest);
> +
> +		cb(&n.n, len, n.n.type);
> +
> +		p += len;
> +	}
> +}
> +
> +#endif
> diff --git a/testcases/kernel/watchqueue/wqueue01.c b/testcases/kernel/watchqueue/wqueue01.c
> new file mode 100644
> index 000000000..24c3908ce
> --- /dev/null
> +++ b/testcases/kernel/watchqueue/wqueue01.c
> @@ -0,0 +1,40 @@
> +// SPDX-License-Identifier: GPL-2.0-or-later
> +/*
> + * Copyright (C) 2021 SUSE LLC Andrea Cervesato <andrea.cervesato@suse.com>
> + */
> +
> +/*\
> + * [Description]
> + *
> + * Test if keyctl update is correctly recognized by watch queue.
> + */
> +
> +#include "tst_test.h"
> +#include "lapi/keyctl.h"
> +#include "common.h"
> +
> +static void saw_key_updated(struct watch_notification *n, size_t len, unsigned int wtype)
> +{
> +	if (wqueue_key_event(n, len, wtype, NOTIFY_KEY_UPDATED))
> +		tst_res(TPASS, "keyctl update has been recognized");
> +	else
> +		tst_res(TFAIL, "keyctl update has not been recognized");
> +}
> +
> +static void run(void)
> +{
> +	int fd;
> +	key_serial_t key;
> +
> +	fd = wqueue_watch(256, &wqueue_filter);
> +	key = wqueue_add_key(fd);
> +
> +	keyctl(KEYCTL_UPDATE, key, "b", 1);
> +	wqueue_consumer(fd, saw_key_updated);
> +
> +	SAFE_CLOSE(fd);
> +}
> +
> +static struct tst_test test = {
> +	.test_all = run,
> +};
> -- 
> 2.34.1
> 
> 
> -- 
> Mailing list info: https://lists.linux.it/listinfo/ltp