root/include/crm/pengine/pe_types.h

/* */

INCLUDED FROM

   1 /*
   2  * Copyright 2004-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__CRM_PENGINE_PE_TYPES__H
  11 #  define PCMK__CRM_PENGINE_PE_TYPES__H
  12 
  13 
  14 #  include <stdbool.h>              // bool
  15 #  include <sys/types.h>            // time_t
  16 #  include <libxml/tree.h>          // xmlNode
  17 #  include <glib.h>                 // gboolean, guint, GList, GHashTable
  18 #  include <crm/common/iso8601.h>
  19 #  include <crm/pengine/common.h>
  20 
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif
  24 
  25 /*!
  26  * \file
  27  * \brief Data types for cluster status
  28  * \ingroup pengine
  29  */
  30 
  31 typedef struct pe_node_s pe_node_t;
  32 typedef struct pe_action_s pe_action_t;
  33 typedef struct pe_resource_s pe_resource_t;
  34 typedef struct pe_working_set_s pe_working_set_t;
  35 
  36 enum pe_obj_types {
  37     pe_unknown = -1,
  38     pe_native = 0,
  39     pe_group = 1,
  40     pe_clone = 2,
  41     pe_container = 3,
  42 };
  43 
  44 typedef struct resource_object_functions_s {
  45     gboolean (*unpack) (pe_resource_t*, pe_working_set_t*);
  46     pe_resource_t *(*find_rsc) (pe_resource_t *parent, const char *search,
  47                                 const pe_node_t *node, int flags);
  48     /* parameter result must be free'd */
  49     char *(*parameter) (pe_resource_t*, pe_node_t*, gboolean, const char*,
  50                         pe_working_set_t*);
  51     //! \deprecated will be removed in a future release
  52     void (*print) (pe_resource_t*, const char*, long, void*);
  53     gboolean (*active) (pe_resource_t*, gboolean);
  54     enum rsc_role_e (*state) (const pe_resource_t*, gboolean);
  55     pe_node_t *(*location) (const pe_resource_t*, GList**, int);
  56     void (*free) (pe_resource_t*);
  57     void (*count) (pe_resource_t*);
  58     gboolean (*is_filtered) (pe_resource_t*, GList *, gboolean);
  59 } resource_object_functions_t;
  60 
  61 typedef struct resource_alloc_functions_s resource_alloc_functions_t;
  62 
  63 enum pe_quorum_policy {
  64     no_quorum_freeze,
  65     no_quorum_stop,
  66     no_quorum_ignore,
  67     no_quorum_suicide,
  68     no_quorum_demote
  69 };
  70 
  71 enum node_type {
  72     node_ping,      //! \deprecated Do not use
  73     node_member,
  74     node_remote
  75 };
  76 
  77 //! \deprecated will be removed in a future release
  78 enum pe_restart {
  79     pe_restart_restart, //! \deprecated will be removed in a future release
  80     pe_restart_ignore   //! \deprecated will be removed in a future release
  81 };
  82 
  83 //! Determine behavior of pe_find_resource_with_flags()
  84 enum pe_find {
  85     pe_find_renamed  = 0x001, //!< match resource ID or LRM history ID
  86     pe_find_anon     = 0x002, //!< match base name of anonymous clone instances
  87     pe_find_clone    = 0x004, //!< match only clone instances
  88     pe_find_current  = 0x008, //!< match resource active on specified node
  89     pe_find_inactive = 0x010, //!< match resource not running anywhere
  90     pe_find_any      = 0x020, //!< match base name of any clone instance
  91 };
  92 
  93 // @TODO Make these an enum
  94 
  95 #  define pe_flag_have_quorum           0x00000001ULL
  96 #  define pe_flag_symmetric_cluster     0x00000002ULL
  97 #  define pe_flag_maintenance_mode      0x00000008ULL
  98 
  99 #  define pe_flag_stonith_enabled       0x00000010ULL
 100 #  define pe_flag_have_stonith_resource 0x00000020ULL
 101 #  define pe_flag_enable_unfencing      0x00000040ULL
 102 #  define pe_flag_concurrent_fencing    0x00000080ULL
 103 
 104 #  define pe_flag_stop_rsc_orphans      0x00000100ULL
 105 #  define pe_flag_stop_action_orphans   0x00000200ULL
 106 #  define pe_flag_stop_everything       0x00000400ULL
 107 
 108 #  define pe_flag_start_failure_fatal   0x00001000ULL
 109 
 110 //! \deprecated
 111 #  define pe_flag_remove_after_stop     0x00002000ULL
 112 
 113 #  define pe_flag_startup_fencing       0x00004000ULL
 114 #  define pe_flag_shutdown_lock         0x00008000ULL
 115 
 116 #  define pe_flag_startup_probes        0x00010000ULL
 117 #  define pe_flag_have_status           0x00020000ULL
 118 #  define pe_flag_have_remote_nodes     0x00040000ULL
 119 
 120 #  define pe_flag_quick_location        0x00100000ULL
 121 #  define pe_flag_sanitized             0x00200000ULL
 122 
 123 //! \deprecated
 124 #  define pe_flag_stdout                0x00400000ULL
 125 
 126 //! Don't count total, disabled and blocked resource instances
 127 #  define pe_flag_no_counts             0x00800000ULL
 128 
 129 /*! Skip deprecated code that is kept solely for backward API compatibility.
 130  * (Internal code should always set this.)
 131  */
 132 #  define pe_flag_no_compat             0x01000000ULL
 133 
 134 #  define pe_flag_show_scores           0x02000000ULL
 135 #  define pe_flag_show_utilization      0x04000000ULL
 136 
 137 /*!
 138  * When scheduling, only unpack the CIB (including constraints), calculate
 139  * as much cluster status as possible, and apply node health.
 140  */
 141 #  define pe_flag_check_config          0x08000000ULL
 142 
 143 struct pe_working_set_s {
 144     xmlNode *input;
 145     crm_time_t *now;
 146 
 147     /* options extracted from the input */
 148     char *dc_uuid;
 149     pe_node_t *dc_node;
 150     const char *stonith_action;
 151     const char *placement_strategy;
 152 
 153     unsigned long long flags;
 154 
 155     int stonith_timeout;
 156     enum pe_quorum_policy no_quorum_policy;
 157 
 158     GHashTable *config_hash;
 159     GHashTable *tickets;
 160 
 161     // Actions for which there can be only one (e.g. fence nodeX)
 162     GHashTable *singletons;
 163 
 164     GList *nodes;
 165     GList *resources;
 166     GList *placement_constraints;
 167     GList *ordering_constraints;
 168     GList *colocation_constraints;
 169     GList *ticket_constraints;
 170 
 171     GList *actions;
 172     xmlNode *failed;
 173     xmlNode *op_defaults;
 174     xmlNode *rsc_defaults;
 175 
 176     /* stats */
 177     int num_synapse;
 178     int max_valid_nodes;    //! Deprecated (will be removed in a future release)
 179     int order_id;
 180     int action_id;
 181 
 182     /* final output */
 183     xmlNode *graph;
 184 
 185     GHashTable *template_rsc_sets;
 186     const char *localhost;
 187     GHashTable *tags;
 188 
 189     int blocked_resources;
 190     int disabled_resources;
 191 
 192     GList *param_check; // History entries that need to be checked
 193     GList *stop_needed; // Containers that need stop actions
 194     time_t recheck_by;  // Hint to controller to re-run scheduler by this time
 195     int ninstances;     // Total number of resource instances
 196     guint shutdown_lock;// How long (seconds) to lock resources to shutdown node
 197     int priority_fencing_delay; // Priority fencing delay
 198 
 199     void *priv;
 200 };
 201 
 202 enum pe_check_parameters {
 203     /* Clear fail count if parameters changed for un-expired start or monitor
 204      * last_failure.
 205      */
 206     pe_check_last_failure,
 207 
 208     /* Clear fail count if parameters changed for start, monitor, promote, or
 209      * migrate_from actions for active resources.
 210      */
 211     pe_check_active,
 212 };
 213 
 214 struct pe_node_shared_s {
 215     const char *id;
 216     const char *uname;
 217     enum node_type type;
 218 
 219     /* @TODO convert these flags into a bitfield */
 220     gboolean online;
 221     gboolean standby;
 222     gboolean standby_onfail;
 223     gboolean pending;
 224     gboolean unclean;
 225     gboolean unseen;
 226     gboolean shutdown;
 227     gboolean expected_up;
 228     gboolean is_dc;
 229     gboolean maintenance;
 230     gboolean rsc_discovery_enabled;
 231     gboolean remote_requires_reset;
 232     gboolean remote_was_fenced;
 233     gboolean remote_maintenance; /* what the remote-rsc is thinking */
 234     gboolean unpacked;
 235 
 236     int num_resources;
 237     pe_resource_t *remote_rsc;
 238     GList *running_rsc;       /* pe_resource_t* */
 239     GList *allocated_rsc;     /* pe_resource_t* */
 240 
 241     GHashTable *attrs;          /* char* => char* */
 242     GHashTable *utilization;
 243     GHashTable *digest_cache;   //!< cache of calculated resource digests
 244     int priority; // calculated based on the priority of resources running on the node
 245     pe_working_set_t *data_set; //!< Cluster that this node is part of
 246 };
 247 
 248 struct pe_node_s {
 249     int weight;
 250     gboolean fixed;
 251     int count;
 252     struct pe_node_shared_s *details;
 253     int rsc_discover_mode;
 254 };
 255 
 256 #  define pe_rsc_orphan                     0x00000001ULL
 257 #  define pe_rsc_managed                    0x00000002ULL
 258 #  define pe_rsc_block                      0x00000004ULL
 259 #  define pe_rsc_orphan_container_filler    0x00000008ULL
 260 
 261 #  define pe_rsc_notify                     0x00000010ULL
 262 #  define pe_rsc_unique                     0x00000020ULL
 263 #  define pe_rsc_fence_device               0x00000040ULL
 264 #  define pe_rsc_promotable                 0x00000080ULL
 265 
 266 #  define pe_rsc_provisional                0x00000100ULL
 267 #  define pe_rsc_allocating                 0x00000200ULL
 268 #  define pe_rsc_merging                    0x00000400ULL
 269 #  define pe_rsc_restarting                 0x00000800ULL
 270 
 271 #  define pe_rsc_stop                       0x00001000ULL
 272 #  define pe_rsc_reload                     0x00002000ULL
 273 #  define pe_rsc_allow_remote_remotes       0x00004000ULL
 274 #  define pe_rsc_critical                   0x00008000ULL
 275 
 276 #  define pe_rsc_failed                     0x00010000ULL
 277 #  define pe_rsc_runnable                   0x00040000ULL
 278 #  define pe_rsc_start_pending              0x00080000ULL
 279 
 280 //!< \deprecated Do not use
 281 #  define pe_rsc_starting                   0x00100000ULL
 282 
 283 //!< \deprecated Do not use
 284 #  define pe_rsc_stopping                   0x00200000ULL
 285 
 286 #  define pe_rsc_stop_unexpected            0x00400000ULL
 287 #  define pe_rsc_allow_migrate              0x00800000ULL
 288 
 289 #  define pe_rsc_failure_ignored            0x01000000ULL
 290 #  define pe_rsc_maintenance                0x04000000ULL
 291 #  define pe_rsc_is_container               0x08000000ULL
 292 
 293 #  define pe_rsc_needs_quorum               0x10000000ULL
 294 #  define pe_rsc_needs_fencing              0x20000000ULL
 295 #  define pe_rsc_needs_unfencing            0x40000000ULL
 296 
 297 enum pe_graph_flags {
 298     pe_graph_none = 0x00000,
 299     pe_graph_updated_first = 0x00001,
 300     pe_graph_updated_then = 0x00002,
 301     pe_graph_disable = 0x00004,
 302 };
 303 
 304 /* *INDENT-OFF* */
 305 enum pe_action_flags {
 306     pe_action_pseudo = 0x00001,
 307     pe_action_runnable = 0x00002,
 308     pe_action_optional = 0x00004,
 309     pe_action_print_always = 0x00008,
 310 
 311     pe_action_have_node_attrs = 0x00010,
 312     pe_action_implied_by_stonith = 0x00040,
 313     pe_action_migrate_runnable =   0x00080,
 314 
 315     pe_action_dumped = 0x00100,
 316     pe_action_processed = 0x00200,
 317 #if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
 318     pe_action_clear = 0x00400, //! \deprecated Unused
 319 #endif
 320     pe_action_dangle = 0x00800,
 321 
 322     /* This action requires one or more of its dependencies to be runnable.
 323      * We use this to clear the runnable flag before checking dependencies.
 324      */
 325     pe_action_requires_any = 0x01000,
 326 
 327     pe_action_reschedule = 0x02000,
 328     pe_action_tracking = 0x04000,
 329     pe_action_dedup = 0x08000, //! Internal state tracking when creating graph
 330 
 331     pe_action_dc = 0x10000,         //! Action may run on DC instead of target
 332 };
 333 /* *INDENT-ON* */
 334 
 335 struct pe_resource_s {
 336     char *id;
 337     char *clone_name;
 338     xmlNode *xml;
 339     xmlNode *orig_xml;
 340     xmlNode *ops_xml;
 341 
 342     pe_working_set_t *cluster;
 343     pe_resource_t *parent;
 344 
 345     enum pe_obj_types variant;
 346     void *variant_opaque;
 347     resource_object_functions_t *fns;
 348     resource_alloc_functions_t *cmds;
 349 
 350     enum rsc_recovery_type recovery_type;
 351 
 352     enum pe_restart restart_type; //!< \deprecated will be removed in future release
 353 
 354     int priority;
 355     int stickiness;
 356     int sort_index;
 357     int failure_timeout;
 358     int migration_threshold;
 359     guint remote_reconnect_ms;
 360     char *pending_task;
 361 
 362     unsigned long long flags;
 363 
 364     // @TODO merge these into flags
 365     gboolean is_remote_node;
 366     gboolean exclusive_discover;
 367 
 368     //!@{
 369     //! This field should be treated as internal to Pacemaker
 370     GList *rsc_cons_lhs;      // List of pcmk__colocation_t*
 371     GList *rsc_cons;          // List of pcmk__colocation_t*
 372     GList *rsc_location;      // List of pe__location_t*
 373     GList *actions;           // List of pe_action_t*
 374     GList *rsc_tickets;       // List of rsc_ticket*
 375     //!@}
 376 
 377     pe_node_t *allocated_to;
 378     pe_node_t *partial_migration_target;
 379     pe_node_t *partial_migration_source;
 380     GList *running_on;        /* pe_node_t*   */
 381     GHashTable *known_on;       /* pe_node_t*   */
 382     GHashTable *allowed_nodes;  /* pe_node_t*   */
 383 
 384     enum rsc_role_e role;
 385     enum rsc_role_e next_role;
 386 
 387     GHashTable *meta;
 388     GHashTable *parameters; //! \deprecated Use pe_rsc_params() instead
 389     GHashTable *utilization;
 390 
 391     GList *children;          /* pe_resource_t*   */
 392     GList *dangling_migrations;       /* pe_node_t*       */
 393 
 394     pe_resource_t *container;
 395     GList *fillers;
 396 
 397     pe_node_t *pending_node;    // Node on which pending_task is happening
 398     pe_node_t *lock_node;       // Resource is shutdown-locked to this node
 399     time_t lock_time;           // When shutdown lock started
 400 
 401     /* Resource parameters may have node-attribute-based rules, which means the
 402      * values can vary by node. This table is a cache of parameter name/value
 403      * tables for each node (as needed). Use pe_rsc_params() to get the table
 404      * for a given node.
 405      */
 406     GHashTable *parameter_cache; // Key = node name, value = parameters table
 407 #if ENABLE_VERSIONED_ATTRS
 408     xmlNode *versioned_parameters;
 409 #endif
 410 };
 411 
 412 #if ENABLE_VERSIONED_ATTRS
 413 // Used as action->action_details if action->rsc is not NULL
 414 typedef struct pe_rsc_action_details_s {
 415     xmlNode *versioned_parameters;
 416     xmlNode *versioned_meta;
 417 } pe_rsc_action_details_t;
 418 #endif
 419 
 420 struct pe_action_s {
 421     int id;
 422     int priority;
 423 
 424     pe_resource_t *rsc;
 425     pe_node_t *node;
 426     xmlNode *op_entry;
 427 
 428     char *task;
 429     char *uuid;
 430     char *cancel_task;
 431     char *reason;
 432 
 433     enum pe_action_flags flags;
 434     enum rsc_start_requirement needs;
 435     enum action_fail_response on_fail;
 436     enum rsc_role_e fail_role;
 437 
 438     GHashTable *meta;
 439     GHashTable *extra;
 440 
 441     /* 
 442      * These two varables are associated with the constraint logic
 443      * that involves first having one or more actions runnable before
 444      * then allowing this action to execute.
 445      *
 446      * These varables are used with features such as 'clone-min' which
 447      * requires at minimum X number of cloned instances to be running
 448      * before an order dependency can run. Another option that uses
 449      * this is 'require-all=false' in ordering constrants. This option
 450      * says "only require one instance of a resource to start before
 451      * allowing dependencies to start" -- basically, require-all=false is
 452      * the same as clone-min=1.
 453      */
 454 
 455     /* current number of known runnable actions in the before list. */
 456     int runnable_before;
 457     /* the number of "before" runnable actions required for this action
 458      * to be considered runnable */ 
 459     int required_runnable_before;
 460 
 461     GList *actions_before;    /* pe_action_wrapper_t* */
 462     GList *actions_after;     /* pe_action_wrapper_t* */
 463 
 464     /* Some of the above fields could be moved to the details,
 465      * except for API backward compatibility.
 466      */
 467     void *action_details; // varies by type of action
 468 };
 469 
 470 typedef struct pe_ticket_s {
 471     char *id;
 472     gboolean granted;
 473     time_t last_granted;
 474     gboolean standby;
 475     GHashTable *state;
 476 } pe_ticket_t;
 477 
 478 typedef struct pe_tag_s {
 479     char *id;
 480     GList *refs;
 481 } pe_tag_t;
 482 
 483 //! Internal tracking for transition graph creation
 484 enum pe_link_state {
 485     pe_link_not_dumped, //! Internal tracking for transition graph creation
 486     pe_link_dumped,     //! Internal tracking for transition graph creation
 487     pe_link_dup,        //! \deprecated No longer used by Pacemaker
 488 };
 489 
 490 enum pe_discover_e {
 491     pe_discover_always = 0,
 492     pe_discover_never,
 493     pe_discover_exclusive,
 494 };
 495 
 496 /* *INDENT-OFF* */
 497 enum pe_ordering {
 498     pe_order_none                  = 0x0,       /* deleted */
 499     pe_order_optional              = 0x1,       /* pure ordering, nothing implied */
 500     pe_order_apply_first_non_migratable = 0x2,  /* Only apply this constraint's ordering if first is not migratable. */
 501 
 502     pe_order_implies_first         = 0x10,      /* If 'then' is required, ensure 'first' is too */
 503     pe_order_implies_then          = 0x20,      /* If 'first' is required, ensure 'then' is too */
 504     pe_order_promoted_implies_first = 0x40,     /* If 'then' is required and then's rsc is promoted, ensure 'first' becomes required too */
 505 
 506     /* first requires then to be both runnable and migrate runnable. */
 507     pe_order_implies_first_migratable  = 0x80,
 508 
 509     pe_order_runnable_left         = 0x100,     /* 'then' requires 'first' to be runnable */
 510 
 511     pe_order_pseudo_left           = 0x200,     /* 'then' can only be pseudo if 'first' is runnable */
 512     pe_order_implies_then_on_node  = 0x400,     /* If 'first' is required on 'nodeX',
 513                                                  * ensure instances of 'then' on 'nodeX' are too.
 514                                                  * Only really useful if 'then' is a clone and 'first' is not
 515                                                  */
 516     pe_order_probe                 = 0x800,     /* If 'first->rsc' is
 517                                                  *  - running but about to stop, ignore the constraint
 518                                                  *  - otherwise, behave as runnable_left
 519                                                  */
 520 
 521     pe_order_restart               = 0x1000,    /* 'then' is runnable if 'first' is optional or runnable */
 522     pe_order_stonith_stop          = 0x2000,    //<! \deprecated Will be removed in future release
 523     pe_order_serialize_only        = 0x4000,    /* serialize */
 524     pe_order_same_node             = 0x8000,    /* applies only if 'first' and 'then' are on same node */
 525 
 526     pe_order_implies_first_printed = 0x10000,   /* Like ..implies_first but only ensures 'first' is printed, not mandatory */
 527     pe_order_implies_then_printed  = 0x20000,   /* Like ..implies_then but only ensures 'then' is printed, not mandatory */
 528 
 529     pe_order_asymmetrical          = 0x100000,  /* Indicates asymmetrical one way ordering constraint. */
 530     pe_order_load                  = 0x200000,  /* Only relevant if... */
 531     pe_order_one_or_more           = 0x400000,  /* 'then' is runnable only if one or more of its dependencies are too */
 532     pe_order_anti_colocation       = 0x800000,
 533 
 534     pe_order_preserve              = 0x1000000, /* Hack for breaking user ordering constraints with container resources */
 535     pe_order_then_cancels_first    = 0x2000000, // if 'then' becomes required, 'first' becomes optional
 536     pe_order_trace                 = 0x4000000, /* test marker */
 537 
 538 #if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
 539     // \deprecated Use pe_order_promoted_implies_first instead
 540     pe_order_implies_first_master  = pe_order_promoted_implies_first,
 541 #endif
 542 };
 543 /* *INDENT-ON* */
 544 
 545 typedef struct pe_action_wrapper_s {
 546     enum pe_ordering type;
 547     enum pe_link_state state;
 548     pe_action_t *action;
 549 } pe_action_wrapper_t;
 550 
 551 #if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
 552 #include <crm/pengine/pe_types_compat.h>
 553 #endif
 554 
 555 #ifdef __cplusplus
 556 }
 557 #endif
 558 
 559 #endif // PCMK__CRM_PENGINE_PE_TYPES__H

/* */