pipeline: allocate shared vregion for LL modules

Create a per-pipeline vregion in pipeline_new() when the IPC4 pipeline
extension payload specifies lifetime or interim heap sizes. The vregion
size is the sum of both. Store the vregion pointer in struct pipeline.

In module_adapter_new_ext() resolve the pipeline pointer before
module_adapter_mem_alloc() so the pipeline's vregion can be passed
down. LL modules on a pipeline with a vregion use it as their
allocation backend via vregion_get(), instead of the driver's default
heap. DP modules continue to create their own per-module vregion.

Call vregion_set_interim() for the pipeline vregion in
pipeline_complete() to switch the allocator to interim mode after all
lifetime allocations are done.

Release the pipeline vregion with vregion_put() in ipc_pipeline_free()
before calling pipeline_free(). Warn if the refcount does not reach
zero, indicating a module still holds a reference.

Also fix a pre-existing leak in module_adapter_mem_free(): always free
the per-module mod_alloc_ctx for LL modules regardless of the vregion
refcount, since alloc is allocated from the system heap, not from the
vregion.

Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>

Author: Jyri Sarha

src/audio/module_adapter/module_adapter.c

@@ -88,7 +88,8 @@ static struct vregion *module_adapter_dp_heap_new(const struct comp_ipc_config *
 static
 struct processing_module *module_adapter_mem_alloc(const struct comp_driver *drv,
 						   const struct comp_ipc_config *config,
-						   const struct module_ext_init_data *ext_init)
+						   const struct module_ext_init_data *ext_init,
+						   struct vregion *ppl_vreg)
 {
 	struct k_heap *mod_heap;
 	struct vregion *mod_vreg;
@@ -113,6 +114,10 @@ struct processing_module *module_adapter_mem_alloc(const struct comp_driver *drv
 			return NULL;
 		}
 		mod_heap = NULL;
+	} else if (ppl_vreg && config->proc_domain == COMP_PROCESSING_DOMAIN_LL) {
+		mod_vreg = vregion_get(ppl_vreg);
+		mod_heap = NULL;
+		heap_size = 0;
 	} else {
 		mod_heap = drv->user_heap;
 		heap_size = 0;
@@ -193,10 +198,12 @@ static void module_adapter_mem_free(struct processing_module *mod)
 #endif
 	if (alloc->vreg) {
 		struct vregion *mod_vreg = alloc->vreg;
+		uint32_t proc_domain = mod->dev->ipc_config.proc_domain;
 
 		vregion_free(mod_vreg, mod->dev);
 		vregion_free(mod_vreg, mod);
-		if (!vregion_put(mod_vreg))
+		/* DP module alloc is freed later, but for LL modules we free it here */
+		if (!vregion_put(mod_vreg) || proc_domain == COMP_PROCESSING_DOMAIN_LL)
 			rfree(alloc);
 	} else {
 		sof_heap_free(mod_heap, mod->dev);
@@ -251,7 +258,25 @@ struct comp_dev *module_adapter_new_ext(const struct comp_driver *drv,
 		NULL;
 #endif
 
-	struct processing_module *mod = module_adapter_mem_alloc(drv, config, ext_init);
+#if CONFIG_IPC_MAJOR_4
+	struct ipc_comp_dev *ipc_pipe;
+	struct ipc *ipc = ipc_get();
+	struct vregion *ppl_vreg = NULL;
+
+	/* resolve the pipeline pointer early to pass its vregion to mem_alloc */
+	ipc_pipe = ipc_get_comp_by_ppl_id(ipc, COMP_TYPE_PIPELINE, config->pipeline_id,
+					  IPC_COMP_IGNORE_REMOTE);
+	if (ipc_pipe && ipc_pipe->pipeline)
+		ppl_vreg = ipc_pipe->pipeline->vreg;
+#endif
+
+	struct processing_module *mod = module_adapter_mem_alloc(drv, config, ext_init,
+#if CONFIG_IPC_MAJOR_4
+								 ppl_vreg
+#else
+								 NULL
+#endif
+								 );
 
 	if (!mod)
 		return NULL;
@@ -310,12 +335,7 @@ struct comp_dev *module_adapter_new_ext(const struct comp_driver *drv,
 		goto err;
 
 #if CONFIG_IPC_MAJOR_4
-	struct ipc_comp_dev *ipc_pipe;
-	struct ipc *ipc = ipc_get();
-
 	/* set the pipeline pointer if ipc_pipe is valid */
-	ipc_pipe = ipc_get_comp_by_ppl_id(ipc, COMP_TYPE_PIPELINE, config->pipeline_id,
-					  IPC_COMP_IGNORE_REMOTE);
 	if (ipc_pipe) {
 		dev->pipeline = ipc_pipe->pipeline;
 

src/audio/pipeline/pipeline-graph.c

@@ -25,6 +25,7 @@
 #include <ipc/stream.h>
 #include <ipc/topology.h>
 #include <ipc4/module.h>
+#include <ipc4/pipeline.h>
 #include <errno.h>
 #include <stdbool.h>
 #include <stddef.h>
@@ -135,6 +136,16 @@ struct pipeline *pipeline_new(struct k_heap *heap, uint32_t pipeline_id, uint32_
 
 	/* init pipeline */
 	p->heap = heap;
+
+	/* Create vregion for pipeline and its modules if size info is available */
+	if (IS_ENABLED(CONFIG_SOF_VREGIONS) &&
+	    pparams && pparams->mem_data && pparams->mem_data->heap_bytes) {
+		alloc->vreg = vregion_create(pparams->mem_data->heap_bytes);
+		if (!alloc->vreg)
+			pipe_cl_err("Failed to create pipeline vregion of %zu bytes, using heap",
+				    pparams->mem_data->heap_bytes);
+	}
+
 	p->comp_id = comp_id;
 	p->priority = priority;
 	p->pipeline_id = pipeline_id;
@@ -337,6 +348,10 @@ int pipeline_complete(struct pipeline *p, struct comp_dev *source,
 
 	p->source_comp = source;
 	p->sink_comp = sink;
+
+	if (p->vreg)
+		vregion_set_interim(p->vreg);
+
 	p->status = COMP_STATE_READY;
 
 	/* show heap status */

src/include/sof/audio/pipeline.h

@@ -26,6 +26,7 @@ struct comp_dev;
 struct ipc;
 struct ipc_msg;
 struct k_heap;
+struct vregion;
 
 /*
  * Pipeline status to stop execution of current path, but to keep the
@@ -54,6 +55,7 @@ struct k_heap;
  */
 struct pipeline {
 	struct k_heap *heap;	/**< heap used for allocating this pipeline */
+	struct vregion *vreg;	/**< shared vregion for pipeline modules */
 	uint32_t comp_id;	/**< component id for pipeline */
 	uint32_t pipeline_id;	/**< pipeline id */
 	uint32_t sched_id;	/**< Scheduling component id */

src/ipc/ipc4/helper.c

@@ -513,6 +513,11 @@ __cold int ipc_pipeline_free(struct ipc *ipc, uint32_t comp_id)
 		return ret;
 	}
 
+	if (ipc_pipe->pipeline->vreg) {
+		if (vregion_put(ipc_pipe->pipeline->vreg))
+			tr_warn(&ipc_tr, "pipeline vregion still in use");
+	}
+
 	/* free buffer, delete all tasks and remove from list */
 	ret = pipeline_free(ipc_pipe->pipeline);
 	if (ret < 0) {