path: root/lib/kunit/string-stream.c
diff options
authorAlan Maguire <>2020-05-29 22:46:20 +0100
committerShuah Khan <>2020-06-26 14:12:00 -0600
commitd4cdd146d0db900b2eb6c2d28cba719b3bf0a928 (patch)
treebbb042fbdd37bc931289384eaf393fa1c079500f /lib/kunit/string-stream.c
parent48778464bb7d346b47157d21ffde2af6b2d39110 (diff)
kunit: generalize kunit_resource API beyond allocated resources
In its original form, the kunit resources API - consisting the struct kunit_resource and associated functions - was focused on adding allocated resources during test operation that would be automatically cleaned up on test completion. The recent RFC patch proposing converting KASAN tests to KUnit [1] showed another potential model - where outside of test context, but with a pointer to the test state, we wish to access/update test-related data, but expressly want to avoid allocations. It turns out we can generalize the kunit_resource to support static resources where the struct kunit_resource * is passed in and initialized for us. As part of this work, we also change the "allocation" field to the more general "data" name, as instead of associating an allocation, we can associate a pointer to static data. Static data is distinguished by a NULL free functions. A test is added to cover using kunit_add_resource() with a static resource and data. Finally we also make use of the kernel's krefcount interfaces to manage reference counting of KUnit resources. The motivation for this is simple; if we have kernel threads accessing and using resources (say via kunit_find_resource()) we need to ensure we do not remove said resources (or indeed free them if they were dynamically allocated) until the reference count reaches zero. A new function - kunit_put_resource() - is added to handle this, and it should be called after a thread using kunit_find_resource() is finished with the retrieved resource. We ensure that the functions needed to look up, use and drop reference count are "static inline"-defined so that they can be used by builtin code as well as modules in the case that KUnit is built as a module. A cosmetic change here also; I've tried moving to kunit_[action]_resource() as the format of function names for consistency and readability. [1] Signed-off-by: Alan Maguire <> Reviewed-by: Brendan Higgins <> Signed-off-by: Shuah Khan <>
Diffstat (limited to 'lib/kunit/string-stream.c')
1 files changed, 6 insertions, 8 deletions
diff --git a/lib/kunit/string-stream.c b/lib/kunit/string-stream.c
index 350392013c14..141789ca8949 100644
--- a/lib/kunit/string-stream.c
+++ b/lib/kunit/string-stream.c
@@ -33,14 +33,14 @@ static int string_stream_fragment_init(struct kunit_resource *res,
if (!frag->fragment)
return -ENOMEM;
- res->allocation = frag;
+ res->data = frag;
return 0;
static void string_stream_fragment_free(struct kunit_resource *res)
- struct string_stream_fragment *frag = res->allocation;
+ struct string_stream_fragment *frag = res->data;
kunit_kfree(frag->test, frag->fragment);
@@ -65,9 +65,8 @@ static struct string_stream_fragment *alloc_string_stream_fragment(
static int string_stream_fragment_destroy(struct string_stream_fragment *frag)
- return kunit_resource_destroy(frag->test,
+ return kunit_destroy_resource(frag->test,
- string_stream_fragment_free,
@@ -179,7 +178,7 @@ static int string_stream_init(struct kunit_resource *res, void *context)
if (!stream)
return -ENOMEM;
- res->allocation = stream;
+ res->data = stream;
stream->gfp = ctx->gfp;
stream->test = ctx->test;
@@ -190,7 +189,7 @@ static int string_stream_init(struct kunit_resource *res, void *context)
static void string_stream_free(struct kunit_resource *res)
- struct string_stream *stream = res->allocation;
+ struct string_stream *stream = res->data;
@@ -211,8 +210,7 @@ struct string_stream *alloc_string_stream(struct kunit *test, gfp_t gfp)
int string_stream_destroy(struct string_stream *stream)
- return kunit_resource_destroy(stream->test,
+ return kunit_destroy_resource(stream->test,
- string_stream_free,