FSTATAT(2)

名前
fstatat - ディレクトリファイルディスクリプタから相対的な位置にあるファイルの状態を取得する

書式
#include <fcntl.h> /* AT_* 定数の定義 */
#include <sys/stat.h>

int fstatat(int dirfd, const char *pathname, struct stat *buf,
            int flags);

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

fstatat():
    glibc 2.10 以降:
        _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
    glibc 2.10 より前:
        _ATFILE_SOURCE

説明
fstatat() システムコールは、この man ページで説明している違いがある以外は、 stat(2) と全く同じように動作する。 pathname で指定されるパス名が相対パスである場合、 ファイルディスクリプタ dirfd で参照されるディレクトリからの相対パス名として解釈される (stat(2) では、相対パスは呼び出し元プロセスのカレントワーキングディレクトリからの 相対パスとなる)。 pathname が相対パスであり、かつ dirfd が特別な値 AT_FDCWD である場合、 pathname は (stat(2) と同じように) 呼び出し元プロセスの カレントワーキングディレクトリからの相対パス名として解釈される。 pathname が絶対パスである場合、 dirfd は無視される。 flags には 0 または以下のフラグの 1 つ以上を論理和 (OR) で指定する。

AT_EMPTY_PATH (Linux 2.6.39 以降)
    pathname が空の文字列の場合、 dirfd が参照するファイルに対して操作が行われる (dirfd は open(2) の O_PATH フラグを使って取得することができる)。 この場合、 dirfd は、 ディレクトリだけでなく、任意の種類のファイルを参照することができる。

AT_NO_AUTOMOUNT (Linux 2.6.38 以降)
    pathname がオートマウントポイントのディレクトリの場合、 pathname の最後の要素 ("basename") のオートマウントを行わない。 このフラグを使うと、(マウント先の場所ではなく) オートマウントポイント 自身の属性を収集することができる。 ディレクトリをスキャンするようなツールで、オートマウントポイントを 含むディレクトリで大量のオートマウントが起こらないようにするのに、 このフラグを使うことができる。 マウントポイントがすでにマウントされている場合には、 AT_NO_AUTOMOUNT フラグは何も効果はない。

AT_SYMLINK_NOFOLLOW
    pathname がシンボリックリンクの場合は、それを辿るのではなく、 lstat(2) と同様にリンク自身についての情報を返す (デフォルトでは、 fstatat() は stat(2) と同様にシンボリックリンクを辿る)。

返り値
成功した場合、 fstatat() は 0 を返す。 エラーの場合、-1 が返されて、 errno にはエラーを示す値が設定される。

エラー
stat(2) と同じエラーが fstatat() でも起こる。 fstatat() では、その他に以下のエラーが起こる:

EBADF
    dirfd が有効なファイルディスクリプタでない。

EINVAL
    flags に不正なフラグ値が指定された。

ENOTDIR
    pathname が相対パスで、かつ dirfd がディレクトリ以外のファイルを参照するファイルディスクリプタである。

バージョン
fstatat() は Linux カーネル 2.6.16 で追加された。 ライブラリによるサポートは glibc バージョン 2.4 で追加された。

準拠
POSIX.1-2008. Solaris には、これと同じようなシステムコールが存在する。

注意
fstatat() が必要な理由については、 openat(2) を参照すること。 glibc の fstatat() のラッパー関数が利用するシステムコールとしては、 実際には fstatat64() が呼び出される。

関連項目
openat(2), stat(2), path_resolution(7), symlink(7),

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