[apple/xnu.git] / bsd / man / man2 / getfsstat.2

.\"	$NetBSD: getfsstat.2,v 1.6 1995/06/29 11:40:44 cgd 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.1 (Berkeley) 6/9/93
.\"
.Dd Oct 28, 2008
.Dt GETFSSTAT 2
.Os
.Sh NAME
.Nm getfsstat
.Nd get list of all mounted file systems
.Sh SYNOPSIS
.Fd #include <sys/param.h>
.Fd #include <sys/ucred.h>
.Fd #include <sys/mount.h>
.Ft int
.Fn getfsstat "struct statfs *buf" "int bufsize" "int flags"
.Sh TRANSITIIONAL SYNOPSIS (NOW DEPRECATED)
.Ft int
.br
.Fn getfsstat64 "struct statfs64 *buf" "int bufsize" "int flags" ;
.Sh DESCRIPTION
The
.Fn getfsstat
function returns information about all mounted file systems.
The
.Fa buf
argument is a pointer to an array of
.Fa statfs
structures (see 
.Xr statfs 2 ) .
As
.Xr statfs 2
indicates, the structure is defined differently depending on
whether the macro _DARWIN_FEATURE_64_BIT_INODE is defined (see
.Xr stat 2
for more information on this macro).
.Pp
Fields that are undefined for a particular file system 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
If
.Fa flags
is set to
.Dv MNT_NOWAIT ,
.Fn getfsstat
will directly return the information retained in the kernel
to avoid delays caused by waiting for updated information from
a file system that is perhaps temporarily unable to respond.
Some of the information returned may be out of date, however; if
.Fa flags
is set to
.Dv MNT_WAIT
or
.Dv MNT_DWAIT
instead,
.Fn getfsstat
will request updated information from each mounted filesystem before
returning.
.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
The
.Fa buf
argument 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 TRANSITIONAL DESCRIPTION (NOW DEPRECATED)
The
.Fn getfsstat64
routine is equivalent to the default
.Fn getfstat
(when
.Dv _DARWIN_FEATURE_64_BIT_INODE
is defined), so there is no longer any reason to use it (it will be removed
in the future).
.Sh SEE ALSO
.Xr stat 2 ,
.Xr statfs 2 ,
.Xr fstab 5 ,
.Xr mount 8
.Sh HISTORY
The
.Fn getfsstat
function first appeared in 4.4BSD.
Commit	Line	Data
9bccf70c A	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	.\"
b0d623f7	36	.Dd Oct 28, 2008
9bccf70c A	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
91447636	47	.Fn getfsstat "struct statfs *buf" "int bufsize" "int flags"
b0d623f7 A	48	.Sh TRANSITIIONAL SYNOPSIS (NOW DEPRECATED)
	49	.Ft int
	50	.br
	51	.Fn getfsstat64 "struct statfs64 *buf" "int bufsize" "int flags" ;
9bccf70c	52	.Sh DESCRIPTION
b0d623f7 A	53	The
	54	.Fn getfsstat
	55	function returns information about all mounted file systems.
	56	The
	57	.Fa buf
	58	argument is a pointer to an array of
b0d623f7	59	.Fa statfs
6d2010ae A	60	structures (see
	61	.Xr statfs 2 ) .
	62	As
	63	.Xr statfs 2
	64	indicates, the structure is defined differently depending on
	65	whether the macro _DARWIN_FEATURE_64_BIT_INODE is defined (see
	66	.Xr stat 2
	67	for more information on this macro).
9bccf70c A	68	.Pp
	69	Fields that are undefined for a particular file system are set to -1.
	70	The buffer is filled with an array of
	71	.Fa statfs
	72	structures, one for each mounted file system
	73	up to the size specified by
	74	.Fa bufsize .
	75	.Pp
	76	If
	77	.Fa buf
	78	is given as NULL,
	79	.Fn getfsstat
	80	returns just the number of mounted file systems.
	81	.Pp
9bccf70c A	82	If
	83	.Fa flags
	84	is set to
	85	.Dv MNT_NOWAIT ,
	86	.Fn getfsstat
91447636 A	87	will directly return the information retained in the kernel
	88	to avoid delays caused by waiting for updated information from
	89	a file system that is perhaps temporarily unable to respond.
	90	Some of the information returned may be out of date, however; if
	91	.Fa flags
	92	is set to
	93	.Dv MNT_WAIT
b0d623f7 A	94	or
b0d623f7 A	95	.Dv MNT_DWAIT
91447636	96	instead,
9bccf70c	97	.Fn getfsstat
91447636 A	98	will request updated information from each mounted filesystem before
91447636 A	99	returning.
9bccf70c A	100	.Sh RETURN VALUES
	101	Upon successful completion, the number of
	102	.Fa statfs
	103	structures is returned.
	104	Otherwise, -1 is returned and the global variable
	105	.Va errno
	106	is set to indicate the error.
	107	.Sh ERRORS
39037602	108	.Fn getfsstat
9bccf70c A	109	fails if one or more of the following are true:
	110	.Bl -tag -width Er
	111	.It Bq Er EFAULT
b0d623f7 A	112	The
	113	.Fa buf
	114	argument points to an invalid address.
9bccf70c A	115	.It Bq Er EIO
	116	An
	117	.Tn I/O
	118	error occurred while reading from or writing to the file system.
	119	.El
b0d623f7 A	120	.Sh TRANSITIONAL DESCRIPTION (NOW DEPRECATED)
	121	The
	122	.Fn getfsstat64
	123	routine is equivalent to the default
	124	.Fn getfstat
	125	(when
	126	.Dv _DARWIN_FEATURE_64_BIT_INODE
	127	is defined), so there is no longer any reason to use it (it will be removed
	128	in the future).
9bccf70c	129	.Sh SEE ALSO
6d2010ae	130	.Xr stat 2 ,
9bccf70c A	131	.Xr statfs 2 ,
	132	.Xr fstab 5 ,
	133	.Xr mount 8
	134	.Sh HISTORY
	135	The
	136	.Fn getfsstat
	137	function first appeared in 4.4BSD.