X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=include%2Fusterr-signal-safe.h;h=868a0d8b81257d186cd5a788e40c1891058c52b7;hb=2792781482a58865c7504100d8c1ba6db41193d1;hp=d46b0f6a7af8929fbd9296dfc3bf29d37bdf179d;hpb=943a422e5d4259eea626eb7910b3d11ac39c5105;p=lttng-ust.git diff --git a/include/usterr-signal-safe.h b/include/usterr-signal-safe.h index d46b0f6a..868a0d8b 100644 --- a/include/usterr-signal-safe.h +++ b/include/usterr-signal-safe.h @@ -1,50 +1,51 @@ -#ifndef _USTERR_SIGNAL_SAFE_H -#define _USTERR_SIGNAL_SAFE_H - /* - * Copyright (C) 2009 Pierre-Marc Fournier - * Copyright (C) 2011 Mathieu Desnoyers - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; version 2.1 of - * the License. - * - * This library 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 - * Lesser General Public License for more details. + * SPDX-License-Identifier: LGPL-2.1-only * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + * Copyright (C) 2009 Pierre-Marc Fournier + * Copyright (C) 2011 Mathieu Desnoyers */ +#ifndef _USTERR_SIGNAL_SAFE_H +#define _USTERR_SIGNAL_SAFE_H + #include #include -#include #include #include +#include #include -#include -#include "lttng/ust-tid.h" - -enum ust_loglevel { - UST_LOGLEVEL_UNKNOWN = 0, - UST_LOGLEVEL_NORMAL, - UST_LOGLEVEL_DEBUG, +#include +#include "ust-tid.h" +#include "ust-snprintf.h" + +enum ust_err_loglevel { + UST_ERR_LOGLEVEL_UNKNOWN = 0, + UST_ERR_LOGLEVEL_NORMAL, + UST_ERR_LOGLEVEL_DEBUG, }; -extern volatile enum ust_loglevel ust_loglevel; -void init_usterr(void); +__attribute__((visibility("hidden"))) +extern volatile enum ust_err_loglevel ust_err_loglevel; -static inline int ust_debug(void) +__attribute__((visibility("hidden"))) +void ust_err_init(void); + +#ifdef LTTNG_UST_DEBUG +static inline bool ust_err_debug_enabled(void) +{ + return true; +} +#else /* #ifdef LTTNG_UST_DEBUG */ +static inline bool ust_err_debug_enabled(void) { - return ust_loglevel == UST_LOGLEVEL_DEBUG; + return ust_err_loglevel == UST_ERR_LOGLEVEL_DEBUG; } +#endif /* #else #ifdef LTTNG_UST_DEBUG */ +/* + * The default component for error messages. + */ #ifndef UST_COMPONENT -//#error UST_COMPONENT is undefined #define UST_COMPONENT libust #endif @@ -52,85 +53,72 @@ static inline int ust_debug(void) #define UST_XSTR(d) UST_STR(d) #define UST_STR(s) #s -#define USTERR_MAX_LEN 512 +#define UST_ERR_MAX_LEN 512 -/* We sometimes print in the tracing path, and tracing can occur in +/* + * We sometimes print in the tracing path, and tracing can occur in * signal handlers, so we must use a print method which is signal safe. */ - -extern int ust_safe_snprintf(char *str, size_t n, const char *fmt, ...) - __attribute__ ((format (printf, 3, 4))); - -static inline void __attribute__ ((format (printf, 1, 2))) - __check_ust_safe_fmt(const char *fmt, ...) -{ -} - -/* Can't use dynamic allocation. Limit ourselves to USTERR_MAX_LEN chars. */ +/* Can't use dynamic allocation. Limit ourselves to UST_ERR_MAX_LEN chars. */ /* Add end of string in case of buffer overflow. */ #define sigsafe_print_err(fmt, args...) \ do { \ - char ____buf[USTERR_MAX_LEN]; \ - int ____saved_errno; \ - ____saved_errno = errno; /* signal-safety */ \ - ust_safe_snprintf(____buf, sizeof(____buf), fmt, ## args); \ - ____buf[sizeof(____buf) - 1] = 0; \ - patient_write(STDERR_FILENO, ____buf, strlen(____buf)); \ - errno = ____saved_errno; /* signal-safety */ \ + if (ust_err_debug_enabled()) { \ + char ____buf[UST_ERR_MAX_LEN]; \ + int ____saved_errno; \ + \ + ____saved_errno = errno; /* signal-safety */ \ + ust_safe_snprintf(____buf, sizeof(____buf), fmt, ## args); \ + ____buf[sizeof(____buf) - 1] = 0; \ + ust_patient_write(STDERR_FILENO, ____buf, strlen(____buf)); \ + errno = ____saved_errno; /* signal-safety */ \ + fflush(stderr); \ + } \ } while (0) #define UST_STR_COMPONENT UST_XSTR(UST_COMPONENT) #define ERRMSG(fmt, args...) \ do { \ - sigsafe_print_err(UST_STR_COMPONENT "[%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" UST_XSTR(__LINE__) ")\n", \ + sigsafe_print_err(UST_STR_COMPONENT "[%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" UST_XSTR(__LINE__) ")\n", \ (long) getpid(), \ - (long) gettid(), \ + (long) lttng_gettid(), \ ## args, __func__); \ - fflush(stderr); \ } while(0) -#ifdef LTTNG_UST_DEBUG -# define DBG(fmt, args...) ERRMSG(fmt, ## args) -# define DBG_raw(fmt, args...) \ - do { \ - sigsafe_print_err(fmt, ## args); \ - fflush(stderr); \ + +#define DBG(fmt, args...) ERRMSG(fmt, ## args) +#define DBG_raw(fmt, args...) sigsafe_print_err(fmt, ## args) +#define WARN(fmt, args...) ERRMSG("Warning: " fmt, ## args) +#define ERR(fmt, args...) ERRMSG("Error: " fmt, ## args) +#define BUG(fmt, args...) ERRMSG("BUG: " 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 { \ + if (ust_err_debug_enabled()) { \ + char buf[200] = "Error in strerror_r()"; \ + strerror_r(errno, buf, sizeof(buf)); \ + ERRMSG("Error: " call ": %s", ## args, buf); \ + } \ } while(0) #else -# define DBG(fmt, args...) \ - do { \ - if (ust_debug()) \ - ERRMSG(fmt, ## args); \ - } while (0) -# define DBG_raw(fmt, args...) \ - do { \ - if (ust_debug()) { \ - sigsafe_print_err(fmt, ## args); \ - fflush(stderr); \ - } \ +/* + * Version using GNU strerror_r, for linux with appropriate defines. + */ +#define PERROR(call, args...) \ + do { \ + if (ust_err_debug_enabled()) { \ + char *buf; \ + char tmp[200]; \ + buf = strerror_r(errno, tmp, sizeof(tmp)); \ + ERRMSG("Error: " call ": %s", ## args, buf); \ + } \ } while(0) #endif -#define WARN(fmt, args...) ERRMSG("Warning: " fmt, ## args) -#define ERR(fmt, args...) ERRMSG("Error: " fmt, ## args) -#define BUG(fmt, args...) ERRMSG("BUG: " fmt, ## args) - -#if (_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE) -#define PERROR(call, args...)\ - do { \ - char buf[200] = "Error in strerror_r()"; \ - strerror_r(errno, buf, sizeof(buf)); \ - ERRMSG("Error: " call ": %s", ## args, buf); \ - } while(0); -#else -#define PERROR(call, args...)\ - do { \ - char *buf; \ - char tmp[200]; \ - buf = strerror_r(errno, tmp, sizeof(tmp)); \ - ERRMSG("Error: " call ": %s", ## args, buf); \ - } while(0); -#endif #define BUG_ON(condition) \ do { \