diff options
Diffstat (limited to '')
| -rw-r--r-- | include/crm/cluster.h | 203 |
1 files changed, 115 insertions, 88 deletions
diff --git a/include/crm/cluster.h b/include/crm/cluster.h index b61fd70..778c4ba 100644 --- a/include/crm/cluster.h +++ b/include/crm/cluster.h @@ -1,5 +1,5 @@ /* - * Copyright 2004-2023 the Pacemaker project contributors + * Copyright 2004-2024 the Pacemaker project contributors * * The version control history for this file may have further details. * @@ -24,14 +24,33 @@ extern "C" { # include <corosync/cpg.h> # endif +// @COMPAT Make this internal when we can break API backward compatibility +//! \deprecated Do not use (public access will be removed in a future release) extern gboolean crm_have_quorum; + +// @COMPAT Make this internal when we can break API backward compatibility +//! \deprecated Do not use (public access will be removed in a future release) extern GHashTable *crm_peer_cache; + +// @COMPAT Make this internal when we can break API backward compatibility +//! \deprecated Do not use (public access will be removed in a future release) extern GHashTable *crm_remote_peer_cache; + +// @COMPAT Make this internal when we can break API backward compatibility +//! \deprecated Do not use (public access will be removed in a future release) extern unsigned long long crm_peer_seq; +// @COMPAT Make this internal when we can break API backward compatibility +//! \deprecated Do not use (public access will be removed in a future release) #define CRM_NODE_LOST "lost" + +// @COMPAT Make this internal when we can break API backward compatibility +//! \deprecated Do not use (public access will be removed in a future release) #define CRM_NODE_MEMBER "member" +// @COMPAT Make this internal when we can break API backward compatibility +//!@{ +//! \deprecated Do not use (public access will be removed in a future release) enum crm_join_phase { /* @COMPAT: crm_join_nack_quiet can be replaced by crm_node_t:user_data * at a compatibility break. @@ -46,18 +65,47 @@ enum crm_join_phase { crm_join_finalized = 3, crm_join_confirmed = 4, }; +//!@} +// @COMPAT Make this internal when we can break API backward compatibility +//!@{ +//! \deprecated Do not use (public access will be removed in a future release) enum crm_node_flags { - /* node is not a cluster node and should not be considered for cluster membership */ - crm_remote_node = 0x0001, + /* Node is not a cluster node and should not be considered for cluster + * membership + */ + crm_remote_node = (1U << 0), - /* node's cache entry is dirty */ - crm_node_dirty = 0x0010, + // Node's cache entry is dirty + crm_node_dirty = (1U << 1), }; +//!@} +// @COMPAT Make this internal when we can break API backward compatibility +//!@{ +//! \deprecated Do not use (public access will be removed in a future release) typedef struct crm_peer_node_s { char *uname; // Node name as known to cluster - char *uuid; // Node UUID to ensure uniqueness + + /* @COMPAT This is less than ideal since the value is not a valid XML ID + * (for Corosync, it's the string equivalent of the node's numeric node ID, + * but XML IDs can't start with a number) and the three elements should have + * different IDs. + * + * Ideally, we would use something like node-NODEID, node_state-NODEID, and + * transient_attributes-NODEID as the element IDs. Unfortunately changing it + * would be impractical due to backward compatibility; older nodes in a + * rolling upgrade will always write and expect the value in the old format. + * + * This is also named poorly, since the value is not a UUID, but at least + * that can be changed at an API compatibility break. + */ + /*! Value of the PCMK_XA_ID XML attribute to use with the node's + * PCMK_XE_NODE, PCMK_XE_NODE_STATE, and PCMK_XE_TRANSIENT_ATTRIBUTES + * XML elements in the CIB + */ + char *uuid; + char *state; // @TODO change to enum uint64_t flags; // Bitmask of crm_node_flags uint64_t last_seen; // Only needed by cluster nodes @@ -82,15 +130,19 @@ typedef struct crm_peer_node_s { time_t when_member; // Since when node has been a cluster member time_t when_online; // Since when peer has been online in CPG } crm_node_t; +//!@} -void crm_peer_init(void); -void crm_peer_destroy(void); - -typedef struct crm_cluster_s { +// Implementation of pcmk_cluster_t +// @COMPAT Make this internal when we can break API backward compatibility +//!@{ +//! \deprecated Do not use (public access will be removed in a future release) +struct crm_cluster_s { char *uuid; char *uname; uint32_t nodeid; + // NOTE: sbd (as of at least 1.5.2) uses this + //! \deprecated Call pcmk_cluster_set_destroy_fn() to set this void (*destroy) (gpointer); # if SUPPORT_COROSYNC @@ -99,119 +151,94 @@ typedef struct crm_cluster_s { * cluster layer further. */ struct cpg_name group; + + // NOTE: sbd (as of at least 1.5.2) uses this + /*! + * \deprecated Call pcmk_cpg_set_deliver_fn() and pcmk_cpg_set_confchg_fn() + * to set these + */ cpg_callbacks_t cpg; + cpg_handle_t cpg_handle; # endif -} crm_cluster_t; +}; +//!@} + +//! Connection to a cluster layer +typedef struct crm_cluster_s pcmk_cluster_t; -gboolean crm_cluster_connect(crm_cluster_t *cluster); -void crm_cluster_disconnect(crm_cluster_t *cluster); +int pcmk_cluster_connect(pcmk_cluster_t *cluster); +int pcmk_cluster_disconnect(pcmk_cluster_t *cluster); -crm_cluster_t *pcmk_cluster_new(void); -void pcmk_cluster_free(crm_cluster_t *cluster); +pcmk_cluster_t *pcmk_cluster_new(void); +void pcmk_cluster_free(pcmk_cluster_t *cluster); +int pcmk_cluster_set_destroy_fn(pcmk_cluster_t *cluster, void (*fn)(gpointer)); +#if SUPPORT_COROSYNC +int pcmk_cpg_set_deliver_fn(pcmk_cluster_t *cluster, cpg_deliver_fn_t fn); +int pcmk_cpg_set_confchg_fn(pcmk_cluster_t *cluster, cpg_confchg_fn_t fn); +#endif // SUPPORT_COROSYNC + +/* @COMPAT Make this internal when we can break API backward compatibility. Also + * evaluate whether we can drop this entirely. Since 2.0.0, we have sent only + * messages with crm_class_cluster. + */ +//!@{ +//! \deprecated Do not use (public access will be removed in a future release) enum crm_ais_msg_class { crm_class_cluster = 0, }; +//!@} +// @COMPAT Make this internal when we can break API backward compatibility +//!@{ +//! \deprecated Do not use (public access will be removed in a future release) enum crm_ais_msg_types { crm_msg_none = 0, - crm_msg_ais = 1, + crm_msg_ais = 1, // Unused crm_msg_lrmd = 2, crm_msg_cib = 3, crm_msg_crmd = 4, crm_msg_attrd = 5, - crm_msg_stonithd = 6, - crm_msg_te = 7, - crm_msg_pe = 8, + crm_msg_stonithd = 6, // Unused + crm_msg_te = 7, // Unused + crm_msg_pe = 8, // Unused crm_msg_stonith_ng = 9, }; +//!@} -/* used with crm_get_peer_full */ -enum crm_get_peer_flags { - CRM_GET_PEER_CLUSTER = 0x0001, - CRM_GET_PEER_REMOTE = 0x0002, - CRM_GET_PEER_ANY = CRM_GET_PEER_CLUSTER|CRM_GET_PEER_REMOTE, -}; - -gboolean send_cluster_message(const crm_node_t *node, - enum crm_ais_msg_types service, - const xmlNode *data, gboolean ordered); - -int crm_remote_peer_cache_size(void); - -/* Initialize and refresh the remote peer cache from a cib config */ -void crm_remote_peer_cache_refresh(xmlNode *cib); -crm_node_t *crm_remote_peer_get(const char *node_name); -void crm_remote_peer_cache_remove(const char *node_name); - -/* allows filtering of remote and cluster nodes using crm_get_peer_flags */ -crm_node_t *crm_get_peer_full(unsigned int id, const char *uname, int flags); - -/* only searches cluster nodes */ -crm_node_t *crm_get_peer(unsigned int id, const char *uname); - -guint crm_active_peers(void); -gboolean crm_is_peer_active(const crm_node_t * node); -guint reap_crm_member(uint32_t id, const char *name); - -# if SUPPORT_COROSYNC -uint32_t get_local_nodeid(cpg_handle_t handle); - -gboolean cluster_connect_cpg(crm_cluster_t *cluster); -void cluster_disconnect_cpg(crm_cluster_t * cluster); - -void pcmk_cpg_membership(cpg_handle_t handle, - const struct cpg_name *groupName, - const struct cpg_address *member_list, size_t member_list_entries, - const struct cpg_address *left_list, size_t left_list_entries, - const struct cpg_address *joined_list, size_t joined_list_entries); -gboolean crm_is_corosync_peer_active(const crm_node_t * node); -gboolean send_cluster_text(enum crm_ais_msg_class msg_class, const char *data, - gboolean local, const crm_node_t *node, - enum crm_ais_msg_types dest); -char *pcmk_message_common_cs(cpg_handle_t handle, uint32_t nodeid, uint32_t pid, void *msg, - uint32_t *kind, const char **from); -# endif - -const char *crm_peer_uuid(crm_node_t *node); -const char *crm_peer_uname(const char *uuid); - +// @COMPAT Make this internal when we can break API backward compatibility +//!@{ +//! \deprecated Do not use (public access will be removed in a future release) enum crm_status_type { crm_status_uname, crm_status_nstate, crm_status_processes, }; +//!@} -enum crm_ais_msg_types text2msg_type(const char *text); -void crm_set_status_callback(void (*dispatch) (enum crm_status_type, crm_node_t *, const void *)); -void crm_set_autoreap(gboolean autoreap); - -enum cluster_type_e { - pcmk_cluster_unknown = 0x0001, - pcmk_cluster_invalid = 0x0002, - // 0x0004 was heartbeat - // 0x0010 was corosync 1 with plugin - pcmk_cluster_corosync = 0x0020, - // 0x0040 was corosync 1 with CMAN +/*! + * \enum pcmk_cluster_layer + * \brief Types of cluster layer + */ +enum pcmk_cluster_layer { + pcmk_cluster_layer_unknown = 1, //!< Unknown cluster layer + pcmk_cluster_layer_invalid = 2, //!< Invalid cluster layer + pcmk_cluster_layer_corosync = 32, //!< Corosync Cluster Engine }; -enum cluster_type_e get_cluster_type(void); -const char *name_for_cluster_type(enum cluster_type_e type); +enum pcmk_cluster_layer pcmk_get_cluster_layer(void); +const char *pcmk_cluster_layer_text(enum pcmk_cluster_layer layer); -gboolean is_corosync_cluster(void); - -const char *get_local_node_name(void); -char *get_node_name(uint32_t nodeid); - -/*! +/* * \brief Get log-friendly string equivalent of a join phase * * \param[in] phase Join phase * * \return Log-friendly string equivalent of \p phase */ +//! \deprecated Do not use (public access will be removed in a future release) static inline const char * crm_join_phase_str(enum crm_join_phase phase) { |