main: factor out code to parse layout for raid10 and faulty.
[thirdparty/mdadm.git] / mdadm.h
CommitLineData
64c4757e 1/*
9a9dab36 2 * mdadm - manage Linux "md" devices aka RAID arrays.
64c4757e 3 *
4f589ad0 4 * Copyright (C) 2001-2006 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
22 * Email: <neilb@cse.unsw.edu.au>
23 * Paper: Neil Brown
24 * School of Computer Science and Engineering
25 * The University of New South Wales
26 * Sydney, 2052
27 * Australia
28 */
29
4ccdb956 30#define _GNU_SOURCE
c2c9bb6f 31#define _FILE_OFFSET_BITS 64
64c4757e 32#include <unistd.h>
e39b673e 33#if !defined(__dietlibc__) && !defined(__KLIBC__)
64c4757e 34extern __off64_t lseek64 __P ((int __fd, __off64_t __offset, int __whence));
f783ca4f 35#else
fffdbe5e 36# if defined(__NO_STAT64) || __WORDSIZE != 32
f783ca4f
NB
37# define lseek64 lseek
38# endif
98c6faba 39#endif
64c4757e
NB
40
41#include <sys/types.h>
42#include <sys/stat.h>
43#include <stdlib.h>
44#include <time.h>
11018a45 45#include <sys/time.h>
64c4757e
NB
46#include <getopt.h>
47#include <fcntl.h>
48#include <stdio.h>
49#include <errno.h>
50#include <string.h>
773135f5 51#include <syslog.h>
b56c3630
NB
52#ifdef __dietlibc__
53#include <strings.h>
280a927d
NB
54/* dietlibc has deprecated random and srandom!! */
55#define random rand
56#define srandom srand
98c6faba
NB
57#endif
58
64c4757e
NB
59
60#include <linux/kdev_t.h>
e0d19036
NB
61/*#include <linux/fs.h> */
62#include <sys/mount.h>
63#include <asm/types.h>
64c4757e
NB
64#include <sys/ioctl.h>
65#define MD_MAJOR 9
dd0781e5 66#define MdpMinorShift 6
64c4757e 67
e0d19036 68#ifndef BLKGETSIZE64
98c6faba 69#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
e0d19036 70#endif
56eb10c0 71
c82f047c
NB
72#define DEFAULT_BITMAP_CHUNK 4096
73#define DEFAULT_BITMAP_DELAY 5
dfd4d8ee 74#define DEFAULT_MAX_WRITE_BEHIND 256
64c4757e
NB
75
76#include "md_u.h"
e0d19036 77#include "md_p.h"
c82f047c 78#include "bitmap.h"
f7dd881f 79#include "msg.h"
64c4757e 80
1e0d770c 81#include <endian.h>
efd441d1
NB
82/* Redhat don't like to #include <asm/byteorder.h>, and
83 * some time include <linux/byteorder/xxx_endian.h> isn't enough,
84 * and there is no standard conversion function so... */
0ae03b8a
NB
85/* And dietlibc doesn't think byteswap is ok, so.. */
86/* #include <byteswap.h> */
87#define bswap_16(x) (((x) & 0x00ffU) << 8 | \
88 ((x) & 0xff00U) >> 8)
89#define bswap_32(x) (((x) & 0x000000ffU) << 24 | \
90 ((x) & 0xff000000U) >> 24 | \
91 ((x) & 0x0000ff00U) << 8 | \
92 ((x) & 0x00ff0000U) >> 8)
93#define bswap_64(x) (((x) & 0x00000000000000ffULL) << 56 | \
94 ((x) & 0xff00000000000000ULL) >> 56 | \
95 ((x) & 0x000000000000ff00ULL) << 40 | \
96 ((x) & 0x00ff000000000000ULL) >> 40 | \
97 ((x) & 0x0000000000ff0000ULL) << 24 | \
98 ((x) & 0x0000ff0000000000ULL) >> 24 | \
99 ((x) & 0x00000000ff000000ULL) << 8 | \
100 ((x) & 0x000000ff00000000ULL) >> 8)
101
e39b673e 102#if !defined(__KLIBC__)
efd441d1
NB
103#if BYTE_ORDER == LITTLE_ENDIAN
104#define __cpu_to_le16(_x) (_x)
105#define __cpu_to_le32(_x) (_x)
106#define __cpu_to_le64(_x) (_x)
107#define __le16_to_cpu(_x) (_x)
108#define __le32_to_cpu(_x) (_x)
109#define __le64_to_cpu(_x) (_x)
974e620d
NB
110
111#define __cpu_to_be16(_x) bswap_16(_x)
112#define __cpu_to_be32(_x) bswap_32(_x)
113#define __cpu_to_be64(_x) bswap_64(_x)
114#define __be16_to_cpu(_x) bswap_16(_x)
115#define __be32_to_cpu(_x) bswap_32(_x)
116#define __be64_to_cpu(_x) bswap_64(_x)
efd441d1
NB
117#elif BYTE_ORDER == BIG_ENDIAN
118#define __cpu_to_le16(_x) bswap_16(_x)
119#define __cpu_to_le32(_x) bswap_32(_x)
120#define __cpu_to_le64(_x) bswap_64(_x)
121#define __le16_to_cpu(_x) bswap_16(_x)
122#define __le32_to_cpu(_x) bswap_32(_x)
123#define __le64_to_cpu(_x) bswap_64(_x)
974e620d
NB
124
125#define __cpu_to_be16(_x) (_x)
126#define __cpu_to_be32(_x) (_x)
127#define __cpu_to_be64(_x) (_x)
128#define __be16_to_cpu(_x) (_x)
129#define __be32_to_cpu(_x) (_x)
130#define __be64_to_cpu(_x) (_x)
1e0d770c
NB
131#else
132# error "unknown endianness."
133#endif
e39b673e 134#endif /* __KLIBC__ */
1e0d770c
NB
135
136
137
4b1ac34b
NB
138/* general information that might be extracted from a superblock */
139struct mdinfo {
140 mdu_array_info_t array;
141 mdu_disk_info_t disk;
142 __u64 events;
fbf8a0b7 143 int uuid[4];
31317663 144 char name[33];
353632d9 145 unsigned long long data_offset;
598f0d58
NB
146 unsigned long long component_size; /* same as array.size, except in
147 * sectors and up to 64bits.
148 */
da9b4a62
DW
149 unsigned long long custom_array_size; /* size for non-default sized
150 * arrays (in sectors)
151 */
353632d9
NB
152 int reshape_active;
153 unsigned long long reshape_progress;
0fd5c350 154 unsigned long long resync_start;
a67dd8cc 155 unsigned long safe_mode_delay; /* ms delay to mark clean */
353632d9 156 int new_level, delta_disks, new_layout, new_chunk;
06c7f68e 157 int errors;
7e0f6979
NB
158 int cache_size; /* size of raid456 stripe cache*/
159 int mismatch_cnt;
160 char text_version[50];
dd15dc4a
NB
161
162 int container_member; /* for assembling external-metatdata arrays
163 * This is to be used internally by metadata
164 * handler only */
06c7f68e
NB
165
166 char sys_name[20];
7e0f6979 167 struct mdinfo *devs;
06c7f68e 168 struct mdinfo *next;
549e9569
NB
169
170 /* Device info for mdmon: */
171 int state_fd;
8d45d196
DW
172 #define DS_FAULTY 1
173 #define DS_INSYNC 2
174 #define DS_WRITE_MOSTLY 4
175 #define DS_SPARE 8
176 #define DS_BLOCKED 16
177 #define DS_REMOVE 1024
92967543 178 #define DS_UNBLOCK 2048
549e9569
NB
179 int prev_state, curr_state, next_state;
180
4b1ac34b
NB
181};
182
5bbb4842
NB
183struct createinfo {
184 int uid;
185 int gid;
186 int autof;
187 int mode;
38098016 188 int symlinks;
058574b1 189 struct supertype *supertype;
5bbb4842
NB
190};
191
9a9dab36 192#define Name "mdadm"
682c7051 193
e0d19036
NB
194enum mode {
195 ASSEMBLE=1,
196 BUILD,
197 CREATE,
198 MANAGE,
199 MISC,
200 MONITOR,
dd0781e5 201 GROW,
8382f19b 202 INCREMENTAL,
1f48664b 203 AUTODETECT,
e0d19036
NB
204};
205
64c4757e 206extern char short_options[];
024768c4 207extern char short_bitmap_options[];
c06487ce 208extern char short_bitmap_auto_options[];
64c4757e 209extern struct option long_options[];
56eedc1a 210extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5 211 Help_create[], Help_build[], Help_assemble[], Help_grow[],
8382f19b 212 Help_incr[],
e0d19036 213 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e 214
997aed5d
NB
215/* for option that don't have short equivilents, we assign arbitrary
216 * small numbers. '1' means an undecorated option, so we start at '2'.
217 */
218enum special_options {
219 AssumeClean = 2,
220 BitmapChunk,
221 WriteBehind,
222 ReAdd,
223 NoDegraded,
224 Sparc22,
225 BackupFile,
226 HomeHost,
589395d6 227 AutoHomeHost,
38098016 228 Symlinks,
1f48664b 229 AutoDetect,
1770662b 230 Waitclean,
4cce4069 231 DetailPlatform,
997aed5d
NB
232};
233
64c4757e 234/* structures read from config file */
52826846
NB
235/* List of mddevice names and identifiers
236 * Identifiers can be:
237 * uuid=128-hex-uuid
238 * super-minor=decimal-minor-number-from-superblock
239 * devices=comma,separated,list,of,device,names,with,wildcards
240 *
241 * If multiple fields are present, the intersection of all matching
242 * devices is considered
243 */
98c6faba 244#define UnSet (0xfffe)
52826846 245typedef struct mddev_ident_s {
dd0781e5 246 char *devname;
aba69144 247
dd0781e5 248 int uuid_set;
3fa06e9d 249 int uuid[4];
947fd4dd 250 char name[33];
52826846 251
98c6faba 252 unsigned int super_minor;
52826846 253
dd0781e5 254 char *devices; /* comma separated list of device
52826846
NB
255 * names with wild cards
256 */
dd0781e5 257 int level;
98c6faba
NB
258 unsigned int raid_disks;
259 unsigned int spare_disks;
82d9eba6 260 struct supertype *st;
dd0781e5
NB
261 int autof; /* 1 for normal, 2 for partitioned */
262 char *spare_group;
7ef02d01 263 char *bitmap_file;
c82f047c 264 int bitmap_fd;
dd0781e5 265
1771a6e2
N
266 char *container; /* /dev/whatever name of container, or
267 * uuid of container. You would expect
268 * this to be the 'devname' or UUID
dbb44303
N
269 * of some other entry.
270 */
271 char *member; /* subarray within a container */
272
52826846
NB
273 struct mddev_ident_s *next;
274} *mddev_ident_t;
64c4757e
NB
275
276/* List of device names - wildcards expanded */
277typedef struct mddev_dev_s {
278 char *devname;
cd29a5c8
NB
279 char disposition; /* 'a' for add, 'r' for remove, 'f' for fail.
280 * Not set for names read from .config
281 */
b3d31955 282 char writemostly; /* 1 for 'set writemostly', 2 for 'clear writemostly' */
fe80f49b 283 char re_add;
811e6cbe 284 char used; /* set when used */
9008ed1c
N
285 struct mdinfo *content; /* If devname is a container, this might list
286 * the remaining member arrays. */
64c4757e
NB
287 struct mddev_dev_s *next;
288} *mddev_dev_t;
289
682c7051
NB
290typedef struct mapping {
291 char *name;
292 int num;
293} mapping_t;
294
e0d19036
NB
295
296struct mdstat_ent {
297 char *dev;
298 int devnum;
299 int active;
300 char *level;
301 char *pattern; /* U or up, _ for down */
302 int percent; /* -1 if no resync */
e5329c37 303 int resync; /* 1 if resync, 0 if recovery */
549e9569
NB
304 int devcnt;
305 int raid_disks;
306 int chunk_size;
307 char * metadata_version;
e0d19036
NB
308 struct mdstat_ent *next;
309};
310
22a88995 311extern struct mdstat_ent *mdstat_read(int hold, int start);
e0d19036 312extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 313extern void mdstat_wait(int seconds);
1ed3f387 314extern void mdstat_wait_fd(int fd, const sigset_t *sigmask);
8382f19b
NB
315extern int mddev_busy(int devnum);
316
317struct map_ent {
318 struct map_ent *next;
319 int devnum;
1522c538 320 char metadata[20];
8382f19b 321 int uuid[4];
195254b8 322 int bad;
8382f19b
NB
323 char *path;
324};
1522c538 325extern int map_update(struct map_ent **mpp, int devnum, char *metadata,
8382f19b
NB
326 int uuid[4], char *path);
327extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
f2e55ecc
N
328extern struct map_ent *map_by_devnum(struct map_ent **map, int devnum);
329extern struct map_ent *map_by_name(struct map_ent **map, char *name);
8382f19b
NB
330extern void map_read(struct map_ent **melp);
331extern int map_write(struct map_ent *mel);
332extern void map_delete(struct map_ent **mapp, int devnum);
333extern void map_free(struct map_ent *map);
334extern void map_add(struct map_ent **melp,
1522c538 335 int devnum, char *metadata, int uuid[4], char *path);
ad5bc697
N
336extern int map_lock(struct map_ent **melp);
337extern void map_unlock(struct map_ent **melp);
e0d19036 338
e86c9dd6 339/* various details can be requested */
dab4a513
DW
340enum sysfs_read_flags {
341 GET_LEVEL = (1 << 0),
342 GET_LAYOUT = (1 << 1),
343 GET_COMPONENT = (1 << 2),
344 GET_CHUNK = (1 << 3),
345 GET_CACHE = (1 << 4),
346 GET_MISMATCH = (1 << 5),
347 GET_VERSION = (1 << 6),
348 GET_DISKS = (1 << 7),
349 GET_DEGRADED = (1 << 8),
350 GET_SAFEMODE = (1 << 9),
351 GET_DEVS = (1 << 10), /* gets role, major, minor */
352 GET_OFFSET = (1 << 11),
353 GET_SIZE = (1 << 12),
354 GET_STATE = (1 << 13),
355 GET_ERROR = (1 << 14),
356 SKIP_GONE_DEVS = (1 << 15),
357};
e86c9dd6
NB
358
359/* If fd >= 0, get the array it is open on,
360 * else use devnum. >=0 -> major9. <0.....
361 */
549e9569 362extern int sysfs_open(int devnum, char *devname, char *attr);
f35f2525 363extern void sysfs_init(struct mdinfo *mdi, int fd, int devnum);
7e0f6979
NB
364extern void sysfs_free(struct mdinfo *sra);
365extern struct mdinfo *sysfs_read(int fd, int devnum, unsigned long options);
1770662b
DW
366extern int sysfs_attr_match(const char *attr, const char *str);
367extern int sysfs_match_word(const char *word, char **list);
7e0f6979 368extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 369 char *name, char *val);
7e0f6979 370extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 371 char *name, unsigned long long val);
97590376 372extern int sysfs_uevent(struct mdinfo *sra, char *event);
7e0f6979 373extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 374 char *name, unsigned long long *val);
93ecfa01
N
375extern int sysfs_get_str(struct mdinfo *sra, struct mdinfo *dev,
376 char *name, char *val, int size);
8ed3e5e1 377extern int sysfs_set_safemode(struct mdinfo *sra, unsigned long ms);
f35f2525 378extern int sysfs_set_array(struct mdinfo *info, int vers);
462906cd
N
379extern int sysfs_add_disk(struct mdinfo *sra, struct mdinfo *sd,
380 int in_sync);
f1665f72 381extern int sysfs_disk_to_scsi_id(int fd, __u32 *id);
f94d52f4 382extern int sysfs_unique_holder(int devnum, long rdev);
c69b251b 383extern int load_sys(char *path, char *buf);
e86c9dd6
NB
384
385
386extern int save_stripes(int *source, unsigned long long *offsets,
387 int raid_disks, int chunk_size, int level, int layout,
388 int nwrites, int *dest,
389 unsigned long long start, unsigned long long length);
353632d9
NB
390extern int restore_stripes(int *dest, unsigned long long *offsets,
391 int raid_disks, int chunk_size, int level, int layout,
392 int source, unsigned long long read_offset,
393 unsigned long long start, unsigned long long length);
e86c9dd6 394
52826846
NB
395#ifndef Sendmail
396#define Sendmail "/usr/lib/sendmail -t"
397#endif
398
773135f5
NB
399#define SYSLOG_FACILITY LOG_DAEMON
400
682c7051
NB
401extern char *map_num(mapping_t *map, int num);
402extern int map_name(mapping_t *map, char *name);
b640a252 403extern mapping_t r5layout[], r6layout[], pers[], modes[], faultylayout[];
682c7051 404
16c6fa80 405extern char *map_dev(int major, int minor, int create);
64c4757e 406
549e9569 407struct active_array;
2e735d19 408struct metadata_update;
64c4757e 409
6adfd3af
NB
410/* A superswitch provides entry point the a metadata handler.
411 *
412 * The super_switch primarily operates on some "metadata" that
413 * is accessed via the 'supertype'.
414 * This metadata has one of three possible sources.
415 * 1/ It is read from a single device. In this case it may not completely
416 * describe the array or arrays as some information might be on other
417 * devices.
418 * 2/ It is read from all devices in a container. In this case all
419 * information is present.
420 * 3/ It is created by ->init_super / ->add_to_super. In this case it will
421 * be complete once enough ->add_to_super calls have completed.
422 *
423 * When creating an array inside a container, the metadata will be
424 * formed by a combination of 2 and 3. The metadata or the array is read,
425 * then new information is added.
426 *
427 * The metadata must sometimes have a concept of a 'current' array
428 * and a 'current' device.
429 * The 'current' array is set by init_super to be the newly created array,
430 * or is set by super_by_fd when it finds it is looking at an array inside
431 * a container.
432 *
433 * The 'current' device is either the device that the metadata was read from
434 * in case 1, or the last device added by add_to_super in case 3.
435 * Case 2 does not identify a 'current' device.
436 */
f9ce90ba 437extern struct superswitch {
6adfd3af
NB
438
439 /* Used to report details of metadata read from a component
440 * device. ->load_super has been called.
441 */
3da92f27 442 void (*examine_super)(struct supertype *st, char *homehost);
061f2c6a 443 void (*brief_examine_super)(struct supertype *st, int verbose);
0d726f17 444 void (*export_examine_super)(struct supertype *st);
6adfd3af
NB
445
446 /* Used to report details of an active array.
447 * ->load_super was possibly given a 'component' string.
448 */
3da92f27 449 void (*detail_super)(struct supertype *st, char *homehost);
3da92f27 450 void (*brief_detail_super)(struct supertype *st);
0d726f17 451 void (*export_detail_super)(struct supertype *st);
6adfd3af 452
4cce4069 453 /* Optional: platform hardware / firmware details */
5615172f 454 int (*detail_platform)(int verbose, int enumerate_only);
4cce4069 455
6adfd3af
NB
456 /* Used:
457 * to get uuid to storing in bitmap metadata
458 * and 'reshape' backup-data metadata
459 * To see if a device is being re-added to an array it was part of.
460 */
3da92f27 461 void (*uuid_from_super)(struct supertype *st, int uuid[4]);
6adfd3af 462
8592f29d 463 /* Extract generic details from metadata. This could be details about
6adfd3af
NB
464 * the container, or about an individual array within the container.
465 * The determination is made either by:
466 * load_super being given a 'component' string.
467 * validate_geometry determining what to create.
d2ca6449
NB
468 * The info includes both array information and device information.
469 * The particular device should be:
470 * The last device added by add_to_super
471 * The device the metadata was loaded from by load_super
6adfd3af 472 */
3da92f27 473 void (*getinfo_super)(struct supertype *st, struct mdinfo *info);
6adfd3af
NB
474
475 /* Check if the given metadata is flagged as belonging to "this"
9362c1c8 476 * host. 0 for 'no', 1 for 'yes', -1 for "Don't record homehost"
6adfd3af 477 */
3da92f27 478 int (*match_home)(struct supertype *st, char *homehost);
6adfd3af
NB
479
480 /* Make one of several generic modifications to metadata
481 * prior to assembly (or other times).
482 * sparc2.2 - first bug in early 0.90 metadata
483 * super-minor - change name of 0.90 metadata
484 * summaries - 'correct' any redundant data
485 * resync - mark array as dirty to trigger a resync.
486 * uuid - set new uuid - only 0.90 or 1.x
487 * name - change the name of the array (where supported)
488 * homehost - change which host this array is tied to.
489 * devicesize - If metadata is at start of device, change recorded
490 * device size to match actual device size
491 * byteorder - swap bytes for 0.90 metadata
492 *
493 * force-one - mark that device as uptodate, not old or failed.
494 * force-array - mark array as clean if it would not otherwise
495 * assemble
496 * assemble - not sure how this is different from force-one...
497 * linear-grow-new - add a new device to a linear array, but don't
498 * change the size: so superblock still matches
499 * linear-grow-update - now change the size of the array.
500 */
68c7d6d7 501 int (*update_super)(struct supertype *st, struct mdinfo *info,
3da92f27 502 char *update,
e5eac01f
NB
503 char *devname, int verbose,
504 int uuid_set, char *homehost);
6adfd3af
NB
505
506 /* Create new metadata for new array as described. This could
507 * be a new container, or an array in a pre-existing container.
508 * Also used to zero metadata prior to writing it to invalidate old
509 * metadata.
510 */
3da92f27
NB
511 int (*init_super)(struct supertype *st, mdu_array_info_t *info,
512 unsigned long long size, char *name,
513 char *homehost, int *uuid);
6adfd3af
NB
514
515 /* update the metadata to include new device, either at create or
516 * when hot-adding a spare.
517 */
f20c3968 518 int (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo,
111d01fc 519 int fd, char *devname);
6adfd3af
NB
520
521 /* Write metadata to one device when fixing problems or adding
522 * a new device.
523 */
3da92f27 524 int (*store_super)(struct supertype *st, int fd);
6adfd3af
NB
525
526 /* Write all metadata for this array.
527 */
111d01fc 528 int (*write_init_super)(struct supertype *st);
64557c33 529 int (*compare_super)(struct supertype *st, struct supertype *tst);
3da92f27 530 int (*load_super)(struct supertype *st, int fd, char *devname);
82d9eba6 531 struct supertype * (*match_metadata_desc)(char *arg);
1bf4e2d9 532 __u64 (*avail_size)(struct supertype *st, __u64 size);
3da92f27 533 int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
199171a2 534 int delay, int write_behind,
f9c25f1d 535 unsigned long long size, int may_change, int major);
3da92f27
NB
536 void (*locate_bitmap)(struct supertype *st, int fd);
537 int (*write_bitmap)(struct supertype *st, int fd);
538 void (*free_super)(struct supertype *st);
78e44928
NB
539
540 /* validate_geometry is called with an st returned by
541 * match_metadata_desc.
542 * It should check that the geometry described in compatible with
543 * the metadata type. It will be called repeatedly as devices
544 * added to validate changing size and new devices. If there are
545 * inter-device dependencies, it should record sufficient details
546 * so these can be validated.
e46273eb 547 * Both 'size' and '*freesize' are in sectors. chunk is bytes.
78e44928 548 */
17f25ca6
NB
549 int (*validate_geometry)(struct supertype *st, int level, int layout,
550 int raiddisks,
551 int chunk, unsigned long long size,
2c514b71
NB
552 char *subdev, unsigned long long *freesize,
553 int verbose);
598f0d58
NB
554
555 struct mdinfo *(*container_content)(struct supertype *st);
a18a888e
DW
556 /* Allow a metadata handler to override mdadm's default layouts */
557 int (*default_layout)(int level); /* optional */
598f0d58 558
549e9569 559/* for mdmon */
cba0191b
NB
560 int (*open_new)(struct supertype *c, struct active_array *a,
561 char *inst);
ed9d66aa
NB
562
563 /* Tell the metadata handler the current state of the array.
564 * This covers whether it is known to be consistent (no pending writes)
01f157d7 565 * and how far along a resync is known to have progressed
ed9d66aa
NB
566 * (in a->resync_start).
567 * resync status is really irrelevant if the array is not consistent,
568 * but some metadata (DDF!) have a place to record the distinction.
01f157d7
N
569 * If 'consistent' is '2', then the array can mark it dirty if a
570 * resync/recovery/whatever is required, or leave it clean if not.
571 * Return value is 0 dirty (not consistent) and 1 if clean.
572 * it is only really important if consistent is passed in as '2'.
4e5528c6 573 */
01f157d7 574 int (*set_array_state)(struct active_array *a, int consistent);
7a7cc504
NB
575
576 /* When the state of a device might have changed, we call set_disk to
577 * tell the metadata what the current state is.
578 * Typically this happens on spare->in_sync and (spare|in_sync)->faulty
579 * transitions.
580 * set_disk might be called when the state of the particular disk has
581 * not in fact changed.
582 */
8d45d196 583 void (*set_disk)(struct active_array *a, int n, int state);
2e735d19
NB
584 void (*sync_metadata)(struct supertype *st);
585 void (*process_update)(struct supertype *st,
586 struct metadata_update *update);
edd8d13c
NB
587 void (*prepare_update)(struct supertype *st,
588 struct metadata_update *update);
549e9569 589
6c3fb95c
NB
590 /* activate_spare will check if the array is degraded and, if it
591 * is, try to find some spare space in the container.
592 * On success, it add appropriate updates (For process_update) to
593 * to the 'updates' list and returns a list of 'mdinfo' identifying
594 * the device, or devices as there might be multiple missing
595 * devices and multiple spares available.
596 */
597 struct mdinfo *(*activate_spare)(struct active_array *a,
598 struct metadata_update **updates);
549e9569 599
f277ce36 600 int swapuuid; /* true if uuid is bigending rather than hostendian */
d03373f1 601 int external;
4cce4069 602 const char *name; /* canonical metadata name */
0063ecba 603} super0, super1, super_ddf, *superlist[];
82d9eba6 604
0063ecba 605extern struct superswitch super_imsm;
cdddbdbc 606
edd8d13c
NB
607struct metadata_update {
608 int len;
609 char *buf;
610 void *space; /* allocated space that monitor will use */
611 struct metadata_update *next;
612};
613
6adfd3af
NB
614/* A supertype holds a particular collection of metadata.
615 * It identifies the metadata type by the superswitch, and the particular
616 * sub-version of that metadata type.
617 * metadata read in or created is stored in 'sb' and 'info'.
618 * There are also fields used by mdmon to track containers.
619 *
352452c3
N
620 * A supertype may refer to:
621 * Just an array, possibly in a container
622 * A container, not identifying any particular array
623 * Info read from just one device, not yet fully describing the array/container.
624 *
625 *
6adfd3af
NB
626 * A supertype is created by:
627 * super_by_fd
628 * guess_super
629 * dup_super
630 */
82d9eba6
NB
631struct supertype {
632 struct superswitch *ss;
633 int minor_version;
ea329559 634 int max_devs;
2f6079dc 635 int container_dev; /* devnum of container */
f7e7067b 636 char subarray[32]; /* name of array inside container */
64557c33 637 void *sb;
111d01fc 638 void *info;
352452c3
N
639 int loaded_container; /* Set if load_super found a container,
640 * not just one device */
549e9569 641
edd8d13c
NB
642 struct metadata_update *updates;
643 struct metadata_update **update_tail;
644
549e9569
NB
645 /* extra stuff used by mdmon */
646 struct active_array *arrays;
549e9569 647 int sock; /* listen to external programs */
549e9569
NB
648 int devnum;
649 char *devname; /* e.g. md0. This appears in metadata_verison:
650 * external:/md0/12
651 */
652 int devcnt;
653
654 struct mdinfo *devs;
655
82d9eba6 656};
f9ce90ba 657
1686dc25 658extern struct supertype *super_by_fd(int fd);
82d9eba6 659extern struct supertype *guess_super(int fd);
3da92f27 660extern struct supertype *dup_super(struct supertype *st);
beae1dfe 661extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
8382f19b
NB
662extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
663 mdu_disk_info_t *disk);
a7c6e3fb 664void wait_for(char *dev, int fd);
f9ce90ba 665
838acbc2
NB
666#if __GNUC__ < 3
667struct stat64;
668#endif
669
45e878bb
NB
670#define HAVE_NFTW we assume
671#define HAVE_FTW
672
2df1f269 673#ifdef __UCLIBC__
45e878bb 674# include <features.h>
2df1f269
BRF
675# ifndef __UCLIBC_HAS_LFS__
676# define lseek64 lseek
677# endif
45e878bb
NB
678# ifndef __UCLIBC_HAS_FTW__
679# undef HAVE_FTW
680# undef HAVE_NFTW
681# endif
682#endif
683
684#ifdef __dietlibc__
685# undef HAVE_NFTW
686#endif
687
e39b673e 688#if defined(__KLIBC__)
689# undef HAVE_NFTW
690# undef HAVE_FTW
691#endif
692
45e878bb 693#ifndef HAVE_NFTW
173fc515 694# define FTW_PHYS 1
45e878bb
NB
695# ifndef HAVE_FTW
696 struct FTW {};
173fc515
NB
697# endif
698#endif
699
45e878bb
NB
700#ifdef HAVE_FTW
701# include <ftw.h>
702#endif
703
173fc515
NB
704extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
705
f9ce90ba 706
64c4757e 707extern int Manage_ro(char *devname, int fd, int readonly);
91f068bf 708extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
dd0781e5 709extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
b5e64645 710extern int Manage_reconfig(char *devname, int fd, int layout);
64c4757e 711extern int Manage_subdevs(char *devname, int fd,
dab6685f 712 mddev_dev_t devlist, int verbose);
1f48664b 713extern int autodetect(void);
e5329c37 714extern int Grow_Add_device(char *devname, int fd, char *newdev);
8fac0577 715extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
06b0d786 716extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
e86c9dd6
NB
717 long long size,
718 int level, int layout, int chunksize, int raid_disks);
06b0d786
NB
719extern int Grow_restart(struct supertype *st, struct mdinfo *info,
720 int *fdlist, int cnt, char *backup_file);
64c4757e
NB
721
722
7f91af49 723extern int Assemble(struct supertype *st, char *mddev,
52826846 724 mddev_ident_t ident,
06b0d786 725 mddev_dev_t devlist, char *backup_file,
64c4757e 726 int readonly, int runstop,
0ac91628 727 char *update, char *homehost, int require_homehost,
64c4757e
NB
728 int verbose, int force);
729
7f91af49
N
730extern int Build(char *mddev, int chunk, int level, int layout,
731 int raiddisks, mddev_dev_t devlist, int assume_clean,
732 char *bitmap_file, int bitmap_chunk, int write_behind,
83208785 733 int delay, int verbose, int autof, unsigned long long size);
64c4757e
NB
734
735
7f91af49 736extern int Create(struct supertype *st, char *mddev,
5dd497ee 737 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
3d3dd91e 738 char *name, char *homehost, int *uuid,
cd29a5c8 739 int subdevs, mddev_dev_t devlist,
47d79ef8 740 int runstop, int verbose, int force, int assume_clean,
7f91af49 741 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int autof);
64c4757e 742
54bad364 743extern int Detail(char *dev, int brief, int export, int test, char *homehost);
4cce4069 744extern int Detail_Platform(struct superswitch *ss, int scan, int verbose);
e0d19036 745extern int Query(char *dev);
0d726f17
KS
746extern int Examine(mddev_dev_t devlist, int brief, int export, int scan,
747 int SparcAdjust, struct supertype *forcest, char *homehost);
cd29a5c8 748extern int Monitor(mddev_dev_t devlist,
e0d19036 749 char *mailaddr, char *alert_cmd,
aa88f531 750 int period, int daemonise, int scan, int oneshot,
8aec876d 751 int dosyslog, int test, char *pidfile);
64c4757e 752
111d01fc 753extern int Kill(char *dev, int force, int quiet, int noexcl);
b90c0e9a 754extern int Wait(char *dev);
27dec8fa 755extern int WaitClean(char *dev, int verbose);
9a9dab36 756
8382f19b 757extern int Incremental(char *devname, int verbose, int runstop,
0ac91628
N
758 struct supertype *st, char *homehost, int require_homehost,
759 int autof);
598f0d58 760extern int Incremental_container(struct supertype *st, char *devname,
215bb3f7
N
761 int verbose, int runstop, int autof,
762 int trustworthy);
8382f19b
NB
763extern void RebuildMap(void);
764extern int IncrementalScan(int verbose);
765
c82f047c
NB
766extern int CreateBitmap(char *filename, int force, char uuid[16],
767 unsigned long chunksize, unsigned long daemon_sleep,
dfd4d8ee 768 unsigned long write_behind,
dcec9ee5
NB
769 unsigned long long array_size,
770 int major);
55935d51 771extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
bf4fb153 772extern int bitmap_update_uuid(int fd, int *uuid, int swap);
2a528478 773extern unsigned long bitmap_sectors(struct bitmap_super_s *bsb);
c82f047c 774
64c4757e 775extern int md_get_version(int fd);
e0d19036 776extern int get_linux_version(void);
84e11361 777extern long long parse_size(char *size);
64c4757e 778extern int parse_uuid(char *str, int uuid[4]);
4a06e2c2
N
779extern int parse_layout_10(char *layout);
780extern int parse_layout_faulty(char *layout);
682c7051
NB
781extern int check_ext2(int fd, char *name);
782extern int check_reiser(int fd, char *name);
783extern int check_raid(int fd, char *name);
64c4757e 784
dd0781e5 785extern int get_mdp_major(void);
8b0dabea 786extern int dev_open(char *dev, int flags);
e8a70c89 787extern int open_dev(int devnum);
a931db9e 788extern int open_dev_excl(int devnum);
8d80900b 789extern int is_standard(char *dev, int *nump);
9008ed1c 790extern int same_dev(char *one, char *two);
dd0781e5 791
f1ae21c4 792extern int parse_auto(char *str, char *msg, int config);
8aec876d
NB
793extern mddev_ident_t conf_get_ident(char *dev);
794extern mddev_dev_t conf_get_devs(void);
8382f19b 795extern int conf_test_dev(char *devname);
31015d57 796extern int conf_test_metadata(const char *version);
8aec876d
NB
797extern struct createinfo *conf_get_create_info(void);
798extern void set_conffile(char *file);
799extern char *conf_get_mailaddr(void);
800extern char *conf_get_mailfrom(void);
801extern char *conf_get_program(void);
0ac91628 802extern char *conf_get_homehost(int *require_homehostp);
e0d19036 803extern char *conf_line(FILE *file);
98c6faba 804extern char *conf_word(FILE *file, int allow_key);
0ac91628
N
805extern int conf_name_is_free(char *name);
806extern int devname_matches(char *name, char *match);
360b4636 807extern struct mddev_ident_s *conf_match(struct mdinfo *info, struct supertype *st);
0ac91628 808
e0d19036
NB
809extern void free_line(char *line);
810extern int match_oneof(char *devices, char *devname);
e0d19036 811extern void uuid_from_super(int uuid[4], mdp_super_t *super);
36ba7d48 812extern const int uuid_match_any[4];
f277ce36 813extern int same_uuid(int a[4], int b[4], int swapuuid);
350f29f9 814extern void copy_uuid(void *a, int b[4], int swapuuid);
d7288ddc 815extern char *fname_from_uuid(struct supertype *st,
ff54de6e 816 struct mdinfo *info, char *buf, char sep);
4b1ac34b 817extern unsigned long calc_csum(void *super, int bytes);
583315d9 818extern int enough(int level, int raid_disks, int layout, int clean,
265e0f17 819 char *avail, int avail_disks);
e0d19036 820extern int ask(char *mesg);
8fac0577 821extern unsigned long long get_component_size(int fd);
0430ed48 822extern void remove_partitions(int fd);
5f8097be
NB
823extern unsigned long long calc_array_size(int level, int raid_disks, int layout,
824 int chunksize, unsigned long long devsize);
edd8d13c
NB
825extern int flush_metadata_updates(struct supertype *st);
826extern void append_metadata_update(struct supertype *st, void *buf, int len);
6234c63c
DW
827extern int assemble_container_content(struct supertype *st, int mdfd,
828 struct mdinfo *content, int runstop,
829 char *chosen_name, int verbose);
e0d19036 830
7801ac20
N
831extern int add_disk(int mdfd, struct supertype *st,
832 struct mdinfo *sra, struct mdinfo *info);
f35f2525 833extern int set_array_info(int mdfd, struct supertype *st, struct mdinfo *info);
cd29a5c8 834
56eb10c0 835extern char *human_size(long long bytes);
e4965ef8
N
836extern char *human_size_brief(long long bytes);
837extern void print_r10_layout(int layout);
e0d19036 838
63152c1b
NB
839#define NoMdDev (1<<23)
840extern int find_free_devnum(int use_partitions);
841
e0d19036
NB
842extern void put_md_name(char *name);
843extern char *get_md_name(int dev);
844
c913b90e 845extern char DefaultConfFile[];
b5e64645 846
69207ff6
N
847extern int create_mddev(char *dev, char *name, int autof, int trustworthy,
848 char *chosen);
849/* values for 'trustworthy' */
850#define LOCAL 1
851#define FOREIGN 2
852#define METADATA 3
6be1d39d 853extern int open_mddev(char *dev, int report_errors);
a322f70c 854extern int open_container(int fd);
b5e64645 855
a931db9e
NB
856extern int mdmon_running(int devnum);
857extern int signal_mdmon(int devnum);
40ebbb9c 858extern int check_env(char *name);
8850ee3e 859extern int start_mdmon(int devnum);
a931db9e 860
2f6079dc 861extern char *devnum2devname(int num);
77472ff8 862extern int devname2devnum(char *name);
c94709e8 863extern int stat2devnum(struct stat *st);
2f6079dc 864extern int fd2devnum(int fd);
b5e64645 865
a931db9e
NB
866static inline int dev2major(int d)
867{
868 if (d >= 0)
869 return MD_MAJOR;
870 else
871 return get_mdp_major();
872}
873
874static inline int dev2minor(int d)
875{
876 if (d >= 0)
877 return d;
878 return (-1-d) << MdpMinorShift;
879}
880
6416d527
NB
881static inline int ROUND_UP(int a, int base)
882{
883 return ((a+base-1)/base)*base;
884}
885
3c558363
N
886static inline int is_subarray(char *vers)
887{
e9dd1598
N
888 /* The version string for a 'subarray' (an array in a container)
889 * is
890 * /containername/componentname for normal read-write arrays
891 * -containername/componentname for read-only arrays.
892 * containername is e.g. md0, md_d1
893 * componentname is dependant on the metadata. e.g. '1' 'S1' ...
894 */
895 return (*vers == '/' || *vers == '-');
3c558363
N
896}
897
2a24d7b6
DW
898#ifdef DEBUG
899#define dprintf(fmt, arg...) \
900 fprintf(stderr, fmt, ##arg)
901#else
902#define dprintf(fmt, arg...) \
903 ({ if (0) fprintf(stderr, fmt, ##arg); 0; })
904#endif
1a0ee0ba
DK
905#include <assert.h>
906#include <stdarg.h>
907static inline int xasprintf(char **strp, const char *fmt, ...) {
908 va_list ap;
909 int ret;
910 va_start(ap, fmt);
089485cb 911 ret = vasprintf(strp, fmt, ap);
1a0ee0ba
DK
912 va_end(ap);
913 assert(ret >= 0);
914 return ret;
915}
2a24d7b6 916
b5e64645
NB
917#define LEVEL_MULTIPATH (-4)
918#define LEVEL_LINEAR (-1)
919#define LEVEL_FAULTY (-5)
920
17f25ca6
NB
921/* kernel module doesn't know about these */
922#define LEVEL_CONTAINER (-100)
a322f70c 923#define LEVEL_UNSUPPORTED (-200)
17f25ca6 924
b5e64645
NB
925
926/* faulty stuff */
927
928#define WriteTransient 0
929#define ReadTransient 1
930#define WritePersistent 2
931#define ReadPersistent 3
932#define WriteAll 4 /* doesn't go to device */
933#define ReadFixable 5
934#define Modes 6
935
936#define ClearErrors 31
937#define ClearFaults 30
938
939#define AllPersist 100 /* internal use only */
940#define NoPersist 101
941
942#define ModeMask 0x1f
943#define ModeShift 5
fe6729fa
NB
944
945
946#ifdef __TINYC__
947#undef minor
948#undef major
949#undef makedev
950#define minor(x) ((x)&0xff)
951#define major(x) (((x)>>8)&0xff)
952#define makedev(M,m) (((M)<<8) | (m))
953#endif
954
b640a252 955/* for raid4/5/6 */
e86c9dd6
NB
956#define ALGORITHM_LEFT_ASYMMETRIC 0
957#define ALGORITHM_RIGHT_ASYMMETRIC 1
958#define ALGORITHM_LEFT_SYMMETRIC 2
959#define ALGORITHM_RIGHT_SYMMETRIC 3
b640a252
N
960
961/* Define non-rotating (raid4) algorithms. These allow
962 * conversion of raid4 to raid5.
963 */
964#define ALGORITHM_PARITY_0 4 /* P or P,Q are initial devices */
965#define ALGORITHM_PARITY_N 5 /* P or P,Q are final devices. */
966
967/* DDF RAID6 layouts differ from md/raid6 layouts in two ways.
968 * Firstly, the exact positioning of the parity block is slightly
969 * different between the 'LEFT_*' modes of md and the "_N_*" modes
970 * of DDF.
971 * Secondly, or order of datablocks over which the Q syndrome is computed
972 * is different.
973 * Consequently we have different layouts for DDF/raid6 than md/raid6.
974 * These layouts are from the DDFv1.2 spec.
975 * Interestingly DDFv1.2-Errata-A does not specify N_CONTINUE but
976 * leaves RLQ=3 as 'Vendor Specific'
977 */
978
979#define ALGORITHM_ROTATING_ZERO_RESTART 8 /* DDF PRL=6 RLQ=1 */
980#define ALGORITHM_ROTATING_N_RESTART 9 /* DDF PRL=6 RLQ=2 */
981#define ALGORITHM_ROTATING_N_CONTINUE 10 /*DDF PRL=6 RLQ=3 */
982
983
984/* For every RAID5 algorithm we define a RAID6 algorithm
985 * with exactly the same layout for data and parity, and
986 * with the Q block always on the last device (N-1).
987 * This allows trivial conversion from RAID5 to RAID6
988 */
989#define ALGORITHM_LEFT_ASYMMETRIC_6 16
990#define ALGORITHM_RIGHT_ASYMMETRIC_6 17
991#define ALGORITHM_LEFT_SYMMETRIC_6 18
992#define ALGORITHM_RIGHT_SYMMETRIC_6 19
993#define ALGORITHM_PARITY_0_6 20
994#define ALGORITHM_PARITY_N_6 ALGORITHM_PARITY_N
995