FLOCKFILE(3)

名前
flockfile, ftrylockfile, funlockfile - 標準入出力 FILE のロックを行う

書式
#include <stdio.h>

void flockfile(FILE *filehandle);
int ftrylockfile(FILE *filehandle);
void funlockfile(FILE *filehandle);

glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

上記の全ての関数:
    _POSIX_C_SOURCE >= 1 || _XOPEN_SOURCE || _BSD_SOURCE || _SVID_SOURCE || _POSIX_SOURCE

説明
標準入出力関数はスレッドセーフである。これは、各 FILE オブジェクトに対し、ロック数 (lockcount) と (ロック数が 0 でない場合は) 所有者スレッド (owner thread) を管理することで実現される。 ライブラリの呼び出しが行われる毎に、標準入出力関数は FILE オブジェクトが他のスレッドによってロックされていない状態になるまで待ち、 FILE オブジェクトをロックし、要求されて入出力を行い、 オブジェクトのロックを解除する。

(注: このロックは、 flock(2) や lockf(3) といった関数が行うロックとは全く無関係である。)

これらのことはすべて C プログラマには見えない部分で行われるが、 より細かい制御ができた方がよい理由が2つあるだろう。一つは、一つのスレッドが 行う一連の入出力動作は一緒に行われ、他のスレッドの入出力によって中断されない 方がよいということであろう。もう一つは、効率を大きく上げるためには ロックのオーバヘッドを避ける必要があるということであろう。

この目的を実現するために、 FILE オブジェクトのロック、一連の入出力動作の実行、 ロックの解除をスレッドが明示的に指示することができる。 これにより、他のスレッドが途中で入出力を行うのを防止する。 このようなことを行う理由が効率の向上であるならば、 ロックを行わないバージョンの標準入出力関数を使うこともできる。 例えば、 getc(3) や putc(3) の代わりに getc_unlocked(3) や putc_unlocked(3) を使用する。

flockfile() 関数は、*filehandle が他のスレッドにロックされていな い状態になるまで待ったのち、現在のスレッドを *filehandle のオーナに設 定し、ロック数を加算する。

funlockfile() 関数は、ロック数を減算する。

ftrylockfile() 関数は flockfile() のブロッキングを行わない バージョンである。他のスレッドが *filehandle をロックしている時は 何も行わず、そうでない場合は *filehandle の所有権を獲得し、 ロック数を加算する。

返り値
ftrylockfile() 関数はロックに成功すると 0 を返し、 失敗した場合は 0 以外の値を返す。

エラー
なし。

属性

  マルチスレッディング (pthreads(7) 参照)
関数 flockfile(), ftrylockfile(), funlockfile() はスレッドセーフである。

準拠
POSIX.1-2001.

可用性
_POSIX_THREAD_SAFE_FUNCTIONS が定義されているときにこれらの関数を使用することができる。

関連項目
unlocked_stdio(3)

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