rte_redundancy_config.h

Go to the documentation of this file.

#ifndef RTE_REDUNDANCY_CONFIG_H
#define RTE_REDUNDANCY_CONFIG_H
 
#include <stdint.h>
#include <stdbool.h>
#include "rte/utils/status/rte_status.h"
#include "rte/redundancy/voter/rte_voter.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define RTE_REDUNDANCY_CONFIG_MAX_ROLE_NAME_LEN 16U

#define RTE_REDUNDANCY_CONFIG_MAX_REPLICAS 5U

#define RTE_REDUNDANCY_CONFIG_MAX_FILE_SIZE 8192U

#define RTE_CHANNEL_CONFIG_MAX_CHANNELS 32U

#define RTE_CHANNEL_CONFIG_MAX_NAME_LEN 32U

#define RTE_CHANNEL_CONFIG_MAX_HOST_LEN 64U

typedef enum {
    RTE_CHANNEL_TRANSPORT_FLOW = 0,
    RTE_CHANNEL_TRANSPORT_POSIX_NETLINK = 1,
    RTE_CHANNEL_TRANSPORT_DDS = 2
} rte_channel_transport_t;

typedef enum {
    RTE_CHANNEL_ROLE_LISTEN = 0,
    RTE_CHANNEL_ROLE_CONNECT = 1
} rte_channel_role_t;

typedef struct {
    uint32_t                 id;
    char                     name[RTE_CHANNEL_CONFIG_MAX_NAME_LEN];
    rte_channel_transport_t transport;
    rte_channel_role_t      role;
    char                     host[RTE_CHANNEL_CONFIG_MAX_HOST_LEN];
    uint16_t                 port;
    uint32_t                 message_size;
    uint32_t                 connect_timeout_ms;
    uint32_t                 rcvbuf_bytes;
    uint32_t                 sndbuf_bytes;
} rte_channel_def_t;

typedef enum {
    RTE_REDUNDANCY_TOPOLOGY_2OO2 = 0,
    RTE_REDUNDANCY_TOPOLOGY_2OO2_REDUNDANT = 1,
    RTE_REDUNDANCY_TOPOLOGY_2OO3 = 2,
    RTE_REDUNDANCY_TOPOLOGY_NMR = 3
} rte_redundancy_topology_t;

typedef enum {
    RTE_STANDBY_MODE_HOT = 0,
    RTE_STANDBY_MODE_WARM = 1,
    RTE_STANDBY_MODE_COLD = 2
} rte_standby_mode_t;

typedef struct {
    rte_redundancy_topology_t topology;
    uint32_t replica_count;
    uint32_t quorum_size;
    rte_standby_mode_t standby_mode;
    uint32_t role_count;
    char roles[RTE_REDUNDANCY_CONFIG_MAX_REPLICAS][RTE_REDUNDANCY_CONFIG_MAX_ROLE_NAME_LEN];
    uint32_t channel_count;
    rte_channel_def_t channels[RTE_CHANNEL_CONFIG_MAX_CHANNELS];
} rte_redundancy_config_t;

rte_status_t rte_redundancy_config_standby_mode_from_string(const char *name, rte_standby_mode_t *out_mode);

const char *rte_redundancy_config_standby_mode_to_string(rte_standby_mode_t mode);

rte_status_t rte_redundancy_config_topology_from_string(const char *name,
                                                           rte_redundancy_topology_t *out_topology);

const char *rte_redundancy_config_topology_to_string(rte_redundancy_topology_t topology);

typedef bool (*rte_redundancy_capability_fn)(rte_redundancy_topology_t topology, uint32_t replica_count,
                                               void *context);

rte_status_t rte_redundancy_config_register_capability(rte_redundancy_capability_fn fn, void *context);

rte_status_t rte_redundancy_config_load(const char *path, rte_redundancy_config_t *out_config);

rte_status_t rte_redundancy_config_apply_to_voter(const rte_redundancy_config_t *config,
                                                     rte_voter_config_t *voter_cfg);

rte_status_t rte_channel_config_transport_from_string(const char *name, rte_channel_transport_t *out_transport);

rte_status_t rte_channel_config_role_from_string(const char *name, rte_channel_role_t *out_role);

rte_status_t rte_redundancy_config_find_channel_by_name(const rte_redundancy_config_t *config,
                                                          const char *name,
                                                          rte_channel_def_t *out_channel);

rte_status_t rte_redundancy_config_find_channel_by_id(const rte_redundancy_config_t *config,
                                                        uint32_t id,
                                                        rte_channel_def_t *out_channel);

const rte_redundancy_config_t *rte_redundancy_config_get_active(void);

void rte_redundancy_config_set_active(const rte_redundancy_config_t *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_REDUNDANCY_CONFIG_H */