pacemaker  1.1.17-b36b869ca8
Scalable High-Availability cluster resource manager
lrmd.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012 David Vossel <davidvossel@gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17  *
18  */
19 
25 #include <stdbool.h>
26 #include <crm/services.h>
27 
28 #ifndef LRMD__H
29 # define LRMD__H
30 
31 typedef struct lrmd_s lrmd_t;
32 typedef struct lrmd_key_value_s {
33  char *key;
34  char *value;
37 
38 #define LRMD_PROTOCOL_VERSION "1.1"
39 
40 /* *INDENT-OFF* */
41 #define DEFAULT_REMOTE_KEY_LOCATION "/etc/pacemaker/authkey"
42 #define ALT_REMOTE_KEY_LOCATION "/etc/corosync/authkey"
43 #define DEFAULT_REMOTE_PORT 3121
44 #define DEFAULT_REMOTE_USERNAME "lrmd"
45 
46 #define F_LRMD_OPERATION "lrmd_op"
47 #define F_LRMD_CLIENTNAME "lrmd_clientname"
48 #define F_LRMD_IS_IPC_PROVIDER "lrmd_is_ipc_provider"
49 #define F_LRMD_CLIENTID "lrmd_clientid"
50 #define F_LRMD_PROTOCOL_VERSION "lrmd_protocol_version"
51 #define F_LRMD_REMOTE_MSG_TYPE "lrmd_remote_msg_type"
52 #define F_LRMD_REMOTE_MSG_ID "lrmd_remote_msg_id"
53 #define F_LRMD_CALLBACK_TOKEN "lrmd_async_id"
54 #define F_LRMD_CALLID "lrmd_callid"
55 #define F_LRMD_CANCEL_CALLID "lrmd_cancel_callid"
56 #define F_LRMD_CALLOPTS "lrmd_callopt"
57 #define F_LRMD_CALLDATA "lrmd_calldata"
58 #define F_LRMD_RC "lrmd_rc"
59 #define F_LRMD_EXEC_RC "lrmd_exec_rc"
60 #define F_LRMD_OP_STATUS "lrmd_exec_op_status"
61 #define F_LRMD_TIMEOUT "lrmd_timeout"
62 #define F_LRMD_WATCHDOG "lrmd_watchdog"
63 #define F_LRMD_CLASS "lrmd_class"
64 #define F_LRMD_PROVIDER "lrmd_provider"
65 #define F_LRMD_TYPE "lrmd_type"
66 #define F_LRMD_ORIGIN "lrmd_origin"
67 
68 #define F_LRMD_RSC_RUN_TIME "lrmd_run_time"
69 #define F_LRMD_RSC_RCCHANGE_TIME "lrmd_rcchange_time"
70 #define F_LRMD_RSC_EXEC_TIME "lrmd_exec_time"
71 #define F_LRMD_RSC_QUEUE_TIME "lrmd_queue_time"
72 
73 #define F_LRMD_RSC_ID "lrmd_rsc_id"
74 #define F_LRMD_RSC_ACTION "lrmd_rsc_action"
75 #define F_LRMD_RSC_USERDATA_STR "lrmd_rsc_userdata_str"
76 #define F_LRMD_RSC_OUTPUT "lrmd_rsc_output"
77 #define F_LRMD_RSC_EXIT_REASON "lrmd_rsc_exit_reason"
78 #define F_LRMD_RSC_START_DELAY "lrmd_rsc_start_delay"
79 #define F_LRMD_RSC_INTERVAL "lrmd_rsc_interval"
80 #define F_LRMD_RSC_METADATA "lrmd_rsc_metadata_res"
81 #define F_LRMD_RSC_DELETED "lrmd_rsc_deleted"
82 #define F_LRMD_RSC "lrmd_rsc"
83 
84 #define LRMD_OP_RSC_CHK_REG "lrmd_rsc_check_register"
85 #define LRMD_OP_RSC_REG "lrmd_rsc_register"
86 #define LRMD_OP_RSC_EXEC "lrmd_rsc_exec"
87 #define LRMD_OP_RSC_CANCEL "lrmd_rsc_cancel"
88 #define LRMD_OP_RSC_UNREG "lrmd_rsc_unregister"
89 #define LRMD_OP_RSC_INFO "lrmd_rsc_info"
90 #define LRMD_OP_RSC_METADATA "lrmd_rsc_metadata"
91 #define LRMD_OP_POKE "lrmd_rsc_poke"
92 #define LRMD_OP_NEW_CLIENT "lrmd_rsc_new_client"
93 #define LRMD_OP_CHECK "lrmd_check"
94 
95 #define LRMD_IPC_OP_NEW "new"
96 #define LRMD_IPC_OP_DESTROY "destroy"
97 #define LRMD_IPC_OP_EVENT "event"
98 #define LRMD_IPC_OP_REQUEST "request"
99 #define LRMD_IPC_OP_RESPONSE "response"
100 #define LRMD_IPC_OP_SHUTDOWN_REQ "shutdown_req"
101 #define LRMD_IPC_OP_SHUTDOWN_ACK "shutdown_ack"
102 #define LRMD_IPC_OP_SHUTDOWN_NACK "shutdown_nack"
103 
104 #define F_LRMD_IPC_OP "lrmd_ipc_op"
105 #define F_LRMD_IPC_IPC_SERVER "lrmd_ipc_server"
106 #define F_LRMD_IPC_SESSION "lrmd_ipc_session"
107 #define F_LRMD_IPC_CLIENT "lrmd_ipc_client"
108 #define F_LRMD_IPC_PROXY_NODE "lrmd_ipc_proxy_node"
109 #define F_LRMD_IPC_USER "lrmd_ipc_user"
110 #define F_LRMD_IPC_MSG "lrmd_ipc_msg"
111 #define F_LRMD_IPC_MSG_ID "lrmd_ipc_msg_id"
112 #define F_LRMD_IPC_MSG_FLAGS "lrmd_ipc_msg_flags"
113 
114 #define T_LRMD "lrmd"
115 #define T_LRMD_REPLY "lrmd_reply"
116 #define T_LRMD_NOTIFY "lrmd_notify"
117 #define T_LRMD_IPC_PROXY "lrmd_ipc_proxy"
118 /* *INDENT-ON* */
119 
123 lrmd_t *lrmd_api_new(void);
124 
134 lrmd_t *lrmd_remote_api_new(const char *nodename, const char *server, int port);
135 
143 bool lrmd_dispatch(lrmd_t * lrmd);
144 
152 int lrmd_poll(lrmd_t * lrmd, int timeout);
153 
157 void lrmd_api_delete(lrmd_t * lrmd);
158 lrmd_key_value_t *lrmd_key_value_add(lrmd_key_value_t * kvp, const char *key, const char *value);
159 
160 /* *INDENT-OFF* */
161 /* Reserved for future use */
163  lrmd_opt_none = 0x00000000,
164  /* lrmd_opt_sync_call = 0x00000001, //Not implemented, patches welcome. */
174 };
175 
184 };
185 
186 /* *INDENT-ON* */
187 
188 #ifdef ENABLE_VERSIONED_ATTRS
189 #include <libxml/tree.h>
190 #endif
191 
192 typedef struct lrmd_event_data_s {
195 
197  const char *rsc_id;
199  const char *op_type;
201  const char *user_data;
202 
204  int call_id;
206  int timeout;
208  int interval;
213 
215  enum ocf_exitcode rc;
219  const char *output;
221  unsigned int t_run;
223  unsigned int t_rcchange;
225  unsigned int exec_time;
227  unsigned int queue_time;
228 
231 
232  /* This is a GHashTable containing the
233  * parameters given to the operation */
234  void *params;
235 
239  const char *remote_nodename;
240 
242  const char *exit_reason;
243 
244 #ifdef ENABLE_VERSIONED_ATTRS
245  /* This is an xmlNode containing the versioned parameters
246  * that should be evaluated */
247  xmlNode *versioned_params;
248 #endif
249 
251 
253 void lrmd_free_event(lrmd_event_data_t * event);
254 
255 typedef struct lrmd_rsc_info_s {
256  char *id;
257  char *type;
258  char *class;
259  char *provider;
261 
263 void lrmd_free_rsc_info(lrmd_rsc_info_t * rsc_info);
264 
265 typedef void (*lrmd_event_callback) (lrmd_event_data_t * event);
266 
267 typedef struct lrmd_list_s {
268  const char *val;
269  struct lrmd_list_s *next;
270 } lrmd_list_t;
271 
272 void lrmd_list_freeall(lrmd_list_t * head);
274 
275 typedef struct lrmd_api_operations_s {
282  int (*connect) (lrmd_t * lrmd, const char *client_name, int *fd);
283 
294  int (*connect_async) (lrmd_t * lrmd, const char *client_name, int timeout /*ms */ );
295 
302  int (*is_connected) (lrmd_t * lrmd);
303 
311  int (*poke_connection) (lrmd_t * lrmd);
312 
319  int (*disconnect) (lrmd_t * lrmd);
320 
329  int (*register_rsc) (lrmd_t * lrmd,
330  const char *rsc_id,
331  const char *class,
332  const char *provider, const char *agent, enum lrmd_call_options options);
333 
340  lrmd_rsc_info_t *(*get_rsc_info) (lrmd_t * lrmd,
341  const char *rsc_id, enum lrmd_call_options options);
342 
357  int (*unregister_rsc) (lrmd_t * lrmd, const char *rsc_id, enum lrmd_call_options options);
358 
362  void (*set_callback) (lrmd_t * lrmd, lrmd_event_callback callback);
363 
379  int (*exec) (lrmd_t * lrmd, const char *rsc_id, const char *action, const char *userdata, /* userdata string given back in event notification */
380  int interval, /* ms */
381  int timeout, /* ms */
382  int start_delay, /* ms */
383  enum lrmd_call_options options, lrmd_key_value_t * params); /* ownership of params is given up to api here */
384 
408  int (*cancel) (lrmd_t * lrmd, const char *rsc_id, const char *action, int interval);
409 
418  int (*get_metadata) (lrmd_t * lrmd,
419  const char *class,
420  const char *provider,
421  const char *agent, char **output, enum lrmd_call_options options);
422 
432  int (*list_agents) (lrmd_t * lrmd, lrmd_list_t ** agents, const char *class,
433  const char *provider);
434 
445  int (*list_ocf_providers) (lrmd_t * lrmd, const char *agent, lrmd_list_t ** providers);
446 
455  int (*list_standards) (lrmd_t * lrmd, lrmd_list_t ** standards);
456 
458 
459 struct lrmd_s {
461  void *private;
462 };
463 
464 static inline const char *
465 lrmd_event_type2str(enum lrmd_callback_event type)
466 {
467  switch (type) {
468  case lrmd_event_register:
469  return "register";
471  return "unregister";
473  return "exec_complete";
475  return "disconnect";
476  case lrmd_event_connect:
477  return "connect";
478  case lrmd_event_poke:
479  return "poke";
481  return "new_client";
482  }
483  return "unknown";
484 }
485 
486 #endif
Services API.
struct lrmd_rsc_info_s lrmd_rsc_info_t
lrmd_call_options
Definition: lrmd.h:162
lrmd_callback_event
Definition: lrmd.h:176
const char * user_data
Definition: lrmd.h:201
const char * rsc_id
Definition: lrmd.h:197
unsigned int queue_time
Definition: lrmd.h:227
void(* lrmd_event_callback)(lrmd_event_data_t *event)
Definition: lrmd.h:265
char * id
Definition: lrmd.h:256
void lrmd_list_freeall(lrmd_list_t *head)
Definition: lrmd_client.c:138
void lrmd_free_event(lrmd_event_data_t *event)
Definition: lrmd_client.c:233
unsigned int t_rcchange
Definition: lrmd.h:223
const char * output
Definition: lrmd.h:219
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 remote lrmd connection using tls backend.
Definition: lrmd_client.c:2211
int connection_rc
Definition: lrmd.h:230
const char * val
Definition: lrmd.h:268
struct lrmd_api_operations_s lrmd_api_operations_t
unsigned int exec_time
Definition: lrmd.h:225
void * params
Definition: lrmd.h:234
lrmd_rsc_info_t * lrmd_copy_rsc_info(lrmd_rsc_info_t *rsc_info)
Definition: lrmd_client.c:1479
const char * exit_reason
Definition: lrmd.h:242
char * key
Definition: lrmd.h:33
struct lrmd_list_s * next
Definition: lrmd.h:269
int rsc_deleted
Definition: lrmd.h:212
lrmd_t * lrmd_api_new(void)
Create a new local lrmd connection.
Definition: lrmd_client.c:2178
bool lrmd_dispatch(lrmd_t *lrmd)
Use after lrmd_poll returns 1 to read and dispatch a message.
Definition: lrmd_client.c:456
lrmd_key_value_t * lrmd_key_value_add(lrmd_key_value_t *kvp, const char *key, const char *value)
Definition: lrmd_client.c:153
struct lrmd_key_value_s * next
Definition: lrmd.h:35
int start_delay
Definition: lrmd.h:210
const char * op_type
Definition: lrmd.h:199
unsigned int t_run
Definition: lrmd.h:221
void lrmd_key_value_freeall(lrmd_key_value_t *head)
Definition: lrmd_client.c:176
char * type
Definition: lrmd.h:257
struct lrmd_key_value_s lrmd_key_value_t
const char * remote_nodename
Definition: lrmd.h:239
ocf_exitcode
Definition: services.h:101
lrmd_api_operations_t * cmds
Definition: lrmd.h:460
lrmd_event_data_t * lrmd_copy_event(lrmd_event_data_t *event)
Definition: lrmd_client.c:196
char * provider
Definition: lrmd.h:259
Definition: lrmd.h:459
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:431
struct lrmd_list_s lrmd_list_t
void lrmd_free_rsc_info(lrmd_rsc_info_t *rsc_info)
Definition: lrmd_client.c:1496
void lrmd_api_delete(lrmd_t *lrmd)
Destroy lrmd object.
Definition: lrmd_client.c:2240
char * value
Definition: lrmd.h:34
enum crm_ais_msg_types type
Definition: internal.h:51