[v2,2/5] qemu/bitmap: Document bitmap_new() returned pointer

Commit Message

Philippe Mathieu-Daudé May 15, 2020, 9:19 a.m. UTC

Reviewed-by: Stefan Hajnoczi <[e-mail]>
Signed-off-by: Philippe Mathieu-Daudé <[e-mail]>
---
 include/qemu/bitmap.h | 2 ++
 1 file changed, 2 insertions(+)

Patch

diff --git a/include/qemu/bitmap.h b/include/qemu/bitmap.h
index 82a1d2f41f..0b390ff576 100644
--- a/include/qemu/bitmap.h
+++ b/include/qemu/bitmap.h
@@ -90,12 +90,14 @@  int slow_bitmap_intersects(const unsigned long *bitmap1,
                            const unsigned long *bitmap2, long bits);
 long slow_bitmap_count_one(const unsigned long *bitmap, long nbits);
 
+/* callers must free the returned pointer with g_free() */
 static inline unsigned long *bitmap_try_new(long nbits)
 {
     long len = BITS_TO_LONGS(nbits) * sizeof(unsigned long);
     return g_try_malloc0(len);
 }
 
+/* callers must free the returned pointer with g_free() */
 static inline unsigned long *bitmap_new(long nbits)
 {
     unsigned long *ptr = bitmap_try_new(nbits);