1.\" Copyright (c) 1989, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)getmntinfo.3 8.1 (Berkeley) 6/9/93 33.\" $FreeBSD: src/lib/libc/gen/getmntinfo.3,v 1.8.2.4 2003/03/13 18:05:37 trhodes Exp $ 34.\" $DragonFly: src/lib/libc/gen/getmntinfo.3,v 1.5 2008/06/03 12:40:09 swildner Exp $ 35.\" 36.Dd June 9, 1993 37.Dt GETMNTINFO 3 38.Os 39.Sh NAME 40.Nm getmntinfo 41.Nd get information about mounted file systems 42.Nm getmntvinfo 43.Nd get extended information about mounted file systems 44.Sh LIBRARY 45.Lb libc 46.Sh SYNOPSIS 47.In sys/param.h 48.In sys/ucred.h 49.In sys/mount.h 50.Ft int 51.Fn getmntinfo "struct statfs **mntbufp" "int flags" 52.Ft int 53.Fn getmntvinfo "struct statfs **mntbufp" "struct statvfs **mntvbufp" "int flags" 54.Sh DESCRIPTION 55The 56.Fn getmntinfo 57function 58returns an array of 59.Fn statfs 60structures describing each currently mounted file system (see 61.Xr statfs 2 ) . 62.Pp 63The 64.Fn getmntinfo 65function 66passes its 67.Fa flags 68argument transparently to 69.Xr getfsstat 2 . 70.Sh RETURN VALUES 71On successful completion, 72.Fn getmntinfo 73returns a count of the number of elements in the array. 74The pointer to the array is stored into 75.Fa mntbufp . 76.Pp 77If an error occurs, zero is returned and the external variable 78.Va errno 79is set to indicate the error. 80Although the pointer 81.Fa mntbufp 82will be unmodified, any information previously returned by 83.Fn getmntinfo 84will be lost. 85.Pp 86The 87.Fn getmntvinfo 88function 89returns an array of 90.Fn statfs 91and 92.Fn statvfs 93structures describing each currently mounted file system (see 94.Xr statfs 2 ) , 95and otherwise works like 96.Fn getmntinfo . 97.Sh ERRORS 98The 99.Fn getmntinfo 100function may fail and set 101.Va errno 102for any of the errors specified for the library routines 103.Xr getfsstat 2 104.Xr getvfsstat 2 105or 106.Xr malloc 3 . 107.Sh SEE ALSO 108.Xr getfsstat 2 , 109.Xr mount 2 , 110.Xr statfs 2 , 111.Xr mount 8 112.Sh HISTORY 113The 114.Fn getmntinfo 115function first appeared in 116.Bx 4.4 . 117.Sh BUGS 118The 119.Fn getmntinfo 120function writes the array of structures to an internal static object 121and returns 122a pointer to that object. 123Subsequent calls to 124.Fn getmntinfo 125will modify the same object. 126.Pp 127The memory allocated by 128.Fn getmntinfo 129cannot be 130.Xr free 3 Ns 'd 131by the application. 132