luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-02 05:43:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'document-oom-behavior' into 'main'

Browse Source 
mem: Document OOM behavior for allocations

See merge request GNOME/glib!2861
This commit is contained in:
Emmanuele Bassi 2022-08-22 14:01:15 +00:00
commit 0e112b457d
1 changed files with 33 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
glib/gmem.c
View File

@ -111,10 +111,13 @@ static GMemVTable glib_mem_vtable = {
/** /**
* g_malloc: * g_malloc:
* @n_bytes: the number of bytes to allocate * @n_bytes: the number of bytes to allocate
* *
* Allocates @n_bytes bytes of memory. * Allocates @n_bytes bytes of memory.
* If @n_bytes is 0 it returns %NULL. * If @n_bytes is 0 it returns %NULL.
* *
* If the allocation fails (because the system is out of memory),
* the program is terminated.
*
* Returns: a pointer to the allocated memory * Returns: a pointer to the allocated memory
*/ */
gpointer gpointer
@ -141,10 +144,13 @@ g_malloc (gsize n_bytes)
/** /**
* g_malloc0: * g_malloc0:
* @n_bytes: the number of bytes to allocate * @n_bytes: the number of bytes to allocate
* *
* Allocates @n_bytes bytes of memory, initialized to 0's. * Allocates @n_bytes bytes of memory, initialized to 0's.
* If @n_bytes is 0 it returns %NULL. * If @n_bytes is 0 it returns %NULL.
* *
* If the allocation fails (because the system is out of memory),
* the program is terminated.
*
* Returns: a pointer to the allocated memory * Returns: a pointer to the allocated memory
*/ */
gpointer gpointer
@ -172,13 +178,16 @@ g_malloc0 (gsize n_bytes)
* g_realloc: * g_realloc:
* @mem: (nullable): the memory to reallocate * @mem: (nullable): the memory to reallocate
* @n_bytes: new size of the memory in bytes * @n_bytes: new size of the memory in bytes
* *
* Reallocates the memory pointed to by @mem, so that it now has space for * Reallocates the memory pointed to by @mem, so that it now has space for
* @n_bytes bytes of memory. It returns the new address of the memory, which may * @n_bytes bytes of memory. It returns the new address of the memory, which may
* have been moved. @mem may be %NULL, in which case it's considered to * have been moved. @mem may be %NULL, in which case it's considered to
* have zero-length. @n_bytes may be 0, in which case %NULL will be returned * have zero-length. @n_bytes may be 0, in which case %NULL will be returned
* and @mem will be freed unless it is %NULL. * and @mem will be freed unless it is %NULL.
* *
* If the allocation fails (because the system is out of memory),
* the program is terminated.
*
* Returns: the new address of the allocated memory * Returns: the new address of the allocated memory
*/ */
gpointer gpointer
@ -345,10 +354,13 @@ g_try_realloc (gpointer mem,
* g_malloc_n: * g_malloc_n:
* @n_blocks: the number of blocks to allocate * @n_blocks: the number of blocks to allocate
* @n_block_bytes: the size of each block in bytes * @n_block_bytes: the size of each block in bytes
* *
* This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, * This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes,
* but care is taken to detect possible overflow during multiplication. * but care is taken to detect possible overflow during multiplication.
* *
* If the allocation fails (because the system is out of memory),
* the program is terminated.
*
* Since: 2.24 * Since: 2.24
* Returns: a pointer to the allocated memory * Returns: a pointer to the allocated memory
*/ */
@ -369,10 +381,13 @@ g_malloc_n (gsize n_blocks,
* g_malloc0_n: * g_malloc0_n:
* @n_blocks: the number of blocks to allocate * @n_blocks: the number of blocks to allocate
* @n_block_bytes: the size of each block in bytes * @n_block_bytes: the size of each block in bytes
* *
* This function is similar to g_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, * This function is similar to g_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes,
* but care is taken to detect possible overflow during multiplication. * but care is taken to detect possible overflow during multiplication.
* *
* If the allocation fails (because the system is out of memory),
* the program is terminated.
*
* Since: 2.24 * Since: 2.24
* Returns: a pointer to the allocated memory * Returns: a pointer to the allocated memory
*/ */
@ -394,10 +409,13 @@ g_malloc0_n (gsize n_blocks,
* @mem: (nullable): the memory to reallocate * @mem: (nullable): the memory to reallocate
* @n_blocks: the number of blocks to allocate * @n_blocks: the number of blocks to allocate
* @n_block_bytes: the size of each block in bytes * @n_block_bytes: the size of each block in bytes
* *
* This function is similar to g_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, * This function is similar to g_realloc(), allocating (@n_blocks * @n_block_bytes) bytes,
* but care is taken to detect possible overflow during multiplication. * but care is taken to detect possible overflow during multiplication.
* *
* If the allocation fails (because the system is out of memory),
* the program is terminated.
*
* Since: 2.24 * Since: 2.24
* Returns: the new address of the allocated memory * Returns: the new address of the allocated memory
*/ */
@ -556,6 +574,9 @@ g_mem_profile (void)
* alignment value. Additionally, it will detect possible overflow during * alignment value. Additionally, it will detect possible overflow during
* multiplication. * multiplication.
* *
* If the allocation fails (because the system is out of memory),
* the program is terminated.
*
* Aligned memory allocations returned by this function can only be * Aligned memory allocations returned by this function can only be
* freed using g_aligned_free(). * freed using g_aligned_free().
* *