logging: rpc: fix overwriting of buffer's header #20032
Open
Conversation
This file contains 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
github-actions
bot
added
the
changelog-entry-required
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:sdk-nrf: PR head: b571a6ea9ecf4d0c0ca54dacadb51c657c4e3825 more detailssdk-nrf:
Github labels
List of changed files detected by CI (1)Outputs:ToolchainVersion: 342151af73 Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
This commit fixes an issue where a header of a MPSC buffer was overwritten by log's header causing a log be falsely claimed. Signed-off-by: Konrad Derda <[email protected]>
kderda
force-pushed
the
fix_rpc_log_history
branch
from
7686057 to
b571a6e
Compare
| @@ -14,6 +14,40 @@ | |||
| static uint32_t __aligned(Z_LOG_MSG_ALIGNMENT) log_history_raw[HISTORY_WLEN]; | |||
| static struct mpsc_pbuf_buffer log_history_pbuf; | |||
|
|
|||
| static bool copy_to_pbuffer(const union log_msg_generic *msg) | |||
There was a problem hiding this comment.
Is there a reason to extract this to a separate function if it's used in only one function that does only this? This way it's harder to figure out that the actual change is copying everything without the first two bits :)
| uint8_t *src_data; | ||
| size_t hdr_wlen; | ||
|
|
||
| wlen = log_msg_generic_get_wlen((union mpsc_pbuf_generic *)msg); |
There was a problem hiding this comment.
Suggested change
| wlen = log_msg_generic_get_wlen((union mpsc_pbuf_generic *)msg); | |
| wlen = log_msg_generic_get_wlen(&msg->buf); |
To avoid unsafe casts if not needed.
Comment on lines
+37
to
+44
| hdr_wlen = DIV_ROUND_UP(sizeof(struct mpsc_pbuf_hdr), sizeof(uint32_t)); | ||
|
|
||
| if (wlen <= hdr_wlen) { | ||
| return false; | ||
| } | ||
|
|
||
| dst->hdr.data = msg->buf.hdr.data; | ||
| memcpy(dst_data, src_data, (wlen - hdr_wlen) * sizeof(uint32_t)); |
There was a problem hiding this comment.
If the rounding up was actually needed, this code would be incorrect as it would copy too few bytes. Suggest a bit more assumption-less code:
Suggested change
| hdr_wlen = DIV_ROUND_UP(sizeof(struct mpsc_pbuf_hdr), sizeof(uint32_t)); | |
| if (wlen <= hdr_wlen) { | |
| return false; | |
| } | |
| dst->hdr.data = msg->buf.hdr.data; | |
| memcpy(dst_data, src_data, (wlen - hdr_wlen) * sizeof(uint32_t)); | |
| if (wlen * sizeof(uint32_t) <= sizeof(struct mpsc_pbuf_hdr)) { | |
| return false; | |
| } | |
| dst->hdr.data = msg->buf.hdr.data; | |
| memcpy(dst_data, src_data, wlen * sizeof(uint32_t) - sizeof(struct mpsc_pbuf_hdr)); |
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.
This commit fixes an issue where a header of a MPSC buffer was overwritten by log's header causing a log be falsely claimed.