pacemaker  2.0.2-debe490
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-2019 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  * For system error codes, see:
53  * - /usr/include/asm-generic/errno.h
54  * - /usr/include/asm-generic/errno-base.h
55  */
56 
57 # define pcmk_ok 0
58 # define PCMK_ERROR_OFFSET 190 /* Replacements on non-linux systems, see include/portability.h */
59 # define PCMK_CUSTOM_OFFSET 200 /* Purely custom codes */
60 # define pcmk_err_generic 201
61 # define pcmk_err_no_quorum 202
62 # define pcmk_err_schema_validation 203
63 # define pcmk_err_transform_failed 204
64 # define pcmk_err_old_data 205
65 # define pcmk_err_diff_failed 206
66 # define pcmk_err_diff_resync 207
67 # define pcmk_err_cib_modified 208
68 # define pcmk_err_cib_backup 209
69 # define pcmk_err_cib_save 210
70 # define pcmk_err_schema_unchanged 211
71 # define pcmk_err_cib_corrupt 212
72 # define pcmk_err_multiple 213
73 # define pcmk_err_node_unknown 214
74 # define pcmk_err_already 215
75 # define pcmk_err_bad_nvpair 216
76 # define pcmk_err_unknown_format 217
77 
78 /*
79  * Exit status codes
80  *
81  * We want well-specified (i.e. OS-invariant) exit status codes for our daemons
82  * and applications so they can be relied on by callers. (Function return codes
83  * and errno's do not make good exit statuses.)
84  *
85  * The only hard rule is that exit statuses must be between 0 and 255; all else
86  * is convention. Universally, 0 is success, and 1 is generic error (excluding
87  * OSes we don't support -- for example, OpenVMS considers 1 success!).
88  *
89  * For init scripts, the LSB gives meaning to 0-7, and sets aside 150-199 for
90  * application use. OCF adds 8-9 and 189-199.
91  *
92  * sysexits.h was an attempt to give additional meanings, but never really
93  * caught on. It uses 0 and 64-78.
94  *
95  * Bash reserves 2 ("incorrect builtin usage") and 126-255 (126 is "command
96  * found but not executable", 127 is "command not found", 128 + n is
97  * "interrupted by signal n").
98  *
99  * tldp.org recommends 64-113 for application use.
100  *
101  * We try to overlap with the above conventions when practical.
102  */
103 typedef enum crm_exit_e {
104  // Common convention
107 
108  // LSB + OCF
115 
116  // sysexits.h
117  CRM_EX_USAGE = 64, // command line usage error
118  CRM_EX_DATAERR = 65, // user-supplied data incorrect
119  CRM_EX_NOINPUT = 66, // input file not available
120  CRM_EX_NOUSER = 67, // user does not exist
121  CRM_EX_NOHOST = 68, // host unknown
122  CRM_EX_UNAVAILABLE = 69, // needed service unavailable
123  CRM_EX_SOFTWARE = 70, // internal software bug
124  CRM_EX_OSERR = 71, // external (OS/environmental) problem
125  CRM_EX_OSFILE = 72, // system file not usable
126  CRM_EX_CANTCREAT = 73, // file couldn't be created
127  CRM_EX_IOERR = 74, // file I/O error
128  CRM_EX_TEMPFAIL = 75, // try again
129  CRM_EX_PROTOCOL = 76, // protocol violated
130  CRM_EX_NOPERM = 77, // non-file permission issue
131  CRM_EX_CONFIG = 78, // misconfiguration
132 
133  // Custom
134  CRM_EX_FATAL = 100, // do not respawn
135  CRM_EX_PANIC = 101, // panic the local host
136  CRM_EX_DISCONNECT = 102, // lost connection to something
137  CRM_EX_OLD = 103, // update older than existing config
138  CRM_EX_DIGEST = 104, // digest comparison failed
139  CRM_EX_NOSUCH = 105, // requested item does not exist
140  CRM_EX_QUORUM = 106, // local partition does not have quorum
141  CRM_EX_UNSAFE = 107, // requires --force or new conditions
142  CRM_EX_EXISTS = 108, // requested item already exists
143  CRM_EX_MULTIPLE = 109, // requested item has multiple matches
144  CRM_EX_EXPIRED = 110, // requested item has expired
145  CRM_EX_NOT_YET_IN_EFFECT = 111, // requested item is not in effect
146  CRM_EX_INDETERMINATE = 112, // could not determine status
147 
148  // Other
149  CRM_EX_TIMEOUT = 124, // convention from timeout(1)
150  CRM_EX_MAX = 255, // ensure crm_exit_t can hold this
151 } crm_exit_t;
152 
153 const char *pcmk_strerror(int rc);
154 const char *pcmk_errorname(int rc);
155 const char *bz2_strerror(int rc);
156 crm_exit_t crm_errno2exit(int rc);
157 const char *crm_exit_name(crm_exit_t exit_code);
158 const char *crm_exit_str(crm_exit_t exit_code);
160 
161 #ifdef __cplusplus
162 }
163 #endif
164 
165 #endif
const char * pcmk_errorname(int rc)
Definition: results.c:26
crm_exit_t crm_errno2exit(int rc)
Map an errno to a similar exit status.
Definition: results.c:362
const char * pcmk_strerror(int rc)
Definition: results.c:188
const char * bz2_strerror(int rc)
Definition: results.c:443
_Noreturn crm_exit_t crm_exit(crm_exit_t rc)
Definition: results.c:476
enum crm_exit_e crm_exit_t
const char * crm_exit_str(crm_exit_t exit_code)
Definition: results.c:306
#define _Noreturn
Definition: results.h:38
crm_exit_e
Definition: results.h:103
const char * crm_exit_name(crm_exit_t exit_code)
Definition: results.c:260