#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/msg_xml.h>
#include "services_private.h"
#include "services_lsb.h"

Include dependency graph for services.c:

Macros
#define	_GNU_SOURCE

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

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. More...

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. More...

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

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. More...

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

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

void	services_action_cleanup (svc_action_t *op)

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. More...

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

void	services_add_inflight_op (svc_action_t *op)

void	services_untrack_op (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 *))

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

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. More...

GList *	resources_list_standards (void)

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

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

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

Macro Definition Documentation

◆ _GNU_SOURCE

#define _GNU_SOURCE

Definition at line 13 of file services.c.

Function Documentation

◆ cancel_recurring_action()

gboolean cancel_recurring_action ( svc_action_t * op )

Definition at line 565 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: a list of what was found. The list items are char *.

Note: It is the caller's responsibility to free the result with g_list_free_full(list, free).

Definition at line 953 of file services.c.

◆ is_op_blocked()

gboolean is_op_blocked ( const char * rsc )

Definition at line 822 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
[in]	standard	Resource agent standard (ocf, lsb, etc.)
[in]	provider	Resource agent provider
[in]	agent	Resource agent name
[in]	action	action (start, stop, monitor, etc.)
[in]	interval_ms	How often to repeat this action (if 0, execute once)
[in]	timeout	Consider action failed if it does not complete in this many milliseconds
[in]	params	Action parameters

Returns: newly allocated action instance

Postcondition: After the call, 'params' is owned, and later free'd by the svc_action_t result

Note: The caller is responsible for freeing the return value using services_action_free().

Definition at line 335 of file services.c.

◆ resources_agent_exists()

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

Does the given standard, provider, and agent describe a resource that can exist?

Parameters

[in]	standard	Which class of agent does the resource belong to?
[in]	provider	What provides the agent (NULL for most standards)?
[in]	agent	What is the name of the agent?

Returns: A boolean

Definition at line 1073 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, then upstart. It would be preferable to put systemd first, but LSB merely requires a file existence check, while systemd requires contacting D-Bus.

Definition at line 71 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 using this standard (e.g. ocf, lsb, etc.) (or NULL for all)
[in]	provider	list agents from this provider (or NULL for all)

Returns: a list of resource agents. The list items are char *.

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

Definition at line 1017 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 standard (e.g. ocf, lsb, etc.)

Returns: a 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 1007 of file services.c.

◆ resources_list_standards()

GList* resources_list_standards ( void )

Get list of available standards

Returns: a list of resource standards. The list items are char *. This list must be destroyed using g_list_free_full(list, free).

Definition at line 959 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 (ocf, lsb, etc.)
[in]	provider	Resource agent provider
[in]	agent	Resource agent name
[in]	action	action (start, stop, monitor, etc.)
[in]	interval_ms	How often to repeat this action (if 0, execute once)
[in]	timeout	Consider action failed if it does not complete in this many milliseconds
[in]	params	Action parameters

Returns: newly allocated action instance

Postcondition: After the call, 'params' is owned, and later free'd by the svc_action_t result

Note: The caller is responsible for freeing the return value using services_action_free().

Definition at line 168 of file services.c.

◆ services_action_async()

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

Definition at line 813 of file services.c.

◆ services_action_async_fork_notify()

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

Run an action asynchronously.

Parameters

[in]	op	services action data
[in]	action_callback	callback for when the action completes
[in]	action_fork_callback	callback for when action forked successfully

Return values

TRUE	succesfully started execution
FALSE	failed to start execution, no callback will be received

Definition at line 781 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 591 of file services.c.

◆ services_action_cleanup()

void services_action_cleanup ( svc_action_t * op )

Definition at line 474 of file services.c.

◆ services_action_create_generic()

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

Utilize services API to execute 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	command to execute
[in]	args	arguments to the command, NULL terminated

Returns: a svc_action_t object, used to pass to the execute function (services_action_sync() or services_action_async()) and is provided to the callback.

Definition at line 352 of file services.c.

◆ services_action_free()

void services_action_free ( svc_action_t * op )

Definition at line 513 of file services.c.

◆ services_action_kick()

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

Kick a recurring action so it is scheduled immediately for re-execution

Definition at line 658 of file services.c.

◆ services_action_sync()

gboolean services_action_sync ( svc_action_t * op )

Definition at line 918 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]	action	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 or upstart 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 420 of file services.c.

◆ services_add_inflight_op()

void services_add_inflight_op ( svc_action_t * op )

Definition at line 749 of file services.c.

◆ services_alert_async()

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

Execute an alert agent action.

Parameters

[in]	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().

Definition at line 438 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 390 of file services.c.

◆ services_untrack_op()

void services_untrack_op ( svc_action_t * op )

Definition at line 770 of file services.c.

Macros

Functions

Macro Definition Documentation

◆ _GNU_SOURCE

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__create_resource_action()

◆ 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_untrack_op()