Skip to content

userspace: proxy: Add support for llext modules #10643

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

Open
softwarecki wants to merge 5 commits into
base: main
Choose a base branch
from
Open

userspace: proxy: Add support for llext modules #10643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
748a0c6
manifest: rimage: llext: Add user_mode param to SOF_LLEXT_MODULE_MANI…
softwarecki Mar 23, 2026
658944a
userspace: proxy: Add support for llext modules
softwarecki Mar 3, 2026
f966a95
fast_get: Enable buffer sharing when using module driver heap
softwarecki Mar 20, 2026
9e41394
userspace: proxy: Rename user_get_partition_attr
softwarecki Apr 17, 2026
e6690d7
userspace: proxy: Add partition for k_heap struct
softwarecki Mar 19, 2026
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
47 changes: 36 additions & 11 deletions src/audio/module_adapter/library/userspace_proxy.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
#include <stdint.h>

#include <sof/lib_manager.h>
#include <sof/llext_manager.h>
#include <sof/audio/component.h>
#include <sof/schedule/dp_schedule.h>
#include <rtos/userspace_helper.h>
Expand Down Expand Up @@ -163,6 +164,7 @@ static int user_work_item_init(struct userspace_context *user_ctx, struct k_heap
work_item->event = &worker.event;
#endif
work_item->params.context = user_ctx;
work_item->params.mod = NULL;
user_ctx->work_item = work_item;

return 0;
Expand Down Expand Up @@ -198,7 +200,7 @@ static int userspace_proxy_invoke(struct userspace_context *user_ctx, uint32_t c
struct k_mem_partition ipc_part = {
.start = ipc_req_buf,
.size = MAILBOX_HOSTBOX_SIZE,
.attr = user_get_partition_attr(ipc_req_buf) | K_MEM_PARTITION_P_RO_U_RO,
.attr = user_get_partition_cache_attr(ipc_req_buf) | K_MEM_PARTITION_P_RO_U_RO,
};
int ret = 0, ret2;

Expand Down Expand Up @@ -274,8 +276,25 @@ static int userspace_proxy_memory_init(struct userspace_context *user_ctx,
tr_dbg(&userspace_proxy_tr, "Heap partition %#lx + %zx, attr = %u",
heap_part.start, heap_part.size, heap_part.attr);

#if !defined(CONFIG_XTENSA_MMU_DOUBLE_MAP) && defined(CONFIG_SOF_ZEPHYR_HEAP_CACHED)
#define HEAP_PART_CACHED
/* When a new memory domain is created, only the "factory" entries from the L2 page
* tables are copied. Memory that was dynamically mapped during firmware execution
* will not be accessible from the new domain. The k_heap structure (drv->user_heap)
* resides in such dynamically mapped memory, so we must explicitly add a partition
* for it to ensure that syscalls can access this structure from the userspace domain.
Comment thread
softwarecki marked this conversation as resolved.
*/
struct k_mem_partition heap_struct_part = {
.attr = K_MEM_PARTITION_P_RW_U_NA |
user_get_partition_cache_attr(POINTER_TO_UINT(drv->user_heap))
};

k_mem_region_align(&heap_struct_part.start, &heap_struct_part.size,
POINTER_TO_UINT(drv->user_heap),
sizeof(*drv->user_heap), CONFIG_MM_DRV_PAGE_SIZE);
Comment thread
softwarecki marked this conversation as resolved.

tr_dbg(&userspace_proxy_tr, "Heap struct partition %#lx + %zx, attr = %u",
heap_struct_part.start, heap_struct_part.size, heap_struct_part.attr);

#if defined(CONFIG_SOF_ZEPHYR_HEAP_CACHED)
/* Add cached module private heap to memory partitions */
struct k_mem_partition heap_cached_part = {
.attr = K_MEM_PARTITION_P_RW_U_RW | XTENSA_MMU_CACHED_WB
Expand All @@ -294,10 +313,11 @@ static int userspace_proxy_memory_init(struct userspace_context *user_ctx,
* These include ops structures marked with APP_TASK_DATA.
*/
&common_partition,
#ifdef HEAP_PART_CACHED
#ifdef CONFIG_SOF_ZEPHYR_HEAP_CACHED
&heap_cached_part,
#endif
&heap_part
&heap_part,
&heap_struct_part
};

tr_dbg(&userspace_proxy_tr, "Common partition %#lx + %zx, attr = %u",
Expand Down Expand Up @@ -326,7 +346,7 @@ static int userspace_proxy_add_sections(struct userspace_context *user_ctx, uint

mem_partition.start = mod->segment[idx].v_base_addr;
mem_partition.size = mod->segment[idx].flags.r.length * CONFIG_MM_DRV_PAGE_SIZE;
mem_partition.attr |= user_get_partition_attr(mem_partition.start);
mem_partition.attr |= user_get_partition_cache_attr(mem_partition.start);

ret = k_mem_domain_add_partition(user_ctx->comp_dom, &mem_partition);

Expand All @@ -339,7 +359,7 @@ static int userspace_proxy_add_sections(struct userspace_context *user_ctx, uint

lib_manager_get_instance_bss_address(instance_id, mod, &va_base, &mem_partition.size);
mem_partition.start = POINTER_TO_UINT(va_base);
mem_partition.attr = user_get_partition_attr(mem_partition.start) |
mem_partition.attr = user_get_partition_cache_attr(mem_partition.start) |
K_MEM_PARTITION_P_RW_U_RW;
ret = k_mem_domain_add_partition(user_ctx->comp_dom, &mem_partition);

Expand Down Expand Up @@ -382,7 +402,7 @@ static int userspace_proxy_start_agent(struct userspace_context *user_ctx,
}

int userspace_proxy_create(struct userspace_context **user_ctx, const struct comp_driver *drv,
const struct sof_man_module *manifest, system_agent_start_fn start_fn,
const struct sof_man_module *manifest, system_agent_start_fn agent_fn,
const struct system_agent_params *agent_params,
const void **agent_interface, const struct module_interface **ops)
{
Expand Down Expand Up @@ -410,15 +430,20 @@ int userspace_proxy_create(struct userspace_context **user_ctx, const struct com
if (ret)
goto error_dom;
Comment thread
softwarecki marked this conversation as resolved.

ret = userspace_proxy_add_sections(context, agent_params->instance_id, manifest);
if (agent_fn)
ret = userspace_proxy_add_sections(context, agent_params->instance_id, manifest);
else
/* llext modules do not use the system agent. */
ret = llext_manager_add_domain(agent_params->module_id, domain);
Comment thread
softwarecki marked this conversation as resolved.
Comment thread
softwarecki marked this conversation as resolved.

if (ret)
goto error_dom;

ret = user_work_item_init(context, drv->user_heap);
if (ret)
goto error_dom;

ret = userspace_proxy_start_agent(context, start_fn, agent_params, agent_interface);
ret = userspace_proxy_start_agent(context, agent_fn, agent_params, agent_interface);
if (ret) {
tr_err(&userspace_proxy_tr, "System agent failed with error %d.", ret);
goto error_work_item;
Comment thread
softwarecki marked this conversation as resolved.
Expand Down Expand Up @@ -680,7 +705,7 @@ static int userspace_proxy_get_configuration(struct processing_module *mod, uint
struct k_mem_partition ipc_resp_part = {
.start = ipc_resp_buf,
.size = SOF_IPC_MSG_MAX_SIZE,
.attr = user_get_partition_attr(ipc_resp_buf) | K_MEM_PARTITION_P_RW_U_RW,
.attr = user_get_partition_cache_attr(ipc_resp_buf) | K_MEM_PARTITION_P_RW_U_RW,
};
int ret;

Expand Down
4 changes: 3 additions & 1 deletion src/include/module/module/llext.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#ifndef MODULE_LLEXT_H
#define MODULE_LLEXT_H

#define SOF_LLEXT_MODULE_MANIFEST(manifest_name, entry, affinity, mod_uuid, instances) \
#define SOF_LLEXT_MODULE_MANIFEST(manifest_name, entry, affinity, mod_uuid, instances, ...) \
{ \
.module = { \
.name = manifest_name, \
Expand All @@ -16,6 +16,8 @@
.type = { \
.load_type = SOF_MAN_MOD_TYPE_LLEXT, \
.domain_ll = 1, \
.user_mode = COND_CODE_0(NUM_VA_ARGS_LESS_1(_, ##__VA_ARGS__), (0), \
(GET_ARG_N(1, __VA_ARGS__))), \
Copy link
Copy Markdown
Collaborator

@lyakh lyakh Apr 17, 2026

Choose a reason for hiding this comment

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

does this mean that you only ever use the first of the variadic parameters? Then maybe just add one user_mode while renaming this macro to something different like SOF_LLEXT_MODULE_MANIFEST_USER() and make #define SOF_LLEXT_MODULE_MANIFEST(a, b, c, d, e) SOF_LLEXT_MODULE_MANIFEST_USER(a, b, c, d, e, 0)?

Copy link
Copy Markdown
Collaborator

@lyakh lyakh Apr 27, 2026

Choose a reason for hiding this comment

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

@softwarecki please, don't resolve comments without addressing or replying to them

}, \
.affinity_mask = (affinity), \
} \
Expand Down
23 changes: 12 additions & 11 deletions src/library_manager/lib_manager.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,12 +543,14 @@ static int lib_manager_start_agent(const struct comp_driver *drv,
return ret;
}
#endif /* CONFIG_SOF_USERSPACE_PROXY */
if (agent) {
Copy link
Copy Markdown
Collaborator

@lyakh lyakh Apr 27, 2026

Choose a reason for hiding this comment

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

so, if agent == NULL and CONFIG_SOF_USERSPACE_PROXY isn't defined, this function will build some on-stack objects in lines 525-534 above which then won't be used and will be just dropped. Can we change this?

ret = agent(&agent_params, agent_interface);
if (ret)
tr_err(&lib_manager_tr, "System agent start failed %d!", ret);
return ret;
}

ret = agent(&agent_params, agent_interface);
if (ret)
tr_err(&lib_manager_tr, "System agent start failed %d!", ret);

return ret;
return 0;
}

enum buildinfo_mod_type { MOD_TYPE_INVALID, MOD_TYPE_IADK, MOD_TYPE_LMDK, MOD_TYPE_LLEXT };
Expand Down Expand Up @@ -654,6 +656,7 @@ static struct comp_dev *lib_manager_module_create(const struct comp_driver *drv,
case MOD_TYPE_LLEXT:
agent = NULL;
ops = (const struct module_interface *)module_entry_point;
agent_iface = NULL;
break;
case MOD_TYPE_LMDK:
agent = &native_system_agent_start;
Expand All @@ -671,12 +674,10 @@ static struct comp_dev *lib_manager_module_create(const struct comp_driver *drv,
}

/* At this point module resources are allocated and it is moved to L2 memory. */
if (agent) {
Copy link
Copy Markdown
Collaborator

@lyakh lyakh Apr 27, 2026

Choose a reason for hiding this comment

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

maybe we can change the above condition to if (agent || IS_ENABLED(CONFIG_SOF_USERSPACE_PROXY)) because that's what you're trying to address, right?

ret = lib_manager_start_agent(drv, config, mod, args, module_entry_point, agent,
agent_iface, &userspace, &ops);
if (ret)
goto err;
}
ret = lib_manager_start_agent(drv, config, mod, args, module_entry_point, agent,
agent_iface, &userspace, &ops);
if (ret)
goto err;

if (comp_set_adapter_ops(drv, ops) < 0)
goto err;
Expand Down
1 change: 1 addition & 0 deletions tools/rimage/src/manifest.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ static void man_get_section_manifest(struct image *image,
man_module->type.domain_dp = sof_mod->module.type.domain_dp;
man_module->type.domain_ll = sof_mod->module.type.domain_ll;
man_module->type.load_type = sof_mod->module.type.load_type;
man_module->type.user_mode = sof_mod->module.type.user_mode;

/* text segment */
segment = &man_module->segment[SOF_MAN_SEGMENT_TEXT];
Expand Down
2 changes: 1 addition & 1 deletion zephyr/include/rtos/userspace_helper.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ int user_access_to_mailbox(struct k_mem_domain *domain, k_tid_t thread_id);
*
* @param ptr Address of the partition start
*/
static inline uint32_t user_get_partition_attr(uintptr_t ptr)
static inline uint32_t user_get_partition_cache_attr(uintptr_t ptr)
{
return sys_cache_is_ptr_cached(UINT_TO_POINTER(ptr)) ? XTENSA_MMU_CACHED_WB : 0;
}
Expand Down
12 changes: 10 additions & 2 deletions zephyr/lib/fast-get.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,11 @@ const void *fast_get(struct k_heap *heap, const void *dram_ptr, size_t size)
alloc_align = PLATFORM_DCACHE_ALIGN;
}

if (size > FAST_GET_MAX_COPY_SIZE || !IS_ENABLED(CONFIG_USERSPACE))
/* The module driver heap is shared by all instances of a given module.
* Instances can share the allocated buffer.
*/
if (size > FAST_GET_MAX_COPY_SIZE || !IS_ENABLED(CONFIG_USERSPACE) ||
IS_ENABLED(CONFIG_SOF_USERSPACE_USE_DRIVER_HEAP))
alloc_ptr = dram_ptr;
else
/* When userspace is enabled only share large buffers */
Expand Down Expand Up @@ -186,8 +190,12 @@ const void *fast_get(struct k_heap *heap, const void *dram_ptr, size_t size)
/*
* We only get there for large buffers, since small buffers with
* enabled userspace don't create fast-get entries
*
* We also reach this point when using the module driver heap.
* Since the heap is already shared across module instances,
* we skip memory domain manipulation.
*/
if (current_is_userspace) {
if (current_is_userspace && size > FAST_GET_MAX_COPY_SIZE) {
if (!fast_get_partition_exists(mdom, ret,
ALIGN_UP(size, CONFIG_MM_DRV_PAGE_SIZE))) {
LOG_DBG("grant access to domain %p", mdom);
Expand Down
2 changes: 0 additions & 2 deletions zephyr/lib/userspace_helper.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@
#include <sof/lib/dai.h>
#include <sof/lib/dma.h>

#define MODULE_DRIVER_HEAP_CACHED CONFIG_SOF_ZEPHYR_HEAP_CACHED

/* Zephyr includes */
#include <zephyr/kernel.h>
#include <zephyr/app_memory/app_memdomain.h>
Expand Down
Loading