Add documentation for the statvfs, fstatvfs and fhstatvfs system calls.
authorSascha Wildner <swildner@dragonflybsd.org>
Sun, 28 Sep 2008 16:33:35 +0000 (16:33 +0000)
committerSascha Wildner <swildner@dragonflybsd.org>
Sun, 28 Sep 2008 16:33:35 +0000 (16:33 +0000)
Adapted-from: OpenBSD and NetBSD

lib/libc/sys/Makefile.inc
lib/libc/sys/fhopen.2
lib/libc/sys/stat.2
lib/libc/sys/statfs.2
lib/libc/sys/statvfs.2 [new file with mode: 0644]

index 0360307..19ee1b2 100644 (file)
@@ -1,6 +1,6 @@
 #      @(#)Makefile.inc        8.3 (Berkeley) 10/24/94
 # $FreeBSD: src/lib/libc/sys/Makefile.inc,v 1.75.2.7 2003/04/22 17:31:18 trhodes Exp $
-# $DragonFly: src/lib/libc/sys/Makefile.inc,v 1.35 2008/08/09 18:33:39 swildner Exp $
+# $DragonFly: src/lib/libc/sys/Makefile.inc,v 1.36 2008/09/28 16:33:35 swildner Exp $
 
 # sys sources
 .PATH: ${.CURDIR}/../libc/${MACHINE_ARCH}/sys ${.CURDIR}/../libc/sys
@@ -88,7 +88,7 @@ MAN+= _exit.2 accept.2 access.2 acct.2 adjtime.2 \
        setuid.2 shmat.2 shmctl.2 shmget.2 shutdown.2 \
        sigaction.2 sigaltstack.2 sigpending.2 sigprocmask.2 sigreturn.2 \
        sigstack.2 sigsuspend.2 socket.2 socketpair.2 stat.2 statfs.2 \
-       swapon.2 symlink.2 sync.2 sysarch.2 syscall.2 syslink.2 \
+       statvfs.2 swapon.2 symlink.2 sync.2 sysarch.2 syscall.2 syslink.2 \
        truncate.2 tls.2 umask.2 umtx.2 undelete.2 \
        unlink.2 utimes.2 upc_register.2 usched_set.2 uuidgen.2 \
        varsym.2 vfork.2 wait.2 write.2
@@ -106,7 +106,7 @@ MLINKS+=chmod.2 fchmod.2 chmod.2 lchmod.2
 MLINKS+=chown.2 fchown.2 chown.2 lchown.2
 MLINKS+=clock_gettime.2 clock_getres.2 clock_gettime.2 clock_settime.2
 MLINKS+=dup.2 dup2.2
-MLINKS+=fhopen.2 fhstat.2 fhopen.2 fhstatfs.2
+MLINKS+=fhopen.2 fhstat.2 fhopen.2 fhstatfs.2 fhopen.2 fhstatvfs.2
 MLINKS+=getdirentries.2 _DIRENT_DIRSIZ.2 \
        getdirentries.2 _DIRENT_NEXT.2 \
        getdirentries.2 getdents.2
@@ -151,6 +151,7 @@ MLINKS+=setuid.2 setegid.2 setuid.2 seteuid.2 setuid.2 setgid.2
 MLINKS+=shmat.2 shmdt.2
 MLINKS+=stat.2 fstat.2 stat.2 lstat.2
 MLINKS+=statfs.2 fstatfs.2
+MLINKS+=statvfs.2 fstatvfs.2
 MLINKS+=syscall.2 __syscall.2
 MLINKS+=tls.2 set_tls_area.2 tls.2 get_tls_area.2
 MLINKS+=truncate.2 ftruncate.2
index a43b350..4454be8 100644 (file)
@@ -1,6 +1,6 @@
 .\"    $NetBSD: fhopen.2,v 1.1 1999/06/30 01:32:15 wrstuden Exp $
 .\"    $FreeBSD: src/lib/libc/sys/fhopen.2,v 1.4.2.7 2002/12/29 16:35:34 schweikh Exp $
-.\"    $DragonFly: src/lib/libc/sys/fhopen.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
+.\"    $DragonFly: src/lib/libc/sys/fhopen.2,v 1.3 2008/09/28 16:33:35 swildner Exp $
 .\"
 .\" Copyright (c) 1999 National Aeronautics & Space Administration
 .\" All rights reserved.
 .\" 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.
-.\"/
-.Dd June 29, 1999
+.\"
+.Dd September 28, 2008
 .Dt FHOPEN 2
 .Os
 .Sh NAME
 .Nm fhopen ,
 .Nm fhstat ,
-.Nm fhstatfs
+.Nm fhstatfs ,
+.Nm fhstatvfs
 .Nd access file via file handle
 .Sh LIBRARY
 .Lb libc
 .In sys/param.h
 .In sys/mount.h
 .In sys/stat.h
+.In sys/statvfs.h
 .Ft int
 .Fn fhopen "const fhandle_t *fhp" "int flags"
 .Ft int
 .Fn fhstat "const fhandle_t *fhp" "struct stat *sb"
 .Ft int
 .Fn fhstatfs "const fhandle_t *fhp" "struct statfs *buf"
+.Ft int
+.Fn fhstatvfs "const fhandle_t *fhp" "struct statvfs *buf"
 .Sh DESCRIPTION
 These functions provide a means to access a file given the file handle
 .Fa fhp .
@@ -75,13 +79,15 @@ call.
 All said flags are valid except for
 .Dv O_CREAT .
 .Pp
-.Fn fhstat
+.Fn fhstat ,
+.Fn fhstatfs ,
 and
-.Fn fhstatfs
+.Fn fhstatvfs
 provide the functionality of the
-.Xr fstat 2
+.Xr fstat 2 ,
+.Xr fstatfs 2 ,
 and
-.Xr fstatfs 2
+.Xr fstatvfs 2 ,
 calls except that they return information for the file referred to by
 .Fa fhp
 rather than an open file.
@@ -93,18 +99,20 @@ otherwise the value \-1 is returned and the global variable
 .Va errno
 is set to indicate the error.
 .Pp
-.Rv -std fhstat fhstatfs
+.Rv -std fhstat fhstatfs fhstatvfs
 .Sh ERRORS
 In addition to the errors returned by
 .Xr open 2 ,
 .Xr fstat 2 ,
+.Xr fstatfs 2 ,
 and
-.Xr fstatfs 2
+.Xr fstatvfs 2
 respectively,
 .Fn fhopen ,
 .Fn fhstat ,
+.Fn fhstatfs ,
 and
-.Fn fhstatfs
+.Fn fhstatvfs
 will return
 .Bl -tag -width Er
 .It Bq Er EINVAL
@@ -121,6 +129,7 @@ is no longer valid.
 .Sh SEE ALSO
 .Xr fstat 2 ,
 .Xr fstatfs 2 ,
+.Xr fstatvfs 2 ,
 .Xr getfh 2 ,
 .Xr open 2
 .Sh HISTORY
@@ -130,10 +139,11 @@ The
 and
 .Fn fhstatfs
 functions first appeared in
-.Nx 1.5
-and was adapted to
-.Fx 4.0
-by Alfred Perlstein.
+.Dx 1.1 .
+The
+.Fn fhstatvfs
+function first appeared in
+.Dx 1.13 .
 .Sh AUTHORS
 This man page was written by
 .An William Studenmund
index 0ef13dd..8816375 100644 (file)
@@ -31,9 +31,9 @@
 .\"
 .\"     @(#)stat.2     8.4 (Berkeley) 5/1/95
 .\" $FreeBSD: src/lib/libc/sys/stat.2,v 1.16.2.7 2001/12/14 18:34:01 ru Exp $
-.\" $DragonFly: src/lib/libc/sys/stat.2,v 1.5 2008/05/01 23:36:43 swildner Exp $
+.\" $DragonFly: src/lib/libc/sys/stat.2,v 1.6 2008/09/28 16:33:35 swildner Exp $
 .\"
-.Dd May 1, 1995
+.Dd September 28, 2008
 .Dt STAT 2
 .Os
 .Sh NAME
@@ -255,6 +255,8 @@ An I/O error occurred while reading from or writing to the file system.
 .Xr access 2 ,
 .Xr chmod 2 ,
 .Xr chown 2 ,
+.Xr statfs 2 ,
+.Xr statvfs 2 ,
 .Xr utimes 2 ,
 .Xr symlink 7
 .Sh STANDARDS
index 4032c4e..fc03a9f 100644 (file)
@@ -31,9 +31,9 @@
 .\"
 .\"    @(#)statfs.2    8.5 (Berkeley) 5/24/95
 .\" $FreeBSD: src/lib/libc/sys/statfs.2,v 1.9.2.7 2001/12/14 18:34:01 ru Exp $
-.\" $DragonFly: src/lib/libc/sys/statfs.2,v 1.3 2007/02/25 18:35:05 swildner Exp $
+.\" $DragonFly: src/lib/libc/sys/statfs.2,v 1.4 2008/09/28 16:33:35 swildner Exp $
 .\"
-.Dd May 24, 1995
+.Dd September 28, 2008
 .Dt STATFS 2
 .Os
 .Sh NAME
@@ -178,6 +178,9 @@ An
 .Tn I/O
 error occurred while reading from or writing to the file system.
 .El
+.Sh SEE ALSO
+.Xr stat 2 ,
+.Xr statvfs 2
 .Sh HISTORY
 The
 .Fn statfs
diff --git a/lib/libc/sys/statvfs.2 b/lib/libc/sys/statvfs.2
new file mode 100644 (file)
index 0000000..2727388
--- /dev/null
@@ -0,0 +1,179 @@
+.\"    $OpenBSD: statvfs.3,v 1.5 2008/03/26 09:37:59 jmc Exp $
+.\"    $NetBSD: statfs.2,v 1.10 1995/06/29 11:40:48 cgd Exp $
+.\"    $DragonFly: src/lib/libc/sys/statvfs.2,v 1.1 2008/09/28 16:33:35 swildner Exp $
+.\"
+.\" 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.
+.\" 3. 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
+.\" SUCH DAMAGE.
+.\"
+.\"    @(#)statfs.2    8.3 (Berkeley) 2/11/94
+.\"
+.Dd September 28, 2008
+.Dt STATVFS 2
+.Os
+.Sh NAME
+.Nm statvfs ,
+.Nm fstatvfs
+.Nd get file system statistics
+.Sh SYNOPSIS
+.Fd #include <sys/statvfs.h>
+.Ft int
+.Fn statvfs "const char *path" "struct statvfs *buf"
+.Ft int
+.Fn fstatvfs "int fd" "struct statvfs *buf"
+.Sh DESCRIPTION
+.Fn statvfs
+returns information about a mounted file system.
+.Fa path
+is the path name of any file within the mounted file system.
+.Fa buf
+is a pointer to a
+.Nm statvfs
+structure defined as follows:
+.Bd -literal
+struct statvfs {
+        unsigned long f_bsize;       /* file system block size */
+        unsigned long f_frsize;      /* fundamental file system block size */
+        fsblkcnt_t    f_blocks;      /* number of blocks (unit f_frsize) */
+        fsblkcnt_t    f_bfree;       /* free blocks in file system */
+        fsblkcnt_t    f_bavail;      /* free blocks for non-root */
+        fsfilcnt_t    f_files;       /* total file inodes */
+        fsfilcnt_t    f_ffree;       /* free file inodes */
+        fsfilcnt_t    f_favail;      /* free file inodes for to non-root */
+        unsigned long f_fsid;        /* file system id */
+        unsigned long f_flag;        /* bit mask of f_flag values */
+        unsigned long f_namemax;     /* maximum filename length */
+        uid_t         f_owner;       /* user that mounted the filesystem */
+        unsigned int  f_type;        /* filesystem type */
+
+        uint64_t      f_syncreads;   /* count of sync reads since mount */
+        uint64_t      f_syncwrites;  /* count of sync writes since mount */
+
+        uint64_t      f_asyncreads;  /* count of async reads since mount */
+        uint64_t      f_asyncwrites; /* count of async writes since mount */
+
+        /*
+         * DragonFly extensions - full uuid FSID and owner
+         */
+        uuid_t        f_fsid_uuid;
+        uuid_t        f_uid_uuid;
+};
+
+/*
+ * f_flag definitions
+ */
+#define ST_RDONLY     0x00000001     /* fs is read-only */
+#define ST_NOSUID     0x00000002     /* ST_ISUID or ST_ISGID not supported */
+
+/*
+ * DragonFly specific flags
+ */
+#define ST_FSID_UUID  0x40000000     /* f_fsid_uuid field is valid */
+#define ST_OWNER_UUID 0x80000000     /* f_owner_uuid field is valid */
+.Ed
+.Pp
+The fields of type
+.Va fsblkcnt_t
+are reported in units of
+.Va f_frsize .
+.Pp
+.Fn fstatvfs
+returns the same information about an open file referenced by descriptor
+.Fa fd .
+.Sh RETURN VALUES
+.Rv -std statvfs fstatvfs
+.Sh ERRORS
+.Fn statvfs
+fails if one or more of the following are true:
+.Bl -tag -width Er
+.It Bq Er ENOTDIR
+A component of the path prefix of
+.Fa path
+is not a directory.
+.It Bq Er ENAMETOOLONG
+The length of a component of
+.Fa path
+exceeds
+.Dv {NAME_MAX}
+characters, or the length of
+.Fa path
+exceeds
+.Dv {PATH_MAX}
+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
+.Fa buf
+or
+.Fa path
+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
+.Fn fstatvfs
+fails if one or more of the following are true:
+.Bl -tag -width Er
+.It Bq Er EBADF
+.Fa fd
+is not a valid open file descriptor.
+.It Bq Er EFAULT
+.Fa buf
+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
+.Sh SEE ALSO
+.Xr df 1 ,
+.Xr mount 2 ,
+.Xr stat 2 ,
+.Xr statfs 2
+.Sh STANDARDS
+The
+.Fn statvfs
+and
+.Fn fstatvfs
+system calls conform to
+.St -p1003.1-2001 .
+.Sh HISTORY
+The
+.Fn statvfs
+and
+.Fn fstatvfs
+functions first appeared in
+.Dx 1.13 .