Adding upstream version 2.1.6.upstream/2.1.6

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 992 insertions, 0 deletions

diff --git a/lib/common/nvpair.c b/lib/common/nvpair.c
new file mode 100644
index 0000000..3766c45
--- /dev/null
+++ b/lib/common/nvpair.c
@@ -0,0 +1,992 @@
+/*
+ * Copyright 2004-2023 the Pacemaker project contributors
+ *
+ * The version control history for this file may have further details.
+ *
+ * This source code is licensed under the GNU Lesser General Public License
+ * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
+ */
+
+#include <crm_internal.h>
+
+#include <stdio.h>
+#include <sys/types.h>
+#include <string.h>
+#include <ctype.h>
+#include <glib.h>
+#include <libxml/tree.h>
+
+#include <crm/crm.h>
+#include <crm/msg_xml.h>
+#include <crm/common/xml.h>
+#include <crm/common/xml_internal.h>
+#include "crmcommon_private.h"
+
+/*
+ * This file isolates handling of three types of name/value pairs:
+ *
+ * - pcmk_nvpair_t data type
+ * - XML attributes (<TAG ... NAME=VALUE ...>)
+ * - XML nvpair elements (<nvpair id=ID name=NAME value=VALUE>)
+ */
+
+// pcmk_nvpair_t handling
+
+/*!
+ * \internal
+ * \brief Allocate a new name/value pair
+ *
+ * \param[in] name   New name (required)
+ * \param[in] value  New value
+ *
+ * \return Newly allocated name/value pair
+ * \note The caller is responsible for freeing the result with
+ *       \c pcmk__free_nvpair().
+ */
+static pcmk_nvpair_t *
+pcmk__new_nvpair(const char *name, const char *value)
+{
+    pcmk_nvpair_t *nvpair = NULL;
+
+    CRM_ASSERT(name);
+
+    nvpair = calloc(1, sizeof(pcmk_nvpair_t));
+    CRM_ASSERT(nvpair);
+
+    pcmk__str_update(&nvpair->name, name);
+    pcmk__str_update(&nvpair->value, value);
+    return nvpair;
+}
+
+/*!
+ * \internal
+ * \brief Free a name/value pair
+ *
+ * \param[in,out] nvpair  Name/value pair to free
+ */
+static void
+pcmk__free_nvpair(gpointer data)
+{
+    if (data) {
+        pcmk_nvpair_t *nvpair = data;
+
+        free(nvpair->name);
+        free(nvpair->value);
+        free(nvpair);
+    }
+}
+
+/*!
+ * \brief Prepend a name/value pair to a list
+ *
+ * \param[in,out] nvpairs  List to modify
+ * \param[in]     name     New entry's name
+ * \param[in]     value    New entry's value
+ *
+ * \return New head of list
+ * \note The caller is responsible for freeing the list with
+ *       \c pcmk_free_nvpairs().
+ */
+GSList *
+pcmk_prepend_nvpair(GSList *nvpairs, const char *name, const char *value)
+{
+    return g_slist_prepend(nvpairs, pcmk__new_nvpair(name, value));
+}
+
+/*!
+ * \brief Free a list of name/value pairs
+ *
+ * \param[in,out] list  List to free
+ */
+void
+pcmk_free_nvpairs(GSList *nvpairs)
+{
+    g_slist_free_full(nvpairs, pcmk__free_nvpair);
+}
+
+/*!
+ * \internal
+ * \brief Compare two name/value pairs
+ *
+ * \param[in] a  First name/value pair to compare
+ * \param[in] b  Second name/value pair to compare
+ *
+ * \return 0 if a == b, 1 if a > b, -1 if a < b
+ */
+static gint
+pcmk__compare_nvpair(gconstpointer a, gconstpointer b)
+{
+    int rc = 0;
+    const pcmk_nvpair_t *pair_a = a;
+    const pcmk_nvpair_t *pair_b = b;
+
+    CRM_ASSERT(a != NULL);
+    CRM_ASSERT(pair_a->name != NULL);
+
+    CRM_ASSERT(b != NULL);
+    CRM_ASSERT(pair_b->name != NULL);
+
+    rc = strcmp(pair_a->name, pair_b->name);
+    if (rc < 0) {
+        return -1;
+    } else if (rc > 0) {
+        return 1;
+    }
+    return 0;
+}
+
+/*!
+ * \brief Sort a list of name/value pairs
+ *
+ * \param[in,out] list  List to sort
+ *
+ * \return New head of list
+ */
+GSList *
+pcmk_sort_nvpairs(GSList *list)
+{
+    return g_slist_sort(list, pcmk__compare_nvpair);
+}
+
+/*!
+ * \brief Create a list of name/value pairs from an XML node's attributes
+ *
+ * \param[in]  XML to parse
+ *
+ * \return New list of name/value pairs
+ * \note It is the caller's responsibility to free the list with
+ *       \c pcmk_free_nvpairs().
+ */
+GSList *
+pcmk_xml_attrs2nvpairs(const xmlNode *xml)
+{
+    GSList *result = NULL;
+
+    for (xmlAttrPtr iter = pcmk__xe_first_attr(xml); iter != NULL;
+         iter = iter->next) {
+
+        result = pcmk_prepend_nvpair(result,
+                                     (const char *) iter->name,
+                                     (const char *) pcmk__xml_attr_value(iter));
+    }
+    return result;
+}
+
+/*!
+ * \internal
+ * \brief Add an XML attribute corresponding to a name/value pair
+ *
+ * Suitable for glib list iterators, this function adds a NAME=VALUE
+ * XML attribute based on a given name/value pair.
+ *
+ * \param[in]  data       Name/value pair
+ * \param[out] user_data  XML node to add attributes to
+ */
+static void
+pcmk__nvpair_add_xml_attr(gpointer data, gpointer user_data)
+{
+    pcmk_nvpair_t *pair = data;
+    xmlNode *parent = user_data;
+
+    crm_xml_add(parent, pair->name, pair->value);
+}
+
+/*!
+ * \brief Add XML attributes based on a list of name/value pairs
+ *
+ * \param[in,out] list  List of name/value pairs
+ * \param[in,out] xml   XML node to add attributes to
+ */
+void
+pcmk_nvpairs2xml_attrs(GSList *list, xmlNode *xml)
+{
+    g_slist_foreach(list, pcmk__nvpair_add_xml_attr, xml);
+}
+
+// convenience function for name=value strings
+
+/*!
+ * \internal
+ * \brief Extract the name and value from an input string formatted as "name=value".
+ * If unable to extract them, they are returned as NULL.
+ *
+ * \param[in]  input The input string, likely from the command line
+ * \param[out] name  Everything before the first '=' in the input string
+ * \param[out] value Everything after the first '=' in the input string
+ *
+ * \return 2 if both name and value could be extracted, 1 if only one could, and
+ *         and error code otherwise
+ */
+int
+pcmk__scan_nvpair(const char *input, char **name, char **value)
+{
+#ifdef HAVE_SSCANF_M
+    *name = NULL;
+    *value = NULL;
+    if (sscanf(input, "%m[^=]=%m[^\n]", name, value) <= 0) {
+        return -pcmk_err_bad_nvpair;
+    }
+#else
+    char *sep = NULL;
+    *name = NULL;
+    *value = NULL;
+
+    sep = strstr(optarg, "=");
+    if (sep == NULL) {
+        return -pcmk_err_bad_nvpair;
+    }
+
+    *name = strndup(input, sep-input);
+
+    if (*name == NULL) {
+        return -ENOMEM;
+    }
+
+    /* If the last char in optarg is =, the user gave no
+     * value for the option.  Leave it as NULL.
+     */
+    if (*(sep+1) != '\0') {
+        *value = strdup(sep+1);
+
+        if (*value == NULL) {
+            return -ENOMEM;
+        }
+    }
+#endif
+
+    if (*name != NULL && *value != NULL) {
+        return 2;
+    } else if (*name != NULL || *value != NULL) {
+        return 1;
+    } else {
+        return -pcmk_err_bad_nvpair;
+    }
+}
+
+/*!
+ * \internal
+ * \brief Format a name/value pair.
+ *
+ * Units can optionally be provided for the value.  Note that unlike most
+ * formatting functions, this one returns the formatted string.  It is
+ * assumed that the most common use of this function will be to build up
+ * a string to be output as part of other functions.
+ *
+ * \note The caller is responsible for freeing the return value after use.
+ *
+ * \param[in]     name  The name of the nvpair.
+ * \param[in]     value The value of the nvpair.
+ * \param[in]     units Optional units for the value, or NULL.
+ *
+ * \return Newly allocated string with name/value pair
+ */
+char *
+pcmk__format_nvpair(const char *name, const char *value, const char *units)
+{
+    return crm_strdup_printf("%s=\"%s%s\"", name, value, units ? units : "");
+}
+
+// XML attribute handling
+
+/*!
+ * \brief Create an XML attribute with specified name and value
+ *
+ * \param[in,out] node   XML node to modify
+ * \param[in]     name   Attribute name to set
+ * \param[in]     value  Attribute value to set
+ *
+ * \return New value on success, \c NULL otherwise
+ * \note This does nothing if node, name, or value are \c NULL or empty.
+ */
+const char *
+crm_xml_add(xmlNode *node, const char *name, const char *value)
+{
+    bool dirty = FALSE;
+    xmlAttr *attr = NULL;
+
+    CRM_CHECK(node != NULL, return NULL);
+    CRM_CHECK(name != NULL, return NULL);
+
+    if (value == NULL) {
+        return NULL;
+    }
+
+    if (pcmk__tracking_xml_changes(node, FALSE)) {
+        const char *old = crm_element_value(node, name);
+
+        if (old == NULL || value == NULL || strcmp(old, value) != 0) {
+            dirty = TRUE;
+        }
+    }
+
+    if (dirty && (pcmk__check_acl(node, name, pcmk__xf_acl_create) == FALSE)) {
+        crm_trace("Cannot add %s=%s to %s", name, value, node->name);
+        return NULL;
+    }
+
+    attr = xmlSetProp(node, (pcmkXmlStr) name, (pcmkXmlStr) value);
+    if (dirty) {
+        pcmk__mark_xml_attr_dirty(attr);
+    }
+
+    CRM_CHECK(attr && attr->children && attr->children->content, return NULL);
+    return (char *)attr->children->content;
+}
+
+/*!
+ * \brief Replace an XML attribute with specified name and (possibly NULL) value
+ *
+ * \param[in,out] node   XML node to modify
+ * \param[in]     name   Attribute name to set
+ * \param[in]     value  Attribute value to set
+ *
+ * \return New value on success, \c NULL otherwise
+ * \note This does nothing if node or name is \c NULL or empty.
+ */
+const char *
+crm_xml_replace(xmlNode *node, const char *name, const char *value)
+{
+    bool dirty = FALSE;
+    xmlAttr *attr = NULL;
+    const char *old_value = NULL;
+
+    CRM_CHECK(node != NULL, return NULL);
+    CRM_CHECK(name != NULL && name[0] != 0, return NULL);
+
+    old_value = crm_element_value(node, name);
+
+    /* Could be re-setting the same value */
+    CRM_CHECK(old_value != value, return value);
+
+    if (pcmk__check_acl(node, name, pcmk__xf_acl_write) == FALSE) {
+        /* Create a fake object linked to doc->_private instead? */
+        crm_trace("Cannot replace %s=%s to %s", name, value, node->name);
+        return NULL;
+
+    } else if (old_value && !value) {
+        xml_remove_prop(node, name);
+        return NULL;
+    }
+
+    if (pcmk__tracking_xml_changes(node, FALSE)) {
+        if (!old_value || !value || !strcmp(old_value, value)) {
+            dirty = TRUE;
+        }
+    }
+
+    attr = xmlSetProp(node, (pcmkXmlStr) name, (pcmkXmlStr) value);
+    if (dirty) {
+        pcmk__mark_xml_attr_dirty(attr);
+    }
+    CRM_CHECK(attr && attr->children && attr->children->content, return NULL);
+    return (char *) attr->children->content;
+}
+
+/*!
+ * \brief Create an XML attribute with specified name and integer value
+ *
+ * This is like \c crm_xml_add() but taking an integer value.
+ *
+ * \param[in,out] node   XML node to modify
+ * \param[in]     name   Attribute name to set
+ * \param[in]     value  Attribute value to set
+ *
+ * \return New value as string on success, \c NULL otherwise
+ * \note This does nothing if node or name are \c NULL or empty.
+ */
+const char *
+crm_xml_add_int(xmlNode *node, const char *name, int value)
+{
+    char *number = pcmk__itoa(value);
+    const char *added = crm_xml_add(node, name, number);
+
+    free(number);
+    return added;
+}
+
+/*!
+ * \brief Create an XML attribute with specified name and unsigned value
+ *
+ * This is like \c crm_xml_add() but taking a guint value.
+ *
+ * \param[in,out] node   XML node to modify
+ * \param[in]     name   Attribute name to set
+ * \param[in]     ms     Attribute value to set
+ *
+ * \return New value as string on success, \c NULL otherwise
+ * \note This does nothing if node or name are \c NULL or empty.
+ */
+const char *
+crm_xml_add_ms(xmlNode *node, const char *name, guint ms)
+{
+    char *number = crm_strdup_printf("%u", ms);
+    const char *added = crm_xml_add(node, name, number);
+
+    free(number);
+    return added;
+}
+
+// Maximum size of null-terminated string representation of 64-bit integer
+// -9223372036854775808
+#define LLSTRSIZE 21
+
+/*!
+ * \brief Create an XML attribute with specified name and long long int value
+ *
+ * This is like \c crm_xml_add() but taking a long long int value. It is a
+ * useful equivalent for defined types like time_t, etc.
+ *
+ * \param[in,out] xml    XML node to modify
+ * \param[in]     name   Attribute name to set
+ * \param[in]     value  Attribute value to set
+ *
+ * \return New value as string on success, \c NULL otherwise
+ * \note This does nothing if xml or name are \c NULL or empty.
+ *       This does not support greater than 64-bit values.
+ */
+const char *
+crm_xml_add_ll(xmlNode *xml, const char *name, long long value)
+{
+    char s[LLSTRSIZE] = { '\0', };
+
+    if (snprintf(s, LLSTRSIZE, "%lld", (long long) value) == LLSTRSIZE) {
+        return NULL;
+    }
+    return crm_xml_add(xml, name, s);
+}
+
+/*!
+ * \brief Create XML attributes for seconds and microseconds
+ *
+ * This is like \c crm_xml_add() but taking a struct timeval.
+ *
+ * \param[in,out] xml        XML node to modify
+ * \param[in]     name_sec   Name of XML attribute for seconds
+ * \param[in]     name_usec  Name of XML attribute for microseconds (or NULL)
+ * \param[in]     value      Time value to set
+ *
+ * \return New seconds value as string on success, \c NULL otherwise
+ * \note This does nothing if xml, name_sec, or value is \c NULL.
+ */
+const char *
+crm_xml_add_timeval(xmlNode *xml, const char *name_sec, const char *name_usec,
+                    const struct timeval *value)
+{
+    const char *added = NULL;
+
+    if (xml && name_sec && value) {
+        added = crm_xml_add_ll(xml, name_sec, (long long) value->tv_sec);
+        if (added && name_usec) {
+            // Any error is ignored (we successfully added seconds)
+            crm_xml_add_ll(xml, name_usec, (long long) value->tv_usec);
+        }
+    }
+    return added;
+}
+
+/*!
+ * \brief Retrieve the value of an XML attribute
+ *
+ * \param[in] data   XML node to check
+ * \param[in] name   Attribute name to check
+ *
+ * \return Value of specified attribute (may be \c NULL)
+ */
+const char *
+crm_element_value(const xmlNode *data, const char *name)
+{
+    xmlAttr *attr = NULL;
+
+    if (data == NULL) {
+        crm_err("Couldn't find %s in NULL", name ? name : "<null>");
+        CRM_LOG_ASSERT(data != NULL);
+        return NULL;
+
+    } else if (name == NULL) {
+        crm_err("Couldn't find NULL in %s", crm_element_name(data));
+        return NULL;
+    }
+
+    /* The first argument to xmlHasProp() has always been const,
+     * but libxml2 <2.9.2 didn't declare that, so cast it
+     */
+    attr = xmlHasProp((xmlNode *) data, (pcmkXmlStr) name);
+    if (!attr || !attr->children) {
+        return NULL;
+    }
+    return (const char *) attr->children->content;
+}
+
+/*!
+ * \brief Retrieve the integer value of an XML attribute
+ *
+ * This is like \c crm_element_value() but getting the value as an integer.
+ *
+ * \param[in]  data  XML node to check
+ * \param[in]  name  Attribute name to check
+ * \param[out] dest  Where to store element value
+ *
+ * \return 0 on success, -1 otherwise
+ */
+int
+crm_element_value_int(const xmlNode *data, const char *name, int *dest)
+{
+    const char *value = NULL;
+
+    CRM_CHECK(dest != NULL, return -1);
+    value = crm_element_value(data, name);
+    if (value) {
+        long long value_ll;
+
+        if ((pcmk__scan_ll(value, &value_ll, 0LL) != pcmk_rc_ok)
+            || (value_ll < INT_MIN) || (value_ll > INT_MAX)) {
+            *dest = PCMK__PARSE_INT_DEFAULT;
+        } else {
+            *dest = (int) value_ll;
+            return 0;
+        }
+    }
+    return -1;
+}
+
+/*!
+ * \brief Retrieve the long long integer value of an XML attribute
+ *
+ * This is like \c crm_element_value() but getting the value as a long long int.
+ *
+ * \param[in]  data  XML node to check
+ * \param[in]  name  Attribute name to check
+ * \param[out] dest  Where to store element value
+ *
+ * \return 0 on success, -1 otherwise
+ */
+int
+crm_element_value_ll(const xmlNode *data, const char *name, long long *dest)
+{
+    const char *value = NULL;
+
+    CRM_CHECK(dest != NULL, return -1);
+    value = crm_element_value(data, name);
+    if ((value != NULL)
+        && (pcmk__scan_ll(value, dest, PCMK__PARSE_INT_DEFAULT) == pcmk_rc_ok)) {
+        return 0;
+    }
+    return -1;
+}
+
+/*!
+ * \brief Retrieve the millisecond value of an XML attribute
+ *
+ * This is like \c crm_element_value() but returning the value as a guint.
+ *
+ * \param[in]  data   XML node to check
+ * \param[in]  name   Attribute name to check
+ * \param[out] dest   Where to store attribute value
+ *
+ * \return \c pcmk_ok on success, -1 otherwise
+ */
+int
+crm_element_value_ms(const xmlNode *data, const char *name, guint *dest)
+{
+    const char *value = NULL;
+    long long value_ll;
+
+    CRM_CHECK(dest != NULL, return -1);
+    *dest = 0;
+    value = crm_element_value(data, name);
+    if ((pcmk__scan_ll(value, &value_ll, 0LL) != pcmk_rc_ok)
+        || (value_ll < 0) || (value_ll > G_MAXUINT)) {
+        return -1;
+    }
+    *dest = (guint) value_ll;
+    return pcmk_ok;
+}
+
+/*!
+ * \brief Retrieve the seconds-since-epoch value of an XML attribute
+ *
+ * This is like \c crm_element_value() but returning the value as a time_t.
+ *
+ * \param[in]  xml    XML node to check
+ * \param[in]  name   Attribute name to check
+ * \param[out] dest   Where to store attribute value
+ *
+ * \return \c pcmk_ok on success, -1 otherwise
+ */
+int
+crm_element_value_epoch(const xmlNode *xml, const char *name, time_t *dest)
+{
+    long long value_ll = 0;
+
+    if (crm_element_value_ll(xml, name, &value_ll) < 0) {
+        return -1;
+    }
+
+    /* Unfortunately, we can't do any bounds checking, since time_t has neither
+     * standardized bounds nor constants defined for them.
+     */
+    *dest = (time_t) value_ll;
+    return pcmk_ok;
+}
+
+/*!
+ * \brief Retrieve the value of XML second/microsecond attributes as time
+ *
+ * This is like \c crm_element_value() but returning value as a struct timeval.
+ *
+ * \param[in]  xml        XML to parse
+ * \param[in]  name_sec   Name of XML attribute for seconds
+ * \param[in]  name_usec  Name of XML attribute for microseconds
+ * \param[out] dest       Where to store result
+ *
+ * \return \c pcmk_ok on success, -errno on error
+ * \note Values default to 0 if XML or XML attribute does not exist
+ */
+int
+crm_element_value_timeval(const xmlNode *xml, const char *name_sec,
+                          const char *name_usec, struct timeval *dest)
+{
+    long long value_i = 0;
+
+    CRM_CHECK(dest != NULL, return -EINVAL);
+    dest->tv_sec = 0;
+    dest->tv_usec = 0;
+
+    if (xml == NULL) {
+        return pcmk_ok;
+    }
+
+    /* Unfortunately, we can't do any bounds checking, since there are no
+     * constants provided for the bounds of time_t and suseconds_t, and
+     * calculating them isn't worth the effort. If there are XML values
+     * beyond the native sizes, there will probably be worse problems anyway.
+     */
+
+    // Parse seconds
+    errno = 0;
+    if (crm_element_value_ll(xml, name_sec, &value_i) < 0) {
+        return -errno;
+    }
+    dest->tv_sec = (time_t) value_i;
+
+    // Parse microseconds
+    if (crm_element_value_ll(xml, name_usec, &value_i) < 0) {
+        return -errno;
+    }
+    dest->tv_usec = (suseconds_t) value_i;
+
+    return pcmk_ok;
+}
+
+/*!
+ * \brief Retrieve a copy of the value of an XML attribute
+ *
+ * This is like \c crm_element_value() but allocating new memory for the result.
+ *
+ * \param[in] data   XML node to check
+ * \param[in] name   Attribute name to check
+ *
+ * \return Value of specified attribute (may be \c NULL)
+ * \note The caller is responsible for freeing the result.
+ */
+char *
+crm_element_value_copy(const xmlNode *data, const char *name)
+{
+    char *value_copy = NULL;
+
+    pcmk__str_update(&value_copy, crm_element_value(data, name));
+    return value_copy;
+}
+
+/*!
+ * \brief Add hash table entry to XML as (possibly legacy) name/value
+ *
+ * Suitable for \c g_hash_table_foreach(), this function takes a hash table key
+ * and value, with an XML node passed as user data, and adds an XML attribute
+ * with the specified name and value if it does not already exist. If the key
+ * name starts with a digit, this will instead add a \<param name=NAME
+ * value=VALUE/> child to the XML (for legacy compatibility with heartbeat).
+ *
+ * \param[in]     key        Key of hash table entry
+ * \param[in]     value      Value of hash table entry
+ * \param[in,out] user_data  XML node
+ */
+void
+hash2smartfield(gpointer key, gpointer value, gpointer user_data)
+{
+    const char *name = key;
+    const char *s_value = value;
+
+    xmlNode *xml_node = user_data;
+
+    if (isdigit(name[0])) {
+        xmlNode *tmp = create_xml_node(xml_node, XML_TAG_PARAM);
+
+        crm_xml_add(tmp, XML_NVPAIR_ATTR_NAME, name);
+        crm_xml_add(tmp, XML_NVPAIR_ATTR_VALUE, s_value);
+
+    } else if (crm_element_value(xml_node, name) == NULL) {
+        crm_xml_add(xml_node, name, s_value);
+        crm_trace("dumped: %s=%s", name, s_value);
+
+    } else {
+        crm_trace("duplicate: %s=%s", name, s_value);
+    }
+}
+
+/*!
+ * \brief Set XML attribute based on hash table entry
+ *
+ * Suitable for \c g_hash_table_foreach(), this function takes a hash table key
+ * and value, with an XML node passed as user data, and adds an XML attribute
+ * with the specified name and value if it does not already exist.
+ *
+ * \param[in]     key        Key of hash table entry
+ * \param[in]     value      Value of hash table entry
+ * \param[in,out] user_data  XML node
+ */
+void
+hash2field(gpointer key, gpointer value, gpointer user_data)
+{
+    const char *name = key;
+    const char *s_value = value;
+
+    xmlNode *xml_node = user_data;
+
+    if (crm_element_value(xml_node, name) == NULL) {
+        crm_xml_add(xml_node, name, s_value);
+
+    } else {
+        crm_trace("duplicate: %s=%s", name, s_value);
+    }
+}
+
+/*!
+ * \brief Set XML attribute based on hash table entry, as meta-attribute name
+ *
+ * Suitable for \c g_hash_table_foreach(), this function takes a hash table key
+ * and value, with an XML node passed as user data, and adds an XML attribute
+ * with the meta-attribute version of the specified name and value if it does
+ * not already exist and if the name does not appear to be cluster-internal.
+ *
+ * \param[in]     key        Key of hash table entry
+ * \param[in]     value      Value of hash table entry
+ * \param[in,out] user_data  XML node
+ */
+void
+hash2metafield(gpointer key, gpointer value, gpointer user_data)
+{
+    char *crm_name = NULL;
+
+    if (key == NULL || value == NULL) {
+        return;
+    }
+
+    /* Filter out cluster-generated attributes that contain a '#' or ':'
+     * (like fail-count and last-failure).
+     */
+    for (crm_name = key; *crm_name; ++crm_name) {
+        if ((*crm_name == '#') || (*crm_name == ':')) {
+            return;
+        }
+    }
+
+    crm_name = crm_meta_name(key);
+    hash2field(crm_name, value, user_data);
+    free(crm_name);
+}
+
+// nvpair handling
+
+/*!
+ * \brief Create an XML name/value pair
+ *
+ * \param[in,out] parent  If not \c NULL, make new XML node a child of this one
+ * \param[in]     id      Set this as XML ID (or NULL to auto-generate)
+ * \param[in]     name    Name to use
+ * \param[in]     value   Value to use
+ *
+ * \return New XML object on success, \c NULL otherwise
+ */
+xmlNode *
+crm_create_nvpair_xml(xmlNode *parent, const char *id, const char *name,
+                      const char *value)
+{
+    xmlNode *nvp;
+
+    /* id can be NULL so we auto-generate one, and name can be NULL if this
+     * will be used to delete a name/value pair by ID, but both can't be NULL
+     */
+    CRM_CHECK(id || name, return NULL);
+
+    nvp = create_xml_node(parent, XML_CIB_TAG_NVPAIR);
+    CRM_CHECK(nvp, return NULL);
+
+    if (id) {
+        crm_xml_add(nvp, XML_ATTR_ID, id);
+    } else {
+        const char *parent_id = ID(parent);
+
+        crm_xml_set_id(nvp, "%s-%s",
+                       (parent_id? parent_id : XML_CIB_TAG_NVPAIR), name);
+    }
+    crm_xml_add(nvp, XML_NVPAIR_ATTR_NAME, name);
+    crm_xml_add(nvp, XML_NVPAIR_ATTR_VALUE, value);
+    return nvp;
+}
+
+/*!
+ * \brief Add XML nvpair element based on hash table entry
+ *
+ * Suitable for \c g_hash_table_foreach(), this function takes a hash table key
+ * and value, with an XML node passed as the user data, and adds an \c nvpair
+ * XML element with the specified name and value.
+ *
+ * \param[in]     key        Key of hash table entry
+ * \param[in]     value      Value of hash table entry
+ * \param[in,out] user_data  XML node
+ */
+void
+hash2nvpair(gpointer key, gpointer value, gpointer user_data)
+{
+    const char *name = key;
+    const char *s_value = value;
+    xmlNode *xml_node = user_data;
+
+    crm_create_nvpair_xml(xml_node, name, name, s_value);
+    crm_trace("dumped: name=%s value=%s", name, s_value);
+}
+
+/*!
+ * \brief Retrieve XML attributes as a hash table
+ *
+ * Given an XML element, this will look for any \<attributes> element child,
+ * creating a hash table of (newly allocated string) name/value pairs taken
+ * first from the attributes element's NAME=VALUE XML attributes, and then
+ * from any \<param name=NAME value=VALUE> children of attributes.
+ *
+ * \param[in]  XML node to parse
+ *
+ * \return Hash table with name/value pairs
+ * \note It is the caller's responsibility to free the result using
+ *       \c g_hash_table_destroy().
+ */
+GHashTable *
+xml2list(const xmlNode *parent)
+{
+    xmlNode *child = NULL;
+    xmlAttrPtr pIter = NULL;
+    xmlNode *nvpair_list = NULL;
+    GHashTable *nvpair_hash = pcmk__strkey_table(free, free);
+
+    CRM_CHECK(parent != NULL, return nvpair_hash);
+
+    nvpair_list = find_xml_node(parent, XML_TAG_ATTRS, FALSE);
+    if (nvpair_list == NULL) {
+        crm_trace("No attributes in %s", crm_element_name(parent));
+        crm_log_xml_trace(parent, "No attributes for resource op");
+    }
+
+    crm_log_xml_trace(nvpair_list, "Unpacking");
+
+    for (pIter = pcmk__xe_first_attr(nvpair_list); pIter != NULL;
+         pIter = pIter->next) {
+
+        const char *p_name = (const char *)pIter->name;
+        const char *p_value = pcmk__xml_attr_value(pIter);
+
+        crm_trace("Added %s=%s", p_name, p_value);
+
+        g_hash_table_insert(nvpair_hash, strdup(p_name), strdup(p_value));
+    }
+
+    for (child = pcmk__xml_first_child(nvpair_list); child != NULL;
+         child = pcmk__xml_next(child)) {
+
+        if (strcmp((const char *)child->name, XML_TAG_PARAM) == 0) {
+            const char *key = crm_element_value(child, XML_NVPAIR_ATTR_NAME);
+            const char *value = crm_element_value(child, XML_NVPAIR_ATTR_VALUE);
+
+            crm_trace("Added %s=%s", key, value);
+            if (key != NULL && value != NULL) {
+                g_hash_table_insert(nvpair_hash, strdup(key), strdup(value));
+            }
+        }
+    }
+
+    return nvpair_hash;
+}
+
+void
+pcmk__xe_set_bool_attr(xmlNodePtr node, const char *name, bool value)
+{
+    crm_xml_add(node, name, value ? XML_BOOLEAN_TRUE : XML_BOOLEAN_FALSE);
+}
+
+int
+pcmk__xe_get_bool_attr(const xmlNode *node, const char *name, bool *value)
+{
+    const char *xml_value = NULL;
+    int ret, rc;
+
+    if (node == NULL) {
+        return ENODATA;
+    } else if (name == NULL || value == NULL) {
+        return EINVAL;
+    }
+
+    xml_value = crm_element_value(node, name);
+
+    if (xml_value == NULL) {
+        return ENODATA;
+    }
+
+    rc = crm_str_to_boolean(xml_value, &ret);
+    if (rc == 1) {
+        *value = ret;
+        return pcmk_rc_ok;
+    } else {
+        return pcmk_rc_bad_input;
+    }
+}
+
+bool
+pcmk__xe_attr_is_true(const xmlNode *node, const char *name)
+{
+    bool value = false;
+    int rc;
+
+    rc = pcmk__xe_get_bool_attr(node, name, &value);
+    return rc == pcmk_rc_ok && value == true;
+}
+
+// Deprecated functions kept only for backward API compatibility
+// LCOV_EXCL_START
+
+#include <crm/common/util_compat.h>
+
+int
+pcmk_scan_nvpair(const char *input, char **name, char **value)
+{
+    return pcmk__scan_nvpair(input, name, value);
+}
+
+char *
+pcmk_format_nvpair(const char *name, const char *value,
+                   const char *units)
+{
+    return pcmk__format_nvpair(name, value, units);
+}
+
+char *
+pcmk_format_named_time(const char *name, time_t epoch_time)
+{
+    char *now_s = pcmk__epoch2str(&epoch_time, 0);
+    char *result = crm_strdup_printf("%s=\"%s\"", name, pcmk__s(now_s, ""));
+
+    free(now_s);
+    return result;
+}
+
+// LCOV_EXCL_STOP
+// End deprecated API