CVS log for src/sbin/raidctl/raidctl.8

Up to [cvs.NetBSD.org] / src / sbin / raidctl

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

Pull up following revision(s) (requested by oster in ticket #675):

	sbin/raidctl/raidctl.8: revision 1.81
	sbin/raidctl/raidctl.c: revision 1.80

Implement command-line configuration of simple RAID sets with raidctl
based on the usage pattern:

 raidctl <device> create <level> <component1> <component2> ...

For example,

 raidctl raid0 create mirror absent /dev/wd1e

will create a RAID level 1 (mirror) set with an absent first component
and /dev/wd1e as the second component. The resulting RAID device will
be marked as auto-configurable, will have a serial number set (based
on the current time), and parity will be initialized. Reasonable
performance values are automatically used by default for other parameters
normally specified in the configuration file.

Also: Only print out Autoconfig status if being verbose.

Pull up following revision(s) (requested by oster in ticket #674):

	sys/dev/raidframe/rf_raid.h: revision 1.52
	sbin/raidctl/raidctl.8: revision 1.80
	sys/dev/raidframe/rf_driver.c: revision 1.141
	sys/dev/raidframe/rf_disks.c: revision 1.94
	sys/dev/raidframe/rf_diskqueue.c: revision 1.64
	sys/dev/raidframe/rf_diskqueue.h: revision 1.30
	sys/dev/raidframe/rf_disks.h: revision 1.15
	sys/dev/raidframe/rf_netbsdkintf.c: revision 1.414
	sys/dev/raidframe/rf_reconstruct.c: revision 1.129
	sys/dev/raidframe/raidframeio.h: revision 1.12
	sbin/raidctl/raidctl.c: revision 1.79

Implement hot removal of spares and components. From manu@.

Implement a long desired feature of automatically incorporating
a used spare into the array after a reconstruct.

Given the configuration:

Components:
 /dev/wd0e: failed
 /dev/wd1e: optimal
 /dev/wd2e: optimal
Spares:
 /dev/wd3e: spare

Running 'raidctl -F /dev/wd0e raid0' will now result in the
following configuration after a successful rebuild:

Components:
 /dev/wd3e: optimal
 /dev/wd1e: optimal
 /dev/wd2e: optimal
No spares.

Thanks to manu@ for the development of the initial set of changes
which allowed the changes to automatically incorporate a used spare
to come to fruition. Thanks also to manu@ for useful discussions
about and additional testing of these changes.

We no longer need the deprecated copyback functionality now that
incorporating a used spare is automatic.

Copyback has always been an issue, as to do a copyback all IO to
the array had to be suspended, and so was very, very unlikely to
have been used in anything resembling a production system.

Implement command-line configuration of simple RAID sets with raidctl
based on the usage pattern:

    raidctl <device> create <level> <component1> <component2> ...

For example,

    raidctl raid0 create mirror absent /dev/wd1e

will create a RAID level 1 (mirror) set with an absent first component
and /dev/wd1e as the second component.  The resulting RAID device will
be marked as auto-configurable, will have a serial number set (based
on the current time), and parity will be initialized.  Reasonable
performance values are automatically used by default for other parameters
normally specified in the configuration file.

Also: Only print out Autoconfig status if being verbose.

Implement hot removal of spares and components.  From manu@.

Implement a long desired feature of automatically incorporating
a used spare into the array after a reconstruct.

Given the configuration:
Components:
           /dev/wd0e: failed
           /dev/wd1e: optimal
           /dev/wd2e: optimal
Spares:
           /dev/wd3e: spare

Running 'raidctl -F /dev/wd0e raid0' will now result in the
following configuration after a successful rebuild:
Components:
           /dev/wd3e: optimal
           /dev/wd1e: optimal
           /dev/wd2e: optimal
No spares.

Thanks to manu@ for the development of the initial set of changes
which allowed the changes to automatically incorporate a used spare
to come to fruition.  Thanks also to manu@ for useful discussions
about and additional testing of these changes.

Implement "raidctl -t config-file"

This does the same config file parse  that -c/-C do, but only
that (hence no raidframe device is needed, or accepted).

Any syntax errors in the config file will be reported, nothing
else happens.

Support on-demand re-scanning all devices to look for
autoconfig RAID sets.  raidctl now supports looking
for autoconfig RAID sets with a new '-L' flag.

sync with head

Avoid using Pq.

In this case, the parentheses were wrong when a line was extended.

move the basic history i wrote from raidctl(8) to raid(4), and
fix the x86 (thanks simonb) and sparc bootable dates, a couple
of spelling errors.

update the list of platforms supporting loading kernels from raid.
expand the HISTORY section to include notable RF moments in netbsd.
bump date.

Pull up following revision(s) (requested by nakayama in ticket #1019):

	sbin/raidctl/rf_configure.h: revision 1.2
	sbin/raidctl/rf_configure.c: revision 1.27
	sbin/raidctl/rf_configure.c: revision 1.28
	sbin/raidctl/rf_configure.c: revision 1.29
	sbin/raidctl/raidctl.8: revision 1.73
	sbin/raidctl/rf_configure.c: revision 1.30
	sbin/raidctl/rf_configure.c: revision 1.31
	sbin/raidctl/rf_configure.c: revision 1.32

support NAME=<wedge name> syntax for disks and spares

 -

stop using magic constants
wrap long lines
use warn{,x}
make static
knf

 -

White space and comment formatting.   NFC.

 -

With char bug[SIZE]  using sizeof(bug[0]) is kind of boring, use
sizeof(bug) instead...

 -

Avoid needless pointer calisthenics: &foo[0] -> foo

 -

Several more cleanups:
1. Don't force use of "for" when "while" works better.
2. No need to check c != '\0' when we also check (c == ' ' || c == '\t')
3. Use the size of the buffer we're using, rather than a different one
   (not really a concern, they're the same size)
4. Don't use fscanf() to read file data, use fgets() & sscanf().
5. After using a pointer as a char *, validate alignment before switching
   to int * (can only fail if kernel #define gets set stupidly)   Or #6...
6. Validate sparemap file name isn't too long for assigned space.
7. recognise that strlen() returns size_t - don't shove it into an int.
8. On out of mem, be more clear which allocation failed in warning msg.

ATF tests all pass.   But I don't think they use sparemap files.

implement 32-bit compat support for raidframe.

convert several raidframe ioctls to be bitsize idempotent so that
they work the same in 32 and 64 bit worlds, allowing netbsd32 to
configure and query raid properly.  remove useless 'row' in a few
places.  add COMPAT_80 and put the old ioctls there.

raidframeio.h:
  RAIDFRAME_TEST_ACC
  - remove, unused
  RAIDFRAME_GET_COMPONENT_LABEL
  - convert to label not pointer to label
  RAIDFRAME_CHECK_RECON_STATUS_EXT
  RAIDFRAME_CHECK_PARITYREWRITE_STATUS_EXT
  RAIDFRAME_CHECK_COPYBACK_STATUS_EXT
  - convert to progress info not pointer to info
  RAIDFRAME_GET_INFO
  - version entirely.
raidframevar.h:
  - rf_recon_req{} has row, flags and raidPtr removed (they're
    not a useful part of this interface.)
  - RF_Config_s{} and RF_DeviceConfig_s{} have numRow/rows removed.
  - RF_RaidDisk_s{} is re-ordered slightly to fix alignment
    padding - the actual data was already OK.
  - InstallSpareTable() loses row argument

rf_compat32.c has code for RF_Config_s{} in 32 bit mode, used
by RAIDFRAME_CONFIGURE and RAIDFRAME_GET_INFO32.

rf_compat80.c has code for rf_recon_req{}, RF_RaidDisk_s{} and
RF_DeviceConfig_s{} to handle RAIDFRAME_FAIL_DISK,
RAIDFRAME_GET_COMPONENT_LABEL, RAIDFRAME_CHECK_RECON_STATUS_EXT,
RAIDFRAME_CHECK_PARITYREWRITE_STATUS_EXT,
RAIDFRAME_CHECK_COPYBACK_STATUS_EXT, RAIDFRAME_GET_INFO.

move several of the per-ioctl code blocks into separate functions.

add rf_recon_req_internal{} to replace old usage of global
rf_recon_req{} that had unused void * in the structure, ruining
it's 32/64 bit ABI.

add missing case for RAIDFRAME_GET_INFO50.

adjust raid tests to use the new .conf format, and add a case to
test the old method as well.

raidctl:
deal with lack of 'row' members in a couple of places.
fail request no longer takes row.
handle "START array" sections with just "numCol numSpare", ie
no "numRow" specified.  for now, generate old-style configuration
but update raidctl.8 to specify the new style (keeping reference
to the old style.)

note that: RF_ComponentLabel_s::{row,num_rows} and
RF_SingleComponent_s::row are obsolete but not removed yet.

support NAME=<wedge name> syntax for disks and spares

Pull up following revision(s) (requested by christos in ticket #1457):
	sbin/raidctl/raidctl.c: revision 1.64
	sbin/raidctl/raidctl.8: revision 1.70
	sys/dev/raidframe/rf_netbsdkintf.c: revision 1.341
	sys/dev/raidframe/raidframeio.h: revision 1.7
Add a SET_LAST_UNIT ioctl.
Access to the SET_LAST_UNIT ioctl.

Remove workaround for ancient HTML generation code.

Use standard sort order for options.

Add -U to usage.

Access to the SET_LAST_UNIT ioctl.

Pull up following revision(s) (requested by sborrill in ticket #863):
	sbin/raidctl/raidctl.8: revisions 1.68, 1.69
Clarify that what was previously known as -A root is now -A forceroot, not
-A softroot and that -A root can still be used for historical reasons.
--
Bump date for previous. Add whitespace.
Fix some mandoc warnings.

Bump date for previous. Add whitespace.
Fix some mandoc warnings.

Clarify that what was previously known as -A root is now -A forceroot, not
-A softroot and that -A root can still be used for historical reasons.

Rebase to HEAD as of a few days ago.

sync with head.

for a reference, the tree before this commit was tagged
as yamt-pagecache-tag8.

this commit was splitted into small chunks to avoid
a limitation of cvs.  ("Protocol error: too many arguments")

Add the ability to "softroot" mount (i.e. mount root only when the raid
set contains the boot device), as opposed to "hardroot" (the previous
default which forces the raid to be root no matter what).

Belatedly note root on RAIDframe support for sandpoint.

Pull up following revision(s) (requested by tron in ticket #1879):
	sbin/raidctl/raidctl.8: revision 1.65
Note that NetBSD/amd64 can boot off RAID volumes.

Pull up following revision(s) (requested by tron in ticket #1879):
	sbin/raidctl/raidctl.8: revision 1.65
Note that NetBSD/amd64 can boot off RAID volumes.

Pull up following revision(s) (requested by tron in ticket #1879):
	sbin/raidctl/raidctl.8: revision 1.65
Note that NetBSD/amd64 can boot off RAID volumes.

Pull up following revision(s) (requested by tron in ticket #948):
	sbin/raidctl/raidctl.8: revision 1.65
Note that NetBSD/amd64 can boot off RAID volumes.

Pull up following revision(s) (requested by tron in ticket #948):
	sbin/raidctl/raidctl.8: revision 1.65
Note that NetBSD/amd64 can boot off RAID volumes.

Pull up following revision(s) (requested by tron in ticket #948):
	sbin/raidctl/raidctl.8: revision 1.65
Note that NetBSD/amd64 can boot off RAID volumes.

Note that NetBSD/amd64 can boot of RAID volumes.

sync with head

Remove unexpected newline between Em macro and text.

New sentence, new line.

Document the need for zeroing out the first 64 blocks of a replacement
component in a failed RAID set in order to avoid potentially configuring
RAId 1 sets with erroneous values taken from random extent data in the
replacement component partitions.

sync to netbsd-5

+ Fatal errors due to uninitialized components are ignored.
for -C. For dillo@

Consistently use "START disks" in examples. Bump date.

Pull up following revision(s) (requested by tron in ticket #1187):
	sbin/raidctl/raidctl.8: revisions 1.57-1.59 via patch
	sbin/raidctl/raidctl.c: revision 1.42 via patch
	sys/dev/raidframe/files.raidframe: revision 1.8 via patch
	sys/dev/raidframe/rf_copyback.c: revision 1.42 via patch
	sys/dev/raidframe/rf_disks.c: revision 1.72 via patch
	sys/dev/raidframe/rf_driver.c: revision 1.122 via patch
	sys/dev/raidframe/rf_engine.c: revision 1.40 via patch
	sys/dev/raidframe/rf_kintf.h: revision 1.21 via patch
	sys/dev/raidframe/rf_netbsdkintf.c: revision 1.269 via patch
	sys/dev/raidframe/rf_paritymap.c: revisions 1.1-1.3 via patch
	sys/dev/raidframe/rf_paritymap.h: revision 1.1 via patch
	sys/dev/raidframe/rf_parityscan.c: revision 1.33 via patch
	sys/dev/raidframe/rf_parityscan.h: revision 1.8 via patch
	sys/dev/raidframe/rf_raid.h: revision 1.38 via patch
	sys/dev/raidframe/rf_reconstruct.c: revision 1.108 via patch
	sys/dev/raidframe/rf_states.c: revision 1.44 via patch
	sys/dev/raidframe/raidframeio.h: revision 1.6 via patch
	sys/dev/raidframe/raidframevar.h: revision 1.13 via patch
Pull up the RAIDframe parity map Summer Of Code project.
Drastically reduces the amount of time spent rewriting parity after an
unclean shutdown by keeping better track of which regions might have had
outstanding writes.  Enabled by default; can be disabled on a per-set
basis, or tuned, with the new raidctl(8) commands.

Remove trailing whitespace.

Bump date; also fix typo pointed out by snj@.

Finally commit the RAIDframe parity map Summer Of Code project.

Drastically reduces the amount of time spent rewriting parity after an
unclean shutdown by keeping better track of which regions might have had
outstanding writes.  Enabled by default; can be disabled on a per-set
basis, or tuned, with the new raidctl(8) commands.

Discussed on tech-kern@ to a general air of approval; exhortations to
commit from mrg@, christos@, and others.

Thanks to Google for their sponsorship, oster@ for mentoring the
project, assorted developers for trying very hard to break it, and
probably more I'm forgetting.

Sync with HEAD.

Sync with wrstuden-revivesa-base-2.

Drop trailing whitespace.

Bump date (before wizd).

Add description of some of the things 'raidctl -u' doesn't do.

We have the notion of an 'absent' disk, so use that in another example.

Sync with HEAD.

sync with head.

Move TNF licenses to 2 clause form

sync with HEAD

Sync with HEAD.

Fix a minor typo:  wd0h was repeated, change second instance to wd1h as is likely intended.

Talk a bit more about how the size of a RAID set is determined, and
of RF_PROTECTED_SECTORS.  Requested by (and with comments from and
thanks to) Christoph (bad@).

file raidctl.8 was added on branch matt-mips64 on 2007-08-06 19:44:17 +0000

Talk a bit more about how the size of a RAID set is determined, and
of RF_PROTECTED_SECTORS.  Requested by (and with comments from and
thanks to) Christoph (bad@).

Pull up revision 1.41-1.42, 1.44-1.46 (requested by fredb in ticket #1151):
Sync raidctl(8) with raid(4) regarding booting from RAID 1.

Bump date for previous.

Add a few more lines about the 'Parity status:' output of 'raidctl -s'.
This should address PR#29540.

Give Dd the full month names as argument.

Greg Oster just reminded me, I left out "vax".

Sync with raid(4) regarding the architectures that support booting directly
from RAID 1, using language supplied by Anders Dinson in PR bin/29158, with
some additions by myself.

Use Dq instead of quotes; bump date for previous.

Pull up revision 1.43 (requested by oster in ticket #378):
Update docs to reflect the support for the word "absent" in the "disks"
section of RAID config files.

Update docs to reflect the support for the word "absent" in the "disks"
section of RAID config files.

Add commas in enumeration; bump date for previous.

Add i386 to the list of systems that support booting from raid1.
RAID(4) also needs changing - if someone knows where the source is....

Pull up revisions 1.39-1.40 (requested by oster in ticket #130):

Swapping to RAID 5 is happy now.  Remove indications to the contrary.

Bump date for last.

Swapping to RAID 5 is happy now.  Remove indications to the contrary.

Pullup patch (requested by oster in ticket #1555)

Add a couple little warnings about swapping to RAID 5 sets.

Note in the description of hot-adding components that a component label is
not required for the component.  Thanks to David Maxwell for the
documentation suggestion.

Bump date for previous.

Add a couple little warnings about swapping to RAID 5 sets.
(it currently doesn't work.)

.Nm does not need a dummy argument ("") before punctuation or
for correct formatting of the SYNOPSIS any longer.

Remove trailing space.

Catch up on some documentation stuff:
- add a note about adding 'swapoff=YES' to /etc/rc.conf
- add a note about not using raid0[cd] for a filesystem.
- filesystems -> file systems

Use more markup.

New sentence, new line. By Robert Elz with minimal fixes.

Remove duplicate 'to'. From Ryo HAYASAKA in bin/17562.

Generate <>& symbolically. I'm avoiding .../dist/... directories for now.

Drop trailing whitespace.

Add a description of how to possibly recover a RAID set in the
event of a multiple disk failure.

Don't abuse -unfilled for -literal; sort sections, sort SEE ALSO, drop
lots of unnecessary .Pps.

Whitespace nits

* add -G, which lists the configuration of the given raid set in the
  same configuration format that -c and -C use.
  this is useful if you're using autoconfig and you've misplaced the
  /etc/raidXXX.conf files
* "filesystem" -> "file system", and other man page cleanups.

Drop arguments of .Os.

Pullup 1.22 [oster]:
- cleanup wording and add additional comments on such things as
    "component1" and "raidctl -A yes"
- add a note about how to build a RAID set with a limited number of disks
    (thanks to Simon Burge for suggestions)
- improve layout of 'raidctl -i' discussion (thanks to Hubert Feyrer)
- add a (small) section on Performance Tuning

- cleanup wording and add additional comments on such things as
    "component1" and "raidctl -A yes"
- add a note about how to build a RAID set with a limited number of disks
    (thanks to Simon Burge for suggestions)
- improve layout of 'raidctl -i' discussion (thanks to Hubert Feyrer)
- add a (small) section on Performance Tuning

Pullup of 1.20->1.21  (approved by thorpej)
Clarify a few things about parity.  Add more documentation about RAID on RAID,
and root on RAID.

Clarify a few things about parity.  Add more documentation about RAID on RAID,
and root on RAID.

Add a .Sq for single quotes, instead of doing it by hand.
Fixes a formatting problem.

Approved by: thorpej

Add a .Sq for single quotes, instead of doing it by hand.
Fixes a formatting problem noted by Hubert Feyrer (Thanks Hubert!).

Sync w/ netbsd-1-5-base.

Slight wording improvement on the 'raidctl -R' case.

Fix up some single quotes that messed up a line.  (Thanks Wiz!)

Update for 'options RAID_AUTOCONFIG'.

Add a few more examples, and a summary.

More updates, spelling fixes, etc.

First revamp of the docs.  This is still work-in-progress.  More to come
shortly.

Document the new autoconfiguration switches, and update the Usage: line.
More doc changes expected soon.

it's -> its

- add '-v' (Verbose) option, which, most notably, provides
a spiffy lukemftp-inspired progress bar for parity re-writing,
reconstructs, copybacks, et al.

- make 'raidctl -P' wait until the parity has been updated before exiting
(it waited previously, but only because the parity re-write ioctl wouldn't
exit until the parity was successfully re-written)

Pull up to last week's -current.

Typos (from OpenBSD)

Add two more options to raidctl:
  -p    check (and return) the status of the parity
  -P    check the status of the parity, and rebuild if necessary

Addresses PR#7494

Remove blank lines.

Fix minor formatting error.

Fix minor formatting error.

Update for recent changes: component labels, clean bits, adding hot
spares, and rebuilding components in-place.  Re-arrange the
letters/options to make more sense (and make better use of the alphabet).

fix typo

Add missing NetBSD RCS ID's!  Thanks to SAITOH Masanobu (msaitoh@netbsd.org)
for pointing this out.

Fix tpyo.

Oops. Forgot the man-page for 'raidctl' when the rest of 'raidctl' went in.