Commit | Line | Data |
---|---|---|
5e96a467 | 1 | /* |
c0c0989a | 2 | * SPDX-License-Identifier: LGPL-2.1-only |
30ffe279 | 3 | * |
c0c0989a MJ |
4 | * Copyright (C) 2009 Pierre-Marc Fournier |
5 | * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
30ffe279 NC |
6 | */ |
7 | ||
c6e6343c MJ |
8 | #ifndef _UST_COMMON_LOGGING_H |
9 | #define _UST_COMMON_LOGGING_H | |
c0c0989a | 10 | |
30ffe279 NC |
11 | #include <string.h> |
12 | #include <sys/types.h> | |
30ffe279 NC |
13 | #include <errno.h> |
14 | #include <stdarg.h> | |
2b6f4374 | 15 | #include <stdbool.h> |
30ffe279 | 16 | #include <stdio.h> |
c6e6343c MJ |
17 | |
18 | #include <lttng/ust-utils.h> | |
39313bf3 MJ |
19 | #include <urcu/compiler.h> |
20 | #include <urcu/system.h> | |
c6e6343c | 21 | |
9d315d6d MJ |
22 | #include "common/patient.h" |
23 | #include "common/compat/tid.h" | |
24 | #include "common/safe-snprintf.h" | |
30ffe279 | 25 | |
c6e6343c MJ |
26 | enum lttng_ust_log_level { |
27 | LTTNG_UST_LOG_LEVEL_UNKNOWN = 0, | |
39313bf3 | 28 | LTTNG_UST_LOG_LEVEL_SILENT, |
c6e6343c | 29 | LTTNG_UST_LOG_LEVEL_DEBUG, |
5e96a467 MD |
30 | }; |
31 | ||
39313bf3 | 32 | extern int lttng_ust_log_level /* enum lttng_ust_log_level */ |
1d18d519 | 33 | __attribute__((visibility("hidden"))); |
ddabe860 | 34 | |
39313bf3 MJ |
35 | /* |
36 | * Initialize the global log level from the "LTTNG_UST_DEBUG" environment | |
37 | * variable. | |
38 | * | |
39 | * This could end up being called concurrently by multiple threads but doesn't | |
40 | * require a mutex since the input is invariant across threads and the result | |
41 | * will be the same. | |
42 | * | |
43 | * Return the current log level to save the caller a second read of the global | |
44 | * log level. | |
45 | */ | |
46 | int lttng_ust_logging_init(void) | |
1d18d519 | 47 | __attribute__((visibility("hidden"))); |
5e96a467 | 48 | |
7bdd21a4 | 49 | #ifdef LTTNG_UST_DEBUG |
39313bf3 MJ |
50 | static inline |
51 | bool lttng_ust_logging_debug_enabled(void) | |
7bdd21a4 | 52 | { |
2b6f4374 | 53 | return true; |
7bdd21a4 MD |
54 | } |
55 | #else /* #ifdef LTTNG_UST_DEBUG */ | |
39313bf3 MJ |
56 | static inline |
57 | bool lttng_ust_logging_debug_enabled(void) | |
5e96a467 | 58 | { |
39313bf3 MJ |
59 | int current_log_level; |
60 | ||
61 | current_log_level = CMM_LOAD_SHARED(lttng_ust_log_level); | |
62 | ||
63 | /* If the global log level is unknown, lazy-initialize it. */ | |
64 | if (caa_unlikely(current_log_level == LTTNG_UST_LOG_LEVEL_UNKNOWN)) | |
65 | current_log_level = lttng_ust_logging_init(); | |
66 | ||
67 | return current_log_level == LTTNG_UST_LOG_LEVEL_DEBUG; | |
5e96a467 | 68 | } |
39313bf3 | 69 | #endif /* #ifdef LTTNG_UST_DEBUG */ |
5e96a467 | 70 | |
2b6f4374 MJ |
71 | /* |
72 | * The default component for error messages. | |
73 | */ | |
30ffe279 | 74 | #ifndef UST_COMPONENT |
30ffe279 NC |
75 | #define UST_COMPONENT libust |
76 | #endif | |
77 | ||
c6e6343c | 78 | #define LTTNG_UST_LOG_MAX_LEN 512 |
37ed587a | 79 | |
2b6f4374 MJ |
80 | /* |
81 | * We sometimes print in the tracing path, and tracing can occur in | |
30ffe279 NC |
82 | * signal handlers, so we must use a print method which is signal safe. |
83 | */ | |
c6e6343c | 84 | /* Can't use dynamic allocation. Limit ourselves to LTTNG_UST_LOG_MAX_LEN chars. */ |
648bb724 | 85 | /* Add end of string in case of buffer overflow. */ |
5e96a467 | 86 | #define sigsafe_print_err(fmt, args...) \ |
648bb724 | 87 | do { \ |
c6e6343c MJ |
88 | if (lttng_ust_logging_debug_enabled()) { \ |
89 | char ____buf[LTTNG_UST_LOG_MAX_LEN]; \ | |
7bdd21a4 MD |
90 | int ____saved_errno; \ |
91 | \ | |
92 | ____saved_errno = errno; /* signal-safety */ \ | |
93 | ust_safe_snprintf(____buf, sizeof(____buf), fmt, ## args); \ | |
94 | ____buf[sizeof(____buf) - 1] = 0; \ | |
516d12da | 95 | ust_patient_write(STDERR_FILENO, ____buf, strlen(____buf)); \ |
7bdd21a4 MD |
96 | errno = ____saved_errno; /* signal-safety */ \ |
97 | fflush(stderr); \ | |
98 | } \ | |
648bb724 | 99 | } while (0) |
30ffe279 | 100 | |
c6e6343c | 101 | #define LTTNG_UST_STR_COMPONENT lttng_ust_stringify(UST_COMPONENT) |
30ffe279 | 102 | |
5e96a467 MD |
103 | #define ERRMSG(fmt, args...) \ |
104 | do { \ | |
c6e6343c | 105 | sigsafe_print_err(LTTNG_UST_STR_COMPONENT "[%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" lttng_ust_stringify(__LINE__) ")\n", \ |
5e96a467 | 106 | (long) getpid(), \ |
0f029713 | 107 | (long) lttng_gettid(), \ |
5e96a467 | 108 | ## args, __func__); \ |
5e96a467 | 109 | } while(0) |
30ffe279 | 110 | |
7bdd21a4 MD |
111 | |
112 | #define DBG(fmt, args...) ERRMSG(fmt, ## args) | |
113 | #define DBG_raw(fmt, args...) sigsafe_print_err(fmt, ## args) | |
114 | #define WARN(fmt, args...) ERRMSG("Warning: " fmt, ## args) | |
115 | #define ERR(fmt, args...) ERRMSG("Error: " fmt, ## args) | |
116 | #define BUG(fmt, args...) ERRMSG("BUG: " fmt, ## args) | |
30ffe279 | 117 | |
b52af467 | 118 | #if !defined(__GLIBC__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE)) |
9fd26814 MD |
119 | /* |
120 | * Version using XSI strerror_r. | |
121 | */ | |
7bdd21a4 MD |
122 | #define PERROR(call, args...) \ |
123 | do { \ | |
c6e6343c | 124 | if (lttng_ust_logging_debug_enabled()) { \ |
4041a8a7 MJ |
125 | char perror_buf[200] = "Error in strerror_r()"; \ |
126 | strerror_r(errno, perror_buf, \ | |
127 | sizeof(perror_buf)); \ | |
128 | ERRMSG("Error: " call ": %s", ## args, \ | |
129 | perror_buf); \ | |
7bdd21a4 MD |
130 | } \ |
131 | } while(0) | |
30ffe279 | 132 | #else |
9fd26814 MD |
133 | /* |
134 | * Version using GNU strerror_r, for linux with appropriate defines. | |
135 | */ | |
7bdd21a4 MD |
136 | #define PERROR(call, args...) \ |
137 | do { \ | |
c6e6343c | 138 | if (lttng_ust_logging_debug_enabled()) { \ |
4041a8a7 MJ |
139 | char *perror_buf; \ |
140 | char perror_tmp[200]; \ | |
141 | perror_buf = strerror_r(errno, perror_tmp, \ | |
142 | sizeof(perror_tmp)); \ | |
143 | ERRMSG("Error: " call ": %s", ## args, \ | |
144 | perror_buf); \ | |
7bdd21a4 MD |
145 | } \ |
146 | } while(0) | |
30ffe279 NC |
147 | #endif |
148 | ||
5e96a467 MD |
149 | #define BUG_ON(condition) \ |
150 | do { \ | |
b5a3dfa5 | 151 | if (caa_unlikely(condition)) \ |
5e96a467 MD |
152 | ERR("condition not respected (BUG) on line %s:%d", __FILE__, __LINE__); \ |
153 | } while(0) | |
154 | #define WARN_ON(condition) \ | |
155 | do { \ | |
b5a3dfa5 | 156 | if (caa_unlikely(condition)) \ |
5e96a467 MD |
157 | WARN("condition not respected on line %s:%d", __FILE__, __LINE__); \ |
158 | } while(0) | |
30ffe279 NC |
159 | #define WARN_ON_ONCE(condition) WARN_ON(condition) |
160 | ||
c6e6343c | 161 | #endif /* _UST_COMMON_LOGGING_H */ |