cFE Integration candidate: 2021-01-19 #1109

astrogeco · 2021-01-21T15:33:28Z

Describe the contribution

Fix #1074, Refactor CFE_TIME_RegisterSynchCallback
Fix #449, Add OS_printf to CFE_ES_SYSLOG_APPEND
Fix #488, Pad msg headers to 64 bit
Fix #903, Add CFE_SB_GetUserData padding check
Fix #877, Remove duplicate CFE_MISSION_REV define
Fix #901, Remove UT_CheckForOpenSockets references
Fix #904, Update cpuname targets.cmake documentation
Fix #1090, UT event check bounds
Fix #1052, Refactor UT_ClearForceFail to UT_ClearDefaultReturnValue
Fix #1068, Create Security Policy
Fix #933, Remove SenderReporting from SB global
Fix #985, globalize "resource ID" definitions
Fix #1073, refactor SB API for proper global locks
Fix #945, Finish CFE_PLATFORM_ES_PERF_MAX_IDS removal
Fix #954, Handle debug events in unit test
Fix #955, Remove OS_printf stub count checks in UT
Fix #1089, Cleanup strncpy use - unit tests
Fix #1089, Cleanup strncpy use - main code
Fix #932, Update UT for CFE_MISSION* string sizing
Fix #1134, Add UtDebug output to CFE_ES_WriteToSysLog stub

Testing performed
See https://github.com/nasa/cFS/pull/177/checks

Expected behavior changes

PR #1048 - Documentation: Add Security.md with instructions to report vulnerability

PR #1086 - Documentation: Update cpuname/MISSION_CPUNAMES documentation

PR #1091 - Fixes UT_CheckEventHistoryFromFunc() helper routine to read the correct number of IDs so it checks the correct number of events. Also correct bad event checks in TBL UT.

PR #1076 - Adds OS_printf to CFE_ES_SYSLOG_APPEND so it matches CFE_ES_WriteToSysLog

PR #1099 - Removes unused SenderReporting and CFE_PLATFORM_SB_DEFAULT_REPORT_SENDER

PR #1106 - Tests pass when debug events are enabled via CFE_PLATFORM_EVS_DEFAULT_TYPE_FLAG in platform config.

PR #1085 - Removes references to UT_CheckForOpenSockets which is no longer applicable since the UT framework resets the state for each unit test.

PR #1053 - Rename UT_ClearForceFail as UT_ClearDefaultValue given change in nasa/osal#724

PR #905 - Adds checks that ensure CFE_SB_GetUserData works with all payload data types.

PR #1077

Adds header padding to 64-bit so that CFE_SB_GetUserData will work for message structures with elements up to 64 bit
For primary-only header config: telemetry header required to 64 bit boundary (affects all receivers)
For primary and extended header config: command header required padding to 64 bit boundary (affects all senders)

PR #1075 - Refactor CFE_TIME_RegisterSynchCallback to only have one return point and eliminates "possible uninitialized variable" static analysis warning

PR #1092 - None of these changes are expected to cause problematic.

Addresses message delivery issues due to inconsistent locking by reworking cFE-SB API implementation. Ensures all events are generated and counters are incremented consistently by avoiding early returns in functions and using the PendingEventID register to record what event ID should be sent per the current operation.
Employs the CFE_ES_ResourceID_t type and related patterns for managing the SB Pipe IDs. In particular this (intentionally) makes it not possible
Will break code which directly accessed these items without going through the lookup function.
CFE_SB_PipeId_t type is no longer usable as a direct array index, increased in size from 8 to 32 bits, and is now consistent with all other ID types in both behavior and size.
The "pipe stats" structure in the Pipe TLM is also changed. This structure contained a CFE_SB_PipeId_t value, hence why it had to be updated because the type is now bigger. The spare bytes are also moved to the end of the struct.

PR #1107 - Removes OS_printf checks of stub calls in unit tests and checks for specific format string in history instead to confirm the right path was taken.

PR #1084 - Removes CFE_MISSION_REV from platform config.

PR #1104 - Removes the rest of the references and uses of CFE_PLATFORM_ES_PERF_MAX_IDS in favor of CFE_MISSION_ES_PERF_MAX_IDS

PR #1098

Remove uses of strncpy and other minor hardcoded references
Cleanup unit tests to reflect size changes in CFE_MISSION_MAX_API_LEN and CFE_MISSION_MAX_PATH_LEN.
Moved ES pipe name and lengths to defines
Removed PipeName and PipeDepth variables from app global
Removed unnecessary (char *) casts
Simplified &stingname[0] to stringname where observed
Enables projects that have OSs with different limits to maintain a standard cmd/tlm and have unit tests pass.

PR #1135 - Make CFE_ES_WriteToSysLog stub unit test more informative by adding UtDebug output

System(s) tested on
Ubuntu 18.04

Additional context
Part of nasa/cFS#177

Third party code
None

Contributor Info - All information REQUIRED for consideration of pull request
@skliper
@zanzaben
@ArielSAdamsNASA
@jphickey

- One return point - Eliminates "possible uninitialized variable" static analysis warning

Divide the "position" (in bytes) by the size of the event IDs to get the number of events. Also correct bad event checks in TBL UT.

Move certain definitions related to the CFE_ES_ResourceID_t type into the global CFE include files. This introduces two new headers: cfe_resourceid.h (public) cfe_resourceid_internal.h (private to CFE core apps) This allows other CFE core apps, such as SB, to use the CFE_ES_ResourceID_t using the same manipulators.

Significant refactor of many SB API calls to address inconsistencies with respect to locking and unlocking of global data structures. First this updates the definition of CFE_SB_PipeId_t to use the CFE_ES_ResourceID_t base type, and a new ID range. Notably this prevents direct access to the CFE_SB.PipeTbl global, forcing code to go through the proper lookup routine, which should only be done while locked. All API implementations follow the same general pattern: - Initial checks/queries while unlocked - Lock SB global - Lookups and/or modifications to the pipe table/routing info - Unlock SB global - Invoke other subsystems (e.g. OSAL) - Re-lock SB global (if needed) do final update, and unlock again - Send all events All error counters should be updated at the end, while still locked. All event processing is deferred to the end of each function, after all other processing is done.

Fix #1068, Create cFE Security Policy Markdown

Fix #904, Update cpuname targets.cmake documentation

Fix #1090, UT event check bounds

Fix #449, Add OS_printf to CFE_ES_SYSLOG_APPEND

Fix #933, Remove SenderReporting from SB global

Fix #954, Handle debug events in unit test

Fix #901, Remove UT_CheckForOpenSockets references

Fix #1052, Refactor UT_ClearForceFail to UT_ClearDefaultReturnValue

Fix #903, Add CFE_SB_GetUserData padding check

astrogeco · 2021-01-25T02:41:45Z

@skliper #905 broke one of the tests.

 The following tests FAILED:
Errors while running CTest
	 70 - cfe-core_sb_UT (Failed)
make: *** [test] Error 8

See https://github.com/nasa/cFS/runs/1759255844

Fix #488, Pad msg headers to 64 bit

Fix #1074, Refactor CFE_TIME_RegisterSynchCallback

Fix #1073, software bus locking

skliper · 2021-01-25T13:29:33Z

@astrogeco - is it working now that you added #1077? #905 was marked as dependent.

astrogeco · 2021-01-25T14:04:30Z

@astrogeco - is it working now that you added #1077? #905 was marked as dependent.

Yeah, I found it, sorry!

astrogeco · 2021-01-25T14:05:28Z

@astrogeco - is it working now that you added #1077? #905 was marked as dependent.

Yeah, I found it, sorry!

I didn't catch the dependency on #1077 because it was in the comments.

Fix #955, Remove OS_printf stub count checks in UT

…em_all Fix #877, Remove duplicate CFE_MISSION_REV define

Fix #945, Finish CFE_PLATFORM_ES_PERF_MAX_IDS removal

Fix #932 and #1089, strncpy cleanup and UT updates for mission sizing of API_LEN and PATH_LEN

Define a data structure in cfe_sb_msg.h that will be used with the "write pipe info" command (CFE_SB_SEND_PIPE_INFO_CC). This allows the internal CFE_SB_PipeD_t descriptor object to evolve as needed without affecting the binary format of the file that is generated form this command, and items such as memory pointers may be excluded from the file.

Fix #982, separate pipeinfo file data structure

Fix #1134, Add UtDebug output to CFE_ES_WriteToSysLog stub

Update ReadMe

cFE Integration candidate: 2021-01-19

Combines: nasa/cFE#1109 nasa/osal#767 nasa/PSP#243 nasa/sample_app#121 nasa/ci_lab#68 nasa/to_lab#79 nasa/sch_lab#62 nasa/sample_lib#41 nasa/tblCRCTool#29 nasa/elf2cfetbl#65 nasa/cFS-GroundSystem#150

skliper and others added 18 commits January 7, 2021 12:44

Fix #1074, Refactor CFE_TIME_RegisterSynchCallback

ad74393

- One return point - Eliminates "possible uninitialized variable" static analysis warning

Fix #449, Add OS_printf to CFE_ES_SYSLOG_APPEND

73717b8

Fix #488, Pad msg headers to 64 bit

778aafb

Fix #903, Add CFE_SB_GetUserData padding check

856c88a

Fix #877, Remove duplicate CFE_MISSION_REV define

1b31bd9

Fix #901, Remove UT_CheckForOpenSockets references

483b7c0

Fix #904, Update cpuname targets.cmake documentation

a32ed2a

Fix #1090, UT event check bounds

ad9ae56

Divide the "position" (in bytes) by the size of the event IDs to get the number of events. Also correct bad event checks in TBL UT.

Fix #1052, Refactor UT_ClearForceFail to UT_ClearDefaultReturnValue

266ed95

Fix #1068, Create Security Policy

63b4347

Fix #933, Remove SenderReporting from SB global

3852145

Fix #945, Finish CFE_PLATFORM_ES_PERF_MAX_IDS removal

21bf38a

Fix #954, Handle debug events in unit test

d1c5ab0

Fix #955, Remove OS_printf stub count checks in UT

fc97a62

Merge pull request #1048 from ArielSAdamsNASA/main

4d406db

Fix #1068, Create cFE Security Policy Markdown

Merge pull request #1086 from skliper/fix904-cpuname_doc

8559cf3

Fix #904, Update cpuname targets.cmake documentation

astrogeco added the IC:2021-01-19 label Jan 21, 2021

Merge pull request #1091 from jphickey/fix-1090-ut-eventcheck-bounds

0658a01

Fix #1090, UT event check bounds

astrogeco added a commit to nasa/cFS that referenced this pull request Jan 21, 2021

Add nasa/cFE#1109

84fe1d2

astrogeco added 6 commits January 21, 2021 13:04

Merge pull request #1076 from skliper/fix449-consistent_log

bd87123

Fix #449, Add OS_printf to CFE_ES_SYSLOG_APPEND

Merge pull request #1099 from skliper/fix933-rm_senderreporting

f9abb48

Fix #933, Remove SenderReporting from SB global

Merge pull request #1106 from skliper/fix954-test_w_debug_events

9f8a776

Fix #954, Handle debug events in unit test

Merge pull request #1085 from skliper/fix901-rm-ut-checkforopensockets

c403d0e

Fix #901, Remove UT_CheckForOpenSockets references

Merge pull request #1053 from zanzaben/fix1052_Rename_UT_ClearForceFail

6618ce1

Fix #1052, Refactor UT_ClearForceFail to UT_ClearDefaultReturnValue

Merge pull request #905 from skliper/fix903-getuserdata-padcheck

6ca043d

Fix #903, Add CFE_SB_GetUserData padding check

astrogeco added 2 commits January 24, 2021 21:45

Merge pull request #1077 from skliper/fix488-header_alignment

a68947e

Fix #488, Pad msg headers to 64 bit

Merge pull request #1075 from skliper/fix1074-multiple_returns

c9f9d42

Fix #1074, Refactor CFE_TIME_RegisterSynchCallback

Merge pull request #1092 from jphickey/fix-1073-sb-locking

95ec2da

Fix #1073, software bus locking

astrogeco and others added 7 commits January 25, 2021 11:37

Merge pull request #1107 from skliper/fix955-os_printf_count

1927e61

Fix #955, Remove OS_printf stub count checks in UT

Merge pull request #1084 from skliper/fix877-one_missionrev_2_rule_th…

5b1d054

…em_all Fix #877, Remove duplicate CFE_MISSION_REV define

Merge pull request #1104 from skliper/fix945-platform_perf_max_id

cc514bc

Fix #945, Finish CFE_PLATFORM_ES_PERF_MAX_IDS removal

Fix #1089, Cleanup strncpy use - unit tests

28c746c

Fix #1089, Cleanup strncpy use - main code

5edcf20

Fix #932, Update UT for CFE_MISSION* string sizing

26a0e06

Merge pull request #1098 from skliper/fix1089-clean_strncpy

a4aa481

Fix #932 and #1089, strncpy cleanup and UT updates for mission sizing of API_LEN and PATH_LEN

astrogeco mentioned this pull request Jan 25, 2021

cFS Bundle Integration candidate: 2021-01-19 nasa/cFS#177

Merged

jphickey and others added 2 commits January 26, 2021 10:25

Merge pull request #1102 from jphickey/fix-982-separate-pipeinfo

79cfde6

Fix #982, separate pipeinfo file data structure

jphickey force-pushed the integration-candidate branch from 7d0845c to 79cfde6 Compare January 26, 2021 15:28

skliper and others added 3 commits January 26, 2021 16:31

Fix #1134, Add UtDebug output to CFE_ES_WriteToSysLog stub

383438d

Merge pull request #1135 from skliper/fix1134-writetosyslog_utdebug

a991e96

Fix #1134, Add UtDebug output to CFE_ES_WriteToSysLog stub

Bump to v6.8.0-rc1+dev290

f221911

Update ReadMe

astrogeco force-pushed the integration-candidate branch from 4d03efa to f221911 Compare January 27, 2021 00:09

astrogeco marked this pull request as ready for review January 27, 2021 04:18

astrogeco merged commit 258625f into main Jan 27, 2021

astrogeco added a commit that referenced this pull request Jan 27, 2021

Merge pull request #1109 from nasa/integration-candidate

4374482

cFE Integration candidate: 2021-01-19

skliper added this to the 7.0.0 milestone Sep 24, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cFE Integration candidate: 2021-01-19 #1109

cFE Integration candidate: 2021-01-19 #1109

astrogeco commented Jan 21, 2021 •

edited

Loading

astrogeco commented Jan 25, 2021

skliper commented Jan 25, 2021

astrogeco commented Jan 25, 2021

astrogeco commented Jan 25, 2021

cFE Integration candidate: 2021-01-19 #1109

cFE Integration candidate: 2021-01-19 #1109

Conversation

astrogeco commented Jan 21, 2021 • edited Loading

astrogeco commented Jan 25, 2021

skliper commented Jan 25, 2021

astrogeco commented Jan 25, 2021

astrogeco commented Jan 25, 2021

astrogeco commented Jan 21, 2021 •

edited

Loading