module: generic: use a single static lock for module resources

Replace the per-pool k_mutex embedded in struct module_resources with a
single static K_MUTEX_DEFINE() shared by all module resource pools.

This approach to implement locking works both in kernel and userspace
SOF builds. When userspace is enabled, the resource API is only ever
entered from supervisor context (the z_impl_* syscall bodies), so is it
ok to have the lock only accessible from kernel.

Lock contention is negligible: resource bookkeeping happens at module
setup and teardown, not on the processing path, and the mutex carries
priority inheritance for the rare overlap.

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

Author: kv2019i

src/audio/module_adapter/module/generic.c

@@ -28,6 +28,15 @@
 
 LOG_MODULE_DECLARE(module_adapter, CONFIG_SOF_LOG_LEVEL);
 
+/*
+ * A single lock shared by all module resource pools. The resource API is only
+ * ever entered from supervisor context (the z_impl_* syscall bodies), so the
+ * lock does not need to live in the per-module, user-writable struct - a static
+ * kernel object serialises all pools. Contention is negligible because resource
+ * bookkeeping only happens at module setup/teardown, not on the processing path.
+ */
+static K_MUTEX_DEFINE(mod_res_lock);
+
 int module_load_config(struct comp_dev *dev, const void *cfg, size_t size)
 {
 	int ret;
@@ -79,7 +88,6 @@ void mod_resource_init(struct processing_module *mod)
 	struct module_resources *res = &mod->priv.resources;
 
 	/* Init memory list */
-	k_mutex_init(&res->lock);
 	list_init(&res->objpool.list);
 	res->objpool.heap = res->alloc->heap;
 	res->objpool.vreg = res->alloc->vreg;
@@ -179,18 +187,18 @@ void *z_impl_mod_balloc_align(struct processing_module *mod, size_t size, size_t
 	struct module_resources *res = &mod->priv.resources;
 	struct module_resource *container;
 
-	k_mutex_lock(&res->lock, K_FOREVER);
+	k_mutex_lock(&mod_res_lock, K_FOREVER);
 
 	container = container_get(mod);
 	if (!container) {
-		k_mutex_unlock(&res->lock);
+		k_mutex_unlock(&mod_res_lock);
 		return NULL;
 	}
 
 	if (!size) {
 		comp_err(mod->dev, "requested allocation of 0 bytes.");
 		container_put(mod, container);
-		k_mutex_unlock(&res->lock);
+		k_mutex_unlock(&mod_res_lock);
 		return NULL;
 	}
 
@@ -202,7 +210,7 @@ void *z_impl_mod_balloc_align(struct processing_module *mod, size_t size, size_t
 		comp_err(mod->dev, "Failed to alloc %zu bytes %zu alignment for comp %#x.",
 			 size, alignment, dev_comp_id(mod->dev));
 		container_put(mod, container);
-		k_mutex_unlock(&res->lock);
+		k_mutex_unlock(&mod_res_lock);
 		return NULL;
 	}
 	/* Store reference to allocated memory */
@@ -214,7 +222,7 @@ void *z_impl_mod_balloc_align(struct processing_module *mod, size_t size, size_t
 	if (res->heap_usage > res->heap_high_water_mark)
 		res->heap_high_water_mark = res->heap_usage;
 
-	k_mutex_unlock(&res->lock);
+	k_mutex_unlock(&mod_res_lock);
 	return ptr;
 }
 EXPORT_SYMBOL(z_impl_mod_balloc_align);
@@ -235,18 +243,18 @@ void *z_impl_mod_alloc_ext(struct processing_module *mod, uint32_t flags, size_t
 	struct module_resources *res = &mod->priv.resources;
 	struct module_resource *container;
 
-	k_mutex_lock(&res->lock, K_FOREVER);
+	k_mutex_lock(&mod_res_lock, K_FOREVER);
 
 	container = container_get(mod);
 	if (!container) {
-		k_mutex_unlock(&res->lock);
+		k_mutex_unlock(&mod_res_lock);
 		return NULL;
 	}
 
 	if (!size) {
 		comp_err(mod->dev, "requested allocation of 0 bytes.");
 		container_put(mod, container);
-		k_mutex_unlock(&res->lock);
+		k_mutex_unlock(&mod_res_lock);
 		return NULL;
 	}
 
@@ -257,7 +265,7 @@ void *z_impl_mod_alloc_ext(struct processing_module *mod, uint32_t flags, size_t
 		comp_err(mod->dev, "Failed to alloc %zu bytes %zu alignment for comp %#x.",
 			 size, alignment, dev_comp_id(mod->dev));
 		container_put(mod, container);
-		k_mutex_unlock(&res->lock);
+		k_mutex_unlock(&mod_res_lock);
 		return NULL;
 	}
 	/* Store reference to allocated memory */
@@ -269,7 +277,7 @@ void *z_impl_mod_alloc_ext(struct processing_module *mod, uint32_t flags, size_t
 	if (res->heap_usage > res->heap_high_water_mark)
 		res->heap_high_water_mark = res->heap_usage;
 
-	k_mutex_unlock(&res->lock);
+	k_mutex_unlock(&mod_res_lock);
 	return ptr;
 }
 EXPORT_SYMBOL(z_impl_mod_alloc_ext);
@@ -284,30 +292,29 @@ EXPORT_SYMBOL(z_impl_mod_alloc_ext);
 #if CONFIG_COMP_BLOB
 struct comp_data_blob_handler *z_impl_mod_data_blob_handler_new(struct processing_module *mod)
 {
-	struct module_resources *res = &mod->priv.resources;
 	struct comp_data_blob_handler *bhp;
 	struct module_resource *container;
 
-	k_mutex_lock(&res->lock, K_FOREVER);
+	k_mutex_lock(&mod_res_lock, K_FOREVER);
 
 	container = container_get(mod);
 	if (!container) {
-		k_mutex_unlock(&res->lock);
+		k_mutex_unlock(&mod_res_lock);
 		return NULL;
 	}
 
 	bhp = comp_data_blob_handler_new_ext(mod->dev, false, NULL, NULL);
 	if (!bhp) {
 		container_put(mod, container);
-		k_mutex_unlock(&res->lock);
+		k_mutex_unlock(&mod_res_lock);
 		return NULL;
 	}
 
 	container->bhp = bhp;
 	container->size = 0;
 	container->type = MOD_RES_BLOB_HANDLER;
 
-	k_mutex_unlock(&res->lock);
+	k_mutex_unlock(&mod_res_lock);
 	return bhp;
 }
 EXPORT_SYMBOL(z_impl_mod_data_blob_handler_new);
@@ -328,26 +335,26 @@ const void *z_impl_mod_fast_get(struct processing_module *mod, const void * cons
 	struct module_resource *container;
 	const void *ptr;
 
-	k_mutex_lock(&res->lock, K_FOREVER);
+	k_mutex_lock(&mod_res_lock, K_FOREVER);
 
 	container = container_get(mod);
 	if (!container) {
-		k_mutex_unlock(&res->lock);
+		k_mutex_unlock(&mod_res_lock);
 		return NULL;
 	}
 
 	ptr = fast_get(res->alloc, dram_ptr, size);
 	if (!ptr) {
 		container_put(mod, container);
-		k_mutex_unlock(&res->lock);
+		k_mutex_unlock(&mod_res_lock);
 		return NULL;
 	}
 
 	container->sram_ptr = ptr;
 	container->size = 0;
 	container->type = MOD_RES_FAST_GET;
 
-	k_mutex_unlock(&res->lock);
+	k_mutex_unlock(&mod_res_lock);
 	return ptr;
 }
 EXPORT_SYMBOL(z_impl_mod_fast_get);
@@ -425,10 +432,10 @@ int z_impl_mod_free(struct processing_module *mod, const void *ptr)
 	/* Find which container holds this memory */
 	struct mod_res_cb_arg cb_arg = {mod, ptr};
 
-	k_mutex_lock(&res->lock, K_FOREVER);
+	k_mutex_lock(&mod_res_lock, K_FOREVER);
 	int ret = objpool_iterate(&res->objpool, mod_res_free, &cb_arg);
 
-	k_mutex_unlock(&res->lock);
+	k_mutex_unlock(&mod_res_lock);
 
 	if (ret < 0)
 		comp_err(mod->dev, "error: could not find memory pointed by %p", ptr);
@@ -755,10 +762,10 @@ void z_impl_mod_free_all(struct processing_module *mod)
 	/* Free all contents found in used containers */
 	struct mod_res_cb_arg cb_arg = {mod, NULL};
 
-	k_mutex_lock(&res->lock, K_FOREVER);
+	k_mutex_lock(&mod_res_lock, K_FOREVER);
 	objpool_iterate(&res->objpool, mod_res_free, &cb_arg);
 	objpool_prune(&res->objpool);
-	k_mutex_unlock(&res->lock);
+	k_mutex_unlock(&mod_res_lock);
 
 	/* Make sure resource lists and accounting are reset */
 	mod_resource_init(mod);

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

@@ -125,7 +125,6 @@ struct module_param {
  * when the module unloads.
  */
 struct module_resources {
-	struct k_mutex lock;
 	struct objpool_head objpool;
 	size_t heap_usage;
 	size_t heap_high_water_mark;