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.\" @(#)statfs.2 8.5 (Berkeley) 5/24/95 33.\" $FreeBSD$ 34.\" 35.Dd May 24, 1995 36.Dt STATFS 2 37.Os 38.Sh NAME 39.Nm statfs 40.Nd get file system statistics 41.Sh LIBRARY 42.Lb libc 43.Sh SYNOPSIS 44.Fd #include <sys/param.h> 45.Fd #include <sys/mount.h> 46.Ft int 47.Fn statfs "const char *path" "struct statfs *buf" 48.Ft int 49.Fn fstatfs "int fd" "struct statfs *buf" 50.Sh DESCRIPTION 51.Fn Statfs 52returns information about a mounted file system. 53.Fa Path 54is the path name of any file within the mounted filesystem. 55.Fa Buf 56is a pointer to a 57.Fn statfs 58structure defined as follows: 59.Bd -literal 60typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */ 61 62/* 63 * file system statistics 64 */ 65 66#define MFSNAMELEN 16 /* length of fs type name, including null */ 67#define MNAMELEN 90 /* length of buffer for returned name */ 68 69struct statfs { 70long f_bsize; /* fundamental file system block size */ 71long f_iosize; /* optimal transfer block size */ 72long f_blocks; /* total data blocks in file system */ 73long f_bfree; /* free blocks in fs */ 74long f_bavail; /* free blocks avail to non-superuser */ 75long f_files; /* total file nodes in file system */ 76long f_ffree; /* free file nodes in fs */ 77fsid_t f_fsid; /* file system id */ 78uid_t f_owner; /* user that mounted the filesystem */ 79int f_type; /* type of filesystem */ 80int f_flags; /* copy of mount flags */ 81long f_syncwrites; /* count of sync writes since mount */ 82long f_asyncwrites; /* count of async writes since mount */ 83char f_fstypename[MFSNAMELEN];/* fs type name */ 84char f_mntonname[MNAMELEN]; /* mount point */ 85long f_syncreads; /* count of sync reads since mount */ 86long f_asyncreads; /* count of async reads since mount */ 87char f_mntfromname[MNAMELEN]; /* mounted filesystem */ 88}; 89.Ed 90The flags that may be returned include: 91.Bl -tag -width MNT_SYNCHRONOUS 92.It Dv MNT_RDONLY 93The filesystem is mounted read-only; 94Even the super-user may not write on it. 95.It Dv MNT_NOEXEC 96Files may not be executed from the filesystem. 97.It Dv MNT_NOSUID 98Setuid and setgid bits on files are not honored when they are executed. 99.It Dv MNT_NODEV 100Special files in the filesystem may not be opened. 101.It Dv MNT_SYNCHRONOUS 102All I/O to the filesystem is done synchronously. 103.It Dv MNT_ASYNC 104No filesystem I/O is done synchronously. 105.It Dv MNT_LOCAL 106The filesystem resides locally. 107.It Dv MNT_QUOTA 108The filesystem has quotas enabled on it. 109.It Dv MNT_ROOTFS 110Identifies the root filesystem. 111.It Dv MNT_EXRDONLY 112The filesystem is exported read-only. 113.It Dv MNT_EXPORTED 114The filesystem is exported for both reading and writing. 115.It Dv MNT_DEFEXPORTED 116The filesystem is exported for both reading and writing to any Internet host. 117.It Dv MNT_EXPORTANON 118The filesystem maps all remote accesses to the anonymous user. 119.It Dv MNT_EXKERB 120The filesystem is exported with Kerberos uid mapping. 121.El 122.Pp 123Fields that are undefined for a particular file system are set to -1. 124.Fn Fstatfs 125returns the same information about an open file referenced by descriptor 126.Fa fd . 127.Sh RETURN VALUES 128Upon successful completion, a value of 0 is returned. 129Otherwise, -1 is returned and the global variable 130.Va errno 131is set to indicate the error. 132.Sh ERRORS 133.Fn Statfs 134fails if one or more of the following are true: 135.Bl -tag -width Er 136.It Bq Er ENOTDIR 137A component of the path prefix of 138.Fa Path 139is not a directory. 140.It Bq Er ENAMETOOLONG 141The length of a component of 142.Fa path 143exceeds 255 characters, 144or the length of 145.Fa path 146exceeds 1023 characters. 147.It Bq Er ENOENT 148The file referred to by 149.Fa path 150does not exist. 151.It Bq Er EACCES 152Search permission is denied for a component of the path prefix of 153.Fa path . 154.It Bq Er ELOOP 155Too many symbolic links were encountered in translating 156.Fa path . 157.It Bq Er EFAULT 158.Fa Buf 159or 160.Fa path 161points to an invalid address. 162.It Bq Er EIO 163An 164.Tn I/O 165error occurred while reading from or writing to the file system. 166.El 167.Pp 168.Fn Fstatfs 169fails if one or more of the following are true: 170.Bl -tag -width Er 171.It Bq Er EBADF 172.Fa fd 173is not a valid open file descriptor. 174.It Bq Er EFAULT 175.Fa Buf 176points to an invalid address. 177.It Bq Er EIO 178An 179.Tn I/O 180error occurred while reading from or writing to the file system. 181.El 182.Sh HISTORY 183The 184.Fn statfs 185function first appeared in 186.Bx 4.4 . 187