pacemaker  2.0.1-9e909a5bdd
Scalable High-Availability cluster resource manager
lrmd.h
Go to the documentation of this file.
1 /*
2  * Copyright 2012-2018 David Vossel <davidvossel@gmail.com>
3  *
4  * This source code is licensed under the GNU Lesser General Public License
5  * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
6  */
7 
8 #ifndef LRMD__H
9 # define LRMD__H
10 
11 #ifdef __cplusplus
12 extern "C" {
13 #endif
14 
20 #include <stdbool.h>
21 #include <crm_config.h>
22 #include <crm/services.h>
23 
24 typedef struct lrmd_s lrmd_t;
25 typedef struct lrmd_key_value_s {
26  char *key;
27  char *value;
30 
31 /* This should be bumped every time there is an incompatible change that
32  * prevents older clients from connecting to this version of the server.
33  */
34 #define LRMD_PROTOCOL_VERSION "1.1"
35 
36 /* This is the version that the client version will actually be compared
37  * against. This should be identical to LRMD_PROTOCOL_VERSION. However, we
38  * accidentally bumped LRMD_PROTOCOL_VERSION in 6424a647 (1.1.15) when we didn't
39  * need to, so for now it's different. If we ever have a truly incompatible
40  * bump, we can drop this and compare against LRMD_PROTOCOL_VERSION.
41  */
42 #define LRMD_MIN_PROTOCOL_VERSION "1.0"
43 
44 /* *INDENT-OFF* */
45 #define DEFAULT_REMOTE_KEY_LOCATION PACEMAKER_CONFIG_DIR "/authkey"
46 #define ALT_REMOTE_KEY_LOCATION "/etc/corosync/authkey"
47 #define DEFAULT_REMOTE_PORT 3121
48 #define DEFAULT_REMOTE_USERNAME "lrmd"
49 
50 #define F_LRMD_OPERATION "lrmd_op"
51 #define F_LRMD_CLIENTNAME "lrmd_clientname"
52 #define F_LRMD_IS_IPC_PROVIDER "lrmd_is_ipc_provider"
53 #define F_LRMD_CLIENTID "lrmd_clientid"
54 #define F_LRMD_PROTOCOL_VERSION "lrmd_protocol_version"
55 #define F_LRMD_REMOTE_MSG_TYPE "lrmd_remote_msg_type"
56 #define F_LRMD_REMOTE_MSG_ID "lrmd_remote_msg_id"
57 #define F_LRMD_CALLBACK_TOKEN "lrmd_async_id"
58 #define F_LRMD_CALLID "lrmd_callid"
59 #define F_LRMD_CALLOPTS "lrmd_callopt"
60 #define F_LRMD_CALLDATA "lrmd_calldata"
61 #define F_LRMD_RC "lrmd_rc"
62 #define F_LRMD_EXEC_RC "lrmd_exec_rc"
63 #define F_LRMD_OP_STATUS "lrmd_exec_op_status"
64 #define F_LRMD_TIMEOUT "lrmd_timeout"
65 #define F_LRMD_WATCHDOG "lrmd_watchdog"
66 #define F_LRMD_CLASS "lrmd_class"
67 #define F_LRMD_PROVIDER "lrmd_provider"
68 #define F_LRMD_TYPE "lrmd_type"
69 #define F_LRMD_ORIGIN "lrmd_origin"
70 
71 #define F_LRMD_RSC_RUN_TIME "lrmd_run_time"
72 #define F_LRMD_RSC_RCCHANGE_TIME "lrmd_rcchange_time"
73 #define F_LRMD_RSC_EXEC_TIME "lrmd_exec_time"
74 #define F_LRMD_RSC_QUEUE_TIME "lrmd_queue_time"
75 
76 #define F_LRMD_RSC_ID "lrmd_rsc_id"
77 #define F_LRMD_RSC_ACTION "lrmd_rsc_action"
78 #define F_LRMD_RSC_USERDATA_STR "lrmd_rsc_userdata_str"
79 #define F_LRMD_RSC_OUTPUT "lrmd_rsc_output"
80 #define F_LRMD_RSC_EXIT_REASON "lrmd_rsc_exit_reason"
81 #define F_LRMD_RSC_START_DELAY "lrmd_rsc_start_delay"
82 #define F_LRMD_RSC_INTERVAL "lrmd_rsc_interval"
83 #define F_LRMD_RSC_DELETED "lrmd_rsc_deleted"
84 #define F_LRMD_RSC "lrmd_rsc"
85 
86 #define F_LRMD_ALERT_ID "lrmd_alert_id"
87 #define F_LRMD_ALERT_PATH "lrmd_alert_path"
88 #define F_LRMD_ALERT "lrmd_alert"
89 
90 #define LRMD_OP_RSC_REG "lrmd_rsc_register"
91 #define LRMD_OP_RSC_EXEC "lrmd_rsc_exec"
92 #define LRMD_OP_RSC_CANCEL "lrmd_rsc_cancel"
93 #define LRMD_OP_RSC_UNREG "lrmd_rsc_unregister"
94 #define LRMD_OP_RSC_INFO "lrmd_rsc_info"
95 #define LRMD_OP_RSC_METADATA "lrmd_rsc_metadata"
96 #define LRMD_OP_POKE "lrmd_rsc_poke"
97 #define LRMD_OP_NEW_CLIENT "lrmd_rsc_new_client"
98 #define LRMD_OP_CHECK "lrmd_check"
99 #define LRMD_OP_ALERT_EXEC "lrmd_alert_exec"
100 #define LRMD_OP_GET_RECURRING "lrmd_get_recurring"
101 
102 #define LRMD_IPC_OP_NEW "new"
103 #define LRMD_IPC_OP_DESTROY "destroy"
104 #define LRMD_IPC_OP_EVENT "event"
105 #define LRMD_IPC_OP_REQUEST "request"
106 #define LRMD_IPC_OP_RESPONSE "response"
107 #define LRMD_IPC_OP_SHUTDOWN_REQ "shutdown_req"
108 #define LRMD_IPC_OP_SHUTDOWN_ACK "shutdown_ack"
109 #define LRMD_IPC_OP_SHUTDOWN_NACK "shutdown_nack"
110 
111 #define F_LRMD_IPC_OP "lrmd_ipc_op"
112 #define F_LRMD_IPC_IPC_SERVER "lrmd_ipc_server"
113 #define F_LRMD_IPC_SESSION "lrmd_ipc_session"
114 #define F_LRMD_IPC_CLIENT "lrmd_ipc_client"
115 #define F_LRMD_IPC_USER "lrmd_ipc_user"
116 #define F_LRMD_IPC_MSG "lrmd_ipc_msg"
117 #define F_LRMD_IPC_MSG_ID "lrmd_ipc_msg_id"
118 #define F_LRMD_IPC_MSG_FLAGS "lrmd_ipc_msg_flags"
119 
120 #define T_LRMD "lrmd"
121 #define T_LRMD_REPLY "lrmd_reply"
122 #define T_LRMD_NOTIFY "lrmd_notify"
123 #define T_LRMD_IPC_PROXY "lrmd_ipc_proxy"
124 #define T_LRMD_RSC_OP "lrmd_rsc_op"
125 /* *INDENT-ON* */
126 
130 lrmd_t *lrmd_api_new(void);
131 
141 lrmd_t *lrmd_remote_api_new(const char *nodename, const char *server, int port);
142 
150 bool lrmd_dispatch(lrmd_t * lrmd);
151 
159 int lrmd_poll(lrmd_t * lrmd, int timeout);
160 
164 void lrmd_api_delete(lrmd_t * lrmd);
165 lrmd_key_value_t *lrmd_key_value_add(lrmd_key_value_t * kvp, const char *key, const char *value);
166 
167 /* *INDENT-OFF* */
168 /* Reserved for future use */
170  lrmd_opt_none = 0x00000000,
171  /* lrmd_opt_sync_call = 0x00000001, //Not implemented, patches welcome. */
181 };
182 
191 };
192 
193 /* *INDENT-ON* */
194 
195 typedef struct lrmd_event_data_s {
198 
200  const char *rsc_id;
202  const char *op_type;
204  const char *user_data;
205 
207  int call_id;
209  int timeout;
211  guint interval_ms;
216 
218  enum ocf_exitcode rc;
222  const char *output;
224  unsigned int t_run;
226  unsigned int t_rcchange;
228  unsigned int exec_time;
230  unsigned int queue_time;
231 
234 
235  /* This is a GHashTable containing the
236  * parameters given to the operation */
237  void *params;
238 
242  const char *remote_nodename;
243 
245  const char *exit_reason;
247 
249 void lrmd_free_event(lrmd_event_data_t * event);
250 
251 typedef struct lrmd_rsc_info_s {
252  char *id;
253  char *type;
254  char *standard;
255  char *provider;
257 
258 typedef struct lrmd_op_info_s {
259  char *rsc_id;
260  char *action;
264 
265 lrmd_rsc_info_t *lrmd_new_rsc_info(const char *rsc_id, const char *standard,
266  const char *provider, const char *type);
268 void lrmd_free_rsc_info(lrmd_rsc_info_t * rsc_info);
269 void lrmd_free_op_info(lrmd_op_info_t *op_info);
270 
271 typedef void (*lrmd_event_callback) (lrmd_event_data_t * event);
272 
273 typedef struct lrmd_list_s {
274  const char *val;
275  struct lrmd_list_s *next;
276 } lrmd_list_t;
277 
278 void lrmd_list_freeall(lrmd_list_t * head);
280 
281 typedef struct lrmd_api_operations_s {
288  int (*connect) (lrmd_t * lrmd, const char *client_name, int *fd);
289 
300  int (*connect_async) (lrmd_t * lrmd, const char *client_name, int timeout /*ms */ );
301 
308  int (*is_connected) (lrmd_t * lrmd);
309 
317  int (*poke_connection) (lrmd_t * lrmd);
318 
325  int (*disconnect) (lrmd_t * lrmd);
326 
335  int (*register_rsc) (lrmd_t * lrmd,
336  const char *rsc_id,
337  const char *standard,
338  const char *provider, const char *agent, enum lrmd_call_options options);
339 
346  lrmd_rsc_info_t *(*get_rsc_info) (lrmd_t * lrmd,
347  const char *rsc_id, enum lrmd_call_options options);
348 
354  int (*get_recurring_ops) (lrmd_t *lrmd, const char *rsc_id, int timeout_ms,
355  enum lrmd_call_options options, GList **output);
356 
371  int (*unregister_rsc) (lrmd_t * lrmd, const char *rsc_id, enum lrmd_call_options options);
372 
376  void (*set_callback) (lrmd_t * lrmd, lrmd_event_callback callback);
377 
393  int (*exec) (lrmd_t * lrmd, const char *rsc_id, const char *action, const char *userdata, /* userdata string given back in event notification */
394  guint interval_ms,
395  int timeout, /* ms */
396  int start_delay, /* ms */
397  enum lrmd_call_options options, lrmd_key_value_t * params); /* ownership of params is given up to api here */
398 
422  int (*cancel) (lrmd_t *lrmd, const char *rsc_id, const char *action,
423  guint interval_ms);
424 
448  int (*get_metadata) (lrmd_t * lrmd,
449  const char *standard,
450  const char *provider,
451  const char *agent, char **output, enum lrmd_call_options options);
452 
462  int (*list_agents) (lrmd_t * lrmd, lrmd_list_t ** agents,
463  const char *standard, const char *provider);
464 
475  int (*list_ocf_providers) (lrmd_t * lrmd, const char *agent, lrmd_list_t ** providers);
476 
485  int (*list_standards) (lrmd_t * lrmd, lrmd_list_t ** standards);
486 
502  int (*exec_alert) (lrmd_t *lrmd, const char *alert_id,
503  const char *alert_path, int timeout, /* ms */
504  lrmd_key_value_t *params); /* ownership of params is given up to api here */
505 
523  int (*get_metadata_params) (lrmd_t *lrmd, const char *standard,
524  const char *provider, const char *agent,
525  char **output, enum lrmd_call_options options,
526  lrmd_key_value_t *params);
527 
529 
530 struct lrmd_s {
533 };
534 
535 static inline const char *
536 lrmd_event_type2str(enum lrmd_callback_event type)
537 {
538  switch (type) {
539  case lrmd_event_register:
540  return "register";
542  return "unregister";
544  return "exec_complete";
546  return "disconnect";
547  case lrmd_event_connect:
548  return "connect";
549  case lrmd_event_poke:
550  return "poke";
552  return "new_client";
553  }
554  return "unknown";
555 }
556 
557 #ifdef __cplusplus
558 }
559 #endif
560 
561 #endif
Services API.
char * rsc_id
Definition: lrmd.h:259
struct lrmd_rsc_info_s lrmd_rsc_info_t
lrmd_call_options
Definition: lrmd.h:169
lrmd_callback_event
Definition: lrmd.h:183
const char * user_data
Definition: lrmd.h:204
const char * rsc_id
Definition: lrmd.h:200
unsigned int queue_time
Definition: lrmd.h:230
void(* lrmd_event_callback)(lrmd_event_data_t *event)
Definition: lrmd.h:271
void lrmd_free_op_info(lrmd_op_info_t *op_info)
Definition: lrmd_client.c:1553
char * id
Definition: lrmd.h:252
void lrmd_list_freeall(lrmd_list_t *head)
Definition: lrmd_client.c:127
void lrmd_free_event(lrmd_event_data_t *event)
Definition: lrmd_client.c:202
unsigned int t_rcchange
Definition: lrmd.h:226
const char * output
Definition: lrmd.h:222
struct lrmd_event_data_s lrmd_event_data_t
lrmd_t * lrmd_remote_api_new(const char *nodename, const char *server, int port)
Create a new TLS connection to a remote executor.
Definition: lrmd_client.c:1971
int connection_rc
Definition: lrmd.h:233
const char * val
Definition: lrmd.h:274
struct lrmd_api_operations_s lrmd_api_operations_t
unsigned int exec_time
Definition: lrmd.h:228
char * interval_ms_s
Definition: lrmd.h:261
void * params
Definition: lrmd.h:237
lrmd_rsc_info_t * lrmd_new_rsc_info(const char *rsc_id, const char *standard, const char *provider, const char *type)
Definition: lrmd_client.c:1470
lrmd_rsc_info_t * lrmd_copy_rsc_info(lrmd_rsc_info_t *rsc_info)
Definition: lrmd_client.c:1496
const char * exit_reason
Definition: lrmd.h:245
char * key
Definition: lrmd.h:26
struct lrmd_list_s * next
Definition: lrmd.h:275
int rsc_deleted
Definition: lrmd.h:215
lrmd_t * lrmd_api_new(void)
Create a new connection to the local executor.
Definition: lrmd_client.c:1935
bool lrmd_dispatch(lrmd_t *lrmd)
Use after lrmd_poll returns 1 to read and dispatch a message.
Definition: lrmd_client.c:418
lrmd_key_value_t * lrmd_key_value_add(lrmd_key_value_t *kvp, const char *key, const char *value)
Definition: lrmd_client.c:142
struct lrmd_key_value_s * next
Definition: lrmd.h:28
int start_delay
Definition: lrmd.h:213
const char * op_type
Definition: lrmd.h:202
char * action
Definition: lrmd.h:260
unsigned int t_run
Definition: lrmd.h:224
void lrmd_key_value_freeall(lrmd_key_value_t *head)
Definition: lrmd_client.c:165
void * lrmd_private
Definition: lrmd.h:532
char * type
Definition: lrmd.h:253
struct lrmd_key_value_s lrmd_key_value_t
const char * remote_nodename
Definition: lrmd.h:242
ocf_exitcode
Definition: services.h:87
lrmd_api_operations_t * cmds
Definition: lrmd.h:531
char * standard
Definition: lrmd.h:254
lrmd_event_data_t * lrmd_copy_event(lrmd_event_data_t *event)
Definition: lrmd_client.c:179
char * provider
Definition: lrmd.h:255
Definition: lrmd.h:530
int lrmd_poll(lrmd_t *lrmd, int timeout)
Poll for a specified timeout period to determine if a message is ready for dispatch.
Definition: lrmd_client.c:393
struct lrmd_list_s lrmd_list_t
void lrmd_free_rsc_info(lrmd_rsc_info_t *rsc_info)
Definition: lrmd_client.c:1503
struct lrmd_op_info_s lrmd_op_info_t
void lrmd_api_delete(lrmd_t *lrmd)
Destroy executor connection object.
Definition: lrmd_client.c:1998
char * timeout_ms_s
Definition: lrmd.h:262
char * value
Definition: lrmd.h:27
guint interval_ms
Definition: lrmd.h:211
enum crm_ais_msg_types type
Definition: internal.h:83