![[first]](../icons/first.png){kind=icon}
![[previous]](../icons/n_left.png){kind=icon}
![[next]](../icons/n_right.png){kind=icon}
![[last]](../icons/last.png){kind=icon}
![[top]](../icons/n_top.png){kind=icon}
![[bottom]](../icons/bottom.png){kind=icon}
![[index]](../icons/index.png){kind=icon}
![[help]](../icons/help.png){kind=icon}
*/
1 /*
2 * Copyright 2015-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 CRM_COMMON_INTERNAL__H
11 #define CRM_COMMON_INTERNAL__H
12
13 #include <unistd.h> // pid_t, getpid()
14 #include <stdbool.h> // bool
15 #include <stdint.h> // uint8_t, uint64_t
16
17 #include <glib.h> // guint, GList, GHashTable
18 #include <libxml/tree.h> // xmlNode
19
20 #include <crm/common/util.h> // crm_strdup_printf()
21 #include <crm/common/logging.h> // do_crm_log_unlikely(), etc.
22 #include <crm/common/mainloop.h> // mainloop_io_t, struct ipc_client_callbacks
23 #include <crm/common/health_internal.h>
24 #include <crm/common/io_internal.h>
25 #include <crm/common/iso8601_internal.h>
26 #include <crm/common/results_internal.h>
27 #include <crm/common/messages_internal.h>
28 #include <crm/common/strings_internal.h>
29 #include <crm/common/acl_internal.h>
30
31 /* This says whether the current application is a Pacemaker daemon or not,
32 * and is used to change default logging settings such as whether to log to
33 * stderr, etc., as well as a few other details such as whether blackbox signal
34 * handling is enabled.
35 *
36 * It is set when logging is initialized, and does not need to be set directly.
37 */
38 extern bool pcmk__is_daemon;
39
40 // Number of elements in a statically defined array
41 #define PCMK__NELEM(a) ((int) (sizeof(a)/sizeof(a[0])) )
42
43 #if SUPPORT_CIBSECRETS
44 /* internal CIB utilities (from cib_secrets.c) */
45
46 int pcmk__substitute_secrets(const char *rsc_id, GHashTable *params);
47 #endif
48
49
50 /* internal digest-related utilities (from digest.c) */
51
52 bool pcmk__verify_digest(xmlNode *input, const char *expected);
53
54
55 /* internal main loop utilities (from mainloop.c) */
56
57 int pcmk__add_mainloop_ipc(crm_ipc_t *ipc, int priority, void *userdata,
58 const struct ipc_client_callbacks *callbacks,
59 mainloop_io_t **source);
60 guint pcmk__mainloop_timer_get_period(const mainloop_timer_t *timer);
61
62
63 /* internal node-related XML utilities (from nodes.c) */
64
65 /*!
66 * \internal
67 * \brief Add local node name and ID to an XML node
68 *
69 * \param[in,out] request XML node to modify
70 * \param[in] node The local node's name
71 * \param[in] nodeid The local node's ID (can be 0)
72 */
73 void pcmk__xe_add_node(xmlNode *xml, const char *node, int nodeid);
74
75
76 /* internal name/value utilities (from nvpair.c) */
77
78 int pcmk__scan_nvpair(const char *input, char **name, char **value);
79 char *pcmk__format_nvpair(const char *name, const char *value,
80 const char *units);
81 char *pcmk__format_named_time(const char *name, time_t epoch_time);
82
83 /*!
84 * \internal
85 * \brief Add a boolean attribute to an XML node.
86 *
87 * \param[in,out] node XML node to add attributes to
88 * \param[in] name XML attribute to create
89 * \param[in] value Value to give to the attribute
90 */
91 void
92 pcmk__xe_set_bool_attr(xmlNodePtr node, const char *name, bool value);
93
94 /*!
95 * \internal
96 * \brief Extract a boolean attribute's value from an XML element
97 *
98 * \param[in] node XML node to get attribute from
99 * \param[in] name XML attribute to get
100 *
101 * \return True if the given \p name is an attribute on \p node and has
102 * the value "true", False in all other cases
103 */
104 bool
105 pcmk__xe_attr_is_true(const xmlNode *node, const char *name);
106
107 /*!
108 * \internal
109 * \brief Extract a boolean attribute's value from an XML element, with
110 * error checking
111 *
112 * \param[in] node XML node to get attribute from
113 * \param[in] name XML attribute to get
114 * \param[out] value Destination for the value of the attribute
115 *
116 * \return EINVAL if \p name or \p value are NULL, ENODATA if \p node is
117 * NULL or the attribute does not exist, pcmk_rc_unknown_format
118 * if the attribute is not a boolean, and pcmk_rc_ok otherwise.
119 *
120 * \note \p value only has any meaning if the return value is pcmk_rc_ok.
121 */
122 int
123 pcmk__xe_get_bool_attr(const xmlNode *node, const char *name, bool *value);
124
125
126 /* internal procfs utilities (from procfs.c) */
127
128 pid_t pcmk__procfs_pid_of(const char *name);
129 unsigned int pcmk__procfs_num_cores(void);
130 int pcmk__procfs_pid2path(pid_t pid, char path[], size_t path_size);
131 bool pcmk__procfs_has_pids(void);
132
133 /* internal XML schema functions (from xml.c) */
134
135 void crm_schema_init(void);
136 void crm_schema_cleanup(void);
137
138
139 /* internal functions related to process IDs (from pid.c) */
140
141 /*!
142 * \internal
143 * \brief Check whether process exists (by PID and optionally executable path)
144 *
145 * \param[in] pid PID of process to check
146 * \param[in] daemon If not NULL, path component to match with procfs entry
147 *
148 * \return Standard Pacemaker return code
149 * \note Particular return codes of interest include pcmk_rc_ok for alive,
150 * ESRCH for process is not alive (verified by kill and/or executable path
151 * match), EACCES for caller unable or not allowed to check. A result of
152 * "alive" is less reliable when \p daemon is not provided or procfs is
153 * not available, since there is no guarantee that the PID has not been
154 * recycled for another process.
155 * \note This function cannot be used to verify \e authenticity of the process.
156 */
157 int pcmk__pid_active(pid_t pid, const char *daemon);
158
159 int pcmk__read_pidfile(const char *filename, pid_t *pid);
160 int pcmk__pidfile_matches(const char *filename, pid_t expected_pid,
161 const char *expected_name, pid_t *pid);
162 int pcmk__lock_pidfile(const char *filename, const char *name);
163
164
165 /* internal functions related to resource operations (from operations.c) */
166
167 // printf-style format to create operation ID from resource, action, interval
168 #define PCMK__OP_FMT "%s_%s_%u"
169
170 char *pcmk__op_key(const char *rsc_id, const char *op_type, guint interval_ms);
171 char *pcmk__notify_key(const char *rsc_id, const char *notify_type,
172 const char *op_type);
173 char *pcmk__transition_key(int transition_id, int action_id, int target_rc,
174 const char *node);
175 void pcmk__filter_op_for_digest(xmlNode *param_set);
176 bool pcmk__is_fencing_action(const char *action);
177
178
179 // bitwise arithmetic utilities
180
181 /*!
182 * \internal
183 * \brief Set specified flags in a flag group
184 *
185 * \param[in] function Function name of caller
186 * \param[in] line Line number of caller
187 * \param[in] log_level Log a message at this level
188 * \param[in] flag_type Label describing this flag group (for logging)
189 * \param[in] target Name of object whose flags these are (for logging)
190 * \param[in] flag_group Flag group being manipulated
191 * \param[in] flags Which flags in the group should be set
192 * \param[in] flags_str Readable equivalent of \p flags (for logging)
193 *
194 * \return Possibly modified flag group
195 */
196 static inline uint64_t
197 pcmk__set_flags_as(const char *function, int line, uint8_t log_level,
/* ![[next]](../icons/right.png)
![[first]](../icons/n_first.png)
![[top]](../icons/top.png)
*/
198 const char *flag_type, const char *target,
199 uint64_t flag_group, uint64_t flags, const char *flags_str)
200 {
201 uint64_t result = flag_group | flags;
202
203 if (result != flag_group) {
204 do_crm_log_unlikely(log_level,
205 "%s flags %#.8llx (%s) for %s set by %s:%d",
206 ((flag_type == NULL)? "Group of" : flag_type),
207 (unsigned long long) flags,
208 ((flags_str == NULL)? "flags" : flags_str),
209 ((target == NULL)? "target" : target),
210 function, line);
211 }
212 return result;
213 }
214
215 /*!
216 * \internal
217 * \brief Clear specified flags in a flag group
218 *
219 * \param[in] function Function name of caller
220 * \param[in] line Line number of caller
221 * \param[in] log_level Log a message at this level
222 * \param[in] flag_type Label describing this flag group (for logging)
223 * \param[in] target Name of object whose flags these are (for logging)
224 * \param[in] flag_group Flag group being manipulated
225 * \param[in] flags Which flags in the group should be cleared
226 * \param[in] flags_str Readable equivalent of \p flags (for logging)
227 *
228 * \return Possibly modified flag group
229 */
230 static inline uint64_t
231 pcmk__clear_flags_as(const char *function, int line, uint8_t log_level,
/* ![[previous]](../icons/left.png)
*/
232 const char *flag_type, const char *target,
233 uint64_t flag_group, uint64_t flags, const char *flags_str)
234 {
235 uint64_t result = flag_group & ~flags;
236
237 if (result != flag_group) {
238 do_crm_log_unlikely(log_level,
239 "%s flags %#.8llx (%s) for %s cleared by %s:%d",
240 ((flag_type == NULL)? "Group of" : flag_type),
241 (unsigned long long) flags,
242 ((flags_str == NULL)? "flags" : flags_str),
243 ((target == NULL)? "target" : target),
244 function, line);
245 }
246 return result;
247 }
248
249 // miscellaneous utilities (from utils.c)
250
251 void pcmk__daemonize(const char *name, const char *pidfile);
252 void pcmk__panic(const char *origin);
253 pid_t pcmk__locate_sbd(void);
254 void pcmk__sleep_ms(unsigned int ms);
255
256 extern int pcmk__score_red;
257 extern int pcmk__score_green;
258 extern int pcmk__score_yellow;
259
260 /*!
261 * \internal
262 * \brief Resize a dynamically allocated memory block
263 *
264 * \param[in] ptr Memory block to resize (or NULL to allocate new memory)
265 * \param[in] size New size of memory block in bytes (must be > 0)
266 *
267 * \return Pointer to resized memory block
268 *
269 * \note This asserts on error, so the result is guaranteed to be non-NULL
270 * (which is the main advantage of this over directly using realloc()).
271 */
272 static inline void *
273 pcmk__realloc(void *ptr, size_t size)
/* */
274 {
275 void *new_ptr;
276
277 // realloc(p, 0) can replace free(p) but this wrapper can't
278 CRM_ASSERT(size > 0);
279
280 new_ptr = realloc(ptr, size);
281 if (new_ptr == NULL) {
282 free(ptr);
283 abort();
284 }
285 return new_ptr;
286 }
287
288
289 static inline char *
290 pcmk__getpid_s(void)
/* */
291 {
292 return crm_strdup_printf("%lu", (unsigned long) getpid());
293 }
294
295 // More efficient than g_list_length(list) == 1
296 static inline bool
297 pcmk__list_of_1(GList *list)
/* */
298 {
299 return list && (list->next == NULL);
300 }
301
302 // More efficient than g_list_length(list) > 1
303 static inline bool
304 pcmk__list_of_multiple(GList *list)
/* */
305 {
306 return list && (list->next != NULL);
307 }
308
309 /* convenience functions for failure-related node attributes */
310
311 #define PCMK__FAIL_COUNT_PREFIX "fail-count"
312 #define PCMK__LAST_FAILURE_PREFIX "last-failure"
313
314 /*!
315 * \internal
316 * \brief Generate a failure-related node attribute name for a resource
317 *
318 * \param[in] prefix Start of attribute name
319 * \param[in] rsc_id Resource name
320 * \param[in] op Operation name
321 * \param[in] interval_ms Operation interval
322 *
323 * \return Newly allocated string with attribute name
324 *
325 * \note Failure attributes are named like PREFIX-RSC#OP_INTERVAL (for example,
326 * "fail-count-myrsc#monitor_30000"). The '#' is used because it is not
327 * a valid character in a resource ID, to reliably distinguish where the
328 * operation name begins. The '_' is used simply to be more comparable to
329 * action labels like "myrsc_monitor_30000".
330 */
331 static inline char *
332 pcmk__fail_attr_name(const char *prefix, const char *rsc_id, const char *op,
/* */
333 guint interval_ms)
334 {
335 CRM_CHECK(prefix && rsc_id && op, return NULL);
336 return crm_strdup_printf("%s-%s#%s_%u", prefix, rsc_id, op, interval_ms);
337 }
338
339 static inline char *
340 pcmk__failcount_name(const char *rsc_id, const char *op, guint interval_ms)
/* */
341 {
342 return pcmk__fail_attr_name(PCMK__FAIL_COUNT_PREFIX, rsc_id, op,
343 interval_ms);
344 }
345
346 static inline char *
347 pcmk__lastfailure_name(const char *rsc_id, const char *op, guint interval_ms)
/* ![[last]](../icons/n_last.png)
*/
348 {
349 return pcmk__fail_attr_name(PCMK__LAST_FAILURE_PREFIX, rsc_id, op,
350 interval_ms);
351 }
352
353 // internal resource agent functions (from agents.c)
354 int pcmk__effective_rc(int rc);
355
356 #endif /* CRM_COMMON_INTERNAL__H */
![[bottom]](../icons/n_bottom.png){kind=icon}
*/