Commit 26075518 authored by David Gow's avatar David Gow Committed by Shuah Khan
Browse files

kunit: Move kunit_abort() call out of kunit_do_failed_assertion() 



KUnit aborts the current thread when an assertion fails. Currently, this
is done conditionally as part of the kunit_do_failed_assertion()
function, but this hides the kunit_abort() call from the compiler
(particularly if it's in another module). This, in turn, can lead to
both suboptimal code generation (the compiler can't know if
kunit_do_failed_assertion() will return), and to static analysis tools
like smatch giving false positives.

Moving the kunit_abort() call into the macro should give the compiler
and tools a better chance at understanding what's going on. Doing so
requires exporting kunit_abort(), though it's recommended to continue to
use assertions in lieu of aborting directly.

In addition, kunit_abort() and kunit_do_failed_assertion() are renamed
to make it clear they they're intended for internal KUnit use, to:
__kunit_do_failed_assertion() and __kunit_abort()

Suggested-by: default avatarDan Carpenter <dan.carpenter@linaro.org>
Signed-off-by: default avatarDavid Gow <davidgow@google.com>
Reviewed-by: default avatarMiguel Ojeda <ojeda@kernel.org>
Reviewed-by: default avatarDaniel Latypov <dlatypov@google.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent c042030a

include/kunit/test.h

+12 −8
Original line number Diff line number Diff line
@@ -482,7 +482,9 @@ void __printf(2, 3) kunit_log_append(char *log, const char *fmt, ...); 
 */

#define KUNIT_SUCCEED(test) do {} while (0)



void kunit_do_failed_assertion(struct kunit *test,

void __noreturn __kunit_abort(struct kunit *test);



void __kunit_do_failed_assertion(struct kunit *test,

			       const struct kunit_loc *loc,

			       enum kunit_assert_type type,

			       const struct kunit_assert *assert,
@@ -492,13 +494,15 @@ void kunit_do_failed_assertion(struct kunit *test, 
#define _KUNIT_FAILED(test, assert_type, assert_class, assert_format, INITIALIZER, fmt, ...) do { \

	static const struct kunit_loc __loc = KUNIT_CURRENT_LOC;	       \

	const struct assert_class __assertion = INITIALIZER;		       \

	kunit_do_failed_assertion(test,					       \

	__kunit_do_failed_assertion(test,				       \

				    &__loc,				       \

				    assert_type,			       \

				    &__assertion.assert,		       \

				    assert_format,			       \

				    fmt,				       \

				    ##__VA_ARGS__);			       \

	if (assert_type == KUNIT_ASSERTION)				       \

		__kunit_abort(test);					       \

} while (0)

lib/kunit/test.c

+4 −6
Original line number Diff line number Diff line
@@ -323,7 +323,7 @@ static void kunit_fail(struct kunit *test, const struct kunit_loc *loc, 
	string_stream_destroy(stream);

}



static void __noreturn kunit_abort(struct kunit *test)

void __noreturn __kunit_abort(struct kunit *test)

{

	kunit_try_catch_throw(&test->try_catch); /* Does not return. */
@@ -335,8 +335,9 @@ static void __noreturn kunit_abort(struct kunit *test) 
	 */

	WARN_ONCE(true, "Throw could not abort from test!\n");

}

EXPORT_SYMBOL_GPL(__kunit_abort);



void kunit_do_failed_assertion(struct kunit *test,

void __kunit_do_failed_assertion(struct kunit *test,

			       const struct kunit_loc *loc,

			       enum kunit_assert_type type,

			       const struct kunit_assert *assert,
@@ -353,11 +354,8 @@ void kunit_do_failed_assertion(struct kunit *test, 
	kunit_fail(test, loc, type, assert, assert_format, &message);



	va_end(args);



	if (type == KUNIT_ASSERTION)

		kunit_abort(test);

}

EXPORT_SYMBOL_GPL(kunit_do_failed_assertion);

EXPORT_SYMBOL_GPL(__kunit_do_failed_assertion);



void kunit_init_test(struct kunit *test, const char *name, char *log)

{