aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMattias Andrée <maandree@member.fsf.org>2016-01-01 17:57:55 +0100
committerMattias Andrée <maandree@member.fsf.org>2016-01-01 17:57:55 +0100
commitf26d755dcc28ee4b4a23986a83f197125eb20467 (patch)
tree6702b9502131b7a9d60cc432a0639deb98cfb0d6 /src
parentextension: free will perserve errno (diff)
downloadslibc-f26d755dcc28ee4b4a23986a83f197125eb20467.tar.gz
slibc-f26d755dcc28ee4b4a23986a83f197125eb20467.tar.bz2
slibc-f26d755dcc28ee4b4a23986a83f197125eb20467.tar.xz
doc
Signed-off-by: Mattias Andrée <maandree@member.fsf.org>
Diffstat (limited to 'src')
-rw-r--r--src/slibc-alloc.c24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/slibc-alloc.c b/src/slibc-alloc.c
index f93a4b5..9e4dc6d 100644
--- a/src/slibc-alloc.c
+++ b/src/slibc-alloc.c
@@ -60,6 +60,8 @@
*
* `errno` is guaranteed not to be set.
*
+ * @etymology (Fast) variant of (`free`).
+ *
* @param segment The memory segment to free.
*
* @since Always.
@@ -80,6 +82,8 @@ void fast_free(void* segment)
*
* `errno` is guaranteed not to be set.
*
+ * @etymology (Secure) variant of (`free`).
+ *
* @param segment The memory segment to free.
*
* @since Always.
@@ -106,6 +110,8 @@ void secure_free(void* segment)
*
* `p = malloc(n), allocsize(p)` will return `n`.
*
+ * @etymology Memory (alloc)ation (size).
+ *
* @param segment The memory segment.
* @return The size of the memory segment, 0 on error.
*
@@ -178,6 +184,8 @@ size_t allocsize(void* segment)
* with zeroes, including the old allocation if it creates a
* new allocation.
*
+ * @etymology (C)lear and (realloc)ate memory.
+ *
* @param ptr The old allocation, see `realloc` for more details.
* @param size The new allocation size, see `realloc` for more details.
* @return The new allocation, see `realloc` for more details.
@@ -196,6 +204,8 @@ void* crealloc(void* ptr, size_t size)
* This function behaves exactly like `realloc`, except it is
* guaranteed to never initialise or errors data.
*
+ * @etymology (Fast) variant of (`realloc`).
+ *
* @param ptr The old allocation, see `realloc` for more details.
* @param size The new allocation size, see `realloc` for more details.
* @return The new allocation, see `realloc` for more details.
@@ -214,6 +224,8 @@ void* fast_realloc(void* ptr, size_t size)
* This function behaves exactly like `crealloc`, except it
* does not initialise newly allocated size.
*
+ * @etymology (Secure) variant of (`realloc`).
+ *
* @param ptr The old allocation, see `realloc` for more details.
* @param size The new allocation size, see `realloc` for more details.
* @return The new allocation, see `realloc` for more details.
@@ -241,6 +253,8 @@ void* secure_realloc(void* ptr, size_t size)
* `secure_realloc(p, n)` is equivalent to (but slightly fast than)
* `custom_realloc(p, n, 1, 0, 1)`.
*
+ * @etymology (Custom)isable variant of (`realloc`).
+ *
* @param ptr The old allocation, see `realloc` for more details.
* @param size The new allocation size, see `realloc` for more details.
* @param clear_old Whether the disowned area is cleared, even if `ptr` is returned.
@@ -271,6 +285,8 @@ void* custom_realloc(void* ptr, size_t size, int clear_old, int clear_new, int c
* The behaviour is undefined if `mode` does not
* contain a valid flag-combination.
*
+ * @etymology (Ext)end memory (alloc)ation.
+ *
* @param ptr The old allocation, see `realloc` for more details.
* @param size The new allocation size, see `realloc` for more details.
* @param mode `EXTALLOC_CLEAR` or `EXTALLOC_MALLOC`, or both or neither.
@@ -314,6 +330,8 @@ void* extalloc(void* ptr, size_t size, enum extalloc_mode mode)
* the aligment is applied when it is necessary to
* create a new allocation.
*
+ * @etymology (Re)allocate (mem)ory and (align).
+ *
* @param ptr The old allocation, see `realloc` for more details.
* @param boundary The alignment, not checked before necessary.
* @param size The new allocation size, see `realloc` for more details.
@@ -392,6 +410,8 @@ void* rememalign(void* ptr, size_t boundary, size_t size, enum rememalign_mode m
* the aligment is applied when it is necessary to
* create a new allocation.
*
+ * @etymology (Naïve) variant of (`realloc`).
+ *
* @param ptr The old allocation, see `realloc` for more details.
* @param boundary The alignment, not checked before necessary.
* @param size The new allocation size, see `realloc` for more details.
@@ -416,6 +436,8 @@ void* naive_realloc(void* ptr, size_t boundary, size_t size)
* not possible to perform the shrink or grow without creating
* new pointer.
*
+ * @etymology (Naïve) variant of (`extalloc`).
+ *
* @param ptr The old allocation, see `realloc` for more details.
* @param size The new allocation size, see `realloc` for more details.
* @return `ptr` on success or `NULL` on error or if `malloc` is needed.
@@ -513,6 +535,8 @@ static inline void* falloc_realloc(void* ptr, size_t* ptrshift, size_t alignment
* `(mode & FALLOC_INIT) && !(mode & FALLOC_MEMCPY)`, the
* entire allocation will be cleared.
*
+ * @etymology (F)ast memory (alloc)ation.
+ *
* @param ptr The old pointer, `NULL` if a new shall be created.
* @param ptrshift Pointer that is used to keep track of the pointer's
* shift for alignment. `NULL` if the shift shall not