cFE Integration candidate: 2021-02-02 #1150

astrogeco · 2021-02-03T02:49:28Z

Describe the contribution
Fix #1070, patch PSP include directory reference
Fix #1108, split resource id functions into module
Fix #723, CFE_EVS_Register const correct and report truncation
Fix #680, Remove table service exclusion logic
Fix #609, Remove CFE_PLATFORM_EVS_LOG_ON undefined option to diasble log
Fix #915, Check for file existence in CFE_ES_RestartApp
Fix #1122, ES and EVS use default message limits
Fix #1123, Convert global CFE_SB_Default_Qos to macro
Fix #780, Hex output for return checking ASSERTs
Fix #986, Remove unnecessary CFE_MSG_Init in TBL
Fix #1069, Resolve mismatched types in SBR throttle
Fix #1071, Initialize Status in CFE_ES_WaitForSystemState
Fix #1110, Remove unimplemented ES prototypes
Fix #1014, Remove Test_SB_Cmds_SubRptUnexpCmdCode
Fix #997, Simplify UT_InitData SB setup
Fix #996, Remove CFE_PLATFORM_SB_MAX_PIPE_DEPTH in favor of OS_QUEUE_…
Fix #1100, Update highest MsgId documentation/verification
Fix #793, Clarify restart/reload app behavior
Fix #1036, Clear task data in EarlyInit and standardize name
Fix #1032, Send->Write name update for SB write cmds
Fix #1141, PipeName unset with debug event
Fix #1145, Update workflow action badge
Fix #1144, Add workflow action timeout
Fix #1108, clean up ifdef blocks
Fix #1162, Add CodeQL analysis to workflow

HOTFIX for #1136, update doxygen refs
HOTFIX for #1136, remove ref to CFEESResourceIDBase

Testing performed
See https://github.com/nasa/cfs/pull/182/checks

Expected behavior changes

PR #1072 and #1139 - Corrects reference to PSP header file location. Build now succesfully completes the build succeeds again when using add_psp_module() in custom CMakeLists file.

PR #1118 - Replace "send" with "write" in names for commands that write files. For example, CFE_SB_**SEND**_ROUTING_INFO_CC is now CFE_SB_**WRITE**_ROUTING_INFO_CC. Updates function names, command code names and comments.

PR #1112 - Removes incorrectly implemented deferred return code of -1 for CFE_SB_ReceiveBuffer from software bus setup in UT_InitData.

PR #1121 - Implements more informative assert messages by making SETUP, TEARDOWN, ASSERT print 0x%lx while ASSERT_EQ now prints both %lfand0x%lx` format for the inputs

PR #1146 - Updates continuous-integration badges in ReadMe.md. The badges now reflect the success status of different runs.

PR #1113 - Remove Test_SB_Cmds_SubRptUnexpCmdCode which was a duplicate of Test_SB_Cmds_CmdUnexpCmdCode and did not implement any new tests.

PR #1115 - Initializes status in CFE_ES_WaitForSystemState and adds missing success test case so the function doesn't return an uninitialized Status.

PR #1120 - Removes the HkPacket and TblRegPacket message initializations from CFE_TBL_EarlyInit since they are initialized in CFE_TBL_InitData. Moves the NotifyMsg message initialization to CFE_TBL_InitData and sets the message ID each time it's sent from CFE_TBL_SendNotificationMsg. Possibly results in small performance improvement since the message isn't initialized every call.

PR #1114 - Removes unimplemented CFE_ES_AppGetList and CFE_ES_AppDumpAllInfo prototypes.

PR #1147 - Adds a 15-minute timeout to continuous integration workflows to prevent excess resource utilization.

PR #1142 - Makes debug subscription events only print the Pipe ID, not a name, in the debug events.

PR #1101 - Updates the documentation and verification for CFE_PLATFORM_SB_HIGHEST_VALID_MSGID to allows the full range of values.

PR #1083 - Clarifies the difference between "restart" and "reload" in API/cmd and user's guide documentation for CFE_ES_RESTART_APP_CC.

PR #1128 - CFE_ES_RestartApp now checks for file existence as part of command processing and does not remove the app if the file doesn't exist (just avoids one error case). it also rejects the command and increments command error counter if file is missing.

PR #1116 - Switches throttle indexes to use CFE_SB_RouteId_Atom_t and combines helper function given that msgid was removed due to being a resource hog. Resolves static analysis warning.

PR #1111 - Removes CFE_PLATFORM_SB_MAX_PIPE_DEPTH in favor of OS_QUEUE_MAX_DEPTH. This depth parameter in command is now checked prior to attempting OSAL call.

PR #1133 - Filters pointer now const in API and reports truncation when registering filters with CFE_EVS_Register.

PR #1129 - Removes the ability to disable the log by not defining CFE_PLATFORM_EVS_LOG_ON so users are no longer able to disable log completely. For minimum memory use define CFE_PLATFORM_EVS_LOG_MAX = 1. Note: This could remove control based on LogEnabled, panic on reset area fail and limp along if "sem create" fails.

PR #1132 - This removes the remnants of the table service exclusion logic and documentation: EXCLUDE_CFE_TBL no longer available, even if defined, table services will still start.

PR #1126 - Set ES and EVS pipe message limit to defaults as opposed to the custom, unjustified, CFE_SB_SubscribeEx. This change might queue additional HK messages, but SCH loads after ES anyways.

PR #1125 - Replaces CFE_SB_Default_Qos with CFE_SB_DEFAULT_QOS macro that avoids global variable exposure. Removes SB-internal defines that are not implemented nor used.

PR #1124 - Explicity memset the task data to zero at the start of EarlyInit. Standardize the global typdef/variable names.

PR #1136 - Moves all functions, macros, types, and other definitions related to resource IDs and generic resource management into a separate module, like CFE MSG, SBR, etc. This allows a mission to elect "strict" implementations of these objects, where every ID type is unique, and assigning between them or uint32 results in a compiler error. API now has separate types for each resource type (Apps, Tasks, Libs, Counters, etc). The user can elect at the mission level whether this is a simple typedef (all uint32, all interchangeable) or a wrapper type (separate/strict type, cannot be interchanged). The former is backward compatible but the latter is not - must use proper types.

PR #1163 - Adds Code QL analysis to continuous integration workflow.

System(s) tested on
Ubuntu 18.04

Additional context
Part of nasa/cFS#182

Third party code
None

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

The PSP header files are located in fsw/shared/inc, not fsw/shared. This corrects the reference.

Move all functions, macros, types, and other definitions related to resource IDs and generic resource management into a separate module, like CFE MSG and SBR, etc. Notably this allows a mission to elect "strict" implementations of these objects, where every ID type is unique, and assigning between them (or uint32) results in a compiler error.

Test was just a copy/paste of Test_SB_Cmds_CmdUnexpCmdCode and did not actually implement a new test. Subscription reporting is a no parameter command.

…MAX_DEPTH

Fix #1070, patch PSP include directory reference

Do not print the pipe name in the debug event, just pipe ID.

Remove code blocks that were commented out, not needed.

Fix #1032, Send->Write name update for SB write cmds

Fix #997, Simplify UT_InitData SB setup

Fix #780, Hex output for return checking ASSERTs

Fix #1145, Update workflow action badge

Fix #1144, Add workflow action timeout

Fix #1141, pipe name unset

Fix #1100, Update highest MsgId documentation/verification

Fix #793, Clarify restart/reload app behavior

Fix #915, Check for file existence in CFE_ES_RestartApp

Fix #1069, Resolve mismatched types in SBR throttle

Fix #996, Remove CFE_PLATFORM_SB_MAX_PIPE_DEPTH in favor of OS_QUEUE_MAX_DEPTH

Fix #723, CFE_EVS_Register const correct and report truncation

Fix #609, Remove CFE_PLATFORM_EVS_LOG_ON undefined option to diasble log

Fix #680, Remove table service exclusion logic

Fix #1122, ES and EVS use default message limits

Fix #1123, Convert global CFE_SB_Default_Qos to macro

Fix #1036, Clear task data in EarlyInit and standardize name #1124

Fix #1108, split resource id functions into module

Corrects warnings/errors in doxygen userguide

Fix #1162, Add CodeQL analysis to workflow

Combines - nasa/cFE#1150 - nasa/osal#774 - nasa/PSP#250 - nasa/to_lab#84 - nasa/tblCRCTool#35

Combines nasa/cFE#1150 nasa/osal#774 nasa/PSP#250 nasa/to_lab#84 nasa/tblCRCTool#35

Combines nasa/cFE#1150 nasa/osal#774 nasa/PSP#250 nasa/to_lab#84 nasa/tblCRCTool#35 Also adds minor white-space fix in codeql-build.yml

jphickey and others added 28 commits January 6, 2021 15:08

Fix #1070, patch PSP include directory reference

6da6a1b

The PSP header files are located in fsw/shared/inc, not fsw/shared. This corrects the reference.

Fix #723, CFE_EVS_Register const correct and report truncation

b50cd5b

Fix #680, Remove table service exclusion logic

8257c1e

Fix #609, Remove CFE_PLATFORM_EVS_LOG_ON undefined option to diasble log

dcadb67

Fix #915, Check for file existence in CFE_ES_RestartApp

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Learn about vigilant mode

79c4210

Fix #1122, ES and EVS use default message limits

68ccd7a

Fix #1123, Convert global CFE_SB_Default_Qos to macro

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Learn about vigilant mode

7a2dcce

Fix #780, Hex output for return checking ASSERTs

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Learn about vigilant mode

c4fe4bb

Fix #986, Remove unnecessary CFE_MSG_Init in TBL

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Learn about vigilant mode

4a86e23

Fix #1069, Resolve mismatched types in SBR throttle

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

07721cb

Fix #1071, Initialize Status in CFE_ES_WaitForSystemState

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

1def3b5

Fix #1110, Remove unimplemented ES prototypes

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

2511181

Fix #997, Simplify UT_InitData SB setup

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

1a17cfc

Fix #996, Remove CFE_PLATFORM_SB_MAX_PIPE_DEPTH in favor of OS_QUEUE_…

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

bd051ff

…MAX_DEPTH

Fix #1100, Update highest MsgId documentation/verification

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

b04e876

Fix #793, Clarify restart/reload app behavior

3811351

Fix #1036, Clear task data in EarlyInit and standardize name

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Learn about vigilant mode

cf198f6

Fix #1032, Send->Write name update for SB write cmds

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

038ed40

Merge pull request #1072 from jphickey/fix-1070-psp-includedir

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Learn about vigilant mode

ea20cb3

Fix #1070, patch PSP include directory reference

Fix #1141, PipeName unset with debug event

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Learn about vigilant mode

a97a268

Do not print the pipe name in the debug event, just pipe ID.

Fix #1145, Update workflow action badge

45cfa66

Fix #1144, Add workflow action timeout

f3b28cc

Fix #1108, clean up ifdef blocks

f7be6e3

Remove code blocks that were commented out, not needed.

Merge pull request #1118 from skliper/fix1032-send_misnomer

b7358d2

Fix #1032, Send->Write name update for SB write cmds

Merge pull request #1112 from skliper/fix997-ut_sb_setup

27f74f5

Fix #997, Simplify UT_InitData SB setup

Merge pull request #1121 from skliper/fix780-assert_hex

f6c6737

Fix #780, Hex output for return checking ASSERTs

astrogeco added the IC:2021-02-02 label Feb 3, 2021

Merge pull request #1146 from skliper/fix1145-action_badge

fddcd0a

Fix #1145, Update workflow action badge

astrogeco added 12 commits February 2, 2021 22:01

Merge pull request #1147 from skliper/fix1144-action_timeout

993c9ce

Fix #1144, Add workflow action timeout

Merge pull request #1142 from jphickey/fix-1141-fixup-debug-event

7d311a7

Fix #1141, pipe name unset

Merge pull request #1101 from skliper/fix1100-highest_valid_msgid

eff9a87

Fix #1100, Update highest MsgId documentation/verification

Merge pull request #1083 from skliper/fix793-reload_restart_doc

11201fa

Fix #793, Clarify restart/reload app behavior

Merge pull request #1128 from skliper/fix915-restart_file_check

d9f3fa4

Fix #915, Check for file existence in CFE_ES_RestartApp

Merge pull request #1116 from skliper/fix1069-sbr_throttle_types

3a1b9e1

Fix #1069, Resolve mismatched types in SBR throttle

Merge pull request #1111 from skliper/fix996-max_queue_depth

64aeec0

Fix #996, Remove CFE_PLATFORM_SB_MAX_PIPE_DEPTH in favor of OS_QUEUE_MAX_DEPTH

Merge pull request #1133 from skliper/fix723-filter_truncation

4936a5d

Fix #723, CFE_EVS_Register const correct and report truncation

Merge pull request #1129 from skliper/fix609-evs_log_not_optional

7357fa3

Fix #609, Remove CFE_PLATFORM_EVS_LOG_ON undefined option to diasble log

Merge pull request #1132 from skliper/fix680-conditional_tbl

e0cb584

Fix #680, Remove table service exclusion logic

Merge pull request #1126 from skliper/fix1122-default_subscribe

4c441b0

Fix #1122, ES and EVS use default message limits

Merge pull request #1125 from skliper/fix1123-extern_qos

89a3c04

Fix #1123, Convert global CFE_SB_Default_Qos to macro

astrogeco changed the title ~~cFE Bundle Integration candidate: 2021-02-02~~ cFE Integration candidate: 2021-02-02 Feb 8, 2021

Merge pull request #1124 from 'skliper/fix1036-clear_globals'

60668b1

Fix #1036, Clear task data in EarlyInit and standardize name #1124

jphickey force-pushed the integration-candidate branch from 0c16636 to 60668b1 Compare February 8, 2021 19:35

Merge pull request #1136 from jphickey/fix-1108-resourceid-module

3bb2a17

Fix #1108, split resource id functions into module

jphickey force-pushed the integration-candidate branch from 2edfc87 to 3bb2a17 Compare February 8, 2021 20:29

jphickey and others added 4 commits February 8, 2021 16:04

HOTFIX for #1136, update doxygen refs

4fa3786

Corrects warnings/errors in doxygen userguide

HOTFIX for #1136, remove ref to CFEESResourceIDBase

0d1e7c0

Fix #1162, Add CodeQL analysis to workflow

cfb01fb

Merge pull request #1163 from skliper/fix1162-add_codeql

bd54771

Fix #1162, Add CodeQL analysis to workflow

astrogeco marked this pull request as ready for review February 15, 2021 18:15

Bump to v6.8.0-rc1+dev348

557d92b

astrogeco mentioned this pull request Feb 16, 2021

cFS Bundle Integration Candidate: 2021-02-02 nasa/cFS#182

Merged

astrogeco merged commit 6b9c267 into main Feb 16, 2021

astrogeco added a commit to nasa/cFS that referenced this pull request Feb 16, 2021

Integration Candidate 2021-02-02

aceffb3

Combines - nasa/cFE#1150 - nasa/osal#774 - nasa/PSP#250 - nasa/to_lab#84 - nasa/tblCRCTool#35

astrogeco added a commit to nasa/cFS that referenced this pull request Feb 16, 2021

Integration Candidate 2021-02-02

2295806

Combines - nasa/cFE#1150 - nasa/osal#774 - nasa/PSP#250 - nasa/to_lab#84 - nasa/tblCRCTool#35

astrogeco added a commit to nasa/cFS that referenced this pull request Feb 16, 2021

Integration Candidate 2021-02-02

3ad1759

Combines nasa/cFE#1150 nasa/osal#774 nasa/PSP#250 nasa/to_lab#84 nasa/tblCRCTool#35

astrogeco added a commit to nasa/cFS that referenced this pull request Feb 16, 2021

Integration Candidate 2021-02-02

a41549c

Combines nasa/cFE#1150 nasa/osal#774 nasa/PSP#250 nasa/to_lab#84 nasa/tblCRCTool#35 Also adds minor white-space fix in codeql-build.yml

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-02-02 #1150

cFE Integration candidate: 2021-02-02 #1150

astrogeco commented Feb 3, 2021 •

edited

Loading

cFE Integration candidate: 2021-02-02 #1150

cFE Integration candidate: 2021-02-02 #1150

Conversation

astrogeco commented Feb 3, 2021 • edited Loading

astrogeco commented Feb 3, 2021 •

edited

Loading