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