Add documentation for the statvfs, fstatvfs and fhstatvfs system calls.
[dragonfly.git] / lib / libc / sys / statvfs.2
1 .\"     $OpenBSD: statvfs.3,v 1.5 2008/03/26 09:37:59 jmc Exp $
2 .\"     $NetBSD: statfs.2,v 1.10 1995/06/29 11:40:48 cgd Exp $
3 .\"     $DragonFly: src/lib/libc/sys/statvfs.2,v 1.1 2008/09/28 16:33:35 swildner Exp $
4 .\"
5 .\" Copyright (c) 1989, 1991, 1993
6 .\"     The Regents of the University of California.  All rights reserved.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. 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.3 (Berkeley) 2/11/94
33 .\"
34 .Dd September 28, 2008
35 .Dt STATVFS 2
36 .Os
37 .Sh NAME
38 .Nm statvfs ,
39 .Nm fstatvfs
40 .Nd get file system statistics
41 .Sh SYNOPSIS
42 .Fd #include <sys/statvfs.h>
43 .Ft int
44 .Fn statvfs "const char *path" "struct statvfs *buf"
45 .Ft int
46 .Fn fstatvfs "int fd" "struct statvfs *buf"
47 .Sh DESCRIPTION
48 .Fn statvfs
49 returns information about a mounted file system.
50 .Fa path
51 is the path name of any file within the mounted file system.
52 .Fa buf
53 is a pointer to a
54 .Nm statvfs
55 structure defined as follows:
56 .Bd -literal
57 struct statvfs {
58         unsigned long f_bsize;       /* file system block size */
59         unsigned long f_frsize;      /* fundamental file system block size */
60         fsblkcnt_t    f_blocks;      /* number of blocks (unit f_frsize) */
61         fsblkcnt_t    f_bfree;       /* free blocks in file system */
62         fsblkcnt_t    f_bavail;      /* free blocks for non-root */
63         fsfilcnt_t    f_files;       /* total file inodes */
64         fsfilcnt_t    f_ffree;       /* free file inodes */
65         fsfilcnt_t    f_favail;      /* free file inodes for to non-root */
66         unsigned long f_fsid;        /* file system id */
67         unsigned long f_flag;        /* bit mask of f_flag values */
68         unsigned long f_namemax;     /* maximum filename length */
69         uid_t         f_owner;       /* user that mounted the filesystem */
70         unsigned int  f_type;        /* filesystem type */
71
72         uint64_t      f_syncreads;   /* count of sync reads since mount */
73         uint64_t      f_syncwrites;  /* count of sync writes since mount */
74
75         uint64_t      f_asyncreads;  /* count of async reads since mount */
76         uint64_t      f_asyncwrites; /* count of async writes since mount */
77
78         /*
79          * DragonFly extensions - full uuid FSID and owner
80          */
81         uuid_t        f_fsid_uuid;
82         uuid_t        f_uid_uuid;
83 };
84
85 /*
86  * f_flag definitions
87  */
88 #define ST_RDONLY     0x00000001     /* fs is read-only */
89 #define ST_NOSUID     0x00000002     /* ST_ISUID or ST_ISGID not supported */
90
91 /*
92  * DragonFly specific flags
93  */
94 #define ST_FSID_UUID  0x40000000     /* f_fsid_uuid field is valid */
95 #define ST_OWNER_UUID 0x80000000     /* f_owner_uuid field is valid */
96 .Ed
97 .Pp
98 The fields of type
99 .Va fsblkcnt_t
100 are reported in units of
101 .Va f_frsize .
102 .Pp
103 .Fn fstatvfs
104 returns the same information about an open file referenced by descriptor
105 .Fa fd .
106 .Sh RETURN VALUES
107 .Rv -std statvfs fstatvfs
108 .Sh ERRORS
109 .Fn statvfs
110 fails if one or more of the following are true:
111 .Bl -tag -width Er
112 .It Bq Er ENOTDIR
113 A component of the path prefix of
114 .Fa path
115 is not a directory.
116 .It Bq Er ENAMETOOLONG
117 The length of a component of
118 .Fa path
119 exceeds
120 .Dv {NAME_MAX}
121 characters, or the length of
122 .Fa path
123 exceeds
124 .Dv {PATH_MAX}
125 characters.
126 .It Bq Er ENOENT
127 The file referred to by
128 .Fa path
129 does not exist.
130 .It Bq Er EACCES
131 Search permission is denied for a component of the path prefix of
132 .Fa path .
133 .It Bq Er ELOOP
134 Too many symbolic links were encountered in translating
135 .Fa path .
136 .It Bq Er EFAULT
137 .Fa buf
138 or
139 .Fa path
140 points to an invalid address.
141 .It Bq Er EIO
142 An
143 .Tn I/O
144 error occurred while reading from or writing to the file system.
145 .El
146 .Pp
147 .Fn fstatvfs
148 fails if one or more of the following are true:
149 .Bl -tag -width Er
150 .It Bq Er EBADF
151 .Fa fd
152 is not a valid open file descriptor.
153 .It Bq Er EFAULT
154 .Fa buf
155 points to an invalid address.
156 .It Bq Er EIO
157 An
158 .Tn I/O
159 error occurred while reading from or writing to the file system.
160 .El
161 .Sh SEE ALSO
162 .Xr df 1 ,
163 .Xr mount 2 ,
164 .Xr stat 2 ,
165 .Xr statfs 2
166 .Sh STANDARDS
167 The
168 .Fn statvfs
169 and
170 .Fn fstatvfs
171 system calls conform to
172 .St -p1003.1-2001 .
173 .Sh HISTORY
174 The
175 .Fn statvfs
176 and
177 .Fn fstatvfs
178 functions first appeared in
179 .Dx 1.13 .