0899a6c0b7
Extended logger configuration to allow function name prefix for messages with certain severity levels. By default only debug messages are prefixed with function name. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
429 lines
14 KiB
C
429 lines
14 KiB
C
/*
|
|
* Copyright (c) 2018 Nordic Semiconductor ASA
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef ZEPHYR_INCLUDE_LOGGING_LOG_H_
|
|
#define ZEPHYR_INCLUDE_LOGGING_LOG_H_
|
|
|
|
#include <logging/log_instance.h>
|
|
#include <logging/log_core.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Logging
|
|
* @defgroup logging Logging
|
|
* @{
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @brief Logger API
|
|
* @defgroup log_api Logging API
|
|
* @ingroup logger
|
|
* @{
|
|
*/
|
|
|
|
#define LOG_LEVEL_NONE 0
|
|
#define LOG_LEVEL_ERR 1
|
|
#define LOG_LEVEL_WRN 2
|
|
#define LOG_LEVEL_INF 3
|
|
#define LOG_LEVEL_DBG 4
|
|
|
|
/**
|
|
* @brief Writes an ERROR level message to the log.
|
|
*
|
|
* @details It's meant to report severe errors, such as those from which it's
|
|
* not possible to recover.
|
|
*
|
|
* @param ... A string optionally containing printk valid conversion specifier,
|
|
* followed by as many values as specifiers.
|
|
*/
|
|
#define LOG_ERR(...) _LOG(LOG_LEVEL_ERR, __VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Writes a WARNING level message to the log.
|
|
*
|
|
* @details It's meant to register messages related to unusual situations that
|
|
* are not necessarily errors.
|
|
*
|
|
* @param ... A string optionally containing printk valid conversion specifier,
|
|
* followed by as many values as specifiers.
|
|
*/
|
|
#define LOG_WRN(...) _LOG(LOG_LEVEL_WRN, __VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Writes an INFO level message to the log.
|
|
*
|
|
* @details It's meant to write generic user oriented messages.
|
|
*
|
|
* @param ... A string optionally containing printk valid conversion specifier,
|
|
* followed by as many values as specifiers.
|
|
*/
|
|
#define LOG_INF(...) _LOG(LOG_LEVEL_INF, __VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Writes a DEBUG level message to the log.
|
|
*
|
|
* @details It's meant to write developer oriented information.
|
|
*
|
|
* @param ... A string optionally containing printk valid conversion specifier,
|
|
* followed by as many values as specifiers.
|
|
*/
|
|
#define LOG_DBG(...) _LOG(LOG_LEVEL_DBG, __VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Writes an ERROR level message associated with the instance to the log.
|
|
*
|
|
* Message is associated with specific instance of the module which has
|
|
* independent filtering settings (if runtime filtering is enabled) and
|
|
* message prefix (\<module_name\>.\<instance_name\>). It's meant to report
|
|
* severe errors, such as those from which it's not possible to recover.
|
|
*
|
|
* @param _log_inst Pointer to the log structure associated with the instance.
|
|
* @param ... A string optionally containing printk valid conversion specifier,
|
|
* followed by as many values as specifiers.
|
|
*/
|
|
#define LOG_INST_ERR(_log_inst, ...) \
|
|
_LOG_INSTANCE(LOG_LEVEL_ERR, _log_inst, __VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Writes a WARNING level message associated with the instance to the
|
|
* log.
|
|
*
|
|
* Message is associated with specific instance of the module which has
|
|
* independent filtering settings (if runtime filtering is enabled) and
|
|
* message prefix (\<module_name\>.\<instance_name\>). It's meant to register
|
|
* messages related to unusual situations that are not necessarily errors.
|
|
*
|
|
* @param _log_inst Pointer to the log structure associated with the instance.
|
|
* @param ... A string optionally containing printk valid conversion
|
|
* specifier, followed by as many values as specifiers.
|
|
*/
|
|
#define LOG_INST_WRN(_log_inst, ...) \
|
|
_LOG_INSTANCE(LOG_LEVEL_WRN, _log_inst, __VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Writes an INFO level message associated with the instance to the log.
|
|
*
|
|
* Message is associated with specific instance of the module which has
|
|
* independent filtering settings (if runtime filtering is enabled) and
|
|
* message prefix (\<module_name\>.\<instance_name\>). It's meant to write
|
|
* generic user oriented messages.
|
|
*
|
|
* @param _log_inst Pointer to the log structure associated with the instance.
|
|
* @param ... A string optionally containing printk valid conversion specifier,
|
|
* followed by as many values as specifiers.
|
|
*/
|
|
#define LOG_INST_INF(_log_inst, ...) \
|
|
_LOG_INSTANCE(LOG_LEVEL_INF, _log_inst, __VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Writes a DEBUG level message associated with the instance to the log.
|
|
*
|
|
* Message is associated with specific instance of the module which has
|
|
* independent filtering settings (if runtime filtering is enabled) and
|
|
* message prefix (\<module_name\>.\<instance_name\>). It's meant to write
|
|
* developer oriented information.
|
|
*
|
|
* @param _log_inst Pointer to the log structure associated with the instance.
|
|
* @param ... A string optionally containing printk valid conversion specifier,
|
|
* followed by as many values as specifiers.
|
|
*/
|
|
#define LOG_INST_DBG(_log_inst, ...) \
|
|
_LOG_INSTANCE(LOG_LEVEL_DBG, _log_inst, __VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Writes an ERROR level hexdump message to the log.
|
|
*
|
|
* @details It's meant to report severe errors, such as those from which it's
|
|
* not possible to recover.
|
|
*
|
|
* @param _data Pointer to the data to be logged.
|
|
* @param _length Length of data (in bytes).
|
|
* @param _str Persistent, raw string.
|
|
*/
|
|
#define LOG_HEXDUMP_ERR(_data, _length, _str) \
|
|
_LOG_HEXDUMP(LOG_LEVEL_ERR, _data, _length, _str)
|
|
|
|
/**
|
|
* @brief Writes a WARNING level message to the log.
|
|
*
|
|
* @details It's meant to register messages related to unusual situations that
|
|
* are not necessarily errors.
|
|
*
|
|
* @param _data Pointer to the data to be logged.
|
|
* @param _length Length of data (in bytes).
|
|
* @param _str Persistent, raw string.
|
|
*/
|
|
#define LOG_HEXDUMP_WRN(_data, _length, _str) \
|
|
_LOG_HEXDUMP(LOG_LEVEL_WRN, _data, _length, _str)
|
|
|
|
/**
|
|
* @brief Writes an INFO level message to the log.
|
|
*
|
|
* @details It's meant to write generic user oriented messages.
|
|
*
|
|
* @param _data Pointer to the data to be logged.
|
|
* @param _length Length of data (in bytes).
|
|
* @param _str Persistent, raw string.
|
|
*/
|
|
#define LOG_HEXDUMP_INF(_data, _length, _str) \
|
|
_LOG_HEXDUMP(LOG_LEVEL_INF, _data, _length, _str)
|
|
|
|
/**
|
|
* @brief Writes a DEBUG level message to the log.
|
|
*
|
|
* @details It's meant to write developer oriented information.
|
|
*
|
|
* @param _data Pointer to the data to be logged.
|
|
* @param _length Length of data (in bytes).
|
|
* @param _str Persistent, raw string.
|
|
*/
|
|
#define LOG_HEXDUMP_DBG(_data, _length, _str) \
|
|
_LOG_HEXDUMP(LOG_LEVEL_DBG, _data, _length, _str)
|
|
|
|
/**
|
|
* @brief Writes an ERROR hexdump message associated with the instance to the
|
|
* log.
|
|
*
|
|
* Message is associated with specific instance of the module which has
|
|
* independent filtering settings (if runtime filtering is enabled) and
|
|
* message prefix (\<module_name\>.\<instance_name\>). It's meant to report
|
|
* severe errors, such as those from which it's not possible to recover.
|
|
*
|
|
* @param _log_inst Pointer to the log structure associated with the instance.
|
|
* @param _data Pointer to the data to be logged.
|
|
* @param _length Length of data (in bytes).
|
|
* @param _str Persistent, raw string.
|
|
*/
|
|
#define LOG_INST_HEXDUMP_ERR(_log_inst, _data, _length, _str) \
|
|
_LOG_HEXDUMP_INSTANCE(LOG_LEVEL_ERR, _log_inst, _data, _length, _str)
|
|
|
|
/**
|
|
* @brief Writes a WARNING level hexdump message associated with the instance to
|
|
* the log.
|
|
*
|
|
* @details It's meant to register messages related to unusual situations that
|
|
* are not necessarily errors.
|
|
*
|
|
* @param _log_inst Pointer to the log structure associated with the instance.
|
|
* @param _data Pointer to the data to be logged.
|
|
* @param _length Length of data (in bytes).
|
|
* @param _str Persistent, raw string.
|
|
*/
|
|
#define LOG_INST_HEXDUMP_WRN(_log_inst, _data, _length, _str) \
|
|
_LOG_HEXDUMP_INSTANCE(LOG_LEVEL_WRN, _log_inst, _data, _length, _str)
|
|
|
|
/**
|
|
* @brief Writes an INFO level hexdump message associated with the instance to
|
|
* the log.
|
|
*
|
|
* @details It's meant to write generic user oriented messages.
|
|
*
|
|
* @param _log_inst Pointer to the log structure associated with the instance.
|
|
* @param _data Pointer to the data to be logged.
|
|
* @param _length Length of data (in bytes).
|
|
* @param _str Persistent, raw string.
|
|
*/
|
|
#define LOG_INST_HEXDUMP_INF(_log_inst, _data, _length, _str) \
|
|
_LOG_HEXDUMP_INSTANCE(LOG_LEVEL_INF, _log_inst, _data, _length, _str)
|
|
|
|
/**
|
|
* @brief Writes a DEBUG level hexdump message associated with the instance to
|
|
* the log.
|
|
*
|
|
* @details It's meant to write developer oriented information.
|
|
*
|
|
* @param _log_inst Pointer to the log structure associated with the instance.
|
|
* @param _data Pointer to the data to be logged.
|
|
* @param _length Length of data (in bytes).
|
|
* @param _str Persistent, raw string.
|
|
*/
|
|
#define LOG_INST_HEXDUMP_DBG(_log_inst, _data, _length, _str) \
|
|
_LOG_HEXDUMP_INSTANCE(LOG_LEVEL_DBG, _log_inst, _data, _length, _str)
|
|
|
|
/**
|
|
* @brief Writes an formatted string to the log.
|
|
*
|
|
* @details Conditionally compiled (see CONFIG_LOG_PRINTK). Function provides
|
|
* printk functionality. It is inefficient compared to standard logging
|
|
* because string formatting is performed in the call context and not deferred
|
|
* to the log processing context (@ref log_process).
|
|
*
|
|
* @param fmt Formatted string to output.
|
|
* @param ap Variable parameters.
|
|
*
|
|
* return Number of bytes written.
|
|
*/
|
|
int log_printk(const char *fmt, va_list ap);
|
|
|
|
/** @brief Copy transient string to a buffer from internal, logger pool.
|
|
*
|
|
* Function should be used when transient string is intended to be logged.
|
|
* Logger allocates a buffer and copies input string returning a pointer to the
|
|
* copy. Logger ensures that buffer is freed when logger message is freed.
|
|
*
|
|
* @param str Transient string.
|
|
*
|
|
* @return Copy of the string or default string if buffer could not be
|
|
* allocated. String may be truncated if input string does not fit in
|
|
* a buffer from the pool (see CONFIG_LOG_STRDUP_MAX_STRING).
|
|
*/
|
|
char *log_strdup(const char *str);
|
|
|
|
/* Macro expects that optionally on second argument local log level is provided.
|
|
* If provided it is returned, otherwise default log level is returned or
|
|
* LOG_LEVEL, if it was locally defined.
|
|
*/
|
|
#if !defined(CONFIG_LOG)
|
|
#define _LOG_LEVEL_RESOLVE(...) LOG_LEVEL_NONE
|
|
#else
|
|
#define _LOG_LEVEL_RESOLVE(...) \
|
|
_LOG_EVAL(LOG_LEVEL, \
|
|
(__LOG_ARG_2(__VA_ARGS__, LOG_LEVEL)), \
|
|
(__LOG_ARG_2(__VA_ARGS__, CONFIG_LOG_DEFAULT_LEVEL)))
|
|
#endif
|
|
|
|
/* Return first argument */
|
|
#define _LOG_ARG1(arg1, ...) arg1
|
|
|
|
|
|
#define _LOG_MODULE_CONST_DATA_CREATE(_name, _level) \
|
|
const struct log_source_const_data LOG_ITEM_CONST_DATA(_name) \
|
|
__attribute__ ((section("." STRINGIFY(LOG_ITEM_CONST_DATA(_name))))) \
|
|
__attribute__((used)) = { \
|
|
.name = STRINGIFY(_name), \
|
|
.level = _level \
|
|
}
|
|
|
|
#define _LOG_MODULE_DYNAMIC_DATA_CREATE(_name) \
|
|
struct log_source_dynamic_data LOG_ITEM_DYNAMIC_DATA(_name) \
|
|
__attribute__ ((section("." STRINGIFY( \
|
|
LOG_ITEM_DYNAMIC_DATA(_name)))) \
|
|
) \
|
|
__attribute__((used))
|
|
|
|
#define _LOG_MODULE_DYNAMIC_DATA_COND_CREATE(_name) \
|
|
_LOG_EVAL( \
|
|
IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING), \
|
|
(_LOG_MODULE_DYNAMIC_DATA_CREATE(_name);), \
|
|
() \
|
|
)
|
|
|
|
#define _LOG_MODULE_DATA_CREATE(_name, _level) \
|
|
_LOG_MODULE_CONST_DATA_CREATE(_name, _level); \
|
|
_LOG_MODULE_DYNAMIC_DATA_COND_CREATE(_name)
|
|
|
|
/**
|
|
* @brief Create module-specific state and register the module with Logger.
|
|
*
|
|
* This macro normally must be used after including <logging/log.h> to
|
|
* complete the initialization of the module.
|
|
*
|
|
* Module registration can be skipped in two cases:
|
|
*
|
|
* - The module consists of more than one file, and another file
|
|
* invokes this macro. (LOG_MODULE_DECLARE() should be used instead
|
|
* in all of the module's other files.)
|
|
* - Instance logging is used and there is no need to create module entry. In
|
|
* that case LOG_LEVEL_SET() should be used to set log level used within the
|
|
* file.
|
|
*
|
|
* Macro accepts one or two parameters:
|
|
* - module name
|
|
* - optional log level. If not provided then default log level is used in
|
|
* the file.
|
|
*
|
|
* Example usage:
|
|
* - LOG_MODULE_REGISTER(foo, CONFIG_FOO_LOG_LEVEL)
|
|
* - LOG_MODULE_REGISTER(foo)
|
|
*
|
|
*
|
|
* @note The module's state is defined, and the module is registered,
|
|
* only if LOG_LEVEL for the current source file is non-zero or
|
|
* it is not defined and CONFIG_LOG_DEFAULT_LOG_LEVEL is non-zero.
|
|
* In other cases, this macro has no effect.
|
|
* @see LOG_MODULE_DECLARE
|
|
*/
|
|
|
|
|
|
#define LOG_MODULE_REGISTER(...) \
|
|
_LOG_EVAL( \
|
|
_LOG_LEVEL_RESOLVE(__VA_ARGS__), \
|
|
(_LOG_MODULE_DATA_CREATE(_LOG_ARG1(__VA_ARGS__), \
|
|
_LOG_LEVEL_RESOLVE(__VA_ARGS__))),\
|
|
()/*Empty*/ \
|
|
) \
|
|
LOG_MODULE_DECLARE(__VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Macro for declaring a log module (not registering it).
|
|
*
|
|
* Modules which are split up over multiple files must have exactly
|
|
* one file use LOG_MODULE_REGISTER() to create module-specific state
|
|
* and register the module with the logger core.
|
|
*
|
|
* The other files in the module should use this macro instead to
|
|
* declare that same state. (Otherwise, LOG_INF() etc. will not be
|
|
* able to refer to module-specific state variables.)
|
|
*
|
|
* Macro accepts one or two parameters:
|
|
* - module name
|
|
* - optional log level. If not provided then default log level is used in
|
|
* the file.
|
|
*
|
|
* Example usage:
|
|
* - LOG_MODULE_DECLARE(foo, CONFIG_FOO_LOG_LEVEL)
|
|
* - LOG_MODULE_DECLARE(foo)
|
|
*
|
|
* @note The module's state is declared only if LOG_LEVEL for the
|
|
* current source file is non-zero or it is not defined and
|
|
* CONFIG_LOG_DEFAULT_LOG_LEVEL is non-zero. In other cases,
|
|
* this macro has no effect.
|
|
* @see LOG_MODULE_REGISTER
|
|
*/
|
|
#define LOG_MODULE_DECLARE(...) \
|
|
extern const struct log_source_const_data \
|
|
LOG_ITEM_CONST_DATA(_LOG_ARG1(__VA_ARGS__)); \
|
|
extern struct log_source_dynamic_data \
|
|
LOG_ITEM_DYNAMIC_DATA(_LOG_ARG1(__VA_ARGS__)); \
|
|
\
|
|
static const struct log_source_const_data * \
|
|
__log_current_const_data __attribute__((unused)) = \
|
|
_LOG_LEVEL_RESOLVE(__VA_ARGS__) ? \
|
|
&LOG_ITEM_CONST_DATA(_LOG_ARG1(__VA_ARGS__)) : NULL; \
|
|
\
|
|
static struct log_source_dynamic_data * \
|
|
__log_current_dynamic_data __attribute__((unused)) = \
|
|
(_LOG_LEVEL_RESOLVE(__VA_ARGS__) && \
|
|
IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING)) ? \
|
|
&LOG_ITEM_DYNAMIC_DATA(_LOG_ARG1(__VA_ARGS__)) : NULL;\
|
|
\
|
|
static const u32_t __log_level __attribute__((unused)) = \
|
|
_LOG_LEVEL_RESOLVE(__VA_ARGS__)
|
|
|
|
/**
|
|
* @brief Macro for setting log level in the file or function where instance
|
|
* logging API is used.
|
|
*
|
|
* @param level Level used in file or in function.
|
|
*
|
|
*/
|
|
#define LOG_LEVEL_SET(level) \
|
|
static const u32_t __log_level __attribute__((unused)) = level
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ZEPHYR_INCLUDE_LOGGING_LOG_H_ */
|