projects / babeltrace.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Logging: require modules to define BT_LOG_OUTPUT_LEVEL
[babeltrace.git] / logging / log.c
1 /*
2 * This is zf_log.c, modified with Babeltrace prefixes.
3 * See <https://github.com/wonder-mice/zf_log/>.
4 * See LICENSE.
5 */
6
7 #include <babeltrace/babeltrace-internal.h>
8
9 /* When defined, Android log (android/log.h) will be used by default instead of
10 * stderr (ignored on non-Android platforms). Date, time, pid and tid (context)
11 * will be provided by Android log. Android log features will be used to output
12 * log level and tag.
13 */
14 #ifdef BT_LOG_USE_ANDROID_LOG
15 #undef BT_LOG_USE_ANDROID_LOG
16 #if defined(__ANDROID__)
17 #define BT_LOG_USE_ANDROID_LOG 1
18 #else
19 #define BT_LOG_USE_ANDROID_LOG 0
20 #endif
21 #else
22 #define BT_LOG_USE_ANDROID_LOG 0
23 #endif
24 /* When defined, NSLog (uses Apple System Log) will be used instead of stderr
25 * (ignored on non-Apple platforms). Date, time, pid and tid (context) will be
26 * provided by NSLog. Curiously, doesn't use NSLog() directly, but piggybacks on
27 * non-public CFLog() function. Both use Apple System Log internally, but it's
28 * easier to call CFLog() from C than NSLog(). Current implementation doesn't
29 * support "%@" format specifier.
30 */
31 #ifdef BT_LOG_USE_NSLOG
32 #undef BT_LOG_USE_NSLOG
33 #if defined(__APPLE__) && defined(__MACH__)
34 #define BT_LOG_USE_NSLOG 1
35 #else
36 #define BT_LOG_USE_NSLOG 0
37 #endif
38 #else
39 #define BT_LOG_USE_NSLOG 0
40 #endif
41 /* When defined, OutputDebugString() will be used instead of stderr (ignored on
42 * non-Windows platforms). Uses OutputDebugStringA() variant and feeds it with
43 * UTF-8 data.
44 */
45 #ifdef BT_LOG_USE_DEBUGSTRING
46 #undef BT_LOG_USE_DEBUGSTRING
47 #if defined(_WIN32) || defined(_WIN64)
48 #define BT_LOG_USE_DEBUGSTRING 1
49 #else
50 #define BT_LOG_USE_DEBUGSTRING 0
51 #endif
52 #else
53 #define BT_LOG_USE_DEBUGSTRING 0
54 #endif
55 /* When defined, bt_log library will not contain definition of tag prefix
56 * variable. In that case it must be defined elsewhere using
57 * BT_LOG_DEFINE_TAG_PREFIX macro, for example:
58 *
59 * BT_LOG_DEFINE_TAG_PREFIX = "ProcessName";
60 *
61 * This allows to specify custom value for static initialization and avoid
62 * overhead of setting this value in runtime.
63 */
64 #ifdef BT_LOG_EXTERN_TAG_PREFIX
65 #undef BT_LOG_EXTERN_TAG_PREFIX
66 #define BT_LOG_EXTERN_TAG_PREFIX 1
67 #else
68 #define BT_LOG_EXTERN_TAG_PREFIX 0
69 #endif
70 /* When defined, bt_log library will not contain definition of global format
71 * variable. In that case it must be defined elsewhere using
72 * BT_LOG_DEFINE_GLOBAL_FORMAT macro, for example:
73 *
74 * BT_LOG_DEFINE_GLOBAL_FORMAT = {MEM_WIDTH};
75 *
76 * This allows to specify custom value for static initialization and avoid
77 * overhead of setting this value in runtime.
78 */
79 #ifdef BT_LOG_EXTERN_GLOBAL_FORMAT
80 #undef BT_LOG_EXTERN_GLOBAL_FORMAT
81 #define BT_LOG_EXTERN_GLOBAL_FORMAT 1
82 #else
83 #define BT_LOG_EXTERN_GLOBAL_FORMAT 0
84 #endif
85 /* When defined, bt_log library will not contain definition of global output
86 * variable. In that case it must be defined elsewhere using
87 * BT_LOG_DEFINE_GLOBAL_OUTPUT macro, for example:
88 *
89 * BT_LOG_DEFINE_GLOBAL_OUTPUT = {BT_LOG_PUT_STD, custom_output_callback};
90 *
91 * This allows to specify custom value for static initialization and avoid
92 * overhead of setting this value in runtime.
93 */
94 #ifdef BT_LOG_EXTERN_GLOBAL_OUTPUT
95 #undef BT_LOG_EXTERN_GLOBAL_OUTPUT
96 #define BT_LOG_EXTERN_GLOBAL_OUTPUT 1
97 #else
98 #define BT_LOG_EXTERN_GLOBAL_OUTPUT 0
99 #endif
100 /* When defined, bt_log library will not contain definition of global output
101 * level variable. In that case it must be defined elsewhere using
102 * BT_LOG_DEFINE_GLOBAL_OUTPUT_LEVEL macro, for example:
103 *
104 * BT_LOG_DEFINE_GLOBAL_OUTPUT_LEVEL = BT_LOG_WARN;
105 *
106 * This allows to specify custom value for static initialization and avoid
107 * overhead of setting this value in runtime.
108 */
109 #ifdef BT_LOG_EXTERN_GLOBAL_OUTPUT_LEVEL
110 #undef BT_LOG_EXTERN_GLOBAL_OUTPUT_LEVEL
111 #define BT_LOG_EXTERN_GLOBAL_OUTPUT_LEVEL 1
112 #else
113 #define BT_LOG_EXTERN_GLOBAL_OUTPUT_LEVEL 0
114 #endif
115 /* When defined, implementation will prefer smaller code size over speed.
116 * Very rough estimate is that code will be up to 2x smaller and up to 2x
117 * slower. Disabled by default.
118 */
119 #ifdef BT_LOG_OPTIMIZE_SIZE
120 #undef BT_LOG_OPTIMIZE_SIZE
121 #define BT_LOG_OPTIMIZE_SIZE 1
122 #else
123 #define BT_LOG_OPTIMIZE_SIZE 0
124 #endif
125 /* Size of the log line buffer. The buffer is allocated on stack. It limits
126 * maximum length of a log line.
127 */
128 #ifndef BT_LOG_BUF_SZ
129 #define BT_LOG_BUF_SZ 512
130 #endif
131 /* Default number of bytes in one line of memory output. For large values
132 * BT_LOG_BUF_SZ also must be increased.
133 */
134 #ifndef BT_LOG_MEM_WIDTH
135 #define BT_LOG_MEM_WIDTH 32
136 #endif
137 /* String to put in the end of each log line (can be empty). Its value used by
138 * stderr output callback. Its size used as a default value for BT_LOG_EOL_SZ.
139 */
140 #ifndef BT_LOG_EOL
141 #define BT_LOG_EOL "\n"
142 #endif
143 /* Default delimiter that separates parts of log message. Can NOT contain '%'
144 * or '\0'.
145 *
146 * Log message format specifications can override (or ignore) this value. For
147 * more details see BT_LOG_MESSAGE_CTX_FORMAT, BT_LOG_MESSAGE_SRC_FORMAT and
148 * BT_LOG_MESSAGE_TAG_FORMAT.
149 */
150 #ifndef BT_LOG_DEF_DELIMITER
151 #define BT_LOG_DEF_DELIMITER " "
152 #endif
153 /* Specifies log message context format. Log message context includes date,
154 * time, process id, thread id and message's log level. Custom information can
155 * be added as well. Supported fields: YEAR, MONTH, DAY, HOUR, MINUTE, SECOND,
156 * MILLISECOND, PID, TID, LEVEL, S(str), F_INIT(statements),
157 * F_UINT(width, value).
158 *
159 * Must be defined as a tuple, for example:
160 *
161 * #define BT_LOG_MESSAGE_CTX_FORMAT (YEAR, S("."), MONTH, S("."), DAY, S(" > "))
162 *
163 * In that case, resulting log message will be:
164 *
165 * 2016.12.22 > TAG function@filename.c:line Message text
166 *
167 * Note, that tag, source location and message text are not impacted by
168 * this setting. See BT_LOG_MESSAGE_TAG_FORMAT and BT_LOG_MESSAGE_SRC_FORMAT.
169 *
170 * If message context must be visually separated from the rest of the message,
171 * it must be reflected in context format (notice trailing S(" > ") in the
172 * example above).
173 *
174 * S(str) adds constant string str. String can NOT contain '%' or '\0'.
175 *
176 * F_INIT(statements) adds initialization statement(s) that will be evaluated
177 * once for each log message. All statements are evaluated in specified order.
178 * Several F_INIT() fields can be used in every log message format
179 * specification. Fields, like F_UINT(width, value), are allowed to use results
180 * of initialization statements. If statement introduces variables (or other
181 * names, like structures) they must be prefixed with "f_". Statements must be
182 * enclosed into additional "()". Example:
183 *
184 * #define BT_LOG_MESSAGE_CTX_FORMAT \
185 * (F_INIT(( struct rusage f_ru; getrusage(RUSAGE_SELF, &f_ru); )), \
186 * YEAR, S("."), MONTH, S("."), DAY, S(" "), \
187 * F_UINT(5, f_ru.ru_nsignals), \
188 * S(" "))
189 *
190 * F_UINT(width, value) adds unsigned integer value extended with up to width
191 * spaces (for alignment purposes). Value can be any expression that evaluates
192 * to unsigned integer. If expression contains non-standard functions, they
193 * must be declared with F_INIT(). Example:
194 *
195 * #define BT_LOG_MESSAGE_CTX_FORMAT \
196 * (YEAR, S("."), MONTH, S("."), DAY, S(" "), \
197 * F_INIT(( unsigned tickcount(); )), \
198 * F_UINT(5, tickcount()), \
199 * S(" "))
200 *
201 * Other log message format specifications follow same rules, but have a
202 * different set of supported fields.
203 */
204 #ifndef BT_LOG_MESSAGE_CTX_FORMAT
205 #define BT_LOG_MESSAGE_CTX_FORMAT \
206 (MONTH, S("-"), DAY, S(BT_LOG_DEF_DELIMITER), \
207 HOUR, S(":"), MINUTE, S(":"), SECOND, S("."), MILLISECOND, S(BT_LOG_DEF_DELIMITER), \
208 PID, S(BT_LOG_DEF_DELIMITER), TID, S(BT_LOG_DEF_DELIMITER), \
209 LEVEL, S(BT_LOG_DEF_DELIMITER))
210 #endif
211 /* Example:
212 */
213 /* Specifies log message tag format. It includes tag prefix and tag. Custom
214 * information can be added as well. Supported fields:
215 * TAG(prefix_delimiter, tag_delimiter), S(str), F_INIT(statements),
216 * F_UINT(width, value).
217 *
218 * TAG(prefix_delimiter, tag_delimiter) adds following string to log message:
219 *
220 * PREFIX<prefix_delimiter>TAG<tag_delimiter>
221 *
222 * Prefix delimiter will be used only when prefix is not empty. Tag delimiter
223 * will be used only when prefixed tag is not empty. Example:
224 *
225 * #define BT_LOG_TAG_FORMAT (S("["), TAG(".", ""), S("] "))
226 *
227 * See BT_LOG_MESSAGE_CTX_FORMAT for details.
228 */
229 #ifndef BT_LOG_MESSAGE_TAG_FORMAT
230 #define BT_LOG_MESSAGE_TAG_FORMAT \
231 (TAG(".", BT_LOG_DEF_DELIMITER))
232 #endif
233 /* Specifies log message source location format. It includes function name,
234 * file name and file line. Custom information can be added as well. Supported
235 * fields: FUNCTION, FILENAME, FILELINE, S(str), F_INIT(statements),
236 * F_UINT(width, value).
237 *
238 * See BT_LOG_MESSAGE_CTX_FORMAT for details.
239 */
240 #ifndef BT_LOG_MESSAGE_SRC_FORMAT
241 #define BT_LOG_MESSAGE_SRC_FORMAT \
242 (FUNCTION, S("@"), FILENAME, S(":"), FILELINE, S(BT_LOG_DEF_DELIMITER))
243 #endif
244 /* Fields that can be used in log message format specifications (see above).
245 * Mentioning them here explicitly, so we know that nobody else defined them
246 * before us. See BT_LOG_MESSAGE_CTX_FORMAT for details.
247 */
248 #define YEAR YEAR
249 #define MONTH MONTH
250 #define DAY DAY
251 #define MINUTE MINUTE
252 #define SECOND SECOND
253 #define MILLISECOND MILLISECOND
254 #define PID PID
255 #define TID TID
256 #define LEVEL LEVEL
257 #define TAG(prefix_delim, tag_delim) TAG(prefix_delim, tag_delim)
258 #define FUNCTION FUNCTION
259 #define FILENAME FILENAME
260 #define FILELINE FILELINE
261 #define S(str) S(str)
262 #define F_INIT(statements) F_INIT(statements)
263 #define F_UINT(width, value) F_UINT(width, value)
264 /* Number of bytes to reserve for EOL in the log line buffer (must be >0).
265 * Must be larger than or equal to length of BT_LOG_EOL with terminating null.
266 */
267 #ifndef BT_LOG_EOL_SZ
268 #define BT_LOG_EOL_SZ sizeof(BT_LOG_EOL)
269 #endif
270 /* Compile instrumented version of the library to facilitate unit testing.
271 */
272 #ifndef BT_LOG_INSTRUMENTED
273 #define BT_LOG_INSTRUMENTED 0
274 #endif
275
276 #if defined(__linux__)
277 #if !defined(__ANDROID__) && !defined(_GNU_SOURCE)
278 #define _GNU_SOURCE
279 #endif
280 #endif
281 #if defined(__MINGW32__)
282 #ifdef __STRICT_ANSI__
283 #undef __STRICT_ANSI__
284 #endif
285 #endif
286 #include <assert.h>
287 #include <ctype.h>
288 #include <string.h>
289 #include <time.h>
290 #include <stdarg.h>
291 #include <stddef.h>
292 #include <stdlib.h>
293 #include <stdio.h>
294
295 #define BT_LOG_OUTPUT_LEVEL dummy
296
297 #include <babeltrace/logging-internal.h>
298 #include <babeltrace/logging.h>
299
300 #if defined(_WIN32) || defined(_WIN64)
301 #include <windows.h>
302 #else
303 #include <unistd.h>
304 #include <sys/time.h>
305 #if defined(__linux__)
306 #include <linux/limits.h>
307 #else
308 #include <sys/syslimits.h>
309 #endif
310 #endif
311
312 #if defined(__linux__)
313 #include <sys/prctl.h>
314 #include <sys/types.h>
315 #if !defined(__ANDROID__)
316 #include <sys/syscall.h>
317 #endif
318 #endif
319 #if defined(__MACH__)
320 #include <pthread.h>
321 #endif
322
323 #define INLINE _BT_LOG_INLINE
324 #define VAR_UNUSED(var) (void)var
325 #define RETVAL_UNUSED(expr) do { while(expr) break; } while(0)
326 #define STATIC_ASSERT(name, cond) \
327 typedef char assert_##name[(cond)? 1: -1]
328 #define ASSERT_UNREACHABLE(why) assert(!sizeof(why))
329 #ifndef _countof
330 #define _countof(xs) (sizeof(xs) / sizeof((xs)[0]))
331 #endif
332
333 #if BT_LOG_INSTRUMENTED
334 #define INSTRUMENTED_CONST
335 #else
336 #define INSTRUMENTED_CONST const
337 #endif
338
339 #define _PP_PASTE_2(a, b) a ## b
340 #define _PP_CONCAT_2(a, b) _PP_PASTE_2(a, b)
341
342 #define _PP_PASTE_3(a, b, c) a ## b ## c
343 #define _PP_CONCAT_3(a, b, c) _PP_PASTE_3(a, b, c)
344
345 /* Microsoft C preprocessor is a piece of shit. This moron treats __VA_ARGS__
346 * as a single token and requires additional expansion to realize that it's
347 * actually a list. If not for it, there would be no need in this extra
348 * expansion.
349 */
350 #define _PP_ID(x) x
351 #define _PP_NARGS_N(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20,_21,_22,_23,_24,...) _24
352 #define _PP_NARGS(...) _PP_ID(_PP_NARGS_N(__VA_ARGS__,24,23,22,21,20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0))
353
354 /* There is a more efficient way to implement this, but it requires
355 * working C preprocessor. Unfortunately, Microsoft Visual Studio doesn't
356 * have one.
357 */
358 #define _PP_HEAD__(x, ...) x
359 #define _PP_HEAD_(...) _PP_ID(_PP_HEAD__(__VA_ARGS__, ~))
360 #define _PP_HEAD(xs) _PP_HEAD_ xs
361 #define _PP_TAIL_(x, ...) (__VA_ARGS__)
362 #define _PP_TAIL(xs) _PP_TAIL_ xs
363 #define _PP_UNTUPLE_(...) __VA_ARGS__
364 #define _PP_UNTUPLE(xs) _PP_UNTUPLE_ xs
365
366 /* Apply function macro to each element in tuple. Output is not
367 * enforced to be a tuple.
368 */
369 #define _PP_MAP_1(f, xs) f(_PP_HEAD(xs))
370 #define _PP_MAP_2(f, xs) f(_PP_HEAD(xs)) _PP_MAP_1(f, _PP_TAIL(xs))
371 #define _PP_MAP_3(f, xs) f(_PP_HEAD(xs)) _PP_MAP_2(f, _PP_TAIL(xs))
372 #define _PP_MAP_4(f, xs) f(_PP_HEAD(xs)) _PP_MAP_3(f, _PP_TAIL(xs))
373 #define _PP_MAP_5(f, xs) f(_PP_HEAD(xs)) _PP_MAP_4(f, _PP_TAIL(xs))
374 #define _PP_MAP_6(f, xs) f(_PP_HEAD(xs)) _PP_MAP_5(f, _PP_TAIL(xs))
375 #define _PP_MAP_7(f, xs) f(_PP_HEAD(xs)) _PP_MAP_6(f, _PP_TAIL(xs))
376 #define _PP_MAP_8(f, xs) f(_PP_HEAD(xs)) _PP_MAP_7(f, _PP_TAIL(xs))
377 #define _PP_MAP_9(f, xs) f(_PP_HEAD(xs)) _PP_MAP_8(f, _PP_TAIL(xs))
378 #define _PP_MAP_10(f, xs) f(_PP_HEAD(xs)) _PP_MAP_9(f, _PP_TAIL(xs))
379 #define _PP_MAP_11(f, xs) f(_PP_HEAD(xs)) _PP_MAP_10(f, _PP_TAIL(xs))
380 #define _PP_MAP_12(f, xs) f(_PP_HEAD(xs)) _PP_MAP_11(f, _PP_TAIL(xs))
381 #define _PP_MAP_13(f, xs) f(_PP_HEAD(xs)) _PP_MAP_12(f, _PP_TAIL(xs))
382 #define _PP_MAP_14(f, xs) f(_PP_HEAD(xs)) _PP_MAP_13(f, _PP_TAIL(xs))
383 #define _PP_MAP_15(f, xs) f(_PP_HEAD(xs)) _PP_MAP_14(f, _PP_TAIL(xs))
384 #define _PP_MAP_16(f, xs) f(_PP_HEAD(xs)) _PP_MAP_15(f, _PP_TAIL(xs))
385 #define _PP_MAP_17(f, xs) f(_PP_HEAD(xs)) _PP_MAP_16(f, _PP_TAIL(xs))
386 #define _PP_MAP_18(f, xs) f(_PP_HEAD(xs)) _PP_MAP_17(f, _PP_TAIL(xs))
387 #define _PP_MAP_19(f, xs) f(_PP_HEAD(xs)) _PP_MAP_18(f, _PP_TAIL(xs))
388 #define _PP_MAP_20(f, xs) f(_PP_HEAD(xs)) _PP_MAP_19(f, _PP_TAIL(xs))
389 #define _PP_MAP_21(f, xs) f(_PP_HEAD(xs)) _PP_MAP_20(f, _PP_TAIL(xs))
390 #define _PP_MAP_22(f, xs) f(_PP_HEAD(xs)) _PP_MAP_21(f, _PP_TAIL(xs))
391 #define _PP_MAP_23(f, xs) f(_PP_HEAD(xs)) _PP_MAP_22(f, _PP_TAIL(xs))
392 #define _PP_MAP_24(f, xs) f(_PP_HEAD(xs)) _PP_MAP_23(f, _PP_TAIL(xs))
393 #define _PP_MAP(f, xs) _PP_CONCAT_2(_PP_MAP_, _PP_NARGS xs) (f, xs)
394
395 /* Apply function macro to each element in tuple in reverse order.
396 * Output is not enforced to be a tuple.
397 */
398 #define _PP_RMAP_1(f, xs) f(_PP_HEAD(xs))
399 #define _PP_RMAP_2(f, xs) _PP_RMAP_1(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
400 #define _PP_RMAP_3(f, xs) _PP_RMAP_2(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
401 #define _PP_RMAP_4(f, xs) _PP_RMAP_3(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
402 #define _PP_RMAP_5(f, xs) _PP_RMAP_4(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
403 #define _PP_RMAP_6(f, xs) _PP_RMAP_5(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
404 #define _PP_RMAP_7(f, xs) _PP_RMAP_6(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
405 #define _PP_RMAP_8(f, xs) _PP_RMAP_7(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
406 #define _PP_RMAP_9(f, xs) _PP_RMAP_8(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
407 #define _PP_RMAP_10(f, xs) _PP_RMAP_9(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
408 #define _PP_RMAP_11(f, xs) _PP_RMAP_10(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
409 #define _PP_RMAP_12(f, xs) _PP_RMAP_11(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
410 #define _PP_RMAP_13(f, xs) _PP_RMAP_12(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
411 #define _PP_RMAP_14(f, xs) _PP_RMAP_13(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
412 #define _PP_RMAP_15(f, xs) _PP_RMAP_14(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
413 #define _PP_RMAP_16(f, xs) _PP_RMAP_15(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
414 #define _PP_RMAP_17(f, xs) _PP_RMAP_16(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
415 #define _PP_RMAP_18(f, xs) _PP_RMAP_17(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
416 #define _PP_RMAP_19(f, xs) _PP_RMAP_18(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
417 #define _PP_RMAP_20(f, xs) _PP_RMAP_19(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
418 #define _PP_RMAP_21(f, xs) _PP_RMAP_20(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
419 #define _PP_RMAP_22(f, xs) _PP_RMAP_21(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
420 #define _PP_RMAP_23(f, xs) _PP_RMAP_22(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
421 #define _PP_RMAP_24(f, xs) _PP_RMAP_23(f, _PP_TAIL(xs)) f(_PP_HEAD(xs))
422 #define _PP_RMAP(f, xs) _PP_CONCAT_2(_PP_RMAP_, _PP_NARGS xs) (f, xs)
423
424 /* Used to implement _BT_LOG_MESSAGE_FORMAT_CONTAINS() macro. All possible
425 * fields must be mentioned here. Not counting F_INIT() here because it's
426 * somewhat special and is handled spearatly (at least for now).
427 */
428 #define _BT_LOG_MESSAGE_FORMAT_MASK__ (0<<0)
429 #define _BT_LOG_MESSAGE_FORMAT_MASK__YEAR (1<<1)
430 #define _BT_LOG_MESSAGE_FORMAT_MASK__MONTH (1<<2)
431 #define _BT_LOG_MESSAGE_FORMAT_MASK__DAY (1<<3)
432 #define _BT_LOG_MESSAGE_FORMAT_MASK__HOUR (1<<4)
433 #define _BT_LOG_MESSAGE_FORMAT_MASK__MINUTE (1<<5)
434 #define _BT_LOG_MESSAGE_FORMAT_MASK__SECOND (1<<6)
435 #define _BT_LOG_MESSAGE_FORMAT_MASK__MILLISECOND (1<<7)
436 #define _BT_LOG_MESSAGE_FORMAT_MASK__PID (1<<8)
437 #define _BT_LOG_MESSAGE_FORMAT_MASK__TID (1<<9)
438 #define _BT_LOG_MESSAGE_FORMAT_MASK__LEVEL (1<<10)
439 #define _BT_LOG_MESSAGE_FORMAT_MASK__TAG(ps, ts) (1<<11)
440 #define _BT_LOG_MESSAGE_FORMAT_MASK__FUNCTION (1<<12)
441 #define _BT_LOG_MESSAGE_FORMAT_MASK__FILENAME (1<<13)
442 #define _BT_LOG_MESSAGE_FORMAT_MASK__FILELINE (1<<14)
443 #define _BT_LOG_MESSAGE_FORMAT_MASK__S(s) (1<<15)
444 #define _BT_LOG_MESSAGE_FORMAT_MASK__F_INIT(expr) (0<<16)
445 #define _BT_LOG_MESSAGE_FORMAT_MASK__F_UINT(w, v) (1<<17)
446 #define _BT_LOG_MESSAGE_FORMAT_MASK(field) \
447 _PP_CONCAT_3(_BT_LOG_MESSAGE_FORMAT_MASK_, _, field)
448
449 /* Logical "or" of masks of fields used in specified format specification.
450 */
451 #define _BT_LOG_MESSAGE_FORMAT_FIELDS(format) \
452 (0 _PP_MAP(| _BT_LOG_MESSAGE_FORMAT_MASK, format))
453
454 /* Expands to expressions that evaluates to true if field is used in
455 * specified format specification. Example:
456 *
457 * #if _BT_LOG_MESSAGE_FORMAT_CONTAINS(F_UINT, BT_LOG_MESSAGE_CTX_FORMAT)
458 * ...
459 * #endif
460 */
461 #define _BT_LOG_MESSAGE_FORMAT_CONTAINS(field, format) \
462 (_BT_LOG_MESSAGE_FORMAT_MASK(field) & _BT_LOG_MESSAGE_FORMAT_FIELDS(format))
463
464 /* Same, but checks all supported format specifications.
465 */
466 #define _BT_LOG_MESSAGE_FORMAT_FIELD_USED(field) \
467 (_BT_LOG_MESSAGE_FORMAT_CONTAINS(field, BT_LOG_MESSAGE_CTX_FORMAT) || \
468 _BT_LOG_MESSAGE_FORMAT_CONTAINS(field, BT_LOG_MESSAGE_TAG_FORMAT) || \
469 _BT_LOG_MESSAGE_FORMAT_CONTAINS(field, BT_LOG_MESSAGE_SRC_FORMAT))
470
471 #define _BT_LOG_MESSAGE_FORMAT_DATETIME_USED \
472 (_BT_LOG_MESSAGE_FORMAT_CONTAINS(YEAR, BT_LOG_MESSAGE_CTX_FORMAT) || \
473 _BT_LOG_MESSAGE_FORMAT_CONTAINS(MONTH, BT_LOG_MESSAGE_CTX_FORMAT) || \
474 _BT_LOG_MESSAGE_FORMAT_CONTAINS(DAY, BT_LOG_MESSAGE_CTX_FORMAT) || \
475 _BT_LOG_MESSAGE_FORMAT_CONTAINS(HOUR, BT_LOG_MESSAGE_CTX_FORMAT) || \
476 _BT_LOG_MESSAGE_FORMAT_CONTAINS(MINUTE, BT_LOG_MESSAGE_CTX_FORMAT) || \
477 _BT_LOG_MESSAGE_FORMAT_CONTAINS(SECOND, BT_LOG_MESSAGE_CTX_FORMAT) || \
478 _BT_LOG_MESSAGE_FORMAT_CONTAINS(MILLISECOND, BT_LOG_MESSAGE_CTX_FORMAT))
479
480 #if defined(_MSC_VER) && !defined(__INTEL_COMPILER)
481 #pragma warning(disable:4204) /* nonstandard extension used: non-constant aggregate initializer */
482 #define memccpy _memccpy
483 #endif
484
485 #if (defined(_MSC_VER) && !defined(__INTEL_COMPILER)) || defined(__MINGW64__)
486 #define vsnprintf(s, sz, fmt, va) fake_vsnprintf(s, sz, fmt, va)
487 static int fake_vsnprintf(char *s, size_t sz, const char *fmt, va_list ap)
488 {
489 const int n = vsnprintf_s(s, sz, _TRUNCATE, fmt, ap);
490 return 0 < n? n: (int)sz + 1; /* no need in _vscprintf() for now */
491 }
492 #if BT_LOG_OPTIMIZE_SIZE
493 #define snprintf(s, sz, ...) fake_snprintf(s, sz, __VA_ARGS__)
494 static int fake_snprintf(char *s, size_t sz, const char *fmt, ...)
495 {
496 va_list va;
497 va_start(va, fmt);
498 const int n = fake_vsnprintf(s, sz, fmt, va);
499 va_end(va);
500 return n;
501 }
502 #endif
503 #endif
504
505 typedef void (*time_cb)(struct tm *const tm, unsigned *const usec);
506 typedef void (*pid_cb)(int *const pid, int *const tid);
507 typedef void (*buffer_cb)(bt_log_message *msg, char *buf);
508
509 typedef struct src_location
510 {
511 const char *const func;
512 const char *const file;
513 const unsigned line;
514 }
515 src_location;
516
517 typedef struct mem_block
518 {
519 const void *const d;
520 const unsigned d_sz;
521 }
522 mem_block;
523
524 static void time_callback(struct tm *const tm, unsigned *const usec);
525 static void pid_callback(int *const pid, int *const tid);
526 static void buffer_callback(bt_log_message *msg, char *buf);
527
528 STATIC_ASSERT(eol_fits_eol_sz, sizeof(BT_LOG_EOL) <= BT_LOG_EOL_SZ);
529 STATIC_ASSERT(eol_sz_greater_than_zero, 0 < BT_LOG_EOL_SZ);
530 STATIC_ASSERT(eol_sz_less_than_buf_sz, BT_LOG_EOL_SZ < BT_LOG_BUF_SZ);
531 #if !defined(_WIN32) && !defined(_WIN64)
532 STATIC_ASSERT(buf_sz_less_than_pipe_buf, BT_LOG_BUF_SZ <= PIPE_BUF);
533 #endif
534 static const char c_hex[] = "0123456789abcdef";
535
536 static INSTRUMENTED_CONST unsigned g_buf_sz = BT_LOG_BUF_SZ - BT_LOG_EOL_SZ;
537 static INSTRUMENTED_CONST time_cb g_time_cb = time_callback;
538 static INSTRUMENTED_CONST pid_cb g_pid_cb = pid_callback;
539 static INSTRUMENTED_CONST buffer_cb g_buffer_cb = buffer_callback;
540
541 #if BT_LOG_USE_ANDROID_LOG
542 #include <android/log.h>
543
544 static INLINE int android_lvl(const int lvl)
545 {
546 switch (lvl)
547 {
548 case BT_LOG_VERBOSE:
549 return ANDROID_LOG_VERBOSE;
550 case BT_LOG_DEBUG:
551 return ANDROID_LOG_DEBUG;
552 case BT_LOG_INFO:
553 return ANDROID_LOG_INFO;
554 case BT_LOG_WARN:
555 return ANDROID_LOG_WARN;
556 case BT_LOG_ERROR:
557 return ANDROID_LOG_ERROR;
558 case BT_LOG_FATAL:
559 return ANDROID_LOG_FATAL;
560 default:
561 ASSERT_UNREACHABLE("Bad log level");
562 return ANDROID_LOG_UNKNOWN;
563 }
564 }
565
566 static void out_android_callback(const bt_log_message *const msg, void *arg)
567 {
568 VAR_UNUSED(arg);
569 *msg->p = 0;
570 const char *tag = msg->p;
571 if (msg->tag_e != msg->tag_b)
572 {
573 tag = msg->tag_b;
574 *msg->tag_e = 0;
575 }
576 __android_log_print(android_lvl(msg->lvl), tag, "%s", msg->msg_b);
577 }
578
579 enum { OUT_ANDROID_MASK = BT_LOG_PUT_STD & ~BT_LOG_PUT_CTX };
580 #define OUT_ANDROID OUT_ANDROID_MASK, 0, out_android_callback
581 #endif
582
583 #if BT_LOG_USE_NSLOG
584 #include <CoreFoundation/CoreFoundation.h>
585 CF_EXPORT void CFLog(int32_t level, CFStringRef format, ...);
586
587 static INLINE int apple_lvl(const int lvl)
588 {
589 switch (lvl)
590 {
591 case BT_LOG_VERBOSE:
592 return 7; /* ASL_LEVEL_DEBUG / kCFLogLevelDebug */;
593 case BT_LOG_DEBUG:
594 return 7; /* ASL_LEVEL_DEBUG / kCFLogLevelDebug */;
595 case BT_LOG_INFO:
596 return 6; /* ASL_LEVEL_INFO / kCFLogLevelInfo */;
597 case BT_LOG_WARN:
598 return 4; /* ASL_LEVEL_WARNING / kCFLogLevelWarning */;
599 case BT_LOG_ERROR:
600 return 3; /* ASL_LEVEL_ERR / kCFLogLevelError */;
601 case BT_LOG_FATAL:
602 return 0; /* ASL_LEVEL_EMERG / kCFLogLevelEmergency */;
603 default:
604 ASSERT_UNREACHABLE("Bad log level");
605 return 0; /* ASL_LEVEL_EMERG / kCFLogLevelEmergency */;
606 }
607 }
608
609 static void out_nslog_callback(const bt_log_message *const msg, void *arg)
610 {
611 VAR_UNUSED(arg);
612 *msg->p = 0;
613 CFLog(apple_lvl(msg->lvl), CFSTR("%s"), msg->tag_b);
614 }
615
616 enum { OUT_NSLOG_MASK = BT_LOG_PUT_STD & ~BT_LOG_PUT_CTX };
617 #define OUT_NSLOG OUT_NSLOG_MASK, 0, out_nslog_callback
618 #endif
619
620 #if BT_LOG_USE_DEBUGSTRING
621 #include <windows.h>
622
623 static void out_debugstring_callback(const bt_log_message *const msg, void *arg)
624 {
625 VAR_UNUSED(arg);
626 msg->p[0] = '\n';
627 msg->p[1] = '\0';
628 OutputDebugStringA(msg->buf);
629 }
630
631 enum { OUT_DEBUGSTRING_MASK = BT_LOG_PUT_STD };
632 #define OUT_DEBUGSTRING OUT_DEBUGSTRING_MASK, 0, out_debugstring_callback
633 #endif
634
635 BT_HIDDEN
636 void bt_log_out_stderr_callback(const bt_log_message *const msg, void *arg)
637 {
638 VAR_UNUSED(arg);
639 const size_t eol_len = sizeof(BT_LOG_EOL) - 1;
640 memcpy(msg->p, BT_LOG_EOL, eol_len);
641 #if defined(_WIN32) || defined(_WIN64)
642 /* WriteFile() is atomic for local files opened with FILE_APPEND_DATA and
643 without FILE_WRITE_DATA */
644 WriteFile(GetStdHandle(STD_ERROR_HANDLE), msg->buf,
645 (DWORD)(msg->p - msg->buf + eol_len), 0, 0);
646 #else
647 /* write() is atomic for buffers less than or equal to PIPE_BUF. */
648 RETVAL_UNUSED(write(STDERR_FILENO, msg->buf,
649 (size_t)(msg->p - msg->buf) + eol_len));
650 #endif
651 }
652
653 static const bt_log_output out_stderr = {BT_LOG_OUT_STDERR};
654
655 #if !BT_LOG_EXTERN_TAG_PREFIX
656 BT_LOG_DEFINE_TAG_PREFIX = 0;
657 #endif
658
659 #if !BT_LOG_EXTERN_GLOBAL_FORMAT
660 BT_LOG_DEFINE_GLOBAL_FORMAT = {BT_LOG_MEM_WIDTH};
661 #endif
662
663 #if !BT_LOG_EXTERN_GLOBAL_OUTPUT
664 #if BT_LOG_USE_ANDROID_LOG
665 BT_LOG_DEFINE_GLOBAL_OUTPUT = {OUT_ANDROID};
666 #elif BT_LOG_USE_NSLOG
667 BT_LOG_DEFINE_GLOBAL_OUTPUT = {OUT_NSLOG};
668 #elif BT_LOG_USE_DEBUGSTRING
669 BT_LOG_DEFINE_GLOBAL_OUTPUT = {OUT_DEBUGSTRING};
670 #else
671 BT_LOG_DEFINE_GLOBAL_OUTPUT = {BT_LOG_OUT_STDERR};
672 #endif
673 #endif
674
675 #if !BT_LOG_EXTERN_GLOBAL_OUTPUT_LEVEL
676 BT_LOG_DEFINE_GLOBAL_OUTPUT_LEVEL = 0;
677 #endif
678
679 const bt_log_spec _bt_log_stderr_spec =
680 {
681 BT_LOG_GLOBAL_FORMAT,
682 &out_stderr,
683 };
684
685 static const bt_log_spec global_spec =
686 {
687 BT_LOG_GLOBAL_FORMAT,
688 BT_LOG_GLOBAL_OUTPUT,
689 };
690
691 #if _BT_LOG_MESSAGE_FORMAT_CONTAINS(LEVEL, BT_LOG_MESSAGE_CTX_FORMAT)
692 static char lvl_char(const int lvl)
693 {
694 switch (lvl)
695 {
696 case BT_LOG_VERBOSE:
697 return 'V';
698 case BT_LOG_DEBUG:
699 return 'D';
700 case BT_LOG_INFO:
701 return 'I';
702 case BT_LOG_WARN:
703 return 'W';
704 case BT_LOG_ERROR:
705 return 'E';
706 case BT_LOG_FATAL:
707 return 'F';
708 default:
709 ASSERT_UNREACHABLE("Bad log level");
710 return '?';
711 }
712 }
713 #endif
714
715 #define GCCVER_LESS(MAJOR, MINOR, PATCH) \
716 (__GNUC__ < MAJOR || \
717 (__GNUC__ == MAJOR && (__GNUC_MINOR__ < MINOR || \
718 (__GNUC_MINOR__ == MINOR && __GNUC_PATCHLEVEL__ < PATCH))))
719
720 #if !defined(__clang__) && defined(__GNUC__) && GCCVER_LESS(4,7,0)
721 #define __atomic_load_n(vp, model) __sync_fetch_and_add(vp, 0)
722 #define __atomic_fetch_add(vp, n, model) __sync_fetch_and_add(vp, n)
723 #define __atomic_sub_fetch(vp, n, model) __sync_sub_and_fetch(vp, n)
724 #define __atomic_or_fetch(vp, n, model) __sync_or_and_fetch(vp, n)
725 #define __atomic_and_fetch(vp, n, model) __sync_and_and_fetch(vp, n)
726 /* Note: will not store old value of *vp in *ep (non-standard behaviour) */
727 #define __atomic_compare_exchange_n(vp, ep, d, weak, smodel, fmodel) \
728 __sync_bool_compare_and_swap(vp, *(ep), d)
729 #endif
730
731 #if !BT_LOG_OPTIMIZE_SIZE && !defined(_WIN32) && !defined(_WIN64)
732 #define TCACHE
733 #define TCACHE_STALE (0x40000000)
734 #define TCACHE_FLUID (0x40000000 | 0x80000000)
735 static unsigned g_tcache_mode = TCACHE_STALE;
736 static struct timeval g_tcache_tv = {0, 0};
737 static struct tm g_tcache_tm = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
738
739 static INLINE int tcache_get(const struct timeval *const tv, struct tm *const tm)
740 {
741 unsigned mode;
742 mode = __atomic_load_n(&g_tcache_mode, __ATOMIC_RELAXED);
743 if (0 == (mode & TCACHE_FLUID))
744 {
745 mode = __atomic_fetch_add(&g_tcache_mode, 1, __ATOMIC_ACQUIRE);
746 if (0 == (mode & TCACHE_FLUID))
747 {
748 if (g_tcache_tv.tv_sec == tv->tv_sec)
749 {
750 *tm = g_tcache_tm;
751 __atomic_sub_fetch(&g_tcache_mode, 1, __ATOMIC_RELEASE);
752 return !0;
753 }
754 __atomic_or_fetch(&g_tcache_mode, TCACHE_STALE, __ATOMIC_RELAXED);
755 }
756 __atomic_sub_fetch(&g_tcache_mode, 1, __ATOMIC_RELEASE);
757 }
758 return 0;
759 }
760
761 static INLINE void tcache_set(const struct timeval *const tv, struct tm *const tm)
762 {
763 unsigned stale = TCACHE_STALE;
764 if (__atomic_compare_exchange_n(&g_tcache_mode, &stale, TCACHE_FLUID,
765 0, __ATOMIC_ACQUIRE, __ATOMIC_RELAXED))
766 {
767 g_tcache_tv = *tv;
768 g_tcache_tm = *tm;
769 __atomic_and_fetch(&g_tcache_mode, ~TCACHE_FLUID, __ATOMIC_RELEASE);
770 }
771 }
772 #endif
773
774 static void time_callback(struct tm *const tm, unsigned *const msec)
775 {
776 #if !_BT_LOG_MESSAGE_FORMAT_DATETIME_USED
777 VAR_UNUSED(tm);
778 VAR_UNUSED(msec);
779 #else
780 #if defined(_WIN32) || defined(_WIN64)
781 SYSTEMTIME st;
782 GetLocalTime(&st);
783 tm->tm_year = st.wYear;
784 tm->tm_mon = st.wMonth;
785 tm->tm_mday = st.wDay;
786 tm->tm_wday = st.wDayOfWeek;
787 tm->tm_hour = st.wHour;
788 tm->tm_min = st.wMinute;
789 tm->tm_sec = st.wSecond;
790 *msec = st.wMilliseconds;
791 #else
792 struct timeval tv;
793 gettimeofday(&tv, 0);
794 #ifndef TCACHE
795 localtime_r(&tv.tv_sec, tm);
796 #else
797 if (!tcache_get(&tv, tm))
798 {
799 localtime_r(&tv.tv_sec, tm);
800 tcache_set(&tv, tm);
801 }
802 #endif
803 *msec = (unsigned)tv.tv_usec / 1000;
804 #endif
805 #endif
806 }
807
808 static void pid_callback(int *const pid, int *const tid)
809 {
810 #if !_BT_LOG_MESSAGE_FORMAT_CONTAINS(PID, BT_LOG_MESSAGE_CTX_FORMAT)
811 VAR_UNUSED(pid);
812 #else
813 #if defined(_WIN32) || defined(_WIN64)
814 *pid = GetCurrentProcessId();
815 #else
816 *pid = getpid();
817 #endif
818 #endif
819
820 #if !_BT_LOG_MESSAGE_FORMAT_CONTAINS(TID, BT_LOG_MESSAGE_CTX_FORMAT)
821 VAR_UNUSED(tid);
822 #else
823 #if defined(_WIN32) || defined(_WIN64)
824 *tid = GetCurrentThreadId();
825 #elif defined(__ANDROID__)
826 *tid = gettid();
827 #elif defined(__linux__)
828 *tid = syscall(SYS_gettid);
829 #elif defined(__MACH__)
830 *tid = (int)pthread_mach_thread_np(pthread_self());
831 #else
832 #define Platform not supported
833 #endif
834 #endif
835 }
836
837 static void buffer_callback(bt_log_message *msg, char *buf)
838 {
839 msg->e = (msg->p = msg->buf = buf) + g_buf_sz;
840 }
841
842 #if _BT_LOG_MESSAGE_FORMAT_CONTAINS(FUNCTION, BT_LOG_MESSAGE_SRC_FORMAT)
843 static const char *funcname(const char *func)
844 {
845 return func? func: "";
846 }
847 #endif
848
849 #if _BT_LOG_MESSAGE_FORMAT_CONTAINS(FILENAME, BT_LOG_MESSAGE_SRC_FORMAT)
850 static const char *filename(const char *file)
851 {
852 const char *f = file;
853 for (const char *p = file; 0 != *p; ++p)
854 {
855 if ('/' == *p || '\\' == *p)
856 {
857 f = p + 1;
858 }
859 }
860 return f;
861 }
862 #endif
863
864 static INLINE size_t nprintf_size(bt_log_message *const msg)
865 {
866 // *nprintf() always puts 0 in the end when input buffer is not empty. This
867 // 0 is not desired because its presence sets (ctx->p) to (ctx->e - 1) which
868 // leaves space for one more character. Some put_xxx() functions don't use
869 // *nprintf() and could use that last character. In that case log line will
870 // have multiple (two) half-written parts which is confusing. To workaround
871 // that we allow *nprintf() to write its 0 in the eol area (which is always
872 // not empty).
873 return (size_t)(msg->e - msg->p + 1);
874 }
875
876 static INLINE void put_nprintf(bt_log_message *const msg, const int n)
877 {
878 if (0 < n)
879 {
880 msg->p = n < msg->e - msg->p? msg->p + n: msg->e;
881 }
882 }
883
884 static INLINE char *put_padding_r(const unsigned w, const char wc,
885 char *p, char *e)
886 {
887 for (char *const b = e - w; b < p; *--p = wc) {}
888 return p;
889 }
890
891 static char *put_integer_r(unsigned v, const int sign,
892 const unsigned w, const char wc, char *const e)
893 {
894 static const char _signs[] = {'-', '0', '+'};
895 static const char *const signs = _signs + 1;
896 char *p = e;
897 do { *--p = '0' + v % 10; } while (0 != (v /= 10));
898 if (0 == sign) return put_padding_r(w, wc, p, e);
899 if ('0' != wc)
900 {
901 *--p = signs[sign];
902 return put_padding_r(w, wc, p, e);
903 }
904 p = put_padding_r(w, wc, p, e + 1);
905 *--p = signs[sign];
906 return p;
907 }
908
909 static INLINE char *put_uint_r(const unsigned v, const unsigned w, const char wc,
910 char *const e)
911 {
912 return put_integer_r(v, 0, w, wc, e);
913 }
914
915 static INLINE char *put_int_r(const int v, const unsigned w, const char wc,
916 char *const e)
917 {
918 return 0 <= v? put_integer_r((unsigned)v, 0, w, wc, e)
919 : put_integer_r((unsigned)-v, -1, w, wc, e);
920 }
921
922 static INLINE char *put_stringn(const char *const s_p, const char *const s_e,
923 char *const p, char *const e)
924 {
925 const ptrdiff_t m = e - p;
926 ptrdiff_t n = s_e - s_p;
927 if (n > m)
928 {
929 n = m;
930 }
931 memcpy(p, s_p, n);
932 return p + n;
933 }
934
935 static INLINE char *put_string(const char *s, char *p, char *const e)
936 {
937 const ptrdiff_t n = e - p;
938 char *const c = (char *)memccpy(p, s, '\0', n);
939 return 0 != c? c - 1: e;
940 }
941
942 static INLINE char *put_uint(unsigned v, const unsigned w, const char wc,
943 char *const p, char *const e)
944 {
945 char buf[16];
946 char *const se = buf + _countof(buf);
947 char *sp = put_uint_r(v, w, wc, se);
948 return put_stringn(sp, se, p, e);
949 }
950
951 #define PUT_CSTR_R(p, STR) \
952 do { \
953 for (unsigned i = sizeof(STR) - 1; 0 < i--;) { \
954 *--(p) = (STR)[i]; \
955 } \
956 } _BT_LOG_ONCE
957
958 #define PUT_CSTR_CHECKED(p, e, STR) \
959 do { \
960 for (unsigned i = 0; (e) > (p) && (sizeof(STR) - 1) > i; ++i) { \
961 *(p)++ = (STR)[i]; \
962 } \
963 } _BT_LOG_ONCE
964
965 /* F_INIT field support.
966 */
967 #define _BT_LOG_MESSAGE_FORMAT_INIT__
968 #define _BT_LOG_MESSAGE_FORMAT_INIT__YEAR
969 #define _BT_LOG_MESSAGE_FORMAT_INIT__MONTH
970 #define _BT_LOG_MESSAGE_FORMAT_INIT__DAY
971 #define _BT_LOG_MESSAGE_FORMAT_INIT__HOUR
972 #define _BT_LOG_MESSAGE_FORMAT_INIT__MINUTE
973 #define _BT_LOG_MESSAGE_FORMAT_INIT__SECOND
974 #define _BT_LOG_MESSAGE_FORMAT_INIT__MILLISECOND
975 #define _BT_LOG_MESSAGE_FORMAT_INIT__PID
976 #define _BT_LOG_MESSAGE_FORMAT_INIT__TID
977 #define _BT_LOG_MESSAGE_FORMAT_INIT__LEVEL
978 #define _BT_LOG_MESSAGE_FORMAT_INIT__TAG(ps, ts)
979 #define _BT_LOG_MESSAGE_FORMAT_INIT__FUNCTION
980 #define _BT_LOG_MESSAGE_FORMAT_INIT__FILENAME
981 #define _BT_LOG_MESSAGE_FORMAT_INIT__FILELINE
982 #define _BT_LOG_MESSAGE_FORMAT_INIT__S(s)
983 #define _BT_LOG_MESSAGE_FORMAT_INIT__F_INIT(expr) _PP_UNTUPLE(expr);
984 #define _BT_LOG_MESSAGE_FORMAT_INIT__F_UINT(w, v)
985 #define _BT_LOG_MESSAGE_FORMAT_INIT(field) \
986 _PP_CONCAT_3(_BT_LOG_MESSAGE_FORMAT_INIT_, _, field)
987
988 /* Implements generation of printf-like format string for log message
989 * format specification.
990 */
991 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__ ""
992 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__YEAR "%04u"
993 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__MONTH "%02u"
994 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__DAY "%02u"
995 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__HOUR "%02u"
996 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__MINUTE "%02u"
997 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__SECOND "%02u"
998 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__MILLISECOND "%03u"
999 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__PID "%5i"
1000 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__TID "%5i"
1001 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__LEVEL "%c"
1002 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__TAG UNDEFINED
1003 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__FUNCTION "%s"
1004 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__FILENAME "%s"
1005 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__FILELINE "%u"
1006 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__S(s) s
1007 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__F_INIT(expr) ""
1008 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT__F_UINT(w, v) "%" #w "u"
1009 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_FMT(field) \
1010 _PP_CONCAT_3(_BT_LOG_MESSAGE_FORMAT_PRINTF_FMT_, _, field)
1011
1012 /* Implements generation of printf-like format parameters for log message
1013 * format specification.
1014 */
1015 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__
1016 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__YEAR ,(unsigned)(tm.tm_year + 1900)
1017 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__MONTH ,(unsigned)(tm.tm_mon + 1)
1018 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__DAY ,(unsigned)tm.tm_mday
1019 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__HOUR ,(unsigned)tm.tm_hour
1020 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__MINUTE ,(unsigned)tm.tm_min
1021 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__SECOND ,(unsigned)tm.tm_sec
1022 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__MILLISECOND ,(unsigned)msec
1023 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__PID ,pid
1024 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__TID ,tid
1025 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__LEVEL ,(char)lvl_char(msg->lvl)
1026 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__TAG UNDEFINED
1027 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__FUNCTION ,funcname(src->func)
1028 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__FILENAME ,filename(src->file)
1029 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__FILELINE ,src->line
1030 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__S(s)
1031 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__F_INIT(expr)
1032 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL__F_UINT(w, v) ,v
1033 #define _BT_LOG_MESSAGE_FORMAT_PRINTF_VAL(field) \
1034 _PP_CONCAT_3(_BT_LOG_MESSAGE_FORMAT_PRINTF_VAL_, _, field)
1035
1036 /* Implements generation of put_xxx_t statements for log message specification.
1037 */
1038 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__
1039 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__YEAR p = put_uint_r(tm.tm_year + 1900, 4, '0', p);
1040 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__MONTH p = put_uint_r((unsigned)tm.tm_mon + 1, 2, '0', p);
1041 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__DAY p = put_uint_r((unsigned)tm.tm_mday, 2, '0', p);
1042 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__HOUR p = put_uint_r((unsigned)tm.tm_hour, 2, '0', p);
1043 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__MINUTE p = put_uint_r((unsigned)tm.tm_min, 2, '0', p);
1044 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__SECOND p = put_uint_r((unsigned)tm.tm_sec, 2, '0', p);
1045 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__MILLISECOND p = put_uint_r(msec, 3, '0', p);
1046 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__PID p = put_int_r(pid, 5, ' ', p);
1047 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__TID p = put_int_r(tid, 5, ' ', p);
1048 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__LEVEL *--p = lvl_char(msg->lvl);
1049 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__TAG UNDEFINED
1050 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__FUNCTION UNDEFINED
1051 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__FILENAME UNDEFINED
1052 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__FILELINE UNDEFINED
1053 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__S(s) PUT_CSTR_R(p, s);
1054 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__F_INIT(expr)
1055 #define _BT_LOG_MESSAGE_FORMAT_PUT_R__F_UINT(w, v) p = put_uint_r(v, w, ' ', p);
1056 #define _BT_LOG_MESSAGE_FORMAT_PUT_R(field) \
1057 _PP_CONCAT_3(_BT_LOG_MESSAGE_FORMAT_PUT_R_, _, field)
1058
1059 static void put_ctx(bt_log_message *const msg)
1060 {
1061 _PP_MAP(_BT_LOG_MESSAGE_FORMAT_INIT, BT_LOG_MESSAGE_CTX_FORMAT)
1062 #if !_BT_LOG_MESSAGE_FORMAT_FIELDS(BT_LOG_MESSAGE_CTX_FORMAT)
1063 VAR_UNUSED(msg);
1064 #else
1065 #if _BT_LOG_MESSAGE_FORMAT_DATETIME_USED
1066 struct tm tm;
1067 unsigned msec;
1068 g_time_cb(&tm, &msec);
1069 #endif
1070 #if _BT_LOG_MESSAGE_FORMAT_CONTAINS(PID, BT_LOG_MESSAGE_CTX_FORMAT) || \
1071 _BT_LOG_MESSAGE_FORMAT_CONTAINS(TID, BT_LOG_MESSAGE_CTX_FORMAT)
1072 int pid, tid;
1073 g_pid_cb(&pid, &tid);
1074 #endif
1075
1076 #if BT_LOG_OPTIMIZE_SIZE
1077 int n;
1078 n = snprintf(msg->p, nprintf_size(msg),
1079 _PP_MAP(_BT_LOG_MESSAGE_FORMAT_PRINTF_FMT, BT_LOG_MESSAGE_CTX_FORMAT)
1080 _PP_MAP(_BT_LOG_MESSAGE_FORMAT_PRINTF_VAL, BT_LOG_MESSAGE_CTX_FORMAT));
1081 put_nprintf(msg, n);
1082 #else
1083 char buf[64];
1084 char *const e = buf + sizeof(buf);
1085 char *p = e;
1086 _PP_RMAP(_BT_LOG_MESSAGE_FORMAT_PUT_R, BT_LOG_MESSAGE_CTX_FORMAT)
1087 msg->p = put_stringn(p, e, msg->p, msg->e);
1088 #endif
1089 #endif
1090 }
1091
1092 #define PUT_TAG(msg, tag, prefix_delim, tag_delim) \
1093 do { \
1094 const char *ch; \
1095 msg->tag_b = msg->p; \
1096 if (0 != (ch = _bt_log_tag_prefix)) { \
1097 for (;msg->e != msg->p && 0 != (*msg->p = *ch); ++msg->p, ++ch) {} \
1098 } \
1099 if (0 != (ch = tag) && 0 != tag[0]) { \
1100 if (msg->tag_b != msg->p) { \
1101 PUT_CSTR_CHECKED(msg->p, msg->e, prefix_delim); \
1102 } \
1103 for (;msg->e != msg->p && 0 != (*msg->p = *ch); ++msg->p, ++ch) {} \
1104 } \
1105 msg->tag_e = msg->p; \
1106 if (msg->tag_b != msg->p) { \
1107 PUT_CSTR_CHECKED(msg->p, msg->e, tag_delim); \
1108 } \
1109 } _BT_LOG_ONCE
1110
1111 /* Implements simple put statements for log message specification.
1112 */
1113 #define _BT_LOG_MESSAGE_FORMAT_PUT__
1114 #define _BT_LOG_MESSAGE_FORMAT_PUT__YEAR UNDEFINED
1115 #define _BT_LOG_MESSAGE_FORMAT_PUT__MONTH UNDEFINED
1116 #define _BT_LOG_MESSAGE_FORMAT_PUT__DAY UNDEFINED
1117 #define _BT_LOG_MESSAGE_FORMAT_PUT__HOUR UNDEFINED
1118 #define _BT_LOG_MESSAGE_FORMAT_PUT__MINUTE UNDEFINED
1119 #define _BT_LOG_MESSAGE_FORMAT_PUT__SECOND UNDEFINED
1120 #define _BT_LOG_MESSAGE_FORMAT_PUT__MILLISECOND UNDEFINED
1121 #define _BT_LOG_MESSAGE_FORMAT_PUT__PID UNDEFINED
1122 #define _BT_LOG_MESSAGE_FORMAT_PUT__TID UNDEFINED
1123 #define _BT_LOG_MESSAGE_FORMAT_PUT__LEVEL UNDEFINED
1124 #define _BT_LOG_MESSAGE_FORMAT_PUT__TAG(pd, td) PUT_TAG(msg, tag, pd, td);
1125 #define _BT_LOG_MESSAGE_FORMAT_PUT__FUNCTION msg->p = put_string(funcname(src->func), msg->p, msg->e);
1126 #define _BT_LOG_MESSAGE_FORMAT_PUT__FILENAME msg->p = put_string(filename(src->file), msg->p, msg->e);
1127 #define _BT_LOG_MESSAGE_FORMAT_PUT__FILELINE msg->p = put_uint(src->line, 0, '\0', msg->p, msg->e);
1128 #define _BT_LOG_MESSAGE_FORMAT_PUT__S(s) PUT_CSTR_CHECKED(msg->p, msg->e, s);
1129 #define _BT_LOG_MESSAGE_FORMAT_PUT__F_INIT(expr)
1130 #define _BT_LOG_MESSAGE_FORMAT_PUT__F_UINT(w, v) msg->p = put_uint(v, w, ' ', msg->p, msg->e);
1131 #define _BT_LOG_MESSAGE_FORMAT_PUT(field) \
1132 _PP_CONCAT_3(_BT_LOG_MESSAGE_FORMAT_PUT_, _, field)
1133
1134 static void put_tag(bt_log_message *const msg, const char *const tag)
1135 {
1136 _PP_MAP(_BT_LOG_MESSAGE_FORMAT_INIT, BT_LOG_MESSAGE_TAG_FORMAT)
1137 #if !_BT_LOG_MESSAGE_FORMAT_CONTAINS(TAG, BT_LOG_MESSAGE_TAG_FORMAT)
1138 VAR_UNUSED(tag);
1139 #endif
1140 #if !_BT_LOG_MESSAGE_FORMAT_FIELDS(BT_LOG_MESSAGE_TAG_FORMAT)
1141 VAR_UNUSED(msg);
1142 #else
1143 _PP_MAP(_BT_LOG_MESSAGE_FORMAT_PUT, BT_LOG_MESSAGE_TAG_FORMAT)
1144 #endif
1145 }
1146
1147 static void put_src(bt_log_message *const msg, const src_location *const src)
1148 {
1149 _PP_MAP(_BT_LOG_MESSAGE_FORMAT_INIT, BT_LOG_MESSAGE_SRC_FORMAT)
1150 #if !_BT_LOG_MESSAGE_FORMAT_CONTAINS(FUNCTION, BT_LOG_MESSAGE_SRC_FORMAT) && \
1151 !_BT_LOG_MESSAGE_FORMAT_CONTAINS(FILENAME, BT_LOG_MESSAGE_SRC_FORMAT) && \
1152 !_BT_LOG_MESSAGE_FORMAT_CONTAINS(FILELINE, BT_LOG_MESSAGE_SRC_FORMAT)
1153 VAR_UNUSED(src);
1154 #endif
1155 #if !_BT_LOG_MESSAGE_FORMAT_FIELDS(BT_LOG_MESSAGE_SRC_FORMAT)
1156 VAR_UNUSED(msg);
1157 #else
1158 #if BT_LOG_OPTIMIZE_SIZE
1159 int n;
1160 n = snprintf(msg->p, nprintf_size(msg),
1161 _PP_MAP(_BT_LOG_MESSAGE_FORMAT_PRINTF_FMT, BT_LOG_MESSAGE_SRC_FORMAT)
1162 _PP_MAP(_BT_LOG_MESSAGE_FORMAT_PRINTF_VAL, BT_LOG_MESSAGE_SRC_FORMAT));
1163 put_nprintf(msg, n);
1164 #else
1165 _PP_MAP(_BT_LOG_MESSAGE_FORMAT_PUT, BT_LOG_MESSAGE_SRC_FORMAT)
1166 #endif
1167 #endif
1168 }
1169
1170 static void put_msg(bt_log_message *const msg,
1171 const char *const fmt, va_list va)
1172 {
1173 int n;
1174 msg->msg_b = msg->p;
1175 n = vsnprintf(msg->p, nprintf_size(msg), fmt, va);
1176 put_nprintf(msg, n);
1177 }
1178
1179 static void output_mem(const bt_log_spec *log, bt_log_message *const msg,
1180 const mem_block *const mem)
1181 {
1182 if (0 == mem->d || 0 == mem->d_sz)
1183 {
1184 return;
1185 }
1186 const unsigned char *mem_p = (const unsigned char *)mem->d;
1187 const unsigned char *const mem_e = mem_p + mem->d_sz;
1188 const unsigned char *mem_cut;
1189 const ptrdiff_t mem_width = (ptrdiff_t)log->format->mem_width;
1190 char *const hex_b = msg->msg_b;
1191 char *const ascii_b = hex_b + 2 * mem_width + 2;
1192 char *const ascii_e = ascii_b + mem_width;
1193 if (msg->e < ascii_e)
1194 {
1195 return;
1196 }
1197 while (mem_p != mem_e)
1198 {
1199 char *hex = hex_b;
1200 char *ascii = ascii_b;
1201 for (mem_cut = mem_width < mem_e - mem_p? mem_p + mem_width: mem_e;
1202 mem_cut != mem_p; ++mem_p)
1203 {
1204 const unsigned char ch = *mem_p;
1205 *hex++ = c_hex[(0xf0 & ch) >> 4];
1206 *hex++ = c_hex[(0x0f & ch)];
1207 *ascii++ = isprint(ch)? (char)ch: '?';
1208 }
1209 while (hex != ascii_b)
1210 {
1211 *hex++ = ' ';
1212 }
1213 msg->p = ascii;
1214 log->output->callback(msg, log->output->arg);
1215 }
1216 }
1217
1218 BT_HIDDEN
1219 void bt_log_set_tag_prefix(const char *const prefix)
1220 {
1221 _bt_log_tag_prefix = prefix;
1222 }
1223
1224 BT_HIDDEN
1225 void bt_log_set_mem_width(const unsigned w)
1226 {
1227 _bt_log_global_format.mem_width = w;
1228 }
1229
1230 BT_HIDDEN
1231 void bt_log_set_output_level(const int lvl)
1232 {
1233 _bt_log_global_output_lvl = lvl;
1234 }
1235
1236 BT_HIDDEN
1237 void bt_log_set_output_v(const unsigned mask, void *const arg,
1238 const bt_log_output_cb callback)
1239 {
1240 _bt_log_global_output.mask = mask;
1241 _bt_log_global_output.arg = arg;
1242 _bt_log_global_output.callback = callback;
1243 }
1244
1245 static void _bt_log_write_imp(
1246 const bt_log_spec *log,
1247 const src_location *const src, const mem_block *const mem,
1248 const int lvl, const char *const tag, const char *const fmt, va_list va)
1249 {
1250 bt_log_message msg;
1251 char buf[BT_LOG_BUF_SZ];
1252 const unsigned mask = log->output->mask;
1253 msg.lvl = lvl;
1254 msg.tag = tag;
1255 g_buffer_cb(&msg, buf);
1256 if (BT_LOG_PUT_CTX & mask)
1257 {
1258 put_ctx(&msg);
1259 }
1260 if (BT_LOG_PUT_TAG & mask)
1261 {
1262 put_tag(&msg, tag);
1263 }
1264 if (0 != src && BT_LOG_PUT_SRC & mask)
1265 {
1266 put_src(&msg, src);
1267 }
1268 if (BT_LOG_PUT_MSG & mask)
1269 {
1270 put_msg(&msg, fmt, va);
1271 }
1272 log->output->callback(&msg, log->output->arg);
1273 if (0 != mem && BT_LOG_PUT_MSG & mask)
1274 {
1275 output_mem(log, &msg, mem);
1276 }
1277 }
1278
1279 BT_HIDDEN
1280 void _bt_log_write_d(
1281 const char *const func, const char *const file, const unsigned line,
1282 const int lvl, const char *const tag,
1283 const char *const fmt, ...)
1284 {
1285 const src_location src = {func, file, line};
1286 va_list va;
1287 va_start(va, fmt);
1288 _bt_log_write_imp(&global_spec, &src, 0, lvl, tag, fmt, va);
1289 va_end(va);
1290 }
1291
1292 BT_HIDDEN
1293 void _bt_log_write_aux_d(
1294 const char *const func, const char *const file, const unsigned line,
1295 const bt_log_spec *const log, const int lvl, const char *const tag,
1296 const char *const fmt, ...)
1297 {
1298 const src_location src = {func, file, line};
1299 va_list va;
1300 va_start(va, fmt);
1301 _bt_log_write_imp(log, &src, 0, lvl, tag, fmt, va);
1302 va_end(va);
1303 }
1304
1305 BT_HIDDEN
1306 void _bt_log_write(const int lvl, const char *const tag,
1307 const char *const fmt, ...)
1308 {
1309 va_list va;
1310 va_start(va, fmt);
1311 _bt_log_write_imp(&global_spec, 0, 0, lvl, tag, fmt, va);
1312 va_end(va);
1313 }
1314
1315 BT_HIDDEN
1316 void _bt_log_write_aux(
1317 const bt_log_spec *const log, const int lvl, const char *const tag,
1318 const char *const fmt, ...)
1319 {
1320 va_list va;
1321 va_start(va, fmt);
1322 _bt_log_write_imp(log, 0, 0, lvl, tag, fmt, va);
1323 va_end(va);
1324 }
1325
1326 BT_HIDDEN
1327 void _bt_log_write_mem_d(
1328 const char *const func, const char *const file, const unsigned line,
1329 const int lvl, const char *const tag,
1330 const void *const d, const unsigned d_sz,
1331 const char *const fmt, ...)
1332 {
1333 const src_location src = {func, file, line};
1334 const mem_block mem = {d, d_sz};
1335 va_list va;
1336 va_start(va, fmt);
1337 _bt_log_write_imp(&global_spec, &src, &mem, lvl, tag, fmt, va);
1338 va_end(va);
1339 }
1340
1341 BT_HIDDEN
1342 void _bt_log_write_mem_aux_d(
1343 const char *const func, const char *const file, const unsigned line,
1344 const bt_log_spec *const log, const int lvl, const char *const tag,
1345 const void *const d, const unsigned d_sz,
1346 const char *const fmt, ...)
1347 {
1348 const src_location src = {func, file, line};
1349 const mem_block mem = {d, d_sz};
1350 va_list va;
1351 va_start(va, fmt);
1352 _bt_log_write_imp(log, &src, &mem, lvl, tag, fmt, va);
1353 va_end(va);
1354 }
1355
1356 BT_HIDDEN
1357 void _bt_log_write_mem(const int lvl, const char *const tag,
1358 const void *const d, const unsigned d_sz,
1359 const char *const fmt, ...)
1360 {
1361 const mem_block mem = {d, d_sz};
1362 va_list va;
1363 va_start(va, fmt);
1364 _bt_log_write_imp(&global_spec, 0, &mem, lvl, tag, fmt, va);
1365 va_end(va);
1366 }
1367
1368 BT_HIDDEN
1369 void _bt_log_write_mem_aux(
1370 const bt_log_spec *const log, const int lvl, const char *const tag,
1371 const void *const d, const unsigned d_sz,
1372 const char *const fmt, ...)
1373 {
1374 const mem_block mem = {d, d_sz};
1375 va_list va;
1376 va_start(va, fmt);
1377 _bt_log_write_imp(log, 0, &mem, lvl, tag, fmt, va);
1378 va_end(va);
1379 }
BabelTrace - Trace Format Babel Tower
This page took 0.083853 seconds and 5 git commands to generate.