include/lttng/usterr-signal-safe.h

   1 #ifndef _USTERR_SIGNAL_SAFE_H
   2 #define _USTERR_SIGNAL_SAFE_H
   3
   4 /*
   5  * Copyright (C) 2009  Pierre-Marc Fournier
   6  * Copyright (C) 2011  Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; version 2.1 of
  11  * the License.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  21  */
  22
  23 #include <string.h>
  24 #include <sys/types.h>
  25 #include <sys/syscall.h>
  26 #include <errno.h>
  27 #include <stdarg.h>
  28 #include <stdio.h>
  29
  30 #include <lttng/core.h>
  31 #include <lttng/share.h>
  32
  33 enum ust_loglevel {
  34         UST_LOGLEVEL_UNKNOWN = 0,
  35         UST_LOGLEVEL_NORMAL,
  36         UST_LOGLEVEL_DEBUG,
  37 };
  38
  39 extern volatile enum ust_loglevel ust_loglevel;
  40 void init_usterr(void);
  41
  42 static inline int ust_debug(void)
  43 {
  44         return ust_loglevel == UST_LOGLEVEL_DEBUG;
  45 }
  46
  47 #ifndef UST_COMPONENT
  48 //#error UST_COMPONENT is undefined
  49 #define UST_COMPONENT libust
  50 #endif
  51
  52 /* To stringify the expansion of a define */
  53 #define UST_XSTR(d) UST_STR(d)
  54 #define UST_STR(s) #s
  55
  56 #define USTERR_MAX_LEN  512
  57
  58 /* We sometimes print in the tracing path, and tracing can occur in
  59  * signal handlers, so we must use a print method which is signal safe.
  60  */
  61
  62 extern int ust_safe_snprintf(char *str, size_t n, const char *fmt, ...)
  63         __attribute__ ((format (printf, 3, 4)));
  64
  65 static inline void __attribute__ ((format (printf, 1, 2)))
  66         __check_ust_safe_fmt(const char *fmt, ...)
  67 {
  68 }
  69
  70 #define sigsafe_print_err(fmt, args...)                                 \
  71 {                                                                       \
  72         /* Can't use dynamic allocation. Limit ourselves to USTERR_MAX_LEN chars. */ \
  73         char ____buf[USTERR_MAX_LEN];                                   \
  74         int ____saved_errno;                                            \
  75                                                                         \
  76         /* Save the errno. */                                           \
  77         ____saved_errno = errno;                                        \
  78                                                                         \
  79         ust_safe_snprintf(____buf, sizeof(____buf), fmt, ## args);      \
  80                                                                         \
  81         /* Add end of string in case of buffer overflow. */             \
  82         ____buf[sizeof(____buf) - 1] = 0;                               \
  83                                                                         \
  84         patient_write(STDERR_FILENO, ____buf, strlen(____buf));         \
  85         /*                                                              \
  86          * Can't print errors because we are in the error printing code \
  87          * path.                                                        \
  88          */                                                             \
  89                                                                         \
  90         /* Restore errno, in order to be async-signal safe. */          \
  91         errno = ____saved_errno;                                        \
  92 }
  93
  94 #define UST_STR_COMPONENT UST_XSTR(UST_COMPONENT)
  95
  96 #define ERRMSG(fmt, args...)                    \
  97         do {                                    \
  98                 sigsafe_print_err(UST_STR_COMPONENT "[%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" UST_XSTR(__LINE__) ")\n",    \
  99                 (long) getpid(),                \
 100                 (long) syscall(SYS_gettid),     \
 101                 ## args, __func__);             \
 102                 fflush(stderr);                 \
 103         } while(0)
 104
 105 #ifdef UST_DEBUG
 106 # define DBG(fmt, args...)                      ERRMSG(fmt, ## args)
 107 # define DBG_raw(fmt, args...)                                  \
 108         do {                                                    \
 109                 sigsafe_print_err(fmt, ## args);                \
 110                 fflush(stderr);                                 \
 111         } while(0)
 112 #else
 113 # define DBG(fmt, args...)                                      \
 114         do {                                                    \
 115                 if (ust_debug())                                \
 116                         ERRMSG(fmt, ## args);                   \
 117         } while (0)
 118 # define DBG_raw(fmt, args...)                                  \
 119         do {                                                    \
 120                 if (ust_debug()) {                              \
 121                         sigsafe_print_err(fmt, ## args);        \
 122                         fflush(stderr);                         \
 123                 }                                               \
 124         } while(0)
 125 #endif
 126 #define WARN(fmt, args...) ERRMSG("Warning: " fmt, ## args)
 127 #define ERR(fmt, args...) ERRMSG("Error: " fmt, ## args)
 128 #define BUG(fmt, args...) ERRMSG("BUG: " fmt, ## args)
 129
 130 #if (_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE)
 131 #define PERROR(call, args...)\
 132         do { \
 133                 char buf[200] = "Error in strerror_r()"; \
 134                 strerror_r(errno, buf, sizeof(buf)); \
 135                 ERRMSG("Error: " call ": %s", ## args, buf); \
 136         } while(0);
 137 #else
 138 #define PERROR(call, args...)\
 139         do { \
 140                 char *buf; \
 141                 char tmp[200]; \
 142                 buf = strerror_r(errno, tmp, sizeof(tmp)); \
 143                 ERRMSG("Error: " call ": %s", ## args, buf); \
 144         } while(0);
 145 #endif
 146
 147 #define BUG_ON(condition)                                       \
 148         do {                                                    \
 149                 if (caa_unlikely(condition))                    \
 150                         ERR("condition not respected (BUG) on line %s:%d", __FILE__, __LINE__); \
 151         } while(0)
 152 #define WARN_ON(condition)                                      \
 153         do {                                                    \
 154                 if (caa_unlikely(condition))                    \
 155                         WARN("condition not respected on line %s:%d", __FILE__, __LINE__); \
 156         } while(0)
 157 #define WARN_ON_ONCE(condition) WARN_ON(condition)
 158
 159 #endif /* _USTERR_SIGNAL_SAFE_H */