tests: add stack usage metrics#17706
Merged
kaspar030 merged 9 commits intoRIOT-OS:masterfrom Mar 29, 2022
Merged
Conversation
kaspar030
requested review from
MichelRottleuthner,
aabadie,
fjmolinas,
leandrolanzieri and
smlng
as code owners
github-actions
bot
added
Area: core
Contributor
Author
|
this might still have some DEVELHELP related issues. |
kaspar030
force-pushed
the
add_stack_usage_metrics
branch
from
310e099 to
14c4bd9
Compare
kaspar030
added
the
CI: ready for build
kaspar030
force-pushed
the
add_stack_usage_metrics
branch
from
4cbe89d to
4ebc158
Compare
Contributor
Author
|
Mmmh, the metric collection fails when an application runs multiple threads with the same name (or, restarts one of them). :( I'm trying to come up with a solution that doesn't require the metrics collection script to deal with metric specific cases, like, Would creating a list make sense, if there's multiple entries? that would look like this: (note the multiple "used" entries for t1 and t2) |
github-actions
bot
added
the
Area: CI
Contributor
Author
|
OK, I went with the threads being a list: this needs a fix to the metrics script so lists get concatenated. |
kaspar030
added
CI: ready for build
MrKevinWeiss
added
CI: ready for build
Contributor
|
results after the murdock scripts have been updated Details{
"metrics": {
"tests/malloc_thread_safety": {
"native:gnu": {
"threads": [
{
"name": "t1",
"stack_size": 4096,
"stack_used": 860
},
{
"name": "t2",
"stack_size": 4096,
"stack_used": 860
},
{
"name": "t1",
"stack_size": 4096,
"stack_used": 472
},
{
"name": "t2",
"stack_size": 4096,
"stack_used": 472
},
{
"name": "idle",
"stack_size": 8192,
"stack_used": 600
},
{
"name": "main",
"stack_size": 12288,
"stack_used": 2508
}
]
}
},
"tests/thread_cooperation": {
"native:gnu": {
"threads": [
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2508
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2508
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2508
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2508
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2508
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2508
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2508
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2412
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2412
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2412
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2412
},
{
"name": "thread",
"stack_size": 8192,
"stack_used": 2412
},
{
"name": "idle",
"stack_size": 8192,
"stack_used": 436
},
{
"name": "main",
"stack_size": 12288,
"stack_used": 2612
}
]
}
}
}
} |
kaspar030
added
the
CI: run tests
kaspar030
force-pushed
the
add_stack_usage_metrics
branch
2 times, most recently
from
7161055 to
c64a776
Compare
kaspar030
removed
the
CI: run tests
github-actions
bot
removed
the
Area: CI
kaspar030
added
CI: ready for build
kaspar030
force-pushed
the
add_stack_usage_metrics
branch
from
6f741e1 to
3e8362f
Compare
Contributor
Author
|
I think this is good to go! |
maribu
approved these changes
Mar 29, 2022
Member
maribu
left a comment
maribu
left a comment
There was a problem hiding this comment.
Code looks good to me and test output was provided. Please squash the style nitpick right in.
This commit adds a module that can print stack metrics in the format as understood by CI.
- activate THREAD_CREATE_STACKTEST also if test_utils_print_stack_usage is used - make thread_measure_stack_free() available unconditionally - if DEVELHELP is active, call test_utils_print_stack_usage() on any thread exit - if DEVELHELP is active, call test_utils_print_stack_usage() after main for the idle thread, if that is used
kaspar030
force-pushed
the
add_stack_usage_metrics
branch
from
fe3e733 to
2a13f07
Compare
Contributor
Author
|
Thanks! |
Contributor
|
|
Contributor
Author
|
on it |
Contributor
Author
|
Hm. The pthread threads' stack is too small for the printing of the stack sizes :/ |
Contributor
DISABLE_MODULE then? |
Contributor
Author
|
Using fmt if available, don't print anything if the stack is too small: #17891 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Contribution description
This PR adds a module that, when enabled, will make threads print their stack usage on exit, in a format that the CI's metrics collection understands (and is somewhat human readable).
Example:
Details
This has some impact, the printing itself uses printf. Also, the actual stack data fields are kept per-thread, so 8 bytes more per thread. That means unfortunately some tests for some small-ram boards fall over the cliff.
Testing procedure
CI should be fine.
Issues/PRs references