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