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