statfsのヘルプ・マニュアル
日本語 英語
statfs --help
man statfs
STATFS(2) Linux Programmer’s Manual STATFS(2)
名前
statfs, fstatfs - ファイル・システムの統計を得る
書式
#include /* または */
int statfs(const char *path, struct statfs *buf);
int fstatfs(int fd, struct statfs *buf);
書式
関 数 statfs() はマウントされたファイル・システムについての情報を返す。
path はマウントされたファイル・システムにあるファイルのパス名であ る 。
buf は statfs 構造体へのポインターで、およそ以下のように定義される:
struct statfs {
long f_type; /* ファイルシステムの型 (下記参照) */
long f_bsize; /* 最適なブロックサイズ */
long f_blocks; /* ファイルシステムの総データブロック数 */
long f_bfree; /* ファイルシステムの空きブロック数 */
long f_bavail; /* 非スーパーユーザが使用可能な空きブロック数 */
long f_files; /* ファイルシステムの総ファイルノード数 */
long f_ffree; /* ファイルシステムの空きファイルノード数 */
fsid_t f_fsid; /* ファイルシステムの ID */
long f_namelen; /* ファイル名の最大長 */
};
ファイル・システムの型:
ADFS_SUPER_MAGIC 0xadf5
AFFS_SUPER_MAGIC 0xADFF
BEFS_SUPER_MAGIC 0x42465331
BFS_MAGIC 0x1BADFACE
CIFS_MAGIC_NUMBER 0xFF534D42
CODA_SUPER_MAGIC 0x73757245
COH_SUPER_MAGIC 0x012FF7B7
CRAMFS_MAGIC 0x28cd3d45
DEVFS_SUPER_MAGIC 0x1373
EFS_SUPER_MAGIC 0x00414A53
EXT_SUPER_MAGIC 0x137D
EXT2_OLD_SUPER_MAGIC 0xEF51
EXT2_SUPER_MAGIC 0xEF53
EXT3_SUPER_MAGIC 0xEF53
HFS_SUPER_MAGIC 0x4244
HPFS_SUPER_MAGIC 0xF995E849
HUGETLBFS_MAGIC 0x958458f6
ISOFS_SUPER_MAGIC 0x9660
JFFS2_SUPER_MAGIC 0x72b6
JFS_SUPER_MAGIC 0x3153464a
MINIX_SUPER_MAGIC 0x137F /* オリジナルの minix */
MINIX_SUPER_MAGIC2 0x138F /* 30 文字ファイル名の minix */
MINIX2_SUPER_MAGIC 0x2468 /* minix V2 */
MINIX2_SUPER_MAGIC2 0x2478 /* minix V2, 30 文字ファイル名 */
MSDOS_SUPER_MAGIC 0x4d44
NCP_SUPER_MAGIC 0x564c
NFS_SUPER_MAGIC 0x6969
NTFS_SB_MAGIC 0x5346544e
OPENPROM_SUPER_MAGIC 0x9fa1
PROC_SUPER_MAGIC 0x9fa0
QNX4_SUPER_MAGIC 0x002f
REISERFS_SUPER_MAGIC 0x52654973
ROMFS_MAGIC 0x7275
SMB_SUPER_MAGIC 0x517B
SYSV2_SUPER_MAGIC 0x012FF7B6
SYSV4_SUPER_MAGIC 0x012FF7B5
TMPFS_MAGIC 0x01021994
UDF_SUPER_MAGIC 0x15013346
UFS_MAGIC 0x00011954
USBDEVICE_SUPER_MAGIC 0x9fa2
VXFS_SUPER_MAGIC 0xa501FCF5
XENIX_SUPER_MAGIC 0x012FF7B4
XFS_SUPER_MAGIC 0x58465342
_XIAFS_SUPER_MAGIC 0x012FD16D
f_fsid にどんな値が入るべきなのかは誰も知らない (但し、下記を参照)。
それぞれのファイル・システムにおいて未定義のフィールドには 0 が設定され
る。 fstatfs() はディスクリプター fd によって参照されるオープンされたフ
ァイルについて、同じ情報を返す。
返り値
成 功すれば 0 が返される。エラーの場合は -1 が返され、 errno が適切に設
定される。
エラー
EACCES (statfs() の場合) path のディレクトリ部分に検索許可が与えられ て
いない (path_resolution(7) も参照すること)。
EBADF (fstatfs() の場合) fd は有効なオープンされたファイル・ディスクリ
プターではない。
EFAULT buf または path が不正なアドレスを指している。
EINTR この呼び出しがシグナルで中断された。
EIO ファイル・システムの読み込みの間に I/O エラーが発生した。
ELOOP (statfs() の場合) path を解決するのに辿るべきシンボリック・リ ン
クが多すぎる。
ENAMETOOLONG
(statfs() の場合) path が長過ぎる。
ENOENT (statfs() の場合) path によって参照されるファイルが存在しない。
ENOMEM カーネルに十分なメモリがない。
ENOSYS ファイル・システムがこの呼び出しをサポートしていない。
ENOTDIR
(statfs() の場合) path のディレクトリ部分がディレクトリでない。
EOVERFLOW
値が大き過ぎるため、返り値の構造体で表現できない。
準拠
Linux 固有である。 Linux の statfs() は 4.4BSD のものに影響を受けている
。 (しかし同じ構造体を使用しているわけではない)
注意
このライブラリコールをサポートするため、カーネルにはシス テ ム コ ー ル
statfs(), fstatfs(), statfs64(), fstatfs64() がある。
しか持たないシステムもあり、 も持っているシ
ステムもある。前者は後者をインクルードするので、前者をインクルードす る
のが良いと考えられる。
LSB ではライブラリコール statfs(), fstatfs() を非推奨として、代わりに
statvfs(2), fstatvfs(2) を使うように指示している。
f_fsid フィールド
Solaris, Irix, POSIX にはシステムコール statvfs(2) が あ り 、 struct
statvfs を 返 す ( で定義されている)。この構造体には、
unsigned long f_fsid が含まれている。 Linux, SunOS, HP-UX, 4.4BSD に は
システムコール statfs() があり、 struct statfs を返す ( で定
義されている)。この構造体には fsid_t f_fsid, が含まれており、 fsid_t は
struct { int val[2]; } と定義されている。 FreeBSD でも同じであるが、イ
ンクルードファイル を使う。
f_fsid はあるランダムな値を持ち、 (f_fsid,ino) という 1 組の値でファ イ
ル を一意に決定できるようにする、というのが基本的な考え方である。いくつ
かの OS では、デバイス番号 (の変種) を使ったり、デバイス番号とファイ ル
・ システムタイプを組み合わせて使ったりしている。 OS の中には f_fsid フ
ィールドの取得をスーパーユーザに限定しているものもある (非特権ユーザ が
取得すると 0 となる)。 NFS でエクスポートされる場合、このフィールドがフ
ァイル・システムのファイルハンドルで使われており、この値を提供すると セ
キュリティ上の問題がある。
い くつかの OS では、 fsid を sysfs() システムコールの第 2 引き数として
使用できる。
関連項目
stat(2), statvfs(2), path_resolution(7)
Linux 2004-06-23 STATFS(2)
STATFS(2) Linux Programmer’s Manual STATFS(2)
NAME
statfs, fstatfs - get filesystem statistics
SYNOPSIS
#include /* or */
int statfs(const char *path, struct statfs *buf);
int fstatfs(int fd, struct statfs *buf);
DESCRIPTION
The statfs() system call returns information about a mounted filesys-
tem. path is the pathname of any file within the mounted filesystem.
buf is a pointer to a statfs structure defined approximately as fol-
lows:
struct statfs {
__fsword_t f_type; /* Type of filesystem (see below) */
__fsword_t f_bsize; /* Optimal transfer block size */
fsblkcnt_t f_blocks; /* Total data blocks in filesystem */
fsblkcnt_t f_bfree; /* Free blocks in filesystem */
fsblkcnt_t f_bavail; /* Free blocks available to
unprivileged user */
fsfilcnt_t f_files; /* Total file nodes in filesystem */
fsfilcnt_t f_ffree; /* Free file nodes in filesystem */
fsid_t f_fsid; /* Filesystem ID */
__fsword_t f_namelen; /* Maximum length of filenames */
__fsword_t f_frsize; /* Fragment size (since Linux 2.6) */
__fsword_t f_flags; /* Mount flags of filesystem
(since Linux 2.6.36) */
__fsword_t f_spare[xxx];
/* Padding bytes reserved for future use */
};
Filesystem types:
ADFS_SUPER_MAGIC 0xadf5
AFFS_SUPER_MAGIC 0xADFF
BDEVFS_MAGIC 0x62646576
BEFS_SUPER_MAGIC 0x42465331
BFS_MAGIC 0x1BADFACE
BINFMTFS_MAGIC 0x42494e4d
BTRFS_SUPER_MAGIC 0x9123683E
CGROUP_SUPER_MAGIC 0x27e0eb
CIFS_MAGIC_NUMBER 0xFF534D42
CODA_SUPER_MAGIC 0x73757245
COH_SUPER_MAGIC 0x012FF7B7
CRAMFS_MAGIC 0x28cd3d45
DEBUGFS_MAGIC 0x64626720
DEVFS_SUPER_MAGIC 0x1373
DEVPTS_SUPER_MAGIC 0x1cd1
EFIVARFS_MAGIC 0xde5e81e4
EFS_SUPER_MAGIC 0x00414A53
EXT_SUPER_MAGIC 0x137D
EXT2_OLD_SUPER_MAGIC 0xEF51
EXT2_SUPER_MAGIC 0xEF53
EXT3_SUPER_MAGIC 0xEF53
EXT4_SUPER_MAGIC 0xEF53
FUSE_SUPER_MAGIC 0x65735546
FUTEXFS_SUPER_MAGIC 0xBAD1DEA
HFS_SUPER_MAGIC 0x4244
HOSTFS_SUPER_MAGIC 0x00c0ffee
HPFS_SUPER_MAGIC 0xF995E849
HUGETLBFS_MAGIC 0x958458f6
ISOFS_SUPER_MAGIC 0x9660
JFFS2_SUPER_MAGIC 0x72b6
JFS_SUPER_MAGIC 0x3153464a
MINIX_SUPER_MAGIC 0x137F /* orig. minix */
MINIX_SUPER_MAGIC2 0x138F /* 30 char minix */
MINIX2_SUPER_MAGIC 0x2468 /* minix V2 */
MINIX2_SUPER_MAGIC2 0x2478 /* minix V2, 30 char names */
MINIX3_SUPER_MAGIC 0x4d5a /* minix V3 fs, 60 char names */
MQUEUE_MAGIC 0x19800202
MSDOS_SUPER_MAGIC 0x4d44
NCP_SUPER_MAGIC 0x564c
NFS_SUPER_MAGIC 0x6969
NILFS_SUPER_MAGIC 0x3434
NTFS_SB_MAGIC 0x5346544e
OCFS2_SUPER_MAGIC 0x7461636f
OPENPROM_SUPER_MAGIC 0x9fa1
PIPEFS_MAGIC 0x50495045
PROC_SUPER_MAGIC 0x9fa0
PSTOREFS_MAGIC 0x6165676C
QNX4_SUPER_MAGIC 0x002f
QNX6_SUPER_MAGIC 0x68191122
RAMFS_MAGIC 0x858458f6
REISERFS_SUPER_MAGIC 0x52654973
ROMFS_MAGIC 0x7275
SELINUX_MAGIC 0xf97cff8c
SMACK_MAGIC 0x43415d53
SMB_SUPER_MAGIC 0x517B
SOCKFS_MAGIC 0x534F434B
SQUASHFS_MAGIC 0x73717368
SYSFS_MAGIC 0x62656572
SYSV2_SUPER_MAGIC 0x012FF7B6
SYSV4_SUPER_MAGIC 0x012FF7B5
TMPFS_MAGIC 0x01021994
UDF_SUPER_MAGIC 0x15013346
UFS_MAGIC 0x00011954
USBDEVICE_SUPER_MAGIC 0x9fa2
V9FS_MAGIC 0x01021997
VXFS_SUPER_MAGIC 0xa501FCF5
XENFS_SUPER_MAGIC 0xabba1974
XENIX_SUPER_MAGIC 0x012FF7B4
XFS_SUPER_MAGIC 0x58465342
_XIAFS_SUPER_MAGIC 0x012FD16D
Most of these MAGIC constants are defined in
/usr/include/linux/magic.h, and some are hardcoded in kernel sources.
The f_flags is a bit mask indicating mount options for the file system.
It contains zero or more of the following bits:
ST_MANDLOCK
Mandatory locking is permitted on the filesystem (see fcntl(2)).
ST_NOATIME
Do not update access times; see mount(2).
ST_NODEV
Disallow access to device special files on this filesystem.
ST_NODIRATIME
Do not update directory access times; see mount(2).
ST_NOEXEC
Execution of programs is disallowed on this filesystem.
ST_NOSUID
The set-user-ID and set-group-ID bits are ignored by exec(3) for
executable files on this filesystem
ST_RDONLY
This filesystem is mounted read-only.
ST_RELATIME
Update atime relative to mtime/ctime; see mount(2).
ST_SYNCHRONOUS
Writes are synched to the filesystem immediately (see the
description of O_SYNC in open(2)).
Nobody knows what f_fsid is supposed to contain (but see below).
Fields that are undefined for a particular filesystem are set to 0.
fstatfs() returns the same information about an open file referenced by
descriptor fd.
RETURN VALUE
On success, zero is returned. On error, -1 is returned, and errno is
set appropriately.
ERRORS
EACCES (statfs()) Search permission is denied for a component of the
path prefix of path. (See also path_resolution(7).)
EBADF (fstatfs()) fd is not a valid open file descriptor.
EFAULT buf or path points to an invalid address.
EINTR This call was interrupted by a signal.
EIO An I/O error occurred while reading from the filesystem.
ELOOP (statfs()) Too many symbolic links were encountered in translat-
ing path.
ENAMETOOLONG
(statfs()) path is too long.
ENOENT (statfs()) The file referred to by path does not exist.
ENOMEM Insufficient kernel memory was available.
ENOSYS The filesystem does not support this call.
ENOTDIR
(statfs()) A component of the path prefix of path is not a
directory.
EOVERFLOW
Some values were too large to be represented in the returned
struct.
CONFORMING TO
Linux-specific. The Linux statfs() was inspired by the 4.4BSD one (but
they do not use the same structure).
NOTES
The __fsword_t type used for various fields in the statfs structure
definition is a glibc internal type, not intended for public use. This
leaves the programmer in a bit of a conundrum when trying to copy or
compare these fields to local variables in a program. Using
unsigned int for such variables suffices on most systems.
The original Linux statfs() and fstatfs() system calls were not
designed with extremely large file sizes in mind. Subsequently, Linux
2.6 added new statfs64() and fstatfs64() system calls that employ a new
structure, statfs64. The new structure contains the same fields as the
original statfs structure, but the sizes of various fields are
increased, to accommodate large file sizes. The glibc statfs() and
fstatfs() wrapper functions transparently deal with the kernel differ-
ences.
Some systems have only , other systems also have
, where the former includes the latter. So it seems
including the former is the best choice.
LSB has deprecated the library calls statfs() and fstatfs() and tells
us to use statvfs(2) and fstatvfs(2) instead.
The f_fsid field
Solaris, Irix and POSIX have a system call statvfs(2) that returns a
struct statvfs (defined in ) containing an unsigned long
f_fsid. Linux, SunOS, HP-UX, 4.4BSD have a system call statfs() that
returns a struct statfs (defined in ) containing a fsid_t
f_fsid, where fsid_t is defined as struct { int val[2]; }. The same
holds for FreeBSD, except that it uses the include file .
The general idea is that f_fsid contains some random stuff such that
the pair (f_fsid,ino) uniquely determines a file. Some operating sys-
tems use (a variation on) the device number, or the device number com-
bined with the filesystem type. Several operating systems restrict
giving out the f_fsid field to the superuser only (and zero it for
unprivileged users), because this field is used in the filehandle of
the filesystem when NFS-exported, and giving it out is a security con-
cern.
Under some operating systems, the fsid can be used as the second argu-
ment to the sysfs(2) system call.
BUGS
From Linux 2.6.38 up to and including Linux 3.1, fstatfs() failed with
the error ENOSYS for file descriptors created by pipe(2).
SEE ALSO
stat(2), statvfs(2), path_resolution(7)
Linux 2015-02-21 STATFS(2)