lib/libc/sys/getfsstat.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 .\"     @(#)getfsstat.2 8.3 (Berkeley) 5/25/95
  33 .\" $FreeBSD: src/lib/libc/sys/getfsstat.2,v 1.7.2.4 2001/12/14 18:34:00 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/getfsstat.2,v 1.5 2008/06/01 20:46:45 dillon Exp $
  35 .\"
  36 .Dd May 25, 1995
  37 .Dt GETFSSTAT 2
  38 .Os
  39 .Sh NAME
  40 .Nm getfsstat ,
  41 .Nm getvfsstat
  42 .Nd get list of all mounted filesystems
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In sys/param.h
  47 .In sys/ucred.h
  48 .In sys/mount.h
  49 .Ft int
  50 .Fn getfsstat "struct statfs *buf" "long bufsize" "int flags"
  51 .Fn getvfsstat "struct statfs *buf" "struct statvfs *vbuf" "long vbufsize" "int flags"
  52 .Sh DESCRIPTION
  53 .Fn Getfsstat
  54 returns information about all mounted filesystems.
  55 .Fa Buf
  56 is a pointer to
  57 .Vt statfs
  58 structures defined as follows:
  59 .Bd -literal
  60 typedef 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
  69 struct statfs {
  70     long    f_spare2;           /* placeholder */
  71     long    f_bsize;            /* fundamental file system block size */
  72     long    f_iosize;           /* optimal transfer block size */
  73     long    f_blocks;           /* total data blocks in file system */
  74     long    f_bfree;            /* free blocks in fs */
  75     long    f_bavail;           /* free blocks avail to non-superuser */
  76     long    f_files;            /* total file nodes in file system */
  77     long    f_ffree;            /* free file nodes in fs */
  78     fsid_t  f_fsid;             /* file system id */
  79     uid_t   f_owner;            /* user that mounted the filesystem */
  80     int     f_type;             /* type of filesystem (see below) */
  81     int     f_flags;            /* copy of mount flags */
  82     long    f_spare[2];         /* spare for later */
  83     char    f_fstypename[MFSNAMELEN];/* fs type name */
  84     char    f_mntonname[MNAMELEN];/* directory on which mounted */
  85     char    f_mntfromname[MNAMELEN];/* mounted filesystem */
  86 };
  87 .Ed
  88 .Pp
  89 The flags that may be returned include:
  90 .Bl -tag -width ".Dv MNT_SYNCHRONOUS"
  91 .It Dv MNT_RDONLY
  92 The filesystem is mounted read-only;
  93 Even the super-user may not write on it.
  94 .It Dv MNT_NOEXEC
  95 Files may not be executed from the filesystem.
  96 .It Dv MNT_NOSUID
  97 Setuid and setgid bits on files are not honored when they are executed.
  98 .It Dv MNT_NODEV
  99 Special files in the filesystem may not be opened.
 100 .It Dv MNT_SYNCHRONOUS
 101 All I/O to the filesystem is done synchronously.
 102 .It Dv MNT_ASYNC
 103 No filesystem I/O is done synchronously.
 104 .It Dv MNT_LOCAL
 105 The filesystem resides locally.
 106 .It Dv MNT_QUOTA
 107 The filesystem has quotas enabled on it.
 108 .It Dv MNT_ROOTFS
 109 Identifies the root filesystem.
 110 .It Dv MNT_EXRDONLY
 111 The filesystem is exported read-only.
 112 .It Dv MNT_EXPORTED
 113 The filesystem is exported for both reading and writing.
 114 .It Dv MNT_DEFEXPORTED
 115 The filesystem is exported for both reading and writing to any Internet host.
 116 .It Dv MNT_EXPORTANON
 117 The filesystem maps all remote accesses to the anonymous user.
 118 .It Dv MNT_EXKERB
 119 The filesystem is exported with Kerberos uid mapping.
 120 .El
 121 .Pp
 122 Fields that are undefined for a particular filesystem are set to -1.
 123 The buffer is filled with an array of
 124 .Fa fsstat
 125 structures, one for each mounted filesystem
 126 up to the size specified by
 127 .Fa bufsize .
 128 .Pp
 129 If
 130 .Fa buf
 131 is given as NULL,
 132 .Fn getfsstat
 133 returns just the number of mounted filesystems.
 134 .Pp
 135 Normally
 136 .Fa flags
 137 should be specified as
 138 .Dv MNT_WAIT .
 139 If
 140 .Fa flags
 141 is set to
 142 .Dv MNT_NOWAIT ,
 143 .Fn getfsstat
 144 will return the information it has available without requesting
 145 an update from each filesystem.
 146 Thus, some of the information will be out of date, but
 147 .Fn getfsstat
 148 will not block waiting for information from a filesystem that is
 149 unable to respond.
 150 .Fn Getvfsstat
 151 returns extended information about all mounted filesystems.
 152 Note that
 153 .Fa vbufsize
 154 represents the size of
 155 .Fa vbuf ,
 156 and
 157 .Fa buf
 158 is expected to be of contemporary size for its own structures.
 159 .Sh RETURN VALUES
 160 Upon successful completion, the number of
 161 .Fa fsstat
 162 structures is returned.
 163 Otherwise, -1 is returned and the global variable
 164 .Va errno
 165 is set to indicate the error.
 166 .Sh ERRORS
 167 .Fn Getfsstat
 168 and
 169 .Fn getvfsstat
 170 fail if one or more of the following are true:
 171 .Bl -tag -width Er
 172 .It Bq Er EFAULT
 173 .Fa Buf
 174 points to an invalid address.
 175 .It Bq Er EIO
 176 An
 177 .Tn I/O
 178 error occurred while reading from or writing to the filesystem.
 179 .El
 180 .Sh SEE ALSO
 181 .Xr statfs 2 ,
 182 .Xr fstab 5 ,
 183 .Xr mount 8
 184 .Sh HISTORY
 185 The
 186 .Fn getfsstat
 187 function first appeared in
 188 .Bx 4.4 .