Skip to content

Commit

Permalink
Fix #93, Adds static analysis comments and replace strncpy with snprintf
Browse files Browse the repository at this point in the history 
This commit addresses issues flagged during static analysis by:
- Adding JSC 2.1 disposition comments.
- Replacing strncpy with snprintf to enhance safety and compliance.
  • Loading branch information
jdfiguer authored and jdfiguer committed Jun 13, 2024
1 parent 69fc1b9 commit cece39c
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 18 deletions.
8 changes: 4 additions & 4 deletions fsw/src/cs_compute.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -536,20 +536,20 @@ void CS_RecomputeEepromMemoryChildTask(void)

if (Table == CS_EEPROM_TABLE)
{
strncpy(TableType, "EEPROM", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "EEPROM");
}
if (Table == CS_MEMORY_TABLE)
{
strncpy(TableType, "Memory", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "Memory");
}
if (Table == CS_CFECORE)
{
strncpy(TableType, "cFE Core", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "cFE Core");
CS_AppData.HkPacket.Payload.CfeCoreBaseline = NewChecksumValue;
}
if (Table == CS_OSCORE)
{
strncpy(TableType, "OS", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "OS");
CS_AppData.HkPacket.Payload.OSBaseline = NewChecksumValue;
}

Expand Down
2 changes: 1 addition & 1 deletion fsw/src/cs_init.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ CFE_Status_t CS_SbInit(void)
CFE_Status_t Result = CFE_SUCCESS;

/* Initialize app configuration data */
strncpy(CS_AppData.PipeName, CS_CMD_PIPE_NAME, CS_CMD_PIPE_NAME_LEN);
snprintf(CS_AppData.PipeName, sizeof(CS_AppData.PipeName), "%s", CS_CMD_PIPE_NAME);

CS_AppData.PipeDepth = CS_PIPE_DEPTH;

Expand Down
28 changes: 15 additions & 13 deletions fsw/src/cs_table_processing.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,7 @@ CFE_Status_t CS_ValidateTablesChecksumDefinitionTable(void *TblPtr)
StateField = OuterEntry->State;

/* Check for non-zero length for table name */
/* SAD: Using strlen since OuterEntry->Name is null-terminated in cs/fsw/src/cs_table_processing.c::CS_ProcessNewAppDefinitionTable() */
if (strlen(OuterEntry->Name) != 0)
{
/* Verify valid state definition */
Expand Down Expand Up @@ -357,6 +358,7 @@ CFE_Status_t CS_ValidateAppChecksumDefinitionTable(void *TblPtr)
}
BadCount++;
}
/* SAD: Using strlen since OuterEntry->Name is null-terminated in cs/fsw/src/cs_table_processing.c::CS_ProcessNewAppDefinitionTable() */
else if (strlen(OuterEntry->Name) != 0)
{
/* Verify valid state definition */
Expand Down Expand Up @@ -466,7 +468,7 @@ void CS_ProcessNewEepromMemoryDefinitionTable(const CS_Def_EepromMemory_Table_En
memcpy(&StartOfResultsTable, ResultsTblPtr, sizeof(StartOfResultsTable));
memcpy(&StartOfDefTable, DefinitionTblPtr, sizeof(StartOfDefTable));

strncpy(&TableType[0], "Undef Tbl", CS_TABLETYPE_NAME_SIZE); /* Init the table type string */
snprintf(&TableType[0], CS_TABLETYPE_NAME_SIZE, "%s", "Undef Tbl"); /* Init the table type string */

/* We don't want to be doing chekcksums while changing the table out */
if (Table == CS_EEPROM_TABLE)
Expand Down Expand Up @@ -528,11 +530,11 @@ void CS_ProcessNewEepromMemoryDefinitionTable(const CS_Def_EepromMemory_Table_En
{
if (Table == CS_EEPROM_TABLE)
{
strncpy(&TableType[0], "EEPROM", CS_TABLETYPE_NAME_SIZE);
snprintf(&TableType[0], CS_TABLETYPE_NAME_SIZE, "%s", "EEPROM");
}
if (Table == CS_MEMORY_TABLE)
{
strncpy(&TableType[0], "Memory", CS_TABLETYPE_NAME_SIZE);
snprintf(&TableType[0], CS_TABLETYPE_NAME_SIZE, "%s", "Memory");
}

CFE_EVS_SendEvent(CS_PROCESS_EEPROM_MEMORY_NO_ENTRIES_INF_EID, CFE_EVS_EventType_INFORMATION,
Expand Down Expand Up @@ -825,7 +827,7 @@ CFE_Status_t CS_TableInit(CFE_TBL_Handle_t *DefinitionTableHandle, CFE_TBL_Handl
osal_id_t Fd = OS_OBJECT_ID_UNDEFINED;
char TableType[CS_TABLETYPE_NAME_SIZE];

strncpy(TableType, "Undef Tbl", CS_TABLETYPE_NAME_SIZE); /* Init table type */
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "Undef Tbl"); /* Init table type */

SizeOfTable = NumEntries * SizeofResultsTableEntry;

Expand Down Expand Up @@ -904,19 +906,19 @@ CFE_Status_t CS_TableInit(CFE_TBL_Handle_t *DefinitionTableHandle, CFE_TBL_Handl
{
if (Table == CS_EEPROM_TABLE)
{
strncpy(TableType, "EEPROM", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "EEPROM");
}
if (Table == CS_MEMORY_TABLE)
{
strncpy(TableType, "Memory", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "Memory");
}
if (Table == CS_TABLES_TABLE)
{
strncpy(TableType, "Tables", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "Tables");
}
if (Table == CS_APP_TABLE)
{
strncpy(TableType, "Apps", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "Apps");
}

CFE_EVS_SendEvent(CS_TBL_INIT_ERR_EID, CFE_EVS_EventType_ERROR,
Expand Down Expand Up @@ -967,7 +969,7 @@ CFE_Status_t CS_HandleTableUpdate(void *DefinitionTblPtr, void *ResultsTblPtr, C
int32 Loop = 0;
char TableType[CS_TABLETYPE_NAME_SIZE];

strncpy(TableType, "Undef Tbl", CS_TABLETYPE_NAME_SIZE); /* Init table type */
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "Undef Tbl"); /* Init table type */

/* Below, there are several values that are returned and assigned, but never evaluated. */
/* This is done so intentionally, as it helps us with Source-Level debugging this functions. */
Expand Down Expand Up @@ -1031,19 +1033,19 @@ CFE_Status_t CS_HandleTableUpdate(void *DefinitionTblPtr, void *ResultsTblPtr, C
{
if (Table == CS_EEPROM_TABLE)
{
strncpy(TableType, "EEPROM", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "EEPROM");
}
if (Table == CS_MEMORY_TABLE)
{
strncpy(TableType, "Memory", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "Memory");
}
if (Table == CS_TABLES_TABLE)
{
strncpy(TableType, "Table", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "Table");
}
if (Table == CS_APP_TABLE)
{
strncpy(TableType, "App", CS_TABLETYPE_NAME_SIZE);
snprintf(TableType, CS_TABLETYPE_NAME_SIZE, "%s", "App");
}

/* There was a problem somewhere, generate an event */
Expand Down

0 comments on commit cece39c

Please sign in to comment.