.\" Copyright (c) 1989, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" @(#)statfs.2 8.1 (Berkeley) 6/9/93
.Nd get file system statistics
.Fd #include <sys/param.h>
.Fd #include <sys/mount.h>
.Fn statfs "const char *path" "struct statfs *buf"
.Fn fstatfs "int fd" "struct statfs *buf"
returns information about a mounted file system.
is the path name of any file within the mounted filesystem.
structure defined as follows:
#define MNAMELEN 32 /* length of buffer for returned name */
short f_type; /* type of filesystem (see below) */
short f_flags; /* copy of mount flags */
long f_bsize; /* fundamental file system block size */
long f_iosize; /* optimal transfer block size */
long f_blocks; /* total data blocks in file system */
long f_bfree; /* free blocks in fs */
long f_bavail; /* free blocks avail to non-superuser */
long f_files; /* total file nodes in file system */
long f_ffree; /* free file nodes in fs */
fsid_t f_fsid; /* file system id */
long f_spare[6]; /* spare for later */
char f_mntonname[MNAMELEN]; /* mount point */
char f_mntfromname[MNAMELEN]; /* mounted filesystem */
Fields that are undefined for a particular file system are set to -1.
returns the same information about an open file referenced by descriptor
Upon successful completion, a value of 0 is returned.
Otherwise, -1 is returned and the global variable
is set to indicate the error.
fails if one or more of the following are true:
.Bl -tag -width ENAMETOOLONGA
A component of the path prefix of
contains a character with the high-order bit set.
The length of a component of
Search permission is denied for a component of the path prefix of
Too many symbolic links were encountered in translating
points to an invalid address.
error occurred while reading from or writing to the file system.
fails if one or both of the following are true:
.Bl -tag -width ENAMETOOLONGA
is not a valid open file descriptor.
points to an invalid address.
error occurred while reading from or writing to the file system.
function first appeared in 4.4BSD.