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