pacemaker  1.1.24-3850484742
Scalable High-Availability cluster resource manager
logging.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2004 Andrew Beekhof <andrew@beekhof.net>
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This software is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
25 #ifndef CRM_LOGGING__H
26 # define CRM_LOGGING__H
27 # include <qb/qblog.h>
28 # ifndef LOG_TRACE
29 # define LOG_TRACE LOG_DEBUG+1
30 # endif
31 # define LOG_DEBUG_2 LOG_TRACE
32 # define LOG_DEBUG_3 LOG_TRACE
33 # define LOG_DEBUG_4 LOG_TRACE
34 # define LOG_DEBUG_5 LOG_TRACE
35 # define LOG_DEBUG_6 LOG_TRACE
36 
37 /* "Extended information" logging support */
38 #ifdef QB_XS
39 # define CRM_XS QB_XS
40 # define crm_extended_logging(t, e) qb_log_ctl((t), QB_LOG_CONF_EXTENDED, (e))
41 #else
42 # define CRM_XS "|"
43 
44 /* A caller might want to check the return value, so we can't define this as a
45  * no-op, and we can't simply define it to be 0 because gcc will then complain
46  * when the value isn't checked.
47  */
48 static inline int
49 crm_extended_logging(int t, int e)
50 {
51  return 0;
52 }
53 #endif
54 
55 extern unsigned int crm_log_level;
56 extern gboolean crm_config_error;
57 extern gboolean crm_config_warning;
58 extern unsigned int crm_trace_nonlog;
59 
61 {
64  xml_log_option_text = 0x0004, /* add this option to dump text into xml */
73 };
74 
75 void crm_enable_blackbox(int nsig);
76 void crm_disable_blackbox(int nsig);
77 void crm_write_blackbox(int nsig, struct qb_log_callsite *callsite);
78 
79 void crm_update_callsites(void);
80 
81 void crm_log_deinit(void);
82 
83 gboolean crm_log_cli_init(const char *entity);
84 
85 void crm_log_preinit(const char *entity, int argc, char **argv);
86 gboolean crm_log_init(const char *entity, uint8_t level, gboolean daemon,
87  gboolean to_stderr, int argc, char **argv, gboolean quiet);
88 
89 void crm_log_args(int argc, char **argv);
90 void crm_log_output_fn(const char *file, const char *function, int line, int level,
91  const char *prefix, const char *output);
92 # define crm_log_output(level, prefix, output) crm_log_output_fn(__FILE__, __FUNCTION__, __LINE__, level, prefix, output)
93 
94 gboolean crm_add_logfile(const char *filename);
95 
96 void crm_bump_log_level(int argc, char **argv);
97 
98 void crm_enable_stderr(int enable);
99 
100 gboolean crm_is_callsite_active(struct qb_log_callsite *cs, uint8_t level, uint32_t tags);
101 
102 void log_data_element(int log_level, const char *file, const char *function, int line,
103  const char *prefix, xmlNode * data, int depth, gboolean formatted);
104 char *crm_strdup_printf (char const *format, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
105 
106 /* returns the old value */
107 unsigned int set_crm_log_level(unsigned int level);
108 
109 unsigned int get_crm_log_level(void);
110 
111 /*
112  * Throughout the macros below, note the leading, pre-comma, space in the
113  * various ' , ##args' occurrences to aid portability across versions of 'gcc'.
114  * http://gcc.gnu.org/onlinedocs/cpp/Variadic-Macros.html#Variadic-Macros
115  */
116 #if defined(__clang__)
117 # define CRM_TRACE_INIT_DATA(name)
118 # else
119 # define CRM_TRACE_INIT_DATA(name) QB_LOG_INIT_DATA(name)
120 #endif
121 
129 # define do_crm_log(level, fmt, args...) \
130  qb_log_from_external_source(__func__, __FILE__, fmt, level, __LINE__, 0 , ##args)
131 
139 # define do_crm_log_unlikely(level, fmt, args...) do { \
140  static struct qb_log_callsite *trace_cs = NULL; \
141  if(trace_cs == NULL) { \
142  trace_cs = qb_log_callsite_get(__func__, __FILE__, fmt, level, __LINE__, 0); \
143  } \
144  if (crm_is_callsite_active(trace_cs, level, 0)) { \
145  qb_log_from_external_source( \
146  __func__, __FILE__, fmt, level, __LINE__, 0 , ##args); \
147  } \
148  } while(0)
149 
164 # define pcmk__log_else(level, else_action) do { \
165  static struct qb_log_callsite *trace_cs = NULL; \
166  \
167  if (trace_cs == NULL) { \
168  trace_cs = qb_log_callsite_get(__func__, __FILE__, "log_else", \
169  level, __LINE__, 0); \
170  } \
171  if (!crm_is_callsite_active(trace_cs, level, 0)) { \
172  else_action; \
173  } \
174  } while(0)
175 
176 # define CRM_LOG_ASSERT(expr) do { \
177  if(__unlikely((expr) == FALSE)) { \
178  static struct qb_log_callsite *core_cs = NULL; \
179  if(core_cs == NULL) { \
180  core_cs = qb_log_callsite_get(__func__, __FILE__, "log-assert", LOG_TRACE, __LINE__, 0); \
181  } \
182  crm_abort(__FILE__, __FUNCTION__, __LINE__, #expr, \
183  core_cs?core_cs->targets:FALSE, TRUE); \
184  } \
185  } while(0)
186 
187 /* 'failure_action' MUST NOT be 'continue' as it will apply to the
188  * macro's do-while loop
189  */
190 # define CRM_CHECK(expr, failure_action) do { \
191  if(__unlikely((expr) == FALSE)) { \
192  static struct qb_log_callsite *core_cs = NULL; \
193  if(core_cs == NULL) { \
194  core_cs = qb_log_callsite_get(__func__, __FILE__, "check-assert", LOG_TRACE, __LINE__, 0); \
195  } \
196  crm_abort(__FILE__, __FUNCTION__, __LINE__, #expr, \
197  core_cs?core_cs->targets:FALSE, TRUE); \
198  failure_action; \
199  } \
200  } while(0)
201 
202 # define do_crm_log_xml(level, text, xml) do { \
203  static struct qb_log_callsite *xml_cs = NULL; \
204  if(xml_cs == NULL) { \
205  xml_cs = qb_log_callsite_get(__func__, __FILE__, "xml-blob", level, __LINE__, 0); \
206  } \
207  if (crm_is_callsite_active(xml_cs, level, 0)) { \
208  log_data_element(level, __FILE__, __FUNCTION__, __LINE__, text, xml, 1, xml_log_option_formatted); \
209  } \
210  } while(0)
211 
222 # define do_crm_log_alias(level, file, function, line, fmt, args...) do { \
223  if(level > 0) { \
224  qb_log_from_external_source(function, file, fmt, level, line, 0 , ##args); \
225  } else { \
226  printf(fmt "\n" , ##args); \
227  } \
228  } while(0)
229 
239 # define do_crm_log_always(level, fmt, args...) qb_log(level, fmt , ##args)
240 
252 # define crm_perror(level, fmt, args...) do { \
253  const char *err = strerror(errno); \
254  /* cast to int makes coverity happy when level == 0 */ \
255  if (level <= (int)crm_log_level) { \
256  fprintf(stderr, fmt ": %s (%d)\n" , ##args, err, errno); \
257  } \
258  do_crm_log(level, fmt ": %s (%d)" , ##args, err, errno); \
259  } while(0)
260 
261 # define crm_log_tag(level, tag, fmt, args...) do { \
262  static struct qb_log_callsite *trace_tag_cs = NULL; \
263  int converted_tag = g_quark_try_string(tag); \
264  if(trace_tag_cs == NULL) { \
265  trace_tag_cs = qb_log_callsite_get(__func__, __FILE__, fmt, level, __LINE__, converted_tag); \
266  } \
267  if (crm_is_callsite_active(trace_tag_cs, level, converted_tag)) { \
268  qb_log_from_external_source(__func__, __FILE__, fmt, level, \
269  __LINE__, converted_tag , ##args); \
270  } \
271  } while(0)
272 
273 # define crm_crit(fmt, args...) qb_logt(LOG_CRIT, 0, fmt , ##args)
274 # define crm_err(fmt, args...) qb_logt(LOG_ERR, 0, fmt , ##args)
275 # define crm_warn(fmt, args...) qb_logt(LOG_WARNING, 0, fmt , ##args)
276 # define crm_notice(fmt, args...) qb_logt(LOG_NOTICE, 0, fmt , ##args)
277 # define crm_info(fmt, args...) qb_logt(LOG_INFO, 0, fmt , ##args)
278 
279 # define crm_debug(fmt, args...) do_crm_log_unlikely(LOG_DEBUG, fmt , ##args)
280 # define crm_trace(fmt, args...) do_crm_log_unlikely(LOG_TRACE, fmt , ##args)
281 
282 # define crm_log_xml_crit(xml, text) do_crm_log_xml(LOG_CRIT, text, xml)
283 # define crm_log_xml_err(xml, text) do_crm_log_xml(LOG_ERR, text, xml)
284 # define crm_log_xml_warn(xml, text) do_crm_log_xml(LOG_WARNING, text, xml)
285 # define crm_log_xml_notice(xml, text) do_crm_log_xml(LOG_NOTICE, text, xml)
286 # define crm_log_xml_info(xml, text) do_crm_log_xml(LOG_INFO, text, xml)
287 # define crm_log_xml_debug(xml, text) do_crm_log_xml(LOG_DEBUG, text, xml)
288 # define crm_log_xml_trace(xml, text) do_crm_log_xml(LOG_TRACE, text, xml)
289 
290 # define crm_log_xml_explicit(xml, text) do { \
291  static struct qb_log_callsite *digest_cs = NULL; \
292  digest_cs = qb_log_callsite_get( \
293  __func__, __FILE__, text, LOG_TRACE, __LINE__, \
294  crm_trace_nonlog); \
295  if (digest_cs && digest_cs->targets) { \
296  do_crm_log_xml(LOG_TRACE, text, xml); \
297  } \
298  } while(0)
299 
300 # define crm_str(x) (const char*)(x?x:"<null>")
301 
302 #endif
void crm_write_blackbox(int nsig, struct qb_log_callsite *callsite)
Definition: logging.c:435
void crm_enable_stderr(int enable)
Definition: logging.c:921
void log_data_element(int log_level, const char *file, const char *function, int line, const char *prefix, xmlNode *data, int depth, gboolean formatted)
char unsigned int set_crm_log_level(unsigned int level)
Definition: logging.c:910
gboolean crm_log_init(const char *entity, uint8_t level, gboolean daemon, gboolean to_stderr, int argc, char **argv, gboolean quiet)
Definition: logging.c:767
unsigned int crm_trace_nonlog
Definition: logging.c:50
gboolean crm_log_cli_init(const char *entity)
Definition: logging.c:492
void crm_bump_log_level(int argc, char **argv)
Definition: logging.c:933
void crm_log_deinit(void)
Definition: logging.c:182
gboolean crm_config_error
Definition: utils.c:59
int daemon(int nochdir, int noclose)
void crm_log_output_fn(const char *file, const char *function, int line, int level, const char *prefix, const char *output)
Definition: logging.c:1423
void crm_enable_blackbox(int nsig)
Definition: logging.c:423
enum crm_proc_flag __attribute__
xml_log_options
Definition: logging.h:60
void crm_log_args(int argc, char **argv)
Definition: logging.c:958
void crm_log_preinit(const char *entity, int argc, char **argv)
Definition: logging.c:717
gboolean crm_is_callsite_active(struct qb_log_callsite *cs, uint8_t level, uint32_t tags)
Definition: logging.c:602
unsigned int get_crm_log_level(void)
Definition: logging.c:951
unsigned int crm_log_level
Definition: logging.c:48
void crm_disable_blackbox(int nsig)
Definition: logging.c:429
gboolean crm_config_warning
Definition: utils.c:60
#define uint32_t
Definition: stdint.in.h:158
char data[0]
Definition: internal.h:86
#define uint8_t
Definition: stdint.in.h:144
gboolean crm_add_logfile(const char *filename)
Definition: logging.c:224
char * crm_strdup_printf(char const *format,...) __attribute__((__format__(__printf__
void crm_update_callsites(void)
Definition: logging.c:631