doc: services: logging: add limitation when using logging thread name #96640
+20
−0
Conversation
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
dcpleung
previously approved these changes
Sep 29, 2025
1 task
JarmouniA
reviewed
Oct 8, 2025
Add a note about a limitation when using deferred logging + thread name together with dynamically allocated struct k_thread. This limitation has been raised in issue zephyrproject-rtos#95077. Signed-off-by: Loic Domaigne <[email protected]>
ljd42
force-pushed
the
docfix-95077-logging-thread_name
branch
from
2fba872 to
30b5cd6
Compare
JarmouniA
approved these changes
Oct 8, 2025
|
|
Hi @dcpleung, @nordic-krch : |
kartben
reviewed
Oct 13, 2025
| :c:func:`malloc` for instance. In this case, if the thread logs some messages and then gets | ||
| stopped and its ``struct k_thread`` is freed, the log system will still try to access that | ||
| structure when handling the message later. This creates a use-after-free scenario. | ||
| To avoid this, a solution consists of calling :c:func:`log_flush` before freeing the structure. |
There was a problem hiding this comment.
Suggested change
| To avoid this, a solution consists of calling :c:func:`log_flush` before freeing the structure. | |
| To avoid this, a solution consists in calling :c:func:`log_flush` before freeing the structure. |
| struct k_thread *thread = malloc(sizeof(*thread)); /* struct allocated dynamically */ | ||
| k_thread_create(thread, ...); | ||
| k_thread_name_set(thread, "foobar2025"); |
There was a problem hiding this comment.
Suggested change
| k_thread_name_set(thread, "foobar2025"); | |
| k_thread_name_set(thread, "foobar2025"); |
Nit but you probably shouldn't use a year here since this will have the code snippet "age" for no reason. "foo bar" should be just fine :)
| k_thread_create(thread, ...); | ||
| k_thread_name_set(thread, "foobar2025"); | ||
| // Thread calls LOG_*(...) |
There was a problem hiding this comment.
This comment should be C style too
|
|
||
| .. code-block:: c | ||
| struct k_thread *thread = malloc(sizeof(*thread)); /* struct allocated dynamically */ |
There was a problem hiding this comment.
This should probably be k_malloc (resp. k_free), not everyone necessarily have malloc/free available
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.
Add a note about a limitation when using deferred logging + thread name together with dynamically allocated struct k_thread. This limitation has been raised in issue #95077.