getfsstat(2) - NetBSD Manual Pages

Command:
Section:
Arch:
Collection:
>>>
GETFSSTAT(2)              NetBSD Programmer's Manual              GETFSSTAT(2)


NAME

     getfsstat - get list of all mounted file systems


SYNOPSIS

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

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


DESCRIPTION

     getfsstat() returns information about all mounted file systems.  buf is a
     pointer to an array of statfs structures defined as follows:

     typedef struct { int32_t val[2]; } fsid_t;

     #define MFSNAMELEN   16 /* length of fs type name, including nul */
     #define MNAMELEN     90 /* length of buffer for returned name */

     struct statfs {
         short   f_type;     /* type of file system (unused; zero) */
         u_short f_flags;    /* copy of mount flags */
         long    f_bsize;    /* fundamental file system block size */
         long    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 */
         long    f_files;    /* total file nodes in file system */
         long    f_ffree;    /* free file nodes in fs */
         fsid_t  f_fsid;     /* file system id */
         uid_t   f_owner;    /* user that mounted the file system */
         long    f_spare[4]; /* spare for later */
         char    f_fstypename[MFSNAMELEN]; /* fs type name */
         char    f_mntonname[MNAMELEN];    /* directory on which mounted */
         char    f_mntfromname[MNAMELEN];  /* mounted file system */
     };

     The flags that may be returned include:

     MNT_RDONLY        The filesystem is mounted read-only; Even the super-us-
                       er may not write on it.

     MNT_NOEXEC        Files may not be executed from the filesystem.

     MNT_NOSUID        Setuid and setgid bits on files are not honored when
                       they are executed.

     MNT_NODEV         Special files in the filesystem may not be opened.

     MNT_SYNCHRONOUS   All I/O to the filesystem is done synchronously.

     MNT_ASYNCHRONOUS  No filesystem I/O is done synchronously.

     MNT_LOCAL         The filesystem resides locally.

     MNT_QUOTA         The filesystem has quotas enabled on it.

     MNT_ROOTFS        Identifies the root filesystem.

     MNT_EXRDONLY      The filesystem is exported read-only.

     MNT_EXPORTED      The filesystem is exported for both reading and writ-
                       ing.

     MNT_DEFEXPORTED   The filesystem is exported for both reading and writing
                       to any Internet host.

     MNT_EXPORTANON    The filesystem maps all remote accesses to the anony-
                       mous user.

     MNT_EXKERB        The filesystem is exported with Kerberos uid mapping.

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

     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 waiting
     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 indi-
     cate 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
                   file system.


SEE ALSO

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


HISTORY

     The getfsstat() function first appeared in 4.4BSD.

NetBSD 1.4                       May 25, 1995                                2