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