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