/* 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/kernel.h>#include <linux/module.h>#include <linux/slab.h>#include <linux/types.h>#include <linux/kref.h> struct kunit_resource; typedef int (*kunit_resource_init_t)(struct kunit_resource *, void *);typedef void (*kunit_resource_free_t)(struct kunit_resource *); /** * struct kunit_resource - represents a *test managed resource* * @data: for the user to store arbitrary data. * @name: optional name * @free: a user supplied function to free the resource. Populated by * kunit_resource_alloc(). * * Represents a *test managed resource*, a resource which will automatically be * cleaned up at the end of a test case. * * Resources are reference counted so if a resource is retrieved via * kunit_alloc_and_get_resource() or kunit_find_resource(), we need * to call kunit_put_resource() to reduce the resource reference count * when finished with it.  Note that kunit_alloc_resource() does not require a * kunit_resource_put() because it does not retrieve the resource itself. * * Example: * * .. code-block:: c * *	struct kunit_kmalloc_params { *		size_t size; *		gfp_t gfp; *	}; * *	static int kunit_kmalloc_init(struct kunit_resource *res, void *context) *	{ *		struct kunit_kmalloc_params *params = context; *		res->data = kmalloc(params->size, params->gfp); * *		if (!res->data) *			return -ENOMEM; * *		return 0; *	} * *	static void kunit_kmalloc_free(struct kunit_resource *res) *	{ *		kfree(res->data); *	} * *	void *kunit_kmalloc(struct kunit *test, size_t size, gfp_t gfp) *	{ *		struct kunit_kmalloc_params params; * *		params.size = size; *		params.gfp = gfp; * *		return kunit_alloc_resource(test, kunit_kmalloc_init, *			kunit_kmalloc_free, &params); *	} * * Resources can also be named, with lookup/removal done on a name * basis also.  kunit_add_named_resource(), kunit_find_named_resource() * and kunit_destroy_named_resource().  Resource names must be * unique within the test instance. */struct kunit_resource {	void *data;	const char *name;	kunit_resource_free_t free; 	/* private: internal use only. */	struct kref refcount;	struct list_head node;}; struct kunit; /* Size of log associated with test. */#define KUNIT_LOG_SIZE	512 /* Maximum size of parameter description string. */#define KUNIT_PARAM_DESC_SIZE 128 /* * 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_SUBTEST_INDENT		"    "#define KUNIT_SUBSUBTEST_INDENT		"        " /** * 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. * * 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); 	/* private: internal use only. */	bool success;	char *log;}; static inline char *kunit_status_to_string(bool status){	return status ? "ok" : "not ok";} /** * 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 } /** * 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 } /** * struct kunit_suite - describes a related collection of &struct kunit_case * * @name:	the name of the test. Purely informational. * @init:	called before every test case. * @exit:	called after every test case. * @test_cases:	a null terminated array of test cases. * * 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. * * Every &struct kunit_case must be associated with a kunit_suite for KUnit * to run it. */struct kunit_suite {	const char name[256];	int (*init)(struct kunit *test);	void (*exit)(struct kunit *test);	struct kunit_case *test_cases; 	/* private: internal use only */	struct dentry *debugfs;	char *log;}; /** * 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! */	char *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.	 */	bool success; /* Read only after test_case finishes! */	spinlock_t lock; /* Guards all mutable test state. */	/*	 * 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. */}; static inline void kunit_set_failure(struct kunit *test){	WRITE_ONCE(test->success, false);} void kunit_init_test(struct kunit *test, const char *name, char *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); int __kunit_test_suites_init(struct kunit_suite * const * const suites); void __kunit_test_suites_exit(struct kunit_suite **suites); #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) */ #ifdef MODULE/** * kunit_test_suites_for_module() - 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. * * 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_for_module(__suites)				\	static int __init kunit_test_suites_init(void)			\	{								\		return __kunit_test_suites_init(__suites);		\	}								\	module_init(kunit_test_suites_init);				\									\	static void __exit kunit_test_suites_exit(void)			\	{								\		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(__suites...)						\	__kunit_test_suites(__UNIQUE_ID(array),				\			    __UNIQUE_ID(suites),			\			    ##__suites) #define kunit_test_suite(suite)	kunit_test_suites(&suite) #define kunit_suite_for_each_test_case(suite, test_case)		\	for (test_case = suite->test_cases; test_case->run_case; test_case++) bool kunit_suite_has_succeeded(struct kunit_suite *suite); /* * Like kunit_alloc_resource() below, but returns the struct kunit_resource * object that contains the allocation. This is mostly for testing purposes. */struct kunit_resource *kunit_alloc_and_get_resource(struct kunit *test,						    kunit_resource_init_t init,						    kunit_resource_free_t free,						    gfp_t internal_gfp,						    void *context); /** * kunit_get_resource() - Hold resource for use.  Should not need to be used *			  by most users as we automatically get resources *			  retrieved by kunit_find_resource*(). * @res: resource */static inline void kunit_get_resource(struct kunit_resource *res){	kref_get(&res->refcount);} /* * Called when refcount reaches zero via kunit_put_resources(); * should not be called directly. */static inline void kunit_release_resource(struct kref *kref){	struct kunit_resource *res = container_of(kref, struct kunit_resource,						  refcount); 	/* If free function is defined, resource was dynamically allocated. */	if (res->free) {		res->free(res);		kfree(res);	}} /** * kunit_put_resource() - When caller is done with retrieved resource, *			  kunit_put_resource() should be called to drop *			  reference count.  The resource list maintains *			  a reference count on resources, so if no users *			  are utilizing a resource and it is removed from *			  the resource list, it will be freed via the *			  associated free function (if any).  Only *			  needs to be used if we alloc_and_get() or *			  find() resource. * @res: resource */static inline void kunit_put_resource(struct kunit_resource *res){	kref_put(&res->refcount, kunit_release_resource);} /** * kunit_add_resource() - Add a *test managed resource*. * @test: The test context object. * @init: a user-supplied function to initialize the result (if needed).  If *        none is supplied, the resource data value is simply set to @data. *	  If an init function is supplied, @data is passed to it instead. * @free: a user-supplied function to free the resource (if needed). * @res: The resource. * @data: value to pass to init function or set in resource data field. */int kunit_add_resource(struct kunit *test,		       kunit_resource_init_t init,		       kunit_resource_free_t free,		       struct kunit_resource *res,		       void *data); /** * kunit_add_named_resource() - Add a named *test managed resource*. * @test: The test context object. * @init: a user-supplied function to initialize the resource data, if needed. * @free: a user-supplied function to free the resource data, if needed. * @res: The resource. * @name: name to be set for resource. * @data: value to pass to init function or set in resource data field. */int kunit_add_named_resource(struct kunit *test,			     kunit_resource_init_t init,			     kunit_resource_free_t free,			     struct kunit_resource *res,			     const char *name,			     void *data); /** * kunit_alloc_resource() - Allocates a *test managed resource*. * @test: The test context object. * @init: a user supplied function to initialize the resource. * @free: a user supplied function to free the resource. * @internal_gfp: gfp to use for internal allocations, if unsure, use GFP_KERNEL * @context: for the user to pass in arbitrary data to the init function. * * Allocates a *test managed resource*, a resource which will automatically be * cleaned up at the end of a test case. See &struct kunit_resource for an * example. * * Note: KUnit needs to allocate memory for a kunit_resource object. You must * specify an @internal_gfp that is compatible with the use context of your * resource. */static inline void *kunit_alloc_resource(struct kunit *test,					 kunit_resource_init_t init,					 kunit_resource_free_t free,					 gfp_t internal_gfp,					 void *context){	struct kunit_resource *res; 	res = kzalloc(sizeof(*res), internal_gfp);	if (!res)		return NULL; 	if (!kunit_add_resource(test, init, free, res, context))		return res->data; 	return NULL;} typedef bool (*kunit_resource_match_t)(struct kunit *test,				       struct kunit_resource *res,				       void *match_data); /** * kunit_resource_instance_match() - Match a resource with the same instance. * @test: Test case to which the resource belongs. * @res: The resource. * @match_data: The resource pointer to match against. * * An instance of kunit_resource_match_t that matches a resource whose * allocation matches @match_data. */static inline bool kunit_resource_instance_match(struct kunit *test,						 struct kunit_resource *res,						 void *match_data){	return res->data == match_data;} /** * kunit_resource_name_match() - Match a resource with the same name. * @test: Test case to which the resource belongs. * @res: The resource. * @match_name: The name to match against. */static inline bool kunit_resource_name_match(struct kunit *test,					     struct kunit_resource *res,

Lines 1–500 of 1796. Load more