Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
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
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 0
20#define LOG_LEVEL_ERR 1
21#define LOG_LEVEL_WRN 2
22#define LOG_LEVEL_INF 3
23#define LOG_LEVEL_DBG 4
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29#ifndef CONFIG_LOG
30#define CONFIG_LOG_DEFAULT_LEVEL 0
31#define CONFIG_LOG_MAX_LEVEL 0
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_XXXX1 _LOG_YYYY,
58#define _LOG_XXXX2 _LOG_YYYY,
59#define _LOG_XXXX3 _LOG_YYYY,
60#define _LOG_XXXX4 _LOG_YYYY,
61
76#define Z_LOG_EVAL(_eval_level, _iftrue, _iffalse) \
77 Z_LOG_EVAL1(_eval_level, _iftrue, _iffalse)
78
79#define Z_LOG_EVAL1(_eval_level, _iftrue, _iffalse) \
80 __COND_CODE(_LOG_ZZZZ##_eval_level, _iftrue, _iffalse)
81
82#define _LOG_ZZZZ1 _LOG_YYYY,
83#define _LOG_ZZZZ2 _LOG_YYYY,
84#define _LOG_ZZZZ3 _LOG_YYYY,
85#define _LOG_ZZZZ4 _LOG_YYYY,
86
91#define LOG_CURRENT_MODULE_ID() (__log_level != 0 ? \
92 log_const_source_id(__log_current_const_data) : 0U)
93
94/* Set of defines that are set to 1 if function name prefix is enabled for given level. */
95#define Z_LOG_FUNC_PREFIX_0 0
96#define Z_LOG_FUNC_PREFIX_1 COND_CODE_1(CONFIG_LOG_FUNC_NAME_PREFIX_ERR, (1), (0))
97#define Z_LOG_FUNC_PREFIX_2 COND_CODE_1(CONFIG_LOG_FUNC_NAME_PREFIX_WRN, (1), (0))
98#define Z_LOG_FUNC_PREFIX_3 COND_CODE_1(CONFIG_LOG_FUNC_NAME_PREFIX_INF, (1), (0))
99#define Z_LOG_FUNC_PREFIX_4 COND_CODE_1(CONFIG_LOG_FUNC_NAME_PREFIX_DBG, (1), (0))
100
110#define Z_LOG_STR_WITH_PREFIX2(...) \
111 "%s: " GET_ARG_N(1, __VA_ARGS__), (const char *)__func__\
112 COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__),\
113 (),\
114 (, GET_ARGS_LESS_N(1, __VA_ARGS__))\
115 )
116
117/* Macro handles case when no format string is provided: e.g. LOG_DBG().
118 * Handling of format string is deferred to the next level macro.
119 */
120#define Z_LOG_STR_WITH_PREFIX(...) \
121 COND_CODE_0(NUM_VA_ARGS_LESS_1(_, ##__VA_ARGS__), \
122 ("%s", (const char *)__func__), \
123 (Z_LOG_STR_WITH_PREFIX2(__VA_ARGS__)))
124
130#define Z_LOG_STR(_level, ...) \
131 COND_CODE_1(UTIL_CAT(Z_LOG_FUNC_PREFIX_##_level), \
132 (Z_LOG_STR_WITH_PREFIX(__VA_ARGS__)), (__VA_ARGS__))
133
134#define Z_LOG_LEVEL_CHECK(_level, _check_level, _default_level) \
135 ((_level) <= Z_LOG_RESOLVED_LEVEL(_check_level, _default_level))
136
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
170#define Z_LOG_STATIC_INST_LEVEL_CHECK(_level, _inst, _source) \
171 (IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) || !_inst || \
172 (_level <= ((const struct log_source_const_data *)_source)->level))
173
184#define Z_LOG_DYNAMIC_LEVEL_CHECK(_level, _source) \
185 (!IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) || k_is_user_context() || \
186 ((_level) <= Z_LOG_RUNTIME_FILTER(((struct log_source_dynamic_data *)_source)->filters)))
187
199#define Z_LOG_LEVEL_ALL_CHECK(_level, _inst, _source) \
200 (Z_LOG_CONST_LEVEL_CHECK(_level) && \
201 Z_LOG_STATIC_INST_LEVEL_CHECK(_level, _inst, _source) && \
202 Z_LOG_DYNAMIC_LEVEL_CHECK(_level, _source))
203
209#define Z_LOG_CURRENT_DATA() \
210 COND_CODE_1(CONFIG_LOG_RUNTIME_FILTERING, \
211 (__log_current_dynamic_data), (__log_current_const_data))
212
213/*****************************************************************************/
214/****************** Definitions used by minimal logging *********************/
215/*****************************************************************************/
216void z_log_minimal_hexdump_print(int level, const void *data, size_t size);
217void z_log_minimal_vprintk(const char *fmt, va_list ap);
218void z_log_minimal_printk(const char *fmt, ...);
219
220#define Z_LOG_TO_PRINTK(_level, fmt, ...) do { \
221 z_log_minimal_printk("%c: " fmt "\n", \
222 z_log_minimal_level_to_char(_level), \
223 ##__VA_ARGS__); \
224} while (false)
225
226#define Z_LOG_TO_VPRINTK(_level, fmt, valist) do { \
227 z_log_minimal_printk("%c: ", z_log_minimal_level_to_char(_level)); \
228 z_log_minimal_vprintk(fmt, valist); \
229 z_log_minimal_printk("\n"); \
230} while (false)
231
232static inline char z_log_minimal_level_to_char(int level)
233{
234 switch (level) {
235 case LOG_LEVEL_ERR:
236 return 'E';
237 case LOG_LEVEL_WRN:
238 return 'W';
239 case LOG_LEVEL_INF:
240 return 'I';
241 case LOG_LEVEL_DBG:
242 return 'D';
243 default:
244 return '?';
245 }
246}
247
248#define Z_LOG_INST(_inst) COND_CODE_1(CONFIG_LOG, (_inst), NULL)
249
250/* If strings are removed from the binary then there is a risk of creating invalid
251 * cbprintf package if %p is used with character pointer which is interpreted as
252 * string. A compile time check is performed (since format string is known at
253 * compile time) and check fails logging message is not created but error is
254 * emitted instead. String check may increase compilation time so it is not
255 * always performed (could significantly increase CI time).
256 */
257#ifdef CONFIG_LOG_FMT_STRING_VALIDATE
258#define LOG_STRING_WARNING(_mode, _src, ...) \
259 Z_LOG_MSG_CREATE(UTIL_NOT(IS_ENABLED(CONFIG_USERSPACE)), _mode, \
260 Z_LOG_LOCAL_DOMAIN_ID, _src, LOG_LEVEL_ERR, NULL, 0, \
261 "char pointer used for %%p, cast to void *:\"%s\"", \
262 GET_ARG_N(1, __VA_ARGS__))
263
264#define LOG_POINTERS_VALIDATE(string_ok, ...) \
265 _Pragma("GCC diagnostic push") \
266 _Pragma("GCC diagnostic ignored \"-Wpointer-arith\"") \
267 string_ok = Z_CBPRINTF_POINTERS_VALIDATE(__VA_ARGS__); \
268 _Pragma("GCC diagnostic pop")
269#else
270#define LOG_POINTERS_VALIDATE(string_ok, ...) string_ok = true
271#define LOG_STRING_WARNING(_mode, _src, ...)
272#endif
273
274/*****************************************************************************/
275/****************** Macros for standard logging ******************************/
276/*****************************************************************************/
292#define Z_LOG2(_level, _inst, _source, ...) \
293 do { \
294 if (!Z_LOG_LEVEL_ALL_CHECK(_level, _inst, _source)) { \
295 break; \
296 } \
297 if (IS_ENABLED(CONFIG_LOG_MODE_MINIMAL)) { \
298 Z_LOG_TO_PRINTK(_level, __VA_ARGS__); \
299 break; \
300 } \
301 int _mode; \
302 bool string_ok; \
303 LOG_POINTERS_VALIDATE(string_ok, __VA_ARGS__); \
304 if (!string_ok) { \
305 LOG_STRING_WARNING(_mode, _source, __VA_ARGS__); \
306 break; \
307 } \
308 Z_LOG_MSG_CREATE(UTIL_NOT(IS_ENABLED(CONFIG_USERSPACE)), _mode, \
309 Z_LOG_LOCAL_DOMAIN_ID, _source, _level, NULL, 0, __VA_ARGS__); \
310 (void)_mode; \
311 if (false) { \
312 /* Arguments checker present but never evaluated.*/ \
313 /* Placed here to ensure that __VA_ARGS__ are*/ \
314 /* evaluated once when log is enabled.*/ \
315 z_log_printf_arg_checker(__VA_ARGS__); \
316 } \
317 } while (false)
318
319#define Z_LOG(_level, ...) Z_LOG2(_level, 0, Z_LOG_CURRENT_DATA(), __VA_ARGS__)
320#define Z_LOG_INSTANCE(_level, _inst, ...) Z_LOG2(_level, 1, Z_LOG_INST(_inst), __VA_ARGS__)
321
322/*****************************************************************************/
323/****************** Macros for hexdump logging *******************************/
324/*****************************************************************************/
345#define Z_LOG_HEXDUMP2(_level, _inst, _source, _data, _len, ...) \
346 do { \
347 if (!Z_LOG_LEVEL_ALL_CHECK(_level, _inst, _source)) { \
348 break; \
349 } \
350 const char *_str = GET_ARG_N(1, __VA_ARGS__); \
351 if (IS_ENABLED(CONFIG_LOG_MODE_MINIMAL)) { \
352 Z_LOG_TO_PRINTK(_level, "%s", _str); \
353 z_log_minimal_hexdump_print((_level), (const char *)(_data), (_len)); \
354 break; \
355 } \
356 int mode; \
357 Z_LOG_MSG_CREATE(UTIL_NOT(IS_ENABLED(CONFIG_USERSPACE)), mode, \
358 Z_LOG_LOCAL_DOMAIN_ID, _source, _level, _data, _len, \
359 COND_CODE_0(NUM_VA_ARGS_LESS_1(_, ##__VA_ARGS__), \
360 (), \
361 (COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__), \
362 ("%s", __VA_ARGS__), (__VA_ARGS__))))); \
363 } while (false)
364
365#define Z_LOG_HEXDUMP(_level, _data, _length, ...) \
366 Z_LOG_HEXDUMP2(_level, 0, Z_LOG_CURRENT_DATA(), _data, _length, __VA_ARGS__)
367
368#define Z_LOG_HEXDUMP_INSTANCE(_level, _inst, _data, _length, ...) \
369 Z_LOG_HEXDUMP2(_level, 1, Z_LOG_INST(_inst), _data, _length, __VA_ARGS__)
370
371/*****************************************************************************/
372/****************** Filtering macros *****************************************/
373/*****************************************************************************/
374
376#define LOG_LEVEL_BITS 3U
377
379#define LOG_FILTER_SLOT_SIZE LOG_LEVEL_BITS
380
382#define LOG_FILTERS_NUM_OF_SLOTS (32 / LOG_FILTER_SLOT_SIZE)
383
385#define LOG_FILTERS_MAX_BACKENDS \
386 (LOG_FILTERS_NUM_OF_SLOTS - (1 + IS_ENABLED(CONFIG_LOG_FRONTEND)))
387
389#define LOG_FRONTEND_SLOT_ID (LOG_FILTERS_NUM_OF_SLOTS - 1)
390
392#define LOG_FILTER_SLOT_MASK (BIT(LOG_FILTER_SLOT_SIZE) - 1U)
393
398#define LOG_FILTER_SLOT_SHIFT(_id) (LOG_FILTER_SLOT_SIZE * (_id))
399
400#define LOG_FILTER_SLOT_GET(_filters, _id) \
401 ((*(_filters) >> LOG_FILTER_SLOT_SHIFT(_id)) & LOG_FILTER_SLOT_MASK)
402
403#define LOG_FILTER_SLOT_SET(_filters, _id, _filter) \
404 do { \
405 *(_filters) &= ~(LOG_FILTER_SLOT_MASK << \
406 LOG_FILTER_SLOT_SHIFT(_id)); \
407 *(_filters) |= ((_filter) & LOG_FILTER_SLOT_MASK) << \
408 LOG_FILTER_SLOT_SHIFT(_id); \
409 } while (false)
410
411#define LOG_FILTER_AGGR_SLOT_IDX 0
412
413#define LOG_FILTER_AGGR_SLOT_GET(_filters) \
414 LOG_FILTER_SLOT_GET(_filters, LOG_FILTER_AGGR_SLOT_IDX)
415
416#define LOG_FILTER_FIRST_BACKEND_SLOT_IDX 1
417
418/* Return aggregated (highest) level for all enabled backends, e.g. if there
419 * are 3 active backends, one backend is set to get INF logs from a module and
420 * two other backends are set for ERR, returned level is INF.
421 */
422#define Z_LOG_RUNTIME_FILTER(_filter) \
423 LOG_FILTER_SLOT_GET(&(_filter), LOG_FILTER_AGGR_SLOT_IDX)
424
428#define LOG_LEVEL_INTERNAL_RAW_STRING LOG_LEVEL_NONE
429
432
443#define Z_LOG_PRINTK(_is_raw, ...) do { \
444 if (!IS_ENABLED(CONFIG_LOG)) { \
445 break; \
446 } \
447 if (IS_ENABLED(CONFIG_LOG_MODE_MINIMAL)) { \
448 z_log_minimal_printk(__VA_ARGS__); \
449 break; \
450 } \
451 int _mode; \
452 if (0) {\
453 z_log_printf_arg_checker(__VA_ARGS__); \
454 } \
455 Z_LOG_MSG_CREATE(!IS_ENABLED(CONFIG_USERSPACE), _mode, \
456 Z_LOG_LOCAL_DOMAIN_ID, (const void *)(uintptr_t)_is_raw, \
457 LOG_LEVEL_INTERNAL_RAW_STRING, NULL, 0, __VA_ARGS__);\
458} while (0)
459
468 const struct log_source_const_data *data)
469{
470 return ((const uint8_t *)data - (uint8_t *)TYPE_SECTION_START(log_const))/
471 sizeof(struct log_source_const_data);
472}
473
476
481#define LOG_ITEM_DYNAMIC_DATA(_name) UTIL_CAT(log_dynamic_, _name)
482
483#define LOG_INSTANCE_DYNAMIC_DATA(_module_name, _inst) \
484 LOG_ITEM_DYNAMIC_DATA(Z_LOG_INSTANCE_FULL_NAME(_module_name, _inst))
485
494{
495 return ((uint8_t *)data - (uint8_t *)TYPE_SECTION_START(log_dynamic))/
496 sizeof(struct log_source_dynamic_data);
497}
498
506static inline uint32_t log_source_id(const void *source)
507{
508 return IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) ?
510 log_const_source_id((const struct log_source_const_data *)source);
511}
512
514static inline __printf_like(1, 2)
515void z_log_printf_arg_checker(const char *fmt, ...)
516{
517 ARG_UNUSED(fmt);
518}
519
529static inline void log_generic(uint8_t level, const char *fmt, va_list ap)
530{
531 z_log_msg_runtime_vcreate(Z_LOG_LOCAL_DOMAIN_ID, NULL, level,
532 NULL, 0, 0, fmt, ap);
533}
534
535#ifdef __cplusplus
536}
537#endif
538
539#endif /* ZEPHYR_INCLUDE_LOGGING_LOG_CORE_H_ */
#define TYPE_SECTION_START_EXTERN(type, secname)
iterable section extern for start symbol for a generic type
Definition iterable_sections.h:78
#define TYPE_SECTION_START(secname)
iterable section start symbol for a generic type
Definition iterable_sections.h:55
#define TYPE_SECTION_END_EXTERN(type, secname)
iterable section extern for end symbol for a generic type
Definition iterable_sections.h:92
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:140
static uint32_t log_source_id(const void *source)
Get index of the log source based on the address of the associated data.
Definition log_core.h:506
#define LOG_LEVEL_INF
Definition log_core.h:22
#define LOG_LEVEL_WRN
Definition log_core.h:21
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:493
#define LOG_LEVEL_ERR
Definition log_core.h:20
static void log_generic(uint8_t level, const char *fmt, va_list ap)
Write a generic log message.
Definition log_core.h:529
#define LOG_LEVEL_DBG
Definition log_core.h:23
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:467
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
Constant data associated with the source of log messages.
Definition log_instance.h:17
Dynamic data associated with the source of log messages.
Definition log_instance.h:30
Misc utilities.