lockf
Section: C Library Functions (3)
Updated: 2026-02-08
Index
JM Home Page
roff page
名前
lockf - オープンされたファイルに対する POSIX ロックの適用・テスト・解除を行う
ライブラリ
標準 C ライブラリ (libc,~-lc)
書式
#include <unistd.h>
int lockf(int fd, int op, off_t size);
glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):
lockf():
_XOPEN_SOURCE >= 500
|| /* glibc >= 2.19: */ _DEFAULT_SOURCE
|| /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
説明
Apply, test, or remove a POSIX lock on a section of an open file. The file
is specified by fd, a file descriptor open for writing, the action by
op, and the section consists of byte positions pos..pos+size-1
if size is positive, and pos-size..pos-1 if size is negative,
where pos is the current file position, and if size is zero, the
section extends from the current file position to infinity, encompassing the
present and future end-of-file positions. In all cases, the section may
extend past current end-of-file.
Linux では、 lockf() は単に fcntl(2) のロックへのインターフェースである。 多くの他のシステムで
lockf() はこのように実装されているが、 POSIX.1 では lockf() と fcntl(2)
のロックとの関係は規定されていない。 おそらく、移植性が必要なアプリケーションでは、 lockf() と fcntl(2)
のロックを混ぜて呼び出すのは避けるべきであろう。
有効なオプションを以下に挙げる。
- F_LOCK
-
ファイルの指定されたセクションに排他ロックを設定する。 そのセクション (の一部) が既にロックされていた場合、
前のロックが解除されるまで関数の呼び出しがブロックされる。 このセクションが前にロックされているセクションと重なった場合、 2
つのセクションは結合される。 ロックを保持しているプロセスが、 そのファイルのファイルディスクリプターをクローズすると、 ファイルロックは解放される。
子プロセスはロックを継承しない。
- F_TLOCK
-
F_LOCK と同様であるが、ファイルが既にロックされている場合、 関数の呼び出しはブロックを行わずにエラーを返す。
- F_ULOCK
-
ファイルの指定されたセクションのロックを解除する。 これによりロックされたセクションが 2 つに分割されるかもしれない。
- F_TEST
-
次のようにロックのテストをする。 指定されたセクションがロックされていないか、 このプロセスによりロックされている場合、0 を返す。
他のプロセスがロックを保持している場合、-1 を返し、 errno を EAGAIN (いくつかの他のシステムでは EACCES)
に設定する。
返り値
成功すると、0 を返す。 エラーの場合、-1 を返し、 errno にエラーを示す値を設定する。
エラー
- EACCES か EAGAIN
-
ロックされたファイルに対して、 F_TLOCK または F_TEST が指定されている。
または、ファイルが他のプロセスによりメモリーマップされており、 指定された操作が禁止されている。
- EBADF
-
fd is not an open file descriptor; or op is F_LOCK or F_TLOCK
and fd is not a writable file descriptor.
- EDEADLK
-
op was F_LOCK and this lock operation would cause a deadlock.
- EINTR
-
ロックの獲得を待っている間に、ハンドラーにより捕捉されたシグナルを 受信し、 flock() が中断された。 signal(7) 参照。
- EINVAL
-
An invalid operation was specified in op.
- ENOLCK
-
非常に多くのセグメントロックが開かれ、ロックテーブルが一杯である。
属性
この節で使用されている用語の説明については、 attributes(7) を参照。
| インターフェース | 属性 | 値
|
lockf()
| Thread safety | MT-Safe
|
標準規格
POSIX.1-2008.
歴史
POSIX.1-2001, SVr4.
関連項目
fcntl(2), flock(2)
Linux カーネルソースの Documentation/filesystems ディレクトリにある locks.txt と
mandatory-locking.txt (以前のカーネルでは、これらのファイルは Documentation ディレクトリ直下にあり、
mandatory-locking.txt は mandatory.txt という名前であった。)
Index
- 名前
-
- ライブラリ
-
- 書式
-
- 説明
-
- 返り値
-
- エラー
-
- 属性
-
- 標準規格
-
- 歴史
-
- 関連項目
-
This document was created by
man2html,
using the manual pages.