STATVFS(3)

NAME
statvfs, fstatvfs - get file system statistics

SYNOPSIS
#include <sys/statvfs.h>
int
statvfs(const char *path, struct statvfs *buf);
int
fstatvfs(int fd, struct statvfs *buf);

DESCRIPTION
statvfs() returns information about a mounted file system. path is the path name of any file within the mounted file system. buf is a pointer to a statvfs structure defined as follows:

    struct statvfs {
            unsigned long f_bsize;    /* file system block size */
            unsigned long f_frsize;   /* fundamental file system block size */
            fsblkcnt_t    f_blocks;   /* number of blocks (unit f_frsize) */
            fsblkcnt_t    f_bfree;    /* free blocks in file system */
            fsblkcnt_t    f_bavail;   /* free blocks for non-root */
            fsfilcnt_t    f_files;    /* total file inodes */
            fsfilcnt_t    f_ffree;    /* free file inodes */
            fsfilcnt_t    f_favail;   /* free file inodes for to non-root */
            unsigned long f_fsid;     /* file system id */
            unsigned long f_flag;     /* bit mask of f_flag values */
            unsigned long f_namemax;  /* maximum filename length */
    };
    #define ST_RDONLY     0x0001UL    /* read-only filesystem */
    #define	ST_NOSUID     0x0002UL    /* nosuid flag set */

The fields of type fsblkcnt_t are reported in units of f_frsize.

fstatvfs() returns the same information about an open file referenced by descriptor fd.

RETURN VALUES
Upon successful completion, a value of 0 is returned. Otherwise, -1 is returned and the global variable errno is set to indicate the error.

ERRORS
statvfs() fails if one or more of the following are true:

[ENOTDIR]
    A component of the path prefix of path is not a directory.

[ENAMETOOLONG]
    The length of a component of path exceeds {NAME_MAX} characters, or the length of path exceeds {PATH_MAX} characters.

[ENOENT]
    The file referred to by path does not exist.

[EACCES]
    Search permission is denied for a component of the path prefix of path.

[ELOOP]
    Too many symbolic links were encountered in translating path.

[EFAULT]
    buf or path points to an invalid address.

[EIO]
    An I/O error occurred while reading from or writing to the file system.

fstatvfs() fails if one or more of the following are true:

[EBADF]
    fd is not a valid open file descriptor.

[EFAULT]
    buf points to an invalid address.

[EIO]
    An I/O error occurred while reading from or writing to the file system.

SEE ALSO
df(1), mount(2), stat(2), statfs(2)

STANDARDS
The statvfs() and fstatvfs() functions conform to p1003.1-2001.

HISTORY
The statvfs() and fstatvfs() functions first appeared in OpenBSD 4.4.