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