release/man2/futex.2

   1 .\" Page by b.hubert
   2 .\"
   3 .\" %%%LICENSE_START(FREELY_REDISTRIBUTABLE)
   4 .\" may be freely modified and distributed
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\" Niki A. Rahimi (LTC Security Development, narahimi@us.ibm.com)
   8 .\" added ERRORS section.
   9 .\"
  10 .\" Modified 2004-06-17 mtk
  11 .\" Modified 2004-10-07 aeb, added FUTEX_REQUEUE, FUTEX_CMP_REQUEUE
  12 .\"
  13 .\" FIXME
  14 .\" See also https://bugzilla.kernel.org/show_bug.cgi?id=14303
  15 .\" 2.6.14 adds FUTEX_WAKE_OP
  16 .\"     commit 4732efbeb997189d9f9b04708dc26bf8613ed721
  17 .\"     Author: Jakub Jelinek <jakub@redhat.com>
  18 .\"     Date:   Tue Sep 6 15:16:25 2005 -0700
  19 .\"
  20 .\" FIXME
  21 .\" 2.6.18 adds (Ingo Molnar) priority inheritance support:
  22 .\" FUTEX_LOCK_PI, FUTEX_UNLOCK_PI, and FUTEX_TRYLOCK_PI.  These need
  23 .\" to be documented in the manual page.  Probably there is sufficient
  24 .\" material in the kernel source file Documentation/pi-futex.txt.
  25 .\"     commit c87e2837be82df479a6bae9f155c43516d2feebc
  26 .\"     Author: Ingo Molnar <mingo@elte.hu>
  27 .\"     Date:   Tue Jun 27 02:54:58 2006 -0700
  28 .\"
  29 .\"     commit e2970f2fb6950183a34e8545faa093eb49d186e1
  30 .\"     Author: Ingo Molnar <mingo@elte.hu>
  31 .\"     Date:   Tue Jun 27 02:54:47 2006 -0700
  32 .\"
  33 .\"     See Documentation/futex-requeue-pi.txt
  34 .\"
  35 .\" FIXME
  36 .\" 2.6.25 adds FUTEX_WAKE_BITSET, FUTEX_WAIT_BITSET
  37 .\"     commit cd689985cf49f6ff5c8eddc48d98b9d581d9475d
  38 .\"     Author: Thomas Gleixner <tglx@linutronix.de>
  39 .\"     Date:   Fri Feb 1 17:45:14 2008 +0100
  40 .\"
  41 .\" FIXME
  42 .\" 2.6.31 adds FUTEX_WAIT_REQUEUE_PI, FUTEX_CMP_REQUEUE_PI
  43 .\"     commit 52400ba946759af28442dee6265c5c0180ac7122
  44 .\"     Author: Darren Hart <dvhltc@us.ibm.com>
  45 .\"     Date:   Fri Apr 3 13:40:49 2009 -0700
  46 .\"
  47 .\"     commit ba9c22f2c01cf5c88beed5a6b9e07d42e10bd358
  48 .\"     Author: Darren Hart <dvhltc@us.ibm.com>
  49 .\"     Date:   Mon Apr 20 22:22:22 2009 -0700
  50 .\"
  51 .\"     See Documentation/futex-requeue-pi.txt
  52 .\"
  53 .\"*******************************************************************
  54 .\"
  55 .\" This file was generated with po4a. Translate the source file.
  56 .\"
  57 .\"*******************************************************************
  58 .TH FUTEX 2 2013\-07\-30 Linux "Linux Programmer's Manual"
  59 .SH 名前
  60 futex \- 高速ユーザ空間ロック
  61 .SH 書式
  62 .nf
  63 .sp
  64 \fB#include <linux/futex.h>\fP
  65 \fB#include <sys/time.h>\fP
  66 .sp
  67 \fBint futex(int *\fP\fIuaddr\fP\fB, int \fP\fIop\fP\fB, int \fP\fIval\fP\fB, const struct timespec *\fP\fItimeout\fP\fB,\fP
  68 .br
  69 .\" int *? void *? u32 *?
  70 \fB          int *\fP\fIuaddr2\fP\fB, int \fP\fIval3\fP\fB);\fP
  71 .fi
  72 .SH 説明
  73 .PP
  74 \fBfutex\fP()  システムコールは、 指定したアドレスの値が変更されるのをプログラムが待つ手段や 特定のアドレスに対して待機中のプロセスを
  75 wake (起床) させる手段を提供する (プロセスが異なれば同じメモリに対するアドレスも同じではないかもしれないが、
  76 カーネルは異なる位置にマップされた同じメモリを \fBfutex\fP()  で使えるよう内部でマップする)。 通常は、このシステムコールは
  77 \fBfutex\fP(7)  に書かれているように、 共有メモリ中のロックが競合する場合の処理を実装するのに用いられる。
  78 .PP
  79 \fBfutex\fP(7)  の操作がユーザ空間で競合なく完了しなかった場合、 カーネルに仲裁させるためにシステムコールを呼ぶ必要がある。
  80 仲裁というのは、呼び出しプロセスを sleep (起床待ち) させたり、反対に 待ちプロセスを wake させたりすることを意味する。
  81 .PP
  82 この関数を呼び出すプロセスは \fBfutex\fP(7)  に記述されているセマンティクスに忠実であることが要求される。
  83 このセマンティクスには移植不可能なアセンブリ命令を書くことが含まれる。 このことは言い換えると futex
  84 のユーザのほとんどは実際はライブラリの作者であり、 一般アプリケーションの開発者ではないということである。
  85 .PP
  86 \fIuaddr\fP 引き数は、カウンタを格納する、 アラインメントの揃った int 型変数を指している必要がある。 実行する操作は \fIop\fP
  87 引き数を介して、値 \fIval\fP とともに渡される。
  88 .PP
  89 現在のところ 5 つの操作が定義されている:
  90 .TP
  91 \fBFUTEX_WAIT\fP
  92 この操作は futex アドレス \fIuaddr\fP に指定された値 \fIval\fP がまだ格納されているかどうかを不可分操作で検証し、 sleep 状態で
  93 この futex アドレスに対して \fBFUTEX_WAKE\fP が実行されるのを待つ。 \fItimeout\fP 引き数が NULL でない場合、その内容は
  94 待ち時間の最大値を表す。NULL の場合は無限大を表す。 引き数 \fIuaddr2\fP と \fIval3\fP は無視される。
  95
  96 \fBfutex\fP(7)  に照らし合わせると、この呼び出しは カウントのデクリメントで負の値 (競合を表す) になった場合に実行され、
  97 別のプロセスがその futex を解放し \fBFUTEX_WAKE\fP の操作を実行するまで sleep する。
  98 .TP
  99 \fBFUTEX_WAKE\fP
 100 この操作では指定した futex アドレスに対して待ち状態の (すなわち \fBFUTEX_WAIT\fP 中の) 最大 \fIval\fP 個のプロセスを
 101 wake させる。 引き数 \fItimeout\fP, \fIuaddr2\fP, \fIval3\fP は無視される。
 102
 103 \fBfutex\fP(4) に照らし合わせると、 この操作は カウントのインクリメントで待ちプロセスがあると判明し、 futex 値が 1 に設定された
 104 (利用可能であることを表す) 場合に実行される。
 105 .TP
 106 \fBFUTEX_FD\fP (Linux 2.6.25 以前)
 107 .\" , suitable for .BR poll (2).
 108 非同期の wake に対応するため、この操作はファイルディスクリプタを futex に 関連づける。 別のプロセスが \fBFUTEX_WAKE\fP
 109 を実行すると、プロセスは \fIval\fP で渡されたシグナル番号のシグナルを受信する。 呼び出しプロセスは使用後、返されたファイルディスクリプタを
 110 クローズしなければならない。 引き数 \fItimeout\fP, \fIuaddr2\fP, \fIval3\fP は無視される。
 111
 112 競合状態を防止するため、呼び出しプロセスは \fBFUTEX_FD\fP が返ったあと futex が up されたかどうかを確認しなければならない。
 113
 114 \fBFUTEX_FD\fP はもともと競合が起きやすかったため、 Linux 2.6.26 以降で削除されている。
 115 .TP
 116 \fBFUTEX_REQUEUE\fP (Linux 2.5.70 以降)
 117 この操作は、 \fBFUTEX_WAKE\fP が使われていて、かつ wake されている全てのプロセスが 他の futex を取得する必要がある場合に、
 118 「獣の群れの暴走 (thundering herd)」効果を避けるために導入された。 この呼び出しは \fIval\fP 個のプロセスを wake
 119 し、アドレス \fIuaddr2\fP で futex を待っている他の全てのプロセスを再度キューにいれる。 引き数 \fItimeout\fP と \fIval3\fP
 120 は無視される。
 121 .TP
 122 \fBFUTEX_CMP_REQUEUE\fP (Linux 2.6.7 以降)
 123 故意に \fBFUTEX_REQUEUE\fP を使う場合に競合が起こるため、 \fBFUTEX_CMP_REQUEUE\fP が導入された。これは
 124 \fBFUTEX_REQUEUE\fP と似ているが、場所 \fIuaddr\fP に値 \fIval3\fP がまだ保持されているかを最初にチェックする。
 125 保持されていない場合、操作はエラー \fBEAGAIN\fP で失敗する。引き数 \fItimeout\fP は無視される。
 126 .SH 返り値
 127 .PP
 128 エラーの場合、全ての操作で \-1 が返り、 \fIerrno\fP
 129 がエラーの内容を示す値に設定される。成功時の返り値は操作によって異なり、以下のリストに書かれている通りである。
 130 .TP
 131 \fBFUTEX_WAIT\fP
 132 そのプロセスが \fBFUTEX_WAKE\fP により wake された場合 0 を返す。発生する可能性があるエラーについては「エラー」の節を参照。
 133 .TP
 134 \fBFUTEX_WAKE\fP
 135 wake したプロセスの数を返す。
 136 .TP
 137 \fBFUTEX_FD\fP
 138 futex に関連づけられた新たなファイルディスクリプタを返す。
 139 .TP
 140 \fBFUTEX_REQUEUE\fP
 141 wake したプロセスの数を返す。
 142 .TP
 143 \fBFUTEX_CMP_REQUEUE\fP
 144 wake したプロセスの数を返す。
 145 .SH エラー
 146 .TP
 147 \fBEACCES\fP
 148 futex メモリに読み込みアクセス権がなかった。
 149 .TP
 150 \fBEAGAIN\fP
 151 \fBFUTEX_CMP_REQUEUE\fP で、\fIuaddr\fP が指す値が期待値 \fIval3\fP と異なる状況が検出された。
 152 (これは競合を示しているかもしれない。この場合は安全な \fBFUTEX_WAKE\fP を使うこと。)
 153 .TP
 154 \fBEFAULT\fP
 155 ユーザ空間から \fItimeout\fP の情報を取得する際にエラーが発生した。
 156 .TP
 157 \fBEINTR\fP
 158 \fBFUTEX_WAIT\fP 操作がシグナル (\fBsignal\fP(7) 参照) もしくは偽の wakeup により中断された。
 159 .TP
 160 \fBEINVAL\fP
 161 無効な引き数。
 162 .TP
 163 \fBENFILE\fP
 164 オープンされているファイルの総数がシステムの制限に達した。
 165 .TP
 166 \fBENOSYS\fP
 167 \fIop\fP に無効な操作が指定された。
 168 .TP
 169 \fBETIMEDOUT\fP
 170 \fBFUTEX_WAIT\fP 操作でタイムアウトが発生した。
 171 .TP
 172 \fBEWOULDBLOCK\fP
 173 \fIop\fP が \fBFUTEX_WAIT\fP で、その呼び出しにおいて \fIuaddr\fP が指す値が期待値 \fIval\fP と異なっていた。
 174 .SH バージョン
 175 .PP
 176 最初の futex 対応は Linux 2.5.7 で組み込まれたが、 上記のセマンティクスとは異なる。 4
 177 つの引き数のここに書かれているセマンティクスを持つ システムコールは、Linux 2.5.40 で導入された。 Linux 2.5.70 では 1
 178 つの引き数が追加された。 Linux 2.6.7 では 6 番目の引き数が追加された。 これは汚く、s390 アーキテクチャ上の特別のものである。
 179 .SH 準拠
 180 このシステムコールは Linux 固有である。
 181 .SH 注意
 182 .PP
 183 .\" .SH "AUTHORS"
 184 .\" .PP
 185 .\" Futexes were designed and worked on by
 186 .\" Hubertus Franke (IBM Thomas J. Watson Research Center),
 187 .\" Matthew Kirkwood, Ingo Molnar (Red Hat)
 188 .\" and Rusty Russell (IBM Linux Technology Center).
 189 .\" This page written by bert hubert.
 190 繰り返すが、裸の futex はエンドユーザが容易に使うことのできる概念として 意図されたものではない (glibc
 191 にはこのシステムコールに対するラッパー関数はない)。 実装者は、アセンブリ言語に慣れており、以下に挙げる futex ユーザ空間ライブラリの
 192 ソースを読み終えていることが要求される。
 193 .SH 関連項目
 194 \fBrestart_syscall\fP(2), \fBfutex\fP(7)
 195 .PP
 196 \fIFuss, Futexes and Furwocks: Fast Userlevel Locking in Linux\fP (proceedings
 197 of the Ottawa Linux Symposium 2002), online at
 198 .br
 199 .UR http://kernel.org\:/doc\:/ols\:/2002\:/ols2002\-pages\-479\-495.pdf
 200 .UE
 201 .PP
 202 futex の使用例ライブラリ, futex\-*.tar.bz2
 203 .br
 204 .UR ftp://ftp.nl.kernel.org\:/pub\:/linux\:/kernel\:/people\:/rusty/
 205 .UE
 206 .SH この文書について
 207 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 208 である。プロジェクトの説明とバグ報告に関する情報は
 209 http://www.kernel.org/doc/man\-pages/ に書かれている。