Zephyr API Documentation  3.5.0
A Scalable Open Source RTOS
3.5.0
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
log_core.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6#ifndef ZEPHYR_INCLUDE_LOGGING_LOG_CORE_H_
7#define ZEPHYR_INCLUDE_LOGGING_LOG_CORE_H_
8
9#include <zephyr/logging/log_msg.h>
10#include <zephyr/logging/log_instance.h>
11#include <stdbool.h>
12#include <stdint.h>
13#include <stdarg.h>
14#include <zephyr/sys/util.h>
15
16/* This header file keeps all macros and functions needed for creating logging
17 * messages (macros like @ref LOG_ERR).
18 */
19#define LOG_LEVEL_NONE 0U
20#define LOG_LEVEL_ERR 1U
21#define LOG_LEVEL_WRN 2U
22#define LOG_LEVEL_INF 3U
23#define LOG_LEVEL_DBG 4U
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29#ifndef CONFIG_LOG
30#define CONFIG_LOG_DEFAULT_LEVEL 0U
31#define CONFIG_LOG_MAX_LEVEL 0U
32#endif
33
34/* Id of local domain. */
35#define Z_LOG_LOCAL_DOMAIN_ID 0
36
37#define LOG_FUNCTION_PREFIX_MASK \
38 (((uint32_t)IS_ENABLED(CONFIG_LOG_FUNC_NAME_PREFIX_ERR) << \
39 LOG_LEVEL_ERR) | \
40 ((uint32_t)IS_ENABLED(CONFIG_LOG_FUNC_NAME_PREFIX_WRN) << \
41 LOG_LEVEL_WRN) | \
42 ((uint32_t)IS_ENABLED(CONFIG_LOG_FUNC_NAME_PREFIX_INF) << \
43 LOG_LEVEL_INF) | \
44 ((uint32_t)IS_ENABLED(CONFIG_LOG_FUNC_NAME_PREFIX_DBG) << LOG_LEVEL_DBG))
45
50#define Z_LOG_RESOLVED_LEVEL(_level, _default) \
51 Z_LOG_RESOLVED_LEVEL1(_level, _default)
52
53#define Z_LOG_RESOLVED_LEVEL1(_level, _default) \
54 __COND_CODE(_LOG_XXXX##_level, (_level), (_default))
55
56#define _LOG_XXXX0 _LOG_YYYY,
57#define _LOG_XXXX0U _LOG_YYYY,
58#define _LOG_XXXX1 _LOG_YYYY,
59#define _LOG_XXXX1U _LOG_YYYY,
60#define _LOG_XXXX2 _LOG_YYYY,
61#define _LOG_XXXX2U _LOG_YYYY,
62#define _LOG_XXXX3 _LOG_YYYY,
63#define _LOG_XXXX3U _LOG_YYYY,
64#define _LOG_XXXX4 _LOG_YYYY,
65#define _LOG_XXXX4U _LOG_YYYY,
66
81#define Z_LOG_EVAL(_eval_level, _iftrue, _iffalse) \
82 Z_LOG_EVAL1(_eval_level, _iftrue, _iffalse)
83
84#define Z_LOG_EVAL1(_eval_level, _iftrue, _iffalse) \
85 __COND_CODE(_LOG_ZZZZ##_eval_level, _iftrue, _iffalse)
86
87#define _LOG_ZZZZ1 _LOG_YYYY,
88#define _LOG_ZZZZ1U _LOG_YYYY,
89#define _LOG_ZZZZ2 _LOG_YYYY,
90#define _LOG_ZZZZ2U _LOG_YYYY,
91#define _LOG_ZZZZ3 _LOG_YYYY,
92#define _LOG_ZZZZ3U _LOG_YYYY,
93#define _LOG_ZZZZ4 _LOG_YYYY,
94#define _LOG_ZZZZ4U _LOG_YYYY,
95
100#define LOG_CURRENT_MODULE_ID() (__log_level != 0 ? \
101 log_const_source_id(__log_current_const_data) : 0U)
102
103/* Set of defines that are set to 1 if function name prefix is enabled for given level. */
104#define Z_LOG_FUNC_PREFIX_0U 0
105#define Z_LOG_FUNC_PREFIX_1U COND_CODE_1(CONFIG_LOG_FUNC_NAME_PREFIX_ERR, (1), (0))
106#define Z_LOG_FUNC_PREFIX_2U COND_CODE_1(CONFIG_LOG_FUNC_NAME_PREFIX_WRN, (1), (0))
107#define Z_LOG_FUNC_PREFIX_3U COND_CODE_1(CONFIG_LOG_FUNC_NAME_PREFIX_INF, (1), (0))
108#define Z_LOG_FUNC_PREFIX_4U COND_CODE_1(CONFIG_LOG_FUNC_NAME_PREFIX_DBG, (1), (0))
109
119#define Z_LOG_STR_WITH_PREFIX2(...) \
120 "%s: " GET_ARG_N(1, __VA_ARGS__), (const char *)__func__\
121 COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__),\
122 (),\
123 (, GET_ARGS_LESS_N(1, __VA_ARGS__))\
124 )
125
126/* Macro handles case when no format string is provided: e.g. LOG_DBG().
127 * Handling of format string is deferred to the next level macro.
128 */
129#define Z_LOG_STR_WITH_PREFIX(...) \
130 COND_CODE_0(NUM_VA_ARGS_LESS_1(_, ##__VA_ARGS__), \
131 ("%s", (const char *)__func__), \
132 (Z_LOG_STR_WITH_PREFIX2(__VA_ARGS__)))
133
139#define Z_LOG_STR(_level, ...) \
140 COND_CODE_1(UTIL_CAT(Z_LOG_FUNC_PREFIX_##_level), \
141 (Z_LOG_STR_WITH_PREFIX(__VA_ARGS__)), (__VA_ARGS__))
142
143#define Z_LOG_LEVEL_CHECK(_level, _check_level, _default_level) \
144 (_level <= Z_LOG_RESOLVED_LEVEL(_check_level, _default_level))
145
146#define Z_LOG_CONST_LEVEL_CHECK(_level) \
147 (IS_ENABLED(CONFIG_LOG) && \
148 (Z_LOG_LEVEL_CHECK(_level, CONFIG_LOG_OVERRIDE_LEVEL, LOG_LEVEL_NONE) \
149 || \
150 ((IS_ENABLED(CONFIG_LOG_OVERRIDE_LEVEL) == false) && \
151 (_level <= __log_level) && \
152 (_level <= CONFIG_LOG_MAX_LEVEL) \
153 ) \
154 ))
155
156/*****************************************************************************/
157/****************** Definitions used by minimal logging *********************/
158/*****************************************************************************/
159void z_log_minimal_hexdump_print(int level, const void *data, size_t size);
160void z_log_minimal_vprintk(const char *fmt, va_list ap);
161void z_log_minimal_printk(const char *fmt, ...);
162
163#define Z_LOG_TO_PRINTK(_level, fmt, ...) do { \
164 z_log_minimal_printk("%c: " fmt "\n", \
165 z_log_minimal_level_to_char(_level), \
166 ##__VA_ARGS__); \
167} while (false)
168
169#define Z_LOG_TO_VPRINTK(_level, fmt, valist) do { \
170 z_log_minimal_printk("%c: ", z_log_minimal_level_to_char(_level)); \
171 z_log_minimal_vprintk(fmt, valist); \
172 z_log_minimal_printk("\n"); \
173} while (false)
174
175static inline char z_log_minimal_level_to_char(int level)
176{
177 switch (level) {
178 case LOG_LEVEL_ERR:
179 return 'E';
180 case LOG_LEVEL_WRN:
181 return 'W';
182 case LOG_LEVEL_INF:
183 return 'I';
184 case LOG_LEVEL_DBG:
185 return 'D';
186 default:
187 return '?';
188 }
189}
190
191#define Z_LOG_INST(_inst) COND_CODE_1(CONFIG_LOG, (_inst), NULL)
192
193/*****************************************************************************/
194/****************** Macros for standard logging ******************************/
195/*****************************************************************************/
214#define Z_LOG2(_level, _inst, _source, _dsource, ...) do { \
215 if (!Z_LOG_CONST_LEVEL_CHECK(_level)) { \
216 break; \
217 } \
218 if (IS_ENABLED(CONFIG_LOG_MODE_MINIMAL)) { \
219 Z_LOG_TO_PRINTK(_level, __VA_ARGS__); \
220 break; \
221 } \
222 /* For instance logging check instance specific static level */ \
223 if (_inst != 0 && !IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING)) { \
224 if (_level > ((struct log_source_const_data *)_source)->level) { \
225 break; \
226 } \
227 } \
228 \
229 bool is_user_context = k_is_user_context(); \
230 if (!IS_ENABLED(CONFIG_LOG_FRONTEND) && IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) && \
231 !is_user_context && _level > Z_LOG_RUNTIME_FILTER((_dsource)->filters)) { \
232 break; \
233 } \
234 int _mode; \
235 void *_src = IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) ? \
236 (void *)_dsource : (void *)_source; \
237 Z_LOG_MSG_CREATE(UTIL_NOT(IS_ENABLED(CONFIG_USERSPACE)), _mode, \
238 Z_LOG_LOCAL_DOMAIN_ID, _src, _level, NULL,\
239 0, __VA_ARGS__); \
240 (void)_mode; \
241 if (false) { \
242 /* Arguments checker present but never evaluated.*/ \
243 /* Placed here to ensure that __VA_ARGS__ are*/ \
244 /* evaluated once when log is enabled.*/ \
245 z_log_printf_arg_checker(__VA_ARGS__); \
246 } \
247} while (false)
248
249#define Z_LOG(_level, ...) \
250 Z_LOG2(_level, 0, __log_current_const_data, __log_current_dynamic_data, __VA_ARGS__)
251
252#define Z_LOG_INSTANCE(_level, _inst, ...) do { \
253 (void)_inst; \
254 Z_LOG2(_level, 1, \
255 COND_CODE_1(CONFIG_LOG_RUNTIME_FILTERING, (NULL), (Z_LOG_INST(_inst))), \
256 (struct log_source_dynamic_data *)COND_CODE_1( \
257 CONFIG_LOG_RUNTIME_FILTERING, \
258 (Z_LOG_INST(_inst)), (NULL)), \
259 __VA_ARGS__); \
260} while (0)
261
262/*****************************************************************************/
263/****************** Macros for hexdump logging *******************************/
264/*****************************************************************************/
287#define Z_LOG_HEXDUMP2(_level, _inst, _source, _dsource, _data, _len, ...) do { \
288 const char *_str = GET_ARG_N(1, __VA_ARGS__); \
289 if (!Z_LOG_CONST_LEVEL_CHECK(_level)) { \
290 break; \
291 } \
292 /* For instance logging check instance specific static level */ \
293 if (_inst & !IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING)) { \
294 if (_level > ((struct log_source_const_data *)_source)->level) { \
295 break; \
296 } \
297 } \
298 bool is_user_context = k_is_user_context(); \
299 uint32_t filters = IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) ? \
300 (_dsource)->filters : 0;\
301 \
302 if (IS_ENABLED(CONFIG_LOG_MODE_MINIMAL)) { \
303 Z_LOG_TO_PRINTK(_level, "%s", _str); \
304 z_log_minimal_hexdump_print(_level, \
305 (const char *)_data, _len);\
306 break; \
307 } \
308 if (!IS_ENABLED(CONFIG_LOG_FRONTEND) && IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) && \
309 !is_user_context && _level > Z_LOG_RUNTIME_FILTER(filters)) { \
310 break; \
311 } \
312 int mode; \
313 void *_src = IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) ? \
314 (void *)_dsource : (void *)_source; \
315 Z_LOG_MSG_CREATE(UTIL_NOT(IS_ENABLED(CONFIG_USERSPACE)), mode, \
316 Z_LOG_LOCAL_DOMAIN_ID, _src, _level, \
317 _data, _len, \
318 COND_CODE_0(NUM_VA_ARGS_LESS_1(_, ##__VA_ARGS__), \
319 (), \
320 (COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__), \
321 ("%s", __VA_ARGS__), (__VA_ARGS__)))));\
322} while (false)
323
324#define Z_LOG_HEXDUMP(_level, _data, _length, ...) \
325 Z_LOG_HEXDUMP2(_level, 0, \
326 __log_current_const_data, \
327 __log_current_dynamic_data, \
328 _data, _length, __VA_ARGS__)
329
330#define Z_LOG_HEXDUMP_INSTANCE(_level, _inst, _data, _length, _str) \
331 Z_LOG_HEXDUMP2(_level, 1, \
332 COND_CODE_1(CONFIG_LOG_RUNTIME_FILTERING, (NULL), (Z_LOG_INST(_inst))), \
333 (struct log_source_dynamic_data *)COND_CODE_1( \
334 CONFIG_LOG_RUNTIME_FILTERING, \
335 (Z_LOG_INST(_inst)), (NULL)), \
336 _data, _length, _str)
337
338/*****************************************************************************/
339/****************** Filtering macros *****************************************/
340/*****************************************************************************/
341
343#define LOG_LEVEL_BITS 3U
344
346#define LOG_FILTER_SLOT_SIZE LOG_LEVEL_BITS
347
349#define LOG_FILTERS_NUM_OF_SLOTS (32 / LOG_FILTER_SLOT_SIZE)
350
352#define LOG_FILTER_SLOT_MASK (BIT(LOG_FILTER_SLOT_SIZE) - 1U)
353
358#define LOG_FILTER_SLOT_SHIFT(_id) (LOG_FILTER_SLOT_SIZE * (_id))
359
360#define LOG_FILTER_SLOT_GET(_filters, _id) \
361 ((*(_filters) >> LOG_FILTER_SLOT_SHIFT(_id)) & LOG_FILTER_SLOT_MASK)
362
363#define LOG_FILTER_SLOT_SET(_filters, _id, _filter) \
364 do { \
365 *(_filters) &= ~(LOG_FILTER_SLOT_MASK << \
366 LOG_FILTER_SLOT_SHIFT(_id)); \
367 *(_filters) |= ((_filter) & LOG_FILTER_SLOT_MASK) << \
368 LOG_FILTER_SLOT_SHIFT(_id); \
369 } while (false)
370
371#define LOG_FILTER_AGGR_SLOT_IDX 0
372
373#define LOG_FILTER_AGGR_SLOT_GET(_filters) \
374 LOG_FILTER_SLOT_GET(_filters, LOG_FILTER_AGGR_SLOT_IDX)
375
376#define LOG_FILTER_FIRST_BACKEND_SLOT_IDX 1
377
378/* Return aggregated (highest) level for all enabled backends, e.g. if there
379 * are 3 active backends, one backend is set to get INF logs from a module and
380 * two other backends are set for ERR, returned level is INF.
381 */
382#define Z_LOG_RUNTIME_FILTER(_filter) \
383 LOG_FILTER_SLOT_GET(&_filter, LOG_FILTER_AGGR_SLOT_IDX)
384
388#define LOG_LEVEL_INTERNAL_RAW_STRING LOG_LEVEL_NONE
389
390TYPE_SECTION_START_EXTERN(struct log_source_const_data, log_const);
391TYPE_SECTION_END_EXTERN(struct log_source_const_data, log_const);
392
403#define Z_LOG_PRINTK(_is_raw, ...) do { \
404 if (!IS_ENABLED(CONFIG_LOG)) { \
405 break; \
406 } \
407 if (IS_ENABLED(CONFIG_LOG_MODE_MINIMAL)) { \
408 z_log_minimal_printk(__VA_ARGS__); \
409 break; \
410 } \
411 int _mode; \
412 if (0) {\
413 z_log_printf_arg_checker(__VA_ARGS__); \
414 } \
415 Z_LOG_MSG_CREATE(!IS_ENABLED(CONFIG_USERSPACE), _mode, \
416 Z_LOG_LOCAL_DOMAIN_ID, (uintptr_t)_is_raw, \
417 LOG_LEVEL_INTERNAL_RAW_STRING, NULL, 0, __VA_ARGS__);\
418} while (0)
419
427static inline uint32_t log_const_source_id(
428 const struct log_source_const_data *data)
429{
430 return ((const uint8_t *)data - (uint8_t *)TYPE_SECTION_START(log_const))/
431 sizeof(struct log_source_const_data);
432}
433
434TYPE_SECTION_START_EXTERN(struct log_source_dynamic_data, log_dynamic);
435TYPE_SECTION_END_EXTERN(struct log_source_dynamic_data, log_dynamic);
436
441#define LOG_ITEM_DYNAMIC_DATA(_name) UTIL_CAT(log_dynamic_, _name)
442
443#define LOG_INSTANCE_DYNAMIC_DATA(_module_name, _inst) \
444 LOG_ITEM_DYNAMIC_DATA(Z_LOG_INSTANCE_FULL_NAME(_module_name, _inst))
445
453static inline uint32_t log_dynamic_source_id(struct log_source_dynamic_data *data)
454{
455 return ((uint8_t *)data - (uint8_t *)TYPE_SECTION_START(log_dynamic))/
456 sizeof(struct log_source_dynamic_data);
457}
458
460static inline __printf_like(1, 2)
461void z_log_printf_arg_checker(const char *fmt, ...)
462{
463 ARG_UNUSED(fmt);
464}
465
475static inline void log2_generic(uint8_t level, const char *fmt, va_list ap)
476{
477 z_log_msg_runtime_vcreate(Z_LOG_LOCAL_DOMAIN_ID, NULL, level,
478 NULL, 0, 0, fmt, ap);
479}
480
481#ifdef __cplusplus
482}
483#endif
484
485#endif /* ZEPHYR_INCLUDE_LOGGING_LOG_CORE_H_ */
TYPE_SECTION_START_EXTERN
#define TYPE_SECTION_START_EXTERN(type, secname)
iterable section extern for start symbol for a generic type
Definition: iterable_sections.h:78
TYPE_SECTION_START
#define TYPE_SECTION_START(secname)
iterable section start symbol for a generic type
Definition: iterable_sections.h:55
TYPE_SECTION_END_EXTERN
#define TYPE_SECTION_END_EXTERN(type, secname)
iterable section extern for end symbol for a generic type
Definition: iterable_sections.h:92
LOG_LEVEL_INF
#define LOG_LEVEL_INF
Definition: log_core.h:22
log2_generic
static void log2_generic(uint8_t level, const char *fmt, va_list ap)
Writes a generic log message to the logging v2.
Definition: log_core.h:475
LOG_LEVEL_WRN
#define LOG_LEVEL_WRN
Definition: log_core.h:21
log_dynamic_source_id
static uint32_t log_dynamic_source_id(struct log_source_dynamic_data *data)
Get index of the log source based on the address of the dynamic data associated with the source.
Definition: log_core.h:453
LOG_LEVEL_ERR
#define LOG_LEVEL_ERR
Definition: log_core.h:20
LOG_LEVEL_DBG
#define LOG_LEVEL_DBG
Definition: log_core.h:23
log_const_source_id
static uint32_t log_const_source_id(const struct log_source_const_data *data)
Get index of the log source based on the address of the constant data associated with the source.
Definition: log_core.h:427
log_msg.h
log_instance.h
uint32_t
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
uint8_t
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
log_source_const_data
Constant data associated with the source of log messages.
Definition: log_instance.h:17
log_source_dynamic_data
Dynamic data associated with the source of log messages.
Definition: log_instance.h:30
util.h
Misc utilities.