pacemaker  1.1.16-94ff4df
Scalable High-Availability cluster resource manager
internal.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2004 Andrew Beekhof <andrew@beekhof.net>
3  *
4  * This program 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 of the License, or (at your option) any later version.
8  *
9  * This software 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  * 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 #ifndef PE_INTERNAL__H
19 # define PE_INTERNAL__H
20 # include <crm/pengine/status.h>
21 # include <crm/pengine/remote.h>
22 
23 # define pe_rsc_info(rsc, fmt, args...) crm_log_tag(LOG_INFO, rsc ? rsc->id : "<NULL>", fmt, ##args)
24 # define pe_rsc_debug(rsc, fmt, args...) crm_log_tag(LOG_DEBUG, rsc ? rsc->id : "<NULL>", fmt, ##args)
25 # define pe_rsc_trace(rsc, fmt, args...) crm_log_tag(LOG_TRACE, rsc ? rsc->id : "<NULL>", fmt, ##args)
26 
27 # define pe_err(fmt...) { was_processing_error = TRUE; crm_config_error = TRUE; crm_err(fmt); }
28 # define pe_warn(fmt...) { was_processing_warning = TRUE; crm_config_warning = TRUE; crm_warn(fmt); }
29 # define pe_proc_err(fmt...) { was_processing_error = TRUE; crm_err(fmt); }
30 # define pe_proc_warn(fmt...) { was_processing_warning = TRUE; crm_warn(fmt); }
31 # define pe_set_action_bit(action, bit) action->flags = crm_set_bit(__FUNCTION__, action->uuid, action->flags, bit)
32 # define pe_clear_action_bit(action, bit) action->flags = crm_clear_bit(__FUNCTION__, action->uuid, action->flags, bit)
33 
34 typedef struct notify_data_s {
35  GHashTable *keys;
36 
37  const char *action;
38 
43 
44  GListPtr active; /* notify_entry_t* */
45  GListPtr inactive; /* notify_entry_t* */
46  GListPtr start; /* notify_entry_t* */
47  GListPtr stop; /* notify_entry_t* */
48  GListPtr demote; /* notify_entry_t* */
49  GListPtr promote; /* notify_entry_t* */
50  GListPtr master; /* notify_entry_t* */
51  GListPtr slave; /* notify_entry_t* */
52  GHashTable *allowed_nodes;
53 
55 
56 bool pe_can_fence(pe_working_set_t *data_set, node_t *node);
57 
58 int merge_weights(int w1, int w2);
59 void add_hash_param(GHashTable * hash, const char *name, const char *value);
60 void append_hashtable(gpointer key, gpointer value, gpointer user_data);
61 
62 char *native_parameter(resource_t * rsc, node_t * node, gboolean create, const char *name,
63  pe_working_set_t * data_set);
64 node_t *native_location(resource_t * rsc, GListPtr * list, gboolean current);
65 
66 void pe_metadata(void);
67 void verify_pe_options(GHashTable * options);
68 
69 void common_update_score(resource_t * rsc, const char *id, int score);
70 void native_add_running(resource_t * rsc, node_t * node, pe_working_set_t * data_set);
71 node_t *rsc_known_on(resource_t * rsc, GListPtr * list);
72 
73 gboolean native_unpack(resource_t * rsc, pe_working_set_t * data_set);
74 gboolean group_unpack(resource_t * rsc, pe_working_set_t * data_set);
75 gboolean clone_unpack(resource_t * rsc, pe_working_set_t * data_set);
76 gboolean master_unpack(resource_t * rsc, pe_working_set_t * data_set);
77 
78 resource_t *native_find_rsc(resource_t * rsc, const char *id, node_t * node, int flags);
79 
80 gboolean native_active(resource_t * rsc, gboolean all);
81 gboolean group_active(resource_t * rsc, gboolean all);
82 gboolean clone_active(resource_t * rsc, gboolean all);
83 gboolean master_active(resource_t * rsc, gboolean all);
84 
85 void native_print(resource_t * rsc, const char *pre_text, long options, void *print_data);
86 void group_print(resource_t * rsc, const char *pre_text, long options, void *print_data);
87 void clone_print(resource_t * rsc, const char *pre_text, long options, void *print_data);
88 void master_print(resource_t * rsc, const char *pre_text, long options, void *print_data);
89 
90 void native_free(resource_t * rsc);
91 void group_free(resource_t * rsc);
92 void clone_free(resource_t * rsc);
93 void master_free(resource_t * rsc);
94 
95 enum rsc_role_e native_resource_state(const resource_t * rsc, gboolean current);
96 enum rsc_role_e group_resource_state(const resource_t * rsc, gboolean current);
97 enum rsc_role_e clone_resource_state(const resource_t * rsc, gboolean current);
98 enum rsc_role_e master_resource_state(const resource_t * rsc, gboolean current);
99 
100 gboolean common_unpack(xmlNode * xml_obj, resource_t ** rsc, resource_t * parent,
101  pe_working_set_t * data_set);
102 void common_print(resource_t * rsc, const char *pre_text, long options, void *print_data);
103 void common_free(resource_t * rsc);
104 
106 
107 extern node_t *node_copy(const node_t *this_node);
108 extern time_t get_effective_time(pe_working_set_t * data_set);
109 extern int get_failcount(node_t * node, resource_t * rsc, time_t *last_failure,
110  pe_working_set_t * data_set);
111 extern int get_failcount_full(node_t * node, resource_t * rsc, time_t *last_failure,
112  bool effective, xmlNode * xml_op, pe_working_set_t * data_set);
113 extern int get_failcount_all(node_t * node, resource_t * rsc, time_t *last_failure,
114  pe_working_set_t * data_set);
115 
116 /* Binary like operators for lists of nodes */
117 extern void node_list_exclude(GHashTable * list, GListPtr list2, gboolean merge_scores);
118 extern GListPtr node_list_dup(GListPtr list, gboolean reset, gboolean filter);
119 extern GListPtr node_list_from_hash(GHashTable * hash, gboolean reset, gboolean filter);
120 
121 extern GHashTable *node_hash_from_list(GListPtr list);
122 static inline gpointer
123 pe_hash_table_lookup(GHashTable * hash, gconstpointer key)
124 {
125  if (hash) {
126  return g_hash_table_lookup(hash, key);
127  }
128  return NULL;
129 }
130 
131 extern action_t *get_pseudo_op(const char *name, pe_working_set_t * data_set);
132 extern gboolean order_actions(action_t * lh_action, action_t * rh_action, enum pe_ordering order);
133 
134 GHashTable *node_hash_dup(GHashTable * hash);
135 extern GListPtr node_list_and(GListPtr list1, GListPtr list2, gboolean filter);
136 
137 extern GListPtr node_list_xor(GListPtr list1, GListPtr list2, gboolean filter);
138 
139 extern GListPtr node_list_minus(GListPtr list1, GListPtr list2, gboolean filter);
140 
141 extern void pe_free_shallow(GListPtr alist);
142 extern void pe_free_shallow_adv(GListPtr alist, gboolean with_data);
143 
144 /* Printing functions for debug */
145 extern void print_node(const char *pre_text, node_t * node, gboolean details);
146 
147 extern void print_resource(int log_level, const char *pre_text, resource_t * rsc, gboolean details);
148 
149 extern void dump_node_scores_worker(int level, const char *file, const char *function, int line,
150  resource_t * rsc, const char *comment, GHashTable * nodes);
151 
152 extern void dump_node_capacity(int level, const char *comment, node_t * node);
153 extern void dump_rsc_utilization(int level, const char *comment, resource_t * rsc, node_t * node);
154 
155 # define dump_node_scores(level, rsc, text, nodes) do { \
156  dump_node_scores_worker(level, __FILE__, __FUNCTION__, __LINE__, rsc, text, nodes); \
157  } while(0)
158 
159 /* Sorting functions */
160 extern gint sort_rsc_priority(gconstpointer a, gconstpointer b);
161 extern gint sort_rsc_index(gconstpointer a, gconstpointer b);
162 
163 extern xmlNode *find_rsc_op_entry(resource_t * rsc, const char *key);
164 
165 extern action_t *custom_action(resource_t * rsc, char *key, const char *task, node_t * on_node,
166  gboolean optional, gboolean foo, pe_working_set_t * data_set);
167 
168 # define delete_key(rsc) generate_op_key(rsc->id, CRMD_ACTION_DELETE, 0)
169 # define delete_action(rsc, node, optional) custom_action( \
170  rsc, delete_key(rsc), CRMD_ACTION_DELETE, node, \
171  optional, TRUE, data_set);
172 
173 # define stopped_key(rsc) generate_op_key(rsc->id, CRMD_ACTION_STOPPED, 0)
174 # define stopped_action(rsc, node, optional) custom_action( \
175  rsc, stopped_key(rsc), CRMD_ACTION_STOPPED, node, \
176  optional, TRUE, data_set);
177 
178 # define stop_key(rsc) generate_op_key(rsc->id, CRMD_ACTION_STOP, 0)
179 # define stop_action(rsc, node, optional) custom_action( \
180  rsc, stop_key(rsc), CRMD_ACTION_STOP, node, \
181  optional, TRUE, data_set);
182 
183 # define reload_key(rsc) generate_op_key(rsc->id, CRMD_ACTION_RELOAD, 0)
184 # define start_key(rsc) generate_op_key(rsc->id, CRMD_ACTION_START, 0)
185 # define start_action(rsc, node, optional) custom_action( \
186  rsc, start_key(rsc), CRMD_ACTION_START, node, \
187  optional, TRUE, data_set)
188 
189 # define started_key(rsc) generate_op_key(rsc->id, CRMD_ACTION_STARTED, 0)
190 # define started_action(rsc, node, optional) custom_action( \
191  rsc, started_key(rsc), CRMD_ACTION_STARTED, node, \
192  optional, TRUE, data_set)
193 
194 # define promote_key(rsc) generate_op_key(rsc->id, CRMD_ACTION_PROMOTE, 0)
195 # define promote_action(rsc, node, optional) custom_action( \
196  rsc, promote_key(rsc), CRMD_ACTION_PROMOTE, node, \
197  optional, TRUE, data_set)
198 
199 # define promoted_key(rsc) generate_op_key(rsc->id, CRMD_ACTION_PROMOTED, 0)
200 # define promoted_action(rsc, node, optional) custom_action( \
201  rsc, promoted_key(rsc), CRMD_ACTION_PROMOTED, node, \
202  optional, TRUE, data_set)
203 
204 # define demote_key(rsc) generate_op_key(rsc->id, CRMD_ACTION_DEMOTE, 0)
205 # define demote_action(rsc, node, optional) custom_action( \
206  rsc, demote_key(rsc), CRMD_ACTION_DEMOTE, node, \
207  optional, TRUE, data_set)
208 
209 # define demoted_key(rsc) generate_op_key(rsc->id, CRMD_ACTION_DEMOTED, 0)
210 # define demoted_action(rsc, node, optional) custom_action( \
211  rsc, demoted_key(rsc), CRMD_ACTION_DEMOTED, node, \
212  optional, TRUE, data_set)
213 
214 extern action_t *find_first_action(GListPtr input, const char *uuid, const char *task,
215  node_t * on_node);
216 extern enum action_tasks get_complex_task(resource_t * rsc, const char *name,
217  gboolean allow_non_atomic);
218 
219 extern GListPtr find_actions(GListPtr input, const char *key, const node_t *on_node);
220 extern GListPtr find_actions_exact(GListPtr input, const char *key, node_t * on_node);
221 extern GListPtr find_recurring_actions(GListPtr input, node_t * not_on_node);
222 
223 extern void pe_free_action(action_t * action);
224 
225 extern void resource_location(resource_t * rsc, node_t * node, int score, const char *tag,
226  pe_working_set_t * data_set);
227 
228 extern gint sort_op_by_callid(gconstpointer a, gconstpointer b);
229 extern gboolean get_target_role(resource_t * rsc, enum rsc_role_e *role);
230 
231 extern resource_t *find_clone_instance(resource_t * rsc, const char *sub_id,
232  pe_working_set_t * data_set);
233 
234 extern void destroy_ticket(gpointer data);
235 extern ticket_t *ticket_new(const char *ticket_id, pe_working_set_t * data_set);
236 
237 char *clone_strip(const char *last_rsc_id);
238 char *clone_zero(const char *last_rsc_id);
239 
240 int get_target_rc(xmlNode * xml_op);
241 
242 gint sort_node_uname(gconstpointer a, gconstpointer b);
243 bool is_set_recursive(resource_t * rsc, long long flag, bool any);
244 
255 };
256 
257 typedef struct op_digest_cache_s {
259  xmlNode *params_all;
260  xmlNode *params_secure;
261  xmlNode *params_restart;
266 
267 op_digest_cache_t *rsc_action_digest_cmp(resource_t * rsc, xmlNode * xml_op, node_t * node,
268  pe_working_set_t * data_set);
269 
270 action_t *pe_fence_op(node_t * node, const char *op, bool optional, pe_working_set_t * data_set);
271 void trigger_unfencing(
272  resource_t * rsc, node_t *node, const char *reason, action_t *dependency, pe_working_set_t * data_set);
273 
274 void set_bit_recursive(resource_t * rsc, unsigned long long flag);
275 void clear_bit_recursive(resource_t * rsc, unsigned long long flag);
276 
277 gboolean add_tag_ref(GHashTable * tags, const char * tag_name, const char * obj_ref);
278 
279 void print_rscs_brief(GListPtr rsc_list, const char * pre_text, long options,
280  void * print_data, gboolean print_all);
281 void pe_fence_node(pe_working_set_t * data_set, node_t * node, const char *reason);
282 
283 #endif
void verify_pe_options(GHashTable *options)
Definition: common.c:181
void clone_print(resource_t *rsc, const char *pre_text, long options, void *print_data)
Definition: clone.c:401
action_t * pre_done
Definition: internal.h:41
void group_free(resource_t *rsc)
Definition: group.c:195
void dump_rsc_utilization(int level, const char *comment, resource_t *rsc, node_t *node)
Definition: utils.c:282
gint sort_rsc_priority(gconstpointer a, gconstpointer b)
Definition: utils.c:331
gint sort_rsc_index(gconstpointer a, gconstpointer b)
Definition: utils.c:304
gboolean get_target_role(resource_t *rsc, enum rsc_role_e *role)
Definition: utils.c:1732
void pe_metadata(void)
Definition: common.c:172
node_t * node_copy(const node_t *this_node)
Definition: utils.c:66
action_t * post_done
Definition: internal.h:42
GListPtr node_list_dup(GListPtr list, gboolean reset, gboolean filter)
Definition: utils.c:138
GHashTable * allowed_nodes
Definition: internal.h:52
action_t * post
Definition: internal.h:40
bool pe_can_fence(pe_working_set_t *data_set, node_t *node)
Definition: utils.c:39
enum action_tasks get_complex_task(resource_t *rsc, const char *name, gboolean allow_non_atomic)
Definition: utils.c:1139
struct op_digest_cache_s op_digest_cache_t
enum rsc_role_e master_resource_state(const resource_t *rsc, gboolean current)
GListPtr slave
Definition: internal.h:51
char * native_parameter(resource_t *rsc, node_t *node, gboolean create, const char *name, pe_working_set_t *data_set)
Definition: native.c:230
GListPtr find_actions_exact(GListPtr input, const char *key, node_t *on_node)
Definition: utils.c:1233
GHashTable * keys
Definition: internal.h:35
GListPtr find_actions(GListPtr input, const char *key, const node_t *on_node)
Definition: utils.c:1193
gboolean common_unpack(xmlNode *xml_obj, resource_t **rsc, resource_t *parent, pe_working_set_t *data_set)
Definition: complex.c:381
void common_print(resource_t *rsc, const char *pre_text, long options, void *print_data)
void common_update_score(resource_t *rsc, const char *id, int score)
Definition: complex.c:742
void common_free(resource_t *rsc)
Definition: complex.c:795
void print_node(const char *pre_text, node_t *node, gboolean details)
Definition: utils.c:1024
gint sort_op_by_callid(gconstpointer a, gconstpointer b)
Definition: utils.c:1331
time_t get_effective_time(pe_working_set_t *data_set)
Definition: utils.c:1446
GListPtr node_list_and(GListPtr list1, GListPtr list2, gboolean filter)
gboolean master_active(resource_t *rsc, gboolean all)
xmlNode * params_restart
Definition: internal.h:261
void set_bit_recursive(resource_t *rsc, unsigned long long flag)
Definition: utils.c:2040
action_t * get_pseudo_op(const char *name, pe_working_set_t *data_set)
Definition: utils.c:1820
int get_target_rc(xmlNode *xml_op)
Definition: unpack.c:2937
int get_failcount(node_t *node, resource_t *rsc, time_t *last_failure, pe_working_set_t *data_set)
Definition: utils.c:1500
GListPtr node_list_xor(GListPtr list1, GListPtr list2, gboolean filter)
void native_print(resource_t *rsc, const char *pre_text, long options, void *print_data)
Definition: native.c:468
void print_rscs_brief(GListPtr rsc_list, const char *pre_text, long options, void *print_data, gboolean print_all)
Definition: native.c:859
GListPtr find_recurring_actions(GListPtr input, node_t *not_on_node)
Definition: utils.c:1105
void clone_free(resource_t *rsc)
Definition: clone.c:603
enum rsc_role_e group_resource_state(const resource_t *rsc, gboolean current)
Definition: group.c:218
void master_free(resource_t *rsc)
GListPtr stop
Definition: internal.h:47
void native_add_running(resource_t *rsc, node_t *node, pe_working_set_t *data_set)
Definition: native.c:32
void append_hashtable(gpointer key, gpointer value, gpointer user_data)
int get_failcount_full(node_t *node, resource_t *rsc, time_t *last_failure, bool effective, xmlNode *xml_op, pe_working_set_t *data_set)
Definition: utils.c:1625
char * digest_all_calc
Definition: internal.h:262
char * clone_strip(const char *last_rsc_id)
Definition: unpack.c:1523
pe_working_set_t * pe_dataset
Definition: utils.c:29
action_t * find_first_action(GListPtr input, const char *uuid, const char *task, node_t *on_node)
Definition: utils.c:1163
GListPtr master
Definition: internal.h:50
char * digest_secure_calc
Definition: internal.h:263
void pe_fence_node(pe_working_set_t *data_set, node_t *node, const char *reason)
Definition: unpack.c:66
gboolean add_tag_ref(GHashTable *tags, const char *tag_name, const char *obj_ref)
Definition: utils.c:2122
action_t * custom_action(resource_t *rsc, char *key, const char *task, node_t *on_node, gboolean optional, gboolean foo, pe_working_set_t *data_set)
Definition: utils.c:358
void pe_free_shallow_adv(GListPtr alist, gboolean with_data)
enum rsc_role_e native_resource_state(const resource_t *rsc, gboolean current)
Definition: native.c:727
void group_print(resource_t *rsc, const char *pre_text, long options, void *print_data)
Definition: group.c:146
xmlNode * find_rsc_op_entry(resource_t *rsc, const char *key)
Definition: utils.c:1018
gboolean native_active(resource_t *rsc, gboolean all)
Definition: native.c:274
GHashTable * node_hash_dup(GHashTable *hash)
node_t * native_location(resource_t *rsc, GListPtr *list, gboolean current)
Definition: native.c:739
GListPtr node_list_from_hash(GHashTable *hash, gboolean reset, gboolean filter)
xmlNode * params_all
Definition: internal.h:259
action_t * pe_fence_op(node_t *node, const char *op, bool optional, pe_working_set_t *data_set)
Definition: utils.c:2053
GListPtr active
Definition: internal.h:44
enum rsc_role_e clone_resource_state(const resource_t *rsc, gboolean current)
Definition: clone.c:638
GListPtr node_list_minus(GListPtr list1, GListPtr list2, gboolean filter)
pe_ordering
Definition: status.h:377
GHashTable * node_hash_from_list(GListPtr list)
Definition: utils.c:122
gboolean clone_active(resource_t *rsc, gboolean all)
Definition: clone.c:268
void add_hash_param(GHashTable *hash, const char *name, const char *value)
Definition: common.c:419
GListPtr demote
Definition: internal.h:48
void resource_location(resource_t *rsc, node_t *node, int score, const char *tag, pe_working_set_t *data_set)
Definition: utils.c:1287
void node_list_exclude(GHashTable *list, GListPtr list2, gboolean merge_scores)
Definition: utils.c:87
int get_failcount_all(node_t *node, resource_t *rsc, time_t *last_failure, pe_working_set_t *data_set)
Definition: utils.c:1699
ticket_t * ticket_new(const char *ticket_id, pe_working_set_t *data_set)
Definition: utils.c:1849
gboolean group_active(resource_t *rsc, gboolean all)
Definition: group.c:101
char * clone_zero(const char *last_rsc_id)
Definition: unpack.c:1562
GListPtr inactive
Definition: internal.h:45
xmlNode * params_secure
Definition: internal.h:260
void dump_node_capacity(int level, const char *comment, node_t *node)
Definition: utils.c:261
int merge_weights(int w1, int w2)
Definition: common.c:382
char data[0]
Definition: internal.h:58
action_t * pre
Definition: internal.h:39
rsc_role_e
Definition: common.h:81
void native_free(resource_t *rsc)
Definition: native.c:720
void dump_node_scores_worker(int level, const char *file, const char *function, int line, resource_t *rsc, const char *comment, GHashTable *nodes)
Definition: utils.c:173
gboolean native_unpack(resource_t *rsc, pe_working_set_t *data_set)
Definition: native.c:126
void pe_free_action(action_t *action)
Definition: utils.c:1084
void clear_bit_recursive(resource_t *rsc, unsigned long long flag)
Definition: utils.c:2027
void destroy_ticket(gpointer data)
Definition: utils.c:1837
void pe_free_shallow(GListPtr alist)
Definition: status.h:165
GListPtr promote
Definition: internal.h:49
struct notify_data_s notify_data_t
void print_resource(int log_level, const char *pre_text, resource_t *rsc, gboolean details)
Definition: utils.c:1068
GListPtr start
Definition: internal.h:46
gboolean order_actions(action_t *lh_action, action_t *rh_action, enum pe_ordering order)
Definition: utils.c:1768
op_digest_cache_t * rsc_action_digest_cmp(resource_t *rsc, xmlNode *xml_op, node_t *node, pe_working_set_t *data_set)
Definition: utils.c:1928
const char * action
Definition: internal.h:37
resource_t * find_clone_instance(resource_t *rsc, const char *sub_id, pe_working_set_t *data_set)
Definition: clone.c:66
gboolean group_unpack(resource_t *rsc, pe_working_set_t *data_set)
Definition: group.c:31
gint sort_node_uname(gconstpointer a, gconstpointer b)
Definition: utils.c:164
GList * GListPtr
Definition: crm.h:198
bool is_set_recursive(resource_t *rsc, long long flag, bool any)
Definition: clone.c:370
char * digest_restart_calc
Definition: internal.h:264
node_t * rsc_known_on(resource_t *rsc, GListPtr *list)
void trigger_unfencing(resource_t *rsc, node_t *node, const char *reason, action_t *dependency, pe_working_set_t *data_set)
Definition: utils.c:2087
resource_t * native_find_rsc(resource_t *rsc, const char *id, node_t *node, int flags)
Definition: native.c:161
uint64_t flags
Definition: remote.c:121
void master_print(resource_t *rsc, const char *pre_text, long options, void *print_data)
action_tasks
Definition: common.h:52
rsc_digest_cmp_val
Definition: internal.h:245
gboolean clone_unpack(resource_t *rsc, pe_working_set_t *data_set)
Definition: clone.c:153
gboolean master_unpack(resource_t *rsc, pe_working_set_t *data_set)
Definition: clone.c:135