kunit: Expose 'static stub' API to redirect functions
authorDavid Gow <davidgow@google.com>
Tue, 31 Jan 2023 06:46:40 +0000 (14:46 +0800)
committerShuah Khan <skhan@linuxfoundation.org>
Wed, 8 Feb 2023 21:28:17 +0000 (14:28 -0700)
commite047c5eaa76324575e1f95664be4c74ce0e2571b
tree51b5e8bb2d8f8bcfda247ec69533f086a9f0834e
parent7170b7ed6acbde523c5d362c8978c60df4c30f30
kunit: Expose 'static stub' API to redirect functions

Add a simple way of redirecting calls to functions by including a
special prologue in the "real" function which checks to see if the
replacement function should be called (and, if so, calls it).

To redirect calls to a function, make the first (non-declaration) line
of the function:

KUNIT_STATIC_STUB_REDIRECT(function_name, [function arguments]);

(This will compile away to nothing if KUnit is not enabled, otherwise it
will check if a redirection is active, call the replacement function,
and return. This check is protected by a static branch, so has very
little overhead when there are no KUnit tests running.)

Calls to the real function can be redirected to a replacement using:

kunit_activate_static_stub(test, real_fn, replacement_fn);

The redirection will only affect calls made from within the kthread of
the current test, and will be automatically disabled when the test
completes. It can also be manually disabled with
kunit_deactivate_static_stub().

The 'example' KUnit test suite has a more complete example.

Co-developed-by: Daniel Latypov <dlatypov@google.com>
Signed-off-by: Daniel Latypov <dlatypov@google.com>
Signed-off-by: David Gow <davidgow@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
include/kunit/static_stub.h [new file with mode: 0644]
include/kunit/test-bug.h
lib/kunit/Makefile
lib/kunit/hooks-impl.h
lib/kunit/kunit-example-test.c
lib/kunit/static_stub.c [new file with mode: 0644]