root/include/crm/common/results.h

/* [previous][next][first][last][top][bottom][index][help] */

INCLUDED FROM


DEFINITIONS

This source file includes following definitions.
  1. pcmk_exec_status_str

   1 /*
   2  * Copyright 2012-2023 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 PCMK__CRM_COMMON_RESULTS__H
  10 #  define PCMK__CRM_COMMON_RESULTS__H
  11 
  12 #ifdef __cplusplus
  13 extern "C" {
  14 #endif
  15 
  16 /*!
  17  * \file
  18  * \brief Function and executable result codes
  19  * \ingroup core
  20  */
  21 
  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 (!(expr)) {                                                       \
  44             crm_abort(__FILE__, __func__, __LINE__, #expr, TRUE, FALSE);     \
  45             abort(); /* crm_abort() doesn't always abort! */                 \
  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 that
  57  * system errors and custom errors could collide (which did in fact happen
  58  * already on one architecture). The new intepretation is that negative values
  59  * are from the pcmk_rc_e enum, and positive values are system error numbers.
  60  * Both use 0 for success.
  61  *
  62  * For system error codes, see:
  63  * - /usr/include/asm-generic/errno.h
  64  * - /usr/include/asm-generic/errno-base.h
  65  */
  66 
  67 // Legacy custom return codes for Pacemaker API functions (deprecated)
  68 #  define pcmk_ok                       0
  69 #  define PCMK_ERROR_OFFSET             190    /* Replacements on non-linux systems, see include/portability.h */
  70 #  define PCMK_CUSTOM_OFFSET            200    /* Purely custom codes */
  71 #  define pcmk_err_generic              201
  72 #  define pcmk_err_no_quorum            202
  73 #  define pcmk_err_schema_validation    203
  74 #  define pcmk_err_transform_failed     204
  75 #  define pcmk_err_old_data             205
  76 #  define pcmk_err_diff_failed          206
  77 #  define pcmk_err_diff_resync          207
  78 #  define pcmk_err_cib_modified         208
  79 #  define pcmk_err_cib_backup           209
  80 #  define pcmk_err_cib_save             210
  81 #  define pcmk_err_schema_unchanged     211
  82 #  define pcmk_err_cib_corrupt          212
  83 #  define pcmk_err_multiple             213
  84 #  define pcmk_err_node_unknown         214
  85 #  define pcmk_err_already              215
  86 /* On HPPA 215 is ENOSYM (Unknown error 215), which hopefully never happens. */
  87 #ifdef __hppa__
  88 #  define pcmk_err_bad_nvpair           250 /* 216 is ENOTSOCK */
  89 #  define pcmk_err_unknown_format       252 /* 217 is EDESTADDRREQ */
  90 #else
  91 #  define pcmk_err_bad_nvpair           216
  92 #  define pcmk_err_unknown_format       217
  93 #endif
  94 
  95 /*!
  96  * \enum pcmk_rc_e
  97  * \brief Return codes for Pacemaker API functions
  98  *
  99  * Any Pacemaker API function documented as returning a "standard Pacemaker
 100  * return code" will return pcmk_rc_ok (0) on success, and one of this
 101  * enumeration's other (negative) values or a (positive) system error number
 102  * otherwise. The custom codes are at -1001 and lower, so that the caller may
 103  * use -1 through -1000 for their own custom values if desired. While generally
 104  * referred to as "errors", nonzero values simply indicate a result, which might
 105  * or might not be an error depending on the calling context.
 106  */
 107 enum pcmk_rc_e {
 108     /* When adding new values, use consecutively lower numbers, update the array
 109      * in lib/common/results.c, and test with crm_error.
 110      */
 111     pcmk_rc_bad_xml_patch       = -1036,
 112     pcmk_rc_bad_input           = -1035,
 113     pcmk_rc_disabled            = -1034,
 114     pcmk_rc_duplicate_id        = -1033,
 115     pcmk_rc_unpack_error        = -1032,
 116     pcmk_rc_invalid_transition  = -1031,
 117     pcmk_rc_graph_error         = -1030,
 118     pcmk_rc_dot_error           = -1029,
 119     pcmk_rc_underflow           = -1028,
 120     pcmk_rc_no_input            = -1027,
 121     pcmk_rc_no_output           = -1026,
 122     pcmk_rc_after_range         = -1025,
 123     pcmk_rc_within_range        = -1024,
 124     pcmk_rc_before_range        = -1023,
 125     pcmk_rc_undetermined        = -1022,
 126     pcmk_rc_op_unsatisfied      = -1021,
 127     pcmk_rc_ipc_pid_only        = -1020,
 128     pcmk_rc_ipc_unresponsive    = -1019,
 129     pcmk_rc_ipc_unauthorized    = -1018,
 130     pcmk_rc_no_quorum           = -1017,
 131     pcmk_rc_schema_validation   = -1016,
 132     pcmk_rc_schema_unchanged    = -1015,
 133     pcmk_rc_transform_failed    = -1014,
 134     pcmk_rc_old_data            = -1013,
 135     pcmk_rc_diff_failed         = -1012,
 136     pcmk_rc_diff_resync         = -1011,
 137     pcmk_rc_cib_modified        = -1010,
 138     pcmk_rc_cib_backup          = -1009,
 139     pcmk_rc_cib_save            = -1008,
 140     pcmk_rc_cib_corrupt         = -1007,
 141     pcmk_rc_multiple            = -1006,
 142     pcmk_rc_node_unknown        = -1005,
 143     pcmk_rc_already             = -1004,
 144     pcmk_rc_bad_nvpair          = -1003,
 145     pcmk_rc_unknown_format      = -1002,
 146     // Developers: Use a more specific code than pcmk_rc_error whenever possible
 147     pcmk_rc_error               = -1001,
 148 
 149     // Values -1 through -1000 reserved for caller use
 150 
 151     pcmk_rc_ok                  =     0
 152 
 153     // Positive values reserved for system error numbers
 154 };
 155 
 156 
 157 /*!
 158  * \enum ocf_exitcode
 159  * \brief Exit status codes for resource agents
 160  *
 161  * The OCF Resource Agent API standard enumerates the possible exit status codes
 162  * that agents should return. Besides being used with OCF agents, these values
 163  * are also used by the executor as a universal status for all agent standards;
 164  * actual results are mapped to these before returning them to clients.
 165  */
 166 enum ocf_exitcode {
 167     PCMK_OCF_OK                   = 0,   //!< Success
 168     PCMK_OCF_UNKNOWN_ERROR        = 1,   //!< Unspecified error
 169     PCMK_OCF_INVALID_PARAM        = 2,   //!< Parameter invalid (in local context)
 170     PCMK_OCF_UNIMPLEMENT_FEATURE  = 3,   //!< Requested action not implemented
 171     PCMK_OCF_INSUFFICIENT_PRIV    = 4,   //!< Insufficient privileges
 172     PCMK_OCF_NOT_INSTALLED        = 5,   //!< Dependencies not available locally
 173     PCMK_OCF_NOT_CONFIGURED       = 6,   //!< Parameter invalid (inherently)
 174     PCMK_OCF_NOT_RUNNING          = 7,   //!< Service safely stopped
 175     PCMK_OCF_RUNNING_PROMOTED     = 8,   //!< Service active and promoted
 176     PCMK_OCF_FAILED_PROMOTED      = 9,   //!< Service failed and possibly in promoted role
 177     PCMK_OCF_DEGRADED             = 190, //!< Service active but more likely to fail soon
 178     PCMK_OCF_DEGRADED_PROMOTED    = 191, //!< Service promoted but more likely to fail soon
 179 
 180     /* These two are Pacemaker extensions, not in the OCF standard. The
 181      * controller records PCMK_OCF_UNKNOWN for pending actions.
 182      * PCMK_OCF_CONNECTION_DIED is used only with older DCs that don't support
 183      * PCMK_EXEC_NOT_CONNECTED.
 184      */
 185     PCMK_OCF_CONNECTION_DIED      = 189, //!< \deprecated See PCMK_EXEC_NOT_CONNECTED
 186     PCMK_OCF_UNKNOWN              = 193, //!< Action is pending
 187 
 188 #if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
 189     // Former Pacemaker extensions
 190     PCMK_OCF_EXEC_ERROR           = 192, //!< \deprecated (Unused)
 191     PCMK_OCF_SIGNAL               = 194, //!< \deprecated (Unused)
 192     PCMK_OCF_NOT_SUPPORTED        = 195, //!< \deprecated (Unused)
 193     PCMK_OCF_PENDING              = 196, //!< \deprecated (Unused)
 194     PCMK_OCF_CANCELLED            = 197, //!< \deprecated (Unused)
 195     PCMK_OCF_TIMEOUT              = 198, //!< \deprecated (Unused)
 196     PCMK_OCF_OTHER_ERROR          = 199, //!< \deprecated (Unused)
 197 
 198     //! \deprecated Use PCMK_OCF_RUNNING_PROMOTED instead
 199     PCMK_OCF_RUNNING_MASTER     = PCMK_OCF_RUNNING_PROMOTED,
 200 
 201     //! \deprecated Use PCMK_OCF_FAILED_PROMOTED instead
 202     PCMK_OCF_FAILED_MASTER      = PCMK_OCF_FAILED_PROMOTED,
 203 
 204     //! \deprecated Use PCMK_OCF_DEGRADED_PROMOTED instead
 205     PCMK_OCF_DEGRADED_MASTER    = PCMK_OCF_DEGRADED_PROMOTED,
 206 #endif
 207 };
 208 
 209 /*!
 210  * \enum crm_exit_e
 211  * \brief Exit status codes for tools and daemons
 212  *
 213  * We want well-specified (i.e. OS-invariant) exit status codes for our daemons
 214  * and applications so they can be relied on by callers. (Function return codes
 215  * and errno's do not make good exit statuses.)
 216  *
 217  * The only hard rule is that exit statuses must be between 0 and 255; all else
 218  * is convention. Universally, 0 is success, and 1 is generic error (excluding
 219  * OSes we don't support -- for example, OpenVMS considers 1 success!).
 220  *
 221  * For init scripts, the LSB gives meaning to 0-7, and sets aside 150-199 for
 222  * application use. OCF adds 8-9 and 190-191.
 223  *
 224  * sysexits.h was an attempt to give additional meanings, but never really
 225  * caught on. It uses 0 and 64-78.
 226  *
 227  * Bash reserves 2 ("incorrect builtin usage") and 126-255 (126 is "command
 228  * found but not executable", 127 is "command not found", 128 + n is
 229  * "interrupted by signal n").
 230  *
 231  * tldp.org recommends 64-113 for application use.
 232  *
 233  * We try to overlap with the above conventions when practical.
 234  */
 235 typedef enum crm_exit_e {
 236     // Common convention
 237     CRM_EX_OK                   =   0, //!< Success
 238     CRM_EX_ERROR                =   1, //!< Unspecified error
 239 
 240     // LSB + OCF
 241     CRM_EX_INVALID_PARAM        =   2, //!< Parameter invalid (in local context)
 242     CRM_EX_UNIMPLEMENT_FEATURE  =   3, //!< Requested action not implemented
 243     CRM_EX_INSUFFICIENT_PRIV    =   4, //!< Insufficient privileges
 244     CRM_EX_NOT_INSTALLED        =   5, //!< Dependencies not available locally
 245     CRM_EX_NOT_CONFIGURED       =   6, //!< Parameter invalid (inherently)
 246     CRM_EX_NOT_RUNNING          =   7, //!< Service safely stopped
 247     CRM_EX_PROMOTED             =   8, //!< Service active and promoted
 248     CRM_EX_FAILED_PROMOTED      =   9, //!< Service failed and possibly promoted
 249 
 250     // sysexits.h
 251     CRM_EX_USAGE                =  64, //!< Command line usage error
 252     CRM_EX_DATAERR              =  65, //!< User-supplied data incorrect
 253     CRM_EX_NOINPUT              =  66, //!< Input file not available
 254     CRM_EX_NOUSER               =  67, //!< User does not exist
 255     CRM_EX_NOHOST               =  68, //!< Host unknown
 256     CRM_EX_UNAVAILABLE          =  69, //!< Needed service unavailable
 257     CRM_EX_SOFTWARE             =  70, //!< Internal software bug
 258     CRM_EX_OSERR                =  71, //!< External (OS/environmental) problem
 259     CRM_EX_OSFILE               =  72, //!< System file not usable
 260     CRM_EX_CANTCREAT            =  73, //!< File couldn't be created
 261     CRM_EX_IOERR                =  74, //!< File I/O error
 262     CRM_EX_TEMPFAIL             =  75, //!< Try again
 263     CRM_EX_PROTOCOL             =  76, //!< Protocol violated
 264     CRM_EX_NOPERM               =  77, //!< Non-file permission issue
 265     CRM_EX_CONFIG               =  78, //!< Misconfiguration
 266 
 267     // Custom
 268     CRM_EX_FATAL                = 100, //!< Do not respawn
 269     CRM_EX_PANIC                = 101, //!< Panic the local host
 270     CRM_EX_DISCONNECT           = 102, //!< Lost connection to something
 271     CRM_EX_OLD                  = 103, //!< Update older than existing config
 272     CRM_EX_DIGEST               = 104, //!< Digest comparison failed
 273     CRM_EX_NOSUCH               = 105, //!< Requested item does not exist
 274     CRM_EX_QUORUM               = 106, //!< Local partition does not have quorum
 275     CRM_EX_UNSAFE               = 107, //!< Requires --force or new conditions
 276     CRM_EX_EXISTS               = 108, //!< Requested item already exists
 277     CRM_EX_MULTIPLE             = 109, //!< Requested item has multiple matches
 278     CRM_EX_EXPIRED              = 110, //!< Requested item has expired
 279     CRM_EX_NOT_YET_IN_EFFECT    = 111, //!< Requested item is not in effect
 280     CRM_EX_INDETERMINATE        = 112, //!< Could not determine status
 281     CRM_EX_UNSATISFIED          = 113, //!< Requested item does not satisfy constraints
 282 
 283     // Other
 284     CRM_EX_TIMEOUT              = 124, //!< Convention from timeout(1)
 285 
 286     /* Anything above 128 overlaps with some shells' use of these values for
 287      * "interrupted by signal N", and so may be unreliable when detected by
 288      * shell scripts.
 289      */
 290 
 291     // OCF Resource Agent API 1.1
 292     CRM_EX_DEGRADED             = 190, //!< Service active but more likely to fail soon
 293     CRM_EX_DEGRADED_PROMOTED    = 191, //!< Service promoted but more likely to fail soon
 294 
 295     /* Custom
 296      *
 297      * This can be used to initialize exit status variables or to indicate that
 298      * a command is pending (which is what the controller uses it for).
 299      */
 300     CRM_EX_NONE                 = 193, //!< No exit status available
 301 
 302     CRM_EX_MAX                  = 255, //!< Ensure crm_exit_t can hold this
 303 } crm_exit_t;
 304 
 305 /*!
 306  * \enum pcmk_exec_status
 307  * \brief Execution status
 308  *
 309  * These codes are used to specify the result of the attempt to execute an
 310  * agent, rather than the agent's result itself.
 311  */
 312 enum pcmk_exec_status {
 313     PCMK_EXEC_UNKNOWN = -2,     //!< Used only to initialize variables
 314     PCMK_EXEC_PENDING = -1,     //!< Action is in progress
 315     PCMK_EXEC_DONE,             //!< Action completed, result is known
 316     PCMK_EXEC_CANCELLED,        //!< Action was cancelled
 317     PCMK_EXEC_TIMEOUT,          //!< Action did not complete in time
 318     PCMK_EXEC_NOT_SUPPORTED,    //!< Agent does not implement requested action
 319     PCMK_EXEC_ERROR,            //!< Execution failed, may be retried
 320     PCMK_EXEC_ERROR_HARD,       //!< Execution failed, do not retry on node
 321     PCMK_EXEC_ERROR_FATAL,      //!< Execution failed, do not retry anywhere
 322     PCMK_EXEC_NOT_INSTALLED,    //!< Agent or dependency not available locally
 323     PCMK_EXEC_NOT_CONNECTED,    //!< No connection to executor
 324     PCMK_EXEC_INVALID,          //!< Action cannot be attempted (e.g. shutdown)
 325     PCMK_EXEC_NO_FENCE_DEVICE,  //!< No fence device is configured for target
 326     PCMK_EXEC_NO_SECRETS,       //!< Necessary CIB secrets are unavailable
 327 
 328     // Add new values above here then update this one below
 329     PCMK_EXEC_MAX = PCMK_EXEC_NO_SECRETS, //!< Maximum value for this enum
 330 };
 331 
 332 /*!
 333  * \enum pcmk_result_type
 334  * \brief Types of Pacemaker result codes
 335  *
 336  * A particular integer can have different meanings within different Pacemaker
 337  * result code families. It may be interpretable within zero, one, or multiple
 338  * families.
 339  *
 340  * These values are useful for specifying how an integer result code should be
 341  * interpreted in situations involving a generic integer value. For example, a
 342  * function that can process multiple types of result codes might accept an
 343  * arbitrary integer argument along with a \p pcmk_result_type argument that
 344  * specifies how to interpret the integer.
 345  */
 346 enum pcmk_result_type {
 347     pcmk_result_legacy      = 0,  //!< Legacy API function return code
 348     pcmk_result_rc          = 1,  //!< Standard Pacemaker return code
 349     pcmk_result_exitcode    = 2,  //!< Exit status code
 350     pcmk_result_exec_status = 3,  //!< Execution status
 351 };
 352 
 353 int pcmk_result_get_strings(int code, enum pcmk_result_type type,
 354                             const char **name, const char **desc);
 355 const char *pcmk_rc_name(int rc);
 356 const char *pcmk_rc_str(int rc);
 357 crm_exit_t pcmk_rc2exitc(int rc);
 358 enum ocf_exitcode pcmk_rc2ocf(int rc);
 359 int pcmk_rc2legacy(int rc);
 360 int pcmk_legacy2rc(int legacy_rc);
 361 const char *pcmk_strerror(int rc);
 362 const char *pcmk_errorname(int rc);
 363 const char *bz2_strerror(int rc);
 364 const char *crm_exit_name(crm_exit_t exit_code);
 365 const char *crm_exit_str(crm_exit_t exit_code);
 366 _Noreturn crm_exit_t crm_exit(crm_exit_t rc);
 367 
 368 static inline const char *
 369 pcmk_exec_status_str(enum pcmk_exec_status status)
     /* [previous][next][first][last][top][bottom][index][help] */
 370 {
 371     switch (status) {
 372         case PCMK_EXEC_PENDING:         return "pending";
 373         case PCMK_EXEC_DONE:            return "complete";
 374         case PCMK_EXEC_CANCELLED:       return "Cancelled";
 375         case PCMK_EXEC_TIMEOUT:         return "Timed Out";
 376         case PCMK_EXEC_NOT_SUPPORTED:   return "NOT SUPPORTED";
 377         case PCMK_EXEC_ERROR:           return "Error";
 378         case PCMK_EXEC_ERROR_HARD:      return "Hard error";
 379         case PCMK_EXEC_ERROR_FATAL:     return "Fatal error";
 380         case PCMK_EXEC_NOT_INSTALLED:   return "Not installed";
 381         case PCMK_EXEC_NOT_CONNECTED:   return "Internal communication failure";
 382         case PCMK_EXEC_INVALID:         return "Cannot execute now";
 383         case PCMK_EXEC_NO_FENCE_DEVICE: return "No fence device";
 384         case PCMK_EXEC_NO_SECRETS:      return "CIB secrets unavailable";
 385         default:                        return "UNKNOWN!";
 386     }
 387 }
 388 
 389 #ifdef __cplusplus
 390 }
 391 #endif
 392 
 393 #endif

/* [previous][next][first][last][top][bottom][index][help] */