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