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