Fix #777 deprecate sb #998

skliper · 2020-11-04T17:17:33Z

Describe the contribution
Fix #777 - see issue for deprecated elements

Testing performed
Built and ran, enabled telemetry, checked noops. Unit tests built and passed.

Expected behavior changes
None

System(s) tested on

Hardware: cFS Dev Server
OS: Ubuntu 18.04
Versions: Bundle main + this commit

Additional context
#777

Third party code
None

Contributor Info - All information REQUIRED for consideration of pull request
Jacob Hageman - NASA/GSFC

astrogeco · 2020-11-04T17:45:39Z

CCB 2020-11-04

Replaces old refrences with new ones. Also updated the App dev guide language.
Tables also use the new APIs
Hope to review asynchronously or have a splinter

Updates the unit tests, unit test support, and stubs to replace deprecated SB APIs with MSG APIs.

Update documentation to replace deprecated SB APIs with MSG APIs

Update the core software from the deprecated SB APIs to the MSG APIs.

skliper · 2020-11-04T21:53:42Z

Ready for review - 8514efa unit test updates, 1da6b3c doc updates, 34e5510 core updates.

zanzaben · 2020-11-04T22:03:18Z

fsw/cfe-core/src/evs/cfe_evs_task.c

-    int32 Status;    
-    CFE_SB_MsgPtr_t    EVS_MsgPtr; /* Pointer to SB message */
+    int32              Status;
+    CFE_MSG_Message_t *MsgPtr; /* Pointer to SB message */


Should this comment should be change to not mention SB?

Suggested change

CFE_MSG_Message_t *MsgPtr; /* Pointer to SB message */

CFE_MSG_Message_t *MsgPtr; /* Pointer to message */

Planning to address as part of #1009 cleanup.

skliper · 2020-11-13T16:13:16Z

@acudmore @jphickey @ejtimmon Please review so I can address #1009 and move forward with the standard pattern implementation.

jphickey

I've reviewed, and I'm honestly a little reluctant to go forth with this - we definitely have more to discuss here! I'm really not convinced we should be removing the CFE_SB_Msg_t type. There is an important distinction between a message in its raw form and a message as its being transported via SB - like the analogy of a letter vs. an envelope going through the post office to be delivered to its destination. MSG lib should be dealing with letters while SB deals with envelopes. They are related, but different.

My concern is that this change set is undoing a lot of that distinction that was already there. I suppose we can put it back in #1009, or maybe we should hold off on at least the final commit in this change set.

FWIW - I am in agreement with the removal of the "clear" flag on init (first commit) and the removal of most "manipulator" routines - again with the analogy of an envelope, once it is "sealed" you can look at its basic stuff such as the address/delivery info (msgid, size) but not the stuff inside (timestamps, cmd codes, payload). So it makes sense that the SB functions that get/set internal message fields should be deprecated in favor of the MSG versions. But when dealing with messages in their delivery form we should still have an SB level API for that that works with SB defined types.

jphickey · 2020-11-13T16:31:07Z

docs/cFE Application Developers Guide.md

+| Command Code                | CFE_MSG_SetFcnCode                     | Command Only        |
+| Checksum                    | CFE_MSG_GenerateChecksum               | Command Only        |
+| Time                        | CFE_SB_TimeStampMsg                    | Telemetry Only      |
+| Time                        | CFE_MSG_SetMsgTime                     | Telemetry Only      |


The "applicability" column is a bit confusing now - Since the MSG module allows users to customize their headers - a user can now invent their own headers that have a checksum on every packet type and/or timestamps on commands, etc.

So "applicability" is always implementation defined now ... whats listed here is applicability when using the included "msg" implementation.

jphickey · 2020-11-13T16:35:10Z

docs/cFE Application Developers Guide.md

-                                   CFE_SB_CLEAR_DATA);
+   CFE_MSG_Init((CFE_MSG_Message_t *) SAMPLE_AppData.BigPktPtr,
+                                      SAMPLE_BIG_TLM_MID,
+                                      SAMPLE_BIGPKT_MSGLEN);


Casting here is not desirable. We really shouldn't be documenting typecasts like this as the "recommended" way of doing things. I recognize that this was a preexisting issue in the docs though - and its just updated here.

Maybe this will also be affected by #1009 -- but we really should have a pattern that does not require casting when calling the basic APIs.

fsw/cfe-core/src/evs/cfe_evs_utils.c

jphickey · 2020-11-13T17:13:03Z

@acudmore @jphickey @ejtimmon Please review so I can address #1009 and move forward with the standard pattern implementation.

Sorry for the delay I was under the impression we might have an actual splinter meeting about this, but I'm fine to do it all via github as well.

skliper · 2020-11-16T22:17:29Z

@astrogeco can we move forward with this one? Maybe create a new issue for the documentation and fix it later.

Fix #777, Use MSG APIs - Core software Fix #777, Use MSG APIs - Docs Fix #777, Use MSG APIs - Unit tests

Fix nasa#777, Use MSG APIs - Core software Fix nasa#777, Use MSG APIs - Docs Fix nasa#777, Use MSG APIs - Unit tests See nasa#998 for more details

skliper added CCB:Ready Ready for discussion at the Configuration Control Board (CCB) Priority: Mission Feature or bug related to stakeholder needs labels Nov 4, 2020

astrogeco added CCB:Splinter Item needs a focused splinter meeting CCB-20201104 and removed CCB:Ready Ready for discussion at the Configuration Control Board (CCB) labels Nov 4, 2020

astrogeco requested review from jphickey, a user and ejtimmon November 4, 2020 17:45

Fix nasa#777, Use MSG APIs - Unit tests

8514efa

Updates the unit tests, unit test support, and stubs to replace deprecated SB APIs with MSG APIs.

skliper force-pushed the fix777-deprecate-sb branch from 146fa01 to 8514efa Compare November 4, 2020 20:55

skliper added 2 commits November 4, 2020 16:28

Fix nasa#777, Use MSG APIs - Docs

1da6b3c

Update documentation to replace deprecated SB APIs with MSG APIs

Fix nasa#777, Use MSG APIs - Core software

34e5510

Update the core software from the deprecated SB APIs to the MSG APIs.

skliper marked this pull request as ready for review November 4, 2020 21:50

skliper requested a review from zanzaben November 4, 2020 21:51

skliper mentioned this pull request Nov 4, 2020

Remove the SB APIs deprecated in #777 and #998 #1002

Closed

zanzaben reviewed Nov 4, 2020

View reviewed changes

This was referenced Nov 5, 2020

Fix #663, more consistent use of data types #1003

Merged

Refactor message header alignment and "raw" types to fit a clear pattern #1009

Closed

jphickey reviewed Nov 13, 2020

View reviewed changes

skliper mentioned this pull request Nov 13, 2020

Fix# 1009, Apply consistent alignment pattern #1015

Merged

astrogeco added the CCB:FastTrack label Nov 17, 2020

jphickey mentioned this pull request Nov 20, 2020

UT stubs for CFE_SB_TimeStampMsg and CFE_SB_SetMsgTime very inconsistent #1026

Open

astrogeco added the IC-20201124 label Nov 23, 2020

astrogeco changed the base branch from main to integration-candidate November 23, 2020 04:30

astrogeco added the conflicts label Nov 23, 2020

astrogeco mentioned this pull request Nov 23, 2020

Fix merge conflicts in PR #998 #1028

Closed

jphickey added a commit that referenced this pull request Nov 23, 2020

Merge pull request #998 into integration-candidate

325e9d2

Fix #777, Use MSG APIs - Core software Fix #777, Use MSG APIs - Docs Fix #777, Use MSG APIs - Unit tests

astrogeco merged commit 7b9db48 into nasa:integration-candidate Nov 23, 2020

astrogeco mentioned this pull request Dec 2, 2020

cFE Integration Candidate: 2020-11-24 #1027

Merged

skliper mentioned this pull request Jan 7, 2021

Improve API consistency for functions accepting a software bus message #440

Closed

skliper linked an issue Jan 7, 2021 that may be closed by this pull request

Improve API consistency for functions accepting a software bus message #440

Closed

skliper deleted the fix777-deprecate-sb branch February 1, 2021 22:07

astrogeco mentioned this pull request Mar 24, 2021

cFE Integration candidate: 2021-03-30 #1258

Merged

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

Fix #777 deprecate sb #998

Fix #777 deprecate sb #998

skliper commented Nov 4, 2020

astrogeco commented Nov 4, 2020

skliper commented Nov 4, 2020

zanzaben Nov 4, 2020

skliper Nov 13, 2020

skliper commented Nov 13, 2020

jphickey left a comment •

edited

Loading

jphickey Nov 13, 2020

jphickey Nov 13, 2020

jphickey commented Nov 13, 2020

skliper commented Nov 16, 2020

	CFE_MSG_Message_t MsgPtr; / Pointer to SB message */
	CFE_MSG_Message_t MsgPtr; / Pointer to message */

Fix #777 deprecate sb #998

Fix #777 deprecate sb #998

Conversation

skliper commented Nov 4, 2020

astrogeco commented Nov 4, 2020

skliper commented Nov 4, 2020

zanzaben Nov 4, 2020

Choose a reason for hiding this comment

skliper Nov 13, 2020

Choose a reason for hiding this comment

skliper commented Nov 13, 2020

jphickey left a comment • edited Loading

Choose a reason for hiding this comment

jphickey Nov 13, 2020

Choose a reason for hiding this comment

jphickey Nov 13, 2020

Choose a reason for hiding this comment

jphickey commented Nov 13, 2020

skliper commented Nov 16, 2020

jphickey left a comment •

edited

Loading