cs_app_cmds.c

/************************************************************************
 * NASA Docket No. GSC-18,915-1, and identified as “cFS Checksum
 * Application version 2.5.1”
 *
 * Copyright (c) 2021 United States Government as represented by the
 * Administrator of the National Aeronautics and Space Administration.
 * All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License. You may obtain
 * a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ************************************************************************/

/**
 * @file
 *   The CFS Checksum (CS) Application's commands for checking App
 */

/*************************************************************************
 **
 ** Include section
 **
 **************************************************************************/
#include "cfe.h"
#include "cs_app.h"
#include "cs_events.h"
#include "cs_utils.h"
#include "cs_compute.h"
#include "cs_app_cmds.h"
/**************************************************************************
 **
 ** Functions
 **
 **************************************************************************/

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                 */
/* CS Disable background checking of App command                   */
/*                                                                 */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
void CS_DisableAppCmd(const CS_NoArgsCmd_t *CmdPtr)
{
    if (CS_CheckRecomputeOneshot() == false)
    {
        CS_AppData.HkPacket.Payload.AppCSState = CS_STATE_DISABLED;
        CS_ZeroAppTempValues();

#if (CS_PRESERVE_STATES_ON_PROCESSOR_RESET == true)
        CS_UpdateCDS();
#endif

        CFE_EVS_SendEvent(CS_DISABLE_APP_INF_EID, CFE_EVS_EventType_INFORMATION, "Checksumming of App is Disabled");
        CS_AppData.HkPacket.Payload.CmdCounter++;
    }
}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                 */
/* CS Enable background checking of App command                    */
/*                                                                 */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
void CS_EnableAppCmd(const CS_NoArgsCmd_t *CmdPtr)
{
    if (CS_CheckRecomputeOneshot() == false)
    {
        CS_AppData.HkPacket.Payload.AppCSState = CS_STATE_ENABLED;

#if (CS_PRESERVE_STATES_ON_PROCESSOR_RESET == true)
        CS_UpdateCDS();
#endif

        CFE_EVS_SendEvent(CS_ENABLE_APP_INF_EID, CFE_EVS_EventType_INFORMATION, "Checksumming of App is Enabled");
        CS_AppData.HkPacket.Payload.CmdCounter++;
    }
}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                 */
/* CS Report the baseline checksum of an entry in the App table    */
/*                                                                 */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
void CS_ReportBaselineAppCmd(const CS_AppNameCmd_t *CmdPtr)
{
    /* command verification variables */
    CS_Res_App_Table_Entry_t *ResultsEntry;
    char                      Name[OS_MAX_API_NAME];

    strncpy(Name, CmdPtr->Payload.Name, sizeof(Name) - 1);
    Name[sizeof(Name) - 1] = '\0';

    if (CS_GetAppResTblEntryByName(&ResultsEntry, Name))
    {
        if (ResultsEntry->ComputedYet == true)
        {
            CFE_EVS_SendEvent(CS_BASELINE_APP_INF_EID, CFE_EVS_EventType_INFORMATION,
                              "Report baseline of app %s is 0x%08X", Name, (unsigned int)ResultsEntry->ComparisonValue);
        }
        else
        {
            CFE_EVS_SendEvent(CS_NO_BASELINE_APP_INF_EID, CFE_EVS_EventType_INFORMATION,
                              "Report baseline of app %s has not been computed yet", Name);
        }
        CS_AppData.HkPacket.Payload.CmdCounter++;
    }
    else
    {
        CFE_EVS_SendEvent(CS_BASELINE_INVALID_NAME_APP_ERR_EID, CFE_EVS_EventType_ERROR,
                          "App report baseline failed, app %s not found", Name);
        CS_AppData.HkPacket.Payload.CmdErrCounter++;
    }
}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                 */
/* CS Recompute the baseline of an entry in the App table cmd      */
/*                                                                 */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
void CS_RecomputeBaselineAppCmd(const CS_AppNameCmd_t *CmdPtr)
{
    /* command verification variables */
    CFE_ES_TaskId_t           ChildTaskID;
    CFE_Status_t              Status;
    CS_Res_App_Table_Entry_t *ResultsEntry;
    char                      Name[OS_MAX_API_NAME];

    strncpy(Name, CmdPtr->Payload.Name, sizeof(Name) - 1);
    Name[sizeof(Name) - 1] = '\0';

    if (CS_AppData.HkPacket.Payload.RecomputeInProgress == false &&
        CS_AppData.HkPacket.Payload.OneShotInProgress == false)
    {
        /* make sure the entry is a valid number and is defined in the table */
        if (CS_GetAppResTblEntryByName(&ResultsEntry, Name))
        {
            /* There is no child task running right now, we can use it*/
            CS_AppData.HkPacket.Payload.RecomputeInProgress = true;

            /* fill in child task variables */
            CS_AppData.ChildTaskTable = CS_APP_TABLE;

            CS_AppData.RecomputeAppEntryPtr = ResultsEntry;

            Status = CFE_ES_CreateChildTask(&ChildTaskID, CS_RECOMP_APP_TASK_NAME, CS_RecomputeAppChildTask, NULL,
                                            CFE_PLATFORM_ES_DEFAULT_STACK_SIZE, CS_CHILD_TASK_PRIORITY, 0);
            if (Status == CFE_SUCCESS)
            {
                CFE_EVS_SendEvent(CS_RECOMPUTE_APP_STARTED_DBG_EID, CFE_EVS_EventType_DEBUG,
                                  "Recompute baseline of app %s started", Name);
                CS_AppData.HkPacket.Payload.CmdCounter++;
            }
            else /* child task creation failed */
            {
                CFE_EVS_SendEvent(CS_RECOMPUTE_APP_CREATE_CHDTASK_ERR_EID, CFE_EVS_EventType_ERROR,
                                  "Recompute baseline of app %s failed, CFE_ES_CreateChildTask returned: 0x%08X", Name,
                                  (unsigned int)Status);
                CS_AppData.HkPacket.Payload.CmdErrCounter++;
                CS_AppData.HkPacket.Payload.RecomputeInProgress = false;
            }
        }
        else
        {
            CFE_EVS_SendEvent(CS_RECOMPUTE_UNKNOWN_NAME_APP_ERR_EID, CFE_EVS_EventType_ERROR,
                              "App recompute baseline failed, app %s not found", Name);
            CS_AppData.HkPacket.Payload.CmdErrCounter++;
        }
    }
    else
    {
        /*send event that we can't start another task right now */
        CFE_EVS_SendEvent(CS_RECOMPUTE_APP_CHDTASK_ERR_EID, CFE_EVS_EventType_ERROR,
                          "App recompute baseline for app %s failed: child task in use", Name);
        CS_AppData.HkPacket.Payload.CmdErrCounter++;
    }
}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                 */
/* CS Disable a specific entry in the App table command            */
/*                                                                 */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
void CS_DisableNameAppCmd(const CS_AppNameCmd_t *CmdPtr)
{
    /* command verification variables */
    CS_Res_App_Table_Entry_t *ResultsEntry;
    CS_Def_App_Table_Entry_t *DefinitionEntry;
    char                      Name[OS_MAX_API_NAME];

    if (CS_CheckRecomputeOneshot() == false)
    {
        strncpy(Name, CmdPtr->Payload.Name, sizeof(Name) - 1);
        Name[sizeof(Name) - 1] = '\0';

        if (CS_GetAppResTblEntryByName(&ResultsEntry, Name))
        {
            ResultsEntry->State             = CS_STATE_DISABLED;
            ResultsEntry->TempChecksumValue = 0;
            ResultsEntry->ByteOffset        = 0;

            CFE_EVS_SendEvent(CS_DISABLE_APP_NAME_INF_EID, CFE_EVS_EventType_INFORMATION,
                              "Checksumming of app %s is Disabled", Name);

            if (CS_GetAppDefTblEntryByName(&DefinitionEntry, Name))
            {
                DefinitionEntry->State = CS_STATE_DISABLED;
                CS_ResetTablesTblResultEntry(CS_AppData.AppResTablesTblPtr);
                CFE_TBL_Modified(CS_AppData.DefAppTableHandle);
            }
            else
            {
                CFE_EVS_SendEvent(CS_DISABLE_APP_DEF_NOT_FOUND_DBG_EID, CFE_EVS_EventType_DEBUG,
                                  "CS unable to update apps definition table for entry %s", Name);
            }

            CS_AppData.HkPacket.Payload.CmdCounter++;
        }

        else
        {
            CFE_EVS_SendEvent(CS_DISABLE_APP_UNKNOWN_NAME_ERR_EID, CFE_EVS_EventType_ERROR,
                              "App disable app command failed, app %s not found", Name);
            CS_AppData.HkPacket.Payload.CmdErrCounter++;
        }
    }
}

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                 */
/* CS Enable a specific entry in the App table command             */
/*                                                                 */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
void CS_EnableNameAppCmd(const CS_AppNameCmd_t *CmdPtr)
{
    /* command verification variables */
    CS_Res_App_Table_Entry_t *ResultsEntry;
    CS_Def_App_Table_Entry_t *DefinitionEntry;
    char                      Name[OS_MAX_API_NAME];

    if (CS_CheckRecomputeOneshot() == false)
    {
        strncpy(Name, CmdPtr->Payload.Name, sizeof(Name) - 1);
        Name[sizeof(Name) - 1] = '\0';

        if (CS_GetAppResTblEntryByName(&ResultsEntry, Name))
        {
            ResultsEntry->State = CS_STATE_ENABLED;

            CFE_EVS_SendEvent(CS_ENABLE_APP_NAME_INF_EID, CFE_EVS_EventType_INFORMATION,
                              "Checksumming of app %s is Enabled", Name);

            if (CS_GetAppDefTblEntryByName(&DefinitionEntry, Name))
            {
                DefinitionEntry->State = CS_STATE_ENABLED;
                CS_ResetTablesTblResultEntry(CS_AppData.AppResTablesTblPtr);
                CFE_TBL_Modified(CS_AppData.DefAppTableHandle);
            }
            else
            {
                CFE_EVS_SendEvent(CS_ENABLE_APP_DEF_NOT_FOUND_DBG_EID, CFE_EVS_EventType_DEBUG,
                                  "CS unable to update apps definition table for entry %s", Name);
            }

            CS_AppData.HkPacket.Payload.CmdCounter++;
        }
        else
        {
            CFE_EVS_SendEvent(CS_ENABLE_APP_UNKNOWN_NAME_ERR_EID, CFE_EVS_EventType_ERROR,
                              "App enable app command failed, app %s not found", Name);
            CS_AppData.HkPacket.Payload.CmdErrCounter++;
        }
    }
}