malloc_usable_size(3) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ATTRIBUTES | STANDARDS | CAVEATS | SEE ALSO

malloc_usable_size(3)   Library Functions Manual   malloc_usable_size(3)

NAME         top

       malloc_usable_size - obtain size of block of memory allocated
       from heap

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <malloc.h>

       size_t malloc_usable_size(void *_Nullable ptr);

DESCRIPTION         top

       This function can be used for diagnostics or statistics about
       allocations from malloc(3) or a related function.

RETURN VALUE         top

       malloc_usable_size() returns a value no less than the size of the
       block of allocated memory pointed to by ptr.  If ptr is NULL, 0
       is returned.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌─────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                           Attribute     Value   │
       ├─────────────────────────────────────┼───────────────┼─────────┤
       │ malloc_usable_size()                │ Thread safety │ MT-Safe │
       └─────────────────────────────────────┴───────────────┴─────────┘

STANDARDS         top

       GNU.

CAVEATS         top

       The value returned by malloc_usable_size() may be greater than
       the requested size of the allocation because of various internal
       implementation details, none of which the programmer should rely
       on.  This function is intended to only be used for diagnostics
       and statistics; writing to the excess memory without first
       calling realloc(3) to resize the allocation is not supported.
       The returned value is only valid at the time of the call.

SEE ALSO         top

       malloc(3)

Linux man-pages (unreleased)   2024-05-02          malloc_usable_size(3)

Pages that refer to this page: malloc(3)