[babeltrace.git] / include / babeltrace / logging.h

#ifndef BABELTRACE_LOGGING_H
#define BABELTRACE_LOGGING_H

/*
 * Babeltrace - Logging
 *
 * Copyright (c) 2017 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 <stdint.h>
#include <stdbool.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
@defgroup logging Logging
@ingroup apiref
@brief Logging.

@code
#include <babeltrace/logging.h>
@endcode

The functions in this module control the Babeltrace library's logging
behaviour.

You can set the current global log level of the library with
bt_logging_set_global_level(). Note that, if the level you set is below
the minimal logging level (configured at build time, which you can get
with bt_logging_get_minimal_level()), the logging statement between the
current global log level and the minimal log level are not executed.

@file
@brief Logging functions.
@sa logging

@addtogroup logging
@{
*/

/**
@brief Log levels.
*/
enum bt_logging_level {
	/// Additional, low-level debugging context information.
	BT_LOGGING_LEVEL_VERBOSE	= 1,

	/**
	Debugging information, only useful when searching for the
	cause of a bug.
	*/
	BT_LOGGING_LEVEL_DEBUG		= 2,

	/**
	Non-debugging information and failure to load optional
	subsystems.
	*/
	BT_LOGGING_LEVEL_INFO		= 3,

	/**
	Errors caused by a bad usage of the library, that is, a
	non-observance of the documented function preconditions.

	The library's and object's states remain consistent when a
	warning is issued.
	*/
	BT_LOGGING_LEVEL_WARN		= 4,

	/**
	An important error from which the library cannot recover, but
	the executed stack of functions can still return cleanly.
	*/
	BT_LOGGING_LEVEL_ERROR		= 5,

	/**
	The library cannot continue to work in this condition: it must
	terminate immediately, without even returning to the user's
	execution.
	*/
	BT_LOGGING_LEVEL_FATAL		= 6,

	/// Logging is disabled.
	BT_LOGGING_LEVEL_NONE		= 0xff,
};

/**
@brief	Returns the minimal log level of the Babeltrace library.

The minimal log level is defined at the library's build time. Any
logging statement with a level below the minimal log level is not
compiled. This means that it is useless, although possible, to set the
global log level with bt_logging_set_global_level() below this level.

@returns	Minimal, build time log level.

@sa bt_logging_get_global_level(): Returns the current global log level.
*/
extern enum bt_logging_level bt_logging_get_minimal_level(void);

/**
@brief	Returns the current global log level of the Babeltrace library.

@returns	Current global log level.

@sa bt_logging_set_global_level(): Sets the current global log level.
@sa bt_logging_get_minimal_level(): Returns the minimal log level.
*/
extern enum bt_logging_level bt_logging_get_global_level(void);

/**
@brief	Sets the current global log level of the Babeltrace library
	to \p log_level.

If \p log_level is below what bt_logging_get_minimal_level() returns,
the logging statements with a level between \p log_level and the minimal
log level cannot be executed.

@param[in] log_level	Library's new global log level.

@sa bt_logging_get_global_level(): Returns the global log level.
*/
extern void bt_logging_set_global_level(enum bt_logging_level log_level);

/** @} */

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_LOGGING_H */
Commit	Line	Data
beb0fb75 PP	1	#ifndef BABELTRACE_LOGGING_H
	2	#define BABELTRACE_LOGGING_H
	3
	4	/*
	5	* Babeltrace - Logging
	6	*
	7	* Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	22	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	23	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	24	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	25	* SOFTWARE.
	26	*/
	27
	28	#include <stdint.h>
	29	#include <stdbool.h>
	30	#include <stddef.h>
beb0fb75 PP	31
	32	#ifdef __cplusplus
	33	extern "C" {
	34	#endif
	35
	36	/**
	37	@defgroup logging Logging
	38	@ingroup apiref
	39	@brief Logging.
	40
	41	@code
	42	#include <babeltrace/logging.h>
	43	@endcode
	44
	45	The functions in this module control the Babeltrace library's logging
	46	behaviour.
	47
	48	You can set the current global log level of the library with
	49	bt_logging_set_global_level(). Note that, if the level you set is below
	50	the minimal logging level (configured at build time, which you can get
	51	with bt_logging_get_minimal_level()), the logging statement between the
	52	current global log level and the minimal log level are not executed.
	53
	54	@file
	55	@brief Logging functions.
	56	@sa logging
	57
	58	@addtogroup logging
	59	@{
	60	*/
	61
	62	/**
	63	@brief Log levels.
	64	*/
	65	enum bt_logging_level {
	66	/// Additional, low-level debugging context information.
	67	BT_LOGGING_LEVEL_VERBOSE = 1,
	68
	69	/**
	70	Debugging information, only useful when searching for the
	71	cause of a bug.
	72	*/
	73	BT_LOGGING_LEVEL_DEBUG = 2,
	74
	75	/**
	76	Non-debugging information and failure to load optional
	77	subsystems.
	78	*/
	79	BT_LOGGING_LEVEL_INFO = 3,
	80
	81	/**
	82	Errors caused by a bad usage of the library, that is, a
	83	non-observance of the documented function preconditions.
	84
	85	The library's and object's states remain consistent when a
	86	warning is issued.
	87	*/
	88	BT_LOGGING_LEVEL_WARN = 4,
	89
	90	/**
	91	An important error from which the library cannot recover, but
	92	the executed stack of functions can still return cleanly.
	93	*/
	94	BT_LOGGING_LEVEL_ERROR = 5,
95
96	/**
97	The library cannot continue to work in this condition: it must
98	terminate immediately, without even returning to the user's
99	execution.
100	*/
101	BT_LOGGING_LEVEL_FATAL = 6,
102
103	/// Logging is disabled.
104	BT_LOGGING_LEVEL_NONE = 0xff,
105	};
106
107	/**
108	@brief Returns the minimal log level of the Babeltrace library.
109
110	The minimal log level is defined at the library's build time. Any
111	logging statement with a level below the minimal log level is not
112	compiled. This means that it is useless, although possible, to set the
113	global log level with bt_logging_set_global_level() below this level.
114
115	@returns Minimal, build time log level.
116
117	@sa bt_logging_get_global_level(): Returns the current global log level.
118	*/
119	extern enum bt_logging_level bt_logging_get_minimal_level(void);
120
121	/**
122	@brief Returns the current global log level of the Babeltrace library.
123
124	@returns Current global log level.
125
126	@sa bt_logging_set_global_level(): Sets the current global log level.
127	@sa bt_logging_get_minimal_level(): Returns the minimal log level.
128	*/
129	extern enum bt_logging_level bt_logging_get_global_level(void);
130
131	/**
132	@brief Sets the current global log level of the Babeltrace library
133	to \p log_level.
134
135	If \p log_level is below what bt_logging_get_minimal_level() returns,
136	the logging statements with a level between \p log_level and the minimal
137	log level cannot be executed.
138
139	@param[in] log_level Library's new global log level.
140
141	@sa bt_logging_get_global_level(): Returns the global log level.
142	*/
143	extern void bt_logging_set_global_level(enum bt_logging_level log_level);
144
145	/** @} */
146
147	#ifdef __cplusplus
148	}
149	#endif
150
151	#endif /* BABELTRACE_LOGGING_H */