Refactor: libcrmcomon: New pcmk__xe_get_int()

To replace crm_element_value_int().

Note that, like the other recently added getter functions, this leaves
dest unchanged on error. crm_element_value_int() set dest to -1.

This should indirectly improve some of the callers, which were not
error-checking crm_element_value_int()'s return code and simply assumed
the value was valid and not -1.

And IMO, it's better not to log errors or warnings within the getter
function as crm_element_value_int() was doing. The caller has more
context and can log errors or warnings if appropriate. Sometimes, a
parse failure may be expected as a legitimate possibility.

The one case I found questionable was the getting of PCMK__XA_ST_DELAY
in create_remote_stonith_op(). If that value is set to -1, then all
delays are disabled. crm_element_value_int() sets the value to -1 upon a
parse error, and this function was not doing any error checking before
now. So I wondered if we were relying on the parse error defaulting to
-1.

However, I don't think it's a problem. It looks like that attribute is
only ever getting set by crm_xml_add_int() -- so even if it's set based
on user input, it's set to a valid integer. The -1 value seems to be
intended only for when it's set explicitly to -1. We simply haven't
error-checked the parsing before now.

See commit a0cbd52 and associated commits in PR ClusterLabs#2027.

Signed-off-by: Reid Wahl <[email protected]>

Author: nrwahl2

daemons/attrd/attrd_attributes.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2024 the Pacemaker project contributors
+ * Copyright 2013-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -38,7 +38,7 @@ attrd_create_attribute(xmlNode *xml)
     /* Set type is meaningful only when writing to the CIB. Private
      * attributes are not written.
      */
-    crm_element_value_int(xml, PCMK__XA_ATTR_IS_PRIVATE, &is_private);
+    pcmk__xe_get_int(xml, PCMK__XA_ATTR_IS_PRIVATE, &is_private);
     if (!is_private && !pcmk__str_any_of(set_type,
                                          PCMK_XE_INSTANCE_ATTRIBUTES,
                                          PCMK_XE_UTILIZATION, NULL)) {

daemons/attrd/attrd_corosync.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2024 the Pacemaker project contributors
+ * Copyright 2013-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -81,7 +81,7 @@ attrd_peer_message(pcmk__node_status_t *peer, xmlNode *xml)
              * response so the originating peer knows what they're a confirmation
              * for.
              */
-            crm_element_value_int(xml, PCMK__XA_CALL_ID, &callid);
+            pcmk__xe_get_int(xml, PCMK__XA_CALL_ID, &callid);
             reply = attrd_confirmation(callid);
 
             /* And then send the confirmation back to the originating peer.  This
@@ -243,7 +243,7 @@ update_attr_on_host(attribute_t *a, const pcmk__node_status_t *peer,
     }
 
     // If value is for a Pacemaker Remote node, remember that
-    crm_element_value_int(xml, PCMK__XA_ATTR_IS_REMOTE, &is_remote);
+    pcmk__xe_get_int(xml, PCMK__XA_ATTR_IS_REMOTE, &is_remote);
     if (is_remote) {
         attrd_set_value_flags(v, attrd_value_remote);
         pcmk__assert(pcmk__cluster_lookup_remote_node(host) != NULL);
@@ -299,8 +299,7 @@ update_attr_on_host(attribute_t *a, const pcmk__node_status_t *peer,
     } else {
         int is_force_write = 0;
 
-        crm_element_value_int(xml, PCMK__XA_ATTRD_IS_FORCE_WRITE,
-                              &is_force_write);
+        pcmk__xe_get_int(xml, PCMK__XA_ATTRD_IS_FORCE_WRITE, &is_force_write);
 
         if (is_force_write == 1 && a->timeout_ms && a->timer) {
             /* Save forced writing and set change flag. */

daemons/attrd/attrd_elections.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2024 the Pacemaker project contributors
+ * Copyright 2013-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -108,7 +108,7 @@ attrd_check_for_new_writer(const pcmk__node_status_t *peer, const xmlNode *xml)
 {
     int peer_state = 0;
 
-    crm_element_value_int(xml, PCMK__XA_ATTR_WRITER, &peer_state);
+    pcmk__xe_get_int(xml, PCMK__XA_ATTR_WRITER, &peer_state);
     if (peer_state == election_won) {
         if ((election_state(attrd_cluster) == election_won)
             && !pcmk__str_eq(peer->name, attrd_cluster->priv->node_name,

daemons/attrd/attrd_ipc.c

@@ -151,7 +151,7 @@ attrd_client_peer_remove(pcmk__request_t *request)
     if (host == NULL) {
         int nodeid = 0;
 
-        crm_element_value_int(xml, PCMK__XA_ATTR_HOST_ID, &nodeid);
+        pcmk__xe_get_int(xml, PCMK__XA_ATTR_HOST_ID, &nodeid);
         if (nodeid > 0) {
             pcmk__node_status_t *node = NULL;
             char *host_alloc = NULL;

daemons/attrd/attrd_messages.c

@@ -107,8 +107,8 @@ handle_confirm_request(pcmk__request_t *request)
 
         crm_debug("Received confirmation from %s", request->peer);
 
-        if (crm_element_value_int(request->xml, PCMK__XA_CALL_ID,
-                                  &callid) == -1) {
+        if (pcmk__xe_get_int(request->xml, PCMK__XA_CALL_ID,
+                             &callid) != pcmk_rc_ok) {
             pcmk__set_result(&request->result, CRM_EX_PROTOCOL, PCMK_EXEC_INVALID,
                              "Could not get callid from XML");
         } else {

daemons/attrd/attrd_sync.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022-2024 the Pacemaker project contributors
+ * Copyright 2022-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -240,7 +240,7 @@ attrd_ack_waitlist_clients(enum attrd_sync_point sync_point, const xmlNode *xml)
         return;
     }
 
-    if (crm_element_value_int(xml, PCMK__XA_CALL_ID, &callid) == -1) {
+    if (pcmk__xe_get_int(xml, PCMK__XA_CALL_ID, &callid) != pcmk_rc_ok) {
         crm_warn("Could not get callid from request XML");
         return;
     }
@@ -484,7 +484,8 @@ attrd_expect_confirmations(pcmk__request_t *request, attrd_confirmation_action_f
         expected_confirmations = pcmk__intkey_table((GDestroyNotify) free_action);
     }
 
-    if (crm_element_value_int(request->xml, PCMK__XA_CALL_ID, &callid) == -1) {
+    if (pcmk__xe_get_int(request->xml, PCMK__XA_CALL_ID,
+                         &callid) != pcmk_rc_ok) {
         crm_err("Could not get callid from xml");
         return;
     }

daemons/based/based_callbacks.c

@@ -171,7 +171,7 @@ do_local_notify(const xmlNode *notify_src, const char *client_id,
 
     CRM_CHECK((notify_src != NULL) && (client_id != NULL), return);
 
-    crm_element_value_int(notify_src, PCMK__XA_CIB_CALLID, &msg_id);
+    pcmk__xe_get_int(notify_src, PCMK__XA_CIB_CALLID, &msg_id);
 
     client_obj = pcmk__find_client_by_id(client_id);
     if (client_obj == NULL) {
@@ -259,8 +259,7 @@ cib_common_callback_worker(uint32_t id, uint32_t flags, xmlNode * op_request,
         const char *type = crm_element_value(op_request,
                                              PCMK__XA_CIB_NOTIFY_TYPE);
 
-        crm_element_value_int(op_request, PCMK__XA_CIB_NOTIFY_ACTIVATE,
-                              &on_off);
+        pcmk__xe_get_int(op_request, PCMK__XA_CIB_NOTIFY_ACTIVATE, &on_off);
 
         crm_debug("Setting %s callbacks %s for client %s",
                   type, (on_off? "on" : "off"), pcmk__client_name(cib_client));

daemons/controld/controld_execd_state.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2024 the Pacemaker project contributors
+ * Copyright 2012-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -571,7 +571,7 @@ crmd_remote_proxy_cb(lrmd_t *lrmd, void *userdata, xmlNode *msg)
                          CRM_OP_NODE_INFO, pcmk__str_none)) {
             int node_id = 0;
 
-            crm_element_value_int(request, PCMK_XA_ID, &node_id);
+            pcmk__xe_get_int(request, PCMK_XA_ID, &node_id);
             if ((node_id <= 0)
                 && (crm_element_value(request, PCMK_XA_UNAME) == NULL)) {
                 crm_xml_add(request, PCMK_XA_UNAME, lrm_state->node_name);
@@ -592,7 +592,7 @@ crmd_remote_proxy_cb(lrmd_t *lrmd, void *userdata, xmlNode *msg)
             crm_xml_add(op_reply, PCMK_XA_FUNCTION, __func__);
             crm_xml_add_int(op_reply, PCMK__XA_LINE, __LINE__);
 
-            crm_element_value_int(msg, PCMK__XA_LRMD_IPC_MSG_ID, &msg_id);
+            pcmk__xe_get_int(msg, PCMK__XA_LRMD_IPC_MSG_ID, &msg_id);
             remote_proxy_relay_response(proxy, op_reply, msg_id);
 
             pcmk__xml_free(op_reply);

daemons/controld/controld_join_client.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2004-2024 the Pacemaker project contributors
+ * Copyright 2004-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -278,7 +278,7 @@ do_cl_join_finalize_respond(long long action,
         was_nack = FALSE;
     }
 
-    crm_element_value_int(input->msg, PCMK__XA_JOIN_ID, &join_id);
+    pcmk__xe_get_int(input->msg, PCMK__XA_JOIN_ID, &join_id);
 
     if (was_nack) {
         crm_err("Shutting down because cluster join with leader %s failed "

daemons/controld/controld_join_dc.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2004-2024 the Pacemaker project contributors
+ * Copyright 2004-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -464,7 +464,7 @@ do_dc_join_filter_offer(long long action,
     join_node = pcmk__get_node(0, join_from, NULL,
                                pcmk__node_search_cluster_member);
 
-    crm_element_value_int(join_ack->msg, PCMK__XA_JOIN_ID, &join_id);
+    pcmk__xe_get_int(join_ack->msg, PCMK__XA_JOIN_ID, &join_id);
     if (join_id != current_join_id) {
         crm_debug("Ignoring join-%d request from %s because we are on join-%d",
                   join_id, join_from, current_join_id);
@@ -795,7 +795,8 @@ do_dc_join_ack(long long action,
         goto done;
     }
 
-    if (crm_element_value_int(join_ack->msg, PCMK__XA_JOIN_ID, &join_id) != 0) {
+    if (pcmk__xe_get_int(join_ack->msg, PCMK__XA_JOIN_ID,
+                         &join_id) != pcmk_rc_ok) {
         crm_warn("Ignoring join confirmation from %s without valid join ID",
                  join_from);
         goto done;