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