Debug stream text msg improvements#10845
Open
jsarha wants to merge 2 commits into
Open
Conversation
added 2 commits
June 5, 2026 01:00
Refactor ds_vamsg() to separate the text formatting from the debug stream record sending. The new ds_send_text_record() takes a pre-formatted text buffer and length, and is declared as a Zephyr syscall when CONFIG_USERSPACE is enabled. ds_vamsg() now formats the message into a local buffer and calls ds_send_text_record(), which can be invoked from both user and supervisor contexts. Add the z_vrfy wrapper with K_SYSCALL_MEMORY_READ validation and register the syscall header in CMakeLists.txt. Define DS_TEXT_MSG_MAX_LEN (128) in the shared user header to keep the buffer size consistent between user and kernel sides. Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
Export ds_msg() to allow using it in loadable modules. Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves debug stream text messaging for Zephyr-based SOF builds by making ds_send_text_record() callable from user space via a syscall and by exporting ds_msg() for use from module code.
Changes:
- Register
debug_stream_text_msg.hfor Zephyr syscall header generation. - Add
ds_send_text_record()API as a Zephyr syscall (whenCONFIG_USERSPACEis enabled) and introduceDS_TEXT_MSG_MAX_LEN. - Implement syscall plumbing (
z_impl_*/z_vrfy_*+ marshalling include) and exportds_msg().
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
zephyr/CMakeLists.txt |
Adds the header to Zephyr’s syscall generation inputs. |
src/include/user/debug_stream_text_msg.h |
Introduces DS_TEXT_MSG_MAX_LEN and the ds_send_text_record() syscall/public prototype. |
src/debug/debug_stream/debug_stream_text_msg.c |
Implements the syscall handler + verifier and exports ds_msg(); refactors text record sending path. |
Comment on lines
+55
to
+67
| void ds_vamsg(const char *format, va_list args) | ||
| { | ||
| char text[DS_TEXT_MSG_MAX_LEN]; | ||
| ssize_t len; | ||
|
|
||
| len = vsnprintf(text, sizeof(text), format, args); | ||
|
|
||
| if (len < 0) | ||
| return; | ||
| len = MIN(len, sizeof(text)); | ||
|
|
||
| ds_send_text_record(text, len); | ||
| } |
Comment on lines
+27
to
+33
| #define DS_TEXT_MSG_MAX_LEN 128 | ||
|
|
||
| #if defined(__ZEPHYR__) && defined(CONFIG_USERSPACE) | ||
| __syscall void ds_send_text_record(const char *text, size_t len); | ||
| #else | ||
| void ds_send_text_record(const char *text, size_t len); | ||
| #endif |
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
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.
Make ds_send_text_record() a syscall to make userspace debugging easier. And export ds_msg() to allow its usage in module code.