[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>

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

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

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

extern int lttng_opt_quiet;
extern int lttng_opt_verbose;

/* 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.
 */
#define __lttng_print(type, fmt, args...)                           \
	do {                                                            \
		if (lttng_opt_quiet == 0 && type == PRINT_MSG) {            \
			fprintf(stdout, fmt, ## args);                          \
		} else if (lttng_opt_quiet == 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 \
		" [%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" XSTR(__LINE__) ")\n", \
			(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_WARN, "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 _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);

#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
	26	#ifndef _GNU_SOURCE
	27	#error "lttng-tools error.h needs _GNU_SOURCE"
	28	#endif
	29
	30	#include <lttng/lttng-error.h>
	31	#include <common/compat/tid.h>
	32
	33	/* Stringify the expansion of a define */
	34	#define XSTR(d) STR(d)
	35	#define STR(s) #s
	36
	37	extern int lttng_opt_quiet;
	38	extern int lttng_opt_verbose;
	39
	40	/* Error type. */
	41	#define PRINT_ERR 0x1
	42	#define PRINT_WARN 0x2
	43	#define PRINT_BUG 0x3
	44	#define PRINT_MSG 0x4
	45	#define PRINT_DBG 0x10
	46	#define PRINT_DBG2 0x20
	47	#define PRINT_DBG3 0x30
	48
	49	/*
	50	* Macro for printing message depending on command line option and verbosity.
	51	*/
	52	#define __lttng_print(type, fmt, args...) \
	53	do { \
	54	if (lttng_opt_quiet == 0 && type == PRINT_MSG) { \
	55	fprintf(stdout, fmt, ## args); \
	56	} else if (lttng_opt_quiet == 0 && \
	57	(((type & PRINT_DBG) && lttng_opt_verbose == 1) \|\| \
	58	((type & (PRINT_DBG \| PRINT_DBG2)) && \
	59	lttng_opt_verbose == 2) \|\| \
	60	((type & (PRINT_DBG \| PRINT_DBG2 \| PRINT_DBG3)) && \
	61	lttng_opt_verbose == 3))) { \
	62	fprintf(stderr, fmt, ## args); \
	63	} else if (lttng_opt_quiet == 0 && (type & (PRINT_WARN))) { \
	64	fprintf(stderr, fmt, ## args); \
	65	} else if (type & (PRINT_ERR \| PRINT_BUG)) { \
	66	fprintf(stderr, fmt, ## args); \
	67	} \
	68	} while (0);
	69
	70	/* Three level of debug. Use -v, -vv or -vvv for the levels */
	71	#define _ERRMSG(msg, type, fmt, args...) __lttng_print(type, msg \
	72	" [%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" XSTR(__LINE__) ")\n", \
	73	(long) getpid(), (long) gettid(), ## args, __func__)
	74
	75	#define MSG(fmt, args...) \
	76	__lttng_print(PRINT_MSG, fmt "\n", ## args)
	77	#define _MSG(fmt, args...) \
	78	__lttng_print(PRINT_MSG, fmt, ## args)
	79	#define ERR(fmt, args...) \
	80	__lttng_print(PRINT_ERR, "Error: " fmt "\n", ## args)
	81	#define WARN(fmt, args...) \
	82	__lttng_print(PRINT_WARN, "Warning: " fmt "\n", ## args)
	83
	84	#define BUG(fmt, args...) _ERRMSG("BUG", PRINT_BUG, fmt, ## args)
	85
	86	#define DBG(fmt, args...) _ERRMSG("DEBUG1", PRINT_DBG, fmt, ## args)
	87	#define DBG2(fmt, args...) _ERRMSG("DEBUG2", PRINT_DBG2, fmt, ## args)
	88	#define DBG3(fmt, args...) _ERRMSG("DEBUG3", PRINT_DBG3, fmt, ## args)
	89
	90	#define _PERROR(fmt, args...) _ERRMSG("PERROR", PRINT_ERR, fmt, ## args)
	91
	92	#if !defined(__linux__) \|\| ((_POSIX_C_SOURCE >= 200112L \|\| _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE))
	93
	94	/*
	95	* Version using XSI strerror_r.
	96	*/
	97	#define PERROR(call, args...) \
	98	do { \
	99	char buf[200]; \
	100	strerror_r(errno, buf, sizeof(buf)); \
	101	_PERROR(call ": %s", ## args, buf); \
	102	} while(0);
	103	#else
	104	/*
	105	* Version using GNU strerror_r, for linux with appropriate defines.
	106	*/
	107	#define PERROR(call, args...) \
	108	do { \
	109	char *buf; \
	110	char tmp[200]; \
	111	buf = strerror_r(errno, tmp, sizeof(tmp)); \
	112	_PERROR(call ": %s", ## args, buf); \
	113	} while(0);
	114	#endif
	115
	116	const char *error_get_str(int32_t code);
	117
	118	#endif /* _ERROR_H */