1.\" $NetBSD: getfsstat.2,v 1.6 1995/06/29 11:40:44 cgd Exp $ 2.\" 3.\" Copyright (c) 1989, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)getfsstat.2 8.1 (Berkeley) 6/9/93 35.\" 36.Dd Oct 28, 2008 37.Dt GETFSSTAT 2 38.Os 39.Sh NAME 40.Nm getfsstat 41.Nd get list of all mounted file systems 42.Sh SYNOPSIS 43.Fd #include <sys/param.h> 44.Fd #include <sys/ucred.h> 45.Fd #include <sys/mount.h> 46.Ft int 47.Fn getfsstat "struct statfs *buf" "int bufsize" "int flags" 48.Sh TRANSITIIONAL SYNOPSIS (NOW DEPRECATED) 49.Ft int 50.br 51.Fn getfsstat64 "struct statfs64 *buf" "int bufsize" "int flags" ; 52.Sh DESCRIPTION 53The 54.Fn getfsstat 55function returns information about all mounted file systems. 56The 57.Fa buf 58argument is a pointer to an array of 59.Fa statfs 60structures (see 61.Xr statfs 2 ) . 62As 63.Xr statfs 2 64indicates, the structure is defined differently depending on 65whether the macro _DARWIN_FEATURE_64_BIT_INODE is defined (see 66.Xr stat 2 67for more information on this macro). 68.Pp 69Fields that are undefined for a particular file system are set to -1. 70The buffer is filled with an array of 71.Fa statfs 72structures, one for each mounted file system 73up to the size specified by 74.Fa bufsize . 75.Pp 76If 77.Fa buf 78is given as NULL, 79.Fn getfsstat 80returns just the number of mounted file systems. 81.Pp 82If 83.Fa flags 84is set to 85.Dv MNT_NOWAIT , 86.Fn getfsstat 87will directly return the information retained in the kernel 88to avoid delays caused by waiting for updated information from 89a file system that is perhaps temporarily unable to respond. 90Some of the information returned may be out of date, however; if 91.Fa flags 92is set to 93.Dv MNT_WAIT 94or 95.Dv MNT_DWAIT 96instead, 97.Fn getfsstat 98will request updated information from each mounted filesystem before 99returning. 100.Sh RETURN VALUES 101Upon successful completion, the number of 102.Fa statfs 103structures is returned. 104Otherwise, -1 is returned and the global variable 105.Va errno 106is set to indicate the error. 107.Sh ERRORS 108.Fn getfsstat 109fails if one or more of the following are true: 110.Bl -tag -width Er 111.It Bq Er EFAULT 112The 113.Fa buf 114argument points to an invalid address. 115.It Bq Er EIO 116An 117.Tn I/O 118error occurred while reading from or writing to the file system. 119.El 120.Sh TRANSITIONAL DESCRIPTION (NOW DEPRECATED) 121The 122.Fn getfsstat64 123routine is equivalent to the default 124.Fn getfstat 125(when 126.Dv _DARWIN_FEATURE_64_BIT_INODE 127is defined), so there is no longer any reason to use it (it will be removed 128in the future). 129.Sh SEE ALSO 130.Xr stat 2 , 131.Xr statfs 2 , 132.Xr fstab 5 , 133.Xr mount 8 134.Sh HISTORY 135The 136.Fn getfsstat 137function first appeared in 4.4BSD. 138