root/include/crm/common/results_internal.h

/* */

INCLUDED FROM

DEFINITIONS

1. pcmk__format_result

   1 /*
   2  * Copyright 2020-2022 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 PCMK__COMMON_RESULTS_INTERNAL__H
  11 #define PCMK__COMMON_RESULTS_INTERNAL__H
  12 
  13 #include <glib.h>               // GQuark
  14 
  15 // Generic result code type
  16 
  17 int pcmk__result_bounds(enum pcmk_result_type, int *lower, int *upper);
  18 
  19 // Standard Pacemaker API return codes
  20 
  21 extern const size_t pcmk__n_rc;
  22 
  23 /* Error domains for use with g_set_error */
  24 
  25 GQuark pcmk__rc_error_quark(void);
  26 GQuark pcmk__exitc_error_quark(void);
  27 
  28 #define PCMK__RC_ERROR       pcmk__rc_error_quark()
  29 #define PCMK__EXITC_ERROR    pcmk__exitc_error_quark()
  30 
  31 /* Action results */
  32 
  33 typedef struct {
  34     int exit_status;        // Child exit status
  35     enum pcmk_exec_status execution_status; // Execution status
  36     char *exit_reason;      // Brief, human-friendly explanation
  37     char *action_stdout;    // Action output
  38     char *action_stderr;    // Action error output
  39 } pcmk__action_result_t;
  40 
  41 /*!
  42  * \internal
  43  * \brief Static initialization for an action result
  44  *
  45  * \note Importantly, this ensures pcmk__reset_result() won't try to free
  46  *       garbage.
  47  */
  48 #define PCMK__UNKNOWN_RESULT {                  \
  49         .exit_status = CRM_EX_OK,               \
  50         .execution_status = PCMK_EXEC_UNKNOWN,  \
  51         .exit_reason = NULL,                    \
  52         .action_stdout = NULL,                  \
  53         .action_stderr = NULL,                  \
  54     }
  55 
  56 void pcmk__set_result(pcmk__action_result_t *result, int exit_status,
  57                       enum pcmk_exec_status exec_status,
  58                       const char *exit_reason);
  59 
  60 void pcmk__format_result(pcmk__action_result_t *result, int exit_status,
     /*  */
  61                          enum pcmk_exec_status exec_status,
  62                          const char *format, ...) G_GNUC_PRINTF(4, 5);
  63 
  64 void pcmk__set_result_output(pcmk__action_result_t *result,
  65                              char *out, char *err);
  66 
  67 void pcmk__reset_result(pcmk__action_result_t *result);
  68 
  69 void pcmk__copy_result(const pcmk__action_result_t *src,
  70                        pcmk__action_result_t *dst);
  71 
  72 /*!
  73  * \internal
  74  * \brief Check whether a result is OK
  75  *
  76  * \param[in] result
  77  *
  78  * \return true if the result's exit status is CRM_EX_OK and its
  79  *         execution status is PCMK_EXEC_DONE, otherwise false
  80  */
  81 static inline bool
  82 pcmk__result_ok(const pcmk__action_result_t *result)
  83 {
  84     return (result != NULL) && (result->exit_status == CRM_EX_OK)
  85             && (result->execution_status == PCMK_EXEC_DONE);
  86 }
  87 
  88 #endif // PCMK__COMMON_RESULTS_INTERNAL__H

/* */