pacemaker  2.1.4-dc6eb4362
Scalable High-Availability cluster resource manager
common.h
Go to the documentation of this file.
1 /*
2  * Copyright 2004-2022 the Pacemaker project contributors
3  *
4  * The version control history for this file may have further details.
5  *
6  * This source code is licensed under the GNU Lesser General Public License
7  * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
8  */
9 
10 #ifndef PCMK__CRM_PENGINE_COMMON__H
11 # define PCMK__CRM_PENGINE_COMMON__H
12 
13 # include <glib.h>
14 # include <regex.h>
15 # include <crm/common/iso8601.h>
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 extern gboolean was_processing_error;
22 extern gboolean was_processing_warning;
23 
24 /* The order is (partially) significant here; the values from action_fail_ignore
25  * through action_fail_fence are in order of increasing severity.
26  *
27  * @COMPAT The values should be ordered and numbered per the "TODO" comments
28  * below, so all values are in order of severity and there is room for
29  * future additions, but that would break API compatibility.
30  * @TODO For now, we just use a function to compare the values specially, but
31  * at the next compatibility break, we should arrange things properly.
32  */
34  action_fail_ignore, // @TODO = 10
35  // @TODO action_fail_demote = 20,
36  action_fail_recover, // @TODO = 30
37  // @TODO action_fail_reset_remote = 40,
38  // @TODO action_fail_restart_container = 50,
39  action_fail_migrate, // @TODO = 60
40  action_fail_block, // @TODO = 70
41  action_fail_stop, // @TODO = 80
42  action_fail_standby, // @TODO = 90
43  action_fail_fence, // @TODO = 100
44 
45  // @COMPAT Values below here are out of order for API compatibility
46 
48 
49  /* This is reserved for internal use for remote node connection resources.
50  * Fence the remote node if stonith is enabled, otherwise attempt to recover
51  * the connection resource. This allows us to specify types of connection
52  * resource failures that should result in fencing the remote node
53  * (for example, recurring monitor failures).
54  */
56 
58 };
59 
60 /* the "done" action must be the "pre" action +1 */
76 };
77 
83 };
84 
86  rsc_req_nothing, /* Allowed by custom_action() */
87  rsc_req_quorum, /* Enforced by custom_action() */
88  rsc_req_stonith /* Enforced by native_start_constraints() */
89 };
90 
92 enum rsc_role_e {
98 
99 #if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
102 
105 #endif
106 };
107 
108 # define RSC_ROLE_MAX (RSC_ROLE_PROMOTED + 1)
109 
110 # define RSC_ROLE_UNKNOWN_S "Unknown"
111 # define RSC_ROLE_STOPPED_S "Stopped"
112 # define RSC_ROLE_STARTED_S "Started"
113 # define RSC_ROLE_UNPROMOTED_S "Unpromoted"
114 # define RSC_ROLE_PROMOTED_S "Promoted"
115 # define RSC_ROLE_UNPROMOTED_LEGACY_S "Slave"
116 # define RSC_ROLE_PROMOTED_LEGACY_S "Master"
117 
120  pe_print_log = (1 << 0),
121  pe_print_html = (1 << 1),
122  pe_print_ncurses = (1 << 2),
123  pe_print_printf = (1 << 3),
124  pe_print_dev = (1 << 4),
125  pe_print_details = (1 << 5),
126  pe_print_max_details = (1 << 6),
127  pe_print_rsconly = (1 << 7),
128  pe_print_ops = (1 << 8),
130  pe_print_xml = (1 << 10),
131  pe_print_brief = (1 << 11),
132  pe_print_pending = (1 << 12),
134  pe_print_clone_active = (1 << 14), // Print clone instances only if active
135  pe_print_implicit = (1 << 15) // Print implicitly created resources
136 };
137 
138 const char *task2text(enum action_tasks task);
139 enum action_tasks text2task(const char *task);
140 enum rsc_role_e text2role(const char *role);
141 const char *role2text(enum rsc_role_e role);
142 const char *fail2text(enum action_fail_response fail);
143 
144 const char *pe_pref(GHashTable * options, const char *name);
145 void calculate_active_ops(GList * sorted_op_list, int *start_index, int *stop_index);
146 
154 static inline const char *
155 recovery2text(enum rsc_recovery_type type)
156 {
157  switch (type) {
158  case recovery_stop_only:
159  return "shutting it down";
160  case recovery_stop_start:
161  return "attempting recovery";
162  case recovery_block:
163  return "waiting for an administrator";
165  return "stopping unexpected instances";
166  }
167  return "Unknown";
168 }
169 
170 typedef struct pe_re_match_data {
171  char *string;
172  int nregs;
173  regmatch_t *pmatch;
175 
176 typedef struct pe_match_data {
178  GHashTable *params;
179  GHashTable *meta;
181 
182 typedef struct pe_rsc_eval_data {
183  const char *standard;
184  const char *provider;
185  const char *agent;
187 
188 typedef struct pe_op_eval_data {
189  const char *op_name;
190  guint interval;
192 
193 typedef struct pe_rule_eval_data {
194  GHashTable *node_hash;
201 
202 #if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
204 #endif
205 
206 #ifdef __cplusplus
207 }
208 #endif
209 
210 #endif
const char * task2text(enum action_tasks task)
Definition: common.c:401
const char * provider
Definition: common.h:184
const char * name
Definition: cib.c:24
struct crm_time_s crm_time_t
Definition: iso8601.h:32
struct pe_rule_eval_data pe_rule_eval_data_t
pe_re_match_data_t * re
Definition: common.h:177
Deprecated Pacemaker scheduler utilities.
enum action_tasks text2task(const char *task)
Definition: common.c:351
const char * pe_pref(GHashTable *options, const char *name)
Definition: common.c:305
Ignored.
Definition: common.h:125
enum crm_ais_msg_types type
Definition: cpg.c:48
struct pe_re_match_data pe_re_match_data_t
action_fail_response
Definition: common.h:33
const char * role2text(enum rsc_role_e role)
Definition: common.c:454
rsc_recovery_type
Definition: common.h:78
guint interval
Definition: common.h:190
pe_match_data_t * match_data
Definition: common.h:197
pe_op_eval_data_t * op_data
Definition: common.h:199
void calculate_active_ops(GList *sorted_op_list, int *start_index, int *stop_index)
Definition: unpack.c:2259
struct pe_rsc_eval_data pe_rsc_eval_data_t
const char * op_name
Definition: common.h:189
ISO_8601 Date handling.
struct pe_match_data pe_match_data_t
rsc_start_requirement
Definition: common.h:85
GHashTable * meta
Definition: common.h:179
pe_print_options
Deprecated.
Definition: common.h:119
enum rsc_role_e text2role(const char *role)
Definition: common.c:483
pe_rsc_eval_data_t * rsc_data
Definition: common.h:198
const char * agent
Definition: common.h:185
GHashTable * params
Definition: common.h:178
const char * fail2text(enum action_fail_response fail)
Definition: common.c:311
const char * standard
Definition: common.h:183
crm_time_t * now
Definition: common.h:196
GHashTable * node_hash
Definition: common.h:194
regmatch_t * pmatch
Definition: common.h:173
struct pe_op_eval_data pe_op_eval_data_t
rsc_role_e
Possible roles that a resource can be in.
Definition: common.h:92
Ignored.
Definition: common.h:127
gboolean was_processing_error
Definition: common.c:20
gboolean was_processing_warning
Definition: common.c:21
enum rsc_role_e role
Definition: common.h:195
char * string
Definition: common.h:171
action_tasks
Definition: common.h:61