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