malloc(3)

๐ŸŽ€ malloc(3) ๐ŸŽ€

Library Functions Manual โ€” like, the whole girl group of dynamic memory, bestie ๐Ÿ’–


โœจ NAME โœจ

malloc, free, calloc, realloc, reallocarray โ€” allocate and free dynamic memory ๐Ÿซถ


๐Ÿ“š LIBRARY ๐Ÿ“š

Standard C library (libc, -lc) ๐Ÿ’…


๐Ÿฆ‹ SYNOPSIS ๐Ÿฆ‹

#include <stdlib.h>

void *malloc(size_t size);
void free(void *_Nullable p);
void *calloc(size_t n, size_t size);
void *realloc(void *_Nullable p, size_t size);
void *reallocarray(void *_Nullable p, size_t n, size_t size);

๐ŸŒธ Feature Test Macro Requirements for glibc (see feature_test_macros(7)) ๐ŸŒธ

reallocarray():
    Since glibc 2.29:
        _DEFAULT_SOURCE
    glibc 2.28 and earlier:
        _GNU_SOURCE

๐ŸŒˆ DESCRIPTION ๐ŸŒˆ

๐Ÿ’– malloc() ๐Ÿ’–

malloc() allocates size bytes and hands you back a pointer to the allocated memory. It does not initialize the memory โ€” no zeroing, no nothing, so please don't assume it's clean, because it is not. That's calloc()'s job, and we'll get to her.

If size is 0, then malloc() returns a unique pointer value that can later be successfully passed to free(). (See "Nonportable behavior" for the portability drama, because friendship with other libcs is complicated.)

๐Ÿ’… free() ๐Ÿ’…

free() frees the memory space pointed to by p, which must have been returned by a previous call to malloc() or related functions.

Otherwise? Or if p has already been freed? ๐Ÿ’€ Undefined behavior occurs. Not being dramatic โ€” that's literally what it says. Double-free is not the vibe, bestie.

If p is NULL, no operation is performed. Slay, that one's actually safe.

๐ŸŽ€ calloc() ๐ŸŽ€

calloc() allocates memory for an array of n elements of size bytes each and returns a pointer to the allocated memory. The memory is set to zero. Iconic. She comes pre-cleaned โœจ

If n or size is 0, then calloc() returns a unique pointer value that can later be successfully passed to free().

If the multiplication of n and size would result in integer overflow, then calloc() returns an error. By contrast, an integer overflow would not be detected in the following call to malloc(), with the result that an incorrectly sized block of memory would be allocated:

malloc(n * size);

Yeah. That one's giving "trust me bro" energy, and calloc() is not here for it.

โœจ realloc() โœจ

realloc() changes the size of the memory block pointed to by p to size bytes. The contents of the memory will be unchanged in the range from the start of the region up to the minimum of the old and new sizes.

If the new size is larger than the old size, the added memory will not be initialized. Again. Not zeroed. Not ever.

If p is NULL, then the call is equivalent to malloc(size), for all values of size.

If size is equal to zero, and p is not NULL, then the call is equivalent to free(p) (but see "Nonportable behavior" for portability issues, because this one is a whole saga, fr fr).

Unless p is NULL, it must have been returned by an earlier call to malloc or related functions. If the area pointed to was moved, a free(p) is done.

๐Ÿ“ reallocarray() ๐Ÿ“

reallocarray() changes the size of (and possibly moves) the memory block pointed to by p to be large enough for an array of n elements, each of which is size bytes. It is equivalent to the call

realloc(p, n * size);

However, unlike that realloc() call, reallocarray() fails safely in the case where the multiplication would overflow. If such an overflow occurs, reallocarray() returns an error. She does the math check for you. Queen behavior ๐Ÿ‘‘


๐Ÿ”ฅ RETURN VALUE ๐Ÿ”ฅ

The malloc(), calloc(), realloc(), and reallocarray() functions return a pointer to the allocated memory, which is suitably aligned for any type that fits into the requested size or less. On error, these functions return NULL and set errno.

Attempting to allocate more than PTRDIFF_MAX bytes is considered an error, as an object that large could cause later pointer subtraction to overflow. ๐Ÿ˜ญ

The free() function returns no value, and preserves errno.

The realloc() and reallocarray() functions return NULL if p is not NULL and the requested size is zero; this is not considered an error. (See "Nonportable behavior" for portability issues.)

Otherwise, the returned pointer may be the same as p if the allocation was not moved (e.g., there was room to expand the allocation in-place), or different from p if the allocation was moved to a new address.

And listen โ€” if these functions fail, the original block is left untouched; it is not freed or moved. No accidental destruction. We love a safe failure ๐Ÿ’–


๐Ÿ’€ ERRORS ๐Ÿ’€

calloc(), malloc(), realloc(), and reallocarray() can fail with the following error:

  • ENOMEM โ€” Out of memory. Possibly, the application hit the RLIMIT_AS or RLIMIT_DATA limit described in getrlimit(2). Another reason could be that the number of mappings created by the caller process exceeded the limit specified by /proc/sys/vm/max_map_count.

๐Ÿซถ ATTRIBUTES ๐Ÿซถ

For an explanation of the terms used in this section, see attributes(7).

  • Interface: malloc(), free(), calloc(), realloc() โ€” Attribute: Thread safety โ€” Value: MT-Safe

๐Ÿ“œ STANDARDS ๐Ÿ“œ

  • malloc()
  • free()
  • calloc()
  • realloc()

โ†’ C23, POSIX.1-2024.

  • reallocarray()

โ†’ POSIX.1-2024.

๐ŸŒช๏ธ realloc(p, 0) ๐ŸŒช๏ธ

The behavior of realloc(p, 0) in glibc doesn't conform to any of C99, C11, POSIX.1-2001, POSIX.1-2004, POSIX.1-2008, POSIX.1-2013, POSIX.1-2017, or POSIX.1-2024. Not one. Not a single one, bestie ๐Ÿ˜ญ

The C17 specification was changed to make it conforming, but that specification made it impossible to write code that reliably determines if the input pointer is freed after realloc(p, 0), and C23 changed it again to make this undefined behavior, acknowledging that the C17 specification was broad enough so that undefined behavior wasn't worse than that. The standards committee said "yeah we're just gonna call it UB and move on" ๐Ÿ’€

reallocarray() suffers the same issues in glibc.

musl libc and the BSDs conform to all versions of ISO C and POSIX.1. Good for them, honestly ๐ŸŒธ

gnulib provides the realloc-posix module, which provides wrappers realloc() and reallocarray() that conform to all versions of ISO C and POSIX.1.

There's a proposal to standardize the BSD behavior: https://www.open-std.org/jtc1/sc22/wg14/www/docs/n3621.txt.


๐Ÿฆ‹ HISTORY ๐Ÿฆ‹

  • malloc()
  • free()
  • calloc()
  • realloc()

โ†’ POSIX.1-2001, C89.

  • reallocarray()

โ†’ glibc 2.26. OpenBSD 5.6, FreeBSD 11.0.

malloc() and related functions rejected sizes greater than PTRDIFF_MAX starting in glibc 2.30.

free() preserved errno starting in glibc 2.33.

๐ŸŒ€ realloc(p, 0) ๐ŸŒ€

C89 was ambiguous in its specification of realloc(p, 0). C99 partially fixed this.

The original implementation in glibc would have been conforming to C99. However, and ironically, trying to comply with C99 before the standard was released, glibc changed its behavior in glibc 2.1.1 into something that ended up not conforming to the final C99 specification (but this is debated, as the wording of the standard seems self-contradicting). Not them trying to be early and getting it wrong ๐Ÿ˜ญ it's giving "submitted the assignment before the prompt dropped".


๐Ÿ“ NOTES ๐Ÿ“

By default, Linux follows an optimistic memory allocation strategy. This means that when malloc() returns non-NULL there is no guarantee that the memory really is available. Yes, really, bestie ๐Ÿ™ˆ

In case it turns out that the system is out of memory, one or more processes will be killed by the OOM killer. For more information, see the description of /proc/sys/vm/overcommit_memory and /proc/sys/vm/oom_adj in proc(5), and the Linux kernel source file Documentation/vm/overcommit-accounting.rst.

Normally, malloc() allocates memory from the heap, and adjusts the size of the heap as required, using sbrk(2). When allocating blocks of memory larger than MMAP_THRESHOLD bytes, the glibc malloc() implementation allocates the memory as a private anonymous mapping using mmap(2). MMAP_THRESHOLD is 128 kB by default, but is adjustable using mallopt(3).

Prior to Linux 4.7, allocations performed using mmap(2) were unaffected by the RLIMIT_DATA resource limit; since Linux 4.7, this limit is also enforced for allocations performed using mmap(2).

To avoid corruption in multithreaded applications, mutexes are used internally to protect the memory-management data structures employed by these functions. In a multithreaded application in which threads simultaneously allocate and free memory, there could be contention for these mutexes.

To scalably handle memory allocation in multithreaded applications, glibc creates additional memory allocation arenas if mutex contention is detected. Each arena is a large region of memory that is internally allocated by the system (using brk(2) or mmap(2)), and managed with its own mutexes. She's got a whole system of rooms, and every room has her own lock ๐Ÿ”ฅ

If your program uses a private memory allocator, it should do so by replacing malloc(), free(), calloc(), and realloc(). The replacement functions must implement the documented glibc behaviors, including errno handling, size-zero allocations, and overflow checking; otherwise, other library routines may crash or operate incorrectly.

For example, if the replacement free() does not preserve errno, then seemingly unrelated library routines may fail without having a valid reason in errno. That's the "why is my totally unrelated thing broken" pipeline, and it's real ๐Ÿ˜ญ

Private memory allocators may also need to replace other glibc functions; see "Replacing malloc" in the glibc manual for details.

Crashes in memory allocators are almost always related to heap corruption, such as overflowing an allocated chunk or freeing the same pointer twice. Every single time. It's always that ๐Ÿ’€

The malloc() implementation is tunable via environment variables; see mallopt(3) for details.

๐ŸŒŠ Nonportable behavior ๐ŸŒŠ

The behavior of these functions when the requested size is zero is glibc specific; other implementations may return NULL without setting errno, and portable POSIX programs should tolerate such behavior. See realloc(3p).

POSIX requires memory allocators to set errno upon failure. However, the C standard does not require this, and applications portable to non-POSIX platforms should not assume this.

Portable programs should not use private memory allocators, as POSIX and the C standard do not allow replacement of malloc(), free(), calloc(), and realloc().


๐Ÿ› BUGS ๐Ÿ›

Programmers would naturally expect by induction that realloc(p, size) is consistent with free(p) and malloc(size), as that is the behavior in the general case. This is not explicitly required by POSIX.1-2024 or C11, but all conforming implementations are consistent with that.

The glibc implementation of realloc() is not consistent with that, and as a consequence, it is dangerous to call realloc(p, 0) in glibc. Full stop. Do not do it ๐Ÿ™ˆ

A trivial workaround for glibc is calling it as:

realloc(p, size?size:1)

The workaround for reallocarray() in glibc โ€” which shares the same bug โ€” would be:

reallocarray(p, n?n:1, size?size:1)

There's more of this page still coming, bestie โ€” part 2 has the rest ๐Ÿ‘€

โœจ EXAMPLES โœจ

Okay bestie, time for the ~demonstration~, and honestly it's giving "I wrote a whole macro because I have trust issues" energy ๐Ÿซถ โ€” watch:

#include <err.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#define MALLOCARRAY(n, type)  ((type *) my_mallocarray(n, sizeof(type)))
#define MALLOC(type)          MALLOCARRAY(1, type)

static inline void *my_mallocarray(size_t n, size_t size);

int
main(void)
{
    char  *p;

    p = MALLOCARRAY(32, char);
    if (p == NULL)
        err(EXIT_FAILURE, "malloc");

    strlcpy(p, "foo", 32);
    puts(p);
}

static inline void *
my_mallocarray(size_t n, size_t size)
{
    return reallocarray(NULL, n, size);
}

CHEF'S KISS ๐Ÿ’… Look at what's happening here, because it's lowkey genius:

  • The macro MALLOCARRAY(n, type) does the size math for you โ€” it multiplies n by sizeof(type) so you literally cannot forget the multiplication and you cannot overflow it on a 32-bit box. Periodt. ๐Ÿ’–
  • The macro MALLOC(type) is just a lil shortcut on top: it's MALLOCARRAY(1, type), aka "gimme room for exactly one of these, bestie".
  • Then my_mallocarray is a tiny โœจstatic inlineโœจ wrapper that just calls reallocarray(NULL, n, size) โ€” and yes, passing NULL to reallocarray() is the move, because that's literally how malloc() works internally anyway. No cap. ๐Ÿฆ‹
  • And the check? if (p == NULL) then err(EXIT_FAILURE, "malloc") โ€” you always vibe check your pointer first, babe, that's the whole lesson here. ๐Ÿ™ˆ

๐Ÿ’– SEE ALSO ๐Ÿ’–

The whole friendship group, right here:

Heads up, bestie! โœ‹ If you want the ~deep lore~ on how the GNU C library actually implements all of this, the tea is at https://sourceware.org/glibc/wiki/MallocInternals. Go read it, it's iconic. ๐Ÿ‘‘

And that's the whole page, bestie!! ๐ŸŽ€ This absolute banger of a manpage came from Linux man-pages 6.20, dated 2026-02-08 โ€” so go forth, malloc() responsibly, free everything you allocate, and may your valgrind runs always come back clean. iykyk ๐ŸŒธ๐Ÿ’œโœจ

๐Ÿ“ฆ where this page comes from
  • arch rolling: man-pages 6.20-1 ยท BSD-2-Clause AND BSD-3-Clause AND BSD-4.3TAHOE AND BSD-4-Clause-UC AND GPL-1.0-or-later AND GPL-2.0-only AND GPL-2.0-or-later AND GPL-3.0-or-later AND LGPL-3.0-linking-exception AND LGPL-3.0-or-later AND LicenseRef-Public-Domain AND LicenseRef-UltraPermissive AND Linux-man-pages-1-para AND Linux-man-pages-copyleft AND Linux-man-pages-copyleft-2-para AND Linux-man-pages-copyleft-var AND MIT AND Spencer-94
  • nixpkgs unstable: man-pages 6.20
  • ๐Ÿ“œ the page's license: Linux-man-pages-copyleft
  • ๐Ÿ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms