original/man3/malloc_trim.3

   1 '\" t
   2 .\" Copyright (c) 2012 by Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH MALLOC_TRIM 3  2012-03-29 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 malloc_trim \- release free memory from the top of the heap
  29 .SH SYNOPSIS
  30 .B #include <malloc.h>
  31
  32 .BI "void malloc_trim(size_t "  pad );
  33 .SH DESCRIPTION
  34 The
  35 .BR malloc_trim ()
  36 function attempts to release free memory at the top of the heap
  37 (by calling
  38 .BR sbrk (2)
  39 with a suitable argument).
  40
  41 The
  42 .I pad
  43 argument specifies the amount of free space to leave untrimmed
  44 at the top of the heap.
  45 If this argument is 0, only the minimum amount of memory is maintained
  46 at the top of the heap (i.e., one page or less).
  47 A nonzero argument can be used to maintain some trailing space
  48 at the top of the heap in order to allow future allocations
  49 to be made without having to extend the heap with
  50 .BR sbrk (2).
  51 .SH RETURN VALUE
  52 The
  53 .BR malloc_trim ()
  54 function returns 1 if memory was actually released back to the system,
  55 or 0 if it was not possible to release any memory.
  56 .SH ERRORS
  57 No errors are defined.
  58 .\" .SH VERSIONS
  59 .\" Available already in glibc 2.0, possibly earlier
  60 .SH CONFORMING TO
  61 This function is a GNU extension.
  62 .SH NOTES
  63 This function is automatically called by
  64 .BR free (3)
  65 in certain circumstances; see the discussion of
  66 .B M_TOP_PAD
  67 and
  68 .B M_TRIM_THRESHOLD
  69 in
  70 .BR mallopt (3).
  71
  72 This function cannot release free memory located at places
  73 other than the top of the heap.
  74
  75 This function releases only memory in the main arena.
  76 .\" malloc/malloc.c::mTRIm():
  77 .\"     return result | (av == &main_arena ? sYSTRIm (pad, av) : 0);
  78 .SH SEE ALSO
  79 .BR sbrk (2),
  80 .BR malloc (3),
  81 .BR mallopt (3)
  82 .SH COLOPHON
  83 This page is part of release 3.67 of the Linux
  84 .I man-pages
  85 project.
  86 A description of the project,
  87 information about reporting bugs,
  88 and the latest version of this page,
  89 can be found at
  90 \%http://www.kernel.org/doc/man\-pages/.