kunit: Annotate _MSG assertion variants with gnu printf specifiers
authorDavid Gow <davidgow@google.com>
Wed, 21 Feb 2024 09:27:22 +0000 (17:27 +0800)
committerShuah Khan <skhan@linuxfoundation.org>
Wed, 28 Feb 2024 20:07:49 +0000 (13:07 -0700)
KUnit's assertion macros have variants which accept a printf format
string, to allow tests to specify a more detailed message on failure.
These (and the related KUNIT_FAIL() macro) ultimately wrap the
__kunit_do_failed_assertion() function, which accepted a printf format
specifier, but did not have the __printf attribute, so gcc couldn't warn
on incorrect agruments.

It turns out there were quite a few tests with such incorrect arguments.

Add the __printf() specifier now that we've fixed these errors, to
prevent them from recurring.

Suggested-by: Linus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: David Gow <davidgow@google.com>
Tested-by: Guenter Roeck <linux@roeck-us.net>
Reviewed-by: Justin Stitt <justinstitt@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
include/kunit/test.h

index fcb4a49..61637ef 100644 (file)
@@ -579,12 +579,12 @@ void __printf(2, 3) kunit_log_append(struct string_stream *log, const char *fmt,
 
 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,
-                              assert_format_t assert_format,
-                              const char *fmt, ...);
+void __printf(6, 7) __kunit_do_failed_assertion(struct kunit *test,
+                                               const struct kunit_loc *loc,
+                                               enum kunit_assert_type type,
+                                               const struct kunit_assert *assert,
+                                               assert_format_t assert_format,
+                                               const char *fmt, ...);
 
 #define _KUNIT_FAILED(test, assert_type, assert_class, assert_format, INITIALIZER, fmt, ...) do { \
        static const struct kunit_loc __loc = KUNIT_CURRENT_LOC;               \