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