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