[thirdparty/mdadm.git] / ChangeLog

Changes Prior to this release
    -   Fix another bug in Assemble.c due to confusing 'i' with 'j'
    -   Minimal, untested, support for multipath
    -   re-write of argument parsing to have more coherent modes,
    -   add --query,-Q option
    -   Update mdadm.8 to reflect arg processing change and --query
    -   Change "long" to "unsigned long" for device sizes
    -   Handle "mailaddr" and "program" lines in config file for follow/scan mode.
    -   --follow --scan will exit if no program or mail found
    -   Add MAILADDR and PROGRAM to mdadm.conf-example
    -   Spell check man pages
    -   consistently use "component devices" instead of "subdevices"
    -   Make -Wall -Werror really work and fix lots of errors.
    -   --detail and --stop can have --scan which chooses devices from /proc/mdstat
    -   --monitor detects 20% changes in resync, failed spares,
        disappearing arrays,
    -   --monitor --scan will automatically add any devices found in /proc/mdstat
    -   --monitor will move spares between arrays with same spare-group if necessary
    -   Documentation for Monitor Mode
    -   --query notes if the array containing the given device is active or not
    -   Finished md.4 man page.
	
Changes Prior to 0.7.2 release
    -   mdadm.spec updates and ifdef BLKGETSIZE64 from  Luca Berra -- bluca@comedia.it
    -   more mdadm.spec updates from  Gregory Leblanc <gleblanc@linuxweasel.com>
    -   make directory for mdadm.conf configurable in Makefile
    -   Finished mdadm.conf.5.  Removed details of conf file from
	mdadm.8 leaving a reference to mdadm.conf.5.
    -   Fix bug in Assemble.c, thanks to Junaid Rizvi <domdev@sat.net.pk>
    -   Get --assemble --force to make sure old major/minor numbers are
        consistant, as md.c worries about this :-(
	
	
Changes Prior to 0.7.1 release
    -   update mdadm.spec
    -   use BLKGETSIZE64 if available for array size
    -   give human readable as GiB/MiB and GB and MB, with 2 decimal point precision
    -   Only warn about size variation for raid1/4/5.
    -   Started md.4 man page
    -   Started mdadm.conf.5 man page
	
Changes Prior to 0.7 release	

    -   Fix makefile to install binary at /sbin and not /sbin/sbin
	Also install man page.
    -   Add --zero-superblock based on --destroywithextremeprejudice
	from Dale Stephenson <steph@snapserver.com>
    -   change name to mdadm.  It is palandromic, and much nicer to pronouce.
	
Changes Prior to 0.6 release

    -   Remove the limit on the number of device names that can be
	given on the command line.
    -   Fix bug in --assemble --force where it would only update a 
	single superblock.
    -   Fix bogus printing of big numbers not being block devices
	when given names of devices that don't exist.
    -   When --assemble --force, consider superblocks with an event
	count that is 1 behind as out-of-date.  Normally they are
	considered up-to-date (as the kernel assumes this too).
    -   When marking drives as not-failed in the superblock, 
	we also mark them as ACTIVE and SYNC.
    -   Don't start arrays for which not all drives are available unless:
	 --scan   which implies that all drives were found automatically
	 --run    which means the user knows what they want
	 --force  which means that we are fixing something broken
    -   Make sure all device numbers passed as 3rd arg of ioctl
	are passed as unsigned lock, so that it works on SPARC
    -   If HOT_ADD_DISK failes for -a, then only try ADD_NEW_DISK
	if we cannot read from the array, i.e. if the array is
	not started yet.
    -   man page update
    -   Taught Examine to handle --scan. It examines all devices listed
	on DEVICE lines in the config file.  
    -   Added --brief (-b) flag for Examine and Detail to print out
	and mdctl.conf compatible description with uuid=, level=,
	disks= and  - for Examine - devices=
	--examine --brief collects all devices the make the one array and 
	list them as one entry.
    -   Added level= and disks= options to ARRAY lines in config files
	so --brief output could be used as-is.
    -   Make parity style ({left,right}-{,a}symmetric) consistantly use -,
	never _.
    -   Add "Array Size" to --detail output
    -   Change "Size" to "Device Size" and exclude from Detail of arrays
	that do not have a consistent device size.
    -   Add Human readable MiB or GiB value on size lines of Detail and Examine
    -   --assemble --scan  doesn't complain about active drives
    -   require number of spares given in -x to be listed.
    -   Made --build actually work.
Changes Prior to 0.5 release

  --assemble:
     spare drives are handled properly.

     --force can be used to recover from 2-drive failures on RAID5
     If you belive that /dev/hda1 /dev/hdb1 /dev/hdc1 /dev/hdd1 should
     make a raid5 array, but it has experienced multiple failures and
     wont start, then

       mdctl --assemble --force /dev/md0 /dev/hd[abcd]1

     Should update the superblock on the newest failed drive and
     restart the array in degraded mode.  You should then remove the
     remaining failed drive and re-add it (if you are happy that it
     might work).

     Ofcourse whenever you have a 2-drive failure, you have a risk
     of corruption in data that hasn't be changed for a long time.  So
     this doesn't give you your array back all nice and happy, but it
     does allow you to recover data that might not be corrupt.

     More flexibility in identifying a RAID array in the mdctl.conf
     e.g.
         array /dev/md4  super-minor=4

      assembles /dev/md4 from all devices found that have a raid
      superblock that says the minor number of the array is 4.
      If the blocks with the right minor number do not all have the
      same UUID, an error is flags and no assembly happens.
 
        array /dev/md3  devices=/dev/hd[abc]2

      Assembles /dev/md3 drom /dev/hda2 /dev/hdb2 and/dev/hdc2.  All
      devices must exist and have raid superblock with the same uuid.

      If two identity specifiers are used, only devices that match all
      of them are considered, so

        array /dev/md2 devices=/dev/hd?2 super-minor=2

      will assemble /dev/md2 using all /dev/hd?2 devices which have a 
      raid superblock with minor number 2.
 
  --create:
      When listing devices for --create, the word "missing" can be
      used to indicate that the respective slot does not have a
      working drive currently.  This is similar to the "failed-disk"
      directive in mkraid/raidtab.
      e.g.
         mdctl --create --level=5 -raid-disks=4 --spare-disks=2
                 /dev/md0 /dev/sda /dev/sdb missing /dev/sdc /dev/sdd  /dev/sde

      will create a raid5 array with the third slot empty, and two
      spares.

      By default, raid5 arrays are created with the last slot empty
      and drive listed for the last slot added as a spare.  If a
      "missing" slot is given, or if --force is given, then --create
      does exactly what you ask and doesn't try to be clever.
   

   --follow / --monitor:

      This is a new mode.  I couldn't stop my self from picking a name
      starting with F (as current modes start A,B,C,D,E) but I
      relented and provided an alternate name that is somewhat more
      meaningful. 
 
      In this mode, mdctl does not exit, but runs continuously and
      periodically polls all the md devices to see if they have had
      any interested state change.
      The changes that it currently notices are:
           Fail      -  an active disc fails
           FailSpare -  a spare, that was presumably being build, fails
           ActiveSpare - a spare becomes active, presumably after a rebuild.

      Options:
         --mail mailaddress  - send Email on any Fail* event
         --program program   - run the program on any event.  
		   Args are: eventname mddevice subdevice(if-known)
         --delay  seconds    - change from the default 60second pause
			       between polls.

      I plan to add functionality to this mode to allow sharing of
      spare drives. If an array is marks "spare-group=fred", and it
      has a failed drive and no spares, and if some other array is
      also "spare-group=fred" and it has no failed drives, but does
      have a spare drive that is big enough, the spare will be moved
      to the first array.

  I also have the idea of adding a --grow mode which will re-organise
  the data on an N disk raid0/4/5 array to be on an N+M disk array.
  I have no concrete plans for this though.

  I got rid of the "v" in the archive file name, and include the
  version number in the directory created by the archive.

  There is now a man page and mdctl.spec (for rpm) thanks to
  Danilo Godec <danci@agenda.si>.
  
  Ofcourse, the man page is now out of date and despite being based on
  the --help output, is not wholy correct.  After I get --follow
  working properly, I plan to revise the various documentation and/or
  the code to make sure the two match.
Commit	Line	Data
11a3e71d	1	Changes Prior to this release
e0d19036 NB	2	- Fix another bug in Assemble.c due to confusing 'i' with 'j'
	3	- Minimal, untested, support for multipath
	4	- re-write of argument parsing to have more coherent modes,
	5	- add --query,-Q option
	6	- Update mdadm.8 to reflect arg processing change and --query
	7	- Change "long" to "unsigned long" for device sizes
	8	- Handle "mailaddr" and "program" lines in config file for follow/scan mode.
	9	- --follow --scan will exit if no program or mail found
	10	- Add MAILADDR and PROGRAM to mdadm.conf-example
	11	- Spell check man pages
	12	- consistently use "component devices" instead of "subdevices"
	13	- Make -Wall -Werror really work and fix lots of errors.
	14	- --detail and --stop can have --scan which chooses devices from /proc/mdstat
	15	- --monitor detects 20% changes in resync, failed spares,
	16	disappearing arrays,
	17	- --monitor --scan will automatically add any devices found in /proc/mdstat
	18	- --monitor will move spares between arrays with same spare-group if necessary
	19	- Documentation for Monitor Mode
	20	- --query notes if the array containing the given device is active or not
	21	- Finished md.4 man page.
	22
	23	Changes Prior to 0.7.2 release
11a3e71d NB	24	- mdadm.spec updates and ifdef BLKGETSIZE64 from Luca Berra -- bluca@comedia.it
	25	- more mdadm.spec updates from Gregory Leblanc <gleblanc@linuxweasel.com>
	26	- make directory for mdadm.conf configurable in Makefile
	27	- Finished mdadm.conf.5. Removed details of conf file from
	28	mdadm.8 leaving a reference to mdadm.conf.5.
	29	- Fix bug in Assemble.c, thanks to Junaid Rizvi <domdev@sat.net.pk>
	30	- Get --assemble --force to make sure old major/minor numbers are
	31	consistant, as md.c worries about this :-(
	32
	33
	34	Changes Prior to 0.7.1 release
56eb10c0 NB	35	- update mdadm.spec
	36	- use BLKGETSIZE64 if available for array size
	37	- give human readable as GiB/MiB and GB and MB, with 2 decimal point precision
	38	- Only warn about size variation for raid1/4/5.
	39	- Started md.4 man page
	40	- Started mdadm.conf.5 man page
	41
9a9dab36 NB	42	Changes Prior to 0.7 release
	43
	44	- Fix makefile to install binary at /sbin and not /sbin/sbin
	45	Also install man page.
	46	- Add --zero-superblock based on --destroywithextremeprejudice
	47	from Dale Stephenson <steph@snapserver.com>
	48	- change name to mdadm. It is palandromic, and much nicer to pronouce.
	49
cd29a5c8 NB	50	Changes Prior to 0.6 release
cd29a5c8 NB	51
9a9dab36	52	- Remove the limit on the number of device names that can be
cd29a5c8 NB	53	given on the command line.
	54	- Fix bug in --assemble --force where it would only update a
	55	single superblock.
	56	- Fix bogus printing of big numbers not being block devices
	57	when given names of devices that don't exist.
	58	- When --assemble --force, consider superblocks with an event
	59	count that is 1 behind as out-of-date. Normally they are
	60	considered up-to-date (as the kernel assumes this too).
	61	- When marking drives as not-failed in the superblock,
	62	we also mark them as ACTIVE and SYNC.
	63	- Don't start arrays for which not all drives are available unless:
	64	--scan which implies that all drives were found automatically
	65	--run which means the user knows what they want
	66	--force which means that we are fixing something broken
	67	- Make sure all device numbers passed as 3rd arg of ioctl
	68	are passed as unsigned lock, so that it works on SPARC
	69	- If HOT_ADD_DISK failes for -a, then only try ADD_NEW_DISK
	70	if we cannot read from the array, i.e. if the array is
	71	not started yet.
	72	- man page update
	73	- Taught Examine to handle --scan. It examines all devices listed
	74	on DEVICE lines in the config file.
	75	- Added --brief (-b) flag for Examine and Detail to print out
	76	and mdctl.conf compatible description with uuid=, level=,
	77	disks= and - for Examine - devices=
	78	--examine --brief collects all devices the make the one array and
	79	list them as one entry.
	80	- Added level= and disks= options to ARRAY lines in config files
	81	so --brief output could be used as-is.
	82	- Make parity style ({left,right}-{,a}symmetric) consistantly use -,
	83	never _.
	84	- Add "Array Size" to --detail output
	85	- Change "Size" to "Device Size" and exclude from Detail of arrays
	86	that do not have a consistent device size.
	87	- Add Human readable MiB or GiB value on size lines of Detail and Examine
	88	- --assemble --scan doesn't complain about active drives
	89	- require number of spares given in -x to be listed.
	90	- Made --build actually work.
	91	Changes Prior to 0.5 release
	92
	93	--assemble:
	94	spare drives are handled properly.
	95
	96	--force can be used to recover from 2-drive failures on RAID5
	97	If you belive that /dev/hda1 /dev/hdb1 /dev/hdc1 /dev/hdd1 should
	98	make a raid5 array, but it has experienced multiple failures and
	99	wont start, then
	100
	101	mdctl --assemble --force /dev/md0 /dev/hd[abcd]1
	102
	103	Should update the superblock on the newest failed drive and
	104	restart the array in degraded mode. You should then remove the
	105	remaining failed drive and re-add it (if you are happy that it
	106	might work).
	107
	108	Ofcourse whenever you have a 2-drive failure, you have a risk
	109	of corruption in data that hasn't be changed for a long time. So
	110	this doesn't give you your array back all nice and happy, but it
	111	does allow you to recover data that might not be corrupt.
	112
	113	More flexibility in identifying a RAID array in the mdctl.conf
	114	e.g.
	115	array /dev/md4 super-minor=4
	116
117	assembles /dev/md4 from all devices found that have a raid
118	superblock that says the minor number of the array is 4.
119	If the blocks with the right minor number do not all have the
120	same UUID, an error is flags and no assembly happens.
121
122	array /dev/md3 devices=/dev/hd[abc]2
123
124	Assembles /dev/md3 drom /dev/hda2 /dev/hdb2 and/dev/hdc2. All
125	devices must exist and have raid superblock with the same uuid.
126
127	If two identity specifiers are used, only devices that match all
128	of them are considered, so
129
130	array /dev/md2 devices=/dev/hd?2 super-minor=2
131
132	will assemble /dev/md2 using all /dev/hd?2 devices which have a
133	raid superblock with minor number 2.
134
135	--create:
136	When listing devices for --create, the word "missing" can be
137	used to indicate that the respective slot does not have a
138	working drive currently. This is similar to the "failed-disk"
139	directive in mkraid/raidtab.
140	e.g.
141	mdctl --create --level=5 -raid-disks=4 --spare-disks=2
142	/dev/md0 /dev/sda /dev/sdb missing /dev/sdc /dev/sdd /dev/sde
143
144	will create a raid5 array with the third slot empty, and two
145	spares.
146
147	By default, raid5 arrays are created with the last slot empty
148	and drive listed for the last slot added as a spare. If a
149	"missing" slot is given, or if --force is given, then --create
150	does exactly what you ask and doesn't try to be clever.
151
152
153	--follow / --monitor:
154
155	This is a new mode. I couldn't stop my self from picking a name
156	starting with F (as current modes start A,B,C,D,E) but I
157	relented and provided an alternate name that is somewhat more
158	meaningful.
159
160	In this mode, mdctl does not exit, but runs continuously and
161	periodically polls all the md devices to see if they have had
162	any interested state change.
163	The changes that it currently notices are:
164	Fail - an active disc fails
165	FailSpare - a spare, that was presumably being build, fails
166	ActiveSpare - a spare becomes active, presumably after a rebuild.
167
168	Options:
169	--mail mailaddress - send Email on any Fail* event
170	--program program - run the program on any event.
171	Args are: eventname mddevice subdevice(if-known)
172	--delay seconds - change from the default 60second pause
173	between polls.
174
175	I plan to add functionality to this mode to allow sharing of
176	spare drives. If an array is marks "spare-group=fred", and it
177	has a failed drive and no spares, and if some other array is
178	also "spare-group=fred" and it has no failed drives, but does
179	have a spare drive that is big enough, the spare will be moved
180	to the first array.
181
182	I also have the idea of adding a --grow mode which will re-organise
183	the data on an N disk raid0/4/5 array to be on an N+M disk array.
184	I have no concrete plans for this though.
185
186	I got rid of the "v" in the archive file name, and include the
187	version number in the directory created by the archive.
188
189	There is now a man page and mdctl.spec (for rpm) thanks to
190	Danilo Godec <danci@agenda.si>.
191
192	Ofcourse, the man page is now out of date and despite being based on
193	the --help output, is not wholy correct. After I get --follow
194	working properly, I plan to revise the various documentation and/or
195	the code to make sure the two match.
196