Blame man3/malloc_stats.3

Packit 7cfc04
'\" t
Packit 7cfc04
.\" Copyright (c) 2012 by Michael Kerrisk <mtk.manpages@gmail.com>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.TH MALLOC_STATS 3  2017-09-15 "Linux" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
malloc_stats \- print memory allocation statistics
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.B #include <malloc.h>
Packit 7cfc04
.PP
Packit 7cfc04
.B void malloc_stats(void);
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
.BR malloc_stats ()
Packit 7cfc04
function prints (on standard error) statistics about memory allocated by
Packit 7cfc04
.BR malloc (3)
Packit 7cfc04
and related functions.
Packit 7cfc04
For each arena (allocation area), this function prints
Packit 7cfc04
the total amount of memory allocated
Packit 7cfc04
and the total number of bytes consumed by in-use allocations.
Packit 7cfc04
(These two values correspond to the
Packit 7cfc04
.I arena
Packit 7cfc04
and
Packit 7cfc04
.I uordblks
Packit 7cfc04
fields retrieved by
Packit 7cfc04
.BR mallinfo (3).)
Packit 7cfc04
In addition,
Packit 7cfc04
the function prints the sum of these two statistics for all arenas,
Packit 7cfc04
and the maximum number of blocks and bytes that were ever simultaneously
Packit 7cfc04
allocated using
Packit 7cfc04
.BR mmap (2).
Packit 7cfc04
.\" .SH VERSIONS
Packit 7cfc04
.\" Available already in glibc 2.0, possibly earlier
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lb lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR malloc_stats ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.sp 1
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
This function is a GNU extension.
Packit 7cfc04
.SH NOTES
Packit 7cfc04
More detailed information about memory allocations in the main arena
Packit 7cfc04
can be obtained using
Packit 7cfc04
.BR mallinfo (3).
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR mmap (2),
Packit 7cfc04
.BR mallinfo (3),
Packit 7cfc04
.BR malloc (3),
Packit 7cfc04
.BR malloc_info (3),
Packit 7cfc04
.BR mallopt (3)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.