No OneTemporary
Actions

Size

93 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/lib/common/ipc_client.c b/lib/common/ipc_client.c
	index 63483e7b2d..e9575a57dc 100644
	--- a/lib/common/ipc_client.c
	+++ b/lib/common/ipc_client.c
	@@ -1,1694 +1,1693 @@
	/*
	* Copyright 2004-2025 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>

	#if defined(HAVE_UCRED) \|\| defined(HAVE_SOCKPEERCRED)
	#include <sys/socket.h>
	#elif defined(HAVE_GETPEERUCRED)
	#include <ucred.h>
	#endif

	#include <stdio.h>
	#include <sys/types.h>
	#include <errno.h>
	#include <bzlib.h>

	#include <crm/crm.h> /* indirectly: pcmk_err_generic */
	#include <crm/common/xml.h>
	#include <crm/common/ipc.h>
	#include <crm/common/ipc_internal.h>
	#include "crmcommon_private.h"

	static int is_ipc_provider_expected(qb_ipcc_connection_t *qb_ipc, int sock,
	uid_t refuid, gid_t refgid, pid_t *gotpid,
	uid_t gotuid, gid_t gotgid);

	/*!
	* \brief Create a new object for using Pacemaker daemon IPC
	*
	* \param[out] api Where to store new IPC object
	* \param[in] server Which Pacemaker daemon the object is for
	*
	* \return Standard Pacemaker result code
	*
	* \note The caller is responsible for freeing *api using pcmk_free_ipc_api().
	* \note This is intended to supersede crm_ipc_new() but currently only
	* supports the controller, pacemakerd, and schedulerd IPC API.
	*/
	int
	pcmk_new_ipc_api(pcmk_ipc_api_t **api, enum pcmk_ipc_server server)
	{
	if (api == NULL) {
	return EINVAL;
	}

	*api = calloc(1, sizeof(pcmk_ipc_api_t));
	if (*api == NULL) {
	return errno;
	}

	(*api)->server = server;
	if (pcmk_ipc_name(*api, false) == NULL) {
	pcmk_free_ipc_api(*api);
	*api = NULL;
	return EOPNOTSUPP;
	}

	(*api)->ipc_size_max = 0;

	// Set server methods and max_size (if not default)
	switch (server) {
	case pcmk_ipc_attrd:
	(*api)->cmds = pcmk__attrd_api_methods();
	break;

	case pcmk_ipc_based:
	(api)->ipc_size_max = 512 1024; // 512KB
	break;

	case pcmk_ipc_controld:
	(*api)->cmds = pcmk__controld_api_methods();
	break;

	case pcmk_ipc_execd:
	break;

	case pcmk_ipc_fenced:
	break;

	case pcmk_ipc_pacemakerd:
	(*api)->cmds = pcmk__pacemakerd_api_methods();
	break;

	case pcmk_ipc_schedulerd:
	(*api)->cmds = pcmk__schedulerd_api_methods();
	// @TODO max_size could vary by client, maybe take as argument?
	(api)->ipc_size_max = 5 1024 * 1024; // 5MB
	break;

	default: // pcmk_ipc_unknown
	pcmk_free_ipc_api(*api);
	*api = NULL;
	return EINVAL;
	}
	if ((*api)->cmds == NULL) {
	pcmk_free_ipc_api(*api);
	*api = NULL;
	return ENOMEM;
	}

	- (api)->ipc = crm_ipc_new(pcmk_ipc_name(api, false),
	- (*api)->ipc_size_max);
	+ (api)->ipc = crm_ipc_new(pcmk_ipc_name(api, false), 0);
	if ((*api)->ipc == NULL) {
	pcmk_free_ipc_api(*api);
	*api = NULL;
	return ENOMEM;
	}

	// If daemon API has its own data to track, allocate it
	if ((*api)->cmds->new_data != NULL) {
	if ((api)->cmds->new_data(api) != pcmk_rc_ok) {
	pcmk_free_ipc_api(*api);
	*api = NULL;
	return ENOMEM;
	}
	}
	crm_trace("Created %s API IPC object", pcmk_ipc_name(*api, true));
	return pcmk_rc_ok;
	}

	static void
	free_daemon_specific_data(pcmk_ipc_api_t *api)
	{
	if ((api != NULL) && (api->cmds != NULL)) {
	if ((api->cmds->free_data != NULL) && (api->api_data != NULL)) {
	api->cmds->free_data(api->api_data);
	api->api_data = NULL;
	}
	free(api->cmds);
	api->cmds = NULL;
	}
	}

	/*!
	* \internal
	* \brief Call an IPC API event callback, if one is registed
	*
	* \param[in,out] api IPC API connection
	* \param[in] event_type The type of event that occurred
	* \param[in] status Event status
	* \param[in,out] event_data Event-specific data
	*/
	void
	pcmk__call_ipc_callback(pcmk_ipc_api_t *api, enum pcmk_ipc_event event_type,
	crm_exit_t status, void *event_data)
	{
	if ((api != NULL) && (api->cb != NULL)) {
	api->cb(api, event_type, status, event_data, api->user_data);
	}
	}

	/*!
	* \internal
	* \brief Clean up after an IPC disconnect
	*
	* \param[in,out] user_data IPC API connection that disconnected
	*
	* \note This function can be used as a main loop IPC destroy callback.
	*/
	static void
	ipc_post_disconnect(gpointer user_data)
	{
	pcmk_ipc_api_t *api = user_data;

	crm_info("Disconnected from %s", pcmk_ipc_name(api, true));

	// Perform any daemon-specific handling needed
	if ((api->cmds != NULL) && (api->cmds->post_disconnect != NULL)) {
	api->cmds->post_disconnect(api);
	}

	// Call client's registered event callback
	pcmk__call_ipc_callback(api, pcmk_ipc_event_disconnect, CRM_EX_DISCONNECT,
	NULL);

	/* If this is being called from a running main loop, mainloop_gio_destroy()
	* will free ipc and mainloop_io immediately after calling this function.
	* If this is called from a stopped main loop, these will leak, so the best
	* practice is to close the connection before stopping the main loop.
	*/
	api->ipc = NULL;
	api->mainloop_io = NULL;

	if (api->free_on_disconnect) {
	/* pcmk_free_ipc_api() has already been called, but did not free api
	* or api->cmds because this function needed them. Do that now.
	*/
	free_daemon_specific_data(api);
	crm_trace("Freeing IPC API object after disconnect");
	free(api);
	}
	}

	/*!
	* \brief Free the contents of an IPC API object
	*
	* \param[in,out] api IPC API object to free
	*/
	void
	pcmk_free_ipc_api(pcmk_ipc_api_t *api)
	{
	bool free_on_disconnect = false;

	if (api == NULL) {
	return;
	}
	crm_debug("Releasing %s IPC API", pcmk_ipc_name(api, true));

	if (api->ipc != NULL) {
	if (api->mainloop_io != NULL) {
	/* We need to keep the api pointer itself around, because it is the
	* user data for the IPC client destroy callback. That will be
	* triggered by the pcmk_disconnect_ipc() call below, but it might
	* happen later in the main loop (if still running).
	*
	* This flag tells the destroy callback to free the object. It can't
	* do that unconditionally, because the application might call this
	* function after a disconnect that happened by other means.
	*/
	free_on_disconnect = api->free_on_disconnect = true;
	}
	pcmk_disconnect_ipc(api); // Frees api if free_on_disconnect is true
	}
	if (!free_on_disconnect) {
	free_daemon_specific_data(api);
	crm_trace("Freeing IPC API object");
	free(api);
	}
	}

	/*!
	* \brief Get the IPC name used with an IPC API connection
	*
	* \param[in] api IPC API connection
	* \param[in] for_log If true, return human-friendly name instead of IPC name
	*
	* \return IPC API's human-friendly or connection name, or if none is available,
	* "Pacemaker" if for_log is true and NULL if for_log is false
	*/
	const char *
	pcmk_ipc_name(const pcmk_ipc_api_t *api, bool for_log)
	{
	if (api == NULL) {
	return for_log? "Pacemaker" : NULL;
	}
	if (for_log) {
	const char *name = pcmk__server_log_name(api->server);

	return pcmk__s(name, "Pacemaker");
	}
	switch (api->server) {
	// These servers do not have pcmk_ipc_api_t implementations yet
	case pcmk_ipc_based:
	case pcmk_ipc_execd:
	case pcmk_ipc_fenced:
	return NULL;

	default:
	return pcmk__server_ipc_name(api->server);
	}
	}

	/*!
	* \brief Check whether an IPC API connection is active
	*
	* \param[in,out] api IPC API connection
	*
	* \return true if IPC is connected, false otherwise
	*/
	bool
	pcmk_ipc_is_connected(pcmk_ipc_api_t *api)
	{
	return (api != NULL) && crm_ipc_connected(api->ipc);
	}

	/*!
	* \internal
	* \brief Call the daemon-specific API's dispatch function
	*
	* Perform daemon-specific handling of IPC reply dispatch. It is the daemon
	* method's responsibility to call the client's registered event callback, as
	* well as allocate and free any event data.
	*
	* \param[in,out] api IPC API connection
	* \param[in,out] message IPC reply XML to dispatch
	*/
	static bool
	call_api_dispatch(pcmk_ipc_api_t api, xmlNode message)
	{
	crm_log_xml_trace(message, "ipc-received");
	if ((api->cmds != NULL) && (api->cmds->dispatch != NULL)) {
	return api->cmds->dispatch(api, message);
	}

	return false;
	}

	/*!
	* \internal
	* \brief Dispatch previously read IPC data
	*
	* \param[in] buffer Data read from IPC
	* \param[in,out] api IPC object
	*
	* \return Standard Pacemaker return code. In particular:
	*
	* pcmk_rc_ok: There are no more messages expected from the server. Quit
	* reading.
	* EINPROGRESS: There are more messages expected from the server. Keep reading.
	*
	* All other values indicate an error.
	*/
	static int
	dispatch_ipc_data(const char buffer, pcmk_ipc_api_t api)
	{
	bool more = false;
	xmlNode *msg;

	if (buffer == NULL) {
	crm_warn("Empty message received from %s IPC",
	pcmk_ipc_name(api, true));
	return ENOMSG;
	}

	msg = pcmk__xml_parse(buffer);
	if (msg == NULL) {
	crm_warn("Malformed message received from %s IPC",
	pcmk_ipc_name(api, true));
	return EPROTO;
	}

	more = call_api_dispatch(api, msg);
	pcmk__xml_free(msg);

	if (more) {
	return EINPROGRESS;
	} else {
	return pcmk_rc_ok;
	}
	}

	/*!
	* \internal
	* \brief Dispatch data read from IPC source
	*
	* \param[in] buffer Data read from IPC
	* \param[in] length Number of bytes of data in buffer (ignored)
	* \param[in,out] user_data IPC object
	*
	* \return Always 0 (meaning connection is still required)
	*
	* \note This function can be used as a main loop IPC dispatch callback.
	*/
	static int
	dispatch_ipc_source_data(const char *buffer, ssize_t length, gpointer user_data)
	{
	pcmk_ipc_api_t *api = user_data;

	CRM_CHECK(api != NULL, return 0);
	dispatch_ipc_data(buffer, api);
	return 0;
	}

	/*!
	* \brief Check whether an IPC connection has data available (without main loop)
	*
	* \param[in] api IPC API connection
	* \param[in] timeout_ms If less than 0, poll indefinitely; if 0, poll once
	* and return immediately; otherwise, poll for up to
	* this many milliseconds
	*
	* \return Standard Pacemaker return code
	*
	* \note Callers of pcmk_connect_ipc() using pcmk_ipc_dispatch_poll should call
	* this function to check whether IPC data is available. Return values of
	* interest include pcmk_rc_ok meaning data is available, and EAGAIN
	* meaning no data is available; all other values indicate errors.
	* \todo This does not allow the caller to poll multiple file descriptors at
	* once. If there is demand for that, we could add a wrapper for
	* pcmk__ipc_fd(api->ipc), so the caller can call poll() themselves.
	*/
	int
	pcmk_poll_ipc(const pcmk_ipc_api_t *api, int timeout_ms)
	{
	int rc;
	struct pollfd pollfd = { 0, };

	if ((api == NULL) \|\| (api->dispatch_type != pcmk_ipc_dispatch_poll)) {
	return EINVAL;
	}

	rc = pcmk__ipc_fd(api->ipc, &(pollfd.fd));
	if (rc != pcmk_rc_ok) {
	crm_debug("Could not obtain file descriptor for %s IPC: %s",
	pcmk_ipc_name(api, true), pcmk_rc_str(rc));
	return rc;
	}

	pollfd.events = POLLIN;
	rc = poll(&pollfd, 1, timeout_ms);
	if (rc < 0) {
	/* Some UNIX systems return negative and set EAGAIN for failure to
	* allocate memory; standardize the return code in that case
	*/
	return (errno == EAGAIN)? ENOMEM : errno;
	} else if (rc == 0) {
	return EAGAIN;
	}
	return pcmk_rc_ok;
	}

	/*!
	* \brief Dispatch available messages on an IPC connection (without main loop)
	*
	* \param[in,out] api IPC API connection
	*
	* \return Standard Pacemaker return code
	*
	* \note Callers of pcmk_connect_ipc() using pcmk_ipc_dispatch_poll should call
	* this function when IPC data is available.
	*/
	void
	pcmk_dispatch_ipc(pcmk_ipc_api_t *api)
	{
	if (api == NULL) {
	return;
	}
	while (crm_ipc_ready(api->ipc) > 0) {
	if (crm_ipc_read(api->ipc) > 0) {
	dispatch_ipc_data(crm_ipc_buffer(api->ipc), api);
	}
	}
	}

	// \return Standard Pacemaker return code
	static int
	connect_with_main_loop(pcmk_ipc_api_t *api)
	{
	int rc;

	struct ipc_client_callbacks callbacks = {
	.dispatch = dispatch_ipc_source_data,
	.destroy = ipc_post_disconnect,
	};

	rc = pcmk__add_mainloop_ipc(api->ipc, G_PRIORITY_DEFAULT, api,
	&callbacks, &(api->mainloop_io));
	if (rc != pcmk_rc_ok) {
	return rc;
	}
	crm_debug("Connected to %s IPC (attached to main loop)",
	pcmk_ipc_name(api, true));
	/* After this point, api->mainloop_io owns api->ipc, so api->ipc
	* should not be explicitly freed.
	*/
	return pcmk_rc_ok;
	}

	// \return Standard Pacemaker return code
	static int
	connect_without_main_loop(pcmk_ipc_api_t *api)
	{
	int rc = pcmk__connect_generic_ipc(api->ipc);

	if (rc != pcmk_rc_ok) {
	crm_ipc_close(api->ipc);
	} else {
	crm_debug("Connected to %s IPC (without main loop)",
	pcmk_ipc_name(api, true));
	}
	return rc;
	}

	/*!
	* \internal
	* \brief Connect to a Pacemaker daemon via IPC (retrying after soft errors)
	*
	* \param[in,out] api IPC API instance
	* \param[in] dispatch_type How IPC replies should be dispatched
	* \param[in] attempts How many times to try (in case of soft error)
	*
	* \return Standard Pacemaker return code
	*/
	int
	pcmk__connect_ipc(pcmk_ipc_api_t *api, enum pcmk_ipc_dispatch dispatch_type,
	int attempts)
	{
	int rc = pcmk_rc_ok;

	if ((api == NULL) \|\| (attempts < 1)) {
	return EINVAL;
	}

	if (api->ipc == NULL) {
	- api->ipc = crm_ipc_new(pcmk_ipc_name(api, false), api->ipc_size_max);
	+ api->ipc = crm_ipc_new(pcmk_ipc_name(api, false), 0);
	if (api->ipc == NULL) {
	return ENOMEM;
	}
	}

	if (crm_ipc_connected(api->ipc)) {
	crm_trace("Already connected to %s", pcmk_ipc_name(api, true));
	return pcmk_rc_ok;
	}

	api->dispatch_type = dispatch_type;

	crm_debug("Attempting connection to %s (up to %d time%s)",
	pcmk_ipc_name(api, true), attempts, pcmk__plural_s(attempts));
	for (int remaining = attempts - 1; remaining >= 0; --remaining) {
	switch (dispatch_type) {
	case pcmk_ipc_dispatch_main:
	rc = connect_with_main_loop(api);
	break;

	case pcmk_ipc_dispatch_sync:
	case pcmk_ipc_dispatch_poll:
	rc = connect_without_main_loop(api);
	break;
	}

	if ((remaining == 0) \|\| ((rc != EAGAIN) && (rc != EALREADY))) {
	break; // Result is final
	}

	// Retry after soft error (interrupted by signal, etc.)
	pcmk__sleep_ms((attempts - remaining) * 500);
	crm_debug("Re-attempting connection to %s (%d attempt%s remaining)",
	pcmk_ipc_name(api, true), remaining,
	pcmk__plural_s(remaining));
	}

	if (rc != pcmk_rc_ok) {
	return rc;
	}

	if ((api->cmds != NULL) && (api->cmds->post_connect != NULL)) {
	rc = api->cmds->post_connect(api);
	if (rc != pcmk_rc_ok) {
	crm_ipc_close(api->ipc);
	}
	}
	return rc;
	}

	/*!
	* \brief Connect to a Pacemaker daemon via IPC
	*
	* \param[in,out] api IPC API instance
	* \param[in] dispatch_type How IPC replies should be dispatched
	*
	* \return Standard Pacemaker return code
	*/
	int
	pcmk_connect_ipc(pcmk_ipc_api_t *api, enum pcmk_ipc_dispatch dispatch_type)
	{
	int rc = pcmk__connect_ipc(api, dispatch_type, 2);

	if (rc != pcmk_rc_ok) {
	crm_err("Connection to %s failed: %s",
	pcmk_ipc_name(api, true), pcmk_rc_str(rc));
	}
	return rc;
	}

	/*!
	* \brief Disconnect an IPC API instance
	*
	* \param[in,out] api IPC API connection
	*
	* \return Standard Pacemaker return code
	*
	* \note If the connection is attached to a main loop, this function should be
	* called before quitting the main loop, to ensure that all memory is
	* freed.
	*/
	void
	pcmk_disconnect_ipc(pcmk_ipc_api_t *api)
	{
	if ((api == NULL) \|\| (api->ipc == NULL)) {
	return;
	}
	switch (api->dispatch_type) {
	case pcmk_ipc_dispatch_main:
	{
	mainloop_io_t *mainloop_io = api->mainloop_io;

	// Make sure no code with access to api can use these again
	api->mainloop_io = NULL;
	api->ipc = NULL;

	mainloop_del_ipc_client(mainloop_io);
	// After this point api might have already been freed
	}
	break;

	case pcmk_ipc_dispatch_poll:
	case pcmk_ipc_dispatch_sync:
	{
	crm_ipc_t *ipc = api->ipc;

	// Make sure no code with access to api can use ipc again
	api->ipc = NULL;

	// This should always be the case already, but to be safe
	api->free_on_disconnect = false;

	crm_ipc_close(ipc);
	crm_ipc_destroy(ipc);
	ipc_post_disconnect(api);
	}
	break;
	}
	}

	/*!
	* \brief Register a callback for IPC API events
	*
	* \param[in,out] api IPC API connection
	* \param[in] callback Callback to register
	* \param[in] userdata Caller data to pass to callback
	*
	* \note This function may be called multiple times to update the callback
	* and/or user data. The caller remains responsible for freeing
	* userdata in any case (after the IPC is disconnected, if the
	* user data is still registered with the IPC).
	*/
	void
	pcmk_register_ipc_callback(pcmk_ipc_api_t *api, pcmk_ipc_callback_t cb,
	void *user_data)
	{
	if (api == NULL) {
	return;
	}
	api->cb = cb;
	api->user_data = user_data;
	}

	/*!
	* \internal
	* \brief Send an XML request across an IPC API connection
	*
	* \param[in,out] api IPC API connection
	* \param[in] request XML request to send
	*
	* \return Standard Pacemaker return code
	*
	* \note Daemon-specific IPC API functions should call this function to send
	* requests, because it handles different dispatch types appropriately.
	*/
	int
	pcmk__send_ipc_request(pcmk_ipc_api_t api, const xmlNode request)
	{
	int rc;
	xmlNode *reply = NULL;
	enum crm_ipc_flags flags = crm_ipc_flags_none;

	if ((api == NULL) \|\| (api->ipc == NULL) \|\| (request == NULL)) {
	return EINVAL;
	}
	crm_log_xml_trace(request, "ipc-sent");

	// Synchronous dispatch requires waiting for a reply
	if ((api->dispatch_type == pcmk_ipc_dispatch_sync)
	&& (api->cmds != NULL)
	&& (api->cmds->reply_expected != NULL)
	&& (api->cmds->reply_expected(api, request))) {
	flags = crm_ipc_client_response;
	}

	/* The 0 here means a default timeout of 5 seconds
	*
	* @TODO Maybe add a timeout_ms member to pcmk_ipc_api_t and a
	* pcmk_set_ipc_timeout() setter for it, then use it here.
	*/
	rc = crm_ipc_send(api->ipc, request, flags, 0, &reply);

	if (rc < 0) {
	return pcmk_legacy2rc(rc);
	} else if (rc == 0) {
	return ENODATA;
	}

	// With synchronous dispatch, we dispatch any reply now
	if (reply != NULL) {
	bool more = call_api_dispatch(api, reply);

	pcmk__xml_free(reply);

	while (more) {
	rc = crm_ipc_read(api->ipc);

	if (rc == -EAGAIN) {
	continue;
	} else if (rc == -ENOMSG \|\| rc == pcmk_ok) {
	return pcmk_rc_ok;
	} else if (rc < 0) {
	return -rc;
	}

	rc = dispatch_ipc_data(crm_ipc_buffer(api->ipc), api);

	if (rc == pcmk_rc_ok) {
	more = false;
	} else if (rc == EINPROGRESS) {
	more = true;
	} else {
	continue;
	}
	}
	}
	return pcmk_rc_ok;
	}

	/*!
	* \internal
	* \brief Create the XML for an IPC request to purge a node from the peer cache
	*
	* \param[in] api IPC API connection
	* \param[in] node_name If not NULL, name of node to purge
	* \param[in] nodeid If not 0, node ID of node to purge
	*
	* \return Newly allocated IPC request XML
	*
	* \note The controller, fencer, and pacemakerd use the same request syntax, but
	* the attribute manager uses a different one. The CIB manager doesn't
	* have any syntax for it. The executor and scheduler don't connect to the
	* cluster layer and thus don't have or need any syntax for it.
	*
	* \todo Modify the attribute manager to accept the common syntax (as well
	* as its current one, for compatibility with older clients). Modify
	* the CIB manager to accept and honor the common syntax. Modify the
	* executor and scheduler to accept the syntax (immediately returning
	* success), just for consistency. Modify this function to use the
	* common syntax with all daemons if their version supports it.
	*/
	static xmlNode *
	create_purge_node_request(const pcmk_ipc_api_t api, const char node_name,
	uint32_t nodeid)
	{
	xmlNode *request = NULL;
	const char *client = crm_system_name? crm_system_name : "client";

	switch (api->server) {
	case pcmk_ipc_attrd:
	request = pcmk__xe_create(NULL, __func__);
	crm_xml_add(request, PCMK__XA_T, PCMK__VALUE_ATTRD);
	crm_xml_add(request, PCMK__XA_SRC, crm_system_name);
	crm_xml_add(request, PCMK_XA_TASK, PCMK__ATTRD_CMD_PEER_REMOVE);
	pcmk__xe_set_bool_attr(request, PCMK__XA_REAP, true);
	crm_xml_add(request, PCMK__XA_ATTR_HOST, node_name);
	if (nodeid > 0) {
	crm_xml_add_int(request, PCMK__XA_ATTR_HOST_ID, nodeid);
	}
	break;

	case pcmk_ipc_controld:
	case pcmk_ipc_fenced:
	case pcmk_ipc_pacemakerd:
	request = pcmk__new_request(api->server, client, NULL,
	pcmk_ipc_name(api, false),
	CRM_OP_RM_NODE_CACHE, NULL);
	if (nodeid > 0) {
	crm_xml_add_ll(request, PCMK_XA_ID, (long long) nodeid);
	}
	crm_xml_add(request, PCMK_XA_UNAME, node_name);
	break;

	case pcmk_ipc_based:
	case pcmk_ipc_execd:
	case pcmk_ipc_schedulerd:
	break;

	default: // pcmk_ipc_unknown (shouldn't be possible)
	return NULL;
	}
	return request;
	}

	/*!
	* \brief Ask a Pacemaker daemon to purge a node from its peer cache
	*
	* \param[in,out] api IPC API connection
	* \param[in] node_name If not NULL, name of node to purge
	* \param[in] nodeid If not 0, node ID of node to purge
	*
	* \return Standard Pacemaker return code
	*
	* \note At least one of node_name or nodeid must be specified.
	*/
	int
	pcmk_ipc_purge_node(pcmk_ipc_api_t api, const char node_name, uint32_t nodeid)
	{
	int rc = 0;
	xmlNode *request = NULL;

	if (api == NULL) {
	return EINVAL;
	}
	if ((node_name == NULL) && (nodeid == 0)) {
	return EINVAL;
	}

	request = create_purge_node_request(api, node_name, nodeid);
	if (request == NULL) {
	return EOPNOTSUPP;
	}
	rc = pcmk__send_ipc_request(api, request);
	pcmk__xml_free(request);

	crm_debug("%s peer cache purge of node %s[%lu]: rc=%d",
	pcmk_ipc_name(api, true), node_name, (unsigned long) nodeid, rc);
	return rc;
	}

	/*
	* Generic IPC API (to eventually be deprecated as public API and made internal)
	*/

	struct crm_ipc_s {
	struct pollfd pfd;
	unsigned int max_buf_size; // maximum bytes we can send or receive over IPC
	unsigned int buf_size; // size of allocated buffer
	int msg_size;
	int need_reply;
	char *buffer;
	char *server_name; // server IPC name being connected to
	qb_ipcc_connection_t *ipc;
	};

	/*!
	* \brief Create a new (legacy) object for using Pacemaker daemon IPC
	*
	* \param[in] name IPC system name to connect to
	* \param[in] max_size Use a maximum IPC buffer size of at least this size
	*
	* \return Newly allocated IPC object on success, NULL otherwise
	*
	* \note The caller is responsible for freeing the result using
	* crm_ipc_destroy().
	* \note This should be considered deprecated for use with daemons supported by
	* pcmk_new_ipc_api().
	*/
	crm_ipc_t *
	crm_ipc_new(const char *name, size_t max_size)
	{
	crm_ipc_t *client = NULL;

	client = calloc(1, sizeof(crm_ipc_t));
	if (client == NULL) {
	crm_err("Could not create IPC connection: %s", strerror(errno));
	return NULL;
	}

	client->server_name = strdup(name);
	if (client->server_name == NULL) {
	crm_err("Could not create %s IPC connection: %s",
	name, strerror(errno));
	free(client);
	return NULL;
	}
	client->buf_size = pcmk__ipc_buffer_size(max_size);
	client->buffer = malloc(client->buf_size);
	if (client->buffer == NULL) {
	crm_err("Could not create %s IPC connection: %s",
	name, strerror(errno));
	free(client->server_name);
	free(client);
	return NULL;
	}

	/* Clients initiating connection pick the max buf size */
	client->max_buf_size = client->buf_size;

	client->pfd.fd = -1;
	client->pfd.events = POLLIN;
	client->pfd.revents = 0;

	return client;
	}

	/*!
	* \internal
	* \brief Connect a generic (not daemon-specific) IPC object
	*
	* \param[in,out] ipc Generic IPC object to connect
	*
	* \return Standard Pacemaker return code
	*/
	int
	pcmk__connect_generic_ipc(crm_ipc_t *ipc)
	{
	uid_t cl_uid = 0;
	gid_t cl_gid = 0;
	pid_t found_pid = 0;
	uid_t found_uid = 0;
	gid_t found_gid = 0;
	int rc = pcmk_rc_ok;

	if (ipc == NULL) {
	return EINVAL;
	}

	ipc->need_reply = FALSE;
	ipc->ipc = qb_ipcc_connect(ipc->server_name, ipc->buf_size);
	if (ipc->ipc == NULL) {
	return errno;
	}

	rc = qb_ipcc_fd_get(ipc->ipc, &ipc->pfd.fd);
	if (rc < 0) { // -errno
	crm_ipc_close(ipc);
	return -rc;
	}

	rc = pcmk_daemon_user(&cl_uid, &cl_gid);
	rc = pcmk_legacy2rc(rc);
	if (rc != pcmk_rc_ok) {
	crm_ipc_close(ipc);
	return rc;
	}

	rc = is_ipc_provider_expected(ipc->ipc, ipc->pfd.fd, cl_uid, cl_gid,
	&found_pid, &found_uid, &found_gid);
	if (rc != pcmk_rc_ok) {
	if (rc == pcmk_rc_ipc_unauthorized) {
	crm_info("%s IPC provider authentication failed: process %lld has "
	"uid %lld (expected %lld) and gid %lld (expected %lld)",
	ipc->server_name,
	(long long) PCMK__SPECIAL_PID_AS_0(found_pid),
	(long long) found_uid, (long long) cl_uid,
	(long long) found_gid, (long long) cl_gid);
	}
	crm_ipc_close(ipc);
	return rc;
	}

	ipc->max_buf_size = qb_ipcc_get_buffer_size(ipc->ipc);
	if (ipc->max_buf_size > ipc->buf_size) {
	free(ipc->buffer);
	ipc->buffer = calloc(ipc->max_buf_size, sizeof(char));
	if (ipc->buffer == NULL) {
	rc = errno;
	crm_ipc_close(ipc);
	return rc;
	}
	ipc->buf_size = ipc->max_buf_size;
	}

	return pcmk_rc_ok;
	}

	void
	crm_ipc_close(crm_ipc_t * client)
	{
	if (client) {
	if (client->ipc) {
	qb_ipcc_connection_t *ipc = client->ipc;

	client->ipc = NULL;
	qb_ipcc_disconnect(ipc);
	}
	}
	}

	void
	crm_ipc_destroy(crm_ipc_t * client)
	{
	if (client) {
	if (client->ipc && qb_ipcc_is_connected(client->ipc)) {
	crm_notice("Destroying active %s IPC connection",
	client->server_name);
	/* The next line is basically unsafe
	*
	* If this connection was attached to mainloop and mainloop is active,
	* the 'disconnected' callback will end up back here and we'll end
	* up free'ing the memory twice - something that can still happen
	* even without this if we destroy a connection and it closes before
	* we call exit
	*/
	/* crm_ipc_close(client); */
	} else {
	crm_trace("Destroying inactive %s IPC connection",
	client->server_name);
	}
	free(client->buffer);
	free(client->server_name);
	free(client);
	}
	}

	/*!
	* \internal
	* \brief Get the file descriptor for a generic IPC object
	*
	* \param[in,out] ipc Generic IPC object to get file descriptor for
	* \param[out] fd Where to store file descriptor
	*
	* \return Standard Pacemaker return code
	*/
	int
	pcmk__ipc_fd(crm_ipc_t ipc, int fd)
	{
	if ((ipc == NULL) \|\| (fd == NULL)) {
	return EINVAL;
	}
	if ((ipc->ipc == NULL) \|\| (ipc->pfd.fd < 0)) {
	return ENOTCONN;
	}
	*fd = ipc->pfd.fd;
	return pcmk_rc_ok;
	}

	int
	crm_ipc_get_fd(crm_ipc_t * client)
	{
	int fd = -1;

	if (pcmk__ipc_fd(client, &fd) != pcmk_rc_ok) {
	crm_err("Could not obtain file descriptor for %s IPC",
	((client == NULL)? "unspecified" : client->server_name));
	errno = EINVAL;
	return -EINVAL;
	}
	return fd;
	}

	bool
	crm_ipc_connected(crm_ipc_t * client)
	{
	bool rc = FALSE;

	if (client == NULL) {
	crm_trace("No client");
	return FALSE;

	} else if (client->ipc == NULL) {
	crm_trace("No connection");
	return FALSE;

	} else if (client->pfd.fd < 0) {
	crm_trace("Bad descriptor");
	return FALSE;
	}

	rc = qb_ipcc_is_connected(client->ipc);
	if (rc == FALSE) {
	client->pfd.fd = -EINVAL;
	}
	return rc;
	}

	/*!
	* \brief Check whether an IPC connection is ready to be read
	*
	* \param[in,out] client Connection to check
	*
	* \return Positive value if ready to be read, 0 if not ready, -errno on error
	*/
	int
	crm_ipc_ready(crm_ipc_t *client)
	{
	int rc;

	pcmk__assert(client != NULL);

	if (!crm_ipc_connected(client)) {
	return -ENOTCONN;
	}

	client->pfd.revents = 0;
	rc = poll(&(client->pfd), 1, 0);
	return (rc < 0)? -errno : rc;
	}

	// \return Standard Pacemaker return code
	static int
	crm_ipc_decompress(crm_ipc_t * client)
	{
	pcmk__ipc_header_t header = (pcmk__ipc_header_t )(void*)client->buffer;

	if (header->size_compressed) {
	int rc = 0;
	unsigned int size_u = 1 + header->size_uncompressed;
	/* never let buf size fall below our max size required for ipc reads. */
	unsigned int new_buf_size = QB_MAX((sizeof(pcmk__ipc_header_t) + size_u), client->max_buf_size);
	char *uncompressed = pcmk__assert_alloc(1, new_buf_size);

	crm_trace("Decompressing message data %u bytes into %u bytes",
	header->size_compressed, size_u);

	rc = BZ2_bzBuffToBuffDecompress(uncompressed + sizeof(pcmk__ipc_header_t), &size_u,
	client->buffer + sizeof(pcmk__ipc_header_t), header->size_compressed, 1, 0);
	rc = pcmk__bzlib2rc(rc);

	if (rc != pcmk_rc_ok) {
	crm_err("Decompression failed: %s " QB_XS " rc=%d",
	pcmk_rc_str(rc), rc);
	free(uncompressed);
	return rc;
	}

	pcmk__assert(size_u == header->size_uncompressed);

	memcpy(uncompressed, client->buffer, sizeof(pcmk__ipc_header_t)); /* Preserve the header */
	header = (pcmk__ipc_header_t )(void)uncompressed;

	free(client->buffer);
	client->buf_size = new_buf_size;
	client->buffer = uncompressed;
	}

	pcmk__assert(client->buffer[sizeof(pcmk__ipc_header_t)
	+ header->size_uncompressed - 1] == 0);
	return pcmk_rc_ok;
	}

	long
	crm_ipc_read(crm_ipc_t * client)
	{
	pcmk__ipc_header_t *header = NULL;

	pcmk__assert((client != NULL) && (client->ipc != NULL)
	&& (client->buffer != NULL));

	client->buffer[0] = 0;
	client->msg_size = qb_ipcc_event_recv(client->ipc, client->buffer,
	client->buf_size, 0);
	if (client->msg_size >= 0) {
	int rc = crm_ipc_decompress(client);

	if (rc != pcmk_rc_ok) {
	return pcmk_rc2legacy(rc);
	}

	header = (pcmk__ipc_header_t )(void)client->buffer;
	if (!pcmk__valid_ipc_header(header)) {
	return -EBADMSG;
	}

	crm_trace("Received %s IPC event %d size=%u rc=%d text='%.100s'",
	client->server_name, header->qb.id, header->qb.size,
	client->msg_size,
	client->buffer + sizeof(pcmk__ipc_header_t));

	} else {
	crm_trace("No message received from %s IPC: %s",
	client->server_name, pcmk_strerror(client->msg_size));

	if (client->msg_size == -EAGAIN) {
	return -EAGAIN;
	}
	}

	if (!crm_ipc_connected(client) \|\| client->msg_size == -ENOTCONN) {
	crm_err("Connection to %s IPC failed", client->server_name);
	}

	if (header) {
	/* Data excluding the header */
	return header->size_uncompressed;
	}
	return -ENOMSG;
	}

	const char *
	crm_ipc_buffer(crm_ipc_t * client)
	{
	pcmk__assert(client != NULL);
	return client->buffer + sizeof(pcmk__ipc_header_t);
	}

	uint32_t
	crm_ipc_buffer_flags(crm_ipc_t * client)
	{
	pcmk__ipc_header_t *header = NULL;

	pcmk__assert(client != NULL);
	if (client->buffer == NULL) {
	return 0;
	}

	header = (pcmk__ipc_header_t )(void)client->buffer;
	return header->flags;
	}

	const char *
	crm_ipc_name(crm_ipc_t * client)
	{
	pcmk__assert(client != NULL);
	return client->server_name;
	}

	// \return Standard Pacemaker return code
	static int
	internal_ipc_get_reply(crm_ipc_t *client, int request_id, int ms_timeout,
	ssize_t bytes, xmlNode *reply)
	{
	pcmk__ipc_header_t *hdr = NULL;
	time_t timeout = 0;
	int32_t qb_timeout = -1;
	int rc = pcmk_rc_ok;

	if (ms_timeout > 0) {
	timeout = time(NULL) + 1 + pcmk__timeout_ms2s(ms_timeout);
	qb_timeout = 1000;
	}

	/* get the reply */
	crm_trace("Expecting reply to %s IPC message %d", client->server_name,
	request_id);

	do {
	xmlNode *xml = NULL;

	*bytes = qb_ipcc_recv(client->ipc, client->buffer, client->buf_size,
	qb_timeout);

	if (*bytes <= 0) {
	if (!crm_ipc_connected(client)) {
	crm_err("%s IPC provider disconnected while waiting for message %d",
	client->server_name, request_id);
	break;
	}

	continue;
	}

	rc = crm_ipc_decompress(client);
	if (rc != pcmk_rc_ok) {
	return rc;
	}

	hdr = (pcmk__ipc_header_t )(void) client->buffer;

	if (hdr->qb.id == request_id) {
	/* Got the reply we were expecting. */
	break;
	}

	xml = pcmk__xml_parse(crm_ipc_buffer(client));

	if (hdr->qb.id < request_id) {
	crm_err("Discarding old reply %d (need %d)", hdr->qb.id, request_id);
	crm_log_xml_notice(xml, "OldIpcReply");
	} else if (hdr->qb.id > request_id) {
	crm_err("Discarding newer reply %d (need %d)", hdr->qb.id, request_id);
	crm_log_xml_notice(xml, "ImpossibleReply");
	pcmk__assert(hdr->qb.id <= request_id);
	}
	} while (time(NULL) < timeout \|\| (timeout == 0 && *bytes == -EAGAIN));

	if (*bytes > 0) {
	crm_trace("Received %zd-byte reply %" PRId32 " to %s IPC %d: %.100s",
	*bytes, hdr->qb.id, client->server_name, request_id,
	crm_ipc_buffer(client));

	if (reply != NULL) {
	*reply = pcmk__xml_parse(crm_ipc_buffer(client));
	}
	} else if (*bytes < 0) {
	rc = (int) -*bytes; // System errno
	crm_trace("No reply to %s IPC %d: %s " QB_XS " rc=%d",
	client->server_name, request_id, pcmk_rc_str(rc), rc);
	}
	/* If bytes == 0, we'll return that to crm_ipc_send which will interpret
	* that as pcmk_rc_ok, log that the IPC request failed (since we did not
	* give it a valid reply), and return that 0 to its callers. It's up to
	* the callers to take appropriate action after that.
	*/

	return rc;
	}

	/*!
	* \brief Send an IPC XML message
	*
	* \param[in,out] client Connection to IPC server
	* \param[in] message XML message to send
	* \param[in] flags Bitmask of crm_ipc_flags
	* \param[in] ms_timeout Give up if not sent within this much time
	* (5 seconds if 0, or no timeout if negative)
	* \param[out] reply Reply from server (or NULL if none)
	*
	* \return Negative errno on error, otherwise size of reply received in bytes
	* if reply was needed, otherwise number of bytes sent
	*/
	int
	crm_ipc_send(crm_ipc_t client, const xmlNode message,
	enum crm_ipc_flags flags, int32_t ms_timeout, xmlNode **reply)
	{
	int rc = 0;
	time_t timeout = 0;
	ssize_t qb_rc = 0;
	ssize_t bytes = 0;
	struct iovec *iov;
	static uint32_t id = 0;
	static int factor = 8;
	pcmk__ipc_header_t *header;

	if (client == NULL) {
	crm_notice("Can't send IPC request without connection (bug?): %.100s",
	message);
	return -ENOTCONN;

	} else if (!crm_ipc_connected(client)) {
	/* Don't even bother */
	crm_notice("Can't send %s IPC requests: Connection closed",
	client->server_name);
	return -ENOTCONN;
	}

	if (ms_timeout == 0) {
	ms_timeout = 5000;
	}

	if (client->need_reply) {
	qb_rc = qb_ipcc_recv(client->ipc, client->buffer, client->buf_size, ms_timeout);
	if (qb_rc < 0) {
	crm_warn("Sending %s IPC disabled until pending reply received",
	client->server_name);
	return -EALREADY;

	} else {
	crm_notice("Sending %s IPC re-enabled after pending reply received",
	client->server_name);
	client->need_reply = FALSE;
	}
	}

	id++;
	CRM_LOG_ASSERT(id != 0); /* Crude wrap-around detection */
	rc = pcmk__ipc_prepare_iov(id, message, client->max_buf_size, &iov, &bytes);
	if (rc != pcmk_rc_ok) {
	crm_warn("Couldn't prepare %s IPC request: %s " QB_XS " rc=%d",
	client->server_name, pcmk_rc_str(rc), rc);
	return pcmk_rc2legacy(rc);
	}

	header = iov[0].iov_base;
	pcmk__set_ipc_flags(header->flags, client->server_name, flags);

	if (pcmk_is_set(flags, crm_ipc_proxied)) {
	/* Don't look for a synchronous response */
	pcmk__clear_ipc_flags(flags, "client", crm_ipc_client_response);
	}

	if(header->size_compressed) {
	if(factor < 10 && (client->max_buf_size / 10) < (bytes / factor)) {
	crm_notice("Compressed message exceeds %d0%% of configured IPC "
	"limit (%u bytes); consider setting PCMK_ipc_buffer to "
	"%u or higher",
	factor, client->max_buf_size, 2 * client->max_buf_size);
	factor++;
	}
	}

	crm_trace("Sending %s IPC request %d of %u bytes using %dms timeout",
	client->server_name, header->qb.id, header->qb.size, ms_timeout);

	/* Send the IPC request, respecting any timeout we were passed */
	if (ms_timeout > 0) {
	timeout = time(NULL) + 1 + pcmk__timeout_ms2s(ms_timeout);
	}

	do {
	qb_rc = qb_ipcc_sendv(client->ipc, iov, 2);
	} while ((qb_rc == -EAGAIN) && ((timeout == 0) \|\| (time(NULL) < timeout)));

	rc = (int) qb_rc; // Negative of system errno, or bytes sent
	if (qb_rc <= 0) {
	goto send_cleanup;
	}

	/* If we should not wait for a response, bail now */
	if (!pcmk_is_set(flags, crm_ipc_client_response)) {
	crm_trace("Not waiting for reply to %s IPC request %d",
	client->server_name, header->qb.id);
	goto send_cleanup;
	}

	rc = internal_ipc_get_reply(client, header->qb.id, ms_timeout, &bytes, reply);
	if (rc == pcmk_rc_ok) {
	rc = (int) bytes; // Size of reply received
	} else {
	/* rc is either a positive system errno or a negative standard Pacemaker
	* return code. If it's an errno, we need to convert it back to a
	* negative number for comparison and return at the end of this function.
	*/
	rc = pcmk_rc2legacy(rc);

	if (ms_timeout > 0) {
	/* We didn't get the reply in time, so disable future sends for now.
	* The only alternative would be to close the connection since we
	* don't know how to detect and discard out-of-sequence replies.
	*
	* @TODO Implement out-of-sequence detection
	*/
	client->need_reply = TRUE;
	}
	}

	send_cleanup:
	if (!crm_ipc_connected(client)) {
	crm_notice("Couldn't send %s IPC request %d: Connection closed "
	QB_XS " rc=%d", client->server_name, header->qb.id, rc);

	} else if (rc == -ETIMEDOUT) {
	crm_warn("%s IPC request %d failed: %s after %dms " QB_XS " rc=%d",
	client->server_name, header->qb.id, pcmk_strerror(rc),
	ms_timeout, rc);
	crm_write_blackbox(0, NULL);

	} else if (rc <= 0) {
	crm_warn("%s IPC request %d failed: %s " QB_XS " rc=%d",
	client->server_name, header->qb.id,
	((rc == 0)? "No bytes sent" : pcmk_strerror(rc)), rc);
	}

	pcmk_free_ipc_event(iov);
	return rc;
	}

	/*!
	* \brief Ensure an IPC provider has expected user or group
	*
	* \param[in] qb_ipc libqb client connection if available
	* \param[in] sock Connected Unix socket for IPC
	* \param[in] refuid Expected user ID
	* \param[in] refgid Expected group ID
	* \param[out] gotpid If not NULL, where to store provider's actual process ID
	* (or 1 on platforms where ID is not available)
	* \param[out] gotuid If not NULL, where to store provider's actual user ID
	* \param[out] gotgid If not NULL, where to store provider's actual group ID
	*
	* \return Standard Pacemaker return code
	* \note An actual user ID of 0 (root) will always be considered authorized,
	* regardless of the expected values provided. The caller can use the
	* output arguments to be stricter than this function.
	*/
	static int
	is_ipc_provider_expected(qb_ipcc_connection_t *qb_ipc, int sock,
	uid_t refuid, gid_t refgid,
	pid_t gotpid, uid_t gotuid, gid_t *gotgid)
	{
	int rc = EOPNOTSUPP;
	pid_t found_pid = 0;
	uid_t found_uid = 0;
	gid_t found_gid = 0;

	#ifdef HAVE_QB_IPCC_AUTH_GET
	if (qb_ipc != NULL) {
	rc = qb_ipcc_auth_get(qb_ipc, &found_pid, &found_uid, &found_gid);
	rc = -rc; // libqb returns 0 or -errno
	if (rc == pcmk_rc_ok) {
	goto found;
	}
	}
	#endif

	#ifdef HAVE_UCRED
	{
	struct ucred ucred;
	socklen_t ucred_len = sizeof(ucred);

	if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &ucred_len) < 0) {
	rc = errno;
	} else if (ucred_len != sizeof(ucred)) {
	rc = EOPNOTSUPP;
	} else {
	found_pid = ucred.pid;
	found_uid = ucred.uid;
	found_gid = ucred.gid;
	goto found;
	}
	}
	#endif

	#ifdef HAVE_SOCKPEERCRED
	{
	struct sockpeercred sockpeercred;
	socklen_t sockpeercred_len = sizeof(sockpeercred);

	if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED,
	&sockpeercred, &sockpeercred_len) < 0) {
	rc = errno;
	} else if (sockpeercred_len != sizeof(sockpeercred)) {
	rc = EOPNOTSUPP;
	} else {
	found_pid = sockpeercred.pid;
	found_uid = sockpeercred.uid;
	found_gid = sockpeercred.gid;
	goto found;
	}
	}
	#endif

	#ifdef HAVE_GETPEEREID // For example, FreeBSD
	if (getpeereid(sock, &found_uid, &found_gid) < 0) {
	rc = errno;
	} else {
	found_pid = PCMK__SPECIAL_PID;
	goto found;
	}
	#endif

	#ifdef HAVE_GETPEERUCRED
	{
	ucred_t *ucred = NULL;

	if (getpeerucred(sock, &ucred) < 0) {
	rc = errno;
	} else {
	found_pid = ucred_getpid(ucred);
	found_uid = ucred_geteuid(ucred);
	found_gid = ucred_getegid(ucred);
	ucred_free(ucred);
	goto found;
	}
	}
	#endif

	return rc; // If we get here, nothing succeeded

	found:
	if (gotpid != NULL) {
	*gotpid = found_pid;
	}
	if (gotuid != NULL) {
	*gotuid = found_uid;
	}
	if (gotgid != NULL) {
	*gotgid = found_gid;
	}
	if ((found_uid != 0) && (found_uid != refuid) && (found_gid != refgid)) {
	return pcmk_rc_ipc_unauthorized;
	}
	return pcmk_rc_ok;
	}

	int
	crm_ipc_is_authentic_process(int sock, uid_t refuid, gid_t refgid,
	pid_t gotpid, uid_t gotuid, gid_t *gotgid)
	{
	int ret = is_ipc_provider_expected(NULL, sock, refuid, refgid,
	gotpid, gotuid, gotgid);

	/* The old function had some very odd return codes*/
	if (ret == 0) {
	return 1;
	} else if (ret == pcmk_rc_ipc_unauthorized) {
	return 0;
	} else {
	return pcmk_rc2legacy(ret);
	}
	}

	int
	pcmk__ipc_is_authentic_process_active(const char *name, uid_t refuid,
	gid_t refgid, pid_t *gotpid)
	{
	static char last_asked_name[PATH_MAX / 2] = ""; /* log spam prevention */
	int fd;
	int rc = pcmk_rc_ipc_unresponsive;
	int auth_rc = 0;
	int32_t qb_rc;
	pid_t found_pid = 0; uid_t found_uid = 0; gid_t found_gid = 0;
	qb_ipcc_connection_t *c;
	#ifdef HAVE_QB_IPCC_CONNECT_ASYNC
	struct pollfd pollfd = { 0, };
	int poll_rc;

	c = qb_ipcc_connect_async(name, 0,
	&(pollfd.fd));
	#else
	c = qb_ipcc_connect(name, 0);
	#endif
	if (c == NULL) {
	crm_info("Could not connect to %s IPC: %s", name, strerror(errno));
	rc = pcmk_rc_ipc_unresponsive;
	goto bail;
	}
	#ifdef HAVE_QB_IPCC_CONNECT_ASYNC
	pollfd.events = POLLIN;
	do {
	poll_rc = poll(&pollfd, 1, 2000);
	} while ((poll_rc == -1) && (errno == EINTR));

	/* If poll() failed, given that disconnect function is not registered yet,
	* qb_ipcc_disconnect() won't clean up the socket. In any case, call
	* qb_ipcc_connect_continue() here so that it may fail and do the cleanup
	* for us.
	*/
	if (qb_ipcc_connect_continue(c) != 0) {
	crm_info("Could not connect to %s IPC: %s", name,
	(poll_rc == 0)?"timeout":strerror(errno));
	rc = pcmk_rc_ipc_unresponsive;
	c = NULL; // qb_ipcc_connect_continue cleaned up for us
	goto bail;
	}
	#endif

	qb_rc = qb_ipcc_fd_get(c, &fd);
	if (qb_rc != 0) {
	rc = (int) -qb_rc; // System errno
	crm_err("Could not get fd from %s IPC: %s " QB_XS " rc=%d",
	name, pcmk_rc_str(rc), rc);
	goto bail;
	}

	auth_rc = is_ipc_provider_expected(c, fd, refuid, refgid,
	&found_pid, &found_uid, &found_gid);
	if (auth_rc == pcmk_rc_ipc_unauthorized) {
	crm_err("Daemon (IPC %s) effectively blocked with unauthorized"
	" process %lld (uid: %lld, gid: %lld)",
	name, (long long) PCMK__SPECIAL_PID_AS_0(found_pid),
	(long long) found_uid, (long long) found_gid);
	rc = pcmk_rc_ipc_unauthorized;
	goto bail;
	}

	if (auth_rc != pcmk_rc_ok) {
	rc = auth_rc;
	crm_err("Could not get peer credentials from %s IPC: %s "
	QB_XS " rc=%d", name, pcmk_rc_str(rc), rc);
	goto bail;
	}

	if (gotpid != NULL) {
	*gotpid = found_pid;
	}

	rc = pcmk_rc_ok;
	if ((found_uid != refuid \|\| found_gid != refgid)
	&& strncmp(last_asked_name, name, sizeof(last_asked_name))) {
	if ((found_uid == 0) && (refuid != 0)) {
	crm_warn("Daemon (IPC %s) runs as root, whereas the expected"
	" credentials are %lld:%lld, hazard of violating"
	" the least privilege principle",
	name, (long long) refuid, (long long) refgid);
	} else {
	crm_notice("Daemon (IPC %s) runs as %lld:%lld, whereas the"
	" expected credentials are %lld:%lld, which may"
	" mean a different set of privileges than expected",
	name, (long long) found_uid, (long long) found_gid,
	(long long) refuid, (long long) refgid);
	}
	memccpy(last_asked_name, name, '\0', sizeof(last_asked_name));
	}

	bail:
	if (c != NULL) {
	qb_ipcc_disconnect(c);
	}
	return rc;
	}

	// Deprecated functions kept only for backward API compatibility
	// LCOV_EXCL_START

	#include <crm/common/ipc_client_compat.h>

	bool
	crm_ipc_connect(crm_ipc_t *client)
	{
	int rc = pcmk__connect_generic_ipc(client);

	if (rc == pcmk_rc_ok) {
	return true;
	}
	if ((client != NULL) && (client->ipc == NULL)) {
	errno = (rc > 0)? rc : ENOTCONN;
	crm_debug("Could not establish %s IPC connection: %s (%d)",
	client->server_name, pcmk_rc_str(errno), errno);
	} else if (rc == pcmk_rc_ipc_unauthorized) {
	crm_err("%s IPC provider authentication failed",
	(client == NULL)? "Pacemaker" : client->server_name);
	errno = ECONNABORTED;
	} else {
	crm_err("Could not verify authenticity of %s IPC provider",
	(client == NULL)? "Pacemaker" : client->server_name);
	errno = ENOTCONN;
	}
	return false;
	}

	// LCOV_EXCL_STOP
	// End deprecated API
	diff --git a/lib/common/mainloop.c b/lib/common/mainloop.c
	index 9529d523af..f48680f624 100644
	--- a/lib/common/mainloop.c
	+++ b/lib/common/mainloop.c
	@@ -1,1465 +1,1465 @@
	/*
	* Copyright 2004-2024 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 <stdlib.h>
	#include <string.h>
	#include <signal.h>
	#include <errno.h>

	#include <sys/wait.h>

	#include <crm/crm.h>
	#include <crm/common/xml.h>
	#include <crm/common/mainloop.h>
	#include <crm/common/ipc_internal.h>

	#include <qb/qbarray.h>

	struct mainloop_child_s {
	pid_t pid;
	char *desc;
	unsigned timerid;
	gboolean timeout;
	void *privatedata;

	enum mainloop_child_flags flags;

	/* Called when a process dies */
	void (callback) (mainloop_child_t p, pid_t pid, int core, int signo, int exitcode);
	};

	struct trigger_s {
	GSource source;
	gboolean running;
	gboolean trigger;
	void *user_data;
	guint id;

	};

	struct mainloop_timer_s {
	guint id;
	guint period_ms;
	bool repeat;
	char *name;
	GSourceFunc cb;
	void *userdata;
	};

	static gboolean
	crm_trigger_prepare(GSource * source, gint * timeout)
	{
	crm_trigger_t trig = (crm_trigger_t ) source;

	/* cluster-glue's FD and IPC related sources make use of
	* g_source_add_poll() but do not set a timeout in their prepare
	* functions
	*
	* This means mainloop's poll() will block until an event for one
	* of these sources occurs - any /other/ type of source, such as
	* this one or g_idle_*, that doesn't use g_source_add_poll() is
	* S-O-L and won't be processed until there is something fd-based
	* happens.
	*
	* Luckily the timeout we can set here affects all sources and
	* puts an upper limit on how long poll() can take.
	*
	* So unconditionally set a small-ish timeout, not too small that
	* we're in constant motion, which will act as an upper bound on
	* how long the signal handling might be delayed for.
	*/
	timeout = 500; / Timeout in ms */

	return trig->trigger;
	}

	static gboolean
	crm_trigger_check(GSource * source)
	{
	crm_trigger_t trig = (crm_trigger_t ) source;

	return trig->trigger;
	}

	/*!
	* \internal
	* \brief GSource dispatch function for crm_trigger_t
	*
	* \param[in] source crm_trigger_t being dispatched
	* \param[in] callback Callback passed at source creation
	* \param[in,out] userdata User data passed at source creation
	*
	* \return G_SOURCE_REMOVE to remove source, G_SOURCE_CONTINUE to keep it
	*/
	static gboolean
	crm_trigger_dispatch(GSource *source, GSourceFunc callback, gpointer userdata)
	{
	gboolean rc = G_SOURCE_CONTINUE;
	crm_trigger_t trig = (crm_trigger_t ) source;

	if (trig->running) {
	/* Wait until the existing job is complete before starting the next one */
	return G_SOURCE_CONTINUE;
	}
	trig->trigger = FALSE;

	if (callback) {
	int callback_rc = callback(trig->user_data);

	if (callback_rc < 0) {
	crm_trace("Trigger handler %p not yet complete", trig);
	trig->running = TRUE;
	} else if (callback_rc == 0) {
	rc = G_SOURCE_REMOVE;
	}
	}
	return rc;
	}

	static void
	crm_trigger_finalize(GSource * source)
	{
	crm_trace("Trigger %p destroyed", source);
	}

	static GSourceFuncs crm_trigger_funcs = {
	crm_trigger_prepare,
	crm_trigger_check,
	crm_trigger_dispatch,
	crm_trigger_finalize,
	};

	static crm_trigger_t *
	mainloop_setup_trigger(GSource * source, int priority, int (*dispatch) (gpointer user_data),
	gpointer userdata)
	{
	crm_trigger_t *trigger = NULL;

	trigger = (crm_trigger_t *) source;

	trigger->id = 0;
	trigger->trigger = FALSE;
	trigger->user_data = userdata;

	if (dispatch) {
	g_source_set_callback(source, dispatch, trigger, NULL);
	}

	g_source_set_priority(source, priority);
	g_source_set_can_recurse(source, FALSE);

	trigger->id = g_source_attach(source, NULL);
	return trigger;
	}

	void
	mainloop_trigger_complete(crm_trigger_t * trig)
	{
	crm_trace("Trigger handler %p complete", trig);
	trig->running = FALSE;
	}

	/*!
	* \brief Create a trigger to be used as a mainloop source
	*
	* \param[in] priority Relative priority of source (lower number is higher priority)
	* \param[in] dispatch Trigger dispatch function (should return 0 to remove the
	* trigger from the mainloop, -1 if the trigger should be
	* kept but the job is still running and not complete, and
	* 1 if the trigger should be kept and the job is complete)
	* \param[in] userdata Pointer to pass to \p dispatch
	*
	* \return Newly allocated mainloop source for trigger
	*/
	crm_trigger_t *
	mainloop_add_trigger(int priority, int (*dispatch) (gpointer user_data),
	gpointer userdata)
	{
	GSource *source = NULL;

	pcmk__assert(sizeof(crm_trigger_t) > sizeof(GSource));
	source = g_source_new(&crm_trigger_funcs, sizeof(crm_trigger_t));

	return mainloop_setup_trigger(source, priority, dispatch, userdata);
	}

	void
	mainloop_set_trigger(crm_trigger_t * source)
	{
	if(source) {
	source->trigger = TRUE;
	}
	}

	gboolean
	mainloop_destroy_trigger(crm_trigger_t * source)
	{
	GSource *gs = NULL;

	if(source == NULL) {
	return TRUE;
	}

	gs = (GSource *)source;

	g_source_destroy(gs); /* Remove from mainloop, ref_count-- */
	g_source_unref(gs); /* The caller no longer carries a reference to source
	*
	* At this point the source should be free'd,
	* unless we're currently processing said
	* source, in which case mainloop holds an
	* additional reference and it will be free'd
	* once our processing completes
	*/
	return TRUE;
	}

	// Define a custom glib source for signal handling

	// Data structure for custom glib source
	typedef struct signal_s {
	crm_trigger_t trigger; // trigger that invoked source (must be first)
	void (*handler) (int sig); // signal handler
	int signal; // signal that was received
	} crm_signal_t;

	// Table to associate signal handlers with signal numbers
	static crm_signal_t *crm_signals[NSIG];

	/*!
	* \internal
	* \brief Dispatch an event from custom glib source for signals
	*
	* Given an signal event, clear the event trigger and call any registered
	* signal handler.
	*
	* \param[in] source glib source that triggered this dispatch
	* \param[in] callback (ignored)
	* \param[in] userdata (ignored)
	*/
	static gboolean
	crm_signal_dispatch(GSource *source, GSourceFunc callback, gpointer userdata)
	{
	crm_signal_t sig = (crm_signal_t ) source;

	if(sig->signal != SIGCHLD) {
	crm_notice("Caught '%s' signal " QB_XS " %d (%s handler)",
	strsignal(sig->signal), sig->signal,
	(sig->handler? "invoking" : "no"));
	}

	sig->trigger.trigger = FALSE;
	if (sig->handler) {
	sig->handler(sig->signal);
	}
	return TRUE;
	}

	/*!
	* \internal
	* \brief Handle a signal by setting a trigger for signal source
	*
	* \param[in] sig Signal number that was received
	*
	* \note This is the true signal handler for the mainloop signal source, and
	* must be async-safe.
	*/
	static void
	mainloop_signal_handler(int sig)
	{
	if (sig > 0 && sig < NSIG && crm_signals[sig] != NULL) {
	mainloop_set_trigger((crm_trigger_t *) crm_signals[sig]);
	}
	}

	// Functions implementing our custom glib source for signal handling
	static GSourceFuncs crm_signal_funcs = {
	crm_trigger_prepare,
	crm_trigger_check,
	crm_signal_dispatch,
	crm_trigger_finalize,
	};

	/*!
	* \internal
	* \brief Set a true signal handler
	*
	* signal()-like interface to sigaction()
	*
	* \param[in] sig Signal number to register handler for
	* \param[in] dispatch Signal handler
	*
	* \return The previous value of the signal handler, or SIG_ERR on error
	* \note The dispatch function must be async-safe.
	*/
	sighandler_t
	crm_signal_handler(int sig, sighandler_t dispatch)
	{
	sigset_t mask;
	struct sigaction sa;
	struct sigaction old;

	if (sigemptyset(&mask) < 0) {
	crm_err("Could not set handler for signal %d: %s",
	sig, pcmk_rc_str(errno));
	return SIG_ERR;
	}

	memset(&sa, 0, sizeof(struct sigaction));
	sa.sa_handler = dispatch;
	sa.sa_flags = SA_RESTART;
	sa.sa_mask = mask;

	if (sigaction(sig, &sa, &old) < 0) {
	crm_err("Could not set handler for signal %d: %s",
	sig, pcmk_rc_str(errno));
	return SIG_ERR;
	}
	return old.sa_handler;
	}

	static void
	mainloop_destroy_signal_entry(int sig)
	{
	crm_signal_t *tmp = crm_signals[sig];

	if (tmp != NULL) {
	crm_signals[sig] = NULL;
	crm_trace("Unregistering mainloop handler for signal %d", sig);
	mainloop_destroy_trigger((crm_trigger_t *) tmp);
	}
	}

	/*!
	* \internal
	* \brief Add a signal handler to a mainloop
	*
	* \param[in] sig Signal number to handle
	* \param[in] dispatch Signal handler function
	*
	* \note The true signal handler merely sets a mainloop trigger to call this
	* dispatch function via the mainloop. Therefore, the dispatch function
	* does not need to be async-safe.
	*/
	gboolean
	mainloop_add_signal(int sig, void (*dispatch) (int sig))
	{
	GSource *source = NULL;
	int priority = G_PRIORITY_HIGH - 1;

	if (sig == SIGTERM) {
	/* TERM is higher priority than other signals,
	* signals are higher priority than other ipc.
	* Yes, minus: smaller is "higher"
	*/
	priority--;
	}

	if (sig >= NSIG \|\| sig < 0) {
	crm_err("Signal %d is out of range", sig);
	return FALSE;

	} else if (crm_signals[sig] != NULL && crm_signals[sig]->handler == dispatch) {
	crm_trace("Signal handler for %d is already installed", sig);
	return TRUE;

	} else if (crm_signals[sig] != NULL) {
	crm_err("Different signal handler for %d is already installed", sig);
	return FALSE;
	}

	pcmk__assert(sizeof(crm_signal_t) > sizeof(GSource));
	source = g_source_new(&crm_signal_funcs, sizeof(crm_signal_t));

	crm_signals[sig] = (crm_signal_t *) mainloop_setup_trigger(source, priority, NULL, NULL);
	pcmk__assert(crm_signals[sig] != NULL);

	crm_signals[sig]->handler = dispatch;
	crm_signals[sig]->signal = sig;

	if (crm_signal_handler(sig, mainloop_signal_handler) == SIG_ERR) {
	mainloop_destroy_signal_entry(sig);
	return FALSE;
	}

	return TRUE;
	}

	gboolean
	mainloop_destroy_signal(int sig)
	{
	if (sig >= NSIG \|\| sig < 0) {
	crm_err("Signal %d is out of range", sig);
	return FALSE;

	} else if (crm_signal_handler(sig, NULL) == SIG_ERR) {
	crm_perror(LOG_ERR, "Could not uninstall signal handler for signal %d", sig);
	return FALSE;

	} else if (crm_signals[sig] == NULL) {
	return TRUE;
	}
	mainloop_destroy_signal_entry(sig);
	return TRUE;
	}

	static qb_array_t *gio_map = NULL;

	void
	mainloop_cleanup(void)
	{
	if (gio_map != NULL) {
	qb_array_free(gio_map);
	gio_map = NULL;
	}

	for (int sig = 0; sig < NSIG; ++sig) {
	mainloop_destroy_signal_entry(sig);
	}
	}

	/*
	* libqb...
	*/
	struct gio_to_qb_poll {
	int32_t is_used;
	guint source;
	int32_t events;
	void *data;
	qb_ipcs_dispatch_fn_t fn;
	enum qb_loop_priority p;
	};

	static gboolean
	gio_read_socket(GIOChannel * gio, GIOCondition condition, gpointer data)
	{
	struct gio_to_qb_poll adaptor = (struct gio_to_qb_poll )data;
	gint fd = g_io_channel_unix_get_fd(gio);

	crm_trace("%p.%d %d", data, fd, condition);

	/* if this assert get's hit, then there is a race condition between
	* when we destroy a fd and when mainloop actually gives it up */
	pcmk__assert(adaptor->is_used > 0);

	return (adaptor->fn(fd, condition, adaptor->data) == 0);
	}

	static void
	gio_poll_destroy(gpointer data)
	{
	struct gio_to_qb_poll adaptor = (struct gio_to_qb_poll )data;

	adaptor->is_used--;
	pcmk__assert(adaptor->is_used >= 0);

	if (adaptor->is_used == 0) {
	crm_trace("Marking adaptor %p unused", adaptor);
	adaptor->source = 0;
	}
	}

	/*!
	* \internal
	* \brief Convert libqb's poll priority into GLib's one
	*
	* \param[in] prio libqb's poll priority (#QB_LOOP_MED assumed as fallback)
	*
	* \return best matching GLib's priority
	*/
	static gint
	conv_prio_libqb2glib(enum qb_loop_priority prio)
	{
	switch (prio) {
	case QB_LOOP_LOW: return G_PRIORITY_LOW;
	case QB_LOOP_HIGH: return G_PRIORITY_HIGH;
	default: return G_PRIORITY_DEFAULT; // QB_LOOP_MED
	}
	}

	/*!
	* \internal
	* \brief Convert libqb's poll priority to rate limiting spec
	*
	* \param[in] prio libqb's poll priority (#QB_LOOP_MED assumed as fallback)
	*
	* \return best matching rate limiting spec
	* \note This is the inverse of libqb's qb_ipcs_request_rate_limit().
	*/
	static enum qb_ipcs_rate_limit
	conv_libqb_prio2ratelimit(enum qb_loop_priority prio)
	{
	switch (prio) {
	case QB_LOOP_LOW: return QB_IPCS_RATE_SLOW;
	case QB_LOOP_HIGH: return QB_IPCS_RATE_FAST;
	default: return QB_IPCS_RATE_NORMAL; // QB_LOOP_MED
	}
	}

	static int32_t
	gio_poll_dispatch_update(enum qb_loop_priority p, int32_t fd, int32_t evts,
	void *data, qb_ipcs_dispatch_fn_t fn, int32_t add)
	{
	struct gio_to_qb_poll *adaptor;
	GIOChannel *channel;
	int32_t res = 0;

	res = qb_array_index(gio_map, fd, (void **)&adaptor);
	if (res < 0) {
	crm_err("Array lookup failed for fd=%d: %d", fd, res);
	return res;
	}

	crm_trace("Adding fd=%d to mainloop as adaptor %p", fd, adaptor);

	if (add && adaptor->source) {
	crm_err("Adaptor for descriptor %d is still in-use", fd);
	return -EEXIST;
	}
	if (!add && !adaptor->is_used) {
	crm_err("Adaptor for descriptor %d is not in-use", fd);
	return -ENOENT;
	}

	/* channel is created with ref_count = 1 */
	channel = g_io_channel_unix_new(fd);
	if (!channel) {
	crm_err("No memory left to add fd=%d", fd);
	return -ENOMEM;
	}

	if (adaptor->source) {
	g_source_remove(adaptor->source);
	adaptor->source = 0;
	}

	/* Because unlike the poll() API, glib doesn't tell us about HUPs by default */
	evts \|= (G_IO_HUP \| G_IO_NVAL \| G_IO_ERR);

	adaptor->fn = fn;
	adaptor->events = evts;
	adaptor->data = data;
	adaptor->p = p;
	adaptor->is_used++;
	adaptor->source =
	g_io_add_watch_full(channel, conv_prio_libqb2glib(p), evts,
	gio_read_socket, adaptor, gio_poll_destroy);

	/* Now that mainloop now holds a reference to channel,
	* thanks to g_io_add_watch_full(), drop ours from g_io_channel_unix_new().
	*
	* This means that channel will be free'd by:
	* g_main_context_dispatch()
	* -> g_source_destroy_internal()
	* -> g_source_callback_unref()
	* shortly after gio_poll_destroy() completes
	*/
	g_io_channel_unref(channel);

	crm_trace("Added to mainloop with gsource id=%d", adaptor->source);
	if (adaptor->source > 0) {
	return 0;
	}

	return -EINVAL;
	}

	static int32_t
	gio_poll_dispatch_add(enum qb_loop_priority p, int32_t fd, int32_t evts,
	void *data, qb_ipcs_dispatch_fn_t fn)
	{
	return gio_poll_dispatch_update(p, fd, evts, data, fn, QB_TRUE);
	}

	static int32_t
	gio_poll_dispatch_mod(enum qb_loop_priority p, int32_t fd, int32_t evts,
	void *data, qb_ipcs_dispatch_fn_t fn)
	{
	return gio_poll_dispatch_update(p, fd, evts, data, fn, QB_FALSE);
	}

	static int32_t
	gio_poll_dispatch_del(int32_t fd)
	{
	struct gio_to_qb_poll *adaptor;

	crm_trace("Looking for fd=%d", fd);
	if (qb_array_index(gio_map, fd, (void **)&adaptor) == 0) {
	if (adaptor->source) {
	g_source_remove(adaptor->source);
	adaptor->source = 0;
	}
	}
	return 0;
	}

	struct qb_ipcs_poll_handlers gio_poll_funcs = {
	.job_add = NULL,
	.dispatch_add = gio_poll_dispatch_add,
	.dispatch_mod = gio_poll_dispatch_mod,
	.dispatch_del = gio_poll_dispatch_del,
	};

	static enum qb_ipc_type
	pick_ipc_type(enum qb_ipc_type requested)
	{
	const char *env = pcmk__env_option(PCMK__ENV_IPC_TYPE);

	if (env && strcmp("shared-mem", env) == 0) {
	return QB_IPC_SHM;
	} else if (env && strcmp("socket", env) == 0) {
	return QB_IPC_SOCKET;
	} else if (env && strcmp("posix", env) == 0) {
	return QB_IPC_POSIX_MQ;
	} else if (env && strcmp("sysv", env) == 0) {
	return QB_IPC_SYSV_MQ;
	} else if (requested == QB_IPC_NATIVE) {
	/* We prefer shared memory because the server never blocks on
	* send. If part of a message fits into the socket, libqb
	* needs to block until the remainder can be sent also.
	* Otherwise the client will wait forever for the remaining
	* bytes.
	*/
	return QB_IPC_SHM;
	}
	return requested;
	}

	qb_ipcs_service_t *
	mainloop_add_ipc_server(const char *name, enum qb_ipc_type type,
	struct qb_ipcs_service_handlers *callbacks)
	{
	return mainloop_add_ipc_server_with_prio(name, type, callbacks, QB_LOOP_MED);
	}

	qb_ipcs_service_t *
	mainloop_add_ipc_server_with_prio(const char *name, enum qb_ipc_type type,
	struct qb_ipcs_service_handlers *callbacks,
	enum qb_loop_priority prio)
	{
	int rc = 0;
	qb_ipcs_service_t *server = NULL;

	if (gio_map == NULL) {
	gio_map = qb_array_create_2(64, sizeof(struct gio_to_qb_poll), 1);
	}

	server = qb_ipcs_create(name, 0, pick_ipc_type(type), callbacks);

	if (server == NULL) {
	crm_err("Could not create %s IPC server: %s (%d)",
	name, pcmk_rc_str(errno), errno);
	return NULL;
	}

	if (prio != QB_LOOP_MED) {
	qb_ipcs_request_rate_limit(server, conv_libqb_prio2ratelimit(prio));
	}

	// All clients should use at least PCMK_ipc_buffer as their buffer size
	qb_ipcs_enforce_buffer_size(server, crm_ipc_default_buffer_size());
	qb_ipcs_poll_handlers_set(server, &gio_poll_funcs);

	rc = qb_ipcs_run(server);
	if (rc < 0) {
	crm_err("Could not start %s IPC server: %s (%d)", name, pcmk_strerror(rc), rc);
	return NULL; // qb_ipcs_run() destroys server on failure
	}

	return server;
	}

	void
	mainloop_del_ipc_server(qb_ipcs_service_t * server)
	{
	if (server) {
	qb_ipcs_destroy(server);
	}
	}

	struct mainloop_io_s {
	char *name;
	void *userdata;

	int fd;
	guint source;
	crm_ipc_t *ipc;
	GIOChannel *channel;

	int (dispatch_fn_ipc) (const char buffer, ssize_t length, gpointer userdata);
	int (*dispatch_fn_io) (gpointer userdata);
	void (*destroy_fn) (gpointer userdata);

	};

	/*!
	* \internal
	* \brief I/O watch callback function (GIOFunc)
	*
	* \param[in] gio I/O channel being watched
	* \param[in] condition I/O condition satisfied
	* \param[in] data User data passed when source was created
	*
	* \return G_SOURCE_REMOVE to remove source, G_SOURCE_CONTINUE to keep it
	*/
	static gboolean
	mainloop_gio_callback(GIOChannel *gio, GIOCondition condition, gpointer data)
	{
	gboolean rc = G_SOURCE_CONTINUE;
	mainloop_io_t *client = data;

	pcmk__assert(client->fd == g_io_channel_unix_get_fd(gio));

	if (condition & G_IO_IN) {
	if (client->ipc) {
	long read_rc = 0L;
	int max = 10;

	do {
	read_rc = crm_ipc_read(client->ipc);
	if (read_rc <= 0) {
	crm_trace("Could not read IPC message from %s: %s (%ld)",
	client->name, pcmk_strerror(read_rc), read_rc);

	} else if (client->dispatch_fn_ipc) {
	const char *buffer = crm_ipc_buffer(client->ipc);

	crm_trace("New %ld-byte IPC message from %s "
	"after I/O condition %d",
	read_rc, client->name, (int) condition);
	if (client->dispatch_fn_ipc(buffer, read_rc, client->userdata) < 0) {
	crm_trace("Connection to %s no longer required", client->name);
	rc = G_SOURCE_REMOVE;
	}
	}

	} while ((rc == G_SOURCE_CONTINUE) && (read_rc > 0) && --max > 0);

	} else {
	crm_trace("New I/O event for %s after I/O condition %d",
	client->name, (int) condition);
	if (client->dispatch_fn_io) {
	if (client->dispatch_fn_io(client->userdata) < 0) {
	crm_trace("Connection to %s no longer required", client->name);
	rc = G_SOURCE_REMOVE;
	}
	}
	}
	}

	if (client->ipc && !crm_ipc_connected(client->ipc)) {
	crm_err("Connection to %s closed " QB_XS " client=%p condition=%d",
	client->name, client, condition);
	rc = G_SOURCE_REMOVE;

	} else if (condition & (G_IO_HUP \| G_IO_NVAL \| G_IO_ERR)) {
	crm_trace("The connection %s[%p] has been closed (I/O condition=%d)",
	client->name, client, condition);
	rc = G_SOURCE_REMOVE;

	} else if ((condition & G_IO_IN) == 0) {
	/*
	#define GLIB_SYSDEF_POLLIN =1
	#define GLIB_SYSDEF_POLLPRI =2
	#define GLIB_SYSDEF_POLLOUT =4
	#define GLIB_SYSDEF_POLLERR =8
	#define GLIB_SYSDEF_POLLHUP =16
	#define GLIB_SYSDEF_POLLNVAL =32

	typedef enum
	{
	G_IO_IN GLIB_SYSDEF_POLLIN,
	G_IO_OUT GLIB_SYSDEF_POLLOUT,
	G_IO_PRI GLIB_SYSDEF_POLLPRI,
	G_IO_ERR GLIB_SYSDEF_POLLERR,
	G_IO_HUP GLIB_SYSDEF_POLLHUP,
	G_IO_NVAL GLIB_SYSDEF_POLLNVAL
	} GIOCondition;

	A bitwise combination representing a condition to watch for on an event source.

	G_IO_IN There is data to read.
	G_IO_OUT Data can be written (without blocking).
	G_IO_PRI There is urgent data to read.
	G_IO_ERR Error condition.
	G_IO_HUP Hung up (the connection has been broken, usually for pipes and sockets).
	G_IO_NVAL Invalid request. The file descriptor is not open.
	*/
	crm_err("Strange condition: %d", condition);
	}

	/* G_SOURCE_REMOVE results in mainloop_gio_destroy() being called
	* just before the source is removed from mainloop
	*/
	return rc;
	}

	static void
	mainloop_gio_destroy(gpointer c)
	{
	mainloop_io_t *client = c;
	char *c_name = strdup(client->name);

	/* client->source is valid but about to be destroyed (ref_count == 0) in gmain.c
	* client->channel will still have ref_count > 0... should be == 1
	*/
	crm_trace("Destroying client %s[%p]", c_name, c);

	if (client->ipc) {
	crm_ipc_close(client->ipc);
	}

	if (client->destroy_fn) {
	void (*destroy_fn) (gpointer userdata) = client->destroy_fn;

	client->destroy_fn = NULL;
	destroy_fn(client->userdata);
	}

	if (client->ipc) {
	crm_ipc_t *ipc = client->ipc;

	client->ipc = NULL;
	crm_ipc_destroy(ipc);
	}

	crm_trace("Destroyed client %s[%p]", c_name, c);

	free(client->name); client->name = NULL;
	free(client);

	free(c_name);
	}

	/*!
	* \brief Connect to IPC and add it as a main loop source
	*
	* \param[in,out] ipc IPC connection to add
	* \param[in] priority Event source priority to use for connection
	* \param[in] userdata Data to register with callbacks
	* \param[in] callbacks Dispatch and destroy callbacks for connection
	* \param[out] source Newly allocated event source
	*
	* \return Standard Pacemaker return code
	*
	* \note On failure, the caller is still responsible for ipc. On success, the
	* caller should call mainloop_del_ipc_client() when source is no longer
	* needed, which will lead to the disconnection of the IPC later in the
	* main loop if it is connected. However the IPC disconnects,
	* mainloop_gio_destroy() will free ipc and source after calling the
	* destroy callback.
	*/
	int
	pcmk__add_mainloop_ipc(crm_ipc_t ipc, int priority, void userdata,
	const struct ipc_client_callbacks *callbacks,
	mainloop_io_t **source)
	{
	int rc = pcmk_rc_ok;
	int fd = -1;
	const char *ipc_name = NULL;

	CRM_CHECK((ipc != NULL) && (callbacks != NULL), return EINVAL);

	ipc_name = pcmk__s(crm_ipc_name(ipc), "Pacemaker");
	rc = pcmk__connect_generic_ipc(ipc);
	if (rc != pcmk_rc_ok) {
	crm_debug("Connection to %s failed: %s", ipc_name, pcmk_rc_str(rc));
	return rc;
	}

	rc = pcmk__ipc_fd(ipc, &fd);
	if (rc != pcmk_rc_ok) {
	crm_debug("Could not obtain file descriptor for %s IPC: %s",
	ipc_name, pcmk_rc_str(rc));
	crm_ipc_close(ipc);
	return rc;
	}

	*source = mainloop_add_fd(ipc_name, priority, fd, userdata, NULL);
	if (*source == NULL) {
	rc = errno;
	crm_ipc_close(ipc);
	return rc;
	}

	(*source)->ipc = ipc;
	(*source)->destroy_fn = callbacks->destroy;
	(*source)->dispatch_fn_ipc = callbacks->dispatch;
	return pcmk_rc_ok;
	}

	/*!
	* \brief Get period for mainloop timer
	*
	* \param[in] timer Timer
	*
	* \return Period in ms
	*/
	guint
	pcmk__mainloop_timer_get_period(const mainloop_timer_t *timer)
	{
	if (timer) {
	return timer->period_ms;
	}
	return 0;
	}

	mainloop_io_t *
	mainloop_add_ipc_client(const char *name, int priority, size_t max_size,
	void userdata, struct ipc_client_callbacks callbacks)
	{
	- crm_ipc_t *ipc = crm_ipc_new(name, max_size);
	+ crm_ipc_t *ipc = crm_ipc_new(name, 0);
	mainloop_io_t *source = NULL;
	int rc = pcmk__add_mainloop_ipc(ipc, priority, userdata, callbacks,
	&source);

	if (rc != pcmk_rc_ok) {
	if (crm_log_level == LOG_STDOUT) {
	fprintf(stderr, "Connection to %s failed: %s",
	name, pcmk_rc_str(rc));
	}
	crm_ipc_destroy(ipc);
	if (rc > 0) {
	errno = rc;
	} else {
	errno = ENOTCONN;
	}
	return NULL;
	}
	return source;
	}

	void
	mainloop_del_ipc_client(mainloop_io_t * client)
	{
	mainloop_del_fd(client);
	}

	crm_ipc_t *
	mainloop_get_ipc_client(mainloop_io_t * client)
	{
	if (client) {
	return client->ipc;
	}
	return NULL;
	}

	mainloop_io_t *
	mainloop_add_fd(const char name, int priority, int fd, void userdata,
	struct mainloop_fd_callbacks * callbacks)
	{
	mainloop_io_t *client = NULL;

	if (fd >= 0) {
	client = calloc(1, sizeof(mainloop_io_t));
	if (client == NULL) {
	return NULL;
	}
	client->name = strdup(name);
	client->userdata = userdata;

	if (callbacks) {
	client->destroy_fn = callbacks->destroy;
	client->dispatch_fn_io = callbacks->dispatch;
	}

	client->fd = fd;
	client->channel = g_io_channel_unix_new(fd);
	client->source =
	g_io_add_watch_full(client->channel, priority,
	(G_IO_IN \| G_IO_HUP \| G_IO_NVAL \| G_IO_ERR), mainloop_gio_callback,
	client, mainloop_gio_destroy);

	/* Now that mainloop now holds a reference to channel,
	* thanks to g_io_add_watch_full(), drop ours from g_io_channel_unix_new().
	*
	* This means that channel will be free'd by:
	* g_main_context_dispatch() or g_source_remove()
	* -> g_source_destroy_internal()
	* -> g_source_callback_unref()
	* shortly after mainloop_gio_destroy() completes
	*/
	g_io_channel_unref(client->channel);
	crm_trace("Added connection %d for %s[%p].%d", client->source, client->name, client, fd);
	} else {
	errno = EINVAL;
	}

	return client;
	}

	void
	mainloop_del_fd(mainloop_io_t * client)
	{
	if (client != NULL) {
	crm_trace("Removing client %s[%p]", client->name, client);
	if (client->source) {
	/* Results in mainloop_gio_destroy() being called just
	* before the source is removed from mainloop
	*/
	g_source_remove(client->source);
	}
	}
	}

	static GList *child_list = NULL;

	pid_t
	mainloop_child_pid(mainloop_child_t * child)
	{
	return child->pid;
	}

	const char *
	mainloop_child_name(mainloop_child_t * child)
	{
	return child->desc;
	}

	int
	mainloop_child_timeout(mainloop_child_t * child)
	{
	return child->timeout;
	}

	void *
	mainloop_child_userdata(mainloop_child_t * child)
	{
	return child->privatedata;
	}

	void
	mainloop_clear_child_userdata(mainloop_child_t * child)
	{
	child->privatedata = NULL;
	}

	/* good function name */
	static void
	child_free(mainloop_child_t *child)
	{
	if (child->timerid != 0) {
	crm_trace("Removing timer %d", child->timerid);
	g_source_remove(child->timerid);
	child->timerid = 0;
	}
	free(child->desc);
	free(child);
	}

	/* terrible function name */
	static int
	child_kill_helper(mainloop_child_t *child)
	{
	int rc;
	if (child->flags & mainloop_leave_pid_group) {
	crm_debug("Kill pid %d only. leave group intact.", child->pid);
	rc = kill(child->pid, SIGKILL);
	} else {
	crm_debug("Kill pid %d's group", child->pid);
	rc = kill(-child->pid, SIGKILL);
	}

	if (rc < 0) {
	if (errno != ESRCH) {
	crm_perror(LOG_ERR, "kill(%d, KILL) failed", child->pid);
	}
	return -errno;
	}
	return 0;
	}

	static gboolean
	child_timeout_callback(gpointer p)
	{
	mainloop_child_t *child = p;
	int rc = 0;

	child->timerid = 0;
	if (child->timeout) {
	crm_warn("%s process (PID %d) will not die!", child->desc, (int)child->pid);
	return FALSE;
	}

	rc = child_kill_helper(child);
	if (rc == -ESRCH) {
	/* Nothing left to do. pid doesn't exist */
	return FALSE;
	}

	child->timeout = TRUE;
	crm_debug("%s process (PID %d) timed out", child->desc, (int)child->pid);

	child->timerid = pcmk__create_timer(5000, child_timeout_callback, child);
	return FALSE;
	}

	static bool
	child_waitpid(mainloop_child_t *child, int flags)
	{
	int rc = 0;
	int core = 0;
	int signo = 0;
	int status = 0;
	int exitcode = 0;
	bool callback_needed = true;

	rc = waitpid(child->pid, &status, flags);
	if (rc == 0) { // WNOHANG in flags, and child status is not available
	crm_trace("Child process %d (%s) still active",
	child->pid, child->desc);
	callback_needed = false;

	} else if (rc != child->pid) {
	/* According to POSIX, possible conditions:
	* - child->pid was non-positive (process group or any child),
	* and rc is specific child
	* - errno ECHILD (pid does not exist or is not child)
	* - errno EINVAL (invalid flags)
	* - errno EINTR (caller interrupted by signal)
	*
	* @TODO Handle these cases more specifically.
	*/
	signo = SIGCHLD;
	exitcode = 1;
	crm_notice("Wait for child process %d (%s) interrupted: %s",
	child->pid, child->desc, pcmk_rc_str(errno));

	} else if (WIFEXITED(status)) {
	exitcode = WEXITSTATUS(status);
	crm_trace("Child process %d (%s) exited with status %d",
	child->pid, child->desc, exitcode);

	} else if (WIFSIGNALED(status)) {
	signo = WTERMSIG(status);
	crm_trace("Child process %d (%s) exited with signal %d (%s)",
	child->pid, child->desc, signo, strsignal(signo));

	#ifdef WCOREDUMP // AIX, SunOS, maybe others
	} else if (WCOREDUMP(status)) {
	core = 1;
	crm_err("Child process %d (%s) dumped core",
	child->pid, child->desc);
	#endif

	} else { // flags must contain WUNTRACED and/or WCONTINUED to reach this
	crm_trace("Child process %d (%s) stopped or continued",
	child->pid, child->desc);
	callback_needed = false;
	}

	if (callback_needed && child->callback) {
	child->callback(child, child->pid, core, signo, exitcode);
	}
	return callback_needed;
	}

	static void
	child_death_dispatch(int signal)
	{
	for (GList *iter = child_list; iter; ) {
	GList *saved = iter;
	mainloop_child_t *child = iter->data;

	iter = iter->next;
	if (child_waitpid(child, WNOHANG)) {
	crm_trace("Removing completed process %d from child list",
	child->pid);
	child_list = g_list_remove_link(child_list, saved);
	g_list_free(saved);
	child_free(child);
	}
	}
	}

	static gboolean
	child_signal_init(gpointer p)
	{
	crm_trace("Installed SIGCHLD handler");
	/* Do NOT use g_child_watch_add() and friends, they rely on pthreads */
	mainloop_add_signal(SIGCHLD, child_death_dispatch);

	/* In case they terminated before the signal handler was installed */
	child_death_dispatch(SIGCHLD);
	return FALSE;
	}

	gboolean
	mainloop_child_kill(pid_t pid)
	{
	GList *iter;
	mainloop_child_t *child = NULL;
	mainloop_child_t *match = NULL;
	/* It is impossible to block SIGKILL, this allows us to
	* call waitpid without WNOHANG flag.*/
	int waitflags = 0, rc = 0;

	for (iter = child_list; iter != NULL && match == NULL; iter = iter->next) {
	child = iter->data;
	if (pid == child->pid) {
	match = child;
	}
	}

	if (match == NULL) {
	return FALSE;
	}

	rc = child_kill_helper(match);
	if(rc == -ESRCH) {
	/* It's gone, but hasn't shown up in waitpid() yet. Wait until we get
	* SIGCHLD and let handler clean it up as normal (so we get the correct
	* return code/status). The blocking alternative would be to call
	* child_waitpid(match, 0).
	*/
	crm_trace("Waiting for signal that child process %d completed",
	match->pid);
	return TRUE;

	} else if(rc != 0) {
	/* If KILL for some other reason set the WNOHANG flag since we
	* can't be certain what happened.
	*/
	waitflags = WNOHANG;
	}

	if (!child_waitpid(match, waitflags)) {
	/* not much we can do if this occurs */
	return FALSE;
	}

	child_list = g_list_remove(child_list, match);
	child_free(match);
	return TRUE;
	}

	/* Create/Log a new tracked process
	* To track a process group, use -pid
	*
	* @TODO Using a non-positive pid (i.e. any child, or process group) would
	* likely not be useful since we will free the child after the first
	* completed process.
	*/
	void
	mainloop_child_add_with_flags(pid_t pid, int timeout, const char desc, void privatedata, enum mainloop_child_flags flags,
	void (callback) (mainloop_child_t p, pid_t pid, int core, int signo, int exitcode))
	{
	static bool need_init = TRUE;
	mainloop_child_t *child = pcmk__assert_alloc(1, sizeof(mainloop_child_t));

	child->pid = pid;
	child->timerid = 0;
	child->timeout = FALSE;
	child->privatedata = privatedata;
	child->callback = callback;
	child->flags = flags;
	child->desc = pcmk__str_copy(desc);

	if (timeout) {
	child->timerid = pcmk__create_timer(timeout, child_timeout_callback, child);
	}

	child_list = g_list_append(child_list, child);

	if(need_init) {
	need_init = FALSE;
	/* SIGCHLD processing has to be invoked from mainloop.
	* We do not want it to be possible to both add a child pid
	* to mainloop, and have the pid's exit callback invoked within
	* the same callstack. */
	pcmk__create_timer(1, child_signal_init, NULL);
	}
	}

	void
	mainloop_child_add(pid_t pid, int timeout, const char desc, void privatedata,
	void (callback) (mainloop_child_t p, pid_t pid, int core, int signo, int exitcode))
	{
	mainloop_child_add_with_flags(pid, timeout, desc, privatedata, 0, callback);
	}

	static gboolean
	mainloop_timer_cb(gpointer user_data)
	{
	int id = 0;
	bool repeat = FALSE;
	struct mainloop_timer_s *t = user_data;

	pcmk__assert(t != NULL);

	id = t->id;
	t->id = 0; /* Ensure it's unset during callbacks so that
	* mainloop_timer_running() works as expected
	*/

	if(t->cb) {
	crm_trace("Invoking callbacks for timer %s", t->name);
	repeat = t->repeat;
	if(t->cb(t->userdata) == FALSE) {
	crm_trace("Timer %s complete", t->name);
	repeat = FALSE;
	}
	}

	if(repeat) {
	/* Restore if repeating */
	t->id = id;
	}

	return repeat;
	}

	bool
	mainloop_timer_running(mainloop_timer_t *t)
	{
	if(t && t->id != 0) {
	return TRUE;
	}
	return FALSE;
	}

	void
	mainloop_timer_start(mainloop_timer_t *t)
	{
	mainloop_timer_stop(t);
	if(t && t->period_ms > 0) {
	crm_trace("Starting timer %s", t->name);
	t->id = pcmk__create_timer(t->period_ms, mainloop_timer_cb, t);
	}
	}

	void
	mainloop_timer_stop(mainloop_timer_t *t)
	{
	if(t && t->id != 0) {
	crm_trace("Stopping timer %s", t->name);
	g_source_remove(t->id);
	t->id = 0;
	}
	}

	guint
	mainloop_timer_set_period(mainloop_timer_t *t, guint period_ms)
	{
	guint last = 0;

	if(t) {
	last = t->period_ms;
	t->period_ms = period_ms;
	}

	if(t && t->id != 0 && last != t->period_ms) {
	mainloop_timer_start(t);
	}
	return last;
	}

	mainloop_timer_t *
	mainloop_timer_add(const char name, guint period_ms, bool repeat, GSourceFunc cb, void userdata)
	{
	mainloop_timer_t *t = pcmk__assert_alloc(1, sizeof(mainloop_timer_t));

	if (name != NULL) {
	t->name = crm_strdup_printf("%s-%u-%d", name, period_ms, repeat);
	} else {
	t->name = crm_strdup_printf("%p-%u-%d", t, period_ms, repeat);
	}
	t->id = 0;
	t->period_ms = period_ms;
	t->repeat = repeat;
	t->cb = cb;
	t->userdata = userdata;
	crm_trace("Created timer %s with %p %p", t->name, userdata, t->userdata);
	return t;
	}

	void
	mainloop_timer_del(mainloop_timer_t *t)
	{
	if(t) {
	crm_trace("Destroying timer %s", t->name);
	mainloop_timer_stop(t);
	free(t->name);
	free(t);
	}
	}

	/*
	* Helpers to make sure certain events aren't lost at shutdown
	*/

	static gboolean
	drain_timeout_cb(gpointer user_data)
	{
	bool timeout_popped = (bool) user_data;

	*timeout_popped = TRUE;
	return FALSE;
	}

	/*!
	* \brief Drain some remaining main loop events then quit it
	*
	* \param[in,out] mloop Main loop to drain and quit
	* \param[in] n Drain up to this many pending events
	*/
	void
	pcmk_quit_main_loop(GMainLoop *mloop, unsigned int n)
	{
	if ((mloop != NULL) && g_main_loop_is_running(mloop)) {
	GMainContext *ctx = g_main_loop_get_context(mloop);

	/* Drain up to n events in case some memory clean-up is pending
	* (helpful to reduce noise in valgrind output).
	*/
	for (int i = 0; (i < n) && g_main_context_pending(ctx); ++i) {
	g_main_context_dispatch(ctx);
	}
	g_main_loop_quit(mloop);
	}
	}

	/*!
	* \brief Process main loop events while a certain condition is met
	*
	* \param[in,out] mloop Main loop to process
	* \param[in] timer_ms Don't process longer than this amount of time
	* \param[in] check Function that returns true if events should be
	* processed
	*
	* \note This function is intended to be called at shutdown if certain important
	* events should not be missed. The caller would likely quit the main loop
	* or exit after calling this function. The check() function will be
	* passed the remaining timeout in milliseconds.
	*/
	void
	pcmk_drain_main_loop(GMainLoop mloop, guint timer_ms, bool (check)(guint))
	{
	bool timeout_popped = FALSE;
	guint timer = 0;
	GMainContext *ctx = NULL;

	CRM_CHECK(mloop && check, return);

	ctx = g_main_loop_get_context(mloop);
	if (ctx) {
	time_t start_time = time(NULL);

	timer = pcmk__create_timer(timer_ms, drain_timeout_cb, &timeout_popped);
	while (!timeout_popped
	&& check(timer_ms - (time(NULL) - start_time) * 1000)) {
	g_main_context_iteration(ctx, TRUE);
	}
	}
	if (!timeout_popped && (timer > 0)) {
	g_source_remove(timer);
	}
	}

File Metadata

Mime Type: text/x-diff
Expires: Mon, Apr 21, 2:24 PM (1 d, 12 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1661748
Default Alt Text: (93 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions