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