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