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