Commit d20a6ba5 authored by Joe Fradley's avatar Joe Fradley Committed by Shuah Khan
Browse files

kunit: add kunit.enable to enable/disable KUnit test 



This patch adds the kunit.enable module parameter that will need to be
set to true in addition to KUNIT being enabled for KUnit tests to run.
The default value is true giving backwards compatibility. However, for
the production+testing use case the new config option
KUNIT_DEFAULT_ENABLED can be set to N requiring the tester to opt-in
by passing kunit.enable=1 to the kernel.

Signed-off-by: default avatarJoe Fradley <joefradley@google.com>
Reviewed-by: default avatarDavid Gow <davidgow@google.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent a15cfa39

Documentation/admin-guide/kernel-parameters.txt

+6 −0
Original line number Diff line number Diff line
@@ -2436,6 +2436,12 @@ 
			0: force disabled

			1: force enabled



	kunit.enable=	[KUNIT] Enable executing KUnit tests. Requires

			CONFIG_KUNIT to be set to be fully enabled. The

			default value can be overridden via

			KUNIT_DEFAULT_ENABLED.

			Default is 1 (enabled)



	kvm.ignore_msrs=[KVM] Ignore guest accesses to unhandled MSRs.

			Default is 0 (don't ignore, but inject #GP)

include/kunit/test.h

+2 −0
Original line number Diff line number Diff line
@@ -228,6 +228,8 @@ static inline void kunit_set_failure(struct kunit *test) 
	WRITE_ONCE(test->status, KUNIT_FAILURE);

}



bool kunit_enabled(void);



void kunit_init_test(struct kunit *test, const char *name, char *log);



int kunit_run_tests(struct kunit_suite *suite);

lib/kunit/Kconfig

+11 −0
Original line number Diff line number Diff line
@@ -59,4 +59,15 @@ config KUNIT_ALL_TESTS 


	  If unsure, say N.



config KUNIT_DEFAULT_ENABLED

	bool "Default value of kunit.enable"

	default y

	help

	  Sets the default value of kunit.enable. If set to N then KUnit

	  tests will not execute unless kunit.enable=1 is passed to the

	  kernel command line.



	  In most cases this should be left as Y. Only if additional opt-in

	  behavior is needed should this be set to N.



endif # KUNIT

lib/kunit/executor.c

+4 −0
Original line number Diff line number Diff line
@@ -190,6 +190,10 @@ int kunit_run_all_tests(void) 
{

	struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};

	int err = 0;

	if (!kunit_enabled()) {

		pr_info("kunit: disabled\n");

		goto out;

	}



	if (filter_glob_param) {

		suite_set = kunit_filter_suites(&suite_set, filter_glob_param, &err);

lib/kunit/test.c

+24 −0
Original line number Diff line number Diff line
@@ -54,6 +54,17 @@ void __kunit_fail_current_test(const char *file, int line, const char *fmt, ...) 
EXPORT_SYMBOL_GPL(__kunit_fail_current_test);

#endif



/*

 * Enable KUnit tests to run.

 */

#ifdef CONFIG_KUNIT_DEFAULT_ENABLED

static bool enable_param = true;

#else

static bool enable_param;

#endif

module_param_named(enable, enable_param, bool, 0);

MODULE_PARM_DESC(enable, "Enable KUnit tests");



/*

 * KUnit statistic mode:

 * 0 - disabled
@@ -586,10 +597,20 @@ static void kunit_init_suite(struct kunit_suite *suite) 
	suite->suite_init_err = 0;

}



bool kunit_enabled(void)

{

	return enable_param;

}



int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_suites)

{

	unsigned int i;



	if (!kunit_enabled() && num_suites > 0) {

		pr_info("kunit: disabled\n");

		return 0;

	}



	for (i = 0; i < num_suites; i++) {

		kunit_init_suite(suites[i]);

		kunit_run_tests(suites[i]);
@@ -607,6 +628,9 @@ void __kunit_test_suites_exit(struct kunit_suite **suites, int num_suites) 
{

	unsigned int i;



	if (!kunit_enabled())

		return;



	for (i = 0; i < num_suites; i++)

		kunit_exit_suite(suites[i]);