sys/contrib/openzfs/man/man1/raidz_test.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 (c) 2016 Gvozden Nešković. All rights reserved.
  24 .\"
  25 .TH RAIDZ_TEST 1 "Aug 24, 2020" OpenZFS
  26
  27 .SH NAME
  28 \fBraidz_test\fR \- raidz implementation verification and benchmarking tool
  29 .SH SYNOPSIS
  30 .LP
  31 .BI "raidz_test <options>"
  32 .SH DESCRIPTION
  33 .LP
  34 This manual page documents briefly the \fBraidz_test\fR command.
  35 .LP
  36 Purpose of this tool is to run all supported raidz implementation and verify
  37 results of all methods. Tool also contains a parameter sweep option where all
  38 parameters affecting RAIDZ block are verified (like ashift size, data offset,
  39 data size, etc...).
  40 The tool also supports a benchmarking mode using -B option.
  41 .SH OPTION
  42 .HP
  43 .BI "\-h" ""
  44 .IP
  45 Print a help summary.
  46 .HP
  47 .BI "\-a" " ashift (default: 9)"
  48 .IP
  49 Ashift value.
  50 .HP
  51 .BI "\-o" " zio_off_shift" " (default: 0)"
  52 .IP
  53 Zio offset for raidz block. Offset value is 1 << (zio_off_shift)
  54 .HP
  55 .BI "\-d" " raidz_data_disks" " (default: 8)"
  56 .IP
  57 Number of raidz data disks to use. Additional disks for parity will be used
  58 during testing.
  59 .HP
  60 .BI "\-s" " zio_size_shift" " (default: 19)"
  61 .IP
  62 Size of data for raidz block. Size is 1 << (zio_size_shift).
  63 .HP
  64 .BI "\-S(weep)"
  65 .IP
  66 Sweep parameter space while verifying the raidz implementations. This option
  67 will exhaust all most of valid values for -a -o -d -s options. Runtime using
  68 this option will be long.
  69 .HP
  70 .BI "\-t(imeout)"
  71 .IP
  72 Wall time for sweep test in seconds. The actual runtime could be longer.
  73 .HP
  74 .BI "\-B(enchmark)"
  75 .IP
  76 This options starts the benchmark mode. All implementations are benchmarked
  77 using increasing per disk data size. Results are given as throughput per disk,
  78 measured in MiB/s.
  79 .HP
  80 .BI "\-v(erbose)"
  81 .IP
  82 Increase verbosity.
  83 .HP
  84 .BI "\-T(est the test)"
  85 .IP
  86 Debugging option. When this option is specified tool is supposed to fail
  87 all tests. This is to check if tests would properly verify bit-exactness.
  88 .HP
  89 .BI "\-D(ebug)"
  90 .IP
  91 Debugging option. Specify to attach gdb when SIGSEGV or SIGABRT are received.
  92 .HP
  93
  94 .SH "SEE ALSO"
  95 .BR "ztest (1)"
  96 .SH "AUTHORS"
  97 vdev_raidz, created for ZFS on Linux by Gvozden Nešković <neskovic@gmail.com>