aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--include/slibc-alloc.h5
-rw-r--r--src/slibc-alloc.c5
2 files changed, 10 insertions, 0 deletions
diff --git a/include/slibc-alloc.h b/include/slibc-alloc.h
index d792ebc..edc7cc7 100644
--- a/include/slibc-alloc.h
+++ b/include/slibc-alloc.h
@@ -47,6 +47,11 @@ void secure_free(void*);
* This function returns the allocation size of
* a memory segment.
*
+ * Note, this only works for the malloc-family of functions.
+ * It does not work on `alloca`, `strdupa` (or similar
+ * functions), memory maps (that are not created by `malloc`,)
+ * or arrays.
+ *
* `p = malloc(n), allocsize(p)` will return `n`.
*
* @param segment The memory segment.
diff --git a/src/slibc-alloc.c b/src/slibc-alloc.c
index ce271b5..743597e 100644
--- a/src/slibc-alloc.c
+++ b/src/slibc-alloc.c
@@ -62,6 +62,11 @@ void secure_free(void* segment)
* This function returns the allocation size of
* a memory segment.
*
+ * Note, this only works for the malloc-family of functions.
+ * It does not work on `alloca`, `strdupa` (or similar
+ * functions), memory maps (that are not created by `malloc`,)
+ * or arrays.
+ *
* `p = malloc(n), allocsize(p)` will return `n`.
*
* @param segment The memory segment.