pacemaker  2.0.4-2deceaa
Scalable High-Availability cluster resource manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
results.h
Go to the documentation of this file.
1 /*
2  * Copyright 2012-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 #ifndef CRM_RESULTS__H
10 # define CRM_RESULTS__H
11 
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15 
22 // Lifted from config.h
23 /* The _Noreturn keyword of C11. */
24 #ifndef _Noreturn
25 # if (defined __cplusplus \
26  && ((201103 <= __cplusplus && !(__GNUC__ == 4 && __GNUC_MINOR__ == 7)) \
27  || (defined _MSC_VER && 1900 <= _MSC_VER)))
28 # define _Noreturn [[noreturn]]
29 # elif ((!defined __cplusplus || defined __clang__) \
30  && (201112 <= (defined __STDC_VERSION__ ? __STDC_VERSION__ : 0) \
31  || 4 < __GNUC__ + (7 <= __GNUC_MINOR__)))
32  /* _Noreturn works as-is. */
33 # elif 2 < __GNUC__ + (8 <= __GNUC_MINOR__) || 0x5110 <= __SUNPRO_C
34 # define _Noreturn __attribute__ ((__noreturn__))
35 # elif 1200 <= (defined _MSC_VER ? _MSC_VER : 0)
36 # define _Noreturn __declspec (noreturn)
37 # else
38 # define _Noreturn
39 # endif
40 #endif
41 
42 # define CRM_ASSERT(expr) do { \
43  if(__unlikely((expr) == FALSE)) { \
44  crm_abort(__FILE__, __FUNCTION__, __LINE__, #expr, TRUE, FALSE); \
45  abort(); /* Redundant but it makes static analyzers happy */ \
46  } \
47  } while(0)
48 
49 /*
50  * Function return codes
51  *
52  * Most Pacemaker API functions return an integer return code. There are two
53  * alternative interpretations. The legacy interpration is that the absolute
54  * value of the return code is either a system error number or a custom
55  * pcmk_err_* number. This is less than ideal because system error numbers are
56  * constrained only to the positive int range, so there's the possibility
57  * (though not noticed in the wild) that system errors and custom errors could
58  * collide. The new intepretation is that negative values are from the pcmk_rc_e
59  * enum, and positive values are system error numbers. Both use 0 for success.
60  *
61  * For system error codes, see:
62  * - /usr/include/asm-generic/errno.h
63  * - /usr/include/asm-generic/errno-base.h
64  */
65 
66 // Legacy custom return codes for Pacemaker API functions (deprecated)
67 # define pcmk_ok 0
68 # define PCMK_ERROR_OFFSET 190 /* Replacements on non-linux systems, see include/portability.h */
69 # define PCMK_CUSTOM_OFFSET 200 /* Purely custom codes */
70 # define pcmk_err_generic 201
71 # define pcmk_err_no_quorum 202
72 # define pcmk_err_schema_validation 203
73 # define pcmk_err_transform_failed 204
74 # define pcmk_err_old_data 205
75 # define pcmk_err_diff_failed 206
76 # define pcmk_err_diff_resync 207
77 # define pcmk_err_cib_modified 208
78 # define pcmk_err_cib_backup 209
79 # define pcmk_err_cib_save 210
80 # define pcmk_err_schema_unchanged 211
81 # define pcmk_err_cib_corrupt 212
82 # define pcmk_err_multiple 213
83 # define pcmk_err_node_unknown 214
84 # define pcmk_err_already 215
85 /* On HPPA 215 is ENOSYM (Unknown error 215), which hopefully never happens. */
86 #ifdef __hppa__
87 # define pcmk_err_bad_nvpair 250 /* 216 is ENOTSOCK */
88 # define pcmk_err_unknown_format 252 /* 217 is EDESTADDRREQ */
89 #else
90 # define pcmk_err_bad_nvpair 216
91 # define pcmk_err_unknown_format 217
92 #endif
93 
106 enum pcmk_rc_e {
107  /* When adding new values, use consecutively lower numbers, update the array
108  * in lib/common/results.c, and test with crm_error.
109  */
136  // Developers: Use a more specific code than pcmk_rc_error whenever possible
137  pcmk_rc_error = -1001,
138 
139  // Values -1 through -1000 reserved for caller use
140 
142 
143  // Positive values reserved for system error numbers
144 };
145 
146 /*
147  * Exit status codes
148  *
149  * We want well-specified (i.e. OS-invariant) exit status codes for our daemons
150  * and applications so they can be relied on by callers. (Function return codes
151  * and errno's do not make good exit statuses.)
152  *
153  * The only hard rule is that exit statuses must be between 0 and 255; all else
154  * is convention. Universally, 0 is success, and 1 is generic error (excluding
155  * OSes we don't support -- for example, OpenVMS considers 1 success!).
156  *
157  * For init scripts, the LSB gives meaning to 0-7, and sets aside 150-199 for
158  * application use. OCF adds 8-9 and 189-199.
159  *
160  * sysexits.h was an attempt to give additional meanings, but never really
161  * caught on. It uses 0 and 64-78.
162  *
163  * Bash reserves 2 ("incorrect builtin usage") and 126-255 (126 is "command
164  * found but not executable", 127 is "command not found", 128 + n is
165  * "interrupted by signal n").
166  *
167  * tldp.org recommends 64-113 for application use.
168  *
169  * We try to overlap with the above conventions when practical.
170  */
171 typedef enum crm_exit_e {
172  // Common convention
175 
176  // LSB + OCF
183 
184  // sysexits.h
185  CRM_EX_USAGE = 64, // command line usage error
186  CRM_EX_DATAERR = 65, // user-supplied data incorrect
187  CRM_EX_NOINPUT = 66, // input file not available
188  CRM_EX_NOUSER = 67, // user does not exist
189  CRM_EX_NOHOST = 68, // host unknown
190  CRM_EX_UNAVAILABLE = 69, // needed service unavailable
191  CRM_EX_SOFTWARE = 70, // internal software bug
192  CRM_EX_OSERR = 71, // external (OS/environmental) problem
193  CRM_EX_OSFILE = 72, // system file not usable
194  CRM_EX_CANTCREAT = 73, // file couldn't be created
195  CRM_EX_IOERR = 74, // file I/O error
196  CRM_EX_TEMPFAIL = 75, // try again
197  CRM_EX_PROTOCOL = 76, // protocol violated
198  CRM_EX_NOPERM = 77, // non-file permission issue
199  CRM_EX_CONFIG = 78, // misconfiguration
200 
201  // Custom
202  CRM_EX_FATAL = 100, // do not respawn
203  CRM_EX_PANIC = 101, // panic the local host
204  CRM_EX_DISCONNECT = 102, // lost connection to something
205  CRM_EX_OLD = 103, // update older than existing config
206  CRM_EX_DIGEST = 104, // digest comparison failed
207  CRM_EX_NOSUCH = 105, // requested item does not exist
208  CRM_EX_QUORUM = 106, // local partition does not have quorum
209  CRM_EX_UNSAFE = 107, // requires --force or new conditions
210  CRM_EX_EXISTS = 108, // requested item already exists
211  CRM_EX_MULTIPLE = 109, // requested item has multiple matches
212  CRM_EX_EXPIRED = 110, // requested item has expired
213  CRM_EX_NOT_YET_IN_EFFECT = 111, // requested item is not in effect
214  CRM_EX_INDETERMINATE = 112, // could not determine status
215  CRM_EX_UNSATISFIED = 113, // requested item does not satisfy constraints
216 
217  // Other
218  CRM_EX_TIMEOUT = 124, // convention from timeout(1)
219  CRM_EX_MAX = 255, // ensure crm_exit_t can hold this
220 } crm_exit_t;
221 
222 const char *pcmk_rc_name(int rc);
223 const char *pcmk_rc_str(int rc);
225 int pcmk_rc2legacy(int rc);
226 int pcmk_legacy2rc(int legacy_rc);
227 const char *pcmk_strerror(int rc);
228 const char *pcmk_errorname(int rc);
229 const char *bz2_strerror(int rc);
231 const char *crm_exit_name(crm_exit_t exit_code);
232 const char *crm_exit_str(crm_exit_t exit_code);
234 
235 #ifdef __cplusplus
236 }
237 #endif
238 
239 #endif
const char * pcmk_errorname(int rc)
Definition: results.c:29
crm_exit_t crm_errno2exit(int rc)
Definition: results.c:570
const char * pcmk_strerror(int rc)
Definition: results.c:55
const char * bz2_strerror(int rc)
Definition: results.c:718
int pcmk_rc2legacy(int rc)
Definition: results.c:430
_Noreturn crm_exit_t crm_exit(crm_exit_t rc)
Definition: results.c:751
crm_exit_t pcmk_rc2exitc(int rc)
Map a function return code to the most similar exit code.
Definition: results.c:613
enum crm_exit_e crm_exit_t
const char * pcmk_rc_str(int rc)
Get a user-friendly description of a return code.
Definition: results.c:413
pcmk_rc_e
Return codes for Pacemaker API functions.
Definition: results.h:106
const char * crm_exit_str(crm_exit_t exit_code)
Definition: results.c:519
int rc
Definition: pcmk_fence.c:34
int pcmk_legacy2rc(int legacy_rc)
Definition: results.c:443
const char * pcmk_rc_name(int rc)
Get a return code constant name as a string.
Definition: results.c:259
#define _Noreturn
Definition: results.h:38
crm_exit_e
Definition: results.h:171
const char * crm_exit_name(crm_exit_t exit_code)
Definition: results.c:472