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.Dd December 27, 2016 29.Dt GETMNTINFO 3 30.Os 31.Sh NAME 32.Nm getmntinfo 33.Nd get information about mounted file systems 34.Sh LIBRARY 35.Lb libc 36.Sh SYNOPSIS 37.In sys/param.h 38.In sys/ucred.h 39.In sys/mount.h 40.Ft int 41.Fn getmntinfo "struct statfs **mntbufp" "int mode" 42.Sh DESCRIPTION 43The 44.Fn getmntinfo 45function 46returns an array of 47.Fn statfs 48structures describing each currently mounted file system (see 49.Xr statfs 2 ) . 50.Pp 51The 52.Fn getmntinfo 53function 54passes its 55.Fa mode 56argument transparently to 57.Xr getfsstat 2 . 58.Sh RETURN VALUES 59On successful completion, 60.Fn getmntinfo 61returns a count of the number of elements in the array. 62The pointer to the array is stored into 63.Fa mntbufp . 64.Pp 65If an error occurs, zero is returned and the external variable 66.Va errno 67is set to indicate the error. 68Although the pointer 69.Fa mntbufp 70will be unmodified, any information previously returned by 71.Fn getmntinfo 72will be lost. 73.Sh ERRORS 74The 75.Fn getmntinfo 76function 77may fail and set errno for any of the errors specified for the library 78routines 79.Xr getfsstat 2 80or 81.Xr malloc 3 . 82.Sh SEE ALSO 83.Xr getfsstat 2 , 84.Xr mount 2 , 85.Xr statfs 2 , 86.Xr mount 8 87.Sh HISTORY 88The 89.Fn getmntinfo 90function first appeared in 91.Bx 4.4 . 92.Sh BUGS 93The 94.Fn getmntinfo 95function writes the array of structures to an internal static object 96and returns 97a pointer to that object. 98Subsequent calls to 99.Fn getmntinfo 100will modify the same object. 101.Pp 102The memory allocated by 103.Fn getmntinfo 104cannot be 105.Xr free 3 Ns 'd 106by the application. 107