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