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