blob: e128ef33240b564aeead7a18e4c4c13c19337cd5 [file] [log] [blame]
// SPDX-License-Identifier: GPL-2.0
/*
* Common KUnit mock call arg matchers and formatters.
*
* Copyright (C) 2018, Google LLC.
* Author: Brendan Higgins <brendanhiggins@google.com>
*/
#include <linux/kernel.h>
#include <test/mock.h>
static bool match_any(struct mock_param_matcher *pmatcher,
struct test_stream *stream,
const void *actual)
{
stream->add(stream, "don't care");
return true;
}
static struct mock_param_matcher any_matcher = {
.match = match_any,
};
struct mock_param_matcher *any(struct test *test)
{
return &any_matcher;
}
#define DEFINE_MATCHER_STRUCT(type_name, type) \
struct mock_##type_name##_matcher { \
struct mock_param_matcher matcher; \
type expected; \
};
#define DEFINE_TO_MATCHER_STRUCT(type_name) \
struct mock_##type_name##_matcher * \
to_mock_##type_name##_matcher( \
struct mock_param_matcher *matcher) \
{ \
return container_of(matcher, \
struct mock_##type_name##_matcher, \
matcher); \
}
#define DEFINE_MATCH_FUNC(type_name, type, op_name, op) \
bool match_##type_name##_##op_name( \
struct mock_param_matcher *pmatcher, \
struct test_stream *stream, \
const void *pactual) \
{ \
struct mock_##type_name##_matcher *matcher = \
to_mock_##type_name##_matcher(pmatcher); \
type actual = *((type *) pactual); \
bool matches = actual op matcher->expected; \
\
if (matches) \
stream->add(stream, \
"%d "#op" %d", \
actual, \
matcher->expected); \
else \
stream->add(stream, \
"%d not "#op" %d", \
actual, \
matcher->expected); \
\
return matches; \
}
#define DEFINE_MATCH_FACTORY(type_name, type, op_name) \
struct mock_param_matcher *type_name##_##op_name( \
struct test *test, type expected) \
{ \
struct mock_##type_name##_matcher *matcher; \
\
matcher = test_kmalloc(test, \
sizeof(*matcher), \
GFP_KERNEL); \
if (!matcher) \
return NULL; \
\
matcher->matcher.match = match_##type_name##_##op_name;\
matcher->expected = expected; \
return &matcher->matcher; \
}
#define DEFINE_MATCHER_WITH_TYPENAME(type_name, type) \
DEFINE_MATCHER_STRUCT(type_name, type) \
DEFINE_TO_MATCHER_STRUCT(type_name) \
DEFINE_MATCH_FUNC(type_name, type, eq, ==) \
DEFINE_MATCH_FACTORY(type_name, type, eq) \
DEFINE_MATCH_FUNC(type_name, type, ne, !=) \
DEFINE_MATCH_FACTORY(type_name, type, ne) \
DEFINE_MATCH_FUNC(type_name, type, le, <=) \
DEFINE_MATCH_FACTORY(type_name, type, le) \
DEFINE_MATCH_FUNC(type_name, type, lt, <) \
DEFINE_MATCH_FACTORY(type_name, type, lt) \
DEFINE_MATCH_FUNC(type_name, type, ge, >=) \
DEFINE_MATCH_FACTORY(type_name, type, ge) \
DEFINE_MATCH_FUNC(type_name, type, gt, >) \
DEFINE_MATCH_FACTORY(type_name, type, gt)
#define DEFINE_MATCHER(type) DEFINE_MATCHER_WITH_TYPENAME(type, type)
DEFINE_MATCHER(u8);
DEFINE_MATCHER(u16);
DEFINE_MATCHER(u32);
DEFINE_MATCHER(u64);
DEFINE_MATCHER(char);
DEFINE_MATCHER_WITH_TYPENAME(uchar, unsigned char);
DEFINE_MATCHER_WITH_TYPENAME(schar, signed char);
DEFINE_MATCHER(short);
DEFINE_MATCHER_WITH_TYPENAME(ushort, unsigned short);
DEFINE_MATCHER(int);
DEFINE_MATCHER_WITH_TYPENAME(uint, unsigned int);
DEFINE_MATCHER(long);
DEFINE_MATCHER_WITH_TYPENAME(ulong, unsigned long);
DEFINE_MATCHER_WITH_TYPENAME(longlong, long long);
DEFINE_MATCHER_WITH_TYPENAME(ulonglong, unsigned long long);
DEFINE_MATCHER_WITH_TYPENAME(ptr, void *);
DEFINE_MATCHER_STRUCT(bool, bool)
DEFINE_TO_MATCHER_STRUCT(bool)
DEFINE_MATCH_FUNC(bool, bool, eq, ==)
DEFINE_MATCH_FACTORY(bool, bool, eq)
DEFINE_MATCH_FUNC(bool, bool, ne, !=)
DEFINE_MATCH_FACTORY(bool, bool, ne)
struct mock_memeq_matcher {
struct mock_param_matcher matcher;
const void *expected;
size_t size;
};
static bool match_memeq(struct mock_param_matcher *pmatcher,
struct test_stream *stream,
const void *pactual)
{
struct mock_memeq_matcher *matcher =
container_of(pmatcher,
struct mock_memeq_matcher,
matcher);
const void *actual = CONVERT_TO_ACTUAL_TYPE(const void *, pactual);
bool matches = !memcmp(actual, matcher->expected, matcher->size);
int i;
for (i = 0; i < matcher->size; i++)
stream->add(stream, "%02x, ", ((const char *) actual)[i]);
if (matches)
stream->add(stream, "== ");
else
stream->add(stream, "!= ");
for (i = 0; i < matcher->size; i++)
stream->add(stream,
"%02x, ",
((const char *) matcher->expected)[i]);
return matches;
}
struct mock_param_matcher *memeq(struct test *test,
const void *buf,
size_t size)
{
struct mock_memeq_matcher *matcher;
matcher = test_kzalloc(test, sizeof(*matcher), GFP_KERNEL);
if (!matcher)
return NULL;
matcher->matcher.match = match_memeq;
matcher->expected = buf;
matcher->size = size;
return &matcher->matcher;
}
struct mock_streq_matcher {
struct mock_param_matcher matcher;
const char *expected;
};
static bool match_streq(struct mock_param_matcher *pmatcher,
struct test_stream *stream,
const void *pactual)
{
struct mock_streq_matcher *matcher =
container_of(pmatcher,
struct mock_streq_matcher,
matcher);
const char *actual = CONVERT_TO_ACTUAL_TYPE(const char *, pactual);
bool matches = !strcmp(actual, matcher->expected);
if (matches)
stream->add(stream, "%s == %s", actual, matcher->expected);
else
stream->add(stream, "%s != %s", actual, matcher->expected);
return matches;
}
struct mock_param_matcher *streq(struct test *test, const char *str)
{
struct mock_streq_matcher *matcher;
matcher = test_kzalloc(test, sizeof(*matcher), GFP_KERNEL);
if (!matcher)
return NULL;
matcher->matcher.match = match_streq;
matcher->expected = str;
return &matcher->matcher;
}
struct mock_str_contains_matcher {
struct mock_param_matcher matcher;
const char *needle;
};
static bool match_str_contains(struct mock_param_matcher *pmatcher,
struct test_stream *stream,
const void *phaystack)
{
struct mock_str_contains_matcher *matcher =
container_of(pmatcher,
struct mock_str_contains_matcher,
matcher);
const char *haystack = CONVERT_TO_ACTUAL_TYPE(const char *, phaystack);
bool matches = strstr(haystack, matcher->needle);
if (matches)
stream->add(stream,
"'%s' found in '%s'",
matcher->needle,
haystack);
else
stream->add(stream,
"'%s' not found in '%s'",
matcher->needle,
haystack);
return matches;
}
struct mock_param_matcher *str_contains(struct test *test, const char *str)
{
struct mock_str_contains_matcher *matcher;
matcher = test_kzalloc(test, sizeof(*matcher), GFP_KERNEL);
if (!matcher)
return NULL;
matcher->matcher.match = match_str_contains;
matcher->needle = str;
return &matcher->matcher;
}
struct mock_param_matcher *va_format_cmp(struct test *test,
struct mock_param_matcher *fmt_matcher,
struct mock_param_matcher *va_matcher)
{
struct mock_struct_matcher_entry *entries;
entries = test_kzalloc(test, sizeof(*entries) * 3, GFP_KERNEL);
if (!entries)
return NULL;
INIT_MOCK_STRUCT_MATCHER_ENTRY(&entries[0],
struct va_format,
fmt,
fmt_matcher);
INIT_MOCK_STRUCT_MATCHER_ENTRY(&entries[1],
struct va_format,
va,
va_matcher);
INIT_MOCK_STRUCT_MATCHER_ENTRY_LAST(&entries[2]);
return struct_cmp(test, "va_format", entries);
}
struct mock_struct_matcher {
struct mock_param_matcher matcher;
const char *struct_name;
struct mock_struct_matcher_entry *entries;
};
static bool match_struct(struct mock_param_matcher *pmatcher,
struct test_stream *stream,
const void *pactual)
{
struct mock_struct_matcher *matcher =
container_of(pmatcher,
struct mock_struct_matcher,
matcher);
struct mock_struct_matcher_entry *entry;
const char *actual = CONVERT_TO_ACTUAL_TYPE(const char *, pactual);
const char *member_ptr;
bool matches = true, tmp;
stream->add(stream, "struct %s {", matcher->struct_name);
for (entry = matcher->entries; entry->matcher; entry++) {
member_ptr = actual + entry->member_offset;
tmp = entry->matcher->match(entry->matcher, stream, member_ptr);
matches = matches && tmp;
stream->add(stream, ", ");
}
stream->add(stream, "}");
return matches;
}
struct mock_param_matcher *struct_cmp(struct test *test,
const char *struct_name,
struct mock_struct_matcher_entry *entries)
{
struct mock_struct_matcher *matcher;
matcher = test_kzalloc(test, sizeof(*matcher), GFP_KERNEL);
if (!matcher)
return NULL;
matcher->matcher.match = match_struct;
matcher->struct_name = struct_name;
matcher->entries = entries;
return &matcher->matcher;
}
static bool match_and_capture_param(struct mock_param_matcher *pmatcher,
struct test_stream *stream,
const void *param)
{
struct mock_param_capturer *capturer =
container_of(pmatcher,
struct mock_param_capturer,
matcher);
struct mock_param_matcher *child_matcher = capturer->child_matcher;
bool matches;
matches = child_matcher->match(child_matcher, stream, param);
if (matches)
capturer->captured_param = capturer->capture_param(stream->test,
param);
return matches;
}
struct mock_param_capturer *mock_param_capturer_create(
struct test *test,
struct mock_param_matcher *child_matcher,
void *(*capture_param)(struct test *, const void *))
{
struct mock_param_capturer *capturer;
capturer = test_kzalloc(test, sizeof(*capturer), GFP_KERNEL);
if (!capturer)
return NULL;
capturer->matcher.match = match_and_capture_param;
capturer->child_matcher = child_matcher;
capturer->capture_param = capture_param;
capturer->captured_param = NULL;
return capturer;
}
static void *mock_capture_int(struct test *test, const void *param)
{
int value = CONVERT_TO_ACTUAL_TYPE(int, param);
int *pvalue;
pvalue = test_kzalloc(test, sizeof(*pvalue), GFP_KERNEL);
if (!pvalue)
return NULL;
*pvalue = value;
return pvalue;
}
struct mock_param_capturer *mock_int_capturer_create(
struct test *test, struct mock_param_matcher *child_matcher)
{
return mock_param_capturer_create(test,
child_matcher,
mock_capture_int);
}
static void *mock_capture_ptr(struct test *test, const void *param)
{
void *ptr = CONVERT_TO_ACTUAL_TYPE(void *, param);
void **pptr;
pptr = test_kzalloc(test, sizeof(*pptr), GFP_KERNEL);
*pptr = ptr;
return pptr;
}
struct mock_param_capturer *mock_ptr_capturer_create(
struct test *test, struct mock_param_matcher *child_matcher)
{
return mock_param_capturer_create(test,
child_matcher,
mock_capture_ptr);
}
#define DEFINE_RETURN_ACTION_STRUCT(type_name, type) \
struct mock_##type_name##_action { \
struct mock_action action; \
type ret; \
};
#define DEFINE_RETURN_ACTION_FUNC(type_name, type) \
void *do_##type_name##_return(struct mock_action *paction, \
const void **params, \
int len) \
{ \
struct mock_##type_name##_action *action = \
container_of(paction, \
struct mock_##type_name##_action,\
action); \
\
return (void *) &action->ret; \
}
#define DEFINE_RETURN_ACTION_FACTORY(type_name, type) \
struct mock_action *type_name##_return(struct test *test, \
type ret) \
{ \
struct mock_##type_name##_action *action; \
\
action = test_kmalloc(test, \
sizeof(*action), \
GFP_KERNEL); \
if (!action) \
return NULL; \
\
action->action.do_action = do_##type_name##_return; \
action->ret = ret; \
\
return &action->action; \
}
#define DEFINE_RETURN_ACTION_WITH_TYPENAME(type_name, type) \
DEFINE_RETURN_ACTION_STRUCT(type_name, type); \
DEFINE_RETURN_ACTION_FUNC(type_name, type); \
DEFINE_RETURN_ACTION_FACTORY(type_name, type);
#define DEFINE_RETURN_ACTION(type) \
DEFINE_RETURN_ACTION_WITH_TYPENAME(type, type)
DEFINE_RETURN_ACTION(bool);
DEFINE_RETURN_ACTION(u8);
DEFINE_RETURN_ACTION(u16);
DEFINE_RETURN_ACTION(u32);
DEFINE_RETURN_ACTION(u64);
DEFINE_RETURN_ACTION(char);
DEFINE_RETURN_ACTION_WITH_TYPENAME(uchar, unsigned char);
DEFINE_RETURN_ACTION_WITH_TYPENAME(schar, signed char);
DEFINE_RETURN_ACTION(short);
DEFINE_RETURN_ACTION_WITH_TYPENAME(ushort, unsigned short);
DEFINE_RETURN_ACTION(int);
DEFINE_RETURN_ACTION_WITH_TYPENAME(uint, unsigned int);
DEFINE_RETURN_ACTION(long);
DEFINE_RETURN_ACTION_WITH_TYPENAME(ulong, unsigned long);
DEFINE_RETURN_ACTION_WITH_TYPENAME(longlong, long long);
DEFINE_RETURN_ACTION_WITH_TYPENAME(ulonglong, unsigned long long);
DEFINE_RETURN_ACTION_WITH_TYPENAME(ptr, void *);
struct mock_invoke_action {
struct mock_action action;
struct test *test;
void *(*invokable)(struct test *test, const void *params[], int len);
};
static void *do_invoke(struct mock_action *paction,
const void *params[],
int len)
{
struct mock_invoke_action *action =
container_of(paction,
struct mock_invoke_action,
action);
return action->invokable(action->test, params, len);
}
struct mock_action *invoke(struct test *test,
void *(*invokable)(struct test *,
const void *params[],
int len))
{
struct mock_invoke_action *action;
action = test_kmalloc(test, sizeof(*action), GFP_KERNEL);
if (!action)
return NULL;
action->action.do_action = do_invoke;
action->test = test;
action->invokable = invokable;
return &action->action;
}
struct mock_param_integer_formatter {
struct mock_param_formatter formatter;
const char *fmt_str;
};
static void mock_format_integer(struct mock_param_formatter *pformatter,
struct test_stream *stream,
const void *pparam)
{
struct mock_param_integer_formatter *formatter =
container_of(pformatter,
struct mock_param_integer_formatter,
formatter);
long long param = CONVERT_TO_ACTUAL_TYPE(long long, pparam);
stream->add(stream, formatter->fmt_str, param);
}
#define INTEGER_FORMATTER_INIT(type, fmt) { \
.formatter = { \
.type_name = #type, \
.format = mock_format_integer, \
}, \
.fmt_str = fmt, \
}
static struct mock_param_integer_formatter integer_formatters[] = {
INTEGER_FORMATTER_INIT(u8, "%hhu"),
INTEGER_FORMATTER_INIT(u16, "%hu"),
INTEGER_FORMATTER_INIT(u32, "%u"),
INTEGER_FORMATTER_INIT(u64, "%llu"),
INTEGER_FORMATTER_INIT(char, "%c"),
INTEGER_FORMATTER_INIT(unsigned char, "%hhu"),
INTEGER_FORMATTER_INIT(signed char, "%hhd"),
INTEGER_FORMATTER_INIT(short, "%hd"),
INTEGER_FORMATTER_INIT(unsigned short, "%hu"),
INTEGER_FORMATTER_INIT(int, "%d"),
INTEGER_FORMATTER_INIT(unsigned int, "%u"),
INTEGER_FORMATTER_INIT(long, "%ld"),
INTEGER_FORMATTER_INIT(unsigned long, "%lu"),
INTEGER_FORMATTER_INIT(long long, "%lld"),
INTEGER_FORMATTER_INIT(unsigned long long, "%llu"),
INTEGER_FORMATTER_INIT(void *, "%px"),
};
static void mock_format_string(struct mock_param_formatter *formatter,
struct test_stream *stream,
const void *pparam)
{
const char *param = CONVERT_TO_ACTUAL_TYPE(const char *, pparam);
stream->add(stream, "%s", param);
}
static struct mock_param_formatter string_formatter = {
.type_name = "const char *",
.format = mock_format_string,
};
static void mock_format_unknown(struct mock_param_formatter *formatter,
struct test_stream *stream,
const void *param)
{
stream->add(stream, "%pS", param);
}
struct mock_param_formatter unknown_formatter[] = {
{
.type_name = "<unknown>",
.format = mock_format_unknown,
},
{},
};
static int mock_register_all_formatters(void)
{
int i;
for (i = 0; i < ARRAY_SIZE(integer_formatters); i++)
mock_register_formatter(&integer_formatters[i].formatter);
mock_register_formatter(&string_formatter);
return 0;
}
test_pure_initcall(mock_register_all_formatters);
struct mock_struct_formatter {
struct mock_param_formatter formatter;
const char *type_name;
struct mock_struct_formatter_entry *entries;
};
static void mock_format_struct(struct mock_param_formatter *pformatter,
struct test_stream *stream,
const void *pparam)
{
struct mock_struct_formatter *formatter =
container_of(pformatter,
struct mock_struct_formatter,
formatter);
struct mock_struct_formatter_entry *entry;
const char *param = CONVERT_TO_ACTUAL_TYPE(const char *, pparam);
const char *member_ptr;
stream->add(stream, "%s {", formatter->type_name);
for (entry = formatter->entries; entry->formatter; entry++) {
member_ptr = param + entry->member_offset;
entry->formatter->format(entry->formatter, stream, member_ptr);
stream->add(stream, ", ");
}
stream->add(stream, "}");
}
struct mock_param_formatter *mock_struct_formatter(
struct test *test,
const char *type_name,
struct mock_struct_formatter_entry *entries)
{
struct mock_struct_formatter *formatter;
formatter = test_kzalloc(test, sizeof(*formatter), GFP_KERNEL);
if (!formatter)
return NULL;
formatter->formatter.type_name = type_name;
formatter->formatter.format = mock_format_struct;
formatter->type_name = type_name;
formatter->entries = entries;
return &formatter->formatter;
}
/* Composite matchers: match_and, match_or. */
struct mock_composite_binary_matcher {
struct mock_param_matcher *left_matcher;
struct mock_param_matcher *right_matcher;
struct mock_param_matcher matcher;
};
#define DEFINE_COMPOSITE_BINARY_MATCH_FUNC(combine_op, op_name) \
bool match_##op_name(struct mock_param_matcher *pmatcher, \
struct test_stream *stream, \
const void *pactual) \
{ \
bool result; \
struct mock_composite_binary_matcher *compound_matcher = \
container_of(pmatcher, \
struct mock_composite_binary_matcher, \
matcher); \
\
stream->add(stream, "(("); \
result = compound_matcher->left_matcher->match( \
compound_matcher->left_matcher, stream, pactual); \
stream->add(stream, ") " #op_name " (("); \
result combine_op compound_matcher->right_matcher->match( \
compound_matcher->right_matcher, stream, pactual); \
stream->add(stream, "))"); \
\
return result; \
} \
#define DEFINE_COMPOSITE_BINARY_MATCHER_FACTORY(combine_op, op_name) \
struct mock_param_matcher *op_name(struct test *test, \
struct mock_param_matcher *left_matcher, \
struct mock_param_matcher *right_matcher) \
{ \
struct mock_composite_binary_matcher *matcher; \
\
matcher = test_kmalloc(test, \
sizeof(*matcher), \
GFP_KERNEL); \
if (!matcher) \
return NULL; \
\
matcher->matcher.match = match_##op_name; \
matcher->left_matcher = left_matcher; \
matcher->right_matcher = right_matcher; \
return &matcher->matcher; \
} \
#define COMPOSITE_BINARY_MATCHER(combine_op, op_name) \
DEFINE_COMPOSITE_BINARY_MATCH_FUNC(combine_op, op_name) \
DEFINE_COMPOSITE_BINARY_MATCHER_FACTORY(combine_op, op_name) \
/* Conjunction of the inner matchers. */
COMPOSITE_BINARY_MATCHER(&=, and);
/* Disjunction of the inner matchers. */
COMPOSITE_BINARY_MATCHER(|=, or);
struct mock_composite_unary_matcher {
struct mock_param_matcher *inner_matcher;
struct mock_param_matcher matcher;
};
bool match_not(struct mock_param_matcher *pmatcher,
struct test_stream *stream,
const void *pactual)
{
bool result;
struct mock_composite_unary_matcher *compound_matcher =
container_of(pmatcher,
struct mock_composite_unary_matcher,
matcher);
stream->add(stream, "not (");
result = !compound_matcher->inner_matcher->match(
compound_matcher->inner_matcher,
stream,
pactual);
stream->add(stream, ")");
return result;
}
/* Negates the result of the inner matcher */
struct mock_param_matcher *not(struct test *test,
struct mock_param_matcher *inner_matcher)
{
struct mock_composite_unary_matcher *matcher;
matcher = test_kmalloc(test,
sizeof(*matcher),
GFP_KERNEL);
if (!matcher)
return NULL;
matcher->matcher.match = match_not;
matcher->inner_matcher = inner_matcher;
return &matcher->matcher;
}