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