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