Skip to content

Container: switch to object pool #10514

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

Merged
kv2019i merged 4 commits into from
Feb 4, 2026
Merged

Container: switch to object pool #10514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a44e0c7
objpool: add support for custom heap
lyakh Feb 2, 2026
335fc5e
objpool: add an iterator and a destructor
lyakh Feb 2, 2026
fdd9deb
ztest: move wrapped malloc functions into a separate file
lyakh Feb 3, 2026
d0f17c7
audio: module-adapter: use objpool for allocation containers
lyakh Feb 2, 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
1 change: 1 addition & 0 deletions posix/include/rtos/alloc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ static inline void k_heap_init(struct k_heap *heap, void *mem, size_t bytes)
void *sof_heap_alloc(struct k_heap *heap, uint32_t flags, size_t bytes,
size_t alignment);
void sof_heap_free(struct k_heap *heap, void *addr);
struct k_heap *sof_sys_heap_get(void);

/**
* Calculates length of the null-terminated string.
Expand Down
117 changes: 41 additions & 76 deletions src/audio/module_adapter/module/generic.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
*/

#include <rtos/symbol.h>
#include <sof/compiler_attributes.h>
#include <sof/objpool.h>
#include <sof/audio/module_adapter/module/generic.h>
#include <sof/audio/data_blob.h>
#include <sof/lib/fast-get.h>
Expand Down Expand Up @@ -81,10 +83,10 @@ int module_load_config(struct comp_dev *dev, const void *cfg, size_t size)
void mod_resource_init(struct processing_module *mod)
{
struct module_data *md = &mod->priv;

/* Init memory list */
list_init(&md->resources.res_list);
list_init(&md->resources.free_cont_list);
list_init(&md->resources.cont_chunk_list);
list_init(&md->resources.objpool.list);
md->resources.objpool.heap = md->resources.heap;
md->resources.heap_usage = 0;
md->resources.heap_high_water_mark = 0;
}
Expand Down Expand Up @@ -141,43 +143,14 @@ int module_init(struct processing_module *mod)
return 0;
}

struct container_chunk {
struct list_item chunk_list;
struct module_resource containers[CONFIG_MODULE_MEMORY_API_CONTAINER_CHUNK_SIZE];
};

static struct module_resource *container_get(struct processing_module *mod)
{
struct module_resources *res = &mod->priv.resources;
struct k_heap *mod_heap = res->heap;
struct module_resource *container;

if (list_is_empty(&res->free_cont_list)) {
struct container_chunk *chunk = sof_heap_alloc(mod_heap, 0, sizeof(*chunk), 0);
int i;

if (!chunk) {
comp_err(mod->dev, "allocating more containers failed");
return NULL;
}

memset(chunk, 0, sizeof(*chunk));

list_item_append(&chunk->chunk_list, &res->cont_chunk_list);
for (i = 0; i < ARRAY_SIZE(chunk->containers); i++)
list_item_append(&chunk->containers[i].list, &res->free_cont_list);
}

container = list_first_item(&res->free_cont_list, struct module_resource, list);
list_item_del(&container->list);
return container;
return objpool_alloc(&mod->priv.resources.objpool, sizeof(struct module_resource), 0);
}

static void container_put(struct processing_module *mod, struct module_resource *container)
{
struct module_resources *res = &mod->priv.resources;

list_item_append(&container->list, &res->free_cont_list);
objpool_free(&mod->priv.resources.objpool, container);
}

#if CONFIG_USERSPACE
Expand Down Expand Up @@ -235,7 +208,6 @@ void *mod_balloc_align(struct processing_module *mod, size_t size, size_t alignm
container->ptr = ptr;
container->size = size;
container->type = MOD_RES_HEAP;
list_item_prepend(&container->list, &res->res_list);

res->heap_usage += size;
if (res->heap_usage > res->heap_high_water_mark)
Expand Down Expand Up @@ -286,7 +258,6 @@ void *z_impl_mod_alloc_ext(struct processing_module *mod, uint32_t flags, size_t
container->ptr = ptr;
container->size = size;
container->type = MOD_RES_HEAP;
list_item_prepend(&container->list, &res->res_list);

res->heap_usage += size;
if (res->heap_usage > res->heap_high_water_mark)
Expand All @@ -306,7 +277,7 @@ EXPORT_SYMBOL(z_impl_mod_alloc_ext);
#if CONFIG_COMP_BLOB
struct comp_data_blob_handler *mod_data_blob_handler_new(struct processing_module *mod)
{
struct module_resources *res = &mod->priv.resources;
struct module_resources * __maybe_unused res = &mod->priv.resources;
struct comp_data_blob_handler *bhp;
struct module_resource *container;

Expand All @@ -325,7 +296,6 @@ struct comp_data_blob_handler *mod_data_blob_handler_new(struct processing_modul
container->bhp = bhp;
container->size = 0;
container->type = MOD_RES_BLOB_HANDLER;
list_item_prepend(&container->list, &res->res_list);

return bhp;
}
Expand Down Expand Up @@ -362,7 +332,6 @@ const void *z_impl_mod_fast_get(struct processing_module *mod, const void * cons
container->sram_ptr = ptr;
container->size = 0;
container->type = MOD_RES_FAST_GET;
list_item_prepend(&container->list, &res->res_list);

return ptr;
}
Expand Down Expand Up @@ -394,6 +363,29 @@ static int free_contents(struct processing_module *mod, struct module_resource *
return -EINVAL;
}

struct mod_res_cb_arg {
struct processing_module *mod;
const void *ptr;
};

static bool mod_res_free(void *data, void *arg)
{
struct mod_res_cb_arg *cb_arg = arg;
struct module_resource *container = data;

if (cb_arg->ptr && container->ptr != cb_arg->ptr)
return false;

int ret = free_contents(cb_arg->mod, container);

if (ret < 0)
comp_err(cb_arg->mod->dev, "Cannot free allocation %p", cb_arg->ptr);

container_put(cb_arg->mod, container);

return true;
}

/**
* Frees the memory block removes it from module's book keeping.
* @param mod Pointer to module this memory block was allocated for.
Expand All @@ -402,28 +394,19 @@ static int free_contents(struct processing_module *mod, struct module_resource *
int z_impl_mod_free(struct processing_module *mod, const void *ptr)
{
struct module_resources *res = &mod->priv.resources;
struct module_resource *container;
struct list_item *res_list;

MEM_API_CHECK_THREAD(res);
if (!ptr)
return 0;

/* Find which container keeps this memory */
list_for_item(res_list, &res->res_list) {
container = container_of(res_list, struct module_resource, list);
if (container->ptr == ptr) {
int ret = free_contents(mod, container);

list_item_del(&container->list);
container_put(mod, container);
return ret;
}
}
/* Find which container holds this memory */
struct mod_res_cb_arg cb_arg = {mod, ptr};
int ret = objpool_iterate(&res->objpool, mod_res_free, &cb_arg);

comp_err(mod->dev, "error: could not find memory pointed by %p", ptr);
if (ret < 0)
comp_err(mod->dev, "error: could not find memory pointed by %p", ptr);

return -EINVAL;
return ret;
}
EXPORT_SYMBOL(z_impl_mod_free);

Expand Down Expand Up @@ -684,32 +667,14 @@ int module_reset(struct processing_module *mod)
void mod_free_all(struct processing_module *mod)
{
struct module_resources *res = &mod->priv.resources;
struct k_heap *mod_heap = res->heap;
struct list_item *list;
struct list_item *_list;

MEM_API_CHECK_THREAD(res);
/* Free all contents found in used containers */
list_for_item(list, &res->res_list) {
struct module_resource *container =
container_of(list, struct module_resource, list);

free_contents(mod, container);
}

/*
* We do not need to remove the containers from res_list in
* the loop above or go through free_cont_list as all the
* containers are anyway freed in the loop below, and the list
* heads are reinitialized when mod_resource_init() is called.
*/
list_for_item_safe(list, _list, &res->cont_chunk_list) {
struct container_chunk *chunk =
container_of(list, struct container_chunk, chunk_list);
/* Free all contents found in used containers */
struct mod_res_cb_arg cb_arg = {mod, NULL};

list_item_del(&chunk->chunk_list);
sof_heap_free(mod_heap, chunk);
}
objpool_iterate(&res->objpool, mod_res_free, &cb_arg);
objpool_prune(&res->objpool);

/* Make sure resource lists and accounting are reset */
mod_resource_init(mod);
Expand Down
7 changes: 3 additions & 4 deletions src/include/sof/audio/module_adapter/module/generic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
#ifndef __SOF_AUDIO_MODULE_GENERIC__
#define __SOF_AUDIO_MODULE_GENERIC__

#include <sof/audio/component.h>
#include <sof/objpool.h>
#include <sof/ut.h>
#include <sof/audio/component.h>
#include <sof/audio/sink_api.h>
#include <sof/audio/source_api.h>
#include "module_interface.h"
Expand Down Expand Up @@ -128,9 +129,7 @@ struct module_param {
* when the module unloads.
*/
struct module_resources {
struct list_item res_list; /**< Allocad resource containers */
struct list_item free_cont_list; /**< Unused memory containers */
struct list_item cont_chunk_list; /**< Memory container chunks */
struct objpool_head objpool;
size_t heap_usage;
size_t heap_high_water_mark;
struct k_heap *heap;
Expand Down
28 changes: 28 additions & 0 deletions src/include/sof/objpool.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@

#include <sof/list.h>

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

struct k_heap;
struct objpool_head {
struct list_item list;
struct k_heap *heap;
uint32_t flags;
};

Expand Down Expand Up @@ -49,4 +53,28 @@ void *objpool_alloc(struct objpool_head *head, size_t size, uint32_t flags);
*/
int objpool_free(struct objpool_head *head, void *data);

/**
* Free all of the object pool memory
*
* @param head Pointer to the object pool head.
*/
void objpool_prune(struct objpool_head *head);

/* returns true to stop */
typedef bool (*objpool_iterate_cb)(void *data, void *arg);

/**
* Iterate over object pool entries until stopped
*
* @param head Pointer to the object pool head.
* @param cb Callback function
* @param arg Callback function argument
*
* @return 0 on success or a negative error code.
*
* Call the callback function for each entry in the pool, until it returns true.
* If the callback never returns true, return an error.
*/
int objpool_iterate(struct objpool_head *head, objpool_iterate_cb cb, void *arg);

#endif
52 changes: 46 additions & 6 deletions src/lib/objpool.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,34 @@ struct objpool {

#define OBJPOOL_BITS (sizeof(((struct objpool *)0)->mask) * 8)

static int objpool_add(struct list_item *head, unsigned int n, size_t size, uint32_t flags)
static int objpool_add(struct objpool_head *head, unsigned int n, size_t size, uint32_t flags)
{
if (n > OBJPOOL_BITS)
return -ENOMEM;

if (!is_power_of_2(n))
return -EINVAL;

size_t aligned_size = ALIGN_UP(size, sizeof(int));
size_t aligned_size = n * ALIGN_UP(size, sizeof(int));

/* Initialize with 0 to give caller a chance to identify new allocations */
struct objpool *pobjpool = rzalloc(flags, n * aligned_size + sizeof(*pobjpool));
if (!head->heap)
head->heap = sof_sys_heap_get();

struct objpool *pobjpool = sof_heap_alloc(head->heap, flags,
aligned_size + sizeof(*pobjpool), 0);

if (!pobjpool)
return -ENOMEM;

/* Initialize with 0 to give caller a chance to identify new allocations */
memset(pobjpool->data, 0, aligned_size);

pobjpool->n = n;
/* clear bit means free */
pobjpool->mask = 0;
pobjpool->size = size;

list_item_append(&pobjpool->list, head);
list_item_append(&pobjpool->list, &head->list);

return 0;
}
Expand Down Expand Up @@ -99,7 +105,7 @@ void *objpool_alloc(struct objpool_head *head, size_t size, uint32_t flags)
new_n = pobjpool->n << 1;
}

if (objpool_add(&head->list, new_n, size, flags) < 0)
if (objpool_add(head, new_n, size, flags) < 0)
return NULL;

/* Return the first element of the new objpool, which is now the last one in the list */
Expand Down Expand Up @@ -137,3 +143,37 @@ int objpool_free(struct objpool_head *head, void *data)

return -EINVAL;
}

void objpool_prune(struct objpool_head *head)
{
struct list_item *next, *tmp;

list_for_item_safe(next, tmp, &head->list) {
list_item_del(next);
sof_heap_free(head->heap, container_of(next, struct objpool, list));
}
}

int objpool_iterate(struct objpool_head *head, objpool_iterate_cb cb, void *arg)
{
struct list_item *list;

list_for_item(list, &head->list) {
struct objpool *pobjpool = container_of(list, struct objpool, list);
size_t aligned_size = ALIGN_UP(pobjpool->size, sizeof(int));
uint32_t mask = pobjpool->mask;
unsigned int bit;

if (!mask)
/* all free */
continue;

for (; mask; mask &= ~BIT(bit)) {
Copy link
Contributor

@jsarha jsarha Feb 3, 2026

Choose a reason for hiding this comment

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

This looks funny and almost makes me think bit is used uninitialized. I would write it this way:

while (mask) {
	bit = ffs(mask) - 1;
	if (cb(pobjpool->data + bit * aligned_size, arg))
		return 0;
	mask &= ~BIT(bit)
}

But both definitely work, and I did not follow your suggestion to go from while to for, so feel free not to follow mine.

Copy link
Collaborator Author

@lyakh lyakh Feb 4, 2026

Choose a reason for hiding this comment

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

@jsarha heh, yep, love my for loops ;-) To me such a for loop is a way to separate iterator initialisation, check and advance from the actual work. It's like using (iterator) iterate; But is does seem to be a matter of taste, so, we can leave it at that ;-)

bit = ffs(mask) - 1;
if (cb(pobjpool->data + bit * aligned_size, arg))
return 0;
}
}

return -ENOENT;
}
5 changes: 5 additions & 0 deletions src/platform/library/lib/alloc.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,8 @@ void heap_trace_all(int force)
{
heap_trace(NULL, 0);
}

struct k_heap *sof_sys_heap_get(void)
{
return NULL;
}
1 change: 1 addition & 0 deletions test/cmocka/src/audio/eq_fir/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ add_library(audio_for_eq_fir STATIC
${PROJECT_SOURCE_DIR}/src/ipc/ipc3/helper.c
${PROJECT_SOURCE_DIR}/src/ipc/ipc-common.c
${PROJECT_SOURCE_DIR}/src/ipc/ipc-helper.c
${PROJECT_SOURCE_DIR}/src/lib/objpool.c
${PROJECT_SOURCE_DIR}/test/cmocka/src/notifier_mocks.c
${PROJECT_SOURCE_DIR}/src/audio/pipeline/pipeline-graph.c
${PROJECT_SOURCE_DIR}/src/audio/pipeline/pipeline-params.c
Expand Down
1 change: 1 addition & 0 deletions test/cmocka/src/audio/eq_iir/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ add_library(audio_for_eq_iir STATIC
${PROJECT_SOURCE_DIR}/src/ipc/ipc3/helper.c
${PROJECT_SOURCE_DIR}/src/ipc/ipc-common.c
${PROJECT_SOURCE_DIR}/src/ipc/ipc-helper.c
${PROJECT_SOURCE_DIR}/src/lib/objpool.c
${PROJECT_SOURCE_DIR}/test/cmocka/src/notifier_mocks.c
${PROJECT_SOURCE_DIR}/src/audio/pipeline/pipeline-graph.c
${PROJECT_SOURCE_DIR}/src/audio/pipeline/pipeline-params.c
Expand Down
Loading
Loading