include/crm/cib/internal.h

/* */
   1 /*
   2  * Copyright 2004-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 
  10 #ifndef CIB_INTERNAL__H
  11 #  define CIB_INTERNAL__H
  12 #  include <crm/cib.h>
  13 #  include <crm/common/ipc_internal.h>
  14 #  include <crm/common/output_internal.h>
  15 
  16 // Request types for CIB manager IPC/CPG
  17 #define PCMK__CIB_REQUEST_SECONDARY     "cib_slave"
  18 #define PCMK__CIB_REQUEST_ALL_SECONDARY "cib_slave_all"
  19 #define PCMK__CIB_REQUEST_PRIMARY       "cib_master"
  20 #define PCMK__CIB_REQUEST_SYNC_TO_ALL   "cib_sync"
  21 #define PCMK__CIB_REQUEST_SYNC_TO_ONE   "cib_sync_one"
  22 #define PCMK__CIB_REQUEST_IS_PRIMARY    "cib_ismaster"
  23 #define PCMK__CIB_REQUEST_BUMP          "cib_bump"
  24 #define PCMK__CIB_REQUEST_QUERY         "cib_query"
  25 #define PCMK__CIB_REQUEST_CREATE        "cib_create"
  26 #define PCMK__CIB_REQUEST_MODIFY        "cib_modify"
  27 #define PCMK__CIB_REQUEST_DELETE        "cib_delete"
  28 #define PCMK__CIB_REQUEST_ERASE         "cib_erase"
  29 #define PCMK__CIB_REQUEST_REPLACE       "cib_replace"
  30 #define PCMK__CIB_REQUEST_APPLY_PATCH   "cib_apply_diff"
  31 #define PCMK__CIB_REQUEST_UPGRADE       "cib_upgrade"
  32 #define PCMK__CIB_REQUEST_ABS_DELETE    "cib_delete_alt"
  33 #define PCMK__CIB_REQUEST_NOOP          "noop"
  34 #define PCMK__CIB_REQUEST_SHUTDOWN      "cib_shutdown_req"
  35 
  36 #  define F_CIB_CLIENTID  "cib_clientid"
  37 #  define F_CIB_CALLOPTS  "cib_callopt"
  38 #  define F_CIB_CALLID    "cib_callid"
  39 #  define F_CIB_CALLDATA  "cib_calldata"
  40 #  define F_CIB_OPERATION "cib_op"
  41 #  define F_CIB_ISREPLY   "cib_isreplyto"
  42 #  define F_CIB_SECTION   "cib_section"
  43 #  define F_CIB_HOST    "cib_host"
  44 #  define F_CIB_RC      "cib_rc"
  45 #  define F_CIB_UPGRADE_RC      "cib_upgrade_rc"
  46 #  define F_CIB_DELEGATED       "cib_delegated_from"
  47 #  define F_CIB_OBJID   "cib_object"
  48 #  define F_CIB_OBJTYPE "cib_object_type"
  49 #  define F_CIB_EXISTING        "cib_existing_object"
  50 #  define F_CIB_SEENCOUNT       "cib_seen"
  51 #  define F_CIB_TIMEOUT "cib_timeout"
  52 #  define F_CIB_UPDATE  "cib_update"
  53 #  define F_CIB_GLOBAL_UPDATE   "cib_update"
  54 #  define F_CIB_UPDATE_RESULT   "cib_update_result"
  55 #  define F_CIB_CLIENTNAME      "cib_clientname"
  56 #  define F_CIB_NOTIFY_TYPE     "cib_notify_type"
  57 #  define F_CIB_NOTIFY_ACTIVATE "cib_notify_activate"
  58 #  define F_CIB_UPDATE_DIFF     "cib_update_diff"
  59 #  define F_CIB_USER            "cib_user"
  60 #  define F_CIB_LOCAL_NOTIFY_ID "cib_local_notify_id"
  61 #  define F_CIB_PING_ID         "cib_ping_id"
  62 #  define F_CIB_SCHEMA_MAX      "cib_schema_max"
  63 #  define F_CIB_CHANGE_SECTION  "cib_change_section"
  64 
  65 #  define T_CIB                 "cib"
  66 #  define T_CIB_NOTIFY          "cib_notify"
  67 /* notify sub-types */
  68 #  define T_CIB_PRE_NOTIFY      "cib_pre_notify"
  69 #  define T_CIB_POST_NOTIFY     "cib_post_notify"
  70 #  define T_CIB_UPDATE_CONFIRM  "cib_update_confirmation"
  71 #  define T_CIB_REPLACE_NOTIFY  "cib_refresh_notify"
  72 
  73 /*!
  74  * \internal
  75  * \enum cib_change_section_info
  76  * \brief Flags to indicate which sections of the CIB have changed
  77  */
  78 enum cib_change_section_info {
  79     cib_change_section_none     = 0,        //!< No sections have changed
  80     cib_change_section_nodes    = (1 << 0), //!< The nodes section has changed
  81     cib_change_section_alerts   = (1 << 1), //!< The alerts section has changed
  82     cib_change_section_status   = (1 << 2), //!< The status section has changed
  83 };
  84 
  85 
  86 gboolean cib_diff_version_details(xmlNode * diff, int *admin_epoch, int *epoch, int *updates,
  87                                   int *_admin_epoch, int *_epoch, int *_updates);
  88 
  89 gboolean cib_read_config(GHashTable * options, xmlNode * current_cib);
  90 
  91 typedef struct cib_notify_client_s {
  92     const char *event;
  93     const char *obj_id;         /* implement one day */
  94     const char *obj_type;       /* implement one day */
  95     void (*callback) (const char *event, xmlNode * msg);
  96 
  97 } cib_notify_client_t;
  98 
  99 typedef struct cib_callback_client_s {
 100     void (*callback) (xmlNode *, int, int, xmlNode *, void *);
 101     const char *id;
 102     void *user_data;
 103     gboolean only_success;
 104     struct timer_rec_s *timer;
 105     void (*free_func)(void *);
 106 } cib_callback_client_t;
 107 
 108 struct timer_rec_s {
 109     int call_id;
 110     int timeout;
 111     guint ref;
 112     cib_t *cib;
 113 };
 114 
 115 #define cib__set_call_options(cib_call_opts, call_for, flags_to_set) do {   \
 116         cib_call_opts = pcmk__set_flags_as(__func__, __LINE__,              \
 117             LOG_TRACE, "CIB call", (call_for), (cib_call_opts),             \
 118             (flags_to_set), #flags_to_set); \
 119     } while (0)
 120 
 121 #define cib__clear_call_options(cib_call_opts, call_for, flags_to_clear) do {  \
 122         cib_call_opts = pcmk__clear_flags_as(__func__, __LINE__,               \
 123             LOG_TRACE, "CIB call", (call_for), (cib_call_opts),                \
 124             (flags_to_clear), #flags_to_clear);                                \
 125     } while (0)
 126 
 127 typedef int (*cib_op_t) (const char *, int, const char *, xmlNode *,
 128                          xmlNode *, xmlNode *, xmlNode **, xmlNode **);
 129 
 130 cib_t *cib_new_variant(void);
 131 
 132 int cib_perform_op(const char *op, int call_options, cib_op_t * fn, gboolean is_query,
 133                    const char *section, xmlNode * req, xmlNode * input,
 134                    gboolean manage_counters, gboolean * config_changed,
 135                    xmlNode * current_cib, xmlNode ** result_cib, xmlNode ** diff,
 136                    xmlNode ** output);
 137 
 138 xmlNode *cib_create_op(int call_id, const char *op, const char *host,
 139                        const char *section, xmlNode * data, int call_options,
 140                        const char *user_name);
 141 
 142 void cib_native_callback(cib_t * cib, xmlNode * msg, int call_id, int rc);
 143 void cib_native_notify(gpointer data, gpointer user_data);
 144 
 145 int cib_process_query(const char *op, int options, const char *section, xmlNode * req,
 146                       xmlNode * input, xmlNode * existing_cib, xmlNode ** result_cib,
 147                       xmlNode ** answer);
 148 
 149 int cib_process_erase(const char *op, int options, const char *section, xmlNode * req,
 150                       xmlNode * input, xmlNode * existing_cib, xmlNode ** result_cib,
 151                       xmlNode ** answer);
 152 
 153 int cib_process_bump(const char *op, int options, const char *section, xmlNode * req,
 154                      xmlNode * input, xmlNode * existing_cib, xmlNode ** result_cib,
 155                      xmlNode ** answer);
 156 
 157 int cib_process_replace(const char *op, int options, const char *section, xmlNode * req,
 158                         xmlNode * input, xmlNode * existing_cib, xmlNode ** result_cib,
 159                         xmlNode ** answer);
 160 
 161 int cib_process_create(const char *op, int options, const char *section, xmlNode * req,
 162                        xmlNode * input, xmlNode * existing_cib, xmlNode ** result_cib,
 163                        xmlNode ** answer);
 164 
 165 int cib_process_modify(const char *op, int options, const char *section, xmlNode * req,
 166                        xmlNode * input, xmlNode * existing_cib, xmlNode ** result_cib,
 167                        xmlNode ** answer);
 168 
 169 int cib_process_delete(const char *op, int options, const char *section, xmlNode * req,
 170                        xmlNode * input, xmlNode * existing_cib, xmlNode ** result_cib,
 171                        xmlNode ** answer);
 172 
 173 int cib_process_diff(const char *op, int options, const char *section, xmlNode * req,
 174                      xmlNode * input, xmlNode * existing_cib, xmlNode ** result_cib,
 175                      xmlNode ** answer);
 176 
 177 int cib_process_upgrade(const char *op, int options, const char *section, xmlNode * req,
 178                         xmlNode * input, xmlNode * existing_cib, xmlNode ** result_cib,
 179                         xmlNode ** answer);
 180 
 181 /*!
 182  * \internal
 183  * \brief Query or modify a CIB
 184  *
 185  * \param[in]     op            PCMK__CIB_REQUEST_* operation to be performed
 186  * \param[in]     options       Flag set of \c cib_call_options
 187  * \param[in]     section       XPath to query or modify
 188  * \param[in]     req           unused
 189  * \param[in]     input         Portion of CIB to modify (used with
 190  *                              PCMK__CIB_REQUEST_CREATE,
 191  *                              PCMK__CIB_REQUEST_MODIFY, and
 192  *                              PCMK__CIB_REQUEST_REPLACE)
 193  * \param[in,out] existing_cib  Input CIB (used with PCMK__CIB_REQUEST_QUERY)
 194  * \param[in,out] result_cib    CIB copy to make changes in (used with
 195  *                              PCMK__CIB_REQUEST_CREATE,
 196  *                              PCMK__CIB_REQUEST_MODIFY,
 197  *                              PCMK__CIB_REQUEST_DELETE, and
 198  *                              PCMK__CIB_REQUEST_REPLACE)
 199  * \param[out]    answer        Query result (used with PCMK__CIB_REQUEST_QUERY)
 200  *
 201  * \return Legacy Pacemaker return code
 202  */
 203 int cib_process_xpath(const char *op, int options, const char *section,
 204                       const xmlNode *req, xmlNode *input, xmlNode *existing_cib,
 205                       xmlNode **result_cib, xmlNode ** answer);
 206 
 207 bool cib__config_changed_v1(xmlNode *last, xmlNode *next, xmlNode **diff);
 208 
 209 int cib_internal_op(cib_t * cib, const char *op, const char *host,
 210                     const char *section, xmlNode * data,
 211                     xmlNode ** output_data, int call_options, const char *user_name);
 212 
 213 
 214 int cib_file_read_and_verify(const char *filename, const char *sigfile,
 215                              xmlNode **root);
 216 int cib_file_write_with_digest(xmlNode *cib_root, const char *cib_dirname,
 217                                const char *cib_filename);
 218 
 219 void cib__set_output(cib_t *cib, pcmk__output_t *out);
 220 
 221 cib_callback_client_t* cib__lookup_id (int call_id);
 222 
 223 /*!
 224  * \internal
 225  * \brief Connect to, query, and optionally disconnect from the CIB
 226  *
 227  * Open a read-write connection to the CIB manager if an already connected
 228  * client is not passed in. Then query the CIB and store the resulting XML.
 229  * Finally, disconnect if the CIB connection isn't being returned to the caller.
 230  *
 231  * \param[in,out] out         Output object (may be \p NULL)
 232  * \param[in,out] cib         If not \p NULL, where to store CIB connection
 233  * \param[out]    cib_object  Where to store query result
 234  *
 235  * \return Standard Pacemaker return code
 236  *
 237  * \note If \p cib is not \p NULL, the caller is responsible for freeing \p *cib
 238  *       using \p cib_delete().
 239  * \note If \p *cib points to an existing \p cib_t object, this function will
 240  *       reuse it instead of creating a new one. If the existing client is
 241  *       already connected, the connection will be reused, even if it's
 242  *       read-only.
 243  */
 244 int cib__signon_query(pcmk__output_t *out, cib_t **cib, xmlNode **cib_object);
 245 
 246 int cib__clean_up_connection(cib_t **cib);
 247 
 248 int cib__update_node_attr(pcmk__output_t *out, cib_t *cib, int call_options,
 249                           const char *section, const char *node_uuid, const char *set_type,
 250                           const char *set_name, const char *attr_id, const char *attr_name,
 251                           const char *attr_value, const char *user_name,
 252                           const char *node_type);
 253 
 254 int cib__get_node_attrs(pcmk__output_t *out, cib_t *cib, const char *section,
 255                         const char *node_uuid, const char *set_type, const char *set_name,
 256                         const char *attr_id, const char *attr_name, const char *user_name,
 257                         xmlNode **result);
 258 
 259 int cib__delete_node_attr(pcmk__output_t *out, cib_t *cib, int options,
 260                           const char *section, const char *node_uuid, const char *set_type,
 261                           const char *set_name, const char *attr_id, const char *attr_name,
 262                           const char *attr_value, const char *user_name);
 263 
 264 #endif
/* */
root/include/crm/cib/internal.h

INCLUDED FROM
