/*
* 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 as published by the Free
- * Software Foundation; only version 2 of the License.
- *
+ * 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., 59 Temple
- * Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * 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
#include <errno.h>
#include <stdio.h>
+#include <stdint.h>
#include <string.h>
+#include <stdbool.h>
+#include <urcu/tls-compat.h>
+#include <common/compat/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
-extern int opt_quiet;
-extern int opt_verbose;
+/*
+ * 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. */
+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;
+}
-#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
+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 (opt_quiet == 0) { \
- if (type == PRINT_MSG) { \
- fprintf(stdout, fmt, ## args); \
- } else if (((type & PRINT_DBG) && opt_verbose == 1) || \
- ((type & (PRINT_DBG | PRINT_DBG2)) && \
- opt_verbose == 2) || \
- ((type & (PRINT_DBG | PRINT_DBG2 | PRINT_DBG3)) && \
- opt_verbose == 3)) { \
- fprintf(stderr, fmt, ## args); \
- } else if (type & (PRINT_ERR | PRINT_WARN | PRINT_BUG)) { \
- fprintf(stderr, fmt, ## args); \
- } \
- } \
- } while (0);
+#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...) __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 _ERRMSG_NO_LOC(msg, type, fmt, args...) __lttng_print(type, msg \
+ " - %s [%ld/%ld]: " fmt "\n", \
+ log_add_time(), (long) getpid(), (long) gettid(), ## args)
#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...) \
- __lttng_print(PRINT_BUG, "BUG: " fmt "\n", ## args)
-/* Three level of debug. Use -v, -vv or -vvv for the levels */
-#define DBG(fmt, args...) __lttng_print(PRINT_DBG, "DEBUG1: " fmt \
- " [in %s() at " __FILE__ ":" XSTR(__LINE__) "]\n", ## args, __func__)
-#define DBG2(fmt, args...) __lttng_print(PRINT_DBG2, "DEBUG2: " fmt \
- " [in %s() at " __FILE__ ":" XSTR(__LINE__) "]\n", ## args, __func__)
-#define DBG3(fmt, args...) __lttng_print(PRINT_DBG3, "DEBUG3: " fmt \
- " [in %s() at " __FILE__ ":" XSTR(__LINE__) "]\n", ## args, __func__)
+#define BUG(fmt, args...) _ERRMSG("BUG", PRINT_BUG, fmt, ## args)
-#define _PERROR(fmt, args...) \
- __lttng_print(PRINT_ERR, "perror " fmt "\n", ## args)
+#define DBG(fmt, args...) _ERRMSG("DEBUG1", PRINT_DBG, fmt, ## args)
+#define DBG_NO_LOC(fmt, args...) _ERRMSG_NO_LOC("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(__GLIBC__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE))
-#if !defined(__linux__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE))
/*
* Version using XSI strerror_r.
*/
} 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 */
projects / lttng-tools.git / blobdiff