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