getfsstat(2) [debian man page]

GETFSSTAT(2)						      BSD System Calls Manual						      GETFSSTAT(2)

NAME

     getfsstat -- get list of all mounted file systems

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <sys/param.h>
     #include <sys/ucred.h>
     #include <sys/mount.h>

     int
     getfsstat(struct statfs *buf, long bufsize, int flags);

DESCRIPTION

     The getfsstat() system call returns information about all mounted file systems.  The buf argument is a pointer to statfs structures, as
     described in statfs(2).

     Fields that are undefined for a particular file system are set to -1.  The buffer is filled with an array of statfs structures, one for each
     mounted file system up to the byte count specified by bufsize.  Note, the bufsize argument is the number of bytes that buf can hold, not the
     count of statfs structures it will hold.

     If buf is given as NULL, getfsstat() returns just the number of mounted file systems.

     Normally flags should be specified as MNT_WAIT.  If flags is set to MNT_NOWAIT, getfsstat() will return the information it has available
     without requesting an update from each file system.  Thus, some of the information will be out of date, but getfsstat() will not block wait-
     ing for information from a file system that is unable to respond.

RETURN VALUES

     Upon successful completion, the number of statfs structures is returned.  Otherwise, -1 is returned and the global variable errno is set to
     indicate the error.

ERRORS

     The getfsstat() system call fails if one or more of the following are true:

     [EFAULT]		The buf argument points to an invalid address.

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

SEE ALSO

     statfs(2), fstab(5), mount(8)

HISTORY

     The getfsstat() system call first appeared in 4.4BSD.

BSD
								 November 20, 2003							       BSD

GETFSSTAT(2)							System Calls Manual						      GETFSSTAT(2)

NAME

       getfsstat - get list of all mounted filesystems

SYNOPSIS

       #include <sys/param.h>
       #include <sys/mount.h>

       int
       getfsstat(buf,bufsize,flags)
       struct statfs *buf;
       int bufsize;
       int flags;

DESCRIPTION

       Getfsstat() returns information about all mounted filesystems.  Buf is a pointer to statfs structures defined as follows:

       #define MNAMELEN 90	 /* length of buffer for returned name */

       struct statfs {
       short   f_type;		 /* type of filesystem (see below) */
       short   f_flags; 	 /* copy of mount flags */
       short   f_bsize; 	 /* fundamental file system block size */
       short   f_iosize;	 /* optimal transfer block size */
       long    f_blocks;	 /* total data blocks in file system */
       long    f_bfree; 	 /* free blocks in fs */
       long    f_bavail;	 /* free blocks avail to non-superuser */
       ino_t   f_files; 	 /* total file nodes in file system */
       ino_t   f_ffree; 	 /* free file nodes in fs */
       u_long  f_fsid[2];	 /* file system id */
       long    f_spare[4];	 /* spare for later */
       char    f_mntonname[MNAMELEN];	 /* mount point */
       char    f_mntfromname[MNAMELEN];  /* mounted filesystem */
       };
       /*
       * File system types. - Only UFS is supported so the other types are not
       * given.
       */
       #define	 MOUNT_NONE	0
       #define	 MOUNT_UFS 1	/* Fast Filesystem */

       Fields that are undefined for a particular filesystem are set to -1.  The buffer is filled with an array of fsstat structures, one for each
       mounted filesystem up to the size specified by bufsize.

       If buf is given as NULL, getfsstat() returns just the number of mounted filesystems.

       Normally flags is currently unused.  In 4.4BSD systems the usage is specified as MNT_WAIT.  If flags is set to MNT_NOWAIT, getfsstat() will
       return  the  information  it has available without requesting an update from each filesystem.  Thus, some of the information will be out of
       date, but getfsstat() will not block waiting for information from a filesystem that is unable to respond.

RETURN VALUES

       Upon successful completion, the number of fsstat structures is returned.  Otherwise, -1 is returned and the global variable errno is set to
       indicate the error.

ERRORS

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

       [EFAULT] 	   Buf points to an invalid address.

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

SEE ALSO

       statfs(2), fstab(5), mount(8)

HISTORY

       The getfsstat function first appeared in 4.4BSD.

4.4 Berkeley Distribution					 December 24, 1995						      GETFSSTAT(2)