objpool: add allocation flags

We need to be able to specify allocation flags for object pools and
to verify their consistency. Add a parameter for that.

Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>

Author: lyakh

src/include/sof/objpool.h

@@ -6,12 +6,21 @@
 #ifndef __ZEPHYR_OBJPOOL_H__
 #define __ZEPHYR_OBJPOOL_H__
 
-struct list_item;
+#include <sof/list.h>
+
+#include <stdint.h>
+
+struct objpool_head {
+	struct list_item list;
+	uint32_t flags;
+};
+
 /**
  * Allocate memory tracked as part of an object pool.
  *
- * @param head Pointer to the object pool list head.
+ * @param head Pointer to the object pool head.
  * @param size Size in bytes of memory blocks to allocate.
+ * @param flags Memory allocation flags.
  *
  * @return a pointer to the allocated memory on success, NULL on failure.
  *
@@ -22,20 +31,22 @@ struct list_item;
  * is requested, the next call allocates 4 blocks, then 8, 16 and 32. After that
  * 32 blocks are allocated every time. Note, that by design allocated blocks are
  * never freed. See more below.
+ * TODO: @a flags are currently only used when allocating new object sets.
+ * Should add a check that they're consistent with already allocated objects.
  */
-void *objpool_alloc(struct list_item *head, size_t size);
+void *objpool_alloc(struct objpool_head *head, size_t size, uint32_t flags);
 
 /**
  * Return a block to the object pool
  *
- * @param head Pointer to the object pool list head.
+ * @param head Pointer to the object pool head.
  * @param data Pointer to the object to return (can be NULL)
  *
  * @return 0 on success or a negative error code.
  *
  * Return a block to the object pool. Memory is never freed by design, unused
  * blocks are kept in the object pool for future re-use.
  */
-int objpool_free(struct list_item *head, void *data);
+int objpool_free(struct objpool_head *head, void *data);
 
 #endif

src/lib/objpool.c

@@ -24,7 +24,7 @@ struct objpool {
 
 #define OBJPOOL_BITS (sizeof(((struct objpool *)0)->mask) * 8)
 
-static int objpool_add(struct list_item *head, unsigned int n, size_t size)
+static int objpool_add(struct list_item *head, unsigned int n, size_t size, uint32_t flags)
 {
 	if (n > OBJPOOL_BITS)
 		return -ENOMEM;
@@ -35,7 +35,7 @@ static int objpool_add(struct list_item *head, unsigned int n, size_t size)
 	size_t aligned_size = ALIGN_UP(size, sizeof(int));
 
 	/* Initialize with 0 to give caller a chance to identify new allocations */
-	struct objpool *pobjpool = rzalloc(0, n * aligned_size + sizeof(*pobjpool));
+	struct objpool *pobjpool = rzalloc(flags, n * aligned_size + sizeof(*pobjpool));
 
 	if (!pobjpool)
 		return -ENOMEM;
@@ -50,7 +50,7 @@ static int objpool_add(struct list_item *head, unsigned int n, size_t size)
 	return 0;
 }
 
-void *objpool_alloc(struct list_item *head, size_t size)
+void *objpool_alloc(struct objpool_head *head, size_t size, uint32_t flags)
 {
 	size_t aligned_size = ALIGN_UP(size, sizeof(int));
 	struct list_item *list;
@@ -60,7 +60,11 @@ void *objpool_alloc(struct list_item *head, size_t size)
 	if (!size || aligned_size > (UINT_MAX >> 5) - sizeof(*pobjpool))
 		return NULL;
 
-	list_for_item(list, head) {
+	if (!list_is_empty(&head->list) && head->flags != flags)
+		/* List isn't empty, and flags don't match */
+		return NULL;
+
+	list_for_item(list, &head->list) {
 		pobjpool = container_of(list, struct objpool, list);
 
 		uint32_t free_mask = MASK(pobjpool->n - 1, 0) & ~pobjpool->mask;
@@ -83,37 +87,37 @@ void *objpool_alloc(struct list_item *head, size_t size)
 	/* no free elements found */
 	unsigned int new_n;
 
-	if (list_is_empty(head)) {
+	if (list_is_empty(&head->list)) {
 		new_n = 2;
 	} else {
 		/* Check the last one */
-		pobjpool = container_of(head->prev, struct objpool, list);
+		pobjpool = container_of(head->list.prev, struct objpool, list);
 
 		if (pobjpool->n == OBJPOOL_BITS)
 			new_n = OBJPOOL_BITS;
 		else
 			new_n = pobjpool->n << 1;
 	}
 
-	if (objpool_add(head, new_n, size) < 0)
+	if (objpool_add(&head->list, new_n, size, flags) < 0)
 		return NULL;
 
 	/* Return the first element of the new objpool, which is now the last one in the list */
-	pobjpool = container_of(head->prev, struct objpool, list);
+	pobjpool = container_of(head->list.prev, struct objpool, list);
 	pobjpool->mask = 1;
 
 	return pobjpool->data;
 }
 
-int objpool_free(struct list_item *head, void *data)
+int objpool_free(struct objpool_head *head, void *data)
 {
 	struct list_item *list;
 	struct objpool *pobjpool;
 
 	if (!data)
 		return 0;
 
-	list_for_item(list, head) {
+	list_for_item(list, &head->list) {
 		pobjpool = container_of(list, struct objpool, list);
 
 		size_t aligned_size = ALIGN_UP(pobjpool->size, sizeof(int));

test/ztest/unit/objpool/test_objpool_ztest.c

@@ -9,6 +9,9 @@
 #include <sof/objpool.h>
 #include <sof/common.h>
 #include <sof/list.h>
+
+#include <rtos/alloc.h>
+
 #include <stdlib.h>
 #include <string.h>
 
@@ -26,23 +29,26 @@ void *__wrap_rzalloc(uint32_t flags, size_t bytes)
 
 ZTEST(objpool_suite, test_objpool_wrong_size)
 {
-	struct list_item head = LIST_INIT(head);
+	struct objpool_head head = {.list = LIST_INIT(head.list)};
 	/* new object pool of 2 blocks */
-	uint8_t *block1 = objpool_alloc(&head, DATA_SIZE);
+	uint8_t *block1 = objpool_alloc(&head, DATA_SIZE, 0);
 	/* should fail because of a different size */
-	uint8_t *block2 = objpool_alloc(&head, DATA_SIZE + 1);
+	uint8_t *block2 = objpool_alloc(&head, DATA_SIZE + 1, 0);
 	/* second block in the first object pool */
-	uint8_t *block3 = objpool_alloc(&head, DATA_SIZE);
+	uint8_t *block3 = objpool_alloc(&head, DATA_SIZE, 0);
 	/* new object pool of 4 blocks */
-	uint8_t *block4 = objpool_alloc(&head, DATA_SIZE);
+	uint8_t *block4 = objpool_alloc(&head, DATA_SIZE, 0);
 	/* should fail because of a different size */
-	uint8_t *block5 = objpool_alloc(&head, DATA_SIZE * 2);
+	uint8_t *block5 = objpool_alloc(&head, DATA_SIZE * 2, 0);
+	/* should fail because of different flags */
+	uint8_t *block6 = objpool_alloc(&head, DATA_SIZE * 2, SOF_MEM_FLAG_COHERENT);
 
 	zassert_not_null(block1);
 	zassert_is_null(block2);
 	zassert_not_null(block3);
 	zassert_not_null(block4);
 	zassert_is_null(block5);
+	zassert_is_null(block6);
 
 	zassert_not_ok(objpool_free(&head, block1 + 1));
 	zassert_ok(objpool_free(&head, block1));
@@ -54,7 +60,7 @@ ZTEST(objpool_suite, test_objpool_wrong_size)
 
 ZTEST(objpool_suite, test_objpool)
 {
-	struct list_item head = LIST_INIT(head);
+	struct objpool_head head = {.list = LIST_INIT(head.list)};
 	void *blocks[62]; /* 2 + 4 + 8 + 16 + 32 */
 	unsigned int k = 0;
 
@@ -64,7 +70,7 @@ ZTEST(objpool_suite, test_objpool)
 		uint8_t *start;
 
 		for (unsigned int j = 0; j < n; j++) {
-			uint8_t *block = objpool_alloc(&head, DATA_SIZE);
+			uint8_t *block = objpool_alloc(&head, DATA_SIZE, 0);
 
 			zassert_not_null(block, "allocation failed loop %u iter %u", i, j);