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         struct supertype *supertype;
 136 };
 137
 138 #define Name "mdadm"
 139
 140 enum mode {
 141         ASSEMBLE=1,
 142         BUILD,
 143         CREATE,
 144         MANAGE,
 145         MISC,
 146         MONITOR,
 147         GROW,
 148 };
 149
 150 extern char short_options[];
 151 extern char short_bitmap_auto_options[];
 152 extern struct option long_options[];
 153 extern char Version[], Usage[], Help[], OptionHelp[],
 154         Help_create[], Help_build[], Help_assemble[], Help_grow[],
 155         Help_manage[], Help_misc[], Help_monitor[], Help_config[];
 156
 157 /* for option that don't have short equivilents, we assign arbitrary
 158  * small numbers.  '1' means an undecorated option, so we start at '2'.
 159  */
 160 enum special_options {
 161         AssumeClean = 2,
 162         BitmapChunk,
 163         WriteBehind,
 164         ReAdd,
 165         NoDegraded,
 166         Sparc22,
 167         BackupFile,
 168         HomeHost,
 169         AutoHomeHost,
 170 };
 171
 172 /* structures read from config file */
 173 /* List of mddevice names and identifiers
 174  * Identifiers can be:
 175  *    uuid=128-hex-uuid
 176  *    super-minor=decimal-minor-number-from-superblock
 177  *    devices=comma,separated,list,of,device,names,with,wildcards
 178  *
 179  * If multiple fields are present, the intersection of all matching
 180  * devices is considered
 181  */
 182 #define UnSet (0xfffe)
 183 typedef struct mddev_ident_s {
 184         char    *devname;
 185
 186         int     uuid_set;
 187         int     uuid[4];
 188         char    name[33];
 189
 190         unsigned int super_minor;
 191
 192         char    *devices;       /* comma separated list of device
 193                                  * names with wild cards
 194                                  */
 195         int     level;
 196         unsigned int raid_disks;
 197         unsigned int spare_disks;
 198         struct supertype *st;
 199         int     autof;          /* 1 for normal, 2 for partitioned */
 200         char    *spare_group;
 201         char    *bitmap_file;
 202         int     bitmap_fd;
 203
 204         struct mddev_ident_s *next;
 205 } *mddev_ident_t;
 206
 207 /* List of device names - wildcards expanded */
 208 typedef struct mddev_dev_s {
 209         char *devname;
 210         char disposition;       /* 'a' for add, 'r' for remove, 'f' for fail.
 211                                  * Not set for names read from .config
 212                                  */
 213         char writemostly;
 214         char re_add;
 215         char used;              /* set when used */
 216         struct mddev_dev_s *next;
 217 } *mddev_dev_t;
 218
 219 typedef struct mapping {
 220         char *name;
 221         int num;
 222 } mapping_t;
 223
 224
 225 struct mdstat_ent {
 226         char            *dev;
 227         int             devnum;
 228         int             active;
 229         char            *level;
 230         char            *pattern; /* U or up, _ for down */
 231         int             percent; /* -1 if no resync */
 232         int             resync; /* 1 if resync, 0 if recovery */
 233         struct mdstat_ent *next;
 234 };
 235
 236 extern struct mdstat_ent *mdstat_read(int hold, int start);
 237 extern void free_mdstat(struct mdstat_ent *ms);
 238 extern void mdstat_wait(int seconds);
 239
 240 /* Data structure for holding info read from sysfs */
 241 struct sysdev {
 242         char    name[20];
 243         int     role;
 244         int     major, minor;
 245         unsigned long long offset, size;
 246         int     state;
 247         int     errors;
 248         struct sysdev *next;
 249 };
 250 struct sysarray {
 251         char    name[20];
 252         struct sysdev *devs;
 253         int     chunk;
 254         unsigned long long component_size;
 255         int     layout;
 256         int     level;
 257         int     spares;
 258 };
 259 /* various details can be requested */
 260 #define GET_LEVEL       1
 261 #define GET_LAYOUT      2
 262 #define GET_COMPONENT   4
 263 #define GET_CHUNK       8
 264
 265 #define GET_DEVS        1024 /* gets role, major, minor */
 266 #define GET_OFFSET      2048
 267 #define GET_SIZE        4096
 268 #define GET_STATE       8192
 269 #define GET_ERROR       16384
 270
 271 /* If fd >= 0, get the array it is open on,
 272  * else use devnum. >=0 -> major9. <0.....
 273  */
 274 extern struct sysarray *sysfs_read(int fd, int devnum, unsigned long options);
 275 extern int sysfs_set_str(struct sysarray *sra, struct sysdev *dev,
 276                          char *name, char *val);
 277 extern int sysfs_set_num(struct sysarray *sra, struct sysdev *dev,
 278                          char *name, unsigned long long val);
 279 extern int sysfs_get_ll(struct sysarray *sra, struct sysdev *dev,
 280                         char *name, unsigned long long *val);
 281
 282
 283 extern int save_stripes(int *source, unsigned long long *offsets,
 284                         int raid_disks, int chunk_size, int level, int layout,
 285                         int nwrites, int *dest,
 286                         unsigned long long start, unsigned long long length);
 287 extern int restore_stripes(int *dest, unsigned long long *offsets,
 288                            int raid_disks, int chunk_size, int level, int layout,
 289                            int source, unsigned long long read_offset,
 290                            unsigned long long start, unsigned long long length);
 291
 292 #ifndef Sendmail
 293 #define Sendmail "/usr/lib/sendmail -t"
 294 #endif
 295
 296 #define SYSLOG_FACILITY LOG_DAEMON
 297
 298 extern char *map_num(mapping_t *map, int num);
 299 extern int map_name(mapping_t *map, char *name);
 300 extern mapping_t r5layout[], pers[], modes[], faultylayout[];
 301
 302 extern char *map_dev(int major, int minor, int create);
 303
 304
 305 extern struct superswitch {
 306         void (*examine_super)(void *sbv, char *homehost);
 307         void (*brief_examine_super)(void *sbv);
 308         void (*detail_super)(void *sbv, char *homehost);
 309         void (*brief_detail_super)(void *sbv);
 310         void (*uuid_from_super)(int uuid[4], void *sbv);
 311         void (*getinfo_super)(struct mdinfo *info, void *sbv);
 312         int (*match_home)(void *sbv, char *homehost);
 313         int (*update_super)(struct mdinfo *info, void *sbv, char *update,
 314                             char *devname, int verbose,
 315                             int uuid_set, char *homehost);
 316         __u64 (*event_super)(void *sbv);
 317         int (*init_super)(struct supertype *st, void **sbp, mdu_array_info_t *info, unsigned long long size, char *name, char *homehost);
 318         void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
 319         int (*store_super)(struct supertype *st, int fd, void *sbv);
 320         int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
 321         int (*compare_super)(void **firstp, void *secondv);
 322         int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
 323         struct supertype * (*match_metadata_desc)(char *arg);
 324         __u64 (*avail_size)(struct supertype *st, __u64 size);
 325         int (*add_internal_bitmap)(struct supertype *st, void *sbv, int chunk, int delay, int write_behind,
 326                                    unsigned long long size, int may_change, int major);
 327         void (*locate_bitmap)(struct supertype *st, int fd, void *sbv);
 328         int (*write_bitmap)(struct supertype *st, int fd, void *sbv);
 329         int major;
 330         int swapuuid; /* true if uuid is bigending rather than hostendian */
 331 } super0, super1, *superlist[];
 332
 333 struct supertype {
 334         struct superswitch *ss;
 335         int minor_version;
 336         int max_devs;
 337 };
 338
 339 extern struct supertype *super_by_version(int vers, int minor);
 340 extern struct supertype *guess_super(int fd);
 341
 342 #if __GNUC__ < 3
 343 struct stat64;
 344 #endif
 345
 346 #ifdef UCLIBC
 347   struct FTW {};
 348 # define FTW_PHYS 1
 349 #else
 350 # include <ftw.h>
 351 # ifdef __dietlibc__
 352 #  define FTW_PHYS 1
 353 # endif
 354 #endif
 355
 356 extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
 357
 358
 359 extern int Manage_ro(char *devname, int fd, int readonly);
 360 extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
 361 extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
 362 extern int Manage_reconfig(char *devname, int fd, int layout);
 363 extern int Manage_subdevs(char *devname, int fd,
 364                           mddev_dev_t devlist, int verbose);
 365 extern int Grow_Add_device(char *devname, int fd, char *newdev);
 366 extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
 367 extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
 368                         long long size,
 369                         int level, int layout, int chunksize, int raid_disks);
 370 extern int Grow_restart(struct supertype *st, struct mdinfo *info,
 371                         int *fdlist, int cnt, char *backup_file);
 372
 373
 374 extern int Assemble(struct supertype *st, char *mddev, int mdfd,
 375                     mddev_ident_t ident,
 376                     char *conffile,
 377                     mddev_dev_t devlist, char *backup_file,
 378                     int readonly, int runstop,
 379                     char *update, char *homehost,
 380                     int verbose, int force);
 381
 382 extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
 383                  int raiddisks,
 384                  mddev_dev_t devlist, int assume_clean,
 385                  char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int verbose);
 386
 387
 388 extern int Create(struct supertype *st, char *mddev, int mdfd,
 389                   int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
 390                   char *name, char *homehost,
 391                   int subdevs, mddev_dev_t devlist,
 392                   int runstop, int verbose, int force, int assume_clean,
 393                   char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
 394
 395 extern int Detail(char *dev, int brief, int test, char *homehost);
 396 extern int Query(char *dev);
 397 extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
 398                    struct supertype *forcest, char *homehost);
 399 extern int Monitor(mddev_dev_t devlist,
 400                    char *mailaddr, char *alert_cmd,
 401                    int period, int daemonise, int scan, int oneshot,
 402                    int dosyslog, char *config, int test, char *pidfile);
 403
 404 extern int Kill(char *dev, int force, int quiet);
 405
 406 extern int CreateBitmap(char *filename, int force, char uuid[16],
 407                         unsigned long chunksize, unsigned long daemon_sleep,
 408                         unsigned long write_behind,
 409                         unsigned long long array_size,
 410                         int major);
 411 extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
 412 extern int bitmap_update_uuid(int fd, int *uuid);
 413
 414 extern int md_get_version(int fd);
 415 extern int get_linux_version(void);
 416 extern int parse_uuid(char *str, int uuid[4]);
 417 extern int check_ext2(int fd, char *name);
 418 extern int check_reiser(int fd, char *name);
 419 extern int check_raid(int fd, char *name);
 420
 421 extern int get_mdp_major(void);
 422 extern int dev_open(char *dev, int flags);
 423 extern int is_standard(char *dev, int *nump);
 424
 425 extern int parse_auto(char *str, char *msg, int config);
 426 extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
 427 extern mddev_dev_t conf_get_devs(char *conffile);
 428 extern struct createinfo *conf_get_create_info(char *conffile);
 429 extern char *conf_get_mailaddr(char *conffile);
 430 extern char *conf_get_mailfrom(char *conffile);
 431 extern char *conf_get_program(char *conffile);
 432 extern char *conf_get_homehost(char *conffile);
 433 extern char *conf_line(FILE *file);
 434 extern char *conf_word(FILE *file, int allow_key);
 435 extern void free_line(char *line);
 436 extern int match_oneof(char *devices, char *devname);
 437 extern void uuid_from_super(int uuid[4], mdp_super_t *super);
 438 extern int same_uuid(int a[4], int b[4], int swapuuid);
 439 /* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
 440 extern unsigned long calc_csum(void *super, int bytes);
 441 extern int enough(int level, int raid_disks, int layout,
 442                    char *avail, int avail_disks);
 443 extern int ask(char *mesg);
 444 extern unsigned long long get_component_size(int fd);
 445
 446
 447 extern char *human_size(long long bytes);
 448 char *human_size_brief(long long bytes);
 449
 450 extern void put_md_name(char *name);
 451 extern char *get_md_name(int dev);
 452
 453 extern char DefaultConfFile[];
 454
 455 extern int open_mddev(char *dev, int autof);
 456
 457
 458 #define LEVEL_MULTIPATH         (-4)
 459 #define LEVEL_LINEAR            (-1)
 460 #define LEVEL_FAULTY            (-5)
 461
 462
 463 /* faulty stuff */
 464
 465 #define WriteTransient  0
 466 #define ReadTransient   1
 467 #define WritePersistent 2
 468 #define ReadPersistent  3
 469 #define WriteAll        4 /* doesn't go to device */
 470 #define ReadFixable     5
 471 #define Modes   6
 472
 473 #define ClearErrors     31
 474 #define ClearFaults     30
 475
 476 #define AllPersist      100 /* internal use only */
 477 #define NoPersist       101
 478
 479 #define ModeMask        0x1f
 480 #define ModeShift       5
 481
 482
 483 #ifdef __TINYC__
 484 #undef minor
 485 #undef major
 486 #undef makedev
 487 #define minor(x) ((x)&0xff)
 488 #define major(x) (((x)>>8)&0xff)
 489 #define makedev(M,m) (((M)<<8) | (m))
 490 #endif
 491
 492 /* for raid5 */
 493 #define ALGORITHM_LEFT_ASYMMETRIC       0
 494 #define ALGORITHM_RIGHT_ASYMMETRIC      1
 495 #define ALGORITHM_LEFT_SYMMETRIC        2
 496 #define ALGORITHM_RIGHT_SYMMETRIC       3