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