Commit d81f0d7b authored by Rae Moar's avatar Rae Moar Committed by Shuah Khan
Browse files

kunit: add KUNIT_INIT_TABLE to init linker section 



Add KUNIT_INIT_TABLE to the INIT_DATA linker section.

Alter the KUnit macros to create init tests:
kunit_test_init_section_suites

Update lib/kunit/executor.c to run both the suites in KUNIT_TABLE and
KUNIT_INIT_TABLE.

Reviewed-by: default avatarDavid Gow <davidgow@google.com>
Signed-off-by: default avatarRae Moar <rmoar@google.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent 69dfdce1

include/asm-generic/vmlinux.lds.h

+8 −1
Original line number Diff line number Diff line
@@ -700,7 +700,8 @@ 
	THERMAL_TABLE(governor)						\

	EARLYCON_TABLE()						\

	LSM_TABLE()							\

	EARLY_LSM_TABLE()

	EARLY_LSM_TABLE()						\

	KUNIT_INIT_TABLE()



#define INIT_TEXT							\

	*(.init.text .init.text.*)					\
@@ -926,6 +927,12 @@ 
		. = ALIGN(8);						\

		BOUNDED_SECTION_POST_LABEL(.kunit_test_suites, __kunit_suites, _start, _end)



/* Alignment must be consistent with (kunit_suite *) in include/kunit/test.h */

#define KUNIT_INIT_TABLE()						\

		. = ALIGN(8);						\

		BOUNDED_SECTION_POST_LABEL(.kunit_init_test_suites, \

				__kunit_init_suites, _start, _end)



#ifdef CONFIG_BLK_DEV_INITRD

#define INIT_RAM_FS							\

	. = ALIGN(4);							\

include/kunit/test.h

+19 −11
Original line number Diff line number Diff line
@@ -337,6 +337,9 @@ void __kunit_test_suites_exit(struct kunit_suite **suites, int num_suites); 
void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin);

void kunit_exec_list_tests(struct kunit_suite_set *suite_set, bool include_attr);



struct kunit_suite_set kunit_merge_suite_sets(struct kunit_suite_set init_suite_set,

		struct kunit_suite_set suite_set);



#if IS_BUILTIN(CONFIG_KUNIT)

int kunit_run_all_tests(void);

#else
@@ -371,6 +374,11 @@ static inline int kunit_run_all_tests(void) 


#define kunit_test_suite(suite)	kunit_test_suites(&suite)



#define __kunit_init_test_suites(unique_array, ...)			       \

	static struct kunit_suite *unique_array[]			       \

	__aligned(sizeof(struct kunit_suite *))				       \

	__used __section(".kunit_init_test_suites") = { __VA_ARGS__ }



/**

 * kunit_test_init_section_suites() - used to register one or more &struct

 *				      kunit_suite containing init functions or
@@ -378,21 +386,21 @@ static inline int kunit_run_all_tests(void) 
 *

 * @__suites: a statically allocated list of &struct kunit_suite.

 *

 * This functions identically as kunit_test_suites() except that it suppresses

 * modpost warnings for referencing functions marked __init or data marked

 * __initdata; this is OK because currently KUnit only runs tests upon boot

 * during the init phase or upon loading a module during the init phase.

 * This functions similar to kunit_test_suites() except that it compiles the

 * list of suites during init phase.

 *

 * This macro also suffixes the array and suite declarations it makes with

 * _probe; so that modpost suppresses warnings about referencing init data

 * for symbols named in this manner.

 *

 * NOTE TO KUNIT DEVS: If we ever allow KUnit tests to be run after boot, these

 * tests must be excluded.

 * Note: these init tests are not able to be run after boot so there is no

 * "run" debugfs file generated for these tests.

 *

 * The only thing this macro does that's different from kunit_test_suites is

 * that it suffixes the array and suite declarations it makes with _probe;

 * modpost suppresses warnings about referencing init data for symbols named in

 * this manner.

 * Also, do not mark the suite or test case structs with __initdata because

 * they will be used after the init phase with debugfs.

 */

#define kunit_test_init_section_suites(__suites...)			\

	__kunit_test_suites(CONCATENATE(__UNIQUE_ID(array), _probe),	\

	__kunit_init_test_suites(CONCATENATE(__UNIQUE_ID(array), _probe), \

			    ##__suites)



#define kunit_test_init_section_suite(suite)	\

include/linux/module.h

+2 −0
Original line number Diff line number Diff line
@@ -540,6 +540,8 @@ struct module { 
	struct static_call_site *static_call_sites;

#endif

#if IS_ENABLED(CONFIG_KUNIT)

	int num_kunit_init_suites;

	struct kunit_suite **kunit_init_suites;

	int num_kunit_suites;

	struct kunit_suite **kunit_suites;

#endif

kernel/module/main.c

+3 −0
Original line number Diff line number Diff line
@@ -2199,6 +2199,9 @@ static int find_module_sections(struct module *mod, struct load_info *info) 
	mod->kunit_suites = section_objs(info, ".kunit_test_suites",

					      sizeof(*mod->kunit_suites),

					      &mod->num_kunit_suites);

	mod->kunit_init_suites = section_objs(info, ".kunit_init_test_suites",

					      sizeof(*mod->kunit_init_suites),

					      &mod->num_kunit_init_suites);

#endif



	mod->extable = section_objs(info, "__ex_table",

lib/kunit/executor.c

+58 −6
Original line number Diff line number Diff line
@@ -12,6 +12,8 @@ 
 */

extern struct kunit_suite * const __kunit_suites_start[];

extern struct kunit_suite * const __kunit_suites_end[];

extern struct kunit_suite * const __kunit_init_suites_start[];

extern struct kunit_suite * const __kunit_init_suites_end[];



static char *action_param;
@@ -292,6 +294,33 @@ void kunit_exec_list_tests(struct kunit_suite_set *suite_set, bool include_attr) 
	}

}



struct kunit_suite_set kunit_merge_suite_sets(struct kunit_suite_set init_suite_set,

		struct kunit_suite_set suite_set)

{

	struct kunit_suite_set total_suite_set = {NULL, NULL};

	struct kunit_suite **total_suite_start = NULL;

	size_t init_num_suites, num_suites, suite_size;



	init_num_suites = init_suite_set.end - init_suite_set.start;

	num_suites = suite_set.end - suite_set.start;

	suite_size = sizeof(suite_set.start);



	/* Allocate memory for array of all kunit suites */

	total_suite_start = kmalloc_array(init_num_suites + num_suites, suite_size, GFP_KERNEL);

	if (!total_suite_start)

		return total_suite_set;



	/* Append init suites and then all other kunit suites */

	memcpy(total_suite_start, init_suite_set.start, init_num_suites * suite_size);

	memcpy(total_suite_start + init_num_suites, suite_set.start, num_suites * suite_size);



	/* Set kunit suite set start and end */

	total_suite_set.start = total_suite_start;

	total_suite_set.end = total_suite_start + (init_num_suites + num_suites);



	return total_suite_set;

}



#if IS_BUILTIN(CONFIG_KUNIT)



static char *kunit_shutdown;
@@ -313,21 +342,41 @@ static void kunit_handle_shutdown(void) 


int kunit_run_all_tests(void)

{

	struct kunit_suite_set suite_set = {

	struct kunit_suite_set suite_set = {NULL, NULL};

	struct kunit_suite_set filtered_suite_set = {NULL, NULL};

	struct kunit_suite_set init_suite_set = {

		__kunit_init_suites_start, __kunit_init_suites_end,

	};

	struct kunit_suite_set normal_suite_set = {

		__kunit_suites_start, __kunit_suites_end,

	};

	size_t init_num_suites = init_suite_set.end - init_suite_set.start;

	int err = 0;



	if (init_num_suites > 0) {

		suite_set = kunit_merge_suite_sets(init_suite_set, normal_suite_set);

		if (!suite_set.start)

			goto out;

	} else

		suite_set = normal_suite_set;



	if (!kunit_enabled()) {

		pr_info("kunit: disabled\n");

		goto out;

		goto free_out;

	}



	if (filter_glob_param || filter_param) {

		suite_set = kunit_filter_suites(&suite_set, filter_glob_param,

		filtered_suite_set = kunit_filter_suites(&suite_set, filter_glob_param,

				filter_param, filter_action_param, &err);



		/* Free original suite set before using filtered suite set */

		if (init_num_suites > 0)

			kfree(suite_set.start);

		suite_set = filtered_suite_set;



		if (err) {

			pr_err("kunit executor: error filtering suites: %d\n", err);

			goto out;

			goto free_out;

		}

	}
@@ -340,9 +389,12 @@ int kunit_run_all_tests(void) 
	else

		pr_err("kunit executor: unknown action '%s'\n", action_param);



	if (filter_glob_param || filter_param) { /* a copy was made of each suite */

free_out:

	if (filter_glob_param || filter_param)

		kunit_free_suite_set(suite_set);

	}

	else if (init_num_suites > 0)

		/* Don't use kunit_free_suite_set because suites aren't individually allocated */

		kfree(suite_set.start);



out:

	kunit_handle_shutdown();