services.c File Reference

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

Include dependency graph for services.c:

Go to the source code of this file.

Macros
#define	_GNU_SOURCE
#define	lsb_metadata_template
#define	LSB_INITSCRIPT_INFOBEGIN_TAG   "### BEGIN INIT INFO"
#define	LSB_INITSCRIPT_INFOEND_TAG   "### END INIT INFO"
#define	PROVIDES   "# Provides:"
#define	REQ_START   "# Required-Start:"
#define	REQ_STOP   "# Required-Stop:"
#define	SHLD_START   "# Should-Start:"
#define	SHLD_STOP   "# Should-Stop:"
#define	DFLT_START   "# Default-Start:"
#define	DFLT_STOP   "# Default-Stop:"
#define	SHORT_DSCR   "# Short-Description:"
#define	DESCRIPTION   "# Description:"
#define	lsb_meta_helper_free_value(m)
#define	DESC_MAX   2048

Functions
svc_action_t *	services_action_create (const char *name, const char *action, int interval, int timeout)
const char *	resources_find_service_class (const char *agent)
	Find first service class that can provide a specified agent. More...
svc_action_t *	resources_action_create (const char *name, const char *standard, const char *provider, const char *agent, const char *action, int interval, 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, int interval)
	Cancel a recurring action. More...
gboolean	services_action_kick (const char *name, const char *action, int interval)
void	services_add_inflight_op (svc_action_t *op)
void	services_untrack_op (svc_action_t *op)
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 *	services_list (void)
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...

Macro Definition Documentation

#define _GNU_SOURCE

Definition at line 11 of file services.c.

#define DESC_MAX   2048

Definition at line 986 of file services.c.

#define DESCRIPTION   "# Description:"

Definition at line 956 of file services.c.

#define DFLT_START   "# Default-Start:"

Definition at line 953 of file services.c.

#define DFLT_STOP   "# Default-Stop:"

Definition at line 954 of file services.c.

#define LSB_INITSCRIPT_INFOBEGIN_TAG   "### BEGIN INIT INFO"

Definition at line 946 of file services.c.

#define LSB_INITSCRIPT_INFOEND_TAG   "### END INIT INFO"

Definition at line 947 of file services.c.

#define lsb_meta_helper_free_value

(

m

)

Value:

do {                                        \
        if ((m) != NULL) {                      \
            xmlFree(m);                         \
            (m) = NULL;                         \
        }                                       \
    } while(0)

Definition at line 958 of file services.c.

#define lsb_metadata_template

Value:

"<?xml version='1.0'?>\n"                                           \
    "<!DOCTYPE resource-agent SYSTEM 'ra-api-1.dtd'>\n"                 \
    "<resource-agent name='%s' version='" PCMK_DEFAULT_AGENT_VERSION "'>\n" \
    "  <version>1.0</version>\n"                                        \
    "  <longdesc lang='en'>\n"                                          \
    "%s"                                                                \
    "  </longdesc>\n"                                                   \
    "  <shortdesc lang='en'>%s</shortdesc>\n"                           \
    "  <parameters>\n"                                                  \
    "  </parameters>\n"                                                 \
    "  <actions>\n"                                                     \
    "    <action name='meta-data'    timeout='5' />\n"                  \
    "    <action name='start'        timeout='15' />\n"                 \
    "    <action name='stop'         timeout='15' />\n"                 \
    "    <action name='status'       timeout='15' />\n"                 \
    "    <action name='restart'      timeout='15' />\n"                 \
    "    <action name='force-reload' timeout='15' />\n"                 \
    "    <action name='monitor'      timeout='15' interval='15' />\n"   \
    "  </actions>\n"                                                    \
    "  <special tag='LSB'>\n"                                           \
    "    <Provides>%s</Provides>\n"                                     \
    "    <Required-Start>%s</Required-Start>\n"                         \
    "    <Required-Stop>%s</Required-Stop>\n"                           \
    "    <Should-Start>%s</Should-Start>\n"                             \
    "    <Should-Stop>%s</Should-Stop>\n"                               \
    "    <Default-Start>%s</Default-Start>\n"                           \
    "    <Default-Stop>%s</Default-Stop>\n"                             \
    "  </special>\n"                                                    \
    "</resource-agent>\n"

Definition at line 912 of file services.c.

#define PROVIDES   "# Provides:"

Definition at line 948 of file services.c.

#define REQ_START   "# Required-Start:"

Definition at line 949 of file services.c.

#define REQ_STOP   "# Required-Stop:"

Definition at line 950 of file services.c.

#define SHLD_START   "# Should-Start:"

Definition at line 951 of file services.c.

#define SHLD_STOP   "# Should-Stop:"

Definition at line 952 of file services.c.

#define SHORT_DSCR   "# Short-Description:"

Definition at line 955 of file services.c.

Function Documentation

gboolean cancel_recurring_action

(

svc_action_t *

op

)

Definition at line 615 of file services.c.

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 1351 of file services.c.

gboolean is_op_blocked

(

const char *

rsc

)

Definition at line 856 of file services.c.

svc_action_t* resources_action_create	(	const char *	name,
		const char *	standard,
		const char *	provider,
		const char *	agent,
		const char *	action,
		int	interval,
		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	how often to repeat this action, in milliseconds (if 0, execute only 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 165 of file services.c.

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 70 of file services.c.

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 1425 of file services.c.

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 1415 of file services.c.

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 1371 of file services.c.

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

Run an action asynchronously.

Parameters

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

Return values

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

Definition at line 827 of file services.c.

gboolean services_action_cancel	(	const char *	name,
		const char *	action,
		int	interval
	)

Cancel a recurring action.

Parameters

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

Returns

TRUE if action was successfully cancelled, FALSE otherwise

Definition at line 641 of file services.c.

void services_action_cleanup

(

svc_action_t *

op

)

Definition at line 527 of file services.c.

svc_action_t* services_action_create	(	const char *	name,
		const char *	action,
		int	interval,
		int	timeout
	)

Definition at line 52 of file services.c.

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 367 of file services.c.

void services_action_free

(

svc_action_t *

op

)

Definition at line 563 of file services.c.

gboolean services_action_kick	(	const char *	name,
		const char *	action,
		int	interval
	)

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

Definition at line 704 of file services.c.

gboolean services_action_sync

(

svc_action_t *

op

)

Definition at line 1316 of file services.c.

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 435 of file services.c.

void services_add_inflight_op

(

svc_action_t *

op

)

Definition at line 795 of file services.c.

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 482 of file services.c.

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 405 of file services.c.

GList* services_list

(

void

)

Get a list of services

Returns

a list of services. The list items are gchar *. This list must be destroyed using g_list_free_full(list, free).

Definition at line 1357 of file services.c.

void services_untrack_op

(

svc_action_t *

op

)

Definition at line 816 of file services.c.