リナックスコマンド

lockfのヘルプ・マニュアル

日本語 英語

• help
• man

lockf --help

man lockf

LOCKF(3) Linux Programmer’s Manual LOCKF(3) 名前 lockf - 開いているファイルに対して POSIX ロックを適用・テスト・解除する 。 書式 #include int lockf(int fd, int cmd, off_t len); glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照): lockf(): _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE >= 500 説明 開いているファイルのセクションに対して、 POSIX ロックの適用・テスト・解 除 をする。ファイルは fd で指定される。これは書き込みのためにオープンし たファイルディスクリプタである。アクションは cmd で指定される。 pos を 現 在 の フ ァイル位置とすると、 len が正の場合、セクションはバイト位置 pos..pos+len-1 である。 len が負の場合、セクションはバイ ト 位 置 pos- len..pos-1 である。 len が 0 の場合、セクションは現在のファイル位置から 無限大までとなる (つまり現在の、あるいは変更された場合は将来の、ファ イ ル終端位置まで)。どの場合においても、セクションは以前のファイル終端より も拡大されうる。 Linux では、この関数は単に 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 が開いているファイルのディスクリプタではない。 EDEADLK コマンドが T_LOCK であり、このロック操作がデッドロックを引き起こ している。 EINVAL fd に無効な操作が指定された。 ENOLCK 非常に多くのセグメントロックが開かれ、ロックテーブルが溢れた。 準拠 SVr4, POSIX.1-2001. 関連項目 fcntl(2), flock(2) カーネルソースの Documentation ディレクトリにある locks.txt と manda- tory-locking.txt (カーネル 2.6.23 以前では mandatory.txt)。 GNU 2009-03-30 LOCKF(3)

LOCKF(3) Linux Programmer’s Manual LOCKF(3) NAME lockf - apply, test or remove a POSIX lock on an open file SYNOPSIS #include int lockf(int fd, int cmd, off_t len); Feature Test Macro Requirements for glibc (see feature_test_macros(7)): lockf(): _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE >= 500 DESCRIPTION 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 cmd, and the section consists of byte positions pos..pos+len-1 if len is positive, and pos-len..pos-1 if len is negative, where pos is the current file position, and if len 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. On Linux, lockf() is just an interface on top of fcntl(2) locking. Many other systems implement lockf() in this way, but note that POSIX.1-2001 leaves the relationship between lockf() and fcntl(2) locks unspecified. A portable application should probably avoid mixing calls to these interfaces. Valid operations are given below: F_LOCK Set an exclusive lock on the specified section of the file. If (part of) this section is already locked, the call blocks until the previous lock is released. If this section overlaps an ear- lier locked section, both are merged. File locks are released as soon as the process holding the locks closes some file descriptor for the file. A child process does not inherit these locks. F_TLOCK Same as F_LOCK but the call never blocks and returns an error instead if the file is already locked. F_ULOCK Unlock the indicated section of the file. This may cause a locked section to be split into two locked sections. F_TEST Test the lock: return 0 if the specified section is unlocked or locked by this process; return -1, set errno to EAGAIN (EACCES on some other systems), if another process holds a lock. RETURN VALUE On success, zero is returned. On error, -1 is returned, and errno is set appropriately. ERRORS EACCES or EAGAIN The file is locked and F_TLOCK or F_TEST was specified, or the operation is prohibited because the file has been memory-mapped by another process. EBADF fd is not an open file descriptor. EDEADLK The command was T_LOCK and this lock operation would cause a deadlock. EINVAL An invalid operation was specified in fd. ENOLCK Too many segment locks open, lock table is full. CONFORMING TO SVr4, POSIX.1-2001. SEE ALSO fcntl(2), flock(2) There are also locks.txt and mandatory-locking.txt in the kernel source directory Documentation/filesystems. (On older kernels, these files are directly under the Documentation/ directory, and mandatory-lock- ing.txt is called mandatory.txt.) COLOPHON This page is part of release 3.22 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. GNU 2009-07-25 LOCKF(3)