patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

logging: Refactoring macro to avoid Coverity issue

Browse source 
Change a runtime log check such that Coverity does not report a
needless issue on every use of any log macro.

Before the change, this was used in log macros:

    else if(is_user_context || (_level <= LOG_RUNTIME_FILTER(_filter)))

If runtime filtering is not enabled, this expands to:

    else if(is_user_context || 1)

Because the level is compared to log level debug (4) and will always be,
equal or lower.
Coverity always reports this as a potential issue, since the
variable part (is_user_context) makes no difference.

After the change, a macro is used which expands into the original code
when runtime filtering is used, else it simply expands to:

    else if(true)

Which has equal semantics as the previous code but isn't flagged by
Coverity.

Signed-off-by: Torstein Grindvik <torstein.grindvik@nordicsemi.no>
This commit is contained in:
Torstein Grindvik 2020-09-30 13:46:57 +02:00 committed by Andrew Boie
parent 39696e3c1b
commit 84cdc6fd92
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
include/logging/log_core.h
View file

@ -264,8 +264,8 @@ static inline char z_log_minimal_level_to_char(int level)
\
if (IS_ENABLED(CONFIG_LOG_MINIMAL)) { \
Z_LOG_TO_PRINTK(_level, __VA_ARGS__); \
} else if (is_user_context || \
(_level <= LOG_RUNTIME_FILTER(_filter))) { \
} else if (LOG_CHECK_CTX_LVL_FILTER(is_user_context, \
_level, _filter)) { \
struct log_msg_ids src_level = { \
.level = _level, \
.domain_id = CONFIG_LOG_DOMAIN_ID, \
@ -320,8 +320,8 @@ static inline char z_log_minimal_level_to_char(int level)
log_minimal_hexdump_print(_level, \
(const char *)_data, \
_length); \
} else if (is_user_context || \
(_level <= LOG_RUNTIME_FILTER(_filter))) { \
} else if (LOG_CHECK_CTX_LVL_FILTER(is_user_context,\
_level, _filter)) { \
struct log_msg_ids src_level = { \
.level = _level, \
.domain_id = CONFIG_LOG_DOMAIN_ID, \
@ -402,9 +402,12 @@ static inline char z_log_minimal_level_to_char(int level)
#define LOG_FILTER_FIRST_BACKEND_SLOT_IDX 1
#ifdef CONFIG_LOG_RUNTIME_FILTERING
#define LOG_CHECK_CTX_LVL_FILTER(ctx, _level, _filter) \
(ctx || (_level <= LOG_RUNTIME_FILTER(_filter)))
#define LOG_RUNTIME_FILTER(_filter) \
LOG_FILTER_SLOT_GET(&(_filter)->filters, LOG_FILTER_AGGR_SLOT_IDX)
#else
#define LOG_CHECK_CTX_LVL_FILTER(ctx, _level, _filter) (true)
#define LOG_RUNTIME_FILTER(_filter) LOG_LEVEL_DBG
#endif
@ -724,8 +727,8 @@ __syscall void z_log_hexdump_from_user(uint32_t src_level_val,
} else { \
vprintk(_str, _valist); \
} \
} else if (is_user_context || \
(_level <= LOG_RUNTIME_FILTER(_filter))) { \
} else if (LOG_CHECK_CTX_LVL_FILTER(is_user_context, \
_level, _filter)) { \
struct log_msg_ids src_level = { \
.level = _level, \
.domain_id = CONFIG_LOG_DOMAIN_ID, \