[babeltrace.git] / src / lib / logging.h

#ifndef BABELTRACE_LIB_LOGGING_INTERNAL_H
#define BABELTRACE_LIB_LOGGING_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include "common/macros.h"
#include <stdarg.h>

#ifndef BT_LOG_TAG
# error Please define a tag with BT_LOG_TAG before including this file.
#endif

#define BT_LOG_OUTPUT_LEVEL bt_lib_log_level

#include "logging/log.h"

#define BT_LIB_LOG_LIBBABELTRACE2_NAME "libbabeltrace2"

extern
int bt_lib_log_level;

#define BT_LIB_LOG(_lvl, _fmt, ...)					\
	do {								\
		if (BT_LOG_ON(_lvl)) {					\
			bt_lib_log(_BT_LOG_SRCLOC_FUNCTION, __FILE__,	\
				__LINE__, _lvl, _BT_LOG_TAG,		\
				(_fmt), ##__VA_ARGS__);			\
		}							\
	} while (0)

/* See `CONTRIBUTING.adoc` for usage */
#define BT_LIB_LOGF(_fmt, ...)	BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__)
#define BT_LIB_LOGE(_fmt, ...)	BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
#define BT_LIB_LOGW(_fmt, ...)	BT_LIB_LOG(BT_LOG_WARNING, _fmt, ##__VA_ARGS__)
#define BT_LIB_LOGI(_fmt, ...)	BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__)
#define BT_LIB_LOGD(_fmt, ...)	BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__)
#define BT_LIB_LOGT(_fmt, ...)	BT_LIB_LOG(BT_LOG_TRACE, _fmt, ##__VA_ARGS__)

/*
 * Log statement, specialized for the Babeltrace library.
 *
 * This function does NOT check that logging is enabled for level `lvl`:
 * you must check it manually with BT_LOG_ON().
 *
 * Use one of the BT_LIB_LOG*() macros above instead of calling this
 * function directly.
 *
 * This function would normally be BT_HIDDEN, but it is used by the Python
 * plugin provider, which is conceptually part of libbabeltrace2, but
 * implemented as a separate shared object, for modularity.  It is therefore
 * exposed, but not part of the public ABI.
 */
void bt_lib_log(const char *func, const char *file, unsigned line,
		int lvl, const char *tag, const char *fmt, ...);

#define BT_LIB_LOG_AND_APPEND(_lvl, _fmt, ...)				\
	do {								\
		bt_lib_maybe_log_and_append_cause(			\
			_BT_LOG_SRCLOC_FUNCTION, __FILE__,		\
			__LINE__, _lvl, _BT_LOG_TAG,			\
			(_fmt), ##__VA_ARGS__);				\
	} while (0)

/* See `CONTRIBUTING.adoc` for usage */
#define BT_LIB_LOGE_APPEND_CAUSE(_fmt, ...)				\
	BT_LIB_LOG_AND_APPEND(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
#define BT_LIB_LOGW_APPEND_CAUSE(_fmt, ...)				\
	BT_LIB_LOG_AND_APPEND(BT_LOG_WARNING, _fmt, ##__VA_ARGS__)

/*
 * Like bt_lib_log(), but also appends a cause to the current thread's
 * error object.
 *
 * Note that, unlike bt_lib_log(), this function does check that logging
 * is enabled for level `lvl` before logging. This is to ensure that,
 * even though logging is disabled, the function still appends an error
 * cause, as the error reporting system does not rely on logging.
 *
 * Use one of the BT_LIB_LOG*_APPEND_CAUSE() macros above instead of
 * calling this function directly.
 *
 * This function would normally be BT_HIDDEN, but it is used by the Python
 * plugin provider, which is conceptually part of libbabeltrace2, but
 * implemented as a separate shared object, for modularity.  It is therefore
 * exposed, but not part of the ABI.
 */
void bt_lib_maybe_log_and_append_cause(const char *func, const char *file,
		unsigned line, int lvl, const char *tag,
		const char *fmt, ...);

#define BT_LIB_LOG_SUPPORTED

#endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */
Commit	Line	Data
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
beb0fb75 PP	34
578e048b	35	#include "logging/log.h"
beb0fb75	36
d5becf10 FD	37	#define BT_LIB_LOG_LIBBABELTRACE2_NAME "libbabeltrace2"
d5becf10 FD	38
61d6f9b1	39	extern
beb0fb75 PP	40	int bt_lib_log_level;
beb0fb75 PP	41
3dca2276 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
b359e350	51	/* See `CONTRIBUTING.adoc` for usage */
476ef981 PP	52	#define BT_LIB_LOGF(_fmt, ...) BT_LIB_LOG(BT_LOG_FATAL, _fmt, ##__VA_ARGS__)
476ef981 PP	53	#define BT_LIB_LOGE(_fmt, ...) BT_LIB_LOG(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
770538dd	54	#define BT_LIB_LOGW(_fmt, ...) BT_LIB_LOG(BT_LOG_WARNING, _fmt, ##__VA_ARGS__)
476ef981 PP	55	#define BT_LIB_LOGI(_fmt, ...) BT_LIB_LOG(BT_LOG_INFO, _fmt, ##__VA_ARGS__)
476ef981 PP	56	#define BT_LIB_LOGD(_fmt, ...) BT_LIB_LOG(BT_LOG_DEBUG, _fmt, ##__VA_ARGS__)
ef267d12	57	#define BT_LIB_LOGT(_fmt, ...) BT_LIB_LOG(BT_LOG_TRACE, _fmt, ##__VA_ARGS__)
476ef981 PP	58
	59	/*
	60	* Log statement, specialized for the Babeltrace library.
	61	*
3cd4c495 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
476ef981	66	* function directly.
ddccb6ce SM	67	*
	68	* This function would normally be BT_HIDDEN, but it is used by the Python
	69	* plugin provider, which is conceptually part of libbabeltrace2, but
	70	* implemented as a separate shared object, for modularity. It is therefore
	71	* exposed, but not part of the public ABI.
476ef981	72	*/
476ef981 PP	73	void bt_lib_log(const char func, const char file, unsigned line,
	74	int lvl, const char tag, const char fmt, ...);
	75
3cd4c495 PP	76	#define BT_LIB_LOG_AND_APPEND(_lvl, _fmt, ...) \
	77	do { \
	78	bt_lib_maybe_log_and_append_cause( \
	79	_BT_LOG_SRCLOC_FUNCTION, __FILE__, \
	80	__LINE__, _lvl, _BT_LOG_TAG, \
	81	(_fmt), ##__VA_ARGS__); \
	82	} while (0)
	83
	84	/* See `CONTRIBUTING.adoc` for usage */
	85	#define BT_LIB_LOGE_APPEND_CAUSE(_fmt, ...) \
	86	BT_LIB_LOG_AND_APPEND(BT_LOG_ERROR, _fmt, ##__VA_ARGS__)
	87	#define BT_LIB_LOGW_APPEND_CAUSE(_fmt, ...) \
770538dd	88	BT_LIB_LOG_AND_APPEND(BT_LOG_WARNING, _fmt, ##__VA_ARGS__)
3cd4c495 PP	89
	90	/*
	91	* Like bt_lib_log(), but also appends a cause to the current thread's
	92	* error object.
	93	*
	94	* Note that, unlike bt_lib_log(), this function does check that logging
	95	* is enabled for level `lvl` before logging. This is to ensure that,
	96	* even though logging is disabled, the function still appends an error
	97	* cause, as the error reporting system does not rely on logging.
	98	*
	99	* Use one of the BT_LIB_LOG*_APPEND_CAUSE() macros above instead of
	100	* calling this function directly.
ddccb6ce SM	101	*
	102	* This function would normally be BT_HIDDEN, but it is used by the Python
	103	* plugin provider, which is conceptually part of libbabeltrace2, but
	104	* implemented as a separate shared object, for modularity. It is therefore
	105	* exposed, but not part of the ABI.
3cd4c495 PP	106	*/
	107	void bt_lib_maybe_log_and_append_cause(const char func, const char file,
	108	unsigned line, int lvl, const char *tag,
	109	const char *fmt, ...);
	110
7151fb67 PP	111	#define BT_LIB_LOG_SUPPORTED
7151fb67 PP	112
beb0fb75	113	#endif /* BABELTRACE_LIB_LOGGING_INTERNAL_H */