modules: Add safeguard to mod_alloc() and friends

Add safeguard to mod_alloc() and friends that checks that they are
always called from the same thread (e.g. no locking needed).

The checking code has to be also behind defined(__ZEPHYR__) to keep
cmocka tests working.

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

Author: Jyri Sarha

src/audio/module_adapter/Kconfig

@@ -13,6 +13,17 @@ menu "Processing modules"
 		  containers to allocate at once is selected by this
 		  config option.
 
+	config MODULE_MEMORY_API_DEBUG
+		bool "Turn on memory API thread safety checks"
+		default y if DEBUG
+		help
+		  The Module Memory API structures are not protected
+		  by locks. This is because the initialization,
+		  allocation, and freeing of resources should always
+		  be done in the same thread. This option adds an
+		  assert to make sure no other thread makes such
+		  operations.
+
 	config CADENCE_CODEC
 		bool "Cadence codec"
 		default n

src/audio/module_adapter/module/generic.c

@@ -17,6 +17,14 @@
 #include <sof/audio/data_blob.h>
 #include <sof/lib/fast-get.h>
 
+/* The __ZEPHYR__ condition is to keep cmocka tests working */
+#if CONFIG_MODULE_MEMORY_API_DEBUG && defined(__ZEPHYR__)
+#define MEM_API_CHECK_THREAD(res) __ASSERT((res)->rsrc_mngr == k_current_get(), \
+		"Module memory API operation from wrong thread")
+#else
+#define MEM_API_CHECK_THREAD(res)
+#endif
+
 LOG_MODULE_DECLARE(module_adapter, CONFIG_SOF_LOG_LEVEL);
 
 int module_load_config(struct comp_dev *dev, const void *cfg, size_t size)
@@ -99,7 +107,9 @@ int module_init(struct processing_module *mod)
 	list_init(&md->resources.cont_chunk_list);
 	md->resources.heap_usage = 0;
 	md->resources.heap_high_water_mark = 0;
-
+#if CONFIG_MODULE_MEMORY_API_DEBUG && defined(__ZEPHYR__)
+	md->resources.rsrc_mngr = k_current_get();
+#endif
 	/* Now we can proceed with module specific initialization */
 	ret = interface->init(mod);
 	if (ret) {
@@ -167,6 +177,7 @@ void *mod_alloc_align(struct processing_module *mod, uint32_t size, uint32_t ali
 	struct module_resources *res = &mod->priv.resources;
 	void *ptr;
 
+	MEM_API_CHECK_THREAD(res);
 	if (!container)
 		return NULL;
 
@@ -251,6 +262,7 @@ mod_data_blob_handler_new(struct processing_module *mod)
 	struct module_resource *container = container_get(mod);
 	struct comp_data_blob_handler *bhp;
 
+	MEM_API_CHECK_THREAD(res);
 	if (!container)
 		return NULL;
 
@@ -284,6 +296,7 @@ const void *mod_fast_get(struct processing_module *mod, const void * const dram_
 	struct module_resource *container = container_get(mod);
 	const void *ptr;
 
+	MEM_API_CHECK_THREAD(res);
 	if (!container)
 		return NULL;
 
@@ -340,6 +353,7 @@ int mod_free(struct processing_module *mod, const void *ptr)
 	struct list_item *res_list;
 	struct list_item *_res_list;
 
+	MEM_API_CHECK_THREAD(res);
 	if (!ptr)
 		return 0;
 
@@ -560,6 +574,7 @@ void mod_free_all(struct processing_module *mod)
 	struct list_item *list;
 	struct list_item *_list;
 
+	MEM_API_CHECK_THREAD(res);
 	/* Find which container keeps this memory */
 	list_for_item_safe(list, _list, &res->res_list) {
 		struct module_resource *container =

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

@@ -19,6 +19,11 @@
 #include <sof/audio/source_api.h>
 #include "module_interface.h"
 
+/* The __ZEPHYR__ condition is to keep cmocka tests working */
+#if CONFIG_MODULE_MEMORY_API_DEBUG && defined(__ZEPHYR__)
+#include <zephyr/kernel/thread.h>
+#endif
+
 /*
  * helpers to determine processing type
  * Needed till all the modules use PROCESSING_MODE_SINK_SOURCE
@@ -127,6 +132,9 @@ struct module_resources {
 	struct list_item cont_chunk_list;	/**< Memory container chunks */
 	size_t heap_usage;
 	size_t heap_high_water_mark;
+#if CONFIG_MODULE_MEMORY_API_DEBUG && defined(__ZEPHYR__)
+	k_tid_t rsrc_mngr;
+#endif
 };
 
 enum mod_resource_type {