share/man/man9/VFS_STATFS.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 1996 Doug Rabson
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\" This program is free software.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd May 23, 2009
  32 .Dt VFS_STATFS 9
  33 .Os
  34 .Sh NAME
  35 .Nm VFS_STATFS
  36 .Nd return file system status
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/mount.h
  40 .In sys/vnode.h
  41 .Ft int
  42 .Fn VFS_STATFS "struct mount *mp" "struct statfs *sbp"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn VFS_STATFS
  46 macro returns various pieces of information about the file system,
  47 including recommended I/O sizes, free space, free inodes, etc.
  48 .Pp
  49 The arguments it expects are:
  50 .Bl -tag -width sbp
  51 .It Fa mp
  52 The file system.
  53 .It Fa sbp
  54 A
  55 .Vt statfs
  56 structure, as defined by
  57 .In sys/mount.h ,
  58 into which information is placed about the file system.
  59 .El
  60 .Pp
  61 The fields of
  62 .Vt "struct statfs"
  63 related to the file system are as follows:
  64 .Bl -tag -width ".Va f_mntfromname"
  65 .It Va f_type
  66 Type of file system.
  67 .It Va f_flags
  68 A copy of mount exported flags.
  69 .It Va f_bsize
  70 Fragment size.
  71 .It Va f_iosize
  72 Optimal transfer block size.
  73 .It Va f_blocks
  74 The total number of data blocks in the file system.
  75 .It Va f_bfree
  76 The number of free blocks in the file system.
  77 .It Va f_bavail
  78 The number of free blocks available to non-superuser processes.
  79 .It Va f_files
  80 The total number of file nodes in the file system.
  81 .It Va f_ffree
  82 The number of free nodes available to non-superuser processes.
  83 .It Va f_syncwrites
  84 The number of synchronous writes since the file system was mounted.
  85 .It Va f_asyncwrites
  86 The number of asynchronous writes since the file system was mounted.
  87 .It Va f_syncreads
  88 The number of synchronous reads since the file system was mounted.
  89 .It Va f_asyncreads
  90 The number of asynchronous reads since the file system was mounted.
  91 .It Va f_namemax
  92 The maximum file name length for this file system.
  93 .It Va f_owner
  94 The user ID of the user that mounted the file system.
  95 .It Va f_fsid
  96 Unique file system ID.
  97 .It Va f_fstypename
  98 The file system type name; a string of at most
  99 .Dv MFSNAMELEN
 100 bytes.
 101 .It Va f_mntfromname
 102 The device name the file system was mounted from; a string of at most
 103 .Dv MNAMELEN
 104 bytes.
 105 .It Va f_mntonname
 106 The name of the directory on which the file system is mounted;
 107 a string of at most
 108 .Dv MNAMELEN
 109 bytes.
 110 .El
 111 .Sh SEE ALSO
 112 .Xr VFS 9 ,
 113 .Xr vnode 9
 114 .Sh AUTHORS
 115 This manual page was written by
 116 .An Doug Rabson .