osal Integration candidate: 2021-05-11 #996
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The UtAssert API documentation was very terse and some references are obsolete/incorrect. This converts to doxygen form and corrects the stale/incorrect references. In particular - UtMemSet does not exist, but the standard C memset call should be used to fill a memory region with a constant value.
Clarify use of the stack_size parameter, and that it should not be 0.
Update the configuration guide for the current build system (CMake) and the currently provided set of OS/BSP layers. Many of the examples in this guide referred to items which are obsolete. However, this does *NOT* fix references to the applications and in particular the "tasking example" as this still may be brought back.
Confirm consistency between the return values generated by each OSAL API and the doxygen documentation. Each explicitly-returned status code should have a corresponding "retval" entry in the documentation. Also confirms that each explicitly-returned status code has a matching case in the coverage tests that specifically checks for that return value. Some were actually missing, where as some were just being reported incorrectly. Finally this also corrects one argument name mismatch in QueueCreate where it was prototyped as "data_size" but implemented as "max_size".
Adds various review items into the document, adds some new sections regarding the sample Makefile wrapper.
Adds a real mutex for use with low level BSP console output. This needs to be actually implemented in the BSP layer, so it will be used by UtAssert outputs (pass/fail message) in addition to OS_printf(). This also converts OS_DEBUG to use the same console output rather than calling fprintf directly. The combination of a mutex and all common print outputs (UtAssert, OS_printf, OS_DEBUG) going through the same path makes the test output on VxWorks much more coherent.
In some versions of VxWorks the fcntl F_GETFL/F_SETFL opcodes do not appear to be implemented, and thus it is not possible to set O_NONBLOCK mode. However, this mode is not necessarily required, it is more of a backup/failsafe. The "selectable" flag should not be dependent on whether O_NONBLOCK flag got set. This also adjust some timeouts and adds some delays to improve the reliability of network-api-test on VxWorks. The timeouts were only 10ms, and this is much too short as messages are getting written on a 9600 baud console (avg 1ms/char). A single log message can easily take 50-60ms alone.
Fix #640, configuration guide updates
Fix #963, improve documentation of UtAssert API calls
Fix #545, update OS_TaskCreate doc
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
pushed a commit
to jphickey/osal
that referenced
this pull request
Aug 10, 2022
jphickey
pushed a commit
to jphickey/osal
that referenced
this pull request
Aug 10, 2022
Fix nasa#996, Remove CFE_PLATFORM_SB_MAX_PIPE_DEPTH in favor of OS_QUEUE_MAX_DEPTH
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Part of nasa/cFS#256
Tests
osal checks https://github.com/nasa/osal/pull/996/checks
cFS Bundle checks https://github.com/nasa/cfs/pull/256/checks
Description
PR #978
Fix #640, configuration guide updates
Significant update to the configuration guide for the current build system (CMake) and the currently provided set of OS/BSP layers. Many of the examples in this guide referred to items which are now obsolete.
PR #974
Fix #963, improve documentation of UtAssert API calls
The UtAssert API documentation was very terse and some references are obsolete/incorrect. This converts to doxygen form and
corrects the stale/incorrect references.
In particular - UtMemSet does not exist, but the standard C memset call should be used to fill a memory region with a constant value.
PR #977
Fix #545, update OS_TaskCreate doc
Clarify use of the stack_size parameter, and that it should not be 0.
PR #980
Related to #331,
Ensure consistency between the return values generated by each OSAL API and the doxygen documentation.
Fix missing or incorrect explicitly-returned status code in the coverage tests.
Correct one argument name mismatch in QueueCreate where it was prototyped as "data_size" but implemented as "max_size".
Authors
@jphickey