wip: alloc: add scratch & batch heaps on top of virtual pages

lrgirdwo · lrgirdwo · commit 04bc5c1460d8 · 2025-10-05T19:18:03.000+01:00
WIP: To be split into smaller patches.

1) Add a simple contiguous virtual page allocator.

2) Add a scratch and batch heap on top of pre alloctated virtual pages.

3) Integrate into mod_alloc() and mod_free() to use scratch and batch
   heaps for runtime and lifetime pipeline data.

4) TODO: Make sure all pipeline resources exist within same virtual
   region.

Signed-off-by: Liam Girdwood &lt;liam.r.girdwood@linux.intel.com&gt;
diff --git a/src/audio/module_adapter/module/generic.c b/src/audio/module_adapter/module/generic.c
@@ -184,11 +184,22 @@ void *mod_alloc_align(struct processing_module *mod, uint32_t size, uint32_t ali
 		return NULL;
 	}
 
+#if CONFIG_SOF_PACOVR
+	/* do we need to use the scratch heap or the batch heap? */
+	if (mod->priv.state != MODULE_INITIALIZED) {
+		/* batch allocator */
+		ptr = pacovr_batch_alloc(mod->dev->pipeline->pacovr, size);
+	} else {
+		/* scratch allocator */
+		ptr = pacovr_scratch_alloc_align(mod->dev->pipeline->pacovr, size, alignment);
+	}
+#else
 	/* Allocate memory for module */
 	if (alignment)
 		ptr = rballoc_align(SOF_MEM_FLAG_USER, size, alignment);
 	else
 		ptr = rballoc(SOF_MEM_FLAG_USER, size);
+#endif
 
 	if (!ptr) {
 		comp_err(mod->dev, "failed to allocate memory.");
@@ -318,7 +329,18 @@ static int free_contents(struct processing_module *mod, struct module_resource *
 
 	switch (container->type) {
 	case MOD_RES_HEAP:
+#if CONFIG_SOF_PACOVR
+	/* do we need to use the scratch heap or the batch heap? */
+	if (mod->priv.state != MODULE_INITIALIZED) {
+		/* batch allocator */
+		pacovr_batch_free(mod->dev->pipeline->pacovr);
+	} else {
+		/* scratch allocator */
+		pacovr_scratch_free(mod->dev->pipeline->pacovr);
+	}
+#else
 		rfree(container->ptr);
+#endif
 		res->heap_usage -= container->size;
 		return 0;
 #if CONFIG_COMP_BLOB
diff --git a/src/audio/pipeline/pipeline-graph.c b/src/audio/pipeline/pipeline-graph.c
@@ -12,6 +12,7 @@
 #include <rtos/interrupt.h>
 #include <rtos/symbol.h>
 #include <sof/lib/mm_heap.h>
+#include <sof/lib/pacovr.h>
 #include <sof/lib/uuid.h>
 #include <sof/compiler_attributes.h>
 #include <sof/list.h>
@@ -127,6 +128,18 @@ struct pipeline *pipeline_new(uint32_t pipeline_id, uint32_t priority, uint32_t
 		return NULL;
 	}
 
+#if CONFIG_SOF_PACOVR
+	/* create a pacovr region for all resources */
+	// TODO: make batch and scratch sizes configurable from topology
+	size_t scratch_size = 0x4000; /* 16kB scratch */
+	size_t batch_size = 0x20000;  /* 128kB batch */
+	p->pacovr = pacovr_create(batch_size, scratch_size);
+	if (!p->pacovr) {
+		pipe_err(p, "pipeline_new(): pacovr_create() failed.");
+		goto free;
+	}
+#endif
+
 	/* init pipeline */
 	p->comp_id = comp_id;
 	p->priority = priority;
@@ -236,6 +249,10 @@ int pipeline_free(struct pipeline *p)
 
 	pipeline_posn_offset_put(p->posn_offset);
 
+#if CONFIG_SOF_PACOVR
+	/* free pacovr region */
+	pacovr_destroy(p->pacovr);
+#endif
 	/* now free the pipeline */
 	rfree(p);
 
diff --git a/src/include/sof/audio/pipeline.h b/src/include/sof/audio/pipeline.h
@@ -10,6 +10,7 @@
 
 #include <sof/lib/cpu.h>
 #include <sof/lib/mailbox.h>
+#include <sof/lib/pacovr.h>
 #include <sof/list.h>
 #include <rtos/task.h>
 #include <rtos/sof.h>
@@ -64,6 +65,9 @@ struct pipeline {
 	uint32_t time_domain;	/**< scheduling time domain */
 	uint32_t attributes;   /**< pipeline attributes from IPC extension msg/ */
 
+	/* pipeline resource management */
+	struct pacovr *pacovr;
+
 	/* runtime status */
 	int32_t xrun_bytes;		/* last xrun length */
 	uint32_t status;		/* pipeline status */
diff --git a/zephyr/CMakeLists.txt b/zephyr/CMakeLists.txt
@@ -288,7 +288,11 @@ if (CONFIG_SOC_SERIES_INTEL_ADSP_ACE)
 	)
 
 	# Sources for virtual heap management
-	zephyr_library_sources(
+	zephyr_library_sources_ifdef(CONFIG_SOF_PACOVR
+		lib/vpages.c
+		lib/pacovr.c
+	)
+	zephyr_library_sources_ifndef(CONFIG_SOF_PACOVR,
 		lib/regions_mm.c
 	)
 
diff --git a/zephyr/Kconfig b/zephyr/Kconfig
@@ -76,6 +76,16 @@ config SOF_ZEPHYR_USERSPACE_MODULE_HEAP_SIZE
 	 module has its own independent heap to which only it has access. This heap is
 	 shared between instances of the same module.
 
+config SOF_PACOVR
+	bool "Enable PACOVR memory allocator"
+	default y if ACE
+	default n
+	depends on ACE
+	help
+	  Enable the PACOVR memory allocator for pipeline resource management.
+	  PACOVR provides a way to manage memory resources for audio pipelines,
+	  including both batch and scratch allocations.
+
 config ZEPHYR_NATIVE_DRIVERS
 	bool "Use Zephyr native drivers"
 	help
diff --git a/zephyr/include/sof/lib/pacovr.h b/zephyr/include/sof/lib/pacovr.h
@@ -0,0 +1,114 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright(c) 2025 Intel Corporation.
+
+/* Pre Allocated Contiguous Virtual Region */
+#ifndef __SOF_LIB_PACOVR_H__
+#define __SOF_LIB_PACOVR_H__
+
+#include <zephyr/kernel.h>
+#include <stddef.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct pacovr;
+
+/**
+ * @brief Create a new PACOVR instance.
+ *
+ * Create a new PACOVR instance with specified batch and scratch sizes. Total
+ * size is the sum of batch and scratch sizes.
+ *
+ * @param[in] batch_size Size of the PACOVR batch region.
+ * @param[in] scratch_size Size of the scratch heap.
+ * @return struct pacovr* Pointer to the new PACOVR instance, or NULL on failure.
+ */
+struct pacovr *pacovr_create(size_t batch_size, size_t scratch_size);
+
+/**
+ * @brief Destroy a PACOVR instance.
+ *
+ * Free all associated resources and deallocate the PACOVR instance.
+ *
+ * @param[in] p Pointer to the PACOVR instance to destroy.
+ */
+void pacovr_destroy(struct pacovr *p);
+
+/**
+ * @brief Allocate memory from the PACOVR scratch heap.
+ *
+ * Allocate memory from the PACOVR scratch heap. Intended use for temporary
+ * allocations during audio processing. i.e. change of parameters or kcontrols.
+ *
+ * @param[in] p Pointer to the PACOVR instance.
+ * @param[in] size Size of the allocation.
+ * @return void* Pointer to the allocated memory, or NULL on failure.
+ */
+void *pacovr_scratch_alloc(struct pacovr *p, size_t size);
+
+/**
+ * @brief Allocate memory with alignment from the PACOVR scratch heap.
+ *
+ * Allocate memory with alignment from the PACOVR scratch heap. Intended use for
+ * temporary allocations during audio processing. i.e. change of parameters or
+ * kcontrols.
+ *
+ * @param[in] p Pointer to the PACOVR instance.
+ * @param[in] size Size of the allocation.
+ * @param[in] align Alignment of the allocation.
+ * @return void* Pointer to the allocated memory, or NULL on failure.
+ */
+void *pacovr_scratch_alloc_align(struct pacovr *p, size_t size, size_t align);
+
+/**
+ * @brief Free memory from the PACOVR scratch heap.
+ *
+ * Free memory from the PACOVR scratch heap. Intended use for temporary
+ * allocations during audio processing. i.e. change of parameters or
+ * kcontrols.
+ *
+ * @param[in] p Pointer to the PACOVR instance.
+ * @param[in] ptr Pointer to the memory to free.
+ */
+void pacovr_scratch_free(struct pacovr *p, void *ptr);
+
+/**
+ * @brief Allocate memory from the PACOVR batch allocator.
+ *
+ * Allocate memory from the PACOVR batch allocator. Intended use for
+ * allocations that persist for the lifetime of the audio processing pipeline.
+ * i.e. component data, buffers, etc.
+ *
+ * @param[in] p Pointer to the PACOVR instance.
+ * @param[in] size Size of the allocation.
+ * @param[in] align Alignment of the allocation.
+ * @return void* Pointer to the allocated memory, or NULL on failure.
+ */
+void *pacovr_batch_alloc(struct pacovr *p, size_t size);
+
+/**
+ * @brief Free memory from the PACOVR batch allocator.
+ *
+ * Free memory from the PACOVR batch allocator. This is a no-op and is
+ * intended for tuning and tracking only. Batch allocations are freed
+ * when the PACOVR instance is destroyed. Any call to this function usually
+ * means the allocation should have been from the scratch heap.
+ *
+ * @param[in] p Pointer to the PACOVR instance.
+ * @param[in] ptr Pointer to the memory to free.
+ */
+void pacovr_batch_free(struct pacovr *p, void *ptr);
+
+/**
+ * @brief Log PACOVR memory usage.
+ *
+ * @param[in] p Pointer to the PACOVR instance.
+ */
+void pacovr_info(struct pacovr *p);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __SOF_LIB_PACOVR_H__ */
diff --git a/zephyr/include/sof/lib/vpage.h b/zephyr/include/sof/lib/vpage.h
@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright(c) 2025 Intel Corporation.
+
+/* Virtual Page Allocator API */
+#ifndef __SOF_LIB_VPAGE_H__
+#define __SOF_LIB_VPAGE_H__
+
+#include <zephyr/kernel.h>
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Allocate virtual pages
+ * Allocates a specified number of contiguous virtual memory pages.
+ *
+ * @param[in] pages Number of 4kB pages to allocate.
+ *
+ * @return Pointer to the allocated virtual memory region, or NULL on failure.
+ */
+void *vpage_alloc(uint32_t pages);
+
+/**
+ * @brief Free virtual pages
+ * Frees previously allocated virtual memory pages and unmaps them.
+ *
+ * @param[in] ptr Pointer to the memory pages to free.
+ */
+void vpage_free(void *ptr);
+
+/**
+ * @brief Initialize virtual page allocator
+ *
+ * Initializes a virtual page allocator that manages a virtual memory region
+ * using a page table and block structures.
+ *
+ * @retval 0 if successful.
+ * @retval -ENOMEM on creation failure.
+ */
+int vpage_init(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __SOF_LIB_VPAGE_H__ */
diff --git a/zephyr/lib/pacovr.c b/zephyr/lib/pacovr.c
diff --git a/zephyr/lib/vpages.c b/zephyr/lib/vpages.c

Original file line number	Diff line number	Diff line change
`@@ -288,7 +288,11 @@ if (CONFIG_SOC_SERIES_INTEL_ADSP_ACE)`
`288`	`288`	`)`
`289`	`289`
`290`	`290`	`# Sources for virtual heap management`
`291`		`- zephyr_library_sources(`
	`291`	`+ zephyr_library_sources_ifdef(CONFIG_SOF_PACOVR`
	`292`	`+ lib/vpages.c`
	`293`	`+ lib/pacovr.c`
	`294`	`+ )`
	`295`	`+ zephyr_library_sources_ifndef(CONFIG_SOF_PACOVR,`
`292`	`296`	`lib/regions_mm.c`
`293`	`297`	`)`
`294`	`298`