module_adapter: generic: Add mod_alloc_lvl2_init() and mod_free_all_lvl2()

Add mod_alloc_lvl2_init() and mod_free_all_lvl2() to enable second
level or resource allocations for a module. This second level can be
dropped with a single mod_free_all_lvl2() call, but the allocations
made before mod_alloc_lvl2_init() call will be kept.

The motivation behind this extra layer is Cadence codec module. For
the moment it uses mod_alloc() and friends in unorthodox way, and
allocates the resources needed at prepare() callback with mod_alloc(),
and drops those allocations in reset() callback by calling
mod_free_all(). But to do this the module needs to allocate its
private data and other with other means than mod_alloc(). The second
level of tracked allocations should help with this particular case.

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

Author: Jyri Sarha

src/audio/module_adapter/module/generic.c

@@ -75,7 +75,9 @@ static void mod_resource_init(struct processing_module *mod)
 {
 	struct module_data *md = &mod->priv;
 	/* Init memory list */
+	md->resources.lvl2_active = false;
 	list_init(&md->resources.res_list);
+	list_init(&md->resources.lvl2_res_list);
 	list_init(&md->resources.free_cont_list);
 	list_init(&md->resources.cont_chunk_list);
 	md->resources.heap_usage = 0;
@@ -207,7 +209,10 @@ 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);
+	if (res->lvl2_active)
+		list_item_prepend(&container->list, &res->lvl2_res_list);
+	else
+		list_item_prepend(&container->list, &res->res_list);
 
 	res->heap_usage += size;
 	if (res->heap_usage > res->heap_high_water_mark)
@@ -258,7 +263,10 @@ void *mod_alloc_ext(struct processing_module *mod, uint32_t flags, size_t size,
 	container->ptr = ptr;
 	container->size = size;
 	container->type = MOD_RES_HEAP;
-	list_item_prepend(&container->list, &res->res_list);
+	if (res->lvl2_active)
+		list_item_prepend(&container->list, &res->lvl2_res_list);
+	else
+		list_item_prepend(&container->list, &res->res_list);
 
 	res->heap_usage += size;
 	if (res->heap_usage > res->heap_high_water_mark)
@@ -298,7 +306,10 @@ mod_data_blob_handler_new(struct processing_module *mod)
 	container->bhp = bhp;
 	container->size = 0;
 	container->type = MOD_RES_BLOB_HANDLER;
-	list_item_prepend(&container->list, &res->res_list);
+	if (res->lvl2_active)
+		list_item_prepend(&container->list, &res->lvl2_res_list);
+	else
+		list_item_prepend(&container->list, &res->res_list);
 
 	return bhp;
 }
@@ -334,7 +345,10 @@ const void *mod_fast_get(struct processing_module *mod, const void * const dram_
 	container->sram_ptr = ptr;
 	container->size = 0;
 	container->type = MOD_RES_FAST_GET;
-	list_item_prepend(&container->list, &res->res_list);
+	if (res->lvl2_active)
+		list_item_prepend(&container->list, &res->lvl2_res_list);
+	else
+		list_item_prepend(&container->list, &res->res_list);
 
 	return ptr;
 }
@@ -375,15 +389,29 @@ int 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;
+	struct list_item *iterator;
 
 	MEM_API_CHECK_THREAD(res);
 	if (!ptr)
 		return 0;
 
+	if (res->lvl2_active) {
+		/* If level 2 is active, search it first */
+		list_for_item(iterator, &res->lvl2_res_list) {
+			container = container_of(iterator, 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 keeps this memory */
-	list_for_item(res_list, &res->res_list) {
-		container = container_of(res_list, struct module_resource, list);
+	list_for_item(iterator, &res->res_list) {
+		container = container_of(iterator, struct module_resource, list);
 		if (container->ptr == ptr) {
 			int ret = free_contents(mod, container);
 
@@ -415,6 +443,52 @@ void mod_fast_put(struct processing_module *mod, const void *sram_ptr)
 EXPORT_SYMBOL(mod_fast_put);
 #endif
 
+/**
+ * Activate second allocation level. All allocations after this call
+ * are considered 2nd level allocations. The all the 2nd level
+ * allocations can freed with a single mod_free_all_lvl2() call.
+ *
+ * @param mod	Pointer to module to start 2nd level allocations.
+ */
+void mod_alloc_lvl2_init(struct processing_module *mod)
+{
+	struct module_resources *res = &mod->priv.resources;
+
+#if defined(__ZEPHYR__)
+	__ASSERT(!res->lvl2_active, "Level 2 allocations already activated");
+#endif
+	res->lvl2_active = true;
+}
+
+/**
+ * Free all second level allocations and turn off level 2 allocation.
+ * Another mod_alloc_lvl2_init() call activates 2nd level again.
+ *
+ * @param mod	Pointer to module to free 2nd level allocations.
+ */
+void mod_free_all_lvl2(struct processing_module *mod)
+{
+	struct module_resources *res = &mod->priv.resources;
+	struct list_item *iterator;
+	struct list_item *_iterator;
+
+	MEM_API_CHECK_THREAD(res);
+
+	if (!res->lvl2_active)
+		return;
+
+	/* Free all contents found in lvl2 containers */
+	list_for_item_safe(iterator, _iterator, &res->lvl2_res_list) {
+		struct module_resource *container =
+			container_of(iterator, struct module_resource, list);
+
+		free_contents(mod, container);
+		list_item_del(&container->list);
+		container_put(mod, container);
+	}
+	res->lvl2_active = false;
+}
+
 int module_prepare(struct processing_module *mod,
 		   struct sof_source **sources, int num_of_sources,
 		   struct sof_sink **sinks, int num_of_sinks)

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

@@ -127,7 +127,9 @@ struct module_param {
  * when the module unloads.
  */
 struct module_resources {
+	bool lvl2_active;
 	struct list_item res_list;		/**< Allocad resource containers */
+	struct list_item lvl2_res_list;		/**< 2nd level allocated resources */
 	struct list_item free_cont_list;	/**< Unused memory containers */
 	struct list_item cont_chunk_list;	/**< Memory container chunks */
 	size_t heap_usage;
@@ -235,6 +237,9 @@ const void *mod_fast_get(struct processing_module *mod, const void * const dram_
 void mod_fast_put(struct processing_module *mod, const void *sram_ptr);
 #endif
 void mod_free_all(struct processing_module *mod);
+void mod_alloc_lvl2_init(struct processing_module *mod);
+void mod_free_all_lvl2(struct processing_module *mod);
+
 int module_prepare(struct processing_module *mod,
 		   struct sof_source **sources, int num_of_sources,
 		   struct sof_sink **sinks, int num_of_sinks);