名前

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

書式

       #include <stdio.h>

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

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

       上記の全ての関数:
           /* Since glibc 2.24: */ _POSIX_C_SOURCE >= 199309L
               || /* Glibc versions <= 2.23: */ _POSIX_C_SOURCE
               || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_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 以外の値を返す。

エラー

       なし。

属性

       この節で使用されている用語の説明については、 attributes(7) を参照。

       ┌──────────────────────────────┬───────────────┬─────────┐
       │インターフェース              │ 属性          │ 値      │
       ├──────────────────────────────┼───────────────┼─────────┤
       │flockfile(),  ftrylockfile(), │ Thread safety │ MT-Safe │
       │funlockfile()                 │               │         │
       └──────────────────────────────┴───────────────┴─────────┘

準拠

       POSIX.1-2001, POSIX.1-2008.

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

関連項目

       unlocked_stdio(3)

この文書について

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

                                            2020-06-09                               FLOCKFILE(3)