.\" $NetBSD: getfsstat.2,v 1.20 2002/10/01 17:35:41 wiz Exp $ .\" .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)getfsstat.2 8.3 (Berkeley) 5/25/95 .\" .Dd May 25, 1995 .Dt GETFSSTAT 2 .Os .Sh NAME .Nm getfsstat .Nd get list of all mounted file systems .Sh LIBRARY .Lb libc .Sh SYNOPSIS .Fd #include \*[Lt]sys/param.h\*[Gt] .Fd #include \*[Lt]sys/ucred.h\*[Gt] .Fd #include \*[Lt]sys/mount.h\*[Gt] .Ft int .Fn getfsstat "struct statfs *buf" "long bufsize" "int flags" .Sh DESCRIPTION .Fn getfsstat returns information about all mounted file systems. .Fa buf is a pointer to an array of .Nm statfs structures defined as follows: .Bd -literal typedef struct { int32_t val[2]; } fsid_t; /* file system id type */ #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_oflags; /* deprecated 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_flags; /* copy of mount flags */ long f_syncwrites; /* count of sync writes since mount */ long f_asyncwrites; /* count of async writes since mount */ long f_spare[1]; /* 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 */ }; .Ed .Pp The flags that may be returned include: .Bl -tag -width MNT_SYNCHRONOUS .It Dv MNT_RDONLY The filesystem is mounted read-only; Even the super-user may not write on it. .It Dv MNT_NOEXEC Files may not be executed from the filesystem. .It Dv MNT_NOSUID Setuid and setgid bits on files are not honored when they are executed. .It Dv MNT_NODEV Special files in the filesystem may not be opened. .It Dv MNT_SYNCHRONOUS All I/O to the filesystem is done synchronously. .It Dv MNT_ASYNC No filesystem I/O is done synchronously. .It Dv MNT_UNION Union with underlying filesystem. .It Dv MNT_NOCOREDUMP Don't write core dumps to this file system. .It Dv MNT_NOATIME Never update access times. .It Dv MNT_SYMPERM Recognize symbolic link permission. .It Dv MNT_NODEVMTIME Never update modification times for device files. .It Dv MNT_SOFTDEP Use soft dependencies. .It Dv MNT_LOCAL The filesystem resides locally. .It Dv MNT_QUOTA The filesystem has quotas enabled on it. .It Dv MNT_ROOTFS Identifies the root filesystem. .It Dv MNT_EXRDONLY The filesystem is exported read-only. .It Dv MNT_EXPORTED The filesystem is exported for both reading and writing. .It Dv MNT_DEFEXPORTED The filesystem is exported for both reading and writing to any Internet host. .It Dv MNT_EXPORTANON The filesystem maps all remote accesses to the anonymous user. .It Dv MNT_EXKERB The filesystem is exported with Kerberos uid mapping. .It Dv MNT_EXNORESPORT Don't enforce reserved ports (NFS). .It Dv MNT_EXPUBLIC Public export (WebNFS). .El .Pp Fields that are undefined for a particular filesystem are set to -1. The buffer is filled with an array of .Fa statfs structures, one for each mounted file system up to the size specified by .Fa bufsize . .Pp If .Fa buf is given as NULL, .Fn getfsstat returns just the number of mounted file systems. .Pp Normally .Fa flags should be specified as .Dv MNT_WAIT . If .Fa flags is set to .Dv MNT_NOWAIT , .Fn 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 .Fn getfsstat will not block waiting for information from a file system that is unable to respond. .Sh RETURN VALUES Upon successful completion, the number of .Fa statfs structures is returned. Otherwise, -1 is returned and the global variable .Va errno is set to indicate the error. .Sh ERRORS .Fn getfsstat fails if one or more of the following are true: .Bl -tag -width Er .It Bq Er EFAULT .Fa buf points to an invalid address. .It Bq Er EIO An .Tn I/O error occurred while reading from or writing to the file system. .El .Sh SEE ALSO .Xr statfs 2 , .Xr getmntinfo 3 , .Xr fstab 5 , .Xr mount 8 .Sh HISTORY The .Fn getfsstat function first appeared in .Bx 4.4 .