diff mbox series

kunit: Add gnu_printf specifiers

Message ID 20210513200350.854429-1-davidgow@google.com
State Accepted
Commit 44acdbb250a57240ec113f12bd6229854681ea5f
Headers show
Series kunit: Add gnu_printf specifiers | expand

Commit Message

David Gow May 13, 2021, 8:03 p.m. UTC
Some KUnit functions use variable arguments to implement a printf-like
format string. Use the __printf() attribute to let the compiler warn if
invalid format strings are passed in.

If the kernel is build with W=1, it complained about the lack of these
specifiers, e.g.:
../lib/kunit/test.c:72:2: warning: function ‘kunit_log_append’ might be a candidate for ‘gnu_printf’ format attribute [-Wsuggest-attribute=format]

Signed-off-by: David Gow <davidgow@google.com>
---
 include/kunit/test.h      | 2 +-
 lib/kunit/string-stream.h | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

Comments

Brendan Higgins June 15, 2021, 9:01 p.m. UTC | #1
On Thu, May 13, 2021 at 1:03 PM David Gow <davidgow@google.com> wrote:
>

> Some KUnit functions use variable arguments to implement a printf-like

> format string. Use the __printf() attribute to let the compiler warn if

> invalid format strings are passed in.

>

> If the kernel is build with W=1, it complained about the lack of these

> specifiers, e.g.:

> ../lib/kunit/test.c:72:2: warning: function ‘kunit_log_append’ might be a candidate for ‘gnu_printf’ format attribute [-Wsuggest-attribute=format]

>

> Signed-off-by: David Gow <davidgow@google.com>


Acked-by: Brendan Higgins <brendanhiggins@google.com>
diff mbox series

Patch

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 49601c4b98b8..af2e386b867c 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -610,7 +610,7 @@  static inline void *kunit_kzalloc(struct kunit *test, size_t size, gfp_t gfp)
 
 void kunit_cleanup(struct kunit *test);
 
-void kunit_log_append(char *log, const char *fmt, ...);
+void __printf(2, 3) kunit_log_append(char *log, const char *fmt, ...);
 
 /*
  * printk and log to per-test or per-suite log buffer.  Logging only done
diff --git a/lib/kunit/string-stream.h b/lib/kunit/string-stream.h
index fe98a00b75a9..5e94b623454f 100644
--- a/lib/kunit/string-stream.h
+++ b/lib/kunit/string-stream.h
@@ -35,9 +35,9 @@  struct string_stream *alloc_string_stream(struct kunit *test, gfp_t gfp);
 int __printf(2, 3) string_stream_add(struct string_stream *stream,
 				     const char *fmt, ...);
 
-int string_stream_vadd(struct string_stream *stream,
-		       const char *fmt,
-		       va_list args);
+int __printf(2, 0) string_stream_vadd(struct string_stream *stream,
+				      const char *fmt,
+				      va_list args);
 
 char *string_stream_get_string(struct string_stream *stream);