rte_safestate.h

Go to the documentation of this file.

#ifndef RTE_COMMON_SAFESTATE_H
#define RTE_COMMON_SAFESTATE_H
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum rte_safestate_level_e
{
    RTE_SAFESTATE_LEVEL_DEGRADED = 0,

    RTE_SAFESTATE_LEVEL_SAFE = 1,

    RTE_SAFESTATE_LEVEL_REBOOT = 2
} rte_safestate_level_t;

typedef uint16_t rte_safestate_reason_t;

#define RTE_SAFESTATE_REASON_UNSPECIFIED    ((rte_safestate_reason_t)0U)
#define RTE_SAFESTATE_REASON_ASSERT_FAILED  ((rte_safestate_reason_t)1U)
#define RTE_SAFESTATE_REASON_CHECKPOINT_TIMEOUT ((rte_safestate_reason_t)2U)
#define RTE_SAFESTATE_REASON_SETUP_AFTER_INIT ((rte_safestate_reason_t)3U)
#define RTE_SAFESTATE_REASON_OSA_RT_ATTRIBUTE ((rte_safestate_reason_t)4U)
#define RTE_SAFESTATE_REASON_CLOCK_FAILED ((rte_safestate_reason_t)5U)
#define RTE_SAFESTATE_REASON_APPLICATION_BASE ((rte_safestate_reason_t)4096U)

typedef void (*rte_safestate_handler_t)(rte_safestate_level_t level,
                                          rte_safestate_reason_t reason,
                                          const char *file,
                                          int32_t line,
                                          const char *message);

rte_status_t rte_safestate_register_handler(rte_safestate_level_t level,
                                               rte_safestate_handler_t handler);

void rte_safestate_enter(rte_safestate_level_t level,
                           rte_safestate_reason_t reason,
                           const char *file,
                           int32_t line,
                           const char *message);

#define RTE_ASSERT(cond)                                                    \
    do                                                                       \
    {                                                                        \
        if (!(cond))                                                         \
        {                                                                    \
            rte_safestate_enter(RTE_SAFESTATE_LEVEL_SAFE,                  \
                                  RTE_SAFESTATE_REASON_ASSERT_FAILED,        \
                                  __FILE__, (int32_t)__LINE__, #cond);        \
        }                                                                    \
    } while (0)

#define RTE_SAFESTATE(level, reason) \
    rte_safestate_enter((level), (reason), __FILE__, (int32_t)__LINE__, NULL)

#define RTE_REBOOT(reason) \
    rte_safestate_enter(RTE_SAFESTATE_LEVEL_REBOOT, (reason), __FILE__, (int32_t)__LINE__, NULL)
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_COMMON_SAFESTATE_H */
 /* SAFESTATE */