pacemaker  2.0.5-ba59be712
Scalable High-Availability cluster resource manager
common.h
Go to the documentation of this file.
1 /*
2  * Copyright 2004-2020 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 PE_COMMON__H
11 # define PE_COMMON__H
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 # include <glib.h>
18 # include <regex.h>
19 
20 # include <crm/common/iso8601.h>
21 
22 extern gboolean was_processing_error;
23 extern gboolean was_processing_warning;
24 
25 /* The order is (partially) significant here; the values from action_fail_ignore
26  * through action_fail_fence are in order of increasing severity.
27  *
28  * @COMPAT The values should be ordered and numbered per the "TODO" comments
29  * below, so all values are in order of severity and there is room for
30  * future additions, but that would break API compatibility.
31  * @TODO For now, we just use a function to compare the values specially, but
32  * at the next compatibility break, we should arrange things properly.
33  */
35  action_fail_ignore, // @TODO = 10
36  // @TODO action_fail_demote = 20,
37  action_fail_recover, // @TODO = 30
38  // @TODO action_fail_reset_remote = 40,
39  // @TODO action_fail_restart_container = 50,
40  action_fail_migrate, // @TODO = 60
41  action_fail_block, // @TODO = 70
42  action_fail_stop, // @TODO = 80
43  action_fail_standby, // @TODO = 90
44  action_fail_fence, // @TODO = 100
45 
46  // @COMPAT Values below here are out of order for API compatibility
47 
49 
50  /* This is reserved for internal use for remote node connection resources.
51  * Fence the remote node if stonith is enabled, otherwise attempt to recover
52  * the connection resource. This allows us to specify types of connection
53  * resource failures that should result in fencing the remote node
54  * (for example, recurring monitor failures).
55  */
57 
59 };
60 
61 /* the "done" action must be the "pre" action +1 */
77 };
78 
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 
91 enum rsc_role_e {
97 };
98 
99 # define RSC_ROLE_MAX RSC_ROLE_MASTER+1
100 
101 # define RSC_ROLE_UNKNOWN_S "Unknown"
102 # define RSC_ROLE_STOPPED_S "Stopped"
103 # define RSC_ROLE_STARTED_S "Started"
104 # define RSC_ROLE_SLAVE_S "Slave"
105 # define RSC_ROLE_MASTER_S "Master"
106 
108  pe_print_log = (1 << 0),
109  pe_print_html = (1 << 1),
110  pe_print_ncurses = (1 << 2),
111  pe_print_printf = (1 << 3),
112  pe_print_dev = (1 << 4), // Debugging (@COMPAT probably not useful)
113  pe_print_details = (1 << 5),
115  pe_print_rsconly = (1 << 7),
116  pe_print_ops = (1 << 8),
118  pe_print_xml = (1 << 10),
119  pe_print_brief = (1 << 11),
120  pe_print_pending = (1 << 12),
122  pe_print_clone_active = (1 << 14), // Print clone instances only if active
123  pe_print_implicit = (1 << 15) // Print implicitly created resources
124 };
125 
126 const char *task2text(enum action_tasks task);
127 enum action_tasks text2task(const char *task);
128 enum rsc_role_e text2role(const char *role);
129 const char *role2text(enum rsc_role_e role);
130 const char *fail2text(enum action_fail_response fail);
131 
132 const char *pe_pref(GHashTable * options, const char *name);
133 void calculate_active_ops(GList * sorted_op_list, int *start_index, int *stop_index);
134 
135 static inline const char *
136 recovery2text(enum rsc_recovery_type type)
137 {
138  switch (type) {
139  case recovery_stop_only:
140  return "shutting it down";
141  case recovery_stop_start:
142  return "attempting recovery";
143  case recovery_block:
144  return "waiting for an administrator";
145  }
146  return "Unknown";
147 }
148 
149 typedef struct pe_re_match_data {
150  char *string;
151  int nregs;
152  regmatch_t *pmatch;
154 
155 typedef struct pe_match_data {
157  GHashTable *params;
158  GHashTable *meta;
160 
161 typedef struct pe_rsc_eval_data {
162  const char *standard;
163  const char *provider;
164  const char *agent;
166 
167 typedef struct pe_op_eval_data {
168  const char *op_name;
169  guint interval;
171 
172 typedef struct pe_rule_eval_data {
173  GHashTable *node_hash;
180 
181 #ifdef __cplusplus
182 }
183 #endif
184 
185 #endif
const char * task2text(enum action_tasks task)
Definition: common.c:410
const char * provider
Definition: common.h:163
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:156
enum action_tasks text2task(const char *task)
Definition: common.c:358
const char * pe_pref(GHashTable *options, const char *name)
Definition: common.c:312
struct pe_re_match_data pe_re_match_data_t
action_fail_response
Definition: common.h:34
const char * role2text(enum rsc_role_e role)
Definition: common.c:463
rsc_recovery_type
Definition: common.h:79
guint interval
Definition: common.h:169
pe_match_data_t * match_data
Definition: common.h:176
pe_op_eval_data_t * op_data
Definition: common.h:178
void calculate_active_ops(GList *sorted_op_list, int *start_index, int *stop_index)
Definition: unpack.c:2191
struct pe_rsc_eval_data pe_rsc_eval_data_t
const char * op_name
Definition: common.h:168
ISO_8601 Date handling.
struct pe_match_data pe_match_data_t
rsc_start_requirement
Definition: common.h:85
GHashTable * meta
Definition: common.h:158
pe_print_options
Definition: common.h:107
enum rsc_role_e text2role(const char *role)
Definition: common.c:484
pe_rsc_eval_data_t * rsc_data
Definition: common.h:177
const char * agent
Definition: common.h:164
GHashTable * params
Definition: common.h:157
const char * fail2text(enum action_fail_response fail)
Definition: common.c:318
const char * standard
Definition: common.h:162
crm_time_t * now
Definition: common.h:175
GHashTable * node_hash
Definition: common.h:173
regmatch_t * pmatch
Definition: common.h:152
struct pe_op_eval_data pe_op_eval_data_t
rsc_role_e
Definition: common.h:91
gboolean was_processing_error
Definition: common.c:20
char * name
Definition: pcmk_fence.c:31
gboolean was_processing_warning
Definition: common.c:21
enum rsc_role_e role
Definition: common.h:174
char * string
Definition: common.h:150
action_tasks
Definition: common.h:62
enum crm_ais_msg_types type
Definition: internal.h:83