From: Kees Cook <keescook@chromium.org>
To: Brendan Higgins <brendanhiggins@google.com>
Cc: jdike@addtoit.com, richard@nod.at,
anton.ivanov@cambridgegreys.com, arnd@arndb.de,
skhan@linuxfoundation.org, alan.maguire@oracle.com,
yzaikin@google.com, davidgow@google.com,
akpm@linux-foundation.org, rppt@linux.ibm.com,
frowand.list@gmail.com, catalin.marinas@arm.com, will@kernel.org,
monstr@monstr.eu, mpe@ellerman.id.au, benh@kernel.crashing.org,
paulus@samba.org, chris@zankel.net, jcmvbkbc@gmail.com,
gregkh@linuxfoundation.org, sboyd@kernel.org,
logang@deltatee.com, mcgrof@kernel.org,
linux-um@lists.infradead.org, linux-arch@vger.kernel.org,
linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
linuxppc-dev@lists.ozlabs.org, linux-xtensa@linux-xtensa.org
Subject: Re: [PATCH v5 07/12] kunit: test: create a single centralized executor for all tests
Date: Fri, 26 Jun 2020 14:29:22 -0700 [thread overview]
Message-ID: <202006261423.0BC9D830@keescook> (raw)
In-Reply-To: <20200626210917.358969-8-brendanhiggins@google.com>
On Fri, Jun 26, 2020 at 02:09:12PM -0700, Brendan Higgins wrote:
> From: Alan Maguire <alan.maguire@oracle.com>
>
> Add a centralized executor to dispatch tests rather than relying on
> late_initcall to schedule each test suite separately. Centralized
> execution is for built-in tests only; modules will execute tests when
> loaded.
>
> Signed-off-by: Alan Maguire <alan.maguire@oracle.com>
> Co-developed-by: Iurii Zaikin <yzaikin@google.com>
> Signed-off-by: Iurii Zaikin <yzaikin@google.com>
> Co-developed-by: Brendan Higgins <brendanhiggins@google.com>
> Signed-off-by: Brendan Higgins <brendanhiggins@google.com>
> Reviewed-by: Stephen Boyd <sboyd@kernel.org>
> ---
> include/kunit/test.h | 67 +++++++++++++++++++++++++++++---------------
> lib/kunit/Makefile | 3 +-
> lib/kunit/executor.c | 28 ++++++++++++++++++
> lib/kunit/test.c | 2 +-
> 4 files changed, 76 insertions(+), 24 deletions(-)
> create mode 100644 lib/kunit/executor.c
>
> diff --git a/include/kunit/test.h b/include/kunit/test.h
> index 47e61e1d53370..f3e86c3953a2b 100644
> --- a/include/kunit/test.h
> +++ b/include/kunit/test.h
> @@ -224,7 +224,7 @@ size_t kunit_suite_num_test_cases(struct kunit_suite *suite);
> unsigned int kunit_test_case_num(struct kunit_suite *suite,
> struct kunit_case *test_case);
>
> -int __kunit_test_suites_init(struct kunit_suite **suites);
> +int __kunit_test_suites_init(struct kunit_suite * const * const suites);
>
> void __kunit_test_suites_exit(struct kunit_suite **suites);
>
> @@ -237,34 +237,57 @@ void __kunit_test_suites_exit(struct kunit_suite **suites);
> * Registers @suites_list with the test framework. See &struct kunit_suite for
> * more information.
> *
> - * When builtin, KUnit tests are all run as late_initcalls; this means
> - * that they cannot test anything where tests must run at a different init
> - * phase. One significant restriction resulting from this is that KUnit
> - * cannot reliably test anything that is initialize in the late_init phase;
> - * another is that KUnit is useless to test things that need to be run in
> - * an earlier init phase.
> - *
> - * An alternative is to build the tests as a module. Because modules
> - * do not support multiple late_initcall()s, we need to initialize an
> - * array of suites for a module.
> - *
> - * TODO(brendanhiggins@google.com): Don't run all KUnit tests as
> - * late_initcalls. I have some future work planned to dispatch all KUnit
> - * tests from the same place, and at the very least to do so after
> - * everything else is definitely initialized.
> + * If a test suite is built-in, module_init() gets translated into
> + * an initcall which we don't want as the idea is that for builtins
> + * the executor will manage execution. So ensure we do not define
> + * module_{init|exit} functions for the builtin case when registering
> + * suites via kunit_test_suites() below.
> */
> -#define kunit_test_suites(suites_list...) \
> - static struct kunit_suite *suites[] = {suites_list, NULL}; \
> - static int kunit_test_suites_init(void) \
> +#ifdef MODULE
> +#define kunit_test_suites_for_module(__suites) \
> + static int __init kunit_test_suites_init(void) \
> { \
> - return __kunit_test_suites_init(suites); \
> + return __kunit_test_suites_init(__suites); \
> } \
> - late_initcall(kunit_test_suites_init); \
> + module_init(kunit_test_suites_init); \
> + \
> static void __exit kunit_test_suites_exit(void) \
> { \
> - return __kunit_test_suites_exit(suites); \
> + return __kunit_test_suites_exit(__suites); \
> } \
> module_exit(kunit_test_suites_exit)
> +#else
> +#define kunit_test_suites_for_module(__suites)
> +#endif /* MODULE */
> +
> +#define __kunit_test_suites(unique_array, unique_suites, ...) \
> + static struct kunit_suite *unique_array[] = { __VA_ARGS__, NULL }; \
> + kunit_test_suites_for_module(unique_array); \
> + static struct kunit_suite **unique_suites \
> + __used __section(.kunit_test_suites) = unique_array
> +
> +/**
> + * kunit_test_suites() - used to register one or more &struct kunit_suite
> + * with KUnit.
> + *
> + * @suites: a statically allocated list of &struct kunit_suite.
> + *
> + * Registers @suites with the test framework. See &struct kunit_suite for
> + * more information.
> + *
> + * When builtin, KUnit tests are all run via executor; this is done
> + * by placing the array of struct kunit_suite * in the .kunit_test_suites
> + * ELF section.
> + *
> + * An alternative is to build the tests as a module. Because modules do not
> + * support multiple initcall()s, we need to initialize an array of suites for a
> + * module.
> + *
> + */
> +#define kunit_test_suites(...) \
> + __kunit_test_suites(__UNIQUE_ID(array), \
> + __UNIQUE_ID(suites), \
> + __VA_ARGS__)
>
> #define kunit_test_suite(suite) kunit_test_suites(&suite)
>
> diff --git a/lib/kunit/Makefile b/lib/kunit/Makefile
> index 724b94311ca36..c49f4ffb6273a 100644
> --- a/lib/kunit/Makefile
> +++ b/lib/kunit/Makefile
> @@ -3,7 +3,8 @@ obj-$(CONFIG_KUNIT) += kunit.o
> kunit-objs += test.o \
> string-stream.o \
> assert.o \
> - try-catch.o
> + try-catch.o \
> + executor.o
>
> ifeq ($(CONFIG_KUNIT_DEBUGFS),y)
> kunit-objs += debugfs.o
> diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c
> new file mode 100644
> index 0000000000000..7015e7328dce7
> --- /dev/null
> +++ b/lib/kunit/executor.c
> @@ -0,0 +1,28 @@
> +// SPDX-License-Identifier: GPL-2.0
> +
> +#include <kunit/test.h>
> +
> +/*
> + * These symbols point to the .kunit_test_suites section and are defined in
> + * include/asm-generic/vmlinux.lds.h, and consequently must be extern.
> + */
> +extern struct kunit_suite * const * const __kunit_suites_start[];
> +extern struct kunit_suite * const * const __kunit_suites_end[];
I would expect these to be in include/asm-generic/sections.h but I guess
it's not required.
Reviewed-by: Kees Cook <keescook@chromium.org>
--
Kees Cook
next prev parent reply other threads:[~2020-06-26 21:29 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-26 21:09 [PATCH v5 00/12] kunit: create a centralized executor to dispatch all KUnit tests Brendan Higgins
2020-06-26 21:09 ` [PATCH v5 01/12] vmlinux.lds.h: add linker section for KUnit test suites Brendan Higgins
2020-06-26 21:20 ` Kees Cook
2020-06-26 21:22 ` Brendan Higgins
2020-07-08 4:31 ` Luis Chamberlain
2020-08-04 20:03 ` Brendan Higgins
2020-06-26 21:09 ` [PATCH v5 02/12] arch: arm64: " Brendan Higgins
2020-06-26 21:20 ` Kees Cook
2020-06-26 21:23 ` Brendan Higgins
2020-06-26 21:09 ` [PATCH v5 03/12] arch: microblaze: " Brendan Higgins
2020-06-26 21:09 ` [PATCH v5 04/12] arch: powerpc: " Brendan Higgins
2020-06-26 21:09 ` [PATCH v5 05/12] arch: um: " Brendan Higgins
2020-06-26 21:09 ` [PATCH v5 06/12] arch: xtensa: " Brendan Higgins
2020-06-26 21:30 ` Kees Cook
2020-06-26 21:09 ` [PATCH v5 07/12] kunit: test: create a single centralized executor for all tests Brendan Higgins
2020-06-26 21:29 ` Kees Cook [this message]
2020-08-04 20:06 ` Brendan Higgins
2020-06-26 21:09 ` [PATCH v5 08/12] init: main: add KUnit to kernel init Brendan Higgins
2020-06-26 21:33 ` Kees Cook
2020-07-08 4:38 ` Luis Chamberlain
2020-06-26 21:09 ` [PATCH v5 09/12] kunit: test: add test plan to KUnit TAP format Brendan Higgins
2020-06-26 21:35 ` Kees Cook
2020-08-04 20:10 ` Brendan Higgins
2020-06-26 21:09 ` [PATCH v5 10/12] kunit: Add 'kunit_shutdown' option Brendan Higgins
2020-06-26 21:40 ` Kees Cook
2020-08-04 20:18 ` Brendan Higgins
2020-06-26 21:09 ` [PATCH v5 11/12] Documentation: Add kunit_shutdown to kernel-parameters.txt Brendan Higgins
2020-06-26 21:09 ` [PATCH v5 12/12] Documentation: kunit: add a brief blurb about kunit_test_suite Brendan Higgins
2020-06-26 21:52 ` [PATCH v5 00/12] kunit: create a centralized executor to dispatch all KUnit tests Kees Cook
2020-08-04 20:01 ` Brendan Higgins
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=202006261423.0BC9D830@keescook \
--to=keescook@chromium.org \
--cc=akpm@linux-foundation.org \
--cc=alan.maguire@oracle.com \
--cc=anton.ivanov@cambridgegreys.com \
--cc=arnd@arndb.de \
--cc=benh@kernel.crashing.org \
--cc=brendanhiggins@google.com \
--cc=catalin.marinas@arm.com \
--cc=chris@zankel.net \
--cc=davidgow@google.com \
--cc=frowand.list@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=jcmvbkbc@gmail.com \
--cc=jdike@addtoit.com \
--cc=kunit-dev@googlegroups.com \
--cc=linux-arch@vger.kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=linux-um@lists.infradead.org \
--cc=linux-xtensa@linux-xtensa.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=logang@deltatee.com \
--cc=mcgrof@kernel.org \
--cc=monstr@monstr.eu \
--cc=mpe@ellerman.id.au \
--cc=paulus@samba.org \
--cc=richard@nod.at \
--cc=rppt@linux.ibm.com \
--cc=sboyd@kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=will@kernel.org \
--cc=yzaikin@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).