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>
16 #include <ust-share.h>
20 UST_LOGLEVEL_UNKNOWN
= 0,
25 extern volatile enum ust_loglevel ust_loglevel
;
26 void init_usterr(void);
28 #ifdef LTTNG_UST_DEBUG
29 static inline int ust_debug(void)
33 #else /* #ifdef LTTNG_UST_DEBUG */
34 static inline int ust_debug(void)
36 return ust_loglevel
== UST_LOGLEVEL_DEBUG
;
38 #endif /* #else #ifdef LTTNG_UST_DEBUG */
41 //#error UST_COMPONENT is undefined
42 #define UST_COMPONENT libust
45 /* To stringify the expansion of a define */
46 #define UST_XSTR(d) UST_STR(d)
49 #define USTERR_MAX_LEN 512
51 /* We sometimes print in the tracing path, and tracing can occur in
52 * signal handlers, so we must use a print method which is signal safe.
55 extern int ust_safe_snprintf(char *str
, size_t n
, const char *fmt
, ...)
56 __attribute__ ((format (printf
, 3, 4)));
58 /* Can't use dynamic allocation. Limit ourselves to USTERR_MAX_LEN chars. */
59 /* Add end of string in case of buffer overflow. */
60 #define sigsafe_print_err(fmt, args...) \
63 char ____buf[USTERR_MAX_LEN]; \
64 int ____saved_errno; \
66 ____saved_errno = errno; /* signal-safety */ \
67 ust_safe_snprintf(____buf, sizeof(____buf), fmt, ## args); \
68 ____buf[sizeof(____buf) - 1] = 0; \
69 patient_write(STDERR_FILENO, ____buf, strlen(____buf)); \
70 errno = ____saved_errno; /* signal-safety */ \
75 #define UST_STR_COMPONENT UST_XSTR(UST_COMPONENT)
77 #define ERRMSG(fmt, args...) \
79 sigsafe_print_err(UST_STR_COMPONENT "[%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" UST_XSTR(__LINE__) ")\n", \
81 (long) lttng_gettid(), \
86 #define DBG(fmt, args...) ERRMSG(fmt, ## args)
87 #define DBG_raw(fmt, args...) sigsafe_print_err(fmt, ## args)
88 #define WARN(fmt, args...) ERRMSG("Warning: " fmt, ## args)
89 #define ERR(fmt, args...) ERRMSG("Error: " fmt, ## args)
90 #define BUG(fmt, args...) ERRMSG("BUG: " fmt, ## args)
92 #if !defined(__GLIBC__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE))
94 * Version using XSI strerror_r.
96 #define PERROR(call, args...) \
99 char buf[200] = "Error in strerror_r()"; \
100 strerror_r(errno, buf, sizeof(buf)); \
101 ERRMSG("Error: " call ": %s", ## args, buf); \
106 * Version using GNU strerror_r, for linux with appropriate defines.
108 #define PERROR(call, args...) \
113 buf = strerror_r(errno, tmp, sizeof(tmp)); \
114 ERRMSG("Error: " call ": %s", ## args, buf); \
119 #define BUG_ON(condition) \
121 if (caa_unlikely(condition)) \
122 ERR("condition not respected (BUG) on line %s:%d", __FILE__, __LINE__); \
124 #define WARN_ON(condition) \
126 if (caa_unlikely(condition)) \
127 WARN("condition not respected on line %s:%d", __FILE__, __LINE__); \
129 #define WARN_ON_ONCE(condition) WARN_ON(condition)
131 #endif /* _USTERR_SIGNAL_SAFE_H */