mdadm.h

   1 /*
   2  * mdadm - manage Linux "md" devices aka RAID arrays.
   3  *
   4  * Copyright (C) 2001-2002 Neil Brown <neilb@cse.unsw.edu.au>
   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 __USE_LARGEFILE64
  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 #ifdef __dietlibc__NONO
  47 int strncmp(const char *s1, const char *s2, size_t n) __THROW __pure__;
  48 char *strncpy(char *dest, const char *src, size_t n) __THROW;
  49 #include    <strings.h>
  50 #endif
  51
  52
  53 #include        <linux/kdev_t.h>
  54 /*#include      <linux/fs.h> */
  55 #include        <sys/mount.h>
  56 #include        <asm/types.h>
  57 #include        <sys/ioctl.h>
  58 #define MD_MAJOR 9
  59 #define MdpMinorShift 6
  60
  61 #ifndef BLKGETSIZE64
  62 #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
  63 #endif
  64
  65 #define DEFAULT_BITMAP_CHUNK 4096
  66 #define DEFAULT_BITMAP_DELAY 5
  67 #define DEFAULT_MAX_WRITE_BEHIND 256
  68
  69 #include        "md_u.h"
  70 #include        "md_p.h"
  71 #include        "bitmap.h"
  72
  73 /* general information that might be extracted from a superblock */
  74 struct mdinfo {
  75         mdu_array_info_t        array;
  76         mdu_disk_info_t         disk;
  77         __u64                   events;
  78         int                     uuid[4];
  79 };
  80
  81 #define Name "mdadm"
  82
  83 enum mode {
  84         ASSEMBLE=1,
  85         BUILD,
  86         CREATE,
  87         MANAGE,
  88         MISC,
  89         MONITOR,
  90         GROW,
  91 };
  92
  93 extern char short_options[];
  94 extern struct option long_options[];
  95 extern char Version[], Usage[], Help[], OptionHelp[],
  96         Help_create[], Help_build[], Help_assemble[], Help_grow[],
  97         Help_manage[], Help_misc[], Help_monitor[], Help_config[];
  98
  99 /* structures read from config file */
 100 /* List of mddevice names and identifiers
 101  * Identifiers can be:
 102  *    uuid=128-hex-uuid
 103  *    super-minor=decimal-minor-number-from-superblock
 104  *    devices=comma,separated,list,of,device,names,with,wildcards
 105  *
 106  * If multiple fields are present, the intersection of all matching
 107  * devices is considered
 108  */
 109 #define UnSet (0xfffe)
 110 typedef struct mddev_ident_s {
 111         char    *devname;
 112
 113         int     uuid_set;
 114         int     uuid[4];
 115
 116         unsigned int super_minor;
 117
 118         char    *devices;       /* comma separated list of device
 119                                  * names with wild cards
 120                                  */
 121         int     level;
 122         unsigned int raid_disks;
 123         unsigned int spare_disks;
 124         struct supertype *st;
 125         int     autof;          /* 1 for normal, 2 for partitioned */
 126         char    *spare_group;
 127         int     bitmap_fd;
 128
 129         struct mddev_ident_s *next;
 130 } *mddev_ident_t;
 131
 132 /* List of device names - wildcards expanded */
 133 typedef struct mddev_dev_s {
 134         char *devname;
 135         char disposition;       /* 'a' for add, 'r' for remove, 'f' for fail.
 136                                  * Not set for names read from .config
 137                                  */
 138         char writemostly;
 139         struct mddev_dev_s *next;
 140 } *mddev_dev_t;
 141
 142 typedef struct mapping {
 143         char *name;
 144         int num;
 145 } mapping_t;
 146
 147
 148 struct mdstat_ent {
 149         char            *dev;
 150         int             devnum;
 151         int             active;
 152         char            *level;
 153         char            *pattern; /* U or up, _ for down */
 154         int             percent; /* -1 if no resync */
 155         int             resync; /* 1 if resync, 0 if recovery */
 156         struct mdstat_ent *next;
 157 };
 158
 159 extern struct mdstat_ent *mdstat_read(int);
 160 extern void free_mdstat(struct mdstat_ent *ms);
 161 extern void mdstat_wait(int seconds);
 162
 163 #ifndef Sendmail
 164 #define Sendmail "/usr/lib/sendmail -t"
 165 #endif
 166
 167 extern char *map_num(mapping_t *map, int num);
 168 extern int map_name(mapping_t *map, char *name);
 169 extern mapping_t r5layout[], pers[], modes[], faultylayout[];
 170
 171 extern char *map_dev(int major, int minor);
 172
 173
 174 extern struct superswitch {
 175         void (*examine_super)(void *sbv);
 176         void (*brief_examine_super)(void *sbv);
 177         void (*detail_super)(void *sbv);
 178         void (*brief_detail_super)(void *sbv);
 179         void (*uuid_from_super)(int uuid[4], void *sbv);
 180         void (*getinfo_super)(struct mdinfo *info, void *sbv);
 181         int (*update_super)(struct mdinfo *info, void *sbv, char *update, char *devname, int verbose);
 182         __u64 (*event_super)(void *sbv);
 183         int (*init_super)(struct supertype *st, void **sbp, mdu_array_info_t *info);
 184         void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
 185         int (*store_super)(struct supertype *st, int fd, void *sbv);
 186         int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
 187         int (*compare_super)(void **firstp, void *secondv);
 188         int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
 189         struct supertype * (*match_metadata_desc)(char *arg);
 190         __u64 (*avail_size)(__u64 size);
 191         int (*add_internal_bitmap)(void *sbv, int chunk, int delay, int write_behind, unsigned long long size);
 192         void (*locate_bitmap)(struct supertype *st, int fd);
 193         int (*write_bitmap)(struct supertype *st, int fd, void *sbv);
 194         int major;
 195         int swapuuid; /* true if uuid is bigending rather than hostendian */
 196 } super0, super1, *superlist[];
 197
 198 struct supertype {
 199         struct superswitch *ss;
 200         int minor_version;
 201         int max_devs;
 202 };
 203
 204 extern struct supertype *super_by_version(int vers, int minor);
 205 extern struct supertype *guess_super(int fd);
 206
 207 #ifdef UCLIBC
 208   struct FTW {};
 209 # define FTW_PHYS 1
 210 #else
 211 # define  __USE_XOPEN_EXTENDED
 212 # include <ftw.h>
 213 # ifdef __dietlibc__
 214 #  define FTW_PHYS 1
 215 # endif
 216 #endif
 217
 218 extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
 219
 220
 221 extern int Manage_ro(char *devname, int fd, int readonly);
 222 extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
 223 extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
 224 extern int Manage_reconfig(char *devname, int fd, int layout);
 225 extern int Manage_subdevs(char *devname, int fd,
 226                           mddev_dev_t devlist);
 227 extern int Grow_Add_device(char *devname, int fd, char *newdev);
 228 extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind);
 229
 230
 231 extern int Assemble(struct supertype *st, char *mddev, int mdfd,
 232                     mddev_ident_t ident,
 233                     char *conffile,
 234                     mddev_dev_t devlist,
 235                     int readonly, int runstop,
 236                     char *update,
 237                     int verbose, int force);
 238
 239 extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
 240                  int raiddisks,
 241                  mddev_dev_t devlist, int assume_clean,
 242                  char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
 243
 244
 245 extern int Create(struct supertype *st, char *mddev, int mdfd,
 246                   int chunk, int level, int layout, unsigned long size, int raiddisks, int sparedisks,
 247                   int subdevs, mddev_dev_t devlist,
 248                   int runstop, int verbose, int force,
 249                   char *bitmap_file, int bitmap_chunk, int write_behind, int delay);
 250
 251 extern int Detail(char *dev, int brief, int test);
 252 extern int Query(char *dev);
 253 extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
 254                    struct supertype *forcest);
 255 extern int Monitor(mddev_dev_t devlist,
 256                    char *mailaddr, char *alert_cmd,
 257                    int period, int daemonise, int scan, int oneshot,
 258                    char *config, int test, char *pidfile);
 259
 260 extern int Kill(char *dev, int force);
 261
 262 extern int CreateBitmap(char *filename, int force, char uuid[16],
 263                         unsigned long chunksize, unsigned long daemon_sleep,
 264                         unsigned long write_behind,
 265                         unsigned long long array_size);
 266 extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
 267
 268 extern int md_get_version(int fd);
 269 extern int get_linux_version(void);
 270 extern int parse_uuid(char *str, int uuid[4]);
 271 extern int check_ext2(int fd, char *name);
 272 extern int check_reiser(int fd, char *name);
 273 extern int check_raid(int fd, char *name);
 274
 275 extern int get_mdp_major(void);
 276 extern int is_standard(char *dev, int *nump);
 277
 278
 279 extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
 280 extern mddev_dev_t conf_get_devs(char *conffile);
 281 extern char *conf_get_mailaddr(char *conffile);
 282 extern char *conf_get_program(char *conffile);
 283 extern char *conf_line(FILE *file);
 284 extern char *conf_word(FILE *file, int allow_key);
 285 extern void free_line(char *line);
 286 extern int match_oneof(char *devices, char *devname);
 287 extern void uuid_from_super(int uuid[4], mdp_super_t *super);
 288 extern int same_uuid(int a[4], int b[4], int swapuuid);
 289 /* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
 290 extern unsigned long calc_csum(void *super, int bytes);
 291 extern int enough(int level, int raid_disks, int avail_disks);
 292 extern int ask(char *mesg);
 293
 294
 295 extern char *human_size(long long bytes);
 296 char *human_size_brief(long long bytes);
 297
 298 extern void put_md_name(char *name);
 299 extern char *get_md_name(int dev);
 300
 301 extern char DefaultConfFile[];
 302
 303 extern int open_mddev(char *dev, int autof);
 304
 305
 306 #define LEVEL_MULTIPATH         (-4)
 307 #define LEVEL_LINEAR            (-1)
 308 #define LEVEL_FAULTY            (-5)
 309
 310
 311 /* faulty stuff */
 312
 313 #define WriteTransient  0
 314 #define ReadTransient   1
 315 #define WritePersistent 2
 316 #define ReadPersistent  3
 317 #define WriteAll        4 /* doesn't go to device */
 318 #define ReadFixable     5
 319 #define Modes   6
 320
 321 #define ClearErrors     31
 322 #define ClearFaults     30
 323
 324 #define AllPersist      100 /* internal use only */
 325 #define NoPersist       101
 326
 327 #define ModeMask        0x1f
 328 #define ModeShift       5
 329
 330
 331 #ifdef __TINYC__
 332 #undef minor
 333 #undef major
 334 #undef makedev
 335 #define minor(x) ((x)&0xff)
 336 #define major(x) (((x)>>8)&0xff)
 337 #define makedev(M,m) (((M)<<8) | (m))
 338 #endif
 339