log.h File Reference

#include <zephyr/logging/log_instance.h>
#include <zephyr/logging/log_core.h>
#include <zephyr/sys/iterable_sections.h>
#include <zephyr/sys/atomic.h>
#include <zephyr/sys/util_macro.h>

Go to the source code of this file.

Macros
#define	LOG_RATELIMIT_INTERVAL_MS   0
#define	LOG_ERR(...)   Z_LOG(LOG_LEVEL_ERR, __VA_ARGS__)
	Writes an ERROR level message to the log.
#define	LOG_WRN(...)   Z_LOG(LOG_LEVEL_WRN, __VA_ARGS__)
	Writes a WARNING level message to the log.
#define	LOG_INF(...)   Z_LOG(LOG_LEVEL_INF, __VA_ARGS__)
	Writes an INFO level message to the log.
#define	LOG_DBG(...)   Z_LOG(LOG_LEVEL_DBG, __VA_ARGS__)
	Writes a DEBUG level message to the log.
#define	LOG_WRN_ONCE(...)
	Writes a WARNING level message to the log on the first execution only.
#define	LOG_WRN_RATELIMIT(...)    _LOG_RATELIMIT_LVL(LOG_LEVEL_WRN, LOG_RATELIMIT_INTERVAL_MS, __VA_ARGS__)
	Writes a WARNING level message to the log with rate limiting.
#define	LOG_ERR_RATELIMIT(...)    _LOG_RATELIMIT_LVL(LOG_LEVEL_ERR, LOG_RATELIMIT_INTERVAL_MS, __VA_ARGS__)
	Writes an ERROR level message to the log with rate limiting.
#define	LOG_INF_RATELIMIT(...)    _LOG_RATELIMIT_LVL(LOG_LEVEL_INF, LOG_RATELIMIT_INTERVAL_MS, __VA_ARGS__)
	Writes an INFO level message to the log with rate limiting.
#define	LOG_DBG_RATELIMIT(...)    _LOG_RATELIMIT_LVL(LOG_LEVEL_DBG, LOG_RATELIMIT_INTERVAL_MS, __VA_ARGS__)
	Writes a DEBUG level message to the log with rate limiting.
#define	LOG_HEXDUMP_ERR_RATELIMIT(_data, _length, _str)    _LOG_HEXDUMP_RATELIMIT_LVL(LOG_LEVEL_ERR, LOG_RATELIMIT_INTERVAL_MS, _data, _length, _str)
	Writes an ERROR level hexdump message to the log with rate limiting.
#define	LOG_HEXDUMP_WRN_RATELIMIT(_data, _length, _str)    _LOG_HEXDUMP_RATELIMIT_LVL(LOG_LEVEL_WRN, LOG_RATELIMIT_INTERVAL_MS, _data, _length, _str)
	Writes a WARNING level hexdump message to the log with rate limiting.
#define	LOG_HEXDUMP_INF_RATELIMIT(_data, _length, _str)    _LOG_HEXDUMP_RATELIMIT_LVL(LOG_LEVEL_INF, LOG_RATELIMIT_INTERVAL_MS, _data, _length, _str)
	Writes an INFO level hexdump message to the log with rate limiting.
#define	LOG_HEXDUMP_DBG_RATELIMIT(_data, _length, _str)    _LOG_HEXDUMP_RATELIMIT_LVL(LOG_LEVEL_DBG, LOG_RATELIMIT_INTERVAL_MS, _data, _length, _str)
	Writes a DEBUG level hexdump message to the log with rate limiting.
#define	LOG_ERR_RATELIMIT_RATE(_rate_ms, ...)    _LOG_RATELIMIT_LVL(LOG_LEVEL_ERR, _rate_ms, __VA_ARGS__)
	Rate-limited logging macros with custom rate.
#define	LOG_WRN_RATELIMIT_RATE(_rate_ms, ...)    _LOG_RATELIMIT_LVL(LOG_LEVEL_WRN, _rate_ms, __VA_ARGS__)
	Writes a WARNING level message to the log with custom rate limiting.
#define	LOG_INF_RATELIMIT_RATE(_rate_ms, ...)    _LOG_RATELIMIT_LVL(LOG_LEVEL_INF, _rate_ms, __VA_ARGS__)
	Writes an INFO level message to the log with custom rate limiting.
#define	LOG_DBG_RATELIMIT_RATE(_rate_ms, ...)    _LOG_RATELIMIT_LVL(LOG_LEVEL_DBG, _rate_ms, __VA_ARGS__)
	Writes a DEBUG level message to the log with custom rate limiting.
#define	LOG_HEXDUMP_ERR_RATELIMIT_RATE(_rate_ms, _data, _length, _str)    _LOG_HEXDUMP_RATELIMIT_LVL(LOG_LEVEL_ERR, _rate_ms, _data, _length, _str)
	Writes an ERROR level hexdump message to the log with custom rate limiting.
#define	LOG_HEXDUMP_WRN_RATELIMIT_RATE(_rate_ms, _data, _length, _str)    _LOG_HEXDUMP_RATELIMIT_LVL(LOG_LEVEL_WRN, _rate_ms, _data, _length, _str)
	Writes a WARNING level hexdump message to the log with custom rate limiting.
#define	LOG_HEXDUMP_INF_RATELIMIT_RATE(_rate_ms, _data, _length, _str)    _LOG_HEXDUMP_RATELIMIT_LVL(LOG_LEVEL_INF, _rate_ms, _data, _length, _str)
	Writes an INFO level hexdump message to the log with custom rate limiting.
#define	LOG_HEXDUMP_DBG_RATELIMIT_RATE(_rate_ms, _data, _length, _str)    _LOG_HEXDUMP_RATELIMIT_LVL(LOG_LEVEL_DBG, _rate_ms, _data, _length, _str)
	Writes a DEBUG level hexdump message to the log with custom rate limiting.
#define	LOG_PRINTK(...)   Z_LOG_PRINTK(0, __VA_ARGS__)
	Unconditionally print raw log message.
#define	LOG_RAW(...)   Z_LOG_PRINTK(1, __VA_ARGS__)
	Unconditionally print raw log message.
#define	LOG_INST_ERR(_log_inst, ...)   Z_LOG_INSTANCE(LOG_LEVEL_ERR, _log_inst, __VA_ARGS__)
	Writes an ERROR level message associated with the instance to the log.
#define	LOG_INST_WRN(_log_inst, ...)   Z_LOG_INSTANCE(LOG_LEVEL_WRN, _log_inst, __VA_ARGS__)
	Writes a WARNING level message associated with the instance to the log.
#define	LOG_INST_INF(_log_inst, ...)   Z_LOG_INSTANCE(LOG_LEVEL_INF, _log_inst, __VA_ARGS__)
	Writes an INFO level message associated with the instance to the log.
#define	LOG_INST_DBG(_log_inst, ...)   Z_LOG_INSTANCE(LOG_LEVEL_DBG, _log_inst, __VA_ARGS__)
	Writes a DEBUG level message associated with the instance to the log.
#define	LOG_HEXDUMP_ERR(_data, _length, _str)   Z_LOG_HEXDUMP(LOG_LEVEL_ERR, _data, _length, (_str))
	Writes an ERROR level hexdump message to the log.
#define	LOG_HEXDUMP_WRN(_data, _length, _str)   Z_LOG_HEXDUMP(LOG_LEVEL_WRN, _data, _length, (_str))
	Writes a WARNING level message to the log.
#define	LOG_HEXDUMP_INF(_data, _length, _str)   Z_LOG_HEXDUMP(LOG_LEVEL_INF, _data, _length, (_str))
	Writes an INFO level message to the log.
#define	LOG_HEXDUMP_DBG(_data, _length, _str)   Z_LOG_HEXDUMP(LOG_LEVEL_DBG, _data, _length, (_str))
	Writes a DEBUG level message to the log.
#define	LOG_INST_HEXDUMP_ERR(_log_inst, _data, _length, _str)    Z_LOG_HEXDUMP_INSTANCE(LOG_LEVEL_ERR, _log_inst, _data, _length, _str)
	Writes an ERROR hexdump message associated with the instance to the log.
#define	LOG_INST_HEXDUMP_WRN(_log_inst, _data, _length, _str)    Z_LOG_HEXDUMP_INSTANCE(LOG_LEVEL_WRN, _log_inst, _data, _length, _str)
	Writes a WARNING level hexdump message associated with the instance to the log.
#define	LOG_INST_HEXDUMP_INF(_log_inst, _data, _length, _str)    Z_LOG_HEXDUMP_INSTANCE(LOG_LEVEL_INF, _log_inst, _data, _length, _str)
	Writes an INFO level hexdump message associated with the instance to the log.
#define	LOG_INST_HEXDUMP_DBG(_log_inst, _data, _length, _str)    Z_LOG_HEXDUMP_INSTANCE(LOG_LEVEL_DBG, _log_inst, _data, _length, _str)
	Writes a DEBUG level hexdump message associated with the instance to the log.
#define	LOG_MODULE_REGISTER(...)
	Create module-specific state and register the module with Logger.
#define	LOG_MODULE_DECLARE(...)
	Macro for declaring a log module (not registering it).
#define	LOG_LEVEL_SET(level)    static const uint32_t __log_level __unused = Z_LOG_RESOLVED_LEVEL(level, 0)
	Macro for setting log level in the file or function where instance logging API is used.

Macro Definition Documentation

LOG_RATELIMIT_INTERVAL_MS

#define LOG_RATELIMIT_INTERVAL_MS   0