module-adapter: allocate control objects on an own heap

We want to be able to serve all module memory allocations from a
private heap. This commit creates such a heap for DP scheduled
modules and moves struct comp_dev and struct processing_module to it.

Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>

Author: lyakh

src/audio/module_adapter/module_adapter.c

@@ -23,6 +23,7 @@
 #include <sof/platform.h>
 #include <sof/ut.h>
 #include <rtos/interrupt.h>
+#include <rtos/kernel.h>
 #include <rtos/symbol.h>
 #include <limits.h>
 #include <stdint.h>
@@ -44,54 +45,111 @@ struct comp_dev *module_adapter_new(const struct comp_driver *drv,
 	return module_adapter_new_ext(drv, config, spec, NULL, NULL);
 }
 
-static struct processing_module *module_adapter_mem_alloc(const struct comp_driver *drv,
-							  const struct comp_ipc_config *config)
+#if CONFIG_MM_DRV
+#define PAGE_SZ CONFIG_MM_DRV_PAGE_SIZE
+#else
+#include <platform/platform.h>
+#define PAGE_SZ HOST_PAGE_SIZE
+#endif
+
+static struct k_heap *module_adapter_dp_heap(const struct comp_ipc_config *config,
+					     uint32_t *flags)
 {
-	struct comp_dev *dev = comp_alloc(drv, sizeof(*dev));
+	/* src-lite with 8 channels has been seen allocating 14k in one go */
+	/* FIXME: the size will be derived from configuration */
+	const size_t heap_size = 20 * 1024;
 
-	if (!dev) {
-		comp_cl_err(drv, "failed to allocate memory for comp_dev");
+	/* Keep uncached to match the default SOF heap! */
+	uint8_t *mod_heap_mem = rballoc_align(SOF_MEM_FLAG_USER | SOF_MEM_FLAG_COHERENT,
+					      heap_size, PAGE_SZ);
+
+	if (!mod_heap_mem)
 		return NULL;
-	}
 
-	/* allocate module information.
+	struct k_heap *mod_heap = (struct k_heap *)mod_heap_mem;
+	const size_t heap_prefix_size = ALIGN_UP(sizeof(*mod_heap), 8);
+	void *mod_heap_buf = mod_heap_mem + heap_prefix_size;
+
+	k_heap_init(mod_heap, mod_heap_buf, heap_size - heap_prefix_size);
+	/*
 	 * for DP shared modules this struct must be accessible from all cores
 	 * Unfortunately at this point there's no information of components the module
 	 * will be bound to. So we need to allocate shared memory for each DP module
 	 * To be removed when pipeline 2.0 is ready
 	 */
-	int flags = config->proc_domain == COMP_PROCESSING_DOMAIN_DP ?
-			     SOF_MEM_FLAG_USER | SOF_MEM_FLAG_COHERENT : SOF_MEM_FLAG_USER;
+	*flags = SOF_MEM_FLAG_COHERENT;
 
-	struct processing_module *mod = sof_heap_alloc(drv->user_heap, flags, sizeof(*mod), 0);
+	return mod_heap;
+}
+
+static struct processing_module *module_adapter_mem_alloc(const struct comp_driver *drv,
+							  const struct comp_ipc_config *config)
+{
+	struct k_heap *mod_heap;
+	uint32_t flags;
+
+	if (config->proc_domain == COMP_PROCESSING_DOMAIN_DP && IS_ENABLED(CONFIG_USERSPACE) &&
+	    !IS_ENABLED(CONFIG_SOF_USERSPACE_USE_DRIVER_HEAP)) {
+		mod_heap = module_adapter_dp_heap(config, &flags);
+		if (!mod_heap) {
+			comp_cl_err(drv, "Failed to allocate DP module heap");
+			return NULL;
+		}
+	} else {
+		flags = 0;
+		mod_heap = drv->user_heap;
+	}
+
+	struct processing_module *mod = sof_heap_alloc(mod_heap, flags, sizeof(*mod), 0);
 
 	if (!mod) {
-		comp_err(dev, "failed to allocate memory for module");
-		goto err;
+		comp_cl_err(drv, "failed to allocate memory for module");
+		goto emod;
 	}
 
 	memset(mod, 0, sizeof(*mod));
+	mod->priv.resources.heap = mod_heap;
+
+	/*
+	 * comp_alloc() always allocated dev uncached. Would be difficult to optimize. Only
+	 * if the whole currently active topology is running on the primary core, then it
+	 * can be cached. Effectively it can be only cached in single-core configurations.
+	 */
+	struct comp_dev *dev = sof_heap_alloc(mod_heap, SOF_MEM_FLAG_COHERENT, sizeof(*dev), 0);
+
+	if (!dev) {
+		comp_cl_err(drv, "failed to allocate memory for comp_dev");
+		goto err;
+	}
+
+	memset(dev, 0, sizeof(*dev));
+	comp_init(drv, dev, sizeof(*dev));
 	dev->ipc_config = *config;
 	mod->dev = dev;
 	dev->mod = mod;
 
 	return mod;
 
 err:
-	sof_heap_free(drv->user_heap, dev);
+	sof_heap_free(mod_heap, mod);
+emod:
+	if (mod_heap != drv->user_heap)
+		rfree(mod_heap);
 
 	return NULL;
 }
 
 static void module_adapter_mem_free(struct processing_module *mod)
 {
-	const struct comp_driver *drv = mod->dev->drv;
+	struct k_heap *mod_heap = mod->priv.resources.heap;
 
 #if CONFIG_IPC_MAJOR_4
+	const struct comp_driver *drv = mod->dev->drv;
+
 	sof_heap_free(drv->user_heap, mod->priv.cfg.input_pins);
 #endif
-	sof_heap_free(drv->user_heap, mod->dev);
-	sof_heap_free(drv->user_heap, mod);
+	sof_heap_free(mod_heap, mod->dev);
+	sof_heap_free(mod_heap, mod);
 }
 
 /*

src/include/sof/audio/module_adapter/module/generic.h

@@ -132,6 +132,7 @@ struct module_resources {
 	struct list_item cont_chunk_list;	/**< Memory container chunks */
 	size_t heap_usage;
 	size_t heap_high_water_mark;
+	struct k_heap *heap;
 #if CONFIG_MODULE_MEMORY_API_DEBUG && defined(__ZEPHYR__)
 	k_tid_t rsrc_mngr;
 #endif

zephyr/Kconfig

@@ -45,6 +45,12 @@ config SOF_USERSPACE_USE_SHARED_HEAP
 	  When set a shared heap will be used for audio buffers between SOF
 	  kernel and userspace modules.
 
+config SOF_USERSPACE_USE_DRIVER_HEAP
+	bool "Use driver heap for SOF userspace modules"
+	depends on USERSPACE
+	help
+	  When set driver heaps will be used for all SOF userspace modules.
+
 config SOF_ZEPHYR_SHARED_BUFFER_HEAP_SIZE
 	hex "Size of the shared buffer heap for SOF userspace modules"
 	default 0x0 if !SOF_USERSPACE_USE_SHARED_HEAP