# `fcntl` --- The `fcntl` and `ioctl` system calls

This module performs file and I/O control on file descriptors. It is an interface to the `fcntl()` and `ioctl()` Unix routines. See the fcntl(2) and ioctl(2) Unix manual pages for full details.

Availability: Unix, not Emscripten, not WASI.

このモジュール内の全ての関数はファイル記述子 fd を最初の引数に取ります。 この値は `sys.stdin.fileno()` が返すような整数のファイル記述子でも、 `sys.stdin` 自体のような、純粋にファイル記述子だけを返す `fileno()` メソッドを提供している `io.IOBase` オブジェクトでもかまいません。

バージョン 3.3 で変更: 以前は `IOError` を送出していたこのモジュールの操作が、 `OSError` を送出するようになりました。

バージョン 3.8 で変更: The fcntl module now contains `F_ADD_SEALS`, `F_GET_SEALS`, and `F_SEAL_*` constants for sealing of `os.memfd_create()` file descriptors.

バージョン 3.9 で変更: On macOS, the fcntl module exposes the `F_GETPATH` constant, which obtains the path of a file from a file descriptor. On Linux(>=3.15), the fcntl module exposes the `F_OFD_GETLK`, `F_OFD_SETLK` and `F_OFD_SETLKW` constants, which are used when working with open file description locks.

バージョン 3.10 で変更: On Linux >= 2.6.11, the fcntl module exposes the `F_GETPIPE_SZ` and `F_SETPIPE_SZ` constants, which allow to check and modify a pipe's size respectively.

バージョン 3.11 で変更: On FreeBSD, the fcntl module exposes the `F_DUP2FD` and `F_DUP2FD_CLOEXEC` constants, which allow to duplicate a file descriptor, the latter setting `FD_CLOEXEC` flag in addition.

このモジュールには、以下の関数が定義されています:

fcntl.fcntl(fd, cmd, arg=0)

  Perform the operation cmd on file descriptor fd (file objects providing a `fileno()` method are accepted as well). The values used for cmd are operating system dependent, and are available as constants in the `fcntl` module, using the same names as used in the relevant C header files. The argument arg can either be an integer value, or a `bytes` object. With an integer value, the return value of this function is the integer return value of the C `fcntl()` call. When the argument is bytes it represents a binary structure, e.g. created by `struct.pack()`. The binary data is copied to a buffer whose address is passed to the C `fcntl()` call. The return value after a successful call is the contents of the buffer, converted to a `bytes` object. The length of the returned object will be the same as the length of the arg argument. This is limited to 1024 bytes. If the information returned in the buffer by the operating system is larger than 1024 bytes, this is most likely to result in a segmentation violation or a more subtle data corruption.

  If the `fcntl()` call fails, an `OSError` is raised.

  引数 `fd`, `cmd`, `arg` を指定して 監査イベント `fcntl.fcntl` を送出します。

fcntl.ioctl(fd, request, arg=0, mutate_flag=True)

  この関数は `fcntl()` 関数と同じですが、引数の扱いがより複雑であるところが異なります。

  The request parameter is limited to values that can fit in 32-bits. Additional constants of interest for use as the request argument can be found in the `termios` module, under the same names as used in the relevant C header files.

  The parameter arg can be one of an integer, an object supporting the read-only buffer interface (like `bytes`) or an object supporting the read-write buffer interface (like `bytearray`).

  In all but the last case, behaviour is as for the `fcntl()` function.

  If a mutable buffer is passed, then the behaviour is determined by the value of the mutate_flag parameter.

  If it is false, the buffer's mutability is ignored and behaviour is as for a read-only buffer, except that the 1024 byte limit mentioned above is avoided -- so long as the buffer you pass is at least as long as what the operating system wants to put there, things should work.

  If mutate_flag is true (the default), then the buffer is (in effect) passed to the underlying `ioctl()` system call, the latter's return code is passed back to the calling Python, and the buffer's new contents reflect the action of the `ioctl()`. This is a slight simplification, because if the supplied buffer is less than 1024 bytes long it is first copied into a static buffer 1024 bytes long which is then passed to `ioctl()` and copied back into the supplied buffer.

  If the `ioctl()` call fails, an `OSError` exception is raised.

  以下に例を示します:

      >>> import array, fcntl, struct, termios, os
      >>> os.getpgrp()
      13341
      >>> struct.unpack('h', fcntl.ioctl(0, termios.TIOCGPGRP, "  "))[0]
      13341
      >>> buf = array.array('h', [0])
      >>> fcntl.ioctl(0, termios.TIOCGPGRP, buf, 1)
      0
      >>> buf
      array('h', [13341])

  引数 `fd`, `request`, `arg` を指定して 監査イベント `fcntl.ioctl` を送出します。

fcntl.flock(fd, operation)

  ファイル記述子 fd (`fileno()` メソッドを提供しているファイルオブジェクトも含む) に対してロック操作 operation を実行します。 詳細は Unix マニュアルの flock(2) を参照してください (システムによっては、この関数は `fcntl()` を使ってエミュレーションされています)。

  If the `flock()` call fails, an `OSError` exception is raised.

  引数 `fd`, `operation` を指定して 監査イベント `fcntl.flock` を送出します。

fcntl.lockf(fd, cmd, len=0, start=0, whence=0)

  本質的に `fcntl()` によるロッキングの呼び出しをラップしたものです。 fd はロックまたはアンロックするファイルのファイル記述子 (`fileno()` メソッドを提供するファイルオブジェクトも受け付けられます) で、 cmd は以下の値のうちいずれかになります:

  fcntl.LOCK_UN

    Release an existing lock.

  fcntl.LOCK_SH

    Acquire a shared lock.

  fcntl.LOCK_EX

    Acquire an exclusive lock.

  fcntl.LOCK_NB

    Bitwise OR with any of the other three `LOCK_*` constants to make the request non-blocking.

  If `LOCK_NB` is used and the lock cannot be acquired, an `OSError` will be raised and the exception will have an errno attribute set to `EACCES` or `EAGAIN` (depending on the operating system; for portability, check for both values). On at least some systems, `LOCK_EX` can only be used if the file descriptor refers to a file opened for writing.

  len はロックを行いたいバイト数、 start はロック領域先頭の whence からの相対的なバイトオフセット、 whence は `io.IOBase.seek()` と同じで、具体的には:

  - `0` -- relative to the start of the file (`os.SEEK_SET`)

  - `1` -- relative to the current buffer position (`os.SEEK_CUR`)

  - `2` -- relative to the end of the file (`os.SEEK_END`)

  start の標準の値は 0 で、ファイルの先頭から開始することを意味します。len の標準の値は 0 で、ファイルの終了までロックすることを表します。whence の標準の値も 0 です。

  引数 `fd`, `cmd`, `len`, `start`, `whence` を指定して 監査イベント `fcntl.lockf` を送出します。

以下に (全ての SVR4 互換システムでの) 例を示します:

    import struct, fcntl, os

    f = open(...)
    rv = fcntl.fcntl(f, fcntl.F_SETFL, os.O_NDELAY)

    lockdata = struct.pack('hhllhh', fcntl.F_WRLCK, 0, 0, 0, 0, 0)
    rv = fcntl.fcntl(f, fcntl.F_SETLKW, lockdata)

最初の例では、戻り値 rv は整数値を保持しています; 二つ目の例では `bytes` オブジェクトを保持しています。 lockdata 変数の構造体レイアウトはシステム依存です --- 従って `flock()` を呼ぶ方が良いでしょう。

参考

`os` モジュール

  If the locking flags `O_SHLOCK` and `O_EXLOCK` are present in the `os` module (on BSD only), the `os.open()` function provides an alternative to the `lockf()` and `flock()` functions.