1 .\" Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd "control utility for RAID3 devices"
38 .Ar prov prov prov ...
78 utility is used for RAID3 array configuration.
79 After a device is created, all components are detected and configured
81 All operations such as failure detection, stale component detection, rebuild
82 of stale components, etc.\& are also done automatically.
85 utility uses on-disk metadata (the provider's last sector) to store all needed
90 indicates an action to be performed:
91 .Bl -tag -width ".Cm configure"
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).
98 Additional options include:
99 .Bl -tag -width ".Fl h"
101 Do not synchronize after a power failure or system crash.
102 Assumes device is in consistent state.
104 Hardcode providers' names in metadata.
106 Turn off autosynchronization of stale components.
108 Use parity component for reading in round-robin fashion.
109 Without this option the parity component is not used at all for reading operations
110 when the device is in a complete state.
111 With this option specified random I/O read operations are even 40% faster,
112 but sequential reads are slower.
113 One cannot use this option if the
115 option is also specified.
117 Use verify reading feature.
118 When reading from a device in a complete state, also read data from the parity component
119 and verify the data by comparing XORed regular data with parity data.
120 If verification fails, an
122 error is returned and the value of the
123 .Va kern.geom.raid3.stat.parity_mismatch
125 One cannot use this option if the
127 option is also specified.
130 Clear metadata on the given providers.
132 Configure the given device.
134 Additional options include:
135 .Bl -tag -width ".Fl a"
137 Turn on autosynchronization of stale components.
139 Do not hardcode providers' names in metadata.
141 Synchronize device after a power failure or system crash.
143 Do not synchronize after a power failure or system crash.
144 Assumes device is in consistent state.
146 Hardcode providers' names in metadata.
148 Turn off autosynchronization of stale components.
150 Turn on round-robin reading.
152 Turn off round-robin reading.
154 Turn on verify reading.
156 Turn off verify reading.
159 Rebuild the given component forcibly.
160 If autosynchronization was not turned off for the given device, this command
161 should be unnecessary.
163 Add the given component to the existing array, if one of the components was
164 removed previously with the
166 command or if one component is missing and will not be connected again.
168 Additional options include:
169 .Bl -tag -width ".Fl h"
171 Hardcode providers' names in metadata.
174 Remove the given component from the given array and clear metadata on it.
176 Stop the given arrays.
178 Additional options include:
179 .Bl -tag -width ".Fl f"
181 Stop the given array even if it is opened.
197 Additional options include:
198 .Bl -tag -width ".Fl v"
203 Exit status is 0 on success, and 1 if the command fails.
205 Use 3 disks to setup a RAID3 array (with the round-robin reading feature).
206 Create a file system, mount it, then unmount it and stop device:
207 .Bd -literal -offset indent
208 graid3 label -v -r data da0 da1 da2
209 newfs /dev/raid3/data
210 mount /dev/raid3/data /mnt
218 Create a RAID3 array, but do not use the automatic synchronization feature.
219 Rebuild parity component:
220 .Bd -literal -offset indent
221 graid3 label -n data da0 da1 da2
222 graid3 rebuild data da2
225 Replace one data disk with a brand new one:
226 .Bd -literal -offset indent
227 graid3 remove -n 0 data
228 graid3 insert -n 0 data da5
243 .An Pawel Jakub Dawidek Aq pjd@FreeBSD.org
245 There should be a section with an implementation description.
247 Documentation for sysctls
248 .Va kern.geom.raid3.*