action_relation_internal.h

Go to the documentation of this file.

/*
 * Copyright 2023-2024 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_ACTION_RELATION_INTERNAL__H
#define PCMK__CRM_COMMON_ACTION_RELATION_INTERNAL__H

#include <stdbool.h>                        // bool
#include <stdint.h>                         // uint32_t
#include <crm/common/scheduler_types.h>     // pcmk_resource_t, pcmk_action_t

#ifdef __cplusplus
extern "C" {
#endif

// Flags to indicate the relationship between two actions
enum pcmk__action_relation_flags {
    pcmk__ar_none                           = 0U,

    pcmk__ar_ordered                        = (1U << 0),

    pcmk__ar_if_first_unmigratable          = (1U << 1),

    pcmk__ar_then_implies_first             = (1U << 4),

    pcmk__ar_first_implies_then             = (1U << 5),

    pcmk__ar_promoted_then_implies_first    = (1U << 6),

    pcmk__ar_unmigratable_then_blocks       = (1U << 7),

    pcmk__ar_unrunnable_first_blocks        = (1U << 8),

    pcmk__ar_first_else_then                = (1U << 9),

    pcmk__ar_first_implies_same_node_then   = (1U << 10),

    pcmk__ar_nested_remote_probe            = (1U << 11),

    pcmk__ar_intermediate_stop              = (1U << 12),

    pcmk__ar_serialize                      = (1U << 14),

    pcmk__ar_if_on_same_node                = (1U << 15),

    pcmk__ar_then_implies_first_graphed     = (1U << 16),

    pcmk__ar_first_implies_then_graphed     = (1U << 17),

    pcmk__ar_asymmetric                     = (1U << 20),

    pcmk__ar_if_on_same_node_or_target      = (1U << 21),

    pcmk__ar_min_runnable                   = (1U << 22),

    pcmk__ar_if_required_on_same_node       = (1U << 23),

    pcmk__ar_guest_allowed                  = (1U << 24),

    pcmk__ar_then_cancels_first             = (1U << 25),
};

/* Action relation object
 *
 * The most common type of relation is an ordering, in which case action1 etc.
 * refers to the "first" action, and action2 etc. refers to the "then" action.
 */
typedef struct {
    int id;                     // Counter to identify relation
    uint32_t flags;             // Group of enum pcmk__action_relation_flags
    pcmk_resource_t *rsc1;      // Resource for first action, if any
    pcmk_action_t *action1;     // First action in relation
    char *task1;                // Action name or key for first action
    pcmk_resource_t *rsc2;      // Resource for second action, if any
    pcmk_action_t *action2;     // Second action in relation
    char *task2;                // Action name or key for second action
} pcmk__action_relation_t;

// Action sequenced relative to another action
typedef struct pcmk__related_action {
    pcmk_action_t *action;      // Action to be sequenced
    uint32_t flags;             // Group of enum pcmk__action_relation_flags
    bool graphed;               // Whether action has been added to graph yet
} pcmk__related_action_t;

#define pcmk__set_relation_flags(ar_flags, flags_to_set) do {           \
        ar_flags = pcmk__set_flags_as(__func__, __LINE__, LOG_TRACE,    \
                                      "Action relation", "constraint",  \
                                      ar_flags, (flags_to_set),         \
                                      #flags_to_set);                   \
    } while (0)

#define pcmk__clear_relation_flags(ar_flags, flags_to_clear) do {           \
        ar_flags = pcmk__clear_flags_as(__func__, __LINE__, LOG_TRACE,      \
                                        "Action relation", "constraint",    \
                                        ar_flags, (flags_to_clear),         \
                                        #flags_to_clear);                   \
    } while (0)

#ifdef __cplusplus
}
#endif

#endif      // PCMK__CRM_COMMON_ACTION_RELATION_INTERNAL__H