No OneTemporary
Actions

Size

45 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/daemons/attrd/attrd_attributes.c b/daemons/attrd/attrd_attributes.c
	index fdc238375e..7559e89de5 100644
	--- a/daemons/attrd/attrd_attributes.c
	+++ b/daemons/attrd/attrd_attributes.c
	@@ -1,284 +1,299 @@
	/*
	- * 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.
	*
	* This source code is licensed under the GNU General Public License version 2
	* or later (GPLv2+) WITHOUT ANY WARRANTY.
	*/

	#include <crm_internal.h>

	#include <errno.h>
	#include <stdbool.h>
	#include <stdlib.h>
	#include <glib.h>

	#include <crm/common/logging.h>
	#include <crm/common/results.h>
	#include <crm/common/strings_internal.h>
	#include <crm/common/xml.h>

	#include "pacemaker-attrd.h"

	static attribute_t *
	attrd_create_attribute(xmlNode *xml)
	{
	int is_private = 0;
	long long dampen = 0;
	const char *name = crm_element_value(xml, PCMK__XA_ATTR_NAME);
	const char *set_type = crm_element_value(xml, PCMK__XA_ATTR_SET_TYPE);
	const char *dampen_s = crm_element_value(xml, PCMK__XA_ATTR_DAMPENING);
	attribute_t *a = NULL;

	if (set_type == NULL) {
	set_type = PCMK_XE_INSTANCE_ATTRIBUTES;
	}

	/* 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);
	if (!is_private && !pcmk__str_any_of(set_type,
	PCMK_XE_INSTANCE_ATTRIBUTES,
	PCMK_XE_UTILIZATION, NULL)) {
	crm_warn("Ignoring attribute %s with invalid set type %s",
	pcmk__s(name, "(unidentified)"), set_type);
	return NULL;
	}

	a = pcmk__assert_alloc(1, sizeof(attribute_t));

	a->id = pcmk__str_copy(name);
	a->set_type = pcmk__str_copy(set_type);
	a->set_id = crm_element_value_copy(xml, PCMK__XA_ATTR_SET);
	a->user = crm_element_value_copy(xml, PCMK__XA_ATTR_USER);
	a->values = pcmk__strikey_table(NULL, attrd_free_attribute_value);

	if (is_private) {
	attrd_set_attr_flags(a, attrd_attr_is_private);
	}

	if (dampen_s != NULL) {
	dampen = crm_get_msec(dampen_s);
	}

	if (dampen > 0) {
	a->timeout_ms = (int) QB_MIN(dampen, INT_MAX);
	a->timer = attrd_add_timer(a->id, a->timeout_ms, a);
	} else if (dampen < 0) {
	crm_warn("Ignoring invalid delay %s for attribute %s", dampen_s, a->id);
	}

	crm_trace("Created attribute %s with %s write delay and %s CIB user",
	a->id,
	((dampen > 0)? pcmk__readable_interval(a->timeout_ms) : "no"),
	pcmk__s(a->user, "default"));

	g_hash_table_replace(attributes, a->id, a);
	return a;
	}

	static int
	attrd_update_dampening(attribute_t a, xmlNode xml, const char *attr)
	{
	const char *dvalue = crm_element_value(xml, PCMK__XA_ATTR_DAMPENING);
	long long dampen = 0;

	if (dvalue == NULL) {
	crm_warn("Could not update %s: peer did not specify value for delay",
	attr);
	return EINVAL;
	}

	dampen = crm_get_msec(dvalue);
	if (dampen < 0) {
	crm_warn("Could not update %s: invalid delay value %dms (%s)",
	attr, dampen, dvalue);
	return EINVAL;
	}

	if (a->timeout_ms != dampen) {
	mainloop_timer_del(a->timer);
	a->timeout_ms = (int) QB_MIN(dampen, INT_MAX);
	if (dampen > 0) {
	a->timer = attrd_add_timer(attr, a->timeout_ms, a);
	crm_info("Update attribute %s delay to %dms (%s)",
	attr, dampen, dvalue);
	} else {
	a->timer = NULL;
	crm_info("Update attribute %s to remove delay", attr);
	}

	/* If dampening changed, do an immediate write-out,
	* otherwise repeated dampening changes would prevent write-outs
	*/
	attrd_write_or_elect_attribute(a);
	}

	return pcmk_rc_ok;
	}

	GHashTable *attributes = NULL;

	/*!
	* \internal
	* \brief Create an XML representation of an attribute for use in peer messages
	*
	* \param[in,out] parent Create attribute XML as child element of this
	* \param[in] a Attribute to represent
	* \param[in] v Attribute value to represent
	* \param[in] force_write If true, value should be written even if unchanged
	*
	* \return XML representation of attribute
	*/
	xmlNode *
	attrd_add_value_xml(xmlNode parent, const attribute_t a,
	const attribute_value_t *v, bool force_write)
	{
	xmlNode *xml = pcmk__xe_create(parent, __func__);

	crm_xml_add(xml, PCMK__XA_ATTR_NAME, a->id);
	crm_xml_add(xml, PCMK__XA_ATTR_SET_TYPE, a->set_type);
	crm_xml_add(xml, PCMK__XA_ATTR_SET, a->set_id);
	crm_xml_add(xml, PCMK__XA_ATTR_USER, a->user);
	crm_xml_add(xml, PCMK__XA_ATTR_HOST, v->nodename);

	/* @COMPAT Prior to 2.1.10 and 3.0.1, the node's cluster ID was added
	* instead of its XML ID. For Corosync and Pacemaker Remote nodes, those are
	* the same, but if we ever support node XML IDs that differ from their
	* cluster IDs, we will have to drop support for rolling upgrades from
	* versions before those.
	*/
	crm_xml_add(xml, PCMK__XA_ATTR_HOST_ID, attrd_get_node_xml_id(v->nodename));

	crm_xml_add(xml, PCMK__XA_ATTR_VALUE, v->current);
	crm_xml_add_int(xml, PCMK__XA_ATTR_DAMPENING,
	pcmk__timeout_ms2s(a->timeout_ms));
	crm_xml_add_int(xml, PCMK__XA_ATTR_IS_PRIVATE,
	pcmk_is_set(a->flags, attrd_attr_is_private));
	crm_xml_add_int(xml, PCMK__XA_ATTR_IS_REMOTE,
	pcmk_is_set(v->flags, attrd_value_remote));
	crm_xml_add_int(xml, PCMK__XA_ATTRD_IS_FORCE_WRITE, force_write);

	return xml;
	}

	void
	attrd_clear_value_seen(void)
	{
	GHashTableIter aIter;
	GHashTableIter vIter;
	attribute_t *a;
	attribute_value_t *v = NULL;

	g_hash_table_iter_init(&aIter, attributes);
	while (g_hash_table_iter_next(&aIter, NULL, (gpointer *) & a)) {
	g_hash_table_iter_init(&vIter, a->values);
	while (g_hash_table_iter_next(&vIter, NULL, (gpointer *) & v)) {
	attrd_clear_value_flags(v, attrd_value_from_peer);
	}
	}
	}

	attribute_t *
	attrd_populate_attribute(xmlNode xml, const char attr)
	{
	attribute_t *a = NULL;
	bool update_both = false;

	const char *op = crm_element_value(xml, PCMK_XA_TASK);

	// NULL because PCMK__ATTRD_CMD_SYNC_RESPONSE has no PCMK_XA_TASK
	update_both = pcmk__str_eq(op, PCMK__ATTRD_CMD_UPDATE_BOTH,
	pcmk__str_null_matches);

	// Look up or create attribute entry
	a = g_hash_table_lookup(attributes, attr);
	if (a == NULL) {
	if (update_both \|\| pcmk__str_eq(op, PCMK__ATTRD_CMD_UPDATE, pcmk__str_none)) {
	a = attrd_create_attribute(xml);
	if (a == NULL) {
	return NULL;
	}

	} else {
	crm_warn("Could not update %s: attribute not found", attr);
	return NULL;
	}
	}

	// Update attribute dampening
	if (update_both \|\| pcmk__str_eq(op, PCMK__ATTRD_CMD_UPDATE_DELAY, pcmk__str_none)) {
	int rc = attrd_update_dampening(a, xml, attr);

	if (rc != pcmk_rc_ok \|\| !update_both) {
	return NULL;
	}
	}

	return a;
	}

	/*!
	* \internal
	* \brief Get the XML ID used to write out an attribute set
	*
	* \param[in] attr Attribute to get set ID for
	* \param[in] node_state_id XML ID of node state that attribute value is for
	*
	* \return Newly allocated string with XML ID to use for \p attr set
	*/
	char *
	attrd_set_id(const attribute_t attr, const char node_state_id)
	{
	char *set_id = NULL;

	pcmk__assert((attr != NULL) && (node_state_id != NULL));

	if (pcmk__str_empty(attr->set_id)) {
	/* @COMPAT This should really take the set type into account. Currently
	* we use the same XML ID for transient attributes and utilization
	* attributes. It doesn't cause problems because the status section is
	* not limited by the schema in any way, but it's still unfortunate.
	* For backward compatibility reasons, we can't change this.
	*/
	set_id = crm_strdup_printf("%s-%s", PCMK_XE_STATUS, node_state_id);
	} else {
	/* @COMPAT When the user specifies a set ID for an attribute, it is the
	* same for every node. That is less than ideal, but again, the schema
	* doesn't enforce anything for the status section. We couldn't change
	* it without allowing the set ID to vary per value rather than per
	* attribute, which would break backward compatibility, pose design
	* challenges, and potentially cause problems in rolling upgrades.
	*/
	set_id = pcmk__str_copy(attr->set_id);
	}
	pcmk__xml_sanitize_id(set_id);
	return set_id;
	}

	/*!
	* \internal
	* \brief Get the XML ID used to write out an attribute value
	*
	* \param[in] attr Attribute to get value XML ID for
	* \param[in] node_state_id UUID of node that attribute value is for
	*
	* \return Newly allocated string with XML ID of \p attr value
	*/
	char *
	attrd_nvpair_id(const attribute_t attr, const char node_state_id)
	{
	char *nvpair_id = NULL;

	if (attr->set_id != NULL) {
	nvpair_id = crm_strdup_printf("%s-%s", attr->set_id, attr->id);

	} else {
	nvpair_id = crm_strdup_printf(PCMK_XE_STATUS "-%s-%s",
	node_state_id, attr->id);
	}
	pcmk__xml_sanitize_id(nvpair_id);
	return nvpair_id;
	}
	+
	+/*!
	+ * \internal
	+ * \brief Check whether an attribute is one that must be written to the CIB
	+ *
	+ * \param[in] a Attribute to check
	+ *
	+ * \return false if we are in standalone mode or \p a is private, otherwise true
	+ */
	+bool
	+attrd_for_cib(const attribute_t *a)
	+{
	+ return !stand_alone && (a != NULL)
	+ && !pcmk_is_set(a->flags, attrd_attr_is_private);
	+}
	diff --git a/daemons/attrd/attrd_cib.c b/daemons/attrd/attrd_cib.c
	index 4231e4a668..4679434c50 100644
	--- a/daemons/attrd/attrd_cib.c
	+++ b/daemons/attrd/attrd_cib.c
	@@ -1,712 +1,706 @@
	/*
	- * 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.
	*
	* This source code is licensed under the GNU General Public License version 2
	* or later (GPLv2+) WITHOUT ANY WARRANTY.
	*/

	#include <crm_internal.h>

	#include <errno.h>
	#include <stdbool.h>
	#include <stdlib.h>
	#include <glib.h>

	#include <crm/cib/internal.h> // cib__*
	#include <crm/common/logging.h>
	#include <crm/common/results.h>
	#include <crm/common/strings_internal.h>
	#include <crm/common/xml.h>
	#include <crm/cluster/internal.h> // pcmk__get_node()

	#include "pacemaker-attrd.h"

	static int last_cib_op_done = 0;

	static void write_attribute(attribute_t *a, bool ignore_delay);

	static void
	attrd_cib_destroy_cb(gpointer user_data)
	{
	cib_t *cib = user_data;

	cib->cmds->signoff(cib);

	if (attrd_shutting_down(false)) {
	crm_info("Disconnected from the CIB manager");

	} else {
	// @TODO This should trigger a reconnect, not a shutdown
	crm_crit("Lost connection to the CIB manager, shutting down");
	attrd_exit_status = CRM_EX_DISCONNECT;
	attrd_shutdown(0);
	}
	}

	static void
	attrd_cib_updated_cb(const char event, xmlNode msg)
	{
	const xmlNode *patchset = NULL;
	const char *client_name = NULL;
	bool status_changed = false;

	if (cib__get_notify_patchset(msg, &patchset) != pcmk_rc_ok) {
	return;
	}

	if (pcmk__cib_element_in_patchset(patchset, PCMK_XE_ALERTS)) {
	if (attrd_shutting_down(true)) {
	crm_debug("Ignoring alerts change in CIB during shutdown");
	} else {
	mainloop_set_trigger(attrd_config_read);
	}
	}

	status_changed = pcmk__cib_element_in_patchset(patchset, PCMK_XE_STATUS);

	client_name = crm_element_value(msg, PCMK__XA_CIB_CLIENTNAME);
	if (!cib__client_triggers_refresh(client_name)) {
	/* This change came from a source that ensured the CIB is consistent
	* with our attributes table, so we don't need to write anything out.
	*/
	return;
	}

	if (!attrd_election_won()) {
	// Don't write attributes if we're not the writer
	return;
	}

	if (status_changed
	\|\| pcmk__cib_element_in_patchset(patchset, PCMK_XE_NODES)) {

	if (attrd_shutting_down(true)) {
	crm_debug("Ignoring node change in CIB during shutdown");
	return;
	}

	/* An unsafe client modified the PCMK_XE_NODES or PCMK_XE_STATUS
	* section. Write transient attributes to ensure they're up-to-date in
	* the CIB.
	*/
	if (client_name == NULL) {
	client_name = crm_element_value(msg, PCMK__XA_CIB_CLIENTID);
	}
	crm_notice("Updating all attributes after %s event triggered by %s",
	event, pcmk__s(client_name, "unidentified client"));

	attrd_write_attributes(attrd_write_all);
	}
	}

	int
	attrd_cib_connect(int max_retry)
	{
	static int attempts = 0;

	int rc = -ENOTCONN;

	the_cib = cib_new();
	if (the_cib == NULL) {
	return -ENOTCONN;
	}

	do {
	if (attempts > 0) {
	sleep(attempts);
	}
	attempts++;
	crm_debug("Connection attempt %d to the CIB manager", attempts);
	rc = the_cib->cmds->signon(the_cib, crm_system_name, cib_command);

	} while ((rc != pcmk_ok) && (attempts < max_retry));

	if (rc != pcmk_ok) {
	crm_err("Connection to the CIB manager failed: %s " QB_XS " rc=%d",
	pcmk_strerror(rc), rc);
	goto cleanup;
	}

	crm_debug("Connected to the CIB manager after %d attempts", attempts);

	rc = the_cib->cmds->set_connection_dnotify(the_cib, attrd_cib_destroy_cb);
	if (rc != pcmk_ok) {
	crm_err("Could not set disconnection callback");
	goto cleanup;
	}

	rc = the_cib->cmds->add_notify_callback(the_cib,
	PCMK__VALUE_CIB_DIFF_NOTIFY,
	attrd_cib_updated_cb);
	if (rc != pcmk_ok) {
	crm_err("Could not set CIB notification callback");
	goto cleanup;
	}

	return pcmk_ok;

	cleanup:
	cib__clean_up_connection(&the_cib);
	return -ENOTCONN;
	}

	void
	attrd_cib_disconnect(void)
	{
	CRM_CHECK(the_cib != NULL, return);
	the_cib->cmds->del_notify_callback(the_cib, PCMK__VALUE_CIB_DIFF_NOTIFY,
	attrd_cib_updated_cb);
	cib__clean_up_connection(&the_cib);
	mainloop_destroy_trigger(attrd_config_read);
	}

	static void
	attrd_erase_cb(xmlNode msg, int call_id, int rc, xmlNode output,
	void *user_data)
	{
	const char node = pcmk__s((const char ) user_data, "a node");

	if (rc == pcmk_ok) {
	crm_info("Cleared transient node attributes for %s from CIB", node);
	} else {
	crm_err("Unable to clear transient node attributes for %s from CIB: %s",
	node, pcmk_strerror(rc));
	}
	}

	#define XPATH_TRANSIENT "//" PCMK__XE_NODE_STATE \
	"[@" PCMK_XA_UNAME "='%s']" \
	"/" PCMK__XE_TRANSIENT_ATTRIBUTES

	/*!
	* \internal
	* \brief Wipe all transient node attributes for a node from the CIB
	*
	* \param[in] node Node to clear attributes for
	*/
	void
	attrd_cib_erase_transient_attrs(const char *node)
	{
	int call_id = 0;
	char *xpath = NULL;

	CRM_CHECK(node != NULL, return);

	xpath = crm_strdup_printf(XPATH_TRANSIENT, node);

	crm_debug("Clearing transient node attributes for %s from CIB using %s",
	node, xpath);

	call_id = the_cib->cmds->remove(the_cib, xpath, NULL, cib_xpath);
	free(xpath);

	the_cib->cmds->register_callback_full(the_cib, call_id, 120, FALSE,
	pcmk__str_copy(node),
	"attrd_erase_cb", attrd_erase_cb,
	free);
	}

	/*!
	* \internal
	* \brief Prepare the CIB after cluster is connected
	*/
	void
	attrd_cib_init(void)
	{
	/* We have no attribute values in memory, so wipe the CIB to match. This is
	* normally done by the DC's controller when this node leaves the cluster, but
	* this handles the case where the node restarted so quickly that the
	* cluster layer didn't notice.
	*
	* \todo If the attribute manager respawns after crashing (see
	* PCMK_ENV_RESPAWNED), ideally we'd skip this and sync our attributes
	* from the writer. However, currently we reject any values for us
	* that the writer has, in attrd_peer_update().
	*/
	attrd_cib_erase_transient_attrs(attrd_cluster->priv->node_name);

	// Set a trigger for reading the CIB (for the alerts section)
	attrd_config_read = mainloop_add_trigger(G_PRIORITY_HIGH, attrd_read_options, NULL);

	// Always read the CIB at start-up
	mainloop_set_trigger(attrd_config_read);
	}

	static gboolean
	attribute_timer_cb(gpointer data)
	{
	attribute_t *a = data;
	crm_trace("Dampen interval expired for %s", a->id);
	attrd_write_or_elect_attribute(a);
	return FALSE;
	}

	static void
	attrd_cib_callback(xmlNode msg, int call_id, int rc, xmlNode output, void *user_data)
	{
	int level = LOG_ERR;
	GHashTableIter iter;
	const char *peer = NULL;
	attribute_value_t *v = NULL;

	char *name = user_data;
	attribute_t *a = g_hash_table_lookup(attributes, name);

	if(a == NULL) {
	crm_info("Attribute %s no longer exists", name);
	return;
	}

	a->update = 0;
	if (rc == pcmk_ok && call_id < 0) {
	rc = call_id;
	}

	switch (rc) {
	case pcmk_ok:
	level = LOG_INFO;
	last_cib_op_done = call_id;
	if (a->timer && !a->timeout_ms) {
	// Remove temporary dampening for failed writes
	mainloop_timer_del(a->timer);
	a->timer = NULL;
	}
	break;

	case -pcmk_err_diff_failed: /* When an attr changes while the CIB is syncing */
	case -ETIME: /* When an attr changes while there is a DC election */
	case -ENXIO: /* When an attr changes while the CIB is syncing a
	* newer config from a node that just came up
	*/
	level = LOG_WARNING;
	break;
	}

	do_crm_log(level, "CIB update %d result for %s: %s " QB_XS " rc=%d",
	call_id, a->id, pcmk_strerror(rc), rc);

	g_hash_table_iter_init(&iter, a->values);
	while (g_hash_table_iter_next(&iter, (gpointer ) & peer, (gpointer ) & v)) {
	if (rc == pcmk_ok) {
	crm_info("* Wrote %s[%s]=%s",
	a->id, peer, pcmk__s(v->requested, "(unset)"));
	pcmk__str_update(&(v->requested), NULL);
	} else {
	do_crm_log(level, "* Could not write %s[%s]=%s",
	a->id, peer, pcmk__s(v->requested, "(unset)"));
	/* Reattempt write below if we are still the writer */
	attrd_set_attr_flags(a, attrd_attr_changed);
	}
	}

	if (pcmk_is_set(a->flags, attrd_attr_changed) && attrd_election_won()) {
	if (rc == pcmk_ok) {
	/* We deferred a write of a new update because this update was in
	* progress. Write out the new value without additional delay.
	*/
	crm_debug("Pending update for %s can be written now", a->id);
	write_attribute(a, false);

	/* We're re-attempting a write because the original failed; delay
	* the next attempt so we don't potentially flood the CIB manager
	* and logs with a zillion attempts per second.
	*
	* @TODO We could elect a new writer instead. However, we'd have to
	* somehow downgrade our vote, and we'd still need something like this
	* if all peers similarly fail to write this attribute (which may
	* indicate a corrupted attribute entry rather than a CIB issue).
	*/
	} else if (a->timer) {
	// Attribute has a dampening value, so use that as delay
	if (!mainloop_timer_running(a->timer)) {
	crm_trace("Delayed re-attempted write for %s by %s",
	name, pcmk__readable_interval(a->timeout_ms));
	mainloop_timer_start(a->timer);
	}
	} else {
	/* Set a temporary dampening of 2 seconds (timer will continue
	* to exist until the attribute's dampening gets set or the
	* write succeeds).
	*/
	a->timer = attrd_add_timer(a->id, 2000, a);
	mainloop_timer_start(a->timer);
	}
	}
	}

	/*!
	* \internal
	* \brief Add a set-attribute update request to the current CIB transaction
	*
	* \param[in] attr Attribute to update
	* \param[in] attr_id ID of attribute to update
	* \param[in] node_id ID of node for which to update attribute value
	* \param[in] set_id ID of attribute set
	* \param[in] value New value for attribute
	*
	* \return Standard Pacemaker return code
	*/
	static int
	add_set_attr_update(const attribute_t attr, const char attr_id,
	const char node_id, const char set_id, const char *value)
	{
	xmlNode *update = pcmk__xe_create(NULL, PCMK__XE_NODE_STATE);
	xmlNode *child = update;
	int rc = ENOMEM;

	crm_xml_add(child, PCMK_XA_ID, node_id);

	child = pcmk__xe_create(child, PCMK__XE_TRANSIENT_ATTRIBUTES);
	crm_xml_add(child, PCMK_XA_ID, node_id);

	child = pcmk__xe_create(child, attr->set_type);
	crm_xml_add(child, PCMK_XA_ID, set_id);

	child = pcmk__xe_create(child, PCMK_XE_NVPAIR);
	crm_xml_add(child, PCMK_XA_ID, attr_id);
	crm_xml_add(child, PCMK_XA_NAME, attr->id);
	crm_xml_add(child, PCMK_XA_VALUE, value);

	rc = the_cib->cmds->modify(the_cib, PCMK_XE_STATUS, update,
	cib_can_create\|cib_transaction);
	rc = pcmk_legacy2rc(rc);

	pcmk__xml_free(update);
	return rc;
	}

	/*!
	* \internal
	* \brief Add an unset-attribute update request to the current CIB transaction
	*
	* \param[in] attr Attribute to update
	* \param[in] attr_id ID of attribute to update
	* \param[in] node_id ID of node for which to update attribute value
	* \param[in] set_id ID of attribute set
	*
	* \return Standard Pacemaker return code
	*/
	static int
	add_unset_attr_update(const attribute_t attr, const char attr_id,
	const char node_id, const char set_id)
	{
	char *xpath = crm_strdup_printf("/" PCMK_XE_CIB
	"/" PCMK_XE_STATUS
	"/" PCMK__XE_NODE_STATE
	"[@" PCMK_XA_ID "='%s']"
	"/" PCMK__XE_TRANSIENT_ATTRIBUTES
	"[@" PCMK_XA_ID "='%s']"
	"/%s[@" PCMK_XA_ID "='%s']"
	"/" PCMK_XE_NVPAIR
	"[@" PCMK_XA_ID "='%s' "
	"and @" PCMK_XA_NAME "='%s']",
	node_id, node_id, attr->set_type, set_id,
	attr_id, attr->id);

	int rc = the_cib->cmds->remove(the_cib, xpath, NULL,
	cib_xpath\|cib_transaction);

	free(xpath);
	return pcmk_legacy2rc(rc);
	}

	/*!
	* \internal
	* \brief Add an attribute update request to the current CIB transaction
	*
	* \param[in] attr Attribute to update
	* \param[in] value New value for attribute
	* \param[in] node_id ID of node for which to update attribute value
	*
	* \return Standard Pacemaker return code
	*/
	static int
	add_attr_update(const attribute_t attr, const char value, const char *node_id)
	{
	char *set_id = attrd_set_id(attr, node_id);
	char *nvpair_id = attrd_nvpair_id(attr, node_id);
	int rc = pcmk_rc_ok;

	if (value == NULL) {
	rc = add_unset_attr_update(attr, nvpair_id, node_id, set_id);
	} else {
	rc = add_set_attr_update(attr, nvpair_id, node_id, set_id, value);
	}
	free(set_id);
	free(nvpair_id);
	return rc;
	}

	static void
	send_alert_attributes_value(attribute_t a, GHashTable t)
	{
	int rc = 0;
	attribute_value_t *at = NULL;
	GHashTableIter vIter;

	g_hash_table_iter_init(&vIter, t);

	while (g_hash_table_iter_next(&vIter, NULL, (gpointer *) & at)) {
	const char *node_xml_id = attrd_get_node_xml_id(at->nodename);

	rc = attrd_send_attribute_alert(at->nodename, node_xml_id,
	a->id, at->current);
	crm_trace("Sent alerts for %s[%s]=%s with node XML ID %s "
	"(%s agents failed)",
	a->id, at->nodename, at->current,
	pcmk__s(node_xml_id, "unknown"),
	((rc == 0)? "no" : ((rc == -1)? "some" : "all")));
	}
	}

	static void
	set_alert_attribute_value(GHashTable t, attribute_value_t v)
	{
	attribute_value_t *a_v = pcmk__assert_alloc(1, sizeof(attribute_value_t));

	a_v->nodename = pcmk__str_copy(v->nodename);
	a_v->current = pcmk__str_copy(v->current);

	g_hash_table_replace(t, a_v->nodename, a_v);
	}

	mainloop_timer_t *
	attrd_add_timer(const char id, int timeout_ms, attribute_t attr)
	{
	return mainloop_timer_add(id, timeout_ms, FALSE, attribute_timer_cb, attr);
	}

	/*!
	* \internal
	* \brief Write an attribute's values to the CIB if appropriate
	*
	* \param[in,out] a Attribute to write
	* \param[in] ignore_delay If true, write attribute now regardless of any
	* configured delay
	*/
	static void
	write_attribute(attribute_t *a, bool ignore_delay)
	{
	int private_updates = 0, cib_updates = 0;
	attribute_value_t *v = NULL;
	GHashTableIter iter;
	GHashTable *alert_attribute_value = NULL;
	int rc = pcmk_ok;
	- bool should_write = true;
	+ bool should_write = attrd_for_cib(a);

	if (a == NULL) {
	return;
	}

	- // Private attributes (or any in standalone mode) are not written to the CIB
	- if (stand_alone \|\| pcmk_is_set(a->flags, attrd_attr_is_private)) {
	- should_write = false;
	- }
	-
	- /* If this attribute will be written to the CIB ... */
	if (should_write) {
	/* Defer the write if now's not a good time */
	if (a->update && (a->update < last_cib_op_done)) {
	crm_info("Write out of '%s' continuing: update %d considered lost",
	a->id, a->update);
	a->update = 0; // Don't log this message again

	} else if (a->update) {
	crm_info("Write out of '%s' delayed: update %d in progress",
	a->id, a->update);
	goto done;

	} else if (mainloop_timer_running(a->timer)) {
	if (ignore_delay) {
	mainloop_timer_stop(a->timer);
	crm_debug("Overriding '%s' write delay", a->id);
	} else {
	crm_info("Delaying write of '%s'", a->id);
	goto done;
	}
	}

	// Initiate a transaction for all the peer value updates
	CRM_CHECK(the_cib != NULL, goto done);
	the_cib->cmds->set_user(the_cib, a->user);
	rc = the_cib->cmds->init_transaction(the_cib);
	if (rc != pcmk_ok) {
	crm_err("Failed to write %s (set %s): Could not initiate "
	"CIB transaction",
	a->id, pcmk__s(a->set_id, "unspecified"));
	goto done;
	}
	}

	/* The changed and force-write flags apply only to the next write,
	* which this is, so clear them now. Also clear the "node unknown" flag
	* because we will check whether it is known below and reset if appopriate.
	*/
	attrd_clear_attr_flags(a, attrd_attr_changed
	\|attrd_attr_force_write
	\|attrd_attr_node_unknown);

	/* Make the table for the attribute trap */
	alert_attribute_value = pcmk__strikey_table(NULL,
	attrd_free_attribute_value);

	/* Iterate over each peer value of this attribute */
	g_hash_table_iter_init(&iter, a->values);
	while (g_hash_table_iter_next(&iter, NULL, (gpointer *) &v)) {
	const char *node_xml_id = NULL;
	const char *prev_xml_id = NULL;

	if (!should_write) {
	private_updates++;
	continue;
	}

	/* We need the node's CIB XML ID to write out its attributes, so look
	* for it now. Check the node caches first, even if the ID was
	* previously known (in case it changed), but use any previous value as
	* a fallback.
	*/

	prev_xml_id = attrd_get_node_xml_id(v->nodename);

	if (pcmk_is_set(v->flags, attrd_value_remote)) {
	// A Pacemaker Remote node's XML ID is the same as its name
	node_xml_id = v->nodename;

	} else {
	// This creates a cluster node cache entry if none exists
	pcmk__node_status_t *peer = pcmk__get_node(0, v->nodename,
	prev_xml_id,
	pcmk__node_search_any);

	node_xml_id = pcmk__cluster_get_xml_id(peer);
	if (node_xml_id == NULL) {
	node_xml_id = prev_xml_id;
	}
	}

	// Defer write if this is a cluster node that's never been seen
	if (node_xml_id == NULL) {
	attrd_set_attr_flags(a, attrd_attr_node_unknown);
	crm_notice("Cannot write %s[%s]='%s' to CIB because node's XML ID "
	"is unknown (will retry if learned)",
	a->id, v->nodename, v->current);
	continue;
	}

	if (!pcmk__str_eq(prev_xml_id, node_xml_id, pcmk__str_none)) {
	crm_trace("Setting %s[%s] node XML ID to %s (was %s)",
	a->id, v->nodename, node_xml_id,
	pcmk__s(prev_xml_id, "unknown"));
	attrd_set_node_xml_id(v->nodename, node_xml_id);
	}

	// Update this value as part of the CIB transaction we're building
	rc = add_attr_update(a, v->current, node_xml_id);
	if (rc != pcmk_rc_ok) {
	crm_err("Couldn't add %s[%s]='%s' to CIB transaction: %s "
	QB_XS " node XML ID %s",
	a->id, v->nodename, v->current, pcmk_rc_str(rc),
	node_xml_id);
	continue;
	}

	crm_debug("Added %s[%s]=%s to CIB transaction (node XML ID %s)",
	a->id, v->nodename, pcmk__s(v->current, "(unset)"),
	node_xml_id);
	cib_updates++;

	/* Preservation of the attribute to transmit alert */
	set_alert_attribute_value(alert_attribute_value, v);

	// Save this value so we can log it when write completes
	pcmk__str_update(&(v->requested), v->current);
	}

	if (private_updates) {
	crm_info("Processed %d private change%s for %s (set %s)",
	private_updates, pcmk__plural_s(private_updates),
	a->id, pcmk__s(a->set_id, "unspecified"));
	}
	if (cib_updates > 0) {
	char *id = pcmk__str_copy(a->id);

	// Commit transaction
	a->update = the_cib->cmds->end_transaction(the_cib, true, cib_none);

	crm_info("Sent CIB request %d with %d change%s for %s (set %s)",
	a->update, cib_updates, pcmk__plural_s(cib_updates),
	a->id, pcmk__s(a->set_id, "unspecified"));

	if (the_cib->cmds->register_callback_full(the_cib, a->update,
	CIB_OP_TIMEOUT_S, FALSE, id,
	"attrd_cib_callback",
	attrd_cib_callback, free)) {
	// Transmit alert of the attribute
	send_alert_attributes_value(a, alert_attribute_value);
	}
	}

	done:
	// Discard transaction (if any)
	if (the_cib != NULL) {
	the_cib->cmds->end_transaction(the_cib, false, cib_none);
	the_cib->cmds->set_user(the_cib, NULL);
	}

	if (alert_attribute_value != NULL) {
	g_hash_table_destroy(alert_attribute_value);
	}
	}

	/*!
	* \internal
	* \brief Write out attributes
	*
	* \param[in] options Group of enum attrd_write_options
	*/
	void
	attrd_write_attributes(uint32_t options)
	{
	GHashTableIter iter;
	attribute_t *a = NULL;

	crm_debug("Writing out %s attributes",
	pcmk_is_set(options, attrd_write_all)? "all" : "changed");
	g_hash_table_iter_init(&iter, attributes);
	while (g_hash_table_iter_next(&iter, NULL, (gpointer *) & a)) {
	if (!pcmk_is_set(options, attrd_write_all)
	&& pcmk_is_set(a->flags, attrd_attr_node_unknown)) {
	// Try writing this attribute again, in case peer ID was learned
	attrd_set_attr_flags(a, attrd_attr_changed);
	} else if (pcmk_is_set(a->flags, attrd_attr_force_write)) {
	/* If the force_write flag is set, write the attribute. */
	attrd_set_attr_flags(a, attrd_attr_changed);
	}

	if (pcmk_is_set(options, attrd_write_all) \|\|
	pcmk_is_set(a->flags, attrd_attr_changed)) {
	bool ignore_delay = pcmk_is_set(options, attrd_write_no_delay);

	if (pcmk_is_set(a->flags, attrd_attr_force_write)) {
	// Always ignore delay when forced write flag is set
	ignore_delay = true;
	}
	write_attribute(a, ignore_delay);
	} else {
	crm_trace("Skipping unchanged attribute %s", a->id);
	}
	}
	}

	void
	attrd_write_or_elect_attribute(attribute_t *a)
	{
	if (attrd_election_won()) {
	write_attribute(a, false);
	} else {
	attrd_start_election_if_needed();
	}
	}
	diff --git a/daemons/attrd/pacemaker-attrd.h b/daemons/attrd/pacemaker-attrd.h
	index cc0dcf29ee..24ab4c9915 100644
	--- a/daemons/attrd/pacemaker-attrd.h
	+++ b/daemons/attrd/pacemaker-attrd.h
	@@ -1,260 +1,261 @@
	/*
	* Copyright 2013-2025 the Pacemaker project contributors
	*
	* The version control history for this file may have further details.
	*
	* This source code is licensed under the GNU General Public License version 2
	* or later (GPLv2+) WITHOUT ANY WARRANTY.
	*/

	#ifndef PACEMAKER_ATTRD__H
	# define PACEMAKER_ATTRD__H

	#include <regex.h>
	#include <glib.h>
	#include <crm/crm.h>
	#include <crm/cluster.h>
	#include <crm/cluster/election_internal.h>
	#include <crm/common/messages_internal.h>
	#include <crm/cib/cib_types.h>

	/*
	* Legacy attrd (all pre-1.1.11 Pacemaker versions, plus all versions when used
	* with the no-longer-supported CMAN or corosync-plugin stacks) is unversioned.
	*
	* With atomic attrd, each attrd will send ATTRD_PROTOCOL_VERSION with every
	* peer request and reply. As of Pacemaker 2.0.0, at start-up each attrd will
	* also set a private attribute for itself with its version, so any attrd can
	* determine the minimum version supported by all peers.
	*
	* Protocol Pacemaker Significant changes
	* -------- --------- -------------------
	* 1 1.1.11 PCMK__ATTRD_CMD_UPDATE (PCMK__XA_ATTR_NAME only),
	* PCMK__ATTRD_CMD_PEER_REMOVE, PCMK__ATTRD_CMD_REFRESH,
	* "flush", PCMK__ATTRD_CMD_SYNC_RESPONSE
	* 1 1.1.13 PCMK__ATTRD_CMD_UPDATE (with PCMK__XA_ATTR_REGEX),
	* PCMK__ATTRD_CMD_QUERY
	* 1 1.1.15 PCMK__ATTRD_CMD_UPDATE_BOTH,
	* PCMK__ATTRD_CMD_UPDATE_DELAY
	* 2 1.1.17 PCMK__ATTRD_CMD_CLEAR_FAILURE
	* 3 2.1.1 PCMK__ATTRD_CMD_SYNC_RESPONSE indicates remote nodes
	* 4 2.1.5 Multiple attributes can be updated in a single IPC
	* message
	* 5 2.1.5 Peers can request confirmation of a sent message
	* 6 2.1.7 PCMK__ATTRD_CMD_PEER_REMOVE supports PCMK__XA_REAP
	* 7 3.0.0 "flush" support dropped
	*/
	#define ATTRD_PROTOCOL_VERSION "7"

	#define ATTRD_SUPPORTS_MULTI_MESSAGE(x) ((x) >= 4)
	#define ATTRD_SUPPORTS_CONFIRMATION(x) ((x) >= 5)

	#define attrd_send_ack(client, id, flags) \
	pcmk__ipc_send_ack((client), (id), (flags), PCMK__XE_ACK, \
	ATTRD_PROTOCOL_VERSION, CRM_EX_INDETERMINATE)

	void attrd_init_mainloop(void);
	void attrd_run_mainloop(void);

	void attrd_set_requesting_shutdown(void);
	void attrd_clear_requesting_shutdown(void);
	void attrd_free_waitlist(void);
	bool attrd_shutting_down(bool if_requested);
	void attrd_shutdown(int nsig);
	void attrd_init_ipc(void);
	void attrd_ipc_fini(void);

	int attrd_cib_connect(int max_retry);
	void attrd_cib_disconnect(void);
	void attrd_cib_init(void);
	void attrd_cib_erase_transient_attrs(const char *node);

	bool attrd_value_needs_expansion(const char *value);
	int attrd_expand_value(const char value, const char old_value);

	/* regular expression to clear failures of all resources */
	#define ATTRD_RE_CLEAR_ALL \
	"^(" PCMK__FAIL_COUNT_PREFIX "\|" PCMK__LAST_FAILURE_PREFIX ")-"

	/* regular expression to clear failure of all operations for one resource
	* (format takes resource name)
	*/
	#define ATTRD_RE_CLEAR_ONE ATTRD_RE_CLEAR_ALL "%s#.+_[0-9]+$"

	/* regular expression to clear failure of one operation for one resource
	* (format takes resource name, operation name, and interval)
	*/
	#define ATTRD_RE_CLEAR_OP ATTRD_RE_CLEAR_ALL "%s#%s_%u$"

	int attrd_failure_regex(regex_t regex, const char rsc, const char *op,
	guint interval_ms);

	extern cib_t *the_cib;
	extern crm_exit_t attrd_exit_status;

	/* Alerts */

	extern lrmd_t *the_lrmd;
	extern crm_trigger_t *attrd_config_read;

	void attrd_lrmd_disconnect(void);
	gboolean attrd_read_options(gpointer user_data);
	int attrd_send_attribute_alert(const char node, const char node_xml_id,
	const char attr, const char value);

	// Elections
	void attrd_election_init(void);
	void attrd_start_election_if_needed(void);
	bool attrd_election_won(void);
	void attrd_handle_election_op(const pcmk__node_status_t peer, xmlNode xml);
	bool attrd_check_for_new_writer(const pcmk__node_status_t *peer,
	const xmlNode *xml);
	void attrd_declare_winner(void);
	void attrd_remove_voter(const pcmk__node_status_t *peer);
	void attrd_xml_add_writer(xmlNode *xml);

	enum attrd_attr_flags {
	attrd_attr_none = 0U,

	// At least one of attribute's values has changed since last write
	attrd_attr_changed = (1U << 0),

	// At least one of attribute's values has an unknown node XML ID
	attrd_attr_node_unknown = (1U << 1),

	// This attribute should never be written to the CIB
	attrd_attr_is_private = (1U << 2),

	// Ignore any configured delay for next write of this attribute
	attrd_attr_force_write = (1U << 3),
	};

	typedef struct attribute_s {
	char *id; // Attribute name
	char *set_type; // PCMK_XE_INSTANCE_ATTRIBUTES or PCMK_XE_UTILIZATION
	char *set_id; // Set's XML ID to use when writing
	char *user; // ACL user to use for CIB writes
	int update; // Call ID of pending write
	int timeout_ms; // How long to wait for more changes before writing
	uint32_t flags; // Group of enum attrd_attr_flags
	GHashTable *values; // Key: node name, value: attribute_value_t
	mainloop_timer_t *timer; // Timer to use for timeout_ms
	} attribute_t;

	#define attrd_set_attr_flags(attr, flags_to_set) do { \
	(attr)->flags = pcmk__set_flags_as(__func__, __LINE__, \
	LOG_TRACE, "Value for attribute", (attr)->id, \
	(attr)->flags, (flags_to_set), #flags_to_set); \
	} while (0)

	#define attrd_clear_attr_flags(attr, flags_to_clear) do { \
	(attr)->flags = pcmk__clear_flags_as(__func__, __LINE__, \
	LOG_TRACE, "Value for attribute", (attr)->id, \
	(attr)->flags, (flags_to_clear), #flags_to_clear); \
	} while (0)

	enum attrd_value_flags {
	attrd_value_none = 0U,
	attrd_value_remote = (1U << 0), // Value is for Pacemaker Remote node
	attrd_value_from_peer = (1U << 1), // Value is from peer sync response
	};

	typedef struct attribute_value_s {
	char *nodename; // Node that this value is for
	char *current; // Attribute value
	char *requested; // Value specified in pending CIB write, if any
	uint32_t flags; // Group of attrd_value_flags
	} attribute_value_t;

	#define attrd_set_value_flags(attr_value, flags_to_set) do { \
	(attr_value)->flags = pcmk__set_flags_as(__func__, __LINE__, \
	LOG_TRACE, "Value for node", (attr_value)->nodename, \
	(attr_value)->flags, (flags_to_set), #flags_to_set); \
	} while (0)

	#define attrd_clear_value_flags(attr_value, flags_to_clear) do { \
	(attr_value)->flags = pcmk__clear_flags_as(__func__, __LINE__, \
	LOG_TRACE, "Value for node", (attr_value)->nodename, \
	(attr_value)->flags, (flags_to_clear), #flags_to_clear); \
	} while (0)

	extern pcmk_cluster_t *attrd_cluster;
	extern GHashTable *attributes;
	extern GHashTable *peer_protocol_vers;

	#define CIB_OP_TIMEOUT_S 120

	int attrd_cluster_connect(void);
	void attrd_broadcast_value(const attribute_t a, const attribute_value_t v);
	void attrd_peer_update(const pcmk__node_status_t peer, xmlNode xml,
	const char *host, bool filter);
	void attrd_peer_sync(pcmk__node_status_t *peer);
	void attrd_peer_remove(const char host, bool uncache, const char source);
	void attrd_peer_clear_failure(pcmk__request_t *request);
	void attrd_peer_sync_response(const pcmk__node_status_t *peer, bool peer_won,
	xmlNode *xml);

	void attrd_broadcast_protocol(void);
	xmlNode attrd_client_peer_remove(pcmk__request_t request);
	xmlNode attrd_client_clear_failure(pcmk__request_t request);
	xmlNode attrd_client_update(pcmk__request_t request);
	xmlNode attrd_client_refresh(pcmk__request_t request);
	xmlNode attrd_client_query(pcmk__request_t request);
	gboolean attrd_send_message(pcmk__node_status_t node, xmlNode data,
	bool confirm);

	xmlNode attrd_add_value_xml(xmlNode parent, const attribute_t *a,
	const attribute_value_t *v, bool force_write);
	void attrd_clear_value_seen(void);
	void attrd_free_attribute(gpointer data);
	void attrd_free_attribute_value(gpointer data);
	attribute_t attrd_populate_attribute(xmlNode xml, const char *attr);
	char attrd_set_id(const attribute_t attr, const char *node_state_id);
	char attrd_nvpair_id(const attribute_t attr, const char *node_state_id);
	+bool attrd_for_cib(const attribute_t *a);

	enum attrd_write_options {
	attrd_write_changed = 0,
	attrd_write_all = (1 << 0),
	attrd_write_no_delay = (1 << 1),
	};

	void attrd_write_attributes(uint32_t options);
	void attrd_write_or_elect_attribute(attribute_t *a);

	extern int minimum_protocol_version;
	void attrd_remove_peer_protocol_ver(const char *host);
	void attrd_update_minimum_protocol_ver(const char host, const char value);

	mainloop_timer_t attrd_add_timer(const char id, int timeout_ms, attribute_t *attr);

	void attrd_unregister_handlers(void);
	void attrd_handle_request(pcmk__request_t *request);

	enum attrd_sync_point {
	attrd_sync_point_local,
	attrd_sync_point_cluster,
	};

	typedef int (attrd_confirmation_action_fn)(xmlNode );

	void attrd_add_client_to_waitlist(pcmk__request_t *request);
	void attrd_ack_waitlist_clients(enum attrd_sync_point sync_point, const xmlNode *xml);
	int attrd_cluster_sync_point_update(xmlNode *xml);
	void attrd_do_not_expect_from_peer(const char *host);
	void attrd_do_not_wait_for_client(pcmk__client_t *client);
	void attrd_expect_confirmations(pcmk__request_t *request, attrd_confirmation_action_fn fn);
	void attrd_free_confirmations(void);
	void attrd_handle_confirmation(int callid, const char *host);
	void attrd_remove_client_from_waitlist(pcmk__client_t *client);
	const char attrd_request_sync_point(xmlNode xml);
	bool attrd_request_has_sync_point(xmlNode *xml);

	extern gboolean stand_alone;

	// Node utilities (from attrd_nodes.c)
	const char attrd_get_node_xml_id(const char node_name);
	void attrd_set_node_xml_id(const char node_name, const char node_xml_id);
	void attrd_forget_node_xml_id(const char *node_name);
	void attrd_cleanup_xml_ids(void);

	#endif /* PACEMAKER_ATTRD__H */

File Metadata

Mime Type: text/x-diff
Expires: Sat, Jan 25, 11:25 AM (1 d, 16 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1318323
Default Alt Text: (45 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions