Go to the source code of this file.
Macros | |
| #define | PCMK__XML_LOG_BASE(priority, dechunk, postemit, prefix, fmt, ap) |
| Base for directing lib{xml2,xslt} log into standard libqb backend. More... | |
| #define | PCMK__XP_MEMBER_NODE_CONFIG |
| #define | PCMK__XP_GUEST_NODE_CONFIG |
| #define | PCMK__XP_REMOTE_NODE_CONFIG |
| #define | PCMK__XP_REMOTE_NODE_STATUS |
Enumerations | |
| enum | pcmk__xml_artefact_ns { pcmk__xml_artefact_ns_legacy_rng = 1, pcmk__xml_artefact_ns_legacy_xslt, pcmk__xml_artefact_ns_base_rng, pcmk__xml_artefact_ns_base_xslt } |
| enum | xml_private_flags { pcmk__xf_none = 0x0000, pcmk__xf_dirty = 0x0001, pcmk__xf_deleted = 0x0002, pcmk__xf_created = 0x0004, pcmk__xf_modified = 0x0008, pcmk__xf_tracking = 0x0010, pcmk__xf_processed = 0x0020, pcmk__xf_skip = 0x0040, pcmk__xf_moved = 0x0080, pcmk__xf_acl_enabled = 0x0100, pcmk__xf_acl_read = 0x0200, pcmk__xf_acl_write = 0x0400, pcmk__xf_acl_deny = 0x0800, pcmk__xf_acl_create = 0x1000, pcmk__xf_acl_denied = 0x2000, pcmk__xf_lazy = 0x4000 } |
Functions | |
| void | pcmk__strip_xml_text (xmlNode *xml) |
| const char * | pcmk__xe_add_last_written (xmlNode *xe) |
| xmlNode * | pcmk__xe_match (xmlNode *parent, const char *node_name, const char *attr_n, const char *attr_v) |
| void | pcmk__xe_remove_matching_attrs (xmlNode *element, bool(*match)(xmlAttrPtr, void *), void *user_data) |
| char * | pcmk__xml_artefact_root (enum pcmk__xml_artefact_ns ns) |
| char * | pcmk__xml_artefact_path (enum pcmk__xml_artefact_ns ns, const char *filespec) |
| void | pcmk__xe_set_propv (xmlNodePtr node, va_list pairs) |
| void | pcmk__xe_set_props (xmlNodePtr node,...) G_GNUC_NULL_TERMINATED |
| char * | pcmk__xpath_node_id (const char *xpath, const char *node) |
| void | pcmk__set_xml_doc_flag (xmlNode *xml, enum xml_private_flags flag) |
Macro Definition Documentation
◆ PCMK__XML_LOG_BASE
| #define PCMK__XML_LOG_BASE | ( | priority, | |
| dechunk, | |||
| postemit, | |||
| prefix, | |||
| fmt, | |||
| ap | |||
| ) |
Base for directing lib{xml2,xslt} log into standard libqb backend.
This macro implements the core of what can be needed for directing libxml2 or libxslt error messaging into standard, preconfigured libqb-backed log stream.
It's a bit unfortunate that libxml2 (and more sparsely, also libxslt) emits a single message by chunks (location is emitted separatedly from the message itself), so we have to take the effort to combine these chunks back to single message. Whether to do this or not is driven with dechunk toggle.
The form of a macro was chosen for implicit deriving of FILE, etc. and also because static dechunking buffer should be differentiated per library (here we assume different functions referring to this macro will not ever be using both at once), preferably also per-library context of use to avoid clashes altogether.
Note that we cannot use qb_logt, because callsite data have to be known at the moment of compilation, which it is not always the case – xml_log (and unfortunately there's no clear explanation of the fail to compile).
Also note that there's no explicit guard against said libraries producing never-newline-terminated chunks (which would just keep consuming memory), as it's quite improbable. Termination of the program in between the same-message chunks will raise a flag with valgrind and the likes, though.
And lastly, regarding how dechunking combines with other non-message parameters – for priority, most important running specification wins (possibly elevated to LOG_ERR in case of nonconformance with the newline-termination "protocol"), dechunk is expected to always be on once it was at the start, and the rest (postemit and prefix) are picked directly from the last chunk entry finalizing the message (also reasonable to always have it the same with all related entries).
- Parameters
-
[in] priority Syslog priority for the message to be logged [in] dechunk Whether to dechunk new-line terminated message [in] postemit Code to be executed once message is sent out [in] prefix How to prefix the message or NULL for raw passing [in] fmt Format string as with printf-like functions [in] ap Variable argument list to supplement fmtformat string
Definition at line 67 of file xml_internal.h.
◆ PCMK__XP_GUEST_NODE_CONFIG
| #define PCMK__XP_GUEST_NODE_CONFIG |
Definition at line 134 of file xml_internal.h.
◆ PCMK__XP_MEMBER_NODE_CONFIG
| #define PCMK__XP_MEMBER_NODE_CONFIG |
Definition at line 129 of file xml_internal.h.
◆ PCMK__XP_REMOTE_NODE_CONFIG
| #define PCMK__XP_REMOTE_NODE_CONFIG |
Definition at line 140 of file xml_internal.h.
◆ PCMK__XP_REMOTE_NODE_STATUS
| #define PCMK__XP_REMOTE_NODE_STATUS |
Definition at line 145 of file xml_internal.h.
Enumeration Type Documentation
◆ pcmk__xml_artefact_ns
| Enumerator | |
|---|---|
| pcmk__xml_artefact_ns_legacy_rng | |
| pcmk__xml_artefact_ns_legacy_xslt | |
| pcmk__xml_artefact_ns_base_rng | |
| pcmk__xml_artefact_ns_base_xslt | |
Definition at line 149 of file xml_internal.h.
◆ xml_private_flags
| enum xml_private_flags |
Definition at line 315 of file xml_internal.h.
Function Documentation
◆ pcmk__set_xml_doc_flag()
| void pcmk__set_xml_doc_flag | ( | xmlNode * | xml, |
| enum xml_private_flags | flag | ||
| ) |
◆ pcmk__strip_xml_text()
◆ pcmk__xe_add_last_written()
◆ pcmk__xe_match()
| xmlNode* pcmk__xe_match | ( | xmlNode * | parent, |
| const char * | node_name, | ||
| const char * | attr_n, | ||
| const char * | attr_v | ||
| ) |
◆ pcmk__xe_remove_matching_attrs()
| void pcmk__xe_remove_matching_attrs | ( | xmlNode * | element, |
| bool(*)(xmlAttrPtr, void *) | match, | ||
| void * | user_data | ||
| ) |
◆ pcmk__xe_set_props()
◆ pcmk__xe_set_propv()
◆ pcmk__xml_artefact_path()
| char* pcmk__xml_artefact_path | ( | enum pcmk__xml_artefact_ns | ns, |
| const char * | filespec | ||
| ) |
◆ pcmk__xml_artefact_root()
| char* pcmk__xml_artefact_root | ( | enum pcmk__xml_artefact_ns | ns | ) |
