[linuxjm/LDP_man-pages.git] / draft / man2 / fcntl.2

.\" t
.\" This manpage is Copyright (C) 1992 Drew Eckhardt;
.\" and Copyright (C) 1993 Michael Haardt, Ian Jackson;
.\" and Copyright (C) 1998 Jamie Lokier;
.\" and Copyright (C) 2002-2010, 2014 Michael Kerrisk;
.\" and Copyright (C) 2014 Jeff Layton
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" %%%LICENSE_END
.\"
.\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
.\" Modified 1995-09-26 by Andries Brouwer <aeb@cwi.nl>
.\" and again on 960413 and 980804 and 981223.
.\" Modified 1998-12-11 by Jamie Lokier <jamie@imbolc.ucc.ie>
.\" Applied correction by Christian Ehrhardt - aeb, 990712
.\" Modified 2002-04-23 by Michael Kerrisk <mtk.manpages@gmail.com>
.\"     Added note on F_SETFL and O_DIRECT
.\"     Complete rewrite + expansion of material on file locking
.\"     Incorporated description of F_NOTIFY, drawing on
.\"             Stephen Rothwell's notes in Documentation/dnotify.txt.
.\"     Added description of F_SETLEASE and F_GETLEASE
.\" Corrected and polished, aeb, 020527.
.\" Modified 2004-03-03 by Michael Kerrisk <mtk.manpages@gmail.com>
.\"     Modified description of file leases: fixed some errors of detail
.\"     Replaced the term "lease contestant" by "lease breaker"
.\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
.\"     Added notes on capability requirements
.\" Modified 2004-12-08, added O_NOATIME after note from Martin Pool
.\" 2004-12-10, mtk, noted F_GETOWN bug after suggestion from aeb.
.\" 2005-04-08 Jamie Lokier <jamie@shareable.org>, mtk
.\"     Described behavior of F_SETOWN/F_SETSIG in
.\"     multithreaded processes, and generally cleaned
.\"     up the discussion of F_SETOWN.
.\" 2005-05-20, Johannes Nicolai <johannes.nicolai@hpi.uni-potsdam.de>,
.\"     mtk: Noted F_SETOWN bug for socket file descriptor in Linux 2.4
.\"     and earlier.  Added text on permissions required to send signal.
.\" 2009-09-30, Michael Kerrisk
.\"     Note obsolete F_SETOWN behavior with threads.
.\"     Document F_SETOWN_EX and F_GETOWN_EX
.\" 2010-06-17, Michael Kerrisk
.\"     Document F_SETPIPE_SZ and F_GETPIPE_SZ.
.\"
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.\"
.\" Japanese Version Copyright (c) 1996 Takeshi Ueno
.\" and Copyright (c) 2005, 2006, 2008 Akihiro MOTOKI
.\" Translated 1996-07-03, Takeshi Ueno <tueno@vio.co.jp>
.\" Modified 1998-09-10, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
.\" Modified 1999-08-14, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
.\" Updated & Modified 2001-04-03, Yuichi SATO <ysato@h4.dion.ne.jp>
.\" Updated & Modified 2005-03-15, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\" Updated & Modified 2005-04-22, Akihiro MOTOKI
.\" Updated & Modified 2005-10-14, Akihiro MOTOKI
.\" Updated & Modified 2005-11-19, Akihiro MOTOKI, LDP v2.14
.\" Updated 2006-04-16, Akihiro MOTOKI, LDP v2.29
.\" Updated 2008-02-11, Akihiro MOTOKI, LDP v2.77
.\" Updated 2008-09-19, Akihiro MOTOKI, LDP v3.09
.\" Updated 2010-04-23, Akihiro MOTOKI, LDP v3.24
.\" Updated 2012-05-08, Akihiro MOTOKI <amotoki@gmail.com>
.\" Updated 2013-03-26, Akihiro MOTOKI <amotoki@gmail.com>
.\"
.TH FCNTL 2 2014\-09\-06 Linux "Linux Programmer's Manual"
.SH 名前
fcntl \- ファイルディスクリプタの操作を行う
.SH 書式
.nf
\fB#include <unistd.h>\fP
\fB#include <fcntl.h>\fP
.sp
\fBint fcntl(int \fP\fIfd\fP\fB, int \fP\fIcmd\fP\fB, ... /* \fP\fIarg\fP\fB */ );\fP
.fi
.SH 説明
\fBfcntl\fP()  は、オープンされたファイルディスクリプタ \fIfd\fP に関して下記の操作を行う。操作は \fIcmd\fP によって決まる:

\fBfcntl\fP() はオプションとして第三引き数をとることができる。 第三引き数が必要
かどうかは \fIcmd\fP により決まる。必要な引き数の型は \fIcmd\fP 名の後ろの括弧内で
指定されている (ほとんどの場合、必要な型は \fIint\fP であり、この引き数を表すの
に \fIarg\fP という名前を使っている)。引き数が必要ない場合には \fIvoid\fP が指定さ
れている。

Certain of the operations below are supported only since a particular Linux
kernel version.  The preferred method of checking whether the host kernel
supports a particular operation is to invoke \fBfcntl\fP()  with the desired
\fIcmd\fP value and then test whether the call failed with \fBEINVAL\fP,
indicating that the kernel does not recognize this value.
.SS ファイルディスクリプタの複製
.TP 
\fBF_DUPFD\fP (\fIint\fP)
利用可能なファイルディスクリプタのうち、 \fIarg\fP 以上で最小のものを探し、 \fIfd\fP のコピーとする。これは別の形の \fBdup2\fP(2)
である。 \fBdup2\fP(2)  では指定されたディスクリプタが使われる点が違う。
.IP
成功すると、新しいディスクリプタが返される。
.IP
詳細は \fBdup\fP(2)  を参照のこと。
.TP 
\fBF_DUPFD_CLOEXEC\fP (\fIint\fP; Linux 2.6.24 以降)
\fBF_DUPFD\fP と同様だが、それに加えて複製されたディスクリプタに対して close\-on\-exec フラグをセットする。
このフラグを指定することで、プログラムは \fBFD_CLOEXEC\fP フラグをセットするために \fBfcntl\fP()  の \fBF_SETFD\fP
操作を追加で行う必要がなくなる。 このフラグがなぜ有用かについては、 \fBopen\fP(2)  の \fBO_CLOEXEC\fP の説明を参照のこと。
.SS ファイルディスクリプタフラグ
以下のコマンドを使って、ファイルディスクリプタに関連するフラグ を操作することができる。 現在のところ、定義されているフラグは一つだけである:
\fBFD_CLOEXEC\fP (close\-on\-exec フラグ)。 \fBFD_CLOEXEC\fP ビットが 0 なら、ファイルディスクリプタは
\fBexecve\fP(2)  を行ってもオープンされたままだが、そうでない場合はクローズされる。
.TP 
\fBF_GETFD\fP (\fIvoid\fP)
ファイルディスクリプタフラグを読み出す。 \fIarg\fP は無視される。
.TP 
\fBF_SETFD\fP (\fIint\fP)
ファイルディスクリプタフラグに \fIarg\fP で指定した値を設定する。
.PP
マルチスレッドプログラムでは、 \fBfcntl\fP() の \fBF_SETFD\fP を使って close\-on\-exec フラグを設定するのと同時に、
別のスレッドで \fBexecve\fP(2) と \fBfork\fP(2) を実行することは、競合条件次第では、
そのファイルディスクリプタが子プロセスで実行されるプログラムに意図せず見えてしまうという危険性がある。 詳細とこの問題への対処法については
\fBopen\fP(2) の \fBO_CLOEXEC\fP フラグの議論を参照のこと。
.SS ファイル状態フラグ
.\" or
.\" .BR creat (2),
オープンファイル記述 (open file description) には、 ファイル記述毎に設定される状態フラグがいくつかある。これらのフラグは
\fBopen\fP(2)  によって初期化され、 \fBfcntl\fP(2)  により変更することもできる。これらは、 (\fBdup\fP(2),
\fBfcntl\fP(F_DUPFD), \fBfork\fP(2)  などで) 複製されたファイルディスクリプタ同士は 同じオープンファイル記述を参照する。
そのため、 同じファイル状態フラグが共有される。

ファイル状態フラグとその意味は \fBopen\fP(2)  で説明されている。
.TP 
\fBF_GETFL\fP (\fIvoid\fP)
ファイルのアクセスモードとファイル状態フラグを取得する。
\fIarg\fP は無視される。
.TP 
\fBF_SETFL\fP (\fIint\fP)
ファイル状態フラグに \fIarg\fP で指定された値を設定する。 \fIarg\fP のうち、ファイルのアクセスモード (\fBO_RDONLY\fP,
\fBO_WRONLY\fP, \fBO_RDWR\fP)  とファイル作成フラグ (すなわち \fBO_CREAT\fP, \fBO_EXCL\fP,
\fBO_NOCTTY\fP, \fBO_TRUNC\fP)  に関するビットは無視される。 Linux では、このコマンドで変更できるのは
\fBO_APPEND\fP, \fBO_ASYNC\fP, \fBO_DIRECT\fP, \fBO_NOATIME\fP, \fBO_NONBLOCK\fP
フラグだけである。フラグ \fBO_DSYNC\fP, \fBO_SYNC\fP を変更することはできない。下記の「バグ」を参照。
.SS "Advisory record locking"
Linux implements traditional ("process\-associated") UNIX record locks, as
standardized by POSIX.  For a Linux\-specific alternative with better
semantics, see the discussion of open file description locks below.

\fBF_SETLK\fP, \fBF_SETLKW\fP, \fBF_GETLK\fP は、レコードロックの獲得／解放／テストのために使用する
(レコードロックは、バイト範囲ロック、ファイルセグメントロック、ファイル領域ロックとも呼ばれる)。 三番目の引き数 \fIlock\fP
は、以下に示すフィールドを含む構造体へのポインタである (フィールドの順序は関係なく、構造体に他のフィールドがあってもよい)。
.in +4n
.nf
.sp
struct flock {
    ...
    short l_type;    /* Type of lock: F_RDLCK,
                        F_WRLCK, F_UNLCK */
    short l_whence;  /* How to interpret l_start:
                        SEEK_SET, SEEK_CUR, SEEK_END */
    off_t l_start;   /* Starting offset for lock */
    off_t l_len;     /* Number of bytes to lock */
    pid_t l_pid;     /* PID of process blocking our lock
                        (set by F_GETLK and F_OFD_GETLK) */
    ...
};
.fi
.in
.P
この構造体の \fIl_whence\fP, \fIl_start\fP, \fIl_len\fP フィールドで、ロックを行いたいバイト範囲を指定する。
ファイルの末尾より後ろのバイトをロックすることはできるが、 ファイルの先頭より前のバイトをロックすることはできない。

\fIl_start\fP はロックを行う領域の開始オフセットである。 その意味は \fIl_whence\fP により異なる: \fIl_whence\fP が
\fBSEEK_SET\fP の場合はファイルの先頭からのオフセット、 \fIl_whence\fP が \fBSEEK_CUR\fP
の場合は現在のファイルオフセットからのオフセット、 \fIl_whence\fP が \fBSEEK_END\fP
の場合はファイルの末尾からのオフセットと解釈される。 後ろの２つの場合には、 ファイルの先頭より前にならない範囲で、 \fIl_start\fP
に負の値を指定することができる。

\fIl_len\fP はロックしたいバイト数を示す。 \fIl_len\fP が正の場合、ロックされるバイト範囲は \fIl_start\fP 以上
\fIl_start\fP+\fIl_len\fP\-1 以下となる。 \fIl_len\fP に 0 を指定した場合は特別な意味を持つ: \fIl_whence\fP and
\fIl_start\fP で指定される位置からファイルの末尾までの全てのバイトをロックする
(ファイルがどんなに大きくなったとしてもファイルの末尾までロックする)。

POSIX.1\-2001 では、負の値の \fIl_len\fP をサポートする実装を認めている (必須ではない)。 \fIl_len\fP
が負の場合、ロックされるバイト範囲は \fIl_start\fP+\fIl_len\fP 以上 \fIl_start\fP\-1 以下となる。 この動作はカーネル
2.4.21 以降および 2.5.49 以降の Linux で サポートされている。

\fIl_type\fP フィールドは、ファイルに対して読み出しロック (\fBF_RDLCK\fP)  と書き込みロック (\fBF_WRLCK\fP)  のどちらを
設定するかを指定する。 ファイルのある領域に対して、読み出しロック (共有ロック) を保持できる プロセス数に制限はないが、書き込みロック
(排他ロック) を保持できる のは一つのプロセスだけである。排他ロックを設定すると、(共有ロックか 排他ロックにかかわらず)
他のロックは何も設定できない。 一つのプロセスは、ファイルのある領域に対して一種類のロックしか保持できない。
新規のロックがロックが設定されている領域に対して適用されると、既存のロック は新規のロックの種別に変換される
(新規のロックで指定されたバイト範囲が既存ロックの範囲と一致する場合以外では、 変換の過程で既存のロックの分割、縮小、結合が行われることがある)。
.TP 
\fBF_SETLK\fP (\fIstruct flock *\fP)
Acquire a lock (when \fIl_type\fP is \fBF_RDLCK\fP or \fBF_WRLCK\fP)  or release a
lock (when \fIl_type\fP is \fBF_UNLCK\fP)  on the bytes specified by the
\fIl_whence\fP, \fIl_start\fP, and \fIl_len\fP fields of \fIlock\fP.  If a conflicting
lock is held by another process, this call returns \-1 and sets \fIerrno\fP to
\fBEACCES\fP or \fBEAGAIN\fP.  (The error returned in this case differs across
implementations, so POSIX requires a portable application to check for both
errors.)
.TP 
\fBF_SETLKW\fP (\fIstruct flock *\fP)
\fBF_SETLK\fP と同様だが、こちらではそのファイルに対して衝突するロックが 適用されていた場合に、そのロックが解放されるのを待つ点が異なる。
待っている間にシグナルを受けた場合は、システムコールは中断され、 (シグナルハンドラが戻った直後に) 返り値 \-1 を返す (また \fIerrno\fP に
\fBEINTR\fP が設定される; \fBsignal\fP(7)  参照)。
.TP 
\fBF_GETLK\fP (\fIstruct flock *\fP)
On input to this call, \fIlock\fP describes a lock we would like to place on
the file.  If the lock could be placed, \fBfcntl\fP()  does not actually place
it, but returns \fBF_UNLCK\fP in the \fIl_type\fP field of \fIlock\fP and leaves the
other fields of the structure unchanged.

If one or more incompatible locks would prevent this lock being placed, then
\fBfcntl\fP()  returns details about one of those locks in the \fIl_type\fP,
\fIl_whence\fP, \fIl_start\fP, and \fIl_len\fP fields of \fIlock\fP.  If the conflicting
lock is a traditional (process\-associated) record lock, then the \fIl_pid\fP
field is set to the PID of the process holding that lock.  If the
conflicting lock is an open file description lock, then \fIl_pid\fP is set to
\-1.  Note that the returned information may already be out of date by the
time the caller inspects it.
.P
読み出しロックを適用するには、 \fIfd\fP は読み出し用にオープンされていなければならない。 書き込みロックを適用するには、 \fIfd\fP
は書き込み用にオープンされていなければならない。 読み書き両方のロックを適用するには、読み書き両用で ファイルをオープンしなければならない。

When placing locks with \fBF_SETLKW\fP, the kernel detects \fIdeadlocks\fP,
whereby two or more processes have their lock requests mutually blocked by
locks held by the other processes.  For example, suppose process A holds a
write lock on byte 100 of a file, and process B holds a write lock on byte
200.  If each process then attempts to lock the byte already locked by the
other process using \fBF_SETLKW\fP, then, without deadlock detection, both
processes would remain blocked indefinitely.  When the kernel detects such
deadlocks, it causes one of the blocking lock requests to immediately fail
with the error \fBEDEADLK\fP; an application that encounters such an error
should release some of its locks to allow other applications to proceed
before attempting regain the locks that it requires.  Circular deadlocks
involving more than two processes are also detected.  Note, however, that
there are limitations to the kernel's deadlock\-detection algorithm; see
BUGS.

As well as being removed by an explicit \fBF_UNLCK\fP, record locks are
automatically released when the process terminates.
.P
レコードのロックは \fBfork\fP(2)  で作成された子プロセスには継承されないが、 \fBexecve\fP(2)  の前後では保存される。
.P
\fBstdio\fP(3)  ではバッファリングが行われるので、 stdio 関連の関数ではレコードのロックの使用は回避される; 代わりに
\fBread\fP(2)  や \fBwrite\fP(2)  を使用すること。

The record locks described above are associated with the process (unlike the
open file description locks described below).  This has some unfortunate
consequences:
.IP * 3
.\" (Additional file descriptors referring to the same file
.\" may have been obtained by calls to
.\" .BR open "(2), " dup "(2), " dup2 "(2), or " fcntl ().)
If a process closes \fIany\fP file descriptor referring to a file, then all of
the process's locks on that file are released, regardless of the file
descriptor(s) on which the locks were obtained.  This is bad: it means that
a process can lose its locks on a file such as \fI/etc/passwd\fP or
\fI/etc/mtab\fP when for some reason a library function decides to open, read,
and close the same file.
.IP *
The threads in a process share locks.  In other words, a multithreaded
program can't use record locking to ensure that threads don't simultaneously
access the same region of a file.
.PP
Open file description locks solve both of these problems.
.SS "Open file description locks (non\-POSIX)"
Open file description locks are advisory byte\-range locks whose operation is
in most respects identical to the traditional record locks described above.
This lock type is Linux\-specific, and available since Linux 3.15.  For an
explanation of open file descriptions, see \fBopen\fP(2).

The principal difference between the two lock types is that whereas
traditional record locks are associated with a process, open file
description locks are associated with the open file description on which
they are acquired, much like locks acquired with \fBflock\fP(2).  Consequently
(and unlike traditional advisory record locks), open file description locks
are inherited across \fBfork\fP(2)  (and \fBclone\fP(2)  with \fBCLONE_FILES\fP), and
are only automatically released on the last close of the open file
description, instead of being released on any close of the file.
.PP
Open file description locks always conflict with traditional record locks,
even when they are acquired by the same process on the same file descriptor.

Open file description locks placed via the same open file description (i.e.,
via the same file descriptor, or via a duplicate of the file descriptor
created by \fBfork\fP(2), \fBdup\fP(2), \fBfcntl\fP(2)  \fBF_DUPFD\fP, and so on) are
always compatible: if a new lock is placed on an already locked region, then
the existing lock is converted to the new lock type.  (Such conversions may
result in splitting, shrinking, or coalescing with an existing lock as
discussed above.)

On the other hand, open file description locks may conflict with each other
when they are acquired via different open file descriptions.  Thus, the
threads in a multithreaded program can use open file description locks to
synchronize access to a file region by having each thread perform its own
\fBopen\fP(2)  on the file and applying locks via the resulting file
descriptor.
.PP
As with traditional advisory locks, the third argument to \fBfcntl\fP(),
\fIlock\fP, is a pointer to an \fIflock\fP structure.  By contrast with
traditional record locks, the \fIl_pid\fP field of that structure must be set
to zero when using the commands described below.

The commands for working with open file description locks are analogous to
those used with traditional locks:
.TP 
\fBF_OFD_SETLK\fP (\fIstruct flock *\fP)
Acquire an open file description lock (when \fIl_type\fP is \fBF_RDLCK\fP or
\fBF_WRLCK\fP)  or release an open file description lock (when \fIl_type\fP is
\fBF_UNLCK\fP)  on the bytes specified by the \fIl_whence\fP, \fIl_start\fP, and
\fIl_len\fP fields of \fIlock\fP.  If a conflicting lock is held by another
process, this call returns \-1 and sets \fIerrno\fP to \fBEAGAIN\fP.
.TP 
\fBF_OFD_SETLKW\fP (\fIstruct flock *\fP)
\fBF_OFD_SETLK\fP と同様だが、こちらではそのファイルに対して衝突するロックが
適用されていた場合に、そのロックが解放されるのを待つ点が異なる。 待っている間にシグナルを受けた場合は、システムコールは中断され、
(シグナルハンドラが戻った直後に) 返り値 \-1 を返す (また \fIerrno\fP に \fBEINTR\fP が設定される; \fBsignal\fP(7)
参照)。
.TP 
\fBF_OFD_GETLK\fP (\fIstruct flock *\fP)
On input to this call, \fIlock\fP describes an open file description lock we
would like to place on the file.  If the lock could be placed, \fBfcntl\fP()
does not actually place it, but returns \fBF_UNLCK\fP in the \fIl_type\fP field of
\fIlock\fP and leaves the other fields of the structure unchanged.  If one or
more incompatible locks would prevent this lock being placed, then details
about one of these locks are returned via \fIlock\fP, as described above for
\fBF_GETLK\fP.
.PP
.\" commit 57b65325fe34ec4c917bc4e555144b4a94d9e1f7
.\"
In the current implementation, no deadlock detection is performed for open
file description locks.  (This contrasts with process\-associated record
locks, for which the kernel does perform deadlock detection.)
.SS "強制ロック (mandatory locking)"
\fI警告\fP: Linux の強制ロックの実装は信頼性に欠けるものである。 下記の「バグ」の節を参照のこと。

By default, both traditional (process\-associated) and open file description
record locks are advisory.  Advisory locks are not enforced and are useful
only between cooperating processes.

Both lock types can also be mandatory.  Mandatory locks are enforced for all
processes.  If a process tries to perform an incompatible access (e.g.,
\fBread\fP(2)  or \fBwrite\fP(2))  on a file region that has an incompatible
mandatory lock, then the result depends upon whether the \fBO_NONBLOCK\fP flag
is enabled for its open file description.  If the \fBO_NONBLOCK\fP flag is not
enabled, then the system call is blocked until the lock is removed or
converted to a mode that is compatible with the access.  If the
\fBO_NONBLOCK\fP flag is enabled, then the system call fails with the error
\fBEAGAIN\fP.

強制ロックを使用するためには、ロック対象のファイルが含まれるファイルシステム
と、ロック対象のファイル自身の両方について、強制ロックが有効になっていなけれ ばならない。ファイルシステムについて強制ロックを有効にするには、
\fBmount\fP(8)  に "\-o mand" オプションを渡すか、 \fBmount\fP(2)  に \fBMS_MANDLOCK\fP
フラグを指定する。ファイルについて強制ロックを有効にするには、 そのファイルのグループ実行許可 (group execute permission)
を無効とし、 かつ set\-group\-ID 許可ビットを有効にする (\fBchmod\fP(1)  と \fBchmod\fP(2)  を参照)。

Mandatory locking is not specified by POSIX.  Some other systems also
support mandatory locking, although the details of how to enable it vary
across systems.
.SS シグナルの管理
\fBF_GETOWN\fP, \fBF_SETOWN\fP, \fBF_GETOWN_EX\fP, \fBF_SETOWN_EX\fP, \fBF_GETSIG\fP,
\fBF_SETSIG\fP は、I/O が利用可能になったことを示すシグナルを管理するために使用される。
.TP 
\fBF_GETOWN\fP (\fIvoid\fP)
ファイルディスクリプタ \fIfd\fP のイベントに対するシグナル \fBSIGIO\fP および \fBSIGURG\fP を受けているプロセスのプロセスID
かプロセスグループを (関数の結果として) 返す。 プロセスID は正の値として返される。 プロセスグループID は負の値として返される
(下記のバグの章を参照)。 \fIarg\fP は無視される。
.TP 
\fBF_SETOWN\fP (\fIint\fP)
ファイルディスクリプタ \fIfd\fP のイベント発生を知らせるシグナル \fBSIGIO\fP や \fBSIGURG\fP を受けるプロセスの プロセス ID
またはプロセスグループID を \fIarg\fP で指定された ID に設定する。 プロセスID は正の値として指定し、 プロセスグループID
は負の値として指定する。 ほとんどの場合、呼び出し元プロセスは所有者として自分自身を指定する (つまり \fIarg\fP に \fBgetpid\fP(2)
を指定する)。

.\" From glibc.info:
\fBfcntl\fP()  の \fBF_SETFL\fP コマンドを使用してファイルディスクリプタに \fBO_ASYNC\fP
状態フラグを設定した場合には、そのファイルディスクリプタへの 入出力が可能になる度に \fBSIGIO\fP シグナルが送られる。 \fBF_SETSIG\fP は
\fBSIGIO\fP 以外の別のシグナルの配送を受けられるように するのにも使うことができる。 許可 (permission)
のチェックで失敗した場合には、 シグナルは黙って捨てられる。

\fBF_SETOWN\fP により指定された所有者のプロセス (またはプロセスグループ) に シグナルを送る際には、 \fBkill\fP(2)
に書かれているのと同じ許可のチェックが行われる。 このとき、シグナルを送信するプロセスは \fBF_SETOWN\fP を使ったプロセスである
(但し、下記の「バグ」の章を参照のこと)。

.\" The following appears to be rubbish.  It doesn't seem to
.\" be true according to the kernel source, and I can write
.\" a program that gets a terminal-generated SIGIO even though
.\" it is not the foreground process group of the terminal.
.\" -- MTK, 8 Apr 05
.\"
.\" If the file descriptor
.\" .I fd
.\" refers to a terminal device, then SIGIO
.\" signals are sent to the foreground process group of the terminal.
ファイルディスクリプタがソケットを参照している場合は、 \fBF_SETOWN\fP を使用して、ソケットに帯域外 (out\-of\-band)
データが届いた時に \fBSIGURG\fP シグナルを配送する相手を選択することもできる (\fBSIGURG\fP が送られた場合には \fBselect\fP(2)
がソケットが「特別な状態」にあると報告することだろう)。

バージョン 2.6.11 以前の 2.6.x カーネルでは、以下に示す動作であった。
.RS
.IP
.\" The relevant place in the (2.6) kernel source is the
.\" 'switch' in fs/fcntl.c::send_sigio_to_task() -- MTK, Apr 2005
.\" send_sigurg()/send_sigurg_to_task() bypasses
.\" kill_fasync()/send_sigio()/send_sigio_to_task()
.\" to directly call send_group_sig_info()
.\"     -- MTK, Apr 2005 (kernel 2.6.11)
スレッドグループをサポートしているスレッドライブラリ (例えば NPTL) を 使って動作しているマルチスレッドプロセスで \fBF_SETSIG\fP に
0 以外の値を指定した場合、 \fBF_SETOWN\fP に正の値を渡すと、その意味が違ってくる: プロセス全体を示すプロセスID
ではなく、プロセス内の特定の スレッドを示すスレッドID と解釈される。 したがって、 \fBF_SETSIG\fP
を使う場合には、きちんと結果を受け取るには、 \fBF_SETOWN\fP に渡す値を \fBgetpid\fP(2)  ではなく \fBgettid\fP(2)
の返り値にする必要があるだろう。 (現状の Linux スレッド実装では、メインスレッドのスレッドID は そのスレッドのプロセスID
と同じである。つまり、 シグナルスレッドのプログラムではこの場合 \fBgettid\fP(2)  と \fBgetpid\fP(2)
は全く同じように使うことができる。)  ただし、注意すべき点として、この段落で述べたことは、 ソケットの帯域外データが届いたときに生成される
\fBSIGURG\fP シグナルにはあてはまらない。 このシグナルは常にプロセスかプロセスグループに送られ、 送信先は \fBF_SETOWN\fP
に渡された値にしたがって決められる。
.RE
.IP
上記の動作は、Linux 2.6.12 で図らずも削除され、 元に戻されない予定である。 Linux 2.6.32 以降で、特定のスレッド宛にシグナル
\fBSIGIO\fP と \fBSIGURG\fP を送るには \fBF_SETOWN_EX\fP を使うこと。
.TP 
\fBF_GETOWN_EX\fP (struct f_owner_ex *) (Linux 2.6.32 以降)
直前の \fBF_SETOWN_EX\fP 操作で定義された現在のファイルディスクリプタの所有者設定 を返す。情報は \fIarg\fP
が指す構造体に格納されて返される。構造体は以下の通りである。
.nf
.in +4n

struct f_owner_ex {
    int   type;
    pid_t pid;
};

.in
.fi
\fItype\fP フィールドは、 \fBF_OWNER_TID ,\fP \fBF_OWNER_PID ,\fP \fBF_OWNER_PGRP\fP
のいずれか一つの値となる。 \fIpid\fP フィールドは、スレッド ID、プロセス ID、プロセスグループ ID を 表す正の整数である。詳細は
\fBF_SETOWN_EX\fP を参照。
.TP 
\fBF_SETOWN_EX\fP (struct f_owner_ex *) (Linux 2.6.32 以降)
この操作は \fBF_SETOWN\fP と同様の処理を行う。 この操作を使うと、I/O が利用可能になったことを示すシグナルを、
特定のスレッド、プロセス、プロセスグループに送ることができる ようになる。 呼び出し元は、 \fIarg\fP 経由でシグナルの配送先を指定する。
\fIarg\fP は \fIf_owner_ex\fP 構造体へのポインタである。 \fItype\fP フィールドは以下のいずれかの値を取り、 この値により
\fIpid\fP がどのように解釈されるかが規定される。
.RS
.TP 
\fBF_OWNER_TID\fP
スレッド ID が \fIpid\fP で指定された値のスレッドにそのシグナルを送る (スレッド ID は \fBclone\fP(2)  や
\fBgettid\fP(2)  の呼び出しで返される値である)。
.TP 
\fBF_OWNER_PID\fP
ID が \fIpid\fP で指定された値のプロセスにそのシグナルを送る。
.TP 
\fBF_OWNER_PGRP\fP
ID が \fIpid\fP で指定された値のプロセスグループにそのシグナルを送る。 (\fBF_SETOWN\fP と異なり、プロセスグループ ID
には正の値を指定する点に注意すること。)
.RE
.TP 
\fBF_GETSIG\fP (\fIvoid\fP)
入力や出力が可能になった場合に送るシグナルを (関数の結果として) 返す。 値ゼロは \fBSIGIO\fP を送ることを意味する。 (\fBSIGIO\fP
を含む) 他の値はいずれも、 \fBSIGIO\fP の代わりに送るシグナル番号を表す。 後者の場合、シグナルハンドラを \fBSA_SIGINFO\fP
フラグ付きで設定すれば、ハンドラで追加の情報を得ることができる。 \fIarg\fP は無視される。
.TP 
\fBF_SETSIG\fP (\fIint\fP)
.\"
.\" The following was true only up until 2.6.11:
.\"
.\" Additionally, passing a nonzero value to
.\" .B F_SETSIG
.\" changes the signal recipient from a whole process to a specific thread
.\" within a process.
.\" See the description of
.\" .B F_SETOWN
.\" for more details.
入力や出力が可能になった場合に送るシグナルを \fIarg\fP に指定された値に設定する。 値ゼロは \fBSIGIO\fP を送ることを意味する。
(\fBSIGIO\fP を含む) 他の値はいずれも、 \fBSIGIO\fP の代わりに送るシグナル番号を表す。 後者の場合、シグナルハンドラを
\fBSA_SIGINFO\fP フラグ付きで設定すれば、 ハンドラで追加の情報を得ることができる。

\fBF_SETSIG\fP にゼロ以外の値を設定し、シグナルハンドラに \fBSA_SIGINFO\fP フラグを設定すると、 (\fBsigaction\fP(2)
を参照) I/O イベントに関する追加の情報が \fIsiginfo_t\fP 構造体でシグナルハンドラへ渡される。 \fIsi_code\fP
フィールドが示すシグナルの原因が \fBSI_SIGIO\fP である場合、 \fIsi_fd\fP
フィールドにはイベントに対応するファイルディスクリプタが入っている。 それ以外の場合は、どのファイルディスクリプタが利用可能かを示す情報は
ないので、どのファイルディスクリプタで I/O が可能かを判断するためには 通常の機構 (\fBselect\fP(2), \fBpoll\fP(2),
\fBO_NONBLOCK\fP を設定した \fBread\fP(2)  など) を使用しなければならない。

リアルタイムシグナル (値が \fBSIGRTMIN\fP 以上) を選択している場合は、 同じシグナル番号を持つ複数の I/O
イベントがキューに入ることがある (キューに入れるかどうかは利用可能なメモリに依存している)。 上記と同様、 \fBSA_SIGINFO\fP
が設定されている場合、シグナルハンドラのための追加の情報が得られる。

.\" See fs/fcntl.c::send_sigio_to_task() (2.4/2.6) sources -- MTK, Apr 05
以下の点に注意すること。 Linux では一つのプロセスに対してキューに入れられるリアルタイム シグナルの数に上限が設けられており
(\fBgetrlimit\fP(2)  と \fBsignal\fP(7)  を参照)、この上限に達するとカーネルは \fBSIGIO\fP シグナルを配送する。この
\fBSIGIO\fP シグナルは、指定されたスレッドではなくプロセス全体に送られる。
.PP
これらの機構を使用することで、ほとんどの場合で \fBselect\fP(2)  や \fBpoll\fP(2)  を使用せずに完全な非同期 I/O
を実装することができる。
.PP
\fBO_ASYNC\fP の使用方法は BSD と Linux に特有である。 POSIX.1 で規定されている \fBF_GETOWN\fP と
\fBF_SETOWN\fP の使用方法は、ソケットに対する \fBSIGURG\fP シグナルとの組み合わせだけである (POSIX は \fBSIGIO\fP
シグナルは規定していない)。 \fBF_GETOWN_EX\fP, \fBF_SETOWN_EX\fP, \fBF_GETSIG\fP, \fBF_SETSIG\fP は
Linux 固有である。POSIX には、同様のことを行うために、非同期 I/O と \fIaio_sigevent\fP 構造体がある。Linux
では、GNU C ライブラリ (Glibc) の一部として これらも利用可能である。
.SS "リース (leases)"
(Linix 2.4 以降で利用可能)  \fBF_SETLEASE\fP は、 \fIfd\fP
が参照するオープンファイル記述に対して新しいリースを設定するのに使用される。 \fBF_GETLEASE\fP は、 \fIfd\fP
が参照するオープンファイル記述に対して設定されている 現在のリースを取得するのに使用される。 ファイルのリースにより、 あるプロセス ("lease
breaker") がそのファイルディスクリプタが参照 しているファイルに対して \fBopen\fP(2)  や \fBtruncate\fP(2)
を行おうとした際に、リースを保持しているプロセス ("lease holder") へ (シグナルの配送による) 通知が行われるという機構が提供される。
.TP 
\fBF_SETLEASE\fP (\fIint\fP)
\fIarg\fP の内容に基いてファイルのリースの設定、削除を行う。整数 \fIarg\fP には以下の値が指定できる:
.RS
.TP 
\fBF_RDLCK\fP
.\" The following became true in kernel 2.6.10:
.\" See the man-pages-2.09 Changelog for further info.
読み出しリースを取得する。これにより、 そのファイルが書き込み用にオープンされたり、ファイルが切り詰められた場合に、
呼び出し元のプロセスに通知が行われるようになる。 読み出しリースを設定できるのは、読み出し専用でオープンされている
ファイルディスクリプタに対してのみである。
.TP 
\fBF_WRLCK\fP
書き込みリースを取得する。これにより、 (読み出し用か書き込み用にかかわらず) そのファイルがオープンされたり、
ファイルが切り詰められた場合に、呼び出し元のプロセスに通知が行われるようになる。
書き込みリースは、そのファイルに対するオープンされたファイルディスクリプタが 他にない場合にのみ設定できる。
.TP 
\fBF_UNLCK\fP
そのファイルからリースを削除する。
.RE
.P
リースはオープンファイル記述に対して関連付けられる (\fBopen\fP(2)  参照)。 つまり、 (\fBfork\fP(2)  や \fBdup\fP(2)
などにより作成された) ファイルディスクリプタの複製は同じリースを参照し、 複製も含めたどのファイルディスクリプタを使ってもこのリースを変更したり
解放したりできる。 また、これらのファイルディスクリプタのいずれかに対して \fBF_UNLCK\fP
操作が明示的に実行された場合や、すべてのファイルディスクリプタが 閉じられた場合にも、リースは解放される。
.P
リースの取得は通常のファイル (regular file) に対してのみ可能である。 非特権プロセスがリースを取得できるのは、UID (所有者)
がプロセスの ファイルシステム UID と一致するファイルに対してだけである。 \fBCAP_LEASE\fP
ケーパビリティを持つプロセスは任意のファイルに対してリースを取得できる。
.TP 
\fBF_GETLEASE\fP (\fIvoid\fP)
ファイルディスクリプタ \fIfd\fP に対して設定されているリースの種別を取得する。 \fBF_RDLCK\fP, \fBF_WRLCK\fP, \fBF_UNLCK\fP
のいずれかが返される。 \fBF_RDLCK\fP, \fBF_WRLCK\fP はそれぞれ、読み出しリース、書き込みリースが設定されていることを示し、
\fBF_UNLCK\fP はリースが何も設定されていないことを示す。 \fIarg\fP は無視される。
.PP
あるプロセス ("lease breaker") が \fBF_SETLEASE\fP で設定されたリースと矛
盾するような \fBopen\fP(2) や \fBtruncate\fP(2) を実行した場合、 そのシステム
コールはカーネルによって停止され、 カーネルは lease holder にシグナル
(デフォルトでは \fBSIGIO\fP) を送って通知を行う。 lease holder はこのシグ
ナルを受信したときにはきちんと対応すべきである。 具体的には、別のプロセ
スがそのファイルにアクセスするための準備として 必要な後片付け (例えば、
キャッシュされたバッファのフラッシュ) を すべて行ってから、そのファイル
のリースの削除または格下げを行う。リースを削除をするには、 \fIarg\fP に
\fBF_UNLCK\fP を指定して \fBF_SETLEASE\fP を実行する。lease holder がファイル
に書き込みリースを保持していて、 lease breaker が読み出し用にそのファイ
ルをオープンしている場合、 lease holder が保持しているリースを読み出し
リースに格下げすれば 十分である。これをするには、 \fIarg\fP に \fBF_RDLCK\fP
を指定して \fBF_SETLEASE\fP を実行する。

If the lease holder fails to downgrade or remove the lease within the number
of seconds specified in \fI/proc/sys/fs/lease\-break\-time\fP, then the kernel
forcibly removes or downgrades the lease holder's lease.

いったん lease break が開始されると、 lease holder が自発的にそのリース
の格下げか削除を行うか、lease break timer の満了後にカーネルが強制的に
リースの格下げか削除を行うまで、 \fBF_GETLEASE\fP は対象となるリースの型を
返す (リースの型は \fBF_RDLCK\fP か \fBF_UNLCK\fP のどちらであり、lease
breaker と互換性のある型となる)。

一度リースの削除か格下げが自発的もしくは強制的に行われると、 lease breaker がまだシステムコールを再開していない場合には、 カーネルが
lease breaker のシステムコールの続行を許可する。

lease breaker が実行した \fBopen\fP(2)  や \fBtruncate\fP(2)  が停止中にシグナルハンドラにより中断された場合、
そのシステムコールは \fBEINTR\fP エラーで失敗するが、上で述べた他の処理は そのまま行われる。 \fBopen\fP(2)  や
\fBtruncate\fP(2)  が停止中に lease breaker がシグナルにより kill された場合、 上で述べた他の処理はそのまま行われる。
lease breaker が \fBopen\fP(2)  を呼ぶ際に \fBO_NONBLOCK\fP フラグを指定した場合、そのシステムコールは
\fBEWOULDBLOCK\fP エラーで直ちに失敗するが、上で述べた他の処理はそのまま行われる。

lease holder への通知に使われるデフォルトのシグナルは \fBSIGIO\fP だが、 \fBfcntl\fP()  の \fBF_SETSIG\fP
コマンドで変更することができる。 \fBF_SETSIG\fP コマンドが実行され (\fBSIGIO\fP を指定された場合も含む)、 \fBSA_SIGINFO\fP
フラグ付きでシグナルハンドラが設定されている場合には、 ハンドラの第二引き数として \fIsiginfo_t\fP 構造体が渡され、この引き数の
\fIsi_fd\fP フィールドには別のプロセスがアクセスしたリース設定済みファイルの ディスクリプタが入っている
(この機能は複数のファイルに対してリースを設定する場合に有用である)。
.SS "ファイルやディレクトリの変更の通知 (dnotify)"
.TP 
\fBF_NOTIFY\fP (\fIint\fP)
(Linux 2.4 以降)  \fIfd\fP で参照されるディレクトリか、その中にあるファイルに変更があった場合に 通知を行う。どのイベントを通知するかは
\fIarg\fP で指定する。 \fIarg\fP はビットマスクで、以下のビットの 0個以上の論理和をとったものを指定する。
.RS
.sp
.PD 0
.TP  12
\fBDN_ACCESS\fP
A file was accessed (\fBread\fP(2), \fBpread\fP(2), \fBreadv\fP(2), and similar)
.TP 
\fBDN_MODIFY\fP
A file was modified (\fBwrite\fP(2), \fBpwrite\fP(2), \fBwritev\fP(2),
\fBtruncate\fP(2), \fBftruncate\fP(2), and similar).
.TP 
\fBDN_CREATE\fP
A file was created (\fBopen\fP(2), \fBcreat\fP(2), \fBmknod\fP(2), \fBmkdir\fP(2),
\fBlink\fP(2), \fBsymlink\fP(2), \fBrename\fP(2)  into this directory).
.TP 
\fBDN_DELETE\fP
A file was unlinked (\fBunlink\fP(2), \fBrename\fP(2)  to another directory,
\fBrmdir\fP(2)).
.TP 
\fBDN_RENAME\fP
A file was renamed within this directory (\fBrename\fP(2)).
.TP 
\fBDN_ATTRIB\fP
The attributes of a file were changed (\fBchown\fP(2), \fBchmod\fP(2),
\fButime\fP(2), \fButimensat\fP(2), and similar).
.PD
.RE
.IP
(上記の定義を利用するには、\fIどの\fP ヘッダファイルをインクルードするより前に、
\fB_GNU_SOURCE\fP 機能検査マクロを定義しなければならない。)

ディレクトリの変更通知は通常「一回限り (one\-shot)」であり、 アプリケーション側でその後さらに通知を受信したい場合は
再登録しなければならない。 \fIarg\fP に \fBDN_MULTISHOT\fP が含まれていた場合には、
変更通知は明示的に解除されるまで有効状態が継続する。

.\" The following does seem a poor API-design choice...
\fBF_NOTIFY\fP 要求は積算されていく。つまり、 \fIarg\fP で指定されたイベントがすでにモニタされている イベント集合に加算される形になる。
すべてのイベントの通知を無効にするには、 \fIarg\fP に 0 を指定して \fBF_NOTIFY\fP を呼び出す必要がある。

Notification occurs via delivery of a signal.  The default signal is
\fBSIGIO\fP, but this can be changed using the \fBF_SETSIG\fP command to
\fBfcntl\fP().  (Note that \fBSIGIO\fP is one of the nonqueuing standard signals;
switching to the use of a real\-time signal means that multiple notifications
can be queued to the process.)  In the latter case, the signal handler
receives a \fIsiginfo_t\fP structure as its second argument (if the handler was
established using \fBSA_SIGINFO\fP)  and the \fIsi_fd\fP field of this structure
contains the file descriptor which generated the notification (useful when
establishing notification on multiple directories).

特に \fBDN_MULTISHOT\fP を使う場合は、通知にはリアルタイムシグナルを使うべきである。
それは、リアルタイムシグナルを使うことで、複数の通知をキューに入れる ことができるからである。

\fB注意:\fP 新しくアプリケーションを書く際には、(カーネル 2.6.13 以降で利用可能となった)  \fIinotify\fP
インタフェースを使用すべきである。 \fIinotify\fP はファイルシステムイベントの通知を取得するための ずっと優れたインタフェースである。
\fBinotify\fP(7)  を参照。
.SS パイプの容量の変更
.TP 
\fBF_SETPIPE_SZ\fP (\fIint\fP; Linux 2.6.35 以降)
Change the capacity of the pipe referred to by \fIfd\fP to be at least \fIarg\fP
bytes.  An unprivileged process can adjust the pipe capacity to any value
between the system page size and the limit defined in
\fI/proc/sys/fs/pipe\-max\-size\fP (see \fBproc\fP(5)).  Attempts to set the pipe
capacity below the page size are silently rounded up to the page size.
Attempts by an unprivileged process to set the pipe capacity above the limit
in \fI/proc/sys/fs/pipe\-max\-size\fP yield the error \fBEPERM\fP; a privileged
process (\fBCAP_SYS_RESOURCE\fP)  can override the limit.  When allocating the
buffer for the pipe, the kernel may use a capacity larger than \fIarg\fP, if
that is convenient for the implementation.  The actual capacity that is set
is returned as the function result.  Attempting to set the pipe capacity
smaller than the amount of buffer space currently used to store data
produces the error \fBEBUSY\fP.
.TP 
\fBF_GETPIPE_SZ\fP (\fIvoid\fP; Linux 2.6.35 以降)
\fIfd\fP が参照するパイプの容量を (関数の結果として) 返す。
.SH 返り値
成功した場合の返り値は操作の種類により違う:
.TP  0.9i
\fBF_DUPFD\fP
新しいディスクリプタを返す。
.TP 
\fBF_GETFD\fP
ファイルディスクリプタフラグの値
.TP 
\fBF_GETFL\fP
ファイル状態フラグの値
.TP 
\fBF_GETLEASE\fP
ファイルディスクリプタに対して保持されているリースの種別を返す。
.TP 
\fBF_GETOWN\fP
ディスクリプタの所有者を返す。
.TP 
\fBF_GETSIG\fP
読み込みや書き出しが可能になった時に送られるシグナルの値、もしくは 伝統的な \fBSIGIO\fP 動作の場合にはゼロを返す。
.TP 
\fBF_GETPIPE_SZ\fP, \fBF_SETPIPE_SZ\fP
パイプの容量。
.TP 
他の全てのコマンド
0 を返す。
.PP
エラーの時は \-1 が返され、 \fIerrno\fP に適切な値が設定される。
.SH エラー
.TP 
\fBEACCES\fP か \fBEAGAIN\fP
他のプロセスが保持しているロックによって操作が禁止されている。
.TP 
\fBEAGAIN\fP
そのファイルは他のプロセスによってメモリマップされているため、 操作が禁止されている。
.TP 
\fBEBADF\fP
\fIfd\fP がオープンされたファイルディスクリプタでない。 あるいはコマンドが \fBF_SETLK\fP または \fBF_SETLKW\fP
だったが、対象のファイルディスクリプタのオープンモードが 必要となるロックの型にマッチしていない。
.TP 
\fBEDEADLK\fP
指定された \fBF_SETLKW\fP コマンドを実行した場合にはデッドロックになることが検出された。
.TP 
\fBEFAULT\fP
\fIlock\fP が利用可能なアドレス空間の外部にある。
.TP 
\fBEINTR\fP
\fBF_SETLKW\fP コマンドがシグナルにより割り込まれた (\fBsignal\fP(7)  参照)。 \fBF_GETLK\fP と \fBF_SETLK\fP
の場合、ロックを確認したり取得したりする前にシグナルによって割り込まれた。 これはたいていリモートのファイルをロックする場合 (例えば NFS
上でロックする場合) に起こる。 しかしローカルでも起こる場合がある。
.TP 
\fBEINVAL\fP
The value specified in \fIcmd\fP is not recognized by this kernel.
.TP 
\fBEINVAL\fP
\fBF_DUPFD\fPで、 \fIarg\fP が負か、もしくは許される最大値よりも大きい。 \fBF_SETSIG\fP の場合、 \fIarg\fP
が利用可能なシグナル番号ではない。
.TP 
\fBEINVAL\fP
\fIcmd\fP is \fBF_OFD_SETLK\fP, \fBF_OFD_SETLKW\fP, or \fBF_OFD_GETLK\fP, and \fIl_pid\fP
was not specified as zero.
.TP 
\fBEMFILE\fP
\fBF_DUPFD\fPで、 プロセスがすでに最大数までファイルディスクリプタをオープンしている。
.TP 
\fBENOLCK\fP
オープンされているロックの数が多過ぎて、ロックテーブルがいっぱいである。 または remote locking protocol (例えば NFS
上のロック) が失敗した。
.TP 
\fBENOTDIR\fP
\fBF_NOTIFY\fP was specified in \fIcmd\fP, but \fIfd\fP does not refer to a
directory.
.TP 
\fBEPERM\fP
追加専用属性が設定されたファイルの \fBO_APPEND\fP フラグをクリアしようと試みた。
.SH 準拠
SVr4, 4.3BSD, POSIX.1\-2001.  POSIX.1\-2001 で規定されている操作は、
\fBF_DUPFD\fP, \fBF_GETFD\fP, \fBF_SETFD\fP, \fBF_GETFL\fP, \fBF_SETFL\fP,
\fBF_GETLK\fP, \fBF_SETLK\fP, \fBF_SETLKW\fP だけである。

\fBF_GETOWN\fP and \fBF_SETOWN\fP are specified in POSIX.1\-2001.  (To get their
definitions, define either \fB_BSD_SOURCE\fP, or \fB_XOPEN_SOURCE\fP with the
value 500 or greater, or \fB_POSIX_C_SOURCE\fP with the value 200809L or
greater.)

\fBF_DUPFD_CLOEXEC\fP は POSIX.1\-2008 で規定されている。
(これら定義するには、
\fB_POSIX_C_SOURCE\fP を 200809L 以上の値で定義するか、
\fB_XOPEN_SOURCE\fP を 700 以上の値で定義すること。)

.\" .PP
.\" SVr4 documents additional EIO, ENOLINK and EOVERFLOW error conditions.
\fBF_GETOWN_EX\fP, \fBF_SETOWN_EX\fP, \fBF_SETPIPE_SZ\fP, \fBF_GETPIPE_SZ\fP,
\fBF_GETSIG\fP,
\fBF_SETSIG\fP, \fBF_NOTIFY\fP, \fBF_GETLEASE\fP, \fBF_SETLEASE\fP は Linux 固有である
(これらの定義を有効にするには \fB_GNU_SOURCE\fP マクロを定義すること)。

\fBF_OFD_SETLK\fP, \fBF_OFD_SETLKW\fP, and \fBF_OFD_GETLK\fP are Linux\-specific (and
one must define \fB_GNU_SOURCE\fP to obtain their definitions), but work is
being done to have them included in the next version of POSIX.1.
.SH 注意
.\"
エラーの際の返り値が \fBdup2\fP(2)  と \fBF_DUPFD\fP では異なっている。
.SS ファイルロック
元々の Linux の \fBfcntl\fP() システムコールは (\fIflock\fP 構造体で) 大きな
ファイルオフセットを扱えるように設計されていなかった。
その結果、Linux 2.4 で \fBfcntl64\fP() システムコールが追加された。
この新しいシステムコールは、ファイルのロックに \fIflock64\fP という別の
構造体を利用し、これに対応するコマンドとして \fBF_GETLK64\fP,
\fBF_SETLK64\fP, \fBF_SETLKW64\fP を使用する。
しかし、 glibc を使うアプリケーションではこれらの詳細を無視することが
できる。 glibc の \fBfcntl\fP のラッパー関数は新しいシステムコールが
利用できる場合はそれを利用するようになっているからである。

エラーの際の返り値が \fBdup2\fP(2)  と \fBF_DUPFD\fP では異なっている。
.SS "Record locks"
カーネル 2.0 以降では、 \fBflock\fP(2)  と \fBfcntl\fP()  が設定するロック種別の間に相互作用はない。

.\" e.g., Solaris 8 documents this field in fcntl(2), and Irix 6.5
.\" documents it in fcntl(5).  mtk, May 2007
.\" Also, FreeBSD documents it (Apr 2014).
システムによっては、 \fIstruct flock\fP に上記以外のフィールドがあるものもある (例えば \fIl_sysid\fP)。
はっきりと言えることは、ロックを保持しているプロセスが別のマシンに存在 する場合には、 \fIl_pid\fP
だけはあまり役にたたないだろうということである。

元々の Linux の \fBfcntl\fP() システムコールは (\fIflock\fP 構造体で) 大きな
ファイルオフセットを扱えるように設計されていなかった。
その結果、Linux 2.4 で \fBfcntl64\fP() システムコールが追加された。
この新しいシステムコールは、ファイルのロックに \fIflock64\fP という別の
構造体を利用し、これに対応するコマンドとして \fBF_GETLK64\fP,
\fBF_SETLK64\fP, \fBF_SETLKW64\fP を使用する。
しかし、 glibc を使うアプリケーションではこれらの詳細を無視することが
できる。 glibc の \fBfcntl\fP のラッパー関数は新しいシステムコールが
利用できる場合はそれを利用するようになっているからである。
.SS "Record locking and NFS"
.\"
.\" Neil Brown: With NFSv3 the failure mode is the reverse.  If
.\"     the server loses contact with a client then any lock stays in place
.\"     indefinitely ("why can't I read my mail"... I remember it well).
.\"
.\"
.\" Jeff Layton:
.\"     Note that this is not a firm timeout. The server runs a job
.\"     periodically to clean out expired stateful objects, and it's likely
.\"     that there is some time (maybe even up to another whole lease period)
.\"     between when the timeout expires and the job actually runs. If the
.\"     client gets a RENEW in there within that window, its lease will be
.\"     renewed and its state preserved.
.\"
Before Linux 3.12, if an NFSv4 client loses contact with the server for a
period of time (defined as more than 90 seconds with no communication), it
might lose and regain a lock without ever being aware of the fact.  (The
period of time after which contact is assumed lost is known as the NFSv4
leasetime.  On a Linux NFS server, this can be determined by looking at
\fI/proc/fs/nfsd/nfsv4leasetime\fP, which expresses the period in seconds.  The
default value for this file is 90.)  This scenario potentially risks data
corruption, since another process might acquire a lock in the intervening
period and perform file I/O.

.\" commit ef1820f9be27b6ad158f433ab38002ab8131db4d
.\" commit f6de7a39c181dfb8a2c534661a53c73afb3081cd
Since Linux 3.12, if an NFSv4 client loses contact with the server, any I/O
to the file by a process which "thinks" it holds a lock will fail until that
process closes and reopens the file.  A kernel parameter,
\fInfs.recover_lost_locks\fP, can be set to 1 to obtain the pre\-3.12 behavior,
whereby the client will attempt to recover lost locks when contact is
reestablished with the server.  Because of the attendant risk of data
corruption, this parameter defaults to 0 (disabled).
.SH バグ
.SS F_SETFL
.\" FIXME . According to POSIX.1-2001, O_SYNC should also be modifiable
.\" via fcntl(2), but currently Linux does not permit this
.\" See http://bugzilla.kernel.org/show_bug.cgi?id=5994
\fBF_SETFL\fP を使って、 フラグ \fBO_DSYNC\fP と \fBO_SYNC\fP
の状態を変更することはできない。これらのフラグの状態を変更しようとした場合には、黙って無視される。
.SS F_GETOWN
.\" glibc source: sysdeps/unix/sysv/linux/i386/sysdep.h
.\" mtk, Dec 04: some limited testing on alpha and ia64 seems to
.\" indicate that ANY negative PGID value will cause F_GETOWN
.\" to misinterpret the return as an error. Some other architectures
.\" seem to have the same range check as i386.
いくつかのアーキテクチャ (特に i386) における Linux システムコールの慣習
のため以下の制限が存在する。
\fBF_GETOWN\fP が返す (負の) プロセスグループID が \-1 から \-4095 の範囲に入った場合、
glibc はこの返り値をシステムコールでエラーが起こったと間違って解釈してしまう。
つまり、 \fBfcntl\fP() の返り値は \-1 となり、 \fIerrno\fP には (正の) プロセスグループID
が設定されることになる。Linux 固有の \fBF_GETOWN_EX\fP ではこの問題を回避できる。
glibc バージョン 2.11 以降では、glibc では \fBF_GETOWN_EX\fP を使って
\fBF_GETOWN\fP を実装することで、カーネルの \fBF_GETOWN\fP の問題を見えないようにしている。
.SS F_SETOWN
.\"
Linux 2.4 以前では、非特権プロセスが \fBF_SETOWN\fP を使って、ソケットのファイルディスクリプタの所有者に 呼び出し元以外のプロセス
(やプロセスグループ) を指定すると 発生するバグがある。この場合、 呼び出し元が所有者として指定したプロセス (やプロセスグループ) に
シグナルを送る許可を持っていたとしても、 \fBfcntl\fP()  が \-1 を返し \fIerrno\fP に \fBEPERM\fP を設定することがある。
このエラーが返ったにもかかわらず、ファイルディスクリプタの所有者 は設定され、シグナルはその所有者に送られる。
.SS "Deadlock detection"
.\"
The deadlock\-detection algorithm employed by the kernel when dealing with
\fBF_SETLKW\fP requests can yield both false negatives (failures to detect
deadlocks, leaving a set of deadlocked processes blocked indefinitely)  and
false positives (\fBEDEADLK\fP errors when there is no deadlock).  For example,
the kernel limits the lock depth of its dependency search to 10 steps,
meaning that circular deadlock chains that exceed that size will not be
detected.  In addition, the kernel may falsely indicate a deadlock when two
or more processes created using the \fBclone\fP(2)  \fBCLONE_FILES\fP flag place
locks that appear (to the kernel) to conflict.
.SS "強制ロック (mandatory locking)"
.\" http://marc.info/?l=linux-kernel&m=119013491707153&w=2
.\"
.\" Reconfirmed by Jeff Layton
.\"     From: Jeff Layton <jlayton <at> redhat.com>
.\"     Subject: Re: Status of fcntl() mandatory locking
.\"     Newsgroups: gmane.linux.file-systems
.\"     Date: 2014-04-28 10:07:57 GMT
.\"     http://thread.gmane.org/gmane.linux.file-systems/84481/focus=84518
The Linux implementation of mandatory locking is subject to race conditions
which render it unreliable: a \fBwrite\fP(2)  call that overlaps with a lock
may modify data after the mandatory lock is acquired; a \fBread\fP(2)  call
that overlaps with a lock may detect changes to data that were made only
after a write lock was acquired.  Similar races exist between mandatory
locks and \fBmmap\fP(2).  It is therefore inadvisable to rely on mandatory
locking.
.SH 関連項目
\fBdup2\fP(2), \fBflock\fP(2), \fBopen\fP(2), \fBsocket\fP(2), \fBlockf\fP(3),
\fBcapabilities\fP(7), \fBfeature_test_macros\fP(7)

Linux カーネルソースの \fIDocumentation/filesystems/\fP ディレクトリ内の \fIlocks.txt\fP,
\fImandatory\-locking.txt\fP, \fIdnotify.txt\fP (以前のカーネルでは、これらのファイルは
\fIDocumentation/\fP ディレクトリ直下にあり、 \fImandatory\-locking.txt\fP は \fImandatory.txt\fP
という名前であった)
.SH この文書について
この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.77 の一部
である。プロジェクトの説明とバグ報告に関する情報は
http://www.kernel.org/doc/man\-pages/ に書かれている。