STATFS(2)                   BSD System Calls Manual                  STATFS(2)

NAME
     statfs -- get file system statistics

SYNOPSIS
     ##include <>
     ##include <>

     int
     statfs(const char *path, struct statfs *buf);

     int
     fstatfs(int fd, struct statfs *buf);

DESCRIPTION
     Statfs() 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 statfs structure defined as follows:

     typedef struct { int32t val[2]; } fsidt;

     #define MFSNAMELEN   15 /* length of fs type name, not inc. nul */
     #define MNAMELEN     90 /* length of buffer for returned name */

     struct statfs {
         short   fotype;    /* type of file system (reserved: zero) */
         short   foflags;   /* copy of mount flags (reserved: zero) */
         long    fbsize;    /* fundamental file system block size */
         long    fiosize;   /* optimal transfer block size */
         long    fblocks;   /* total data blocks in file system */
         long    fbfree;    /* free blocks in fs */
         long    fbavail;   /* free blocks avail to non-superuser */
         long    ffiles;    /* total file nodes in file system */
         long    fffree;    /* free file nodes in fs */
         fsidt  ffsid;     /* file system id (super-user only) */
         uidt   fowner;    /* user that mounted the file system */
         short   freserved1;        /* reserved for future use */
         short   ftype;     /* type of file system (reserved) */
         long    fflags;    /* copy of mount flags (reserved) */
         long    freserved2[2];     /* reserved for future use */
         char    ffstypename[MFSNAMELEN]; /* fs type name */
         char    fmntonname[MNAMELEN];    /* directory on which mounted */
         char    fmntfromname[MNAMELEN];  /* mounted file system */
         char    freserved3;        /* reserved for future use */
         long    freserved4[4];     /* reserved for future use */
     };

     Fields that are undefined for a particular file system are set to -1.
     Fstatfs() 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.

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

     [ENOTDIR]          A component of the path prefix of Path is not a direc-
                        tory.

     [ENAMETOLONG]     The length of a component of path exceeds {NAMEMAX}
                        characters, or the length of path exceeds {PATHMAX}
                        characters.

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

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

     [ELOP]            Too many symbolic links were encountered in translat-
                        ing 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.

     Fstatfs() 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.

HISTORY
     The statfs() function first appeared in 4.4BSD.

BSD                            February 11, 1994                           BSD