From b9ce5cf9caf52503394ad5eac7a3dee2eee1a296 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Tue, 10 May 2022 14:11:55 +0200 Subject: [PATCH] Optionally call printf on LOG_MESSAGE() arguments MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit With an intentional mistake: ../src/login/logind-dbus.c: In function ‘bus_manager_log_shutdown’: ../src/login/logind-dbus.c:1542:39: error: format ‘%s’ expects a matching ‘char *’ argument [-Werror=format=] 1542 | LOG_MESSAGE("%s %s", message), | ^~~~~~~ --- meson.build | 1 + meson_options.txt | 2 ++ src/basic/log.h | 8 +++++++- src/core/unit.h | 3 ++- 4 files changed, 12 insertions(+), 2 deletions(-) diff --git a/meson.build b/meson.build index 051eea9aac..46f062d530 100644 --- a/meson.build +++ b/meson.build @@ -33,6 +33,7 @@ conf.set_quoted('RELATIVE_SOURCE_PATH', relative_source_path) conf.set10('BUILD_MODE_DEVELOPER', get_option('mode') == 'developer', description : 'tailor build to development or release builds') +conf.set10('LOG_MESSAGE_VERIFICATION', get_option('log-message-verification')) want_ossfuzz = get_option('oss-fuzz') want_libfuzzer = get_option('llvm-fuzz') diff --git a/meson_options.txt b/meson_options.txt index 2a030ac28e..ff59120f77 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -470,6 +470,8 @@ option('fuzz-tests', type : 'boolean', value : 'false', description : 'run the fuzzer regression tests by default (with sanitizers)') option('install-tests', type : 'boolean', value : 'false', description : 'install test executables') +option('log-message-verification', type : 'boolean', value : 'false', + description : 'do fake printf() calls to verify format strings') option('ok-color', type : 'combo', choices : ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', diff --git a/src/basic/log.h b/src/basic/log.h index 6f0d838de3..b03ca3ef21 100644 --- a/src/basic/log.h +++ b/src/basic/log.h @@ -300,7 +300,13 @@ bool log_on_console(void) _pure_; /* Helper to wrap the main message in structured logging. The macro doesn't do much, * except to provide visual grouping of the format string and its arguments. */ -#define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__ +#if LOG_MESSAGE_VERIFICATION +/* Do a fake formatting of the message string to let the scanner verify the arguments + * against the format message. */ +# define LOG_MESSAGE(fmt, ...) "MESSAGE=%.0d" fmt, printf(fmt, ##__VA_ARGS__), ##__VA_ARGS__ +#else +# define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__ +#endif void log_received_signal(int level, const struct signalfd_siginfo *si); diff --git a/src/core/unit.h b/src/core/unit.h index 733eeecd7f..20c511c108 100644 --- a/src/core/unit.h +++ b/src/core/unit.h @@ -1046,7 +1046,8 @@ Condition *unit_find_failed_condition(Unit *u); #define log_unit_struct_iovec(unit, level, iovec, n_iovec) log_unit_struct_iovec_errno(unit, level, 0, iovec, n_iovec) -#define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__ +/* Like LOG_MESSAGE(), but with the unit name prefixed. */ +#define LOG_UNIT_MESSAGE(unit, fmt, ...) LOG_MESSAGE("%s: " fmt, (unit)->id, ##__VA_ARGS__) #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string