1994-05-27 05:00:24 +00:00
|
|
|
.\" 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
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 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.
|
2017-02-28 23:42:47 +00:00
|
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
1994-05-27 05:00:24 +00:00
|
|
|
.\" 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
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
1997-03-11 11:35:56 +00:00
|
|
|
.\" @(#)statfs.2 8.5 (Berkeley) 5/24/95
|
1999-08-28 00:22:10 +00:00
|
|
|
.\" $FreeBSD$
|
1994-05-27 05:00:24 +00:00
|
|
|
.\"
|
Commit the 64-bit inode project.
Extend the ino_t, dev_t, nlink_t types to 64-bit ints. Modify
struct dirent layout to add d_off, increase the size of d_fileno
to 64-bits, increase the size of d_namlen to 16-bits, and change
the required alignment. Increase struct statfs f_mntfromname[] and
f_mntonname[] array length MNAMELEN to 1024.
ABI breakage is mitigated by providing compatibility using versioned
symbols, ingenious use of the existing padding in structures, and
by employing other tricks. Unfortunately, not everything can be
fixed, especially outside the base system. For instance, third-party
APIs which pass struct stat around are broken in backward and
forward incompatible ways.
Kinfo sysctl MIBs ABI is changed in backward-compatible way, but
there is no general mechanism to handle other sysctl MIBS which
return structures where the layout has changed. It was considered
that the breakage is either in the management interfaces, where we
usually allow ABI slip, or is not important.
Struct xvnode changed layout, no compat shims are provided.
For struct xtty, dev_t tty device member was reduced to uint32_t.
It was decided that keeping ABI compat in this case is more useful
than reporting 64-bit dev_t, for the sake of pstat.
Update note: strictly follow the instructions in UPDATING. Build
and install the new kernel with COMPAT_FREEBSD11 option enabled,
then reboot, and only then install new world.
Credits: The 64-bit inode project, also known as ino64, started life
many years ago as a project by Gleb Kurtsou (gleb). Kirk McKusick
(mckusick) then picked up and updated the patch, and acted as a
flag-waver. Feedback, suggestions, and discussions were carried
by Ed Maste (emaste), John Baldwin (jhb), Jilles Tjoelker (jilles),
and Rick Macklem (rmacklem). Kris Moore (kris) performed an initial
ports investigation followed by an exp-run by Antoine Brodin (antoine).
Essential and all-embracing testing was done by Peter Holm (pho).
The heavy lifting of coordinating all these efforts and bringing the
project to completion were done by Konstantin Belousov (kib).
Sponsored by: The FreeBSD Foundation (emaste, kib)
Differential revision: https://reviews.freebsd.org/D10439
2017-05-23 09:29:05 +00:00
|
|
|
.Dd February 13, 2017
|
1994-05-27 05:00:24 +00:00
|
|
|
.Dt STATFS 2
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm statfs
|
|
|
|
|
.Nd get file system statistics
|
2000-04-21 09:42:15 +00:00
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh SYNOPSIS
|
2001-10-01 16:09:29 +00:00
|
|
|
.In sys/param.h
|
|
|
|
|
.In sys/mount.h
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ft int
|
|
|
|
|
.Fn statfs "const char *path" "struct statfs *buf"
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn fstatfs "int fd" "struct statfs *buf"
|
|
|
|
|
.Sh DESCRIPTION
|
2002-12-18 09:22:32 +00:00
|
|
|
The
|
|
|
|
|
.Fn statfs
|
|
|
|
|
system call
|
1994-05-27 05:00:24 +00:00
|
|
|
returns information about a mounted file system.
|
2002-12-19 09:40:28 +00:00
|
|
|
The
|
|
|
|
|
.Fa path
|
|
|
|
|
argument
|
2002-12-12 17:26:04 +00:00
|
|
|
is the path name of any file within the mounted file system.
|
2002-12-19 09:40:28 +00:00
|
|
|
The
|
|
|
|
|
.Fa buf
|
|
|
|
|
argument
|
1994-05-27 05:00:24 +00:00
|
|
|
is a pointer to a
|
2002-12-19 09:40:28 +00:00
|
|
|
.Vt statfs
|
1994-05-27 05:00:24 +00:00
|
|
|
structure defined as follows:
|
|
|
|
|
.Bd -literal
|
1997-02-10 07:29:25 +00:00
|
|
|
typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */
|
1994-05-27 05:00:24 +00:00
|
|
|
|
1997-02-10 07:29:25 +00:00
|
|
|
/*
|
2003-11-16 04:08:16 +00:00
|
|
|
* filesystem statistics
|
1997-02-10 07:29:25 +00:00
|
|
|
*/
|
|
|
|
|
|
2003-11-16 04:08:16 +00:00
|
|
|
#define MFSNAMELEN 16 /* length of type name including null */
|
Commit the 64-bit inode project.
Extend the ino_t, dev_t, nlink_t types to 64-bit ints. Modify
struct dirent layout to add d_off, increase the size of d_fileno
to 64-bits, increase the size of d_namlen to 16-bits, and change
the required alignment. Increase struct statfs f_mntfromname[] and
f_mntonname[] array length MNAMELEN to 1024.
ABI breakage is mitigated by providing compatibility using versioned
symbols, ingenious use of the existing padding in structures, and
by employing other tricks. Unfortunately, not everything can be
fixed, especially outside the base system. For instance, third-party
APIs which pass struct stat around are broken in backward and
forward incompatible ways.
Kinfo sysctl MIBs ABI is changed in backward-compatible way, but
there is no general mechanism to handle other sysctl MIBS which
return structures where the layout has changed. It was considered
that the breakage is either in the management interfaces, where we
usually allow ABI slip, or is not important.
Struct xvnode changed layout, no compat shims are provided.
For struct xtty, dev_t tty device member was reduced to uint32_t.
It was decided that keeping ABI compat in this case is more useful
than reporting 64-bit dev_t, for the sake of pstat.
Update note: strictly follow the instructions in UPDATING. Build
and install the new kernel with COMPAT_FREEBSD11 option enabled,
then reboot, and only then install new world.
Credits: The 64-bit inode project, also known as ino64, started life
many years ago as a project by Gleb Kurtsou (gleb). Kirk McKusick
(mckusick) then picked up and updated the patch, and acted as a
flag-waver. Feedback, suggestions, and discussions were carried
by Ed Maste (emaste), John Baldwin (jhb), Jilles Tjoelker (jilles),
and Rick Macklem (rmacklem). Kris Moore (kris) performed an initial
ports investigation followed by an exp-run by Antoine Brodin (antoine).
Essential and all-embracing testing was done by Peter Holm (pho).
The heavy lifting of coordinating all these efforts and bringing the
project to completion were done by Konstantin Belousov (kib).
Sponsored by: The FreeBSD Foundation (emaste, kib)
Differential revision: https://reviews.freebsd.org/D10439
2017-05-23 09:29:05 +00:00
|
|
|
#define MNAMELEN 1024 /* size of on/from name bufs */
|
|
|
|
|
#define STATFS_VERSION 0x20140518 /* current version number */
|
1994-05-27 05:00:24 +00:00
|
|
|
|
|
|
|
|
struct statfs {
|
2003-11-16 04:08:16 +00:00
|
|
|
uint32_t f_version; /* structure version number */
|
|
|
|
|
uint32_t f_type; /* type of filesystem */
|
|
|
|
|
uint64_t f_flags; /* copy of mount exported flags */
|
|
|
|
|
uint64_t f_bsize; /* filesystem fragment size */
|
|
|
|
|
uint64_t f_iosize; /* optimal transfer block size */
|
|
|
|
|
uint64_t f_blocks; /* total data blocks in filesystem */
|
|
|
|
|
uint64_t f_bfree; /* free blocks in filesystem */
|
|
|
|
|
int64_t f_bavail; /* free blocks avail to non-superuser */
|
|
|
|
|
uint64_t f_files; /* total file nodes in filesystem */
|
|
|
|
|
int64_t f_ffree; /* free nodes avail to non-superuser */
|
|
|
|
|
uint64_t f_syncwrites; /* count of sync writes since mount */
|
|
|
|
|
uint64_t f_asyncwrites; /* count of async writes since mount */
|
|
|
|
|
uint64_t f_syncreads; /* count of sync reads since mount */
|
|
|
|
|
uint64_t f_asyncreads; /* count of async reads since mount */
|
|
|
|
|
uint64_t f_spare[10]; /* unused spare */
|
|
|
|
|
uint32_t f_namemax; /* maximum filename length */
|
|
|
|
|
uid_t f_owner; /* user that mounted the filesystem */
|
|
|
|
|
fsid_t f_fsid; /* filesystem id */
|
|
|
|
|
char f_charspare[80]; /* spare string space */
|
|
|
|
|
char f_fstypename[MFSNAMELEN]; /* filesystem type name */
|
|
|
|
|
char f_mntfromname[MNAMELEN]; /* mounted filesystem */
|
|
|
|
|
char f_mntonname[MNAMELEN]; /* directory on which mounted */
|
1994-05-27 05:00:24 +00:00
|
|
|
};
|
|
|
|
|
.Ed
|
2003-11-16 04:08:16 +00:00
|
|
|
.Pp
|
1997-03-11 11:35:56 +00:00
|
|
|
The flags that may be returned include:
|
2001-03-15 19:52:04 +00:00
|
|
|
.Bl -tag -width MNT_SYNCHRONOUS
|
1997-03-11 11:35:56 +00:00
|
|
|
.It Dv MNT_RDONLY
|
2002-12-12 17:26:04 +00:00
|
|
|
The file system is mounted read-only;
|
1997-03-11 11:35:56 +00:00
|
|
|
Even the super-user may not write on it.
|
|
|
|
|
.It Dv MNT_NOEXEC
|
2002-12-12 17:26:04 +00:00
|
|
|
Files may not be executed from the file system.
|
1997-03-11 11:35:56 +00:00
|
|
|
.It Dv MNT_NOSUID
|
|
|
|
|
Setuid and setgid bits on files are not honored when they are executed.
|
|
|
|
|
.It Dv MNT_SYNCHRONOUS
|
2002-12-12 17:26:04 +00:00
|
|
|
All I/O to the file system is done synchronously.
|
2001-03-15 19:52:04 +00:00
|
|
|
.It Dv MNT_ASYNC
|
2002-12-12 17:26:04 +00:00
|
|
|
No file system I/O is done synchronously.
|
2003-11-16 04:08:16 +00:00
|
|
|
.It Dv MNT_SOFTDEP
|
|
|
|
|
Soft updates being done (see
|
2004-06-30 20:09:10 +00:00
|
|
|
.Xr ffs 7 ) .
|
2006-11-01 23:40:44 +00:00
|
|
|
.It Dv MNT_GJOURNAL
|
|
|
|
|
Journaling with gjournal is enabled (see
|
|
|
|
|
.Xr gjournal 8 ) .
|
2003-11-16 04:08:16 +00:00
|
|
|
.It Dv MNT_SUIDDIR
|
|
|
|
|
Special handling of SUID bit on directories.
|
|
|
|
|
.It Dv MNT_UNION
|
2004-06-30 20:09:10 +00:00
|
|
|
Union with underlying file system.
|
2003-11-16 04:08:16 +00:00
|
|
|
.It Dv MNT_NOSYMFOLLOW
|
|
|
|
|
Symbolic links are not followed.
|
|
|
|
|
.It Dv MNT_NOCLUSTERR
|
|
|
|
|
Read clustering is disabled.
|
|
|
|
|
.It Dv MNT_NOCLUSTERW
|
|
|
|
|
Write clustering is disabled.
|
|
|
|
|
.\".It Dv MNT_JAILDEVFS
|
|
|
|
|
.\"XXX
|
|
|
|
|
.It Dv MNT_MULTILABEL
|
|
|
|
|
Mandatory Access Control (MAC) support for individual objects
|
|
|
|
|
(see
|
2004-06-30 20:09:10 +00:00
|
|
|
.Xr mac 4 ) .
|
2003-11-16 04:08:16 +00:00
|
|
|
.It Dv MNT_ACLS
|
|
|
|
|
Access Control List (ACL) support enabled.
|
1997-03-11 11:35:56 +00:00
|
|
|
.It Dv MNT_LOCAL
|
2002-12-12 17:26:04 +00:00
|
|
|
The file system resides locally.
|
1997-03-11 11:35:56 +00:00
|
|
|
.It Dv MNT_QUOTA
|
2002-12-12 17:26:04 +00:00
|
|
|
The file system has quotas enabled on it.
|
1997-03-11 11:35:56 +00:00
|
|
|
.It Dv MNT_ROOTFS
|
2002-12-12 17:26:04 +00:00
|
|
|
Identifies the root file system.
|
1997-03-11 11:35:56 +00:00
|
|
|
.It Dv MNT_EXRDONLY
|
2002-12-12 17:26:04 +00:00
|
|
|
The file system is exported read-only.
|
2003-11-16 04:08:16 +00:00
|
|
|
.It Dv MNT_NOATIME
|
|
|
|
|
Updating of file access times is disabled.
|
|
|
|
|
.It Dv MNT_USER
|
|
|
|
|
The file system has been mounted by a user.
|
|
|
|
|
.\".It Dv MNT_IGNORE
|
|
|
|
|
.\"XXX
|
1997-03-11 11:35:56 +00:00
|
|
|
.It Dv MNT_EXPORTED
|
2002-12-12 17:26:04 +00:00
|
|
|
The file system is exported for both reading and writing.
|
1997-03-11 11:35:56 +00:00
|
|
|
.It Dv MNT_DEFEXPORTED
|
2002-12-12 17:26:04 +00:00
|
|
|
The file system is exported for both reading and writing to any Internet host.
|
1997-03-11 11:35:56 +00:00
|
|
|
.It Dv MNT_EXPORTANON
|
2002-12-12 17:26:04 +00:00
|
|
|
The file system maps all remote accesses to the anonymous user.
|
1997-03-11 11:35:56 +00:00
|
|
|
.It Dv MNT_EXKERB
|
2002-12-12 17:26:04 +00:00
|
|
|
The file system is exported with Kerberos uid mapping.
|
2003-11-16 04:08:16 +00:00
|
|
|
.It Dv MNT_EXPUBLIC
|
|
|
|
|
The file system is exported publicly (WebNFS).
|
1997-03-11 11:35:56 +00:00
|
|
|
.El
|
1994-05-27 05:00:24 +00:00
|
|
|
.Pp
|
|
|
|
|
Fields that are undefined for a particular file system are set to -1.
|
2002-12-18 09:22:32 +00:00
|
|
|
The
|
|
|
|
|
.Fn fstatfs
|
|
|
|
|
system call
|
1994-05-27 05:00:24 +00:00
|
|
|
returns the same information about an open file referenced by descriptor
|
|
|
|
|
.Fa fd .
|
|
|
|
|
.Sh RETURN VALUES
|
2001-08-31 09:57:38 +00:00
|
|
|
.Rv -std
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh ERRORS
|
2002-12-18 09:22:32 +00:00
|
|
|
The
|
|
|
|
|
.Fn statfs
|
|
|
|
|
system call
|
1994-05-27 05:00:24 +00:00
|
|
|
fails if one or more of the following are true:
|
2000-05-04 13:09:25 +00:00
|
|
|
.Bl -tag -width Er
|
2004-07-20 19:30:57 +00:00
|
|
|
.It Bq Er ENOTDIR
|
|
|
|
|
A component of the path prefix of
|
|
|
|
|
.Fa path
|
|
|
|
|
is not a directory.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er ENAMETOOLONG
|
|
|
|
|
The length of a component of
|
|
|
|
|
.Fa path
|
|
|
|
|
exceeds 255 characters,
|
|
|
|
|
or the length of
|
|
|
|
|
.Fa path
|
|
|
|
|
exceeds 1023 characters.
|
|
|
|
|
.It Bq Er ENOENT
|
|
|
|
|
The file referred to by
|
|
|
|
|
.Fa path
|
|
|
|
|
does not exist.
|
|
|
|
|
.It Bq Er EACCES
|
|
|
|
|
Search permission is denied for a component of the path prefix of
|
|
|
|
|
.Fa path .
|
|
|
|
|
.It Bq Er ELOOP
|
|
|
|
|
Too many symbolic links were encountered in translating
|
|
|
|
|
.Fa path .
|
|
|
|
|
.It Bq Er EFAULT
|
2002-12-19 09:40:28 +00:00
|
|
|
The
|
|
|
|
|
.Fa buf
|
1994-05-27 05:00:24 +00:00
|
|
|
or
|
|
|
|
|
.Fa path
|
2002-12-19 09:40:28 +00:00
|
|
|
argument
|
1994-05-27 05:00:24 +00:00
|
|
|
points to an invalid address.
|
|
|
|
|
.It Bq Er EIO
|
|
|
|
|
An
|
|
|
|
|
.Tn I/O
|
|
|
|
|
error occurred while reading from or writing to the file system.
|
|
|
|
|
.El
|
|
|
|
|
.Pp
|
2002-12-18 09:22:32 +00:00
|
|
|
The
|
|
|
|
|
.Fn fstatfs
|
|
|
|
|
system call
|
1994-05-27 05:00:24 +00:00
|
|
|
fails if one or more of the following are true:
|
2000-11-22 16:02:00 +00:00
|
|
|
.Bl -tag -width Er
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er EBADF
|
2002-12-19 09:40:28 +00:00
|
|
|
The
|
2000-12-29 14:08:20 +00:00
|
|
|
.Fa fd
|
2002-12-19 09:40:28 +00:00
|
|
|
argument
|
1994-05-27 05:00:24 +00:00
|
|
|
is not a valid open file descriptor.
|
|
|
|
|
.It Bq Er EFAULT
|
2002-12-19 09:40:28 +00:00
|
|
|
The
|
|
|
|
|
.Fa buf
|
|
|
|
|
argument
|
1994-05-27 05:00:24 +00:00
|
|
|
points to an invalid address.
|
|
|
|
|
.It Bq Er EIO
|
|
|
|
|
An
|
|
|
|
|
.Tn I/O
|
|
|
|
|
error occurred while reading from or writing to the file system.
|
|
|
|
|
.El
|
2006-01-10 23:24:47 +00:00
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr fhstatfs 2
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
1996-08-22 23:31:07 +00:00
|
|
|
.Fn statfs
|
2002-12-18 09:22:32 +00:00
|
|
|
system call first appeared in
|
1996-08-22 23:31:07 +00:00
|
|
|
.Bx 4.4 .
|
