1 /*
2  * Copyright 2014-2021 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 PENGINE__H
11 #  define PENGINE__H
12 
13 typedef struct rsc_ticket_s rsc_ticket_t;
14 typedef struct lrm_agent_s lrm_agent_t;
15 
16 #  include <glib.h>
17 #  include <crm/crm.h>
18 #  include <crm/common/iso8601.h>
19 #  include <crm/pengine/rules.h>
20 #  include <crm/pengine/common.h>
21 #  include <crm/pengine/status.h>
22 
23 #  include <crm/pengine/complex.h>
24 
25 enum pe_stop_fail {
26     pesf_block,
27     pesf_stonith,
28     pesf_ignore
29 };
30 
31 enum pe_weights {
32     pe_weights_none = 0x0,
33     pe_weights_init = 0x1,
34     pe_weights_forward = 0x4,
35     pe_weights_positive = 0x8,
36     pe_weights_rollback = 0x10,
37 };
38 
39 typedef struct {
40     const char *id;
41     const char *node_attribute;
42     pe_resource_t *rsc_lh;
43     pe_resource_t *rsc_rh;
44 
45     int role_lh;
46     int role_rh;
47 
48     int score;
49     bool influence; // Whether rsc_lh should influence active rsc_rh placement
50 } pcmk__colocation_t;
51 
52 enum loss_ticket_policy_e {
53     loss_ticket_stop,
54     loss_ticket_demote,
55     loss_ticket_fence,
56     loss_ticket_freeze
57 };
58 
59 struct rsc_ticket_s {
60     const char *id;
61     pe_resource_t *rsc_lh;
62     pe_ticket_t *ticket;
63     enum loss_ticket_policy_e loss_policy;
64 
65     int role_lh;
66 };
67 
68 extern gboolean stage0(pe_working_set_t * data_set);
69 extern gboolean probe_resources(pe_working_set_t * data_set);
70 extern gboolean stage2(pe_working_set_t * data_set);
71 extern gboolean stage3(pe_working_set_t * data_set);
72 extern gboolean stage4(pe_working_set_t * data_set);
73 extern gboolean stage5(pe_working_set_t * data_set);
74 extern gboolean stage6(pe_working_set_t * data_set);
75 extern gboolean stage7(pe_working_set_t * data_set);
76 extern gboolean stage8(pe_working_set_t * data_set);
77 
78 extern gboolean summary(GList *resources);
79 
80 extern gboolean unpack_constraints(xmlNode * xml_constraints, pe_working_set_t * data_set);
81 
82 extern gboolean shutdown_constraints(pe_node_t * node, pe_action_t * shutdown_op,
83                                      pe_working_set_t * data_set);
84 
85 void pcmk__order_vs_fence(pe_action_t *stonith_op, pe_working_set_t *data_set);
86 
87 extern int custom_action_order(pe_resource_t * lh_rsc, char *lh_task, pe_action_t * lh_action,
88                                pe_resource_t * rh_rsc, char *rh_task, pe_action_t * rh_action,
89                                enum pe_ordering type, pe_working_set_t * data_set);
90 
91 extern int new_rsc_order(pe_resource_t * lh_rsc, const char *lh_task,
92                          pe_resource_t * rh_rsc, const char *rh_task,
93                          enum pe_ordering type, pe_working_set_t * data_set);
94 
95 #  define order_start_start(rsc1,rsc2, type)				\
96     new_rsc_order(rsc1, CRMD_ACTION_START, rsc2, CRMD_ACTION_START, type, data_set)
97 #  define order_stop_stop(rsc1, rsc2, type)				\
98     new_rsc_order(rsc1, CRMD_ACTION_STOP, rsc2, CRMD_ACTION_STOP, type, data_set)
99 
100 extern void graph_element_from_action(pe_action_t * action, pe_working_set_t * data_set);
101 extern void add_maintenance_update(pe_working_set_t *data_set);
102 xmlNode *pcmk__schedule_actions(pe_working_set_t *data_set, xmlNode *xml_input,
103                                 crm_time_t *now);
104 bool pcmk__ordering_is_invalid(pe_action_t *action, pe_action_wrapper_t *input);
105 
106 extern const char *transition_idle_timeout;
107 
108 /*!
109  * \internal
110  * \brief Check whether colocation's left-hand preferences should be considered
111  *
112  * \param[in] colocation  Colocation constraint
113  * \param[in] rsc         Right-hand instance (normally this will be
114  *                        colocation->rsc_rh, which NULL will be treated as,
115  *                        but for clones or bundles with multiple instances
116  *                        this can be a particular instance)
117  *
118  * \return true if colocation influence should be effective, otherwise false
119  */
120 static inline bool
pcmk__colocation_has_influence(const pcmk__colocation_t * colocation,const pe_resource_t * rsc)121 pcmk__colocation_has_influence(const pcmk__colocation_t *colocation,
122                                const pe_resource_t *rsc)
123 {
124     if (rsc == NULL) {
125         rsc = colocation->rsc_rh;
126     }
127 
128     /* The left hand of a colocation influences the right hand's location
129      * if the influence option is true, or the right hand is not yet active.
130      */
131     return colocation->influence || (rsc->running_on == NULL);
132 }
133 
134 #endif
135