2 * SPDX-License-Identifier: LGPL-2.1-only
4 * Copyright (C) 2009 Pierre-Marc Fournier
5 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 #ifndef _USTERR_SIGNAL_SAFE_H
9 #define _USTERR_SIGNAL_SAFE_H
12 #include <sys/types.h>
17 #include "common/patient.h"
18 #include "common/compat/tid.h"
19 #include "common/safe-snprintf.h"
21 enum ust_err_loglevel
{
22 UST_ERR_LOGLEVEL_UNKNOWN
= 0,
23 UST_ERR_LOGLEVEL_NORMAL
,
24 UST_ERR_LOGLEVEL_DEBUG
,
27 extern volatile enum ust_err_loglevel ust_err_loglevel
28 __attribute__((visibility("hidden")));
30 void ust_err_init(void)
31 __attribute__((visibility("hidden")));
33 #ifdef LTTNG_UST_DEBUG
34 static inline bool ust_err_debug_enabled(void)
38 #else /* #ifdef LTTNG_UST_DEBUG */
39 static inline bool ust_err_debug_enabled(void)
41 return ust_err_loglevel
== UST_ERR_LOGLEVEL_DEBUG
;
43 #endif /* #else #ifdef LTTNG_UST_DEBUG */
46 * The default component for error messages.
49 #define UST_COMPONENT libust
52 /* To stringify the expansion of a define */
53 #define UST_XSTR(d) UST_STR(d)
56 #define UST_ERR_MAX_LEN 512
59 * We sometimes print in the tracing path, and tracing can occur in
60 * signal handlers, so we must use a print method which is signal safe.
62 /* Can't use dynamic allocation. Limit ourselves to UST_ERR_MAX_LEN chars. */
63 /* Add end of string in case of buffer overflow. */
64 #define sigsafe_print_err(fmt, args...) \
66 if (ust_err_debug_enabled()) { \
67 char ____buf[UST_ERR_MAX_LEN]; \
68 int ____saved_errno; \
70 ____saved_errno = errno; /* signal-safety */ \
71 ust_safe_snprintf(____buf, sizeof(____buf), fmt, ## args); \
72 ____buf[sizeof(____buf) - 1] = 0; \
73 ust_patient_write(STDERR_FILENO, ____buf, strlen(____buf)); \
74 errno = ____saved_errno; /* signal-safety */ \
79 #define UST_STR_COMPONENT UST_XSTR(UST_COMPONENT)
81 #define ERRMSG(fmt, args...) \
83 sigsafe_print_err(UST_STR_COMPONENT "[%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" UST_XSTR(__LINE__) ")\n", \
85 (long) lttng_gettid(), \
90 #define DBG(fmt, args...) ERRMSG(fmt, ## args)
91 #define DBG_raw(fmt, args...) sigsafe_print_err(fmt, ## args)
92 #define WARN(fmt, args...) ERRMSG("Warning: " fmt, ## args)
93 #define ERR(fmt, args...) ERRMSG("Error: " fmt, ## args)
94 #define BUG(fmt, args...) ERRMSG("BUG: " fmt, ## args)
96 #if !defined(__GLIBC__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE))
98 * Version using XSI strerror_r.
100 #define PERROR(call, args...) \
102 if (ust_err_debug_enabled()) { \
103 char perror_buf[200] = "Error in strerror_r()"; \
104 strerror_r(errno, perror_buf, \
105 sizeof(perror_buf)); \
106 ERRMSG("Error: " call ": %s", ## args, \
112 * Version using GNU strerror_r, for linux with appropriate defines.
114 #define PERROR(call, args...) \
116 if (ust_err_debug_enabled()) { \
118 char perror_tmp[200]; \
119 perror_buf = strerror_r(errno, perror_tmp, \
120 sizeof(perror_tmp)); \
121 ERRMSG("Error: " call ": %s", ## args, \
127 #define BUG_ON(condition) \
129 if (caa_unlikely(condition)) \
130 ERR("condition not respected (BUG) on line %s:%d", __FILE__, __LINE__); \
132 #define WARN_ON(condition) \
134 if (caa_unlikely(condition)) \
135 WARN("condition not respected on line %s:%d", __FILE__, __LINE__); \
137 #define WARN_ON_ONCE(condition) WARN_ON(condition)
139 #endif /* _USTERR_SIGNAL_SAFE_H */