]> git.ipfire.org Git - thirdparty/mdadm.git/blame - mdadm.h
Assemble: Handle assembling from config file which is out of order.
[thirdparty/mdadm.git] / mdadm.h
CommitLineData
64c4757e 1/*
9a9dab36 2 * mdadm - manage Linux "md" devices aka RAID arrays.
64c4757e 3 *
e736b623 4 * Copyright (C) 2001-2009 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
e736b623 22 * Email: <neilb@suse.de>
64c4757e
NB
23 */
24
4ccdb956 25#define _GNU_SOURCE
c2c9bb6f 26#define _FILE_OFFSET_BITS 64
64c4757e 27#include <unistd.h>
e39b673e 28#if !defined(__dietlibc__) && !defined(__KLIBC__)
64c4757e 29extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
f783ca4f 30#else
fffdbe5e 31# if defined(__NO_STAT64) || __WORDSIZE != 32
f783ca4f
NB
32# define lseek64 lseek
33# endif
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 70
5d4d1b26
N
71#define VAR_RUN "/var/run/mdadm"
72/* ALT_RUN should be somewhere that persists across the pivotroot
73 * from early boot to late boot.
74 * If you don't have /lib/init/rw you might want to use /dev/.something
75 */
76#ifndef ALT_RUN
77#define ALT_RUN "/lib/init/rw/mdadm"
78#endif /* ALT_RUN */
79
64c4757e 80#include "md_u.h"
e0d19036 81#include "md_p.h"
c82f047c 82#include "bitmap.h"
f7dd881f 83#include "msg.h"
64c4757e 84
1e0d770c 85#include <endian.h>
efd441d1
NB
86/* Redhat don't like to #include <asm/byteorder.h>, and
87 * some time include <linux/byteorder/xxx_endian.h> isn't enough,
88 * and there is no standard conversion function so... */
0ae03b8a
NB
89/* And dietlibc doesn't think byteswap is ok, so.. */
90/* #include <byteswap.h> */
91#define bswap_16(x) (((x) & 0x00ffU) << 8 | \
92 ((x) & 0xff00U) >> 8)
93#define bswap_32(x) (((x) & 0x000000ffU) << 24 | \
94 ((x) & 0xff000000U) >> 24 | \
95 ((x) & 0x0000ff00U) << 8 | \
96 ((x) & 0x00ff0000U) >> 8)
97#define bswap_64(x) (((x) & 0x00000000000000ffULL) << 56 | \
98 ((x) & 0xff00000000000000ULL) >> 56 | \
99 ((x) & 0x000000000000ff00ULL) << 40 | \
100 ((x) & 0x00ff000000000000ULL) >> 40 | \
101 ((x) & 0x0000000000ff0000ULL) << 24 | \
102 ((x) & 0x0000ff0000000000ULL) >> 24 | \
103 ((x) & 0x00000000ff000000ULL) << 8 | \
104 ((x) & 0x000000ff00000000ULL) >> 8)
105
e39b673e 106#if !defined(__KLIBC__)
efd441d1
NB
107#if BYTE_ORDER == LITTLE_ENDIAN
108#define __cpu_to_le16(_x) (_x)
109#define __cpu_to_le32(_x) (_x)
110#define __cpu_to_le64(_x) (_x)
111#define __le16_to_cpu(_x) (_x)
112#define __le32_to_cpu(_x) (_x)
113#define __le64_to_cpu(_x) (_x)
974e620d
NB
114
115#define __cpu_to_be16(_x) bswap_16(_x)
116#define __cpu_to_be32(_x) bswap_32(_x)
117#define __cpu_to_be64(_x) bswap_64(_x)
118#define __be16_to_cpu(_x) bswap_16(_x)
119#define __be32_to_cpu(_x) bswap_32(_x)
120#define __be64_to_cpu(_x) bswap_64(_x)
efd441d1
NB
121#elif BYTE_ORDER == BIG_ENDIAN
122#define __cpu_to_le16(_x) bswap_16(_x)
123#define __cpu_to_le32(_x) bswap_32(_x)
124#define __cpu_to_le64(_x) bswap_64(_x)
125#define __le16_to_cpu(_x) bswap_16(_x)
126#define __le32_to_cpu(_x) bswap_32(_x)
127#define __le64_to_cpu(_x) bswap_64(_x)
974e620d
NB
128
129#define __cpu_to_be16(_x) (_x)
130#define __cpu_to_be32(_x) (_x)
131#define __cpu_to_be64(_x) (_x)
132#define __be16_to_cpu(_x) (_x)
133#define __be32_to_cpu(_x) (_x)
134#define __be64_to_cpu(_x) (_x)
1e0d770c
NB
135#else
136# error "unknown endianness."
137#endif
e39b673e 138#endif /* __KLIBC__ */
1e0d770c
NB
139
140
1e5c6983
DW
141/*
142 * min()/max()/clamp() macros that also do
143 * strict type-checking.. See the
144 * "unnecessary" pointer comparison.
145 */
146#define min(x, y) ({ \
147 typeof(x) _min1 = (x); \
148 typeof(y) _min2 = (y); \
149 (void) (&_min1 == &_min2); \
150 _min1 < _min2 ? _min1 : _min2; })
151
152#define max(x, y) ({ \
153 typeof(x) _max1 = (x); \
154 typeof(y) _max2 = (y); \
155 (void) (&_max1 == &_max2); \
156 _max1 > _max2 ? _max1 : _max2; })
1e0d770c 157
4b1ac34b
NB
158/* general information that might be extracted from a superblock */
159struct mdinfo {
160 mdu_array_info_t array;
161 mdu_disk_info_t disk;
162 __u64 events;
fbf8a0b7 163 int uuid[4];
31317663 164 char name[33];
353632d9 165 unsigned long long data_offset;
598f0d58
NB
166 unsigned long long component_size; /* same as array.size, except in
167 * sectors and up to 64bits.
168 */
da9b4a62
DW
169 unsigned long long custom_array_size; /* size for non-default sized
170 * arrays (in sectors)
171 */
353632d9
NB
172 int reshape_active;
173 unsigned long long reshape_progress;
e1516be1
DW
174 union {
175 unsigned long long resync_start; /* per-array resync position */
176 unsigned long long recovery_start; /* per-device rebuild position */
b7528a20 177 #define MaxSector (~0ULL) /* resync/recovery complete position */
e1516be1 178 };
a67dd8cc 179 unsigned long safe_mode_delay; /* ms delay to mark clean */
353632d9 180 int new_level, delta_disks, new_layout, new_chunk;
06c7f68e 181 int errors;
7e0f6979
NB
182 int cache_size; /* size of raid456 stripe cache*/
183 int mismatch_cnt;
184 char text_version[50];
6e46bf34
DW
185 void *update_private; /* for passing metadata-format
186 * specific update data
187 * between successive calls to
188 * update_super()
189 */
dd15dc4a
NB
190
191 int container_member; /* for assembling external-metatdata arrays
192 * This is to be used internally by metadata
193 * handler only */
06c7f68e
NB
194
195 char sys_name[20];
7e0f6979 196 struct mdinfo *devs;
06c7f68e 197 struct mdinfo *next;
549e9569
NB
198
199 /* Device info for mdmon: */
e1516be1 200 int recovery_fd;
549e9569 201 int state_fd;
8d45d196
DW
202 #define DS_FAULTY 1
203 #define DS_INSYNC 2
204 #define DS_WRITE_MOSTLY 4
205 #define DS_SPARE 8
206 #define DS_BLOCKED 16
207 #define DS_REMOVE 1024
92967543 208 #define DS_UNBLOCK 2048
549e9569
NB
209 int prev_state, curr_state, next_state;
210
4b1ac34b
NB
211};
212
5bbb4842
NB
213struct createinfo {
214 int uid;
215 int gid;
216 int autof;
217 int mode;
38098016 218 int symlinks;
058574b1 219 struct supertype *supertype;
5bbb4842
NB
220};
221
9a9dab36 222#define Name "mdadm"
682c7051 223
e0d19036
NB
224enum mode {
225 ASSEMBLE=1,
226 BUILD,
227 CREATE,
228 MANAGE,
229 MISC,
230 MONITOR,
dd0781e5 231 GROW,
8382f19b 232 INCREMENTAL,
1f48664b 233 AUTODETECT,
e0d19036
NB
234};
235
64c4757e 236extern char short_options[];
024768c4 237extern char short_bitmap_options[];
c06487ce 238extern char short_bitmap_auto_options[];
64c4757e 239extern struct option long_options[];
56eedc1a 240extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5 241 Help_create[], Help_build[], Help_assemble[], Help_grow[],
8382f19b 242 Help_incr[],
e0d19036 243 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e 244
997aed5d
NB
245/* for option that don't have short equivilents, we assign arbitrary
246 * small numbers. '1' means an undecorated option, so we start at '2'.
247 */
248enum special_options {
249 AssumeClean = 2,
250 BitmapChunk,
251 WriteBehind,
252 ReAdd,
253 NoDegraded,
254 Sparc22,
255 BackupFile,
256 HomeHost,
589395d6 257 AutoHomeHost,
38098016 258 Symlinks,
1f48664b 259 AutoDetect,
1770662b 260 Waitclean,
4cce4069 261 DetailPlatform,
997aed5d
NB
262};
263
64c4757e 264/* structures read from config file */
52826846
NB
265/* List of mddevice names and identifiers
266 * Identifiers can be:
267 * uuid=128-hex-uuid
268 * super-minor=decimal-minor-number-from-superblock
269 * devices=comma,separated,list,of,device,names,with,wildcards
270 *
271 * If multiple fields are present, the intersection of all matching
272 * devices is considered
273 */
98c6faba 274#define UnSet (0xfffe)
52826846 275typedef struct mddev_ident_s {
dd0781e5 276 char *devname;
aba69144 277
dd0781e5 278 int uuid_set;
3fa06e9d 279 int uuid[4];
947fd4dd 280 char name[33];
52826846 281
98c6faba 282 unsigned int super_minor;
52826846 283
dd0781e5 284 char *devices; /* comma separated list of device
52826846
NB
285 * names with wild cards
286 */
dd0781e5 287 int level;
98c6faba
NB
288 unsigned int raid_disks;
289 unsigned int spare_disks;
82d9eba6 290 struct supertype *st;
dd0781e5
NB
291 int autof; /* 1 for normal, 2 for partitioned */
292 char *spare_group;
7ef02d01 293 char *bitmap_file;
c82f047c 294 int bitmap_fd;
dd0781e5 295
1771a6e2
N
296 char *container; /* /dev/whatever name of container, or
297 * uuid of container. You would expect
298 * this to be the 'devname' or UUID
dbb44303
N
299 * of some other entry.
300 */
301 char *member; /* subarray within a container */
302
52826846 303 struct mddev_ident_s *next;
b179246f
N
304 union {
305 /* fields needed by different users of this structure */
306 int assembled; /* set when assembly succeeds */
307 };
52826846 308} *mddev_ident_t;
64c4757e
NB
309
310/* List of device names - wildcards expanded */
311typedef struct mddev_dev_s {
312 char *devname;
cd29a5c8
NB
313 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
314 * Not set for names read from .config
315 */
b3d31955 316 char writemostly; /* 1 for 'set writemostly', 2 for 'clear writemostly' */
fe80f49b 317 char re_add;
811e6cbe 318 char used; /* set when used */
9008ed1c
N
319 struct mdinfo *content; /* If devname is a container, this might list
320 * the remaining member arrays. */
64c4757e
NB
321 struct mddev_dev_s *next;
322} *mddev_dev_t;
323
682c7051
NB
324typedef struct mapping {
325 char *name;
326 int num;
327} mapping_t;
328
e0d19036
NB
329
330struct mdstat_ent {
331 char *dev;
332 int devnum;
333 int active;
334 char *level;
335 char *pattern; /* U or up, _ for down */
336 int percent; /* -1 if no resync */
e5329c37 337 int resync; /* 1 if resync, 0 if recovery */
549e9569
NB
338 int devcnt;
339 int raid_disks;
340 int chunk_size;
341 char * metadata_version;
e0d19036
NB
342 struct mdstat_ent *next;
343};
344
22a88995 345extern struct mdstat_ent *mdstat_read(int hold, int start);
e0d19036 346extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 347extern void mdstat_wait(int seconds);
58a4ba2a 348extern void mdstat_wait_fd(int fd, const sigset_t *sigmask);
8382f19b
NB
349extern int mddev_busy(int devnum);
350
351struct map_ent {
352 struct map_ent *next;
353 int devnum;
1522c538 354 char metadata[20];
8382f19b 355 int uuid[4];
195254b8 356 int bad;
8382f19b
NB
357 char *path;
358};
1522c538 359extern int map_update(struct map_ent **mpp, int devnum, char *metadata,
8382f19b
NB
360 int uuid[4], char *path);
361extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
f2e55ecc
N
362extern struct map_ent *map_by_devnum(struct map_ent **map, int devnum);
363extern struct map_ent *map_by_name(struct map_ent **map, char *name);
8382f19b
NB
364extern void map_read(struct map_ent **melp);
365extern int map_write(struct map_ent *mel);
366extern void map_delete(struct map_ent **mapp, int devnum);
367extern void map_free(struct map_ent *map);
368extern void map_add(struct map_ent **melp,
1522c538 369 int devnum, char *metadata, int uuid[4], char *path);
ad5bc697
N
370extern int map_lock(struct map_ent **melp);
371extern void map_unlock(struct map_ent **melp);
e0d19036 372
e86c9dd6 373/* various details can be requested */
dab4a513
DW
374enum sysfs_read_flags {
375 GET_LEVEL = (1 << 0),
376 GET_LAYOUT = (1 << 1),
377 GET_COMPONENT = (1 << 2),
378 GET_CHUNK = (1 << 3),
379 GET_CACHE = (1 << 4),
380 GET_MISMATCH = (1 << 5),
381 GET_VERSION = (1 << 6),
382 GET_DISKS = (1 << 7),
383 GET_DEGRADED = (1 << 8),
384 GET_SAFEMODE = (1 << 9),
385 GET_DEVS = (1 << 10), /* gets role, major, minor */
386 GET_OFFSET = (1 << 11),
387 GET_SIZE = (1 << 12),
388 GET_STATE = (1 << 13),
389 GET_ERROR = (1 << 14),
390 SKIP_GONE_DEVS = (1 << 15),
391};
e86c9dd6
NB
392
393/* If fd >= 0, get the array it is open on,
394 * else use devnum. >=0 -> major9. <0.....
395 */
549e9569 396extern int sysfs_open(int devnum, char *devname, char *attr);
f35f2525 397extern void sysfs_init(struct mdinfo *mdi, int fd, int devnum);
7e0f6979
NB
398extern void sysfs_free(struct mdinfo *sra);
399extern struct mdinfo *sysfs_read(int fd, int devnum, unsigned long options);
1770662b
DW
400extern int sysfs_attr_match(const char *attr, const char *str);
401extern int sysfs_match_word(const char *word, char **list);
7e0f6979 402extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 403 char *name, char *val);
7e0f6979 404extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 405 char *name, unsigned long long val);
97590376 406extern int sysfs_uevent(struct mdinfo *sra, char *event);
7236ee7a
N
407extern int sysfs_get_fd(struct mdinfo *sra, struct mdinfo *dev,
408 char *name);
409extern int sysfs_fd_get_ll(int fd, unsigned long long *val);
7e0f6979 410extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 411 char *name, unsigned long long *val);
7236ee7a 412extern int sysfs_fd_get_str(int fd, char *val, int size);
93ecfa01
N
413extern int sysfs_get_str(struct mdinfo *sra, struct mdinfo *dev,
414 char *name, char *val, int size);
8ed3e5e1 415extern int sysfs_set_safemode(struct mdinfo *sra, unsigned long ms);
f35f2525 416extern int sysfs_set_array(struct mdinfo *info, int vers);
2904b26f 417extern int sysfs_add_disk(struct mdinfo *sra, struct mdinfo *sd, int resume);
f1665f72 418extern int sysfs_disk_to_scsi_id(int fd, __u32 *id);
f94d52f4 419extern int sysfs_unique_holder(int devnum, long rdev);
c69b251b 420extern int load_sys(char *path, char *buf);
e86c9dd6
NB
421
422
423extern int save_stripes(int *source, unsigned long long *offsets,
424 int raid_disks, int chunk_size, int level, int layout,
425 int nwrites, int *dest,
a6288483
N
426 unsigned long long start, unsigned long long length,
427 char *buf);
353632d9
NB
428extern int restore_stripes(int *dest, unsigned long long *offsets,
429 int raid_disks, int chunk_size, int level, int layout,
430 int source, unsigned long long read_offset,
431 unsigned long long start, unsigned long long length);
e86c9dd6 432
52826846
NB
433#ifndef Sendmail
434#define Sendmail "/usr/lib/sendmail -t"
435#endif
436
773135f5
NB
437#define SYSLOG_FACILITY LOG_DAEMON
438
682c7051
NB
439extern char *map_num(mapping_t *map, int num);
440extern int map_name(mapping_t *map, char *name);
b640a252 441extern mapping_t r5layout[], r6layout[], pers[], modes[], faultylayout[];
682c7051 442
16c6fa80 443extern char *map_dev(int major, int minor, int create);
64c4757e 444
549e9569 445struct active_array;
2e735d19 446struct metadata_update;
64c4757e 447
6adfd3af
NB
448/* A superswitch provides entry point the a metadata handler.
449 *
450 * The super_switch primarily operates on some "metadata" that
451 * is accessed via the 'supertype'.
452 * This metadata has one of three possible sources.
453 * 1/ It is read from a single device. In this case it may not completely
454 * describe the array or arrays as some information might be on other
455 * devices.
456 * 2/ It is read from all devices in a container. In this case all
457 * information is present.
458 * 3/ It is created by ->init_super / ->add_to_super. In this case it will
459 * be complete once enough ->add_to_super calls have completed.
460 *
461 * When creating an array inside a container, the metadata will be
462 * formed by a combination of 2 and 3. The metadata or the array is read,
463 * then new information is added.
464 *
465 * The metadata must sometimes have a concept of a 'current' array
466 * and a 'current' device.
467 * The 'current' array is set by init_super to be the newly created array,
468 * or is set by super_by_fd when it finds it is looking at an array inside
469 * a container.
470 *
471 * The 'current' device is either the device that the metadata was read from
472 * in case 1, or the last device added by add_to_super in case 3.
473 * Case 2 does not identify a 'current' device.
474 */
f9ce90ba 475extern struct superswitch {
6adfd3af
NB
476
477 /* Used to report details of metadata read from a component
478 * device. ->load_super has been called.
479 */
3da92f27 480 void (*examine_super)(struct supertype *st, char *homehost);
061f2c6a 481 void (*brief_examine_super)(struct supertype *st, int verbose);
4737ae25 482 void (*brief_examine_subarrays)(struct supertype *st, int verbose);
0d726f17 483 void (*export_examine_super)(struct supertype *st);
6adfd3af
NB
484
485 /* Used to report details of an active array.
486 * ->load_super was possibly given a 'component' string.
487 */
3da92f27 488 void (*detail_super)(struct supertype *st, char *homehost);
3da92f27 489 void (*brief_detail_super)(struct supertype *st);
0d726f17 490 void (*export_detail_super)(struct supertype *st);
6adfd3af 491
4cce4069 492 /* Optional: platform hardware / firmware details */
5615172f 493 int (*detail_platform)(int verbose, int enumerate_only);
4cce4069 494
6adfd3af
NB
495 /* Used:
496 * to get uuid to storing in bitmap metadata
497 * and 'reshape' backup-data metadata
498 * To see if a device is being re-added to an array it was part of.
499 */
3da92f27 500 void (*uuid_from_super)(struct supertype *st, int uuid[4]);
6adfd3af 501
8592f29d 502 /* Extract generic details from metadata. This could be details about
6adfd3af
NB
503 * the container, or about an individual array within the container.
504 * The determination is made either by:
505 * load_super being given a 'component' string.
506 * validate_geometry determining what to create.
d2ca6449
NB
507 * The info includes both array information and device information.
508 * The particular device should be:
509 * The last device added by add_to_super
510 * The device the metadata was loaded from by load_super
6adfd3af 511 */
3da92f27 512 void (*getinfo_super)(struct supertype *st, struct mdinfo *info);
6adfd3af
NB
513
514 /* Check if the given metadata is flagged as belonging to "this"
9362c1c8 515 * host. 0 for 'no', 1 for 'yes', -1 for "Don't record homehost"
6adfd3af 516 */
3da92f27 517 int (*match_home)(struct supertype *st, char *homehost);
6adfd3af
NB
518
519 /* Make one of several generic modifications to metadata
520 * prior to assembly (or other times).
521 * sparc2.2 - first bug in early 0.90 metadata
522 * super-minor - change name of 0.90 metadata
523 * summaries - 'correct' any redundant data
524 * resync - mark array as dirty to trigger a resync.
525 * uuid - set new uuid - only 0.90 or 1.x
526 * name - change the name of the array (where supported)
527 * homehost - change which host this array is tied to.
528 * devicesize - If metadata is at start of device, change recorded
529 * device size to match actual device size
530 * byteorder - swap bytes for 0.90 metadata
531 *
532 * force-one - mark that device as uptodate, not old or failed.
533 * force-array - mark array as clean if it would not otherwise
534 * assemble
535 * assemble - not sure how this is different from force-one...
536 * linear-grow-new - add a new device to a linear array, but don't
537 * change the size: so superblock still matches
538 * linear-grow-update - now change the size of the array.
539 */
68c7d6d7 540 int (*update_super)(struct supertype *st, struct mdinfo *info,
3da92f27 541 char *update,
e5eac01f
NB
542 char *devname, int verbose,
543 int uuid_set, char *homehost);
6adfd3af
NB
544
545 /* Create new metadata for new array as described. This could
546 * be a new container, or an array in a pre-existing container.
547 * Also used to zero metadata prior to writing it to invalidate old
548 * metadata.
549 */
3da92f27
NB
550 int (*init_super)(struct supertype *st, mdu_array_info_t *info,
551 unsigned long long size, char *name,
552 char *homehost, int *uuid);
6adfd3af
NB
553
554 /* update the metadata to include new device, either at create or
555 * when hot-adding a spare.
556 */
f20c3968 557 int (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo,
111d01fc 558 int fd, char *devname);
6adfd3af
NB
559
560 /* Write metadata to one device when fixing problems or adding
561 * a new device.
562 */
3da92f27 563 int (*store_super)(struct supertype *st, int fd);
6adfd3af
NB
564
565 /* Write all metadata for this array.
566 */
111d01fc 567 int (*write_init_super)(struct supertype *st);
64557c33 568 int (*compare_super)(struct supertype *st, struct supertype *tst);
3da92f27 569 int (*load_super)(struct supertype *st, int fd, char *devname);
82d9eba6 570 struct supertype * (*match_metadata_desc)(char *arg);
1bf4e2d9 571 __u64 (*avail_size)(struct supertype *st, __u64 size);
3da92f27 572 int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
199171a2 573 int delay, int write_behind,
f9c25f1d 574 unsigned long long size, int may_change, int major);
3da92f27
NB
575 void (*locate_bitmap)(struct supertype *st, int fd);
576 int (*write_bitmap)(struct supertype *st, int fd);
577 void (*free_super)(struct supertype *st);
78e44928
NB
578
579 /* validate_geometry is called with an st returned by
580 * match_metadata_desc.
581 * It should check that the geometry described in compatible with
582 * the metadata type. It will be called repeatedly as devices
583 * added to validate changing size and new devices. If there are
584 * inter-device dependencies, it should record sufficient details
585 * so these can be validated.
e46273eb 586 * Both 'size' and '*freesize' are in sectors. chunk is bytes.
78e44928 587 */
17f25ca6
NB
588 int (*validate_geometry)(struct supertype *st, int level, int layout,
589 int raiddisks,
590 int chunk, unsigned long long size,
2c514b71
NB
591 char *subdev, unsigned long long *freesize,
592 int verbose);
598f0d58
NB
593
594 struct mdinfo *(*container_content)(struct supertype *st);
a18a888e
DW
595 /* Allow a metadata handler to override mdadm's default layouts */
596 int (*default_layout)(int level); /* optional */
598f0d58 597
549e9569 598/* for mdmon */
cba0191b
NB
599 int (*open_new)(struct supertype *c, struct active_array *a,
600 char *inst);
ed9d66aa
NB
601
602 /* Tell the metadata handler the current state of the array.
603 * This covers whether it is known to be consistent (no pending writes)
01f157d7 604 * and how far along a resync is known to have progressed
ed9d66aa
NB
605 * (in a->resync_start).
606 * resync status is really irrelevant if the array is not consistent,
607 * but some metadata (DDF!) have a place to record the distinction.
01f157d7
N
608 * If 'consistent' is '2', then the array can mark it dirty if a
609 * resync/recovery/whatever is required, or leave it clean if not.
610 * Return value is 0 dirty (not consistent) and 1 if clean.
611 * it is only really important if consistent is passed in as '2'.
4e5528c6 612 */
01f157d7 613 int (*set_array_state)(struct active_array *a, int consistent);
7a7cc504
NB
614
615 /* When the state of a device might have changed, we call set_disk to
616 * tell the metadata what the current state is.
617 * Typically this happens on spare->in_sync and (spare|in_sync)->faulty
618 * transitions.
619 * set_disk might be called when the state of the particular disk has
620 * not in fact changed.
621 */
8d45d196 622 void (*set_disk)(struct active_array *a, int n, int state);
2e735d19
NB
623 void (*sync_metadata)(struct supertype *st);
624 void (*process_update)(struct supertype *st,
625 struct metadata_update *update);
edd8d13c
NB
626 void (*prepare_update)(struct supertype *st,
627 struct metadata_update *update);
549e9569 628
6c3fb95c
NB
629 /* activate_spare will check if the array is degraded and, if it
630 * is, try to find some spare space in the container.
631 * On success, it add appropriate updates (For process_update) to
632 * to the 'updates' list and returns a list of 'mdinfo' identifying
633 * the device, or devices as there might be multiple missing
634 * devices and multiple spares available.
635 */
636 struct mdinfo *(*activate_spare)(struct active_array *a,
637 struct metadata_update **updates);
549e9569 638
f277ce36 639 int swapuuid; /* true if uuid is bigending rather than hostendian */
d03373f1 640 int external;
4cce4069 641 const char *name; /* canonical metadata name */
0063ecba 642} super0, super1, super_ddf, *superlist[];
82d9eba6 643
0063ecba 644extern struct superswitch super_imsm;
cdddbdbc 645
edd8d13c
NB
646struct metadata_update {
647 int len;
648 char *buf;
649 void *space; /* allocated space that monitor will use */
650 struct metadata_update *next;
651};
652
6adfd3af
NB
653/* A supertype holds a particular collection of metadata.
654 * It identifies the metadata type by the superswitch, and the particular
655 * sub-version of that metadata type.
656 * metadata read in or created is stored in 'sb' and 'info'.
657 * There are also fields used by mdmon to track containers.
658 *
352452c3
N
659 * A supertype may refer to:
660 * Just an array, possibly in a container
661 * A container, not identifying any particular array
662 * Info read from just one device, not yet fully describing the array/container.
663 *
664 *
6adfd3af
NB
665 * A supertype is created by:
666 * super_by_fd
667 * guess_super
668 * dup_super
669 */
82d9eba6
NB
670struct supertype {
671 struct superswitch *ss;
672 int minor_version;
ea329559 673 int max_devs;
2f6079dc 674 int container_dev; /* devnum of container */
f7e7067b 675 char subarray[32]; /* name of array inside container */
64557c33 676 void *sb;
111d01fc 677 void *info;
352452c3
N
678 int loaded_container; /* Set if load_super found a container,
679 * not just one device */
549e9569 680
edd8d13c
NB
681 struct metadata_update *updates;
682 struct metadata_update **update_tail;
683
549e9569
NB
684 /* extra stuff used by mdmon */
685 struct active_array *arrays;
549e9569 686 int sock; /* listen to external programs */
549e9569
NB
687 int devnum;
688 char *devname; /* e.g. md0. This appears in metadata_verison:
689 * external:/md0/12
690 */
691 int devcnt;
692
693 struct mdinfo *devs;
694
82d9eba6 695};
f9ce90ba 696
1686dc25 697extern struct supertype *super_by_fd(int fd);
82d9eba6 698extern struct supertype *guess_super(int fd);
3da92f27 699extern struct supertype *dup_super(struct supertype *st);
beae1dfe 700extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
8382f19b
NB
701extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
702 mdu_disk_info_t *disk);
a7c6e3fb 703void wait_for(char *dev, int fd);
f9ce90ba 704
838acbc2
NB
705#if __GNUC__ < 3
706struct stat64;
707#endif
708
45e878bb
NB
709#define HAVE_NFTW we assume
710#define HAVE_FTW
711
2df1f269 712#ifdef __UCLIBC__
45e878bb 713# include <features.h>
2df1f269
BRF
714# ifndef __UCLIBC_HAS_LFS__
715# define lseek64 lseek
716# endif
45e878bb
NB
717# ifndef __UCLIBC_HAS_FTW__
718# undef HAVE_FTW
719# undef HAVE_NFTW
720# endif
721#endif
722
723#ifdef __dietlibc__
724# undef HAVE_NFTW
725#endif
726
e39b673e 727#if defined(__KLIBC__)
728# undef HAVE_NFTW
729# undef HAVE_FTW
730#endif
731
45e878bb 732#ifndef HAVE_NFTW
173fc515 733# define FTW_PHYS 1
45e878bb
NB
734# ifndef HAVE_FTW
735 struct FTW {};
173fc515
NB
736# endif
737#endif
738
45e878bb
NB
739#ifdef HAVE_FTW
740# include <ftw.h>
741#endif
742
173fc515
NB
743extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
744
f9ce90ba 745
64c4757e 746extern int Manage_ro(char *devname, int fd, int readonly);
91f068bf 747extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
dd0781e5 748extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
64c4757e 749extern int Manage_subdevs(char *devname, int fd,
dab6685f 750 mddev_dev_t devlist, int verbose);
1f48664b 751extern int autodetect(void);
e5329c37 752extern int Grow_Add_device(char *devname, int fd, char *newdev);
8fac0577 753extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
06b0d786 754extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
e86c9dd6 755 long long size,
19678e53 756 int level, char *layout_str, int chunksize, int raid_disks);
06b0d786 757extern int Grow_restart(struct supertype *st, struct mdinfo *info,
ea0ebe96 758 int *fdlist, int cnt, char *backup_file, int verbose);
e9e43ec3
N
759extern int Grow_continue(int mdfd, struct supertype *st,
760 struct mdinfo *info, char *backup_file);
64c4757e 761
7f91af49 762extern int Assemble(struct supertype *st, char *mddev,
52826846 763 mddev_ident_t ident,
06b0d786 764 mddev_dev_t devlist, char *backup_file,
64c4757e 765 int readonly, int runstop,
0ac91628 766 char *update, char *homehost, int require_homehost,
64c4757e
NB
767 int verbose, int force);
768
7f91af49
N
769extern int Build(char *mddev, int chunk, int level, int layout,
770 int raiddisks, mddev_dev_t devlist, int assume_clean,
771 char *bitmap_file, int bitmap_chunk, int write_behind,
83208785 772 int delay, int verbose, int autof, unsigned long long size);
64c4757e
NB
773
774
7f91af49 775extern int Create(struct supertype *st, char *mddev,
5dd497ee 776 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
3d3dd91e 777 char *name, char *homehost, int *uuid,
cd29a5c8 778 int subdevs, mddev_dev_t devlist,
47d79ef8 779 int runstop, int verbose, int force, int assume_clean,
7f91af49 780 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int autof);
64c4757e 781
54bad364 782extern int Detail(char *dev, int brief, int export, int test, char *homehost);
4cce4069 783extern int Detail_Platform(struct superswitch *ss, int scan, int verbose);
e0d19036 784extern int Query(char *dev);
0d726f17
KS
785extern int Examine(mddev_dev_t devlist, int brief, int export, int scan,
786 int SparcAdjust, struct supertype *forcest, char *homehost);
cd29a5c8 787extern int Monitor(mddev_dev_t devlist,
e0d19036 788 char *mailaddr, char *alert_cmd,
aa88f531 789 int period, int daemonise, int scan, int oneshot,
9a36a9b7 790 int dosyslog, int test, char *pidfile, int increments);
64c4757e 791
9277cc77 792extern int Kill(char *dev, struct supertype *st, int force, int quiet, int noexcl);
b90c0e9a 793extern int Wait(char *dev);
9f1da824 794extern int WaitClean(char *dev, int sock, int verbose);
9a9dab36 795
8382f19b 796extern int Incremental(char *devname, int verbose, int runstop,
0ac91628
N
797 struct supertype *st, char *homehost, int require_homehost,
798 int autof);
598f0d58 799extern int Incremental_container(struct supertype *st, char *devname,
215bb3f7
N
800 int verbose, int runstop, int autof,
801 int trustworthy);
8382f19b
NB
802extern void RebuildMap(void);
803extern int IncrementalScan(int verbose);
804
c82f047c
NB
805extern int CreateBitmap(char *filename, int force, char uuid[16],
806 unsigned long chunksize, unsigned long daemon_sleep,
dfd4d8ee 807 unsigned long write_behind,
dcec9ee5
NB
808 unsigned long long array_size,
809 int major);
55935d51 810extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
bf4fb153 811extern int bitmap_update_uuid(int fd, int *uuid, int swap);
2a528478 812extern unsigned long bitmap_sectors(struct bitmap_super_s *bsb);
c82f047c 813
64c4757e 814extern int md_get_version(int fd);
e0d19036 815extern int get_linux_version(void);
84e11361 816extern long long parse_size(char *size);
64c4757e 817extern int parse_uuid(char *str, int uuid[4]);
4a06e2c2
N
818extern int parse_layout_10(char *layout);
819extern int parse_layout_faulty(char *layout);
682c7051
NB
820extern int check_ext2(int fd, char *name);
821extern int check_reiser(int fd, char *name);
822extern int check_raid(int fd, char *name);
034b203a 823extern int check_partitions(int fd, char *dname, unsigned long long freesize);
64c4757e 824
dd0781e5 825extern int get_mdp_major(void);
8b0dabea 826extern int dev_open(char *dev, int flags);
e8a70c89 827extern int open_dev(int devnum);
a931db9e 828extern int open_dev_excl(int devnum);
8d80900b 829extern int is_standard(char *dev, int *nump);
9008ed1c 830extern int same_dev(char *one, char *two);
dd0781e5 831
f1ae21c4 832extern int parse_auto(char *str, char *msg, int config);
8aec876d
NB
833extern mddev_ident_t conf_get_ident(char *dev);
834extern mddev_dev_t conf_get_devs(void);
8382f19b 835extern int conf_test_dev(char *devname);
31015d57 836extern int conf_test_metadata(const char *version);
8aec876d
NB
837extern struct createinfo *conf_get_create_info(void);
838extern void set_conffile(char *file);
839extern char *conf_get_mailaddr(void);
840extern char *conf_get_mailfrom(void);
841extern char *conf_get_program(void);
0ac91628 842extern char *conf_get_homehost(int *require_homehostp);
e0d19036 843extern char *conf_line(FILE *file);
98c6faba 844extern char *conf_word(FILE *file, int allow_key);
0ac91628
N
845extern int conf_name_is_free(char *name);
846extern int devname_matches(char *name, char *match);
360b4636 847extern struct mddev_ident_s *conf_match(struct mdinfo *info, struct supertype *st);
0ac91628 848
e0d19036
NB
849extern void free_line(char *line);
850extern int match_oneof(char *devices, char *devname);
e0d19036 851extern void uuid_from_super(int uuid[4], mdp_super_t *super);
36ba7d48 852extern const int uuid_match_any[4];
f277ce36 853extern int same_uuid(int a[4], int b[4], int swapuuid);
350f29f9 854extern void copy_uuid(void *a, int b[4], int swapuuid);
aae5a112 855extern char *__fname_from_uuid(int id[4], int swap, char *buf, char sep);
d7288ddc 856extern char *fname_from_uuid(struct supertype *st,
ff54de6e 857 struct mdinfo *info, char *buf, char sep);
4b1ac34b 858extern unsigned long calc_csum(void *super, int bytes);
583315d9 859extern int enough(int level, int raid_disks, int layout, int clean,
265e0f17 860 char *avail, int avail_disks);
e0d19036 861extern int ask(char *mesg);
8fac0577 862extern unsigned long long get_component_size(int fd);
0430ed48 863extern void remove_partitions(int fd);
5f8097be
NB
864extern unsigned long long calc_array_size(int level, int raid_disks, int layout,
865 int chunksize, unsigned long long devsize);
edd8d13c
NB
866extern int flush_metadata_updates(struct supertype *st);
867extern void append_metadata_update(struct supertype *st, void *buf, int len);
6234c63c
DW
868extern int assemble_container_content(struct supertype *st, int mdfd,
869 struct mdinfo *content, int runstop,
870 char *chosen_name, int verbose);
e0d19036 871
7801ac20
N
872extern int add_disk(int mdfd, struct supertype *st,
873 struct mdinfo *sra, struct mdinfo *info);
f35f2525 874extern int set_array_info(int mdfd, struct supertype *st, struct mdinfo *info);
1e5c6983 875unsigned long long min_recovery_start(struct mdinfo *array);
cd29a5c8 876
56eb10c0 877extern char *human_size(long long bytes);
e4965ef8
N
878extern char *human_size_brief(long long bytes);
879extern void print_r10_layout(int layout);
e0d19036 880
63152c1b
NB
881#define NoMdDev (1<<23)
882extern int find_free_devnum(int use_partitions);
883
e0d19036
NB
884extern void put_md_name(char *name);
885extern char *get_md_name(int dev);
886
c913b90e 887extern char DefaultConfFile[];
b5e64645 888
69207ff6
N
889extern int create_mddev(char *dev, char *name, int autof, int trustworthy,
890 char *chosen);
891/* values for 'trustworthy' */
892#define LOCAL 1
893#define FOREIGN 2
894#define METADATA 3
6be1d39d 895extern int open_mddev(char *dev, int report_errors);
a322f70c 896extern int open_container(int fd);
b5e64645 897
5d4d1b26 898extern char *pid_dir;
a931db9e 899extern int mdmon_running(int devnum);
24f6f99b 900extern int mdmon_pid(int devnum);
40ebbb9c 901extern int check_env(char *name);
148acb7b 902extern __u32 random32(void);
8850ee3e 903extern int start_mdmon(int devnum);
a931db9e 904
2f6079dc 905extern char *devnum2devname(int num);
77472ff8 906extern int devname2devnum(char *name);
c94709e8 907extern int stat2devnum(struct stat *st);
2f6079dc 908extern int fd2devnum(int fd);
b5e64645 909
a931db9e
NB
910static inline int dev2major(int d)
911{
912 if (d >= 0)
913 return MD_MAJOR;
914 else
915 return get_mdp_major();
916}
917
918static inline int dev2minor(int d)
919{
920 if (d >= 0)
921 return d;
922 return (-1-d) << MdpMinorShift;
923}
924
6416d527
NB
925static inline int ROUND_UP(int a, int base)
926{
927 return ((a+base-1)/base)*base;
928}
929
3c558363
N
930static inline int is_subarray(char *vers)
931{
e9dd1598
N
932 /* The version string for a 'subarray' (an array in a container)
933 * is
934 * /containername/componentname for normal read-write arrays
935 * -containername/componentname for read-only arrays.
936 * containername is e.g. md0, md_d1
937 * componentname is dependant on the metadata. e.g. '1' 'S1' ...
938 */
939 return (*vers == '/' || *vers == '-');
3c558363
N
940}
941
2a24d7b6
DW
942#ifdef DEBUG
943#define dprintf(fmt, arg...) \
944 fprintf(stderr, fmt, ##arg)
945#else
946#define dprintf(fmt, arg...) \
947 ({ if (0) fprintf(stderr, fmt, ##arg); 0; })
948#endif
1a0ee0ba
DK
949#include <assert.h>
950#include <stdarg.h>
951static inline int xasprintf(char **strp, const char *fmt, ...) {
952 va_list ap;
953 int ret;
954 va_start(ap, fmt);
089485cb 955 ret = vasprintf(strp, fmt, ap);
1a0ee0ba
DK
956 va_end(ap);
957 assert(ret >= 0);
958 return ret;
959}
2a24d7b6 960
b5e64645
NB
961#define LEVEL_MULTIPATH (-4)
962#define LEVEL_LINEAR (-1)
963#define LEVEL_FAULTY (-5)
964
17f25ca6
NB
965/* kernel module doesn't know about these */
966#define LEVEL_CONTAINER (-100)
a322f70c 967#define LEVEL_UNSUPPORTED (-200)
17f25ca6 968
b5e64645
NB
969
970/* faulty stuff */
971
972#define WriteTransient 0
973#define ReadTransient 1
974#define WritePersistent 2
975#define ReadPersistent 3
976#define WriteAll 4 /* doesn't go to device */
977#define ReadFixable 5
978#define Modes 6
979
980#define ClearErrors 31
981#define ClearFaults 30
982
983#define AllPersist 100 /* internal use only */
984#define NoPersist 101
985
986#define ModeMask 0x1f
987#define ModeShift 5
fe6729fa
NB
988
989
990#ifdef __TINYC__
991#undef minor
992#undef major
993#undef makedev
994#define minor(x) ((x)&0xff)
995#define major(x) (((x)>>8)&0xff)
996#define makedev(M,m) (((M)<<8) | (m))
997#endif
998
b640a252 999/* for raid4/5/6 */
e86c9dd6
NB
1000#define ALGORITHM_LEFT_ASYMMETRIC 0
1001#define ALGORITHM_RIGHT_ASYMMETRIC 1
1002#define ALGORITHM_LEFT_SYMMETRIC 2
1003#define ALGORITHM_RIGHT_SYMMETRIC 3
b640a252
N
1004
1005/* Define non-rotating (raid4) algorithms. These allow
1006 * conversion of raid4 to raid5.
1007 */
1008#define ALGORITHM_PARITY_0 4 /* P or P,Q are initial devices */
1009#define ALGORITHM_PARITY_N 5 /* P or P,Q are final devices. */
1010
1011/* DDF RAID6 layouts differ from md/raid6 layouts in two ways.
1012 * Firstly, the exact positioning of the parity block is slightly
1013 * different between the 'LEFT_*' modes of md and the "_N_*" modes
1014 * of DDF.
1015 * Secondly, or order of datablocks over which the Q syndrome is computed
1016 * is different.
1017 * Consequently we have different layouts for DDF/raid6 than md/raid6.
1018 * These layouts are from the DDFv1.2 spec.
1019 * Interestingly DDFv1.2-Errata-A does not specify N_CONTINUE but
1020 * leaves RLQ=3 as 'Vendor Specific'
1021 */
1022
1023#define ALGORITHM_ROTATING_ZERO_RESTART 8 /* DDF PRL=6 RLQ=1 */
1024#define ALGORITHM_ROTATING_N_RESTART 9 /* DDF PRL=6 RLQ=2 */
1025#define ALGORITHM_ROTATING_N_CONTINUE 10 /*DDF PRL=6 RLQ=3 */
1026
1027
1028/* For every RAID5 algorithm we define a RAID6 algorithm
1029 * with exactly the same layout for data and parity, and
1030 * with the Q block always on the last device (N-1).
1031 * This allows trivial conversion from RAID5 to RAID6
1032 */
1033#define ALGORITHM_LEFT_ASYMMETRIC_6 16
1034#define ALGORITHM_RIGHT_ASYMMETRIC_6 17
1035#define ALGORITHM_LEFT_SYMMETRIC_6 18
1036#define ALGORITHM_RIGHT_SYMMETRIC_6 19
1037#define ALGORITHM_PARITY_0_6 20
1038#define ALGORITHM_PARITY_N_6 ALGORITHM_PARITY_N
1039
33a6535d
AW
1040/* Define PATH_MAX in case we don't use glibc or standard library does
1041 * not have PATH_MAX defined. Assume max path length is 4K characters.
1042 */
1043#ifndef PATH_MAX
1044#define PATH_MAX 4096
1045#endif
1046