lib: add internal BT_LIB_LOG*_APPEND_CAUSE() macros
[babeltrace.git] / src / lib / logging.h
CommitLineData
beb0fb75
PP
1#ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
2#define BABELTRACE_LIB_LOGGING_INTERNAL_H
3
4/*
e2f7325d 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
91d81473 26#include "common/macros.h"
476ef981 27#include <stdarg.h>
beb0fb75 28
44c440bc
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
578e048b 35#include "logging/log.h"
beb0fb75 36
61d6f9b1 37extern
beb0fb75
PP
38int bt_lib_log_level;
39
3dca2276
PP
40#define BT_LIB_LOG(_lvl, _fmt, ...) \
41 do { \
42 if (BT_LOG_ON(_lvl)) { \
43 bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__, \
44 __LINE__, _lvl, _BT_LOG_TAG, \
45 (_fmt), ##__VA_ARGS__); \
46 } \
47 } while (0)
48
b359e350 49/* See `CONTRIBUTING.adoc` for usage */
476ef981
PP
50#define BT_LIB_LOGF(_fmt, ...) BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__)
51#define BT_LIB_LOGE(_fmt, ...) BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
52#define BT_LIB_LOGW(_fmt, ...) BT_LIB_LOG(BT_LOG_WARN, _fmt, ##__VA_ARGS__)
53#define BT_LIB_LOGI(_fmt, ...) BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__)
54#define BT_LIB_LOGD(_fmt, ...) BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__)
ef267d12 55#define BT_LIB_LOGT(_fmt, ...) BT_LIB_LOG(BT_LOG_TRACE, _fmt, ##__VA_ARGS__)
476ef981
PP
56
57/*
58 * Log statement, specialized for the Babeltrace library.
59 *
3cd4c495
PP
60 * This function does NOT check that logging is enabled for level `lvl`:
61 * you must check it manually with BT_LOG_ON().
62 *
63 * Use one of the BT_LIB_LOG*() macros above instead of calling this
476ef981
PP
64 * function directly.
65 */
476ef981
PP
66void bt_lib_log(const char *func, const char *file, unsigned line,
67 int lvl, const char *tag, const char *fmt, ...);
68
3cd4c495
PP
69#define BT_LIB_LOG_AND_APPEND(_lvl, _fmt, ...) \
70 do { \
71 bt_lib_maybe_log_and_append_cause( \
72 _BT_LOG_SRCLOC_FUNCTION, __FILE__, \
73 __LINE__, _lvl, _BT_LOG_TAG, \
74 (_fmt), ##__VA_ARGS__); \
75 } while (0)
76
77/* See `CONTRIBUTING.adoc` for usage */
78#define BT_LIB_LOGE_APPEND_CAUSE(_fmt, ...) \
79 BT_LIB_LOG_AND_APPEND(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
80#define BT_LIB_LOGW_APPEND_CAUSE(_fmt, ...) \
81 BT_LIB_LOG_AND_APPEND(BT_LOG_WARN, _fmt, ##__VA_ARGS__)
82
83/*
84 * Like bt_lib_log(), but also appends a cause to the current thread's
85 * error object.
86 *
87 * Note that, unlike bt_lib_log(), this function does check that logging
88 * is enabled for level `lvl` before logging. This is to ensure that,
89 * even though logging is disabled, the function still appends an error
90 * cause, as the error reporting system does not rely on logging.
91 *
92 * Use one of the BT_LIB_LOG*_APPEND_CAUSE() macros above instead of
93 * calling this function directly.
94 */
95void bt_lib_maybe_log_and_append_cause(const char *func, const char *file,
96 unsigned line, int lvl, const char *tag,
97 const char *fmt, ...);
98
7151fb67
PP
99#define BT_LIB_LOG_SUPPORTED
100
beb0fb75 101#endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */
This page took 0.05307 seconds and 4 git commands to generate.