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