1 .\" Copyright (c) 1989, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
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.4 2007/12/03 20:11:15 swildner Exp $
41 .Nd get list of all mounted filesystems
49 .Fn getfsstat "struct statfs *buf" "long bufsize" "int flags"
52 returns information about all mounted filesystems.
56 structures defined as follows:
58 typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */
61 * file system statistics
64 #define MFSNAMELEN 16 /* length of fs type name, including null */
65 #define MNAMELEN 90 /* length of buffer for returned name */
68 long f_spare2; /* placeholder */
69 long f_bsize; /* fundamental file system block size */
70 long f_iosize; /* optimal transfer block size */
71 long f_blocks; /* total data blocks in file system */
72 long f_bfree; /* free blocks in fs */
73 long f_bavail; /* free blocks avail to non-superuser */
74 long f_files; /* total file nodes in file system */
75 long f_ffree; /* free file nodes in fs */
76 fsid_t f_fsid; /* file system id */
77 uid_t f_owner; /* user that mounted the filesystem */
78 int f_type; /* type of filesystem (see below) */
79 int f_flags; /* copy of mount flags */
80 long f_spare[2]; /* spare for later */
81 char f_fstypename[MFSNAMELEN];/* fs type name */
82 char f_mntonname[MNAMELEN];/* directory on which mounted */
83 char f_mntfromname[MNAMELEN];/* mounted filesystem */
87 The flags that may be returned include:
88 .Bl -tag -width ".Dv MNT_SYNCHRONOUS"
90 The filesystem is mounted read-only;
91 Even the super-user may not write on it.
93 Files may not be executed from the filesystem.
95 Setuid and setgid bits on files are not honored when they are executed.
97 Special files in the filesystem may not be opened.
98 .It Dv MNT_SYNCHRONOUS
99 All I/O to the filesystem is done synchronously.
101 No filesystem I/O is done synchronously.
103 The filesystem resides locally.
105 The filesystem has quotas enabled on it.
107 Identifies the root filesystem.
109 The filesystem is exported read-only.
111 The filesystem is exported for both reading and writing.
112 .It Dv MNT_DEFEXPORTED
113 The filesystem is exported for both reading and writing to any Internet host.
114 .It Dv MNT_EXPORTANON
115 The filesystem maps all remote accesses to the anonymous user.
117 The filesystem is exported with Kerberos uid mapping.
120 Fields that are undefined for a particular filesystem are set to -1.
121 The buffer is filled with an array of
123 structures, one for each mounted filesystem
124 up to the size specified by
131 returns just the number of mounted filesystems.
135 should be specified as
142 will return the information it has available without requesting
143 an update from each filesystem.
144 Thus, some of the information will be out of date, but
146 will not block waiting for information from a filesystem that is
149 Upon successful completion, the number of
151 structures is returned.
152 Otherwise, -1 is returned and the global variable
154 is set to indicate the error.
157 fails if one or more of the following are true:
161 points to an invalid address.
165 error occurred while reading from or writing to the filesystem.
174 function first appeared in