granicus.if.org Git - zfs/blob - 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 .\" Copyright (c) 2015, Intel Corporation.
  26 .\"
  27 .TH zpios 1 "2013 FEB 28" "ZFS on Linux" "User Commands"
  28
  29 .SH NAME
  30 zpios \- Directly test the DMU.
  31 .SH SYNOPSIS
  32 .LP
  33 .BI "zpios [options] <\-p " pool ">"
  34
  35 .SH DESCRIPTION
  36 This utility runs in-kernel DMU performance and stress tests that do
  37 not depend on the ZFS Posix Layer ("ZPL").
  38
  39 .SH OPTIONS
  40 .HP
  41 .BI "\-t" " regex" ", \-\-threadcount" " regex"
  42 .IP
  43 Start this many threads for each test series, specified as a comma
  44 delimited regular expression. (eg: "-t 1,2,3")
  45 .IP
  46 This option is mutually exclusive with the \fBthreadcount_*\fR
  47 options.
  48 .HP
  49 .BI "\-l" " regex_low" ", \-\-threadcount_low" " regex_low"
  50 .HP
  51 .BI "\-h" " regex_high" ", \-\-threadcount_high" " regex_high"
  52 .HP
  53 .BI "\-e" " regex_incr" ", \-\-threadcount_incr" " regex_incr"
  54 .IP
  55 Start \fIregex_low\fR threads for the first test,
  56 add \fIregex_incr\fR threads for each subsequent test,
  57 and start \fIregex_high\fR threads for the last test.
  58 .IP
  59 These three options must be specified together and are mutually
  60 exclusive with the \fBthreadcount\fR option.
  61 .HP
  62 .BI "\-n" " regex" ", \-\-regioncount" " regex"
  63 .IP
  64 Create this many regions for each test series, specified as a comma
  65 delimited regular expression. (eg: "-n 512,4096,65536")
  66 .IP
  67 This option is mutually exclusive with the \fBregioncount_*\fR
  68 options.
  69 .HP
  70 .BI "\-i" " regex_low" ", \-\-regioncount_low" " regex_low"
  71 .HP
  72 .BI "\-j" " regex_high" ", \-\-regioncount_high" " regex_high"
  73 .HP
  74 .BI "\-k" " regex_incr" ", \-\-regioncount_incr" " regex_incr"
  75 .IP
  76 Create \fIregex_low\fR regions for the first test,
  77 add \fIregex_incr\fR regions for each subsequent test, and
  78 create \fIregex_high\fR regions for the last test.
  79 .IP
  80 These three options must be specified together and are mutually
  81 exclusive with the \fBregioncount\fR option.
  82 .HP
  83 .BI "\-o" " size" ", \-\-offset" " size"
  84 .IP
  85 Create regions at \fIsize\fR offset for each test series, specified as
  86 a comma delimited regular expression with an optional unit suffix.
  87 (eg: "-o 4M" means four megabytes.)
  88 .IP
  89 This option is mutually exclusive with the \fBoffset_*\fR options.
  90 .HP
  91 .BI "\-m" " size_low" ", \-\-offset_low" " size_low"
  92 .HP
  93 .BI "\-q" " size_high" ", \-\-offset_high" " size_high"
  94 .HP
  95 .BI "\-r" " size_incr" ", \-\-offset_incr" " size_incr"
  96 .IP
  97 Create a region at \fIsize_low\fR offset for the first test, add
  98 \fIsize_incr\fR to the offset for each subsequent test, and create
  99 a region at \fIsize_high\fR offset for the last test.
 100 .IP
 101 These three options must be specified together and are mutually
 102 exclusive with the \fBoffset\fR option.
 103 .HP
 104 .BI "\-c" " size" ", \-\-chunksize" " size"
 105 .IP
 106 Use \fIsize\fR chunks for each test, specified as a comma delimited
 107 regular expression with an optional unit suffix. (eg: "-c 1M" means
 108 one megabyte.) The chunk size must be at least the region size.
 109 .IP
 110 This option is mutually exclusive with the \fBchunksize_*\fB options.
 111 .HP
 112 .BI "\-a" " size_low" ", \-\-chunksize_low" " size_low"
 113 .HP
 114 .BI "\-b" " size_high" ", \-\-chunksize_high" " size_high"
 115 .HP
 116 .BI "\-g" " size_incr" ", \-\-chunksize_incr" " size_incr"
 117 .IP
 118 Use a \fIsize_low\fR chunk size for the first test, add \fIsize_incr\fR
 119 to the chunk size for each subsequent test, and use a \fIsize_high\fR
 120 chunk size for the last test.
 121 .IP
 122 These three options must be specified together and are mutually
 123 exclusive with the \fBchunksize\fR option.
 124 .HP
 125 .BI "\-s" " size" ", \-\-regionsize" " size"
 126 .IP
 127 Use \fIsize\fR regions for each test, specified as a comma delimited
 128 regular expression with an optional unit suffix. (eg: "-s 1M" means
 129 one megabyte.)
 130 .IP
 131 This option is mutually exclusive with the \fBregionsize_*\fB options.
 132 .HP
 133 .BI "\-A" " size_low" ", \-\-regionsize_low" " size_low"
 134 .HP
 135 .BI "\-B" " size_high" ", \-\-regionsize_high" " size_high"
 136 .HP
 137 .BI "\-C" " size_incr" ", \-\-regionsize_incr" " size_incr"
 138 .IP
 139 Use a \fIsize_low\fR region size for the first test, add \fIsize_incr\fR
 140 to the region size for each subsequent test, and use a \fIsize_high\fR
 141 region size for the last test.
 142 .IP
 143 These three options must be specified together and are mutually
 144 exclusive with the \fBregionsize\fR option.
 145 .HP
 146 .BI "\-S" " size | sizes" ", \-\-blocksize" " size | sizes"
 147 .IP
 148 Use \fIsize\fR ZFS blocks for each test, specified as a comma delimited
 149 regular expression with an optional unit suffix. (eg: "-S 1M" means
 150 one megabyte.) The supported range is powers of two from 128K through 16M.
 151 A range of blocks can be tested as follows: "-S 128K,256K,512K,1M".
 152 .IP
 153 .HP
 154 .BI "\-L" " dmu_flags" ", \-\-load" " dmu_flags"
 155 .IP
 156 Specify \fIdmuio\fR for regular DMU_IO, \fIssf\fR for single shared
 157 file access, or \fIfpp\fR for per thread access. Use commas to delimit
 158 multiple flags. (eg: "-L dmuio,ssf")
 159 .HP
 160 .BI "\-p" " name" ", \-\-pool" " name"
 161 .IP
 162 The pool name, which is mandatory.
 163 .HP
 164 .BI "\-M" " test" ", \-\-name" " test"
 165 .IP
 166 An arbitrary string that appears in the program output.
 167 .HP
 168 .BI "-x, \-\-cleanup"
 169 .IP
 170 Enable the DMU_REMOVE flag.
 171 .HP
 172 .BI "\-P" " command" ", \-\-prerun" " command"
 173 .IP
 174 Invoke \fIcommand\fR from the kernel before running the test. Shell
 175 expansion is not performed and the environment is set to
 176 HOME=/; TERM=linux; PATH=/sbin:/usr/sbin:/bin:/usr/bin.
 177 .HP
 178 .BI "\-R" " command" ", \-\-postrun" " command"
 179 .IP
 180 Invoke \fIcommand\fR from the kernel after running the test. Shell
 181 expansion is not performed and the environment is set to
 182 HOME=/; TERM=linux; PATH=/sbin:/usr/sbin:/bin:/usr/bin.
 183 .HP
 184 .BI "\-G" " directory" ", \-\-log" " directory"
 185 .IP
 186 Put logging output in this directory.
 187 .HP
 188 .BI "\-I" " size" ", \-\-regionnoise" " size"
 189 .IP
 190 Randomly vary the \fBregionsize\fR parameter for each test
 191 modulo \fIsize\fR bytes.
 192 .HP
 193 .BI "\-N" " size" ", \-\-chunknoise" " size"
 194 .IP
 195 Randomly vary the \fBchunksize\fR parameter for each test
 196 modulo \fIsize\fR bytes.
 197 .HP
 198 .BI "\-T" " time" ", \-\-threaddelay" " time"
 199 .IP
 200 Randomly vary the execution time for each test
 201 modulo \fItime\fR kernel jiffies.
 202 .HP
 203 .BI "\-V" "" ", \-\-verify" ""
 204 .IP
 205 Enable the DMU_VERIFY flag for trivial data verification.
 206 .HP
 207 .BI "\-z" "" ", \-\-zerocopy" ""
 208 .IP
 209 Enable the DMU_READ_ZC and DMU_WRITE_ZC flags, which are
 210 currently unimplemented for Linux.
 211 .IP
 212 .HP
 213 .BI "\-O" "" ", \-\-nowait" ""
 214 .IP
 215 Enable the DMU_WRITE_NOWAIT flag.
 216 .HP
 217 .BI "\-f" "" ", \-\-noprefetch" ""
 218 .IP
 219 Enable the DMU_READ_NOPF flag.
 220 .HP
 221 .BI "\-H" "" ", \-\-human\-readable" ""
 222 .IP
 223 Print PASS and FAIL results explicitly and put unit suffixes on large
 224 numbers.
 225 .HP
 226 .BI "\-v" "" ", \-\-verbose" ""
 227 .IP
 228 Increase output verbosity.
 229 .HP
 230 .BI "\-?" " " ", \-\-help" " "
 231 .IP
 232 Print the usage message.
 233 .SH "AUTHORS"
 234 The original zpios implementation was created by Cluster File Systems
 235 Inc and adapted to ZFS on Linux by Brian Behlendorf
 236 <behlendorf1@llnl.gov>.
 237
 238 This man page was written by Darik Horn <dajhorn@vanadac.com>.
 239 .SH "SEE ALSO"
 240 .BR zpool (8),
 241 .BR zfs (8)