Skip to content

userspace: remove cache primitive usage from audio code #10232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kv2019i wants to merge 1 commit into from
Closed

userspace: remove cache primitive usage from audio code #10232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/audio/buffers/comp_buffer.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
#include <errno.h>
#include <stddef.h>
#include <stdint.h>
#include <zephyr/syscall.h>

LOG_MODULE_REGISTER(buffer, CONFIG_SOF_LOG_LEVEL);

Expand Down Expand Up @@ -235,6 +236,15 @@ struct comp_buffer *buffer_alloc(size_t size, uint32_t flags, uint32_t align,

tr_dbg(&buffer_tr, "buffer_alloc()");

#if CONFIG_USERSPACE
/*
* cache control is not possible in user-space, so cross-core
* buffers must be allocated as coherent
*/
if (is_shared && k_is_user_context())
flags |= SOF_MEM_FLAG_COHERENT;
#endif

Comment on lines +239 to +247
Copy link
Member

@lgirdwood lgirdwood Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets not do this as performance impact is quite large, in this case it may be a lot faster to have a SOF syscall for buffer WB and INV.

/* validate request */
if (size == 0) {
tr_err(&buffer_tr, "new size = %zu is invalid", size);
Expand Down Expand Up @@ -273,6 +283,15 @@ struct comp_buffer *buffer_alloc_range(size_t preferred_size, size_t minimum_siz
return NULL;
}

#if CONFIG_USERSPACE
/*
* cache control is not possible in user-space, so cross-core
* buffers must be allocated as coherent
*/
if (is_shared && k_is_user_context())
flags |= SOF_MEM_FLAG_COHERENT;
#endif

/* Align preferred size to a multiple of the minimum size */
if (preferred_size % minimum_size)
preferred_size += minimum_size - preferred_size % minimum_size;
Expand Down
27 changes: 27 additions & 0 deletions src/audio/buffers/ring_buffer.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
#include <rtos/alloc.h>
#include <ipc/topology.h>

#include <zephyr/syscall.h>

LOG_MODULE_REGISTER(ring_buffer, CONFIG_SOF_LOG_LEVEL);

SOF_DEFINE_REG_UUID(ring_buffer);
Expand Down Expand Up @@ -53,6 +55,14 @@ static inline void ring_buffer_invalidate_shared(struct ring_buffer *ring_buffer
if (!ring_buffer_is_shared(ring_buffer))
return;

#if CONFIG_USERSPACE
/* user-space shared buffers are allocated as uncached */
if (k_is_user_context()) {
__ASSERT_NO_MSG(sys_cache_is_ptr_cached(ptr) == false);
Copy link

Copilot AI Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider using !sys_cache_is_ptr_cached(ptr) instead of == false for better readability and consistency with C conventions.

Suggested change
__ASSERT_NO_MSG(sys_cache_is_ptr_cached(ptr) == false);
__ASSERT_NO_MSG(!sys_cache_is_ptr_cached(ptr));

Copilot uses AI. Check for mistakes.
return;
}
#endif

/* wrap-around? */
if ((uintptr_t)ptr + size > (uintptr_t)ring_buffer_buffer_end(ring_buffer)) {
/* writeback till the end of circular buffer */
Expand All @@ -72,6 +82,14 @@ static inline void ring_buffer_writeback_shared(struct ring_buffer *ring_buffer,
if (!ring_buffer_is_shared(ring_buffer))
return;

#if CONFIG_USERSPACE
/* user-space shared buffers are allocated as uncached */
if (k_is_user_context()) {
__ASSERT_NO_MSG(sys_cache_is_ptr_cached(ptr) == false);
Copy link

Copilot AI Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider using !sys_cache_is_ptr_cached(ptr) instead of == false for better readability and consistency with C conventions.

Suggested change
__ASSERT_NO_MSG(sys_cache_is_ptr_cached(ptr) == false);
__ASSERT_NO_MSG(!sys_cache_is_ptr_cached(ptr));

Copilot uses AI. Check for mistakes.
return;
}
#endif

/* wrap-around? */
if ((uintptr_t)ptr + size > (uintptr_t)ring_buffer_buffer_end(ring_buffer)) {
/* writeback till the end of circular buffer */
Expand Down Expand Up @@ -355,6 +373,15 @@ struct ring_buffer *ring_buffer_create(struct comp_dev *dev, size_t min_availabl
*/
ring_buffer->data_buffer_size = 3 * max_ibs_obs;

#if CONFIG_USERSPACE
/*
* cache control is not possible in user-space, so cross-core
* buffers must be allocated as coherent
*/
if (is_shared && k_is_user_context())
memory_flags |= SOF_MEM_FLAG_COHERENT;
#endif

/* allocate data buffer - always in cached memory alias */
ring_buffer->data_buffer_size =
ALIGN_UP(ring_buffer->data_buffer_size, PLATFORM_DCACHE_ALIGN);
Expand Down
17 changes: 17 additions & 0 deletions src/include/sof/audio/audio_stream.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
#include <ipc/stream.h>
#include <ipc4/base-config.h>
#include <module/audio/audio_stream.h>
#include <zephyr/syscall.h>

#include <stdbool.h>
#include <stdint.h>
Expand Down Expand Up @@ -733,6 +734,14 @@ static inline void audio_stream_invalidate(struct audio_stream *buffer, uint32_t
tail_size = bytes - head_size;
}

#if CONFIG_USERSPACE
/* user-space shared buffers are allocated as uncached */
if (k_is_user_context()) {
__ASSERT_NO_MSG(sys_cache_is_ptr_cached(buffer->addr) == false);
Copy link

Copilot AI Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider using !sys_cache_is_ptr_cached(buffer->addr) instead of == false for better readability and consistency with C conventions.

Suggested change
__ASSERT_NO_MSG(sys_cache_is_ptr_cached(buffer->addr) == false);
__ASSERT_NO_MSG(!sys_cache_is_ptr_cached(buffer->addr));

Copilot uses AI. Check for mistakes.
return;
}
#endif

dcache_invalidate_region((__sparse_force void __sparse_cache *)buffer->r_ptr, head_size);
if (tail_size)
dcache_invalidate_region((__sparse_force void __sparse_cache *)buffer->addr,
Expand All @@ -756,6 +765,14 @@ static inline void audio_stream_writeback(struct audio_stream *buffer, uint32_t
tail_size = bytes - head_size;
}

#if CONFIG_USERSPACE
/* user-space shared buffers are allocated as uncached */
if (k_is_user_context()) {
__ASSERT_NO_MSG(sys_cache_is_ptr_cached(buffer->addr) == false);
Copy link

Copilot AI Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider using !sys_cache_is_ptr_cached(buffer->addr) instead of == false for better readability and consistency with C conventions.

Suggested change
__ASSERT_NO_MSG(sys_cache_is_ptr_cached(buffer->addr) == false);
__ASSERT_NO_MSG(!sys_cache_is_ptr_cached(buffer->addr));

Copilot uses AI. Check for mistakes.
return;
}
#endif

dcache_writeback_region((__sparse_force void __sparse_cache *)buffer->w_ptr, head_size);
if (tail_size)
dcache_writeback_region((__sparse_force void __sparse_cache *)buffer->addr,
Expand Down
19 changes: 16 additions & 3 deletions src/include/sof/audio/buffer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
#include <ipc/topology.h>
#include <user/trace.h>
#include <sof/audio/format.h>
#include <zephyr/syscall.h>

#include <stdbool.h>
#include <stddef.h>
Expand Down Expand Up @@ -257,20 +258,32 @@ bool buffer_params_match(struct comp_buffer *buffer,
static inline void buffer_stream_invalidate(struct comp_buffer *buffer, uint32_t bytes)
{
#if CONFIG_INCOHERENT
if (audio_buffer_is_shared(&buffer->audio_buffer))
if (audio_buffer_is_shared(&buffer->audio_buffer)) {
#if CONFIG_USERSPACE
/* user-space shared buffers are allocated as uncached */
if (k_is_user_context())
return;
#endif
audio_stream_invalidate(&buffer->stream, bytes);
}
#endif
}

static inline void buffer_stream_writeback(struct comp_buffer *buffer, uint32_t bytes)
{
#if CONFIG_INCOHERENT
if (audio_buffer_is_shared(&buffer->audio_buffer))
if (audio_buffer_is_shared(&buffer->audio_buffer)) {
#if CONFIG_USERSPACE
/* user-space shared buffers are allocated as uncached */
if (k_is_user_context())
return;
#endif

audio_stream_writeback(&buffer->stream, bytes);
}
#endif
}


/*
* Attach a new buffer at the beginning of the list. Note, that "head" must
* really be the head of the list, not a list head within another buffer. We
Expand Down
Loading