/* SPDX-License-Identifier: GPL-2.0 *//* * Base unit test (KUnit) API. * * Copyright (C) 2019, Google LLC. * Author: Brendan Higgins <brendanhiggins@google.com> */ #ifndef _KUNIT_TEST_H#define _KUNIT_TEST_H #include <kunit/assert.h>#include <kunit/try-catch.h> #include <linux/args.h>#include <linux/compiler.h>#include <linux/container_of.h>#include <linux/err.h>#include <linux/init.h>#include <linux/jump_label.h>#include <linux/kconfig.h>#include <linux/kref.h>#include <linux/list.h>#include <linux/module.h>#include <linux/slab.h>#include <linux/spinlock.h>#include <linux/string.h>#include <linux/types.h> #include <asm/rwonce.h> /* Static key: true if any KUnit tests are currently running */DECLARE_STATIC_KEY_FALSE(kunit_running); struct kunit;struct string_stream; /* Maximum size of parameter description string. */#define KUNIT_PARAM_DESC_SIZE 128 /* Maximum size of a status comment. */#define KUNIT_STATUS_COMMENT_SIZE 256 /* * TAP specifies subtest stream indentation of 4 spaces, 8 spaces for a * sub-subtest.  See the "Subtests" section in * https://node-tap.org/tap-protocol/ */#define KUNIT_INDENT_LEN		4#define KUNIT_SUBTEST_INDENT		"    "#define KUNIT_SUBSUBTEST_INDENT		"        " /** * enum kunit_status - Type of result for a test or test suite * @KUNIT_SUCCESS: Denotes the test suite has not failed nor been skipped * @KUNIT_FAILURE: Denotes the test has failed. * @KUNIT_SKIPPED: Denotes the test has been skipped. */enum kunit_status {	KUNIT_SUCCESS,	KUNIT_FAILURE,	KUNIT_SKIPPED,}; /* Attribute struct/enum definitions */ /* * Speed Attribute is stored as an enum and separated into categories of * speed: very_slowm, slow, and normal. These speeds are relative to * other KUnit tests. * * Note: unset speed attribute acts as default of KUNIT_SPEED_NORMAL. */enum kunit_speed {	KUNIT_SPEED_UNSET,	KUNIT_SPEED_VERY_SLOW,	KUNIT_SPEED_SLOW,	KUNIT_SPEED_NORMAL,	KUNIT_SPEED_MAX = KUNIT_SPEED_NORMAL,}; /* Holds attributes for each test case and suite */struct kunit_attributes {	enum kunit_speed speed;}; /** * struct kunit_case - represents an individual test case. * * @run_case: the function representing the actual test case. * @name:     the name of the test case. * @generate_params: the generator function for parameterized tests. * @attr:     the attributes associated with the test * * A test case is a function with the signature, * ``void (*)(struct kunit *)`` * that makes expectations and assertions (see KUNIT_EXPECT_TRUE() and * KUNIT_ASSERT_TRUE()) about code under test. Each test case is associated * with a &struct kunit_suite and will be run after the suite's init * function and followed by the suite's exit function. * * A test case should be static and should only be created with the * KUNIT_CASE() macro; additionally, every array of test cases should be * terminated with an empty test case. * * Example: * * .. code-block:: c * *	void add_test_basic(struct kunit *test) *	{ *		KUNIT_EXPECT_EQ(test, 1, add(1, 0)); *		KUNIT_EXPECT_EQ(test, 2, add(1, 1)); *		KUNIT_EXPECT_EQ(test, 0, add(-1, 1)); *		KUNIT_EXPECT_EQ(test, INT_MAX, add(0, INT_MAX)); *		KUNIT_EXPECT_EQ(test, -1, add(INT_MAX, INT_MIN)); *	} * *	static struct kunit_case example_test_cases[] = { *		KUNIT_CASE(add_test_basic), *		{} *	}; * */struct kunit_case {	void (*run_case)(struct kunit *test);	const char *name;	const void* (*generate_params)(const void *prev, char *desc);	struct kunit_attributes attr; 	/* private: internal use only. */	enum kunit_status status;	char *module_name;	struct string_stream *log;}; static inline char *kunit_status_to_ok_not_ok(enum kunit_status status){	switch (status) {	case KUNIT_SKIPPED:	case KUNIT_SUCCESS:		return "ok";	case KUNIT_FAILURE:		return "not ok";	}	return "invalid";} /** * KUNIT_CASE - A helper for creating a &struct kunit_case * * @test_name: a reference to a test case function. * * Takes a symbol for a function representing a test case and creates a * &struct kunit_case object from it. See the documentation for * &struct kunit_case for an example on how to use it. */#define KUNIT_CASE(test_name)			\		{ .run_case = test_name, .name = #test_name,	\		  .module_name = KBUILD_MODNAME} /** * KUNIT_CASE_ATTR - A helper for creating a &struct kunit_case * with attributes * * @test_name: a reference to a test case function. * @attributes: a reference to a struct kunit_attributes object containing * test attributes */#define KUNIT_CASE_ATTR(test_name, attributes)			\		{ .run_case = test_name, .name = #test_name,	\		  .attr = attributes, .module_name = KBUILD_MODNAME} /** * KUNIT_CASE_SLOW - A helper for creating a &struct kunit_case * with the slow attribute * * @test_name: a reference to a test case function. */ #define KUNIT_CASE_SLOW(test_name)			\		{ .run_case = test_name, .name = #test_name,	\		  .attr.speed = KUNIT_SPEED_SLOW, .module_name = KBUILD_MODNAME} /** * KUNIT_CASE_PARAM - A helper for creation a parameterized &struct kunit_case * * @test_name: a reference to a test case function. * @gen_params: a reference to a parameter generator function. * * The generator function:: * *	const void* gen_params(const void *prev, char *desc) * * is used to lazily generate a series of arbitrarily typed values that fit into * a void*. The argument @prev is the previously returned value, which should be * used to derive the next value; @prev is set to NULL on the initial generator * call. When no more values are available, the generator must return NULL. * Optionally write a string into @desc (size of KUNIT_PARAM_DESC_SIZE) * describing the parameter. */#define KUNIT_CASE_PARAM(test_name, gen_params)			\		{ .run_case = test_name, .name = #test_name,	\		  .generate_params = gen_params, .module_name = KBUILD_MODNAME} /** * KUNIT_CASE_PARAM_ATTR - A helper for creating a parameterized &struct * kunit_case with attributes * * @test_name: a reference to a test case function. * @gen_params: a reference to a parameter generator function. * @attributes: a reference to a struct kunit_attributes object containing * test attributes */#define KUNIT_CASE_PARAM_ATTR(test_name, gen_params, attributes)	\		{ .run_case = test_name, .name = #test_name,	\		  .generate_params = gen_params,				\		  .attr = attributes, .module_name = KBUILD_MODNAME} /** * struct kunit_suite - describes a related collection of &struct kunit_case * * @name:	the name of the test. Purely informational. * @suite_init:	called once per test suite before the test cases. * @suite_exit:	called once per test suite after all test cases. * @init:	called before every test case. * @exit:	called after every test case. * @test_cases:	a null terminated array of test cases. * @attr:	the attributes associated with the test suite * * A kunit_suite is a collection of related &struct kunit_case s, such that * @init is called before every test case and @exit is called after every * test case, similar to the notion of a *test fixture* or a *test class* * in other unit testing frameworks like JUnit or Googletest. * * Note that @exit and @suite_exit will run even if @init or @suite_init * fail: make sure they can handle any inconsistent state which may result. * * Every &struct kunit_case must be associated with a kunit_suite for KUnit * to run it. */struct kunit_suite {	const char name[256];	int (*suite_init)(struct kunit_suite *suite);	void (*suite_exit)(struct kunit_suite *suite);	int (*init)(struct kunit *test);	void (*exit)(struct kunit *test);	struct kunit_case *test_cases;	struct kunit_attributes attr; 	/* private: internal use only */	char status_comment[KUNIT_STATUS_COMMENT_SIZE];	struct dentry *debugfs;	struct string_stream *log;	int suite_init_err;}; /* Stores an array of suites, end points one past the end */struct kunit_suite_set {	struct kunit_suite * const *start;	struct kunit_suite * const *end;}; /** * struct kunit - represents a running instance of a test. * * @priv: for user to store arbitrary data. Commonly used to pass data *	  created in the init function (see &struct kunit_suite). * * Used to store information about the current context under which the test * is running. Most of this data is private and should only be accessed * indirectly via public functions; the one exception is @priv which can be * used by the test writer to store arbitrary data. */struct kunit {	void *priv; 	/* private: internal use only. */	const char *name; /* Read only after initialization! */	struct string_stream *log; /* Points at case log after initialization */	struct kunit_try_catch try_catch;	/* param_value is the current parameter value for a test case. */	const void *param_value;	/* param_index stores the index of the parameter in parameterized tests. */	int param_index;	/*	 * success starts as true, and may only be set to false during a	 * test case; thus, it is safe to update this across multiple	 * threads using WRITE_ONCE; however, as a consequence, it may only	 * be read after the test case finishes once all threads associated	 * with the test case have terminated.	 */	spinlock_t lock; /* Guards all mutable test state. */	enum kunit_status status; /* Read only after test_case finishes! */	/*	 * Because resources is a list that may be updated multiple times (with	 * new resources) from any thread associated with a test case, we must	 * protect it with some type of lock.	 */	struct list_head resources; /* Protected by lock. */ 	char status_comment[KUNIT_STATUS_COMMENT_SIZE];}; static inline void kunit_set_failure(struct kunit *test){	WRITE_ONCE(test->status, KUNIT_FAILURE);} bool kunit_enabled(void);const char *kunit_action(void);const char *kunit_filter_glob(void);char *kunit_filter(void);char *kunit_filter_action(void); void kunit_init_test(struct kunit *test, const char *name, struct string_stream *log); int kunit_run_tests(struct kunit_suite *suite); 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); struct kunit_suite_setkunit_filter_suites(const struct kunit_suite_set *suite_set,		    const char *filter_glob,		    char *filters,		    char *filter_action,		    int *err);void kunit_free_suite_set(struct kunit_suite_set suite_set); int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_suites); 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); #if IS_BUILTIN(CONFIG_KUNIT)int kunit_run_all_tests(void);#elsestatic inline int kunit_run_all_tests(void){	return 0;}#endif /* IS_BUILTIN(CONFIG_KUNIT) */ #define __kunit_test_suites(unique_array, ...)				       \	static struct kunit_suite *unique_array[]			       \	__aligned(sizeof(struct kunit_suite *))				       \	__used __section(".kunit_test_suites") = { __VA_ARGS__ } /** * 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. * This is done by placing the array of struct kunit_suite * in the * .kunit_test_suites ELF section. * * When builtin, KUnit tests are all run via the executor at boot, and when * built as a module, they run on module load. * */#define kunit_test_suites(__suites...)						\	__kunit_test_suites(__UNIQUE_ID(array),				\			    ##__suites) #define kunit_test_suite(suite)	kunit_test_suites(&suite) /** * kunit_test_init_section_suites() - used to register one or more &struct *				      kunit_suite containing init functions or *				      init data. * * @__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. * * NOTE TO KUNIT DEVS: If we ever allow KUnit tests to be run after boot, these * tests must be excluded. * * 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. */#define kunit_test_init_section_suites(__suites...)			\	__kunit_test_suites(CONCATENATE(__UNIQUE_ID(array), _probe),	\			    ##__suites) #define kunit_test_init_section_suite(suite)	\	kunit_test_init_section_suites(&suite) #define kunit_suite_for_each_test_case(suite, test_case)		\	for (test_case = suite->test_cases; test_case->run_case; test_case++) enum kunit_status kunit_suite_has_succeeded(struct kunit_suite *suite); /** * kunit_kmalloc_array() - Like kmalloc_array() except the allocation is *test managed*. * @test: The test context object. * @n: number of elements. * @size: The size in bytes of the desired memory. * @gfp: flags passed to underlying kmalloc(). * * Just like `kmalloc_array(...)`, except the allocation is managed by the test case * and is automatically cleaned up after the test case concludes. See kunit_add_action() * for more information. * * Note that some internal context data is also allocated with GFP_KERNEL, * regardless of the gfp passed in. */void *kunit_kmalloc_array(struct kunit *test, size_t n, size_t size, gfp_t gfp); /** * kunit_kmalloc() - Like kmalloc() except the allocation is *test managed*. * @test: The test context object. * @size: The size in bytes of the desired memory. * @gfp: flags passed to underlying kmalloc(). * * See kmalloc() and kunit_kmalloc_array() for more information. * * Note that some internal context data is also allocated with GFP_KERNEL, * regardless of the gfp passed in. */static inline void *kunit_kmalloc(struct kunit *test, size_t size, gfp_t gfp){	return kunit_kmalloc_array(test, 1, size, gfp);} /** * kunit_kfree() - Like kfree except for allocations managed by KUnit. * @test: The test case to which the resource belongs. * @ptr: The memory allocation to free. */void kunit_kfree(struct kunit *test, const void *ptr); /** * kunit_kzalloc() - Just like kunit_kmalloc(), but zeroes the allocation. * @test: The test context object. * @size: The size in bytes of the desired memory. * @gfp: flags passed to underlying kmalloc(). * * See kzalloc() and kunit_kmalloc_array() for more information. */static inline void *kunit_kzalloc(struct kunit *test, size_t size, gfp_t gfp){	return kunit_kmalloc(test, size, gfp | __GFP_ZERO);} /** * kunit_kcalloc() - Just like kunit_kmalloc_array(), but zeroes the allocation. * @test: The test context object. * @n: number of elements. * @size: The size in bytes of the desired memory. * @gfp: flags passed to underlying kmalloc(). * * See kcalloc() and kunit_kmalloc_array() for more information. */static inline void *kunit_kcalloc(struct kunit *test, size_t n, size_t size, gfp_t gfp){	return kunit_kmalloc_array(test, n, size, gfp | __GFP_ZERO);} void kunit_cleanup(struct kunit *test); void __printf(2, 3) kunit_log_append(struct string_stream *log, const char *fmt, ...); /** * kunit_mark_skipped() - Marks @test_or_suite as skipped * * @test_or_suite: The test context object. * @fmt:  A printk() style format string. * * Marks the test as skipped. @fmt is given output as the test status * comment, typically the reason the test was skipped. * * Test execution continues after kunit_mark_skipped() is called. */#define kunit_mark_skipped(test_or_suite, fmt, ...)			\	do {								\		WRITE_ONCE((test_or_suite)->status, KUNIT_SKIPPED);	\		scnprintf((test_or_suite)->status_comment,		\			  KUNIT_STATUS_COMMENT_SIZE,			\			  fmt, ##__VA_ARGS__);				\	} while (0) /** * kunit_skip() - Marks @test_or_suite as skipped * * @test_or_suite: The test context object. * @fmt:  A printk() style format string. *

Lines 1–500 of 1521. Load more