[PATCH] bitmap: change return value of rte_bitmap_free

[PATCH] bitmap: change return value of rte_bitmap_free

[Stephen Hemminger]

No existing code is checking the return value of rte_bitmap_free
and other functions like rte_free do not return an int.
Change it to just a stub void function.

This was motivated by Coverity warnings about unchecked return
value.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/rel_notes/release_25_11.rst |  3 +++
 lib/eal/include/rte_bitmap.h           | 14 +++-----------
 2 files changed, 6 insertions(+), 11 deletions(-)

diff --git a/doc/guides/rel_notes/release_25_11.rst b/doc/guides/rel_notes/release_25_11.rst
index c5ba335cfc..4b8e084204 100644
--- a/doc/guides/rel_notes/release_25_11.rst
+++ b/doc/guides/rel_notes/release_25_11.rst
@@ -220,6 +220,9 @@ API Changes
   The link type was previously hardcoded to the Ethernet link type in the API.
   This argument is added to ``rte_pcapng_add_interface``.
 
+* bitmap: Changed the return type of ``rte_bitmap_free()`` to void
+  for consistency with other free functions.
+
 
 ABI Changes
 -----------
diff --git a/lib/eal/include/rte_bitmap.h b/lib/eal/include/rte_bitmap.h
index abb102f1d3..5a4a68cc2d 100644
--- a/lib/eal/include/rte_bitmap.h
+++ b/lib/eal/include/rte_bitmap.h
@@ -280,22 +280,14 @@ rte_bitmap_init_with_all_set(uint32_t n_bits, uint8_t *mem, uint32_t mem_size)
 }
 
 /**
- * Bitmap free
+ * Bitmap free does nothing in current version.
  *
  * @param bmp
  *   Handle to bitmap instance
- * @return
- *   0 upon success, error code otherwise
  */
-static inline int
-rte_bitmap_free(struct rte_bitmap *bmp)
+static inline void
+rte_bitmap_free(struct rte_bitmap *bmp __rte_unused)
 {
-	/* Check input arguments */
-	if (bmp == NULL) {
-		return -1;
-	}
-
-	return 0;
 }
 
 /**
-- 
2.51.0

RE: [PATCH] bitmap: change return value of rte_bitmap_free

[Morten Brørup]

> From: Stephen Hemminger [mailto:stephen@networkplumber.org]
> Sent: Tuesday, 28 October 2025 21.45
> 
> No existing code is checking the return value of rte_bitmap_free
> and other functions like rte_free do not return an int.
> Change it to just a stub void function.
> 
> This was motivated by Coverity warnings about unchecked return
> value.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>

Thank you for cleaning up this.

With or without suggestion inline below,
Reviewed-by: Morten Brørup <mb@smartsharesystems.com>

>  /**
> - * Bitmap free
> + * Bitmap free does nothing in current version.

Consider keeping the original headline and adding a note that it does nothing in current version instead.

>   *
>   * @param bmp
>   *   Handle to bitmap instance
> - * @return
> - *   0 upon success, error code otherwise
>   */
> -static inline int
> -rte_bitmap_free(struct rte_bitmap *bmp)
> +static inline void
> +rte_bitmap_free(struct rte_bitmap *bmp __rte_unused)
>  {
> -	/* Check input arguments */
> -	if (bmp == NULL) {
> -		return -1;
> -	}
> -
> -	return 0;
>  }

[PATCH v2] bitmap: change return value of rte_bitmap_free

[Stephen Hemminger]

No existing code is checking the return value of rte_bitmap_free
and other functions like rte_free do not return an int.
Change it to just a stub void function.

This was motivated by Coverity warnings about unchecked return
value.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Reviewed-by: Morten Brørup <mb@smartsharesystems.com>
---
 doc/guides/rel_notes/release_25_11.rst |  3 +++
 lib/eal/include/rte_bitmap.h           | 13 ++++---------
 2 files changed, 7 insertions(+), 9 deletions(-)

diff --git a/doc/guides/rel_notes/release_25_11.rst b/doc/guides/rel_notes/release_25_11.rst
index c5ba335cfc..4b8e084204 100644
--- a/doc/guides/rel_notes/release_25_11.rst
+++ b/doc/guides/rel_notes/release_25_11.rst
@@ -220,6 +220,9 @@ API Changes
   The link type was previously hardcoded to the Ethernet link type in the API.
   This argument is added to ``rte_pcapng_add_interface``.
 
+* bitmap: Changed the return type of ``rte_bitmap_free()`` to void
+  for consistency with other free functions.
+
 
 ABI Changes
 -----------
diff --git a/lib/eal/include/rte_bitmap.h b/lib/eal/include/rte_bitmap.h
index abb102f1d3..ebe6c44998 100644
--- a/lib/eal/include/rte_bitmap.h
+++ b/lib/eal/include/rte_bitmap.h
@@ -282,20 +282,15 @@ rte_bitmap_init_with_all_set(uint32_t n_bits, uint8_t *mem, uint32_t mem_size)
 /**
  * Bitmap free
  *
+ * This function does nothing in current implementation.
+ *
  * @param bmp
  *   Handle to bitmap instance
- * @return
- *   0 upon success, error code otherwise
  */
-static inline int
+static inline void
 rte_bitmap_free(struct rte_bitmap *bmp)
 {
-	/* Check input arguments */
-	if (bmp == NULL) {
-		return -1;
-	}
-
-	return 0;
+	RTE_SET_USED(bmp);
 }
 
 /**
-- 
2.51.0

RE: [PATCH v2] bitmap: change return value of rte_bitmap_free

[Konstantin Ananyev]

> -----Original Message-----
> From: Stephen Hemminger <stephen@networkplumber.org>
> Sent: Wednesday, October 29, 2025 2:51 PM
> To: dev@dpdk.org
> Cc: Stephen Hemminger <stephen@networkplumber.org>; Morten Brørup
> <mb@smartsharesystems.com>; Cristian Dumitrescu
> <cristian.dumitrescu@intel.com>; Tyler Retzlaff <roretzla@linux.microsoft.com>
> Subject: [PATCH v2] bitmap: change return value of rte_bitmap_free
> 
> No existing code is checking the return value of rte_bitmap_free
> and other functions like rte_free do not return an int.
> Change it to just a stub void function.
> 
> This was motivated by Coverity warnings about unchecked return
> value.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> Reviewed-by: Morten Brørup <mb@smartsharesystems.com>
> ---
>  doc/guides/rel_notes/release_25_11.rst |  3 +++
>  lib/eal/include/rte_bitmap.h           | 13 ++++---------
>  2 files changed, 7 insertions(+), 9 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/release_25_11.rst
> b/doc/guides/rel_notes/release_25_11.rst
> index c5ba335cfc..4b8e084204 100644
> --- a/doc/guides/rel_notes/release_25_11.rst
> +++ b/doc/guides/rel_notes/release_25_11.rst
> @@ -220,6 +220,9 @@ API Changes
>    The link type was previously hardcoded to the Ethernet link type in the API.
>    This argument is added to ``rte_pcapng_add_interface``.
> 
> +* bitmap: Changed the return type of ``rte_bitmap_free()`` to void
> +  for consistency with other free functions.
> +
> 
>  ABI Changes
>  -----------
> diff --git a/lib/eal/include/rte_bitmap.h b/lib/eal/include/rte_bitmap.h
> index abb102f1d3..ebe6c44998 100644
> --- a/lib/eal/include/rte_bitmap.h
> +++ b/lib/eal/include/rte_bitmap.h
> @@ -282,20 +282,15 @@ rte_bitmap_init_with_all_set(uint32_t n_bits, uint8_t
> *mem, uint32_t mem_size)
>  /**
>   * Bitmap free
>   *
> + * This function does nothing in current implementation.
> + *
>   * @param bmp
>   *   Handle to bitmap instance
> - * @return
> - *   0 upon success, error code otherwise
>   */
> -static inline int
> +static inline void
>  rte_bitmap_free(struct rte_bitmap *bmp)
>  {
> -	/* Check input arguments */
> -	if (bmp == NULL) {
> -		return -1;
> -	}
> -
> -	return 0;
> +	RTE_SET_USED(bmp);
>  }
> 
>  /**
> --
Acked-by: Konstantin Ananyev <konstantin.ananyev@huawei.com>
> 2.51.0