1 '\" te
   2 .\"  Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH CACHEFSSTAT 1M "Oct 9, 2003"
   7 .SH NAME
   8 cachefsstat \- Cache File System statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/bin/cachefsstat\fR [\fB-z\fR] [\fIpath\fR]...
  13 .fi
  14 
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBcachefsstat\fR command displays statistical information about the cache
  19 file system mounted on \fIpath\fR. The statistical information includes cache
  20 hits and misses, consistency checking, and modification operations. If
  21 \fIpath\fR is not specified, all mounted cache file systems are used.
  22 .sp
  23 .LP
  24 \fBcachefsstat\fR can also be used to reinitialize this information (see
  25 \fB-z\fR option).
  26 .sp
  27 .LP
  28 The statistical information has the following format:
  29 .sp
  30 .in +2
  31 .nf
  32 <\fIcache hit rate\fR>
  33 <\fIconsistency checks\fR>
  34 <\fImodifies\fR>
  35 .fi
  36 .in -2
  37 .sp
  38 
  39 .sp
  40 .LP
  41 where:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIhit rate\fR\fR
  46 .ad
  47 .RS 22n
  48 The percentage of cache hits over the total number of attempts, followed by the
  49 actual numbers of hits and misses.
  50 .RE
  51 
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIconsistency checks\fR\fR
  56 .ad
  57 .RS 22n
  58 The number of consistency checks performed, followed by the number that passed,
  59 and the number that failed.
  60 .RE
  61 
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fImodifies\fR\fR
  66 .ad
  67 .RS 22n
  68 The number of modify operations, including writes, creates, etc.
  69 .RE
  70 
  71 .SH OPTIONS
  72 .sp
  73 .LP
  74 The following option is supported:
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fB-z\fR\fR
  79 .ad
  80 .RS 6n
  81 Zero (reinitialize) statistics. Execute \fBcachefsstat\fR \fB-z\fR before
  82 executing \fBcachefsstat\fR again to gather statistics on the cache
  83 performance. This option can only be use by the superuser. The statistics
  84 printed reflect those just before the statistics are reinitialized.
  85 .RE
  86 
  87 .SH USAGE
  88 .sp
  89 .LP
  90 See \fBlargefile\fR(5) for the description of the behavior of \fBcachefsstat\fR
  91 when encountering files greater than or equal to 2 Gbyte (2^31 bytes).
  92 .SH EXAMPLES
  93 .LP
  94 \fBExample 1 \fRUsing \fBcachefsstat\fR
  95 .sp
  96 .LP
  97 The following example shows the \fBcachefsstat\fR command run on file system
  98 \fB/test\fR:
  99 
 100 .sp
 101 .in +2
 102 .nf
 103 example# cachefsstat /test
 104   /test
 105        cache hit rate:      100% (0 hits, 0 misses)
 106        consistency checks:    0  (0 pass, 0 fail)
 107        modifies:              0
 108 garbage collection:           0
 109 .fi
 110 .in -2
 111 .sp
 112 
 113 .SH EXIT STATUS
 114 .sp
 115 .LP
 116 The following exit values are returned:
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fB0\fR\fR
 121 .ad
 122 .RS 12n
 123 Successful completion.
 124 .RE
 125 
 126 .sp
 127 .ne 2
 128 .na
 129 \fBnon-zero\fR
 130 .ad
 131 .RS 12n
 132 An error occurred.
 133 .RE
 134 
 135 .SH SEE ALSO
 136 .sp
 137 .LP
 138 \fBcachefslog\fR(1M), \fBcachefswssize\fR(1M), \fBcfsadmin\fR(1M),
 139 \fBattributes\fR(5), \fBlargefile\fR(5)