rte_appmanager.h

Go to the documentation of this file.

 
#ifndef RTE_APPMANAGER_H
#define RTE_APPMANAGER_H
 
#include <stdint.h>
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
#include "rte/redundancy/voter/rte_voter.h"
#include "rte/redundancy/watchdog/rte_watchdog.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================
 * Application Manager Interface
 * ========================================================================== */

typedef enum {
    RTE_APP_STATE_UNINITIALIZED = 0,  
    RTE_APP_STATE_INITIALIZING = 1,   
    RTE_APP_STATE_RUNNING = 2,        
    RTE_APP_STATE_SHUTTING_DOWN = 3,  
    RTE_APP_STATE_SHUTDOWN = 4,       
    RTE_APP_STATE_ERROR = 5           
} rte_app_state_t;

typedef struct {
    rte_status_t (*init)(void *context);

    rte_status_t (*pre_execute)(void *context);

    rte_status_t (*execute)(void *context);

    rte_status_t (*post_execute)(void *context);

    rte_status_t (*on_checkpoint_result)(void *context, bool committed);

    rte_status_t (*shutdown)(void *context);

    const char *(*get_name)(void);

    const char *(*get_version)(void);
} rte_appmanager_operations_t;

typedef struct {
    rte_voter_t *voter;                   
    rte_duration_ms_t max_delay_ms;       
    uint32_t expected_node_count;          
    rte_watchdog_t watchdog;              
} rte_appmanager_checkpoint_config_t;

typedef struct {
    const rte_appmanager_operations_t *ops;  
    void *context;                            
    uint32_t max_iterations;                  
    uint32_t error_threshold;                 
    const rte_appmanager_checkpoint_config_t *checkpoint; 
} rte_appmanager_config_t;

typedef struct {
    rte_app_state_t state;         
    uint32_t iteration_count;       
    uint32_t error_count;           
    rte_status_t last_error;       
} rte_appmanager_state_t;
 
/* ============================================================================
 * Checkpoint marks (ADR-034)
 * ========================================================================== */

#define RTE_APPMANAGER_CHECKPOINT_SIGNATURE_SEED ((uint64_t)0xFFFFFFFFFFFFFFFFULL)

uint32_t rte_appmanager_checkpoint_fold_signature(uint64_t signature);

void rte_appmanager_checkpoint_mark(const char *file, int32_t line, const char *label);

#define RTE_CHECKPOINT_MARK() rte_appmanager_checkpoint_mark(__FILE__, (int32_t)__LINE__, NULL)

#define RTE_CHECKPOINT_MARK_LABEL(label_str) rte_appmanager_checkpoint_mark(__FILE__, (int32_t)__LINE__, (label_str))
 
/* ============================================================================
 * Application Manager API
 * ========================================================================== */

int rte_appmanager_run(const rte_appmanager_config_t *config);

rte_app_state_t rte_appmanager_get_state(void);

rte_status_t rte_appmanager_get_stats(rte_appmanager_state_t *state);

void rte_appmanager_request_shutdown(void);

rte_status_t rte_appmanager_install_default_signal_handlers(void);

void rte_appmanager_reset_state(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_APPMANAGER_H */
 /* APPMANAGER */