| Message ID | 20200130230812.142642-4-brendanhiggins@google.com (mailing list archive) |
|---|---|
| State | Superseded, archived |
| Headers | show |
| Series | kunit: create a centralized executor to dispatch all KUnit tests | expand |
On 1/30/20 5:08 PM, 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 | 73 +++++++++++++++++++++++++++----------------- > lib/kunit/Makefile | 3 +- > lib/kunit/executor.c | 36 ++++++++++++++++++++++ > 3 files changed, 83 insertions(+), 29 deletions(-) > create mode 100644 lib/kunit/executor.c > > diff --git a/include/kunit/test.h b/include/kunit/test.h > index 2dfb550c6723a..8a02f93a6b505 100644 > --- a/include/kunit/test.h > +++ b/include/kunit/test.h The following fragment does not match the test.h in Linux 5.5 or 5.4-rc1 (as one possible earlier version). And we are not to Linux 5.5-rc1 yet. (Simple way to check for the mis-match - 5.5 has kunit_test_suite() instead of kunit_test_suites().) I know that there is an alternate tree where some of the development occurs. Can you please add a link in MAINTAINERS? And please note (at least in patch 0) what tree the series is developed against? -Frank > @@ -197,46 +197,63 @@ void kunit_init_test(struct kunit *test, const char *name); > > int kunit_run_tests(struct kunit_suite *suite); > > -/** > - * 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 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(...) \ > - static struct kunit_suite *suites[] = { __VA_ARGS__, 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) \ > { \ > + struct kunit_suite *suites[] = (__suites); \ > unsigned int i; \ > + \ > for (i = 0; suites[i] != NULL; i++) \ > kunit_run_tests(suites[i]); \ > return 0; \ > } \ > - late_initcall(kunit_test_suites_init); \ > + module_init(kunit_test_suites_init); \ > + \ > static void __exit kunit_test_suites_exit(void) \ > { \ > return; \ > } \ > 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 __aligned(8) __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 fab55649b69a5..c282f02ca066b 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 > > obj-$(CONFIG_KUNIT_TEST) += kunit-test.o > > diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c > new file mode 100644 > index 0000000000000..6429927d598a5 > --- /dev/null > +++ b/lib/kunit/executor.c > @@ -0,0 +1,36 @@ > +// 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[]; > + > +#if IS_BUILTIN(CONFIG_KUNIT) > + > +static int kunit_run_all_tests(void) > +{ > + struct kunit_suite * const * const *suites, * const *subsuite; > + bool has_test_failed = false; > + > + for (suites = __kunit_suites_start; > + suites < __kunit_suites_end; > + suites++) { > + for (subsuite = *suites; *subsuite != NULL; subsuite++) { > + if (kunit_run_tests(*subsuite)) > + has_test_failed = true; > + } > + } > + > + if (has_test_failed) > + return -EFAULT; > + > + return 0; > +} > + > +late_initcall(kunit_run_all_tests); > + > +#endif /* IS_BUILTIN(CONFIG_KUNIT) */ >
On Tue, Feb 4, 2020 at 2:27 PM Frank Rowand <frowand.list@gmail.com> wrote: > > On 1/30/20 5:08 PM, 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 | 73 +++++++++++++++++++++++++++----------------- > > lib/kunit/Makefile | 3 +- > > lib/kunit/executor.c | 36 ++++++++++++++++++++++ > > 3 files changed, 83 insertions(+), 29 deletions(-) > > create mode 100644 lib/kunit/executor.c > > > > diff --git a/include/kunit/test.h b/include/kunit/test.h > > index 2dfb550c6723a..8a02f93a6b505 100644 > > --- a/include/kunit/test.h > > +++ b/include/kunit/test.h > > The following fragment does not match the test.h in Linux 5.5 or 5.4-rc1 (as one > possible earlier version). And we are not to Linux 5.5-rc1 yet. (Simple way > to check for the mis-match - 5.5 has kunit_test_suite() instead of > kunit_test_suites().) > > I know that there is an alternate tree where some of the development occurs. > Can you please add a link in MAINTAINERS? And please note (at least in > patch 0) what tree the series is developed against? Yep, I was planning on sending an update to the MAINTAINERS with that and some other updates soon. In future revisions, I will put a link to the tree I developed against. In the meantime, we send pull-requests from here: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/log/?h=kunit And that is what I used as my development base for this series.
diff --git a/include/kunit/test.h b/include/kunit/test.h index 2dfb550c6723a..8a02f93a6b505 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -197,46 +197,63 @@ void kunit_init_test(struct kunit *test, const char *name); int kunit_run_tests(struct kunit_suite *suite); -/** - * 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 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(...) \ - static struct kunit_suite *suites[] = { __VA_ARGS__, 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) \ { \ + struct kunit_suite *suites[] = (__suites); \ unsigned int i; \ + \ for (i = 0; suites[i] != NULL; i++) \ kunit_run_tests(suites[i]); \ return 0; \ } \ - late_initcall(kunit_test_suites_init); \ + module_init(kunit_test_suites_init); \ + \ static void __exit kunit_test_suites_exit(void) \ { \ return; \ } \ 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 __aligned(8) __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 fab55649b69a5..c282f02ca066b 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 obj-$(CONFIG_KUNIT_TEST) += kunit-test.o diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c new file mode 100644 index 0000000000000..6429927d598a5 --- /dev/null +++ b/lib/kunit/executor.c @@ -0,0 +1,36 @@ +// 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[]; + +#if IS_BUILTIN(CONFIG_KUNIT) + +static int kunit_run_all_tests(void) +{ + struct kunit_suite * const * const *suites, * const *subsuite; + bool has_test_failed = false; + + for (suites = __kunit_suites_start; + suites < __kunit_suites_end; + suites++) { + for (subsuite = *suites; *subsuite != NULL; subsuite++) { + if (kunit_run_tests(*subsuite)) + has_test_failed = true; + } + } + + if (has_test_failed) + return -EFAULT; + + return 0; +} + +late_initcall(kunit_run_all_tests); + +#endif /* IS_BUILTIN(CONFIG_KUNIT) */