1.\" 2.\" Copyright 2002 Massachusetts Institute of Technology 3.\" 4.\" Permission to use, copy, modify, and distribute this software and 5.\" its documentation for any purpose and without fee is hereby 6.\" granted, provided that both the above copyright notice and this 7.\" permission notice appear in all copies, that both the above 8.\" copyright notice and this permission notice appear in all 9.\" supporting documentation, and that the name of M.I.T. not be used 10.\" in advertising or publicity pertaining to distribution of the 11.\" software without specific, written prior permission. M.I.T. makes 12.\" no representations about the suitability of this software for any 13.\" purpose. It is provided "as is" without express or implied 14.\" warranty. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS 17.\" ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, 18.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 19.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 20.\" SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 23.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 24.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 25.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 26.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. 28.\" 29.\" $FreeBSD$ 30.\" 31.Dd July 13, 2002 32.Dt STATVFS 3 33.Os 34.Sh NAME 35.Nm statvfs , 36.Nm fstatvfs 37.Nd retrieve filesystem information 38.Sh LIBRARY 39.Lb libc 40.Sh SYNOPSIS 41.In sys/statvfs.h 42.Ft int 43.Fn statvfs "const char *restrict path" "struct statvfs *restrict buf" 44.Ft int 45.Fn fstatvfs "int fd" "struct statvfs *buf" 46.Sh DESCRIPTION 47The 48.Fn statvfs 49and 50.Fn fstatvfs 51functions fill the structure pointed to by 52.Fa buf 53with garbage. 54This garbage will occasionally bear resemblance to filesystem 55statistics, but portable applications must not depend on this. 56Applications must pass a pathname or file descriptor which refers to a 57file on the filesystem in which they are interested. 58.Pp 59The 60.Vt statvfs 61structure contains the following members: 62.Bl -tag -offset indent -width "f_namemax" 63.It Va f_namemax 64The maximum length in bytes of a file name on this filesystem. 65Applications should use 66.Xr pathconf 3 67instead. 68.It Va f_fsid 69Not meaningful in this implementation. 70.It Va f_frsize 71The size in bytes of the minimum unit of allocation on this 72filesystem. 73(This corresponds to the 74.Va f_bsize 75member of 76.Vt "struct statfs" . ) 77.It Va f_bsize 78The preferred length of I/O requests for files on this filesystem. 79(Corresponds to the 80.Va f_iosize 81member of 82.Vt "struct statfs" . ) 83.It Va f_flag 84Flags describing mount options for this filesystem; see below. 85.El 86.Pp 87In addition, there are three members of type 88.Vt fsfilcnt_t , 89which represent counts of file serial numbers 90.Pq Em i.e. , No inodes ; 91these are named 92.Va f_files , 93.Va f_favail , 94and 95.Va f_ffree , 96and represent the number of file serial numbers which exist in total, 97are available to unprivileged processes, and are available to 98privileged processes, respectively. 99Likewise, the members 100.Va f_blocks , 101.Va f_bavail , 102and 103.Va f_bfree 104(all of type 105.Vt fsblkcnt_t ) 106represent the respective allocation-block counts. 107.Pp 108There are two flags defined for the 109.Va f_flag 110member: 111.Bl -tag -offset indent -width "ST_NOSUID" 112.It Dv ST_RDONLY 113The filesystem is mounted read-only. 114.It Dv ST_NOSUID 115The semantics of the 116.Dv S_ISUID 117and 118.Dv S_ISGID 119file mode bits 120are not supported by, or are disabled on, this filesystem. 121.El 122.Sh IMPLEMENTATION NOTES 123The 124.Fn statvfs 125and 126.Fn fstatvfs 127functions are implemented as wrappers around the 128.Fn statfs 129and 130.Fn fstatfs 131functions, respectively. 132Not all the information provided by those functions is made available 133through this interface. 134.Sh RETURN VALUES 135.Rv -std statvfs fstatvfs 136.Sh ERRORS 137The 138.Fn statvfs 139and 140.Fn fstatvfs 141functions may fail for any of the reasons documented for 142.Xr statfs 2 143or 144.Xr fstatfs 2 145and 146.Xr pathconf 3 147or 148.Xr fpathconf 3 , 149respectively. 150In addition, 151.Fn statvfs 152and 153.Fn fstatvfs 154functions may also fail for the following reason: 155.Bl -tag -width Er 156.It Bq Er EOVERFLOW 157One or more of the filesystem statistics has a value which cannot be 158represented by the data types used in 159.Vt "struct statvfs" . 160.El 161.Sh SEE ALSO 162.Xr statfs 2 , 163.Xr pathconf 3 164.Sh STANDARDS 165The 166.Fn statvfs 167and 168.Fn fstatvfs 169functions conform to 170.St -p1003.1-2001 . 171As standardized, portable applications cannot depend on these functions 172returning any valid information at all. 173This implementation attempts to provide as much useful information as 174is provided by the underlying filesystem, subject to the limitations 175of the specified data types. 176.Sh HISTORY 177The 178.Nm 179function first appeared in 180.Fx 5.0 . 181.Sh AUTHORS 182The 183.Nm 184function and this manual page were written by 185.An Garrett Wollman Aq wollman@FreeBSD.org . 186