pacemaker  2.0.2-debe490
Scalable High-Availability cluster resource manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Functions
services.c File Reference
#include <crm_internal.h>
#include <sys/types.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/stonith-ng.h>
#include <crm/msg_xml.h>
#include "services_private.h"
#include "services_lsb.h"
Include dependency graph for services.c:

Go to the source code of this file.

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_tresources_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_tservices_action_create_generic (const char *exec, const char *args[])
 
svc_action_tservices_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

#define _GNU_SOURCE

Definition at line 11 of file services.c.

Function Documentation

gboolean cancel_recurring_action ( svc_action_t op)

Definition at line 515 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]rootfull path to a directory to read
[in]filesreturn list of files if TRUE or directories if FALSE
[in]executableif 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.

gboolean is_op_blocked ( const char *  rsc)

Definition at line 771 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,
guint  interval_ms,
int  timeout,
GHashTable *  params,
enum svc_action_flags  flags 
)

Create a new resource action.

Parameters
[in]nameName of resource
[in]standardResource agent standard (ocf, lsb, etc.)
[in]providerResource agent provider
[in]agentResource agent name
[in]actionaction (start, stop, monitor, etc.)
[in]interval_msHow often to repeat this action (if 0, execute once)
[in]timeoutConsider action failed if it does not complete in this many milliseconds
[in]paramsAction 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 159 of file services.c.

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]standardWhich class of agent does the resource belong to?
[in]providerWhat provides the agent (NULL for most standards)?
[in]agentWhat is the name of the agent?
Returns
A boolean

Definition at line 1065 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]agentName 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 63 of file services.c.

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

Get a list of resource agents.

Parameters
[in]standardlist agents using this standard (e.g. ocf, lsb, etc.) (or NULL for all)
[in]providerlist 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 1009 of file services.c.

GList* resources_list_providers ( const char *  standard)

Get a list of providers.

Parameters
[in]standardlist 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 999 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 959 of file services.c.

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

Definition at line 762 of file services.c.

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]opservices action data
[in]action_callbackcallback for when the action completes
[in]action_fork_callbackcallback for when action forked successfully
Return values
TRUEsuccesfully started execution
FALSEfailed to start execution, no callback will be received

Definition at line 731 of file services.c.

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

Cancel a recurring action.

Parameters
[in]nameName of resource that operation is for
[in]actionName of operation to cancel
[in]interval_msInterval of operation to cancel
Returns
TRUE if action was successfully cancelled, FALSE otherwise

Definition at line 541 of file services.c.

void services_action_cleanup ( svc_action_t op)

Definition at line 424 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]execcommand to execute
[in]argsarguments 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 302 of file services.c.

void services_action_free ( svc_action_t op)

Definition at line 463 of file services.c.

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

gboolean services_action_sync ( svc_action_t op)

Definition at line 918 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]actionAction to modify
[in]userName of user to execute action as
[in]groupName 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 370 of file services.c.

void services_add_inflight_op ( svc_action_t op)

Definition at line 699 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]actionAction to execute
[in]cbFunction 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 388 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]idAlert ID
[in]execPath to alert agent executable
[in]timeoutAction timeout
[in]paramsParameters to use with action
[in]sequenceAction sequence number
[in]cb_dataData 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 340 of file services.c.

void services_untrack_op ( svc_action_t op)

Definition at line 720 of file services.c.