Fix #546 #547, api argument validation

[zanzaben]

Describe the contribution
Fixes #546
Fixes #547
Add validation for method parameters. Mostly null pointer checks for #547 and a few size checks for #546

Fixes #1119
Returning the input instead of an error code

Testing performed
Build and run unit test

Expected behavior changes
No impact to behavior

System(s) tested on
Ubuntu 20.04

Additional Context
Here is the function list from #546 and the changes done

cfe_es_api.c:CFE_ES_DeleteApp - Can get a segmentation fault if user tries to delete an APP greater than CFE_PLATFORM_ES_MAX_APPLICATIONS
CFE_ES_LocateAppRecordByID gets a pointer that is either valid or null

cfe_es_api.c:CFE_ES_ReloadApp - Can Result in Segmentation fault if APID is invalid
CFE_ES_LocateAppRecordByID gets a pointer that is either valid or null

cfe_es_api.c:CFE_ES_CreateChildTask - Input Argument 'Flags' is not validated…also it does not appear to be used anywhere, consider removing
Not changing functions in this task

cfe_es_api.c:CFE_ES_GetAppName - Consider comparing BufferLength with OS_MAX_API_NAME prior to use.
No invalid buffer length

cfe_es_api.c:CFE_ES_RegisterCDS - Consider checking if block size is less than CFE_PLATFORM_ES_MAX_BLOCK_SIZE
CFE_ES_RegisterCDSEx checks BlockSize

cfe_es_perf.c:CFE_ES_PerfLogAdd - Should check if EntryExit is either a 0 or 1
It's internal and the macro that calls it will only pass in valid values

cfe_fs_api.c:CFE_FS_InitHeader - SubType not checked
The API doesn't have a limitation for SubType

cfe_sb_api.c:CFE_SB_SubscribeFull - Quality is not checked…consider checking that it is 0 or 1
Quality is not nessacarly 1 or 0

cfe_sb_api.c:CFE_SB_ZeroCopyGetPtr - Is there a maximum message size? Consider verifying MsgSize prior to use.
Checks MsgSize

cfe_sb_api.c:CFE_SB_SubscribeLocal - MsgLim is not checked…if a max limit does exist, should add argument validation
a max limit doesn't exists

cfe_sb_util.c:CFE_SB_SetUserDataLength - Consider verifying Length of user data (if there exists a limit) and/or TotalMsgSize
Checks TotalMsgSize
cfe_tbl_api.c:CFE_TBL_GetAddresses - Can result in Segmentation fault if NumTables grows larger than max number of tables.
Needs to be enforced by user

cfe_tbl_api.c:CFE_TBL_ReleaseAddresses - Should check to make sure NumTables is less than CFE_PLATFORM_TBL_MAX_NUM_TABLES
Needs to be enforced by user

Here is a list of the functions from #547 and their new current state

cfe_es_api.c:CFE_ES_CalculateCRC
checks for NULL
cfe_es_api.c:CFE_ES_CopyToCDS
checks for NULL
cfe_es_api.c:CFE_ES_CreateChildTask
checks for NULL
cfe_es_api.c:CFE_ES_GetAppID
checks for NULL
cfe_es_api.c:CFE_ES_GetAppName
checks for NULL
cfe_es_api.c:CFE_ES_GetGenCounterIDByName
checks for NULL
cfe_es_api.c:CFE_ES_GetTaskInfo
checks for NULL
cfe_es_api.c:CFE_ES_ProcessCoreException
Method no longer exists
cfe_es_api.c:CFE_ES_RegisterCDS
checks for NULL
cfe_es_api.c:CFE_ES_RestoreFromCDS
checks for NULL
cfe_es_api.c:CFE_ES_RunLoop
Can be called with NULL
cfe_es_api.c:CFE_ES_WriteToSysLog
checks for NULL
cfe_esmempool.c:CFE_ES_GetMemPoolStats
checks for NULL
cfe_esmempool.c:CFE_ES_GetPoolBuf
checks for NULL
cfe_esmempool.c:CFE_ES_GetPoolBufInfo
checks for NULL
cfe_esmempool.c:CFE_ES_PoolCreate
Calls CFE_ES_PoolCreateEx which checks for NULL
cfe_esmempool.c:CFE_ES_PoolCreateEx
checks for NULL
cfe_esmempool.c:CFE_ES_PoolCreateNoSem
Calls CFE_ES_PoolCreateEx which checks for NULL
cfe_esmempool.c:CFE_ES_PutPoolBuf
checks for NULL
cfe_evs.c:CFE_EVS_SendEvent
checks for NULL
cfe_evs.c:CFE_EVS_SendEventWithAppID
checks for NULL
cfe_evs.c:CFE_EVS_SendTimedEvent
checks for NULL
cfe_fs_api.c:CFE_FS_InitHeader
checks for NULL
cfe_fs_api.c:CFE_FS_ReadHeader
checks for NULL
cfe_fs_api.c:CFE_FS_SetTimestamp
No pointer to check
cfe_fs_api.c:CFE_FS_WriteHeader
checks for NULL
cfe_sb_api.c:CFE_SB_CreatePipe
checks for NULL
cfe_sb_api.c:CFE_SB_ZeroCopyGetPtr
checks for NULL
cfe_sb_msg_id_util.c:CFE_SB_GetMsgId
Deprecated
cfe_sb_msg_id_util.c:CFE_SB_SetMsgId
Deprecated
cfe_sb_util.c:CFE_SB_GenerateChecksum
Deprecated
cfe_sb_util.c:CFE_SB_GetChecksum
Deprecated
cfe_sb_util.c:CFE_SB_GetCmdCode
Deprecated
cfe_sb_util.c:CFE_SB_GetMsgTime
Deprecated
cfe_sb_util.c:CFE_SB_GetTotalMsgLength
Deprecated
cfe_sb_util.c:CFE_SB_GetUserData
checks for NULL
cfe_sb_util.c:CFE_SB_GetUserDataLength
checks for NULL
cfe_sb_util.c:CFE_SB_InitMsg
Deprecated
cfe_sb_util.c:CFE_SB_MessageStringGet
checks for NULL
cfe_sb_util.c:CFE_SB_MessageStringSet
checks for NULL
cfe_sb_util.c:CFE_SB_MsgHdrSize
checks for NULL
cfe_sb_util.c:CFE_SB_SetCmdCode
Deprecated
cfe_sb_util.c:CFE_SB_SetMsgTime
Deprecated
cfe_sb_util.c:CFE_SB_SetTotalMsgLength
Deprecated
cfe_sb_util.c:CFE_SB_SetUserDataLength
checks for NULL
cfe_sb_util.c:CFE_SB_TimeStampMsg
calls CFE_MSG_SetMsgTime which checks for NULL
cfe_sb_util.c:CFE_SB_ValidateChecksum
Deprecated
cfe_tbl_api.c:CFE_TBL_GetAddress
checks for NULL
cfe_tbl_api.c:CFE_TBL_GetAddresses
checks for NULL
cfe_tbl_api.c:CFE_TBL_GetInfo
checks for NULL
cfe_tbl_api.c:CFE_TBL_Load
checks for NULL
cfe_tbl_api.c:CFE_TBL_Register
checks for NULL
cfe_tbl_api.c:CFE_TBL_Share
checks for NULL
cfe_time_api:CFE_TIME_Print
checks for NULL
cfe_time_api:CFE_TIME_RegisterSynchCallback
checks for NULL

Contributor Info - All information REQUIRED for consideration of pull request
Alex Campbell GSFC

[skliper]

@zanzaben can you address conflicts so we can get this in?

[astrogeco]

CCB 2021-02-17 PENDING fixes and conflicts.

[skliper]

@zanzaben - for the "Not needed" responses, can you add justification? Looking for the "why" to capture/record the valuable analysis you did for future reference.

[skliper]

Might have conflicts with zero copy updates related to CFE_SB_ZeroCopyHandle_t

[astrogeco]

CCB 2021-02-24 APPROVED

• change int32 to new error type

[astrogeco]

@skliper and @zanzaben are we good to merge this? Looks like there are some open discussions remaining.

[zanzaben]

I am good for it to be merged.

[skliper]

@astrogeco looks fine to me, may have conflicts with the zero copy updates but that's probably in IC?

[astrogeco]

I am good for it to be merged.

Just changed the target to IC and the conflicts popped up, can you fix them?

[zanzaben]

@astrogeco Conflicts fixed