Commit | Line | Data |
---|---|---|
beb0fb75 PP |
1 | #ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H |
2 | #define BABELTRACE_LIB_LOGGING_INTERNAL_H | |
3 | ||
4 | /* | |
f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
beb0fb75 PP |
6 | * |
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
8 | * of this software and associated documentation files (the "Software"), to deal | |
9 | * in the Software without restriction, including without limitation the rights | |
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
11 | * copies of the Software, and to permit persons to whom the Software is | |
12 | * furnished to do so, subject to the following conditions: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in | |
15 | * all copies or substantial portions of the Software. | |
16 | * | |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
23 | * SOFTWARE. | |
24 | */ | |
25 | ||
85e7137b | 26 | #include "common/macros.h" |
57ffc2f1 | 27 | #include <stdarg.h> |
beb0fb75 | 28 | |
7b33a0e0 PP |
29 | #ifndef BT_LOG_TAG |
30 | # error Please define a tag with BT_LOG_TAG before including this file. | |
31 | #endif | |
32 | ||
beb0fb75 PP |
33 | #define BT_LOG_OUTPUT_LEVEL bt_lib_log_level |
34 | ||
57952005 | 35 | #include "logging/log.h" |
beb0fb75 | 36 | |
37996f2f FD |
37 | #define BT_LIB_LOG_LIBBABELTRACE2_NAME "libbabeltrace2" |
38 | ||
b7c70610 | 39 | extern |
beb0fb75 PP |
40 | int bt_lib_log_level; |
41 | ||
8deee039 PP |
42 | #define BT_LIB_LOG(_lvl, _fmt, ...) \ |
43 | do { \ | |
44 | if (BT_LOG_ON(_lvl)) { \ | |
45 | bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \ | |
46 | __LINE__, _lvl, _BT_LOG_TAG, \ | |
47 | (_fmt), ##__VA_ARGS__); \ | |
48 | } \ | |
49 | } while (0) | |
50 | ||
d2d4608f | 51 | /* See `CONTRIBUTING.adoc` for usage */ |
57ffc2f1 PP |
52 | #define BT_LIB_LOGF(_fmt, ...) BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__) |
53 | #define BT_LIB_LOGE(_fmt, ...) BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__) | |
e9d0e821 | 54 | #define BT_LIB_LOGW(_fmt, ...) BT_LIB_LOG(BT_LOG_WARNING, _fmt, ##__VA_ARGS__) |
57ffc2f1 PP |
55 | #define BT_LIB_LOGI(_fmt, ...) BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__) |
56 | #define BT_LIB_LOGD(_fmt, ...) BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__) | |
c9ecaa78 | 57 | #define BT_LIB_LOGT(_fmt, ...) BT_LIB_LOG(BT_LOG_TRACE, _fmt, ##__VA_ARGS__) |
57ffc2f1 PP |
58 | |
59 | /* | |
60 | * Log statement, specialized for the Babeltrace library. | |
61 | * | |
30e5d453 PP |
62 | * This function does NOT check that logging is enabled for level `lvl`: |
63 | * you must check it manually with BT_LOG_ON(). | |
64 | * | |
65 | * Use one of the BT_LIB_LOG*() macros above instead of calling this | |
57ffc2f1 PP |
66 | * function directly. |
67 | */ | |
57ffc2f1 PP |
68 | void bt_lib_log(const char *func, const char *file, unsigned line, |
69 | int lvl, const char *tag, const char *fmt, ...); | |
70 | ||
30e5d453 PP |
71 | #define BT_LIB_LOG_AND_APPEND(_lvl, _fmt, ...) \ |
72 | do { \ | |
73 | bt_lib_maybe_log_and_append_cause( \ | |
74 | _BT_LOG_SRCLOC_FUNCTION, __FILE__, \ | |
75 | __LINE__, _lvl, _BT_LOG_TAG, \ | |
76 | (_fmt), ##__VA_ARGS__); \ | |
77 | } while (0) | |
78 | ||
79 | /* See `CONTRIBUTING.adoc` for usage */ | |
80 | #define BT_LIB_LOGE_APPEND_CAUSE(_fmt, ...) \ | |
81 | BT_LIB_LOG_AND_APPEND(BT_LOG_ERROR, _fmt, ##__VA_ARGS__) | |
82 | #define BT_LIB_LOGW_APPEND_CAUSE(_fmt, ...) \ | |
e9d0e821 | 83 | BT_LIB_LOG_AND_APPEND(BT_LOG_WARNING, _fmt, ##__VA_ARGS__) |
30e5d453 PP |
84 | |
85 | /* | |
86 | * Like bt_lib_log(), but also appends a cause to the current thread's | |
87 | * error object. | |
88 | * | |
89 | * Note that, unlike bt_lib_log(), this function does check that logging | |
90 | * is enabled for level `lvl` before logging. This is to ensure that, | |
91 | * even though logging is disabled, the function still appends an error | |
92 | * cause, as the error reporting system does not rely on logging. | |
93 | * | |
94 | * Use one of the BT_LIB_LOG*_APPEND_CAUSE() macros above instead of | |
95 | * calling this function directly. | |
96 | */ | |
97 | void bt_lib_maybe_log_and_append_cause(const char *func, const char *file, | |
98 | unsigned line, int lvl, const char *tag, | |
99 | const char *fmt, ...); | |
100 | ||
ebb4875d PP |
101 | #define BT_LIB_LOG_SUPPORTED |
102 | ||
beb0fb75 | 103 | #endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */ |