]> git.ipfire.org Git - thirdparty/mdadm.git/blame - mdadm.h
kill-subarray: fix, IMSM cannot kill-subarray with unsupported metadata
[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
c21e737b 67#define DEFAULT_CHUNK 512
c82f047c
NB
68#define DEFAULT_BITMAP_CHUNK 4096
69#define DEFAULT_BITMAP_DELAY 5
dfd4d8ee 70#define DEFAULT_MAX_WRITE_BEHIND 256
64c4757e 71
753cf905 72/* MAP_DIR should be somewhere that persists across the pivotroot
5d4d1b26 73 * from early boot to late boot.
7f5de63d 74 * Currently /dev seems to be the only option on most distros.
5d4d1b26 75 */
753cf905 76#ifndef MAP_DIR
7f5de63d 77#define MAP_DIR "/dev/.mdadm"
753cf905
DL
78#endif /* MAP_DIR */
79/* MAP_FILE is what we name the map file we put in MAP_DIR, in case you
80 * want something other than the default of "map"
81 */
82#ifndef MAP_FILE
83#define MAP_FILE "map"
84#endif /* MAP_FILE */
85/* MDMON_DIR is where pid and socket files used for communicating
86 * with mdmon normally live. It *should* be /var/run, but when
87 * mdmon is needed at early boot then it needs to write there prior
88 * to /var/run being mounted read/write, and it also then needs to
89 * persist beyond when /var/run is mounter read-only. So, to be
90 * safe, the default is somewhere that is read/write early in the
91 * boot process and stays up as long as possible during shutdown.
92 */
93#ifndef MDMON_DIR
7f5de63d 94#define MDMON_DIR "/dev/.mdadm/"
753cf905 95#endif /* MDMON_DIR */
5d4d1b26 96
403410eb
PC
97/* FAILED_SLOTS is where to save files storing recent removal of array
98 * member in order to allow future reuse of disk inserted in the same
99 * slot for array recovery
100 */
101#ifndef FAILED_SLOTS_DIR
102#define FAILED_SLOTS_DIR "/dev/.mdadm/failed-slots"
103#endif /* FAILED_SLOTS */
104
64c4757e 105#include "md_u.h"
e0d19036 106#include "md_p.h"
c82f047c 107#include "bitmap.h"
f7dd881f 108#include "msg.h"
64c4757e 109
1e0d770c 110#include <endian.h>
efd441d1
NB
111/* Redhat don't like to #include <asm/byteorder.h>, and
112 * some time include <linux/byteorder/xxx_endian.h> isn't enough,
113 * and there is no standard conversion function so... */
0ae03b8a
NB
114/* And dietlibc doesn't think byteswap is ok, so.. */
115/* #include <byteswap.h> */
116#define bswap_16(x) (((x) & 0x00ffU) << 8 | \
117 ((x) & 0xff00U) >> 8)
118#define bswap_32(x) (((x) & 0x000000ffU) << 24 | \
119 ((x) & 0xff000000U) >> 24 | \
120 ((x) & 0x0000ff00U) << 8 | \
121 ((x) & 0x00ff0000U) >> 8)
122#define bswap_64(x) (((x) & 0x00000000000000ffULL) << 56 | \
123 ((x) & 0xff00000000000000ULL) >> 56 | \
124 ((x) & 0x000000000000ff00ULL) << 40 | \
125 ((x) & 0x00ff000000000000ULL) >> 40 | \
126 ((x) & 0x0000000000ff0000ULL) << 24 | \
127 ((x) & 0x0000ff0000000000ULL) >> 24 | \
128 ((x) & 0x00000000ff000000ULL) << 8 | \
129 ((x) & 0x000000ff00000000ULL) >> 8)
130
e39b673e 131#if !defined(__KLIBC__)
efd441d1
NB
132#if BYTE_ORDER == LITTLE_ENDIAN
133#define __cpu_to_le16(_x) (_x)
134#define __cpu_to_le32(_x) (_x)
135#define __cpu_to_le64(_x) (_x)
136#define __le16_to_cpu(_x) (_x)
137#define __le32_to_cpu(_x) (_x)
138#define __le64_to_cpu(_x) (_x)
974e620d
NB
139
140#define __cpu_to_be16(_x) bswap_16(_x)
141#define __cpu_to_be32(_x) bswap_32(_x)
142#define __cpu_to_be64(_x) bswap_64(_x)
143#define __be16_to_cpu(_x) bswap_16(_x)
144#define __be32_to_cpu(_x) bswap_32(_x)
145#define __be64_to_cpu(_x) bswap_64(_x)
efd441d1
NB
146#elif BYTE_ORDER == BIG_ENDIAN
147#define __cpu_to_le16(_x) bswap_16(_x)
148#define __cpu_to_le32(_x) bswap_32(_x)
149#define __cpu_to_le64(_x) bswap_64(_x)
150#define __le16_to_cpu(_x) bswap_16(_x)
151#define __le32_to_cpu(_x) bswap_32(_x)
152#define __le64_to_cpu(_x) bswap_64(_x)
974e620d
NB
153
154#define __cpu_to_be16(_x) (_x)
155#define __cpu_to_be32(_x) (_x)
156#define __cpu_to_be64(_x) (_x)
157#define __be16_to_cpu(_x) (_x)
158#define __be32_to_cpu(_x) (_x)
159#define __be64_to_cpu(_x) (_x)
1e0d770c
NB
160#else
161# error "unknown endianness."
162#endif
e39b673e 163#endif /* __KLIBC__ */
1e0d770c
NB
164
165
1e5c6983
DW
166/*
167 * min()/max()/clamp() macros that also do
168 * strict type-checking.. See the
169 * "unnecessary" pointer comparison.
170 */
171#define min(x, y) ({ \
172 typeof(x) _min1 = (x); \
173 typeof(y) _min2 = (y); \
174 (void) (&_min1 == &_min2); \
175 _min1 < _min2 ? _min1 : _min2; })
176
177#define max(x, y) ({ \
178 typeof(x) _max1 = (x); \
179 typeof(y) _max2 = (y); \
180 (void) (&_max1 == &_max2); \
181 _max1 > _max2 ? _max1 : _max2; })
1e0d770c 182
4b1ac34b
NB
183/* general information that might be extracted from a superblock */
184struct mdinfo {
185 mdu_array_info_t array;
186 mdu_disk_info_t disk;
187 __u64 events;
fbf8a0b7 188 int uuid[4];
31317663 189 char name[33];
353632d9 190 unsigned long long data_offset;
598f0d58
NB
191 unsigned long long component_size; /* same as array.size, except in
192 * sectors and up to 64bits.
193 */
da9b4a62
DW
194 unsigned long long custom_array_size; /* size for non-default sized
195 * arrays (in sectors)
196 */
81219e70
LM
197#define NO_RESHAPE 0
198#define VOLUME_RESHAPE 1
199#define CONTAINER_RESHAPE 2
353632d9
NB
200 int reshape_active;
201 unsigned long long reshape_progress;
6e75048b
AK
202 int recovery_blocked; /* for external metadata it
203 * indicates that there is
204 * reshape in progress in
205 * container,
206 * for native metadata it is
207 * reshape_active field mirror
208 */
e1516be1
DW
209 union {
210 unsigned long long resync_start; /* per-array resync position */
211 unsigned long long recovery_start; /* per-device rebuild position */
b7528a20 212 #define MaxSector (~0ULL) /* resync/recovery complete position */
e1516be1 213 };
a67dd8cc 214 unsigned long safe_mode_delay; /* ms delay to mark clean */
353632d9 215 int new_level, delta_disks, new_layout, new_chunk;
06c7f68e 216 int errors;
f21e18ca 217 unsigned long cache_size; /* size of raid456 stripe cache*/
7e0f6979
NB
218 int mismatch_cnt;
219 char text_version[50];
6e46bf34
DW
220 void *update_private; /* for passing metadata-format
221 * specific update data
222 * between successive calls to
223 * update_super()
224 */
dd15dc4a
NB
225
226 int container_member; /* for assembling external-metatdata arrays
227 * This is to be used internally by metadata
228 * handler only */
97b4d0e9
DW
229 int container_enough; /* flag external handlers can set to
230 * indicate that subarrays have not enough (-1),
231 * enough to start (0), or all expected disks (1) */
06c7f68e 232 char sys_name[20];
7e0f6979 233 struct mdinfo *devs;
06c7f68e 234 struct mdinfo *next;
549e9569
NB
235
236 /* Device info for mdmon: */
e1516be1 237 int recovery_fd;
549e9569 238 int state_fd;
8d45d196
DW
239 #define DS_FAULTY 1
240 #define DS_INSYNC 2
241 #define DS_WRITE_MOSTLY 4
242 #define DS_SPARE 8
243 #define DS_BLOCKED 16
244 #define DS_REMOVE 1024
92967543 245 #define DS_UNBLOCK 2048
549e9569
NB
246 int prev_state, curr_state, next_state;
247
4b1ac34b
NB
248};
249
5bbb4842
NB
250struct createinfo {
251 int uid;
252 int gid;
253 int autof;
254 int mode;
38098016 255 int symlinks;
058574b1 256 struct supertype *supertype;
5bbb4842
NB
257};
258
9a9dab36 259#define Name "mdadm"
682c7051 260
e0d19036
NB
261enum mode {
262 ASSEMBLE=1,
263 BUILD,
264 CREATE,
265 MANAGE,
266 MISC,
267 MONITOR,
dd0781e5 268 GROW,
8382f19b 269 INCREMENTAL,
1f48664b 270 AUTODETECT,
e0d19036
NB
271};
272
64c4757e 273extern char short_options[];
024768c4 274extern char short_bitmap_options[];
c06487ce 275extern char short_bitmap_auto_options[];
64c4757e 276extern struct option long_options[];
56eedc1a 277extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5 278 Help_create[], Help_build[], Help_assemble[], Help_grow[],
8382f19b 279 Help_incr[],
e0d19036 280 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e 281
997aed5d 282/* for option that don't have short equivilents, we assign arbitrary
1c7a808c 283 * numbers later than any 'short' character option.
997aed5d
NB
284 */
285enum special_options {
1c7a808c 286 AssumeClean = 300,
997aed5d
NB
287 BitmapChunk,
288 WriteBehind,
289 ReAdd,
290 NoDegraded,
291 Sparc22,
1c7a808c 292 BackupFile,
997aed5d 293 HomeHost,
589395d6 294 AutoHomeHost,
38098016 295 Symlinks,
1f48664b 296 AutoDetect,
1770662b 297 Waitclean,
4cce4069 298 DetailPlatform,
33414a01 299 KillSubarray,
1c7a808c 300 UpdateSubarray,
edde9560 301 IncrementalPath,
1c7a808c
N
302 NoSharing,
303 HelpOptions,
304 Brief,
305 ManageOpt,
306 Add,
307 Remove,
308 Fail,
309 MiscOpt,
310 WaitOpt,
311 ConfigFile,
312 ChunkSize,
313 WriteMostly,
314 Layout,
315 Auto,
316 Force,
317 SuperMinor,
318 EMail,
319 ProgramOpt,
320 Increment,
321 Fork,
322 Bitmap,
323 RebuildMapOpt,
87f26d14 324 InvalidBackup,
20b60dcd 325 UdevRules,
b76b30e0 326 FreezeReshape,
2dddadb0 327 Continue,
997aed5d
NB
328};
329
64c4757e 330/* structures read from config file */
52826846
NB
331/* List of mddevice names and identifiers
332 * Identifiers can be:
333 * uuid=128-hex-uuid
334 * super-minor=decimal-minor-number-from-superblock
335 * devices=comma,separated,list,of,device,names,with,wildcards
336 *
337 * If multiple fields are present, the intersection of all matching
338 * devices is considered
339 */
98c6faba 340#define UnSet (0xfffe)
fa56eddb 341struct mddev_ident {
dd0781e5 342 char *devname;
aba69144 343
dd0781e5 344 int uuid_set;
3fa06e9d 345 int uuid[4];
947fd4dd 346 char name[33];
52826846 347
f21e18ca 348 int super_minor;
52826846 349
dd0781e5 350 char *devices; /* comma separated list of device
52826846
NB
351 * names with wild cards
352 */
dd0781e5 353 int level;
f21e18ca
N
354 int raid_disks;
355 int spare_disks;
82d9eba6 356 struct supertype *st;
dd0781e5
NB
357 int autof; /* 1 for normal, 2 for partitioned */
358 char *spare_group;
7ef02d01 359 char *bitmap_file;
c82f047c 360 int bitmap_fd;
dd0781e5 361
1771a6e2
N
362 char *container; /* /dev/whatever name of container, or
363 * uuid of container. You would expect
364 * this to be the 'devname' or UUID
dbb44303
N
365 * of some other entry.
366 */
367 char *member; /* subarray within a container */
368
fa56eddb 369 struct mddev_ident *next;
b179246f
N
370 union {
371 /* fields needed by different users of this structure */
372 int assembled; /* set when assembly succeeds */
373 };
fa56eddb 374};
64c4757e
NB
375
376/* List of device names - wildcards expanded */
a655e550 377struct mddev_dev {
64c4757e 378 char *devname;
1c7a808c 379 int disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
cd29a5c8
NB
380 * Not set for names read from .config
381 */
b3d31955 382 char writemostly; /* 1 for 'set writemostly', 2 for 'clear writemostly' */
fe80f49b 383 char re_add;
811e6cbe 384 char used; /* set when used */
a655e550
N
385 struct mddev_dev *next;
386};
64c4757e 387
682c7051
NB
388typedef struct mapping {
389 char *name;
390 int num;
391} mapping_t;
392
e0d19036
NB
393
394struct mdstat_ent {
395 char *dev;
396 int devnum;
397 int active;
398 char *level;
399 char *pattern; /* U or up, _ for down */
400 int percent; /* -1 if no resync */
f94c116f 401 int resync; /* 3 if check, 2 if reshape, 1 if resync, 0 if recovery */
549e9569
NB
402 int devcnt;
403 int raid_disks;
549e9569 404 char * metadata_version;
3b57c466
N
405 struct dev_member {
406 char *name;
407 struct dev_member *next;
408 } *members;
e0d19036
NB
409 struct mdstat_ent *next;
410};
411
22a88995 412extern struct mdstat_ent *mdstat_read(int hold, int start);
e0d19036 413extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 414extern void mdstat_wait(int seconds);
58a4ba2a 415extern void mdstat_wait_fd(int fd, const sigset_t *sigmask);
8382f19b 416extern int mddev_busy(int devnum);
3b57c466 417extern struct mdstat_ent *mdstat_by_component(char *name);
78b10e66 418extern struct mdstat_ent *mdstat_by_subdev(char *subdev, int container);
8382f19b
NB
419
420struct map_ent {
421 struct map_ent *next;
422 int devnum;
1522c538 423 char metadata[20];
8382f19b 424 int uuid[4];
195254b8 425 int bad;
8382f19b
NB
426 char *path;
427};
1522c538 428extern int map_update(struct map_ent **mpp, int devnum, char *metadata,
8382f19b 429 int uuid[4], char *path);
4eb26970 430extern void map_remove(struct map_ent **map, int devnum);
8382f19b 431extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
f2e55ecc
N
432extern struct map_ent *map_by_devnum(struct map_ent **map, int devnum);
433extern struct map_ent *map_by_name(struct map_ent **map, char *name);
8382f19b
NB
434extern void map_read(struct map_ent **melp);
435extern int map_write(struct map_ent *mel);
436extern void map_delete(struct map_ent **mapp, int devnum);
437extern void map_free(struct map_ent *map);
438extern void map_add(struct map_ent **melp,
1522c538 439 int devnum, char *metadata, int uuid[4], char *path);
ad5bc697
N
440extern int map_lock(struct map_ent **melp);
441extern void map_unlock(struct map_ent **melp);
cc700db3 442extern void map_fork(void);
e0d19036 443
e86c9dd6 444/* various details can be requested */
dab4a513
DW
445enum sysfs_read_flags {
446 GET_LEVEL = (1 << 0),
447 GET_LAYOUT = (1 << 1),
448 GET_COMPONENT = (1 << 2),
449 GET_CHUNK = (1 << 3),
450 GET_CACHE = (1 << 4),
451 GET_MISMATCH = (1 << 5),
452 GET_VERSION = (1 << 6),
453 GET_DISKS = (1 << 7),
454 GET_DEGRADED = (1 << 8),
455 GET_SAFEMODE = (1 << 9),
456 GET_DEVS = (1 << 10), /* gets role, major, minor */
457 GET_OFFSET = (1 << 11),
458 GET_SIZE = (1 << 12),
459 GET_STATE = (1 << 13),
460 GET_ERROR = (1 << 14),
dab4a513 461};
e86c9dd6
NB
462
463/* If fd >= 0, get the array it is open on,
464 * else use devnum. >=0 -> major9. <0.....
465 */
549e9569 466extern int sysfs_open(int devnum, char *devname, char *attr);
f35f2525 467extern void sysfs_init(struct mdinfo *mdi, int fd, int devnum);
7e0f6979
NB
468extern void sysfs_free(struct mdinfo *sra);
469extern struct mdinfo *sysfs_read(int fd, int devnum, unsigned long options);
1770662b
DW
470extern int sysfs_attr_match(const char *attr, const char *str);
471extern int sysfs_match_word(const char *word, char **list);
7e0f6979 472extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 473 char *name, char *val);
7e0f6979 474extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 475 char *name, unsigned long long val);
97590376 476extern int sysfs_uevent(struct mdinfo *sra, char *event);
7236ee7a
N
477extern int sysfs_get_fd(struct mdinfo *sra, struct mdinfo *dev,
478 char *name);
479extern int sysfs_fd_get_ll(int fd, unsigned long long *val);
7e0f6979 480extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 481 char *name, unsigned long long *val);
7236ee7a 482extern int sysfs_fd_get_str(int fd, char *val, int size);
bc77ed53
DW
483extern int sysfs_attribute_available(struct mdinfo *sra, struct mdinfo *dev,
484 char *name);
93ecfa01
N
485extern int sysfs_get_str(struct mdinfo *sra, struct mdinfo *dev,
486 char *name, char *val, int size);
8ed3e5e1 487extern int sysfs_set_safemode(struct mdinfo *sra, unsigned long ms);
f35f2525 488extern int sysfs_set_array(struct mdinfo *info, int vers);
2904b26f 489extern int sysfs_add_disk(struct mdinfo *sra, struct mdinfo *sd, int resume);
f1665f72 490extern int sysfs_disk_to_scsi_id(int fd, __u32 *id);
f94d52f4 491extern int sysfs_unique_holder(int devnum, long rdev);
bc77ed53 492extern int sysfs_freeze_array(struct mdinfo *sra);
c69b251b 493extern int load_sys(char *path, char *buf);
130994cb
AK
494extern int reshape_prepare_fdlist(char *devname,
495 struct mdinfo *sra,
496 int raid_disks,
497 int nrdisks,
498 unsigned long blocks,
499 char *backup_file,
500 int *fdlist,
501 unsigned long long *offsets);
502extern void reshape_free_fdlist(int *fdlist,
503 unsigned long long *offsets,
504 int size);
e6e9d47b
AK
505extern int reshape_open_backup_file(char *backup,
506 int fd,
507 char *devname,
508 long blocks,
509 int *fdlist,
a93f87ee
N
510 unsigned long long *offsets,
511 int restart);
1c009fc2
AK
512extern unsigned long compute_backup_blocks(int nchunk, int ochunk,
513 unsigned int ndata, unsigned int odata);
e86c9dd6
NB
514
515extern int save_stripes(int *source, unsigned long long *offsets,
516 int raid_disks, int chunk_size, int level, int layout,
517 int nwrites, int *dest,
a6288483
N
518 unsigned long long start, unsigned long long length,
519 char *buf);
353632d9
NB
520extern int restore_stripes(int *dest, unsigned long long *offsets,
521 int raid_disks, int chunk_size, int level, int layout,
522 int source, unsigned long long read_offset,
2fcb75ae
AK
523 unsigned long long start, unsigned long long length,
524 char *src_buf);
e86c9dd6 525
52826846
NB
526#ifndef Sendmail
527#define Sendmail "/usr/lib/sendmail -t"
528#endif
529
773135f5
NB
530#define SYSLOG_FACILITY LOG_DAEMON
531
682c7051
NB
532extern char *map_num(mapping_t *map, int num);
533extern int map_name(mapping_t *map, char *name);
b640a252 534extern mapping_t r5layout[], r6layout[], pers[], modes[], faultylayout[];
682c7051 535
16c6fa80 536extern char *map_dev(int major, int minor, int create);
64c4757e 537
549e9569 538struct active_array;
2e735d19 539struct metadata_update;
64c4757e 540
999b4972
N
541
542/* 'struct reshape' records the intermediate states
543 * a general reshape.
544 * The starting geometry is converted to the 'before' geometry
545 * by at most an atomic level change. They could be the same.
546 * Similarly the 'after' geometry is converted to the final
547 * geometry by at most a level change.
548 * Note that 'before' and 'after' must have the same level.
549 * 'blocks' is the minimum number of sectors for a reshape unit.
550 * This will be a multiple of the stripe size in each of the
551 * 'before' and 'after' geometries.
552 * If 'blocks' is 0, no restriping is necessary.
553 */
554struct reshape {
555 int level;
556 int parity; /* number of parity blocks/devices */
557 struct {
558 int layout;
559 int data_disks;
560 } before, after;
561 unsigned long long backup_blocks;
562 unsigned long long stripes; /* number of old stripes that comprise 'blocks'*/
563 unsigned long long new_size; /* New size of array in sectors */
564};
565
6adfd3af
NB
566/* A superswitch provides entry point the a metadata handler.
567 *
568 * The super_switch primarily operates on some "metadata" that
569 * is accessed via the 'supertype'.
570 * This metadata has one of three possible sources.
571 * 1/ It is read from a single device. In this case it may not completely
572 * describe the array or arrays as some information might be on other
573 * devices.
574 * 2/ It is read from all devices in a container. In this case all
575 * information is present.
576 * 3/ It is created by ->init_super / ->add_to_super. In this case it will
577 * be complete once enough ->add_to_super calls have completed.
578 *
579 * When creating an array inside a container, the metadata will be
580 * formed by a combination of 2 and 3. The metadata or the array is read,
581 * then new information is added.
582 *
583 * The metadata must sometimes have a concept of a 'current' array
584 * and a 'current' device.
585 * The 'current' array is set by init_super to be the newly created array,
586 * or is set by super_by_fd when it finds it is looking at an array inside
587 * a container.
588 *
589 * The 'current' device is either the device that the metadata was read from
590 * in case 1, or the last device added by add_to_super in case 3.
591 * Case 2 does not identify a 'current' device.
592 */
f9ce90ba 593extern struct superswitch {
6adfd3af
NB
594
595 /* Used to report details of metadata read from a component
596 * device. ->load_super has been called.
597 */
3da92f27 598 void (*examine_super)(struct supertype *st, char *homehost);
061f2c6a 599 void (*brief_examine_super)(struct supertype *st, int verbose);
4737ae25 600 void (*brief_examine_subarrays)(struct supertype *st, int verbose);
0d726f17 601 void (*export_examine_super)(struct supertype *st);
6adfd3af
NB
602
603 /* Used to report details of an active array.
604 * ->load_super was possibly given a 'component' string.
605 */
3da92f27 606 void (*detail_super)(struct supertype *st, char *homehost);
3da92f27 607 void (*brief_detail_super)(struct supertype *st);
0d726f17 608 void (*export_detail_super)(struct supertype *st);
6adfd3af 609
4cce4069 610 /* Optional: platform hardware / firmware details */
5615172f 611 int (*detail_platform)(int verbose, int enumerate_only);
4cce4069 612
6adfd3af
NB
613 /* Used:
614 * to get uuid to storing in bitmap metadata
615 * and 'reshape' backup-data metadata
616 * To see if a device is being re-added to an array it was part of.
617 */
3da92f27 618 void (*uuid_from_super)(struct supertype *st, int uuid[4]);
6adfd3af 619
8592f29d 620 /* Extract generic details from metadata. This could be details about
6adfd3af
NB
621 * the container, or about an individual array within the container.
622 * The determination is made either by:
623 * load_super being given a 'component' string.
624 * validate_geometry determining what to create.
d2ca6449
NB
625 * The info includes both array information and device information.
626 * The particular device should be:
627 * The last device added by add_to_super
628 * The device the metadata was loaded from by load_super
a5d85af7
N
629 * If 'map' is present, then it is an array raid_disks long
630 * (raid_disk must already be set and correct) and it is filled
631 * with 1 for slots that are thought to be active and 0 for slots which
632 * appear to be failed/missing.
95eeceeb 633 * *info is zeroed out before data is added.
6adfd3af 634 */
a5d85af7 635 void (*getinfo_super)(struct supertype *st, struct mdinfo *info, char *map);
5c4cd5da 636 struct mdinfo *(*getinfo_super_disks)(struct supertype *st);
6adfd3af 637 /* Check if the given metadata is flagged as belonging to "this"
9362c1c8 638 * host. 0 for 'no', 1 for 'yes', -1 for "Don't record homehost"
6adfd3af 639 */
3da92f27 640 int (*match_home)(struct supertype *st, char *homehost);
6adfd3af
NB
641
642 /* Make one of several generic modifications to metadata
643 * prior to assembly (or other times).
644 * sparc2.2 - first bug in early 0.90 metadata
645 * super-minor - change name of 0.90 metadata
646 * summaries - 'correct' any redundant data
647 * resync - mark array as dirty to trigger a resync.
648 * uuid - set new uuid - only 0.90 or 1.x
649 * name - change the name of the array (where supported)
650 * homehost - change which host this array is tied to.
651 * devicesize - If metadata is at start of device, change recorded
652 * device size to match actual device size
653 * byteorder - swap bytes for 0.90 metadata
654 *
655 * force-one - mark that device as uptodate, not old or failed.
656 * force-array - mark array as clean if it would not otherwise
657 * assemble
658 * assemble - not sure how this is different from force-one...
659 * linear-grow-new - add a new device to a linear array, but don't
660 * change the size: so superblock still matches
661 * linear-grow-update - now change the size of the array.
16715c01
DL
662 * writemostly - set the WriteMostly1 bit in the superblock devflags
663 * readwrite - clear the WriteMostly1 bit in the superblock devflags
6adfd3af 664 */
68c7d6d7 665 int (*update_super)(struct supertype *st, struct mdinfo *info,
3da92f27 666 char *update,
e5eac01f
NB
667 char *devname, int verbose,
668 int uuid_set, char *homehost);
6adfd3af
NB
669
670 /* Create new metadata for new array as described. This could
671 * be a new container, or an array in a pre-existing container.
672 * Also used to zero metadata prior to writing it to invalidate old
673 * metadata.
674 */
3da92f27
NB
675 int (*init_super)(struct supertype *st, mdu_array_info_t *info,
676 unsigned long long size, char *name,
677 char *homehost, int *uuid);
6adfd3af
NB
678
679 /* update the metadata to include new device, either at create or
680 * when hot-adding a spare.
681 */
f20c3968 682 int (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo,
1a64be56
LM
683 int fd, char *devname);
684 /* update the metadata to delete a device,
685 * when hot-removing.
686 */
687 int (*remove_from_super)(struct supertype *st, mdu_disk_info_t *dinfo);
6adfd3af
NB
688
689 /* Write metadata to one device when fixing problems or adding
690 * a new device.
691 */
3da92f27 692 int (*store_super)(struct supertype *st, int fd);
6adfd3af
NB
693
694 /* Write all metadata for this array.
695 */
111d01fc 696 int (*write_init_super)(struct supertype *st);
64557c33 697 int (*compare_super)(struct supertype *st, struct supertype *tst);
3da92f27 698 int (*load_super)(struct supertype *st, int fd, char *devname);
2b959fbf 699 int (*load_container)(struct supertype *st, int fd, char *devname);
82d9eba6 700 struct supertype * (*match_metadata_desc)(char *arg);
1bf4e2d9 701 __u64 (*avail_size)(struct supertype *st, __u64 size);
80e7f8c3 702 unsigned long long (*min_acceptable_spare_size)(struct supertype *st);
3da92f27 703 int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
199171a2 704 int delay, int write_behind,
f9c25f1d 705 unsigned long long size, int may_change, int major);
3da92f27
NB
706 void (*locate_bitmap)(struct supertype *st, int fd);
707 int (*write_bitmap)(struct supertype *st, int fd);
708 void (*free_super)(struct supertype *st);
78e44928
NB
709
710 /* validate_geometry is called with an st returned by
711 * match_metadata_desc.
712 * It should check that the geometry described in compatible with
713 * the metadata type. It will be called repeatedly as devices
714 * added to validate changing size and new devices. If there are
715 * inter-device dependencies, it should record sufficient details
716 * so these can be validated.
30f58b22 717 * Both 'size' and '*freesize' are in sectors. chunk is KiB.
ecbd9e81
N
718 * Return value is:
719 * 1: everything is OK
720 * 0: not OK for some reason - if 'verbose', then error was reported.
721 * -1: st->sb was NULL, 'subdev' is a member of a container of this
722 * types, but array is not acceptable for some reason
723 * message was reported even if verbose is 0.
78e44928 724 */
17f25ca6
NB
725 int (*validate_geometry)(struct supertype *st, int level, int layout,
726 int raiddisks,
c21e737b 727 int *chunk, unsigned long long size,
2c514b71
NB
728 char *subdev, unsigned long long *freesize,
729 int verbose);
598f0d58 730
00bbdbda 731 struct mdinfo *(*container_content)(struct supertype *st, char *subarray);
30f58b22
DW
732 /* query the supertype for default geometry */
733 void (*default_geometry)(struct supertype *st, int *level, int *layout, int *chunk); /* optional */
33414a01
DW
734 /* Permit subarray's to be deleted from inactive containers */
735 int (*kill_subarray)(struct supertype *st); /* optional */
aa534678 736 /* Permit subarray's to be modified */
a951a4f7 737 int (*update_subarray)(struct supertype *st, char *subarray,
fa56eddb 738 char *update, struct mddev_ident *ident); /* optional */
7bc71196
DW
739 /* Check if reshape is supported for this external format.
740 * st is obtained from super_by_fd() where st->subarray[0] is
741 * initialized to indicate if reshape is being performed at the
742 * container or subarray level
743 */
744 int (*reshape_super)(struct supertype *st, long long size, int level,
745 int layout, int chunksize, int raid_disks,
41784c88
AK
746 int delta_disks, char *backup, char *dev,
747 int verbose); /* optional */
999b4972
N
748 int (*manage_reshape)( /* optional */
749 int afd, struct mdinfo *sra, struct reshape *reshape,
750 struct supertype *st, unsigned long blocks,
751 int *fds, unsigned long long *offsets,
752 int dests, int *destfd, unsigned long long *destoffsets);
598f0d58 753
549e9569 754/* for mdmon */
cba0191b
NB
755 int (*open_new)(struct supertype *c, struct active_array *a,
756 char *inst);
ed9d66aa
NB
757
758 /* Tell the metadata handler the current state of the array.
759 * This covers whether it is known to be consistent (no pending writes)
01f157d7 760 * and how far along a resync is known to have progressed
ed9d66aa
NB
761 * (in a->resync_start).
762 * resync status is really irrelevant if the array is not consistent,
763 * but some metadata (DDF!) have a place to record the distinction.
01f157d7
N
764 * If 'consistent' is '2', then the array can mark it dirty if a
765 * resync/recovery/whatever is required, or leave it clean if not.
766 * Return value is 0 dirty (not consistent) and 1 if clean.
767 * it is only really important if consistent is passed in as '2'.
4e5528c6 768 */
01f157d7 769 int (*set_array_state)(struct active_array *a, int consistent);
7a7cc504
NB
770
771 /* When the state of a device might have changed, we call set_disk to
772 * tell the metadata what the current state is.
773 * Typically this happens on spare->in_sync and (spare|in_sync)->faulty
774 * transitions.
775 * set_disk might be called when the state of the particular disk has
776 * not in fact changed.
777 */
8d45d196 778 void (*set_disk)(struct active_array *a, int n, int state);
2e735d19
NB
779 void (*sync_metadata)(struct supertype *st);
780 void (*process_update)(struct supertype *st,
781 struct metadata_update *update);
edd8d13c
NB
782 void (*prepare_update)(struct supertype *st,
783 struct metadata_update *update);
549e9569 784
6c3fb95c
NB
785 /* activate_spare will check if the array is degraded and, if it
786 * is, try to find some spare space in the container.
787 * On success, it add appropriate updates (For process_update) to
788 * to the 'updates' list and returns a list of 'mdinfo' identifying
789 * the device, or devices as there might be multiple missing
790 * devices and multiple spares available.
791 */
792 struct mdinfo *(*activate_spare)(struct active_array *a,
793 struct metadata_update **updates);
2cda7640
ML
794 /*
795 * Return statically allocated string that represents metadata specific
796 * controller domain of the disk. The domain is used in disk domain
797 * matching functions. Disks belong to the same domain if the they have
798 * the same domain from mdadm.conf and belong the same metadata domain.
799 * Returning NULL or not providing this handler means that metadata
800 * does not distinguish the differences between disks that belong to
801 * different controllers. They are in the domain specified by
802 * configuration file (mdadm.conf).
803 * In case when the metadata has the notion of domains based on disk
804 * it shall return NULL for disks that do not belong to the controller
805 * the supported domains. Such disks will form another domain and won't
806 * be mixed with supported ones.
807 */
808 const char *(*get_disk_controller_domain)(const char *path);
549e9569 809
ba53ea59
AK
810 /* for external backup area */
811 int (*recover_backup)(struct supertype *st, struct mdinfo *info);
812
f277ce36 813 int swapuuid; /* true if uuid is bigending rather than hostendian */
d03373f1 814 int external;
4cce4069 815 const char *name; /* canonical metadata name */
0f22b998 816} *superlist[];
82d9eba6 817
0f22b998
N
818extern struct superswitch super0, super1;
819extern struct superswitch super_imsm, super_ddf;
0592faeb 820extern struct superswitch mbr, gpt;
cdddbdbc 821
edd8d13c
NB
822struct metadata_update {
823 int len;
824 char *buf;
825 void *space; /* allocated space that monitor will use */
cb23f1f4
N
826 void **space_list; /* list of allocated spaces that monitor can
827 * use or that it returned.
828 */
edd8d13c
NB
829 struct metadata_update *next;
830};
831
6adfd3af
NB
832/* A supertype holds a particular collection of metadata.
833 * It identifies the metadata type by the superswitch, and the particular
834 * sub-version of that metadata type.
835 * metadata read in or created is stored in 'sb' and 'info'.
836 * There are also fields used by mdmon to track containers.
837 *
352452c3
N
838 * A supertype may refer to:
839 * Just an array, possibly in a container
840 * A container, not identifying any particular array
841 * Info read from just one device, not yet fully describing the array/container.
842 *
843 *
6adfd3af
NB
844 * A supertype is created by:
845 * super_by_fd
846 * guess_super
847 * dup_super
848 */
82d9eba6
NB
849struct supertype {
850 struct superswitch *ss;
851 int minor_version;
ea329559 852 int max_devs;
2f6079dc 853 int container_dev; /* devnum of container */
64557c33 854 void *sb;
111d01fc 855 void *info;
df3346e6
LM
856 int ignore_hw_compat; /* used to inform metadata handlers that it should ignore
857 HW/firmware related incompatability to load metadata.
858 Used when examining metadata to display content of disk
859 when user has no hw/firmare compatible system.
860 */
edd8d13c
NB
861 struct metadata_update *updates;
862 struct metadata_update **update_tail;
863
549e9569
NB
864 /* extra stuff used by mdmon */
865 struct active_array *arrays;
549e9569 866 int sock; /* listen to external programs */
549e9569
NB
867 int devnum;
868 char *devname; /* e.g. md0. This appears in metadata_verison:
869 * external:/md0/12
870 */
871 int devcnt;
872
873 struct mdinfo *devs;
874
82d9eba6 875};
f9ce90ba 876
4725bc31 877extern struct supertype *super_by_fd(int fd, char **subarray);
54887ad8
N
878enum guess_types { guess_any, guess_array, guess_partitions };
879extern struct supertype *guess_super_type(int fd, enum guess_types guess_type);
880static inline struct supertype *guess_super(int fd) {
881 return guess_super_type(fd, guess_any);
882}
3da92f27 883extern struct supertype *dup_super(struct supertype *st);
beae1dfe 884extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
3a371610 885extern int must_be_container(int fd);
0f0749ad 886extern int dev_size_from_id(dev_t id, unsigned long long *size);
8382f19b
NB
887extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
888 mdu_disk_info_t *disk);
a7c6e3fb 889void wait_for(char *dev, int fd);
f9ce90ba 890
5527fc74
N
891/*
892 * Data structures for policy management.
893 * Each device can have a policy structure that lists
894 * various name/value pairs each possibly with a metadata associated.
895 * The policy list is sorted by name/value/metadata
896 */
897struct dev_policy {
898 struct dev_policy *next;
899 char *name; /* None of these strings are allocated. They are
900 * all just references to strings which are known
901 * to exist elsewhere.
902 * name and metadata can be compared by address equality.
903 */
904 const char *metadata;
2cda7640 905 const char *value;
5527fc74
N
906};
907
4e8d9f0a 908extern char pol_act[], pol_domain[], pol_metadata[], pol_auto[];
5527fc74
N
909
910/* iterate over the sublist starting at list, having the same
911 * 'name' as 'list', and matching the given metadata (Where
912 * NULL matches anything
913 */
914#define pol_for_each(item, list, _metadata) \
915 for (item = list; \
916 item && item->name == list->name; \
917 item = item->next) \
918 if (!(!_metadata || !item->metadata || _metadata == item->metadata)) \
919 ; else
920
921/*
922 * policy records read from mdadm are largely just name-value pairs.
923 * The names are constants, not strdupped
924 */
925struct pol_rule {
926 struct pol_rule *next;
927 char *type; /* rule_policy or rule_part */
928 struct rule {
929 struct rule *next;
930 char *name;
931 char *value;
932 char *dups; /* duplicates of 'value' with a partNN appended */
933 } *rule;
934};
935
936extern char rule_policy[], rule_part[];
937extern char rule_path[], rule_type[];
938extern char type_part[], type_disk[];
939
940extern void policyline(char *line, char *type);
4e8d9f0a 941extern void policy_add(char *type, ...);
5527fc74
N
942extern void policy_free(void);
943
73c9c47c 944extern struct dev_policy *path_policy(char *path, char *type);
5527fc74 945extern struct dev_policy *disk_policy(struct mdinfo *disk);
4e8d9f0a 946extern struct dev_policy *devnum_policy(int dev);
5527fc74
N
947extern void dev_policy_free(struct dev_policy *p);
948
e78dda3b
N
949//extern void pol_new(struct dev_policy **pol, char *name, char *val, char *metadata);
950extern void pol_add(struct dev_policy **pol, char *name, char *val, char *metadata);
5527fc74
N
951extern struct dev_policy *pol_find(struct dev_policy *pol, char *name);
952
e3bb5f14
N
953enum policy_action {
954 act_default,
955 act_include,
956 act_re_add,
d2db3045
N
957 act_spare, /* This only applies to bare devices */
958 act_spare_same_slot, /* this allows non-bare devices,
959 * but only if recent removal */
960 act_force_spare, /* this allow non-bare devices in any case */
e3bb5f14
N
961 act_err
962};
963
964extern int policy_action_allows(struct dev_policy *plist, const char *metadata,
965 enum policy_action want);
966extern int disk_action_allows(struct mdinfo *disk, const char *metadata,
967 enum policy_action want);
f5f12c84
N
968
969struct domainlist {
970 struct domainlist *next;
2cda7640 971 const char *dom;
f5f12c84
N
972};
973
974extern int domain_test(struct domainlist *dom, struct dev_policy *pol,
975 const char *metadata);
976extern struct domainlist *domain_from_array(struct mdinfo *mdi,
977 const char *metadata);
e78dda3b
N
978extern void domainlist_add_dev(struct domainlist **dom, int devnum,
979 const char *metadata);
f5f12c84
N
980extern void domain_free(struct domainlist *dl);
981extern void domain_merge(struct domainlist **domp, struct dev_policy *pol,
982 const char *metadata);
e78dda3b 983void domain_add(struct domainlist **domp, char *domain);
f5f12c84 984
403410eb
PC
985extern void policy_save_path(char *id_path, struct map_ent *array);
986extern int policy_check_path(struct mdinfo *disk, struct map_ent *array);
987
838acbc2
NB
988#if __GNUC__ < 3
989struct stat64;
990#endif
991
45e878bb
NB
992#define HAVE_NFTW we assume
993#define HAVE_FTW
994
2df1f269 995#ifdef __UCLIBC__
45e878bb 996# include <features.h>
2df1f269
BRF
997# ifndef __UCLIBC_HAS_LFS__
998# define lseek64 lseek
999# endif
45e878bb
NB
1000# ifndef __UCLIBC_HAS_FTW__
1001# undef HAVE_FTW
1002# undef HAVE_NFTW
1003# endif
1004#endif
1005
1006#ifdef __dietlibc__
1007# undef HAVE_NFTW
1008#endif
1009
e39b673e 1010#if defined(__KLIBC__)
1011# undef HAVE_NFTW
1012# undef HAVE_FTW
1013#endif
1014
45e878bb 1015#ifndef HAVE_NFTW
173fc515 1016# define FTW_PHYS 1
45e878bb
NB
1017# ifndef HAVE_FTW
1018 struct FTW {};
173fc515
NB
1019# endif
1020#endif
1021
45e878bb
NB
1022#ifdef HAVE_FTW
1023# include <ftw.h>
1024#endif
1025
173fc515
NB
1026extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
1027
f9ce90ba 1028
64c4757e 1029extern int Manage_ro(char *devname, int fd, int readonly);
91f068bf 1030extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
dd0781e5 1031extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
64c4757e 1032extern int Manage_subdevs(char *devname, int fd,
833bb0f8 1033 struct mddev_dev *devlist, int verbose, int test,
11b391ec 1034 char *update, int force);
1f48664b 1035extern int autodetect(void);
e5329c37 1036extern int Grow_Add_device(char *devname, int fd, char *newdev);
8fac0577 1037extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
06b0d786 1038extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
e86c9dd6 1039 long long size,
691a36b7 1040 int level, char *layout_str, int chunksize, int raid_disks,
e2e53a2d 1041 struct mddev_dev *devlist,
ce52f92f 1042 int assume_clean, int force);
06b0d786 1043extern int Grow_restart(struct supertype *st, struct mdinfo *info,
ea0ebe96 1044 int *fdlist, int cnt, char *backup_file, int verbose);
e9e43ec3 1045extern int Grow_continue(int mdfd, struct supertype *st,
b76b30e0
AK
1046 struct mdinfo *info, char *backup_file,
1047 int freeze_reshape);
1048
3f54bd62
AK
1049extern int restore_backup(struct supertype *st,
1050 struct mdinfo *content,
1051 int working_disks,
1052 int spares,
1053 char *backup_file,
1054 int verbose);
2dddadb0
AK
1055extern int Grow_continue_command(char *devname, int fd,
1056 char *backup_file, int verbose);
64c4757e 1057
7f91af49 1058extern int Assemble(struct supertype *st, char *mddev,
fa56eddb 1059 struct mddev_ident *ident,
87f26d14
N
1060 struct mddev_dev *devlist,
1061 char *backup_file, int invalid_backup,
64c4757e 1062 int readonly, int runstop,
0ac91628 1063 char *update, char *homehost, int require_homehost,
b76b30e0 1064 int verbose, int force, int freeze_reshape);
64c4757e 1065
7f91af49 1066extern int Build(char *mddev, int chunk, int level, int layout,
a655e550 1067 int raiddisks, struct mddev_dev *devlist, int assume_clean,
7f91af49 1068 char *bitmap_file, int bitmap_chunk, int write_behind,
83208785 1069 int delay, int verbose, int autof, unsigned long long size);
64c4757e
NB
1070
1071
7f91af49 1072extern int Create(struct supertype *st, char *mddev,
5dd497ee 1073 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
3d3dd91e 1074 char *name, char *homehost, int *uuid,
a655e550 1075 int subdevs, struct mddev_dev *devlist,
47d79ef8 1076 int runstop, int verbose, int force, int assume_clean,
7f91af49 1077 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int autof);
64c4757e 1078
54bad364 1079extern int Detail(char *dev, int brief, int export, int test, char *homehost);
4cce4069 1080extern int Detail_Platform(struct superswitch *ss, int scan, int verbose);
e0d19036 1081extern int Query(char *dev);
a655e550 1082extern int Examine(struct mddev_dev *devlist, int brief, int export, int scan,
0d726f17 1083 int SparcAdjust, struct supertype *forcest, char *homehost);
a655e550 1084extern int Monitor(struct mddev_dev *devlist,
e0d19036 1085 char *mailaddr, char *alert_cmd,
aa88f531 1086 int period, int daemonise, int scan, int oneshot,
edde9560
AC
1087 int dosyslog, int test, char *pidfile, int increments,
1088 int share);
64c4757e 1089
9277cc77 1090extern int Kill(char *dev, struct supertype *st, int force, int quiet, int noexcl);
33414a01 1091extern int Kill_subarray(char *dev, char *subarray, int quiet);
fa56eddb 1092extern int Update_subarray(char *dev, char *subarray, char *update, struct mddev_ident *ident, int quiet);
b90c0e9a 1093extern int Wait(char *dev);
9f1da824 1094extern int WaitClean(char *dev, int sock, int verbose);
9a9dab36 1095
8382f19b 1096extern int Incremental(char *devname, int verbose, int runstop,
0ac91628 1097 struct supertype *st, char *homehost, int require_homehost,
b76b30e0 1098 int autof, int freeze_reshape);
8382f19b
NB
1099extern void RebuildMap(void);
1100extern int IncrementalScan(int verbose);
950bc344 1101extern int IncrementalRemove(char *devname, char *path, int verbose);
c82f047c
NB
1102extern int CreateBitmap(char *filename, int force, char uuid[16],
1103 unsigned long chunksize, unsigned long daemon_sleep,
dfd4d8ee 1104 unsigned long write_behind,
dcec9ee5
NB
1105 unsigned long long array_size,
1106 int major);
55935d51 1107extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
20b60dcd 1108extern int Write_rules(char *rule_name);
bf4fb153 1109extern int bitmap_update_uuid(int fd, int *uuid, int swap);
2a528478 1110extern unsigned long bitmap_sectors(struct bitmap_super_s *bsb);
c82f047c 1111
64c4757e 1112extern int md_get_version(int fd);
e0d19036 1113extern int get_linux_version(void);
bc77ed53 1114extern int mdadm_version(char *version);
84e11361 1115extern long long parse_size(char *size);
64c4757e 1116extern int parse_uuid(char *str, int uuid[4]);
4a06e2c2
N
1117extern int parse_layout_10(char *layout);
1118extern int parse_layout_faulty(char *layout);
682c7051
NB
1119extern int check_ext2(int fd, char *name);
1120extern int check_reiser(int fd, char *name);
1121extern int check_raid(int fd, char *name);
53ed6ac3
KW
1122extern int check_partitions(int fd, char *dname,
1123 unsigned long long freesize,
1124 unsigned long long size);
64c4757e 1125
dd0781e5 1126extern int get_mdp_major(void);
8b0dabea 1127extern int dev_open(char *dev, int flags);
e8a70c89 1128extern int open_dev(int devnum);
d998b738 1129extern int open_dev_flags(int devnum, int flags);
a931db9e 1130extern int open_dev_excl(int devnum);
8d80900b 1131extern int is_standard(char *dev, int *nump);
9008ed1c 1132extern int same_dev(char *one, char *two);
dd0781e5 1133
f1ae21c4 1134extern int parse_auto(char *str, char *msg, int config);
fa56eddb 1135extern struct mddev_ident *conf_get_ident(char *dev);
a655e550 1136extern struct mddev_dev *conf_get_devs(void);
8382f19b 1137extern int conf_test_dev(char *devname);
4e8d9f0a 1138extern int conf_test_metadata(const char *version, struct dev_policy *pol, int is_homehost);
8aec876d
NB
1139extern struct createinfo *conf_get_create_info(void);
1140extern void set_conffile(char *file);
1141extern char *conf_get_mailaddr(void);
1142extern char *conf_get_mailfrom(void);
1143extern char *conf_get_program(void);
0ac91628 1144extern char *conf_get_homehost(int *require_homehostp);
e0d19036 1145extern char *conf_line(FILE *file);
98c6faba 1146extern char *conf_word(FILE *file, int allow_key);
0ac91628
N
1147extern int conf_name_is_free(char *name);
1148extern int devname_matches(char *name, char *match);
fa56eddb 1149extern struct mddev_ident *conf_match(struct mdinfo *info, struct supertype *st);
6d11ec6f 1150extern int experimental(void);
0ac91628 1151
e0d19036
NB
1152extern void free_line(char *line);
1153extern int match_oneof(char *devices, char *devname);
e0d19036 1154extern void uuid_from_super(int uuid[4], mdp_super_t *super);
22e263f6 1155extern const int uuid_zero[4];
f277ce36 1156extern int same_uuid(int a[4], int b[4], int swapuuid);
350f29f9 1157extern void copy_uuid(void *a, int b[4], int swapuuid);
aae5a112 1158extern char *__fname_from_uuid(int id[4], int swap, char *buf, char sep);
d7288ddc 1159extern char *fname_from_uuid(struct supertype *st,
ff54de6e 1160 struct mdinfo *info, char *buf, char sep);
4b1ac34b 1161extern unsigned long calc_csum(void *super, int bytes);
583315d9 1162extern int enough(int level, int raid_disks, int layout, int clean,
265e0f17 1163 char *avail, int avail_disks);
8453e704 1164extern int enough_fd(int fd);
e0d19036 1165extern int ask(char *mesg);
8fac0577 1166extern unsigned long long get_component_size(int fd);
0430ed48 1167extern void remove_partitions(int fd);
691c6ee1 1168extern int test_partition(int fd);
bfd76b93 1169extern int test_partition_from_id(dev_t id);
577e8448 1170extern int get_data_disks(int level, int layout, int raid_disks);
5f8097be
NB
1171extern unsigned long long calc_array_size(int level, int raid_disks, int layout,
1172 int chunksize, unsigned long long devsize);
edd8d13c
NB
1173extern int flush_metadata_updates(struct supertype *st);
1174extern void append_metadata_update(struct supertype *st, void *buf, int len);
6234c63c
DW
1175extern int assemble_container_content(struct supertype *st, int mdfd,
1176 struct mdinfo *content, int runstop,
49680258 1177 char *chosen_name, int verbose,
b76b30e0 1178 char *backup_file, int freeze_reshape);
326727d9
AC
1179extern struct mdinfo *container_choose_spares(struct supertype *st,
1180 unsigned long long min_size,
1181 struct domainlist *domlist,
1182 char *spare_group,
1183 const char *metadata, int get_one);
d52bb542 1184extern int move_spare(char *from_devname, char *to_devname, dev_t devid);
7801ac20
N
1185extern int add_disk(int mdfd, struct supertype *st,
1186 struct mdinfo *sra, struct mdinfo *info);
de6ae750
N
1187extern int remove_disk(int mdfd, struct supertype *st,
1188 struct mdinfo *sra, struct mdinfo *info);
f35f2525 1189extern int set_array_info(int mdfd, struct supertype *st, struct mdinfo *info);
1e5c6983 1190unsigned long long min_recovery_start(struct mdinfo *array);
cd29a5c8 1191
56eb10c0 1192extern char *human_size(long long bytes);
e4965ef8
N
1193extern char *human_size_brief(long long bytes);
1194extern void print_r10_layout(int layout);
e0d19036 1195
63152c1b
NB
1196#define NoMdDev (1<<23)
1197extern int find_free_devnum(int use_partitions);
1198
e0d19036
NB
1199extern void put_md_name(char *name);
1200extern char *get_md_name(int dev);
1201
c913b90e 1202extern char DefaultConfFile[];
b5e64645 1203
69207ff6
N
1204extern int create_mddev(char *dev, char *name, int autof, int trustworthy,
1205 char *chosen);
1206/* values for 'trustworthy' */
1207#define LOCAL 1
d1d3482b 1208#define LOCAL_ANY 10
69207ff6
N
1209#define FOREIGN 2
1210#define METADATA 3
6be1d39d 1211extern int open_mddev(char *dev, int report_errors);
a322f70c 1212extern int open_container(int fd);
33414a01
DW
1213extern int is_container_member(struct mdstat_ent *ent, char *devname);
1214extern int is_subarray_active(char *subarray, char *devname);
feab51f8 1215extern int open_subarray(char *dev, char *subarray, struct supertype *st, int quiet);
33414a01 1216extern struct superswitch *version_to_superswitch(char *vers);
b5e64645 1217
a931db9e 1218extern int mdmon_running(int devnum);
24f6f99b 1219extern int mdmon_pid(int devnum);
40ebbb9c 1220extern int check_env(char *name);
148acb7b 1221extern __u32 random32(void);
8850ee3e 1222extern int start_mdmon(int devnum);
a931db9e 1223
999b4972
N
1224extern int child_monitor(int afd, struct mdinfo *sra, struct reshape *reshape,
1225 struct supertype *st, unsigned long stripes,
1226 int *fds, unsigned long long *offsets,
1227 int dests, int *destfd, unsigned long long *destoffsets);
10f22854 1228void abort_reshape(struct mdinfo *sra);
999b4972 1229
2f6079dc 1230extern char *devnum2devname(int num);
11877f4d 1231extern void fmt_devname(char *name, int num);
77472ff8 1232extern int devname2devnum(char *name);
c94709e8 1233extern int stat2devnum(struct stat *st);
2f6079dc 1234extern int fd2devnum(int fd);
b5e64645 1235
a931db9e
NB
1236static inline int dev2major(int d)
1237{
1238 if (d >= 0)
1239 return MD_MAJOR;
1240 else
1241 return get_mdp_major();
1242}
1243
1244static inline int dev2minor(int d)
1245{
1246 if (d >= 0)
1247 return d;
1248 return (-1-d) << MdpMinorShift;
1249}
1250
6416d527
NB
1251static inline int ROUND_UP(int a, int base)
1252{
1253 return ((a+base-1)/base)*base;
1254}
1255
3c558363
N
1256static inline int is_subarray(char *vers)
1257{
e9dd1598
N
1258 /* The version string for a 'subarray' (an array in a container)
1259 * is
1260 * /containername/componentname for normal read-write arrays
746a6567
N
1261 * -containername/componentname for arrays which mdmon must not
1262 * reconfigure. They might be read-only
1263 * or might be undergoing reshape etc.
e9dd1598
N
1264 * containername is e.g. md0, md_d1
1265 * componentname is dependant on the metadata. e.g. '1' 'S1' ...
1266 */
1267 return (*vers == '/' || *vers == '-');
3c558363
N
1268}
1269
e5408a32
DW
1270static inline char *to_subarray(struct mdstat_ent *ent, char *container)
1271{
1272 return &ent->metadata_version[10+strlen(container)+1];
1273}
1274
2a24d7b6
DW
1275#ifdef DEBUG
1276#define dprintf(fmt, arg...) \
1277 fprintf(stderr, fmt, ##arg)
1278#else
1279#define dprintf(fmt, arg...) \
1280 ({ if (0) fprintf(stderr, fmt, ##arg); 0; })
1281#endif
1a0ee0ba
DK
1282#include <assert.h>
1283#include <stdarg.h>
1284static inline int xasprintf(char **strp, const char *fmt, ...) {
1285 va_list ap;
1286 int ret;
1287 va_start(ap, fmt);
089485cb 1288 ret = vasprintf(strp, fmt, ap);
1a0ee0ba
DK
1289 va_end(ap);
1290 assert(ret >= 0);
1291 return ret;
1292}
2a24d7b6 1293
b5e64645
NB
1294#define LEVEL_MULTIPATH (-4)
1295#define LEVEL_LINEAR (-1)
1296#define LEVEL_FAULTY (-5)
1297
17f25ca6
NB
1298/* kernel module doesn't know about these */
1299#define LEVEL_CONTAINER (-100)
a322f70c 1300#define LEVEL_UNSUPPORTED (-200)
17f25ca6 1301
b5e64645
NB
1302
1303/* faulty stuff */
1304
1305#define WriteTransient 0
1306#define ReadTransient 1
1307#define WritePersistent 2
1308#define ReadPersistent 3
1309#define WriteAll 4 /* doesn't go to device */
1310#define ReadFixable 5
1311#define Modes 6
1312
1313#define ClearErrors 31
1314#define ClearFaults 30
1315
1316#define AllPersist 100 /* internal use only */
1317#define NoPersist 101
1318
1319#define ModeMask 0x1f
1320#define ModeShift 5
fe6729fa
NB
1321
1322
1323#ifdef __TINYC__
1324#undef minor
1325#undef major
1326#undef makedev
1327#define minor(x) ((x)&0xff)
1328#define major(x) (((x)>>8)&0xff)
1329#define makedev(M,m) (((M)<<8) | (m))
1330#endif
1331
b640a252 1332/* for raid4/5/6 */
e86c9dd6
NB
1333#define ALGORITHM_LEFT_ASYMMETRIC 0
1334#define ALGORITHM_RIGHT_ASYMMETRIC 1
1335#define ALGORITHM_LEFT_SYMMETRIC 2
1336#define ALGORITHM_RIGHT_SYMMETRIC 3
b640a252
N
1337
1338/* Define non-rotating (raid4) algorithms. These allow
1339 * conversion of raid4 to raid5.
1340 */
1341#define ALGORITHM_PARITY_0 4 /* P or P,Q are initial devices */
1342#define ALGORITHM_PARITY_N 5 /* P or P,Q are final devices. */
1343
1344/* DDF RAID6 layouts differ from md/raid6 layouts in two ways.
1345 * Firstly, the exact positioning of the parity block is slightly
1346 * different between the 'LEFT_*' modes of md and the "_N_*" modes
1347 * of DDF.
1348 * Secondly, or order of datablocks over which the Q syndrome is computed
1349 * is different.
1350 * Consequently we have different layouts for DDF/raid6 than md/raid6.
1351 * These layouts are from the DDFv1.2 spec.
1352 * Interestingly DDFv1.2-Errata-A does not specify N_CONTINUE but
1353 * leaves RLQ=3 as 'Vendor Specific'
1354 */
1355
1356#define ALGORITHM_ROTATING_ZERO_RESTART 8 /* DDF PRL=6 RLQ=1 */
1357#define ALGORITHM_ROTATING_N_RESTART 9 /* DDF PRL=6 RLQ=2 */
1358#define ALGORITHM_ROTATING_N_CONTINUE 10 /*DDF PRL=6 RLQ=3 */
1359
1360
1361/* For every RAID5 algorithm we define a RAID6 algorithm
1362 * with exactly the same layout for data and parity, and
1363 * with the Q block always on the last device (N-1).
1364 * This allows trivial conversion from RAID5 to RAID6
1365 */
1366#define ALGORITHM_LEFT_ASYMMETRIC_6 16
1367#define ALGORITHM_RIGHT_ASYMMETRIC_6 17
1368#define ALGORITHM_LEFT_SYMMETRIC_6 18
1369#define ALGORITHM_RIGHT_SYMMETRIC_6 19
1370#define ALGORITHM_PARITY_0_6 20
1371#define ALGORITHM_PARITY_N_6 ALGORITHM_PARITY_N
1372
33a6535d
AW
1373/* Define PATH_MAX in case we don't use glibc or standard library does
1374 * not have PATH_MAX defined. Assume max path length is 4K characters.
1375 */
1376#ifndef PATH_MAX
1377#define PATH_MAX 4096
1378#endif
1379
2d3603ba
KW
1380#define PROCESS_DELAYED -2
1381#define PROCESS_PENDING -3