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