release/man2/statfs.2

   1 .\" Copyright (C) 2003 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" Modified 2003-08-17 by Walter Harms
  24 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
  25 .\"
  26 .\"*******************************************************************
  27 .\"
  28 .\" This file was generated with po4a. Translate the source file.
  29 .\"
  30 .\"*******************************************************************
  31 .TH STATFS 2 2010\-11\-21 Linux "Linux Programmer's Manual"
  32 .SH 名前
  33 statfs, fstatfs \- ファイルシステムの統計を取得する
  34 .SH 書式
  35 \fB#include <sys/vfs.h> \fP/* または <sys/statfs.h> */
  36 .sp
  37 \fBint statfs(const char *\fP\fIpath\fP\fB, struct statfs *\fP\fIbuf\fP\fB);\fP
  38 .br
  39 \fBint fstatfs(int \fP\fIfd\fP\fB, struct statfs *\fP\fIbuf\fP\fB);\fP
  40 .SH 説明
  41 関数 \fBstatfs\fP()  はマウントされたファイルシステムについての情報を返す。 \fIpath\fP
  42 はマウントされたファイルシステムにあるファイルのパス名である。 \fIbuf\fP は \fIstatfs\fP
  43 構造体へのポインターで、およそ以下のように定義される:
  44
  45 .in +4n
  46 .nf
  47 #if __WORDSIZE == 32            /* システムのワードサイズ */
  48 # define __SWORD_TYPE           int
  49 #else /* __WORDSIZE == 64 */
  50 # define __SWORD_TYPE           long int
  51 #endif
  52
  53 struct statfs {
  54     __SWORD_TYPE f_type;    /* ファイルシステムの種別 (下記参照) */
  55     __SWORD_TYPE f_bsize;   /* 最適な転送ブロックサイズ */
  56     fsblkcnt_t   f_blocks;  /* ファイルシステムの総データブロック数 */
  57     fsblkcnt_t   f_bfree;   /* ファイルシステムの空きブロック数 */
  58     fsblkcnt_t   f_bavail;  /* 非特権ユーザが利用可能な空きブロック数 */
  59     fsfilcnt_t   f_files;   /* ファイルシステムの総ファイルノード数 */
  60     fsfilcnt_t   f_ffree;   /* ファイルシステムの空きファイルノード数 */
  61     fsid_t       f_fsid;    /* ファイルシステムの ID */
  62     __SWORD_TYPE f_namelen; /* ファイル名の最大長 */
  63     __SWORD_TYPE f_frsize;  /* フラグメントサイズ (Linux 2.6 以降) */
  64     __SWORD_TYPE f_spare[5];
  65 };
  66
  67 ファイルシステムの型:
  68
  69    ADFS_SUPER_MAGIC      0xadf5
  70    AFFS_SUPER_MAGIC      0xADFF
  71    BEFS_SUPER_MAGIC      0x42465331
  72    BFS_MAGIC             0x1BADFACE
  73    CIFS_MAGIC_NUMBER     0xFF534D42
  74    CODA_SUPER_MAGIC      0x73757245
  75    COH_SUPER_MAGIC       0x012FF7B7
  76    CRAMFS_MAGIC          0x28cd3d45
  77    DEVFS_SUPER_MAGIC     0x1373
  78    EFS_SUPER_MAGIC       0x00414A53
  79    EXT_SUPER_MAGIC       0x137D
  80    EXT2_OLD_SUPER_MAGIC  0xEF51
  81    EXT2_SUPER_MAGIC      0xEF53
  82    EXT3_SUPER_MAGIC      0xEF53
  83    EXT4_SUPER_MAGIC      0xEF53
  84    HFS_SUPER_MAGIC       0x4244
  85    HPFS_SUPER_MAGIC      0xF995E849
  86    HUGETLBFS_MAGIC       0x958458f6
  87    ISOFS_SUPER_MAGIC     0x9660
  88    JFFS2_SUPER_MAGIC     0x72b6
  89    JFS_SUPER_MAGIC       0x3153464a
  90    MINIX_SUPER_MAGIC     0x137F /* オリジナルの minix */
  91    MINIX_SUPER_MAGIC2    0x138F /* 30 文字ファイル名の minix */
  92    MINIX2_SUPER_MAGIC    0x2468 /* minix V2 */
  93    MINIX2_SUPER_MAGIC2   0x2478 /* minix V2, 30 文字ファイル名 */
  94    MSDOS_SUPER_MAGIC     0x4d44
  95    NCP_SUPER_MAGIC       0x564c
  96    NFS_SUPER_MAGIC       0x6969
  97    NTFS_SB_MAGIC         0x5346544e
  98    OPENPROM_SUPER_MAGIC  0x9fa1
  99    PROC_SUPER_MAGIC      0x9fa0
 100    QNX4_SUPER_MAGIC      0x002f
 101    REISERFS_SUPER_MAGIC  0x52654973
 102    ROMFS_MAGIC           0x7275
 103    SMB_SUPER_MAGIC       0x517B
 104    SYSV2_SUPER_MAGIC     0x012FF7B6
 105    SYSV4_SUPER_MAGIC     0x012FF7B5
 106    TMPFS_MAGIC           0x01021994
 107    UDF_SUPER_MAGIC       0x15013346
 108    UFS_MAGIC             0x00011954
 109    USBDEVICE_SUPER_MAGIC 0x9fa2
 110    VXFS_SUPER_MAGIC      0xa501FCF5
 111    XENIX_SUPER_MAGIC     0x012FF7B4
 112    XFS_SUPER_MAGIC       0x58465342
 113    _XIAFS_SUPER_MAGIC    0x012FD16D
 114 .fi
 115 .in
 116 .PP
 117 \fIf_fsid\fP にどんな値が入るべきなのかは誰も知らない (但し、下記を参照)。
 118 .PP
 119 それぞれのファイルシステムにおいて未定義のフィールドには 0 が 設定される。 \fBfstatfs\fP()  はディスクリプター \fIfd\fP
 120 によって参照されるオープンされたファイルについて、同じ情報を返す。
 121 .SH 返り値
 122 成功した場合、0 が返される。 失敗した場合、 \-1 が返され、 \fIerrno\fP に適切な値がセットされる。
 123 .SH エラー
 124 .TP
 125 \fBEACCES\fP
 126 (\fBstatfs\fP()  の場合)  \fIpath\fP のディレクトリ部分に検索許可が与えられていない (\fBpath_resolution\fP(7)
 127 も参照すること)。
 128 .TP
 129 \fBEBADF\fP
 130 (\fBfstatfs\fP()  の場合)  \fIfd\fP は有効なオープンされたファイルディスクリプターではない。
 131 .TP
 132 \fBEFAULT\fP
 133 \fIbuf\fP または \fIpath\fP が不正なアドレスを指している。
 134 .TP
 135 \fBEINTR\fP
 136 この呼び出しがシグナルで中断された。
 137 .TP
 138 \fBEIO\fP
 139 ファイルシステムからの読み込みの間に I/O エラーが発生した。
 140 .TP
 141 \fBELOOP\fP
 142 (\fBstatfs\fP()  の場合)  \fIpath\fP を解決するのに辿るべきシンボリックリンクが多すぎる。
 143 .TP
 144 \fBENAMETOOLONG\fP
 145 (\fBstatfs\fP()  の場合)  \fIpath\fP が長過ぎる。
 146 .TP
 147 \fBENOENT\fP
 148 (\fBstatfs\fP()  の場合)  \fIpath\fP によって参照されるファイルが存在しない。
 149 .TP
 150 \fBENOMEM\fP
 151 十分なカーネルメモリがない。
 152 .TP
 153 \fBENOSYS\fP
 154 ファイルシステムがこの呼び出しをサポートしていない。
 155 .TP
 156 \fBENOTDIR\fP
 157 (\fBstatfs\fP()  の場合)  \fIpath\fP のディレクトリ部分がディレクトリでない。
 158 .TP
 159 \fBEOVERFLOW\fP
 160 いくつかの値が大き過ぎて、返り値の構造体で表現できない。
 161 .SH 準拠
 162 Linux 固有である。 Linux の \fBstatfs\fP()  は 4.4BSD のものに影響を受けている。
 163 (しかし同じ構造体を使用しているわけではない)
 164 .SH 注意
 165 元々の Linux の \fBstatfs\fP() と \fBfstatfs\fP() システムコールは
 166 非常に大きなファイルサイズを念頭に入れて設計されていなかった。
 167 その後、Linux 2.6 で、新しい構造体 \fIstatfs64\fP を使用する
 168 新しいシステムコール \fBstatfs64\fP() と \fBfstatfs64\fP() が追加された。
 169 新しい構造体は元の \fIstatfs\fP 構造体と同じフィールドを持つが、
 170 いろいろなフィールドのサイズが大きなファイルサイズに対応できるように
 171 増やされている。 glibc の \fBstatfs\fP() と \fBfstatfs\fP() のラッパー関数は
 172 カーネルによるこれらの違いを吸収している。
 173
 174 \fI<sys/vfs.h>\fP しか持たないシステムもあり、 \fI<sys/statfs.h>\fP
 175 も持っているシステムもある。 前者は後者をインクルードするので、 前者をインクルードするのが良いと考えられる。
 176
 177 LSB ではライブラリコール \fBstatfs\fP(), \fBfstatfs\fP()  を非推奨として、代わりに \fBstatvfs\fP(2),
 178 \fBfstatvfs\fP(2)  を使うように指示している。
 179 .SS "f_fsid フィールド"
 180 Solaris, Irix, POSIX にはシステムコール \fBstatvfs\fP(2)  があり、 \fIstruct statvfs\fP を返す
 181 (\fI<sys/statvfs.h>\fP で定義されている)。 この構造体には、 \fIunsigned long\fP \fIf_fsid\fP
 182 が含まれている。 Linux, SunOS, HP\-UX, 4.4BSD にはシステムコール \fBstatfs\fP()  があり、 \fIstruct
 183 statfs\fP を返す (\fI<sys/vfs.h>\fP で定義されている)。 この構造体には \fIfsid_t\fP \fIf_fsid\fP,
 184 が含まれており、 \fIfsid_t\fP は \fIstruct { int val[2]; }\fP と定義されている。 FreeBSD
 185 でも同じであるが、インクルードファイル \fI<sys/mount.h>\fP を使う。
 186
 187 \fIf_fsid\fP はあるランダムな値を持ち、 (\fIf_fsid\fP,\fIino\fP)  という 1 組の値でファイルを一意に決定できるようにする、
 188 というのが基本的な考え方である。 いくつかの OS では、デバイス番号 (の変種) を使ったり、
 189 デバイス番号とファイルシステムタイプを組み合わせて使ったりしている。 OS の中には \fIf_fsid\fP
 190 フィールドの取得をスーパーユーザに限定しているものもある (非特権ユーザが取得すると 0 となる)。 NFS でエクスポートされる場合、
 191 このフィールドがファイルシステムのファイルハンドルで使われており、 この値を提供するとセキュリティ上の問題がある。
 192 .LP
 193 いくつかの OS では、 \fIfsid\fP を \fBsysfs\fP(2)  システムコールの第 2 引き数として使用できる。
 194 .SH 関連項目
 195 \fBstat\fP(2), \fBstatvfs\fP(2), \fBpath_resolution\fP(7)