online-docs/ztest.1.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 8.2.2" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a {\r
  20   color: blue;\r
  21   text-decoration: underline;\r
  22 }\r
  23 a:visited {\r
  24   color: fuchsia;\r
  25 }\r
  26 \r
  27 em {\r
  28   font-style: italic;\r
  29 }\r
  30 \r
  31 strong {\r
  32   font-weight: bold;\r
  33 }\r
  34 \r
  35 tt {\r
  36   color: navy;\r
  37 }\r
  38 \r
  39 h1, h2, h3, h4, h5, h6 {\r
  40   color: #527bbd;\r
  41   font-family: sans-serif;\r
  42   margin-top: 1.2em;\r
  43   margin-bottom: 0.5em;\r
  44   line-height: 1.3;\r
  45 }\r
  46 \r
  47 h1 {\r
  48   border-bottom: 2px solid silver;\r
  49 }\r
  50 h2 {\r
  51   border-bottom: 2px solid silver;\r
  52   padding-top: 0.5em;\r
  53 }\r
  54 \r
  55 div.sectionbody {\r
  56   font-family: serif;\r
  57   margin-left: 0;\r
  58 }\r
  59 \r
  60 hr {\r
  61   border: 1px solid silver;\r
  62 }\r
  63 \r
  64 p {\r
  65   margin-top: 0.5em;\r
  66   margin-bottom: 0.5em;\r
  67 }\r
  68 \r
  69 pre {\r
  70   padding: 0;\r
  71   margin: 0;\r
  72 }\r
  73 \r
  74 span#author {\r
  75   color: #527bbd;\r
  76   font-family: sans-serif;\r
  77   font-weight: bold;\r
  78   font-size: 1.1em;\r
  79 }\r
  80 span#email {\r
  81 }\r
  82 span#revision {\r
  83   font-family: sans-serif;\r
  84 }\r
  85 \r
  86 div#footer {\r
  87   font-family: sans-serif;\r
  88   font-size: small;\r
  89   border-top: 2px solid silver;\r
  90   padding-top: 0.5em;\r
  91   margin-top: 4.0em;\r
  92 }\r
  93 div#footer-text {\r
  94   float: left;\r
  95   padding-bottom: 0.5em;\r
  96 }\r
  97 div#footer-badges {\r
  98   float: right;\r
  99   padding-bottom: 0.5em;\r
 100 }\r
 101 \r
 102 div#preamble,\r
 103 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
 104 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 105 div.admonitionblock {\r
 106   margin-right: 10%;\r
 107   margin-top: 1.5em;\r
 108   margin-bottom: 1.5em;\r
 109 }\r
 110 div.admonitionblock {\r
 111   margin-top: 2.5em;\r
 112   margin-bottom: 2.5em;\r
 113 }\r
 114 \r
 115 div.content { /* Block element content. */\r
 116   padding: 0;\r
 117 }\r
 118 \r
 119 /* Block element titles. */\r
 120 div.title, caption.title {\r
 121   font-family: sans-serif;\r
 122   font-weight: bold;\r
 123   text-align: left;\r
 124   margin-top: 1.0em;\r
 125   margin-bottom: 0.5em;\r
 126 }\r
 127 div.title + * {\r
 128   margin-top: 0;\r
 129 }\r
 130 \r
 131 td div.title:first-child {\r
 132   margin-top: 0.0em;\r
 133 }\r
 134 div.content div.title:first-child {\r
 135   margin-top: 0.0em;\r
 136 }\r
 137 div.content + div.title {\r
 138   margin-top: 0.0em;\r
 139 }\r
 140 \r
 141 div.sidebarblock > div.content {\r
 142   background: #ffffee;\r
 143   border: 1px solid silver;\r
 144   padding: 0.5em;\r
 145 }\r
 146 \r
 147 div.listingblock {\r
 148   margin-right: 0%;\r
 149 }\r
 150 div.listingblock > div.content {\r
 151   border: 1px solid silver;\r
 152   background: #f4f4f4;\r
 153   padding: 0.5em;\r
 154 }\r
 155 \r
 156 div.quoteblock > div.content {\r
 157   padding-left: 2.0em;\r
 158 }\r
 159 \r
 160 div.attribution {\r
 161   text-align: right;\r
 162 }\r
 163 div.verseblock + div.attribution {\r
 164   text-align: left;\r
 165 }\r
 166 \r
 167 div.admonitionblock .icon {\r
 168   vertical-align: top;\r
 169   font-size: 1.1em;\r
 170   font-weight: bold;\r
 171   text-decoration: underline;\r
 172   color: #527bbd;\r
 173   padding-right: 0.5em;\r
 174 }\r
 175 div.admonitionblock td.content {\r
 176   padding-left: 0.5em;\r
 177   border-left: 2px solid silver;\r
 178 }\r
 179 \r
 180 div.exampleblock > div.content {\r
 181   border-left: 2px solid silver;\r
 182   padding: 0.5em;\r
 183 }\r
 184 \r
 185 div.verseblock div.content {\r
 186   white-space: pre;\r
 187 }\r
 188 \r
 189 div.imageblock div.content { padding-left: 0; }\r
 190 div.imageblock img { border: 1px solid silver; }\r
 191 span.image img { border-style: none; }\r
 192 \r
 193 dl {\r
 194   margin-top: 0.8em;\r
 195   margin-bottom: 0.8em;\r
 196 }\r
 197 dt {\r
 198   margin-top: 0.5em;\r
 199   margin-bottom: 0;\r
 200   font-style: italic;\r
 201 }\r
 202 dd > *:first-child {\r
 203   margin-top: 0;\r
 204 }\r
 205 \r
 206 ul, ol {\r
 207     list-style-position: outside;\r
 208 }\r
 209 ol.olist2 {\r
 210   list-style-type: lower-alpha;\r
 211 }\r
 212 \r
 213 div.tableblock > table {\r
 214   border: 3px solid #527bbd;\r
 215 }\r
 216 thead {\r
 217   font-family: sans-serif;\r
 218   font-weight: bold;\r
 219 }\r
 220 tfoot {\r
 221   font-weight: bold;\r
 222 }\r
 223 \r
 224 div.hlist {\r
 225   margin-top: 0.8em;\r
 226   margin-bottom: 0.8em;\r
 227 }\r
 228 div.hlist td {\r
 229   padding-bottom: 5px;\r
 230 }\r
 231 td.hlist1 {\r
 232   vertical-align: top;\r
 233   font-style: italic;\r
 234   padding-right: 0.8em;\r
 235 }\r
 236 td.hlist2 {\r
 237   vertical-align: top;\r
 238 }\r
 239 \r
 240 @media print {\r
 241   div#footer-badges { display: none; }\r
 242 }\r
 243 \r
 244 div#toctitle {\r
 245   color: #527bbd;\r
 246   font-family: sans-serif;\r
 247   font-size: 1.1em;\r
 248   font-weight: bold;\r
 249   margin-top: 1.0em;\r
 250   margin-bottom: 0.1em;\r
 251 }\r
 252 \r
 253 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {\r
 254   margin-top: 0;\r
 255   margin-bottom: 0;\r
 256 }\r
 257 div.toclevel2 {\r
 258   margin-left: 2em;\r
 259   font-size: 0.9em;\r
 260 }\r
 261 div.toclevel3 {\r
 262   margin-left: 4em;\r
 263   font-size: 0.9em;\r
 264 }\r
 265 div.toclevel4 {\r
 266   margin-left: 6em;\r
 267   font-size: 0.9em;\r
 268 }\r
 269 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 270 \r
 271 div.sidebar-content {\r
 272   background: #ffffee;\r
 273   border: 1px solid silver;\r
 274   padding: 0.5em;\r
 275 }\r
 276 div.sidebar-title, div.image-title {\r
 277   font-family: sans-serif;\r
 278   font-weight: bold;\r
 279   margin-top: 0.0em;\r
 280   margin-bottom: 0.5em;\r
 281 }\r
 282 \r
 283 div.listingblock div.content {\r
 284   border: 1px solid silver;\r
 285   background: #f4f4f4;\r
 286   padding: 0.5em;\r
 287 }\r
 288 \r
 289 div.quoteblock-content {\r
 290   padding-left: 2.0em;\r
 291 }\r
 292 \r
 293 div.exampleblock-content {\r
 294   border-left: 2px solid silver;\r
 295   padding-left: 0.5em;\r
 296 }\r
 297 \r
 298 /* IE6 sets dynamically generated links as visited. */\r
 299 div#toc a:visited { color: blue; }\r
 300 </style>\r
 301 <title>ZTEST(1)</title>\r
 302 </head>\r
 303 <body>\r
 304 <div id="header">\r
 305 <h1>ZTEST(1)</h1>\r
 306 <span id="author">Michael Gebetsroither</span><br />\r
 307 <span id="email"><tt>&lt;<a href="mailto:michael.geb@gmx.at">michael.geb@gmx.at</a>&gt;</tt></span><br />\r
 308 </div>\r
 309 <h2>NAME</h2>\r
 310 <div class="sectionbody">\r
 311 <p>ztest - was written by the ZFS Developers as a ZFS unit test.</p>\r
 312 </div>\r
 313 <h2>SYNOPSIS</h2>\r
 314 <div class="sectionbody">\r
 315 <p><strong>ztest</strong> &lt;options&gt;</p>\r
 316 </div>\r
 317 <h2>DESCRIPTION</h2>\r
 318 <div class="sectionbody">\r
 319 <p>This manual page documents briefly the <strong>ztest</strong> command.</p>\r
 320 <p><strong>ztest</strong> was written by the ZFS Developers as a ZFS unit test. The tool was\r
 321 developed in tandem with the ZFS functionality and was executed nightly as one\r
 322 of the many regression test against the daily build. As features were added to\r
 323 ZFS, unit tests were also added to ztest. In addition, a separate test\r
 324 development team wrote and executed more functional and stress tests.</p>\r
 325 <p>By default <strong>ztest</strong> runs for ten minutes and uses block files (stored in /tmp)\r
 326 to create pools rather than using physical disks. Block files afford <strong>ztest</strong>\r
 327 its flexibility to play around with zpool components without requiring large\r
 328 hardware configurations. However, storing the block files in /tmp may not work\r
 329 for you if you have a small tmp directory.</p>\r
 330 <p>By default is non-verbose. This is why entering the command above will result\r
 331 in <strong>ztest</strong> quietly executing for 5 minutes. The -V option can be used to\r
 332 increase the verbosity of the tool. Adding multiple -V option is allowed and\r
 333 the more you add the more chatty <strong>ztest</strong> becomes.</p>\r
 334 <p>After the <strong>ztest</strong> run completes, you should notice many ztest.* files lying\r
 335 around. Once the run completes you can safely remove these files. Note that you\r
 336 shouldn't remove these files during a run. You can re-use these files in your\r
 337 next *ztest* run by using the -E option.</p>\r
 338 </div>\r
 339 <h2>OPTIONS</h2>\r
 340 <div class="sectionbody">\r
 341 <dl>\r
 342 <dt>\r
 343 <strong>-?</strong>\r
 344 </dt>\r
 345 <dd>\r
 346 <p>\r
 347 Print a help summary\r
 348 </p>\r
 349 </dd>\r
 350 <dt>\r
 351 <strong>-v vdevs (default: 5)</strong>\r
 352 </dt>\r
 353 <dd>\r
 354 <p>\r
 355 Number of vdevs.\r
 356 </p>\r
 357 </dd>\r
 358 <dt>\r
 359 <strong>-s size_of_each_vdev (default: 64M)</strong>\r
 360 </dt>\r
 361 <dd>\r
 362 <p>\r
 363 Size of each vdev.\r
 364 </p>\r
 365 </dd>\r
 366 <dt>\r
 367 <strong>-a alignment_shift (default: 9) (use 0 for random)</strong>\r
 368 </dt>\r
 369 <dd>\r
 370 <p>\r
 371 Used alignment in test.\r
 372 </p>\r
 373 </dd>\r
 374 <dt>\r
 375 <strong>-m mirror_copies (default: 2)</strong>\r
 376 </dt>\r
 377 <dd>\r
 378 <p>\r
 379 Number of mirror copies.\r
 380 </p>\r
 381 </dd>\r
 382 <dt>\r
 383 <strong>-r raidz_disks (default: 4)</strong>\r
 384 </dt>\r
 385 <dd>\r
 386 <p>\r
 387 Number of raidz disks.\r
 388 </p>\r
 389 </dd>\r
 390 <dt>\r
 391 <strong>-R raidz_parity (default: 1)</strong>\r
 392 </dt>\r
 393 <dd>\r
 394 <p>\r
 395 Raidz parity.\r
 396 </p>\r
 397 </dd>\r
 398 <dt>\r
 399 <strong>-d datasets (default: 7)</strong>\r
 400 </dt>\r
 401 <dd>\r
 402 <p>\r
 403 Number of datasets.\r
 404 </p>\r
 405 </dd>\r
 406 <dt>\r
 407 <strong>-t threads (default: 23)</strong>\r
 408 </dt>\r
 409 <dd>\r
 410 <p>\r
 411 Number of threads.\r
 412 </p>\r
 413 </dd>\r
 414 <dt>\r
 415 <strong>-g gang_block_threshold (default: 32K)</strong>\r
 416 </dt>\r
 417 <dd>\r
 418 <p>\r
 419 Gang block threshold.\r
 420 </p>\r
 421 </dd>\r
 422 <dt>\r
 423 <strong>-i initialize pool i times (default: 1)</strong>\r
 424 </dt>\r
 425 <dd>\r
 426 <p>\r
 427 Number of pool initialisations.\r
 428 </p>\r
 429 </dd>\r
 430 <dt>\r
 431 <strong>-k kill percentage (default: 70%)</strong>\r
 432 </dt>\r
 433 <dd>\r
 434 <p>\r
 435 Kill percentage.\r
 436 </p>\r
 437 </dd>\r
 438 <dt>\r
 439 <strong>-p pool_name (default: ztest)</strong>\r
 440 </dt>\r
 441 <dd>\r
 442 <p>\r
 443 Pool name.\r
 444 </p>\r
 445 </dd>\r
 446 <dt>\r
 447 <strong>-f file directory for vdev files (default: /tmp)</strong>\r
 448 </dt>\r
 449 <dd>\r
 450 <p>\r
 451 Directory for vdev files.\r
 452 </p>\r
 453 </dd>\r
 454 <dt>\r
 455 <strong>-V(erbose)</strong>\r
 456 </dt>\r
 457 <dd>\r
 458 <p>\r
 459 Verbose (use multiple times for ever more blather).\r
 460 </p>\r
 461 </dd>\r
 462 <dt>\r
 463 <strong>-E(xisting)</strong>\r
 464 </dt>\r
 465 <dd>\r
 466 <p>\r
 467 Use existing pool (use existing pool instead of creating new one).\r
 468 </p>\r
 469 </dd>\r
 470 <dt>\r
 471 <strong>-T time (default: 300 sec)</strong>\r
 472 </dt>\r
 473 <dd>\r
 474 <p>\r
 475 Total test run time.\r
 476 </p>\r
 477 </dd>\r
 478 <dt>\r
 479 <strong>-P passtime (default: 60 sec)</strong>\r
 480 </dt>\r
 481 <dd>\r
 482 <p>\r
 483 Time per pass.\r
 484 </p>\r
 485 </dd>\r
 486 <dt>\r
 487 <strong>-z zil failure rate (default: fail every 2^5 allocs)</strong>\r
 488 </dt>\r
 489 <dd>\r
 490 <p>\r
 491 Injected failure rate.\r
 492 </p>\r
 493 </dd>\r
 494 </dl>\r
 495 </div>\r
 496 <h2>EXAMPLES</h2>\r
 497 <div class="sectionbody">\r
 498 <p>To override /tmp as your location for block files, you can use the -f option:</p>\r
 499 <div class="listingblock">\r
 500 <div class="content">\r
 501 <pre><tt>    ztest -f /</tt></pre>\r
 502 </div></div>\r
 503 <p>To get an idea of what ztest is actually testing try this:</p>\r
 504 <div class="listingblock">\r
 505 <div class="content">\r
 506 <pre><tt>    ztest -f / -VVV</tt></pre>\r
 507 </div></div>\r
 508 <p>Maybe you'd like to run ztest for longer? To do so simply use the -T option and\r
 509 specify the runlength in seconds like so:</p>\r
 510 <div class="listingblock">\r
 511 <div class="content">\r
 512 <pre><tt>    ztest -f / -V -T 120</tt></pre>\r
 513 </div></div>\r
 514 </div>\r
 515 <h2>SEE ALSO</h2>\r
 516 <div class="sectionbody">\r
 517 <p>zpool(1), zfs(1), zdb(1), zfs-fuse(1)</p>\r
 518 </div>\r
 519 <h2>AUTHOR</h2>\r
 520 <div class="sectionbody">\r
 521 <p>This manual page was transvered to asciidoc by Michael Gebetsroither\r
 522 &lt;gebi@grml.org&gt; from http://opensolaris.org/os/community/zfs/ztest/</p>\r
 523 </div>\r
 524 <div id="footer">\r
 525 <div id="footer-text">\r
 526 Last updated 01-Nov-2009 04:31:46 CEST\r
 527 </div>\r
 528 </div>\r
 529 </body>\r
 530 </html>\r