| Message ID | 20240221092728.1281499-10-davidgow@google.com (mailing list archive) |
|---|---|
| State | Mainlined |
| Commit | 806cb2270237ce2ec672a407d66cee17a07d3aa2 |
| Headers | show |
| Series | kunit: Fix printf format specifier issues in KUnit assertions | expand |
On Wed, Feb 21, 2024 at 05:27:22PM +0800, David Gow wrote: > 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> > --- > include/kunit/test.h | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/include/kunit/test.h b/include/kunit/test.h > index fcb4a4940ace..61637ef32302 100644 > --- a/include/kunit/test.h > +++ b/include/kunit/test.h > @@ -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; \ > -- > 2.44.0.rc0.258.g7320e95886-goog >
Hi, On Wed, Feb 21, 2024 at 05:27:22PM +0800, David Gow wrote: > 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> Reviewed-by: Justin Stitt <justinstitt@google.com> > --- > include/kunit/test.h | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/include/kunit/test.h b/include/kunit/test.h > index fcb4a4940ace..61637ef32302 100644 > --- a/include/kunit/test.h > +++ b/include/kunit/test.h > @@ -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; \ > -- > 2.44.0.rc0.258.g7320e95886-goog > Thanks Justin
diff --git a/include/kunit/test.h b/include/kunit/test.h index fcb4a4940ace..61637ef32302 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -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; \
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> --- include/kunit/test.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)