rte_cross_comparator.h

Go to the documentation of this file.

 
#ifndef RTE_CROSS_COMPARATOR_H
#define RTE_CROSS_COMPARATOR_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"
#include "rte/redundancy/voter/rte_voter.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    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_cross_comparator_config_t;

#define RTE_CROSS_COMPARATOR_MAX_MESSAGE_SIZE 256U

typedef struct {
    rte_cross_comparator_config_t config;
    rte_channel_t *channel_a;
    rte_channel_t *channel_b;
    uint32_t registered_count;
    uint32_t total_disagreements;
    bool initialized;
} rte_cross_comparator_storage_t;

typedef rte_cross_comparator_storage_t rte_cross_comparator_t;

rte_status_t rte_cross_comparator_init(rte_cross_comparator_storage_t *storage,
                                          const rte_cross_comparator_config_t *config);

rte_status_t rte_cross_comparator_register_channel(rte_cross_comparator_t *cmp,
                                                      rte_channel_t *channel);

rte_status_t rte_cross_comparator_execute(rte_cross_comparator_t *cmp, size_t data_size,
                                             rte_voting_result_t *result,
                                             void *out_data, size_t *out_size);

rte_status_t rte_cross_comparator_execute_buffers(rte_cross_comparator_t *cmp,
                                                      const void *local_data, const void *peer_data,
                                                      size_t data_size,
                                                      rte_voting_result_t *result,
                                                      void *out_data, size_t *out_size);

rte_status_t rte_cross_comparator_get_aggregated_health(const rte_cross_comparator_t *cmp,
                                                           uint32_t *healthy_count,
                                                           uint32_t *total_disagreements);

rte_status_t rte_cross_comparator_destroy(rte_cross_comparator_t *cmp);
 
#ifdef __cplusplus
}
#endif

 
#endif /* RTE_CROSS_COMPARATOR_H */