util: make env checking more generic
[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 */
353632d9
NB
149 int reshape_active;
150 unsigned long long reshape_progress;
0fd5c350 151 unsigned long long resync_start;
a67dd8cc 152 unsigned long safe_mode_delay; /* ms delay to mark clean */
353632d9 153 int new_level, delta_disks, new_layout, new_chunk;
06c7f68e 154 int errors;
7e0f6979
NB
155 int cache_size; /* size of raid456 stripe cache*/
156 int mismatch_cnt;
157 char text_version[50];
dd15dc4a
NB
158
159 int container_member; /* for assembling external-metatdata arrays
160 * This is to be used internally by metadata
161 * handler only */
06c7f68e
NB
162
163 char sys_name[20];
7e0f6979 164 struct mdinfo *devs;
06c7f68e 165 struct mdinfo *next;
549e9569
NB
166
167 /* Device info for mdmon: */
168 int state_fd;
8d45d196
DW
169 #define DS_FAULTY 1
170 #define DS_INSYNC 2
171 #define DS_WRITE_MOSTLY 4
172 #define DS_SPARE 8
173 #define DS_BLOCKED 16
174 #define DS_REMOVE 1024
92967543 175 #define DS_UNBLOCK 2048
549e9569
NB
176 int prev_state, curr_state, next_state;
177
4b1ac34b
NB
178};
179
5bbb4842
NB
180struct createinfo {
181 int uid;
182 int gid;
183 int autof;
184 int mode;
38098016 185 int symlinks;
058574b1 186 struct supertype *supertype;
5bbb4842
NB
187};
188
9a9dab36 189#define Name "mdadm"
682c7051 190
e0d19036
NB
191enum mode {
192 ASSEMBLE=1,
193 BUILD,
194 CREATE,
195 MANAGE,
196 MISC,
197 MONITOR,
dd0781e5 198 GROW,
8382f19b 199 INCREMENTAL,
1f48664b 200 AUTODETECT,
e0d19036
NB
201};
202
64c4757e 203extern char short_options[];
024768c4 204extern char short_bitmap_options[];
c06487ce 205extern char short_bitmap_auto_options[];
64c4757e 206extern struct option long_options[];
56eedc1a 207extern char Version[], Usage[], Help[], OptionHelp[],
dd0781e5 208 Help_create[], Help_build[], Help_assemble[], Help_grow[],
8382f19b 209 Help_incr[],
e0d19036 210 Help_manage[], Help_misc[], Help_monitor[], Help_config[];
64c4757e 211
997aed5d
NB
212/* for option that don't have short equivilents, we assign arbitrary
213 * small numbers. '1' means an undecorated option, so we start at '2'.
214 */
215enum special_options {
216 AssumeClean = 2,
217 BitmapChunk,
218 WriteBehind,
219 ReAdd,
220 NoDegraded,
221 Sparc22,
222 BackupFile,
223 HomeHost,
589395d6 224 AutoHomeHost,
38098016 225 Symlinks,
1f48664b 226 AutoDetect,
1770662b 227 Waitclean,
997aed5d
NB
228};
229
64c4757e 230/* structures read from config file */
52826846
NB
231/* List of mddevice names and identifiers
232 * Identifiers can be:
233 * uuid=128-hex-uuid
234 * super-minor=decimal-minor-number-from-superblock
235 * devices=comma,separated,list,of,device,names,with,wildcards
236 *
237 * If multiple fields are present, the intersection of all matching
238 * devices is considered
239 */
98c6faba 240#define UnSet (0xfffe)
52826846 241typedef struct mddev_ident_s {
dd0781e5 242 char *devname;
aba69144 243
dd0781e5 244 int uuid_set;
3fa06e9d 245 int uuid[4];
947fd4dd 246 char name[33];
52826846 247
98c6faba 248 unsigned int super_minor;
52826846 249
dd0781e5 250 char *devices; /* comma separated list of device
52826846
NB
251 * names with wild cards
252 */
dd0781e5 253 int level;
98c6faba
NB
254 unsigned int raid_disks;
255 unsigned int spare_disks;
82d9eba6 256 struct supertype *st;
dd0781e5
NB
257 int autof; /* 1 for normal, 2 for partitioned */
258 char *spare_group;
7ef02d01 259 char *bitmap_file;
c82f047c 260 int bitmap_fd;
dd0781e5 261
dbb44303
N
262 char *container; /* /dev/whatever name of container. You
263 * would expect this to be the 'devname'
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 */
64c4757e
NB
280 struct mddev_dev_s *next;
281} *mddev_dev_t;
282
682c7051
NB
283typedef struct mapping {
284 char *name;
285 int num;
286} mapping_t;
287
e0d19036
NB
288
289struct mdstat_ent {
290 char *dev;
291 int devnum;
292 int active;
293 char *level;
294 char *pattern; /* U or up, _ for down */
295 int percent; /* -1 if no resync */
e5329c37 296 int resync; /* 1 if resync, 0 if recovery */
549e9569
NB
297 int devcnt;
298 int raid_disks;
299 int chunk_size;
300 char * metadata_version;
e0d19036
NB
301 struct mdstat_ent *next;
302};
303
22a88995 304extern struct mdstat_ent *mdstat_read(int hold, int start);
e0d19036 305extern void free_mdstat(struct mdstat_ent *ms);
dd0781e5 306extern void mdstat_wait(int seconds);
1ed3f387 307extern void mdstat_wait_fd(int fd, const sigset_t *sigmask);
8382f19b
NB
308extern int mddev_busy(int devnum);
309
310struct map_ent {
311 struct map_ent *next;
312 int devnum;
1522c538 313 char metadata[20];
8382f19b
NB
314 int uuid[4];
315 char *path;
316};
1522c538 317extern int map_update(struct map_ent **mpp, int devnum, char *metadata,
8382f19b
NB
318 int uuid[4], char *path);
319extern struct map_ent *map_by_uuid(struct map_ent **map, int uuid[4]);
320extern void map_read(struct map_ent **melp);
321extern int map_write(struct map_ent *mel);
322extern void map_delete(struct map_ent **mapp, int devnum);
323extern void map_free(struct map_ent *map);
324extern void map_add(struct map_ent **melp,
1522c538 325 int devnum, char *metadata, int uuid[4], char *path);
e0d19036 326
e86c9dd6
NB
327/* various details can be requested */
328#define GET_LEVEL 1
329#define GET_LAYOUT 2
330#define GET_COMPONENT 4
331#define GET_CHUNK 8
758d3a8e 332#define GET_CACHE 16
37dfc3d6 333#define GET_MISMATCH 32
8382f19b 334#define GET_VERSION 64
549e9569 335#define GET_DISKS 128
f1d26766 336#define GET_DEGRADED 256
1770662b 337#define GET_SAFEMODE 512
e86c9dd6
NB
338
339#define GET_DEVS 1024 /* gets role, major, minor */
340#define GET_OFFSET 2048
341#define GET_SIZE 4096
342#define GET_STATE 8192
343#define GET_ERROR 16384
344
345/* If fd >= 0, get the array it is open on,
346 * else use devnum. >=0 -> major9. <0.....
347 */
549e9569 348extern int sysfs_open(int devnum, char *devname, char *attr);
f35f2525 349extern void sysfs_init(struct mdinfo *mdi, int fd, int devnum);
7e0f6979
NB
350extern void sysfs_free(struct mdinfo *sra);
351extern struct mdinfo *sysfs_read(int fd, int devnum, unsigned long options);
1770662b
DW
352extern int sysfs_attr_match(const char *attr, const char *str);
353extern int sysfs_match_word(const char *word, char **list);
7e0f6979 354extern int sysfs_set_str(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 355 char *name, char *val);
7e0f6979 356extern int sysfs_set_num(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 357 char *name, unsigned long long val);
7e0f6979 358extern int sysfs_get_ll(struct mdinfo *sra, struct mdinfo *dev,
e86c9dd6 359 char *name, unsigned long long *val);
8ed3e5e1 360extern int sysfs_set_safemode(struct mdinfo *sra, unsigned long ms);
f35f2525 361extern int sysfs_set_array(struct mdinfo *info, int vers);
2318b9f0 362extern int sysfs_add_disk(struct mdinfo *sra, struct mdinfo *sd);
f1665f72 363extern int sysfs_disk_to_scsi_id(int fd, __u32 *id);
f94d52f4 364extern int sysfs_unique_holder(int devnum, long rdev);
c69b251b 365extern int load_sys(char *path, char *buf);
e86c9dd6
NB
366
367
368extern int save_stripes(int *source, unsigned long long *offsets,
369 int raid_disks, int chunk_size, int level, int layout,
370 int nwrites, int *dest,
371 unsigned long long start, unsigned long long length);
353632d9
NB
372extern int restore_stripes(int *dest, unsigned long long *offsets,
373 int raid_disks, int chunk_size, int level, int layout,
374 int source, unsigned long long read_offset,
375 unsigned long long start, unsigned long long length);
e86c9dd6 376
52826846
NB
377#ifndef Sendmail
378#define Sendmail "/usr/lib/sendmail -t"
379#endif
380
773135f5
NB
381#define SYSLOG_FACILITY LOG_DAEMON
382
682c7051
NB
383extern char *map_num(mapping_t *map, int num);
384extern int map_name(mapping_t *map, char *name);
b5e64645 385extern mapping_t r5layout[], pers[], modes[], faultylayout[];
682c7051 386
16c6fa80 387extern char *map_dev(int major, int minor, int create);
64c4757e 388
549e9569 389struct active_array;
2e735d19 390struct metadata_update;
64c4757e 391
6adfd3af
NB
392/* A superswitch provides entry point the a metadata handler.
393 *
394 * The super_switch primarily operates on some "metadata" that
395 * is accessed via the 'supertype'.
396 * This metadata has one of three possible sources.
397 * 1/ It is read from a single device. In this case it may not completely
398 * describe the array or arrays as some information might be on other
399 * devices.
400 * 2/ It is read from all devices in a container. In this case all
401 * information is present.
402 * 3/ It is created by ->init_super / ->add_to_super. In this case it will
403 * be complete once enough ->add_to_super calls have completed.
404 *
405 * When creating an array inside a container, the metadata will be
406 * formed by a combination of 2 and 3. The metadata or the array is read,
407 * then new information is added.
408 *
409 * The metadata must sometimes have a concept of a 'current' array
410 * and a 'current' device.
411 * The 'current' array is set by init_super to be the newly created array,
412 * or is set by super_by_fd when it finds it is looking at an array inside
413 * a container.
414 *
415 * The 'current' device is either the device that the metadata was read from
416 * in case 1, or the last device added by add_to_super in case 3.
417 * Case 2 does not identify a 'current' device.
418 */
f9ce90ba 419extern struct superswitch {
6adfd3af
NB
420
421 /* Used to report details of metadata read from a component
422 * device. ->load_super has been called.
423 */
3da92f27
NB
424 void (*examine_super)(struct supertype *st, char *homehost);
425 void (*brief_examine_super)(struct supertype *st);
0d726f17 426 void (*export_examine_super)(struct supertype *st);
6adfd3af
NB
427
428 /* Used to report details of an active array.
429 * ->load_super was possibly given a 'component' string.
430 */
3da92f27 431 void (*detail_super)(struct supertype *st, char *homehost);
3da92f27 432 void (*brief_detail_super)(struct supertype *st);
0d726f17 433 void (*export_detail_super)(struct supertype *st);
6adfd3af
NB
434
435 /* Used:
436 * to get uuid to storing in bitmap metadata
437 * and 'reshape' backup-data metadata
438 * To see if a device is being re-added to an array it was part of.
439 */
3da92f27 440 void (*uuid_from_super)(struct supertype *st, int uuid[4]);
6adfd3af
NB
441
442 /* Extra generic details from metadata. This could be details about
443 * the container, or about an individual array within the container.
444 * The determination is made either by:
445 * load_super being given a 'component' string.
446 * validate_geometry determining what to create.
d2ca6449
NB
447 * The info includes both array information and device information.
448 * The particular device should be:
449 * The last device added by add_to_super
450 * The device the metadata was loaded from by load_super
6adfd3af 451 */
3da92f27 452 void (*getinfo_super)(struct supertype *st, struct mdinfo *info);
6adfd3af
NB
453
454 /* Check if the given metadata is flagged as belonging to "this"
9362c1c8 455 * host. 0 for 'no', 1 for 'yes', -1 for "Don't record homehost"
6adfd3af 456 */
3da92f27 457 int (*match_home)(struct supertype *st, char *homehost);
6adfd3af
NB
458
459 /* Make one of several generic modifications to metadata
460 * prior to assembly (or other times).
461 * sparc2.2 - first bug in early 0.90 metadata
462 * super-minor - change name of 0.90 metadata
463 * summaries - 'correct' any redundant data
464 * resync - mark array as dirty to trigger a resync.
465 * uuid - set new uuid - only 0.90 or 1.x
466 * name - change the name of the array (where supported)
467 * homehost - change which host this array is tied to.
468 * devicesize - If metadata is at start of device, change recorded
469 * device size to match actual device size
470 * byteorder - swap bytes for 0.90 metadata
471 *
472 * force-one - mark that device as uptodate, not old or failed.
473 * force-array - mark array as clean if it would not otherwise
474 * assemble
475 * assemble - not sure how this is different from force-one...
476 * linear-grow-new - add a new device to a linear array, but don't
477 * change the size: so superblock still matches
478 * linear-grow-update - now change the size of the array.
479 */
68c7d6d7 480 int (*update_super)(struct supertype *st, struct mdinfo *info,
3da92f27 481 char *update,
e5eac01f
NB
482 char *devname, int verbose,
483 int uuid_set, char *homehost);
6adfd3af
NB
484
485 /* Create new metadata for new array as described. This could
486 * be a new container, or an array in a pre-existing container.
487 * Also used to zero metadata prior to writing it to invalidate old
488 * metadata.
489 */
3da92f27
NB
490 int (*init_super)(struct supertype *st, mdu_array_info_t *info,
491 unsigned long long size, char *name,
492 char *homehost, int *uuid);
6adfd3af
NB
493
494 /* update the metadata to include new device, either at create or
495 * when hot-adding a spare.
496 */
111d01fc
NB
497 void (*add_to_super)(struct supertype *st, mdu_disk_info_t *dinfo,
498 int fd, char *devname);
6adfd3af
NB
499
500 /* Write metadata to one device when fixing problems or adding
501 * a new device.
502 */
3da92f27 503 int (*store_super)(struct supertype *st, int fd);
6adfd3af
NB
504
505 /* Write all metadata for this array.
506 */
111d01fc 507 int (*write_init_super)(struct supertype *st);
64557c33 508 int (*compare_super)(struct supertype *st, struct supertype *tst);
3da92f27 509 int (*load_super)(struct supertype *st, int fd, char *devname);
82d9eba6 510 struct supertype * (*match_metadata_desc)(char *arg);
1bf4e2d9 511 __u64 (*avail_size)(struct supertype *st, __u64 size);
3da92f27 512 int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
199171a2 513 int delay, int write_behind,
f9c25f1d 514 unsigned long long size, int may_change, int major);
3da92f27
NB
515 void (*locate_bitmap)(struct supertype *st, int fd);
516 int (*write_bitmap)(struct supertype *st, int fd);
517 void (*free_super)(struct supertype *st);
78e44928
NB
518
519 /* validate_geometry is called with an st returned by
520 * match_metadata_desc.
521 * It should check that the geometry described in compatible with
522 * the metadata type. It will be called repeatedly as devices
523 * added to validate changing size and new devices. If there are
524 * inter-device dependencies, it should record sufficient details
525 * so these can be validated.
526 */
17f25ca6
NB
527 int (*validate_geometry)(struct supertype *st, int level, int layout,
528 int raiddisks,
529 int chunk, unsigned long long size,
2c514b71
NB
530 char *subdev, unsigned long long *freesize,
531 int verbose);
598f0d58
NB
532
533 struct mdinfo *(*container_content)(struct supertype *st);
534
549e9569 535/* for mdmon */
cba0191b
NB
536 int (*open_new)(struct supertype *c, struct active_array *a,
537 char *inst);
ed9d66aa
NB
538
539 /* Tell the metadata handler the current state of the array.
540 * This covers whether it is known to be consistent (no pending writes)
01f157d7 541 * and how far along a resync is known to have progressed
ed9d66aa
NB
542 * (in a->resync_start).
543 * resync status is really irrelevant if the array is not consistent,
544 * but some metadata (DDF!) have a place to record the distinction.
01f157d7
N
545 * If 'consistent' is '2', then the array can mark it dirty if a
546 * resync/recovery/whatever is required, or leave it clean if not.
547 * Return value is 0 dirty (not consistent) and 1 if clean.
548 * it is only really important if consistent is passed in as '2'.
4e5528c6 549 */
01f157d7 550 int (*set_array_state)(struct active_array *a, int consistent);
7a7cc504
NB
551
552 /* When the state of a device might have changed, we call set_disk to
553 * tell the metadata what the current state is.
554 * Typically this happens on spare->in_sync and (spare|in_sync)->faulty
555 * transitions.
556 * set_disk might be called when the state of the particular disk has
557 * not in fact changed.
558 */
8d45d196 559 void (*set_disk)(struct active_array *a, int n, int state);
2e735d19
NB
560 void (*sync_metadata)(struct supertype *st);
561 void (*process_update)(struct supertype *st,
562 struct metadata_update *update);
edd8d13c
NB
563 void (*prepare_update)(struct supertype *st,
564 struct metadata_update *update);
549e9569 565
6c3fb95c
NB
566 /* activate_spare will check if the array is degraded and, if it
567 * is, try to find some spare space in the container.
568 * On success, it add appropriate updates (For process_update) to
569 * to the 'updates' list and returns a list of 'mdinfo' identifying
570 * the device, or devices as there might be multiple missing
571 * devices and multiple spares available.
572 */
573 struct mdinfo *(*activate_spare)(struct active_array *a,
574 struct metadata_update **updates);
549e9569 575
f277ce36 576 int swapuuid; /* true if uuid is bigending rather than hostendian */
d03373f1 577 int external;
0063ecba 578} super0, super1, super_ddf, *superlist[];
82d9eba6 579
0063ecba 580extern struct superswitch super_imsm;
cdddbdbc 581
edd8d13c
NB
582struct metadata_update {
583 int len;
584 char *buf;
585 void *space; /* allocated space that monitor will use */
586 struct metadata_update *next;
587};
588
6adfd3af
NB
589/* A supertype holds a particular collection of metadata.
590 * It identifies the metadata type by the superswitch, and the particular
591 * sub-version of that metadata type.
592 * metadata read in or created is stored in 'sb' and 'info'.
593 * There are also fields used by mdmon to track containers.
594 *
352452c3
N
595 * A supertype may refer to:
596 * Just an array, possibly in a container
597 * A container, not identifying any particular array
598 * Info read from just one device, not yet fully describing the array/container.
599 *
600 *
6adfd3af
NB
601 * A supertype is created by:
602 * super_by_fd
603 * guess_super
604 * dup_super
605 */
82d9eba6
NB
606struct supertype {
607 struct superswitch *ss;
608 int minor_version;
ea329559 609 int max_devs;
2f6079dc 610 int container_dev; /* devnum of container */
f7e7067b 611 char subarray[32]; /* name of array inside container */
64557c33 612 void *sb;
111d01fc 613 void *info;
352452c3
N
614 int loaded_container; /* Set if load_super found a container,
615 * not just one device */
549e9569 616
edd8d13c
NB
617 struct metadata_update *updates;
618 struct metadata_update **update_tail;
619
549e9569
NB
620 /* extra stuff used by mdmon */
621 struct active_array *arrays;
549e9569 622 int sock; /* listen to external programs */
549e9569
NB
623 int devnum;
624 char *devname; /* e.g. md0. This appears in metadata_verison:
625 * external:/md0/12
626 */
627 int devcnt;
e0d6609f 628 char *device_name; /* e.g. /dev/md/whatever */
549e9569
NB
629
630 struct mdinfo *devs;
631
82d9eba6 632};
f9ce90ba 633
1686dc25 634extern struct supertype *super_by_fd(int fd);
82d9eba6 635extern struct supertype *guess_super(int fd);
3da92f27 636extern struct supertype *dup_super(struct supertype *st);
beae1dfe 637extern int get_dev_size(int fd, char *dname, unsigned long long *sizep);
8382f19b
NB
638extern void get_one_disk(int mdfd, mdu_array_info_t *ainf,
639 mdu_disk_info_t *disk);
f9ce90ba 640
838acbc2
NB
641#if __GNUC__ < 3
642struct stat64;
643#endif
644
45e878bb
NB
645#define HAVE_NFTW we assume
646#define HAVE_FTW
647
173fc515 648#ifdef UCLIBC
45e878bb
NB
649# include <features.h>
650# ifndef __UCLIBC_HAS_FTW__
651# undef HAVE_FTW
652# undef HAVE_NFTW
653# endif
654#endif
655
656#ifdef __dietlibc__
657# undef HAVE_NFTW
658#endif
659
e39b673e 660#if defined(__KLIBC__)
661# undef HAVE_NFTW
662# undef HAVE_FTW
663#endif
664
45e878bb 665#ifndef HAVE_NFTW
173fc515 666# define FTW_PHYS 1
45e878bb
NB
667# ifndef HAVE_FTW
668 struct FTW {};
173fc515
NB
669# endif
670#endif
671
45e878bb
NB
672#ifdef HAVE_FTW
673# include <ftw.h>
674#endif
675
173fc515
NB
676extern int add_dev(const char *name, const struct stat *stb, int flag, struct FTW *s);
677
f9ce90ba 678
64c4757e 679extern int Manage_ro(char *devname, int fd, int readonly);
91f068bf 680extern int Manage_runstop(char *devname, int fd, int runstop, int quiet);
dd0781e5 681extern int Manage_resize(char *devname, int fd, long long size, int raid_disks);
b5e64645 682extern int Manage_reconfig(char *devname, int fd, int layout);
64c4757e 683extern int Manage_subdevs(char *devname, int fd,
dab6685f 684 mddev_dev_t devlist, int verbose);
1f48664b 685extern int autodetect(void);
e5329c37 686extern int Grow_Add_device(char *devname, int fd, char *newdev);
8fac0577 687extern int Grow_addbitmap(char *devname, int fd, char *file, int chunk, int delay, int write_behind, int force);
06b0d786 688extern int Grow_reshape(char *devname, int fd, int quiet, char *backup_file,
e86c9dd6
NB
689 long long size,
690 int level, int layout, int chunksize, int raid_disks);
06b0d786
NB
691extern int Grow_restart(struct supertype *st, struct mdinfo *info,
692 int *fdlist, int cnt, char *backup_file);
64c4757e
NB
693
694
7f91af49 695extern int Assemble(struct supertype *st, char *mddev,
52826846 696 mddev_ident_t ident,
06b0d786 697 mddev_dev_t devlist, char *backup_file,
64c4757e 698 int readonly, int runstop,
e5eac01f 699 char *update, char *homehost,
64c4757e
NB
700 int verbose, int force);
701
7f91af49
N
702extern int Build(char *mddev, int chunk, int level, int layout,
703 int raiddisks, mddev_dev_t devlist, int assume_clean,
704 char *bitmap_file, int bitmap_chunk, int write_behind,
705 int delay, int verbose, int autof);
64c4757e
NB
706
707
7f91af49 708extern int Create(struct supertype *st, char *mddev,
5dd497ee 709 int chunk, int level, int layout, unsigned long long size, int raiddisks, int sparedisks,
3d3dd91e 710 char *name, char *homehost, int *uuid,
cd29a5c8 711 int subdevs, mddev_dev_t devlist,
47d79ef8 712 int runstop, int verbose, int force, int assume_clean,
7f91af49 713 char *bitmap_file, int bitmap_chunk, int write_behind, int delay, int autof);
64c4757e 714
54bad364 715extern int Detail(char *dev, int brief, int export, int test, char *homehost);
e0d19036 716extern int Query(char *dev);
0d726f17
KS
717extern int Examine(mddev_dev_t devlist, int brief, int export, int scan,
718 int SparcAdjust, struct supertype *forcest, char *homehost);
cd29a5c8 719extern int Monitor(mddev_dev_t devlist,
e0d19036 720 char *mailaddr, char *alert_cmd,
aa88f531 721 int period, int daemonise, int scan, int oneshot,
8aec876d 722 int dosyslog, int test, char *pidfile);
64c4757e 723
111d01fc 724extern int Kill(char *dev, int force, int quiet, int noexcl);
b90c0e9a 725extern int Wait(char *dev);
27dec8fa 726extern int WaitClean(char *dev, int verbose);
9a9dab36 727
8382f19b
NB
728extern int Incremental(char *devname, int verbose, int runstop,
729 struct supertype *st, char *homehost, int autof);
598f0d58
NB
730extern int Incremental_container(struct supertype *st, char *devname,
731 int verbose, int runstop, int autof);
8382f19b
NB
732extern void RebuildMap(void);
733extern int IncrementalScan(int verbose);
734
c82f047c
NB
735extern int CreateBitmap(char *filename, int force, char uuid[16],
736 unsigned long chunksize, unsigned long daemon_sleep,
dfd4d8ee 737 unsigned long write_behind,
dcec9ee5
NB
738 unsigned long long array_size,
739 int major);
55935d51 740extern int ExamineBitmap(char *filename, int brief, struct supertype *st);
bf4fb153 741extern int bitmap_update_uuid(int fd, int *uuid, int swap);
2a528478 742extern unsigned long bitmap_sectors(struct bitmap_super_s *bsb);
c82f047c 743
64c4757e 744extern int md_get_version(int fd);
e0d19036 745extern int get_linux_version(void);
64c4757e 746extern int parse_uuid(char *str, int uuid[4]);
682c7051
NB
747extern int check_ext2(int fd, char *name);
748extern int check_reiser(int fd, char *name);
749extern int check_raid(int fd, char *name);
64c4757e 750
dd0781e5 751extern int get_mdp_major(void);
8b0dabea 752extern int dev_open(char *dev, int flags);
a931db9e 753extern int open_dev_excl(int devnum);
8d80900b 754extern int is_standard(char *dev, int *nump);
dd0781e5 755
f1ae21c4 756extern int parse_auto(char *str, char *msg, int config);
8aec876d
NB
757extern mddev_ident_t conf_get_ident(char *dev);
758extern mddev_dev_t conf_get_devs(void);
8382f19b 759extern int conf_test_dev(char *devname);
8aec876d
NB
760extern struct createinfo *conf_get_create_info(void);
761extern void set_conffile(char *file);
762extern char *conf_get_mailaddr(void);
763extern char *conf_get_mailfrom(void);
764extern char *conf_get_program(void);
765extern char *conf_get_homehost(void);
e0d19036 766extern char *conf_line(FILE *file);
98c6faba 767extern char *conf_word(FILE *file, int allow_key);
e0d19036
NB
768extern void free_line(char *line);
769extern int match_oneof(char *devices, char *devname);
e0d19036 770extern void uuid_from_super(int uuid[4], mdp_super_t *super);
36ba7d48 771extern const int uuid_match_any[4];
f277ce36 772extern int same_uuid(int a[4], int b[4], int swapuuid);
350f29f9 773extern void copy_uuid(void *a, int b[4], int swapuuid);
d7288ddc 774extern char *fname_from_uuid(struct supertype *st,
ff54de6e 775 struct mdinfo *info, char *buf, char sep);
4b1ac34b 776extern unsigned long calc_csum(void *super, int bytes);
583315d9 777extern int enough(int level, int raid_disks, int layout, int clean,
265e0f17 778 char *avail, int avail_disks);
e0d19036 779extern int ask(char *mesg);
8fac0577 780extern unsigned long long get_component_size(int fd);
0430ed48 781extern void remove_partitions(int fd);
5f8097be
NB
782extern unsigned long long calc_array_size(int level, int raid_disks, int layout,
783 int chunksize, unsigned long long devsize);
edd8d13c
NB
784extern int flush_metadata_updates(struct supertype *st);
785extern void append_metadata_update(struct supertype *st, void *buf, int len);
71d60c48 786extern struct superswitch *find_metadata_methods(char *vers);
e0d19036 787
7801ac20
N
788extern int add_disk(int mdfd, struct supertype *st,
789 struct mdinfo *sra, struct mdinfo *info);
f35f2525 790extern int set_array_info(int mdfd, struct supertype *st, struct mdinfo *info);
cd29a5c8 791
56eb10c0 792extern char *human_size(long long bytes);
e4965ef8
N
793extern char *human_size_brief(long long bytes);
794extern void print_r10_layout(int layout);
e0d19036 795
63152c1b
NB
796#define NoMdDev (1<<23)
797extern int find_free_devnum(int use_partitions);
798
e0d19036
NB
799extern void put_md_name(char *name);
800extern char *get_md_name(int dev);
801
c913b90e 802extern char DefaultConfFile[];
b5e64645 803
2399204d 804extern int create_mddev(char *dev, int autof);
6be1d39d 805extern int open_mddev(char *dev, int report_errors);
2399204d 806extern int create_mddev_devnum(char *devname, int devnum, char *name,
9a02c62a 807 char *chosen_name, int parts);
a322f70c 808extern int open_container(int fd);
b5e64645 809
a931db9e
NB
810extern int mdmon_running(int devnum);
811extern int signal_mdmon(int devnum);
40ebbb9c 812extern int check_env(char *name);
8850ee3e 813extern int start_mdmon(int devnum);
a931db9e 814
2f6079dc 815extern char *devnum2devname(int num);
77472ff8 816extern int devname2devnum(char *name);
c94709e8 817extern int stat2devnum(struct stat *st);
2f6079dc 818extern int fd2devnum(int fd);
b5e64645 819
a931db9e
NB
820static inline int dev2major(int d)
821{
822 if (d >= 0)
823 return MD_MAJOR;
824 else
825 return get_mdp_major();
826}
827
828static inline int dev2minor(int d)
829{
830 if (d >= 0)
831 return d;
832 return (-1-d) << MdpMinorShift;
833}
834
6416d527
NB
835static inline int ROUND_UP(int a, int base)
836{
837 return ((a+base-1)/base)*base;
838}
839
3c558363
N
840static inline int is_subarray(char *vers)
841{
e9dd1598
N
842 /* The version string for a 'subarray' (an array in a container)
843 * is
844 * /containername/componentname for normal read-write arrays
845 * -containername/componentname for read-only arrays.
846 * containername is e.g. md0, md_d1
847 * componentname is dependant on the metadata. e.g. '1' 'S1' ...
848 */
849 return (*vers == '/' || *vers == '-');
3c558363
N
850}
851
2a24d7b6
DW
852#ifdef DEBUG
853#define dprintf(fmt, arg...) \
854 fprintf(stderr, fmt, ##arg)
855#else
856#define dprintf(fmt, arg...) \
857 ({ if (0) fprintf(stderr, fmt, ##arg); 0; })
858#endif
859
b5e64645
NB
860#define LEVEL_MULTIPATH (-4)
861#define LEVEL_LINEAR (-1)
862#define LEVEL_FAULTY (-5)
863
17f25ca6
NB
864/* kernel module doesn't know about these */
865#define LEVEL_CONTAINER (-100)
a322f70c 866#define LEVEL_UNSUPPORTED (-200)
17f25ca6 867
b5e64645
NB
868
869/* faulty stuff */
870
871#define WriteTransient 0
872#define ReadTransient 1
873#define WritePersistent 2
874#define ReadPersistent 3
875#define WriteAll 4 /* doesn't go to device */
876#define ReadFixable 5
877#define Modes 6
878
879#define ClearErrors 31
880#define ClearFaults 30
881
882#define AllPersist 100 /* internal use only */
883#define NoPersist 101
884
885#define ModeMask 0x1f
886#define ModeShift 5
fe6729fa
NB
887
888
889#ifdef __TINYC__
890#undef minor
891#undef major
892#undef makedev
893#define minor(x) ((x)&0xff)
894#define major(x) (((x)>>8)&0xff)
895#define makedev(M,m) (((M)<<8) | (m))
896#endif
897
e86c9dd6
NB
898/* for raid5 */
899#define ALGORITHM_LEFT_ASYMMETRIC 0
900#define ALGORITHM_RIGHT_ASYMMETRIC 1
901#define ALGORITHM_LEFT_SYMMETRIC 2
902#define ALGORITHM_RIGHT_SYMMETRIC 3