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