pipeline: allocate on specific heap

Add a heap parameter to pipeline allocation functions. This makes it
possible to control how allocations are done with pipeline granularity
and makes it possible to move pipelines to user-space.

Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>

Author: kv2019i

src/audio/pipeline/pipeline-graph.c

@@ -11,6 +11,7 @@
 #include <sof/ipc/msg.h>
 #include <rtos/interrupt.h>
 #include <rtos/symbol.h>
+#include <rtos/alloc.h>
 #include <sof/lib/mm_heap.h>
 #include <sof/lib/uuid.h>
 #include <sof/compiler_attributes.h>
@@ -108,8 +109,8 @@ void pipeline_posn_init(struct sof *sof)
 }
 
 /* create new pipeline - returns pipeline id or negative error */
-struct pipeline *pipeline_new(uint32_t pipeline_id, uint32_t priority, uint32_t comp_id,
-			      struct create_pipeline_params *pparams)
+struct pipeline *pipeline_new(struct k_heap *heap, uint32_t pipeline_id, uint32_t priority,
+			      uint32_t comp_id, struct create_pipeline_params *pparams)
 {
 	struct sof_ipc_stream_posn posn;
 	struct pipeline *p;
@@ -122,13 +123,16 @@ struct pipeline *pipeline_new(uint32_t pipeline_id, uint32_t priority, uint32_t
 	heap_trace_all(0);
 
 	/* allocate new pipeline */
-	p = rzalloc(SOF_MEM_FLAG_USER, sizeof(*p));
+	p = sof_heap_alloc(heap, SOF_MEM_FLAG_USER, sizeof(*p), 0);
 	if (!p) {
 		pipe_cl_err("Out of Memory");
 		return NULL;
 	}
 
+	memset(p, 0, sizeof(*p));
+
 	/* init pipeline */
+	p->heap = heap;
 	p->comp_id = comp_id;
 	p->priority = priority;
 	p->pipeline_id = pipeline_id;
@@ -161,7 +165,7 @@ struct pipeline *pipeline_new(uint32_t pipeline_id, uint32_t priority, uint32_t
 
 	return p;
 free:
-	rfree(p);
+	sof_heap_free(heap, p);
 	return NULL;
 }
 
@@ -230,15 +234,15 @@ int pipeline_free(struct pipeline *p)
 #if !CONFIG_LIBRARY || UNIT_TEST
 		schedule_task_free(p->pipe_task);
 #endif
-		rfree(p->pipe_task);
+		sof_heap_free(p->heap, p->pipe_task);
 	}
 
 	ipc_msg_free(p->msg);
 
 	pipeline_posn_offset_put(p->posn_offset);
 
 	/* now free the pipeline */
-	rfree(p);
+	sof_heap_free(p->heap, p);
 
 	/* show heap status */
 	heap_trace_all(0);

src/audio/pipeline/pipeline-schedule.c

@@ -8,6 +8,7 @@
 #include <sof/audio/buffer.h>
 #include <sof/audio/component_ext.h>
 #include <sof/audio/pipeline.h>
+#include <rtos/alloc.h>
 #include <rtos/interrupt.h>
 #include <sof/lib/agent.h>
 #include <sof/list.h>
@@ -241,15 +242,17 @@ static struct task *pipeline_task_init(struct pipeline *p, uint32_t type)
 {
 	struct pipeline_task *task = NULL;
 
-	task = rzalloc(SOF_MEM_FLAG_USER,
-		       sizeof(*task));
+	task = sof_heap_alloc(p->heap, SOF_MEM_FLAG_USER,
+			      sizeof(*task), 0);
 	if (!task)
 		return NULL;
 
+	memset(task, 0, sizeof(*task));
+
 	if (schedule_task_init_ll(&task->task, SOF_UUID(pipe_task_uuid), type,
 				  p->priority, pipeline_task,
 				  p, p->core, 0) < 0) {
-		rfree(task);
+		sof_heap_free(p->heap, task);
 		return NULL;
 	}
 

src/include/sof/audio/pipeline.h

@@ -25,6 +25,7 @@ struct comp_buffer;
 struct comp_dev;
 struct ipc;
 struct ipc_msg;
+struct k_heap;
 
 /*
  * Pipeline status to stop execution of current path, but to keep the
@@ -52,6 +53,7 @@ struct ipc_msg;
  * Audio pipeline.
  */
 struct pipeline {
+	struct k_heap *heap;	/**< heap used for allocating this pipeline */
 	uint32_t comp_id;	/**< component id for pipeline */
 	uint32_t pipeline_id;	/**< pipeline id */
 	uint32_t sched_id;	/**< Scheduling component id */
@@ -152,14 +154,15 @@ struct create_pipeline_params {
 
 /**
  * \brief Creates a new pipeline.
+ * \param[in] heap Heap to allocate the pipeline on, or NULL for default.
  * \param[in] pipeline_id Pipeline ID number.
  * \param[in] priority Pipeline scheduling priority.
  * \param[in] comp_id Pipeline component ID number.
  * \param[in] pparams Pipeline parameters from IPC payload, maybe NULL.
  * \return New pipeline pointer or NULL.
  */
-struct pipeline *pipeline_new(uint32_t pipeline_id, uint32_t priority, uint32_t comp_id,
-			      struct create_pipeline_params *pparams);
+struct pipeline *pipeline_new(struct k_heap *heap, uint32_t pipeline_id, uint32_t priority,
+			      uint32_t comp_id, struct create_pipeline_params *pparams);
 
 /**
  * \brief Free's a pipeline.

src/ipc/ipc3/helper.c

@@ -395,7 +395,7 @@ int ipc_pipeline_new(struct ipc *ipc, ipc_pipe_new *_pipe_desc)
 	}
 
 	/* create the pipeline */
-	pipe = pipeline_new(pipe_desc->pipeline_id, pipe_desc->priority,
+	pipe = pipeline_new(NULL, pipe_desc->pipeline_id, pipe_desc->priority,
 			    pipe_desc->comp_id, NULL);
 	if (!pipe) {
 		tr_err(&ipc_tr, "pipeline_new() failed");

src/ipc/ipc4/helper.c

@@ -352,8 +352,8 @@ __cold static int ipc4_create_pipeline(struct ipc4_pipeline_create *pipe_desc,
 	}
 
 	/* create the pipeline */
-	pipe = pipeline_new(pipe_desc->primary.r.instance_id, pipe_desc->primary.r.ppl_priority, 0,
-			    pparams);
+	pipe = pipeline_new(NULL, pipe_desc->primary.r.instance_id,
+			    pipe_desc->primary.r.ppl_priority, 0, pparams);
 	if (!pipe) {
 		tr_err(&ipc_tr, "ipc: pipeline_new() failed");
 		return IPC4_OUT_OF_MEMORY;

test/cmocka/src/audio/pipeline/pipeline_free.c

@@ -23,7 +23,7 @@
 #endif
 
 /* mock free() - dont free as we inspect contents */
-void rfree(void *ptr)
+void sof_heap_free(struct k_heap *heap, void *addr)
 {
 }
 

test/cmocka/src/audio/pipeline/pipeline_new.c

@@ -49,7 +49,8 @@ static void test_audio_pipeline_pipeline_new_creation(void **state)
 	struct pipeline_new_setup_data *test_data = *state;
 
 	/*Testing component*/
-	struct pipeline *result = pipeline_new(test_data->pipe_id,
+	struct pipeline *result = pipeline_new(NULL,
+					       test_data->pipe_id,
 					       test_data->priority,
 					       test_data->comp_id,
 					       NULL);