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