]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (C) 2003 Andries Brouwer (aeb@cwi.nl) |
2 | .\" | |
3 | .\" Permission is granted to make and distribute verbatim copies of this | |
4 | .\" manual provided the copyright notice and this permission notice are | |
5 | .\" preserved on all copies. | |
6 | .\" | |
7 | .\" Permission is granted to copy and distribute modified versions of this | |
8 | .\" manual under the conditions for verbatim copying, provided that the | |
9 | .\" entire resulting derived work is distributed under the terms of a | |
10 | .\" permission notice identical to this one. | |
c13182ef | 11 | .\" |
fea681da MK |
12 | .\" Since the Linux kernel and libraries are constantly changing, this |
13 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
14 | .\" responsibility for errors or omissions, or for damages resulting from | |
15 | .\" the use of the information contained herein. The author(s) may not | |
16 | .\" have taken the same level of care in the production of this manual, | |
17 | .\" which is licensed free of charge, as they might when working | |
18 | .\" professionally. | |
c13182ef | 19 | .\" |
fea681da MK |
20 | .\" Formatted or processed versions of this manual, if unaccompanied by |
21 | .\" the source, must acknowledge the copyright and authors of this work. | |
22 | .\" | |
23 | .\" The pathconf note is from Walter Harms | |
24 | .\" This is not a system call on Linux | |
25 | .\" | |
305a0578 | 26 | .\" Modified 2004-06-23 by Michael Kerrisk <mtk-manpages@gmx.net> |
fea681da | 27 | .\" |
d9343c5c | 28 | .TH STATVFS 2 2003-08-22 "Linux" "Linux Programmer's Manual" |
fea681da MK |
29 | .SH NAME |
30 | statvfs, fstatvfs \- get file system statistics | |
31 | .SH SYNOPSIS | |
32 | .B #include <sys/statvfs.h> | |
33 | .sp | |
34 | .BI "int statvfs(const char *" path ", struct statvfs *" buf ); | |
35 | .br | |
36 | .BI "int fstatvfs(int " fd ", struct statvfs *" buf ); | |
37 | .SH DESCRIPTION | |
38 | The function | |
e511ffb6 | 39 | .BR statvfs () |
fea681da MK |
40 | returns information about a mounted file system. |
41 | .I path | |
2d7195b8 | 42 | is the pathname of any file within the mounted filesystem. |
fea681da MK |
43 | .I buf |
44 | is a pointer to a | |
45 | .I statvfs | |
46 | structure defined approximately as follows: | |
47 | ||
48 | .nf | |
cf0a9ace | 49 | struct statvfs { |
fea681da MK |
50 | unsigned long f_bsize; /* file system block size */ |
51 | unsigned long f_frsize; /* fragment size */ | |
52 | fsblkcnt_t f_blocks; /* size of fs in f_frsize units */ | |
53 | fsblkcnt_t f_bfree; /* # free blocks */ | |
54 | fsblkcnt_t f_bavail; /* # free blocks for non-root */ | |
55 | fsfilcnt_t f_files; /* # inodes */ | |
56 | fsfilcnt_t f_ffree; /* # free inodes */ | |
57 | fsfilcnt_t f_favail; /* # free inodes for non-root */ | |
c13182ef | 58 | unsigned long f_fsid; /* file system ID */ |
fea681da MK |
59 | unsigned long f_flag; /* mount flags */ |
60 | unsigned long f_namemax; /* maximum filename length */ | |
cf0a9ace | 61 | }; |
fea681da MK |
62 | .fi |
63 | ||
64 | Here the types | |
66ee0c7e | 65 | .I fsblkcnt_t |
fea681da | 66 | and |
66ee0c7e | 67 | .I fsfilcnt_t |
fea681da MK |
68 | are defined in |
69 | .IR <sys/types.h> . | |
70 | Both used to be | |
9ff08aad | 71 | .IR "unsigned long" . |
fea681da MK |
72 | |
73 | The field | |
74 | .I f_flag | |
75 | is a bit mask (of mount flags, see | |
76 | .BR mount (8)). | |
77 | Bits defined by POSIX are | |
78 | .TP | |
79 | .B ST_RDONLY | |
80 | Read-only file system. | |
81 | .TP | |
82 | .B ST_NOSUID | |
880f5b4b | 83 | Set-user-ID/set-group-ID bits are ignored by |
deff9000 | 84 | .BR exec (3). |
fea681da | 85 | .LP |
fea681da MK |
86 | It is unspecified whether all members of the returned struct |
87 | have meaningful values on all filesystems. | |
88 | ||
e511ffb6 | 89 | .BR fstatvfs () |
fea681da MK |
90 | returns the same information about an open file referenced by descriptor |
91 | .IR fd . | |
92 | .SH "RETURN VALUE" | |
c13182ef MK |
93 | On success, zero is returned. |
94 | On error, \-1 is returned, and | |
fea681da MK |
95 | .I errno |
96 | is set appropriately. | |
97 | .SH ERRORS | |
98 | .TP | |
99 | .B EACCES | |
1e321034 | 100 | .RB ( statvfs ()) |
fea681da MK |
101 | Search permission is denied for a component of the path prefix of |
102 | .IR path . | |
103 | (See also | |
ad7cc990 | 104 | .BR path_resolution (7).) |
fea681da MK |
105 | .TP |
106 | .B EBADF | |
1e321034 | 107 | .RB ( fstatvfs ()) |
fea681da MK |
108 | .I fd |
109 | is not a valid open file descriptor. | |
110 | .TP | |
111 | .B EFAULT | |
112 | .I Buf | |
113 | or | |
114 | .I path | |
115 | points to an invalid address. | |
116 | .TP | |
117 | .B EINTR | |
118 | This call was interrupted by a signal. | |
119 | .TP | |
120 | .B EIO | |
121 | An I/O error occurred while reading from the file system. | |
122 | .TP | |
123 | .B ELOOP | |
1e321034 | 124 | .RB ( statvfs ()) |
fea681da MK |
125 | Too many symbolic links were encountered in translating |
126 | .IR path . | |
127 | .TP | |
128 | .B ENAMETOOLONG | |
1e321034 | 129 | .RB ( statvfs ()) |
fea681da MK |
130 | .I path |
131 | is too long. | |
132 | .TP | |
133 | .B ENOENT | |
1e321034 | 134 | .RB ( statvfs ()) |
fea681da MK |
135 | The file referred to by |
136 | .I path | |
137 | does not exist. | |
138 | .TP | |
139 | .B ENOMEM | |
140 | Insufficient kernel memory was available. | |
141 | .TP | |
142 | .B ENOSYS | |
143 | The file system does not support this call. | |
144 | .TP | |
145 | .B ENOTDIR | |
1e321034 | 146 | .RB ( statvfs ()) |
fea681da MK |
147 | A component of the path prefix of |
148 | .I path | |
149 | is not a directory. | |
150 | .TP | |
151 | .B EOVERFLOW | |
152 | Some values were too large to be represented in the returned struct. | |
fea681da | 153 | .SH "CONFORMING TO" |
75b48e9d | 154 | POSIX.1-2001 |
fea681da | 155 | .SH NOTES |
c13182ef | 156 | The Linux kernel has system calls |
0bfa087b | 157 | .BR statfs (2) |
1e321034 | 158 | and |
0bfa087b | 159 | .BR fstatfs (2) |
fea681da MK |
160 | to support this library call. |
161 | ||
11dcec1d | 162 | The current glibc implementations of |
fea681da MK |
163 | .sp |
164 | .nf | |
165 | pathconf(path, _PC_REC_XFER_ALIGN); | |
166 | pathconf(path, _PC_ALLOC_SIZE_MIN); | |
167 | pathconf(path, _PC_REC_MIN_XFER_SIZE); | |
168 | .fi | |
169 | .sp | |
11dcec1d | 170 | respectively use the |
fea681da MK |
171 | .IR f_frsize , |
172 | .IR f_frsize , | |
173 | and | |
174 | .IR f_bsize | |
175 | fields of the return value of | |
176 | .IR "statvfs(path,buf)" . | |
177 | .SH "SEE ALSO" | |
178 | .BR statfs (2) |