From: Pierre Pfister <ppfister@cisco.com>
Date: Fri, 17 Jun 2016 12:30:02 +0000 (+0100)
Subject: VPP-152: mheap_alloc returns 0 when the requested heap size is too small
X-Git-Tag: v16.09-rc1~263
X-Git-Url: https://gerrit.fd.io/r/gitweb?a=commitdiff_plain;h=889178c02a711fbc66d83415a88608f704fbc561;p=vpp.git

VPP-152: mheap_alloc returns 0 when the requested heap size is too small

mheap_alloc allocates memory_size bytes of memory and returns
a page-aligned memory space prefixed with a word-aligned
header of type mheap_t.

This header includes the actual usable space size, but
when the requested size is too small, the computed size
was incorrect (infinite).

mheap_alloc now returns 0 in such cases.

With help from Yoann Desmouceaux.

Change-Id: I00af63d573d6939aca53dbe7ff612b726bd8f0df
Signed-off-by: Pierre Pfister <ppfister@cisco.com>
---

diff --git a/vppinfra/vppinfra/mheap.c b/vppinfra/vppinfra/mheap.c
index cd8672e7ef4..6163d0b1341 100644
--- a/vppinfra/vppinfra/mheap.c
+++ b/vppinfra/vppinfra/mheap.c
@@ -874,6 +874,15 @@ void * mheap_alloc_with_flags (void * memory, uword memory_size, uword flags)
     h = uword_to_pointer (ah, void *);
     v = mheap_vector (h);
 
+    if (PREDICT_FALSE(memory + memory_size < v)) {
+	/*
+	 * This will happen when the requested memory_size is too
+	 * small to cope with the heap header and/or memory alignment.
+	 */
+	clib_mem_vm_free(memory, memory_size);
+	return 0;
+    }
+
     size = memory + memory_size - v;
   }
 
diff --git a/vppinfra/vppinfra/mheap.h b/vppinfra/vppinfra/mheap.h
index c9eb60de639..a40c26cb60d 100644
--- a/vppinfra/vppinfra/mheap.h
+++ b/vppinfra/vppinfra/mheap.h
@@ -48,7 +48,11 @@
 always_inline void * mheap_get (void * v, uword size, uword * offset_return)
 { return mheap_get_aligned (v, size, 0, 0, offset_return); }
 
-/* Create allocation heap of given size. */
+/* Create allocation heap of given size.
+ * The actual usable size is smaller than the requested size.
+ * memory_bytes must be greater than mheap_page_size + sizeof (mheap_t) + 16.
+ * Otherwise, allocation may fail and return 0.
+ */
 void * mheap_alloc (void * memory, uword memory_bytes);
 void * mheap_alloc_with_flags (void * memory, uword memory_bytes, uword flags);