2023-09-22 09:24:18

by Maciej Wieczor-Retman

Subject: [PATCH v3 1/8] selftests: Add printf attribute to ksefltest prints

Kselftest header defines multiple variadic functions that use printf
along with other logic.

There is no format checking for the variadic functions that use
printing inside kselftest.h. Because of this the compiler won't
be able to catch instances of mismatched printf formats and debugging
tests might be more difficult.

Add the common __printf attribute macro to kselftest.h.

Add __printf attribute to every function using formatted printing with
variadic arguments.

Reviewed-by: Ilpo Järvinen <[email protected]>
Signed-off-by: Maciej Wieczor-Retman <[email protected]>
---
tools/testing/selftests/kselftest.h | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/tools/testing/selftests/kselftest.h b/tools/testing/selftests/kselftest.h
index 529d29a35900..f4c677b5d68f 100644
--- a/tools/testing/selftests/kselftest.h
+++ b/tools/testing/selftests/kselftest.h
@@ -77,6 +77,8 @@
#define KSFT_XPASS 3
#define KSFT_SKIP 4

+#define __printf(a, b) __attribute__((format(printf, a, b)))
+
/* counters */
struct ksft_count {
unsigned int ksft_pass;
@@ -143,7 +145,7 @@ static inline void ksft_print_cnts(void)
ksft_cnt.ksft_xskip, ksft_cnt.ksft_error);
}

-static inline void ksft_print_msg(const char *msg, ...)
+static inline __printf(1, 2) void ksft_print_msg(const char *msg, ...)
{
int saved_errno = errno;
va_list args;
@@ -155,7 +157,7 @@ static inline void ksft_print_msg(const char *msg, ...)
va_end(args);
}

-static inline void ksft_test_result_pass(const char *msg, ...)
+static inline __printf(1, 2) void ksft_test_result_pass(const char *msg, ...)
{
int saved_errno = errno;
va_list args;
@@ -169,7 +171,7 @@ static inline void ksft_test_result_pass(const char *msg, ...)
va_end(args);
}

-static inline void ksft_test_result_fail(const char *msg, ...)
+static inline __printf(1, 2) void ksft_test_result_fail(const char *msg, ...)
{
int saved_errno = errno;
va_list args;
@@ -195,7 +197,7 @@ static inline void ksft_test_result_fail(const char *msg, ...)
ksft_test_result_fail(fmt, ##__VA_ARGS__);\
} while (0)

-static inline void ksft_test_result_xfail(const char *msg, ...)
+static inline __printf(1, 2) void ksft_test_result_xfail(const char *msg, ...)
{
int saved_errno = errno;
va_list args;
@@ -209,7 +211,7 @@ static inline void ksft_test_result_xfail(const char *msg, ...)
va_end(args);
}

-static inline void ksft_test_result_skip(const char *msg, ...)
+static inline __printf(1, 2) void ksft_test_result_skip(const char *msg, ...)
{
int saved_errno = errno;
va_list args;
@@ -224,7 +226,7 @@ static inline void ksft_test_result_skip(const char *msg, ...)
}

/* TODO: how does "error" differ from "fail" or "skip"? */
-static inline void ksft_test_result_error(const char *msg, ...)
+static inline __printf(1, 2) void ksft_test_result_error(const char *msg, ...)
{
int saved_errno = errno;
va_list args;
@@ -271,7 +273,7 @@ static inline int ksft_exit_fail(void)
ksft_cnt.ksft_xfail + \
ksft_cnt.ksft_xskip)

-static inline int ksft_exit_fail_msg(const char *msg, ...)
+static inline __printf(1, 2) int ksft_exit_fail_msg(const char *msg, ...)
{
int saved_errno = errno;
va_list args;
@@ -298,7 +300,7 @@ static inline int ksft_exit_xpass(void)
exit(KSFT_XPASS);
}

-static inline int ksft_exit_skip(const char *msg, ...)
+static inline __printf(1, 2) int ksft_exit_skip(const char *msg, ...)
{
int saved_errno = errno;
va_list args;
--
2.42.0

2023-09-29 23:59:04

by Reinette Chatre

Subject: Re: [PATCH v3 1/8] selftests: Add printf attribute to ksefltest prints

Hi Maciej,

In subject: ksefltest -> kselftest

On 9/22/2023 2:06 AM, Maciej Wieczor-Retman wrote:
> Kselftest header defines multiple variadic functions that use printf
> along with other logic.
>
> There is no format checking for the variadic functions that use
> printing inside kselftest.h. Because of this the compiler won't
> be able to catch instances of mismatched printf formats and debugging
> tests might be more difficult.
>
> Add the common __printf attribute macro to kselftest.h.
>
> Add __printf attribute to every function using formatted printing with
> variadic arguments.
>
> Reviewed-by: Ilpo Järvinen <[email protected]>
> Signed-off-by: Maciej Wieczor-Retman <[email protected]>

With typo fixed:
Reviewed-by: Reinette Chatre <[email protected]>

Reinette