lib: remove unused includes
[babeltrace.git] / src / lib / logging.h
CommitLineData
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
476ef981 10#include <stdarg.h>
beb0fb75 11
44c440bc
PP
12#ifndef BT_LOG_TAG
13# error Please define a tag with BT_LOG_TAG before including this file.
14#endif
15
beb0fb75
PP
16#define BT_LOG_OUTPUT_LEVEL bt_lib_log_level
17
578e048b 18#include "logging/log.h"
beb0fb75 19
d5becf10
FD
20#define BT_LIB_LOG_LIBBABELTRACE2_NAME "libbabeltrace2"
21
61d6f9b1 22extern
beb0fb75
PP
23int bt_lib_log_level;
24
3dca2276
PP
25#define BT_LIB_LOG(_lvl, _fmt, ...) \
26 do { \
27 if (BT_LOG_ON(_lvl)) { \
71436ae4 28 bt_lib_log(__FILE__, __func__, \
3dca2276
PP
29 __LINE__, _lvl, _BT_LOG_TAG, \
30 (_fmt), ##__VA_ARGS__); \
31 } \
32 } while (0)
33
b359e350 34/* See `CONTRIBUTING.adoc` for usage */
476ef981
PP
35#define BT_LIB_LOGF(_fmt, ...) BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__)
36#define BT_LIB_LOGE(_fmt, ...) BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
770538dd 37#define BT_LIB_LOGW(_fmt, ...) BT_LIB_LOG(BT_LOG_WARNING, _fmt, ##__VA_ARGS__)
476ef981
PP
38#define BT_LIB_LOGI(_fmt, ...) BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__)
39#define BT_LIB_LOGD(_fmt, ...) BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__)
ef267d12 40#define BT_LIB_LOGT(_fmt, ...) BT_LIB_LOG(BT_LOG_TRACE, _fmt, ##__VA_ARGS__)
476ef981
PP
41
42/*
43 * Log statement, specialized for the Babeltrace library.
44 *
3cd4c495
PP
45 * This function does NOT check that logging is enabled for level `lvl`:
46 * you must check it manually with BT_LOG_ON().
47 *
48 * Use one of the BT_LIB_LOG*() macros above instead of calling this
476ef981
PP
49 * function directly.
50 */
71436ae4 51void bt_lib_log(const char *file, const char *func, unsigned line,
476ef981
PP
52 int lvl, const char *tag, const char *fmt, ...);
53
71436ae4 54void bt_lib_log_v(const char *file, const char *func, unsigned line,
e020d134
PP
55 int lvl, const char *tag, const char *fmt, va_list *args);
56
3cd4c495
PP
57#define BT_LIB_LOG_AND_APPEND(_lvl, _fmt, ...) \
58 do { \
59 bt_lib_maybe_log_and_append_cause( \
71436ae4 60 __func__, __FILE__, \
3cd4c495
PP
61 __LINE__, _lvl, _BT_LOG_TAG, \
62 (_fmt), ##__VA_ARGS__); \
63 } while (0)
64
65/* See `CONTRIBUTING.adoc` for usage */
66#define BT_LIB_LOGE_APPEND_CAUSE(_fmt, ...) \
67 BT_LIB_LOG_AND_APPEND(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
68#define BT_LIB_LOGW_APPEND_CAUSE(_fmt, ...) \
770538dd 69 BT_LIB_LOG_AND_APPEND(BT_LOG_WARNING, _fmt, ##__VA_ARGS__)
3cd4c495
PP
70
71/*
72 * Like bt_lib_log(), but also appends a cause to the current thread's
73 * error object.
74 *
75 * Note that, unlike bt_lib_log(), this function does check that logging
76 * is enabled for level `lvl` before logging. This is to ensure that,
77 * even though logging is disabled, the function still appends an error
78 * cause, as the error reporting system does not rely on logging.
79 *
80 * Use one of the BT_LIB_LOG*_APPEND_CAUSE() macros above instead of
81 * calling this function directly.
82 */
83void bt_lib_maybe_log_and_append_cause(const char *func, const char *file,
84 unsigned line, int lvl, const char *tag,
85 const char *fmt, ...);
86
7151fb67
PP
87#define BT_LIB_LOG_SUPPORTED
88
beb0fb75 89#endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */
This page took 0.099416 seconds and 4 git commands to generate.