pacemaker  2.1.1-52dc28db4
Scalable High-Availability cluster resource manager
internal.h
Go to the documentation of this file.
1 /*
2  * Copyright 2015-2021 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> // getpid()
14 #include <stdbool.h> // bool
15 #include <stdint.h> // uint8_t, uint64_t
16 #include <string.h> // strcmp()
17 #include <fcntl.h> // open()
18 #include <sys/types.h> // uid_t, gid_t, pid_t
19 
20 #include <glib.h> // guint, GList, GHashTable
21 #include <libxml/tree.h> // xmlNode
22 
23 #include <crm/common/util.h> // crm_strdup_printf()
24 #include <crm/common/logging.h> // do_crm_log_unlikely(), etc.
25 #include <crm/common/mainloop.h> // mainloop_io_t, struct ipc_client_callbacks
27 
28 /* This says whether the current application is a Pacemaker daemon or not,
29  * and is used to change default logging settings such as whether to log to
30  * stderr, etc., as well as a few other details such as whether blackbox signal
31  * handling is enabled.
32  *
33  * It is set when logging is initialized, and does not need to be set directly.
34  */
35 extern bool pcmk__is_daemon;
36 
37 // Number of elements in a statically defined array
38 #define PCMK__NELEM(a) ((int) (sizeof(a)/sizeof(a[0])) )
39 
40 // Internal ACL-related utilities (from acl.c)
41 
42 char *pcmk__uid2username(uid_t uid);
43 const char *pcmk__update_acl_user(xmlNode *request, const char *field,
44  const char *peer_user);
45 
46 static inline bool
47 pcmk__is_privileged(const char *user)
48 {
49  return user && (!strcmp(user, CRM_DAEMON_USER) || !strcmp(user, "root"));
50 }
51 
52 #if SUPPORT_CIBSECRETS
53 // Internal CIB utilities (from cib_secrets.c) */
54 
55 int pcmk__substitute_secrets(const char *rsc_id, GHashTable *params);
56 #endif
57 
58 
59 /* internal digest-related utilities (from digest.c) */
60 
61 bool pcmk__verify_digest(xmlNode *input, const char *expected);
62 
63 
64 /* internal I/O utilities (from io.c) */
65 
66 int pcmk__real_path(const char *path, char **resolved_path);
67 
68 char *pcmk__series_filename(const char *directory, const char *series,
69  int sequence, bool bzip);
70 int pcmk__read_series_sequence(const char *directory, const char *series,
71  unsigned int *seq);
72 void pcmk__write_series_sequence(const char *directory, const char *series,
73  unsigned int sequence, int max);
74 int pcmk__chown_series_sequence(const char *directory, const char *series,
75  uid_t uid, gid_t gid);
76 
77 int pcmk__build_path(const char *path_c, mode_t mode);
78 bool pcmk__daemon_can_write(const char *dir, const char *file);
79 void pcmk__sync_directory(const char *name);
80 
81 int pcmk__file_contents(const char *filename, char **contents);
82 int pcmk__write_sync(int fd, const char *contents);
83 int pcmk__set_nonblocking(int fd);
84 const char *pcmk__get_tmpdir(void);
85 
86 void pcmk__close_fds_in_child(bool);
87 
97 static inline void
98 pcmk__open_devnull(int flags)
99 {
100  // Static analysis clutter
101  // cppcheck-suppress leakReturnValNotUsed
102  (void) open("/dev/null", flags);
103 }
104 
105 
106 /* internal main loop utilities (from mainloop.c) */
107 
108 int pcmk__add_mainloop_ipc(crm_ipc_t *ipc, int priority, void *userdata,
109  struct ipc_client_callbacks *callbacks,
110  mainloop_io_t **source);
112 
113 
114 /* internal messaging utilities (from messages.c) */
115 
116 const char *pcmk__message_name(const char *name);
117 
118 
119 /* internal name/value utilities (from nvpair.c) */
120 
121 int pcmk__scan_nvpair(const char *input, char **name, char **value);
122 char *pcmk__format_nvpair(const char *name, const char *value,
123  const char *units);
124 char *pcmk__format_named_time(const char *name, time_t epoch_time);
125 
126 
127 /* internal procfs utilities (from procfs.c) */
128 
129 pid_t pcmk__procfs_pid_of(const char *name);
130 unsigned int pcmk__procfs_num_cores(void);
131 
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 
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 
177 
178 // bitwise arithmetic utilities
179 
195 static inline uint64_t
196 pcmk__set_flags_as(const char *function, int line, uint8_t log_level,
197  const char *flag_type, const char *target,
198  uint64_t flag_group, uint64_t flags, const char *flags_str)
199 {
200  uint64_t result = flag_group | flags;
201 
202  if (result != flag_group) {
203  do_crm_log_unlikely(log_level,
204  "%s flags 0x%.8llx (%s) for %s set by %s:%d",
205  ((flag_type == NULL)? "Group of" : flag_type),
206  (unsigned long long) flags,
207  ((flags_str == NULL)? "flags" : flags_str),
208  ((target == NULL)? "target" : target),
209  function, line);
210  }
211  return result;
212 }
213 
229 static inline uint64_t
230 pcmk__clear_flags_as(const char *function, int line, uint8_t log_level,
231  const char *flag_type, const char *target,
232  uint64_t flag_group, uint64_t flags, const char *flags_str)
233 {
234  uint64_t result = flag_group & ~flags;
235 
236  if (result != flag_group) {
237  do_crm_log_unlikely(log_level,
238  "%s flags 0x%.8llx (%s) for %s cleared by %s:%d",
239  ((flag_type == NULL)? "Group of" : flag_type),
240  (unsigned long long) flags,
241  ((flags_str == NULL)? "flags" : flags_str),
242  ((target == NULL)? "target" : target),
243  function, line);
244  }
245  return result;
246 }
247 
248 // miscellaneous utilities (from utils.c)
249 
250 void pcmk__daemonize(const char *name, const char *pidfile);
251 void pcmk__panic(const char *origin);
252 pid_t pcmk__locate_sbd(void);
253 void pcmk__sleep_ms(unsigned int ms);
254 
255 extern int pcmk__score_red;
256 extern int pcmk__score_green;
257 extern int pcmk__score_yellow;
258 
271 static inline void *
272 pcmk__realloc(void *ptr, size_t size)
273 {
274  void *new_ptr;
275 
276  // realloc(p, 0) can replace free(p) but this wrapper can't
277  CRM_ASSERT(size > 0);
278 
279  new_ptr = realloc(ptr, size);
280  if (new_ptr == NULL) {
281  free(ptr);
282  abort();
283  }
284  return new_ptr;
285 }
286 
287 
288 /* Error domains for use with g_set_error (from results.c) */
289 
290 GQuark pcmk__rc_error_quark(void);
291 GQuark pcmk__exitc_error_quark(void);
292 
293 #define PCMK__RC_ERROR pcmk__rc_error_quark()
294 #define PCMK__EXITC_ERROR pcmk__exitc_error_quark()
295 
296 static inline char *
297 pcmk__getpid_s(void)
298 {
299  return crm_strdup_printf("%lu", (unsigned long) getpid());
300 }
301 
302 // More efficient than g_list_length(list) == 1
303 static inline bool
304 pcmk__list_of_1(GList *list)
305 {
306  return list && (list->next == NULL);
307 }
308 
309 // More efficient than g_list_length(list) > 1
310 static inline bool
311 pcmk__list_of_multiple(GList *list)
312 {
313  return list && (list->next != NULL);
314 }
315 
316 /* convenience functions for failure-related node attributes */
317 
318 #define PCMK__FAIL_COUNT_PREFIX "fail-count"
319 #define PCMK__LAST_FAILURE_PREFIX "last-failure"
320 
338 static inline char *
339 pcmk__fail_attr_name(const char *prefix, const char *rsc_id, const char *op,
340  guint interval_ms)
341 {
342  CRM_CHECK(prefix && rsc_id && op, return NULL);
343  return crm_strdup_printf("%s-%s#%s_%u", prefix, rsc_id, op, interval_ms);
344 }
345 
346 static inline char *
347 pcmk__failcount_name(const char *rsc_id, const char *op, guint interval_ms)
348 {
349  return pcmk__fail_attr_name(PCMK__FAIL_COUNT_PREFIX, rsc_id, op,
350  interval_ms);
351 }
352 
353 static inline char *
354 pcmk__lastfailure_name(const char *rsc_id, const char *op, guint interval_ms)
355 {
356  return pcmk__fail_attr_name(PCMK__LAST_FAILURE_PREFIX, rsc_id, op,
357  interval_ms);
358 }
359 
360 // internal resource agent functions (from agents.c)
361 int pcmk__effective_rc(int rc);
362 
363 #endif /* CRM_COMMON_INTERNAL__H */
#define CRM_CHECK(expr, failure_action)
Definition: logging.h:218
const char * pcmk__message_name(const char *name)
Get name to be used as identifier for cluster messages.
Definition: messages.c:182
guint pcmk__mainloop_timer_get_period(mainloop_timer_t *timer)
Get period for mainloop timer.
Definition: mainloop.c:926
uint32_t size
Definition: cpg.c:49
void crm_schema_init(void)
Definition: schemas.c:379
int pcmk__read_pidfile(const char *filename, pid_t *pid)
Definition: pid.c:123
int pcmk__read_series_sequence(const char *directory, const char *series, unsigned int *seq)
Definition: io.c:140
int pcmk__write_sync(int fd, const char *contents)
Definition: io.c:487
int pcmk__substitute_secrets(const char *rsc_id, GHashTable *params)
Definition: cib_secrets.c:96
struct mainloop_timer_s mainloop_timer_t
Definition: mainloop.h:34
bool pcmk__verify_digest(xmlNode *input, const char *expected)
Definition: digest.c:220
struct mainloop_io_s mainloop_io_t
Definition: mainloop.h:32
void pcmk__close_fds_in_child(bool)
Definition: io.c:558
void crm_schema_cleanup(void)
Definition: schemas.c:554
void pcmk__filter_op_for_digest(xmlNode *param_set)
Definition: operations.c:390
char * pcmk__format_named_time(const char *name, time_t epoch_time)
Definition: nvpair.c:304
GQuark pcmk__exitc_error_quark(void)
char * pcmk__series_filename(const char *directory, const char *series, int sequence, bool bzip)
Definition: io.c:121
Wrappers for and extensions to glib mainloop.
#define PCMK__LAST_FAILURE_PREFIX
Definition: internal.h:319
Wrappers for and extensions to libqb logging.
int pcmk__effective_rc(int rc)
Definition: agents.c:71
char * pcmk__format_nvpair(const char *name, const char *value, const char *units)
Definition: nvpair.c:285
#define do_crm_log_unlikely(level, fmt, args...)
Log a message that is likely to be filtered out.
Definition: logging.h:183
int daemon(int nochdir, int noclose)
char * pcmk__notify_key(const char *rsc_id, const char *notify_type, const char *op_type)
Definition: operations.c:229
void pcmk__sleep_ms(unsigned int ms)
Definition: utils.c:603
int rc
Definition: pcmk_fence.c:35
uint32_t pid
Definition: cpg.c:46
struct crm_ipc_s crm_ipc_t
Definition: ipc.h:162
Utility functions.
int pcmk__real_path(const char *path, char **resolved_path)
Definition: io.c:85
unsigned int pcmk__procfs_num_cores(void)
Definition: procfs.c:145
const char * pcmk__update_acl_user(xmlNode *request, const char *field, const char *peer_user)
Definition: acl.c:716
char * crm_strdup_printf(char const *format,...) G_GNUC_PRINTF(1
int pcmk__scan_nvpair(const char *input, char **name, char **value)
Definition: nvpair.c:222
bool pcmk__daemon_can_write(const char *dir, const char *file)
Definition: io.c:327
bool pcmk__is_daemon
Definition: logging.c:47
#define PCMK__FAIL_COUNT_PREFIX
Definition: internal.h:318
int pcmk__pid_active(pid_t pid, const char *daemon)
Definition: pid.c:23
int pcmk__file_contents(const char *filename, char **contents)
Definition: io.c:431
#define CRM_DAEMON_USER
Definition: config.h:32
pid_t pcmk__locate_sbd(void)
Definition: watchdog.c:199
char * pcmk__op_key(const char *rsc_id, const char *op_type, guint interval_ms)
Generate an operation key (RESOURCE_ACTION_INTERVAL)
Definition: operations.c:45
void pcmk__write_series_sequence(const char *directory, const char *series, unsigned int sequence, int max)
Definition: io.c:187
pid_t pcmk__procfs_pid_of(const char *name)
Definition: procfs.c:111
const char * target
Definition: pcmk_fence.c:29
int pcmk__score_green
Definition: utils.c:57
void pcmk__daemonize(const char *name, const char *pidfile)
Definition: utils.c:464
int pcmk__lock_pidfile(const char *filename, const char *name)
Definition: pid.c:219
int pcmk__score_red
Definition: utils.c:56
#define CRM_ASSERT(expr)
Definition: results.h:42
const char * pcmk__get_tmpdir(void)
Definition: io.c:540
int pcmk__score_yellow
Definition: utils.c:58
int pcmk__pidfile_matches(const char *filename, pid_t expected_pid, const char *expected_name, pid_t *pid)
Definition: pid.c:177
char * pcmk__transition_key(int transition_id, int action_id, int target_rc, const char *node)
Definition: operations.c:296
int pcmk__chown_series_sequence(const char *directory, const char *series, uid_t uid, gid_t gid)
Definition: io.c:237
void pcmk__sync_directory(const char *name)
Definition: io.c:395
void pcmk__panic(const char *origin)
Definition: watchdog.c:162
char * pcmk__uid2username(uid_t uid)
Definition: acl.c:686
int pcmk__add_mainloop_ipc(crm_ipc_t *ipc, int priority, void *userdata, struct ipc_client_callbacks *callbacks, mainloop_io_t **source)
Connect to IPC and add it as a main loop source.
Definition: mainloop.c:893
char * name
Definition: pcmk_fence.c:31
GQuark pcmk__rc_error_quark(void)
uint64_t flags
Definition: remote.c:149
int pcmk__build_path(const char *path_c, mode_t mode)
Definition: io.c:45
int pcmk__set_nonblocking(int fd)
Definition: io.c:517