![[first]](../icons/first.png){kind=icon}
![[previous]](../icons/n_left.png){kind=icon}
![[next]](../icons/n_right.png){kind=icon}
![[last]](../icons/n_last.png){kind=icon}
![[top]](../icons/n_top.png){kind=icon}
![[bottom]](../icons/bottom.png){kind=icon}
![[index]](../icons/index.png){kind=icon}
![[help]](../icons/help.png){kind=icon}
*/
1 /*
2 * Copyright 2004-2022 the Pacemaker project contributors
3 *
4 * The version control history for this file may have further details.
5 *
6 * This source code is licensed under the GNU General Public License version 2
7 * or later (GPLv2+) WITHOUT ANY WARRANTY.
8 */
9
10 #ifndef PCMK__CRM_COMMON_LOGGING__H
11 # define PCMK__CRM_COMMON_LOGGING__H
12
13 # include <stdio.h>
14 # include <glib.h>
15 # include <qb/qblog.h>
16 # include <libxml/tree.h>
17
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21
22 /**
23 * \file
24 * \brief Wrappers for and extensions to libqb logging
25 * \ingroup core
26 */
27
28
29 /* Define custom log priorities.
30 *
31 * syslog(3) uses int for priorities, but libqb's struct qb_log_callsite uses
32 * uint8_t, so make sure they fit in the latter.
33 */
34
35 // Define something even less desired than debug
36 # ifndef LOG_TRACE
37 # define LOG_TRACE (LOG_DEBUG+1)
38 # endif
39
40 // Print message to stdout instead of logging it
41 # ifndef LOG_STDOUT
42 # define LOG_STDOUT 254
43 # endif
44
45 // Don't send message anywhere
46 # ifndef LOG_NEVER
47 # define LOG_NEVER 255
48 # endif
49
50 /* "Extended information" logging support */
51 #ifdef QB_XS
52 # define CRM_XS QB_XS
53 # define crm_extended_logging(t, e) qb_log_ctl((t), QB_LOG_CONF_EXTENDED, (e))
54 #else
55 # define CRM_XS "|"
56
57 /* A caller might want to check the return value, so we can't define this as a
58 * no-op, and we can't simply define it to be 0 because gcc will then complain
59 * when the value isn't checked.
60 */
61 static inline int
62 crm_extended_logging(int t, int e)
/* ![[first]](../icons/n_first.png)
![[top]](../icons/top.png)
*/
63 {
64 return 0;
65 }
66 #endif
67
68 extern unsigned int crm_log_level;
69 extern unsigned int crm_trace_nonlog;
70
71 /*! \deprecated Pacemaker library functions set this when a configuration
72 * error is found, which turns on extra messages at the end of
73 * processing. It should not be used directly and will be removed
74 * from the public C API in a future release.
75 */
76 extern gboolean crm_config_error;
77
78 /*! \deprecated Pacemaker library functions set this when a configuration
79 * warning is found, which turns on extra messages at the end of
80 * processing. It should not be used directly and will be removed
81 * from the public C API in a future release.
82 */
83 extern gboolean crm_config_warning;
84
85 enum xml_log_options
86 {
87 xml_log_option_filtered = 0x0001,
88 xml_log_option_formatted = 0x0002,
89 xml_log_option_text = 0x0004, /* add this option to dump text into xml */
90 xml_log_option_full_fledged = 0x0008, // Use libxml when converting XML to text
91 xml_log_option_diff_plus = 0x0010,
92 xml_log_option_diff_minus = 0x0020,
93 xml_log_option_diff_short = 0x0040,
94 xml_log_option_diff_all = 0x0100,
95 xml_log_option_dirty_add = 0x1000,
96 xml_log_option_open = 0x2000,
97 xml_log_option_children = 0x4000,
98 xml_log_option_close = 0x8000,
99 };
100
101 void crm_enable_blackbox(int nsig);
102 void crm_disable_blackbox(int nsig);
103 void crm_write_blackbox(int nsig, const struct qb_log_callsite *callsite);
104
105 void crm_update_callsites(void);
106
107 void crm_log_deinit(void);
108
109 /*!
110 * \brief Initializes the logging system and defaults to the least verbose output level
111 *
112 * \param[in] entity If not NULL, will be used as the identity for logging purposes
113 * \param[in] argc The number of command line parameters
114 * \param[in] argv The command line parameter values
115 */
116 void crm_log_preinit(const char *entity, int argc, char *const *argv);
117 gboolean crm_log_init(const char *entity, uint8_t level, gboolean daemon,
118 gboolean to_stderr, int argc, char **argv, gboolean quiet);
119
120 void crm_log_args(int argc, char **argv);
121 void crm_log_output_fn(const char *file, const char *function, int line, int level,
122 const char *prefix, const char *output);
123
124 // Log a block of text line by line
125 #define crm_log_output(level, prefix, output) \
126 crm_log_output_fn(__FILE__, __func__, __LINE__, level, prefix, output)
127
128 void crm_bump_log_level(int argc, char **argv);
129
130 void crm_enable_stderr(int enable);
131
132 gboolean crm_is_callsite_active(struct qb_log_callsite *cs, uint8_t level, uint32_t tags);
133
134 void log_data_element(int log_level, const char *file, const char *function,
135 int line, const char *prefix, const xmlNode *data,
136 int depth, gboolean formatted);
137
138 /* returns the old value */
139 unsigned int set_crm_log_level(unsigned int level);
140
141 unsigned int get_crm_log_level(void);
142
143 /*
144 * Throughout the macros below, note the leading, pre-comma, space in the
145 * various ' , ##args' occurrences to aid portability across versions of 'gcc'.
146 * https://gcc.gnu.org/onlinedocs/cpp/Variadic-Macros.html#Variadic-Macros
147 */
148 #if defined(__clang__)
149 # define CRM_TRACE_INIT_DATA(name)
150 # else
151 # include <assert.h> // required by QB_LOG_INIT_DATA() macro
152 # define CRM_TRACE_INIT_DATA(name) QB_LOG_INIT_DATA(name)
153 #endif
154
155 /* Using "switch" instead of "if" in these macro definitions keeps
156 * static analysis from complaining about constant evaluations
157 */
158
159 /*!
160 * \brief Log a message
161 *
162 * \param[in] level Priority at which to log the message
163 * \param[in] fmt printf-style format string literal for message
164 * \param[in] args Any arguments needed by format string
165 *
166 * \note This is a macro, and \p level may be evaluated more than once.
167 */
168 # define do_crm_log(level, fmt, args...) do { \
169 switch (level) { \
170 case LOG_STDOUT: \
171 printf(fmt "\n" , ##args); \
172 break; \
173 case LOG_NEVER: \
174 break; \
175 default: \
176 qb_log_from_external_source(__func__, __FILE__, fmt, \
177 (level), __LINE__, 0 , ##args); \
178 break; \
179 } \
180 } while (0)
181
182 /*!
183 * \brief Log a message that is likely to be filtered out
184 *
185 * \param[in] level Priority at which to log the message
186 * \param[in] fmt printf-style format string for message
187 * \param[in] args Any arguments needed by format string
188 *
189 * \note This is a macro, and \p level may be evaluated more than once.
190 * This does nothing when level is LOG_STDOUT.
191 */
192 # define do_crm_log_unlikely(level, fmt, args...) do { \
193 switch (level) { \
194 case LOG_STDOUT: case LOG_NEVER: \
195 break; \
196 default: { \
197 static struct qb_log_callsite *trace_cs = NULL; \
198 if (trace_cs == NULL) { \
199 trace_cs = qb_log_callsite_get(__func__, __FILE__, fmt, \
200 (level), __LINE__, 0); \
201 } \
202 if (crm_is_callsite_active(trace_cs, (level), 0)) { \
203 qb_log_from_external_source(__func__, __FILE__, fmt, \
204 (level), __LINE__, 0 , ##args); \
205 } \
206 } \
207 break; \
208 } \
209 } while (0)
210
211 # define CRM_LOG_ASSERT(expr) do { \
212 if (!(expr)) { \
213 static struct qb_log_callsite *core_cs = NULL; \
214 if(core_cs == NULL) { \
215 core_cs = qb_log_callsite_get(__func__, __FILE__, \
216 "log-assert", LOG_TRACE, \
217 __LINE__, 0); \
218 } \
219 crm_abort(__FILE__, __func__, __LINE__, #expr, \
220 core_cs?core_cs->targets:FALSE, TRUE); \
221 } \
222 } while(0)
223
224 /* 'failure_action' MUST NOT be 'continue' as it will apply to the
225 * macro's do-while loop
226 */
227 # define CRM_CHECK(expr, failure_action) do { \
228 if (!(expr)) { \
229 static struct qb_log_callsite *core_cs = NULL; \
230 if (core_cs == NULL) { \
231 core_cs = qb_log_callsite_get(__func__, __FILE__, \
232 "check-assert", \
233 LOG_TRACE, __LINE__, 0); \
234 } \
235 crm_abort(__FILE__, __func__, __LINE__, #expr, \
236 (core_cs? core_cs->targets: FALSE), TRUE); \
237 failure_action; \
238 } \
239 } while(0)
240
241 /*!
242 * \brief Log XML line-by-line in a formatted fashion
243 *
244 * \param[in] level Priority at which to log the messages
245 * \param[in] text Prefix for each line
246 * \param[in] xml XML to log
247 *
248 * \note This is a macro, and \p level may be evaluated more than once.
249 * This does nothing when level is LOG_STDOUT.
250 */
251 # define do_crm_log_xml(level, text, xml) do { \
252 switch (level) { \
253 case LOG_STDOUT: case LOG_NEVER: \
254 break; \
255 default: { \
256 static struct qb_log_callsite *xml_cs = NULL; \
257 if (xml_cs == NULL) { \
258 xml_cs = qb_log_callsite_get(__func__, __FILE__, \
259 "xml-blob", (level), __LINE__, 0); \
260 } \
261 if (crm_is_callsite_active(xml_cs, (level), 0)) { \
262 log_data_element((level), __FILE__, __func__, \
263 __LINE__, text, xml, 1, xml_log_option_formatted); \
264 } \
265 } \
266 break; \
267 } \
268 } while(0)
269
270 /*!
271 * \brief Log a message as if it came from a different code location
272 *
273 * \param[in] level Priority at which to log the message
274 * \param[in] file Source file name to use instead of __FILE__
275 * \param[in] function Source function name to use instead of __func__
276 * \param[in] line Source line number to use instead of __line__
277 * \param[in] fmt printf-style format string literal for message
278 * \param[in] args Any arguments needed by format string
279 *
280 * \note This is a macro, and \p level may be evaluated more than once.
281 */
282 # define do_crm_log_alias(level, file, function, line, fmt, args...) do { \
283 switch (level) { \
284 case LOG_STDOUT: \
285 printf(fmt "\n" , ##args); \
286 break; \
287 case LOG_NEVER: \
288 break; \
289 default: \
290 qb_log_from_external_source(function, file, fmt, (level), \
291 line, 0 , ##args); \
292 break; \
293 } \
294 } while (0)
295
296 /*!
297 * \brief Send a system error message to both the log and stderr
298 *
299 * \param[in] level Priority at which to log the message
300 * \param[in] fmt printf-style format string for message
301 * \param[in] args Any arguments needed by format string
302 *
303 * \deprecated One of the other logging functions should be used with
304 * pcmk_strerror() instead.
305 * \note This is a macro, and \p level may be evaluated more than once.
306 * \note Because crm_perror() adds the system error message and error number
307 * onto the end of fmt, that information will become extended information
308 * if CRM_XS is used inside fmt and will not show up in syslog.
309 */
310 # define crm_perror(level, fmt, args...) do { \
311 switch (level) { \
312 case LOG_NEVER: \
313 break; \
314 default: { \
315 const char *err = strerror(errno); \
316 /* cast to int makes coverity happy when level == 0 */ \
317 if ((level) <= (int) crm_log_level) { \
318 fprintf(stderr, fmt ": %s (%d)\n" , ##args, err, errno);\
319 } \
320 do_crm_log((level), fmt ": %s (%d)" , ##args, err, errno); \
321 } \
322 break; \
323 } \
324 } while (0)
325
326 /*!
327 * \brief Log a message with a tag (for use with PCMK_trace_tags)
328 *
329 * \param[in] level Priority at which to log the message
330 * \param[in] tag String to tag message with
331 * \param[in] fmt printf-style format string for message
332 * \param[in] args Any arguments needed by format string
333 *
334 * \note This is a macro, and \p level may be evaluated more than once.
335 * This does nothing when level is LOG_STDOUT.
336 */
337 # define crm_log_tag(level, tag, fmt, args...) do { \
338 switch (level) { \
339 case LOG_STDOUT: case LOG_NEVER: \
340 break; \
341 default: { \
342 static struct qb_log_callsite *trace_tag_cs = NULL; \
343 int converted_tag = g_quark_try_string(tag); \
344 if (trace_tag_cs == NULL) { \
345 trace_tag_cs = qb_log_callsite_get(__func__, __FILE__, \
346 fmt, (level), __LINE__, converted_tag); \
347 } \
348 if (crm_is_callsite_active(trace_tag_cs, (level), \
349 converted_tag)) { \
350 qb_log_from_external_source(__func__, __FILE__, fmt, \
351 (level), __LINE__, converted_tag , ##args); \
352 } \
353 } \
354 } \
355 } while (0)
356
357 # define crm_emerg(fmt, args...) qb_log(LOG_EMERG, fmt , ##args)
358 # define crm_crit(fmt, args...) qb_logt(LOG_CRIT, 0, fmt , ##args)
359 # define crm_err(fmt, args...) qb_logt(LOG_ERR, 0, fmt , ##args)
360 # define crm_warn(fmt, args...) qb_logt(LOG_WARNING, 0, fmt , ##args)
361 # define crm_notice(fmt, args...) qb_logt(LOG_NOTICE, 0, fmt , ##args)
362 # define crm_info(fmt, args...) qb_logt(LOG_INFO, 0, fmt , ##args)
363
364 # define crm_debug(fmt, args...) do_crm_log_unlikely(LOG_DEBUG, fmt , ##args)
365 # define crm_trace(fmt, args...) do_crm_log_unlikely(LOG_TRACE, fmt , ##args)
366
367 # define crm_log_xml_crit(xml, text) do_crm_log_xml(LOG_CRIT, text, xml)
368 # define crm_log_xml_err(xml, text) do_crm_log_xml(LOG_ERR, text, xml)
369 # define crm_log_xml_warn(xml, text) do_crm_log_xml(LOG_WARNING, text, xml)
370 # define crm_log_xml_notice(xml, text) do_crm_log_xml(LOG_NOTICE, text, xml)
371 # define crm_log_xml_info(xml, text) do_crm_log_xml(LOG_INFO, text, xml)
372 # define crm_log_xml_debug(xml, text) do_crm_log_xml(LOG_DEBUG, text, xml)
373 # define crm_log_xml_trace(xml, text) do_crm_log_xml(LOG_TRACE, text, xml)
374
375 # define crm_log_xml_explicit(xml, text) do { \
376 static struct qb_log_callsite *digest_cs = NULL; \
377 digest_cs = qb_log_callsite_get( \
378 __func__, __FILE__, text, LOG_TRACE, __LINE__, \
379 crm_trace_nonlog); \
380 if (digest_cs && digest_cs->targets) { \
381 do_crm_log_xml(LOG_TRACE, text, xml); \
382 } \
383 } while(0)
384
385 #if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
386 #include <crm/common/logging_compat.h>
387 #endif
388
389 #ifdef __cplusplus
390 }
391 #endif
392
393 #endif
![[last]](../icons/last.png){kind=icon}
![[bottom]](../icons/n_bottom.png){kind=icon}
*/