mdadm.h

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