From 9ddc45884daf87dd4672f48c5d4a7274580ef355 Mon Sep 17 00:00:00 2001
From: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
Date: Fri, 19 Nov 2021 07:02:28 +0100
Subject: [PATCH] logging: Improve instance logging filtering

Instance logging allows to set independent severity level for
each instance (static and runtime). However, so far when runtime
filtering was disabled, static level was not taken into account
and instance messages were only compile time filtered based on
module level.

Improved logging macros to use static instance level to determine
if message shall be created. It enables instance filtering also
when runtime filtering is disabled.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
---
 include/logging/log_core.h | 64 ++++++++++++++++++++++++++++++++++----
 1 file changed, 58 insertions(+), 6 deletions(-)

diff --git a/include/logging/log_core.h b/include/logging/log_core.h
index fb09080ecfa..89a9838d6cf 100644
--- a/include/logging/log_core.h
+++ b/include/logging/log_core.h
@@ -298,7 +298,25 @@ static inline char z_log_minimal_level_to_char(int level)
 /*****************************************************************************/
 /****************** Macros for standard logging ******************************/
 /*****************************************************************************/
-#define Z_LOG2(_level, _source, _dsource, ...) do { \
+/** @internal
+ * @brief Generic logging macro.
+ *
+ * It checks against static levels (resolved at compile timer), runtime levels
+ * and modes and dispatch to relevant processing path.
+ *
+ * @param _level Log message severity level.
+ *
+ * @param _inst Set to 1 for instance specific log message. 0 otherwise.
+ *
+ * @param _source Pointer to static source descriptor object. NULL when runtime filtering
+ * is enabled.
+ *
+ * @param _dsource Pointer to dynamic source descriptor. NULL when runtime filtering
+ * is disabled.
+ *
+ * @param ... String with arguments.
+ */
+#define Z_LOG2(_level, _inst, _source, _dsource, ...) do { \
 	if (!Z_LOG_CONST_LEVEL_CHECK(_level)) { \
 		break; \
 	} \
@@ -306,6 +324,12 @@ static inline char z_log_minimal_level_to_char(int level)
 		Z_LOG_TO_PRINTK(_level, __VA_ARGS__); \
 		break; \
 	} \
+	/* For instance logging check instance specific static level */ \
+	if (_inst & !IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING)) { \
+		if (_level > ((struct log_source_const_data *)_source)->level) { \
+			break; \
+		} \
+	} \
 	\
 	bool is_user_context = k_is_user_context(); \
 	uint32_t filters = IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) ? \
@@ -334,10 +358,10 @@ static inline char z_log_minimal_level_to_char(int level)
 } while (false)
 
 #define Z_LOG(_level, ...) \
-	Z_LOG2(_level, __log_current_const_data, __log_current_dynamic_data, __VA_ARGS__)
+	Z_LOG2(_level, 0, __log_current_const_data, __log_current_dynamic_data, __VA_ARGS__)
 
 #define Z_LOG_INSTANCE(_level, _inst, ...) \
-	Z_LOG2(_level, \
+	Z_LOG2(_level, 1, \
 		COND_CODE_1(CONFIG_LOG_RUNTIME_FILTERING, (NULL), (Z_LOG_INST(_inst))), \
 		(struct log_source_dynamic_data *)COND_CODE_1( \
 						CONFIG_LOG_RUNTIME_FILTERING, \
@@ -347,11 +371,39 @@ static inline char z_log_minimal_level_to_char(int level)
 /*****************************************************************************/
 /****************** Macros for hexdump logging *******************************/
 /*****************************************************************************/
-#define Z_LOG_HEXDUMP2(_level, _source, _dsource, _data, _len, ...) do { \
+/** @internal
+ * @brief Generic logging macro.
+ *
+ * It checks against static levels (resolved at compile timer), runtime levels
+ * and modes and dispatch to relevant processing path.
+ *
+ * @param _level Log message severity level.
+ *
+ * @param _inst Set to 1 for instance specific log message. 0 otherwise.
+ *
+ * @param _source Pointer to static source descriptor object. NULL when runtime filtering
+ * is enabled.
+ *
+ * @param _dsource Pointer to dynamic source descriptor. NULL when runtime filtering
+ * is disabled.
+ *
+ * @param _data Hexdump data;
+ *
+ * @param _len Hexdump data length.
+ *
+ * @param ... String.
+ */
+#define Z_LOG_HEXDUMP2(_level, _inst, _source, _dsource, _data, _len, ...) do { \
 	const char *_str = GET_ARG_N(1, __VA_ARGS__); \
 	if (!Z_LOG_CONST_LEVEL_CHECK(_level)) {	\
 		break; \
 	} \
+	/* For instance logging check instance specific static level */ \
+	if (_inst & !IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING)) { \
+		if (_level > ((struct log_source_const_data *)_source)->level) { \
+			break; \
+		} \
+	} \
 	bool is_user_context = k_is_user_context(); \
 	uint32_t filters = IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) ? \
 						(_dsource)->filters : 0;\
@@ -398,13 +450,13 @@ static inline char z_log_minimal_level_to_char(int level)
 } while (false)
 
 #define Z_LOG_HEXDUMP(_level, _data, _length, ...) \
-	Z_LOG_HEXDUMP2(_level, \
+	Z_LOG_HEXDUMP2(_level, 0, \
 		      __log_current_const_data, \
 		      __log_current_dynamic_data, \
 		      _data, _length, __VA_ARGS__)
 
 #define Z_LOG_HEXDUMP_INSTANCE(_level, _inst, _data, _length, _str) \
-	Z_LOG_HEXDUMP2(_level, \
+	Z_LOG_HEXDUMP2(_level, 1, \
 		COND_CODE_1(CONFIG_LOG_RUNTIME_FILTERING, (NULL), (Z_LOG_INST(_inst))), \
 		(struct log_source_dynamic_data *)COND_CODE_1( \
 						CONFIG_LOG_RUNTIME_FILTERING, \