ab_ga_route_fsm.c

Go to the documentation of this file.

 
#include "ab_ga_route_fsm.h"
 
#include "safeapi/oal/log/sapi_log.h"
#include "safeapi/utils/string/sapi_string.h"
 
static ab_ga_route_state_t status_to_state(rbc_il_route_status_t status)
{
    switch (status)
    {
        case RBC_IL_ROUTE_STATUS_NO_STATUS: return AB_GA_ROUTE_STATE_LOCKED;
        case RBC_IL_ROUTE_STATUS_FS:        return AB_GA_ROUTE_STATE_FS;
        case RBC_IL_ROUTE_STATUS_OS:        return AB_GA_ROUTE_STATE_OS;
        case RBC_IL_ROUTE_STATUS_SH:        return AB_GA_ROUTE_STATE_SH;
        case RBC_IL_ROUTE_STATUS_USED:      return AB_GA_ROUTE_STATE_USED;
        case RBC_IL_ROUTE_STATUS_DEGRADED:  return AB_GA_ROUTE_STATE_DEGRADED;
        default:                            return AB_GA_ROUTE_STATE_LOCKED;
    }
}
 
static bool state_is_stub(ab_ga_route_state_t s)
{
    return (s == AB_GA_ROUTE_STATE_OS) || (s == AB_GA_ROUTE_STATE_SH) || (s == AB_GA_ROUTE_STATE_DEGRADED);
}
 
ab_ga_route_fsm_result_t ab_ga_route_fsm_eval(ab_ga_route_state_t from,
                                              const ab_ga_il_route_cmd_t *cmd)
{
    ab_ga_route_fsm_result_t r;
 
    r.from       = from;
    r.to         = from;
    r.changed    = false;
    r.is_stub    = false;
    r.is_release = false;
 
    if (cmd == NULL)
    {
        return r;
    }
 
    if (cmd->release_route_request)
    {
        /* Release always wins and always resolves to NO_ROUTE. */
        r.is_release = true;
        r.to = AB_GA_ROUTE_STATE_NO_ROUTE;
    }
    else if (cmd->route_type == RBC_IL_ROUTE_TYPE_NO_ROUTE)
    {
        r.to = AB_GA_ROUTE_STATE_NO_ROUTE;
    }
    else /* RBC_IL_ROUTE_TYPE_LOCKED */
    {
        r.to = status_to_state(cmd->route_status);
    }
 
    r.changed = (r.to != r.from);
    r.is_stub = state_is_stub(r.to);
    return r;
}
 
static const char *state_name(ab_ga_route_state_t s)
{
    switch (s)
    {
        case AB_GA_ROUTE_STATE_NO_ROUTE: return "NO_ROUTE";
        case AB_GA_ROUTE_STATE_LOCKED:   return "LOCKED";
        case AB_GA_ROUTE_STATE_FS:       return "FS";
        case AB_GA_ROUTE_STATE_OS:       return "OS";
        case AB_GA_ROUTE_STATE_SH:       return "SH";
        case AB_GA_ROUTE_STATE_USED:     return "USED";
        case AB_GA_ROUTE_STATE_DEGRADED: return "DEGRADED";
        default:                         return "UNKNOWN";
    }
}
 
static void log_step(uint32_t cycle, const char *role_tag, uint16_t route_id,
                     const ab_ga_route_fsm_result_t *r)
{
    char storage[160];
    sapi_string_t line;
    const char *out_cstr = NULL;
 
    if (sapi_string_init(&line, storage, sizeof(storage)) != SAPI_STATUS_OK)
    {
        return;
    }
    (void)sapi_string_copy(&line, "cycle=");
    (void)sapi_string_append_u32(&line, cycle);
    (void)sapi_string_concat(&line, " role=");
    (void)sapi_string_concat(&line, (role_tag != NULL) ? role_tag : "?");
    (void)sapi_string_concat(&line, " route=");
    (void)sapi_string_append_u32(&line, (uint32_t)route_id);
    (void)sapi_string_concat(&line, " ");
    (void)sapi_string_concat(&line, state_name(r->from));
    (void)sapi_string_concat(&line, " -> ");
    (void)sapi_string_concat(&line, state_name(r->to));
    if (r->is_release)
    {
        (void)sapi_string_concat(&line, " (release)");
    }
    if (r->is_stub)
    {
        (void)sapi_string_concat(&line, " STUB: ");
        (void)sapi_string_concat(&line, state_name(r->to));
        (void)sapi_string_concat(&line, " route supervision not implemented yet");
    }
    if (sapi_string_c_str(&line, &out_cstr) == SAPI_STATUS_OK)
    {
        sapi_log_write(SAPI_LOG_LEVEL_INFO, "GA_ROUTE_FSM", out_cstr);
        /* Also to plain stdout (SAFEAPI_EXAMPLE_LOG, ga_interface.h ->
         * common_config.h) - same path every other GA log line uses, so
         * this shows up in `docker logs` / container-log assertions
         * regardless of which sapi_log backend is registered. */
        SAFEAPI_EXAMPLE_LOG("[%s] GA_ROUTE_FSM %s\n", (role_tag != NULL) ? role_tag : "?", out_cstr);
    }
}
 
ab_ga_route_fsm_result_t ab_ga_route_fsm_step(ab_gp_db_t *db, uint16_t route_id,
                                              const ab_ga_il_route_cmd_t *cmd,
                                              uint32_t cycle, const char *role_tag)
{
    ab_ga_route_state_t from;
    ab_ga_route_fsm_result_t r;
 
    from = (ab_ga_route_state_t)ab_gp_db_route_get_fsm_state(db, route_id);
    r = ab_ga_route_fsm_eval(from, cmd);
 
    log_step(cycle, role_tag, route_id, &r);
 
    if (r.changed)
    {
        (void)ab_gp_db_route_set_fsm_state(db, route_id, (uint32_t)r.to);
    }
    return r;
}