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

/*
 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef _ERROR_H
#define _ERROR_H

#include <common/compat/errno.h>
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <stdbool.h>
#include <urcu/tls-compat.h>
#include <common/compat/time.h>
#include <common/string-utils/format.h>
#include <common/macros.h>

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

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

/* 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

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(void);

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