pacemaker  2.1.0-7c3f660
Scalable High-Availability cluster resource manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Enumerations | Functions | Variables
logging.h File Reference
Core API

Wrappers for and extensions to libqb logging. More...

#include <stdio.h>
#include <glib.h>
#include <qb/qblog.h>
#include <libxml/tree.h>
#include <assert.h>
#include <crm/common/logging_compat.h>
Include dependency graph for logging.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define CRM_LOGGING__H
 
#define LOG_TRACE   (LOG_DEBUG+1)
 
#define LOG_STDOUT   254
 
#define LOG_NEVER   255
 
#define CRM_XS   "|"
 
#define crm_log_output(level, prefix, output)   crm_log_output_fn(__FILE__, __func__, __LINE__, level, prefix, output)
 
#define CRM_TRACE_INIT_DATA(name)   QB_LOG_INIT_DATA(name)
 
#define do_crm_log(level, fmt, args...)
 Log a message. More...
 
#define do_crm_log_unlikely(level, fmt, args...)
 Log a message that is likely to be filtered out. More...
 
#define CRM_LOG_ASSERT(expr)
 
#define CRM_CHECK(expr, failure_action)
 
#define do_crm_log_xml(level, text, xml)
 Log XML line-by-line in a formatted fashion. More...
 
#define do_crm_log_alias(level, file, function, line, fmt, args...)
 Log a message as if it came from a different code location. More...
 
#define crm_perror(level, fmt, args...)
 Send a system error message to both the log and stderr. More...
 
#define crm_log_tag(level, tag, fmt, args...)
 Log a message with a tag (for use with PCMK_trace_tags) More...
 
#define crm_emerg(fmt, args...)   qb_log(LOG_EMERG, fmt , ##args)
 
#define crm_crit(fmt, args...)   qb_logt(LOG_CRIT, 0, fmt , ##args)
 
#define crm_err(fmt, args...)   qb_logt(LOG_ERR, 0, fmt , ##args)
 
#define crm_warn(fmt, args...)   qb_logt(LOG_WARNING, 0, fmt , ##args)
 
#define crm_notice(fmt, args...)   qb_logt(LOG_NOTICE, 0, fmt , ##args)
 
#define crm_info(fmt, args...)   qb_logt(LOG_INFO, 0, fmt , ##args)
 
#define crm_debug(fmt, args...)   do_crm_log_unlikely(LOG_DEBUG, fmt , ##args)
 
#define crm_trace(fmt, args...)   do_crm_log_unlikely(LOG_TRACE, fmt , ##args)
 
#define crm_log_xml_crit(xml, text)   do_crm_log_xml(LOG_CRIT, text, xml)
 
#define crm_log_xml_err(xml, text)   do_crm_log_xml(LOG_ERR, text, xml)
 
#define crm_log_xml_warn(xml, text)   do_crm_log_xml(LOG_WARNING, text, xml)
 
#define crm_log_xml_notice(xml, text)   do_crm_log_xml(LOG_NOTICE, text, xml)
 
#define crm_log_xml_info(xml, text)   do_crm_log_xml(LOG_INFO, text, xml)
 
#define crm_log_xml_debug(xml, text)   do_crm_log_xml(LOG_DEBUG, text, xml)
 
#define crm_log_xml_trace(xml, text)   do_crm_log_xml(LOG_TRACE, text, xml)
 
#define crm_log_xml_explicit(xml, text)
 
#define crm_str(x)   (const char*)(x?x:"<null>")
 

Enumerations

enum  xml_log_options {
  xml_log_option_filtered = 0x0001, xml_log_option_formatted = 0x0002, xml_log_option_text = 0x0004, xml_log_option_full_fledged = 0x0008,
  xml_log_option_diff_plus = 0x0010, xml_log_option_diff_minus = 0x0020, xml_log_option_diff_short = 0x0040, xml_log_option_diff_all = 0x0100,
  xml_log_option_dirty_add = 0x1000, xml_log_option_open = 0x2000, xml_log_option_children = 0x4000, xml_log_option_close = 0x8000
}
 

Functions

void crm_enable_blackbox (int nsig)
 
void crm_disable_blackbox (int nsig)
 
void crm_write_blackbox (int nsig, struct qb_log_callsite *callsite)
 
void crm_update_callsites (void)
 
void crm_log_deinit (void)
 
void crm_log_preinit (const char *entity, int argc, char **argv)
 
gboolean crm_log_init (const char *entity, uint8_t level, gboolean daemon, gboolean to_stderr, int argc, char **argv, gboolean quiet)
 
void crm_log_args (int argc, char **argv)
 Log the command line (once) More...
 
void crm_log_output_fn (const char *file, const char *function, int line, int level, const char *prefix, const char *output)
 
void crm_bump_log_level (int argc, char **argv)
 Make logging more verbose. More...
 
void crm_enable_stderr (int enable)
 
gboolean crm_is_callsite_active (struct qb_log_callsite *cs, uint8_t level, uint32_t tags)
 
void log_data_element (int log_level, const char *file, const char *function, int line, const char *prefix, xmlNode *data, int depth, gboolean formatted)
 
unsigned int set_crm_log_level (unsigned int level)
 
unsigned int get_crm_log_level (void)
 

Variables

unsigned int crm_log_level
 
unsigned int crm_trace_nonlog
 
gboolean crm_config_error
 
gboolean crm_config_warning
 

Detailed Description

Wrappers for and extensions to libqb logging.

Definition in file logging.h.

Macro Definition Documentation

#define CRM_CHECK (   expr,
  failure_action 
)
Value:
do { \
if (!(expr)) { \
static struct qb_log_callsite *core_cs = NULL; \
if (core_cs == NULL) { \
core_cs = qb_log_callsite_get(__func__, __FILE__, \
"check-assert", \
LOG_TRACE, __LINE__, 0); \
} \
crm_abort(__FILE__, __func__, __LINE__, #expr, \
(core_cs? core_cs->targets: FALSE), TRUE); \
failure_action; \
} \
} while(0)
LOG_TRACE
#define LOG_TRACE
Definition: logging.h:36
crm_abort
void crm_abort(const char *file, const char *function, int line, const char *condition, gboolean do_core, gboolean do_fork)
Definition: utils.c:440

Definition at line 218 of file logging.h.

#define crm_crit (   fmt,
  args... 
)    qb_logt(LOG_CRIT, 0, fmt , ##args)

Definition at line 349 of file logging.h.

#define crm_debug (   fmt,
  args... 
)    do_crm_log_unlikely(LOG_DEBUG, fmt , ##args)

Definition at line 355 of file logging.h.

#define crm_emerg (   fmt,
  args... 
)    qb_log(LOG_EMERG, fmt , ##args)

Definition at line 348 of file logging.h.

#define crm_err (   fmt,
  args... 
)    qb_logt(LOG_ERR, 0, fmt , ##args)

Definition at line 350 of file logging.h.

#define crm_info (   fmt,
  args... 
)    qb_logt(LOG_INFO, 0, fmt , ##args)

Definition at line 353 of file logging.h.

#define CRM_LOG_ASSERT (   expr)
Value:
do { \
if (!(expr)) { \
static struct qb_log_callsite *core_cs = NULL; \
if(core_cs == NULL) { \
core_cs = qb_log_callsite_get(__func__, __FILE__, \
"log-assert", LOG_TRACE, \
__LINE__, 0); \
} \
crm_abort(__FILE__, __func__, __LINE__, #expr, \
core_cs?core_cs->targets:FALSE, TRUE); \
} \
} while(0)
LOG_TRACE
#define LOG_TRACE
Definition: logging.h:36
crm_abort
void crm_abort(const char *file, const char *function, int line, const char *condition, gboolean do_core, gboolean do_fork)
Definition: utils.c:440

Definition at line 202 of file logging.h.

#define crm_log_output (   level,
  prefix,
  output 
)    crm_log_output_fn(__FILE__, __func__, __LINE__, level, prefix, output)

Definition at line 117 of file logging.h.

#define crm_log_tag (   level,
  tag,
  fmt,
  args... 
)
Value:
do { \
switch (level) { \
case LOG_STDOUT: case LOG_NEVER: \
break; \
default: { \
static struct qb_log_callsite *trace_tag_cs = NULL; \
int converted_tag = g_quark_try_string(tag); \
if (trace_tag_cs == NULL) { \
trace_tag_cs = qb_log_callsite_get(__func__, __FILE__, \
fmt, (level), __LINE__, converted_tag); \
} \
if (crm_is_callsite_active(trace_tag_cs, (level), \
converted_tag)) { \
qb_log_from_external_source(__func__, __FILE__, fmt, \
(level), __LINE__, converted_tag , ##args); \
} \
} \
} \
} while (0)
LOG_NEVER
#define LOG_NEVER
Definition: logging.h:46
crm_is_callsite_active
gboolean crm_is_callsite_active(struct qb_log_callsite *cs, uint8_t level, uint32_t tags)
Definition: logging.c:626
LOG_STDOUT
#define LOG_STDOUT
Definition: logging.h:41

Log a message with a tag (for use with PCMK_trace_tags)

Parameters
[in]levelPriority at which to log the message
[in]tagString to tag message with
[in]fmtprintf-style format string for message
[in]argsAny arguments needed by format string
Note
This is a macro, and level may be evaluated more than once. This does nothing when level is LOG_STDOUT.

Definition at line 328 of file logging.h.

#define crm_log_xml_crit (   xml,
  text 
)    do_crm_log_xml(LOG_CRIT, text, xml)

Definition at line 358 of file logging.h.

#define crm_log_xml_debug (   xml,
  text 
)    do_crm_log_xml(LOG_DEBUG, text, xml)

Definition at line 363 of file logging.h.

#define crm_log_xml_err (   xml,
  text 
)    do_crm_log_xml(LOG_ERR, text, xml)

Definition at line 359 of file logging.h.

#define crm_log_xml_explicit (   xml,
  text 
)
Value:
do { \
static struct qb_log_callsite *digest_cs = NULL; \
digest_cs = qb_log_callsite_get( \
__func__, __FILE__, text, LOG_TRACE, __LINE__, \
crm_trace_nonlog); \
if (digest_cs && digest_cs->targets) { \
do_crm_log_xml(LOG_TRACE, text, xml); \
} \
} while(0)
LOG_TRACE
#define LOG_TRACE
Definition: logging.h:36
crm_trace_nonlog
unsigned int crm_trace_nonlog
Definition: logging.c:46
do_crm_log_xml
#define do_crm_log_xml(level, text, xml)
Log XML line-by-line in a formatted fashion.
Definition: logging.h:242

Definition at line 366 of file logging.h.

#define crm_log_xml_info (   xml,
  text 
)    do_crm_log_xml(LOG_INFO, text, xml)

Definition at line 362 of file logging.h.

#define crm_log_xml_notice (   xml,
  text 
)    do_crm_log_xml(LOG_NOTICE, text, xml)

Definition at line 361 of file logging.h.

#define crm_log_xml_trace (   xml,
  text 
)    do_crm_log_xml(LOG_TRACE, text, xml)

Definition at line 364 of file logging.h.

#define crm_log_xml_warn (   xml,
  text 
)    do_crm_log_xml(LOG_WARNING, text, xml)

Definition at line 360 of file logging.h.

#define CRM_LOGGING__H

Definition at line 21 of file logging.h.

#define crm_notice (   fmt,
  args... 
)    qb_logt(LOG_NOTICE, 0, fmt , ##args)

Definition at line 352 of file logging.h.

#define crm_perror (   level,
  fmt,
  args... 
)
Value:
do { \
switch (level) { \
case LOG_NEVER: \
break; \
default: { \
const char *err = strerror(errno); \
/* cast to int makes coverity happy when level == 0 */ \
if ((level) <= (int) crm_log_level) { \
fprintf(stderr, fmt ": %s (%d)\n" , ##args, err, errno);\
} \
do_crm_log((level), fmt ": %s (%d)" , ##args, err, errno); \
} \
break; \
} \
} while (0)
strerror
char * strerror(int errnum)
LOG_NEVER
#define LOG_NEVER
Definition: logging.h:46
do_crm_log
#define do_crm_log(level, fmt, args...)
Log a message.
Definition: logging.h:159
crm_log_level
unsigned int crm_log_level
Definition: logging.c:45

Send a system error message to both the log and stderr.

Parameters
[in]levelPriority at which to log the message
[in]fmtprintf-style format string for message
[in]argsAny arguments needed by format string
Deprecated:
One of the other logging functions should be used with pcmk_strerror() instead.
Note
This is a macro, and level may be evaluated more than once.
Because crm_perror() adds the system error message and error number onto the end of fmt, that information will become extended information if CRM_XS is used inside fmt and will not show up in syslog.

Definition at line 301 of file logging.h.

#define crm_str (   x)    (const char*)(x?x:"<null>")

Definition at line 376 of file logging.h.

#define crm_trace (   fmt,
  args... 
)    do_crm_log_unlikely(LOG_TRACE, fmt , ##args)

Definition at line 356 of file logging.h.

#define CRM_TRACE_INIT_DATA (   name)    QB_LOG_INIT_DATA(name)

Definition at line 143 of file logging.h.

#define crm_warn (   fmt,
  args... 
)    qb_logt(LOG_WARNING, 0, fmt , ##args)

Definition at line 351 of file logging.h.

#define CRM_XS   "|"

Definition at line 54 of file logging.h.

#define do_crm_log (   level,
  fmt,
  args... 
)
Value:
do { \
switch (level) { \
case LOG_STDOUT: \
printf(fmt "\n" , ##args); \
break; \
case LOG_NEVER: \
break; \
default: \
qb_log_from_external_source(__func__, __FILE__, fmt, \
(level), __LINE__, 0 , ##args); \
break; \
} \
} while (0)
LOG_NEVER
#define LOG_NEVER
Definition: logging.h:46
LOG_STDOUT
#define LOG_STDOUT
Definition: logging.h:41

Log a message.

Parameters
[in]levelPriority at which to log the message
[in]fmtprintf-style format string literal for message
[in]argsAny arguments needed by format string
Note
This is a macro, and level may be evaluated more than once.

Definition at line 159 of file logging.h.

#define do_crm_log_alias (   level,
  file,
  function,
  line,
  fmt,
  args... 
)
Value:
do { \
switch (level) { \
case LOG_STDOUT: \
printf(fmt "\n" , ##args); \
break; \
case LOG_NEVER: \
break; \
default: \
qb_log_from_external_source(function, file, fmt, (level), \
line, 0 , ##args); \
break; \
} \
} while (0)
LOG_NEVER
#define LOG_NEVER
Definition: logging.h:46
LOG_STDOUT
#define LOG_STDOUT
Definition: logging.h:41

Log a message as if it came from a different code location.

Parameters
[in]levelPriority at which to log the message
[in]fileSource file name to use instead of FILE
[in]functionSource function name to use instead of func
[in]lineSource line number to use instead of line
[in]fmtprintf-style format string literal for message
[in]argsAny arguments needed by format string
Note
This is a macro, and level may be evaluated more than once.

Definition at line 273 of file logging.h.

#define do_crm_log_unlikely (   level,
  fmt,
  args... 
)
Value:
do { \
switch (level) { \
case LOG_STDOUT: case LOG_NEVER: \
break; \
default: { \
static struct qb_log_callsite *trace_cs = NULL; \
if (trace_cs == NULL) { \
trace_cs = qb_log_callsite_get(__func__, __FILE__, fmt, \
(level), __LINE__, 0); \
} \
if (crm_is_callsite_active(trace_cs, (level), 0)) { \
qb_log_from_external_source(__func__, __FILE__, fmt, \
(level), __LINE__, 0 , ##args); \
} \
} \
break; \
} \
} while (0)
LOG_NEVER
#define LOG_NEVER
Definition: logging.h:46
crm_is_callsite_active
gboolean crm_is_callsite_active(struct qb_log_callsite *cs, uint8_t level, uint32_t tags)
Definition: logging.c:626
LOG_STDOUT
#define LOG_STDOUT
Definition: logging.h:41

Log a message that is likely to be filtered out.

Parameters
[in]levelPriority at which to log the message
[in]fmtprintf-style format string for message
[in]argsAny arguments needed by format string
Note
This is a macro, and level may be evaluated more than once. This does nothing when level is LOG_STDOUT.

Definition at line 183 of file logging.h.

#define do_crm_log_xml (   level,
  text,
  xml 
)
Value:
do { \
switch (level) { \
case LOG_STDOUT: case LOG_NEVER: \
break; \
default: { \
static struct qb_log_callsite *xml_cs = NULL; \
if (xml_cs == NULL) { \
xml_cs = qb_log_callsite_get(__func__, __FILE__, \
"xml-blob", (level), __LINE__, 0); \
} \
if (crm_is_callsite_active(xml_cs, (level), 0)) { \
log_data_element((level), __FILE__, __func__, \
__LINE__, text, xml, 1, xml_log_option_formatted); \
} \
} \
break; \
} \
} while(0)
log_data_element
void log_data_element(int log_level, const char *file, const char *function, int line, const char *prefix, xmlNode *data, int depth, gboolean formatted)
LOG_NEVER
#define LOG_NEVER
Definition: logging.h:46
crm_is_callsite_active
gboolean crm_is_callsite_active(struct qb_log_callsite *cs, uint8_t level, uint32_t tags)
Definition: logging.c:626
LOG_STDOUT
#define LOG_STDOUT
Definition: logging.h:41

Log XML line-by-line in a formatted fashion.

Parameters
[in]levelPriority at which to log the messages
[in]textPrefix for each line
[in]xmlXML to log
Note
This is a macro, and level may be evaluated more than once. This does nothing when level is LOG_STDOUT.

Definition at line 242 of file logging.h.

#define LOG_NEVER   255

Definition at line 46 of file logging.h.

#define LOG_STDOUT   254

Definition at line 41 of file logging.h.

#define LOG_TRACE   (LOG_DEBUG+1)

Definition at line 36 of file logging.h.

Enumeration Type Documentation

enum xml_log_options
Enumerator
xml_log_option_filtered 
xml_log_option_formatted 
xml_log_option_text 
xml_log_option_full_fledged 
xml_log_option_diff_plus 
xml_log_option_diff_minus 
xml_log_option_diff_short 
xml_log_option_diff_all 
xml_log_option_dirty_add 
xml_log_option_open 
xml_log_option_children 
xml_log_option_close 

Definition at line 84 of file logging.h.

Function Documentation

void crm_bump_log_level ( int  argc,
char **  argv 
)

Make logging more verbose.

If logging to stderr is not already enabled when this function is called, enable it. Otherwise, increase the log level by 1.

Parameters
[in]argcIgnored
[in]argvIgnored

Definition at line 976 of file logging.c.

void crm_disable_blackbox ( int  nsig)

Definition at line 449 of file logging.c.

void crm_enable_blackbox ( int  nsig)

Definition at line 443 of file logging.c.

void crm_enable_stderr ( int  enable)

Definition at line 955 of file logging.c.

gboolean crm_is_callsite_active ( struct qb_log_callsite *  cs,
uint8_t  level,
uint32_t  tags 
)

Definition at line 626 of file logging.c.

void crm_log_args ( int  argc,
char **  argv 
)

Log the command line (once)

Parameters
[in]Numberof values in argv
[in]Command-linearguments (including command name)
Note
This function will only log once, even if called with different arguments.

Definition at line 1002 of file logging.c.

void crm_log_deinit ( void  )

Definition at line 125 of file logging.c.

gboolean crm_log_init ( const char *  entity,
uint8_t  level,
gboolean  daemon,
gboolean  to_stderr,
int  argc,
char **  argv,
gboolean  quiet 
)

Definition at line 796 of file logging.c.

void crm_log_output_fn ( const char *  file,
const char *  function,
int  line,
int  level,
const char *  prefix,
const char *  output 
)

Definition at line 1017 of file logging.c.

void crm_log_preinit ( const char *  entity,
int  argc,
char **  argv 
)

Definition at line 740 of file logging.c.

void crm_update_callsites ( void  )

Definition at line 655 of file logging.c.

void crm_write_blackbox ( int  nsig,
struct qb_log_callsite *  callsite 
)

Definition at line 465 of file logging.c.

unsigned int get_crm_log_level ( void  )

Definition at line 987 of file logging.c.

void log_data_element ( int  log_level,
const char *  file,
const char *  function,
int  line,
const char *  prefix,
xmlNode *  data,
int  depth,
gboolean  formatted 
)
unsigned int set_crm_log_level ( unsigned int  level)

Definition at line 941 of file logging.c.

Variable Documentation

gboolean crm_config_error
Deprecated:
Pacemaker library functions set this when a configuration error is found, which turns on extra messages at the end of processing. It should not be used directly and will be removed from the public C API in a future release.

Definition at line 52 of file utils.c.

gboolean crm_config_warning
Deprecated:
Pacemaker library functions set this when a configuration warning is found, which turns on extra messages at the end of processing. It should not be used directly and will be removed from the public C API in a future release.

Definition at line 53 of file utils.c.

unsigned int crm_log_level

Definition at line 45 of file logging.c.

unsigned int crm_trace_nonlog

Definition at line 46 of file logging.c.

Generated on Tue Jun 8 2021 12:27:48 for pacemaker by   doxygen 1.8.5