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