xref: /freebsd/lib/libc/gen/getmntinfo.3 (revision 75141cc9877bd4c86b39c602f68ae5dc205cefdb)

.\" 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.
.\"
.\"     @(#)getmntinfo.3	8.1 (Berkeley) 6/9/93
.\"
.Dd June 9, 1993
.Dt GETMNTINFO 3
.Os
.Sh NAME
.Nm getmntinfo
.Nd get information about mounted file systems
.Sh SYNOPSIS
.Fd #include <sys/param.h>
.Fd #include <sys/ucred.h>
.Fd #include <sys/mount.h>
.Ft int
.Fn getmntinfo "struct statfs **mntbufp" "int flags"
.Sh DESCRIPTION
The
.Fn getmntinfo
function
returns an array of
.Fn statfs
structures describing each currently mounted file system (see
.Xr statfs 2 ) .
.Pp
The
.Fn getmntinfo
function
passes its
.Fa flags
parameter transparently to
.Xr getfsstat 2 .
.Sh RETURN VALUES
On successful completion,
.Fn getmntinfo
returns a count of the number of elements in the array.
The pointer to the array is stored into
.Fa mntbufp .
.Pp
If an error occurs, zero is returned and the external variable
.Va errno
is set to indicate the error.
Although the pointer
.Fa mntbufp
will be unmodified, any information previously returned by
.Fn getmntinfo
will be lost.
.Sh ERRORS
The
.Fn getmntinfo
function
may fail and set errno for any of the errors specified for the library
routines
.Xr getfsstat 2
or
.Xr malloc 3 .
.Sh SEE ALSO
.Xr getfsstat 2 ,
.Xr mount 2 ,
.Xr statfs 2 ,
.Xr mount 8
.Sh HISTORY
The
.Fn getmntinfo
function first appeared in
.Bx 4.4 .
.Sh BUGS
The
.Fn getmntinfo
function writes the array of structures to an internal static object
and returns
a pointer to that object. Subsequent calls to
.Fn getmntinfo
will modify the same object.
.Pp
The memory allocated by
.Fn getmntinfo
cannot be
.Xr free 3 Ns 'd
by the application.