src/common/error.h

   1 /*
   2  * Copyright (C)  2011 - David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #ifndef _ERROR_H
  19 #define _ERROR_H
  20
  21 #include <errno.h>
  22 #include <stdio.h>
  23 #include <string.h>
  24
  25 #ifndef _GNU_SOURCE
  26 #error "lttng-tools error.h needs _GNU_SOURCE"
  27 #endif
  28
  29 /* Stringify the expansion of a define */
  30 #define XSTR(d) STR(d)
  31 #define STR(s) #s
  32
  33 extern int lttng_opt_quiet;
  34 extern int lttng_opt_verbose;
  35
  36 #define PRINT_ERR   0x1
  37 #define PRINT_WARN  0x2
  38 #define PRINT_BUG   0x3
  39 #define PRINT_MSG   0x4
  40 #define PRINT_DBG   0x10
  41 #define PRINT_DBG2  0x20
  42 #define PRINT_DBG3  0x30
  43
  44 /*
  45  * Macro for printing message depending on command line option and verbosity.
  46  */
  47 #define __lttng_print(type, fmt, args...)                           \
  48         do {                                                            \
  49                 if (lttng_opt_quiet == 0 && type == PRINT_MSG) {            \
  50                         fprintf(stdout, fmt, ## args);                          \
  51                 } else if (lttng_opt_quiet == 0 &&                          \
  52                                 (((type & PRINT_DBG) && lttng_opt_verbose == 1) ||  \
  53                                 ((type & (PRINT_DBG | PRINT_DBG2)) &&               \
  54                                         lttng_opt_verbose == 2) ||                      \
  55                                 ((type & (PRINT_DBG | PRINT_DBG2 | PRINT_DBG3)) &&  \
  56                                         lttng_opt_verbose == 3))) {                     \
  57                         fprintf(stderr, fmt, ## args);                          \
  58                 } else if (lttng_opt_quiet == 0 && (type & (PRINT_WARN))) { \
  59                         fprintf(stderr, fmt, ## args);                          \
  60                 } else if (type & (PRINT_ERR | PRINT_BUG)) {                \
  61                         fprintf(stderr, fmt, ## args);                          \
  62                 }                                                           \
  63         } while (0);
  64
  65 #define MSG(fmt, args...) \
  66         __lttng_print(PRINT_MSG, fmt "\n", ## args)
  67 #define _MSG(fmt, args...) \
  68         __lttng_print(PRINT_MSG, fmt, ## args)
  69 #define ERR(fmt, args...) \
  70         __lttng_print(PRINT_ERR, "Error: " fmt "\n", ## args)
  71 #define WARN(fmt, args...) \
  72         __lttng_print(PRINT_WARN, "Warning: " fmt "\n", ## args)
  73 #define BUG(fmt, args...) \
  74         __lttng_print(PRINT_BUG, "BUG: " fmt "\n", ## args)
  75
  76 /* Three level of debug. Use -v, -vv or -vvv for the levels */
  77 #define DBG(fmt, args...) __lttng_print(PRINT_DBG, "DEBUG1: " fmt \
  78                 " [in %s() at " __FILE__ ":" XSTR(__LINE__) "]\n", ## args, __func__)
  79 #define DBG2(fmt, args...) __lttng_print(PRINT_DBG2, "DEBUG2: " fmt \
  80                 " [in %s() at " __FILE__ ":" XSTR(__LINE__) "]\n", ## args, __func__)
  81 #define DBG3(fmt, args...) __lttng_print(PRINT_DBG3, "DEBUG3: " fmt \
  82                 " [in %s() at " __FILE__ ":" XSTR(__LINE__) "]\n", ## args, __func__)
  83
  84 #define _PERROR(fmt, args...) \
  85         __lttng_print(PRINT_ERR, "PERROR: " fmt \
  86                 " [in %s() at " __FILE__ ":" XSTR(__LINE__) "]\n", ## args, __func__)
  87
  88 #if !defined(__linux__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE))
  89
  90 /*
  91  * Version using XSI strerror_r.
  92  */
  93 #define PERROR(call, args...) \
  94         do { \
  95                 char buf[200]; \
  96                 strerror_r(errno, buf, sizeof(buf)); \
  97                 _PERROR(call ": %s", ## args, buf); \
  98         } while(0);
  99 #else
 100 /*
 101  * Version using GNU strerror_r, for linux with appropriate defines.
 102  */
 103 #define PERROR(call, args...) \
 104         do { \
 105                 char *buf; \
 106                 char tmp[200]; \
 107                 buf = strerror_r(errno, tmp, sizeof(tmp)); \
 108                 _PERROR(call ": %s", ## args, buf); \
 109         } while(0);
 110 #endif
 111
 112 #endif /* _ERROR_H */