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