#include <crm_internal.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <stdio.h>
#include <errno.h>
#include <unistd.h>
#include <dirent.h>
#include <fcntl.h>
#include <crm/crm.h>
#include <crm/common/mainloop.h>
#include <crm/services.h>
#include <crm/services_internal.h>
#include <crm/stonith-ng.h>
#include <crm/common/xml.h>
#include "services_private.h"
#include "services_ocf.h"

Include dependency graph for services.c:

Functions
const char *	resources_find_service_class (const char *agent)
	Find first service class that can provide a specified agent.

svc_action_t *	services__create_resource_action (const char name, const char standard, const char provider, const char agent, const char action, guint interval_ms, int timeout, GHashTable params, enum svc_action_flags flags)
	Create a new resource action.

svc_action_t *	resources_action_create (const char name, const char standard, const char provider, const char agent, const char action, guint interval_ms, int timeout, GHashTable params, enum svc_action_flags flags)
	Create a new resource action.

svc_action_t *	services_action_create_generic (const char exec, const char args[])
	Request execution of an arbitrary command.

svc_action_t *	services_alert_create (const char id, const char exec, int timeout, GHashTable params, int sequence, void cb_data)
	Create an alert agent action.

int	services_action_user (svc_action_t op, const char user)
	Set the user and group that an action will execute as.

gboolean	services_alert_async (svc_action_t action, void(cb)(svc_action_t *op))
	Execute an alert agent action.

void	services_action_cleanup (svc_action_t *op)

enum ocf_exitcode	services_result2ocf (const char standard, const char action, int exit_status)

void	services_action_free (svc_action_t *op)

gboolean	cancel_recurring_action (svc_action_t *op)

gboolean	services_action_cancel (const char name, const char action, guint interval_ms)
	Cancel a recurring action.

gboolean	services_action_kick (const char name, const char action, guint interval_ms)
	Reschedule a recurring action for immediate execution.

void	services_add_inflight_op (svc_action_t *op)

void	services_untrack_op (const svc_action_t *op)

gboolean	services_action_async_fork_notify (svc_action_t op, void(action_callback)(svc_action_t ), void(action_fork_callback)(svc_action_t *))
	Run an action asynchronously, with callback after process is forked.

gboolean	services_action_async (svc_action_t op, void(action_callback)(svc_action_t *))
	Request asynchronous execution of an action.

gboolean	is_op_blocked (const char *rsc)

gboolean	services_action_sync (svc_action_t *op)

GList *	get_directory_list (const char *root, gboolean files, gboolean executable)
	Get a list of files or directories in a given path.

GList *	resources_list_standards (void)

GList *	resources_list_providers (const char *standard)
	Get a list of providers.

GList *	resources_list_agents (const char standard, const char provider)
	Get a list of resource agents.

gboolean	resources_agent_exists (const char standard, const char provider, const char *agent)
	Check whether a resource agent exists on the local host.

void	services__set_result (svc_action_t action, int agent_status, enum pcmk_exec_status exec_status, const char reason)

void	services__copy_result (const svc_action_t action, pcmk__action_result_t result)

void	services__format_result (svc_action_t action, int agent_status, enum pcmk_exec_status exec_status, const char format,...)

void	services__set_cancelled (svc_action_t *action)

const char *	services__action_kind (const svc_action_t *action)

const char *	services__exit_reason (const svc_action_t *action)

char *	services__grab_stdout (svc_action_t *action)

char *	services__grab_stderr (svc_action_t *action)

Function Documentation

◆ cancel_recurring_action()

gboolean cancel_recurring_action ( svc_action_t * op )

Definition at line 624 of file services.c.

◆ get_directory_list()

GList * get_directory_list	(	const char *	root,
		gboolean	files,
		gboolean	executable )

Get a list of files or directories in a given path.

Parameters

[in]	root	Full path to a directory to read
[in]	files	Return list of files if TRUE or directories if FALSE
[in]	executable	If TRUE and files is TRUE, only return executable files

Returns: List of what was found as char * items.

Note: The caller is responsibile for freeing the result with g_list_free_full(list, free).

Definition at line 1031 of file services.c.

◆ is_op_blocked()

gboolean is_op_blocked ( const char * rsc )

Definition at line 889 of file services.c.

◆ resources_action_create()

svc_action_t * resources_action_create	(	const char *	name,
		const char *	standard,
		const char *	provider,
		const char *	agent,
		const char *	action,
		guint	interval_ms,
		int	timeout,
		GHashTable *	params,
		enum svc_action_flags	flags )

Create a new resource action.

Parameters

[in]	name	Name of resource that action is for
[in]	standard	Resource agent standard
[in]	provider	Resource agent provider
[in]	agent	Resource agent name
[in]	action	Name of action to create
[in]	interval_ms	How often to repeat action (if 0, execute once)
[in]	timeout	Error if not complete within this time (ms)
[in,out]	params	Action parameters
[in]	flags	Group of enum svc_action_flags

Returns: Newly allocated action

Note: This function assumes ownership of (and may free) params.; The caller is responsible for freeing the return value using services_action_free().

Definition at line 329 of file services.c.

◆ resources_agent_exists()

gboolean resources_agent_exists	(	const char *	standard,
		const char *	provider,
		const char *	agent )

Check whether a resource agent exists on the local host.

Parameters

[in]	standard	Resource agent standard of agent to check
[in]	provider	Provider of agent to check (or NULL)
[in]	agent	Name of agent to check

Returns: TRUE if agent exists locally, otherwise FALSE

Definition at line 1127 of file services.c.

◆ resources_find_service_class()

const char * resources_find_service_class ( const char * agent )

Find first service class that can provide a specified agent.

Parameters

[in] agent Name of agent to search for

Returns: Service class if found, NULL otherwise

Note: The priority is LSB then systemd. It would be preferable to put systemd first, but LSB merely requires a file existence check, while systemd requires contacting DBus.

Definition at line 63 of file services.c.

◆ resources_list_agents()

GList * resources_list_agents	(	const char *	standard,
		const char *	provider )

Get a list of resource agents.

Parameters

[in]	standard	List agents of this standard (or NULL for all)
[in]	provider	List agents of this provider (or NULL for all)

Returns: List of resource agents as char * items.

Note: The caller is responsible for freeing the result using g_list_free_full(list, free).

Definition at line 1077 of file services.c.

◆ resources_list_providers()

GList * resources_list_providers ( const char * standard )

Get a list of providers.

Parameters

[in] standard List providers of this resource agent standard

Returns: List of providers as char * list items (or NULL if standard does not support providers)

Note: The caller is responsible for freeing the result using g_list_free_full(list, free).

Definition at line 1067 of file services.c.

◆ resources_list_standards()

GList * resources_list_standards ( void )

Get list of available standards

Returns: List of resource standards as char * items.

Note: The caller is responsible for freeing the result using g_list_free_full(list, free).

Definition at line 1037 of file services.c.

◆ services__action_kind()

const char * services__action_kind ( const svc_action_t * action )

Definition at line 1313 of file services.c.

◆ services__copy_result()

void services__copy_result	(	const svc_action_t *	action,
		pcmk__action_result_t *	result )

Definition at line 1243 of file services.c.

◆ services__create_resource_action()

svc_action_t * services__create_resource_action	(	const char *	name,
		const char *	standard,
		const char *	provider,
		const char *	agent,
		const char *	action,
		guint	interval_ms,
		int	timeout,
		GHashTable *	params,
		enum svc_action_flags	flags )

Create a new resource action.

Parameters

[in]	name	Name of resource
[in]	standard	Resource agent standard
[in]	provider	Resource agent provider
[in]	agent	Resource agent name
[in]	action	Name of action
[in]	interval_ms	How often to repeat action (if 0, execute once)
[in]	timeout	Error if not complete within this time (ms)
[in,out]	params	Action parameters
[in]	flags	Group of enum svc_action_flags

Returns: NULL if not enough memory, otherwise newly allocated action instance (if its rc member is not PCMK_OCF_UNKNOWN, the action is invalid)

Note: This function assumes ownership of (and may free) params.; The caller is responsible for freeing the return value using services_action_free().

Definition at line 255 of file services.c.

◆ services__exit_reason()

const char * services__exit_reason ( const svc_action_t * action )

Definition at line 1337 of file services.c.

◆ services__format_result()

void services__format_result	(	svc_action_t *	action,
		int	agent_status,
		enum pcmk_exec_status	exec_status,
		const char *	format,
			... )

Definition at line 1261 of file services.c.

◆ services__grab_stderr()

char * services__grab_stderr ( svc_action_t * action )

Definition at line 1372 of file services.c.

◆ services__grab_stdout()

char * services__grab_stdout ( svc_action_t * action )

Definition at line 1353 of file services.c.

◆ services__set_cancelled()

void services__set_cancelled ( svc_action_t * action )

Definition at line 1295 of file services.c.

◆ services__set_result()

void services__set_result	(	svc_action_t *	action,
		int	agent_status,
		enum pcmk_exec_status	exec_status,
		const char *	reason )

Definition at line 1218 of file services.c.

◆ services_action_async()

gboolean services_action_async	(	svc_action_t *	op,
		void(*	action_callback )(svc_action_t *) )

Request asynchronous execution of an action.

Parameters

[in,out]	op	Action to execute
[in]	action_callback	Function to call when the action completes (if NULL, any previously set callback will continue to be used)

Return values

TRUE	if the caller should not free or otherwise use `op` again, because one of these conditions is true:

op is NULL.
The action was successfully initiated, in which case action_callback has not been called (it will be called when the action completes).
The action's ID matched an existing recurring action. The existing action has taken over the callback and callback data from op and has been re-initiated asynchronously, and op has been freed.
Another action for the same resource is in flight, and op will be blocked until it completes.
The action could not be initiated, and is either non-recurring or being cancelled. action_callback has been called, and op has been freed.

Return values

FALSE if \op is still valid, because the action cannot be initiated, and is a recurring action that is not being cancelled. action_callback has been called, and a timer has been set for the next invocation of op.

Definition at line 880 of file services.c.

◆ services_action_async_fork_notify()

gboolean services_action_async_fork_notify	(	svc_action_t *	op,
		void(*	action_callback )(svc_action_t *),
		void(*	action_fork_callback )(svc_action_t *) )

Run an action asynchronously, with callback after process is forked.

Parameters

[in,out]	op	Action to run
[in]	action_callback	Function to call when action completes (if NULL, any previously set callback will continue to be used)
[in]	action_fork_callback	Function to call after child process is forked for action (if NULL, any previously set callback will continue to be used)

Return values

TRUE	if the caller should not free or otherwise use `op` again, because one of these conditions is true:

op is NULL.
The action was successfully initiated, in which case action_fork_callback has been called, but action_callback has not (it will be called when the action completes).
The action's ID matched an existing recurring action. The existing action has taken over the callback and callback data from op and has been re-initiated asynchronously, and op has been freed.
Another action for the same resource is in flight, and op will be blocked until it completes.
The action could not be initiated, and is either non-recurring or being cancelled. action_fork_callback has not been called, but action_callback has, and op has been freed.

Return values

FALSE if \op is still valid, because the action cannot be initiated, and is a recurring action that is not being cancelled. action_fork_callback has not been called, but action_callback has, and a timer has been set for the next invocation of op.

Definition at line 846 of file services.c.

◆ services_action_cancel()

gboolean services_action_cancel	(	const char *	name,
		const char *	action,
		guint	interval_ms )

Cancel a recurring action.

Parameters

[in]	name	Name of resource that operation is for
[in]	action	Name of operation to cancel
[in]	interval_ms	Interval of operation to cancel

Returns: TRUE if action was successfully cancelled, FALSE otherwise

Definition at line 650 of file services.c.

◆ services_action_cleanup()

void services_action_cleanup ( svc_action_t * op )

Definition at line 492 of file services.c.

◆ services_action_create_generic()

svc_action_t * services_action_create_generic	(	const char *	exec,
		const char *	args[] )

Request execution of an arbitrary command.

This API has useful infrastructure in place to be able to run a command in the background and get notified via a callback when the command finishes.

Parameters

[in]	exec	Full path to command executable
[in]	args	NULL-terminated list of arguments to pass to command

Returns: Newly allocated action object

Definition at line 350 of file services.c.

◆ services_action_free()

void services_action_free ( svc_action_t * op )

Definition at line 566 of file services.c.

◆ services_action_kick()

gboolean services_action_kick	(	const char *	name,
		const char *	action,
		guint	interval_ms )

Reschedule a recurring action for immediate execution.

Parameters

[in]	name	Name of resource that action is for
[in]	action	Action's name
[in]	interval_ms	Action's interval (in milliseconds)

Returns: TRUE on success, otherwise FALSE

Definition at line 718 of file services.c.

◆ services_action_sync()

gboolean services_action_sync ( svc_action_t * op )

Definition at line 996 of file services.c.

◆ services_action_user()

int services_action_user	(	svc_action_t *	op,
		const char *	user )

Set the user and group that an action will execute as.

Parameters

[in,out]	op	Action to modify
[in]	user	Name of user to execute action as
[in]	group	Name of group to execute action as

Returns: pcmk_ok on success, -errno otherwise

Note: This will have no effect unless the process executing the action runs as root and the action is not a systemd action. We could implement this for systemd by adding User= and Group= to [Service] in the override file, but that seems more likely to cause problems than be useful.

Definition at line 436 of file services.c.

◆ services_add_inflight_op()

void services_add_inflight_op ( svc_action_t * op )

Definition at line 814 of file services.c.

◆ services_alert_async()

gboolean services_alert_async	(	svc_action_t *	action,
		void(*	cb )(svc_action_t *op) )

Execute an alert agent action.

Parameters

[in,out]	action	Action to execute
[in]	cb	Function to call when action completes

Returns: TRUE if the library will free action, FALSE otherwise

Note: If this function returns FALSE, it is the caller's responsibility to free the action with services_action_free(). However, unless someone intentionally creates a recurring alert action, this will never return FALSE.

Definition at line 456 of file services.c.

◆ services_alert_create()

svc_action_t * services_alert_create	(	const char *	id,
		const char *	exec,
		int	timeout,
		GHashTable *	params,
		int	sequence,
		void *	cb_data )

Create an alert agent action.

Parameters

[in]	id	Alert ID
[in]	exec	Path to alert agent executable
[in]	timeout	Action timeout
[in]	params	Parameters to use with action
[in]	sequence	Action sequence number
[in]	cb_data	Data to pass to callback function

Returns: New action on success, NULL on error

Note: It is the caller's responsibility to free cb_data. The caller should not free params explicitly.

Definition at line 407 of file services.c.

◆ services_result2ocf()

enum ocf_exitcode services_result2ocf	(	const char *	standard,
		const char *	action,
		int	exit_status )

Definition at line 541 of file services.c.

◆ services_untrack_op()

void services_untrack_op ( const svc_action_t * op )

Definition at line 835 of file services.c.

Functions

Function Documentation

◆ cancel_recurring_action()

◆ get_directory_list()

◆ is_op_blocked()

◆ resources_action_create()

◆ resources_agent_exists()

◆ resources_find_service_class()

◆ resources_list_agents()

◆ resources_list_providers()

◆ resources_list_standards()

◆ services__action_kind()

◆ services__copy_result()

◆ services__create_resource_action()

◆ services__exit_reason()

◆ services__format_result()

◆ services__grab_stderr()

◆ services__grab_stdout()

◆ services__set_cancelled()

◆ services__set_result()

◆ services_action_async()

◆ services_action_async_fork_notify()

◆ services_action_cancel()

◆ services_action_cleanup()

◆ services_action_create_generic()

◆ services_action_free()

◆ services_action_kick()

◆ services_action_sync()

◆ services_action_user()

◆ services_add_inflight_op()

◆ services_alert_async()

◆ services_alert_create()

◆ services_result2ocf()

◆ services_untrack_op()