manual/LDP_man-pages/release/man2/brk.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (c) 1993 Michael Haardt
   4 .\" (michael@moria.de),
   5 .\" Fri Apr  2 11:32:09 MET DST 1993
   6 .\"
   7 .\" This is free documentation; you can redistribute it and/or
   8 .\" modify it under the terms of the GNU General Public License as
   9 .\" published by the Free Software Foundation; either version 2 of
  10 .\" the License, or (at your option) any later version.
  11 .\"
  12 .\" The GNU General Public License's references to "object code"
  13 .\" and "executables" are to be interpreted as the output of any
  14 .\" document formatting or typesetting system, including
  15 .\" intermediate and printed output.
  16 .\"
  17 .\" This manual is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public
  23 .\" License along with this manual; if not, write to the Free
  24 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  25 .\" USA.
  26 .\"
  27 .\" Modified Wed Jul 21 19:52:58 1993 by Rik Faith <faith@cs.unc.edu>
  28 .\" Modified Sun Aug 21 17:40:38 1994 by Rik Faith <faith@cs.unc.edu>
  29 .\"
  30 .\" Japanese Version Copyright (c) 1996 TABATA Tomohira
  31 .\"         all rights reserved.
  32 .\" Translated Wed Jun 26 19:12:54 JST 1996
  33 .\"         by TABATA Tomohira <loba@k2.t.u-tokyo.ac.jp>
  34 .\" Modified Sat Dec 13 23:43:56 JST 1997
  35 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  36 .\" Updated & Modified Wed May 19 01:55:29 JST 2004
  37 .\"         by Yuichi SATO <ysato444@yahoo.co.jp>, LDP v1.66
  38 .\" Updated & Modified Tue Jan  2 09:09:47 JST 2007 by Yuichi SATO, LDP v2.43
  39 .\" Updated 2008-08-04, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.05
  40 .\"
  41 .TH BRK 2 2010-09-20 "Linux" "Linux Programmer's Manual"
  42 .SH 名前
  43 brk, sbrk \- データ・セグメントのサイズの変更する
  44 .SH 書式
  45 .B #include <unistd.h>
  46 .sp
  47 .BI "int brk(void *" addr );
  48 .sp
  49 .BI "void *sbrk(intptr_t " increment );
  50 .sp
  51 .in -4n
  52 glibc 向けの機能検査マクロの要件
  53 .RB ( feature_test_macros (7)
  54 参照):
  55 .in
  56 .sp
  57 .BR brk (),
  58 .BR sbrk ():
  59 .ad l
  60 .RS 4
  61 .PD 0
  62 .TP 4
  63 glibc 2.12 以降:
  64 .nf
  65 _BSD_SOURCE || _SVID_SOURCE ||
  66     (_XOPEN_SOURCE\ >=\ 500 ||
  67         _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED) &&
  68     !(_POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600)
  69 .fi
  70 .TP 4
  71 glibc 2.12 より前:
  72 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  73 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  74 .PD
  75 .RE
  76 .ad b
  77 .SH 説明
  78 .BR brk ()
  79 と
  80 .BR sbrk ()
  81 は
  82 .I "プログラム・ブレーク (program break)"
  83 の場所を変更する。
  84 プログラム・ブレークはプロセスのデータ・セグメント (data segment) の
  85 末尾を示す (プログラム・ブレークは、初期化されていない
  86 データ・セグメントの末尾の直後の場所となる)。
  87 プログラム・ブレークを増やすということは、そのプロセスへの
  88 メモリを割り当てる効果があり、
  89 プログラム・ブレークを減らすということは、メモリを解放する
  90 ということである。
  91
  92 .BR brk ()
  93 は、データ・セグメントの末尾を
  94 .I addr
  95 で指定した値に設定する。
  96 設定が行われるのは、指定した値が有効で、
  97 システムに十分なメモリがあり、
  98 プロセスのデータサイズの最大値を超えていない場合である
  99 .RB ( setrlimit (2)
 100 を参照)。
 101
 102 .BR sbrk ()
 103 は、プログラムのデータ空間を
 104 .I increment
 105 バイトだけ増やす。
 106 .I increment
 107 を 0 にして
 108 .BR sbrk ()
 109 を呼び出すことで、プログラムの現在のブレーク (break) 場所を知ることができる。
 110 .SH 返り値
 111 成功した場合、
 112 .BR brk ()
 113 は 0 を返す。
 114 エラーの場合には、\-1 を返し、
 115 .I errno
 116 に
 117 .B ENOMEM
 118 を設定する
 119 (ただし「LINUX での注意」を参照すること)。
 120
 121 成功した場合、
 122 .BR sbrk ()
 123 は変更前のプログラム・ブレークを返す
 124 (プログラム・ブレークが増やされた場合、この値は
 125 新しく割り当てられたメモリの先頭を指すポインタとなる)。
 126 エラーの場合には、
 127 .I "(void\ *)\ \-1"
 128 を返し、
 129 .I errno
 130 に
 131 .B ENOMEM
 132 を設定する。
 133 .SH 準拠
 134 4.3BSD, SUSv1.
 135 SUSv2 では「過去の名残 (LEGACY)」と位置付けられており、
 136 POSIX.1-2001 で削除された。
 137 .\" .BR brk ()
 138 .\" と
 139 .\" .BR sbrk ()
 140 .\" は C 規格 (C Standard) には定義されていない。
 141 .\" また POSIX.1 規格からは意図的に除外されている (段落 B.1.1.1.3, B.8.3.3 参照)。
 142 .SH 注意
 143 .BR brk ()
 144 や
 145 .BR sbrk ()
 146 を使用するのは避けること。
 147 .BR malloc (3)
 148 メモリ割り当てパッケージの方が、移植性が高く、
 149 使いやすいメモリ割り当て方法を提供している。
 150
 151 いろいろなシステムにおいて、
 152 .BR sbrk ()
 153 の引き数に様々な型が使われている。
 154 一般的なのは \fIint\fP, \fIssize_t\fP, \fIptrdiff_t\fP, \fIintptr_t\fP である。
 155 .\" \fIint\fP (たとえば XPGv4, DU 4.0, HP-UX 11, FreeBSD 4.0, OpenBSD 3.2),
 156 .\" \fIssize_t\fP (OSF1 2.0, Irix 5.3, 6.5),
 157 .\" \fIptrdiff_t\fP (libc4, libc5, ulibc, glibc 2.0, 2.1),
 158 .\" \fIintptr_t\fP (たとえば XPGv5, AIX, SunOS 5.8, 5.9, FreeBSD 4.7,
 159 .\" NetBSD 1.6, Tru64 5.1, glibc2.2).
 160 .\" というのが分かるだろう。
 161 .SS Linux での注意
 162 上で説明した
 163 .BR brk ()
 164 の返り値についての動作は、
 165 Linux の
 166 .BR brk ()
 167 システムコールをラップする glibc の関数によるものである。
 168 (その他の多くの実装でも、
 169 .BR brk ()
 170 の返り値はこれと同じである。
 171 この返り値は SUSv2 でも規定されている。)
 172 しかし、実際の Linux システムコールは、成功した場合、
 173 プログラムの新しいブレークを返す。
 174 失敗した場合、このシステムコールは現在のブレークを返す。
 175 glibc ラッパー関数は同様の働きをし
 176 (すなわち、新しいブレークが
 177 .I addr
 178 より小さいかどうかをチェックし)、
 179 上で説明した 0 と \-1 という返り値を返す。
 180
 181 Linux では
 182 .BR sbrk ()
 183 は
 184 .BR brk ()
 185 システムコールを使うライブラリ関数として実装されており、
 186 以前のブレークの値を返すことができるように内部で調整が行われている。
 187 .SH 関連項目
 188 .BR execve (2),
 189 .BR getrlimit (2),
 190 .BR end (3),
 191 .BR malloc (3)