release/man2/stat.2

   1 .\" t
   2 .\" Copyright (c) 1992 Drew Eckhardt (drew@cs.colorado.edu), March 28, 1992
   3 .\" Parts Copyright (c) 1995 Nicolai Langfeldt (janl@ifi.uio.no), 1/1/95
   4 .\" and Copyright (c) 2006, 2007, 2014 Michael Kerrisk <mtk.manpages@gmail.com>
   5 .\"
   6 .\" %%%LICENSE_START(VERBATIM)
   7 .\" Permission is granted to make and distribute verbatim copies of this
   8 .\" manual provided the copyright notice and this permission notice are
   9 .\" preserved on all copies.
  10 .\"
  11 .\" Permission is granted to copy and distribute modified versions of this
  12 .\" manual under the conditions for verbatim copying, provided that the
  13 .\" entire resulting derived work is distributed under the terms of a
  14 .\" permission notice identical to this one.
  15 .\"
  16 .\" Since the Linux kernel and libraries are constantly changing, this
  17 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  18 .\" responsibility for errors or omissions, or for damages resulting from
  19 .\" the use of the information contained herein.  The author(s) may not
  20 .\" have taken the same level of care in the production of this manual,
  21 .\" which is licensed free of charge, as they might when working
  22 .\" professionally.
  23 .\"
  24 .\" Formatted or processed versions of this manual, if unaccompanied by
  25 .\" the source, must acknowledge the copyright and authors of this work.
  26 .\" %%%LICENSE_END
  27 .\"
  28 .\" Modified by Michael Haardt <michael@moria.de>
  29 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  30 .\" Modified 1995-05-18 by Todd Larason <jtl@molehill.org>
  31 .\" Modified 1997-01-31 by Eric S. Raymond <esr@thyrsus.com>
  32 .\" Modified 1995-01-09 by Richard Kettlewell <richard@greenend.org.uk>
  33 .\" Modified 1998-05-13 by Michael Haardt <michael@cantor.informatik.rwth-aachen.de>
  34 .\" Modified 1999-07-06 by aeb & Albert Cahalan
  35 .\" Modified 2000-01-07 by aeb
  36 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
  37 .\" 2007-06-08 mtk: Added example program
  38 .\" 2007-07-05 mtk: Added details on underlying system call interfaces
  39 .\"
  40 .\"*******************************************************************
  41 .\"
  42 .\" This file was generated with po4a. Translate the source file.
  43 .\"
  44 .\"*******************************************************************
  45 .\"
  46 .\" Japanese Version Copyright (c) 1998-1999 HANATAKA Shinya
  47 .\" and Copyright (c) 2005-2008 Akihiro MOTOKI
  48 .\" Translated 1998-06-21, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  49 .\" Modified 1999-04-16, HANATAKA Shinya
  50 .\" Updated 2000-01-03, Kentaro Shirakata <argrath@ub32.org>
  51 .\" Updated 2000-10-06, Kentaro Shirakata
  52 .\" Updated 2001-04-09, Kentaro Shirakata
  53 .\" Updated 2001-06-25, Kentaro Shirakata
  54 .\" Updated 2005-02-28, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  55 .\" Updated 2005-09-06, Akihiro MOTOKI
  56 .\" Updated 2005-11-19, Akihiro MOTOKI, catch up to LDP v2.14
  57 .\" Updated 2006-07-21, Akihiro MOTOKI, LDP v2.36
  58 .\" Updated 2007-06-13, Akihiro MOTOKI, LDP v2.55
  59 .\" Updated 2008-09-19, Akihiro MOTOKI, LDP v3.08
  60 .\" Updated 2012-04-30, Akihiro MOTOKI <amotoki@gmail.com>
  61 .\" Updated 2012-05-29, Akihiro MOTOKI <amotoki@gmail.com>
  62 .\" Updated 2013-03-26, Akihiro MOTOKI <amotoki@gmail.com>
  63 .\"
  64 .TH STAT 2 2014\-08\-19 Linux "Linux Programmer's Manual"
  65 .SH 名前
  66 stat, fstat, lstat, fstatat \- ファイルの状態を取得する
  67 .SH 書式
  68 .nf
  69 \fB#include <sys/types.h>\fP
  70 .br
  71 \fB#include <sys/stat.h>\fP
  72 .br
  73 \fB#include <unistd.h>\fP
  74 .sp
  75 \fBint stat(const char *\fP\fIpathname\fP\fB, struct stat *\fP\fIbuf\fP\fB);\fP
  76 .br
  77 \fBint fstat(int \fP\fIfd\fP\fB, struct stat *\fP\fIbuf\fP\fB);\fP
  78 .br
  79 \fBint lstat(const char *\fP\fIpathname\fP\fB, struct stat *\fP\fIbuf\fP\fB);\fP
  80 .sp
  81 \fB#include <fcntl.h>           \fP/* AT_* 定数の定義 */
  82 \fB#include <sys/stat.h>\fP
  83 .sp
  84 \fBint fstatat(int \fP\fIdirfd\fP\fB, const char *\fP\fIpathname\fP\fB, struct stat *\fP\fIbuf\fP\fB,\fP
  85 \fB            int \fP\fIflags\fP\fB);\fP
  86 .fi
  87 .sp
  88 .in -4n
  89 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  90 .in
  91 .ad l
  92 .PD 0
  93 .sp
  94 \fBlstat\fP():
  95 .RS 4
  96 /* glibc 2.19 以前 */ _BSD_SOURCE ||
  97 .br
  98 /* glibc 2.20 以降 */_DEFAULT_SOURCE ||
  99 .br
 100 _XOPEN_SOURCE\ >=\ 500 || _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
 101 .br
 102 || /* glibc 2.10 以降: */ _POSIX_C_SOURCE\ >=\ 200112L
 103 .RE
 104 .sp
 105 \fBfstatat\fP():
 106 .PD 0
 107 .ad l
 108 .RS 4
 109 .TP  4
 110 glibc 2.10 以降:
 111 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
 112 .TP
 113 glibc 2.10 より前:
 114 _ATFILE_SOURCE
 115 .RE
 116 .PD
 117 .ad
 118 .SH 説明
 119 .PP
 120 これらの関数は、ファイルについての情報を \fIstat\fP が指すバッファに格納して返す。 ファイルそのものに対するアクセス許可は必要としないが、
 121 \(em\fBstat\fP(), \fBfstatat\fP(), \fBlstat\fP() の場合には \(emそのファイルへ至る \fIpathname\fP
 122 を構成する全てのディレクトリに対する実行 (検索) 許可が必要である。
 123 .PP
 124 \fBstat\fP() と \fBfstatat\fP() は \fIpathname\fP が指すファイルに関する情報を取得する。 \fBfstatat\fP()
 125 の違いについては後で説明する。
 126
 127 \fBlstat\fP()  は \fBstat\fP()  と同じであるが、 \fIpathnames\fP
 128 がシンボリックリンクの場合、リンクが参照しているファイルではなく、 リンク自身の状態を返す点が異なる。
 129
 130 \fBfstat\fP()  は \fBstat\fP()  と同じだが、 状態を取得するファイルをファイルディスクリプタ \fIfd\fP で指定する点が異なる。
 131 .PP
 132 これらのシステムコールはいずれも、結果を \fIstat\fP 構造体に入れて返す。 \fIstat\fP 構造体には以下のフィールドが含まれている:
 133 .PP
 134 .in +4n
 135 .nf
 136 struct stat {
 137     dev_t     st_dev;     /* ファイルがあるデバイスの ID */
 138     ino_t     st_ino;     /* inode 番号 */
 139     mode_t    st_mode;    /* アクセス保護 */
 140     nlink_t   st_nlink;   /* ハードリンクの数 */
 141     uid_t     st_uid;     /* 所有者のユーザ ID */
 142     gid_t     st_gid;     /* 所有者のグループ ID */
 143     dev_t     st_rdev;    /* デバイス ID (特殊ファイルの場合) */
 144     off_t     st_size;    /* 全体のサイズ (バイト単位) */
 145     blksize_t st_blksize; /* ファイルシステム I/O での
 146                              ブロックサイズ */
 147     blkcnt_t  st_blocks;  /* 割り当てられた 512B のブロック数 */
 148 };
 149
 150     /* Linux 2.6 以降では、カーネルは以下のタイムスタンプ
 151        フィールドでナノ秒の精度をサポートしている。
 152        Linux 2.6 より前のバージョンでの詳細は
 153        下記の「注意」を参照。 */
 154
 155     struct timespec st_atim;  /* 最終アクセス時刻 */
 156     struct timespec st_mtim;  /* 最終修正時刻 */
 157     struct timespec st_ctim;  /* 最終状態変更時刻 */
 158
 159 #define st_atime st_atim.tv_sec      /* 後方互換性 */
 160 #define st_mtime st_mtim.tv_sec
 161 #define st_ctime st_ctim.tv_sec
 162 };
 163 .fi
 164 .in
 165
 166 \fI注意:\fP \fIstat\fP 構造体のフィールドの順序はアーキテクチャにより様々である。
 167 また、上記の定義では、フィールド間に存在することがあるパディングバイトは書かれていない。このパディングバイトはアーキテクチャによっても異なる。詳細を知る必要がある場合は
 168 glibc とカーネルのソースを調べてほしい。
 169
 170 \fIst_dev\fP フィールドは、このファイルが存在するデバイスを示す (マクロ \fBmajor\fP(3), \fBminor\fP(3)
 171 は、このフィールドのデバイス ID を分解するのに役立つだろう)。
 172
 173 \fIst_rdev\fP フィールドは、このファイル (inode) が表すデバイスを示す。
 174
 175 \fIst_size\fP フィールドは、(通常のファイルかシンボリックリンクの場合に)
 176 ファイルの大きさをバイト単位で示す。 シンボリックリンクの大きさは、
 177 シンボリックリンクに含まれている パス名の長さ (終端のヌルバイトは含まない)
 178 である。
 179
 180 \fIst_blocks\fP フィールドは、ファイルの大きさを 512 バイトのブロックサイズ単位で示す フィールドは、ファイルに割り当てされたブロック数を
 181 512 バイト単位で示す。 (ファイルに穴があるような場合、この値は \fIst_size\fP/512 より小さくなることもある)。
 182
 183 \fIst_blksize\fP フィールドは、効率的にファイルシステム I/O ができる「好ましい」 ブロックサイズを示す
 184 (もっと小さい単位でファイルに書き込みを行うと、 読み出し\-\-修正\-\-再書き込みといった非効率な動作になってしまうかもしれない)。
 185 .PP
 186 全ての Linux のファイルシステムが全ての時間フィールドを 実装しているわけではない。 ファイルやディレクトリのアクセスが \fIst_atime\fP
 187 フィールドを更新しないようなかたちでマウントできるファイルシステムもある。 (\fBmount\fP(8)  の \fInoatime\fP,
 188 \fInodiratime\fP, \fIrelatime\fP や \fBmount\fP(2)  の関連する情報を参照)。 また、ファイルが \fBO_NOATIME\fP
 189 付きでオープンされている場合には \fIst_atime\fP は更新されない。 \fBopen\fP(2)  参照。
 190
 191 \fIst_atime\fP フィールドはファイルアクセスがあった場合に変更される (例えば、 \fBexecve\fP(2), \fBmknod\fP(2),
 192 \fBpipe\fP(2), \fButime\fP(2)  を使用した場合や \fBread\fP(2)  で 1 バイト以上読み込んだ場合など)。
 193 \fBmmap\fP(2)  などの他のルーチンでは、 \fIst_atime\fP は更新されることもあれば、そうでない場合もある。
 194
 195 \fIst_mtime\fP フィールドは、ファイルが修正された場合に変更される (例えば、 \fBmknod\fP(2), \fBtruncate\fP(2),
 196 \fButime\fP(2)  を使用した場合や \fBwrite\fP(2)  で 1 バイト以上書き込みをした場合など)。 さらに、ディレクトリの
 197 \fIst_mtime\fP は、そのディレクトリで ファイルが作成されたり削除されたりすると変更される。 \fIst_mtime\fP フィールドは
 198 所有者やグループやハード・リンク数やモードの変更では変更 \fIされない。\fP
 199
 200 \fIst_ctime\fP フィールドは書き込みや inode 情報 (所有者、グループ、リンク数、モードなど) の 設定によって変更される。
 201 .PP
 202 以下のマスク値が \fIst_mode\fP フィールドのファイル種別の検査用に定義されている。
 203 .in +4n
 204 .TS
 205 lB l l.
 206 S_IFMT  0170000 ファイル種別を示すビット領域を表すビットマスク
 207
 208 S_IFSOCK        0140000 ソケット
 209 S_IFLNK 0120000 シンボリックリンク
 210 S_IFREG 0100000 通常のファイル
 211 S_IFBLK 0060000 ブロック・デバイス
 212 S_IFDIR 0040000 ディレクトリ
 213 S_IFCHR 0020000 キャラクター・デバイス
 214 S_IFIFO 0010000 FIFO
 215 .TE
 216 .in
 217 .PP
 218 したがって、(例えば) 通常のファイルかどうかを検査するには、以下のようにすればよい。
 219
 220 .nf
 221 .in +4n
 222 stat(pathname, &sb);
 223 if ((sb.st_mode & S_IFMT) == S_IFREG) {
 224     /* Handle regular file */
 225 }
 226 .in
 227 .fi
 228 .PP
 229 上記の形の検査はよくあるので、 POSIX では以下のマクロが定義されており、 \fIst_mode\fP
 230 のファイル種別の検査をより簡単に書けるようになっている。
 231 .RS 4
 232 .TP  1.2i
 233 \fBS_ISREG\fP(m)
 234 通常のファイルか?
 235 .TP
 236 \fBS_ISDIR\fP(m)
 237 ディレクトリか?
 238 .TP
 239 \fBS_ISCHR\fP(m)
 240 キャラクター・デバイスか?
 241 .TP
 242 \fBS_ISBLK\fP(m)
 243 ブロック・デバイスか?
 244 .TP
 245 \fBS_ISFIFO\fP(m)
 246 FIFO (名前付きパイプ) か?
 247 .TP
 248 \fBS_ISLNK\fP(m)
 249 シンボリックリンクか? (POSIX.1\-1996 にはない)
 250 .TP
 251 \fBS_ISSOCK\fP(m)
 252 ソケットか? (POSIX.1\-1996 にはない)
 253 .RE
 254 .PP
 255 上で挙げたコードは以下のように書き換えることができる。
 256
 257 .nf
 258 .in +4n
 259 stat(pathname, &sb);
 260 if (S_ISREG(sb.st_mode)) {
 261     /* Handle regular file */
 262 }
 263 .in
 264 .fi
 265 .PP
 266 上記のほとんどのファイル種別検査マクロの定義は、 機能検査マクロ \fB_BSD_SOURCE\fP (glibc 2.19 以前の場合)、
 267 \fB_SVID_SOURCE\fP (glibc 2.19 以前の場合)、 \fB_DEFAULT_SOURCE\fP (glibc 2.20 以降の場合)
 268 のいずれかが定義されている場合に公開される。 さらに、 \fBS_IFSOCK\fP と \fBS_ISSOCK\fP 以外の上記のすべてのマクロの定義は
 269 \fB_XOPEN_SOURCE\fP が定義されている場合にも公開される。 \fBS_IFSOCK\fP の定義は \fB_XOPEN_SOURCE\fP が値 500
 270 以上で定義された場合にも公開される。
 271
 272 \fBS_ISSOCK\fP() の定義が公開されるのは以下の機能検査マクロが定義されている場合である: \fB_BSD_SOURCE\fP (glibc 2.19
 273 以前の場合)、 \fB_DEFAULT_SOURCE\fP (glibc 2.20 以降の場合)、 値 500 以上の \fB_XOPEN_SOURCE\fP、
 274 値が 200112L 以上の \fB_POSIX_C_SOURCE\fP。
 275 .PP
 276 以下のマスク値が \fIst_mode\fP フィールドのファイルのアクセス許可の検査用に定義されている。
 277 .in +4n
 278 .TS
 279 lB l l.
 280 S_ISUID 0004000 set\-user\-ID bit
 281 S_ISGID 0002000 set\-group\-ID bit (下記参照)
 282 S_ISVTX 0001000 スティッキー・ビット (下記参照)
 283
 284 S_IRWXU   00700 ファイル所有者のアクセス許可用のビットマスク
 285 S_IRUSR   00400 所有者の読み込み許可
 286 S_IWUSR   00200 所有者の書き込み許可
 287 S_IXUSR   00100 所有者の実行許可
 288
 289 S_IRWXG   00070 グループのアクセス許可用のビットマスク
 290 S_IRGRP   00040 グループの読み込み許可
 291 S_IWGRP   00020 グループの書き込み許可
 292 S_IXGRP   00010 グループの実行許可
 293
 294 S_IRWXO   00007 T{
 295 他人 (others) のアクセス許可用のビットマスク
 296 T}
 297 S_IROTH   00004 他人の読み込み許可
 298 S_IWOTH   00002 他人の書き込み許可
 299 S_IXOTH   00001 他人の実行許可
 300 .TE
 301 .in
 302 .P
 303 set\-group\-ID bit (\fBS_ISGID\fP)  にはいくつかの特殊な使用法がある: ディレクトリに設定した場合には、そのディレクトリが
 304 BSD 方式で使用される ことを示す。つまり、そのディレクトリに作成されたファイルのグループID は 作成したプロセスの実効 (effective)
 305 グループID ではなく、ディレクトリの グループID を継承する。また、そのディレクトリに作成されたディレクトリにも \fBS_ISGID\fP
 306 ビットが設定される。グループ実行ビット (\fBS_IXGRP\fP)  が設定されていないファイルに設定された場合は、 set\-group\-ID
 307 ビットはファイル/レコードの 強制的な (mandatory) ロックを表す。
 308 .P
 309 .\"
 310 .\"
 311 ディレクトリにスティッキービット (S_ISVTX) が設定された場合は、 そのディレクトリのファイルの名前を変更したり、削除したりできるのは、
 312 そのファイルの所有者か、そのディレクトリの所有者か、特権プロセス だけとなる。
 313 .SS fstatat()
 314 \fBfstatat\fP() システムコールは \fBstat\fP() と全く同様に動作するが、以下で説明する点が異なる。
 315
 316 指定された \fIpathname\fP が相対パスの場合、 ファイルディスクリプタ \fIdirfd\fP が参照するディレクトリに対する相対パスと解釈される
 317 (\fBstat\fP() に相対パスを渡した場合のように、呼び出したプロセスのカレントワーキングディレクトリに対する相対パスではない)。
 318
 319 \fIpathname\fP が相対パスで、 \fIdirfd\fP が特別な値 \fBAT_FDCWD\fP の場合、 (\fBstat\fP(2) と同様に)
 320 \fIpathname\fP は呼び出したプロセスのカレントワーキングディレクトリに対する相対パスと解釈される。
 321
 322 \fIpathname\fP で指定されたパス名が絶対パスの場合、 \fIdirfd\fP は無視される。
 323
 324 この \fIflags\fP 引き数は下記のフラグの 0 個以上の論理和を取ったものである:
 325 .TP
 326 \fBAT_EMPTY_PATH\fP (Linux 2.6.39 以降)
 327 .\" commit 65cfc6722361570bfe255698d9cd4dccaf47570d
 328 .\" Before glibc 2.16, defining _ATFILE_SOURCE sufficed
 329 \fIpathname\fP が空文字列の場合、 \fIdirfd\fP が参照するファイルに対して操作を行う (\fIdirfd\fP は \fBopen\fP(2) の
 330 \fBO_PATH\fP フラグを使って取得できる)。 \fBdirfd\fP が \fBAT_FDCWD\fP
 331 の場合、呼び出しはカレントワーキングディレクトリに対して操作を行う。 この場合、 \fIdirfd\fP
 332 は、ディレクトリだけでなく、任意のタイプのファイルを参照することができる。 このフラグは Linux 固有であり、その定義を得るには
 333 \fB_GNU_SOURCE\fP を定義すること。
 334 .TP
 335 \fBAT_NO_AUTOMOUNT\fP (Linux 2.6.38 以降)
 336 .\" Before glibc 2.16, defining _ATFILE_SOURCE sufficed
 337 \fIpathname\fP がオートマウントポイントとなっているディレクトリの場合、 \fIpathname\fP の最終 ("basename")
 338 要素のオートマウントを行わない。 これにより (マウントされるはずの場所ではなく) オートマウントポイントの属性を取得することができる。
 339 このフラグを使うと、 ディレクトリをスキャンするツールがオートマウントポイントのディレクトリを大量にオートマウントしてしまうのを防ぐことができる。
 340 マウントポイントがすでにマウントされている場合 \fBAT_NO_AUTOMOUNT\fP フラグは何の効果もない。 このフラグは Linux
 341 固有であり、その定義を得るには \fB_GNU_SOURCE\fP を定義すること。
 342 .TP
 343 \fBAT_SYMLINK_NOFOLLOW\fP
 344 (\fBlstat\fP() 同様) \fIpathname\fP がシンボリックリンクの場合リンクの展開を行わず、 リンク自身の情報を返す (デフォルトでは、
 345 \fBfstatat\fP() は、 \fBstat\fP() と同様に、シンボリックリンクの展開を行う)。
 346 .PP
 347 \fBfstatat\fP() の必要性についての説明については \fBopenat\fP(2) を参照。
 348 .SH 返り値
 349 成功した場合、0 が返される。 失敗した場合、 \-1 が返され、 \fIerrno\fP に適切な値がセットされる。
 350 .SH エラー
 351 .TP
 352 \fBEACCES\fP
 353 \fIpathname\fP が所属するディレクトリとその上位のディレクトリのいずれかに 対する検索許可がなかった
 354 (\fBpath_resolution\fP(7)  も参照のこと)。
 355 .TP
 356 \fBEBADF\fP
 357 \fIfd\fP が不正である。
 358 .TP
 359 \fBEFAULT\fP
 360 アドレスが間違っている。
 361 .TP
 362 \fBELOOP\fP
 363 パスを辿る際に解決すべきシンボリックリンクが多過ぎた。
 364 .TP
 365 \fBENAMETOOLONG\fP
 366 \fIpathname\fP が長過ぎる。
 367 .TP
 368 \fBENOENT\fP
 369 \fIpathname\fP の構成要素が存在しないか、 \fIpathname\fP が空文字列である。
 370 .TP
 371 \fBENOMEM\fP
 372 カーネルのメモリが足りない。
 373 .TP
 374 \fBENOTDIR\fP
 375 \fIpathname\fP の前半部分 (prefix) の構成要素がディレクトリではない。
 376 .TP
 377 \fBEOVERFLOW\fP
 378 \fIpathname\fP または \fIfd\fP が、ファイルサイズ、inode 番号、ブロック数が
 379 それぞれ \fIoff_t\fP 型、 \fIino_t\fP 型、 \fIblkcnt_t\fP 型で表現できないファイルを
 380 参照している。このエラーが起こるのは、例えば、32 ビットプラットフォーム上で
 381 \fI\-D_FILE_OFFSET_BITS=64\fP を指定せずにコンパイルされたアプリケーションが、
 382 ファイルサイズが \fI(1<<31)\-1\fP バイトを超えるファイルに対して
 383 \fBstat\fP() を呼び出した場合である。
 384 .PP
 385 \fBfstatat\fP() では以下のエラーも発生することがある。
 386 .TP
 387 \fBEBADF\fP
 388 \fIdirfd\fP が有効なファイルディスクリプタでない。
 389 .TP
 390 \fBEINVAL\fP
 391 \fIflags\fP に無効なフラグが指定された。
 392 .TP
 393 \fBENOTDIR\fP
 394 \fIpathname\fP が相対パスで、 \fIdirfd\fP がディレクトリ以外のファイルを参照しているファイルディスクリプタである。
 395 .SH バージョン
 396 \fBfstatat\fP()  はカーネル 2.6.16 で Linux に追加された。 ライブラリによるサポートはバージョン 2.4 で glibc
 397 に追加された。
 398 .SH 準拠
 399 .\" SVr4 documents additional
 400 .\" .BR fstat ()
 401 .\" error conditions EINTR, ENOLINK, and EOVERFLOW.  SVr4
 402 .\" documents additional
 403 .\" .BR stat ()
 404 .\" and
 405 .\" .BR lstat ()
 406 .\" error conditions EINTR, EMULTIHOP, ENOLINK, and EOVERFLOW.
 407 \fBstat\fP(), \fBfstat\fP(), \fBlstat\fP(): SVr4, 4.3BSD, POSIX.1\-2001, POSIX.1.2008.
 408
 409 \fBfstatat\fP(): POSIX.1\-2008.
 410
 411 POSIX.1\-2001 では、シンボリックリンクに対する \fBlstat\fP() で
 412 有効な情報を返すように求められていたのは、 \fIstat\fP 構造体の \fIst_size\fP
 413 と \fIst_mode\fP のファイル種別要素だけであった。
 414 POSIX.1\-2008 では規定が厳しくなり、 \fBlstat\fP() は \fIst_mode\fP の
 415 アクセス許可ビット以外の全てのフィールドに有効な情報を返すことが
 416 求められるようになっている。
 417
 418 \fIst_blocks\fP と \fIst_blksize\fP フィールドの使用はあまり移植性がない
 419 (これらのフィールドは BSD によって導入された。 システムごとに解釈が
 420 異なっており、 NFS マウントの場合には同じシステムでも異なる可能性がある)。
 421 \fI<sys/stat.h>\fP から \fIblkcnt_t\fP の \fIblksize_t\fP 型定義を
 422 読み込みたい場合は、(\fIどの\fPヘッダファイルをインクルードするよりも前に)
 423 \fB_XOPEN_SOURCE\fP を 500 以上の値で定義すること。
 424 .LP
 425 POSIX.1\-1990 には \fBS_IFMT\fP, \fBS_IFSOCK\fP, \fBS_IFLNK\fP, \fBS_IFREG\fP,
 426 \fBS_IFBLK\fP, \fBS_IFDIR\fP, \fBS_IFCHR\fP, \fBS_IFIFO\fP, \fBS_ISVTX\fP 定数に関する
 427 記述はなかったが、代わりに \fBS_ISDIR\fP() のようなマクロを使用するように
 428 要求していた。 \fBS_IF*\fP 定数は POSIX.1\-2001 以降には存在する。
 429
 430 マクロ \fBS_ISLNK\fP() と \fBS_ISSOCK\fP() は POSIX.1\-1996 にはないが、
 431 POSIX.1\-2001 には両方とも存在する。 前者は SVID 4 に、後者は SUSv2 に
 432 由来している。
 433 .LP
 434 UNIX\ V7 (とその後のシステム) は \fBS_IREAD\fP, \fBS_IWRITE\fP, \fBS_IEXEC\fP を持っており、
 435 POSIX はその同義語として \fBS_IRUSR\fP, \fBS_IWUSR\fP, \fBS_IXUSR\fP を規定している。
 436 .SS 他のシステム
 437 各種システムで使用されていた(いる)値:
 438 .ad l
 439 .TS
 440 l l l l l.
 441 16進   名前  ls      8進数 説明
 442 f000    S_IFMT          170000  ファイル種別フィールドのビットマスク
 443 0000                    000000  T{
 444 SCO では 使用不能 inode; BSD では不明なファイル種別;
 445 SVID\-v2 と XPG2 では 0 と 0100000 の両方が通常のファイル
 446 T}
 447 1000    S_IFIFO p|      010000  FIFO (名前付きパイプ)
 448 2000    S_IFCHR c       020000  キャラクタ特殊ファイル (V7)
 449 3000    S_IFMPC         030000  多重化されたキャラクタ特殊ファイル (V7)
 450 4000    S_IFDIR d/      040000  ディレクトリ (V7)
 451 5000    S_IFNAM         050000  T{
 452 XENIX の二つの副型を持つ名前付きの特殊ファイル
 453 副型は \fIst_rdev\fP の値 1, 2 で区別される
 454 T}
 455 0001    S_INSEM s       000001  XENIX の IFNAM セマフォ副型
 456 0002    S_INSHD m       000002  XENIX の IFNAM 共有データ副型
 457 6000    S_IFBLK b       060000  ブロック特殊ファイル (V7)
 458 7000    S_IFMPB         070000  多重化されたブロック特殊ファイル (V7)
 459 8000    S_IFREG \-      100000  通常ファイル (V7)
 460 9000    S_IFCMP         110000  VxFS 圧縮ファイル
 461 9000    S_IFNWK n       110000  ネットワーク特殊ファイル (HP\-UX)
 462 a000    S_IFLNK l@      120000  シンボリックリンク (BSD)
 463 b000    S_IFSHAD                130000  T{
 464 Solaris の ACL 用の隠し inode (ユーザ空間からは見えない)
 465 T}
 466 c000    S_IFSOCK        s=      140000  ソケット (BSD; VxFS の "S_IFSOC")
 467 d000    S_IFDOOR        D>      150000  Solaris の door ファイル
 468 e000    S_IFWHT w%      160000  BSD の空白ファイル (inode を使用しない)
 469 0200    S_ISVTX         001000  T{
 470 スティッキービット: 使用後もスワップに残す (V7)
 471 .br
 472 予約 (SVID\-v2)
 473 .br
 474 ディレクトリ以外: ファイルをキャッシュしない (SunOS)
 475 .br
 476 ディレクトリの場合: 削除制限フラグ (SVID\-v4.2)
 477 T}
 478 0400    S_ISGID         002000  T{
 479 実行時の set\-group\-ID (V7)
 480 .br
 481 ディレクトリの場合: GID の伝搬に BSD 方式を使用する
 482 T}
 483 0400    S_ENFMT         002000  T{
 484 System V ファイルロックを強制する (S_ISGID と共有)
 485 T}
 486 0800    S_ISUID         004000  実行時の set\-user\-ID (V7)
 487 0800    S_CDF           004000  T{
 488 ディレクトリがコンテキスト依存ファイル (HP\-UX)
 489 T}
 490 .TE
 491 .ad
 492
 493 スティッキー コマンドは Version 32V AT&T UNIX で登場した。
 494 .SH 注意
 495 Linux では、 \fBlstat\fP() は一般には自動マウント動作 (automounter action) の
 496 きっかけとならないが、 \fBstat\fP() はきっかけとなる (\fBfstatat\fP(2) を参照)。
 497
 498 \fI/proc\fP ディレクトリ以下にあるファイルのほとんどでは、 \fBstat\fP()  を呼び出した際に、 \fIst_size\fP
 499 フィールドにファイルサイズが返されない。 代わりに \fIst_size\fP フィールドには 0 が返される。
 500 .SS タイムスタンプフィールド
 501 古いカーネルや古い標準では、ナノ秒精度のタイムスタンプフィールドはサポートされていなかった。 代わりに 3 つの \fItime_t\fP
 502 型のタイムスタンプフィールド \fIst_atime\fP, \fIst_mtime\fP, and \fIst_ctime\fP があった。これらのフィールドには 1
 503 秒単位のタイムスタンプが記録されていた。
 504
 505 カーネル 2.5.48 以降では、 \fIstat\fP 構造体は 3 つのファイルのタイムスタンプ関連のフィールドでナノ秒単位の精度に対応している。
 506 機能検査マクロ \fB_BSD_SOURCE\fP か \fB_SVID_SOURCE\fP が定義された場合に、各タイムスタンプのナノ秒の情報は
 507 \fIst_atim.tv_nsec\fP という形式の名前で参照できる。 ナノ秒のタイムスタンプは現在では標準化されており、 POSIX.1\-2008
 508 からである。 バージョン 2.12 以降の glibc では、 \fB_POSIX_C_SOURCE\fP が 200809L 以上の値で定義されるか、
 509 \fB_XOPEN_SOURCE\fP が 700 以上の値で定義された場合にも、 このナノ秒のタイムスタンプが公開される。
 510 上記のマクロのいずれも定義されていない場合、ナノ秒の値は \fIst_atimensec\fP という形式の名前で公開される。
 511
 512 .\" commit ef7f38359ea8b3e9c7f2cae9a4d4935f55ca9e80
 513 ナノ秒のタイムスタンプは XFS, JFS, Btrfs, ext4 でサポートされている (Linux 2.6.23 以降)。
 514 ナノ秒のタイムスタンプは ext2, ext3, Reiserfs ではサポートされていない。
 515 サブ秒のタイムスタンプをサポートしていないファイルシステムでは、 ナノ秒のフィールドには値 0 が入る。
 516 .SS 背後のカーネル・インタフェース
 517 .\"
 518 .\" A note from Andries Brouwer, July 2007
 519 .\"
 520 .\" > Is the story not rather more complicated for some calls like
 521 .\" > stat(2)?
 522 .\"
 523 .\" Yes and no, mostly no. See /usr/include/sys/stat.h .
 524 .\"
 525 .\" The idea is here not so much that syscalls change, but that
 526 .\" the definitions of struct stat and of the types dev_t and mode_t change.
 527 .\" This means that libc (even if it does not call the kernel
 528 .\" but only calls some internal function) must know what the
 529 .\" format of dev_t or of struct stat is.
 530 .\" The communication between the application and libc goes via
 531 .\" the include file <sys/stat.h> that defines a _STAT_VER and
 532 .\" _MKNOD_VER describing the layout of the data that user space
 533 .\" uses. Each (almost each) occurrence of stat() is replaced by
 534 .\" an occurrence of xstat() where the first parameter of xstat()
 535 .\" is this version number _STAT_VER.
 536 .\"
 537 .\" Now, also the definitions used by the kernel change.
 538 .\" But glibc copes with this in the standard way, and the
 539 .\" struct stat as returned by the kernel is repacked into
 540 .\" the struct stat as expected by the application.
 541 .\" Thus, _STAT_VER and this setup cater for the application-libc
 542 .\" interface, rather than the libc-kernel interface.
 543 .\"
 544 .\" (Note that the details depend on gcc being used as c compiler.)
 545 時間の経過とともに、 \fIstat\fP 構造体のサイズが大きくなり、この影響で \fBstat\fP()  には 3つのバージョンが存在する:
 546 \fIsys_stat\fP()  (スロットは \fI__NR_oldstat\fP)、 \fIsys_newstat\fP()  (スロットは
 547 \fI__NR_stat\fP)、 \fIsys_stat64\fP()  (カーネル 2.4 で導入; スロットは \fI__NR_stat64\fP).  glibc
 548 の \fBstat\fP()  ラッパー関数はこれらの詳細をアプリケーションから隠蔽してくれる。
 549 具体的には、カーネルが提供しているシステムコールのうち最新のバージョンを 起動し、古いバイナリの場合には必要に応じて返された情報を再構成
 550 (repack) する。 \fBfstat\fP()  と \fBlstat\fP()  についても同様である。
 551
 552 glibc の \fBfstatat\fP() ラッパー関数が内部で利用するシステムコールは、実際には \fBfstatat64\fP() である。
 553 .SH 例
 554 以下のプログラムは \fBstat\fP()  を呼び出し、返ってきた \fIstat\fP 構造体のフィールドのいくつかを表示する。
 555 .nf
 556
 557 #include <sys/types.h>
 558 #include <sys/stat.h>
 559 #include <time.h>
 560 #include <stdio.h>
 561 #include <stdlib.h>
 562
 563 int
 564 main(int argc, char *argv[])
 565 {
 566     struct stat sb;
 567
 568     if (argc != 2) {
 569         fprintf(stderr, "Usage: %s <pathname>\en", argv[0]);
 570         exit(EXIT_FAILURE);
 571     }
 572
 573     if (stat(argv[1], &sb) == \-1) {
 574         perror("stat");
 575         exit(EXIT_FAILURE);
 576     }
 577
 578     printf("File type:                ");
 579
 580     switch (sb.st_mode & S_IFMT) {
 581     case S_IFBLK:  printf("block device\en");            break;
 582     case S_IFCHR:  printf("character device\en");        break;
 583     case S_IFDIR:  printf("directory\en");               break;
 584     case S_IFIFO:  printf("FIFO/pipe\en");               break;
 585     case S_IFLNK:  printf("symlink\en");                 break;
 586     case S_IFREG:  printf("regular file\en");            break;
 587     case S_IFSOCK: printf("socket\en");                  break;
 588     default:       printf("unknown?\en");                break;
 589     }
 590
 591     printf("I\-node number:            %ld\en", (long) sb.st_ino);
 592
 593     printf("Mode:                     %lo (octal)\en",
 594             (unsigned long) sb.st_mode);
 595
 596     printf("Link count:               %ld\en", (long) sb.st_nlink);
 597     printf("Ownership:                UID=%ld   GID=%ld\en",
 598             (long) sb.st_uid, (long) sb.st_gid);
 599
 600     printf("Preferred I/O block size: %ld bytes\en",
 601             (long) sb.st_blksize);
 602     printf("File size:                %lld bytes\en",
 603             (long long) sb.st_size);
 604     printf("Blocks allocated:         %lld\en",
 605             (long long) sb.st_blocks);
 606
 607     printf("Last status change:       %s", ctime(&sb.st_ctime));
 608     printf("Last file access:         %s", ctime(&sb.st_atime));
 609     printf("Last file modification:   %s", ctime(&sb.st_mtime));
 610
 611     exit(EXIT_SUCCESS);
 612 }
 613 .fi
 614 .SH 関連項目
 615 \fBls\fP(1), \fBstat\fP(1), \fBaccess\fP(2), \fBchmod\fP(2), \fBchown\fP(2),
 616 \fBreadlink\fP(2), \fButime\fP(2), \fBcapabilities\fP(7), \fBsymlink\fP(7)
 617 .SH この文書について
 618 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.78 の一部
 619 である。プロジェクトの説明とバグ報告に関する情報は
 620 http://www.kernel.org/doc/man\-pages/ に書かれている。