rte_voter.h

Go to the documentation of this file.

 
#ifndef RTE_VOTER_H
#define RTE_VOTER_H
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/safestate/rte_safestate.h"
#include "rte/redundancy/channel_link/rte_channel.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    RTE_VOTING_2OO2 = 1,
    RTE_VOTING_2OO3 = 2,
    RTE_VOTING_NMR = 3
} rte_voting_strategy_t;

typedef enum {
    RTE_VOTING_AGREED = 0,
    RTE_VOTING_DISAGREED = 1,
    RTE_VOTING_TIMEOUT = 2,
    RTE_VOTING_INSUFFICIENT_QUORUM = 3
} rte_voting_result_t;

typedef bool (*rte_voter_compare_fn)(const void *a, const void *b, size_t size, void *user_ctx);

typedef struct {
    rte_voting_strategy_t voting_strategy;
    uint32_t quorum_size;
    uint32_t channel_timeout_ms;
    rte_voter_compare_fn compare;
    void *compare_context;
    bool log_disagreements;
    rte_safestate_level_t safestate_level;
    rte_safestate_reason_t safestate_reason;
    void (*on_disagreement)(void *context, rte_voting_result_t result);
    void *disagreement_context;
} rte_voter_config_t;

#define RTE_VOTER_MAX_CHANNELS 8U

#define RTE_VOTER_MAX_MESSAGE_SIZE 256U

typedef struct {
    rte_voter_config_t config;
    rte_channel_t *channels[RTE_VOTER_MAX_CHANNELS];
    uint32_t channel_count;
    uint32_t total_disagreements;
    bool initialized;
} rte_voter_storage_t;

typedef rte_voter_storage_t rte_voter_t;

rte_status_t rte_voter_init(rte_voter_storage_t *storage, const rte_voter_config_t *config);

rte_status_t rte_voter_register_channel(rte_voter_t *voter, rte_channel_t *channel);

rte_status_t rte_voter_send(rte_voter_t *voter, const void *data, size_t data_size);

rte_status_t rte_voter_receive(rte_voter_t *voter, void *data, size_t data_size,
                                  rte_voting_result_t *result, size_t *bytes_received);

rte_status_t rte_voter_vote_buffers(rte_voter_t *voter, const void *const *buffers, uint32_t buffer_count,
                                       size_t data_size, rte_voting_result_t *result, void *out_data,
                                       size_t *out_size);

rte_status_t rte_voter_get_aggregated_health(const rte_voter_t *voter,
                                                uint32_t *healthy_count,
                                                uint32_t *total_disagreements);

uint32_t rte_voter_get_channel_count(const rte_voter_t *voter);

rte_channel_t *rte_voter_get_channel(const rte_voter_t *voter, uint32_t index);

rte_channel_t *rte_voter_get_channel_by_name(const rte_voter_t *voter, const char *name);

rte_status_t rte_voter_destroy(rte_voter_t *voter);
 
#ifdef __cplusplus
}
#endif

 
#endif /* RTE_VOTER_H */