Add BT_LOG*_ERRNO() logging macros

[babeltrace.git] / include / babeltrace / logging-internal.h

diff --git a/include/babeltrace/logging-internal.h b/include/babeltrace/logging-internal.h
index e9ce365e19281f8b478960f760b9ccbe68b505b1..13a36441c56dd29f336ce109440fd666b187bf1b 100644 (file)
--- a/include/babeltrace/logging-internal.h
+++ b/include/babeltrace/logging-internal.h
@@ -156,7 +156,11 @@
 #if defined(BT_LOG_OUTPUT_LEVEL)
        #define _BT_LOG_OUTPUT_LEVEL BT_LOG_OUTPUT_LEVEL
 #else
-       #define _BT_LOG_OUTPUT_LEVEL _bt_log_global_output_lvl
+       /*
+        * We disallow this to make sure Babeltrace modules always
+        * have their own local log level.
+        */
+       #error No log level symbol specified: please define BT_LOG_OUTPUT_LEVEL before including this header.
 #endif
 
 /* "Tag" is a compound string that could be associated with a log message. It
@@ -439,6 +443,9 @@
 #if defined(__printflike)
        #define _BT_LOG_PRINTFLIKE(str_index, first_to_check) \
                __printflike(str_index, first_to_check)
+#elif defined(__MINGW_PRINTF_FORMAT)
+       #define _BT_LOG_PRINTFLIKE(str_index, first_to_check) \
+               __attribute__((format(__MINGW_PRINTF_FORMAT, str_index, first_to_check)))
 #elif defined(__GNUC__)
        #define _BT_LOG_PRINTFLIKE(str_index, first_to_check) \
                __attribute__((format(__printf__, str_index, first_to_check)))
@@ -728,6 +735,14 @@ void _bt_log_write_mem_aux(
  * - BT_LOGE("format string", args, ...)
  * - BT_LOGF("format string", args, ...)
  *
+ * Message and error string (errno) logging macros:
+ * - BT_LOGV_ERRNO("format string", args, ...)
+ * - BT_LOGD_ERRNO("format string", args, ...)
+ * - BT_LOGI_ERRNO("format string", args, ...)
+ * - BT_LOGW_ERRNO("format string", args, ...)
+ * - BT_LOGE_ERRNO("format string", args, ...)
+ * - BT_LOGF_ERRNO("format string", args, ...)
+ *
  * Memory logging macros:
  * - BT_LOGV_MEM(data_ptr, data_sz, "format string", args, ...)
  * - BT_LOGD_MEM(data_ptr, data_sz, "format string", args, ...)
@@ -822,6 +837,26 @@ void _bt_log_write_mem_aux(
                        } _BT_LOG_ONCE
 #endif
 
+#if (_POSIX_C_SOURCE >= 200112L) && !  _GNU_SOURCE
+       /* XSI-compliant version of strerror_r(). */
+       #define BT_LOG_WRITE_ERRNO(lvl, tag, _msg, _fmt, args...) \
+                       do { \
+                               char error_str[BUFSIZ]; \
+                               memset(error_str, 0, sizeof(error_str)); \
+                               (void) strerror_r(errno, error_str, sizeof(error_str)); \
+                               BT_LOG_WRITE(lvl, tag, _msg ": %s. " _fmt, error_str, ## args); \
+                       } _BT_LOG_ONCE
+#else
+       /* GNU version of strerror_r(). */
+       #define BT_LOG_WRITE_ERRNO(lvl, tag, _msg, _fmt, args...) \
+                       do { \
+                               char error_str_buf[BUFSIZ]; \
+                               char *error_str; \
+                               error_str = strerror_r(errno, error_str_buf, sizeof(error_str_buf)); \
+                               BT_LOG_WRITE(lvl, tag, _msg ": %s. " _fmt, error_str, ## args); \
+                       } _BT_LOG_ONCE
+#endif
+
 static _BT_LOG_INLINE void _bt_log_unused(const int dummy, ...) {(void)dummy;}
 
 #define _BT_LOG_UNUSED(...) \
@@ -830,6 +865,8 @@ static _BT_LOG_INLINE void _bt_log_unused(const int dummy, ...) {(void)dummy;}
 #if BT_LOG_ENABLED_VERBOSE
        #define BT_LOGV(...) \
                        BT_LOG_WRITE(BT_LOG_VERBOSE, _BT_LOG_TAG, __VA_ARGS__)
+       #define BT_LOGV_ERRNO(...) \
+                       BT_LOG_WRITE_ERRNO(BT_LOG_VERBOSE, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGV_AUX(log, ...) \
                        BT_LOG_WRITE_AUX(log, BT_LOG_VERBOSE, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGV_MEM(d, d_sz, ...) \
@@ -846,6 +883,8 @@ static _BT_LOG_INLINE void _bt_log_unused(const int dummy, ...) {(void)dummy;}
 #if BT_LOG_ENABLED_DEBUG
        #define BT_LOGD(...) \
                        BT_LOG_WRITE(BT_LOG_DEBUG, _BT_LOG_TAG, __VA_ARGS__)
+       #define BT_LOGD_ERRNO(...) \
+                       BT_LOG_WRITE_ERRNO(BT_LOG_DEBUG, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGD_AUX(log, ...) \
                        BT_LOG_WRITE_AUX(log, BT_LOG_DEBUG, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGD_MEM(d, d_sz, ...) \
@@ -862,6 +901,8 @@ static _BT_LOG_INLINE void _bt_log_unused(const int dummy, ...) {(void)dummy;}
 #if BT_LOG_ENABLED_INFO
        #define BT_LOGI(...) \
                        BT_LOG_WRITE(BT_LOG_INFO, _BT_LOG_TAG, __VA_ARGS__)
+       #define BT_LOGI_ERRNO(...) \
+                       BT_LOG_WRITE_ERRNO(BT_LOG_INFO, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGI_AUX(log, ...) \
                        BT_LOG_WRITE_AUX(log, BT_LOG_INFO, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGI_MEM(d, d_sz, ...) \
@@ -878,6 +919,8 @@ static _BT_LOG_INLINE void _bt_log_unused(const int dummy, ...) {(void)dummy;}
 #if BT_LOG_ENABLED_WARN
        #define BT_LOGW(...) \
                        BT_LOG_WRITE(BT_LOG_WARN, _BT_LOG_TAG, __VA_ARGS__)
+       #define BT_LOGW_ERRNO(...) \
+                       BT_LOG_WRITE_ERRNO(BT_LOG_WARN, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGW_AUX(log, ...) \
                        BT_LOG_WRITE_AUX(log, BT_LOG_WARN, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGW_MEM(d, d_sz, ...) \
@@ -894,6 +937,8 @@ static _BT_LOG_INLINE void _bt_log_unused(const int dummy, ...) {(void)dummy;}
 #if BT_LOG_ENABLED_ERROR
        #define BT_LOGE(...) \
                        BT_LOG_WRITE(BT_LOG_ERROR, _BT_LOG_TAG, __VA_ARGS__)
+       #define BT_LOGE_ERRNO(...) \
+                       BT_LOG_WRITE_ERRNO(BT_LOG_ERROR, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGE_AUX(log, ...) \
                        BT_LOG_WRITE_AUX(log, BT_LOG_ERROR, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGE_MEM(d, d_sz, ...) \
@@ -910,6 +955,8 @@ static _BT_LOG_INLINE void _bt_log_unused(const int dummy, ...) {(void)dummy;}
 #if BT_LOG_ENABLED_FATAL
        #define BT_LOGF(...) \
                        BT_LOG_WRITE(BT_LOG_FATAL, _BT_LOG_TAG, __VA_ARGS__)
+       #define BT_LOGF_ERRNO(...) \
+                       BT_LOG_WRITE_ERRNO(BT_LOG_FATAL, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGF_AUX(log, ...) \
                        BT_LOG_WRITE_AUX(log, BT_LOG_FATAL, _BT_LOG_TAG, __VA_ARGS__)
        #define BT_LOGF_MEM(d, d_sz, ...) \
@@ -947,6 +994,8 @@ extern "C" {
  *   bt_log_set_output_v(BT_LOG_OUT_STDERR);
  */
 enum { BT_LOG_OUT_STDERR_MASK = BT_LOG_PUT_STD };
+
+BT_HIDDEN
 void bt_log_out_stderr_callback(const bt_log_message *const msg, void *arg);
 #define BT_LOG_OUT_STDERR BT_LOG_OUT_STDERR_MASK, 0, bt_log_out_stderr_callback
 
@@ -1000,8 +1049,19 @@ end:
        return level;
 }
 
+#define BT_LOG_LEVEL_EXTERN_SYMBOL(_level_sym)                         \
+       extern int _level_sym
+
+#define BT_LOG_INIT_LOG_LEVEL(_level_sym, _env_var)                    \
+       BT_HIDDEN int _level_sym = BT_LOG_NONE;                         \
+       static                                                          \
+       void __attribute__((constructor)) _bt_log_level_ctor(void)      \
+       {                                                               \
+               _level_sym = bt_log_get_level_from_env(_env_var);       \
+       }
+
 #ifdef __cplusplus
 }
 #endif
 
-#endif
+#endif /* BABELTRACE_LOGGING_INTERNAL_H */