man2/brk.2

   1 .\" Copyright (c) 1993 Michael Haardt, (michael@moria.de)
   2 .\" and Copyright 2006, 2008, Michael Kerrisk <tmk.manpages@gmail.com>
   3 .\" Fri Apr  2 11:32:09 MET DST 1993
   4 .\"
   5 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   6 .\" This is free documentation; you can redistribute it and/or
   7 .\" modify it under the terms of the GNU General Public License as
   8 .\" published by the Free Software Foundation; either version 2 of
   9 .\" the License, or (at your option) any later version.
  10 .\"
  11 .\" The GNU General Public License's references to "object code"
  12 .\" and "executables" are to be interpreted as the output of any
  13 .\" document formatting or typesetting system, including
  14 .\" intermediate and printed output.
  15 .\"
  16 .\" This manual is distributed in the hope that it will be useful,
  17 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 .\" GNU General Public License for more details.
  20 .\"
  21 .\" You should have received a copy of the GNU General Public
  22 .\" License along with this manual; if not, see
  23 .\" <http://www.gnu.org/licenses/>.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" Modified Wed Jul 21 19:52:58 1993 by Rik Faith <faith@cs.unc.edu>
  27 .\" Modified Sun Aug 21 17:40:38 1994 by Rik Faith <faith@cs.unc.edu>
  28 .\"
  29 .TH BRK 2 2021-03-22 "Linux" "Linux Programmer's Manual"
  30 .SH NAME
  31 brk, sbrk \- change data segment size
  32 .SH SYNOPSIS
  33 .nf
  34 .B #include <unistd.h>
  35 .PP
  36 .BI "int brk(void *" addr );
  37 .BI "void *sbrk(intptr_t " increment );
  38 .fi
  39 .PP
  40 .RS -4
  41 Feature Test Macro Requirements for glibc (see
  42 .BR feature_test_macros (7)):
  43 .RE
  44 .PP
  45 .BR brk (),
  46 .BR sbrk ():
  47 .nf
  48     Since glibc 2.19:
  49         _DEFAULT_SOURCE
  50             || ((_XOPEN_SOURCE >= 500) &&
  51                 ! (_POSIX_C_SOURCE >= 200112L))
  52 .\"    (_XOPEN_SOURCE >= 500 ||
  53 .\"        _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED) &&
  54     From glibc 2.12 to 2.19:
  55         _BSD_SOURCE || _SVID_SOURCE
  56             || ((_XOPEN_SOURCE >= 500) &&
  57                 ! (_POSIX_C_SOURCE >= 200112L))
  58 .\"    (_XOPEN_SOURCE >= 500 ||
  59 .\"        _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED) &&
  60     Before glibc 2.12:
  61         _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE >= 500
  62 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  63 .fi
  64 .SH DESCRIPTION
  65 .BR brk ()
  66 and
  67 .BR sbrk ()
  68 change the location of the
  69 .IR "program break" ,
  70 which defines the end of the process's data segment
  71 (i.e., the program break is the first location after the end of the
  72 uninitialized data segment).
  73 Increasing the program break has the effect of
  74 allocating memory to the process;
  75 decreasing the break deallocates memory.
  76 .PP
  77 .BR brk ()
  78 sets the end of the data segment to the value specified by
  79 .IR addr ,
  80 when that value is reasonable, the system has enough memory,
  81 and the process does not exceed its maximum data size (see
  82 .BR setrlimit (2)).
  83 .PP
  84 .BR sbrk ()
  85 increments the program's data space by
  86 .I increment
  87 bytes.
  88 Calling
  89 .BR sbrk ()
  90 with an
  91 .I increment
  92 of 0 can be used to find the current location of the program break.
  93 .SH RETURN VALUE
  94 On success,
  95 .BR brk ()
  96 returns zero.
  97 On error, \-1 is returned, and
  98 .I errno
  99 is set to
 100 .BR ENOMEM .
 101 .PP
 102 On success,
 103 .BR sbrk ()
 104 returns the previous program break.
 105 (If the break was increased,
 106 then this value is a pointer to the start of the newly allocated memory).
 107 On error,
 108 .I "(void\ *)\ \-1"
 109 is returned, and
 110 .I errno
 111 is set to
 112 .BR ENOMEM .
 113 .SH CONFORMING TO
 114 4.3BSD; SUSv1, marked LEGACY in SUSv2, removed in POSIX.1-2001.
 115 .\"
 116 .\" .BR brk ()
 117 .\" and
 118 .\" .BR sbrk ()
 119 .\" are not defined in the C Standard and are deliberately excluded from the
 120 .\" POSIX.1-1990 standard (see paragraphs B.1.1.1.3 and B.8.3.3).
 121 .SH NOTES
 122 Avoid using
 123 .BR brk ()
 124 and
 125 .BR sbrk ():
 126 the
 127 .BR malloc (3)
 128 memory allocation package is the
 129 portable and comfortable way of allocating memory.
 130 .PP
 131 Various systems use various types for the argument of
 132 .BR sbrk ().
 133 Common are \fIint\fP, \fIssize_t\fP, \fIptrdiff_t\fP, \fIintptr_t\fP.
 134 .\" One sees
 135 .\" \fIint\fP (e.g., XPGv4, DU 4.0, HP-UX 11, FreeBSD 4.0, OpenBSD 3.2),
 136 .\" \fIssize_t\fP (OSF1 2.0, Irix 5.3, 6.5),
 137 .\" \fIptrdiff_t\fP (libc4, libc5, ulibc, glibc 2.0, 2.1),
 138 .\" \fIintptr_t\fP (e.g., XPGv5, AIX, SunOS 5.8, 5.9, FreeBSD 4.7, NetBSD 1.6,
 139 .\" Tru64 5.1, glibc2.2).
 140 .SS C library/kernel differences
 141 The return value described above for
 142 .BR brk ()
 143 is the behavior provided by the glibc wrapper function for the Linux
 144 .BR brk ()
 145 system call.
 146 (On most other implementations, the return value from
 147 .BR brk ()
 148 is the same; this return value was also specified in SUSv2.)
 149 However,
 150 the actual Linux system call returns the new program break on success.
 151 On failure, the system call returns the current break.
 152 The glibc wrapper function does some work
 153 (i.e., checks whether the new break is less than
 154 .IR addr )
 155 to provide the 0 and \-1 return values described above.
 156 .PP
 157 On Linux,
 158 .BR sbrk ()
 159 is implemented as a library function that uses the
 160 .BR brk ()
 161 system call, and does some internal bookkeeping so that it can
 162 return the old break value.
 163 .SH SEE ALSO
 164 .BR execve (2),
 165 .BR getrlimit (2),
 166 .BR end (3),
 167 .BR malloc (3)