1.\" $NetBSD: statfs.2,v 1.10 1995/06/29 11:40:48 cgd Exp $ 2.\" 3.\" Copyright (c) 1989, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)statfs.2 8.3 (Berkeley) 2/11/94 35.\" 36.Dd August 14, 2008 37.Dt STATFS 2 38.Os 39.Sh NAME 40.Nm statfs, 41.Nm statfs64, 42.Nm fstatfs, 43.Nm fstatfs64 44.Nd get file system statistics 45.Sh SYNOPSIS 46.Fd #include <sys/param.h> 47.Fd #include <sys/mount.h> 48.Ft int 49.Fn statfs "const char *path" "struct statfs *buf" 50.Ft int 51.Fn fstatfs "int fd" "struct statfs *buf" 52.Sh TRANSITIONAL SYNOPSIS (NOW DEPRECATED) 53.Ft int 54.br 55.Fn statfs64 "const char *path" "struct statfs64 *buf" ; 56.sp 57.Ft int 58.br 59.Fn fstatfs64 "int fd" "struct statfs64 *buf" ; 60.Sh DESCRIPTION 61The 62.Fn statfs 63routine returns information about a mounted file system. 64The 65.Fa path 66argument is the path name of any file or directory within the mounted file system. 67The 68.Fa buf 69argument is a pointer to a 70.Fa statfs 71structure. 72When the macro 73.Dv _DARWIN_FEATURE_64_BIT_INODE 74is not defined (see 75.Xr stat 2 76for more information on this macro), the 77.Fa statfs 78structure is defined as: 79.Bd -literal 80typedef struct { int32_t val[2]; } fsid_t; 81 82#define MFSNAMELEN 15 /* length of fs type name, not inc. nul */ 83#define MNAMELEN 90 /* length of buffer for returned name */ 84 85struct statfs { /* when _DARWIN_FEATURE_64_BIT_INODE is NOT defined */ 86 short f_otype; /* type of file system (reserved: zero) */ 87 short f_oflags; /* copy of mount flags (reserved: zero) */ 88 long f_bsize; /* fundamental file system block size */ 89 long f_iosize; /* optimal transfer block size */ 90 long f_blocks; /* total data blocks in file system */ 91 long f_bfree; /* free blocks in fs */ 92 long f_bavail; /* free blocks avail to non-superuser */ 93 long f_files; /* total file nodes in file system */ 94 long f_ffree; /* free file nodes in fs */ 95 fsid_t f_fsid; /* file system id */ 96 uid_t f_owner; /* user that mounted the file system */ 97 short f_reserved1; /* reserved for future use */ 98 short f_type; /* type of file system (reserved) */ 99 long f_flags; /* copy of mount flags */ 100 long f_reserved2[2]; /* reserved for future use */ 101 char f_fstypename[MFSNAMELEN]; /* fs type name */ 102 char f_mntonname[MNAMELEN]; /* directory on which mounted */ 103 char f_mntfromname[MNAMELEN]; /* mounted file system */ 104 char f_reserved3; /* reserved for future use */ 105 long f_reserved4[4]; /* reserved for future use */ 106}; 107.Ed 108.Pp 109However, when the macro 110.Dv _DARWIN_FEATURE_64_BIT_INODE 111is defined, the 112.Fa statfs 113structure is defined as: 114.Bd -literal 115#define MFSTYPENAMELEN 16 /* length of fs type name including null */ 116#define MAXPATHLEN 1024 117#define MNAMELEN MAXPATHLEN 118 119struct statfs { /* when _DARWIN_FEATURE_64_BIT_INODE is defined */ 120 uint32_t f_bsize; /* fundamental file system block size */ 121 int32_t f_iosize; /* optimal transfer block size */ 122 uint64_t f_blocks; /* total data blocks in file system */ 123 uint64_t f_bfree; /* free blocks in fs */ 124 uint64_t f_bavail; /* free blocks avail to non-superuser */ 125 uint64_t f_files; /* total file nodes in file system */ 126 uint64_t f_ffree; /* free file nodes in fs */ 127 fsid_t f_fsid; /* file system id */ 128 uid_t f_owner; /* user that mounted the filesystem */ 129 uint32_t f_type; /* type of filesystem */ 130 uint32_t f_flags; /* copy of mount exported flags */ 131 uint32_t f_fssubtype; /* fs sub-type (flavor) */ 132 char f_fstypename[MFSTYPENAMELEN]; /* fs type name */ 133 char f_mntonname[MAXPATHLEN]; /* directory on which mounted */ 134 char f_mntfromname[MAXPATHLEN]; /* mounted filesystem */ 135 uint32_t f_reserved[8]; /* For future use */ 136}; 137.Ed 138.Pp 139Note that the 140.Fa f_fstypename , 141.Fa f_mntonname , 142and 143.Fa f_mntfromname 144fields are also wider in this variant. 145.Pp 146Fields that are undefined for a particular file system are set to -1. 147The 148.Fn fstatfs 149routine returns the same information about an open file referenced by descriptor 150.Fa fd . 151.Sh FLAGS 152.Bl -tag -width MNT_UNKNOWNPERMISSIONS 153These are some of the flags that may be present in the f_flags field. 154.It Dv MNT_RDONLY 155A read-only filesystem 156.It Dv MNT_SYNCHRONOUS 157File system is written to synchronously 158.It Dv MNT_NOEXEC 159Can't exec from filesystem 160.It Dv MNT_NOSUID 161Setuid bits are not honored on this filesystem 162.It Dv MNT_NODEV 163Don't interpret special files 164.It Dv MNT_UNION 165Union with underlying filesysten 166.It Dv MNT_ASYNC 167File system written to asynchronously 168.It Dv MNT_EXPORTED 169File system is exported 170.It Dv MNT_LOCAL 171File system is stored locally 172.It Dv MNT_QUOTA 173Quotas are enabled on this file system 174.It Dv MNT_ROOTFS 175This file system is the root of the file system 176.It Dv MNT_DOVOLFS 177File system supports volfs 178.It Dv MNT_DONTBROWSE 179File system is not appropriate path to user data 180.It Dv MNT_UNKNOWNPERMISSIONS 181VFS will ignore ownership information on filesystem objects 182.It Dv MNT_AUTOMOUNTED 183File system was mounted by automounter 184.It Dv MNT_JOURNALED 185File system is journaled 186.It Dv MNT_DEFWRITE 187File system should defer writes 188.It Dv MNT_MULTILABEL 189MAC support for individual labels 190.It Dv MNT_CPROTECT 191File system supports per-file encrypted data protection 192.El 193.Sh CAVEATS 194In Mac OS X versions before 10.4, f_iosize is 4096. On these older 195systems, use MAXBSIZE instead. 196.Sh RETURN VALUES 197Upon successful completion, a value of 0 is returned. 198Otherwise, -1 is returned and the global variable 199.Va errno 200is set to indicate the error. 201.Sh ERRORS 202The 203.Fn statfs 204routine fails if one or more of the following are true: 205.Bl -tag -width Er 206.It Bq Er ENOTDIR 207A component of the path prefix of 208.Fa Path 209is not a directory. 210.It Bq Er ENAMETOOLONG 211The length of a component of 212.Fa path 213exceeds 214.Dv {NAME_MAX} 215characters, or the length of 216.Fa path 217exceeds 218.Dv {PATH_MAX} 219characters. 220.It Bq Er ENOENT 221The file or directory referred to by 222.Fa path 223does not exist. 224.It Bq Er EACCES 225Search permission is denied for a component of the path prefix of 226.Fa path . 227.It Bq Er ELOOP 228Too many symbolic links were encountered in translating 229.Fa path . 230.It Bq Er EFAULT 231.Fa Buf 232or 233.Fa path 234points to an invalid address. 235.It Bq Er EIO 236An 237.Tn I/O 238error occurred while reading from or writing to the file system. 239.El 240.Pp 241The 242.Fn fstatfs 243routine fails if one or more of the following are true: 244.Bl -tag -width Er 245.It Bq Er EBADF 246.Fa fd 247is not a valid open file descriptor. 248.It Bq Er EFAULT 249.Fa Buf 250points to an invalid address. 251.It Bq Er EIO 252An 253.Tn I/O 254error occurred while reading from or writing to the file system. 255.El 256.Sh TRANSITIONAL DESCRIPTION (NOW DEPRECATED) 257The 258.Fa statfs64 259and 260.Fa fstatfs64 261routines are equivalent to their corresponding non-64-suffixed routine, 262when 64-bit inodes are in effect. 263They were added before there was support for the symbol variants, and so are 264now deprecated. 265Instead of using these, set the 266.Dv _DARWIN_USE_64_BIT_INODE 267macro before including header files to force 64-bit inode support. 268.Pp 269The 270.Fa statfs64 271structure used by these deprecated routines is the same as the 272.Fa statfs 273structure when 64-bit inodes are in effect (see above). 274.Sh SEE ALSO 275.Xr stat 2 , 276.Xr getfsstat 2 277.Sh HISTORY 278The 279.Fn statfs 280function first appeared in 4.4BSD. The 281.Fn statfs64 282and 283.Fn fstatfs64 284first appeared in Max OS X 10.5 (Leopard) and are now deprecated 285in favor of the corresponding symbol variants. 286