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