Fix #2516, propagate stack pointer for child tasks #2517
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
|
Related OSAL issue is fixed in nasa/osal#1450 (dependency) |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| CFE_ES_ExitChildTask(); | ||
| } | ||
|
|
||
| void TestCreateChildWithStack(void) |
Check notice
Code scanning / CodeQL
Long function without assertion Note test
| #define UT_LOCAL_STACK_SIZE 4096 | ||
| static unsigned long UT_LOCAL_STACK[UT_LOCAL_STACK_SIZE]; | ||
|
|
||
| void TestCheckStackPointer(void) |
Check notice
Code scanning / CodeQL
Long function without assertion Note test
|
Checked the failure reported in the workflows -- confirmed that it is the newly added test, and it should be fixed by the linked OSAL PR. |
| * NOTE: The custom stack does not work on RTEMS, test is disabled on that platform | ||
| * for the time being (custom stack may be deprecated in future CFE release). | ||
| */ | ||
| #ifndef _RTEMS_OS_ |
Check notice
Code scanning / CodeQL
Conditional compilation Note test
jphickey
force-pushed
the
fix-2516-stackptr
branch
from
50eb286
to
0eaba4d
Compare
Update CFE_ES_CreateChildTask to propagate the user-supplied stack pointer to the underlying OS_TaskCreate call. Also adds a functional test to check that the memory address of a local variable within a child task resides within the expected stack buffer. NOTE: this requires an additional fix to POSIX OSAL to make it work on that platform.
jphickey
force-pushed
the
fix-2516-stackptr
branch
from
0eaba4d
to
5dc12a7
Compare
|
Pushed the same content in new commit, in order to re-run workflows. |
jphickey
added
the
CCB:Ready
dzbaker
added
CCB:Approved
2 tasks
dzbaker
added a commit
to nasa/cFS
that referenced
this pull request
Mar 11, 2024
*Combines:* cFE equuleus-rc1+dev104 to_lab equuleus-rc1+dev48 ci_lab equuleus-rc1+dev61 sample_app equuleus-rc1+dev40 **Includes:** *cFE* - nasa/cFE#2517 *to_lab* - nasa/to_lab#194 *ci_lab* - nasa/ci_lab#177 *sample_app* - nasa/sample_app#229 Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
dzbaker
added a commit
to nasa/cFS
that referenced
this pull request
Mar 12, 2024
*Combines:* cFE equuleus-rc1+dev107 to_lab equuleus-rc1+dev48 ci_lab equuleus-rc1+dev61 sample_app equuleus-rc1+dev40 **Includes:** *cFE* - nasa/cFE#2517 - nasa/cFE#2527 *to_lab* - nasa/to_lab#194 *ci_lab* - nasa/ci_lab#177 *sample_app* - nasa/sample_app#229 Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
dzbaker
added a commit
to nasa/cFS
that referenced
this pull request
Mar 12, 2024
*Combines:* cFE equuleus-rc1+dev107 to_lab equuleus-rc1+dev48 ci_lab equuleus-rc1+dev61 sample_app equuleus-rc1+dev40 **Includes:** *cFE* - nasa/cFE#2517 - nasa/cFE#2527 *to_lab* - nasa/to_lab#194 *ci_lab* - nasa/ci_lab#177 *sample_app* - nasa/sample_app#229 Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
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.
Checklist (Please check before submitting)
Describe the contribution
Update CFE_ES_CreateChildTask to propagate the user-supplied stack pointer to the underlying OS_TaskCreate call. Also adds a functional test to check that the memory address of a local variable within a child task resides within the expected stack buffer.
NOTE: this requires an additional fix to POSIX OSAL to make it work on that platform.
Fixes #2516
Testing performed
Build and run all tests
Expected behavior changes
CFE Child tasks created will adhere to passed-in stack pointer.
System(s) tested on
Debian, RTEMS
Additional context
The newly added functional test will fail on POSIX due to a similar bug in the OS_TaskCreate() implementation. This didn't propagate the stack pointer, either.
The biggest risk with "fixing" this is that it might expose stack size problems that were otherwise hidden. Many apps use very small stack sizes for child tasks, and on POSIX (at least Linux/Glibc) it puts TLS storage in the stack buffer. This TLS takes about 10kB off the top of the stack. If the entire stack was only 4kB, this is now a problem. It was hidden because POSIX created a stack anyway, and when it created the stack it was at least 16kB. But by fixing that problem, the stack size really will be only 4kB, and thus not be big enough, and memory corruption will result.
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.