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 #include        <unistd.h>
  32 #ifndef __dietlibc__
  33 extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
  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 #include        "md_u.h"
  72 #include        "md_p.h"
  73 #include        "bitmap.h"
  74
  75 #include <endian.h>
  76 /* Redhat don't like to #include <asm/byteorder.h>, and
  77  * some time include <linux/byteorder/xxx_endian.h> isn't enough,
  78  * and there is no standard conversion function so... */
  79 /* And dietlibc doesn't think byteswap is ok, so.. */
  80 /*  #include <byteswap.h> */
  81 #define bswap_16(x) (((x) & 0x00ffU) << 8 | \
  82                      ((x) & 0xff00U) >> 8)
  83 #define bswap_32(x) (((x) & 0x000000ffU) << 24 | \
  84                      ((x) & 0xff000000U) >> 24 | \
  85                      ((x) & 0x0000ff00U) << 8  | \
  86                      ((x) & 0x00ff0000U) >> 8)
  87 #define bswap_64(x) (((x) & 0x00000000000000ffULL) << 56 | \
  88                      ((x) & 0xff00000000000000ULL) >> 56 | \
  89                      ((x) & 0x000000000000ff00ULL) << 40 | \
  90                      ((x) & 0x00ff000000000000ULL) >> 40 | \
  91                      ((x) & 0x0000000000ff0000ULL) << 24 | \
  92                      ((x) & 0x0000ff0000000000ULL) >> 24 | \
  93                      ((x) & 0x00000000ff000000ULL) << 8 | \
  94                      ((x) & 0x000000ff00000000ULL) >> 8)
  95
  96 #if BYTE_ORDER == LITTLE_ENDIAN
  97 #define __cpu_to_le16(_x) (_x)
  98 #define __cpu_to_le32(_x) (_x)
  99 #define __cpu_to_le64(_x) (_x)
 100 #define __le16_to_cpu(_x) (_x)
 101 #define __le32_to_cpu(_x) (_x)
 102 #define __le64_to_cpu(_x) (_x)
 103 #elif BYTE_ORDER == BIG_ENDIAN
 104 #define __cpu_to_le16(_x) bswap_16(_x)
 105 #define __cpu_to_le32(_x) bswap_32(_x)
 106 #define __cpu_to_le64(_x) bswap_64(_x)
 107 #define __le16_to_cpu(_x) bswap_16(_x)
 108 #define __le32_to_cpu(_x) bswap_32(_x)
 109 #define __le64_to_cpu(_x) bswap_64(_x)
 110 #else
 111 #  error "unknown endianness."
 112 #endif
 113
 114
 115
 116 /* general information that might be extracted from a superblock */
 117 struct mdinfo {
 118         mdu_array_info_t        array;
 119         mdu_disk_info_t         disk;
 120         __u64                   events;
 121         int                     uuid[4];
 122         char                    name[33];
 123         unsigned long long      data_offset;
 124         unsigned long long      component_size;
 125         int                     reshape_active;
 126         unsigned long long      reshape_progress;
 127         int                     new_level, delta_disks, new_layout, new_chunk;
 128 };
 129
 130 struct createinfo {
 131         int     uid;
 132         int     gid;
 133         int     autof;
 134         int     mode;
 135         int     symlinks;
 136         struct supertype *supertype;
 137 };
 138
 139 #define Name "mdadm"
 140
 141 enum mode {
 142         ASSEMBLE=1,
 143         BUILD,
 144         CREATE,
 145         MANAGE,
 146         MISC,
 147         MONITOR,
 148         GROW,
 149         INCREMENTAL,
 150 };
 151
 152 extern char short_options[];
 153 extern char short_bitmap_auto_options[];
 154 extern struct option long_options[];
 155 extern char Version[], Usage[], Help[], OptionHelp[],
 156         Help_create[], Help_build[], Help_assemble[], Help_grow[],
 157         Help_incr[],
 158         Help_manage[], Help_misc[], Help_monitor[], Help_config[];
 159
 160 /* for option that don't have short equivilents, we assign arbitrary
 161  * small numbers.  '1' means an undecorated option, so we start at '2'.
 162  */
 163 enum special_options {
 164         AssumeClean = 2,
 165         BitmapChunk,
 166         WriteBehind,
 167         ReAdd,
 168         NoDegraded,
 169         Sparc22,
 170         BackupFile,
 171         HomeHost,
 172         AutoHomeHost,
 173         Symlinks,
 174 };
 175
 176 /* structures read from config file */
 177 /* List of mddevice names and identifiers
 178  * Identifiers can be:
 179  *    uuid=128-hex-uuid
 180  *    super-minor=decimal-minor-number-from-superblock
 181  *    devices=comma,separated,list,of,device,names,with,wildcards
 182  *
 183  * If multiple fields are present, the intersection of all matching
 184  * devices is considered
 185  */
 186 #define UnSet (0xfffe)
 187 typedef struct mddev_ident_s {
 188         char    *devname;
 189
 190         int     uuid_set;
 191         int     uuid[4];
 192         char    name[33];
 193
 194         unsigned int super_minor;
 195
 196         char    *devices;       /* comma separated list of device
 197                                  * names with wild cards
 198                                  */
 199         int     level;
 200         unsigned int raid_disks;
 201         unsigned int spare_disks;
 202         struct supertype *st;
 203         int     autof;          /* 1 for normal, 2 for partitioned */
 204         char    *spare_group;
 205         char    *bitmap_file;
 206         int     bitmap_fd;
 207
 208         struct mddev_ident_s *next;
 209 } *mddev_ident_t;
 210
 211 /* List of device names - wildcards expanded */
 212 typedef struct mddev_dev_s {
 213         char *devname;
 214         char disposition;       /* 'a' for add, 'r' for remove, 'f' for fail.
 215                                  * Not set for names read from .config
 216                                  */
 217         char writemostly;
 218         char re_add;
 219         char used;              /* set when used */
 220         struct mddev_dev_s *next;
 221 } *mddev_dev_t;
 222
 223 typedef struct mapping {
 224         char *name;
 225         int num;
 226 } mapping_t;
 227
 228
 229 struct mdstat_ent {
 230         char            *dev;
 231         int             devnum;
 232         int             active;
 233         char            *level;
 234         char            *pattern; /* U or up, _ for down */
 235         int             percent; /* -1 if no resync */
 236         int             resync; /* 1 if resync, 0 if recovery */
 237         struct mdstat_ent *next;
 238 };
 239
 240 extern struct mdstat_ent *mdstat_read(int hold, int start);
 241 extern void free_mdstat(struct mdstat_ent *ms);
 242 extern void mdstat_wait(int seconds);
 243 extern int mddev_busy(int devnum);
 244
 245 struct map_ent {
 246         struct map_ent *next;
 247         int     devnum;
 248         int     major,minor;
 249         int     uuid[4];
 250         char    *path;
 251 };
 252 extern int map_update(struct map_ent **mpp, int devnum, int major, int minor,
 253                       int uuid[4], char *path);
 254 extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
 255 extern void map_read(struct map_ent **melp);
 256 extern int map_write(struct map_ent *mel);
 257 extern void map_delete(struct map_ent **mapp, int devnum);
 258 extern void map_free(struct map_ent *map);
 259 extern void map_add(struct map_ent **melp,
 260                     int devnum, int major, int minor, int uuid[4], char *path);
 261
 262 /* Data structure for holding info read from sysfs */
 263 struct sysdev {
 264         char    name[20];
 265         int     role;
 266         int     major, minor;
 267         unsigned long long offset, size;
 268         int     state;
 269         int     errors;
 270         struct sysdev *next;
 271 };
 272 struct sysarray {
 273         char    name[20];
 274         struct sysdev *devs;
 275         int     chunk;
 276         unsigned long long component_size;
 277         int     layout;
 278         int     level;
 279         int     spares;
 280         int     cache_size;
 281         int     mismatch_cnt;
 282         int     major_version, minor_version;
 283 };
 284 /* various details can be requested */
 285 #define GET_LEVEL       1
 286 #define GET_LAYOUT      2
 287 #define GET_COMPONENT   4
 288 #define GET_CHUNK       8
 289 #define GET_CACHE       16
 290 #define GET_MISMATCH    32
 291 #define GET_VERSION     64
 292
 293 #define GET_DEVS        1024 /* gets role, major, minor */
 294 #define GET_OFFSET      2048
 295 #define GET_SIZE        4096
 296 #define GET_STATE       8192
 297 #define GET_ERROR       16384
 298
 299 /* If fd >= 0, get the array it is open on,
 300  * else use devnum. >=0 -> major9. <0.....
 301  */
 302 extern void sysfs_free(struct sysarray *sra);
 303 extern struct sysarray *sysfs_read(int fd, int devnum, unsigned long options);
 304 extern int sysfs_set_str(struct sysarray *sra, struct sysdev *dev,
 305                          char *name, char *val);
 306 extern int sysfs_set_num(struct sysarray *sra, struct sysdev *dev,
 307                          char *name, unsigned long long val);
 308 extern int sysfs_get_ll(struct sysarray *sra, struct sysdev *dev,
 309                         char *name, unsigned long long *val);
 310
 311
 312 extern int save_stripes(int *source, unsigned long long *offsets,
 313                         int raid_disks, int chunk_size, int level, int layout,
 314                         int nwrites, int *dest,
 315                         unsigned long long start, unsigned long long length);
 316 extern int restore_stripes(int *dest, unsigned long long *offsets,
 317                            int raid_disks, int chunk_size, int level, int layout,
 318                            int source, unsigned long long read_offset,
 319                            unsigned long long start, unsigned long long length);
 320
 321 #ifndef Sendmail
 322 #define Sendmail "/usr/lib/sendmail -t"
 323 #endif
 324
 325 #define SYSLOG_FACILITY LOG_DAEMON
 326
 327 extern char *map_num(mapping_t *map, int num);
 328 extern int map_name(mapping_t *map, char *name);
 329 extern mapping_t r5layout[], pers[], modes[], faultylayout[];
 330
 331 extern char *map_dev(int major, int minor, int create);
 332
 333
 334 extern struct superswitch {
 335         void (*examine_super)(void *sbv, char *homehost);
 336         void (*brief_examine_super)(void *sbv);
 337         void (*detail_super)(void *sbv, char *homehost);
 338         void (*brief_detail_super)(void *sbv);
 339         void (*uuid_from_super)(int uuid[4], void *sbv);
 340         void (*getinfo_super)(struct mdinfo *info, void *sbv);
 341         int (*match_home)(void *sbv, char *homehost);
 342         int (*update_super)(struct mdinfo *info, void *sbv, char *update,
 343                             char *devname, int verbose,
 344                             int uuid_set, char *homehost);
 345         int (*init_super)(struct supertype *st, void **sbp, mdu_array_info_t *info, unsigned long long size, char *name, char *homehost, int *uuid);
 346         void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
 347         int (*store_super)(struct supertype *st, int fd, void *sbv);
 348         int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
 349         int (*compare_super)(void **firstp, void *secondv);
 350         int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
 351         struct supertype * (*match_metadata_desc)(char *arg);
 352         __u64 (*avail_size)(struct supertype *st, __u64 size);
 353         int (*add_internal_bitmap)(struct supertype *st, void *sbv, int *chunkp,
 354                                    int delay, int write_behind,
 355                                    unsigned long long size, int may_change, int major);
 356         void (*locate_bitmap)(struct supertype *st, int fd, void *sbv);
 357         int (*write_bitmap)(struct supertype *st, int fd, void *sbv);
 358         int major;
 359         int swapuuid; /* true if uuid is bigending rather than hostendian */
 360 } super0, super1, *superlist[];
 361
 362 struct supertype {
 363         struct superswitch *ss;
 364         int minor_version;
 365         int max_devs;
 366 };
 367
 368 extern struct supertype *super_by_version(int vers, int minor);
 369 extern struct supertype *guess_super(int fd);
 370 extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
 371 extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
 372                          mdu_disk_info_t *disk);
 373
 374 #if __GNUC__ < 3
 375 struct stat64;
 376 #endif
 377
 378 #define HAVE_NFTW  we assume
 379 #define HAVE_FTW
 380
 381 #ifdef UCLIBC
 382 # include <features.h>
 383 # ifndef  __UCLIBC_HAS_FTW__
 384 #  undef HAVE_FTW
 385 #  undef HAVE_NFTW
 386 # endif
 387 #endif
 388
 389 #ifdef __dietlibc__
 390 # undef HAVE_NFTW
 391 #endif
 392
 393 #ifndef HAVE_NFTW
 394 # define FTW_PHYS 1
 395 # ifndef HAVE_FTW
 396   struct FTW {};
 397 # endif
 398 #endif
 399
 400 #ifdef HAVE_FTW
 401 # include <ftw.h>
 402 #endif
 403
 404 extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
 405
 406
 407 extern int Manage_ro(char *devname, int fd, int readonly);
 408 extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
 409 extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
 410 extern int Manage_reconfig(char *devname, int fd, int layout);
 411 extern int Manage_subdevs(char *devname, int fd,
 412                           mddev_dev_t devlist, int verbose);
 413 extern int Grow_Add_device(char *devname, int fd, char *newdev);
 414 extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
 415 extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
 416                         long long size,
 417                         int level, int layout, int chunksize, int raid_disks);
 418 extern int Grow_restart(struct supertype *st, struct mdinfo *info,
 419                         int *fdlist, int cnt, char *backup_file);
 420
 421
 422 extern int Assemble(struct supertype *st, char *mddev, int mdfd,
 423                     mddev_ident_t ident,
 424                     mddev_dev_t devlist, char *backup_file,
 425                     int readonly, int runstop,
 426                     char *update, char *homehost,
 427                     int verbose, int force);
 428
 429 extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
 430                  int raiddisks,
 431                  mddev_dev_t devlist, int assume_clean,
 432                  char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
 433
 434
 435 extern int Create(struct supertype *st, char *mddev, int mdfd,
 436                   int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
 437                   char *name, char *homehost, int *uuid,
 438                   int subdevs, mddev_dev_t devlist,
 439                   int runstop, int verbose, int force, int assume_clean,
 440                   char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
 441
 442 extern int Detail(char *dev, int brief, int test, char *homehost);
 443 extern int Query(char *dev);
 444 extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
 445                    struct supertype *forcest, char *homehost);
 446 extern int Monitor(mddev_dev_t devlist,
 447                    char *mailaddr, char *alert_cmd,
 448                    int period, int daemonise, int scan, int oneshot,
 449                    int dosyslog, int test, char *pidfile);
 450
 451 extern int Kill(char *dev, int force, int quiet);
 452 extern int Wait(char *dev);
 453
 454 extern int Incremental(char *devname, int verbose, int runstop,
 455                        struct supertype *st, char *homehost, int autof);
 456 extern void RebuildMap(void);
 457 extern int IncrementalScan(int verbose);
 458
 459 extern int CreateBitmap(char *filename, int force, char uuid[16],
 460                         unsigned long chunksize, unsigned long daemon_sleep,
 461                         unsigned long write_behind,
 462                         unsigned long long array_size,
 463                         int major);
 464 extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
 465 extern int bitmap_update_uuid(int fd, int *uuid, int swap);
 466
 467 extern int md_get_version(int fd);
 468 extern int get_linux_version(void);
 469 extern int parse_uuid(char *str, int uuid[4]);
 470 extern int check_ext2(int fd, char *name);
 471 extern int check_reiser(int fd, char *name);
 472 extern int check_raid(int fd, char *name);
 473
 474 extern int get_mdp_major(void);
 475 extern int dev_open(char *dev, int flags);
 476 extern int is_standard(char *dev, int *nump);
 477
 478 extern int parse_auto(char *str, char *msg, int config);
 479 extern mddev_ident_t conf_get_ident(char *dev);
 480 extern mddev_dev_t conf_get_devs(void);
 481 extern int conf_test_dev(char *devname);
 482 extern struct createinfo *conf_get_create_info(void);
 483 extern void set_conffile(char *file);
 484 extern char *conf_get_mailaddr(void);
 485 extern char *conf_get_mailfrom(void);
 486 extern char *conf_get_program(void);
 487 extern char *conf_get_homehost(void);
 488 extern char *conf_line(FILE *file);
 489 extern char *conf_word(FILE *file, int allow_key);
 490 extern void free_line(char *line);
 491 extern int match_oneof(char *devices, char *devname);
 492 extern void uuid_from_super(int uuid[4], mdp_super_t *super);
 493 extern int same_uuid(int a[4], int b[4], int swapuuid);
 494 extern void copy_uuid(void *a, int b[4], int swapuuid);
 495 /* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
 496 extern unsigned long calc_csum(void *super, int bytes);
 497 extern int enough(int level, int raid_disks, int layout, int clean,
 498                    char *avail, int avail_disks);
 499 extern int ask(char *mesg);
 500 extern unsigned long long get_component_size(int fd);
 501 extern void remove_partitions(int fd);
 502
 503
 504 extern char *human_size(long long bytes);
 505 char *human_size_brief(long long bytes);
 506
 507 extern void put_md_name(char *name);
 508 extern char *get_md_name(int dev);
 509
 510 extern char DefaultConfFile[];
 511
 512 extern int open_mddev(char *dev, int autof);
 513 extern int open_mddev_devnum(char *devname, int devnum, char *name,
 514                              char *chosen_name);
 515
 516
 517 #define LEVEL_MULTIPATH         (-4)
 518 #define LEVEL_LINEAR            (-1)
 519 #define LEVEL_FAULTY            (-5)
 520
 521
 522 /* faulty stuff */
 523
 524 #define WriteTransient  0
 525 #define ReadTransient   1
 526 #define WritePersistent 2
 527 #define ReadPersistent  3
 528 #define WriteAll        4 /* doesn't go to device */
 529 #define ReadFixable     5
 530 #define Modes   6
 531
 532 #define ClearErrors     31
 533 #define ClearFaults     30
 534
 535 #define AllPersist      100 /* internal use only */
 536 #define NoPersist       101
 537
 538 #define ModeMask        0x1f
 539 #define ModeShift       5
 540
 541
 542 #ifdef __TINYC__
 543 #undef minor
 544 #undef major
 545 #undef makedev
 546 #define minor(x) ((x)&0xff)
 547 #define major(x) (((x)>>8)&0xff)
 548 #define makedev(M,m) (((M)<<8) | (m))
 549 #endif
 550
 551 /* for raid5 */
 552 #define ALGORITHM_LEFT_ASYMMETRIC       0
 553 #define ALGORITHM_RIGHT_ASYMMETRIC      1
 554 #define ALGORITHM_LEFT_SYMMETRIC        2
 555 #define ALGORITHM_RIGHT_SYMMETRIC       3