rte_site_role_policy.h

Go to the documentation of this file.

#ifndef RTE_SITE_ROLE_POLICY_H
#define RTE_SITE_ROLE_POLICY_H
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define RTE_SITE_ROLE_STANDBY_DATA_TIMEOUT_CYCLES 3U

#define RTE_SITE_ROLE_STANDBY_SYNC_RETRY_CYCLES 10U

#define RTE_SITE_ROLE_TAKEOVER_CONFIRM_VALID_CYCLES 120U

#define RTE_SITE_ROLE_BOTH_STANDBY_CYCLES 6U

typedef enum
{
    RTE_SITE_ROLE_ACTION_NONE = 0,    
    RTE_SITE_ROLE_ACTION_PROMOTE,     
    RTE_SITE_ROLE_ACTION_DEMOTE,      
    RTE_SITE_ROLE_ACTION_RENEGOTIATE, 
    RTE_SITE_ROLE_ACTION_ALARM,       
    RTE_SITE_ROLE_ACTION_WAIT         
} rte_site_role_action_t;

typedef enum
{
    RTE_SITE_ROLE_REASON_NONE = 0,
    RTE_SITE_ROLE_REASON_BOTH_FAULTED,         
    RTE_SITE_ROLE_REASON_PEER_FAULTED,         
    RTE_SITE_ROLE_REASON_RECOVERED,            
    RTE_SITE_ROLE_REASON_DISPATCHER_CONFIRMED, 
    RTE_SITE_ROLE_REASON_BOTH_STANDBY_WEST,    
    RTE_SITE_ROLE_REASON_BOTH_STANDBY_SIBLING, 
    RTE_SITE_ROLE_REASON_YIELD_TO_TAKEOVER,    
    RTE_SITE_ROLE_REASON_DUAL_ONLINE,          
    RTE_SITE_ROLE_REASON_WAITING_READY         
} rte_site_role_reason_t;

typedef struct
{
    bool     is_online;              
    bool     own_faulted;            
    bool     is_west;                
    bool     link_up;                
    bool     peer_unresponsive;      
    uint32_t cycle;                  
    uint32_t peer_last_rx_cycle;     
    bool     peer_online_now;        
    bool     peer_faulted;           
    bool     peer_snapshot_valid;    
    bool     sibling_online;         
    bool     takeover_confirmed;     
    uint32_t takeover_confirm_cycle; 
    bool     lost_peer_while_online; 
    uint32_t both_standby_cycles;    
    bool     own_ready;              
    bool     sibling_ready;          
    bool     sibling_reachable;      
} rte_site_role_input_t;

typedef struct
{
    rte_site_role_action_t action;
    rte_site_role_reason_t reason;
    uint32_t               both_standby_cycles; 
} rte_site_role_decision_t;

rte_site_role_decision_t rte_site_role_decide(const rte_site_role_input_t *in);

const char *rte_site_role_reason_text(rte_site_role_reason_t reason);

const char *rte_site_role_reason_token(rte_site_role_reason_t reason);

bool rte_site_role_standby_sync_due(bool sync_enabled, bool is_online, bool link_up, bool healthy, uint32_t cycle,
                                    uint32_t last_try);

bool rte_site_role_standby_data_stale(bool sync_enabled, bool is_online, bool have_snapshot, uint32_t cycle,
                                      uint32_t last_rx_cycle);

bool rte_site_role_takeover_allowed(bool is_online, bool own_faulted, bool peer_unresponsive, bool confirmed,
                                    uint32_t cycle, uint32_t confirm_cycle);

bool rte_site_role_both_standby_tiebreak(uint32_t both_standby_cycles, bool is_west, bool sibling_online);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_SITE_ROLE_POLICY_H */