X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fmdadm.git;a=blobdiff_plain;f=ReadMe.c;h=387ba6d13f7540f43212ccf62cb4a36021d0819d;hp=2a41854cc3837aad4d14977c2f41dcd82ffef431;hb=33414a0182ae193150f65f7bca97a7e4d818a49e;hpb=dab6685f3d9982b697d938d99737897ea8ac768c diff --git a/ReadMe.c b/ReadMe.c index 2a41854c..387ba6d1 100644 --- a/ReadMe.c +++ b/ReadMe.c @@ -1,7 +1,7 @@ /* * mdadm - manage Linux "md" devices aka RAID arrays. * - * Copyright (C) 2001-2002 Neil Brown + * Copyright (C) 2001-2010 Neil Brown * * * This program is free software; you can redistribute it and/or modify @@ -19,17 +19,12 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * * Author: Neil Brown - * Email: - * Paper: Neil Brown - * School of Computer Science and Engineering - * The University of New South Wales - * Sydney, 2052 - * Australia + * Email: */ #include "mdadm.h" -char Version[] = Name " - v2.0-devel-3 - DEVELOPMENT VERSION NOT FOR REGULAR USE - 4 August 2005\n"; +char Version[] = Name " - v3.1.2 - 10th March 2010\n"; /* * File: ReadMe.c @@ -91,7 +86,12 @@ char Version[] = Name " - v2.0-devel-3 - DEVELOPMENT VERSION NOT FOR REGULAR USE * At the time if writing, there is only minimal support. */ -char short_options[]="-ABCDEFGQhVXvqb::c:i:l:p:m:n:x:u:c:d:z:U:sa::rfRSow1te:"; +char short_options[]="-ABCDEFGIQhVXWZ:vqbc:i:l:p:m:n:x:u:c:d:z:U:N:sarfRSow1tye:"; +char short_bitmap_options[]= + "-ABCDEFGIQhVXWZ:vqb:c:i:l:p:m:n:x:u:c:d:z:U:N:sarfRSow1tye:"; +char short_bitmap_auto_options[]= + "-ABCDEFGIQhVXWZ:vqb:c:i:l:p:m:n:x:u:c:d:z:U:N:sa:rfRSow1tye:"; + struct option long_options[] = { {"manage", 0, 0, '@'}, {"misc", 0, 0, '#'}, @@ -102,13 +102,17 @@ struct option long_options[] = { {"examine", 0, 0, 'E'}, {"follow", 0, 0, 'F'}, {"grow", 0, 0, 'G'}, + {"incremental",0,0, 'I'}, {"zero-superblock", 0, 0, 'K'}, /* deliberately no a short_option */ {"query", 0, 0, 'Q'}, {"examine-bitmap", 0, 0, 'X'}, + {"auto-detect", 0, 0, AutoDetect}, + {"detail-platform", 0, 0, DetailPlatform}, + {"kill-subarray", 1, 0, KillSubarray}, /* synonyms */ {"monitor", 0, 0, 'F'}, - + /* after those will normally come the name of the md device */ {"help", 0, 0, 'h'}, {"help-options",0,0,'h'}, @@ -128,12 +132,18 @@ struct option long_options[] = { {"spare-devices",1,0, 'x'}, {"size", 1, 0, 'z'}, {"auto", 1, 0, 'a'}, /* also for --assemble */ - {"assume-clean",0,0, 3 }, + {"assume-clean",0,0, AssumeClean }, {"metadata", 1, 0, 'e'}, /* superblock format */ {"bitmap", 1, 0, 'b'}, - {"bitmap-chunk", 1, 0, 4}, - {"write-behind", 2, 0, 5}, + {"bitmap-chunk", 1, 0, BitmapChunk}, + {"write-behind", 2, 0, WriteBehind}, {"write-mostly",0, 0, 'W'}, + {"re-add", 0, 0, ReAdd}, + {"homehost", 1, 0, HomeHost}, +#if 0 + {"auto-update-homehost", 0, 0, AutoHomeHost}, +#endif + {"symlinks", 1, 0, Symlinks}, /* For assemble */ {"uuid", 1, 0, 'u'}, @@ -153,22 +163,33 @@ struct option long_options[] = { {"stop", 0, 0, 'S'}, {"readonly", 0, 0, 'o'}, {"readwrite", 0, 0, 'w'}, + {"no-degraded",0,0, NoDegraded }, + {"wait", 0, 0, 'W'}, + {"wait-clean", 0, 0, Waitclean }, /* For Detail/Examine */ {"brief", 0, 0, 'b'}, - {"sparc2.2", 0, 0, 22}, + {"export", 0, 0, 'Y'}, + {"sparc2.2", 0, 0, Sparc22}, {"test", 0, 0, 't'}, /* For Follow/monitor */ {"mail", 1, 0, 'm'}, {"program", 1, 0, 'p'}, {"alert", 1, 0, 'p'}, + {"increment", 1, 0, 'r'}, {"delay", 1, 0, 'd'}, {"daemonise", 0, 0, 'f'}, {"daemonize", 0, 0, 'f'}, {"oneshot", 0, 0, '1'}, {"pid-file", 1, 0, 'i'}, - + {"syslog", 0, 0, 'y'}, + /* For Grow */ + {"backup-file", 1,0, BackupFile}, + {"array-size", 1, 0, 'Z'}, + + /* For Incremental */ + {"rebuild-map", 0, 0, 'r'}, {0, 0, 0, 0} }; @@ -178,15 +199,31 @@ char Usage[] = ; char Help[] = +"mdadm is used for building, managing, and monitoring\n" +"Linux md devices (aka RAID arrays)\n" "Usage: mdadm --create device options...\n" +" Create a new array from unused devices.\n" " mdadm --assemble device options...\n" +" Assemble a previously created array.\n" " mdadm --build device options...\n" +" Create or assemble an array without metadata.\n" " mdadm --manage device options...\n" +" make changes to an existing array.\n" " mdadm --misc options... devices\n" +" report on or modify various md related devices.\n" +" mdadm --grow options device\n" +" resize/reshape an active array\n" +" mdadm --incremental device\n" +" add a device to an array as appropriate\n" " mdadm --monitor options...\n" +" Monitor one or more array for significant changes.\n" " mdadm device options...\n" -" mdadm is used for building, managing, and monitoring\n" -" Linux md devices (aka RAID arrays)\n" +" Shorthand for --manage.\n" +"Any parameter that does not start with '-' is treated as a device name\n" +"or, for --examine-bitmap, a file name.\n" +"The first such name is often the name of an md device. Subsequent\n" +"names are often names of component devices.\n" +"\n" " For detailed help on the above major modes use --help after the mode\n" " e.g.\n" " mdadm --assemble --help\n" @@ -198,7 +235,7 @@ char OptionHelp[] = "Any parameter that does not start with '-' is treated as a device name\n" "or, for --examine-bitmap, a file name.\n" "The first such name is often the name of an md device. Subsequent\n" -"names are often names of component devices." +"names are often names of component devices.\n" "\n" "Some common options are:\n" " --help -h : General help message or, after above option,\n" @@ -208,17 +245,22 @@ char OptionHelp[] = " --verbose -v : Be more verbose about what is happening\n" " --quiet -q : Don't print un-necessary messages\n" " --brief -b : Be less verbose, more brief\n" +" --export -Y : With --detail, use key=value format for easy\n" +" import into environment\n" " --force -f : Override normal checks and be more forceful\n" "\n" " --assemble -A : Assemble an array\n" -" --build -B : Build a legacy array\n" +" --build -B : Build an array without metadata\n" " --create -C : Create a new array\n" " --detail -D : Display details of an array\n" " --examine -E : Examine superblock on an array component\n" " --examine-bitmap -X: Display the detail of a bitmap file\n" " --monitor -F : monitor (follow) some arrays\n" +" --grow -G : resize/ reshape and array\n" +" --incremental -I : add a single device to an array as appropriate\n" " --query -Q : Display general information about how a\n" " device relates to the md driver\n" +" --auto-detect : Start arrays auto-detected by the kernel\n" ; /* "\n" @@ -234,7 +276,6 @@ char OptionHelp[] = " --size= -z : Size (in K) of each drive in RAID1/4/5/6/10 - optional\n" " --force -f : Honour devices as listed on command line. Don't\n" " : insert a missing drive for RAID5.\n" -" --auto(=p) -a : Automatically allocate new (partitioned) md array if needed.\n" " --assume-clean : Assume the array is already in-sync. This is dangerous.\n" " --bitmap-chunk= : chunksize of bitmap in bitmap file (Kilobytes)\n" " --delay= -d : seconds between bitmap updates\n" @@ -251,8 +292,8 @@ char OptionHelp[] = " --config= -c : config file\n" " --scan -s : scan config file for missing information\n" " --force -f : Assemble the array even if some superblocks appear out-of-date\n" -" --update= -U : Update superblock: one of sparc2.2, super-minor or summaries\n" -" --auto(=p) -a : Automatically allocate new (partitioned) md array if needed.\n" +" --update= -U : Update superblock: try '-A --update=?' for list of options.\n" +" --no-degraded : Do not start any degraded arrays - default unless --scan.\n" "\n" " For detail or examine:\n" " --brief -b : Just print device name and UUID\n" @@ -273,6 +314,7 @@ char OptionHelp[] = " --readonly -o : mark array as readonly\n" " --readwrite -w : mark array as readwrite\n" " --zero-superblock : erase the MD superblock from a device.\n" +" --wait -W : wait for recovery/resync/reshape to finish.\n" ; */ @@ -371,6 +413,14 @@ char Help_assemble[] = " Those devices are md devices that are to be assembled. Their identity\n" " and components are determined from the config file.\n" "\n" +" If mdadm can not find all of the components for an array, it will assemble\n" +" it but not activate it unless --run or --scan is given. To preserve this\n" +" behaviour even with --scan, add --no-degraded. Note that \"all of the\n" +" components\" means as many as were present the last time the array was running\n" +" as recorded in the superblock. If the array was already degraded, and\n" +" the missing device is not a new problem, it will still be assembled. It\n" +" is only newly missing devices that cause the array not to be started.\n" +"\n" "Options that are valid with --assemble (-A) are:\n" " --bitmap= : bitmap file to use wit the array\n" " --uuid= -u : uuid of array to assemble. Devices which don't\n" @@ -384,7 +434,8 @@ char Help_assemble[] = " for a full array are present\n" " --force -f : Assemble the array even if some superblocks appear\n" " : out-of-date. This involves modifying the superblocks.\n" -" --update= -U : Update superblock: one of sparc2.2, super-minor or summaries\n" +" --update= -U : Update superblock: try '-A --update=?' for option list.\n" +" --no-degraded : Assemble but do not start degraded arrays.\n" ; char Help_manage[] = @@ -419,6 +470,7 @@ char Help_misc[] = " --query -Q : Display general information about how a\n" " device relates to the md driver\n" " --detail -D : Display details of an array\n" +" --detail-platform : Display hardware/firmware details\n" " --examine -E : Examine superblock on an array component\n" " --examine-bitmap -X: Display contents of a bitmap file\n" " --zero-superblock : erase the MD superblock from a device.\n" @@ -427,6 +479,7 @@ char Help_misc[] = " --readonly -o : mark array as readonly\n" " --readwrite -w : mark array as readwrite\n" " --test -t : exit status 0 if ok, 1 if degrade, 2 if dead, 4 if missing\n" +" --wait -W : wait for resync/rebuild/recovery to finish\n" ; char Help_monitor[] = @@ -445,6 +498,7 @@ char Help_monitor[] = " --mail= -m : Address to mail alerts of failure to\n" " --program= -p : Program to run when an event is detected\n" " --alert= : same as --program\n" +" --increment= -r : Report RebuildNN events in the given increment. default=20\n" " --delay= -d : seconds of delay between polling state. default=60\n" " --config= -c : specify a different config file\n" " --scan -s : find mail-address/program in config file\n" @@ -459,19 +513,44 @@ char Help_grow[] = "\n" "This usage causes mdadm to attempt to reconfigure a running array.\n" "This is only possibly if the kernel being used supports a particular\n" -"reconfiguration. This version only supports changing the number of\n" -"devices in a RAID1, and changing the active size of all devices in\n" -"a RAID1/4/5/6.\n" +"reconfiguration. This version supports changing the number of\n" +"devices in a RAID1/5/6, changing the active size of all devices in\n" +"a RAID1/4/5/6, adding or removing a write-intent bitmap, and changing\n" +"the error mode for a 'FAULTY' array.\n" "\n" "Options that are valid with the grow (-G --grow) mode are:\n" +" --level= -l : Tell mdadm what level the array is so that it can\n" +" : interpret '--layout' properly.\n" +" --layout= -p : For a FAULTY array, set/change the error mode.\n" " --size= -z : Change the active size of devices in an array.\n" " : This is useful if all devices have been replaced\n" -" : with larger devices.\n" -" --raid-disks= -n : Change the number of active devices in a RAID1\n" -" : array.\n" +" : with larger devices. Value is in Kilobytes, or\n" +" : the special word 'max' meaning 'as large as possible'.\n" +" --raid-devices= -n : Change the number of active devices in an array.\n" +" --bitmap= -b : Add or remove a write-intent bitmap.\n" +" --backup-file= file : A file on a differt device to store data for a\n" +" : short time while increasing raid-devices on a\n" +" : RAID4/5/6 array. Not needed when a spare is present.\n" +" --array-size= -Z : Change visible size of array. This does not change\n" +" : any data on the device, and is not stable across restarts.\n" ; - +char Help_incr[] = +"Usage: mdadm --incremental [-Rqrs] device\n" +"\n" +"This usage allows for incremental assembly of md arrays. Devices can be\n" +"added one at a time as they are discovered. Once an array has all expected\n" +"devices, it will be started.\n" +"\n" +"Options that are valid with incremental assembly (-I --incremental) more are:\n" +" --run -R : run arrays as soon as a minimal number of devices are\n" +" : present rather than waiting for all expected.\n" +" --quiet -q : Don't print any information messages, just errors.\n" +" --rebuild -r : Rebuild the 'map' file that mdadm uses for tracking\n" +" : partial arrays.\n" +" --scan -s : Use with -R to start any arrays that have the minimal\n" +" : required number of devices, but are not yet started.\n" +; char Help_config[] = "The /etc/mdadm.conf config file:\n\n" @@ -511,21 +590,54 @@ char Help_config[] = /* name/number mappings */ mapping_t r5layout[] = { - { "left-asymmetric", 0}, - { "right-asymmetric", 1}, - { "left-symmetric", 2}, - { "right-symmetric", 3}, - - { "default", 2}, - { "la", 0}, - { "ra", 1}, - { "ls", 2}, - { "rs", 3}, + { "left-asymmetric", ALGORITHM_LEFT_ASYMMETRIC}, + { "right-asymmetric", ALGORITHM_RIGHT_ASYMMETRIC}, + { "left-symmetric", ALGORITHM_LEFT_SYMMETRIC}, + { "right-symmetric", ALGORITHM_RIGHT_SYMMETRIC}, + + { "default", ALGORITHM_LEFT_SYMMETRIC}, + { "la", ALGORITHM_LEFT_ASYMMETRIC}, + { "ra", ALGORITHM_RIGHT_ASYMMETRIC}, + { "ls", ALGORITHM_LEFT_SYMMETRIC}, + { "rs", ALGORITHM_RIGHT_SYMMETRIC}, + + { "parity-first", ALGORITHM_PARITY_0}, + { "parity-last", ALGORITHM_PARITY_N}, + { "ddf-zero-restart", ALGORITHM_RIGHT_ASYMMETRIC}, + { "ddf-N-restart", ALGORITHM_LEFT_ASYMMETRIC}, + { "ddf-N-continue", ALGORITHM_LEFT_SYMMETRIC}, + + { NULL, 0} +}; +mapping_t r6layout[] = { + { "left-asymmetric", ALGORITHM_LEFT_ASYMMETRIC}, + { "right-asymmetric", ALGORITHM_RIGHT_ASYMMETRIC}, + { "left-symmetric", ALGORITHM_LEFT_SYMMETRIC}, + { "right-symmetric", ALGORITHM_RIGHT_SYMMETRIC}, + + { "default", ALGORITHM_LEFT_SYMMETRIC}, + { "la", ALGORITHM_LEFT_ASYMMETRIC}, + { "ra", ALGORITHM_RIGHT_ASYMMETRIC}, + { "ls", ALGORITHM_LEFT_SYMMETRIC}, + { "rs", ALGORITHM_RIGHT_SYMMETRIC}, + + { "parity-first", ALGORITHM_PARITY_0}, + { "parity-last", ALGORITHM_PARITY_N}, + { "ddf-zero-restart", ALGORITHM_ROTATING_ZERO_RESTART}, + { "ddf-N-restart", ALGORITHM_ROTATING_N_RESTART}, + { "ddf-N-continue", ALGORITHM_ROTATING_N_CONTINUE}, + + { "left-asymmetric-6", ALGORITHM_LEFT_ASYMMETRIC_6}, + { "right-asymmetric-6", ALGORITHM_RIGHT_ASYMMETRIC_6}, + { "left-symmetric-6", ALGORITHM_LEFT_SYMMETRIC_6}, + { "right-symmetric-6", ALGORITHM_RIGHT_SYMMETRIC_6}, + { "parity-first-6", ALGORITHM_PARITY_0_6}, + { NULL, 0} }; mapping_t pers[] = { - { "linear", -1}, + { "linear", LEVEL_LINEAR}, { "raid0", 0}, { "0", 0}, { "stripe", 0}, @@ -536,13 +648,14 @@ mapping_t pers[] = { { "4", 4}, { "raid5", 5}, { "5", 5}, - { "multipath", -4}, - { "mp", -4}, + { "multipath", LEVEL_MULTIPATH}, + { "mp", LEVEL_MULTIPATH}, { "raid6", 6}, { "6", 6}, { "raid10", 10}, { "10", 10}, - { "faulty", -5}, + { "faulty", LEVEL_FAULTY}, + { "container", LEVEL_CONTAINER}, { NULL, 0} }; @@ -555,6 +668,8 @@ mapping_t modes[] = { { "misc", MISC}, { "monitor", MONITOR}, { "grow", GROW}, + { "incremental", INCREMENTAL}, + { "auto-detect", AUTODETECT}, }; mapping_t faultylayout[] = {