scheduler.h

Go to the documentation of this file.

/*
 * Copyright 2004-2023 the Pacemaker project contributors
 *
 * The version control history for this file may have further details.
 *
 * This source code is licensed under the GNU Lesser General Public License
 * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
 */

#ifndef PCMK__CRM_COMMON_SCHEDULER__H
#  define PCMK__CRM_COMMON_SCHEDULER__H

#include <sys/types.h>                  // time_t
#include <libxml/tree.h>                // xmlNode
#include <glib.h>                       // guint, GList, GHashTable

#include <crm/common/iso8601.h>         // crm_time_t

#include <crm/common/actions.h>
#include <crm/common/nodes.h>
#include <crm/common/resources.h>
#include <crm/common/roles.h>
#include <crm/common/scheduler_types.h>
#include <crm/common/tags.h>
#include <crm/common/tickets.h>

#ifdef __cplusplus
extern "C" {
#endif

enum pe_quorum_policy {
    pcmk_no_quorum_freeze,  //<! Do not recover resources from outside partition
    pcmk_no_quorum_stop,    //<! Stop all resources in partition
    pcmk_no_quorum_ignore,  //<! Act as if partition still holds quorum
    pcmk_no_quorum_fence,   //<! Fence all nodes in partition
    pcmk_no_quorum_demote,  //<! Demote promotable resources and stop all others

#if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
    no_quorum_freeze    = pcmk_no_quorum_freeze,

    no_quorum_stop      = pcmk_no_quorum_stop,

    no_quorum_ignore    = pcmk_no_quorum_ignore,

    no_quorum_suicide   = pcmk_no_quorum_fence,

    no_quorum_demote    = pcmk_no_quorum_demote,
#endif
};

enum pcmk_scheduler_flags {
    pcmk_sched_none                     = 0ULL,

    // These flags are dynamically determined conditions

    pcmk_sched_quorate                  = (1ULL << 0),

    pcmk_sched_symmetric_cluster        = (1ULL << 1),

    pcmk_sched_in_maintenance           = (1ULL << 3),

    pcmk_sched_fencing_enabled          = (1ULL << 4),

    pcmk_sched_have_fencing             = (1ULL << 5),

    pcmk_sched_enable_unfencing         = (1ULL << 6),

    pcmk_sched_concurrent_fencing       = (1ULL << 7),

    pcmk_sched_stop_removed_resources   = (1ULL << 8),

    pcmk_sched_cancel_removed_actions   = (1ULL << 9),

    pcmk_sched_stop_all                 = (1ULL << 10),

    pcmk_sched_start_failure_fatal      = (1ULL << 12),

    pcmk_sched_remove_after_stop        = (1ULL << 13),

    pcmk_sched_startup_fencing          = (1ULL << 14),

    pcmk_sched_shutdown_lock            = (1ULL << 15),

    pcmk_sched_probe_resources          = (1ULL << 16),

    pcmk_sched_have_status              = (1ULL << 17),

    pcmk_sched_have_remote_nodes        = (1ULL << 18),

    // The remaining flags are scheduling options that must be set explicitly

    pcmk_sched_location_only            = (1ULL << 20),

    pcmk_sched_sanitized                = (1ULL << 21),

    pcmk_sched_no_counts                = (1ULL << 23),

    pcmk_sched_no_compat                = (1ULL << 24),

    pcmk_sched_output_scores            = (1ULL << 25),

    pcmk_sched_show_utilization         = (1ULL << 26),

    pcmk_sched_validate_only            = (1ULL << 27),
};

struct pe_working_set_s {
    // Be careful about when each piece of information is available and final

    xmlNode *input;                 
    crm_time_t *now;                
    char *dc_uuid;                  
    pcmk_node_t *dc_node;           
    const char *stonith_action;     
    const char *placement_strategy; 

    // @COMPAT Change to uint64_t at a compatibility break
    unsigned long long flags;       

    int stonith_timeout;            
    enum pe_quorum_policy no_quorum_policy; 
    GHashTable *config_hash;        

    GHashTable *tickets;

    GHashTable *singletons;

    GList *nodes;                   
    GList *resources;               
    GList *placement_constraints;   
    GList *ordering_constraints;    
    GList *colocation_constraints;  

    GList *ticket_constraints;

    GList *actions;                 
    xmlNode *failed;                
    xmlNode *op_defaults;           
    xmlNode *rsc_defaults;          
    int num_synapse;                
    int max_valid_nodes;            
    int order_id;                   
    int action_id;                  
    xmlNode *graph;                 
    GHashTable *template_rsc_sets;  

    // @COMPAT Replace this with a fencer variable (only place it's used)
    const char *localhost;          

    GHashTable *tags;               
    int blocked_resources;          
    int disabled_resources;         
    GList *param_check;             
    GList *stop_needed;             
    time_t recheck_by;              
    int ninstances;                 
    guint shutdown_lock;            
    int priority_fencing_delay;     

    // pcmk__output_t *
    void *priv;                     

    guint node_pending_timeout;     
};

#ifdef __cplusplus
}
#endif

#endif // PCMK__CRM_COMMON_SCHEDULER__H