pacemaker  2.1.1-52dc28db4
Scalable High-Availability cluster resource manager
agents.c
Go to the documentation of this file.
1 /*
2  * Copyright 2004-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 #include <crm_internal.h>
11 
12 #ifndef _GNU_SOURCE
13 # define _GNU_SOURCE
14 #endif
15 
16 #include <stdio.h>
17 #include <string.h>
18 #include <strings.h>
19 
20 #include <crm/crm.h>
21 #include <crm/common/util.h>
22 
30 uint32_t
31 pcmk_get_ra_caps(const char *standard)
32 {
33  /* @COMPAT This should probably be case-sensitive, but isn't,
34  * for backward compatibility.
35  */
36  if (standard == NULL) {
37  return pcmk_ra_cap_none;
38 
39  } else if (!strcasecmp(standard, PCMK_RESOURCE_CLASS_OCF)) {
42 
43  } else if (!strcasecmp(standard, PCMK_RESOURCE_CLASS_STONITH)) {
44  /* @COMPAT Stonith resources can't really be unique clones, but we've
45  * allowed it in the past and have it in some scheduler regression tests
46  * (which were likely never used as real configurations).
47  *
48  * @TODO Remove pcmk_ra_cap_unique at the next major schema version
49  * bump, with a transform to remove globally-unique from the config.
50  */
53 
54  } else if (!strcasecmp(standard, PCMK_RESOURCE_CLASS_SYSTEMD)
55  || !strcasecmp(standard, PCMK_RESOURCE_CLASS_SERVICE)
56  || !strcasecmp(standard, PCMK_RESOURCE_CLASS_LSB)
57  || !strcasecmp(standard, PCMK_RESOURCE_CLASS_UPSTART)) {
58 
59  /* Since service can map to LSB, systemd, or upstart, these should
60  * have identical capabilities
61  */
62  return pcmk_ra_cap_status;
63 
64  } else if (!strcasecmp(standard, PCMK_RESOURCE_CLASS_NAGIOS)) {
65  return pcmk_ra_cap_params;
66  }
67  return pcmk_ra_cap_none;
68 }
69 
70 int
72 {
73  int remapped_rc = rc;
74 
75  switch (rc) {
76  case PCMK_OCF_DEGRADED:
77  remapped_rc = PCMK_OCF_OK;
78  break;
79 
81  remapped_rc = PCMK_OCF_RUNNING_PROMOTED;
82  break;
83 
84  default:
85  break;
86  }
87 
88  return remapped_rc;
89 }
90 
91 char *
92 crm_generate_ra_key(const char *standard, const char *provider,
93  const char *type)
94 {
95  if (!standard && !provider && !type) {
96  return NULL;
97  }
98 
99  return crm_strdup_printf("%s%s%s:%s",
100  (standard? standard : ""),
101  (provider? ":" : ""), (provider? provider : ""),
102  (type? type : ""));
103 }
104 
119 int
120 crm_parse_agent_spec(const char *spec, char **standard, char **provider,
121  char **type)
122 {
123  char *colon;
124 
125  CRM_CHECK(spec && standard && provider && type, return -EINVAL);
126  *standard = NULL;
127  *provider = NULL;
128  *type = NULL;
129 
130  colon = strchr(spec, ':');
131  if ((colon == NULL) || (colon == spec)) {
132  return -EINVAL;
133  }
134 
135  *standard = strndup(spec, colon - spec);
136  spec = colon + 1;
137 
139  colon = strchr(spec, ':');
140  if ((colon == NULL) || (colon == spec)) {
141  free(*standard);
142  return -EINVAL;
143  }
144  *provider = strndup(spec, colon - spec);
145  spec = colon + 1;
146  }
147 
148  if (*spec == '\0') {
149  free(*standard);
150  free(*provider);
151  return -EINVAL;
152  }
153 
154  *type = strdup(spec);
155  return pcmk_ok;
156 }
157 
169 bool
170 pcmk_stonith_param(const char *param)
171 {
172  if (param == NULL) {
173  return false;
174  }
177  return true;
178  }
179  if (!pcmk__starts_with(param, "pcmk_")) { // Short-circuit common case
180  return false;
181  }
182  if (pcmk__str_any_of(param,
190  NULL)) {
191  return true;
192  }
193  param = strchr(param + 5, '_'); // Skip past "pcmk_ACTION"
194  return pcmk__str_any_of(param, "_action", "_timeout", "_retries", NULL);
195 }
196 
197 // Deprecated functions kept only for backward API compatibility
198 
200 
201 bool
202 crm_provider_required(const char *standard)
203 {
205 }
206 
207 // End deprecated API
#define CRM_CHECK(expr, failure_action)
Definition: logging.h:218
A dumping ground.
#define PCMK_STONITH_HOST_CHECK
Definition: agents.h:33
#define PCMK_STONITH_PROVIDES
Definition: agents.h:36
#define PCMK_STONITH_HOST_MAP
Definition: agents.h:35
#define PCMK_RESOURCE_CLASS_SYSTEMD
Definition: services.h:46
#define PCMK_STONITH_STONITH_TIMEOUT
Definition: agents.h:37
#define PCMK_STONITH_HOST_LIST
Definition: agents.h:34
enum crm_ais_msg_types type
Definition: cpg.c:48
bool pcmk_stonith_param(const char *param)
Check whether a given stonith parameter is handled by Pacemaker.
Definition: agents.c:170
char * strndup(const char *str, size_t len)
#define PCMK_RESOURCE_CLASS_OCF
Definition: services.h:43
int rc
Definition: pcmk_fence.c:35
Utility functions.
#define PCMK_RESOURCE_CLASS_SERVICE
Definition: services.h:44
char * crm_strdup_printf(char const *format,...) G_GNUC_PRINTF(1
#define pcmk_is_set(g, f)
Convenience alias for pcmk_all_flags_set(), to check single flag.
Definition: util.h:114
bool pcmk__str_any_of(const char *s,...) G_GNUC_NULL_TERMINATED
Definition: strings.c:979
#define PCMK_STONITH_ACTION_LIMIT
Definition: agents.h:29
int crm_parse_agent_spec(const char *spec, char **standard, char **provider, char **type)
Parse a "standard[:provider]:type" agent specification.
Definition: agents.c:120
Deprecated Pacemaker resource agent API.
uint32_t pcmk_get_ra_caps(const char *standard)
Get capabilities of a resource agent standard.
Definition: agents.c:31
#define PCMK_RESOURCE_CLASS_STONITH
Definition: services.h:49
bool crm_provider_required(const char *standard)
Definition: agents.c:202
#define PCMK_STONITH_HOST_ARGUMENT
Definition: agents.h:32
#define PCMK_RESOURCE_CLASS_NAGIOS
Definition: services.h:48
#define PCMK_RESOURCE_CLASS_LSB
Definition: services.h:45
#define PCMK_RESOURCE_CLASS_UPSTART
Definition: services.h:47
#define PCMK_STONITH_DELAY_BASE
Definition: agents.h:30
#define pcmk_ok
Definition: results.h:67
bool pcmk__starts_with(const char *str, const char *prefix)
Check whether a string starts with a certain sequence.
Definition: strings.c:483
char * crm_generate_ra_key(const char *standard, const char *provider, const char *type)
Definition: agents.c:92
#define PCMK_STONITH_DELAY_MAX
Definition: agents.h:31
int pcmk__effective_rc(int rc)
Definition: agents.c:71