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