fcdfbd
From 0d15568a538349ac41028db6b506d13dd23e8732 Mon Sep 17 00:00:00 2001
fcdfbd
From: Chris Lumens <clumens@redhat.com>
fcdfbd
Date: Tue, 14 Feb 2023 14:00:37 -0500
fcdfbd
Subject: [PATCH] High: libcrmcommon: Fix handling node=NULL in
fcdfbd
 pcmk__attrd_api_query.
fcdfbd
fcdfbd
According to the header file, if node is NULL, pcmk__attrd_api_query
fcdfbd
should query the value of the given attribute on all cluster nodes.
fcdfbd
This is also what the server expects and how attrd_updater is supposed
fcdfbd
to work.
fcdfbd
fcdfbd
However, pcmk__attrd_api_query has no way of letting callers decide
fcdfbd
whether they want to query all nodes or whether they want to use the
fcdfbd
local node.  We were passing NULL for the node name, which it took to
fcdfbd
mean it should look up the local node name.  This calls
fcdfbd
pcmk__node_attr_target, which probes the local cluster name and returns
fcdfbd
that to pcmk__attrd_api_query.  If it returns non-NULL, that value will
fcdfbd
then be put into the XML IPC call which means the server will only
fcdfbd
return the value for that node.
fcdfbd
fcdfbd
In testing this was usually fine.  However, in pratice, the methods
fcdfbd
pcmk__node_attr_target uses to figure out the local cluster node name
fcdfbd
involves checking the OCF_RESKEY_CRM_meta_on_node environment variable
fcdfbd
among others.
fcdfbd
fcdfbd
This variable was never set in testing, but can be set in the real
fcdfbd
world.  This leads to circumstances where the user did "attrd_updater -QA"
fcdfbd
expecting to get the values on all nodes, but instead only got the value
fcdfbd
on the local cluster node.
fcdfbd
fcdfbd
In pacemaker-2.1.4 and prior, pcmk__node_attr_target was simply never
fcdfbd
called if the node was NULL but was called otherwise.
fcdfbd
fcdfbd
The fix is to modify pcmk__attrd_api_query to take an option for
fcdfbd
querying all nodes.  If that's present, we'll query all nodes.  If it's
fcdfbd
not present, we'll look at the given node name - NULL means look it up,
fcdfbd
anything else means just that node.
fcdfbd
fcdfbd
Regression in 2.1.5 introduced by eb20a65577
fcdfbd
---
fcdfbd
 include/crm/common/attrd_internal.h     |  6 +++++-
fcdfbd
 include/crm/common/ipc_attrd_internal.h |  7 +++++--
fcdfbd
 lib/common/ipc_attrd.c                  | 12 ++++++++----
fcdfbd
 tools/attrd_updater.c                   |  5 +++--
fcdfbd
 4 files changed, 21 insertions(+), 9 deletions(-)
fcdfbd
fcdfbd
diff --git a/include/crm/common/attrd_internal.h b/include/crm/common/attrd_internal.h
fcdfbd
index 389be48..7337c38 100644
fcdfbd
--- a/include/crm/common/attrd_internal.h
fcdfbd
+++ b/include/crm/common/attrd_internal.h
fcdfbd
@@ -1,5 +1,5 @@
fcdfbd
 /*
fcdfbd
- * Copyright 2004-2022 the Pacemaker project contributors
fcdfbd
+ * Copyright 2004-2023 the Pacemaker project contributors
fcdfbd
  *
fcdfbd
  * The version control history for this file may have further details.
fcdfbd
  *
fcdfbd
@@ -25,6 +25,10 @@ enum pcmk__node_attr_opts {
fcdfbd
     pcmk__node_attr_perm           = (1 << 5),
fcdfbd
     pcmk__node_attr_sync_local     = (1 << 6),
fcdfbd
     pcmk__node_attr_sync_cluster   = (1 << 7),
fcdfbd
+    // pcmk__node_attr_utilization is 8, but that has not been backported.
fcdfbd
+    // I'm leaving the gap here in case we backport that in the future and
fcdfbd
+    // also to avoid problems on mixed-version clusters.
fcdfbd
+    pcmk__node_attr_query_all      = (1 << 9),
fcdfbd
 };
fcdfbd
 
fcdfbd
 #define pcmk__set_node_attr_flags(node_attr_flags, flags_to_set) do {   \
fcdfbd
diff --git a/include/crm/common/ipc_attrd_internal.h b/include/crm/common/ipc_attrd_internal.h
fcdfbd
index 2c6713f..b1b7584 100644
fcdfbd
--- a/include/crm/common/ipc_attrd_internal.h
fcdfbd
+++ b/include/crm/common/ipc_attrd_internal.h
fcdfbd
@@ -1,5 +1,5 @@
fcdfbd
 /*
fcdfbd
- * Copyright 2022 the Pacemaker project contributors
fcdfbd
+ * Copyright 2022-2023 the Pacemaker project contributors
fcdfbd
  *
fcdfbd
  * The version control history for this file may have further details.
fcdfbd
  *
fcdfbd
@@ -110,10 +110,13 @@ int pcmk__attrd_api_purge(pcmk_ipc_api_t *api, const char *node);
fcdfbd
  *
fcdfbd
  * \param[in,out] api           Connection to pacemaker-attrd
fcdfbd
  * \param[in]     node          Look up the attribute for this node
fcdfbd
- *                              (or NULL for all nodes)
fcdfbd
+ *                              (or NULL for the local node)
fcdfbd
  * \param[in]     name          Attribute name
fcdfbd
  * \param[in]     options       Bitmask of pcmk__node_attr_opts
fcdfbd
  *
fcdfbd
+ * \note Passing pcmk__node_attr_query_all will cause the function to query
fcdfbd
+ *       the value of \p name on all nodes, regardless of the value of \p node.
fcdfbd
+ *
fcdfbd
  * \return Standard Pacemaker return code
fcdfbd
  */
fcdfbd
 int pcmk__attrd_api_query(pcmk_ipc_api_t *api, const char *node, const char *name,
fcdfbd
diff --git a/lib/common/ipc_attrd.c b/lib/common/ipc_attrd.c
fcdfbd
index 4606509..dece49b 100644
fcdfbd
--- a/lib/common/ipc_attrd.c
fcdfbd
+++ b/lib/common/ipc_attrd.c
fcdfbd
@@ -1,5 +1,5 @@
fcdfbd
 /*
fcdfbd
- * Copyright 2011-2022 the Pacemaker project contributors
fcdfbd
+ * Copyright 2011-2023 the Pacemaker project contributors
fcdfbd
  *
fcdfbd
  * The version control history for this file may have further details.
fcdfbd
  *
fcdfbd
@@ -332,10 +332,14 @@ pcmk__attrd_api_query(pcmk_ipc_api_t *api, const char *node, const char *name,
fcdfbd
         return EINVAL;
fcdfbd
     }
fcdfbd
 
fcdfbd
-    target = pcmk__node_attr_target(node);
fcdfbd
+    if (pcmk_is_set(options, pcmk__node_attr_query_all)) {
fcdfbd
+        node = NULL;
fcdfbd
+    } else {
fcdfbd
+        target = pcmk__node_attr_target(node);
fcdfbd
 
fcdfbd
-    if (target != NULL) {
fcdfbd
-        node = target;
fcdfbd
+        if (target != NULL) {
fcdfbd
+            node = target;
fcdfbd
+        }
fcdfbd
     }
fcdfbd
 
fcdfbd
     request = create_attrd_op(NULL);
fcdfbd
diff --git a/tools/attrd_updater.c b/tools/attrd_updater.c
fcdfbd
index 3cd766d..cbd341d 100644
fcdfbd
--- a/tools/attrd_updater.c
fcdfbd
+++ b/tools/attrd_updater.c
fcdfbd
@@ -376,6 +376,7 @@ attrd_event_cb(pcmk_ipc_api_t *attrd_api, enum pcmk_ipc_event event_type,
fcdfbd
 static int
fcdfbd
 send_attrd_query(pcmk__output_t *out, const char *attr_name, const char *attr_node, gboolean query_all)
fcdfbd
 {
fcdfbd
+    uint32_t options = pcmk__node_attr_none;
fcdfbd
     pcmk_ipc_api_t *attrd_api = NULL;
fcdfbd
     int rc = pcmk_rc_ok;
fcdfbd
 
fcdfbd
@@ -400,10 +401,10 @@ send_attrd_query(pcmk__output_t *out, const char *attr_name, const char *attr_no
fcdfbd
 
fcdfbd
     /* Decide which node(s) to query */
fcdfbd
     if (query_all == TRUE) {
fcdfbd
-        attr_node = NULL;
fcdfbd
+        options |= pcmk__node_attr_query_all;
fcdfbd
     }
fcdfbd
 
fcdfbd
-    rc = pcmk__attrd_api_query(attrd_api, attr_node, attr_name, 0);
fcdfbd
+    rc = pcmk__attrd_api_query(attrd_api, attr_node, attr_name, options);
fcdfbd
 
fcdfbd
     if (rc != pcmk_rc_ok) {
fcdfbd
         g_set_error(&error, PCMK__RC_ERROR, rc, "Could not query value of %s: %s (%d)",
fcdfbd
-- 
fcdfbd
2.31.1
fcdfbd