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