NAME |SYNOPSIS |DESCRIPTION |RETURN VALUE |ERRORS |ATTRIBUTES |CONFORMING TO |NOTES |SEE ALSO |COLOPHON |
STATVFS(3) Linux Programmer's Manual STATVFS(3)statvfs, fstatvfs - get filesystem statistics
#include <sys/statvfs.h>int statvfs(const char *path, struct statvfs *buf);int fstatvfs(intfd, struct statvfs *buf);
The functionstatvfs() returns information about a mounted filesystem.path is the pathname of any file within the mounted filesystem.buf is a pointer to astatvfs structure defined approximately as follows: struct statvfs { unsigned long f_bsize; /* Filesystem block size */ unsigned long f_frsize; /* Fragment size */ fsblkcnt_t f_blocks; /* Size of fs in f_frsize units */ fsblkcnt_t f_bfree; /* Number of free blocks */ fsblkcnt_t f_bavail; /* Number of free blocks for unprivileged users */ fsfilcnt_t f_files; /* Number of inodes */ fsfilcnt_t f_ffree; /* Number of free inodes */ fsfilcnt_t f_favail; /* Number of free inodes for unprivileged users */ unsigned long f_fsid; /* Filesystem ID */ unsigned long f_flag; /* Mount flags */ unsigned long f_namemax; /* Maximum filename length */ }; Here the typesfsblkcnt_t andfsfilcnt_t are defined in<sys/types.h>. Both used to beunsigned long. The fieldf_flag is a bit mask indicating various options that were employed when mounting this filesystem. It contains zero or more of the following flags:ST_MANDLOCK Mandatory locking is permitted on the filesystem (seefcntl(2)).ST_NOATIME Do not update access times; seemount(2).ST_NODEV Disallow access to device special files on this filesystem.ST_NODIRATIME Do not update directory access times; seemount(2).ST_NOEXEC Execution of programs is disallowed on this filesystem.ST_NOSUID The set-user-ID and set-group-ID bits are ignored byexec(3) for executable files on this filesystemST_RDONLY This filesystem is mounted read-only.ST_RELATIME Update atime relative to mtime/ctime; seemount(2).ST_SYNCHRONOUS Writes are synched to the filesystem immediately (see the description ofO_SYNCinopen(2)). It is unspecified whether all members of the returned struct have meaningful values on all filesystems.fstatvfs() returns the same information about an open file referenced by descriptorfd.On success, zero is returned. On error, -1 is returned, anderrno is set appropriately.
EACCES(statvfs()) Search permission is denied for a component of the path prefix ofpath. (See alsopath_resolution(7).)EBADF(fstatvfs())fd is not a valid open file descriptor.EFAULTBuf orpath points to an invalid address.EINTRThis call was interrupted by a signal; seesignal(7).EIOAn I/O error occurred while reading from the filesystem.ELOOP(statvfs()) Too many symbolic links were encountered in translatingpath.ENAMETOOLONG (statvfs())path is too long.ENOENT(statvfs()) The file referred to bypath does not exist.ENOMEMInsufficient kernel memory was available.ENOSYSThe filesystem does not support this call.ENOTDIR (statvfs()) A component of the path prefix ofpath is not a directory.EOVERFLOW Some values were too large to be represented in the returned struct.
For an explanation of the terms used in this section, seeattributes(7). ┌──────────────────────┬───────────────┬─────────┐ │Interface│Attribute│Value│ ├──────────────────────┼───────────────┼─────────┤ │statvfs(),fstatvfs() │ Thread safety │ MT-Safe │ └──────────────────────┴───────────────┴─────────┘
POSIX.1-2001, POSIX.1-2008. Only theST_NOSUIDandST_RDONLYflags of thef_flag field are specified in POSIX.1. To obtain definitions of the remaining flags, one must define_GNU_SOURCE.
The Linux kernel has system callsstatfs(2) andfstatfs(2) to support this library call. In glibc versions before 2.13,statvfs() populated the bits of thef_flag field by scanning the mount options shown in/proc/mounts. However, starting with Linux 2.6.36, the underlyingstatfs(2) system call provides the necessary information via thef_flags field, and since glibc version 2.13, thestatvfs() function will use information from that field rather than scanning/proc/mounts. The glibc implementations of pathconf(path, _PC_REC_XFER_ALIGN); pathconf(path, _PC_ALLOC_SIZE_MIN); pathconf(path, _PC_REC_MIN_XFER_SIZE); respectively use thef_frsize,f_frsize, andf_bsize fields returned by a call tostatvfs() with the argumentpath.
statfs(2)
This page is part of release 5.07 of the Linuxman-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found athttps://www.kernel.org/doc/man-pages/.Linux 2017-09-15 STATVFS(3)Pages that refer to this page:fstatfs(2), fstatfs64(2), statfs(2), statfs64(2)
Copyright and license for this manual page
HTML rendering created 2020-07-14 byMichael Kerrisk, author ofThe Linux Programming Interface, maintainer of theLinuxman-pages project. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH. |  |