blob: 4855d18b08731cb36e3e920b2c73b7213aed3c80 [file] [log] [blame]
#include <linux/sched.h>
#include <linux/sched/debug.h>
#include <os.h>
#include <test/test.h>
struct test_global_context {
struct list_head initcalls;
};
static struct test_global_context test_global_context = {
.initcalls = LIST_HEAD_INIT(test_global_context.initcalls),
};
void test_install_initcall(struct test_initcall *initcall)
{
list_add_tail(&initcall->node, &test_global_context.initcalls);
}
static int test_vprintk_emit(const struct test *test,
int level,
const char *fmt,
va_list args)
{
return vprintk_emit(0, level, NULL, 0, fmt, args);
}
static int test_printk_emit(const struct test *test,
int level,
const char *fmt, ...)
{
va_list args;
int ret;
va_start(args, fmt);
ret = test_vprintk_emit(test, level, fmt, args);
va_end(args);
return ret;
}
static void test_vprintk(const struct test *test,
const char *level,
struct va_format *vaf)
{
test_printk_emit(test,
level[1] - '0',
"kunit %s: %pV", test->name, vaf);
}
static void test_fail(struct test *test, struct test_stream *stream)
{
test->success = false;
stream->set_level(stream, KERN_ERR);
stream->commit(stream);
}
static void __noreturn test_abort(struct test *test)
{
test->death_test = true;
if (current->thread.fault_catcher && current->thread.is_running_test)
UML_LONGJMP(current->thread.fault_catcher, 1);
/*
* Attempted to abort from a not properly initialized test context.
*/
test_err(test,
"Attempted to abort from a not properly initialized test context!");
if (!current->thread.fault_catcher)
test_err(test, "No fault_catcher present!");
if (!current->thread.is_running_test)
test_err(test, "is_running_test not set!");
show_stack(NULL, NULL);
BUG();
}
int test_init_test(struct test *test, const char *name)
{
INIT_LIST_HEAD(&test->resources);
INIT_LIST_HEAD(&test->post_conditions);
test->name = name;
test->vprintk = test_vprintk;
test->fail = test_fail;
test->abort = test_abort;
return 0;
}
/*
* Initializes and runs test case. Does not clean up or do post validations.
*/
static void test_run_case_internal(struct test *test,
struct test_module *module,
struct test_case *test_case)
{
struct test_initcall *initcall;
int ret;
list_for_each_entry(initcall, &test_global_context.initcalls, node) {
ret = initcall->init(initcall, test);
if (ret) {
test_err(test, "failed to initialize: %d", ret);
test->success = false;
return;
}
}
if (module->init) {
ret = module->init(test);
if (ret) {
test_err(test, "failed to initialize: %d", ret);
test->success = false;
return;
}
}
test_case->run_case(test);
}
static void test_case_internal_cleanup(struct test *test)
{
struct test_initcall *initcall;
list_for_each_entry(initcall, &test_global_context.initcalls, node) {
initcall->exit(initcall);
}
test_cleanup(test);
}
/*
* Performs post validations and cleanup after a test case was run.
* XXX: Should ONLY BE CALLED AFTER test_run_case_internal!
*/
static void test_run_case_cleanup(struct test *test,
struct test_module *module,
struct test_case *test_case)
{
struct test_post_condition *condition, *condition_safe;
list_for_each_entry_safe(condition,
condition_safe,
&test->post_conditions,
node) {
condition->validate(condition);
list_del(&condition->node);
}
if (module->exit)
module->exit(test);
test_case_internal_cleanup(test);
}
/*
* Handles an unexpected crash in a test case.
*/
static void test_handle_test_crash(struct test *test,
struct test_module *module,
struct test_case *test_case)
{
/*
* TODO(brendanhiggins@google.com): Right now we don't have a way to
* store a copy of the stack, or a copy of information from the stack,
* so we need to print it in the "trap" handler; otherwise, the stack
* will be destroyed when it returns to us by popping off the
* appropriate stack frames (see longjmp).
*
* Ideally we would print the stack trace here, but we do not have the
* ability to do so with meaningful information at this time.
*/
test_err(test, "%s crashed", test_case->name);
test_case_internal_cleanup(test);
}
/*
* Performs all logic to run a test case. It also catches most errors that
* occurs in a test case and reports them as failures.
*
* XXX: THIS DOES NOT FOLLOW NORMAL CONTROL FLOW. READ CAREFULLY!!!
*/
static bool test_run_case_catch_errors(struct test *test,
struct test_module *module,
struct test_case *test_case)
{
jmp_buf fault_catcher;
int faulted;
test->success = true;
test->death_test = false;
/*
* Tell the trap subsystem that we want to catch any segfaults that
* occur.
*/
current->thread.is_running_test = true;
current->thread.fault_catcher = &fault_catcher;
/*
* ENTER HANDLER: If a failure occurs, we enter here.
*/
faulted = UML_SETJMP(&fault_catcher);
if (faulted == 0) {
/*
* NORMAL CASE: we have not run test_run_case_internal yet.
*
* test_run_case_internal may encounter a fatal error; if it
* does, we will jump to ENTER_HANDLER above instead of
* continuing normal control flow.
*/
test_run_case_internal(test, module, test_case);
/*
* This line may never be reached.
*/
test_run_case_cleanup(test, module, test_case);
} else if (test->death_test) {
/*
* EXPECTED DEATH: test_run_case_internal encountered
* anticipated fatal error. Everything should be in a safe
* state.
*/
test_run_case_cleanup(test, module, test_case);
} else {
/*
* UNEXPECTED DEATH: test_run_case_internal encountered an
* unanticipated fatal error. We have no idea what the state of
* the test case is in.
*/
test_handle_test_crash(test, module, test_case);
test->success = false;
}
/*
* EXIT HANDLER: test case has been run and all possible errors have
* been handled.
*/
/*
* Tell the trap subsystem that we no longer want to catch any
* segfaults.
*/
current->thread.fault_catcher = NULL;
current->thread.is_running_test = false;
return test->success;
}
int test_run_tests(struct test_module *module)
{
bool all_passed = true, success;
struct test_case *test_case;
struct test test;
int ret;
ret = test_init_test(&test, module->name);
if (ret)
return ret;
for (test_case = module->test_cases; test_case->run_case; test_case++) {
success = test_run_case_catch_errors(&test, module, test_case);
if (!success)
all_passed = false;
test_info(&test,
"%s %s",
test_case->name,
success ? "passed" : "failed");
}
if (all_passed)
test_info(&test, "all tests passed");
else
test_info(&test, "one or more tests failed");
return 0;
}
struct test_resource *test_alloc_resource(struct test *test,
int (*init)(struct test_resource *,
void *),
void (*free)(struct test_resource *),
void *context)
{
struct test_resource *res;
int ret;
res = kzalloc(sizeof(*res), GFP_KERNEL);
if (!res)
return NULL;
ret = init(res, context);
if (ret)
return NULL;
res->free = free;
list_add_tail(&res->node, &test->resources);
return res;
}
void test_free_resource(struct test *test, struct test_resource *res)
{
res->free(res);
list_del(&res->node);
kfree(res);
}
struct test_kmalloc_params {
size_t size;
gfp_t gfp;
};
static int test_kmalloc_init(struct test_resource *res, void *context)
{
struct test_kmalloc_params *params = context;
res->allocation = kmalloc(params->size, params->gfp);
if (!res->allocation)
return -ENOMEM;
return 0;
}
static void test_kmalloc_free(struct test_resource *res)
{
kfree(res->allocation);
}
void *test_kmalloc(struct test *test, size_t size, gfp_t gfp)
{
struct test_kmalloc_params params;
struct test_resource *res;
params.size = size;
params.gfp = gfp;
res = test_alloc_resource(test,
test_kmalloc_init,
test_kmalloc_free,
&params);
if (res)
return res->allocation;
else
return NULL;
}
void test_cleanup(struct test *test)
{
struct test_resource *resource, *resource_safe;
list_for_each_entry_safe(resource,
resource_safe,
&test->resources,
node) {
test_free_resource(test, resource);
}
}
void test_printk(const char *level,
const struct test *test,
const char *fmt, ...)
{
struct va_format vaf;
va_list args;
va_start(args, fmt);
vaf.fmt = fmt;
vaf.va = &args;
test->vprintk(test, level, &vaf);
va_end(args);
}