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