lib/libc/sys/statfs.2

   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 .\" 4. 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 .\"     @(#)statfs.2    8.5 (Berkeley) 5/24/95
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd November 1, 2006
  32 .Dt STATFS 2
  33 .Os
  34 .Sh NAME
  35 .Nm statfs
  36 .Nd get file system statistics
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/param.h
  41 .In sys/mount.h
  42 .Ft int
  43 .Fn statfs "const char *path" "struct statfs *buf"
  44 .Ft int
  45 .Fn fstatfs "int fd" "struct statfs *buf"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn statfs
  49 system call
  50 returns information about a mounted file system.
  51 The
  52 .Fa path
  53 argument
  54 is the path name of any file within the mounted file system.
  55 The
  56 .Fa buf
  57 argument
  58 is a pointer to a
  59 .Vt statfs
  60 structure defined as follows:
  61 .Bd -literal
  62 typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */
  63
  64 /*
  65  * filesystem statistics
  66  */
  67
  68 #define MFSNAMELEN      16              /* length of type name including null */
  69 #define MNAMELEN        88              /* size of on/from name bufs */
  70 #define STATFS_VERSION  0x20030518      /* current version number */
  71
  72 struct statfs {
  73 uint32_t f_version;             /* structure version number */
  74 uint32_t f_type;                /* type of filesystem */
  75 uint64_t f_flags;               /* copy of mount exported flags */
  76 uint64_t f_bsize;               /* filesystem fragment size */
  77 uint64_t f_iosize;              /* optimal transfer block size */
  78 uint64_t f_blocks;              /* total data blocks in filesystem */
  79 uint64_t f_bfree;               /* free blocks in filesystem */
  80 int64_t  f_bavail;              /* free blocks avail to non-superuser */
  81 uint64_t f_files;               /* total file nodes in filesystem */
  82 int64_t  f_ffree;               /* free nodes avail to non-superuser */
  83 uint64_t f_syncwrites;          /* count of sync writes since mount */
  84 uint64_t f_asyncwrites;         /* count of async writes since mount */
  85 uint64_t f_syncreads;           /* count of sync reads since mount */
  86 uint64_t f_asyncreads;          /* count of async reads since mount */
  87 uint64_t f_spare[10];           /* unused spare */
  88 uint32_t f_namemax;             /* maximum filename length */
  89 uid_t     f_owner;              /* user that mounted the filesystem */
  90 fsid_t    f_fsid;               /* filesystem id */
  91 char      f_charspare[80];          /* spare string space */
  92 char      f_fstypename[MFSNAMELEN]; /* filesystem type name */
  93 char      f_mntfromname[MNAMELEN];  /* mounted filesystem */
  94 char      f_mntonname[MNAMELEN];    /* directory on which mounted */
  95 };
  96 .Ed
  97 .Pp
  98 The flags that may be returned include:
  99 .Bl -tag -width MNT_SYNCHRONOUS
 100 .It Dv MNT_RDONLY
 101 The file system is mounted read-only;
 102 Even the super-user may not write on it.
 103 .It Dv MNT_NOEXEC
 104 Files may not be executed from the file system.
 105 .It Dv MNT_NOSUID
 106 Setuid and setgid bits on files are not honored when they are executed.
 107 .It Dv MNT_SYNCHRONOUS
 108 All I/O to the file system is done synchronously.
 109 .It Dv MNT_ASYNC
 110 No file system I/O is done synchronously.
 111 .It Dv MNT_SOFTDEP
 112 Soft updates being done (see
 113 .Xr ffs 7 ) .
 114 .It Dv MNT_GJOURNAL
 115 Journaling with gjournal is enabled (see
 116 .Xr gjournal 8 ) .
 117 .It Dv MNT_SUIDDIR
 118 Special handling of SUID bit on directories.
 119 .It Dv MNT_UNION
 120 Union with underlying file system.
 121 .It Dv MNT_NOSYMFOLLOW
 122 Symbolic links are not followed.
 123 .It Dv MNT_NOCLUSTERR
 124 Read clustering is disabled.
 125 .It Dv MNT_NOCLUSTERW
 126 Write clustering is disabled.
 127 .\".It Dv MNT_JAILDEVFS
 128 .\"XXX
 129 .It Dv MNT_MULTILABEL
 130 Mandatory Access Control (MAC) support for individual objects
 131 (see
 132 .Xr mac 4 ) .
 133 .It Dv MNT_ACLS
 134 Access Control List (ACL) support enabled.
 135 .It Dv MNT_LOCAL
 136 The file system resides locally.
 137 .It Dv MNT_QUOTA
 138 The file system has quotas enabled on it.
 139 .It Dv MNT_ROOTFS
 140 Identifies the root file system.
 141 .It Dv MNT_EXRDONLY
 142 The file system is exported read-only.
 143 .It Dv MNT_NOATIME
 144 Updating of file access times is disabled.
 145 .It Dv MNT_USER
 146 The file system has been mounted by a user.
 147 .\".It Dv MNT_IGNORE
 148 .\"XXX
 149 .It Dv MNT_EXPORTED
 150 The file system is exported for both reading and writing.
 151 .It Dv MNT_DEFEXPORTED
 152 The file system is exported for both reading and writing to any Internet host.
 153 .It Dv MNT_EXPORTANON
 154 The file system maps all remote accesses to the anonymous user.
 155 .It Dv MNT_EXKERB
 156 The file system is exported with Kerberos uid mapping.
 157 .It Dv MNT_EXPUBLIC
 158 The file system is exported publicly (WebNFS).
 159 .El
 160 .Pp
 161 Fields that are undefined for a particular file system are set to -1.
 162 The
 163 .Fn fstatfs
 164 system call
 165 returns the same information about an open file referenced by descriptor
 166 .Fa fd .
 167 .Sh RETURN VALUES
 168 .Rv -std
 169 .Sh ERRORS
 170 The
 171 .Fn statfs
 172 system call
 173 fails if one or more of the following are true:
 174 .Bl -tag -width Er
 175 .It Bq Er ENOTDIR
 176 A component of the path prefix of
 177 .Fa path
 178 is not a directory.
 179 .It Bq Er ENAMETOOLONG
 180 The length of a component of
 181 .Fa path
 182 exceeds 255 characters,
 183 or the length of
 184 .Fa path
 185 exceeds 1023 characters.
 186 .It Bq Er ENOENT
 187 The file referred to by
 188 .Fa path
 189 does not exist.
 190 .It Bq Er EACCES
 191 Search permission is denied for a component of the path prefix of
 192 .Fa path .
 193 .It Bq Er ELOOP
 194 Too many symbolic links were encountered in translating
 195 .Fa path .
 196 .It Bq Er EFAULT
 197 The
 198 .Fa buf
 199 or
 200 .Fa path
 201 argument
 202 points to an invalid address.
 203 .It Bq Er EIO
 204 An
 205 .Tn I/O
 206 error occurred while reading from or writing to the file system.
 207 .El
 208 .Pp
 209 The
 210 .Fn fstatfs
 211 system call
 212 fails if one or more of the following are true:
 213 .Bl -tag -width Er
 214 .It Bq Er EBADF
 215 The
 216 .Fa fd
 217 argument
 218 is not a valid open file descriptor.
 219 .It Bq Er EFAULT
 220 The
 221 .Fa buf
 222 argument
 223 points to an invalid address.
 224 .It Bq Er EIO
 225 An
 226 .Tn I/O
 227 error occurred while reading from or writing to the file system.
 228 .El
 229 .Sh SEE ALSO
 230 .Xr fhstatfs 2
 231 .Sh HISTORY
 232 The
 233 .Fn statfs
 234 system call first appeared in
 235 .Bx 4.4 .