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