mdadm-0.8
[thirdparty/mdadm.git] / ReadMe.c
1 /*
2  * mdadm - manage Linux "md" devices aka RAID arrays.
3  *
4  * Copyright (C) 2001-2002 Neil Brown <neilb@cse.unsw.edu.au>
5  *
6  *
7  *    This program is free software; you can redistribute it and/or modify
8  *    it under the terms of the GNU General Public License as published by
9  *    the Free Software Foundation; either version 2 of the License, or
10  *    (at your option) any later version.
11  *
12  *    This program is distributed in the hope that it will be useful,
13  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *    GNU General Public License for more details.
16  *
17  *    You should have received a copy of the GNU General Public License
18  *    along with this program; if not, write to the Free Software
19  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  *
21  *    Author: Neil Brown
22  *    Email: <neilb@cse.unsw.edu.au>
23  *    Paper: Neil Brown
24  *           School of Computer Science and Engineering
25  *           The University of New South Wales
26  *           Sydney, 2052
27  *           Australia
28  */
29
30 #include "mdadm.h"
31
32 char Version[] = Name " - v0.8 -  4 April 2002\n";
33 /*
34  * File: ReadMe.c
35  *
36  * This file contains general comments about the implementation
37  * and the various usage messages that can be displayed by mdadm
38  *
39  * mdadm is a single program that can be used to control Linux md devices.
40  * It is intended to provide all the functionality of the mdtools and
41  * raidtools but with a very different interface.
42  * mdadm can perform all functions without a configuration file.
43  * There is the option of using a configuration file, but not in the same
44  * way that raidtools uses one
45  * raidtools uses a configuration file to describe how to create a RAID
46  * array, and also uses this file partially to start a previously
47  * created RAID array.  Further, raidtools requires the configuration
48  * file for such things as stopping a raid array which needs to know
49  * nothing about the array.
50  *
51  * The configuration file that can be used by mdadm lists two
52  * different things:
53  * 1/ a mapping from uuid to md device to identify which arrays are
54  *    expect and what names (numbers) they should be given
55  * 2/ a list of devices that should be scanned for md sub-devices
56  *
57  *
58  */
59
60 /*
61  * mdadm has 6 major modes of operation:
62  * 1/ Create
63  *     This mode is used to create a new array with a superbock
64  *     It can progress in several step create-add-add-run
65  *     or it can all happen with one command
66  * 2/ Assemble
67  *     This mode is used to assemble the parts of a previously created
68  *     array into an active array.  Components can be explicitly given
69  *     or can be searched for.  mdadm (optionally) check that the components
70  *     do form a bonafide array, and can, on request, fiddle superblock
71  *     version numbers so as to assemble a faulty array.
72  * 3/ Build
73  *     This is for building legacy arrays without superblocks
74  * 4/ Manage
75  *     This is for doing something to one or more devices
76  *     in an array, such as add,remove,fail.
77  *     run/stop/readonly/readwrite are also available
78  * 5/ Misc
79  *     This is for doing things to individual devices.
80  *     They might be parts of an array so
81  *       zero-superblock, examine  might be appropriate
82  *     They might be md arrays so
83  *       run,stop,rw,ro,detail  might be appropriate
84  *     Also query will treat it as either
85  * 6/ Monitor
86  *     This mode never exits but just monitors arrays and reports changes.
87  */
88
89 char short_options[]="-ABCDEFGQhVvbc:l:p:m:n:x:u:c:d:z:sarfRSow";
90 struct option long_options[] = {
91     {"manage",    0, 0, '@'},
92     {"misc",      0, 0, '#'},
93     {"assemble",  0, 0, 'A'},
94     {"build",     0, 0, 'B'},
95     {"create",    0, 0, 'C'},
96     {"detail",    0, 0, 'D'},
97     {"examine",   0, 0, 'E'},
98     {"follow",    0, 0, 'F'},
99     {"grow",      0, 0, 'G'}, /* not yet implemented */
100     {"zero-superblock", 0, 0, 'K'}, /* deliberately no a short_option */
101     {"query",     0, 0, 'Q'},
102
103     /* synonyms */
104     {"monitor",   0, 0, 'F'},
105             
106     /* after those will normally come the name of the md device */
107     {"help",      0, 0, 'h'},
108     {"version",   0, 0, 'V'},
109     {"verbose",   0, 0, 'v'},
110
111     /* For create or build: */
112     {"chunk",     1, 0, 'c'},
113     {"rounding",  1, 0, 'c'}, /* for linear, chunk is really a rounding number */
114     {"level",     1, 0, 'l'}, /* 0,1,4,5,linear */
115     {"parity",    1, 0, 'p'}, /* {left,right}-{a,}symetric */
116     {"layout",    1, 0, 'p'},
117     {"raid-disks",1, 0, 'n'},
118     {"spare-disks",1,0, 'x'},
119     {"size"      ,1, 0, 'z'},
120
121     /* For assemble */
122     {"uuid",      1, 0, 'u'},
123     {"super-minor",1,0, 'm'},
124     {"config",    1, 0, 'c'},
125     {"scan",      0, 0, 's'},
126     {"force",     0, 0, 'f'},
127     /* Management */
128     {"add",       0, 0, 'a'},
129     {"remove",    0, 0, 'r'},
130     {"fail",      0, 0, 'f'},
131     {"set-faulty",0, 0, 'f'},
132     {"run",       0, 0, 'R'},
133     {"stop",      0, 0, 'S'},
134     {"readonly",  0, 0, 'o'},
135     {"readwrite", 0, 0, 'w'},
136
137     /* For Detail/Examine */
138     {"brief",     0, 0, 'b'},
139
140     /* For Follow/monitor */
141     {"mail",      1, 0, 'm'},
142     {"program",   1, 0, 'p'},
143     {"alert",     1, 0, 'p'},
144     {"delay",     1, 0, 'd'},
145     
146     
147     {0, 0, 0, 0}
148 };
149
150 char Usage[] =
151 "Usage: mdadm --help\n"
152 "  for help\n"
153 ;
154
155 char Help[] =
156 "Usage: mdadm --create device options...\n"
157 "       mdadm --assemble device options...\n"
158 "       mdadm --build device options...\n"
159 "       mdadm --manage device options...\n"
160 "       mdadm --misc options... devices\n"
161 "       mdadm --monitor options...\n"
162 "       mdadm device options...\n"
163 " mdadm is used for building, manageing, and monitoring\n"
164 "      Linux md devices (aka RAID arrays)\n"
165 " For detail help on the above major modes use --help after the mode\n"
166 " e.g.\n"
167 "         mdadm --assemble --help\n"
168 "\n"
169 "Any parameter that does not start with '-' is treated as a device name\n"
170 "The first such name is often the name of an md device.  Subsequent\n"
171 "names are often names of component devices."
172 "\n"
173 "Some common options are:\n"
174 "  --help        -h   : This help message or, after above option,\n"
175 "                       mode specific help message\n"
176 "  --version     -V   : Print version information for mdadm\n"
177 "  --verbose     -v   : Be more verbose about what is happening\n"
178 "  --brief       -b   : Be less verbose, more brief\n"
179 "  --force       -f   : Override normal checks and be more forceful\n"
180 "\n"
181 "  --assemble    -A   : Assemble an array\n"
182 "  --build       -B   : Build a legacy array\n"
183 "  --create      -C   : Create a new array\n"
184 "  --detail      -D   : Display details of an array\n"
185 "  --examine     -E   : Examine superblock on an array componenet\n"
186 "  --monitor     -F   : monitor (follow) some arrays\n"
187 "  --query       -Q   : Display general information about how a\n"
188 "                       device relates to the md driver\n"
189 ;
190 /*
191 "\n"
192 " For create or build:\n"
193 "  --chunk=      -c   : chunk size of kibibytes\n"
194 "  --rounding=        : rounding factor for linear array (==chunck size)\n"
195 "  --level=      -l   : raid level: 0,1,4,5,linear.  0 or linear for build\n"
196 "  --paritiy=    -p   : raid5 parity algorith: {left,right}-{,a}symmetric\n"
197 "  --layout=          : same as --parity\n"
198 "  --raid-disks= -n   : number of active devices in array\n"
199 "  --spare-disks= -x  : number of spares (eXtras) devices in initial array\n"
200 "  --size=       -z   : Size (in K) of each drive in RAID1/4/5 - optional\n"
201 "  --force       -f   : Honour devices as listed on command line.  Don't\n"
202 "                     : insert a missing drive for RAID5.\n"
203 "\n"
204 " For assemble:\n"
205 "  --uuid=       -u   : uuid of array to assemble. Devices which don't\n"
206 "                       have this uuid are excluded\n"
207 "  --super-minor= -m  : minor number to look for in super-block when\n"
208 "                       choosing devices to use.\n"
209 "  --config=     -c   : config file\n"
210 "  --scan        -s   : scan config file for missing information\n"
211 "  --force       -f   : Assemble the array even if some superblocks appear out-of-date\n"
212 "\n"
213 " For detail or examine:\n"
214 "  --brief       -b   : Just print device name and UUID\n"
215 "\n"
216 " For follow/monitor:\n"
217 "  --mail=       -m   : Address to mail alerts of failure to\n"
218 "  --program=    -p   : Program to run when an event is detected\n"
219 "  --alert=           : same as --program\n"
220 "  --delay=      -d   : seconds of delay between polling state. default=60\n"
221 "\n"
222 " General management:\n"
223 "  --add         -a   : add, or hotadd subsequent devices\n"
224 "  --remove      -r   : remove subsequent devices\n"
225 "  --fail        -f   : mark subsequent devices a faulty\n"
226 "  --set-faulty       : same as --fail\n"
227 "  --run         -R   : start a partially built array\n"
228 "  --stop        -S   : deactive array, releasing all resources\n"
229 "  --readonly    -o   : mark array as readonly\n"
230 "  --readwrite   -w   : mark array as readwrite\n"
231 "  --zero-superblock  : erase the MD superblock from a device.\n"
232 ;
233 */
234
235 char Help_create[] =
236 "Usage:  mdadm --create device -chunk=X --level=Y --raid-disks=Z devices\n"
237 "\n"
238 " This usage will initialise a new md array and associate some\n"
239 " devices with it.  If enough devices are given to complete the array,\n"
240 " the array will be activated.  Otherwise it will be left inactive\n"
241 " to be completed and activated by subsequent management commands.\n"
242 "\n"
243 " As devices are added, they are checked to see if they already contain\n"
244 " raid superblocks or filesystems.  They are also checked to see if\n"
245 " the variance in device size exceeds 1%.\n"
246 " If any discrepancy is found, the array will not automatically\n"
247 " be run, though the presence of a '--run' can override this\n"
248 " caution.\n"
249 "\n"
250 " If the --size option is given then only that many kilobytes of each\n"
251 " device is used, no matter how big each device is.\n"
252 " If no --size is given, the apparent size of the smallest drive given\n"
253 " is used for raid level 1 and greater, and the full device is used for\n"
254 " other levels.\n"
255 "\n"
256 " Options that are valid with --create (-C) are:\n"
257 "  --chunk=      -c   : chunk size of kibibytes\n"
258 "  --rounding=        : rounding factor for linear array (==chunck size)\n"
259 "  --level=      -l   : raid level: 0,1,4,5,linear,multipath and synonyms\n"
260 "  --paritiy=    -p   : raid5 parity algorith: {left,right}-{,a}symmetric\n"
261 "  --layout=          : same as --parity\n"
262 "  --raid-disks= -n   : number of active devices in array\n"
263 "  --spare-disks= -x  : number of spares (eXtras) devices in initial array\n"
264 "  --size=       -z   : Size (in K) of each drive in RAID1/4/5 - optional\n"
265 "  --force       -f   : Honour devices as listed on command line.  Don't\n"
266 "                     : insert a missing drive for RAID5.\n"
267 "   --run             : insist of running the array even if not all\n"
268 "                     : devices are present or some look odd.\n"
269 "   --readonly        : start the array readonly - not supported yet.\n"
270 "\n"
271 ;
272
273 char Help_build[] =
274 "Usage:  mdadm --build device -chunk=X --level=Y --raid-disks=Z devices\n"
275 "\n"
276 " This usage is similar to --create.  The difference is that it creates\n"
277 " a legacy array without a superblock.  With these arrays there is no\n"
278 " different between initially creating the array and subsequently\n"
279 " assembling the array, except that hopefully there is useful data\n"
280 " there in the second case.\n"
281 "\n"
282 " The level may only be 0, raid0, or linear.\n"
283 " All devices must be listed and the array will be started once complete.\n"
284 " Options that are valid with --build (-B) are:\n"
285 "  --chunk=      -c   : chunk size of kibibytes\n"
286 "  --rounding=        : rounding factor for linear array (==chunck size)\n"
287 "  --level=      -l   : 0, raid0, or linear\n"
288 "  --raid-disks= -n   : number of active devices in array\n"
289 ;
290
291 char Help_assemble[] =
292 "Usage: mdadm --assemble device options...\n"
293 "       mdadm --assemble --scan options...\n"
294 "\n"
295 "This usage assembles one or more raid arrays from pre-existing\n"
296 "components.\n"
297 "For each array, mdadm needs to know the md device, the identity of\n"
298 "the array, and a number of sub devices. These can be found in a number\n"
299 "of ways.\n"
300 "\n"
301 "The md device is either given on the command line or is found listed\n"
302 "in the config file.  The array identity is determined either from the\n"
303 "--uuid or --super-minor commandline arguments, from the config file,\n"
304 "or from the first component device on the command line.\n"
305 "\n"
306 "The different combinations of these are as follows:\n"
307 " If the --scan option is not given, then only devices and identities\n"
308 " listed on the command line are considered.\n"
309 " The first device will be the array device, and the remainder will be\n"
310 " examined when looking for components.\n"
311 " If an explicit identity is given with --uuid or --super-minor, then\n"
312 " only devices with a superblock which matches that identity is considered,\n"
313 " otherwise every device listed is considered.\n"
314 "\n"
315 " If the --scan option is given, and no devices are listed, then\n"
316 " every array listed in the config file is considered for assembly.\n"
317 " The identity of candidate devices are determined from the config file.\n"
318 "\n"
319 " If the --scan option is given as well as one or more devices, then\n"
320 " Those devices are md devices that are to be assembled.  Their identity\n"
321 " and components are determined from the config file.\n"
322 "\n"
323 "Options that are valid with --assemble (-A) are:\n"
324 "  --uuid=       -u   : uuid of array to assemble. Devices which don't\n"
325 "                       have this uuid are excluded\n"
326 "  --super-minor= -m  : minor number to look for in super-block when\n"
327 "                       choosing devices to use.\n"
328 "  --config=     -c   : config file\n"
329 "  --scan        -s   : scan config file for missing information\n"
330 "  --run         -R   : Try to start the array even if not enough devices\n"
331 "                       for a full array are present\n"
332 "  --force       -f   : Assemble the array even if some superblocks appear\n"
333 "                     : out-of-date.  This involves modifying the superblocks.\n"
334 ;
335
336 char Help_manage[] =
337 "Usage: mdadm arraydevice options component devices...\n"
338 "\n"
339 "This usage is for managing the component devices within an array.\n"
340 "The --manage option is not needed and is assumed if the first argument\n"
341 "is a device name or a management option.\n"
342 "The first device listed will be taken to be an md array device, and\n"
343 "subsequent devices are (potential) components of that array.\n"
344 "\n"
345 "Options that are valid with management mode are:\n"
346 "  --add         -a   : hotadd subsequent devices to the array\n"
347 "  --remove      -r   : remove subsequent devices, which must not be active\n"
348 "  --fail        -f   : mark subsequent devices a faulty\n"
349 "  --set-faulty       : same as --fail\n"
350 "  --run         -R   : start a partially built array\n"
351 "  --stop        -S   : deactive array, releasing all resources\n"
352 "  --readonly    -o   : mark array as readonly\n"
353 "  --readwrite   -w   : mark array as readwrite\n"
354 ;
355
356 char Help_misc[] =
357 "Usage: mdadm misc_option  devices...\n"
358 "\n"
359 "This usage is for performing some task on one or more devices, which\n"
360 "may be arrays or components, depending on the task.\n"
361 "The --misc option is not needed (though it is allowed) and is assumed\n"
362 "if the first argument in a misc option.\n"
363 "\n"
364 "Options that are valid with the miscellaneous mode are:\n"
365 "  --query       -Q   : Display general information about how a\n"
366 "                       device relates to the md driver\n"
367 "  --detail      -D   : Display details of an array\n"
368 "  --examine     -E   : Examine superblock on an array componenet\n"
369 "  --zero-superblock  : erase the MD superblock from a device.\n"
370 "  --run         -R   : start a partially built array\n"
371 "  --stop        -S   : deactive array, releasing all resources\n"
372 "  --readonly    -o   : mark array as readonly\n"
373 "  --readwrite   -w   : mark array as readwrite\n"
374 ;
375
376 char Help_monitor[] =
377 "Usage: mdadm --monitor options devices\n"
378 "\n"
379 "This usage causes mdadm to monitor a number of md arrays by periodically\n"
380 "polling their status and acting on any changes.\n"
381 "If any devices are listed then those devices are monitored, otherwise\n"
382 "all devices listed in the config file are monitored.\n"
383 "The address for mailing advisories to, and the program to handle\n"
384 "each change can be specified in the config file or on the command line.\n"
385 "If no mail address or program are specified, then mdadm reports all\n"
386 "state changes to stdout.\n"
387 "\n"
388 "Options that are valid with the monitor (--F --follow) mode are:\n"
389 "  --mail=       -m   : Address to mail alerts of failure to\n"
390 "  --program=    -p   : Program to run when an event is detected\n"
391 "  --alert=           : same as --program\n"
392 "  --delay=      -d   : seconds of delay between polling state. default=60\n"
393 "  --config=     -c   : specify a different config file\n"
394 "  --scan        -s   : find mail-address/program in config file\n"
395 ;
396
397
398
399
400 char Help_config[] =
401 "The /etc/mdadm.conf config file:\n\n"
402 " The config file contains, apart from blank lines and comment lines that\n"
403 " start with a hash(#), four sorts of configuration lines: array lines, \n"
404 " device lines, mailaddr lines and program lines.\n"
405 " Each configuration line is constructed of a number of space separated\n"
406 " words, and can be continued on subsequent physical lines by indenting\n"
407 " those lines.\n"
408 "\n"
409 " A device line starts with the word 'device' and then has a number of words\n"
410 " which identify devices.  These words should be names of devices in the\n"
411 " filesystem, and can contain wildcards. There can be multiple words or each\n"
412 " device line, and multiple device lines.  All devices so listed are checked\n"
413 " for relevant super blocks when assembling arrays.\n"
414 "\n"
415 " An array line start with the word 'array'.  This is followed by the name of\n"
416 " the array device in the filesystem, e.g. '/dev/md2'.  Subsequent words\n"
417 " describe the identity of the array, used to recognise devices to include in the\n"
418 " array.  The identity can be given as a UUID with a word starting 'uuid=', or\n"
419 " as a minor-number stored in the superblock using 'super-minor=', or as a list\n"
420 " of devices.  This is given as a comma separated list of names, possibly\n"
421 " containing wildcards, preceeded by 'devices='. If multiple critea are given,\n"
422 " than a device must match all of them to be considered.\n"
423 "\n"
424 " A mailaddr line starts with the word 'mailaddr' and should contain exactly\n"
425 " one Email address.  'mdadm --monitor --scan' will send alerts of failed drives\n"
426 " to this Email address."
427 "\n"
428 " A program line starts with the word 'program' and should contain exactly\n"
429 " one program name.  'mdadm --monitor --scan' will run this program when any\n"
430 " event is detected.\n"
431 "\n"
432 ;
433
434
435 /* name/number mappings */
436
437 mapping_t r5layout[] = {
438         { "left-asymmetric", 0},
439         { "right-asymmetric", 1},
440         { "left-symmetric", 2},
441         { "right-symmetric", 3},
442
443         { "default", 2},
444         { "la", 0},
445         { "ra", 1},
446         { "ls", 2},
447         { "rs", 3},
448         { NULL, 0}
449 };
450
451 mapping_t pers[] = {
452         { "linear", -1},
453         { "raid0", 0},
454         { "0", 0},
455         { "stripe", 0},
456         { "raid1", 1},
457         { "1", 1},
458         { "mirror", 1},
459         { "raid4", 4},
460         { "4", 4},
461         { "raid5", 5},
462         { "5", 5},
463         { "multipath", -4},
464         { "mp", -4},
465         { NULL, 0}
466 };
467
468
469 mapping_t modes[] = {
470         { "assemble", ASSEMBLE},
471         { "build", BUILD},
472         { "create", CREATE},
473         { "manage", MANAGE},
474         { "misc", MISC},
475         { "monitor", MONITOR},
476 };