Commit | Line | Data |
---|---|---|
beb0fb75 | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
beb0fb75 | 3 | * |
0235b0db | 4 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
beb0fb75 PP |
5 | */ |
6 | ||
0235b0db MJ |
7 | #ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H |
8 | #define BABELTRACE_LIB_LOGGING_INTERNAL_H | |
9 | ||
91d81473 | 10 | #include "common/macros.h" |
476ef981 | 11 | #include <stdarg.h> |
beb0fb75 | 12 | |
44c440bc PP |
13 | #ifndef BT_LOG_TAG |
14 | # error Please define a tag with BT_LOG_TAG before including this file. | |
15 | #endif | |
16 | ||
beb0fb75 PP |
17 | #define BT_LOG_OUTPUT_LEVEL bt_lib_log_level |
18 | ||
578e048b | 19 | #include "logging/log.h" |
beb0fb75 | 20 | |
d5becf10 FD |
21 | #define BT_LIB_LOG_LIBBABELTRACE2_NAME "libbabeltrace2" |
22 | ||
61d6f9b1 | 23 | extern |
beb0fb75 PP |
24 | int bt_lib_log_level; |
25 | ||
3dca2276 PP |
26 | #define BT_LIB_LOG(_lvl, _fmt, ...) \ |
27 | do { \ | |
28 | if (BT_LOG_ON(_lvl)) { \ | |
29 | bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \ | |
30 | __LINE__, _lvl, _BT_LOG_TAG, \ | |
31 | (_fmt), ##__VA_ARGS__); \ | |
32 | } \ | |
33 | } while (0) | |
34 | ||
b359e350 | 35 | /* See `CONTRIBUTING.adoc` for usage */ |
476ef981 PP |
36 | #define BT_LIB_LOGF(_fmt, ...) BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__) |
37 | #define BT_LIB_LOGE(_fmt, ...) BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__) | |
770538dd | 38 | #define BT_LIB_LOGW(_fmt, ...) BT_LIB_LOG(BT_LOG_WARNING, _fmt, ##__VA_ARGS__) |
476ef981 PP |
39 | #define BT_LIB_LOGI(_fmt, ...) BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__) |
40 | #define BT_LIB_LOGD(_fmt, ...) BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__) | |
ef267d12 | 41 | #define BT_LIB_LOGT(_fmt, ...) BT_LIB_LOG(BT_LOG_TRACE, _fmt, ##__VA_ARGS__) |
476ef981 PP |
42 | |
43 | /* | |
44 | * Log statement, specialized for the Babeltrace library. | |
45 | * | |
3cd4c495 PP |
46 | * This function does NOT check that logging is enabled for level `lvl`: |
47 | * you must check it manually with BT_LOG_ON(). | |
48 | * | |
49 | * Use one of the BT_LIB_LOG*() macros above instead of calling this | |
476ef981 | 50 | * function directly. |
ddccb6ce SM |
51 | * |
52 | * This function would normally be BT_HIDDEN, but it is used by the Python | |
53 | * plugin provider, which is conceptually part of libbabeltrace2, but | |
54 | * implemented as a separate shared object, for modularity. It is therefore | |
55 | * exposed, but not part of the public ABI. | |
476ef981 | 56 | */ |
476ef981 PP |
57 | void bt_lib_log(const char *func, const char *file, unsigned line, |
58 | int lvl, const char *tag, const char *fmt, ...); | |
59 | ||
e020d134 PP |
60 | void bt_lib_log_v(const char *func, const char *file, unsigned line, |
61 | int lvl, const char *tag, const char *fmt, va_list *args); | |
62 | ||
3cd4c495 PP |
63 | #define BT_LIB_LOG_AND_APPEND(_lvl, _fmt, ...) \ |
64 | do { \ | |
65 | bt_lib_maybe_log_and_append_cause( \ | |
66 | _BT_LOG_SRCLOC_FUNCTION, __FILE__, \ | |
67 | __LINE__, _lvl, _BT_LOG_TAG, \ | |
68 | (_fmt), ##__VA_ARGS__); \ | |
69 | } while (0) | |
70 | ||
71 | /* See `CONTRIBUTING.adoc` for usage */ | |
72 | #define BT_LIB_LOGE_APPEND_CAUSE(_fmt, ...) \ | |
73 | BT_LIB_LOG_AND_APPEND(BT_LOG_ERROR, _fmt, ##__VA_ARGS__) | |
74 | #define BT_LIB_LOGW_APPEND_CAUSE(_fmt, ...) \ | |
770538dd | 75 | BT_LIB_LOG_AND_APPEND(BT_LOG_WARNING, _fmt, ##__VA_ARGS__) |
3cd4c495 PP |
76 | |
77 | /* | |
78 | * Like bt_lib_log(), but also appends a cause to the current thread's | |
79 | * error object. | |
80 | * | |
81 | * Note that, unlike bt_lib_log(), this function does check that logging | |
82 | * is enabled for level `lvl` before logging. This is to ensure that, | |
83 | * even though logging is disabled, the function still appends an error | |
84 | * cause, as the error reporting system does not rely on logging. | |
85 | * | |
86 | * Use one of the BT_LIB_LOG*_APPEND_CAUSE() macros above instead of | |
87 | * calling this function directly. | |
ddccb6ce SM |
88 | * |
89 | * This function would normally be BT_HIDDEN, but it is used by the Python | |
90 | * plugin provider, which is conceptually part of libbabeltrace2, but | |
91 | * implemented as a separate shared object, for modularity. It is therefore | |
92 | * exposed, but not part of the ABI. | |
3cd4c495 PP |
93 | */ |
94 | void bt_lib_maybe_log_and_append_cause(const char *func, const char *file, | |
95 | unsigned line, int lvl, const char *tag, | |
96 | const char *fmt, ...); | |
97 | ||
7151fb67 PP |
98 | #define BT_LIB_LOG_SUPPORTED |
99 | ||
beb0fb75 | 100 | #endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */ |