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.1 (Berkeley) 6/9/93
.Dd June 9, 1993 .Dt GETFSSTAT 2 .Os .Sh NAME .Nm getfsstat .Nd get list of all mounted filesystems .Sh SYNOPSIS .Fd #include <sys/param.h> .Fd #include <sys/ucred.h> .Fd #include <sys/mount.h> .Ft int .Fn getfsstat "struct statfs *buf" "long bufsize" "int flags" .Sh DESCRIPTION .Fn Getfsstat returns information about all mounted filesystems. .Fa Buf is a pointer to .Xr statfs structures defined as follows: d -literal typedef quad fsid_t; #define MNAMELEN 32 /* length of buffer for returned name */ struct statfs { short f_type; /* type of filesystem (see below) */ short f_flags; /* copy of mount flags */ long f_bsize; /* fundamental filesystem block size */ long f_iosize; /* optimal transfer block size */ long f_blocks; /* total data blocks in filesystem */ long f_bfree; /* free blocks in fs */ long f_bavail; /* free blocks avail to non-superuser */ long f_files; /* total file nodes in filesystem */ long f_ffree; /* free file nodes in fs */ fsid_t f_fsid; /* filesystem id */ long f_spare[6]; /* spare for later */ char f_mntonname[MNAMELEN]; /* directory on which mounted */ char f_mntfromname[MNAMELEN]; /* mounted filesystem */ }; /* * File system types. */ #define MOUNT_UFS 1 #define MOUNT_NFS 2 #define MOUNT_PC 3 .Ed
p Fields that are undefined for a particular filesystem are set to -1. The buffer is filled with an array of .Fa fsstat structures, one for each mounted filesystem up to the size specified by .Fa bufsize .
p If .Fa buf is given as NULL, .Fn getfsstat returns just the number of mounted filesystems.
p 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 filesystem. Thus, some of the information will be out of date, but .Fn getfsstat will not block waiting for information from a filesystem that is unable to respond. .Sh RETURN VALUES Upon successful completion, the number of .Fa fsstat 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: l -tag -width Er t EFAULT .Fa Buf points to an invalid address. t EIO An .Tn I/O error occurred while reading from or writing to the filesystem. .El .Sh SEE ALSO .Xr statfs 2 , .Xr fstab 5 , .Xr mount 8 .Sh HISTORY The .Nm getfsstat function first appeared in 4.4BSD.