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