-
Notifications
You must be signed in to change notification settings - Fork 6.5k
/
log_core.h
326 lines (270 loc) · 9.36 KB
/
log_core.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
/*
* Copyright (c) 2018 Nordic Semiconductor ASA
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef LOG_FRONTEND_H
#define LOG_FRONTEND_H
#include <logging/log_msg.h>
#include <logging/log_instance.h>
#include <misc/util.h>
#ifdef __cplusplus
extern "C" {
#endif
#ifndef CONFIG_LOG_DEFAULT_LEVEL
#define CONFIG_LOG_DEFAULT_LEVEL LOG_LEVEL_NONE
#endif
#ifndef CONFIG_LOG_MAX_LEVEL
#define CONFIG_LOG_MAX_LEVEL LOG_LEVEL_NONE
#endif
#define CONFIG_LOG_DOMAIN_ID 0
#define LOG_LEVEL_BITS 3
/* Conditions determining if logger is used in a module on any level. */
#if CONFIG_LOG && \
((defined(LOG_LEVEL) && LOG_LEVEL) || \
(!defined(LOG_LEVEL) && CONFIG_LOG_DEFAULT_LEVEL))
#define LOG_MODULE_PRESENT 1
#else
#define LOG_MODULE_PRESENT 0
#endif
/** @brief Macro for returning local level value if defined or default.
*
* Check @ref IS_ENABLED macro for detailed explanation of the trick.
*/
#define _LOG_RESOLVED_LEVEL(_level, _default) \
_LOG_RESOLVED_LEVEL1(_level, _default)
#define _LOG_RESOLVED_LEVEL1(_level, _default) \
__LOG_RESOLVED_LEVEL2(_LOG_XXXX##_level, _level, _default)
#define _LOG_XXXX0 _LOG_YYYY,
#define _LOG_XXXX1 _LOG_YYYY,
#define _LOG_XXXX2 _LOG_YYYY,
#define _LOG_XXXX3 _LOG_YYYY,
#define _LOG_XXXX4 _LOG_YYYY,
#define __LOG_RESOLVED_LEVEL2(one_or_two_args, _level, _default) \
__LOG_RESOLVED_LEVEL3(one_or_two_args _level, _default)
#define __LOG_RESOLVED_LEVEL3(ignore_this, val, ...) val
/**
* @def LOG_CONST_ID_GET
* @brief Macro for getting ID of the element of the section.
*
* @param _addr Address of the element.
*/
/**
* @def LOG_CURRENT_MODULE_ID
* @brief Macro for getting ID of current module.
*/
/**
* @def LOG_CURRENT_DYNAMIC_DATA_ADDR
* @brief Macro for getting address of dynamic structure of current module.
*/
#if LOG_MODULE_PRESENT
#define LOG_CONST_ID_GET(_addr) \
log_const_source_id((const struct log_source_const_data *)_addr)
#define LOG_CURRENT_MODULE_ID() \
log_const_source_id(&LOG_ITEM_CONST_DATA(LOG_MODULE_NAME))
#define LOG_CURRENT_DYNAMIC_DATA_ADDR() \
(&LOG_ITEM_DYNAMIC_DATA(LOG_MODULE_NAME))
#else /* LOG_MODULE_PRESENT */
#define LOG_CONST_ID_GET(_addr) 0
#define LOG_CURRENT_MODULE_ID() 0
#define LOG_CURRENT_DYNAMIC_DATA_ADDR() ((struct log_source_dynamic_data *)0)
#endif /* LOG_MODULE_PRESENT */
/** @brief Macro for getting ID of the element of the section.
*
* @param _addr Address of the element.
*/
#if LOG_MODULE_PRESENT
#define LOG_DYNAMIC_ID_GET(_addr) \
log_dynamic_source_id((struct log_source_dynamic_data *)_addr)
#else
#define LOG_DYNAMIC_ID_GET(_addr) 0
#endif
/******************************************************************************/
/****************** Internal macros for log frontend **************************/
/******************************************************************************/
#define _LOG_INTERNAL_X(N, ...) UTIL_CAT(_LOG_INTERNAL_, N)(__VA_ARGS__)
#define __LOG_INTERNAL(_src_level, ...) \
_LOG_INTERNAL_X(NUM_VA_ARGS_LESS_1(__VA_ARGS__), \
_src_level, __VA_ARGS__)
#define _LOG_INTERNAL_0(_src_level, _str) \
log_0(_str, _src_level)
#define _LOG_INTERNAL_1(_src_level, _str, _arg0) \
log_1(_str, (u32_t)(_arg0), _src_level)
#define _LOG_INTERNAL_2(_src_level, _str, _arg0, _arg1) \
log_2(_str, (u32_t)(_arg0), (u32_t)(_arg1), _src_level)
#define _LOG_INTERNAL_3(_src_level, _str, _arg0, _arg1, _arg2) \
log_3(_str, (u32_t)(_arg0), (u32_t)(_arg1), (u32_t)(_arg2), _src_level)
#define __LOG_ARG_CAST(_x) (u32_t)(_x),
#define __LOG_ARGUMENTS(...) MACRO_MAP(__LOG_ARG_CAST, __VA_ARGS__)
#define _LOG_INTERNAL_LONG(_src_level, _str, ...) \
do { \
u32_t args[] = {__LOG_ARGUMENTS(__VA_ARGS__)}; \
log_n(_str, args, ARRAY_SIZE(args), _src_level); \
} while (0)
#define _LOG_INTERNAL_4(_src_level, _str, ...) \
_LOG_INTERNAL_LONG(_src_level, _str, __VA_ARGS__)
#define _LOG_INTERNAL_5(_src_level, _str, ...) \
_LOG_INTERNAL_LONG(_src_level, _str, __VA_ARGS__)
#define _LOG_INTERNAL_6(_src_level, _str, ...) \
_LOG_INTERNAL_LONG(_src_level, _str, __VA_ARGS__)
#define _LOG_INTERNAL_7(_src_level, _str, ...) \
_LOG_INTERNAL_LONG(_src_level, _str, __VA_ARGS__)
#define _LOG_INTERNAL_8(_src_level, _str, ...) \
_LOG_INTERNAL_LONG(_src_level, _str, __VA_ARGS__)
#define _LOG_INTERNAL_9(_src_level, _str, ...) \
_LOG_INTERNAL_LONG(_src_level, _str, __VA_ARGS__)
#define _LOG_LEVEL_CHECK(_level, _check_level, _default_level) \
(_level <= _LOG_RESOLVED_LEVEL(_check_level, _default_level))
#define _LOG_CONST_LEVEL_CHECK(_level) \
(IS_ENABLED(CONFIG_LOG) && \
( \
_LOG_LEVEL_CHECK(_level, CONFIG_LOG_OVERRIDE_LEVEL, LOG_LEVEL_NONE) \
|| \
(!IS_ENABLED(CONFIG_LOG_OVERRIDE_LEVEL) && \
_LOG_LEVEL_CHECK(_level, LOG_LEVEL, CONFIG_LOG_DEFAULT_LEVEL) && \
(_level <= CONFIG_LOG_MAX_LEVEL) \
) \
))
/******************************************************************************/
/****************** Macros for standard logging *******************************/
/******************************************************************************/
#define __LOG(_level, _id, _filter, ...) \
do { \
if (_LOG_CONST_LEVEL_CHECK(_level) && \
(_level <= LOG_RUNTIME_FILTER(_filter))) { \
struct log_msg_ids src_level = { \
.level = _level, \
.source_id = _id, \
.domain_id = CONFIG_LOG_DOMAIN_ID \
}; \
__LOG_INTERNAL(src_level, __VA_ARGS__); \
} else { \
/* arg checker evaluated when log is filtered out \
* to ensure that __VA_ARGS__ are evaluated only \
* once giving always same side effects. \
*/ \
log_printf_arg_checker(__VA_ARGS__); \
} \
} while (0)
#define _LOG(_level, ...) \
__LOG(_level, \
LOG_CURRENT_MODULE_ID(), \
LOG_CURRENT_DYNAMIC_DATA_ADDR(), \
__VA_ARGS__)
#define _LOG_INSTANCE(_level, _inst, ...) \
__LOG(_level, \
IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) ? \
LOG_DYNAMIC_ID_GET(_inst) : \
LOG_CONST_ID_GET(_inst), \
_inst, \
__VA_ARGS__)
/******************************************************************************/
/****************** Macros for hexdump logging ********************************/
/******************************************************************************/
#define __LOG_HEXDUMP(_level, _id, _filter, _data, _length) \
do { \
if (_LOG_CONST_LEVEL_CHECK(_level) && \
(_level <= LOG_RUNTIME_FILTER(_filter))) { \
struct log_msg_ids src_level = { \
.level = _level, \
.source_id = _id, \
.domain_id = CONFIG_LOG_DOMAIN_ID \
}; \
log_hexdump(_data, _length, src_level); \
} \
} while (0)
#define _LOG_HEXDUMP(_level, _data, _length) \
__LOG_HEXDUMP(_level, \
LOG_CURRENT_MODULE_ID(), \
LOG_CURRENT_DYNAMIC_DATA_ADDR(), \
_data, _length)
#define _LOG_HEXDUMP_INSTANCE(_level, _inst, _data, _length) \
__LOG_HEXDUMP(_level, \
IS_ENABLED(CONFIG_LOG_RUNTIME_FILTERING) ? \
LOG_DYNAMIC_ID_GET(_inst) : \
LOG_CONST_ID_GET(_inst), \
_inst, \
_data, \
_length)
/** @brief Dummy function to trigger log messages arguments type checking. */
static inline __printf_like(1, 2)
void log_printf_arg_checker(const char *fmt, ...)
{
}
/** @brief Standard log with no arguments.
*
* @param str String.
* @param src_level Log identification.
*/
void log_0(const char *str, struct log_msg_ids src_level);
/** @brief Standard log with one argument.
*
* @param str String.
* @param arg1 First argument.
* @param src_level Log identification.
*/
void log_1(const char *str,
u32_t arg1,
struct log_msg_ids src_level);
/** @brief Standard log with two arguments.
*
* @param str String.
* @param arg1 First argument.
* @param arg2 Second argument.
* @param src_level Log identification.
*/
void log_2(const char *str,
u32_t arg1,
u32_t arg2,
struct log_msg_ids src_level);
/** @brief Standard log with three arguments.
*
* @param str String.
* @param arg1 First argument.
* @param arg2 Second argument.
* @param arg3 Third argument.
* @param src_level Log identification.
*/
void log_3(const char *str,
u32_t arg1,
u32_t arg2,
u32_t arg3,
struct log_msg_ids src_level);
/** @brief Standard log with arguments list.
*
* @param str String.
* @param args Array with arguments.
* @param narg Number of arguments in the array.
* @param src_level Log identification.
*/
void log_n(const char *str,
u32_t *args,
u32_t narg,
struct log_msg_ids src_level);
/** @brief Hexdump log.
*
* @param data Data.
* @param length Data length.
* @param src_level Log identification.
*/
void log_hexdump(const u8_t *data,
u32_t length,
struct log_msg_ids src_level);
/** @brief Format and put string into log message.
*
* @param fmt String to format.
* @param ap Variable list of arguments.
*
* @return Number of bytes processed.
*/
int log_printk(const char *fmt, va_list ap);
/**
* @brief Writes a generic log message to the log.
*
* @note This function is intended to be used when porting other log systems.
*/
void log_generic(struct log_msg_ids src_level, const char *fmt, va_list ap);
#ifdef __cplusplus
}
#endif
#endif /* LOG_FRONTEND_H */