sbin/geom/class/raid3/graid3.8

   1 .\" Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd August 22, 2004
  28 .Dt GRAID3 8
  29 .Os
  30 .Sh NAME
  31 .Nm graid3
  32 .Nd "control utility for RAID3 devices"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Cm label
  36 .Op Fl hnrvw
  37 .Ar name
  38 .Ar prov prov prov ...
  39 .Nm
  40 .Cm clear
  41 .Op Fl v
  42 .Ar prov ...
  43 .Nm
  44 .Cm configure
  45 .Op Fl adhnrRvwW
  46 .Ar name
  47 .Nm
  48 .Cm rebuild
  49 .Op Fl v
  50 .Ar name
  51 .Ar prov
  52 .Nm
  53 .Cm insert
  54 .Op Fl hv
  55 .Fl n Ar number
  56 .Ar name
  57 .Ar prov
  58 .Nm
  59 .Cm remove
  60 .Op Fl v
  61 .Fl n Ar number
  62 .Ar name
  63 .Nm
  64 .Cm stop
  65 .Op Fl fv
  66 .Ar name ...
  67 .Nm
  68 .Cm list
  69 .Nm
  70 .Cm status
  71 .Nm
  72 .Cm load
  73 .Nm
  74 .Cm unload
  75 .Sh DESCRIPTION
  76 The
  77 .Nm
  78 utility is used for RAID3 array configuration.
  79 After a device is created, all components are detected and configured
  80 automatically.
  81 All operations such as failure detection, stale component detection, rebuild
  82 of stale components, etc.\& are also done automatically.
  83 The
  84 .Nm
  85 utility uses on-disk metadata (the provider's last sector) to store all needed
  86 information.
  87 .Pp
  88 The first argument to
  89 .Nm
  90 indicates an action to be performed:
  91 .Bl -tag -width ".Cm configure"
  92 .It Cm label
  93 Create a RAID3 device.
  94 The last given component will contain parity data, whilst the others
  95 will all contain regular data.
  96 The number of components must be equal to 3, 5, 9, 17, etc.\& (2^n + 1).
  97 .Pp
  98 Additional options include:
  99 .Bl -tag -width ".Fl h"
 100 .It Fl h
 101 Hardcode providers' names in metadata.
 102 .It Fl n
 103 Turn off autosynchronization of stale components.
 104 .It Fl r
 105 Use parity component for reading in round-robin fashion.
 106 Without this option the parity component is not used at all for reading operations
 107 when the device is in a complete state.
 108 With this option specified random I/O read operations are even 40% faster,
 109 but sequential reads are slower.
 110 One cannot use this option if the
 111 .Fl w
 112 option is also specified.
 113 .It Fl w
 114 Use verify reading feature.
 115 When reading from a device in a complete state, also read data from the parity component
 116 and verify the data by comparing XORed regular data with parity data.
 117 If verification fails, an
 118 .Er EIO
 119 error is returned and the value of the
 120 .Va kern.geom.raid3.stat.parity_mismatch
 121 sysctl is increased.
 122 One cannot use this option if the
 123 .Fl r
 124 option is also specified.
 125 .El
 126 .It Cm clear
 127 Clear metadata on the given providers.
 128 .It Cm configure
 129 Configure the given device.
 130 .Pp
 131 Additional options include:
 132 .Bl -tag -width ".Fl a"
 133 .It Fl a
 134 Turn on autosynchronization of stale components.
 135 .It Fl d
 136 Do not hardcode providers' names in metadata.
 137 .It Fl h
 138 Hardcode providers' names in metadata.
 139 .It Fl n
 140 Turn off autosynchronization of stale components.
 141 .It Fl r
 142 Turn on round-robin reading.
 143 .It Fl R
 144 Turn off round-robin reading.
 145 .It Fl w
 146 Turn on verify reading.
 147 .It Fl W
 148 Turn off verify reading.
 149 .El
 150 .It Cm rebuild
 151 Rebuild the given component forcibly.
 152 If autosynchronization was not turned off for the given device, this command
 153 should be unnecessary.
 154 .It Cm insert
 155 Add the given component to the existing array, if one of the components was
 156 removed previously with the
 157 .Cm remove
 158 command or if one component is missing and will not be connected again.
 159 .Pp
 160 Additional options include:
 161 .Bl -tag -width ".Fl h"
 162 .It Fl h
 163 Hardcode providers' names in metadata.
 164 .El
 165 .It Cm remove
 166 Remove the given component from the given array and clear metadata on it.
 167 .It Cm stop
 168 Stop the given arrays.
 169 .Pp
 170 Additional options include:
 171 .Bl -tag -width ".Fl f"
 172 .It Fl f
 173 Stop the given array even if it is opened.
 174 .El
 175 .It Cm list
 176 See
 177 .Xr geom 8 .
 178 .It Cm status
 179 See
 180 .Xr geom 8 .
 181 .It Cm load
 182 See
 183 .Xr geom 8 .
 184 .It Cm unload
 185 See
 186 .Xr geom 8 .
 187 .El
 188 .Pp
 189 Additional options include:
 190 .Bl -tag -width ".Fl v"
 191 .It Fl v
 192 Be more verbose.
 193 .El
 194 .Sh EXIT STATUS
 195 Exit status is 0 on success, and 1 if the command fails.
 196 .Sh EXAMPLES
 197 Use 3 disks to setup a RAID3 array (with the round-robin reading feature).
 198 Create a file system, mount it, then unmount it and stop device:
 199 .Bd -literal -offset indent
 200 graid3 label -v -r data da0 da1 da2
 201 newfs /dev/raid3/data
 202 mount /dev/raid3/data /mnt
 203 \&...
 204 umount /mnt
 205 graid3 stop data
 206 graid3 unload
 207 .Ed
 208 .Pp
 209 .Pp
 210 Create a RAID3 array, but do not use the automatic synchronization feature.
 211 Rebuild parity component:
 212 .Bd -literal -offset indent
 213 graid3 label -n data da0 da1 da2
 214 graid3 rebuild data da2
 215 .Ed
 216 .Pp
 217 Replace one data disk with a brand new one:
 218 .Bd -literal -offset indent
 219 graid3 remove -n 0 data
 220 graid3 insert -n 0 data da5
 221 .Ed
 222 .Sh SEE ALSO
 223 .Xr geom 4 ,
 224 .Xr geom 8 ,
 225 .Xr mount 8 ,
 226 .Xr newfs 8 ,
 227 .Xr umount 8 ,
 228 .Xr vinum 8
 229 .Sh HISTORY
 230 The
 231 .Nm
 232 utility appeared in
 233 .Fx 5.3 .
 234 .Sh AUTHORS
 235 .An Pawel Jakub Dawidek Aq pjd@FreeBSD.org
 236 .Sh BUGS
 237 There should be a section with an implementation description.
 238 .Pp
 239 Documentation for sysctls
 240 .Va kern.geom.raid3.*
 241 is missing.