X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Ferror.h;h=8af989e0436fd910678eb994fa7ebef48c63dd0a;hp=00519d840c65f20475b61c8b4ab43506728ad754;hb=0c818c97b35a36971c326171d9aea5b0a432ced9;hpb=7d9ad8800792b112461e469d774a0abb5ff06043 diff --git a/src/common/error.h b/src/common/error.h index 00519d840..8af989e04 100644 --- a/src/common/error.h +++ b/src/common/error.h @@ -1,29 +1,22 @@ /* - * Copyright (C) 2011 - David Goulet + * Copyright (C) 2011 David Goulet * - * 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. + * SPDX-License-Identifier: GPL-2.0-only * - * 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 +#include #include #include #include +#include #include -#include +#include +#include +#include #ifndef _GNU_SOURCE #error "lttng-tools error.h needs _GNU_SOURCE" @@ -32,6 +25,11 @@ #include #include +/* Avoid conflict with Solaris */ +#if defined(ERR) && defined(__sun__) +#undef ERR +#endif + /* Stringify the expansion of a define */ #define XSTR(d) STR(d) #define STR(s) #s @@ -42,23 +40,90 @@ * every time a log is fired. */ struct log_time { - /* Format: 00:00:00.000000 plus NULL byte. */ - char str[16]; + /* Format: 00:00:00.000000000 plus NULL byte. */ + char str[19]; }; extern 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. */ -#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 +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; +} + +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. @@ -68,29 +133,53 @@ extern int lttng_opt_mi; * 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); +#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(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) @@ -99,13 +188,14 @@ extern int lttng_opt_mi; #define ERR(fmt, args...) \ __lttng_print(PRINT_ERR, "Error: " fmt "\n", ## args) #define WARN(fmt, args...) \ - __lttng_print(PRINT_ERR, "Warning: " fmt "\n", ## 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 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) { \ @@ -137,28 +227,29 @@ extern int lttng_opt_mi; #define _PERROR(fmt, args...) _ERRMSG("PERROR", PRINT_ERR, fmt, ## args) -#if !defined(__linux__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE)) +#if !defined(__GLIBC__) || ((_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); +#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 *buf; \ - char tmp[200]; \ - buf = strerror_r(errno, tmp, sizeof(tmp)); \ - _PERROR(call ": %s", ## args, buf); \ - } while(0); +#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); @@ -168,6 +259,10 @@ const char *error_get_str(int32_t code); * the caller. On error, an empty string is returned thus no time will be * printed in the log. */ -const char *log_add_time(); +const char *log_add_time(void); + +/* Name must be a statically-allocated string. */ +LTTNG_HIDDEN +void logger_set_thread_name(const char *name, bool set_pthread_name); #endif /* _ERROR_H */