projects / unix-history / blobdiff
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
BSD 4_4_Lite1 release
[unix-history] / usr / src / lib / libc / sys / statfs.2
diff --git a/usr/src/lib/libc/sys/statfs.2 b/usr/src/lib/libc/sys/statfs.2
index a483d82..a7a1da2 100644 (file)
--- a/usr/src/lib/libc/sys/statfs.2
+++ b/usr/src/lib/libc/sys/statfs.2
@@ -1,145 +1,161 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1989, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.
 .\"
 .\"
-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.
+.\" 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.
 .\"
 .\"
-.\"    @(#)statfs.2    6.3 (Berkeley) 6/23/90
+.\" 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.
 .\"
 .\"
-.TH STATFS 2 "June 23, 1990"
-.UC 7
-.SH NAME
-statfs \- get file system statistics
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/types.h>
-#include <sys/mount.h>
-.LP
-.ft B
-statfs(path, buf)
-char *path;
-struct statfs *buf;
-.LP
-.ft B
-fstatfs(fd, buf)
-int fd;
-struct statfs *buf;
-.fi
-.ft R
-.SH DESCRIPTION
-.I Statfs
+.\"    @(#)statfs.2    8.3 (Berkeley) 2/11/94
+.\"
+.Dd February 11, 1994
+.Dt STATFS 2
+.Os
+.Sh NAME
+.Nm statfs
+.Nd get file system statistics
+.Sh SYNOPSIS
+.Fd #include <sys/param.h>
+.Fd #include <sys/mount.h>
+.Ft int
+.Fn statfs "const char *path" "struct statfs *buf"
+.Ft int
+.Fn fstatfs "int fd" "struct statfs *buf"
+.Sh DESCRIPTION
+.Fn Statfs
 returns information about a mounted file system.
 returns information about a mounted file system.
-.I path
+.Fa Path
 is the path name of any file within the mounted filesystem.
 is the path name of any file within the mounted filesystem.
-.I Buf
+.Fa Buf
 is a pointer to a
 is a pointer to a
-.I statfs
+.Fn statfs
 structure defined as follows:
 structure defined as follows:
-.IP
-.ta \w'#define\0\0'u +\w'fsid_t\0\0'u +\w'f_mntfromname[MNAMELEN]\0\0'u
-.nf
+.Bd -literal
 typedef quad fsid_t;
 typedef quad fsid_t;
-.sp 1
-#define MNAMELEN 32    /* length of buffer for returned name */
-.sp 1
+
+#define MNAMELEN 90    /* length of buffer for returned name */
+
 struct statfs {
 struct statfs {
-       short   f_type; /* type of filesystem (see below) */
-       short   f_flags;        /* copy of mount flags */
-       long    f_fsize;        /* fundamental file system block size */
-       long    f_bsize;        /* 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];  /* directory on which mounted */
-       char    f_mntfromname[MNAMELEN];        /* mounted filesystem */
+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[9];       /* spare for later */
+char   f_mntonname[MNAMELEN];    /* mount point */
+char   f_mntfromname[MNAMELEN];  /* mounted filesystem */
 };
 /*
 };
 /*
- * File system types.
- */
-#define        MOUNT_UFS       1
-#define        MOUNT_NFS       2
-#define        MOUNT_MFS       3
-#define        MOUNT_PC        4
-.fi
-.PP
-Fields that are undefined for a particular file system are set to \-1.
-.I Fstatfs
+* File system types.
+*/
+#define        MOUNT_UFS       1       /* Fast Filesystem */
+#define        MOUNT_NFS       2       /* Sun-compatible Network Filesystem */
+#define        MOUNT_MFS       3       /* Memory-based Filesystem */
+#define        MOUNT_MSDOS     4       /* MS/DOS Filesystem */
+#define        MOUNT_LFS       5       /* Log-based Filesystem */
+#define        MOUNT_LOFS      6       /* Loopback Filesystem */
+#define        MOUNT_FDESC     7       /* File Descriptor Filesystem */
+#define        MOUNT_PORTAL    8       /* Portal Filesystem */
+#define MOUNT_NULL     9       /* Minimal Filesystem Layer */
+#define MOUNT_UMAP     10      /* Uid/Gid Remapping Filesystem */
+#define MOUNT_KERNFS   11      /* Kernel Information Filesystem */
+#define MOUNT_PROCFS   12      /* /proc Filesystem */
+#define MOUNT_AFS      13      /* Andrew Filesystem */
+#define MOUNT_CD9660   14      /* ISO9660 (aka CDROM) Filesystem */
+#define MOUNT_UNION    15      /* Union (translucent) Filesystem */
+.Ed
+.Pp
+Fields that are undefined for a particular file system are set to -1.
+.Fn Fstatfs
 returns the same information about an open file referenced by descriptor
 returns the same information about an open file referenced by descriptor
-.IR fd .
-.SH RETURN VALUE
+.Fa fd .
+.Sh RETURN VALUES
 Upon successful completion, a value of 0 is returned.
 Upon successful completion, a value of 0 is returned.
-Otherwise, \-1 is returned and the global variable
-.I errno
+Otherwise, -1 is returned and the global variable
+.Va errno
 is set to indicate the error.
 is set to indicate the error.
-.SH ERRORS
-.I Statfs
+.Sh ERRORS
+.Fn Statfs
 fails if one or more of the following are true:
 fails if one or more of the following are true:
-.TP 15
-ENOTDIR
+.Bl -tag -width ENAMETOOLONGA
+.It Bq Er ENOTDIR
 A component of the path prefix of
 A component of the path prefix of
-.I path
+.Fa Path
 is not a directory.
 is not a directory.
-.TP 15
-EINVAL
-.I path
+.It Bq Er EINVAL
+.Fa path
 contains a character with the high-order bit set.
 contains a character with the high-order bit set.
-.TP 15
-ENAMETOOLONG
+.It Bq Er ENAMETOOLONG
 The length of a component of
 The length of a component of
-.I path
+.Fa path
 exceeds 255 characters,
 or the length of
 exceeds 255 characters,
 or the length of
-.I path
+.Fa path
 exceeds 1023 characters.
 exceeds 1023 characters.
-.TP 15
-ENOENT
+.It Bq Er ENOENT
 The file referred to by
 The file referred to by
-.I path
+.Fa path
 does not exist.
 does not exist.
-.TP 15
-EACCES
+.It Bq Er EACCES
 Search permission is denied for a component of the path prefix of
 Search permission is denied for a component of the path prefix of
-.IR path .
-.TP 15
-ELOOP
+.Fa path .
+.It Bq Er ELOOP
 Too many symbolic links were encountered in translating
 Too many symbolic links were encountered in translating
-.IR path .
-.TP 15
-EFAULT
-.I Buf
+.Fa path .
+.It Bq Er EFAULT
+.Fa Buf
 or
 or
-.I path
+.Fa path
 points to an invalid address.
 points to an invalid address.
-.TP 15
-EIO
-An I/O error occurred while reading from or writing to the file system.
-.PP
-.I Fstatfs
-fails if one or both of the following are true:
-.TP 15
-EBADF
-.I fd
+.It Bq Er EIO
+An
+.Tn I/O
+error occurred while reading from or writing to the file system.
+.El
+.Pp
+.Fn Fstatfs
+fails if one or more of the following are true:
+.Bl -tag -width ENAMETOOLONGA
+.It Bq Er EBADF
+.Fa Fd
 is not a valid open file descriptor.
 is not a valid open file descriptor.
-.TP 15
-EFAULT
-.I buf
+.It Bq Er EFAULT
+.Fa Buf
 points to an invalid address.
 points to an invalid address.
-.TP 15
-EIO
-An I/O error occurred while reading from or writing to the file system.
+.It Bq Er EIO
+An
+.Tn I/O
+error occurred while reading from or writing to the file system.
+.El
+.Sh HISTORY
+The
+.Nm statfs
+function first appeared in 4.4BSD.
Continuous source code history from original PDP-7 UNIX to FreeBSD 2, the first fully unencumbered FreeBSD release.