c/mirror_zfs
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_zfs.git synced 2024-11-17 10:01:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

raidz_test.1: modernise

Browse Source 
Also re-add articles left out by the slav who wrote this

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Closes #12125
This commit is contained in:
наб 2021-05-26 14:51:37 +02:00 committed by Brian Behlendorf
parent defa5a0ae5
commit 3365d2cf71
1 changed files with 74 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
man/man1/raidz_test.1
View File

@ -1,4 +1,3 @@
'\" t
.\" .\"
.\" CDDL HEADER START .\" CDDL HEADER START
.\" .\"
@ -19,88 +18,84 @@
.\" .\"
.\" CDDL HEADER END .\" CDDL HEADER END
.\" .\"
.\"
.\" Copyright (c) 2016 Gvozden Nešković. All rights reserved. .\" Copyright (c) 2016 Gvozden Nešković. All rights reserved.
.\" .\"
.TH RAIDZ_TEST 1 "Aug 24, 2020" OpenZFS .Dd May 26, 2021
.Dt RAIDZ_TEST 1
.SH NAME .Os
\fBraidz_test\fR \- raidz implementation verification and benchmarking tool .
.SH SYNOPSIS .Sh NAME
.LP .Nm raidz_test
.BI "raidz_test <options>" .Nd raidz implementation verification and benchmarking tool
.SH DESCRIPTION .Sh SYNOPSIS
.LP .Nm
This manual page documents briefly the \fBraidz_test\fR command. .Op Fl StBevTD
.LP .Op Fl a Ar ashift
Purpose of this tool is to run all supported raidz implementation and verify .Op Fl o Ar zio_off_shift
results of all methods. Tool also contains a parameter sweep option where all .Op Fl d Ar raidz_data_disks
parameters affecting RAIDZ block are verified (like ashift size, data offset, .Op Fl s Ar zio_size_shift
data size, etc...). .Op Fl r Ar reflow_offset
The tool also supports a benchmarking mode using -B option. .
.SH OPTION .Sh DESCRIPTION
.HP The purpose of this tool is to run all supported raidz implementation and verify
.BI "\-h" "" the results of all methods.
.IP It also contains a parameter sweep option where all
parameters affecting a RAIDZ block are verified (like ashift size, data offset,
data size, etc.).
The tool also supports a benchmarking mode using the
.Fl B
option.
.
.Sh OPTION
.Bl -tag -width "-B(enchmark)"
.It Fl h
Print a help summary. Print a help summary.
.HP .It Fl a Ar ashift No (default: Sy 9 )
.BI "\-a" " ashift (default: 9)"
.IP
Ashift value. Ashift value.
.HP .It Fl o Ar zio_off_shift No (default: Sy 0 )
.BI "\-o" " zio_off_shift" " (default: 0)" ZIO offset for each raidz block.
.IP The offset's value is
Zio offset for raidz block. Offset value is 1 << (zio_off_shift) .Sy 1 << zio_off_shift .
.HP .It Fl d Ar raidz_data_disks No (default: Sy 8 )
.BI "\-d" " raidz_data_disks" " (default: 8)" Number of raidz data disks to use.
.IP Additional disks will be used for parity.
Number of raidz data disks to use. Additional disks for parity will be used .It Fl s Ar zio_size_shift No (default: Sy 19 )
during testing. Size of data for raidz block.
.HP The real size is
.BI "\-s" " zio_size_shift" " (default: 19)" .Sy 1 << zio_size_shift .
.IP .It Fl r Ar reflow_offset No (default: Sy uint max )
Size of data for raidz block. Size is 1 << (zio_size_shift). Set raidz expansion offset.
.HP The expanded raidz map allocation function will
.BI "\-r" " reflow_offset" " (default: uint max)"
.IP
Set raidz expansion offset. The expanded raidz map allocation function will
produce different map configurations depending on this value. produce different map configurations depending on this value.
.HP .It Fl S Ns No (weep)
.BI "\-S(weep)" Sweep parameter space while verifying the raidz implementations.
.IP This option
Sweep parameter space while verifying the raidz implementations. This option will exhaust all most of valid values for the
will exhaust all most of valid values for -a -o -d -s options. Runtime using .Fl aods
this option will be long. options.
.HP Runtime using this option will be long.
.BI "\-t(imeout)" .It Fl t Ns No (imeout)
.IP Wall time for sweep test in seconds.
Wall time for sweep test in seconds. The actual runtime could be longer. The actual runtime could be longer.
.HP .It Fl B Ns No (enchmark)
.BI "\-B(enchmark)" All implementations are benchmarked using increasing per disk data size.
.IP Results are given as throughput per disk, measured in MiB/s.
This options starts the benchmark mode. All implementations are benchmarked .It Fl e Ns No (xpansion)
using increasing per disk data size. Results are given as throughput per disk,
measured in MiB/s.
.HP
.BI "\-e(xpansion)"
.IP
Use expanded raidz map allocation function. Use expanded raidz map allocation function.
.HP .It Fl v Ns No (erbose)
.BI "\-v(erbose)"
.IP
Increase verbosity. Increase verbosity.
.HP .It Fl T Ns No (est the test)
.BI "\-T(est the test)" Debugging option: fail all tests.
.IP This is to check if tests would properly verify bit-exactness.
Debugging option. When this option is specified tool is supposed to fail .It Fl D Ns No (ebug)
all tests. This is to check if tests would properly verify bit-exactness. Debugging option: attach
.HP .Xr gdb 1
.BI "\-D(ebug)" when
.IP .Sy SIGSEGV
Debugging option. Specify to attach gdb when SIGSEGV or SIGABRT are received. or
.HP .Sy SIGABRT
are received.
.SH "SEE ALSO" .El
.BR "ztest (1)" .
.SH "AUTHORS" .Sh "SEE ALSO"
vdev_raidz, created for OpenZFS by Gvozden Nešković <neskovic@gmail.com> .Xr ztest 1