Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #1343, OSAL config file simplification #1451

Merged
merged 2 commits into from
May 11, 2021

Conversation

jphickey
Copy link
Contributor

Describe the contribution
The CFE framework build uses mostly default values for OSAL compile time configuration. There are just a few exceptions where the CFE build is tuned for a more debug-friendly result.

This updates the configuration files in "sample_defs" to reflect only those values which are set to a non-default value, along with
information about why the configurable item is changed. Currently, these are only items related to debugging.

This change also includes more documentation/comments about how this configuration facility works and where to find information on the complete set of options available (which is OSAL version dependent).

Fixes #1343

Testing performed
Build and sanity check CFE, run all tests

Expected behavior changes
None, this is just documentation/sample config cleanup, but does not change the effective OSAL configuration, since most of the values in this sample file were the same as the default value.

System(s) tested on
Ubuntu 20.04

Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.

The CFE framework build uses mostly default values for OSAL compile
time configuration.  There are just a few exceptions where the
CFE build is tuned for a more debug-friendly result.

This updates the configuration files in "sample_defs" to reflect
only those values which are set to a non-default value, along with
information about why the configurable item is changed. Currently,
these are only items related to debugging.

This change also includes more documentation/comments about how this
configuration facility works and where to find information on the
complete set of options available (which is OSAL version dependent).
@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Apr 29, 2021
@astrogeco
Copy link
Contributor

CCB:2021-05-05 APPROVED

@astrogeco astrogeco added the CCB:Approved Indicates code review and approval by community CCB label May 5, 2021
By setting OSAL_CONFIG_UTILITYTASK_PRIORITY in the "native_osconfig"
file instead of the default file, it will only apply when building
with SIMULATION=native.  Deployment builds will use the low priority
default value.
@jwilmot
Copy link

jwilmot commented May 5, 2021

Talked with Joe. Concern is that an inexperienced user might leave OSAL_CONFIG_UTILITYTASK_PRIORITY set high and see intermittent bad/non-deterministic real-time behavior. Maybe even losing a mission. You want to be very clear that setting a high priority is a bad idea for real-time flight systems.

@jphickey
Copy link
Contributor Author

jphickey commented May 5, 2021

Pushed update to resolve @jwilmot's concerns - this just moves the setting of the OSAL_CONFIG_UTILITYTASK_PRIORITY value to the native_osconfig.cmake file instead of the default_osconfig.cmake file. This way it only applies when building with SIMULATION=native flag (i.e. debug builds for the local workstation). For any other normal build, it will use the default priority (low).

See commit 63d11eb

@astrogeco astrogeco changed the base branch from main to integration-candidate May 11, 2021 01:33
@astrogeco astrogeco added IC:2021-05-11 and removed CCB:Ready Ready for discussion at the Configuration Control Board (CCB) labels May 11, 2021
@astrogeco astrogeco merged commit 66a630f into nasa:integration-candidate May 11, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request May 11, 2021
nasa/cFE#1487, Remove broken travis-ci script

nasa/cFE#1463, generated coverage stubs for CFE core
nasa/cFE#1463, Move CFE_FS_RunBackgroundFileDump to internal API

nasa/cFE#1451, OSAL config file simplification
astrogeco added a commit to nasa/cFS that referenced this pull request May 12, 2021
nasa/cFE#1492, cFE v6.8.0-rc1+dev575
nasa/osal#996, osal v5.1.0-rc1+dev434

nasa/cFE#1487, Remove broken travis-ci script
nasa/cFE#1463, generated coverage stubs for CFE core
nasa/cFE#1463, Move CFE_FS_RunBackgroundFileDump to internal API
nasa/cFE#1451, OSAL config file simplification
nasa/cFE#1489, removes --quiet option so files checked go to stdout

nasa/osal#978, configuration guide updates
nasa/osal#974, improve documentation of UtAssert API calls
nasa/osal#977, update OS_TaskCreate doc
nasa/osal#997, Enable cppcheck results output
nasa/osal#980, Scrub return values
nasa/osal#992, add local mutex to BSP console
nasa/osal#993, do not require nonblock mode
astrogeco added a commit to nasa/cFS that referenced this pull request May 12, 2021
nasa/cFE#1492, cFE v6.8.0-rc1+dev575
nasa/osal#996, osal v5.1.0-rc1+dev434

nasa/cFE#1487, Remove broken travis-ci script
nasa/cFE#1463, generated coverage stubs for CFE core
nasa/cFE#1463, Move CFE_FS_RunBackgroundFileDump to internal API
nasa/cFE#1451, OSAL config file simplification
nasa/cFE#1489, removes --quiet option so files checked go to stdout

nasa/osal#978, configuration guide updates
nasa/osal#974, improve documentation of UtAssert API calls
nasa/osal#977, update OS_TaskCreate doc
nasa/osal#997, Enable cppcheck results output
nasa/osal#980, Scrub return values
nasa/osal#992, add local mutex to BSP console
nasa/osal#993, do not require nonblock mode

Co-authored-by: Jacob Hageman <jacob.hageman@nasa.gov>
Co-authored-by: Joseph Hickey <joseph.p.hickey@nasa.gov>
@jphickey jphickey deleted the fix-1343-osal-config branch May 14, 2021 14:23
@skliper skliper added this to the 7.0.0 milestone Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB
Projects
None yet
4 participants