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