release/man2/move_pages.2

   1 .\" This manpage is Copyright (C) 2006 Silicon Graphics, Inc.
   2 .\"                               Christoph Lameter
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM_TWO_PARA)
   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 .\" %%%LICENSE_END
  14 .\"
  15 .\" FIXME Should programs normally be using this API directly, or should
  16 .\" they rather be using interfaces in the numactl package?
  17 .\" (e.g., compare with recommendation in mbind(2)).
  18 .\"*******************************************************************
  19 .\"
  20 .\" This file was generated with po4a. Translate the source file.
  21 .\"
  22 .\"*******************************************************************
  23 .\"
  24 .\" Japanese Version Copyright (c) 2008  Akihiro MOTOKI
  25 .\"         all rights reserved.
  26 .\" Translated 2008-10-26, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  27 .\"
  28 .TH MOVE_PAGES 2 2010\-06\-11 Linux "Linux Programmer's Manual"
  29 .SH 名前
  30 move_pages \- あるプロセスの個々のページを別のノードに移動する
  31 .SH 書式
  32 .nf
  33 \fB#include <numaif.h>\fP
  34 .sp
  35 \fBlong move_pages(int \fP\fIpid\fP\fB, unsigned long count, void **\fP\fIpages\fP\fB,\fP
  36 \fB                const int *\fP\fInodes\fP\fB, int *\fP\fIstatus\fP\fB, int \fP\fIflags\fP\fB);\fP
  37 .fi
  38 .sp
  39 \fI\-lnuma\fP とリンクする。
  40 .SH 説明
  41 \fBmove_pages\fP()  は、プロセス \fIpid\fP の指定されたページ \fIpages\fP を \fInodes\fP
  42 で指定されたメモリノードに移動する。 移動の結果は \fIstatus\fP に反映される。 \fIflags\fP では移動されるページに関する制約を指定する。
  43
  44 \fIpid\fP は、移動されるページが属するプロセスの ID である。 別のプロセスのページを移動するためには、呼び出し元が特権
  45 (\fBCAP_SYS_NICE\fP)  を持っているか、呼び出したプロセスの実ユーザ ID か実効ユーザ ID が ページ移動対象のプロセスの実ユーザ
  46 ID か保存 set\-user\-ID のどちらかと 一致しなければならない。 \fIpid\fP が 0 の場合、 \fBmove_pages\fP()
  47 は呼び出したプロセスのページを移動する。
  48
  49 \fIcount\fP は移動するページ数である。 \fIcount\fP により \fIpages\fP, \fInodes\fP, \fIstatus\fP の 3
  50 つの配列の大きさが定義される。
  51
  52 .\" FIXME what if they are not aligned?
  53 \fIpages\fP は、移動すべきページへのポインタの配列であり、 各ポインタはページ境界に揃えた値を指定すべきである。 \fIpid\fP
  54 で指定されたプロセスで見えるアドレスを指定する。
  55
  56 \fInodes\fP は、各ページの希望の移動場所を示す整数値の配列であり、 配列の各要素はノード番号である。 \fInodes\fP には NULL
  57 を指定することもでき、この場合には \fBmove_pages\fP()  はどのページも移動しないが、各ページが現在配置されているノードを配列
  58 \fIstatus\fP に格納して返す。どのページを移動する必要があるかを判断するために、 各ページの状態の取得が必要な場合もある。
  59
  60 \fIstatus\fP は、各ページの状態を表す整数値の配列である。 この配列に有効な値が格納されるのは、 \fBmove_pages\fP()
  61 がエラーを返さなかった場合だけである。
  62
  63 \fIflags\fP には、どの種類のページを移動するかを指定する。 \fBMPOL_MF_MOVE\fP
  64 は、そのプロセスが排他的に使用しているページだけを移動することを意味する。 \fBMPOL_MF_MOVE_ALL\fP
  65 は、複数のプロセス間で共有されているページも移動できることを意味する。 \fBMPOL_MF_MOVE_ALL\fP を使用するためには、そのプロセスが特権
  66 (\fBCAP_SYS_NICE\fP)  を持っていなければならない。
  67 .SS "status 配列に格納されるページ状態"
  68 \fIstatus\fP 配列の各要素として、以下の値が返される。
  69 .TP
  70 \fB0..MAX_NUMNODES\fP
  71 そのページが配置されているノードを示す。
  72 .TP
  73 \fB\-EACCES\fP
  74 そのページは複数のプロセスによりマップされており、 \fBMPOL_MF_MOVE_ALL\fP が指定された場合にのみ移動できる。
  75 .TP
  76 \fB\-EBUSY\fP
  77 そのページが現在ビジーであり、移動できない。後でもう一度試すこと。 この状況は、ページが I/O の実行中であったり、カーネルの他のサブシステム
  78 がそのページへの参照を保持している場合に発生する。
  79 .TP
  80 \fB\-EFAULT\fP
  81 そのページが zero page であるか、そのメモリ領域はそのプロセスにより マップされていない。
  82 .TP
  83 \fB\-EIO\fP
  84 Unable to write back a page.  The page has to be written back in order to
  85 move it since the page is dirty and the filesystem does not provide a
  86 migration function that would allow the move of dirty pages.
  87 .TP
  88 \fB\-EINVAL\fP
  89 A dirty page cannot be moved.  The filesystem does not provide a migration
  90 function and has no ability to write back pages.
  91 .TP
  92 \fB\-ENOENT\fP
  93 ページが存在しない。
  94 .TP
  95 \fB\-ENOMEM\fP
  96 移動先のノードでメモリを確保することができない。
  97 .SH 返り値
  98 .\" FIXME Is the following quite true: does the wrapper in numactl
  99 .\" do the right thing?
 100 成功すると、 \fBmove_pages\fP()  は 0 を返す。 エラーの場合、\-1 を返し、 \fIerrno\fP にエラーを示す値を設定する。
 101 .SH エラー
 102 .TP
 103 \fBE2BIG\fP
 104 移動すべきページが多過ぎる。
 105 .TP
 106 \fBEACCES\fP
 107 .\" FIXME Clarify "current cpuset".  Is that the cpuset of the caller
 108 .\" or the target?
 109 移動先のノードのいずれかが現在の CPU 集合では許可されていない。
 110 .TP
 111 \fBEFAULT\fP
 112 パラメータ配列にアクセスできなかった。
 113 .TP
 114 \fBEINVAL\fP
 115 \fIflags\fP に \fBMPOL_MF_MOVE\fP でも \fBMPOL_MF_MOVE_ALL\fP
 116 でもない値が指定されたか、カーネルスレッドのページを移動させようとした。
 117 .TP
 118 \fBENODEV\fP
 119 移動先のノードのいずれかがオンラインでない。
 120 .TP
 121 \fBENOENT\fP
 122 移動が必要なページが全く見つからなかった。 指定された全てのページが、すでに移動先のノードに存在するか、存在しないか、
 123 無効なアドレスであったか、複数のプロセスによってマップされていて移動でき なかったか、のいずれかであった。
 124 .TP
 125 \fBEPERM\fP
 126 呼び出し元は \fBMPOL_MF_MOVE_ALL\fP を指定したが、十分な特権 (\fBCAP_SYS_NICE\fP)  を持っていない。
 127 または、呼び出し元が他のユーザに属するプロセスのページを移動しようとしたが、 それを行えるだけの特権 (\fBCAP_SYS_NICE\fP)
 128 を持っていなかった。
 129 .TP
 130 \fBESRCH\fP
 131 プロセスが存在しない。
 132 .SH バージョン
 133 \fBmove_pages\fP()  は、バージョン 2.6.18 で初めて Linux に登場した。
 134 .SH 準拠
 135 このシステムコールは Linux 固有である。
 136 .SH 注意
 137 ライブラリによるサポートについては \fBnuma\fP(7)  を参照。
 138
 139 .\" FIXME Clarify "current cpuset".  Is that the cpuset of the caller
 140 .\" or the target?
 141 現在の CPU 集合で許可されているノードの集合を取得するには、フラグ \fBMPOL_F_MEMS_ALLOWED\fP を指定して
 142 \fBget_mempolicy\fP(2)  を使用すればよい。 取得した情報は、CPU 集合の手動または自動での再構成により
 143 いつ何時変化してしまうか分からない。
 144
 145 この関数を使用すると、ページの位置 (ノード) が 指定されたアドレスに対して設定されたメモリポリシー (\fBmbind\fP(2)  参照)
 146 や指定されたプロセスに対して設定されたメモリポリシー (\fBset_mempolicy\fP(2)  参照) に違反してしまう可能性がある。
 147 つまり、メモリポリシーは \fBmove_pages\fP()  で使われる移動先ノードを制限しないということである。
 148
 149 ヘッダファイル \fI<numaif.h>\fP は glibc には含まれておらず、 \fIlibnuma\-devel\fP
 150 か同様のパッケージをインストールする必要がある。
 151 .SH 関連項目
 152 \fBget_mempolicy\fP(2), \fBmbind\fP(2), \fBset_mempolicy\fP(2), \fBnuma\fP(3),
 153 \fBnuma_maps\fP(5), \fBcpuset\fP(7), \fBnuma\fP(7), \fBmigratepages\fP(8),
 154 \fBnumastat\fP(8)
 155 .SH この文書について
 156 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.54 の一部
 157 である。プロジェクトの説明とバグ報告に関する情報は
 158 http://www.kernel.org/doc/man\-pages/ に書かれている。