Received-SPF: pass (google.com: domain of linux-kernel+bounces-179661-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Wed, 15 May 2024 10:37:55 +0200
From: Peter Zijlstra <peterz@infradead.org>
To: Kuan-Wei Chiu <visitorckw@gmail.com>
Cc: colyli@suse.de, kent.overstreet@linux.dev, msakai@redhat.com,
	mingo@redhat.com, acme@kernel.org, namhyung@kernel.org,
	akpm@linux-foundation.org, bfoster@redhat.com, mark.rutland@arm.com,
	alexander.shishkin@linux.intel.com, jolsa@kernel.org,
	irogers@google.com, adrian.hunter@intel.com, bagasdotme@gmail.com,
	jserv@ccns.ncku.edu.tw, linux-bcache@vger.kernel.org,
	linux-kernel@vger.kernel.org, dm-devel@lists.linux.dev,
	linux-bcachefs@vger.kernel.org, linux-perf-users@vger.kernel.org
Subject: Re: [RESEND PATCH v5 11/16] lib min_heap: Update min_heap_push() and
 min_heap_pop() to return bool values
Message-ID: <20240515083755.GB40213@noisy.programming.kicks-ass.net>
References: <20240514084724.557100-1-visitorckw@gmail.com>
 <20240514084724.557100-12-visitorckw@gmail.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20240514084724.557100-12-visitorckw@gmail.com>

On Tue, May 14, 2024 at 04:47:19PM +0800, Kuan-Wei Chiu wrote:
> 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.

But why ?!

> Signed-off-by: Kuan-Wei Chiu <visitorckw@gmail.com>
> Reviewed-by: Ian Rogers <irogers@google.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 c94f9d303205..2d080f85ad0d 100644
> --- a/include/linux/min_heap.h
> +++ b/include/linux/min_heap.h
> @@ -147,18 +147,20 @@ void __min_heapify_all(min_heap_char *heap, size_t elem_size,
>  
>  /* Remove minimum element from the heap, O(log2(nr)). */
>  static __always_inline
> -void __min_heap_pop(min_heap_char *heap, size_t elem_size,
> +bool __min_heap_pop(min_heap_char *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)	\
> @@ -184,7 +186,7 @@ void __min_heap_pop_push(min_heap_char *heap,
>  
>  /* Push an element on to the heap, O(log2(nr)). */
>  static __always_inline
> -void __min_heap_push(min_heap_char *heap, const void *element, size_t elem_size,
> +bool __min_heap_push(min_heap_char *heap, const void *element, size_t elem_size,
>  		const struct min_heap_callbacks *func, void *args)
>  {
>  	void *data = heap->data;
> @@ -192,7 +194,7 @@ void __min_heap_push(min_heap_char *heap, const void *element, size_t elem_size,
>  	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;
> @@ -207,6 +209,8 @@ void __min_heap_push(min_heap_char *heap, const void *element, size_t elem_size,
>  			break;
>  		func->swp(parent, child, args);
>  	}
> +
> +	return true;
>  }
>  
>  #define min_heap_push(_heap, _element, _func, _args)	\
> -- 
> 2.34.1
>