bsd/man/man2/statfs.2

   1 .\"     $NetBSD: statfs.2,v 1.10 1995/06/29 11:40:48 cgd Exp $
   2 .\"
   3 .\" Copyright (c) 1989, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by the University of
  17 .\"     California, Berkeley and its contributors.
  18 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)statfs.2    8.3 (Berkeley) 2/11/94
  35 .\"
  36 .Dd February 11, 1994
  37 .Dt STATFS 2
  38 .Os
  39 .Sh NAME
  40 .Nm statfs
  41 .Nd get file system statistics
  42 .Sh SYNOPSIS
  43 .Fd #include <sys/param.h>
  44 .Fd #include <sys/mount.h>
  45 .Ft int
  46 .Fn statfs "const char *path" "struct statfs *buf"
  47 .Ft int
  48 .Fn fstatfs "int fd" "struct statfs *buf"
  49 .Sh DESCRIPTION
  50 .Fn Statfs
  51 returns information about a mounted file system.
  52 .Fa Path
  53 is the path name of any file within the mounted file system.
  54 .Fa Buf
  55 is a pointer to a statfs structure defined as follows:
  56 .Bd -literal
  57 typedef struct { int32_t val[2]; } fsid_t;
  58
  59 #define MFSNAMELEN   15 /* length of fs type name, not inc. nul */
  60 #define MNAMELEN     90 /* length of buffer for returned name */
  61
  62 struct statfs {
  63     short   f_otype;    /* type of file system (reserved: zero) */
  64     short   f_oflags;   /* copy of mount flags (reserved: zero) */
  65     long    f_bsize;    /* fundamental file system block size */
  66     long    f_iosize;   /* optimal transfer block size */
  67     long    f_blocks;   /* total data blocks in file system */
  68     long    f_bfree;    /* free blocks in fs */
  69     long    f_bavail;   /* free blocks avail to non-superuser */
  70     long    f_files;    /* total file nodes in file system */
  71     long    f_ffree;    /* free file nodes in fs */
  72     fsid_t  f_fsid;     /* file system id (super-user only) */
  73     uid_t   f_owner;    /* user that mounted the file system */
  74     short   f_reserved1;        /* reserved for future use */
  75     short   f_type;     /* type of file system (reserved) */
  76     long    f_flags;    /* copy of mount flags (reserved) */
  77     long    f_reserved2[2];     /* reserved for future use */
  78     char    f_fstypename[MFSNAMELEN]; /* fs type name */
  79     char    f_mntonname[MNAMELEN];    /* directory on which mounted */
  80     char    f_mntfromname[MNAMELEN];  /* mounted file system */
  81     char    f_reserved3;        /* reserved for future use */
  82     long    f_reserved4[4];     /* reserved for future use */
  83 };
  84 .Ed
  85 .Pp
  86 Fields that are undefined for a particular file system are set to -1.
  87 .Fn Fstatfs
  88 returns the same information about an open file referenced by descriptor
  89 .Fa fd .
  90 .Sh RETURN VALUES
  91 Upon successful completion, a value of 0 is returned.
  92 Otherwise, -1 is returned and the global variable
  93 .Va errno
  94 is set to indicate the error.
  95 .Sh ERRORS
  96 .Fn Statfs
  97 fails if one or more of the following are true:
  98 .Bl -tag -width Er
  99 .It Bq Er ENOTDIR
 100 A component of the path prefix of
 101 .Fa Path
 102 is not a directory.
 103 .It Bq Er ENAMETOOLONG
 104 The length of a component of
 105 .Fa path
 106 exceeds
 107 .Dv {NAME_MAX}
 108 characters, or the length of
 109 .Fa path
 110 exceeds
 111 .Dv {PATH_MAX}
 112 characters.
 113 .It Bq Er ENOENT
 114 The file referred to by
 115 .Fa path
 116 does not exist.
 117 .It Bq Er EACCES
 118 Search permission is denied for a component of the path prefix of
 119 .Fa path .
 120 .It Bq Er ELOOP
 121 Too many symbolic links were encountered in translating
 122 .Fa path .
 123 .It Bq Er EFAULT
 124 .Fa Buf
 125 or
 126 .Fa path
 127 points to an invalid address.
 128 .It Bq Er EIO
 129 An
 130 .Tn I/O
 131 error occurred while reading from or writing to the file system.
 132 .El
 133 .Pp
 134 .Fn Fstatfs
 135 fails if one or more of the following are true:
 136 .Bl -tag -width Er
 137 .It Bq Er EBADF
 138 .Fa fd
 139 is not a valid open file descriptor.
 140 .It Bq Er EFAULT
 141 .Fa Buf
 142 points to an invalid address.
 143 .It Bq Er EIO
 144 An
 145 .Tn I/O
 146 error occurred while reading from or writing to the file system.
 147 .El
 148 .Sh HISTORY
 149 The
 150 .Fn statfs
 151 function first appeared in 4.4BSD.