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.\" 3. 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: src/lib/libc/sys/getfsstat.2,v 1.7.2.4 2001/12/14 18:34:00 ru Exp $ 30.\" 31.Dd May 25, 1995 32.Dt GETFSSTAT 2 33.Os 34.Sh NAME 35.Nm getfsstat , 36.Nm getvfsstat 37.Nd get list of all mounted filesystems 38.Sh LIBRARY 39.Lb libc 40.Sh SYNOPSIS 41.In sys/param.h 42.In sys/ucred.h 43.In sys/mount.h 44.Ft int 45.Fn getfsstat "struct statfs *buf" "long bufsize" "int flags" 46.Ft int 47.Fn getvfsstat "struct statfs *buf" "struct statvfs *vbuf" "long vbufsize" "int flags" 48.Sh DESCRIPTION 49.Fn Getfsstat 50returns information about all mounted filesystems. 51.Fa Buf 52is a pointer to 53.Vt statfs 54structures defined as follows: 55.Bd -literal 56typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */ 57 58/* 59 * file system statistics 60 */ 61 62#define MFSNAMELEN 16 /* length of fs type name, including null */ 63#define MNAMELEN 80 /* length of buffer for returned name */ 64 65struct statfs { 66 long f_spare2; /* placeholder */ 67 long f_bsize; /* fundamental file system block size */ 68 long f_iosize; /* optimal transfer block size */ 69 long f_blocks; /* total data blocks in file system */ 70 long f_bfree; /* free blocks in fs */ 71 long f_bavail; /* free blocks avail to non-superuser */ 72 long f_files; /* total file nodes in file system */ 73 long f_ffree; /* free file nodes in fs */ 74 fsid_t f_fsid; /* file system id */ 75 uid_t f_owner; /* user that mounted the filesystem */ 76 int f_type; /* type of filesystem (see below) */ 77 int f_flags; /* copy of mount flags */ 78 long f_syncwrites; /* count of sync writes since mount */ 79 long f_asyncwrites; /* count of async writes since mount */ 80 char f_fstypename[MFSNAMELEN];/* fs type name */ 81 char f_mntonname[MNAMELEN];/* directory on which mounted */ 82 long f_syncreads; /* count of sync reads since mount */ 83 long f_asyncreads; /* count of async reads since mount */ 84 short f_spares1; /* unused spare */ 85 char f_mntfromname[MNAMELEN];/* mounted filesystem */ 86 short f_spares2; /* unused spare */ 87 long f_spare[2]; /* unused spare */ 88}; 89.Ed 90.Pp 91The flags that may be returned include: 92.Bl -tag -width ".Dv MNT_SYNCHRONOUS" 93.It Dv MNT_RDONLY 94The filesystem is mounted read-only; 95Even the super-user may not write on it. 96.It Dv MNT_NOEXEC 97Files may not be executed from the filesystem. 98.It Dv MNT_NOSUID 99Setuid and setgid bits on files are not honored when they are executed. 100.It Dv MNT_NODEV 101Special files in the filesystem may not be opened. 102.It Dv MNT_SYNCHRONOUS 103All I/O to the filesystem is done synchronously. 104.It Dv MNT_ASYNC 105No filesystem I/O is done synchronously. 106.It Dv MNT_LOCAL 107The filesystem resides locally. 108.It Dv MNT_QUOTA 109The filesystem has quotas enabled on it. 110.It Dv MNT_ROOTFS 111Identifies the root filesystem. 112.It Dv MNT_EXRDONLY 113The filesystem is exported read-only. 114.It Dv MNT_EXPORTED 115The filesystem is exported for both reading and writing. 116.It Dv MNT_DEFEXPORTED 117The filesystem is exported for both reading and writing to any Internet host. 118.It Dv MNT_EXPORTANON 119The filesystem maps all remote accesses to the anonymous user. 120.It Dv MNT_EXKERB 121The filesystem is exported with Kerberos uid mapping. 122.El 123.Pp 124Fields that are undefined for a particular filesystem are set to -1. 125The buffer is filled with an array of 126.Fa fsstat 127structures, one for each mounted filesystem 128up to the size specified by 129.Fa bufsize . 130.Pp 131If 132.Fa buf 133is given as NULL, 134.Fn getfsstat 135returns just the number of mounted filesystems. 136.Pp 137Normally 138.Fa flags 139should be specified as 140.Dv MNT_WAIT . 141If 142.Fa flags 143is set to 144.Dv MNT_NOWAIT , 145.Fn getfsstat 146will return the information it has available without requesting 147an update from each filesystem. 148Thus, some of the information will be out of date, but 149.Fn getfsstat 150will not block waiting for information from a filesystem that is 151unable to respond. 152.Fn Getvfsstat 153returns extended information about all mounted filesystems. 154Note that 155.Fa vbufsize 156represents the size of 157.Fa vbuf , 158and 159.Fa buf 160is expected to be of contemporary size for its own structures. 161.Sh RETURN VALUES 162Upon successful completion, the number of 163.Fa fsstat 164structures is returned. 165Otherwise, -1 is returned and the global variable 166.Va errno 167is set to indicate the error. 168.Sh ERRORS 169.Fn Getfsstat 170and 171.Fn getvfsstat 172fail if one or more of the following are true: 173.Bl -tag -width Er 174.It Bq Er EFAULT 175.Fa Buf 176points to an invalid address. 177.It Bq Er EIO 178An 179.Tn I/O 180error occurred while reading from or writing to the filesystem. 181.El 182.Sh SEE ALSO 183.Xr statfs 2 , 184.Xr fstab 5 , 185.Xr mount 8 186.Sh HISTORY 187The 188.Fn getfsstat 189function first appeared in 190.Bx 4.4 . 191