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