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        <getopt.h>
  41 #include        <fcntl.h>
  42 #include        <stdio.h>
  43 #include        <errno.h>
  44 #include        <string.h>
  45 #ifdef __dietlibc__NONO
  46 int strncmp(const char *s1, const char *s2, size_t n) __THROW __pure__;
  47 char *strncpy(char *dest, const char *src, size_t n) __THROW;
  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
  65 #include        "md_u.h"
  66 #include        "md_p.h"
  67
  68 /* general information that might be extracted from a superblock */
  69 struct mdinfo {
  70         mdu_array_info_t        array;
  71         mdu_disk_info_t         disk;
  72         __u64                   events;
  73         unsigned int            uuid[4];
  74 };
  75
  76 #define Name "mdadm"
  77
  78 enum mode {
  79         ASSEMBLE=1,
  80         BUILD,
  81         CREATE,
  82         MANAGE,
  83         MISC,
  84         MONITOR,
  85         GROW,
  86 };
  87
  88 extern char short_options[];
  89 extern struct option long_options[];
  90 extern char Version[], Usage[], Help[], OptionHelp[],
  91         Help_create[], Help_build[], Help_assemble[], Help_grow[],
  92         Help_manage[], Help_misc[], Help_monitor[], Help_config[];
  93
  94 /* structures read from config file */
  95 /* List of mddevice names and identifiers
  96  * Identifiers can be:
  97  *    uuid=128-hex-uuid
  98  *    super-minor=decimal-minor-number-from-superblock
  99  *    devices=comma,separated,list,of,device,names,with,wildcards
 100  *
 101  * If multiple fields are present, the intersection of all matching
 102  * devices is considered
 103  */
 104 #define UnSet (0xfffe)
 105 typedef struct mddev_ident_s {
 106         char    *devname;
 107
 108         int     uuid_set;
 109         __u32   uuid[4];
 110
 111         unsigned int super_minor;
 112
 113         char    *devices;       /* comma separated list of device
 114                                  * names with wild cards
 115                                  */
 116         int     level;
 117         unsigned int raid_disks;
 118         unsigned int spare_disks;
 119         struct supertype *st;
 120         int     autof;          /* 1 for normal, 2 for partitioned */
 121         char    *spare_group;
 122
 123         struct mddev_ident_s *next;
 124 } *mddev_ident_t;
 125
 126 /* List of device names - wildcards expanded */
 127 typedef struct mddev_dev_s {
 128         char *devname;
 129         char disposition;       /* 'a' for add, 'r' for remove, 'f' for fail.
 130                                  * Not set for names read from .config
 131                                  */
 132         struct mddev_dev_s *next;
 133 } *mddev_dev_t;
 134
 135 typedef struct mapping {
 136         char *name;
 137         int num;
 138 } mapping_t;
 139
 140
 141 struct mdstat_ent {
 142         char            *dev;
 143         int             devnum;
 144         int             active;
 145         char            *level;
 146         char            *pattern; /* U or up, _ for down */
 147         int             percent; /* -1 if no resync */
 148         int             resync; /* 1 if resync, 0 if recovery */
 149         struct mdstat_ent *next;
 150 };
 151
 152 extern struct mdstat_ent *mdstat_read(int);
 153 extern void free_mdstat(struct mdstat_ent *ms);
 154 extern void mdstat_wait(int seconds);
 155
 156 #ifndef Sendmail
 157 #define Sendmail "/usr/lib/sendmail -t"
 158 #endif
 159
 160 extern char *map_num(mapping_t *map, int num);
 161 extern int map_name(mapping_t *map, char *name);
 162 extern mapping_t r5layout[], pers[], modes[], faultylayout[];
 163
 164 extern char *map_dev(int major, int minor);
 165
 166
 167 extern struct superswitch {
 168         void (*examine_super)(void *sbv);
 169         void (*brief_examine_super)(void *sbv);
 170         void (*detail_super)(void *sbv);
 171         void (*brief_detail_super)(void *sbv);
 172         void (*uuid_from_super)(int uuid[4], void *sbv);
 173         void (*getinfo_super)(struct mdinfo *info, void *sbv);
 174         int (*update_super)(struct mdinfo *info, void *sbv, char *update, char *devname, int verbose);
 175         __u64 (*event_super)(void *sbv);
 176         int (*init_super)(void **sbp, mdu_array_info_t *info);
 177         void (*add_to_super)(void *sbv, mdu_disk_info_t *dinfo);
 178         int (*store_super)(int fd, void *sbv);
 179         int (*write_init_super)(struct supertype *st, void *sbv, mdu_disk_info_t *dinfo, char *devname);
 180         int (*compare_super)(void **firstp, void *secondv);
 181         int (*load_super)(struct supertype *st, int fd, void **sbp, char *devname);
 182         struct supertype * (*match_metadata_desc)(char *arg);
 183         __u64 (*avail_size)(__u64 size);
 184         int major;
 185 } super0, super1, *superlist[];
 186
 187 struct supertype {
 188         struct superswitch *ss;
 189         int minor_version;
 190 };
 191
 192 extern struct supertype *super_by_version(int vers, int minor);
 193 extern struct supertype *guess_super(int fd);
 194
 195
 196 extern int Manage_ro(char *devname, int fd, int readonly);
 197 extern int Manage_runstop(char *devname, int fd, int runstop);
 198 extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
 199 extern int Manage_reconfig(char *devname, int fd, int layout);
 200 extern int Manage_subdevs(char *devname, int fd,
 201                           mddev_dev_t devlist);
 202 extern int Grow_Add_device(char *devname, int fd, char *newdev);
 203
 204
 205 extern int Assemble(struct supertype *st, char *mddev, int mdfd,
 206                     mddev_ident_t ident,
 207                     char *conffile,
 208                     mddev_dev_t devlist,
 209                     int readonly, int runstop,
 210                     char *update,
 211                     int verbose, int force);
 212
 213 extern int Build(char *mddev, int mdfd, int chunk, int level, int layout,
 214                  int raiddisks,
 215                  mddev_dev_t devlist, int assume_clean);
 216
 217
 218 extern int Create(struct supertype *st, char *mddev, int mdfd,
 219                   int chunk, int level, int layout, unsigned long size, int raiddisks, int sparedisks,
 220                   int subdevs, mddev_dev_t devlist,
 221                   int runstop, int verbose, int force);
 222
 223 extern int Detail(char *dev, int brief, int test);
 224 extern int Query(char *dev);
 225 extern int Examine(mddev_dev_t devlist, int brief, int scan, int SparcAdjust,
 226                    struct supertype *forcest);
 227 extern int Monitor(mddev_dev_t devlist,
 228                    char *mailaddr, char *alert_cmd,
 229                    int period, int daemonise, int scan, int oneshot,
 230                    char *config, int test, char *pidfile);
 231
 232 extern int Kill(char *dev, int force);
 233
 234 extern int md_get_version(int fd);
 235 extern int get_linux_version(void);
 236 extern int parse_uuid(char *str, int uuid[4]);
 237 extern int check_ext2(int fd, char *name);
 238 extern int check_reiser(int fd, char *name);
 239 extern int check_raid(int fd, char *name);
 240
 241 extern int get_mdp_major(void);
 242 extern int is_standard(char *dev, int *nump);
 243
 244
 245 extern mddev_ident_t conf_get_ident(char *conffile, char *dev);
 246 extern mddev_dev_t conf_get_devs(char *conffile);
 247 extern char *conf_get_mailaddr(char *conffile);
 248 extern char *conf_get_program(char *conffile);
 249 extern char *conf_line(FILE *file);
 250 extern char *conf_word(FILE *file, int allow_key);
 251 extern void free_line(char *line);
 252 extern int match_oneof(char *devices, char *devname);
 253 extern void uuid_from_super(int uuid[4], mdp_super_t *super);
 254 extern int same_uuid(int a[4], int b[4]);
 255 /* extern int compare_super(mdp_super_t *first, mdp_super_t *second);*/
 256 extern unsigned long calc_csum(void *super, int bytes);
 257 extern int store_super(int fd, mdp_super_t *super);
 258 extern int enough(int level, int raid_disks, int avail_disks);
 259 extern int ask(char *mesg);
 260
 261
 262 extern char *human_size(long long bytes);
 263 char *human_size_brief(long long bytes);
 264
 265 extern void put_md_name(char *name);
 266 extern char *get_md_name(int dev);
 267
 268 extern char DefaultConfFile[];
 269
 270 extern int open_mddev(char *dev, int autof);
 271
 272
 273 #define LEVEL_MULTIPATH         (-4)
 274 #define LEVEL_LINEAR            (-1)
 275 #define LEVEL_FAULTY            (-5)
 276
 277
 278 /* faulty stuff */
 279
 280 #define WriteTransient  0
 281 #define ReadTransient   1
 282 #define WritePersistent 2
 283 #define ReadPersistent  3
 284 #define WriteAll        4 /* doesn't go to device */
 285 #define ReadFixable     5
 286 #define Modes   6
 287
 288 #define ClearErrors     31
 289 #define ClearFaults     30
 290
 291 #define AllPersist      100 /* internal use only */
 292 #define NoPersist       101
 293
 294 #define ModeMask        0x1f
 295 #define ModeShift       5