man/man1/zpios.1

   1 '\" t
   2 .\"
   3 .\" CDDL HEADER START
   4 .\"
   5 .\" The contents of this file are subject to the terms of the
   6 .\" Common Development and Distribution License (the "License").
   7 .\" You may not use this file except in compliance with the License.
   8 .\"
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10 .\" or http://www.opensolaris.org/os/licensing.
  11 .\" See the License for the specific language governing permissions
  12 .\" and limitations under the License.
  13 .\"
  14 .\" When distributing Covered Code, include this CDDL HEADER in each
  15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16 .\" If applicable, add the following below this CDDL HEADER, with the
  17 .\" fields enclosed by brackets "[]" replaced with your own identifying
  18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  19 .\"
  20 .\" CDDL HEADER END
  21 .\"
  22 .\"
  23 .\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
  24 .\"
  25 .TH zpios 1 "2013 FEB 28" "ZFS on Linux" "User Commands"
  26
  27 .SH NAME
  28 zpios \- Directly test the DMU.
  29 .SH SYNOPSIS
  30 .LP
  31 .BI "zpios [options] <\-p " pool ">"
  32
  33 .SH DESCRIPTION
  34 This utility runs in-kernel DMU performance and stress tests that do
  35 not depend on the ZFS Posix Layer ("ZPL").
  36
  37 .SH OPTIONS
  38 .HP
  39 .BI "\-s" " regex" ", \-\-threadcount" " regex"
  40 .IP
  41 Start this many threads for each test series, specified as a comma
  42 delimited regular expression. (eg: "-s 1,2,3")
  43 .IP
  44 This option is mutually exclusive with the \fBthreadcount_*\fR
  45 options.
  46 .HP
  47 .BI "\-l" " regex_low" ", \-\-threadcount_low" " regex_low"
  48 .HP
  49 .BI "\-h" " regex_high" ", \-\-threadcount_high" " regex_high"
  50 .HP
  51 .BI "\-e" " regex_incr" ", \-\-threadcount_incr" " regex_incr"
  52 .IP
  53 Start \fIregex_low\fR threads for the first test,
  54 add \fIregex_incr\fR threads for each subsequent test,
  55 and start \fIregex_high\fR threads for the last test.
  56 .IP
  57 These three options must be specified together and are mutually
  58 exclusive with the \fBthreadcount\fR option.
  59 .HP
  60 .BI "\-n" " regex" ", \-\-regioncount" " regex"
  61 .IP
  62 Create this many regions for each test series, specified as a comma
  63 delimited regular expression. (eg: "-n 512,4096,65536")
  64 .IP
  65 This option is mutually exclusive with the \fBregioncount_*\fR
  66 options.
  67 .HP
  68 .BI "\-i" " regex_low" ", \-\-regioncount_low" " regex_low"
  69 .HP
  70 .BI "\-j" " regex_high" ", \-\-regioncount_high" " regex_high"
  71 .HP
  72 .BI "\-k" " regex_incr" ", \-\-regioncount_incr" " regex_incr"
  73 .IP
  74 Create \fIregex_low\fR regions for the first test,
  75 add \fIregex_incr\fR regions for each subsequent test, and
  76 create \fIregex_high\fR regions for the last test.
  77 .IP
  78 These three options must be specified together and are mutually
  79 exclusive with the \fBregioncount\fR option.
  80 .HP
  81 .BI "\-o" " size" ", \-\-offset" " size"
  82 .IP
  83 Create regions at \fIsize\fR offset for each test series, specified as
  84 a comma delimited regular expression with an optional unit suffix.
  85 (eg: "-o 4M" means four megabytes.)
  86 .IP
  87 This option is mutually exclusive with the \fBoffset_*\fR options.
  88 .HP
  89 .BI "\-m" " size_low" ", \-\-offset_low" " size_low"
  90 .HP
  91 .BI "\-q" " size_high" ", \-\-offset_high" " size_high"
  92 .HP
  93 .BI "\-r" " size_incr" ", \-\-offset_incr" " size_incr"
  94 .IP
  95 Create a region at \fIsize_low\fR offset for the first test, add
  96 \fIsize_incr\fR to the offset for each subsequent test, and create
  97 a region at \fIsize_high\fR offset for the last test.
  98 .IP
  99 These three options must be specified together and are mutually
 100 exclusive with the \fBoffset\fR option.
 101 .HP
 102 .BI "\-c" " size" ", \-\-chunksize" " size"
 103 .IP
 104 Use \fIsize\fR chunks for each test, specified as a comma delimited
 105 regular expression with an optional unit suffix. (eg: "-c 1M" means
 106 one megabyte.) The chunk size must be at least the region size.
 107 .IP
 108 This option is mutually exclusive with the \fBchunksize_*\fB options.
 109 .HP
 110 .BI "\-a" " size_low" ", \-\-chunksize_low" " size_low"
 111 .HP
 112 .BI "\-b" " size_high" ", \-\-chunksize_high" " size_high"
 113 .HP
 114 .BI "\-g" " size_incr" ", \-\-chunksize_incr" " size_incr"
 115 .IP
 116 Use a \fIsize_low\fR chunk size for the first test, add \fIsize_incr\fR
 117 to the chunk size for each subsequent test, and use a \fIsize_high\fR
 118 chunk size for the last test.
 119 .IP
 120 These three options must be specified together and are mutually
 121 exclusive with the \fBchunksize\fR option.
 122 .HP
 123 .BI "\-L" " dmu_flags" ", \-\-load" " dmu_flags"
 124 .IP
 125 Specify \fIdmuio\fR for regular DMU_IO, \fIssf\fR for single shared
 126 file access, or \fIfpp\fR for per thread access. Use commas to delimit
 127 multiple flags. (eg: "-L dmuio,ssf")
 128 .HP
 129 .BI "\-p" " name" ", \-\-pool" " name"
 130 .IP
 131 The pool name, which is mandatory.
 132 .HP
 133 .BI "\-M" " test" ", \-\-name" " test"
 134 .IP
 135 An arbitrary string that appears in the program output.
 136 .HP
 137 .BI "-x, \-\-cleanup"
 138 .IP
 139 Enable the DMU_REMOVE flag.
 140 .HP
 141 .BI "\-P" " command" ", \-\-prerun" " command"
 142 .IP
 143 Invoke \fIcommand\fR from the kernel before running the test. Shell
 144 expansion is not performed and the environment is set to
 145 HOME=/; TERM=linux; PATH=/sbin:/usr/sbin:/bin:/usr/bin.
 146 .HP
 147 .BI "\-R" " command" ", \-\-postrun" " command"
 148 .IP
 149 Invoke \fIcommand\fR from the kernel after running the test. Shell
 150 expansion is not performed and the environment is set to
 151 HOME=/; TERM=linux; PATH=/sbin:/usr/sbin:/bin:/usr/bin.
 152 .HP
 153 .BI "\-G" " directory" ", \-\-log" " directory"
 154 .IP
 155 Put logging output in this directory.
 156 .HP
 157 .BI "\-I" " size" ", \-\-regionnoise" " size"
 158 .IP
 159 Randomly vary the \fBregionsize\fR parameter for each test
 160 modulo \fIsize\fR bytes.
 161 .HP
 162 .BI "\-N" " size" ", \-\-chunknoise" " size"
 163 .IP
 164 Randomly vary the \fBchunksize\fR parameter for each test
 165 modulo \fIsize\fR bytes.
 166 .HP
 167 .BI "\-T" " time" ", \-\-threaddelay" " time"
 168 .IP
 169 Randomly vary the execution time for each test
 170 modulo \fItime\fR kernel jiffies.
 171 .HP
 172 .BI "\-V" "" ", \-\-verify" ""
 173 .IP
 174 Enable the DMU_VERIFY flag for trivial data verification.
 175 .HP
 176 .BI "\-z" "" ", \-\-zerocopy" ""
 177 .IP
 178 Enable the DMU_READ_ZC and DMU_WRITE_ZC flags, which are
 179 currently unimplemented for Linux.
 180 .IP
 181 .HP
 182 .BI "\-O" "" ", \-\-nowait" ""
 183 .IP
 184 Enable the DMU_WRITE_NOWAIT flag.
 185 .HP
 186 .BI "\-f" "" ", \-\-noprefetch" ""
 187 .IP
 188 Enable the DMU_READ_NOPF flag.
 189 .HP
 190 .BI "\-H" "" ", \-\-human\-readable" ""
 191 .IP
 192 Print PASS and FAIL results explicitly and put unit suffixes on large
 193 numbers.
 194 .HP
 195 .BI "\-v" "" ", \-\-verbose" ""
 196 .IP
 197 Increase output verbosity.
 198 .HP
 199 .BI "\-?" " " ", \-\-help" " "
 200 .IP
 201 Print the usage message.
 202 .SH "AUTHORS"
 203 The original zpios implementation was created by Cluster File Systems
 204 Inc and adapted to ZFS on Linux by Brian Behlendorf
 205 <behlendorf1@llnl.gov>.
 206
 207 This man page was written by Darik Horn <dajhorn@vanadac.com>.
 208 .SH "SEE ALSO"
 209 .BR zpool (8),
 210 .BR zfs (8)