[PATCH 09/13] lib min_heap: Update min_heap_push() and min_heap_pop() to return bool values

Kuan-Wei Chiu
2024-03-19T18:00:57Z

Modify the min_heap_push() and min_heap_pop() to return a boolean
value. They now return false when the operation fails and true when it
succeeds.

Signed-off-by: Kuan-Wei Chiu <visitorckw@gmail.com>
---
include/linux/min_heap.h | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/include/linux/min_heap.h b/include/linux/min_heap.h
index 97d8ba5c32e6..154ac2102114 100644
--- a/include/linux/min_heap.h
+++ b/include/linux/min_heap.h
@@ -130,18 +130,20 @@ void __min_heapify_all(struct __min_heap *heap, size_t elem_size,

/* Remove minimum element from the heap, O(log2(nr)). */
static __always_inline
-void __min_heap_pop(struct __min_heap *heap, size_t elem_size,
+bool __min_heap_pop(struct __min_heap *heap, size_t elem_size,
const struct min_heap_callbacks *func, void *args)
{
void *data = heap->data;

if (WARN_ONCE(heap->nr <= 0, "Popping an empty heap"))
- return;
+ return false;

/* Place last element at the root (position 0) and then sift down. */
heap->nr--;
memcpy(data, data + (heap->nr * elem_size), elem_size);
__min_heapify(heap, 0, elem_size, func, args);
+
+ return true;
}

#define min_heap_pop(_heap, _func, _args) \
@@ -167,7 +169,7 @@ void __min_heap_pop_push(struct __min_heap *heap,

/* Push an element on to the heap, O(log2(nr)). */
static __always_inline
-void __min_heap_push(struct __min_heap *heap, const void *element, size_t elem_size,
+bool __min_heap_push(struct __min_heap *heap, const void *element, size_t elem_size,
const struct min_heap_callbacks *func, void *args)
{
void *data = heap->data;
@@ -175,7 +177,7 @@ void __min_heap_push(struct __min_heap *heap, const void *element, size_t elem_s
int pos;

if (WARN_ONCE(heap->nr >= heap->size, "Pushing on a full heap"))
- return;
+ return false;

/* Place at the end of data. */
pos = heap->nr;
@@ -190,6 +192,8 @@ void __min_heap_push(struct __min_heap *heap, const void *element, size_t elem_s
break;
func->swp(parent, child, args);
}
+
+ return true;
}

#define min_heap_push(_heap, _element, _func, _args) \
--
2.34.1