draft/man3/malloc.3

   1 .\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
   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 .\" Modified Sat Jul 24 19:00:59 1993 by Rik Faith (faith@cs.unc.edu)
  26 .\" Clarification concerning realloc, iwj10@cus.cam.ac.uk (Ian Jackson), 950701
  27 .\" Documented MALLOC_CHECK_, Wolfram Gloger (wmglo@dent.med.uni-muenchen.de)
  28 .\" 2007-09-15 mtk: added notes on malloc()'s use of sbrk() and mmap().
  29 .\"
  30 .\"*******************************************************************
  31 .\"
  32 .\" This file was generated with po4a. Translate the source file.
  33 .\"
  34 .\"*******************************************************************
  35 .TH MALLOC 3 2012\-05\-10 GNU "Linux Programmer's Manual"
  36 .SH 名前
  37 malloc, free, calloc, realloc \- 動的なメモリの割り当てと解放を行う
  38 .SH 書式
  39 .nf
  40 \fB#include <stdlib.h>\fP
  41 .sp
  42 \fBvoid *malloc(size_t \fP\fIsize\fP\fB);\fP
  43 \fBvoid free(void \fP\fI*ptr\fP\fB);\fP
  44 \fBvoid *calloc(size_t \fP\fInmemb\fP\fB, size_t \fP\fIsize\fP\fB);\fP
  45 \fBvoid *realloc(void \fP\fI*ptr\fP\fB, size_t \fP\fIsize\fP\fB);\fP
  46 .fi
  47 .SH 説明
  48 .PP
  49 .\" glibc does this:
  50 \fBmalloc\fP() 関数は \fIsize\fP バイトを割り当て、 割り当てられたメモリに対する
  51 ポインタを返す。\fIメモリの内容は初期化されない\fP。 \fIsize\fP が 0 の場合、
  52 \fBmalloc\fP() は NULL または \fBfree\fP() に後で渡しても問題の起こらない
  53 一意なポインタ値を返す。
  54 .PP
  55 \fBfree\fP() 関数はポインタ \fIptr\fP が指すメモリ空間を解放する。このポインタは、
  56 以前に呼び出された \fBmalloc\fP(), \fBcalloc\fP(), \fBrealloc\fP() のいずれかが返した値で
  57 なければならない。これ以外のポインタを指定したり、すでに \fIfree(ptr)\fP が実行
  58 されていたりした場合の動作は定義されていない。
  59 \fIptr\fP が NULL の場合には、何の動作も行われない。
  60 .PP
  61 .\" glibc does this:
  62 \fBcalloc\fP() 関数は \fIsize\fP バイトの要素 \fInmemb\fP 個からなる配列にメモリを
  63 割り当て、割り当てられたメモリに対するポインタを返す。 メモリの内容は数値ゼロ
  64 (全ビットが 0 のバイト) にセットされる。 \fInmemb\fP か \fIsize\fP が 0 の場合、
  65 \fBcalloc\fP() は NULL または \fBfree\fP() に後で渡しても問題の起こらない一意な
  66 ポインタ値を返す。
  67 .PP
  68 \fBrealloc\fP() は、ポインタ \fIptr\fP が示すメモリブロックのサイズを \fIsize\fP バイト
  69 に変更する。領域の先頭から、新旧のサイズの小さい方の位置までの範囲の内容は
  70 変更されない。新しいサイズが前のサイズよりも大きい場合、追加されたメモリは
  71 初期化 \fIされない\fP。
  72 \fIptr\fP が NULL の場合には \fImalloc(size)\fP と等価である。
  73 \fIsize\fP が 0 で \fIptr\fP が NULL でない場合には、 \fIfree(ptr)\fP と等価である。
  74 \fIptr\fP が NULL 以外の場合、 \fIptr\fP は以前に呼び出された \fBmalloc\fP(), \fBcalloc\fP(),
  75 \fBrealloc\fP() のいずれかが返した値でなければならない。
  76 \fIptr\fP が指す領域が移動されていた場合は \fIfree(ptr)\fP が実行される。
  77 .SH 返り値
  78 関数 \fBcalloc\fP() と \fBmalloc\fP() は、割り当てられたメモリへのポインタを返す。
  79 割り当てられたメモリは、あらゆる種類の変数に対応できるようにアラインメントされる。
  80 エラーの場合、これらの関数は NULL を返す。
  81 \fIsize\fP が 0 で呼び出した \fBmalloc\fP() や、\fInmemb\fP か \fIsize\fP が 0 で呼び出した
  82 \fBcalloc\fP() が成功した場合にも NULL が返される。
  83 .PP
  84 \fBfree\fP() 関数は値を返さない。
  85 .PP
  86 \fBrealloc\fP() 関数は新たに割り当てられたメモリへのポインタを返す。
  87 これはあらゆる種類の変数に対応できるようにアラインメントされており、
  88 \fIptr\fP とは異なることもある。割り当て要求に失敗した場合は NULL が返る。
  89 \fIsize\fP が 0 の場合には、NULL もしくは \fBfree\fP() に渡すことができるポインタが返る。
  90 \fBrealloc\fP() が失敗した場合には、元のブロックは変更されない。
  91 つまり、解放されたり移動されたりはしない。
  92 .SH 準拠
  93 C89, C99.
  94 .SH 注意
  95 デフォルトでは、Linux は楽観的メモリ配置戦略を用いている。つまり、
  96 \fBmalloc\fP() が NULL でない値を返しても、そのメモリが実際に利用可能であること
  97 が保証されない。システムがメモリ不足状態になったとき、メモリ不足解決器 (OOM
  98 killer) によって一つまたは複数のプロセスが削除される。
  99 詳しい情報は、\fBproc\fP(5) の \fI/proc/sys/vm/overcommit_memory\fP と
 100 \fIproc/sys/vm/oom_adj\fP、および Linux カーネルのソースファイルの
 101 \fIDocumentation/vm/overcommit\-accounting\fP を参照のこと。
 102
 103 通常、 \fBmalloc\fP()  は、ヒープからメモリを割り当て、必要に応じてヒープのサイズを \fBsbrk\fP(2)  を使って調節する。
 104 \fBMMAP_THRESHOLD\fP バイトよりも大きなメモリブロックを割り当てる場合、 glibc の \fBmalloc\fP()  実装は
 105 \fBmmap\fP(2)  を使ってプライベートな無名マッピング (anonymous mapping) として メモリを割り当てる。 デフォルトでは
 106 \fBMMAP_THRESHOLD\fP は 128 kB だが、 \fBmallopt\fP(3)  を使って調整できる。 \fBmmap\fP(2)
 107 を使って行われたメモリ割り当ては \fBRLIMIT_DATA\fP リソース上限の影響を受けない (\fBgetrlimit\fP(2)  参照)。
 108
 109 マルチスレッドアプリケーションでのデータ破損を回避するため、内部では mutexを
 110 使用して、これらの関数で利用されるメモリ管理用のデータ構造を保護している。
 111 複数のスレッドが同時にメモリの確保や解放を行うようなマルチスレッドアプリケー
 112 ションでは、これらの mutex の衝突が起こり得る。マルチスレッドアプリケーション
 113 でのメモリ割り当て処理にスケーラビリティを持たせるために、glibc では mutex の
 114 衝突が検出された際には追加の \fIメモリ割り当て領域\fP を作成する。
 115 追加領域の各々は、(\fBbrk\fP(2) や \fBmmap\fP(2) を使って) システムにより内部的に
 116 割り当てられた大きな領域で、それぞれ独自の mutex により管理されている。
 117
 118 UNIX 98 標準では、 \fBmalloc\fP(), \fBcalloc\fP(), \fBrealloc\fP() は実行に失敗したときに \fIerrno\fP を
 119 \fBENOMEM\fP に設定することになっている。 Glibc ではこれが守られていることを仮定している (またこれらのルーチンの glibc
 120 バージョンはこのことを守っている)。 個人的に別の malloc の実装を使っていて、その malloc が\fIerrno\fP
 121 を設定しない場合には、失敗した際に \fIerrno\fP にエラーの理由を設定しないライブラリルーチンがあるかもしれない。
 122 .LP
 123 \fBmalloc\fP(), \fBcalloc\fP(), \fBrealloc\fP(), \fBfree\fP()  における事故は、 ほとんどの場合はヒープの破壊
 124 (corruption) が原因である。 例えば、割り当てられた領域をオーバーフローする、 同じポインタに二度 free する、などがこれにあたる。
 125 .PP
 126 Linux libc の新しいバージョン (5.4.23 より後) と glibc (2.x) には、
 127 環境変数で動作を調整できる \fBmalloc\fP() 実装が含まれている。
 128 詳細は \fBmallopt\fP(3) を参照のこと。
 129 .SH 関連項目
 130 .\" http://g.oswego.edu/dl/html/malloc.html
 131 .\" A Memory Allocator - by Doug Lea
 132 .\"
 133 .\" http://www.bozemanpass.com/info/linux/malloc/Linux_Heap_Contention.html
 134 .\" Linux Heap, Contention in free() - David Boreham
 135 .\"
 136 .\" http://www.citi.umich.edu/projects/linux-scalability/reports/malloc.html
 137 .\" malloc() Performance in a Multithreaded Linux Environment -
 138 .\"     Check Lever, David Boreham
 139 .\"
 140 .ad l
 141 .nh
 142 \fBbrk\fP(2), \fBmmap\fP(2), \fBalloca\fP(3), \fBmalloc_get_state\fP(3),
 143 \fBmalloc_info\fP(3), \fBmalloc_trim\fP(3), \fBmalloc_usable_size\fP(3),
 144 \fBmallopt\fP(3), \fBmcheck\fP(3), \fBmtrace\fP(3), \fBposix_memalign\fP(3)
 145 .SH この文書について
 146 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 147 である。プロジェクトの説明とバグ報告に関する情報は
 148 http://www.kernel.org/doc/man\-pages/ に書かれている。