mdadm.h

   1 /*
   2  * mdadm - manage Linux "md" devices aka RAID arrays.
   3  *
   4  * Copyright (C) 2001-2009 Neil Brown <neilb@suse.de>
   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@suse.de>
  23  */
  24
  25 #define _GNU_SOURCE
  26 #define _FILE_OFFSET_BITS 64
  27 #include        <unistd.h>
  28 #if !defined(__dietlibc__) && !defined(__KLIBC__)
  29 extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
  30 #else
  31 # if defined(__NO_STAT64) || __WORDSIZE != 32
  32 # define lseek64 lseek
  33 # endif
  34 #endif
  35
  36 #include        <sys/types.h>
  37 #include        <sys/stat.h>
  38 #include        <stdlib.h>
  39 #include        <time.h>
  40 #include        <sys/time.h>
  41 #include        <getopt.h>
  42 #include        <fcntl.h>
  43 #include        <stdio.h>
  44 #include        <errno.h>
  45 #include        <string.h>
  46 #include        <syslog.h>
  47 #ifdef __dietlibc__
  48 #include        <strings.h>
  49 /* dietlibc has deprecated random and srandom!! */
  50 #define random rand
  51 #define srandom srand
  52 #endif
  53
  54
  55 #include        <linux/kdev_t.h>
  56 /*#include      <linux/fs.h> */
  57 #include        <sys/mount.h>
  58 #include        <asm/types.h>
  59 #include        <sys/ioctl.h>
  60 #define MD_MAJOR 9
  61 #define MdpMinorShift 6
  62
  63 #ifndef BLKGETSIZE64
  64 #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
  65 #endif
  66
  67 #define DEFAULT_BITMAP_CHUNK 4096
  68 #define DEFAULT_BITMAP_DELAY 5
  69 #define DEFAULT_MAX_WRITE_BEHIND 256
  70
  71 /* VAR_RUN is where pid and socket files used for communicating
  72  * with mdmon normally live.  It should be /var/run, but if
  73  * it is too hard to remount /var/run as read-only rather than
  74  * unmounting it at shutdown time, then it should be
  75  * redefined to some place that comfortably persists until
  76  * final shutdown, possibly in /dev if that is a tmpfs.
  77  * Note: VAR_RUN does not need to be writable at shutdown,
  78  * only during boot when "mdmon --takeover" is run.
  79  */
  80 #ifndef VAR_RUN
  81 #define VAR_RUN "/var/run/mdadm"
  82 #endif /* VAR_RUN */
  83 /* ALT_RUN should be somewhere that persists across the pivotroot
  84  * from early boot to late boot.
  85  * If you don't have /lib/init/rw you might want to use /dev/.something
  86  */
  87 #ifndef ALT_RUN
  88 #define ALT_RUN "/lib/init/rw/mdadm"
  89 #endif /* ALT_RUN */
  90 #ifndef ALT_MAPFILE
  91 #define ALT_MAPFILE "map"
  92 #endif /* ALT_MAPFILE */
  93
  94 #include        "md_u.h"
  95 #include        "md_p.h"
  96 #include        "bitmap.h"
  97 #include        "msg.h"
  98
  99 #include <endian.h>
 100 /* Redhat don't like to #include <asm/byteorder.h>, and
 101  * some time include <linux/byteorder/xxx_endian.h> isn't enough,
 102  * and there is no standard conversion function so... */
 103 /* And dietlibc doesn't think byteswap is ok, so.. */
 104 /*  #include <byteswap.h> */
 105 #define bswap_16(x) (((x) & 0x00ffU) << 8 | \
 106                      ((x) & 0xff00U) >> 8)
 107 #define bswap_32(x) (((x) & 0x000000ffU) << 24 | \
 108                      ((x) & 0xff000000U) >> 24 | \
 109                      ((x) & 0x0000ff00U) << 8  | \
 110                      ((x) & 0x00ff0000U) >> 8)
 111 #define bswap_64(x) (((x) & 0x00000000000000ffULL) << 56 | \
 112                      ((x) & 0xff00000000000000ULL) >> 56 | \
 113                      ((x) & 0x000000000000ff00ULL) << 40 | \
 114                      ((x) & 0x00ff000000000000ULL) >> 40 | \
 115                      ((x) & 0x0000000000ff0000ULL) << 24 | \
 116                      ((x) & 0x0000ff0000000000ULL) >> 24 | \
 117                      ((x) & 0x00000000ff000000ULL) << 8 | \
 118                      ((x) & 0x000000ff00000000ULL) >> 8)
 119
 120 #if !defined(__KLIBC__)
 121 #if BYTE_ORDER == LITTLE_ENDIAN
 122 #define __cpu_to_le16(_x) (_x)
 123 #define __cpu_to_le32(_x) (_x)
 124 #define __cpu_to_le64(_x) (_x)
 125 #define __le16_to_cpu(_x) (_x)
 126 #define __le32_to_cpu(_x) (_x)
 127 #define __le64_to_cpu(_x) (_x)
 128
 129 #define __cpu_to_be16(_x) bswap_16(_x)
 130 #define __cpu_to_be32(_x) bswap_32(_x)
 131 #define __cpu_to_be64(_x) bswap_64(_x)
 132 #define __be16_to_cpu(_x) bswap_16(_x)
 133 #define __be32_to_cpu(_x) bswap_32(_x)
 134 #define __be64_to_cpu(_x) bswap_64(_x)
 135 #elif BYTE_ORDER == BIG_ENDIAN
 136 #define __cpu_to_le16(_x) bswap_16(_x)
 137 #define __cpu_to_le32(_x) bswap_32(_x)
 138 #define __cpu_to_le64(_x) bswap_64(_x)
 139 #define __le16_to_cpu(_x) bswap_16(_x)
 140 #define __le32_to_cpu(_x) bswap_32(_x)
 141 #define __le64_to_cpu(_x) bswap_64(_x)
 142
 143 #define __cpu_to_be16(_x) (_x)
 144 #define __cpu_to_be32(_x) (_x)
 145 #define __cpu_to_be64(_x) (_x)
 146 #define __be16_to_cpu(_x) (_x)
 147 #define __be32_to_cpu(_x) (_x)
 148 #define __be64_to_cpu(_x) (_x)
 149 #else
 150 #  error "unknown endianness."
 151 #endif
 152 #endif /* __KLIBC__ */
 153
 154
 155 /*
 156  * min()/max()/clamp() macros that also do
 157  * strict type-checking.. See the
 158  * "unnecessary" pointer comparison.
 159  */
 160 #define min(x, y) ({                            \
 161         typeof(x) _min1 = (x);                  \
 162         typeof(y) _min2 = (y);                  \
 163         (void) (&_min1 == &_min2);              \
 164         _min1 < _min2 ? _min1 : _min2; })
 165
 166 #define max(x, y) ({                            \
 167         typeof(x) _max1 = (x);                  \
 168         typeof(y) _max2 = (y);                  \
 169         (void) (&_max1 == &_max2);              \
 170         _max1 > _max2 ? _max1 : _max2; })
 171
 172 /* general information that might be extracted from a superblock */
 173 struct mdinfo {
 174         mdu_array_info_t        array;
 175         mdu_disk_info_t         disk;
 176         __u64                   events;
 177         int                     uuid[4];
 178         char                    name[33];
 179         unsigned long long      data_offset;
 180         unsigned long long      component_size; /* same as array.size, except in
 181                                                  * sectors and up to 64bits.
 182                                                  */
 183         unsigned long long      custom_array_size; /* size for non-default sized
 184                                                     * arrays (in sectors)
 185                                                     */
 186         int                     reshape_active;
 187         unsigned long long      reshape_progress;
 188         union {
 189                 unsigned long long resync_start; /* per-array resync position */
 190                 unsigned long long recovery_start; /* per-device rebuild position */
 191                 #define MaxSector  (~0ULL) /* resync/recovery complete position */
 192         };
 193         unsigned long           safe_mode_delay; /* ms delay to mark clean */
 194         int                     new_level, delta_disks, new_layout, new_chunk;
 195         int                     errors;
 196         int                     cache_size; /* size of raid456 stripe cache*/
 197         int                     mismatch_cnt;
 198         char                    text_version[50];
 199         void                    *update_private; /* for passing metadata-format
 200                                                   * specific update data
 201                                                   * between successive calls to
 202                                                   * update_super()
 203                                                   */
 204
 205         int container_member; /* for assembling external-metatdata arrays
 206                                * This is to be used internally by metadata
 207                                * handler only */
 208         int container_enough; /* flag external handlers can set to
 209                                * indicate that subarrays have not enough (-1),
 210                                * enough to start (0), or all expected disks (1) */
 211         char            sys_name[20];
 212         struct mdinfo *devs;
 213         struct mdinfo *next;
 214
 215         /* Device info for mdmon: */
 216         int recovery_fd;
 217         int state_fd;
 218         #define DS_FAULTY       1
 219         #define DS_INSYNC       2
 220         #define DS_WRITE_MOSTLY 4
 221         #define DS_SPARE        8
 222         #define DS_BLOCKED      16
 223         #define DS_REMOVE       1024
 224         #define DS_UNBLOCK      2048
 225         int prev_state, curr_state, next_state;
 226
 227 };
 228
 229 struct createinfo {
 230         int     uid;
 231         int     gid;
 232         int     autof;
 233         int     mode;
 234         int     symlinks;
 235         struct supertype *supertype;
 236 };
 237
 238 #define Name "mdadm"
 239
 240 enum mode {
 241         ASSEMBLE=1,
 242         BUILD,
 243         CREATE,
 244         MANAGE,
 245         MISC,
 246         MONITOR,
 247         GROW,
 248         INCREMENTAL,
 249         AUTODETECT,
 250 };
 251
 252 extern char short_options[];
 253 extern char short_bitmap_options[];
 254 extern char short_bitmap_auto_options[];
 255 extern struct option long_options[];
 256 extern char Version[], Usage[], Help[], OptionHelp[],
 257         Help_create[], Help_build[], Help_assemble[], Help_grow[],
 258         Help_incr[],
 259         Help_manage[], Help_misc[], Help_monitor[], Help_config[];
 260
 261 /* for option that don't have short equivilents, we assign arbitrary
 262  * small numbers.  '1' means an undecorated option, so we start at '2'.
 263  */
 264 enum special_options {
 265         AssumeClean = 2,
 266         BitmapChunk,
 267         WriteBehind,
 268         ReAdd,
 269         NoDegraded,
 270         Sparc22,
 271         BackupFile,
 272         HomeHost,
 273         AutoHomeHost,
 274         Symlinks,
 275         AutoDetect,
 276         Waitclean,
 277         DetailPlatform,
 278 };
 279
 280 /* structures read from config file */
 281 /* List of mddevice names and identifiers
 282  * Identifiers can be:
 283  *    uuid=128-hex-uuid
 284  *    super-minor=decimal-minor-number-from-superblock
 285  *    devices=comma,separated,list,of,device,names,with,wildcards
 286  *
 287  * If multiple fields are present, the intersection of all matching
 288  * devices is considered
 289  */
 290 #define UnSet (0xfffe)
 291 typedef struct mddev_ident_s {
 292         char    *devname;
 293
 294         int     uuid_set;
 295         int     uuid[4];
 296         char    name[33];
 297
 298         unsigned int super_minor;
 299
 300         char    *devices;       /* comma separated list of device
 301                                  * names with wild cards
 302                                  */
 303         int     level;
 304         unsigned int raid_disks;
 305         unsigned int spare_disks;
 306         struct supertype *st;
 307         int     autof;          /* 1 for normal, 2 for partitioned */
 308         char    *spare_group;
 309         char    *bitmap_file;
 310         int     bitmap_fd;
 311
 312         char    *container;     /* /dev/whatever name of container, or
 313                                  * uuid of container.  You would expect
 314                                  * this to be the 'devname' or UUID
 315                                  * of some other entry.
 316                                  */
 317         char    *member;        /* subarray within a container */
 318
 319         struct mddev_ident_s *next;
 320         union {
 321                 /* fields needed by different users of this structure */
 322                 int assembled;  /* set when assembly succeeds */
 323         };
 324 } *mddev_ident_t;
 325
 326 /* List of device names - wildcards expanded */
 327 typedef struct mddev_dev_s {
 328         char *devname;
 329         char disposition;       /* 'a' for add, 'r' for remove, 'f' for fail.
 330                                  * Not set for names read from .config
 331                                  */
 332         char writemostly;       /* 1 for 'set writemostly', 2 for 'clear writemostly' */
 333         char re_add;
 334         char used;              /* set when used */
 335         struct mdinfo *content; /* If devname is a container, this might list
 336                                  * the remaining member arrays. */
 337         struct mddev_dev_s *next;
 338 } *mddev_dev_t;
 339
 340 typedef struct mapping {
 341         char *name;
 342         int num;
 343 } mapping_t;
 344
 345
 346 struct mdstat_ent {
 347         char            *dev;
 348         int             devnum;
 349         int             active;
 350         char            *level;
 351         char            *pattern; /* U or up, _ for down */
 352         int             percent; /* -1 if no resync */
 353         int             resync; /* 1 if resync, 0 if recovery */
 354         int             devcnt;
 355         int             raid_disks;
 356         int             chunk_size;
 357         char *          metadata_version;
 358         struct dev_member {
 359                 char                    *name;
 360                 struct dev_member       *next;
 361         }               *members;
 362         struct mdstat_ent *next;
 363 };
 364
 365 extern struct mdstat_ent *mdstat_read(int hold, int start);
 366 extern void free_mdstat(struct mdstat_ent *ms);
 367 extern void mdstat_wait(int seconds);
 368 extern void mdstat_wait_fd(int fd, const sigset_t *sigmask);
 369 extern int mddev_busy(int devnum);
 370 extern struct mdstat_ent *mdstat_by_component(char *name);
 371
 372 struct map_ent {
 373         struct map_ent *next;
 374         int     devnum;
 375         char    metadata[20];
 376         int     uuid[4];
 377         int     bad;
 378         char    *path;
 379 };
 380 extern int map_update(struct map_ent **mpp, int devnum, char *metadata,
 381                       int uuid[4], char *path);
 382 extern void map_remove(struct map_ent **map, int devnum);
 383 extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
 384 extern struct map_ent *map_by_devnum(struct map_ent **map, int devnum);
 385 extern struct map_ent *map_by_name(struct map_ent **map, char *name);
 386 extern void map_read(struct map_ent **melp);
 387 extern int map_write(struct map_ent *mel);
 388 extern void map_delete(struct map_ent **mapp, int devnum);
 389 extern void map_free(struct map_ent *map);
 390 extern void map_add(struct map_ent **melp,
 391                     int devnum, char *metadata, int uuid[4], char *path);
 392 extern int map_lock(struct map_ent **melp);
 393 extern void map_unlock(struct map_ent **melp);
 394
 395 /* various details can be requested */
 396 enum sysfs_read_flags {
 397         GET_LEVEL       = (1 << 0),
 398         GET_LAYOUT      = (1 << 1),
 399         GET_COMPONENT   = (1 << 2),
 400         GET_CHUNK       = (1 << 3),
 401         GET_CACHE       = (1 << 4),
 402         GET_MISMATCH    = (1 << 5),
 403         GET_VERSION     = (1 << 6),
 404         GET_DISKS       = (1 << 7),
 405         GET_DEGRADED    = (1 << 8),
 406         GET_SAFEMODE    = (1 << 9),
 407         GET_DEVS        = (1 << 10), /* gets role, major, minor */
 408         GET_OFFSET      = (1 << 11),
 409         GET_SIZE        = (1 << 12),
 410         GET_STATE       = (1 << 13),
 411         GET_ERROR       = (1 << 14),
 412         SKIP_GONE_DEVS  = (1 << 15),
 413 };
 414
 415 /* If fd >= 0, get the array it is open on,
 416  * else use devnum. >=0 -> major9. <0.....
 417  */
 418 extern int sysfs_open(int devnum, char *devname, char *attr);
 419 extern void sysfs_init(struct mdinfo *mdi, int fd, int devnum);
 420 extern void sysfs_free(struct mdinfo *sra);
 421 extern struct mdinfo *sysfs_read(int fd, int devnum, unsigned long options);
 422 extern int sysfs_attr_match(const char *attr, const char *str);
 423 extern int sysfs_match_word(const char *word, char **list);
 424 extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
 425                          char *name, char *val);
 426 extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
 427                          char *name, unsigned long long val);
 428 extern int sysfs_uevent(struct mdinfo *sra, char *event);
 429 extern int sysfs_get_fd(struct mdinfo *sra, struct mdinfo *dev,
 430                         char *name);
 431 extern int sysfs_fd_get_ll(int fd, unsigned long long *val);
 432 extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
 433                         char *name, unsigned long long *val);
 434 extern int sysfs_fd_get_str(int fd, char *val, int size);
 435 extern int sysfs_get_str(struct mdinfo *sra, struct mdinfo *dev,
 436                          char *name, char *val, int size);
 437 extern int sysfs_set_safemode(struct mdinfo *sra, unsigned long ms);
 438 extern int sysfs_set_array(struct mdinfo *info, int vers);
 439 extern int sysfs_add_disk(struct mdinfo *sra, struct mdinfo *sd, int resume);
 440 extern int sysfs_disk_to_scsi_id(int fd, __u32 *id);
 441 extern int sysfs_unique_holder(int devnum, long rdev);
 442 extern int load_sys(char *path, char *buf);
 443
 444
 445 extern int save_stripes(int *source, unsigned long long *offsets,
 446                         int raid_disks, int chunk_size, int level, int layout,
 447                         int nwrites, int *dest,
 448                         unsigned long long start, unsigned long long length,
 449                         char *buf);
 450 extern int restore_stripes(int *dest, unsigned long long *offsets,
 451                            int raid_disks, int chunk_size, int level, int layout,
 452                            int source, unsigned long long read_offset,
 453                            unsigned long long start, unsigned long long length);
 454
 455 #ifndef Sendmail
 456 #define Sendmail "/usr/lib/sendmail -t"
 457 #endif
 458
 459 #define SYSLOG_FACILITY LOG_DAEMON
 460
 461 extern char *map_num(mapping_t *map, int num);
 462 extern int map_name(mapping_t *map, char *name);
 463 extern mapping_t r5layout[], r6layout[], pers[], modes[], faultylayout[];
 464
 465 extern char *map_dev(int major, int minor, int create);
 466
 467 struct active_array;
 468 struct metadata_update;
 469
 470 /* A superswitch provides entry point the a metadata handler.
 471  *
 472  * The super_switch primarily operates on some "metadata" that
 473  * is accessed via the 'supertype'.
 474  * This metadata has one of three possible sources.
 475  * 1/ It is read from a single device.  In this case it may not completely
 476  *    describe the array or arrays as some information might be on other
 477  *    devices.
 478  * 2/ It is read from all devices in a container.  In this case all
 479  *    information is present.
 480  * 3/ It is created by ->init_super / ->add_to_super.  In this case it will
 481  *    be complete once enough ->add_to_super calls have completed.
 482  *
 483  * When creating an array inside a container, the metadata will be
 484  * formed by a combination of 2 and 3.  The metadata or the array is read,
 485  * then new information is added.
 486  *
 487  * The metadata must sometimes have a concept of a 'current' array
 488  * and a 'current' device.
 489  * The 'current' array is set by init_super to be the newly created array,
 490  * or is set by super_by_fd when it finds it is looking at an array inside
 491  * a container.
 492  *
 493  * The 'current' device is either the device that the metadata was read from
 494  * in case 1, or the last device added by add_to_super in case 3.
 495  * Case 2 does not identify a 'current' device.
 496  */
 497 extern struct superswitch {
 498
 499         /* Used to report details of metadata read from a component
 500          * device. ->load_super has been called.
 501          */
 502         void (*examine_super)(struct supertype *st, char *homehost);
 503         void (*brief_examine_super)(struct supertype *st, int verbose);
 504         void (*brief_examine_subarrays)(struct supertype *st, int verbose);
 505         void (*export_examine_super)(struct supertype *st);
 506
 507         /* Used to report details of an active array.
 508          * ->load_super was possibly given a 'component' string.
 509          */
 510         void (*detail_super)(struct supertype *st, char *homehost);
 511         void (*brief_detail_super)(struct supertype *st);
 512         void (*export_detail_super)(struct supertype *st);
 513
 514         /* Optional: platform hardware / firmware details */
 515         int (*detail_platform)(int verbose, int enumerate_only);
 516
 517         /* Used:
 518          *   to get uuid to storing in bitmap metadata
 519          *   and 'reshape' backup-data metadata
 520          *   To see if a device is being re-added to an array it was part of.
 521          */
 522         void (*uuid_from_super)(struct supertype *st, int uuid[4]);
 523
 524         /* Extract generic details from metadata.  This could be details about
 525          * the container, or about an individual array within the container.
 526          * The determination is made either by:
 527          *   load_super being given a 'component' string.
 528          *   validate_geometry determining what to create.
 529          * The info includes both array information and device information.
 530          * The particular device should be:
 531          *   The last device added by add_to_super
 532          *   The device the metadata was loaded from by load_super
 533          */
 534         void (*getinfo_super)(struct supertype *st, struct mdinfo *info);
 535
 536         /* Check if the given metadata is flagged as belonging to "this"
 537          * host.  0 for 'no', 1 for 'yes', -1 for "Don't record homehost"
 538          */
 539         int (*match_home)(struct supertype *st, char *homehost);
 540
 541         /* Make one of several generic modifications to metadata
 542          * prior to assembly (or other times).
 543          *   sparc2.2  - first bug in early 0.90 metadata
 544          *   super-minor - change name of 0.90 metadata
 545          *   summaries - 'correct' any redundant data
 546          *   resync - mark array as dirty to trigger a resync.
 547          *   uuid - set new uuid - only 0.90 or 1.x
 548          *   name - change the name of the array (where supported)
 549          *   homehost - change which host this array is tied to.
 550          *   devicesize - If metadata is at start of device, change recorded
 551          *               device size to match actual device size
 552          *   byteorder - swap bytes for 0.90 metadata
 553          *
 554          *   force-one  - mark that device as uptodate, not old or failed.
 555          *   force-array - mark array as clean if it would not otherwise
 556          *               assemble
 557          *   assemble   - not sure how this is different from force-one...
 558          *   linear-grow-new - add a new device to a linear array, but don't
 559          *                   change the size: so superblock still matches
 560          *   linear-grow-update - now change the size of the array.
 561          */
 562         int (*update_super)(struct supertype *st, struct mdinfo *info,
 563                             char *update,
 564                             char *devname, int verbose,
 565                             int uuid_set, char *homehost);
 566
 567         /* Create new metadata for new array as described.  This could
 568          * be a new container, or an array in a pre-existing container.
 569          * Also used to zero metadata prior to writing it to invalidate old
 570          * metadata.
 571          */
 572         int (*init_super)(struct supertype *st, mdu_array_info_t *info,
 573                           unsigned long long size, char *name,
 574                           char *homehost, int *uuid);
 575
 576         /* update the metadata to include new device, either at create or
 577          * when hot-adding a spare.
 578          */
 579         int (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo,
 580                              int fd, char *devname);
 581
 582         /* Write metadata to one device when fixing problems or adding
 583          * a new device.
 584          */
 585         int (*store_super)(struct supertype *st, int fd);
 586
 587         /*  Write all metadata for this array.
 588          */
 589         int (*write_init_super)(struct supertype *st);
 590         int (*compare_super)(struct supertype *st, struct supertype *tst);
 591         int (*load_super)(struct supertype *st, int fd, char *devname);
 592         struct supertype * (*match_metadata_desc)(char *arg);
 593         __u64 (*avail_size)(struct supertype *st, __u64 size);
 594         int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
 595                                    int delay, int write_behind,
 596                                    unsigned long long size, int may_change, int major);
 597         void (*locate_bitmap)(struct supertype *st, int fd);
 598         int (*write_bitmap)(struct supertype *st, int fd);
 599         void (*free_super)(struct supertype *st);
 600
 601         /* validate_geometry is called with an st returned by
 602          * match_metadata_desc.
 603          * It should check that the geometry described in compatible with
 604          * the metadata type.  It will be called repeatedly as devices
 605          * added to validate changing size and new devices.  If there are
 606          * inter-device dependencies, it should record sufficient details
 607          * so these can be validated.
 608          * Both 'size' and '*freesize' are in sectors.  chunk is bytes.
 609          */
 610         int (*validate_geometry)(struct supertype *st, int level, int layout,
 611                                  int raiddisks,
 612                                  int chunk, unsigned long long size,
 613                                  char *subdev, unsigned long long *freesize,
 614                                  int verbose);
 615
 616         struct mdinfo *(*container_content)(struct supertype *st);
 617         /* Allow a metadata handler to override mdadm's default layouts */
 618         int (*default_layout)(int level); /* optional */
 619
 620 /* for mdmon */
 621         int (*open_new)(struct supertype *c, struct active_array *a,
 622                         char *inst);
 623
 624         /* Tell the metadata handler the current state of the array.
 625          * This covers whether it is known to be consistent (no pending writes)
 626          * and how far along a resync is known to have progressed
 627          * (in a->resync_start).
 628          * resync status is really irrelevant if the array is not consistent,
 629          * but some metadata (DDF!) have a place to record the distinction.
 630          * If 'consistent' is '2', then the array can mark it dirty if a
 631          * resync/recovery/whatever is required, or leave it clean if not.
 632          * Return value is 0 dirty (not consistent) and 1 if clean.
 633          * it is only really important if consistent is passed in as '2'.
 634          */
 635         int (*set_array_state)(struct active_array *a, int consistent);
 636
 637         /* When the state of a device might have changed, we call set_disk to
 638          * tell the metadata what the current state is.
 639          * Typically this happens on spare->in_sync and (spare|in_sync)->faulty
 640          * transitions.
 641          * set_disk might be called when the state of the particular disk has
 642          * not in fact changed.
 643          */
 644         void (*set_disk)(struct active_array *a, int n, int state);
 645         void (*sync_metadata)(struct supertype *st);
 646         void (*process_update)(struct supertype *st,
 647                                struct metadata_update *update);
 648         void (*prepare_update)(struct supertype *st,
 649                                struct metadata_update *update);
 650
 651         /* activate_spare will check if the array is degraded and, if it
 652          * is, try to find some spare space in the container.
 653          * On success, it add appropriate updates (For process_update) to
 654          * to the 'updates' list and returns a list of 'mdinfo' identifying
 655          * the device, or devices as there might be multiple missing
 656          * devices and multiple spares available.
 657          */
 658         struct mdinfo *(*activate_spare)(struct active_array *a,
 659                                          struct metadata_update **updates);
 660
 661         int swapuuid; /* true if uuid is bigending rather than hostendian */
 662         int external;
 663         const char *name; /* canonical metadata name */
 664 } super0, super1, super_ddf, *superlist[];
 665
 666 extern struct superswitch super_imsm;
 667
 668 struct metadata_update {
 669         int     len;
 670         char    *buf;
 671         void    *space; /* allocated space that monitor will use */
 672         struct metadata_update *next;
 673 };
 674
 675 /* A supertype holds a particular collection of metadata.
 676  * It identifies the metadata type by the superswitch, and the particular
 677  * sub-version of that metadata type.
 678  * metadata read in or created is stored in 'sb' and 'info'.
 679  * There are also fields used by mdmon to track containers.
 680  *
 681  * A supertype may refer to:
 682  *   Just an array, possibly in a container
 683  *   A container, not identifying any particular array
 684  *   Info read from just one device, not yet fully describing the array/container.
 685  *
 686  *
 687  * A supertype is created by:
 688  *   super_by_fd
 689  *   guess_super
 690  *   dup_super
 691  */
 692 struct supertype {
 693         struct superswitch *ss;
 694         int minor_version;
 695         int max_devs;
 696         int container_dev;    /* devnum of container */
 697         char subarray[32];      /* name of array inside container */
 698         void *sb;
 699         void *info;
 700         int loaded_container;   /* Set if load_super found a container,
 701                                  * not just one device */
 702
 703         struct metadata_update *updates;
 704         struct metadata_update **update_tail;
 705
 706         /* extra stuff used by mdmon */
 707         struct active_array *arrays;
 708         int sock; /* listen to external programs */
 709         int devnum;
 710         char *devname; /* e.g. md0.  This appears in metadata_verison:
 711                         *  external:/md0/12
 712                         */
 713         int devcnt;
 714
 715         struct mdinfo *devs;
 716
 717 };
 718
 719 extern struct supertype *super_by_fd(int fd);
 720 extern struct supertype *guess_super(int fd);
 721 extern struct supertype *dup_super(struct supertype *st);
 722 extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
 723 extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
 724                          mdu_disk_info_t *disk);
 725 void wait_for(char *dev, int fd);
 726
 727 #if __GNUC__ < 3
 728 struct stat64;
 729 #endif
 730
 731 #define HAVE_NFTW  we assume
 732 #define HAVE_FTW
 733
 734 #ifdef __UCLIBC__
 735 # include <features.h>
 736 # ifndef __UCLIBC_HAS_LFS__
 737 #  define lseek64 lseek
 738 # endif
 739 # ifndef  __UCLIBC_HAS_FTW__
 740 #  undef HAVE_FTW
 741 #  undef HAVE_NFTW
 742 # endif
 743 #endif
 744
 745 #ifdef __dietlibc__
 746 # undef HAVE_NFTW
 747 #endif
 748
 749 #if defined(__KLIBC__)
 750 # undef HAVE_NFTW
 751 # undef HAVE_FTW
 752 #endif
 753
 754 #ifndef HAVE_NFTW
 755 # define FTW_PHYS 1
 756 # ifndef HAVE_FTW
 757   struct FTW {};
 758 # endif
 759 #endif
 760
 761 #ifdef HAVE_FTW
 762 # include <ftw.h>
 763 #endif
 764
 765 extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
 766
 767
 768 extern int Manage_ro(char *devname, int fd, int readonly);
 769 extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
 770 extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
 771 extern int Manage_subdevs(char *devname, int fd,
 772                           mddev_dev_t devlist, int verbose, int test);
 773 extern int autodetect(void);
 774 extern int Grow_Add_device(char *devname, int fd, char *newdev);
 775 extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
 776 extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
 777                         long long size,
 778                         int level, char *layout_str, int chunksize, int raid_disks);
 779 extern int Grow_restart(struct supertype *st, struct mdinfo *info,
 780                         int *fdlist, int cnt, char *backup_file, int verbose);
 781 extern int Grow_continue(int mdfd, struct supertype *st,
 782                          struct mdinfo *info, char *backup_file);
 783
 784 extern int Assemble(struct supertype *st, char *mddev,
 785                     mddev_ident_t ident,
 786                     mddev_dev_t devlist, char *backup_file,
 787                     int readonly, int runstop,
 788                     char *update, char *homehost, int require_homehost,
 789                     int verbose, int force);
 790
 791 extern int Build(char *mddev, int chunk, int level, int layout,
 792                  int raiddisks, mddev_dev_t devlist, int assume_clean,
 793                  char *bitmap_file, int bitmap_chunk, int write_behind,
 794                  int delay, int verbose, int autof, unsigned long long size);
 795
 796
 797 extern int Create(struct supertype *st, char *mddev,
 798                   int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
 799                   char *name, char *homehost, int *uuid,
 800                   int subdevs, mddev_dev_t devlist,
 801                   int runstop, int verbose, int force, int assume_clean,
 802                   char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int autof);
 803
 804 extern int Detail(char *dev, int brief, int export, int test, char *homehost);
 805 extern int Detail_Platform(struct superswitch *ss, int scan, int verbose);
 806 extern int Query(char *dev);
 807 extern int Examine(mddev_dev_t devlist, int brief, int export, int scan,
 808                    int SparcAdjust, struct supertype *forcest, char *homehost);
 809 extern int Monitor(mddev_dev_t devlist,
 810                    char *mailaddr, char *alert_cmd,
 811                    int period, int daemonise, int scan, int oneshot,
 812                    int dosyslog, int test, char *pidfile, int increments);
 813
 814 extern int Kill(char *dev, struct supertype *st, int force, int quiet, int noexcl);
 815 extern int Wait(char *dev);
 816 extern int WaitClean(char *dev, int sock, int verbose);
 817
 818 extern int Incremental(char *devname, int verbose, int runstop,
 819                        struct supertype *st, char *homehost, int require_homehost,
 820                        int autof);
 821 extern int Incremental_container(struct supertype *st, char *devname,
 822                                  int verbose, int runstop, int autof,
 823                                  int trustworthy);
 824 extern void RebuildMap(void);
 825 extern int IncrementalScan(int verbose);
 826 extern int IncrementalRemove(char *devname, int verbose);
 827 extern int CreateBitmap(char *filename, int force, char uuid[16],
 828                         unsigned long chunksize, unsigned long daemon_sleep,
 829                         unsigned long write_behind,
 830                         unsigned long long array_size,
 831                         int major);
 832 extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
 833 extern int bitmap_update_uuid(int fd, int *uuid, int swap);
 834 extern unsigned long bitmap_sectors(struct bitmap_super_s *bsb);
 835
 836 extern int md_get_version(int fd);
 837 extern int get_linux_version(void);
 838 extern long long parse_size(char *size);
 839 extern int parse_uuid(char *str, int uuid[4]);
 840 extern int parse_layout_10(char *layout);
 841 extern int parse_layout_faulty(char *layout);
 842 extern int check_ext2(int fd, char *name);
 843 extern int check_reiser(int fd, char *name);
 844 extern int check_raid(int fd, char *name);
 845 extern int check_partitions(int fd, char *dname, unsigned long long freesize);
 846
 847 extern int get_mdp_major(void);
 848 extern int dev_open(char *dev, int flags);
 849 extern int open_dev(int devnum);
 850 extern int open_dev_excl(int devnum);
 851 extern int is_standard(char *dev, int *nump);
 852 extern int same_dev(char *one, char *two);
 853
 854 extern int parse_auto(char *str, char *msg, int config);
 855 extern mddev_ident_t conf_get_ident(char *dev);
 856 extern mddev_dev_t conf_get_devs(void);
 857 extern int conf_test_dev(char *devname);
 858 extern int conf_test_metadata(const char *version, int is_homehost);
 859 extern struct createinfo *conf_get_create_info(void);
 860 extern void set_conffile(char *file);
 861 extern char *conf_get_mailaddr(void);
 862 extern char *conf_get_mailfrom(void);
 863 extern char *conf_get_program(void);
 864 extern char *conf_get_homehost(int *require_homehostp);
 865 extern char *conf_line(FILE *file);
 866 extern char *conf_word(FILE *file, int allow_key);
 867 extern int conf_name_is_free(char *name);
 868 extern int devname_matches(char *name, char *match);
 869 extern struct mddev_ident_s *conf_match(struct mdinfo *info, struct supertype *st);
 870
 871 extern void free_line(char *line);
 872 extern int match_oneof(char *devices, char *devname);
 873 extern void uuid_from_super(int uuid[4], mdp_super_t *super);
 874 extern const int uuid_match_any[4];
 875 extern int same_uuid(int a[4], int b[4], int swapuuid);
 876 extern void copy_uuid(void *a, int b[4], int swapuuid);
 877 extern char *__fname_from_uuid(int id[4], int swap, char *buf, char sep);
 878 extern char *fname_from_uuid(struct supertype *st,
 879                              struct mdinfo *info, char *buf, char sep);
 880 extern unsigned long calc_csum(void *super, int bytes);
 881 extern int enough(int level, int raid_disks, int layout, int clean,
 882                    char *avail, int avail_disks);
 883 extern int ask(char *mesg);
 884 extern unsigned long long get_component_size(int fd);
 885 extern void remove_partitions(int fd);
 886 extern int test_partition(int fd);
 887 extern unsigned long long calc_array_size(int level, int raid_disks, int layout,
 888                                    int chunksize, unsigned long long devsize);
 889 extern int flush_metadata_updates(struct supertype *st);
 890 extern void append_metadata_update(struct supertype *st, void *buf, int len);
 891 extern int assemble_container_content(struct supertype *st, int mdfd,
 892                                       struct mdinfo *content, int runstop,
 893                                       char *chosen_name, int verbose);
 894
 895 extern int add_disk(int mdfd, struct supertype *st,
 896                     struct mdinfo *sra, struct mdinfo *info);
 897 extern int set_array_info(int mdfd, struct supertype *st, struct mdinfo *info);
 898 unsigned long long min_recovery_start(struct mdinfo *array);
 899
 900 extern char *human_size(long long bytes);
 901 extern char *human_size_brief(long long bytes);
 902 extern void print_r10_layout(int layout);
 903
 904 #define NoMdDev (1<<23)
 905 extern int find_free_devnum(int use_partitions);
 906
 907 extern void put_md_name(char *name);
 908 extern char *get_md_name(int dev);
 909
 910 extern char DefaultConfFile[];
 911
 912 extern int create_mddev(char *dev, char *name, int autof, int trustworthy,
 913                         char *chosen);
 914 /* values for 'trustworthy' */
 915 #define LOCAL   1
 916 #define LOCAL_ANY 10
 917 #define FOREIGN 2
 918 #define METADATA 3
 919 extern int open_mddev(char *dev, int report_errors);
 920 extern int open_container(int fd);
 921
 922 extern char *pid_dir;
 923 extern int mdmon_running(int devnum);
 924 extern int mdmon_pid(int devnum);
 925 extern int check_env(char *name);
 926 extern __u32 random32(void);
 927 extern int start_mdmon(int devnum);
 928
 929 extern char *devnum2devname(int num);
 930 extern int devname2devnum(char *name);
 931 extern int stat2devnum(struct stat *st);
 932 extern int fd2devnum(int fd);
 933
 934 static inline int dev2major(int d)
 935 {
 936         if (d >= 0)
 937                 return MD_MAJOR;
 938         else
 939                 return get_mdp_major();
 940 }
 941
 942 static inline int dev2minor(int d)
 943 {
 944         if (d >= 0)
 945                 return d;
 946         return (-1-d) << MdpMinorShift;
 947 }
 948
 949 static inline int ROUND_UP(int a, int base)
 950 {
 951         return ((a+base-1)/base)*base;
 952 }
 953
 954 static inline int is_subarray(char *vers)
 955 {
 956         /* The version string for a 'subarray' (an array in a container)
 957          * is
 958          *    /containername/componentname    for normal read-write arrays
 959          *    -containername/componentname    for read-only arrays.
 960          * containername is e.g. md0, md_d1
 961          * componentname is dependant on the metadata. e.g. '1' 'S1' ...
 962          */
 963         return (*vers == '/' || *vers == '-');
 964 }
 965
 966 #ifdef DEBUG
 967 #define dprintf(fmt, arg...) \
 968         fprintf(stderr, fmt, ##arg)
 969 #else
 970 #define dprintf(fmt, arg...) \
 971         ({ if (0) fprintf(stderr, fmt, ##arg); 0; })
 972 #endif
 973 #include <assert.h>
 974 #include <stdarg.h>
 975 static inline int xasprintf(char **strp, const char *fmt, ...) {
 976         va_list ap;
 977         int ret;
 978         va_start(ap, fmt);
 979         ret = vasprintf(strp, fmt, ap);
 980         va_end(ap);
 981         assert(ret >= 0);
 982         return ret;
 983 }
 984
 985 #define LEVEL_MULTIPATH         (-4)
 986 #define LEVEL_LINEAR            (-1)
 987 #define LEVEL_FAULTY            (-5)
 988
 989 /* kernel module doesn't know about these */
 990 #define LEVEL_CONTAINER         (-100)
 991 #define LEVEL_UNSUPPORTED       (-200)
 992
 993
 994 /* faulty stuff */
 995
 996 #define WriteTransient  0
 997 #define ReadTransient   1
 998 #define WritePersistent 2
 999 #define ReadPersistent  3
1000 #define WriteAll        4 /* doesn't go to device */
1001 #define ReadFixable     5
1002 #define Modes   6
1003
1004 #define ClearErrors     31
1005 #define ClearFaults     30
1006
1007 #define AllPersist      100 /* internal use only */
1008 #define NoPersist       101
1009
1010 #define ModeMask        0x1f
1011 #define ModeShift       5
1012
1013
1014 #ifdef __TINYC__
1015 #undef minor
1016 #undef major
1017 #undef makedev
1018 #define minor(x) ((x)&0xff)
1019 #define major(x) (((x)>>8)&0xff)
1020 #define makedev(M,m) (((M)<<8) | (m))
1021 #endif
1022
1023 /* for raid4/5/6 */
1024 #define ALGORITHM_LEFT_ASYMMETRIC       0
1025 #define ALGORITHM_RIGHT_ASYMMETRIC      1
1026 #define ALGORITHM_LEFT_SYMMETRIC        2
1027 #define ALGORITHM_RIGHT_SYMMETRIC       3
1028
1029 /* Define non-rotating (raid4) algorithms.  These allow
1030  * conversion of raid4 to raid5.
1031  */
1032 #define ALGORITHM_PARITY_0              4 /* P or P,Q are initial devices */
1033 #define ALGORITHM_PARITY_N              5 /* P or P,Q are final devices. */
1034
1035 /* DDF RAID6 layouts differ from md/raid6 layouts in two ways.
1036  * Firstly, the exact positioning of the parity block is slightly
1037  * different between the 'LEFT_*' modes of md and the "_N_*" modes
1038  * of DDF.
1039  * Secondly, or order of datablocks over which the Q syndrome is computed
1040  * is different.
1041  * Consequently we have different layouts for DDF/raid6 than md/raid6.
1042  * These layouts are from the DDFv1.2 spec.
1043  * Interestingly DDFv1.2-Errata-A does not specify N_CONTINUE but
1044  * leaves RLQ=3 as 'Vendor Specific'
1045  */
1046
1047 #define ALGORITHM_ROTATING_ZERO_RESTART 8 /* DDF PRL=6 RLQ=1 */
1048 #define ALGORITHM_ROTATING_N_RESTART    9 /* DDF PRL=6 RLQ=2 */
1049 #define ALGORITHM_ROTATING_N_CONTINUE   10 /*DDF PRL=6 RLQ=3 */
1050
1051
1052 /* For every RAID5 algorithm we define a RAID6 algorithm
1053  * with exactly the same layout for data and parity, and
1054  * with the Q block always on the last device (N-1).
1055  * This allows trivial conversion from RAID5 to RAID6
1056  */
1057 #define ALGORITHM_LEFT_ASYMMETRIC_6     16
1058 #define ALGORITHM_RIGHT_ASYMMETRIC_6    17
1059 #define ALGORITHM_LEFT_SYMMETRIC_6      18
1060 #define ALGORITHM_RIGHT_SYMMETRIC_6     19
1061 #define ALGORITHM_PARITY_0_6            20
1062 #define ALGORITHM_PARITY_N_6            ALGORITHM_PARITY_N
1063
1064 /* Define PATH_MAX in case we don't use glibc or standard library does
1065  * not have PATH_MAX defined. Assume max path length is 4K characters.
1066  */
1067 #ifndef PATH_MAX
1068 #define PATH_MAX        4096
1069 #endif
1070