Seth Woolley's Man Viewer

statvfs(2) - fstatvfs, statvfs, fstatvfs, statvfs - get file system statistics - man 2 statvfs

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

STATVFS(2)                 Linux Programmer's Manual                STATVFS(2)



NAME
       statvfs, fstatvfs - get file(1,n) system statistics

SYNOPSIS
       #include <sys/statvfs.h>

       int statvfs(const char *path, struct statvfs *buf);
       int fstatvfs(int fd, struct statvfs *buf);

DESCRIPTION
       The  function  statvfs returns information about a mounted file(1,n) system.
       path is the path name of any file(1,n) within the mounted  filesystem.   buf
       is a pointer to a statvfs structure defined approximately as follows:

         struct statvfs {
           unsigned long  f_bsize;    /* file(1,n) system block size */
           unsigned long  f_frsize;   /* fragment size */
           fsblkcnt_t     f_blocks;   /* size of fs in(1,8) f_frsize units(1,7) */
           fsblkcnt_t     f_bfree;    /* # free blocks */
           fsblkcnt_t     f_bavail;   /* # free blocks for non-root */
           fsfilcnt_t     f_files;    /* # inodes */
           fsfilcnt_t     f_ffree;    /* # free inodes */
           fsfilcnt_t     f_favail;   /* # free inodes for non-root */
           unsigned long  f_fsid;     /* file(1,n) system id */
           unsigned long  f_flag;     /* mount(2,8) flags */
           unsigned long  f_namemax;  /* maximum filename length */
         };

       Here  the types fsblkcnt_t and fsfilcnt_t are defined in(1,8) <sys/types.h>.
       Both used to be unsigned long.

       The field f_flag is a bit mask (of mount(2,8) flags,  see  mount(2,8)(8)).   Bits
       defined by POSIX are

       ST_RDONLY
              Read-only file(1,n) system.

       ST_NOSUID
              Setuid/setgid bits are ignored by exec(3,n,1 builtins)(2).


       It is unspecified whether all members of the returned struct have mean-
       ingful values on all filesystems.

       fstatvfs returns the same information about an open(2,3,n) file(1,n) referenced  by
       descriptor fd.

RETURN VALUE
       On  success,  zero is returned.  On error(8,n), -1 is returned, and errno is
       set(7,n,1 builtins) appropriately.

ERRORS
       EACCES (statvfs) Search permission is denied for  a  component  of  the
              path prefix of path.  (See also path_resolution(2).)

       EBADF  (fstatvfs) fd is not a valid open(2,3,n) file(1,n) descriptor.

       EFAULT Buf or path points to an invalid address.

       EINTR  This call was interrupted by a signal.

       EIO    An I/O error(8,n) occurred while reading from the file(1,n) system.

       ELOOP  (statvfs)  Too many symbolic links were encountered in(1,8) translat-
              ing path.

       ENAMETOOLONG
              (statvfs) path is too long.

       ENOENT (statvfs) The file(1,n) referred to by path does not exist.

       ENOMEM Insufficient kernel memory was available.

       ENOSYS The file(1,n) system does not support this call.

       ENOTDIR
              (statvfs) A component of the path prefix of path is not a direc-
              tory.

       EOVERFLOW
              Some  values  were  too  large to be represented in(1,8) the returned
              struct.


CONFORMING TO
       Solaris, Irix, POSIX 1003.1-2001

NOTES
       The Linux kernel has system  calls  statfs,  fstatfs  to  support  this
       library call.

       The current glibc implementation of

          pathconf(path, _PC_REC_XFER_ALIGN);
          pathconf(path, _PC_ALLOC_SIZE_MIN);
          pathconf(path, _PC_REC_MIN_XFER_SIZE);

       uses  the f_frsize, f_frsize, and f_bsize fields of the return value of
       statvfs(path,buf).

SEE ALSO
       statfs(2)



Linux 2.6.0                       2003-08-22                        STATVFS(2)

References for this manual (incoming links)