malloc: fix documentation for realloc
Checks
Commit Message
The documentation for rte_realloc claims that the resized area
will always reside on the same NUMA node. This is not actually
the case - while *resized* area will be on the same NUMA node,
if resizing the area is not possible, then the memory will be
reallocated using rte_malloc(), which can allocate memory on
another NUMA node, depending on which lcore rte_realloc() was
called from and which NUMA nodes have memory available.
Fix the API doc to match the actual code of rte_realloc().
Fixes: af75078fece3 ("first public release")
Cc: stable@dpdk.org
Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
---
lib/librte_eal/common/include/rte_malloc.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Comments
22/02/2019 16:29, Anatoly Burakov:
> The documentation for rte_realloc claims that the resized area
> will always reside on the same NUMA node. This is not actually
> the case - while *resized* area will be on the same NUMA node,
> if resizing the area is not possible, then the memory will be
> reallocated using rte_malloc(), which can allocate memory on
> another NUMA node, depending on which lcore rte_realloc() was
> called from and which NUMA nodes have memory available.
>
> Fix the API doc to match the actual code of rte_realloc().
>
> Fixes: af75078fece3 ("first public release")
> Cc: stable@dpdk.org
>
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Applied, thanks
@@ -111,7 +111,7 @@ rte_calloc(const char *type, size_t num, size_t size, unsigned align);
/**
* Replacement function for realloc(), using huge-page memory. Reserved area
* memory is resized, preserving contents. In NUMA systems, the new area
- * resides on the same NUMA socket as the old area.
+ * may not reside on the same NUMA node as the old one.
*
* @param ptr
* Pointer to already allocated memory