OSDN Git Service

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