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

CFE_ES_PerfLogAdd should document config #2407

Closed
irowebbn opened this issue Jul 21, 2023 · 0 comments · Fixed by #2409
Closed

CFE_ES_PerfLogAdd should document config #2407

irowebbn opened this issue Jul 21, 2023 · 0 comments · Fixed by #2409
Labels
docs This change only affects documentation.

Comments

@irowebbn
Copy link
Contributor

Describe the bug
The docstring for CFS_ES_PerfLogAdd makes no mention that the value of Marker is limited by the config value CFE_MISSION_ES_PERF_MAX_IDS.

In my case, I have never altered this limit and was not aware of its existence, so I was surprised when calls to the CFE_ES_PerfLogEntry were failing. The only way to know that this value is used is to check the implementation file at modules/es/fsw/src/cfe_es_perf.c or the note under from the documentation of sample_perfids.h:

Performance ids are limited to the range of 0 to CFE_MISSION_ES_PERF_MAX_IDS - 1.

This text should also appear in the docstring for CFE_ES_PerfLogAdd

I also find the documentation for CFE_MISSION_ES_PERF_MAX_IDS at modules/es/config/default_cfe_es_interface_cfg.h confusing:

**  \cfeescfg Define Max Number of Performance IDs for messages
**
**  \par Description:
**       Defines the maximum number of perf ids allowed in command/telemetry messages
**
**      This affects the layout of command/telemetry messages but does not affect run
**      time behavior or internal allocation.
**
**  \par Limits
**       All CPUs within the same SB domain (mission) must share the same definition
**       Note this affects the size of messages, so it must not cause any message
**       to exceed the max length.
**
*/

I find this confusing because although the value does affect the size of the CFE_ES_HousekeepingTlm_Payload telemetry message via the filter and trigger mask buffers, the wording does not indicate that this limits the upper value of perfids, not the number of perfids. I could have only a few dozen perfids, but if one had a value greater than or equal to this parameter, it would be rejected.

Reporter Info
Isaac Rowe, NASA JSC (Jacobs Technology)

irowebbn added a commit to irowebbn/cFE that referenced this issue Jul 21, 2023
@chillfig chillfig added the docs This change only affects documentation. label Aug 30, 2023
dzbaker added a commit that referenced this issue Dec 5, 2023
Fix #2407 Add perfid limit info to ES docstring
dzbaker added a commit that referenced this issue Dec 5, 2023
Fix #2407 Add perfid limit info to ES docstring
@dzbaker dzbaker closed this as completed in f3a0981 Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change only affects documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants