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.

Sign up for GitHub

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

Jump to bottom

Correct notes on CFE_FS_BackgroundFileDumpRequest #1703

Closed
jphickey opened this issue Jul 23, 2021 · 0 comments · Fixed by #1704 or #1701
Closed

Correct notes on CFE_FS_BackgroundFileDumpRequest #1703

jphickey opened this issue Jul 23, 2021 · 0 comments · Fixed by #1704 or #1701
Assignees
@jphickey
Labels
docs This change only affects documentation.
Milestone
Caelum

Comments

@jphickey
Copy link
Contributor

Describe the bug
The notes for this API say "not on heap" when it really should say "not on stack"

To Reproduce
If buffer is allocated on the stack and object goes out of scope before background job finishes, random unpredictable behavior occurs, as in PR #1673.

Expected behavior
Correct comment.

System observed on:
CI

Additional context
Fundamental requirement is that object must persist for the time the background job runs. So stack is likely a problem, heap is OK as long as it isn't freed before task is done.

Reporter Info
Joseph Hickey, Vantage Systems, Inc.
@jphickey jphickey self-assigned this Jul 23, 2021
@jphickey jphickey added bug docs This change only affects documentation. and removed bug labels Jul 23, 2021
jphickey added a commit to jphickey/cFE that referenced this issue Jul 23, 2021
@jphickey
Fix nasa#1703, update docs for CFE_FS_BackgroundFileDumpRequest
7c1e39e 
Update notes to better clarify that the meta object must persist
for the duration of the dump operation, which occurs in another task,
so it must not be on the stack.
@jphickey jphickey mentioned this issue Jul 23, 2021
Merged
jphickey added a commit to jphickey/cFE that referenced this issue Jul 23, 2021
@jphickey
Fix nasa#1703, update docs for CFE_FS_BackgroundFileDumpRequest
137dcea 
Update notes to better clarify that the meta object must persist
for the duration of the dump operation, which occurs in another task,
so it must not be on the stack.

Also update documentation for background even callbacks to better
clarify arguments and expectations of the implementation.
jphickey added a commit to jphickey/cFE that referenced this issue Jul 23, 2021
@jphickey
Fix nasa#1703, update docs for CFE_FS_BackgroundFileDumpRequest
05e8904 
Update notes to better clarify that the meta object must persist
for the duration of the dump operation, which occurs in another task,
so it must not be on the stack.

Also update documentation for background even callbacks to better
clarify arguments and expectations of the implementation.
astrogeco added a commit that referenced this issue Jul 29, 2021
@astrogeco
Merge pull request #1704 from jphickey/fix-1703-bgfiledump-doc
0865774 
Fix #1703, update docs for CFE_FS_BackgroundFileDumpRequest
@astrogeco astrogeco mentioned this issue Jul 29, 2021
Merged
paulober pushed a commit to paulober/cFE that referenced this issue Aug 1, 2021
@jphickey
Fix nasa#1703, update docs for CFE_FS_BackgroundFileDumpRequest
f2909f6 
Update notes to better clarify that the meta object must persist
for the duration of the dump operation, which occurs in another task,
so it must not be on the stack.

Also update documentation for background even callbacks to better
clarify arguments and expectations of the implementation.
@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
Assignees

@jphickey jphickey

Labels
docs This change only affects documentation.
Projects
None yet
Milestone
Caelum
2 participants
@jphickey @skliper