subsys: logging: log_core: correct timeout of -1 ms to K_FOREVER #63958
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
cfriedt
force-pushed
the
log-mode-block-in-thread
branch
2 times, most recently
from
1021133 to
440b747
Compare
Many releases ago, specifying to block indefinitely in the log processing thread would do just that. However, a subtle bug was introduced such that specifying -1 for `CONFIG_LOG_BLOCK_IN_THREAD_TIMEOUT_MS` would have the exact opposite effect than what was intended. As per Kconfig, a value of -1 should translate to a timeout of `K_FOREVER`. However, conversion via `K_MSEC(-1)` results in a `k_timeout_t` that is equal to `K_NO_WAIT` rather than the intent which is `K_FOREVER`. Add a dedicated check to to ensure that a value of -1 is correctly interpreted as `K_FOREVER` in `log_core.c`. For reference, the blocking feature was described in zephyrproject-rtos#15196, added in zephyrproject-rtos#16194, and it would appear that the regression happened in c5f2cde. Signed-off-by: Christopher Friedt <cfriedt@meta.com>
cfriedt
force-pushed
the
log-mode-block-in-thread
branch
from
440b747 to
6fc1d5a
Compare
|
Assertions that can demonstrate the issue above __ASSERT_NO_MSG(K_TIMEOUT_EQ(K_NO_WAIT, K_MSEC(-1)));
__ASSERT_NO_MSG(!K_TIMEOUT_EQ(K_FOREVER, K_MSEC(-1))); |
cfriedt
requested review from
jgl-meta,
luchnikov,
ycsin,
fabiobaltieri and
jhedberg
and removed request for
dcpleung
cfriedt
added
bug
cfriedt
commented
Oct 15, 2023
| K_MSEC(CONFIG_LOG_BLOCK_IN_THREAD_TIMEOUT_MS)); | ||
| return (struct log_msg *)mpsc_pbuf_alloc( | ||
| buffer, wlen, | ||
| (CONFIG_LOG_BLOCK_IN_THREAD_TIMEOUT_MS == -1) |
There was a problem hiding this comment.
A future enhancement would be to generalize this for any timeout value < 0.
fabiobaltieri
approved these changes
Oct 15, 2023
nordic-krch
approved these changes
Oct 16, 2023
|
Shouldn't this be backported? |
This was referenced Oct 16, 2023
Merged
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.
Many releases ago, specifying to block indefinitely in the log processing thread would do just that.
However, a subtle bug was introduced such that specifying -1 for
CONFIG_LOG_BLOCK_IN_THREAD_TIMEOUT_MSwould have the exact opposite effect than what was intended.As per Kconfig, a value of -1 should translate to a timeout of
K_FOREVER. However, conversion viaK_MSEC(-1)results in ak_timeout_tthat is equal toK_NO_WAIT.Add a dedicated check to to ensure that a value of -1 is correctly interpreted as
K_FOREVERinlog_core.c.For reference, the blocking feature was described in #15196, added in #16194, and it would appear that the regression happened in c5f2cde.
Fixes #63965