]> git.ipfire.org Git - thirdparty/mdadm.git/blame - mdadm.h
Create, Build: use default_layout()
[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>
d15a1f72 38#include <stdint.h>
64c4757e
NB
39#include <stdlib.h>
40#include <time.h>
11018a45 41#include <sys/time.h>
64c4757e
NB
42#include <getopt.h>
43#include <fcntl.h>
44#include <stdio.h>
45#include <errno.h>
46#include <string.h>
773135f5 47#include <syslog.h>
a35aa68f 48#include <stdbool.h>
83a379cf 49#include <signal.h>
977d12d7
JS
50/* Newer glibc requires sys/sysmacros.h directly for makedev() */
51#include <sys/sysmacros.h>
b56c3630
NB
52#ifdef __dietlibc__
53#include <strings.h>
280a927d
NB
54/* dietlibc has deprecated random and srandom!! */
55#define random rand
56#define srandom srand
98c6faba
NB
57#endif
58
e80357f8
GJ
59#ifdef NO_COROSYNC
60#define CS_OK 1
61typedef uint64_t cmap_handle_t;
62#else
63#include <corosync/cmap.h>
64#endif
65
d15a1f72
GJ
66#ifndef NO_DLM
67#include <libdlm.h>
68#include <errno.h>
69#else
70#define LKF_NOQUEUE 0x00000001
d15a1f72
GJ
71#define LKM_PWMODE 4
72#define EUNLOCK 0x10002
73
74typedef void *dlm_lshandle_t;
75
76struct dlm_lksb {
77 int sb_status;
78 uint32_t sb_lkid;
79 char sb_flags;
80 char *sb_lvbptr;
81};
82#endif
83
64c4757e 84#include <linux/kdev_t.h>
e0d19036
NB
85/*#include <linux/fs.h> */
86#include <sys/mount.h>
87#include <asm/types.h>
64c4757e
NB
88#include <sys/ioctl.h>
89#define MD_MAJOR 9
dd0781e5 90#define MdpMinorShift 6
64c4757e 91
e0d19036 92#ifndef BLKGETSIZE64
98c6faba 93#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
e0d19036 94#endif
56eb10c0 95
c21e737b 96#define DEFAULT_CHUNK 512
c82f047c
NB
97#define DEFAULT_BITMAP_CHUNK 4096
98#define DEFAULT_BITMAP_DELAY 5
dfd4d8ee 99#define DEFAULT_MAX_WRITE_BEHIND 256
64c4757e 100
753cf905 101/* MAP_DIR should be somewhere that persists across the pivotroot
5d4d1b26 102 * from early boot to late boot.
96fd06ed 103 * /run seems to have emerged as the best standard.
5d4d1b26 104 */
753cf905 105#ifndef MAP_DIR
96fd06ed 106#define MAP_DIR "/run/mdadm"
753cf905
DL
107#endif /* MAP_DIR */
108/* MAP_FILE is what we name the map file we put in MAP_DIR, in case you
109 * want something other than the default of "map"
110 */
111#ifndef MAP_FILE
112#define MAP_FILE "map"
113#endif /* MAP_FILE */
114/* MDMON_DIR is where pid and socket files used for communicating
96fd06ed 115 * with mdmon normally live. Best is /var/run/mdadm as
753cf905
DL
116 * mdmon is needed at early boot then it needs to write there prior
117 * to /var/run being mounted read/write, and it also then needs to
118 * persist beyond when /var/run is mounter read-only. So, to be
119 * safe, the default is somewhere that is read/write early in the
120 * boot process and stays up as long as possible during shutdown.
121 */
122#ifndef MDMON_DIR
96fd06ed 123#define MDMON_DIR "/run/mdadm"
753cf905 124#endif /* MDMON_DIR */
5d4d1b26 125
403410eb
PC
126/* FAILED_SLOTS is where to save files storing recent removal of array
127 * member in order to allow future reuse of disk inserted in the same
128 * slot for array recovery
129 */
130#ifndef FAILED_SLOTS_DIR
96fd06ed 131#define FAILED_SLOTS_DIR "/run/mdadm/failed-slots"
403410eb
PC
132#endif /* FAILED_SLOTS */
133
ff6bb131
MT
134#ifndef MDMON_SERVICE
135#define MDMON_SERVICE "mdmon"
136#endif /* MDMON_SERVICE */
137
138#ifndef GROW_SERVICE
139#define GROW_SERVICE "mdadm-grow-continue"
140#endif /* GROW_SERVICE */
141
64c4757e 142#include "md_u.h"
e0d19036 143#include "md_p.h"
c82f047c 144#include "bitmap.h"
f7dd881f 145#include "msg.h"
64c4757e 146
1e0d770c 147#include <endian.h>
efd441d1
NB
148/* Redhat don't like to #include <asm/byteorder.h>, and
149 * some time include <linux/byteorder/xxx_endian.h> isn't enough,
150 * and there is no standard conversion function so... */
0ae03b8a
NB
151/* And dietlibc doesn't think byteswap is ok, so.. */
152/* #include <byteswap.h> */
dd47b4e0
JS
153#define __mdadm_bswap_16(x) (((x) & 0x00ffU) << 8 | \
154 ((x) & 0xff00U) >> 8)
155#define __mdadm_bswap_32(x) (((x) & 0x000000ffU) << 24 | \
156 ((x) & 0xff000000U) >> 24 | \
157 ((x) & 0x0000ff00U) << 8 | \
158 ((x) & 0x00ff0000U) >> 8)
159#define __mdadm_bswap_64(x) (((x) & 0x00000000000000ffULL) << 56 | \
160 ((x) & 0xff00000000000000ULL) >> 56 | \
161 ((x) & 0x000000000000ff00ULL) << 40 | \
162 ((x) & 0x00ff000000000000ULL) >> 40 | \
163 ((x) & 0x0000000000ff0000ULL) << 24 | \
164 ((x) & 0x0000ff0000000000ULL) >> 24 | \
165 ((x) & 0x00000000ff000000ULL) << 8 | \
166 ((x) & 0x000000ff00000000ULL) >> 8)
0ae03b8a 167
e39b673e 168#if !defined(__KLIBC__)
efd441d1 169#if BYTE_ORDER == LITTLE_ENDIAN
8a5f247d
JS
170#define __cpu_to_le16(_x) (unsigned int)(_x)
171#define __cpu_to_le32(_x) (unsigned int)(_x)
172#define __cpu_to_le64(_x) (unsigned long long)(_x)
173#define __le16_to_cpu(_x) (unsigned int)(_x)
174#define __le32_to_cpu(_x) (unsigned int)(_x)
175#define __le64_to_cpu(_x) (unsigned long long)(_x)
974e620d 176
dd47b4e0
JS
177#define __cpu_to_be16(_x) __mdadm_bswap_16(_x)
178#define __cpu_to_be32(_x) __mdadm_bswap_32(_x)
179#define __cpu_to_be64(_x) __mdadm_bswap_64(_x)
180#define __be16_to_cpu(_x) __mdadm_bswap_16(_x)
181#define __be32_to_cpu(_x) __mdadm_bswap_32(_x)
182#define __be64_to_cpu(_x) __mdadm_bswap_64(_x)
efd441d1 183#elif BYTE_ORDER == BIG_ENDIAN
dd47b4e0
JS
184#define __cpu_to_le16(_x) __mdadm_bswap_16(_x)
185#define __cpu_to_le32(_x) __mdadm_bswap_32(_x)
186#define __cpu_to_le64(_x) __mdadm_bswap_64(_x)
187#define __le16_to_cpu(_x) __mdadm_bswap_16(_x)
188#define __le32_to_cpu(_x) __mdadm_bswap_32(_x)
189#define __le64_to_cpu(_x) __mdadm_bswap_64(_x)
974e620d 190
8a5f247d
JS
191#define __cpu_to_be16(_x) (unsigned int)(_x)
192#define __cpu_to_be32(_x) (unsigned int)(_x)
193#define __cpu_to_be64(_x) (unsigned long long)(_x)
194#define __be16_to_cpu(_x) (unsigned int)(_x)
195#define __be32_to_cpu(_x) (unsigned int)(_x)
196#define __be64_to_cpu(_x) (unsigned long long)(_x)
1e0d770c
NB
197#else
198# error "unknown endianness."
199#endif
e39b673e 200#endif /* __KLIBC__ */
1e0d770c 201
7039d1f8
JS
202/*
203 * Partially stolen from include/linux/unaligned/packed_struct.h
204 */
205struct __una_u16 { __u16 x; } __attribute__ ((packed));
206struct __una_u32 { __u32 x; } __attribute__ ((packed));
207
208static inline __u16 __get_unaligned16(const void *p)
209{
210 const struct __una_u16 *ptr = (const struct __una_u16 *)p;
211 return ptr->x;
212}
213
214static inline __u32 __get_unaligned32(const void *p)
215{
216 const struct __una_u32 *ptr = (const struct __una_u32 *)p;
217 return ptr->x;
218}
219
220static inline void __put_unaligned16(__u16 val, void *p)
221{
222 struct __una_u16 *ptr = (struct __una_u16 *)p;
223 ptr->x = val;
224}
225
226static inline void __put_unaligned32(__u32 val, void *p)
227{
228 struct __una_u32 *ptr = (struct __una_u32 *)p;
229 ptr->x = val;
230}
231
26714713
DD
232/*
233 * Check at compile time that something is of a particular type.
234 * Always evaluates to 1 so you may use it easily in comparisons.
235*/
236
237#define typecheck(type,x) \
238({ type __dummy; \
239 typeof(x) __dummy2; \
240 (void)(&__dummy == &__dummy2); \
241 1; \
242})
243
244/*
245 * These inlines deal with timer wrapping correctly.
246 *
247 * time_after(a,b) returns true if the time a is after time b.
248*/
249
250#define time_after(a,b) \
251 (typecheck(unsigned int, a) && \
252 typecheck(unsigned int, b) && \
253 ((int)((b) - (a)) < 0))
254
255#define time_before(a,b) time_after(b,a)
256
1e5c6983
DW
257/*
258 * min()/max()/clamp() macros that also do
259 * strict type-checking.. See the
260 * "unnecessary" pointer comparison.
261 */
262#define min(x, y) ({ \
263 typeof(x) _min1 = (x); \
264 typeof(y) _min2 = (y); \
265 (void) (&_min1 == &_min2); \
266 _min1 < _min2 ? _min1 : _min2; })
267
268#define max(x, y) ({ \
269 typeof(x) _max1 = (x); \
270 typeof(y) _max2 = (y); \
271 (void) (&_max1 == &_max2); \
272 _max1 > _max2 ? _max1 : _max2; })
1e0d770c 273
1c0aebc2
N
274#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
275
d56dd607
PB
276extern const char Name[];
277
bb758cca
TM
278struct md_bb_entry {
279 unsigned long long sector;
280 int length;
281};
282
283struct md_bb {
284 int supported;
285 int count;
286 struct md_bb_entry *entries;
287};
288
4b1ac34b
NB
289/* general information that might be extracted from a superblock */
290struct mdinfo {
291 mdu_array_info_t array;
292 mdu_disk_info_t disk;
293 __u64 events;
fbf8a0b7 294 int uuid[4];
31317663 295 char name[33];
353632d9 296 unsigned long long data_offset;
fe384ca0 297 unsigned long long new_data_offset;
598f0d58
NB
298 unsigned long long component_size; /* same as array.size, except in
299 * sectors and up to 64bits.
300 */
da9b4a62
DW
301 unsigned long long custom_array_size; /* size for non-default sized
302 * arrays (in sectors)
303 */
81219e70
LM
304#define NO_RESHAPE 0
305#define VOLUME_RESHAPE 1
306#define CONTAINER_RESHAPE 2
5e88ab2e 307#define RESHAPE_NO_BACKUP 16 /* Mask 'or'ed in */
353632d9
NB
308 int reshape_active;
309 unsigned long long reshape_progress;
6e75048b
AK
310 int recovery_blocked; /* for external metadata it
311 * indicates that there is
312 * reshape in progress in
313 * container,
314 * for native metadata it is
315 * reshape_active field mirror
316 */
051f3265
SL
317 int journal_device_required;
318 int journal_clean;
319
5308f117
AP
320 enum {
321 CONSISTENCY_POLICY_UNKNOWN,
322 CONSISTENCY_POLICY_NONE,
323 CONSISTENCY_POLICY_RESYNC,
324 CONSISTENCY_POLICY_BITMAP,
325 CONSISTENCY_POLICY_JOURNAL,
326 CONSISTENCY_POLICY_PPL,
327 } consistency_policy;
328
80bf9135
N
329 /* During reshape we can sometimes change the data_offset to avoid
330 * over-writing still-valid data. We need to know if there is space.
331 * So getinfo_super will fill in space_before and space_after in sectors.
332 * data_offset can be increased or decreased by this amount.
333 */
334 unsigned long long space_before, space_after;
e1516be1
DW
335 union {
336 unsigned long long resync_start; /* per-array resync position */
337 unsigned long long recovery_start; /* per-device rebuild position */
b7528a20 338 #define MaxSector (~0ULL) /* resync/recovery complete position */
e1516be1 339 };
fbdef498 340 long bitmap_offset; /* 0 == none, 1 == a file */
2432ce9b 341 unsigned int ppl_size;
e97a7cd0 342 int ppl_offset;
a86b1c8d 343 unsigned long long ppl_sector;
a67dd8cc 344 unsigned long safe_mode_delay; /* ms delay to mark clean */
353632d9 345 int new_level, delta_disks, new_layout, new_chunk;
06c7f68e 346 int errors;
f21e18ca 347 unsigned long cache_size; /* size of raid456 stripe cache*/
7e0f6979
NB
348 int mismatch_cnt;
349 char text_version[50];
dd15dc4a
NB
350
351 int container_member; /* for assembling external-metatdata arrays
352 * This is to be used internally by metadata
353 * handler only */
97b4d0e9
DW
354 int container_enough; /* flag external handlers can set to
355 * indicate that subarrays have not enough (-1),
356 * enough to start (0), or all expected disks (1) */
6e6e9874 357 char sys_name[32];
7e0f6979 358 struct mdinfo *devs;
06c7f68e 359 struct mdinfo *next;
549e9569
NB
360
361 /* Device info for mdmon: */
e1516be1 362 int recovery_fd;
549e9569 363 int state_fd;
6dc1785f
TM
364 int bb_fd;
365 int ubb_fd;
8d45d196
DW
366 #define DS_FAULTY 1
367 #define DS_INSYNC 2
368 #define DS_WRITE_MOSTLY 4
369 #define DS_SPARE 8
370 #define DS_BLOCKED 16
371 #define DS_REMOVE 1024
92967543 372 #define DS_UNBLOCK 2048
549e9569 373 int prev_state, curr_state, next_state;
5aa644c6
SL
374
375 /* info read from sysfs */
5e4ca8bb
JS
376 enum {
377 ARRAY_CLEAR,
378 ARRAY_INACTIVE,
379 ARRAY_SUSPENDED,
380 ARRAY_READONLY,
381 ARRAY_READ_AUTO,
382 ARRAY_CLEAN,
383 ARRAY_ACTIVE,
384 ARRAY_WRITE_PENDING,
385 ARRAY_ACTIVE_IDLE,
43ebc910 386 ARRAY_BROKEN,
5e4ca8bb
JS
387 ARRAY_UNKNOWN_STATE,
388 } array_state;
bb758cca 389 struct md_bb bb;
4b1ac34b
NB
390};
391
5bbb4842
NB
392struct createinfo {
393 int uid;
394 int gid;
395 int autof;
396 int mode;
38098016 397 int symlinks;
eca944fa 398 int names;
e2efe9e7 399 int bblist;
058574b1 400 struct supertype *supertype;
5bbb4842
NB
401};
402
fbfdcb06
AO
403struct spare_criteria {
404 unsigned long long min_size;
4b57ecf6 405 unsigned int sector_size;
fbfdcb06
AO
406};
407
e0d19036
NB
408enum mode {
409 ASSEMBLE=1,
410 BUILD,
411 CREATE,
412 MANAGE,
413 MISC,
414 MONITOR,
dd0781e5 415 GROW,
8382f19b 416 INCREMENTAL,
1f48664b 417 AUTODETECT,
5187a385 418 mode_count
e0d19036
NB
419};
420
64c4757e 421extern char short_options[];
024768c4 422extern char short_bitmap_options[];
c06487ce 423extern char short_bitmap_auto_options[];
64c4757e 424extern struct option long_options[];
56eedc1a 425extern char Version[], Usage[], Help[], OptionHelp[],
5187a385 426 *mode_help[],
dd0781e5 427 Help_create[], Help_build[], Help_assemble[], Help_grow[],
8382f19b 428 Help_incr[],
e0d19036 429 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e 430
997aed5d 431/* for option that don't have short equivilents, we assign arbitrary
1c7a808c 432 * numbers later than any 'short' character option.
997aed5d
NB
433 */
434enum special_options {
1c7a808c 435 AssumeClean = 300,
997aed5d
NB
436 BitmapChunk,
437 WriteBehind,
438 ReAdd,
439 NoDegraded,
440 Sparc22,
1c7a808c 441 BackupFile,
997aed5d 442 HomeHost,
589395d6 443 AutoHomeHost,
38098016 444 Symlinks,
1f48664b 445 AutoDetect,
1770662b 446 Waitclean,
4cce4069 447 DetailPlatform,
33414a01 448 KillSubarray,
1c7a808c 449 UpdateSubarray,
edde9560 450 IncrementalPath,
1c7a808c
N
451 NoSharing,
452 HelpOptions,
453 Brief,
d11abe4b 454 NoDevices,
1c7a808c
N
455 ManageOpt,
456 Add,
f33a71f1 457 AddSpare,
01290056 458 AddJournal,
1c7a808c
N
459 Remove,
460 Fail,
70c55e36
N
461 Replace,
462 With,
1c7a808c
N
463 MiscOpt,
464 WaitOpt,
465 ConfigFile,
466 ChunkSize,
467 WriteMostly,
71574efb
N
468 FailFast,
469 NoFailFast,
1c7a808c
N
470 Layout,
471 Auto,
472 Force,
473 SuperMinor,
474 EMail,
475 ProgramOpt,
476 Increment,
477 Fork,
478 Bitmap,
479 RebuildMapOpt,
87f26d14 480 InvalidBackup,
20b60dcd 481 UdevRules,
b76b30e0 482 FreezeReshape,
2dddadb0 483 Continue,
08ca2adf 484 OffRootOpt,
c2ecf5f6 485 Prefer,
f7d3febc 486 KillOpt,
40c9a66a 487 DataOffset,
6d388a88 488 ExamineBB,
74db60b0
N
489 Dump,
490 Restore,
a740cf64 491 Action,
529e2aa5 492 Nodes,
7716570e 493 ClusterName,
4de90913 494 ClusterConfirm,
cc1799c3 495 WriteJournal,
5308f117 496 ConsistencyPolicy,
997aed5d
NB
497};
498
f0ec6710
MN
499enum prefix_standard {
500 JEDEC,
501 IEC
502};
503
0aa2f15b
GJ
504enum bitmap_update {
505 NoUpdate,
506 NameUpdate,
7e6e839a 507 NodeNumUpdate,
0aa2f15b
GJ
508};
509
e22fe3ae
N
510enum flag_mode {
511 FlagDefault, FlagSet, FlagClear,
512};
513
64c4757e 514/* structures read from config file */
52826846
NB
515/* List of mddevice names and identifiers
516 * Identifiers can be:
517 * uuid=128-hex-uuid
518 * super-minor=decimal-minor-number-from-superblock
519 * devices=comma,separated,list,of,device,names,with,wildcards
520 *
521 * If multiple fields are present, the intersection of all matching
522 * devices is considered
523 */
98c6faba 524#define UnSet (0xfffe)
fa56eddb 525struct mddev_ident {
dd0781e5 526 char *devname;
aba69144 527
dd0781e5 528 int uuid_set;
3fa06e9d 529 int uuid[4];
947fd4dd 530 char name[33];
52826846 531
f21e18ca 532 int super_minor;
52826846 533
dd0781e5 534 char *devices; /* comma separated list of device
52826846
NB
535 * names with wild cards
536 */
dd0781e5 537 int level;
f21e18ca
N
538 int raid_disks;
539 int spare_disks;
82d9eba6 540 struct supertype *st;
dd0781e5
NB
541 int autof; /* 1 for normal, 2 for partitioned */
542 char *spare_group;
7ef02d01 543 char *bitmap_file;
c82f047c 544 int bitmap_fd;
dd0781e5 545
1771a6e2
N
546 char *container; /* /dev/whatever name of container, or
547 * uuid of container. You would expect
548 * this to be the 'devname' or UUID
dbb44303
N
549 * of some other entry.
550 */
551 char *member; /* subarray within a container */
552
fa56eddb 553 struct mddev_ident *next;
b179246f
N
554 union {
555 /* fields needed by different users of this structure */
556 int assembled; /* set when assembly succeeds */
557 };
fa56eddb 558};
64c4757e 559
9e33d556
N
560struct context {
561 int readonly;
562 int runstop;
563 int verbose;
9e33d556 564 int brief;
d11abe4b 565 int no_devices;
9e33d556
N
566 int force;
567 char *homehost;
568 int require_homehost;
569 char *prefer;
570 int export;
571 int test;
572 char *subarray;
573 char *update;
574 int scan;
575 int SparcAdjust;
576 int autof;
577 int delay;
578 int freeze_reshape;
579 char *backup_file;
580 int invalid_backup;
a740cf64 581 char *action;
529e2aa5 582 int nodes;
7716570e 583 char *homecluster;
9e33d556
N
584};
585
e705e81b
N
586struct shape {
587 int raiddisks;
588 int sparedisks;
cc1799c3 589 int journaldisks;
e705e81b
N
590 int level;
591 int layout;
592 char *layout_str;
593 int chunk;
594 int bitmap_chunk;
595 char *bitmap_file;
596 int assume_clean;
597 int write_behind;
598 unsigned long long size;
5308f117 599 int consistency_policy;
e705e81b
N
600};
601
64c4757e 602/* List of device names - wildcards expanded */
a655e550 603struct mddev_dev {
64c4757e 604 char *devname;
c8e1a230
N
605 int disposition; /* 'a' for add, 'r' for remove, 'f' for fail,
606 * 'A' for re_add.
cd29a5c8
NB
607 * Not set for names read from .config
608 */
e22fe3ae
N
609 enum flag_mode writemostly;
610 enum flag_mode failfast;
70c55e36 611 int used; /* set when used */
72ca9bcf 612 long long data_offset;
a655e550
N
613 struct mddev_dev *next;
614};
64c4757e 615
682c7051
NB
616typedef struct mapping {
617 char *name;
618 int num;
619} mapping_t;
620
e0d19036 621struct mdstat_ent {
4dd2df09 622 char devnm[32];
e0d19036
NB
623 int active;
624 char *level;
7054da69 625 char *pattern; /* U for up, _ for down */
e0d19036 626 int percent; /* -1 if no resync */
f94c116f 627 int resync; /* 3 if check, 2 if reshape, 1 if resync, 0 if recovery */
549e9569
NB
628 int devcnt;
629 int raid_disks;
549e9569 630 char * metadata_version;
3b57c466
N
631 struct dev_member {
632 char *name;
633 struct dev_member *next;
1011e834 634 } *members;
e0d19036
NB
635 struct mdstat_ent *next;
636};
637
22a88995 638extern struct mdstat_ent *mdstat_read(int hold, int start);
a7a0d8a1 639extern void mdstat_close(void);
e0d19036 640extern void free_mdstat(struct mdstat_ent *ms);
cab9c67d 641extern int mdstat_wait(int seconds);
58a4ba2a 642extern void mdstat_wait_fd(int fd, const sigset_t *sigmask);
4dd2df09 643extern int mddev_busy(char *devnm);
3b57c466 644extern struct mdstat_ent *mdstat_by_component(char *name);
4dd2df09 645extern struct mdstat_ent *mdstat_by_subdev(char *subdev, char *container);
8382f19b
NB
646
647struct map_ent {
648 struct map_ent *next;
4dd2df09 649 char devnm[32];
1522c538 650 char metadata[20];
8382f19b 651 int uuid[4];
195254b8 652 int bad;
8382f19b
NB
653 char *path;
654};
4dd2df09 655extern int map_update(struct map_ent **mpp, char *devnm, char *metadata,
8382f19b 656 int uuid[4], char *path);
4dd2df09 657extern void map_remove(struct map_ent **map, char *devnm);
8382f19b 658extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
4dd2df09 659extern struct map_ent *map_by_devnm(struct map_ent **map, char *devnm);
eb2306f8 660extern void map_free(struct map_ent *map);
f2e55ecc 661extern struct map_ent *map_by_name(struct map_ent **map, char *name);
8382f19b
NB
662extern void map_read(struct map_ent **melp);
663extern int map_write(struct map_ent *mel);
4dd2df09 664extern void map_delete(struct map_ent **mapp, char *devnm);
8382f19b 665extern void map_add(struct map_ent **melp,
4dd2df09 666 char *devnm, char *metadata, int uuid[4], char *path);
ad5bc697
N
667extern int map_lock(struct map_ent **melp);
668extern void map_unlock(struct map_ent **melp);
cc700db3 669extern void map_fork(void);
e0d19036 670
e86c9dd6 671/* various details can be requested */
dab4a513
DW
672enum sysfs_read_flags {
673 GET_LEVEL = (1 << 0),
674 GET_LAYOUT = (1 << 1),
675 GET_COMPONENT = (1 << 2),
676 GET_CHUNK = (1 << 3),
677 GET_CACHE = (1 << 4),
678 GET_MISMATCH = (1 << 5),
679 GET_VERSION = (1 << 6),
680 GET_DISKS = (1 << 7),
dab4a513 681 GET_SAFEMODE = (1 << 9),
c0c1acd6
N
682 GET_BITMAP_LOCATION = (1 << 10),
683
684 GET_DEVS = (1 << 20), /* gets role, major, minor */
685 GET_OFFSET = (1 << 21),
686 GET_SIZE = (1 << 22),
687 GET_STATE = (1 << 23),
688 GET_ERROR = (1 << 24),
5aa644c6 689 GET_ARRAY_STATE = (1 << 25),
5308f117 690 GET_CONSISTENCY_POLICY = (1 << 26),
ae7d61e3 691 GET_DEVS_ALL = (1 << 27),
dab4a513 692};
e86c9dd6
NB
693
694/* If fd >= 0, get the array it is open on,
4dd2df09 695 * else use devnm.
e86c9dd6 696 */
4dd2df09 697extern int sysfs_open(char *devnm, char *devname, char *attr);
dae13137 698extern int sysfs_init(struct mdinfo *mdi, int fd, char *devnm);
a37563c9 699extern void sysfs_init_dev(struct mdinfo *mdi, dev_t devid);
7e0f6979 700extern void sysfs_free(struct mdinfo *sra);
4dd2df09 701extern struct mdinfo *sysfs_read(int fd, char *devnm, unsigned long options);
1770662b
DW
702extern int sysfs_attr_match(const char *attr, const char *str);
703extern int sysfs_match_word(const char *word, char **list);
7e0f6979 704extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 705 char *name, char *val);
7e0f6979 706extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 707 char *name, unsigned long long val);
012a8641
JS
708extern int sysfs_set_num_signed(struct mdinfo *sra, struct mdinfo *dev,
709 char *name, long long val);
97590376 710extern int sysfs_uevent(struct mdinfo *sra, char *event);
7236ee7a
N
711extern int sysfs_get_fd(struct mdinfo *sra, struct mdinfo *dev,
712 char *name);
713extern int sysfs_fd_get_ll(int fd, unsigned long long *val);
7e0f6979 714extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 715 char *name, unsigned long long *val);
2eba8496
N
716extern int sysfs_fd_get_two(int fd, unsigned long long *v1, unsigned long long *v2);
717extern int sysfs_get_two(struct mdinfo *sra, struct mdinfo *dev,
718 char *name, unsigned long long *v1, unsigned long long *v2);
7236ee7a 719extern int sysfs_fd_get_str(int fd, char *val, int size);
bc77ed53
DW
720extern int sysfs_attribute_available(struct mdinfo *sra, struct mdinfo *dev,
721 char *name);
93ecfa01
N
722extern int sysfs_get_str(struct mdinfo *sra, struct mdinfo *dev,
723 char *name, char *val, int size);
8ed3e5e1 724extern int sysfs_set_safemode(struct mdinfo *sra, unsigned long ms);
f35f2525 725extern int sysfs_set_array(struct mdinfo *info, int vers);
2904b26f 726extern int sysfs_add_disk(struct mdinfo *sra, struct mdinfo *sd, int resume);
f1665f72 727extern int sysfs_disk_to_scsi_id(int fd, __u32 *id);
4dd2df09 728extern int sysfs_unique_holder(char *devnm, long rdev);
bc77ed53 729extern int sysfs_freeze_array(struct mdinfo *sra);
efc67e8e 730extern int sysfs_wait(int fd, int *msec);
193b6c0b 731extern int load_sys(char *path, char *buf, int len);
b2514242 732extern int zero_disk_range(int fd, unsigned long long sector, size_t count);
130994cb
AK
733extern int reshape_prepare_fdlist(char *devname,
734 struct mdinfo *sra,
735 int raid_disks,
736 int nrdisks,
737 unsigned long blocks,
738 char *backup_file,
739 int *fdlist,
740 unsigned long long *offsets);
741extern void reshape_free_fdlist(int *fdlist,
742 unsigned long long *offsets,
743 int size);
e6e9d47b
AK
744extern int reshape_open_backup_file(char *backup,
745 int fd,
746 char *devname,
747 long blocks,
748 int *fdlist,
a93f87ee 749 unsigned long long *offsets,
54ded86f 750 char *sysfs_name,
a93f87ee 751 int restart);
1c009fc2
AK
752extern unsigned long compute_backup_blocks(int nchunk, int ochunk,
753 unsigned int ndata, unsigned int odata);
54ded86f
N
754extern char *locate_backup(char *name);
755extern char *make_backup(char *name);
e86c9dd6
NB
756
757extern int save_stripes(int *source, unsigned long long *offsets,
758 int raid_disks, int chunk_size, int level, int layout,
759 int nwrites, int *dest,
a6288483
N
760 unsigned long long start, unsigned long long length,
761 char *buf);
353632d9
NB
762extern int restore_stripes(int *dest, unsigned long long *offsets,
763 int raid_disks, int chunk_size, int level, int layout,
764 int source, unsigned long long read_offset,
2fcb75ae
AK
765 unsigned long long start, unsigned long long length,
766 char *src_buf);
e86c9dd6 767
52826846
NB
768#ifndef Sendmail
769#define Sendmail "/usr/lib/sendmail -t"
770#endif
771
773135f5
NB
772#define SYSLOG_FACILITY LOG_DAEMON
773
682c7051
NB
774extern char *map_num(mapping_t *map, int num);
775extern int map_name(mapping_t *map, char *name);
329dfc28
N
776extern mapping_t r0layout[], r5layout[], r6layout[],
777 pers[], modes[], faultylayout[];
5e4ca8bb 778extern mapping_t consistency_policies[], sysfs_array_states[];
682c7051 779
c2ecf5f6
N
780extern char *map_dev_preferred(int major, int minor, int create,
781 char *prefer);
782static inline char *map_dev(int major, int minor, int create)
783{
784 return map_dev_preferred(major, minor, create, NULL);
785}
64c4757e 786
4389ce73
MT
787/**
788 * is_fd_valid() - check file descriptor.
789 * @fd: file descriptor.
790 *
791 * The function checks if @fd is nonnegative integer and shall be used only
792 * to verify open() result.
793 */
794static inline int is_fd_valid(int fd)
795{
796 return (fd > -1);
797}
798
799/**
800 * close_fd() - verify, close and unset file descriptor.
801 * @fd: pointer to file descriptor.
802 *
803 * The function closes and invalidates file descriptor if appropriative. It
804 * ignores incorrect file descriptor quitely to simplify error handling.
805 */
806static inline void close_fd(int *fd)
807{
808 if (is_fd_valid(*fd) && close(*fd) == 0)
809 *fd = -1;
810}
811
549e9569 812struct active_array;
2e735d19 813struct metadata_update;
64c4757e 814
80bf9135 815/* 'struct reshape' records the intermediate states of
999b4972
N
816 * a general reshape.
817 * The starting geometry is converted to the 'before' geometry
818 * by at most an atomic level change. They could be the same.
819 * Similarly the 'after' geometry is converted to the final
820 * geometry by at most a level change.
821 * Note that 'before' and 'after' must have the same level.
822 * 'blocks' is the minimum number of sectors for a reshape unit.
823 * This will be a multiple of the stripe size in each of the
824 * 'before' and 'after' geometries.
825 * If 'blocks' is 0, no restriping is necessary.
89ecd3cf
N
826 * 'min_offset_change' is the minimum change to data_offset to
827 * allow the reshape to happen. It is at least the larger of
828 * the old and new chunk sizes, and typically the same as 'blocks'
829 * divided by number of data disks.
999b4972
N
830 */
831struct reshape {
832 int level;
833 int parity; /* number of parity blocks/devices */
834 struct {
835 int layout;
836 int data_disks;
837 } before, after;
838 unsigned long long backup_blocks;
89ecd3cf 839 unsigned long long min_offset_change;
999b4972
N
840 unsigned long long stripes; /* number of old stripes that comprise 'blocks'*/
841 unsigned long long new_size; /* New size of array in sectors */
842};
843
7054da69 844/* A superswitch provides entry point to a metadata handler.
6adfd3af 845 *
74db60b0 846 * The superswitch primarily operates on some "metadata" that
6adfd3af
NB
847 * is accessed via the 'supertype'.
848 * This metadata has one of three possible sources.
849 * 1/ It is read from a single device. In this case it may not completely
850 * describe the array or arrays as some information might be on other
851 * devices.
852 * 2/ It is read from all devices in a container. In this case all
853 * information is present.
854 * 3/ It is created by ->init_super / ->add_to_super. In this case it will
855 * be complete once enough ->add_to_super calls have completed.
856 *
857 * When creating an array inside a container, the metadata will be
858 * formed by a combination of 2 and 3. The metadata or the array is read,
859 * then new information is added.
860 *
861 * The metadata must sometimes have a concept of a 'current' array
862 * and a 'current' device.
863 * The 'current' array is set by init_super to be the newly created array,
864 * or is set by super_by_fd when it finds it is looking at an array inside
865 * a container.
866 *
867 * The 'current' device is either the device that the metadata was read from
868 * in case 1, or the last device added by add_to_super in case 3.
869 * Case 2 does not identify a 'current' device.
870 */
f9ce90ba 871extern struct superswitch {
6adfd3af
NB
872
873 /* Used to report details of metadata read from a component
874 * device. ->load_super has been called.
875 */
3da92f27 876 void (*examine_super)(struct supertype *st, char *homehost);
061f2c6a 877 void (*brief_examine_super)(struct supertype *st, int verbose);
4737ae25 878 void (*brief_examine_subarrays)(struct supertype *st, int verbose);
0d726f17 879 void (*export_examine_super)(struct supertype *st);
6d388a88 880 int (*examine_badblocks)(struct supertype *st, int fd, char *devname);
74db60b0 881 int (*copy_metadata)(struct supertype *st, int from, int to);
6adfd3af
NB
882
883 /* Used to report details of an active array.
884 * ->load_super was possibly given a 'component' string.
885 */
b771faef
BK
886 void (*detail_super)(struct supertype *st, char *homehost,
887 char *subarray);
888 void (*brief_detail_super)(struct supertype *st, char *subarray);
0d726f17 889 void (*export_detail_super)(struct supertype *st);
6adfd3af 890
4cce4069 891 /* Optional: platform hardware / firmware details */
9eafa1de
MN
892 int (*detail_platform)(int verbose, int enumerate_only, char *controller_path);
893 int (*export_detail_platform)(int verbose, char *controller_path);
4cce4069 894
6adfd3af
NB
895 /* Used:
896 * to get uuid to storing in bitmap metadata
897 * and 'reshape' backup-data metadata
898 * To see if a device is being re-added to an array it was part of.
899 */
3da92f27 900 void (*uuid_from_super)(struct supertype *st, int uuid[4]);
6adfd3af 901
8592f29d 902 /* Extract generic details from metadata. This could be details about
6adfd3af
NB
903 * the container, or about an individual array within the container.
904 * The determination is made either by:
905 * load_super being given a 'component' string.
906 * validate_geometry determining what to create.
d2ca6449
NB
907 * The info includes both array information and device information.
908 * The particular device should be:
909 * The last device added by add_to_super
910 * The device the metadata was loaded from by load_super
a5d85af7
N
911 * If 'map' is present, then it is an array raid_disks long
912 * (raid_disk must already be set and correct) and it is filled
913 * with 1 for slots that are thought to be active and 0 for slots which
914 * appear to be failed/missing.
95eeceeb 915 * *info is zeroed out before data is added.
6adfd3af 916 */
a5d85af7 917 void (*getinfo_super)(struct supertype *st, struct mdinfo *info, char *map);
5c4cd5da 918 struct mdinfo *(*getinfo_super_disks)(struct supertype *st);
6adfd3af 919 /* Check if the given metadata is flagged as belonging to "this"
9362c1c8 920 * host. 0 for 'no', 1 for 'yes', -1 for "Don't record homehost"
6adfd3af 921 */
3da92f27 922 int (*match_home)(struct supertype *st, char *homehost);
6adfd3af
NB
923
924 /* Make one of several generic modifications to metadata
925 * prior to assembly (or other times).
926 * sparc2.2 - first bug in early 0.90 metadata
927 * super-minor - change name of 0.90 metadata
928 * summaries - 'correct' any redundant data
929 * resync - mark array as dirty to trigger a resync.
930 * uuid - set new uuid - only 0.90 or 1.x
931 * name - change the name of the array (where supported)
932 * homehost - change which host this array is tied to.
933 * devicesize - If metadata is at start of device, change recorded
934 * device size to match actual device size
935 * byteorder - swap bytes for 0.90 metadata
936 *
937 * force-one - mark that device as uptodate, not old or failed.
938 * force-array - mark array as clean if it would not otherwise
939 * assemble
940 * assemble - not sure how this is different from force-one...
941 * linear-grow-new - add a new device to a linear array, but don't
942 * change the size: so superblock still matches
943 * linear-grow-update - now change the size of the array.
16715c01
DL
944 * writemostly - set the WriteMostly1 bit in the superblock devflags
945 * readwrite - clear the WriteMostly1 bit in the superblock devflags
71574efb
N
946 * failfast - set the FailFast1 bit in the superblock
947 * nofailfast - clear the FailFast1 bit
199f1a1f
N
948 * no-bitmap - clear any record that a bitmap is present.
949 * bbl - add a bad-block-log if possible
6dd16dac
N
950 * no-bbl - remove any bad-block-log is it is empty.
951 * force-no-bbl - remove any bad-block-log even if empty.
199f1a1f
N
952 * revert-reshape - If a reshape is in progress, modify metadata so
953 * it will resume going in the opposite direction.
6adfd3af 954 */
68c7d6d7 955 int (*update_super)(struct supertype *st, struct mdinfo *info,
3da92f27 956 char *update,
e5eac01f
NB
957 char *devname, int verbose,
958 int uuid_set, char *homehost);
6adfd3af
NB
959
960 /* Create new metadata for new array as described. This could
961 * be a new container, or an array in a pre-existing container.
962 * Also used to zero metadata prior to writing it to invalidate old
963 * metadata.
964 */
3da92f27 965 int (*init_super)(struct supertype *st, mdu_array_info_t *info,
5308f117 966 struct shape *s, char *name,
83cd1e97
N
967 char *homehost, int *uuid,
968 unsigned long long data_offset);
6adfd3af
NB
969
970 /* update the metadata to include new device, either at create or
971 * when hot-adding a spare.
972 */
f20c3968 973 int (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo,
72ca9bcf
N
974 int fd, char *devname,
975 unsigned long long data_offset);
1a64be56
LM
976 /* update the metadata to delete a device,
977 * when hot-removing.
978 */
979 int (*remove_from_super)(struct supertype *st, mdu_disk_info_t *dinfo);
6adfd3af
NB
980
981 /* Write metadata to one device when fixing problems or adding
982 * a new device.
983 */
3da92f27 984 int (*store_super)(struct supertype *st, int fd);
6adfd3af
NB
985
986 /* Write all metadata for this array.
987 */
111d01fc 988 int (*write_init_super)(struct supertype *st);
e2f408a4
N
989 /* Check if metadata read from one device is compatible with an array,
990 * used when assembling an array, or pseudo-assembling was with
991 * "--examine --brief"
992 * If "st" has not yet been loaded the superblock from, "tst" is
993 * moved in, otherwise the superblock in 'st' is compared with
994 * 'tst'.
995 */
c7b8547c
MT
996 int (*compare_super)(struct supertype *st, struct supertype *tst,
997 int verbose);
e2f408a4
N
998 /* Load metadata from a single device. If 'devname' is not NULL
999 * print error messages as appropriate */
3da92f27 1000 int (*load_super)(struct supertype *st, int fd, char *devname);
e2f408a4
N
1001 /* 'fd' is a 'container' md array - load array metadata from the
1002 * whole container.
1003 */
2b959fbf 1004 int (*load_container)(struct supertype *st, int fd, char *devname);
e2f408a4
N
1005 /* If 'arg' is a valid name of this metadata type, allocate and
1006 * return a 'supertype' for the particular minor version */
82d9eba6 1007 struct supertype * (*match_metadata_desc)(char *arg);
e2f408a4
N
1008 /* If a device has the given size, and the data_offset has been
1009 * requested - work out how much space is available for data.
1010 * This involves adjusting for reserved space (e.g. bitmaps)
1011 * and for any rounding.
1012 * 'mdadm' only calls this for existing arrays where a possible
1013 * spare is being added. However some super-handlers call it
1014 * internally from validate_geometry when creating an array.
1015 */
387fcd59
N
1016 __u64 (*avail_size)(struct supertype *st, __u64 size,
1017 unsigned long long data_offset);
fbfdcb06
AO
1018 /*
1019 * Return spare criteria for array:
1020 * - minimum disk size can be used in array;
4b57ecf6 1021 * - sector size can be used in array.
fbfdcb06 1022 * Return values: 0 - for success and -EINVAL on error.
e2f408a4 1023 */
fbfdcb06
AO
1024 int (*get_spare_criteria)(struct supertype *st,
1025 struct spare_criteria *sc);
e2f408a4
N
1026 /* Find somewhere to put a bitmap - possibly auto-size it - and
1027 * update the metadata to record this. The array may be newly
1028 * created, in which case data_size may be updated, or it might
1029 * already exist. Metadata handler can know if init_super
1030 * has been called, but not write_init_super.
2ec2b7e9
JS
1031 * 0: Success
1032 * -Exxxx: On error
e2f408a4 1033 */
3da92f27 1034 int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
199171a2 1035 int delay, int write_behind,
f9c25f1d 1036 unsigned long long size, int may_change, int major);
b554ab5c
JR
1037 /* Perform additional setup required to activate a bitmap.
1038 */
1039 int (*set_bitmap)(struct supertype *st, struct mdinfo *info);
e2f408a4
N
1040 /* Seek 'fd' to start of write-intent-bitmap. Must be an
1041 * md-native format bitmap
1042 */
b138214f 1043 int (*locate_bitmap)(struct supertype *st, int fd, int node_num);
e2f408a4
N
1044 /* if add_internal_bitmap succeeded for existing array, this
1045 * writes it out.
1046 */
0aa2f15b 1047 int (*write_bitmap)(struct supertype *st, int fd, enum bitmap_update update);
e2f408a4 1048 /* Free the superblock and any other allocated data */
3da92f27 1049 void (*free_super)(struct supertype *st);
78e44928
NB
1050
1051 /* validate_geometry is called with an st returned by
1052 * match_metadata_desc.
e2f408a4 1053 * It should check that the geometry described is compatible with
78e44928
NB
1054 * the metadata type. It will be called repeatedly as devices
1055 * added to validate changing size and new devices. If there are
1056 * inter-device dependencies, it should record sufficient details
1057 * so these can be validated.
30f58b22 1058 * Both 'size' and '*freesize' are in sectors. chunk is KiB.
ecbd9e81
N
1059 * Return value is:
1060 * 1: everything is OK
1061 * 0: not OK for some reason - if 'verbose', then error was reported.
1062 * -1: st->sb was NULL, 'subdev' is a member of a container of this
e2f408a4 1063 * type, but array is not acceptable for some reason
ecbd9e81 1064 * message was reported even if verbose is 0.
78e44928 1065 */
17f25ca6
NB
1066 int (*validate_geometry)(struct supertype *st, int level, int layout,
1067 int raiddisks,
c21e737b 1068 int *chunk, unsigned long long size,
af4348dd 1069 unsigned long long data_offset,
2c514b71 1070 char *subdev, unsigned long long *freesize,
5308f117 1071 int consistency_policy, int verbose);
598f0d58 1072
e2f408a4
N
1073 /* Return a linked list of 'mdinfo' structures for all arrays
1074 * in the container. For non-containers, it is like
1075 * getinfo_super with an allocated mdinfo.*/
00bbdbda 1076 struct mdinfo *(*container_content)(struct supertype *st, char *subarray);
30f58b22
DW
1077 /* query the supertype for default geometry */
1078 void (*default_geometry)(struct supertype *st, int *level, int *layout, int *chunk); /* optional */
33414a01 1079 /* Permit subarray's to be deleted from inactive containers */
3364781b
BK
1080 int (*kill_subarray)(struct supertype *st,
1081 char *subarray_id); /* optional */
aa534678 1082 /* Permit subarray's to be modified */
a951a4f7 1083 int (*update_subarray)(struct supertype *st, char *subarray,
fa56eddb 1084 char *update, struct mddev_ident *ident); /* optional */
7bc71196
DW
1085 /* Check if reshape is supported for this external format.
1086 * st is obtained from super_by_fd() where st->subarray[0] is
1087 * initialized to indicate if reshape is being performed at the
1088 * container or subarray level
1089 */
016e00f5
AK
1090#define APPLY_METADATA_CHANGES 1
1091#define ROLLBACK_METADATA_CHANGES 0
1092
d04f65f4
N
1093 int (*reshape_super)(struct supertype *st,
1094 unsigned long long size, int level,
7bc71196 1095 int layout, int chunksize, int raid_disks,
41784c88 1096 int delta_disks, char *backup, char *dev,
016e00f5 1097 int direction,
41784c88 1098 int verbose); /* optional */
999b4972
N
1099 int (*manage_reshape)( /* optional */
1100 int afd, struct mdinfo *sra, struct reshape *reshape,
1101 struct supertype *st, unsigned long blocks,
1102 int *fds, unsigned long long *offsets,
1103 int dests, int *destfd, unsigned long long *destoffsets);
598f0d58 1104
549e9569 1105/* for mdmon */
cba0191b 1106 int (*open_new)(struct supertype *c, struct active_array *a,
60815698 1107 int inst);
ed9d66aa
NB
1108
1109 /* Tell the metadata handler the current state of the array.
1110 * This covers whether it is known to be consistent (no pending writes)
01f157d7 1111 * and how far along a resync is known to have progressed
ed9d66aa
NB
1112 * (in a->resync_start).
1113 * resync status is really irrelevant if the array is not consistent,
1114 * but some metadata (DDF!) have a place to record the distinction.
1011e834 1115 * If 'consistent' is '2', then the array can mark it dirty if a
01f157d7
N
1116 * resync/recovery/whatever is required, or leave it clean if not.
1117 * Return value is 0 dirty (not consistent) and 1 if clean.
1118 * it is only really important if consistent is passed in as '2'.
4e5528c6 1119 */
01f157d7 1120 int (*set_array_state)(struct active_array *a, int consistent);
7a7cc504
NB
1121
1122 /* When the state of a device might have changed, we call set_disk to
1123 * tell the metadata what the current state is.
1124 * Typically this happens on spare->in_sync and (spare|in_sync)->faulty
1125 * transitions.
1126 * set_disk might be called when the state of the particular disk has
1127 * not in fact changed.
1128 */
8d45d196 1129 void (*set_disk)(struct active_array *a, int n, int state);
2e735d19
NB
1130 void (*sync_metadata)(struct supertype *st);
1131 void (*process_update)(struct supertype *st,
1132 struct metadata_update *update);
5fe6f031
N
1133 /* Prepare updates allocates extra memory that might be
1134 * needed. If the update cannot be understood, return 0.
1135 */
1136 int (*prepare_update)(struct supertype *st,
edd8d13c 1137 struct metadata_update *update);
549e9569 1138
6c3fb95c
NB
1139 /* activate_spare will check if the array is degraded and, if it
1140 * is, try to find some spare space in the container.
1141 * On success, it add appropriate updates (For process_update) to
1142 * to the 'updates' list and returns a list of 'mdinfo' identifying
1143 * the device, or devices as there might be multiple missing
1144 * devices and multiple spares available.
1145 */
1146 struct mdinfo *(*activate_spare)(struct active_array *a,
1147 struct metadata_update **updates);
2cda7640
ML
1148 /*
1149 * Return statically allocated string that represents metadata specific
1150 * controller domain of the disk. The domain is used in disk domain
1151 * matching functions. Disks belong to the same domain if the they have
1152 * the same domain from mdadm.conf and belong the same metadata domain.
1153 * Returning NULL or not providing this handler means that metadata
1154 * does not distinguish the differences between disks that belong to
1155 * different controllers. They are in the domain specified by
1156 * configuration file (mdadm.conf).
1157 * In case when the metadata has the notion of domains based on disk
1158 * it shall return NULL for disks that do not belong to the controller
1159 * the supported domains. Such disks will form another domain and won't
1160 * be mixed with supported ones.
1161 */
1162 const char *(*get_disk_controller_domain)(const char *path);
549e9569 1163
ba53ea59
AK
1164 /* for external backup area */
1165 int (*recover_backup)(struct supertype *st, struct mdinfo *info);
1166
0c21b485
PB
1167 /* validate container after assemble */
1168 int (*validate_container)(struct mdinfo *info);
1169
5308f117
AP
1170 /* write initial empty PPL on device */
1171 int (*write_init_ppl)(struct supertype *st, struct mdinfo *info, int fd);
1172
2432ce9b
AP
1173 /* validate ppl before assemble */
1174 int (*validate_ppl)(struct supertype *st, struct mdinfo *info,
1175 struct mdinfo *disk);
1176
1ab97c97
TM
1177 /* records new bad block in metadata */
1178 int (*record_bad_block)(struct active_array *a, int n,
1179 unsigned long long sector, int length);
1180
42d902d9
TM
1181 /* clears bad block from metadata */
1182 int (*clear_bad_block)(struct active_array *a, int n,
1183 unsigned long long sector, int length);
1184
1185 /* get list of bad blocks from metadata */
1186 struct md_bb *(*get_bad_blocks)(struct active_array *a, int n);
1187
f277ce36 1188 int swapuuid; /* true if uuid is bigending rather than hostendian */
d03373f1 1189 int external;
4cce4069 1190 const char *name; /* canonical metadata name */
0f22b998 1191} *superlist[];
82d9eba6 1192
0f22b998
N
1193extern struct superswitch super0, super1;
1194extern struct superswitch super_imsm, super_ddf;
0592faeb 1195extern struct superswitch mbr, gpt;
cdddbdbc 1196
edd8d13c
NB
1197struct metadata_update {
1198 int len;
1199 char *buf;
1200 void *space; /* allocated space that monitor will use */
cb23f1f4
N
1201 void **space_list; /* list of allocated spaces that monitor can
1202 * use or that it returned.
1203 */
edd8d13c
NB
1204 struct metadata_update *next;
1205};
1206
6adfd3af
NB
1207/* A supertype holds a particular collection of metadata.
1208 * It identifies the metadata type by the superswitch, and the particular
1209 * sub-version of that metadata type.
1210 * metadata read in or created is stored in 'sb' and 'info'.
1211 * There are also fields used by mdmon to track containers.
1212 *
352452c3
N
1213 * A supertype may refer to:
1214 * Just an array, possibly in a container
1215 * A container, not identifying any particular array
1216 * Info read from just one device, not yet fully describing the array/container.
1217 *
1218 *
6adfd3af
NB
1219 * A supertype is created by:
1220 * super_by_fd
1221 * guess_super
1222 * dup_super
1223 */
82d9eba6
NB
1224struct supertype {
1225 struct superswitch *ss;
1226 int minor_version;
ea329559 1227 int max_devs;
4dd2df09 1228 char container_devnm[32]; /* devnm of container */
64557c33 1229 void *sb;
111d01fc 1230 void *info;
afa368f4
N
1231 void *other; /* Hack used to convert v0.90 to v1.0 */
1232 unsigned long long devsize;
23bf42cc 1233 unsigned long long data_offset; /* used by v1.x only */
df3346e6
LM
1234 int ignore_hw_compat; /* used to inform metadata handlers that it should ignore
1235 HW/firmware related incompatability to load metadata.
1236 Used when examining metadata to display content of disk
1237 when user has no hw/firmare compatible system.
1238 */
edd8d13c
NB
1239 struct metadata_update *updates;
1240 struct metadata_update **update_tail;
1241
549e9569
NB
1242 /* extra stuff used by mdmon */
1243 struct active_array *arrays;
549e9569 1244 int sock; /* listen to external programs */
4dd2df09
N
1245 char devnm[32]; /* e.g. md0. This appears in metadata_version:
1246 * external:/md0/12
1247 */
549e9569 1248 int devcnt;
68226a80 1249 int retry_soon;
529e2aa5 1250 int nodes;
7716570e 1251 char *cluster_name;
549e9569
NB
1252
1253 struct mdinfo *devs;
1254
82d9eba6 1255};
f9ce90ba 1256
4725bc31 1257extern struct supertype *super_by_fd(int fd, char **subarray);
54887ad8
N
1258enum guess_types { guess_any, guess_array, guess_partitions };
1259extern struct supertype *guess_super_type(int fd, enum guess_types guess_type);
1260static inline struct supertype *guess_super(int fd) {
1261 return guess_super_type(fd, guess_any);
1262}
3da92f27 1263extern struct supertype *dup_super(struct supertype *st);
beae1dfe 1264extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
32971509 1265extern int get_dev_sector_size(int fd, char *dname, unsigned int *sectsizep);
3a371610 1266extern int must_be_container(int fd);
0f0749ad 1267extern int dev_size_from_id(dev_t id, unsigned long long *size);
4b57ecf6 1268extern int dev_sector_size_from_id(dev_t id, unsigned int *size);
a7c6e3fb 1269void wait_for(char *dev, int fd);
f9ce90ba 1270
5527fc74
N
1271/*
1272 * Data structures for policy management.
1273 * Each device can have a policy structure that lists
1274 * various name/value pairs each possibly with a metadata associated.
1275 * The policy list is sorted by name/value/metadata
1276 */
1277struct dev_policy {
1278 struct dev_policy *next;
1279 char *name; /* None of these strings are allocated. They are
1280 * all just references to strings which are known
1281 * to exist elsewhere.
1282 * name and metadata can be compared by address equality.
1283 */
1284 const char *metadata;
2cda7640 1285 const char *value;
5527fc74
N
1286};
1287
4e8d9f0a 1288extern char pol_act[], pol_domain[], pol_metadata[], pol_auto[];
5527fc74
N
1289
1290/* iterate over the sublist starting at list, having the same
1291 * 'name' as 'list', and matching the given metadata (Where
1292 * NULL matches anything
1293 */
1294#define pol_for_each(item, list, _metadata) \
1295 for (item = list; \
1296 item && item->name == list->name; \
1297 item = item->next) \
1298 if (!(!_metadata || !item->metadata || _metadata == item->metadata)) \
1299 ; else
1300
1301/*
1302 * policy records read from mdadm are largely just name-value pairs.
1303 * The names are constants, not strdupped
1304 */
1305struct pol_rule {
1306 struct pol_rule *next;
1307 char *type; /* rule_policy or rule_part */
1308 struct rule {
1309 struct rule *next;
1310 char *name;
1311 char *value;
1312 char *dups; /* duplicates of 'value' with a partNN appended */
1313 } *rule;
1314};
1315
1316extern char rule_policy[], rule_part[];
1317extern char rule_path[], rule_type[];
1318extern char type_part[], type_disk[];
1319
1320extern void policyline(char *line, char *type);
4e8d9f0a 1321extern void policy_add(char *type, ...);
5527fc74
N
1322extern void policy_free(void);
1323
cd72f9d1 1324extern struct dev_policy *path_policy(char **paths, char *type);
5527fc74 1325extern struct dev_policy *disk_policy(struct mdinfo *disk);
4dd2df09 1326extern struct dev_policy *devid_policy(int devid);
5527fc74
N
1327extern void dev_policy_free(struct dev_policy *p);
1328
e78dda3b
N
1329//extern void pol_new(struct dev_policy **pol, char *name, char *val, char *metadata);
1330extern void pol_add(struct dev_policy **pol, char *name, char *val, char *metadata);
5527fc74
N
1331extern struct dev_policy *pol_find(struct dev_policy *pol, char *name);
1332
e3bb5f14
N
1333enum policy_action {
1334 act_default,
1335 act_include,
1336 act_re_add,
d2db3045
N
1337 act_spare, /* This only applies to bare devices */
1338 act_spare_same_slot, /* this allows non-bare devices,
1339 * but only if recent removal */
1340 act_force_spare, /* this allow non-bare devices in any case */
e3bb5f14
N
1341 act_err
1342};
1343
1344extern int policy_action_allows(struct dev_policy *plist, const char *metadata,
1345 enum policy_action want);
1346extern int disk_action_allows(struct mdinfo *disk, const char *metadata,
1347 enum policy_action want);
f5f12c84
N
1348
1349struct domainlist {
1350 struct domainlist *next;
2cda7640 1351 const char *dom;
f5f12c84
N
1352};
1353
1354extern int domain_test(struct domainlist *dom, struct dev_policy *pol,
1355 const char *metadata);
1356extern struct domainlist *domain_from_array(struct mdinfo *mdi,
1357 const char *metadata);
4dd2df09 1358extern void domainlist_add_dev(struct domainlist **dom, int devid,
e78dda3b 1359 const char *metadata);
f5f12c84
N
1360extern void domain_free(struct domainlist *dl);
1361extern void domain_merge(struct domainlist **domp, struct dev_policy *pol,
1362 const char *metadata);
e78dda3b 1363void domain_add(struct domainlist **domp, char *domain);
f5f12c84 1364
403410eb
PC
1365extern void policy_save_path(char *id_path, struct map_ent *array);
1366extern int policy_check_path(struct mdinfo *disk, struct map_ent *array);
1367
b0681598
MD
1368extern void sysfs_rules_apply(char *devnm, struct mdinfo *dev);
1369extern void sysfsline(char *line);
1370
838acbc2
NB
1371#if __GNUC__ < 3
1372struct stat64;
1373#endif
1374
45e878bb
NB
1375#define HAVE_NFTW we assume
1376#define HAVE_FTW
1377
2df1f269 1378#ifdef __UCLIBC__
45e878bb 1379# include <features.h>
2df1f269
BRF
1380# ifndef __UCLIBC_HAS_LFS__
1381# define lseek64 lseek
1382# endif
45e878bb
NB
1383# ifndef __UCLIBC_HAS_FTW__
1384# undef HAVE_FTW
1385# undef HAVE_NFTW
1386# endif
1387#endif
1388
1389#ifdef __dietlibc__
1390# undef HAVE_NFTW
1391#endif
1392
e39b673e 1393#if defined(__KLIBC__)
1394# undef HAVE_NFTW
1395# undef HAVE_FTW
1396#endif
1397
45e878bb 1398#ifndef HAVE_NFTW
173fc515 1399# define FTW_PHYS 1
45e878bb
NB
1400# ifndef HAVE_FTW
1401 struct FTW {};
173fc515
NB
1402# endif
1403#endif
1404
45e878bb
NB
1405#ifdef HAVE_FTW
1406# include <ftw.h>
1407#endif
1408
173fc515
NB
1409extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
1410
64c4757e 1411extern int Manage_ro(char *devname, int fd, int readonly);
d5a40416 1412extern int Manage_run(char *devname, int fd, struct context *c);
fe7e0e64
N
1413extern int Manage_stop(char *devname, int fd, int quiet,
1414 int will_retry);
64c4757e 1415extern int Manage_subdevs(char *devname, int fd,
833bb0f8 1416 struct mddev_dev *devlist, int verbose, int test,
11b391ec 1417 char *update, int force);
1f48664b 1418extern int autodetect(void);
e5329c37 1419extern int Grow_Add_device(char *devname, int fd, char *newdev);
50f01ba5
N
1420extern int Grow_addbitmap(char *devname, int fd,
1421 struct context *c, struct shape *s);
32754b7d 1422extern int Grow_reshape(char *devname, int fd,
e2e53a2d 1423 struct mddev_dev *devlist,
40c9a66a 1424 unsigned long long data_offset,
32754b7d 1425 struct context *c, struct shape *s);
06b0d786 1426extern int Grow_restart(struct supertype *st, struct mdinfo *info,
ea0ebe96 1427 int *fdlist, int cnt, char *backup_file, int verbose);
e9e43ec3 1428extern int Grow_continue(int mdfd, struct supertype *st,
b76b30e0 1429 struct mdinfo *info, char *backup_file,
06e293d0 1430 int forked, int freeze_reshape);
860f11ed
AP
1431extern int Grow_consistency_policy(char *devname, int fd,
1432 struct context *c, struct shape *s);
b76b30e0 1433
3f54bd62
AK
1434extern int restore_backup(struct supertype *st,
1435 struct mdinfo *content,
1436 int working_disks,
1437 int spares,
54ded86f 1438 char **backup_filep,
3f54bd62 1439 int verbose);
2dddadb0
AK
1440extern int Grow_continue_command(char *devname, int fd,
1441 char *backup_file, int verbose);
64c4757e 1442
7f91af49 1443extern int Assemble(struct supertype *st, char *mddev,
fa56eddb 1444 struct mddev_ident *ident,
87f26d14 1445 struct mddev_dev *devlist,
4977146a 1446 struct context *c);
64c4757e 1447
a4e8316a
N
1448extern int Build(char *mddev, struct mddev_dev *devlist,
1449 struct shape *s, struct context *c);
64c4757e 1450
7f91af49 1451extern int Create(struct supertype *st, char *mddev,
171dccc8 1452 char *name, int *uuid,
a655e550 1453 int subdevs, struct mddev_dev *devlist,
99cc42f4 1454 struct shape *s,
40c9a66a
N
1455 struct context *c,
1456 unsigned long long data_offset);
64c4757e 1457
ef898ce6 1458extern int Detail(char *dev, struct context *c);
9eafa1de 1459extern int Detail_Platform(struct superswitch *ss, int scan, int verbose, int export, char *controller_path);
e0d19036 1460extern int Query(char *dev);
6d388a88 1461extern int ExamineBadblocks(char *devname, int brief, struct supertype *forcest);
eec3f887
N
1462extern int Examine(struct mddev_dev *devlist, struct context *c,
1463 struct supertype *forcest);
a655e550 1464extern int Monitor(struct mddev_dev *devlist,
e0d19036 1465 char *mailaddr, char *alert_cmd,
95c50205
N
1466 struct context *c,
1467 int daemonise, int oneshot,
1468 int dosyslog, char *pidfile, int increments,
1469 int share);
64c4757e 1470
ba728be7
N
1471extern int Kill(char *dev, struct supertype *st, int force, int verbose, int noexcl);
1472extern int Kill_subarray(char *dev, char *subarray, int verbose);
fa56eddb 1473extern int Update_subarray(char *dev, char *subarray, char *update, struct mddev_ident *ident, int quiet);
b90c0e9a 1474extern int Wait(char *dev);
1ea04629 1475extern int WaitClean(char *dev, int verbose);
a740cf64 1476extern int SetAction(char *dev, char *action);
9a9dab36 1477
b11fe74d 1478extern int Incremental(struct mddev_dev *devlist, struct context *c,
11b6d91d 1479 struct supertype *st);
8382f19b 1480extern void RebuildMap(void);
d5a40416 1481extern int IncrementalScan(struct context *c, char *devnm);
950bc344 1482extern int IncrementalRemove(char *devname, char *path, int verbose);
c82f047c
NB
1483extern int CreateBitmap(char *filename, int force, char uuid[16],
1484 unsigned long chunksize, unsigned long daemon_sleep,
dfd4d8ee 1485 unsigned long write_behind,
dcec9ee5
NB
1486 unsigned long long array_size,
1487 int major);
55935d51 1488extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
9c030dad 1489extern int IsBitmapDirty(char *filename);
20b60dcd 1490extern int Write_rules(char *rule_name);
bf4fb153 1491extern int bitmap_update_uuid(int fd, int *uuid, int swap);
561ad559
AP
1492
1493/* calculate the size of the bitmap given the array size and bitmap chunksize */
1494static inline unsigned long long
1495bitmap_bits(unsigned long long array_size, unsigned long chunksize)
1496{
1497 return (array_size * 512 + chunksize - 1) / chunksize;
1498}
1499
74db60b0
N
1500extern int Dump_metadata(char *dev, char *dir, struct context *c,
1501 struct supertype *st);
1502extern int Restore_metadata(char *dev, char *dir, struct context *c,
1503 struct supertype *st, int only);
c82f047c 1504
9db2ab4e 1505int md_array_valid(int fd);
3ab8f4bf 1506int md_array_active(int fd);
a822017f 1507int md_array_is_active(struct mdinfo *info);
9cd39f01 1508int md_get_array_info(int fd, struct mdu_array_info_s *array);
018a4882 1509int md_set_array_info(int fd, struct mdu_array_info_s *array);
d97572f5 1510int md_get_disk_info(int fd, struct mdu_disk_info_s *disk);
e0d19036 1511extern int get_linux_version(void);
bc77ed53 1512extern int mdadm_version(char *version);
51d4261c 1513extern unsigned long long parse_size(char *size);
64c4757e 1514extern int parse_uuid(char *str, int uuid[4]);
913f07d1 1515int default_layout(struct supertype *st, int level, int verbose);
5339f996 1516extern int is_near_layout_10(int layout);
4a06e2c2
N
1517extern int parse_layout_10(char *layout);
1518extern int parse_layout_faulty(char *layout);
60815698 1519extern int parse_num(int *dest, char *num);
4de90913 1520extern int parse_cluster_confirm_arg(char *inp, char **devname, int *slot);
682c7051
NB
1521extern int check_ext2(int fd, char *name);
1522extern int check_reiser(int fd, char *name);
1523extern int check_raid(int fd, char *name);
53ed6ac3
KW
1524extern int check_partitions(int fd, char *dname,
1525 unsigned long long freesize,
1526 unsigned long long size);
0a6bff09 1527extern int fstat_is_blkdev(int fd, char *devname, dev_t *rdev);
9e04ac1c 1528extern int stat_is_blkdev(char *devname, dev_t *rdev);
64c4757e 1529
a35aa68f 1530extern bool is_dev_alive(char *path);
dd0781e5 1531extern int get_mdp_major(void);
cc742d38 1532extern int get_maj_min(char *dev, int *major, int *minor);
8b0dabea 1533extern int dev_open(char *dev, int flags);
4dd2df09 1534extern int open_dev(char *devnm);
8832342d 1535extern void reopen_mddev(int mdfd);
4dd2df09
N
1536extern int open_dev_flags(char *devnm, int flags);
1537extern int open_dev_excl(char *devnm);
8d80900b 1538extern int is_standard(char *dev, int *nump);
9008ed1c 1539extern int same_dev(char *one, char *two);
9eafa1de 1540extern int compare_paths (char* path1,char* path2);
a7dec3fd 1541extern void enable_fds(int devices);
ff6bb131
MT
1542extern void manage_fork_fds(int close_all);
1543extern int continue_via_systemd(char *devnm, char *service_name);
dd0781e5 1544
f1ae21c4 1545extern int parse_auto(char *str, char *msg, int config);
fa56eddb 1546extern struct mddev_ident *conf_get_ident(char *dev);
a655e550 1547extern struct mddev_dev *conf_get_devs(void);
8382f19b 1548extern int conf_test_dev(char *devname);
4e8d9f0a 1549extern int conf_test_metadata(const char *version, struct dev_policy *pol, int is_homehost);
8aec876d
NB
1550extern struct createinfo *conf_get_create_info(void);
1551extern void set_conffile(char *file);
1552extern char *conf_get_mailaddr(void);
1553extern char *conf_get_mailfrom(void);
1554extern char *conf_get_program(void);
0ac91628 1555extern char *conf_get_homehost(int *require_homehostp);
7716570e 1556extern char *conf_get_homecluster(void);
0663137c 1557extern int conf_get_monitor_delay(void);
e0d19036 1558extern char *conf_line(FILE *file);
98c6faba 1559extern char *conf_word(FILE *file, int allow_key);
7103b9b8
N
1560extern void print_quoted(char *str);
1561extern void print_escape(char *str);
06d2ffc3 1562extern int use_udev(void);
2eba8496 1563extern unsigned long GCD(unsigned long a, unsigned long b);
0ac91628 1564extern int conf_name_is_free(char *name);
7c336758 1565extern int conf_verify_devnames(struct mddev_ident *array_list);
0ac91628 1566extern int devname_matches(char *name, char *match);
2244d1a9
N
1567extern struct mddev_ident *conf_match(struct supertype *st,
1568 struct mdinfo *info,
1569 char *devname,
1570 int verbose, int *rvp);
0ac91628 1571
e0d19036
NB
1572extern void free_line(char *line);
1573extern int match_oneof(char *devices, char *devname);
e0d19036 1574extern void uuid_from_super(int uuid[4], mdp_super_t *super);
22e263f6 1575extern const int uuid_zero[4];
f277ce36 1576extern int same_uuid(int a[4], int b[4], int swapuuid);
350f29f9 1577extern void copy_uuid(void *a, int b[4], int swapuuid);
aae5a112 1578extern char *__fname_from_uuid(int id[4], int swap, char *buf, char sep);
d7288ddc 1579extern char *fname_from_uuid(struct supertype *st,
ff54de6e 1580 struct mdinfo *info, char *buf, char sep);
4b1ac34b 1581extern unsigned long calc_csum(void *super, int bytes);
583315d9 1582extern int enough(int level, int raid_disks, int layout, int clean,
de5a472e 1583 char *avail);
e0d19036 1584extern int ask(char *mesg);
8fac0577 1585extern unsigned long long get_component_size(int fd);
0430ed48 1586extern void remove_partitions(int fd);
691c6ee1 1587extern int test_partition(int fd);
bfd76b93 1588extern int test_partition_from_id(dev_t id);
577e8448 1589extern int get_data_disks(int level, int layout, int raid_disks);
5f8097be
NB
1590extern unsigned long long calc_array_size(int level, int raid_disks, int layout,
1591 int chunksize, unsigned long long devsize);
edd8d13c
NB
1592extern int flush_metadata_updates(struct supertype *st);
1593extern void append_metadata_update(struct supertype *st, void *buf, int len);
6234c63c 1594extern int assemble_container_content(struct supertype *st, int mdfd,
11b6d91d
N
1595 struct mdinfo *content,
1596 struct context *c,
9ca39acb
N
1597 char *chosen_name, int *result);
1598#define INCR_NO 1
1599#define INCR_UNSAFE 2
1600#define INCR_ALREADY 4
1601#define INCR_YES 8
326727d9 1602extern struct mdinfo *container_choose_spares(struct supertype *st,
fbfdcb06 1603 struct spare_criteria *criteria,
326727d9
AC
1604 struct domainlist *domlist,
1605 char *spare_group,
1606 const char *metadata, int get_one);
d52bb542 1607extern int move_spare(char *from_devname, char *to_devname, dev_t devid);
7801ac20
N
1608extern int add_disk(int mdfd, struct supertype *st,
1609 struct mdinfo *sra, struct mdinfo *info);
de6ae750
N
1610extern int remove_disk(int mdfd, struct supertype *st,
1611 struct mdinfo *sra, struct mdinfo *info);
1ab9ed2a
N
1612extern int hot_remove_disk(int mdfd, unsigned long dev, int force);
1613extern int sys_hot_remove_disk(int statefd, int force);
f35f2525 1614extern int set_array_info(int mdfd, struct supertype *st, struct mdinfo *info);
1e5c6983 1615unsigned long long min_recovery_start(struct mdinfo *array);
cd29a5c8 1616
56eb10c0 1617extern char *human_size(long long bytes);
f0ec6710 1618extern char *human_size_brief(long long bytes, int prefix);
e4965ef8 1619extern void print_r10_layout(int layout);
e0d19036 1620
4dd2df09 1621extern char *find_free_devnm(int use_partitions);
63152c1b 1622
e0d19036 1623extern void put_md_name(char *name);
d3c40fab 1624extern char *devid2kname(dev_t devid);
13db17bd
ML
1625extern char *devid2devnm(dev_t devid);
1626extern dev_t devnm2devid(char *devnm);
4dd2df09 1627extern char *get_md_name(char *devnm);
e0d19036 1628
c913b90e 1629extern char DefaultConfFile[];
b5e64645 1630
69207ff6 1631extern int create_mddev(char *dev, char *name, int autof, int trustworthy,
cd6cbb08 1632 char *chosen, int block_udev);
69207ff6
N
1633/* values for 'trustworthy' */
1634#define LOCAL 1
d1d3482b 1635#define LOCAL_ANY 10
69207ff6
N
1636#define FOREIGN 2
1637#define METADATA 3
6be1d39d 1638extern int open_mddev(char *dev, int report_errors);
a322f70c 1639extern int open_container(int fd);
4dd2df09
N
1640extern int metadata_container_matches(char *metadata, char *devnm);
1641extern int metadata_subdev_matches(char *metadata, char *devnm);
33414a01
DW
1642extern int is_container_member(struct mdstat_ent *ent, char *devname);
1643extern int is_subarray_active(char *subarray, char *devname);
feab51f8 1644extern int open_subarray(char *dev, char *subarray, struct supertype *st, int quiet);
33414a01 1645extern struct superswitch *version_to_superswitch(char *vers);
b5e64645 1646
4dd2df09
N
1647extern int mdmon_running(char *devnm);
1648extern int mdmon_pid(char *devnm);
40ebbb9c 1649extern int check_env(char *name);
148acb7b 1650extern __u32 random32(void);
c5f71c24 1651extern void random_uuid(__u8 *buf);
4dd2df09 1652extern int start_mdmon(char *devnm);
a931db9e 1653
999b4972
N
1654extern int child_monitor(int afd, struct mdinfo *sra, struct reshape *reshape,
1655 struct supertype *st, unsigned long stripes,
1656 int *fds, unsigned long long *offsets,
1657 int dests, int *destfd, unsigned long long *destoffsets);
10f22854 1658void abort_reshape(struct mdinfo *sra);
999b4972 1659
afa368f4
N
1660void *super1_make_v0(struct supertype *st, struct mdinfo *info, mdp_super_t *sb0);
1661
f96b1302
AP
1662extern char *stat2kname(struct stat *st);
1663extern char *fd2kname(int fd);
4dd2df09
N
1664extern char *stat2devnm(struct stat *st);
1665extern char *fd2devnm(int fd);
cd6cbb08
N
1666extern void udev_block(char *devnm);
1667extern void udev_unblock(void);
a931db9e 1668
a9c15847 1669extern int in_initrd(void);
d15a1f72 1670
e80357f8
GJ
1671struct cmap_hooks {
1672 void *cmap_handle; /* corosync lib related */
1673
1674 int (*initialize)(cmap_handle_t *handle);
1675 int (*get_string)(cmap_handle_t handle,
1676 const char *string,
1677 char **name);
1678 int (*finalize)(cmap_handle_t handle);
1679};
1680
1681extern void set_cmap_hooks(void);
1682extern void set_hooks(void);
1683
d15a1f72
GJ
1684struct dlm_hooks {
1685 void *dlm_handle; /* dlm lib related */
1686
1687 dlm_lshandle_t (*create_lockspace)(const char *name,
1688 unsigned int mode);
1b7eb962 1689 dlm_lshandle_t (*open_lockspace)(const char *name);
d15a1f72
GJ
1690 int (*release_lockspace)(const char *name, dlm_lshandle_t ls,
1691 int force);
1692 int (*ls_lock)(dlm_lshandle_t lockspace, uint32_t mode,
1693 struct dlm_lksb *lksb, uint32_t flags,
1694 const void *name, unsigned int namelen,
1695 uint32_t parent, void (*astaddr) (void *astarg),
1696 void *astarg, void (*bastaddr) (void *astarg),
1697 void *range);
1b7eb962
GJ
1698 int (*ls_unlock_wait)(dlm_lshandle_t lockspace, uint32_t lkid,
1699 uint32_t flags, struct dlm_lksb *lksb);
d15a1f72
GJ
1700 int (*ls_get_fd)(dlm_lshandle_t ls);
1701 int (*dispatch)(int fd);
1702};
1703
7716570e 1704extern int get_cluster_name(char **name);
81a8a694 1705extern int dlm_funs_ready(void);
1b7eb962
GJ
1706extern int cluster_get_dlmlock(void);
1707extern int cluster_release_dlmlock(void);
d15a1f72 1708extern void set_dlm_hooks(void);
a9c15847 1709
2d762ade 1710#define _ROUND_UP(val, base) (((val) + (base) - 1) & ~(base - 1))
de897065
JS
1711#define ROUND_UP(val, base) _ROUND_UP(val, (typeof(val))(base))
1712#define ROUND_UP_PTR(ptr, base) ((typeof(ptr)) \
1713 (ROUND_UP((unsigned long)(ptr), base)))
6416d527 1714
3c558363
N
1715static inline int is_subarray(char *vers)
1716{
e9dd1598 1717 /* The version string for a 'subarray' (an array in a container)
1011e834 1718 * is
e9dd1598 1719 * /containername/componentname for normal read-write arrays
746a6567
N
1720 * -containername/componentname for arrays which mdmon must not
1721 * reconfigure. They might be read-only
1722 * or might be undergoing reshape etc.
e9dd1598
N
1723 * containername is e.g. md0, md_d1
1724 * componentname is dependant on the metadata. e.g. '1' 'S1' ...
1725 */
1726 return (*vers == '/' || *vers == '-');
3c558363
N
1727}
1728
e5408a32
DW
1729static inline char *to_subarray(struct mdstat_ent *ent, char *container)
1730{
1731 return &ent->metadata_version[10+strlen(container)+1];
1732}
1733
83a379cf
LF
1734/**
1735 * signal_s() - Wrapper for sigaction() with signal()-like interface.
1736 * @sig: The signal to set the signal handler to.
1737 * @handler: The signal handler.
1738 *
1739 * Return: previous handler or SIG_ERR on failure.
1740 */
1741static inline sighandler_t signal_s(int sig, sighandler_t handler)
1742{
1743 struct sigaction new_act;
1744 struct sigaction old_act;
1745
1746 new_act.sa_handler = handler;
1747 new_act.sa_flags = 0;
1748
1749 if (sigaction(sig, &new_act, &old_act) == 0)
1750 return old_act.sa_handler;
1751
1752 return SIG_ERR;
1753}
1754
2a24d7b6
DW
1755#ifdef DEBUG
1756#define dprintf(fmt, arg...) \
1ade5cc1
N
1757 fprintf(stderr, "%s: %s: "fmt, Name, __func__, ##arg)
1758#define dprintf_cont(fmt, arg...) \
2a24d7b6
DW
1759 fprintf(stderr, fmt, ##arg)
1760#else
1761#define dprintf(fmt, arg...) \
1ade5cc1
N
1762 ({ if (0) fprintf(stderr, "%s: %s: " fmt, Name, __func__, ##arg); 0; })
1763#define dprintf_cont(fmt, arg...) \
2a24d7b6
DW
1764 ({ if (0) fprintf(stderr, fmt, ##arg); 0; })
1765#endif
1a0ee0ba
DK
1766#include <assert.h>
1767#include <stdarg.h>
1768static inline int xasprintf(char **strp, const char *fmt, ...) {
1769 va_list ap;
1770 int ret;
1771 va_start(ap, fmt);
089485cb 1772 ret = vasprintf(strp, fmt, ap);
1a0ee0ba
DK
1773 va_end(ap);
1774 assert(ret >= 0);
1775 return ret;
1776}
2a24d7b6 1777
1ade5cc1
N
1778#ifdef DEBUG
1779#define pr_err(fmt, args...) fprintf(stderr, "%s: %s: "fmt, Name, __func__, ##args)
1780#else
d56dd607 1781#define pr_err(fmt, args...) fprintf(stderr, "%s: "fmt, Name, ##args)
1ade5cc1 1782#endif
e7b84f9d
N
1783#define cont_err(fmt ...) fprintf(stderr, " " fmt)
1784
503975b9
N
1785void *xmalloc(size_t len);
1786void *xrealloc(void *ptr, size_t len);
1787void *xcalloc(size_t num, size_t size);
1788char *xstrdup(const char *str);
1789
b5e64645
NB
1790#define LEVEL_MULTIPATH (-4)
1791#define LEVEL_LINEAR (-1)
1792#define LEVEL_FAULTY (-5)
1793
17f25ca6
NB
1794/* kernel module doesn't know about these */
1795#define LEVEL_CONTAINER (-100)
a322f70c 1796#define LEVEL_UNSUPPORTED (-200)
17f25ca6 1797
56cb05c4
N
1798/* the kernel does know about this one ... */
1799#define LEVEL_NONE (-1000000)
1800
b5e64645
NB
1801/* faulty stuff */
1802
1803#define WriteTransient 0
1804#define ReadTransient 1
1805#define WritePersistent 2
1806#define ReadPersistent 3
1807#define WriteAll 4 /* doesn't go to device */
1808#define ReadFixable 5
1809#define Modes 6
1810
1811#define ClearErrors 31
1812#define ClearFaults 30
1813
1814#define AllPersist 100 /* internal use only */
1815#define NoPersist 101
1816
1817#define ModeMask 0x1f
1818#define ModeShift 5
fe6729fa 1819
fe6729fa
NB
1820#ifdef __TINYC__
1821#undef minor
1822#undef major
1823#undef makedev
1824#define minor(x) ((x)&0xff)
1825#define major(x) (((x)>>8)&0xff)
1826#define makedev(M,m) (((M)<<8) | (m))
1827#endif
1828
329dfc28
N
1829enum r0layout {
1830 RAID0_ORIG_LAYOUT = 1,
1831 RAID0_ALT_MULTIZONE_LAYOUT = 2,
1832};
1833
b640a252 1834/* for raid4/5/6 */
e86c9dd6
NB
1835#define ALGORITHM_LEFT_ASYMMETRIC 0
1836#define ALGORITHM_RIGHT_ASYMMETRIC 1
1837#define ALGORITHM_LEFT_SYMMETRIC 2
1838#define ALGORITHM_RIGHT_SYMMETRIC 3
b640a252
N
1839
1840/* Define non-rotating (raid4) algorithms. These allow
1841 * conversion of raid4 to raid5.
1842 */
1843#define ALGORITHM_PARITY_0 4 /* P or P,Q are initial devices */
1844#define ALGORITHM_PARITY_N 5 /* P or P,Q are final devices. */
1845
1846/* DDF RAID6 layouts differ from md/raid6 layouts in two ways.
1847 * Firstly, the exact positioning of the parity block is slightly
1848 * different between the 'LEFT_*' modes of md and the "_N_*" modes
1849 * of DDF.
1850 * Secondly, or order of datablocks over which the Q syndrome is computed
1851 * is different.
1852 * Consequently we have different layouts for DDF/raid6 than md/raid6.
1853 * These layouts are from the DDFv1.2 spec.
1854 * Interestingly DDFv1.2-Errata-A does not specify N_CONTINUE but
1855 * leaves RLQ=3 as 'Vendor Specific'
1856 */
1857
1858#define ALGORITHM_ROTATING_ZERO_RESTART 8 /* DDF PRL=6 RLQ=1 */
1859#define ALGORITHM_ROTATING_N_RESTART 9 /* DDF PRL=6 RLQ=2 */
1860#define ALGORITHM_ROTATING_N_CONTINUE 10 /*DDF PRL=6 RLQ=3 */
1861
b640a252
N
1862/* For every RAID5 algorithm we define a RAID6 algorithm
1863 * with exactly the same layout for data and parity, and
1864 * with the Q block always on the last device (N-1).
1865 * This allows trivial conversion from RAID5 to RAID6
1866 */
1867#define ALGORITHM_LEFT_ASYMMETRIC_6 16
1868#define ALGORITHM_RIGHT_ASYMMETRIC_6 17
1869#define ALGORITHM_LEFT_SYMMETRIC_6 18
1870#define ALGORITHM_RIGHT_SYMMETRIC_6 19
1871#define ALGORITHM_PARITY_0_6 20
1872#define ALGORITHM_PARITY_N_6 ALGORITHM_PARITY_N
1873
33a6535d
AW
1874/* Define PATH_MAX in case we don't use glibc or standard library does
1875 * not have PATH_MAX defined. Assume max path length is 4K characters.
1876 */
1877#ifndef PATH_MAX
1878#define PATH_MAX 4096
1879#endif
1880
9dad51d4
N
1881#define RESYNC_NONE -1
1882#define RESYNC_DELAYED -2
1883#define RESYNC_PENDING -3
1c294b5d
LZ
1884#define RESYNC_REMOTE -4
1885#define RESYNC_UNKNOWN -5
a0963a86 1886
480f3566
N
1887/* When using "GET_DISK_INFO" it isn't certain how high
1888 * we need to check. So we impose an absolute limit of
1889 * MAX_DISKS. This needs to be much more than the largest
1890 * number of devices any metadata can support. Currently
1891 * v1.x can support 1920
1892 */
1893#define MAX_DISKS 4096
1894
d04f65f4
N
1895/* Sometimes the 'size' value passed needs to mean "Maximum".
1896 * In those cases with use MAX_SIZE
1897 */
1898#define MAX_SIZE 1
822e393a
N
1899
1900/* We want to use unsigned numbers for sector counts, but need
1901 * a value for 'invalid'. Use '1'.
1902 */
1903#define INVALID_SECTORS 1
72ca9bcf
N
1904/* And another special number needed for --data_offset=variable */
1905#define VARIABLE_OFFSET 3
ced5fa8b
BK
1906
1907/**
1908 * This is true for native and DDF, IMSM allows 16.
1909 */
1910#define MD_NAME_MAX 32