include/usterr.h

   1 /* Copyright (C) 2009  Pierre-Marc Fournier
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2.1 of the License, or (at your option) any later version.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  16  */
  17
  18 #ifndef USTERR_H
  19 #define USTERR_H
  20
  21 #include <string.h>
  22 #include <sys/types.h>
  23 #include <sys/syscall.h>
  24 #include <errno.h>
  25 #include <stdarg.h>
  26 #include <stdio.h>
  27
  28 #include "share.h"
  29
  30 #ifndef UST_COMPONENT
  31 //#error UST_COMPONENT is undefined
  32 #define UST_COMPONENT libust
  33 #endif
  34
  35 /* To stringify the expansion of a define */
  36 #define XSTR(d) STR(d)
  37 #define STR(s) #s
  38
  39 /* We sometimes print in the tracing path, and tracing can occur in
  40  * signal handlers, so we must use a print method which is signal safe.
  41  */
  42
  43 extern int ust_safe_snprintf(char *str, size_t n, const char *fmt, ...);
  44
  45 #define sigsafe_print_err(fmt, args...) \
  46 { \
  47         /* Can't use dynamic allocation. Limit ourselves to 250 chars. */ \
  48         char ____buf[250]; \
  49         int ____saved_errno; \
  50 \
  51         /* Save the errno. */ \
  52         ____saved_errno = errno; \
  53 \
  54         ust_safe_snprintf(____buf, sizeof(____buf), fmt, ## args); \
  55 \
  56         /* Add end of string in case of buffer overflow. */ \
  57         ____buf[sizeof(____buf)-1] = 0; \
  58 \
  59         patient_write(STDERR_FILENO, ____buf, strlen(____buf)); \
  60         /* Can't print errors because we are in the error printing code path. */ \
  61 \
  62         /* Restore errno, in order to be async-signal safe. */ \
  63         errno = ____saved_errno; \
  64 }
  65
  66 #define UST_STR_COMPONENT XSTR(UST_COMPONENT)
  67
  68 #define ERRMSG(fmt, args...) do { sigsafe_print_err(UST_STR_COMPONENT "[%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" XSTR(__LINE__) ")\n", (long) getpid(), (long) syscall(SYS_gettid), ## args, __func__); fflush(stderr); } while(0)
  69
  70 #ifdef UST_DEBUG
  71 # define DBG(fmt, args...) ERRMSG(fmt, ## args)
  72 # define DBG_raw(fmt, args...) do { sigsafe_print_err(fmt, ## args); fflush(stderr); } while(0)
  73 #else
  74 # define DBG(fmt, args...) do {} while(0)
  75 # define DBG_raw(fmt, args...) do {} while(0)
  76 #endif
  77 #define WARN(fmt, args...) ERRMSG("Warning: " fmt, ## args)
  78 #define ERR(fmt, args...) ERRMSG("Error: " fmt, ## args)
  79 #define BUG(fmt, args...) ERRMSG("BUG: " fmt, ## args)
  80
  81 #if (_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE)
  82 #define PERROR(call, args...)\
  83         do { \
  84                 char buf[200] = "Error in strerror_r()"; \
  85                 strerror_r(errno, buf, sizeof(buf)); \
  86                 ERRMSG("Error: " call ": %s", ## args, buf); \
  87         } while(0);
  88 #else
  89 #define PERROR(call, args...)\
  90         do { \
  91                 char *buf; \
  92                 char tmp[200]; \
  93                 buf = strerror_r(errno, tmp, sizeof(tmp)); \
  94                 ERRMSG("Error: " call ": %s", ## args, buf); \
  95         } while(0);
  96 #endif
  97
  98 #define BUG_ON(condition) do { if (unlikely(condition)) ERR("condition not respected (BUG)"); } while(0)
  99 #define WARN_ON(condition) do { if (unlikely(condition)) WARN("condition not respected on line %s:%d", __FILE__, __LINE__); } while(0)
 100 #define WARN_ON_ONCE(condition) WARN_ON(condition)
 101
 102 #endif /* USTERR_H */