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 .\" 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 .\"     @(#)getfsstat.2 8.3 (Berkeley) 5/25/95
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd November 20, 2003
  32 .Dt GETFSSTAT 2
  33 .Os
  34 .Sh NAME
  35 .Nm getfsstat
  36 .Nd get list of all mounted file systems
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/param.h
  41 .In sys/ucred.h
  42 .In sys/mount.h
  43 .Ft int
  44 .Fn getfsstat "struct statfs *buf" "long bufsize" "int flags"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn getfsstat
  48 system call
  49 returns information about all mounted file systems.
  50 The
  51 .Fa buf
  52 argument
  53 is a pointer to
  54 .Vt statfs
  55 structures, as described in
  56 .Xr statfs 2 .
  57 .Pp
  58 Fields that are undefined for a particular file system are set to -1.
  59 The buffer is filled with an array of
  60 .Fa statfs
  61 structures, one for each mounted file system
  62 up to the byte count specified by
  63 .Fa bufsize .
  64 Note, the
  65 .Fa bufsize
  66 argument is the number of bytes that
  67 .Fa buf
  68 can hold, not the count of statfs structures it will hold.
  69 .Pp
  70 If
  71 .Fa buf
  72 is given as NULL,
  73 .Fn getfsstat
  74 returns just the number of mounted file systems.
  75 .Pp
  76 Normally
  77 .Fa flags
  78 should be specified as
  79 .Dv MNT_WAIT .
  80 If
  81 .Fa flags
  82 is set to
  83 .Dv MNT_NOWAIT ,
  84 .Fn getfsstat
  85 will return the information it has available without requesting
  86 an update from each file system.
  87 Thus, some of the information will be out of date, but
  88 .Fn getfsstat
  89 will not block waiting for information from a file system that is
  90 unable to respond.
  91 .Sh RETURN VALUES
  92 Upon successful completion, the number of
  93 .Fa statfs
  94 structures is returned.
  95 Otherwise, -1 is returned and the global variable
  96 .Va errno
  97 is set to indicate the error.
  98 .Sh ERRORS
  99 The
 100 .Fn getfsstat
 101 system call
 102 fails if one or more of the following are true:
 103 .Bl -tag -width Er
 104 .It Bq Er EFAULT
 105 The
 106 .Fa buf
 107 argument
 108 points to an invalid address.
 109 .It Bq Er EIO
 110 An
 111 .Tn I/O
 112 error occurred while reading from or writing to the file system.
 113 .El
 114 .Sh SEE ALSO
 115 .Xr statfs 2 ,
 116 .Xr fstab 5 ,
 117 .Xr mount 8
 118 .Sh HISTORY
 119 The
 120 .Fn getfsstat
 121 system call first appeared in
 122 .Bx 4.4 .