man3/malloc_stats.3

   1 .\" Copyright (c) 2012 by Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH MALLOC_STATS 3  2021-03-22 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 malloc_stats \- print memory allocation statistics
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <malloc.h>
  31 .PP
  32 .B void malloc_stats(void);
  33 .fi
  34 .SH DESCRIPTION
  35 The
  36 .BR malloc_stats ()
  37 function prints (on standard error) statistics about memory allocated by
  38 .BR malloc (3)
  39 and related functions.
  40 For each arena (allocation area), this function prints
  41 the total amount of memory allocated
  42 and the total number of bytes consumed by in-use allocations.
  43 (These two values correspond to the
  44 .I arena
  45 and
  46 .I uordblks
  47 fields retrieved by
  48 .BR mallinfo (3).)
  49 In addition,
  50 the function prints the sum of these two statistics for all arenas,
  51 and the maximum number of blocks and bytes that were ever simultaneously
  52 allocated using
  53 .BR mmap (2).
  54 .\" .SH VERSIONS
  55 .\" Available already in glibc 2.0, possibly earlier
  56 .SH ATTRIBUTES
  57 For an explanation of the terms used in this section, see
  58 .BR attributes (7).
  59 .ad l
  60 .nh
  61 .TS
  62 allbox;
  63 lbx lb lb
  64 l l l.
  65 Interface       Attribute       Value
  66 T{
  67 .BR malloc_stats ()
  68 T}      Thread safety   MT-Safe
  69 .TE
  70 .hy
  71 .ad
  72 .sp 1
  73 .SH CONFORMING TO
  74 This function is a GNU extension.
  75 .SH NOTES
  76 More detailed information about memory allocations in the main arena
  77 can be obtained using
  78 .BR mallinfo (3).
  79 .SH SEE ALSO
  80 .BR mmap (2),
  81 .BR mallinfo (3),
  82 .BR malloc (3),
  83 .BR malloc_info (3),
  84 .BR mallopt (3)