Provided by: manpages-ja-dev_0.5.0.0.20131015+dfsg-2_all bug

名前

       mbind - メモリ領域に対してメモリポリシーを設定する

書式

       #include <numaif.h>

       int mbind(void *addr, unsigned long len, int mode,
                 unsigned long *nodemask, unsigned long maxnode,
                 unsigned flags);

       -lnuma でリンクする。

説明

       mbind()   は、  addr から始まる長さ len バイトの範囲のメモリに NUMA メモリポリシーを設定す
       る。 NUMA ポリシーはポリシーモードと 0 個以上のノードから構成される。 メモリポリシーはどの
       ノードからメモリを割り当てるかを決定する。

       addrlen で指定されたメモリ範囲に、 メモリの「無名」領域 — MAP_ANONYMOUS 付きの mmap(2)
       システムコールを使って作成されたメモリ領域 — や MAP_PRIVATE 付きの mmap(2)  を使ってマップ
       されたメモリマップ・ファイルが含まれている場合、アプリケーションがそのページへの書き込み
       (データの格納)  を行った時には指定されたポリシーのみに基づいてページが割り当てられる。無名
       領域の場合、最初の読み出しアクセスの際には カーネル内の全データが 0 である共有ページが使用
       される。 MAP_PRIVATE でマップされたファイルの場合、最初の読み出しアクセスがあると、 ページ
       割り当てが発生するきっかけとなったプロセスのデフォルトポリシー  にしたがってページの割り当
       てが行われる。 ページ割り当てのきっかけとなったプロセスは、 mbind()   を呼び出したプロセス
       と同じとは限らない。

       指定されたメモリ範囲内にある   MAP_SHARED   のマッピングでは指定されたポリシーは無視され、
       ページ割り当てが発生するきっかけとなったプロセスのデフォルトポリシーに  したがってページの
       割り当てが行われることになる。  繰り返しになるが、ページ割り当てのきっかけとなったプロセス
       は、 mbind()  を呼び出したプロセスと同じとは限らない。

       指定されたメモリ範囲に、 shmget(2)  システムコールを使って作成されたり、 shmat(2)   システ
       ムコールを使って付加  (attach) されたりした共有メモリ領域が 含まれる場合、無名メモリ領域や
       共有メモリ領域に対するページ割り当ては、  共有メモリセグメントへポリシーの設定を行ったプロ
       セスがページ割り当て  のきっかけとなったかに関わらず、指定されたポリシーにしたがって割り当
       て が行われる。 しかしながら、共有メモリ領域が SHM_HUGETLB  フラグを指定して作成された場合
       には、ヒュージページ  (huge  page)  の割り当てが  指定されたポリシーにしたがって行われるの
       は、その領域に対して mbind()  を呼び出したプロセスがページ割り当てのきっかけとなった場合の
       みである。

       デフォルトでは、  mbind()  は新規のメモリ割り当てに対してのみ効果を持つ。 ポリシーが設定さ
       れる前にすでに使用されている範囲内のページに対しては、 ポリシーは影響しない。 このデフォル
       トの動作は、以下で説明するフラグ MPOL_MF_MOVEMPOL_MF_MOVE_ALL により上書きされる可能性
       がある。

       mode 引き数には、 MPOL_DEFAULT, MPOL_BIND, MPOL_INTERLEAVE, MPOL_PREFERRED  のいずれか一つ
       を指定しなければならない。  MPOL_DEFAULT 以外のポリシーモードの場合、呼び出し元は nodemask
       引き数でそのポリシーモードを適用するノードを指定する必要がある。

       mode 引き数には、追加で モードフラグ を含めることもできる。 サポートされている  モードフラ
        は以下の通りである。

       MPOL_F_STATIC_NODES (Linux-2.6.26 以降)
              空でない  nodemask  は、物理ノード ID である。 Linux では、そのプロセスが異なる CPU
              集合コンテキスト (cpuset context)  に移動した場合でも、そのプロセスの現在の CPU  集
              合コンテキストで 許可されているノード集合が変化した場合でも、 nodemask をマッピング
              し直すことはない。

       MPOL_F_RELATIVE_NODES (Linux-2.6.26 以降)
              空でない nodemask は、そのプロセスの現在の CPU 集合で許可されているノード  ID  集合
              における相対的なノード ID である。

       nodemask  は、最大で maxnode ビットから構成されるノードのビットマスクを指す。 ビットマスク
       の大きさは、直近の sizeof(unsigned long)  の倍数に切り上げられるが、カーネルが使用するのは
       maxnode 個までのビットだけである。 NULL 値の nodemask もしくは値が 0 の maxnode はノードの
       空集合を表す。 maxnode の値が 0 の場合、 nodemask 引き数は無視される。 nodemask が必須の場
       面では、 nodemask に、オンラインで、そのプロセスの現在の CPU 集合コンテキストで 許可されて
       おり (MPOL_F_STATIC_NODES モードフラグが指定されていない場合)、メモリがあるノードが 少なく
       とも一つ入っていなければならない。

       モード  MPOL_DEFAULT はデフォルトではないプロセスのメモリポリシーを削除し、 デフォルトの動
       作に戻すことを指定するものである。 mbind()  経由で、あるメモリ領域に対して MPOL_DEFAULT が
       適用された場合、プロセスのデフォルトポリシーを使用することを意味する。  プロセスのデフォル
       トポリシーは、 set_mempolicy(2) で変更されているかもしれない。  プロセスのポリシーのモード
       も  MPOL_DEFAULT  の場合、システム全体のデフォルトポリシーが使用される。  システム全体のデ
       フォルトポリシーでは、割り当てのきっかけとなった CPU  のノードからページの割り当てを行う。
       MPOL_DEFAULT では、引き数 nodemaskmaxnode にノードの空集合を指定しなければならない。

       MPOL_BIND  は厳しいポリシーで、メモリ割り当ては  nodemask に指定されたノードに限定される。
       他のノードへの割り当ては行われない。 nodemask に 2  個以上のノードが指定された場合、ページ
       の割り当ては ノード ID が数字として最小のノードから開始され、 そのノードに空きメモリがなく
       なるまでそのノードから ページ割り当てが行われる。そのノードに空きメモリがなくなったら、 次
       に小さなノード  ID を持つノードからページ割り当てが行われる。 これを、 nodemask で指定され
       た全てのノードで空きメモリがなくなるまで繰り返す。 nodemask で指定された以外のノードからは
       ページの割り当ては行われない。

       MPOL_INTERLEAVE は、メモリ割り当てが nodemask に指定されたノード間で交互に行われることを指
       定するものである。  このポリシーでは、複数のノードにページを広げて配置し、これらのページへ
       の メモリアクセスを分散することで、遅延ではなく、帯域を最適化する。 効果を得るには、メモリ
       領域をある程度大きくすべきであり、 メモリアクセスのパターンがかなり均一な場合でも 少なくと
       も  1MB 以上にすべきである。 このモードでも、一つのページへのアクセスに関しては 一つのノー
       ドのメモリ帯域が上限となることは変わりない。

       MPOL_PREFERRED は、割り当て時に優先されるノードを設定する。 カーネルはまず優先ノードにペー
       ジ割り当てを行おうとし、  優先ノードに空きメモリが少ない場合に他のノードに割り当てを行う。
       nodemask に複数のノード ID が指定された場合は、 nodemask  内の最初のノードが優先ノードとし
       て選択される。  引き数  nodemask, maxnode で空集合が指定された場合は、割り当てのきっかけと
       なった CPU のノードに メモリ割り当てが行われる。 mbind(2) で、あるメモリ領域に対して「ロー
       カルからの割り当て (local allocation)」を 指定する方法はこれしかない。

       flagsMPOL_MF_STRICT が 指定され、 modeMPOL_DEFAULT でない場合、 指定されたポリシー
       に従っていないメモリ領域にページが存在すると、 mbind()  はエラー EIO で失敗する。

       flagsMPOL_MF_MOVE が指定されると、カーネルはそのメモリ領域内の既存の全てのページを移動
       し、 指定されたポリシーに従うようにしようとする。 他のプロセスと共有されているページは移動
       されない。 MPOL_MF_STRICT も指定された場合、移動できなかったページがあると、 mbind()  はエ
       ラー EIO で失敗する。

       flagsMPOL_MF_MOVE_ALL が指定されると、カーネルはそのメモリ領域内の既存の全てのページ
       を、 他のプロセスがページを使用しているかどうかに関わらず移動する。 このフラグを使用するに
       は、呼び出し元のプロセスは特権  (CAP_SYS_NICE) を持っていなければならない。 MPOL_MF_STRICT
       も指定された場合、移動できなかったページがあると、 mbind()  はエラー EIO で失敗する。

返り値

       成功すると、 mbind()  は 0 を返す。エラーの場合、-1 を返し、 errno  にエラーを示す値を設定
       する。

エラー

       EFAULT nodemaskmaxnode で指定されたメモリ領域の一部または全部が、 呼び出し元がアクセス
              可能なアドレス空間外を指している。 もしくは指定されたメモリ領域にマップされていない
              部分 (unmapped hole)  があった、

       EINVAL flagsmode に不正な値が指定された。 addr + lenaddr より小さい。 addr がシス
              テムのページサイズの倍数になっていない。 または modeMPOL_DEFAULTnodemask に
              空でない集合が指定された。  modeMPOL_BINDMPOL_INTERLEAVEnodemask が空で
              あった。 maxnode がカーネルに適用された上限を超えている。 nodemask に、サポートされ
              ている最大ノード  ID より大きいノードが指定された。 nodemask に、オンラインで、かつ
              そのプロセスの現在の CPU 集合コンテキストで  許可されているノードが一つも含まれてい
              ないか、       メモリを含むノードが一つも指定されていない。      mode      引き数に
              MPOL_F_STATIC_NODESMPOL_F_RELATIVE_NODES の両方が指定された。

       EIO    MPOL_MF_STRICT が指定されたが、このポリシーに従っていないノードに  すでにページが存
              在していた。 もしくは MPOL_MF_MOVEMPOL_MF_MOVE_ALL が指定されたが、カーネルが指
              定された領域内の既存の全てのページを 移動することができなかった。

       ENOMEM 利用可能なカーネルメモリが十分でなかった。

       EPERM  flags 引き数に MPOL_MF_MOVE_ALL  フラグが含まれているが、呼び出し元が  CAP_SYS_NICE
              特権を持たない。

バージョン

       mbind()  システムコールはバージョン 2.6.7 で Linux カーネルに追加された。

準拠

       このシステムコールは Linux 固有である。

注意

       ライブラリによるサポートについては numa(7)  を参照。

       NUMA  ポリシーは、 MAP_SHARED フラグが指定されてマップされたメモリマップ・ファイルの領域で
       は サポートされていない。

       MPOL_DEFAULT モードは、  mbind()   と  set_mempolicy(2)   で異なる効果を持つことができる。
       set_mempolicy(2)   で MPOL_DEFAULT が指定された場合、そのプロセスのポリシーはシステムの デ
       フォルトポリシー、すなわちローカルからの割り当て、に戻る。 mbind()  を使ってメモリのある領
       域に  MPOL_DEFAULT  が指定された場合、その範囲に対してそれ以降に行われるページの割り当てで
       は、 set_mempolicy(2) で設定したのと同じように、そのプロセスのポリシーが適用される。  これ
       により、特定のメモリ領域についてだけ明示的なポリシーを削除し、  デフォルトのポリシーに「戻
       す」ことができる。    あるメモリ領域に対して「ローカルからの割り当て」を明示的に設定するに
       は、  modeMPOL_PREFERRED を指定し、 nodemask に空集合のノードを指定すればよい。 この方
       法は set_mempolicy(2)  でも通用する。

       2.6.16 でヒュージページ・ポリシーへの対応が追加された。 インターリーブ・ポリシーがヒュージ
       ページのマッピングで効果を持つには、  ポリシーが適用されるメモリが数十メガバイト以上である
       必要がある。

       MPOL_MF_STRICT はヒュージページのマッピングでは無視される。

       MPOL_MF_MOVEMPOL_MF_MOVE_ALL は Linux 2.6.16 以降でのみ利用可能である。

関連項目

       get_mempolicy(2), getcpu(2),  mmap(2),  set_mempolicy(2),  shmat(2),  shmget(2),  numa(3),
       cpuset(7), numa(7), numactl(8)

この文書について

       この  man ページは Linux man-pages プロジェクトのリリース 3.54 の一部 である。プロジェクト
       の説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。