[lttng-tools.git] / src / common / error.hpp

/*
 * Copyright (C) 2011 EfficiOS Inc.
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */

#ifndef _ERROR_H
#define _ERROR_H

#include <common/compat/errno.hpp>
#include <common/compat/time.hpp>
#include <common/format.hpp>
#include <common/macros.hpp>
#include <common/string-utils/format.hpp>

#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <urcu/tls-compat.h>

#ifndef _GNU_SOURCE
#error "lttng-tools error.h needs _GNU_SOURCE"
#endif

#include <lttng/lttng-error.h>
#include <common/compat/tid.hpp>

/* Avoid conflict with Solaris <sys/regset.h> */
#if defined(ERR) && defined(__sun__)
#undef ERR
#endif

/* Stringify the expansion of a define */
#define XSTR(d) STR(d)
#define STR(s) #s

/*
 * Contains the string of the log entry time. This is used as a thread local
 * storage so we don't race between thread and also avoid memory allocation
 * every time a log is fired.
 */
struct log_time {
	/* Format: 00:00:00.000000000 plus NULL byte. */
	char str[19];
};
extern LTTNG_EXPORT  DECLARE_URCU_TLS(struct log_time, error_log_time);
extern DECLARE_URCU_TLS(const char *, logger_thread_name);

extern int lttng_opt_quiet;
extern int lttng_opt_verbose;
extern int lttng_opt_mi;

/* Error type. */
enum lttng_error_level {
	PRINT_ERR =	0,
	PRINT_BUG =	1,
	PRINT_WARN =	2,
	PRINT_MSG =	3,
	PRINT_DBG =	4,
	PRINT_DBG2 =	5,
	PRINT_DBG3 =	6,
};

static inline bool __lttng_print_check_opt(enum lttng_error_level type)
{
	/* lttng_opt_mi and lttng_opt_quiet. */
	switch (type) {
	case PRINT_DBG3:
	case PRINT_DBG2:
	case PRINT_DBG:
	case PRINT_MSG:
		if (lttng_opt_mi) {
			return false;
		}
		/* Fall-through. */
	case PRINT_WARN:
	case PRINT_BUG:
	case PRINT_ERR:
		if (lttng_opt_quiet) {
			return false;
		}
	}

	/* lttng_opt_verbose */
	switch (type) {
	case PRINT_DBG3:
		if (lttng_opt_verbose < 3) {
			return false;
		}
		break;
	case PRINT_DBG2:
		if (lttng_opt_verbose < 2) {
			return false;
		}
		break;
	case PRINT_DBG:
		if (lttng_opt_verbose < 1) {
			return false;
		}
		break;
	case PRINT_MSG:
	case PRINT_WARN:
	case PRINT_BUG:
	case PRINT_ERR:
		break;
	}

	return true;
}

C_LINKAGE void lttng_abort_on_error(void);

static inline void __lttng_print_check_abort(enum lttng_error_level type)
{
	switch (type) {
	case PRINT_DBG3:
	case PRINT_DBG2:
	case PRINT_DBG:
	case PRINT_MSG:
	case PRINT_WARN:
		break;
	case PRINT_BUG:
	case PRINT_ERR:
		lttng_abort_on_error();
	}
}

/*
 * Macro for printing message depending on command line option and verbosity.
 *
 * Machine interface:
 * We use lttng_opt_mi to suppress all normal msg to stdout. We don't
 * want any nested msg to show up when printing mi to stdout(if it's the case).
 * All warnings and errors should be printed to stderr as normal.
 */
#define __lttng_print(type, fmt, args...)						\
	do {										\
		if (__lttng_print_check_opt(type)) {					\
			fprintf((type) == PRINT_MSG ? stdout : stderr, fmt, ## args);	\
		}									\
		__lttng_print_check_abort(type);					\
	} while (0)

/* Three level of debug. Use -v, -vv or -vvv for the levels */
#define _ERRMSG(msg, type, fmt, args...)                                \
	do {                                                            \
		if (caa_unlikely(__lttng_print_check_opt(type))) {      \
			char generic_name[MAX_INT_DEC_LEN(long) +       \
					  MAX_INT_DEC_LEN(long)];       \
                                                                        \
			snprintf(generic_name, sizeof(generic_name),    \
					"%ld/%ld", (long) getpid(),     \
					(long) lttng_gettid());         \
                                                                        \
			__lttng_print(type,                             \
					msg " - %s [%s]: " fmt          \
					    " (in %s() at " __FILE__    \
					    ":" XSTR(__LINE__) ")\n",   \
					log_add_time(),                 \
					URCU_TLS(logger_thread_name) ?: \
							generic_name,   \
					##args, __func__);              \
		}                                                       \
	} while (0)

#define _ERRMSG_NO_LOC(msg, type, fmt, args...)                          \
	do {                                                             \
		if (caa_unlikely(__lttng_print_check_opt(type))) {       \
			char generic_name[MAX_INT_DEC_LEN(long) +        \
					  MAX_INT_DEC_LEN(long)];        \
                                                                         \
			snprintf(generic_name, sizeof(generic_name),     \
					"%ld/%ld", (long) getpid(),      \
					(long) lttng_gettid());          \
                                                                         \
			__lttng_print(type, msg " - %s [%s]: " fmt "\n", \
					log_add_time(),                  \
					URCU_TLS(logger_thread_name) ?:  \
							generic_name,    \
					##args);                         \
		}                                                        \
	} while (0)

#define MSG(fmt, args...) \
	__lttng_print(PRINT_MSG, fmt "\n", ## args)
#define _MSG(fmt, args...) \
	__lttng_print(PRINT_MSG, fmt, ## args)
#define ERR(fmt, args...) \
	__lttng_print(PRINT_ERR, "Error: " fmt "\n", ## args)
#define WARN(fmt, args...) \
	__lttng_print(PRINT_WARN, "Warning: " fmt "\n", ## args)

#define BUG(fmt, args...) _ERRMSG("BUG", PRINT_BUG, fmt, ## args)

#define DBG(fmt, args...) _ERRMSG("DBG1", PRINT_DBG, fmt, ## args)
#define DBG_NO_LOC(fmt, args...) _ERRMSG_NO_LOC("DBG1", PRINT_DBG, fmt, ## args)
#define DBG2(fmt, args...) _ERRMSG("DBG2", PRINT_DBG2, fmt, ## args)
#define DBG3(fmt, args...) _ERRMSG("DBG3", PRINT_DBG3, fmt, ## args)
#define LOG(type, fmt, args...)			\
	do {					\
		switch (type) {			\
		case PRINT_ERR:			\
			ERR(fmt, ## args);	\
			break;			\
		case PRINT_WARN:		\
			WARN(fmt, ## args);	\
			break;			\
		case PRINT_BUG:			\
			BUG(fmt, ## args);	\
			break;			\
		case PRINT_MSG:			\
			MSG(fmt, ## args);	\
			break;			\
		case PRINT_DBG:			\
			DBG(fmt, ## args);	\
			break;			\
		case PRINT_DBG2:		\
			DBG2(fmt, ## args);	\
			break;			\
		case PRINT_DBG3:		\
			DBG3(fmt, ## args);	\
			break;			\
		default:			\
			abort();		\
		}				\
	} while(0);

#define _PERROR(fmt, args...) _ERRMSG("PERROR", PRINT_ERR, fmt, ## args)

#if !defined(__GLIBC__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE))

/*
 * Version using XSI strerror_r.
 */
#define PERROR(call, args...)                                        \
	do {                                                         \
		char _perror_buf[200];                               \
		strerror_r(errno, _perror_buf, sizeof(_perror_buf)); \
		_PERROR(call ": %s", ##args, _perror_buf);           \
	} while (0);
#else
/*
 * Version using GNU strerror_r, for linux with appropriate defines.
 */
#define PERROR(call, args...)                                             \
	do {                                                              \
		char *_perror_buf;                                        \
		char _perror_tmp[200];                                    \
		_perror_buf = strerror_r(                                 \
				errno, _perror_tmp, sizeof(_perror_tmp)); \
		_PERROR(call ": %s", ##args, _perror_buf);                \
	} while (0);
#endif

#define DBG_FMT(format_str, args...)  DBG("%s", fmt::format(format_str, ##args).c_str())
#define WARN_FMT(format_str, args...) WARN("%s", fmt::format(format_str, ##args).c_str())
#define ERR_FMT(format_str, args...)  ERR("%s", fmt::format(format_str, ##args).c_str())

const char *error_get_str(int32_t code);

/*
 * Function that format the time and return the reference of log_time.str to
 * the caller. On error, an empty string is returned thus no time will be
 * printed in the log.
 */
const char *log_add_time();

/* Name must be a statically-allocated string. */
void logger_set_thread_name(const char *name, bool set_pthread_name);

#endif /* _ERROR_H */
Commit	Line	Data
826d496d	1	/*
21cf9b6b	2	* Copyright (C) 2011 EfficiOS Inc.
fac6795d	3	*
c922647d	4	* SPDX-License-Identifier: LGPL-2.1-only
d14d33bf	5	*
fac6795d DG	6	*/
fac6795d DG	7
db758600 DG	8	#ifndef _ERROR_H
db758600 DG	9	#define _ERROR_H
fac6795d	10
c9e313bc	11	#include <common/compat/errno.hpp>
0038180d JG	12	#include <common/compat/time.hpp>
	13	#include <common/format.hpp>
	14	#include <common/macros.hpp>
	15	#include <common/string-utils/format.hpp>
	16
	17	#include <stdbool.h>
f73fabfd	18	#include <stdint.h>
0038180d	19	#include <stdio.h>
d05ea5da	20	#include <string.h>
a0b439da	21	#include <urcu/tls-compat.h>
fac6795d	22
4c462e79 MD	23	#ifndef _GNU_SOURCE
	24	#error "lttng-tools error.h needs _GNU_SOURCE"
	25	#endif
	26
f73fabfd	27	#include <lttng/lttng-error.h>
c9e313bc	28	#include <common/compat/tid.hpp>
f73fabfd	29
1e9e234a MJ	30	/* Avoid conflict with Solaris <sys/regset.h> */
	31	#if defined(ERR) && defined(__sun__)
	32	#undef ERR
	33	#endif
	34
57d0d501 DG	35	/* Stringify the expansion of a define */
	36	#define XSTR(d) STR(d)
	37	#define STR(s) #s
	38
a0b439da DG	39	/*
	40	* Contains the string of the log entry time. This is used as a thread local
	41	* storage so we don't race between thread and also avoid memory allocation
	42	* every time a log is fired.
	43	*/
	44	struct log_time {
870bdaf9 JD	45	/* Format: 00:00:00.000000000 plus NULL byte. */
870bdaf9 JD	46	char str[19];
a0b439da	47	};
4bd69c5f	48	extern LTTNG_EXPORT DECLARE_URCU_TLS(struct log_time, error_log_time);
ca806b0b	49	extern DECLARE_URCU_TLS(const char *, logger_thread_name);
a0b439da	50
97e19046 DG	51	extern int lttng_opt_quiet;
97e19046 DG	52	extern int lttng_opt_verbose;
c7e35b03	53	extern int lttng_opt_mi;
fac6795d	54
ffe60014	55	/* Error type. */
ce69c47f	56	enum lttng_error_level {
ab530aaf MD	57	PRINT_ERR = 0,
	58	PRINT_BUG = 1,
	59	PRINT_WARN = 2,
	60	PRINT_MSG = 3,
	61	PRINT_DBG = 4,
	62	PRINT_DBG2 = 5,
	63	PRINT_DBG3 = 6,
	64	};
	65
ce69c47f	66	static inline bool __lttng_print_check_opt(enum lttng_error_level type)
ab530aaf MD	67	{
	68	/* lttng_opt_mi and lttng_opt_quiet. */
	69	switch (type) {
	70	case PRINT_DBG3:
	71	case PRINT_DBG2:
	72	case PRINT_DBG:
	73	case PRINT_MSG:
	74	if (lttng_opt_mi) {
	75	return false;
	76	}
	77	/* Fall-through. */
	78	case PRINT_WARN:
	79	case PRINT_BUG:
	80	case PRINT_ERR:
	81	if (lttng_opt_quiet) {
	82	return false;
	83	}
	84	}
	85
	86	/* lttng_opt_verbose */
	87	switch (type) {
	88	case PRINT_DBG3:
	89	if (lttng_opt_verbose < 3) {
	90	return false;
	91	}
	92	break;
	93	case PRINT_DBG2:
	94	if (lttng_opt_verbose < 2) {
	95	return false;
	96	}
	97	break;
	98	case PRINT_DBG:
	99	if (lttng_opt_verbose < 1) {
	100	return false;
	101	}
	102	break;
	103	case PRINT_MSG:
	104	case PRINT_WARN:
	105	case PRINT_BUG:
	106	case PRINT_ERR:
	107	break;
	108	}
	109
	110	return true;
	111	}
	112
d50d200a	113	C_LINKAGE void lttng_abort_on_error(void);
ab530aaf	114
ce69c47f	115	static inline void __lttng_print_check_abort(enum lttng_error_level type)
ab530aaf MD	116	{
	117	switch (type) {
	118	case PRINT_DBG3:
	119	case PRINT_DBG2:
	120	case PRINT_DBG:
	121	case PRINT_MSG:
	122	case PRINT_WARN:
	123	break;
	124	case PRINT_BUG:
	125	case PRINT_ERR:
	126	lttng_abort_on_error();
	127	}
	128	}
fac6795d DG	129
fac6795d DG	130	/*
75dea654	131	* Macro for printing message depending on command line option and verbosity.
c7e35b03 JR	132	*
	133	* Machine interface:
	134	* We use lttng_opt_mi to suppress all normal msg to stdout. We don't
	135	* want any nested msg to show up when printing mi to stdout(if it's the case).
	136	* All warnings and errors should be printed to stderr as normal.
fac6795d	137	*/
ab530aaf MD	138	#define __lttng_print(type, fmt, args...) \
	139	do { \
	140	if (__lttng_print_check_opt(type)) { \
	141	fprintf((type) == PRINT_MSG ? stdout : stderr, fmt, ## args); \
	142	} \
	143	__lttng_print_check_abort(type); \
	144	} while (0)
fac6795d	145
ffe60014	146	/* Three level of debug. Use -v, -vv or -vvv for the levels */
f5fb86c1 JG	147	#define _ERRMSG(msg, type, fmt, args...) \
	148	do { \
	149	if (caa_unlikely(__lttng_print_check_opt(type))) { \
	150	char generic_name[MAX_INT_DEC_LEN(long) + \
	151	MAX_INT_DEC_LEN(long)]; \
	152	\
	153	snprintf(generic_name, sizeof(generic_name), \
	154	"%ld/%ld", (long) getpid(), \
	155	(long) lttng_gettid()); \
	156	\
	157	__lttng_print(type, \
	158	msg " - %s [%s]: " fmt \
	159	" (in %s() at " __FILE__ \
	160	":" XSTR(__LINE__) ")\n", \
	161	log_add_time(), \
	162	URCU_TLS(logger_thread_name) ?: \
	163	generic_name, \
	164	##args, __func__); \
	165	} \
	166	} while (0)
ffe60014	167
f5fb86c1 JG	168	#define _ERRMSG_NO_LOC(msg, type, fmt, args...) \
	169	do { \
	170	if (caa_unlikely(__lttng_print_check_opt(type))) { \
	171	char generic_name[MAX_INT_DEC_LEN(long) + \
	172	MAX_INT_DEC_LEN(long)]; \
	173	\
	174	snprintf(generic_name, sizeof(generic_name), \
	175	"%ld/%ld", (long) getpid(), \
	176	(long) lttng_gettid()); \
	177	\
	178	__lttng_print(type, msg " - %s [%s]: " fmt "\n", \
	179	log_add_time(), \
	180	URCU_TLS(logger_thread_name) ?: \
	181	generic_name, \
	182	##args); \
	183	} \
	184	} while (0)
e6142f2e	185
75dea654 DG	186	#define MSG(fmt, args...) \
75dea654 DG	187	__lttng_print(PRINT_MSG, fmt "\n", ## args)
f37d259d MD	188	#define _MSG(fmt, args...) \
f37d259d MD	189	__lttng_print(PRINT_MSG, fmt, ## args)
75dea654	190	#define ERR(fmt, args...) \
c66f2a27	191	__lttng_print(PRINT_ERR, "Error: " fmt "\n", ## args)
75dea654	192	#define WARN(fmt, args...) \
cb1917a9	193	__lttng_print(PRINT_WARN, "Warning: " fmt "\n", ## args)
75dea654	194
ffe60014 DG	195	#define BUG(fmt, args...) _ERRMSG("BUG", PRINT_BUG, fmt, ## args)
ffe60014 DG	196
f5fb86c1 JG	197	#define DBG(fmt, args...) _ERRMSG("DBG1", PRINT_DBG, fmt, ## args)
	198	#define DBG_NO_LOC(fmt, args...) _ERRMSG_NO_LOC("DBG1", PRINT_DBG, fmt, ## args)
	199	#define DBG2(fmt, args...) _ERRMSG("DBG2", PRINT_DBG2, fmt, ## args)
	200	#define DBG3(fmt, args...) _ERRMSG("DBG3", PRINT_DBG3, fmt, ## args)
7d9ad880 JG	201	#define LOG(type, fmt, args...) \
	202	do { \
	203	switch (type) { \
	204	case PRINT_ERR: \
	205	ERR(fmt, ## args); \
	206	break; \
	207	case PRINT_WARN: \
	208	WARN(fmt, ## args); \
	209	break; \
	210	case PRINT_BUG: \
	211	BUG(fmt, ## args); \
	212	break; \
	213	case PRINT_MSG: \
	214	MSG(fmt, ## args); \
	215	break; \
	216	case PRINT_DBG: \
	217	DBG(fmt, ## args); \
	218	break; \
	219	case PRINT_DBG2: \
	220	DBG2(fmt, ## args); \
	221	break; \
	222	case PRINT_DBG3: \
	223	DBG3(fmt, ## args); \
	224	break; \
	225	default: \
a0377dfe	226	abort(); \
7d9ad880 JG	227	} \
7d9ad880 JG	228	} while(0);
ffe60014 DG	229
ffe60014 DG	230	#define _PERROR(fmt, args...) _ERRMSG("PERROR", PRINT_ERR, fmt, ## args)
75dea654	231
b6dacfe2	232	#if !defined(__GLIBC__) \|\| ((_POSIX_C_SOURCE >= 200112L \|\| _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE))
97e19046	233
818d276f MD	234	/*
	235	* Version using XSI strerror_r.
	236	*/
0c818c97 SM	237	#define PERROR(call, args...) \
	238	do { \
	239	char _perror_buf[200]; \
	240	strerror_r(errno, _perror_buf, sizeof(_perror_buf)); \
	241	_PERROR(call ": %s", ##args, _perror_buf); \
	242	} while (0);
818d276f MD	243	#else
	244	/*
	245	* Version using GNU strerror_r, for linux with appropriate defines.
	246	*/
0c818c97 SM	247	#define PERROR(call, args...) \
	248	do { \
	249	char *_perror_buf; \
	250	char _perror_tmp[200]; \
	251	_perror_buf = strerror_r( \
	252	errno, _perror_tmp, sizeof(_perror_tmp)); \
	253	_PERROR(call ": %s", ##args, _perror_buf); \
	254	} while (0);
818d276f	255	#endif
fac6795d	256
0038180d JG	257	#define DBG_FMT(format_str, args...) DBG("%s", fmt::format(format_str, ##args).c_str())
	258	#define WARN_FMT(format_str, args...) WARN("%s", fmt::format(format_str, ##args).c_str())
	259	#define ERR_FMT(format_str, args...) ERR("%s", fmt::format(format_str, ##args).c_str())
	260
f73fabfd DG	261	const char *error_get_str(int32_t code);
f73fabfd DG	262
a0b439da DG	263	/*
	264	* Function that format the time and return the reference of log_time.str to
	265	* the caller. On error, an empty string is returned thus no time will be
	266	* printed in the log.
	267	*/
cd9adb8b	268	const char *log_add_time();
a0b439da	269
f5fb86c1	270	/* Name must be a statically-allocated string. */
f5fb86c1 JG	271	void logger_set_thread_name(const char *name, bool set_pthread_name);
f5fb86c1 JG	272
db758600	273	#endif /* _ERROR_H */