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

/*
 * Copyright (C)  2011 - David Goulet <david.goulet@polymtl.ca>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _ERROR_H
#define _ERROR_H

#include <errno.h>
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <urcu/tls-compat.h>
#include <time.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.000000 plus NULL byte. */
	char str[16];
};
extern DECLARE_URCU_TLS(struct log_time, error_log_time);

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

/* Error type. */
#define PRINT_ERR   0x1
#define PRINT_WARN  0x2
#define PRINT_BUG   0x3
#define PRINT_MSG   0x4
#define PRINT_DBG   0x10
#define PRINT_DBG2  0x20
#define PRINT_DBG3  0x30

/*
 * 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_opt_quiet == 0 && lttng_opt_mi == 0 &&            \
				type == PRINT_MSG) {                                \
			fprintf(stdout, fmt, ## args);                          \
		} else if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 &&     \
				(((type & PRINT_DBG) && lttng_opt_verbose == 1) ||  \
				((type & (PRINT_DBG | PRINT_DBG2)) &&               \
					lttng_opt_verbose == 2) ||                      \
				((type & (PRINT_DBG | PRINT_DBG2 | PRINT_DBG3)) &&  \
					lttng_opt_verbose == 3))) {                     \
			fprintf(stderr, fmt, ## args);                          \
		} else if (lttng_opt_quiet == 0 && (type & (PRINT_WARN))) { \
			fprintf(stderr, fmt, ## args);                          \
		} else if (type & (PRINT_ERR | PRINT_BUG)) {                \
			fprintf(stderr, fmt, ## args);                          \
		}                                                           \
	} while (0);

/* Three level of debug. Use -v, -vv or -vvv for the levels */
#define _ERRMSG(msg, type, fmt, args...) __lttng_print(type, msg \
		" - %s [%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" XSTR(__LINE__) ")\n", \
			log_add_time(), (long) getpid(), (long) gettid(), ## args, __func__)

#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_ERR, "Warning: " fmt "\n", ## args)

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

#define DBG(fmt, args...) _ERRMSG("DEBUG1", PRINT_DBG, fmt, ## args)
#define DBG2(fmt, args...) _ERRMSG("DEBUG2", PRINT_DBG2, fmt, ## args)
#define DBG3(fmt, args...) _ERRMSG("DEBUG3", 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:			\
			assert(0);		\
		}				\
	} while(0);

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

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

/*
 * Version using XSI strerror_r.
 */
#define PERROR(call, args...) \
	do { \
		char buf[200]; \
		strerror_r(errno, buf, sizeof(buf)); \
		_PERROR(call ": %s", ## args, buf); \
	} while(0);
#else
/*
 * Version using GNU strerror_r, for linux with appropriate defines.
 */
#define PERROR(call, args...) \
	do { \
		char *buf; \
		char tmp[200]; \
		buf = strerror_r(errno, tmp, sizeof(tmp)); \
		_PERROR(call ": %s", ## args, 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();

#endif /* _ERROR_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License, version 2 only,
	6	* as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	11	* more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along
	14	* with this program; if not, write to the Free Software Foundation, Inc.,
	15	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	16	*/
	17
	18	#ifndef _ERROR_H
	19	#define _ERROR_H
	20
	21	#include <errno.h>
	22	#include <stdio.h>
	23	#include <stdint.h>
	24	#include <string.h>
	25	#include <urcu/tls-compat.h>
	26	#include <time.h>
	27
	28	#ifndef _GNU_SOURCE
	29	#error "lttng-tools error.h needs _GNU_SOURCE"
	30	#endif
	31
	32	#include <lttng/lttng-error.h>
	33	#include <common/compat/tid.h>
	34
	35	/* Avoid conflict with Solaris <sys/regset.h> */
	36	#if defined(ERR) && defined(__sun__)
	37	#undef ERR
	38	#endif
	39
	40	/* Stringify the expansion of a define */
	41	#define XSTR(d) STR(d)
	42	#define STR(s) #s
	43
	44	/*
	45	* Contains the string of the log entry time. This is used as a thread local
	46	* storage so we don't race between thread and also avoid memory allocation
	47	* every time a log is fired.
	48	*/
	49	struct log_time {
	50	/* Format: 00:00:00.000000 plus NULL byte. */
	51	char str[16];
	52	};
	53	extern DECLARE_URCU_TLS(struct log_time, error_log_time);
	54
	55	extern int lttng_opt_quiet;
	56	extern int lttng_opt_verbose;
	57	extern int lttng_opt_mi;
	58
	59	/* Error type. */
	60	#define PRINT_ERR 0x1
	61	#define PRINT_WARN 0x2
	62	#define PRINT_BUG 0x3
	63	#define PRINT_MSG 0x4
	64	#define PRINT_DBG 0x10
	65	#define PRINT_DBG2 0x20
	66	#define PRINT_DBG3 0x30
	67
	68	/*
	69	* Macro for printing message depending on command line option and verbosity.
	70	*
	71	* Machine interface:
	72	* We use lttng_opt_mi to suppress all normal msg to stdout. We don't
	73	* want any nested msg to show up when printing mi to stdout(if it's the case).
	74	* All warnings and errors should be printed to stderr as normal.
	75	*/
	76	#define __lttng_print(type, fmt, args...) \
	77	do { \
	78	if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 && \
	79	type == PRINT_MSG) { \
	80	fprintf(stdout, fmt, ## args); \
	81	} else if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 && \
	82	(((type & PRINT_DBG) && lttng_opt_verbose == 1) \|\| \
	83	((type & (PRINT_DBG \| PRINT_DBG2)) && \
	84	lttng_opt_verbose == 2) \|\| \
	85	((type & (PRINT_DBG \| PRINT_DBG2 \| PRINT_DBG3)) && \
	86	lttng_opt_verbose == 3))) { \
	87	fprintf(stderr, fmt, ## args); \
	88	} else if (lttng_opt_quiet == 0 && (type & (PRINT_WARN))) { \
	89	fprintf(stderr, fmt, ## args); \
	90	} else if (type & (PRINT_ERR \| PRINT_BUG)) { \
	91	fprintf(stderr, fmt, ## args); \
	92	} \
	93	} while (0);
	94
	95	/* Three level of debug. Use -v, -vv or -vvv for the levels */
	96	#define _ERRMSG(msg, type, fmt, args...) __lttng_print(type, msg \
	97	" - %s [%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" XSTR(__LINE__) ")\n", \
	98	log_add_time(), (long) getpid(), (long) gettid(), ## args, __func__)
	99
	100	#define MSG(fmt, args...) \
	101	__lttng_print(PRINT_MSG, fmt "\n", ## args)
	102	#define _MSG(fmt, args...) \
	103	__lttng_print(PRINT_MSG, fmt, ## args)
	104	#define ERR(fmt, args...) \
	105	__lttng_print(PRINT_ERR, "Error: " fmt "\n", ## args)
	106	#define WARN(fmt, args...) \
	107	__lttng_print(PRINT_ERR, "Warning: " fmt "\n", ## args)
	108
	109	#define BUG(fmt, args...) _ERRMSG("BUG", PRINT_BUG, fmt, ## args)
	110
	111	#define DBG(fmt, args...) _ERRMSG("DEBUG1", PRINT_DBG, fmt, ## args)
	112	#define DBG2(fmt, args...) _ERRMSG("DEBUG2", PRINT_DBG2, fmt, ## args)
	113	#define DBG3(fmt, args...) _ERRMSG("DEBUG3", PRINT_DBG3, fmt, ## args)
	114	#define LOG(type, fmt, args...) \
	115	do { \
	116	switch (type) { \
	117	case PRINT_ERR: \
	118	ERR(fmt, ## args); \
	119	break; \
	120	case PRINT_WARN: \
	121	WARN(fmt, ## args); \
	122	break; \
	123	case PRINT_BUG: \
	124	BUG(fmt, ## args); \
	125	break; \
	126	case PRINT_MSG: \
	127	MSG(fmt, ## args); \
	128	break; \
	129	case PRINT_DBG: \
	130	DBG(fmt, ## args); \
	131	break; \
	132	case PRINT_DBG2: \
	133	DBG2(fmt, ## args); \
	134	break; \
	135	case PRINT_DBG3: \
	136	DBG3(fmt, ## args); \
	137	break; \
	138	default: \
	139	assert(0); \
	140	} \
	141	} while(0);
	142
	143	#define _PERROR(fmt, args...) _ERRMSG("PERROR", PRINT_ERR, fmt, ## args)
	144
	145	#if !defined(__linux__) \|\| ((_POSIX_C_SOURCE >= 200112L \|\| _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE))
	146
	147	/*
	148	* Version using XSI strerror_r.
	149	*/
	150	#define PERROR(call, args...) \
	151	do { \
	152	char buf[200]; \
	153	strerror_r(errno, buf, sizeof(buf)); \
	154	_PERROR(call ": %s", ## args, buf); \
	155	} while(0);
	156	#else
	157	/*
	158	* Version using GNU strerror_r, for linux with appropriate defines.
	159	*/
	160	#define PERROR(call, args...) \
	161	do { \
	162	char *buf; \
	163	char tmp[200]; \
	164	buf = strerror_r(errno, tmp, sizeof(tmp)); \
	165	_PERROR(call ": %s", ## args, buf); \
	166	} while(0);
	167	#endif
	168
	169	const char *error_get_str(int32_t code);
	170
	171	/*
	172	* Function that format the time and return the reference of log_time.str to
	173	* the caller. On error, an empty string is returned thus no time will be
	174	* printed in the log.
	175	*/
	176	const char *log_add_time();
	177
	178	#endif /* _ERROR_H */