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