release/man2/alloc_hugepages.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright 2003 Andries E. Brouwer (aeb@cwi.nl)
   4 .\"
   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 .\"
  25 .\"
  26 .\" Japanese Version Copyright (c) 2004 Yuichi SATO
  27 .\"         all rights reserved.
  28 .\" Translated 2004-06-06, Yuichi SATO <ysato444@yahoo.co.jp>
  29 .\" Updated 2007-06-11, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.54
  30 .\"
  31 .\"WORD:        huge page       ヒュージページ
  32 .\"
  33 .TH ALLOC_HUGEPAGES 2 2007-05-31 "Linux" "Linux Programmer's Manual"
  34 .SH 名前
  35 alloc_hugepages, free_hugepages \- 大きなサイズのページの割り当てと解放を行う
  36 .SH 書式
  37 .nf
  38 .BI "void *alloc_hugepages(int " key ", void *" addr ", size_t " len ,
  39 .BI "                      int " prot ", int " flag );
  40 .\" asmlinkage unsigned long sys_alloc_hugepages(int key, unsigned long addr,
  41 .\" unsigned long len, int prot, int flag);
  42 .sp
  43 .BI "int free_hugepages(void *" addr );
  44 .\" asmlinkage int sys_free_hugepages(unsigned long addr);
  45 .fi
  46 .SH 説明
  47 システムコール
  48 .BR alloc_hugepages ()
  49 と
  50 .BR free_hugepages ()
  51 は Linux 2.5.36 で導入され、2.5.54 で再び削除された。
  52 これらのシステムコールは i386 と ia64 のみで
  53 (かつ
  54 .B CONFIG_HUGETLB_PAGE
  55 を指定してビルドされた場合に) 存在する。
  56 Linux 2.4.20 では syscall 番号が存在するが、
  57 呼び出すとエラー
  58 .B ENOSYS
  59 で失敗する。
  60 .LP
  61 i386 では、メモリ管理ハードウェアは通常のページ (4 KiB) と
  62 大きなサイズのページ (以下、ヒュージページ; 2MiB または 4 MiB) を
  63 扱うことができる。
  64 同様に、ia64 もいくつかのサイズのヒュージページを扱うことができる。
  65 これらのシステムコールは、ヒュージページをプロセスのメモリにマップしたり、
  66 再び解放したりする。
  67 ヒュージページはメモリ内にロックされ、スワップされない。
  68 .LP
  69 .I key
  70 引き数は識別子である。
  71 0 の場合、ページは非公開になり、子プロセスに継承されない。
  72 正の場合、ページは同じ
  73 .I key
  74 を使う他のアプリケーションと共有され、子プロセスに継承される。
  75 .LP
  76 .BR free_hugepages ()
  77 の
  78 .I addr
  79 引き数は、どのページを解放するかを指定する:
  80 .I addr
  81 は
  82 .BR alloc_hugepages ()
  83 の呼び出しの返り値である
  84 (全てのユーザがメモリを解放したときに、
  85 そのメモリは初めて実際に解放される)。
  86 .BR alloc_hugepages ()
  87 の
  88 .I addr
  89 引き数はヒントであり、カーネルはそれに従うかもしれないし、
  90 従わないかもしれない。
  91 アドレスは正しく配置されなければならない。
  92 .LP
  93 .I len
  94 引き数は要求されたセグメントの長さである。
  95 これはヒュージページのサイズの倍数にしなければならない。
  96 .LP
  97 .I prot
  98 引き数はセグメントのメモリ保護を指定する。
  99 これは
 100 .BR PROT_READ ,
 101 .BR PROT_WRITE ,
 102 .B PROT_EXEC
 103 のいずれかである。
 104 .LP
 105 .I key
 106 が正でない限り、
 107 .I flag
 108 引き数は無視される。
 109 .I key
 110 が正で、かつ
 111 .I flag
 112 が
 113 .B IPC_CREAT
 114 であり、かつ指定された
 115 .I key
 116 で (セグメントが) 何も存在しない場合、
 117 新しいヒュージページセグメントが作成される。
 118 .I flag
 119 が設定されておらず、かつ指定された
 120 .I key
 121 のセグメントが存在しない場合、
 122 .B ENOENT
 123 が返される。
 124 .SH 返り値
 125 成功した場合、
 126 .BR alloc_hugepages ()
 127 は割り当てられた仮想アドレスを返し、
 128 .BR free_hugepages ()
 129 は 0 を返す。
 130 失敗した場合、\-1 を返し、
 131 .I errno
 132 が適切に設定される。
 133 .SH エラー
 134 .TP
 135 .B ENOSYS
 136 このシステムコールはカーネルでサポートされていない。
 137 .SH ファイル
 138 .TP
 139 .I /proc/sys/vm/nr_hugepages
 140 設定された hugetlb ページの数。
 141 このファイルは読み書きできる。
 142 .TP
 143 .I /proc/meminfo
 144 設定された hugetlb ページの数と、
 145 3 つの変数 HugePages_Total, HugePages_Free, Hugepagesize の
 146 サイズについての情報を提供する。
 147 .SH 準拠
 148 このシステムコールは Intel プロセッサ上の Linux に固有のものであり、
 149 移植性が必要なプログラムで使うべきでない。
 150 .SH 注意
 151 これらのシステムコールはなくなった。
 152 これらは Linux 2.5.36 から 2.5.54 にのみ存在する。
 153 代わりに今は hugetlbfs ファイルシステムを使うことができる。
 154 (CPU がサポートしている場合) ヒュージページを持つメモリは、
 155 .BR mmap (2)
 156 を使ってこの仮想ファイルシステムでファイルをマップすることで取得できる。
 157 .LP
 158 ヒュージページの最大数は、
 159 .B hugepages=
 160 起動パラメータを使って指定できる。
 161 .\" ("Processor type and features" 以下の) CONFIG_HUGETLB_PAGE
 162 .\" ("Filesystems" 以下の).CONFIG_HUGETLBFS が必要である。
 163 .\" mount -t hugetlbfs hugetlbfs /huge
 164 .\" SHM_HUGETLB